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

Update deprecated fields #76

Conversation

PassiveModding
Copy link
Contributor

This addresses the following change to jetstream which deprecates the type fields. As of today the fields are no longer present on the events

bluesky-social/jetstream#7

This change updates the event struct to be more human-readable now that we support compression and don't need to save characters as greedily.

Motivation behind this change is to make the event stream readable for someone without having to go lookup docs on event structure. Some existing fields have been a bit cryptic with naming and with value abbreviations, making the stream less understandable to new developers.

Deprecated fields:

* `event.type` -> `event.kind`
  
  * `com, id, acc` -> `commit, identity, account`

* `commit.type` -> `commit.operation`
  
  * `c, u, d` -> `create, update, delete`

To support backwards compatibility for a brief window, the old fields and values will still be emitted during a migration window.

bluesky-social/jetstream#13

Copy link
Owner

@drasticactions drasticactions left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@drasticactions drasticactions merged commit b3a7f0b into drasticactions:develop Nov 1, 2024
3 checks passed
drasticactions pushed a commit that referenced this pull request Nov 4, 2024
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