Zulip Write Only Proxy

Usage

Client

Recommended clients are requests for synchronous code and httpx for asynchronous code. These examples are written for a server running locally at http://localhost:8080 but the actual URL will depend on the deployment.

Using requests (synchronous):

import requests

base_url = "http://localhost:8080"

response = requests.post(f"{base_url}/{endpoint}", data=data, ...)

Using httpx (async):

import httpx

base_url = "http://localhost:8080"

async with httpx.AsyncClient() as client:
    response = await client.post(f"{base_url}/{endpoint}", ...)

Replace endpoint with the desired endpoint (e.g. send_message).

Authentication

Authentication is done by including the token in the header, for example:

headers = {
    "accept": "application/json",
    "X-API-key": "token",
    "Content-Type": "multipart/form-data"
}

This header should be included in all requests. You can create a client which always has the header with:

import requests  # or httpx

client = requests.Session()
client.headers.update({"X-API-key": "token"})

Endpoints

Full API documentation is available by going to the /docs page (e.g. http://localhost:8080/docs). These examples are just intended to show basic usage and may not represent the current state of the API, check the API docs for the latest information.

Sending a message with text

response = client.post(
    f"{base_url}/send_message",
    params={"topic": "test-read-only-thing-2"}
    data={"content": "I recommend muting this topic."},
)

Sending a message with text and an image

/send_message supports sending a file with a message. An inline link to the file will be included at the end of the text message.

response = client.post(
    f"{base_url}/send_message",
    params={"topic": "test-read-only-thing-2"}
    data={'content': f'Interesting plot!'},
    files={'image': open('./downloads/recursion.jpg', 'rb')},
)

Creating a Client

If you have an admin token you can create a new client for a proposal and stream. This will create a new token for the client and return it:

response = client.post(
    f"{base_url}/create_client",
    params={"proposal_no": 1234, "stream": "proposal 1234 stream"},
)

Note that admin tokens can only create clients, they cannot post to a stream as they have no associated stream.

Development

Setup

For development you can either use docker or install the package locally via Poetry.

For docker:

# Build the image:
docker build . --tag zwop:dev

# Start the server, with the current directory mounted as a volume:
docker run -it --rm -v $(PWD):/app -p 8080:8080 zwop:dev

# Or use make, which does the same thing:
make dev-docker

For a direct install with Poetry:

# Install and activate
poetry install
poetry shell

# Start the server using poe, see next section for more details on poe tasks
poe serve

Debugging

When debugging it can be very useful, especially given the async nature of the API, to do so interactively. If using VSCode this can be done by creating a launch configuration for FastAPI. This will start the server and allow you to set breakpoints and step through the code.

Here is an example configuration, placed in .vscode/launch.json:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: FastAPI",
            "type": "python",
            "request": "launch",
            "module": "uvicorn",
            "args": [
                "zulip_write_only_proxy.main:app",
                "--port",
                "8080",
            ],
            "jinja": true,
            "justMyCode": false
        },
        {
            "name": "Python: FastAPI - Test Debug",
            "type": "python",
            "request": "launch",
            "module": "pytest",
            "jinja": true,
            "justMyCode": false
        }
    ]
}

This will add two configurations to the debug menu, one for running the server and one for running tests. The justMyCode option is set to false to allow for debugging/stepping into third party libraries.

See the VSCode Debugging documentation for more information.

Client Configuration

The configuration is very basic and is stored in a JSON file. The client token is used as a key and the value is a dictionary containing the proposal number and stream name.

{
  "t425dYYQAVAT9AZiPx5fe0nrLzQSPpjZW-54EdxOUPQ": {
    "proposal_no": 2222,
    "stream": "proposal 2222 stream",
  }
}

Stream/topic can be edited manually in the JSON file or set at creation time.

Tasks

This project uses poe as a task runner for various commands (see Poe the Poet).

List available commands with poe:

$ poe

CONFIGURED TASKS
  serve
  test
  lint
  format
  ruff
  black
  mypy
  pyright

Run a task with poe <task>:

poe lint  # Run linters - only checks, no code changes

poe format  # Run formatters - changes files in place

poe test  # Run tests

poe serve  # Run the server

Todo

Tentative list of things to do in the future:

• Query MyMdC for the stream name given a proposal number
• Query MyMdC for the list of topics and pass that on instead of trying to get them with the Zulip API
• Improve logging (structlog/loguru? sentry?)
• Set up dependabot
• Add test step to build-image workflow
• Allow for configuring zulip bots to use per client

Deployment

Deployment is similar to development with docker compose, but instead a docker stack is used to allow for better scaling and update configuration.

There are two required environment variables, the port to run on (PORT), and the tag to use for the image (TAG). These should be set in an .env file:

PORT=8089
TAG=0.1.0

To quickly bring the service up or down run make up or make down.

To update, bump up the tag run make up again. This will pull in the latest image and perform a rolling restart of the service, which will first start the new container, wait for a successful health check, and then stop the old container.

For development use there is an additional variable IMAGE which can be set to the name of a local image to use instead of pulling from the registry. This is useful for testing changes. If you recently used make dev-docker that would have build an image tagged zwop:dev which you could then use by setting IMAGE=zwop:dev in the .env file (note that this will not reflect code changes since the last image build).

NB: There is an outstanding issue with docker stack deploy where it does not load .env files in the same way that docker compose up does. This is solved by running docker compose config to generate a compose-compliant file (with env vars substituted), making a few changes via sed, and piping that to docker stack deploy -. Check the Makefile to see the exact command.