Skip to content

Document missing server config options#18122

Merged
MadLittleMods merged 6 commits intodevelopfrom
madlittlemods/document-missing-server-config
Feb 12, 2025
Merged

Document missing server config options#18122
MadLittleMods merged 6 commits intodevelopfrom
madlittlemods/document-missing-server-config

Conversation

@MadLittleMods
Copy link
Copy Markdown
Contributor

@MadLittleMods MadLittleMods commented Jan 31, 2025

I was looking into the USE_FROZEN_DICTS option during the review of #18103 (comment) and noticed that there are several other server config options that aren't in the docs.

Dev notes

self.daemonize = bool(config.get("daemonize"))
self.print_pidfile = bool(config.get("print_pidfile"))
self.user_agent_suffix = config.get("user_agent_suffix")
self.use_frozen_dicts = config.get("use_frozen_dicts", False)

manhole = config.get("manhole")

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Code style is correct
    (run the linters)

Comment thread synapse/events/__init__.py
Comment thread synapse/events/__init__.py
@github-actions github-actions Bot deployed to PR Documentation Preview January 31, 2025 21:06 Active
@github-actions github-actions Bot deployed to PR Documentation Preview January 31, 2025 21:11 Active
@MadLittleMods MadLittleMods marked this pull request as ready for review February 3, 2025 16:52
@MadLittleMods MadLittleMods requested a review from a team as a code owner February 3, 2025 16:52
@MadLittleMods MadLittleMods merged commit 0b1830b into develop Feb 12, 2025
@MadLittleMods MadLittleMods deleted the madlittlemods/document-missing-server-config branch February 12, 2025 17:16
@MadLittleMods
Copy link
Copy Markdown
Contributor Author

Thanks for the review @erikjohnston 🦡

MadLittleMods added a commit that referenced this pull request Apr 24, 2026
…19711)

Known problems: #18117

As a follow-up, we should consider removing this config option
altogether. It's "expensive" and claims to "prevent bugs" but actually
introduces a whole new class of bugs. It could be re-introduced with a
more holistic solution to the typing. Or a completely new approach (safe
mode that blows up when someone mutates the event content, always make
deep clones when handing out references, etc)

The `use_frozen_dict` config option was there [since
inception](a7b65bd)
but was only recently
[documented](#18122) for
completeness sake.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants