Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Python entrypoints vs worker_app are very confusing #13644

Open
@richvdh

Description

@richvdh

We define various "application worker types", such as synapse.app.generic_worker and synapse.app.federation_sender. Which you get is determined by the worker_app configuration setting.

However, for historical reasons, we also have a bunch of entrypoints with matching names: python -m synapse.app.generic_worker or python -m synapse.app.federation_sender. These all do the same thing, but the fact that they exist, and have the same names as the workers, makes the interaction very confusing. We don't make it clear which entrypoint you should use. Possibly we could recommend synapse.app.generic_worker, but that's still confusing.

I think the easiest way out of it is to create a new entrypoint - synapse.app.worker, maybe - which is yet another copy of the existing entrypoints. Then we can deprecate the old names.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-WorkersProblems related to running Synapse in Worker Mode (or replication)O-OccasionalAffects or can be seen by some users regularly or most users rarelyS-MinorBlocks non-critical functionality, workarounds exist.T-TaskRefactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions