getsentry / sentry-kafka-schemas

https://getsentry.github.io/sentry-kafka-schemas/
Other
4 stars 1 forks source link

feat(issue-search): Add first_release_id to the group_attributes kafka schema #286

Closed snigdhas closed 3 months ago

snigdhas commented 3 months ago

Update the schema to handle the new group_first_release_id column added to GroupAttributes in https://github.com/getsentry/snuba/pull/5986

github-actions[bot] commented 3 months ago

versions in use:

The following repositories use one of the schemas you are editing. It is recommended to roll out schema changes in small PRs, meaning that if those used versions lag behind the latest, it is probably best to update those services before rolling out your change.

latest version: 0.1.90

changes considered breaking **schemas/group-attributes.v1.schema.json** - Added a new property, but the consumer has been ignoring additional properties so far. This is probably still fine, but please double-check that the producer does not already send this property with a different type in practice than you defined in this schema. ``` {"path": "", "change": {"PropertyAdd": {"lhs_additional_properties": true, "added": "first_release_id"}}} ```

⚠️ This PR contains breaking changes. Normally you should avoid that and make your consumer backwards-compatible (meaning that updated consumers can still accept old messages). There are a few exceptions:

evanh commented 3 months ago

@snigdhas Why is this a breaking change? Can you look into that failure?

lynnagara commented 3 months ago

@evanh it's technically breaking change because additionalProperties was set to true before, and thus there may have been messages with this key and a different type earlier that were considered valid. But if you know were never sending first_release_id as something else before, you're fine.

snigdhas commented 3 months ago

But if you know were never sending first_release_id as something else before, you're fine

Yep, brand new column on the GroupAttributes table (added here) and hasn't been included in the messages.

lynnagara commented 3 months ago

the json-schema-diff job is set up to fail on breaking changes as a warning but is not required, feel free to merge through that particular failure