Skip to content

Document that Message is not exact #4121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

rk-for-zulip
Copy link
Contributor

This has come up in conversation more than once, and should probably be noted in the code.

We don't do anywhere near enough validation of data from the Zulip
server. Make a note of this in the definition of `Message`, lest it be
marked exact.
`Message` itself isn't exact (q.v.). This isn't much of a problem,
since we don't ever construct `Message` values... except in tests.

Tighten the typing on our `Message`-creation helpers to only accept
values that are documented to be part of `Message`.

Fix the (fortunately harmless) bug which this catches in the outbox-
reducer tests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant