Skip to content
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

Handle updated streams (stream op: update events) #182

Open
chrisbobbe opened this issue Jun 14, 2023 · 3 comments
Open

Handle updated streams (stream op: update events) #182

chrisbobbe opened this issue Jun 14, 2023 · 3 comments
Labels
a-api Implementing specific parts of the Zulip server API a-model Implementing our data model (PerAccountStore, etc.)

Comments

@chrisbobbe
Copy link
Collaborator

Part of #135.

https://zulip.com/api/get-events#stream-update

Handling created/deleted streams (stream op: create / stream op: delete) is #181.

I expect this will involve updating both our store.streams and store.subscriptions data structures.

@chrisbobbe chrisbobbe added a-api Implementing specific parts of the Zulip server API a-model Implementing our data model (PerAccountStore, etc.) labels Jun 14, 2023
@chrisbobbe
Copy link
Collaborator Author

I'm not sure how best to represent the type of this event; see in the doc, for example, value: integer | boolean | string.

@chrisbobbe chrisbobbe added this to the Beta milestone Jun 14, 2023
chrisbobbe added a commit to chrisbobbe/zulip-flutter that referenced this issue Jun 14, 2023
(Handling `op: update` events is zulip#182, as mentioned in the TODOs.)
chrisbobbe added a commit to chrisbobbe/zulip-flutter that referenced this issue Jun 14, 2023
@chrisbobbe
Copy link
Collaborator Author

chrisbobbe commented Jun 14, 2023

Ah: removing this from the "beta" milestone until we make that choice explicitly for this event type. From Greg's comment on the umbrella issue #135 (comment) :

I've given this the "beta" milestone, but there may be specific events we decide can wait for launch or even beyond. What's needed for beta is really just that we should look at the list and make any such choice explicitly.

@chrisbobbe chrisbobbe removed this from the Beta milestone Jun 14, 2023
chrisbobbe added a commit to chrisbobbe/zulip-flutter that referenced this issue Jun 14, 2023
(Handling `op: update` events is zulip#182, as mentioned in the TODOs.)
chrisbobbe added a commit to chrisbobbe/zulip-flutter that referenced this issue Jun 14, 2023
gnprice pushed a commit to chrisbobbe/zulip-flutter that referenced this issue Jun 14, 2023
(Handling `op: update` events is zulip#182, as mentioned in the TODOs.)
gnprice pushed a commit to chrisbobbe/zulip-flutter that referenced this issue Jun 14, 2023
@gnprice gnprice added this to the Beta milestone Sep 14, 2023
@gnprice gnprice modified the milestones: Beta, Launch Sep 22, 2023
sirpengi added a commit to sirpengi/zulip-flutter that referenced this issue Nov 14, 2023
The properties of Subscription are a superset of ZulipStream
properties. Unfortunately this means there are duplicate
fields (such as the stream name) that live in two places and
there is no mechanism yet to synchronize them (that is work
left for zulip#182). This change makes is clearer which
properties of Subscription are specific to subscriptions.
sirpengi added a commit to sirpengi/zulip-flutter that referenced this issue Nov 14, 2023
The properties of Subscription are a superset of ZulipStream
properties. Unfortunately this means there are duplicate
fields (such as the stream name) that live in two places and
there is no mechanism yet to synchronize them (that is work
left for zulip#182). This change makes is clearer which
properties of Subscription are specific to subscriptions.
@gnprice gnprice modified the milestones: Launch, B2: Summer 2024 May 9, 2024
@gnprice
Copy link
Member

gnprice commented Jun 27, 2024

I'm not sure how best to represent the type of this event; see in the doc, for example, value: integer | boolean | string.

Update: a couple of months after this comment, we added UserSettingsUpdateEvent, which has a very similar pattern in the API:
https://zulip.com/api/get-events#user_settings-update
and we worked out a pattern for handling that which we're pretty happy with. So for adding StreamUpdateEvent, let's follow that pattern.

To see all the different pieces of that pattern, see commits 9cb2e4d and 4bcbffd (both from #261). I think a good PR for this issue will look a lot like those two commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-api Implementing specific parts of the Zulip server API a-model Implementing our data model (PerAccountStore, etc.)
Projects
Status: No status
Development

No branches or pull requests

2 participants