DummyBridge

DummyBridge is a Go-based bridge designed for testing purposes. It provides an echo bridge functionality and supports various login flows, including password, cookies, local storage, and display-and-wait.

Features

• Echo Bridge Functionality: Acts as a simple echo bridge for testing.
• Per-Message Echo Controls: Specific outbound messages can suppress or delay the remote echo.
• Login Flows: Supports multiple login flows such as password, cookies, local storage, and display-and-wait.
• Automation: Configurable automation options for management rooms, login, portals, and backfill.

Docker Images

To install Docker, refer to the Docker Engine install guide.

The DummyBridge project provides several Docker images:

• ghcr.io/beeper/dummybridge:latest: The main DummyBridge application.
• ghcr.io/beeper/dummybridge/loginhelper:latest: A helper service for managing login flows.
• ghcr.io/beeper/dummybridge/go:latest: A base image for Go applications.

To pull the latest version of the image, use the following:

docker pull ghcr.io/beeper/dummybridge:latest

Configuration

DummyBridge can be configured using a YAML file. Below is an example configuration:

automation:
  open_management_room: false # Open a management room for admins.
  login: false # Automatically log in admins.
  portals:
    count: 0 # Number of portals to create during startup.
    members: 0 # Number of members initially in each portal.
    messages: 0 # Number of messages initially sent to each portal.
  backfill:
    timelimit: 0s # Duration for the initial startup infinite backfill, e.g. 10s, 1m, 1h

To test slow or missing remote echoes, send trigger phrases in the message body:

• remote-echo none keeps that send pending forever.
• remote-echo fail makes that send fail immediately with an error.
• remote-echo delay 5s delays the remote echo for the parsed Go duration.

Other messages keep the existing immediate-success behavior.

Running

To run DummyBridge using Docker, execute the following command:

docker run -d --name dummybridge -v /path/to/config.yaml:/etc/dummybridge/config.yaml ghcr.io/beeper/dummybridge:latest

Replace /path/to/config.yaml with the path to your configuration file.

Login Flows

Once DummyBridge is launched, you can interact with it using various login flows:

1. Password Login:

   • Navigate to the login page and enter any username and password. These credentials are used as the ID.

2. Cookies Login:

   • Visit the /pages/cookies.html page and enter your username and password. These will be saved as cookies.

3. Local Storage Login:

   • Visit the /pages/localstorage.html page and enter your username and password. These will be saved in local storage.

4. Display and Wait Login:

   • A code will be generated, which you need to enter on the /pages/daw_submit.html page.

DummyBridge supports several commands for testing purposes, such as creating new rooms, generating ghosts, and sending messages. These commands can be executed within the bridge's management room.

Unresolved media (resolve-on-tap)

unresolved-media [image|video|fail|slow] generates a placeholder media message shaped exactly like an unresolved Instagram reel card: a normal m.image preview carrying a com.beeper.unresolved_media marker and an external_url. Clients render it as a card with an explicit open action, and only resolve it when the user taps. Run it inside a portal room, or from the management room, where it auto-creates a portal to put the placeholder in.

Tapping calls the bridge's resolver endpoint, which applies the result as an edit to the original event with com.beeper.dont_render_edited: true. The mode controls what happens on that tap:

Mode	Behaviour
image (default)	Resolves to a different image, so it is obvious the media changed
video	Resolves to a short video — the edit changes msgtype, which is the case clients most often get wrong
fail	Returns an error; the card must stay intact and the account must stay connected
slow	Waits ~10s before resolving, to exercise loading states and cancellation

The mode is encoded in the message ID, so the bridge decides what to do from its own state and never trusts what the client echoed back — matching how a real connector behaves.

License

This project currently does not have a published license.