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

release-23.2: changefeedccl: fix bug with avro encoding and zero-scale decimal cols #118847

Merged
merged 1 commit into from Feb 7, 2024

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Feb 6, 2024

Backport 1/1 commits from #118815 on behalf of @andyyang890.

/cc @cockroachdb/release


This patch fixes a bug where creating a changefeed that targeted
tables with a DECIMAL(n) column (i.e. zero-scale DECIMAL column),
format='avro', and diff would cause a panic.

The cause of this panic was the fact that the third-party goavro
library we use expected the JSON encoding of the schema to have
a numeric scale field for decimal types, but we omitted this
field whenever it was zero (using omitempty), which led to a
runtime type assertion failure. We've updated the field to a pointer
type in our type definition so that we can distinguish between an
unset value and a zero value.

Fixes #118647

Release note (enterprise change): Fixed a bug where creating a
changefeed that targeted tables with a DECIMAL(n) column
(i.e. zero-scale DECIMAL column), format='avro', and diff
would cause a panic.


Release justification: low-risk, high-priority bug fix

This patch fixes a bug where creating a changefeed that targeted
tables with a `DECIMAL(n)` column (i.e. zero-scale `DECIMAL` column),
`format='avro'`, and `diff` would cause a panic.

The cause of this panic was the fact that the third-party `goavro`
library we use expected the JSON encoding of the schema to have
a numeric `scale` field for decimal types, but we omitted this
field whenever it was zero (using `omitempty`), which led to a
runtime type assertion failure. We've updated the field to a pointer
type in our type definition so that we can distinguish between an
unset value and a zero value.

Release note (enterprise change): Fixed a bug where creating a
changefeed that targeted tables with a `DECIMAL(n)` column
(i.e. zero-scale `DECIMAL` column), `format='avro'`, and `diff`
would cause a panic.
@blathers-crl blathers-crl bot requested a review from a team as a code owner February 6, 2024 19:42
@blathers-crl blathers-crl bot removed the request for review from a team February 6, 2024 19:42
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-23.2-118815 branch from d2a72ae to e2eafe7 Compare February 6, 2024 19:42
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Feb 6, 2024
Copy link
Author

blathers-crl bot commented Feb 6, 2024

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Backports should only be created for serious
    issues
    or test-only changes.
  • Backports should not break backwards-compatibility.
  • Backports should change as little code as possible.
  • Backports should not change on-disk formats or node communication protocols.
  • Backports should not add new functionality (except as defined
    here).
  • Backports must not add, edit, or otherwise modify cluster versions; or add version gates.
  • All backports must be reviewed by the owning areas TL and one additional
    TL. For more information as to how that review should be conducted, please consult the backport
    policy
    .
If your backport adds new functionality, please ensure that the following additional criteria are satisfied:
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters. State changes must be further protected such that nodes running old binaries will not be negatively impacted by the new state (with a mixed version test added).
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.
  • Your backport must be accompanied by a post to the appropriate Slack
    channel (#db-backports-point-releases or #db-backports-XX-X-release) for awareness and discussion.

Also, please add a brief release justification to the body of your PR to justify this
backport.

@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Feb 6, 2024
@cockroach-teamcity
Copy link
Member

This change is Reviewable

Copy link
Collaborator

@rharding6373 rharding6373 left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @andyyang890, @jayshrivastava, @nicktrav, @rafiss, and @wenyihu6)

@andyyang890 andyyang890 merged commit c93ad40 into release-23.2 Feb 7, 2024
5 of 6 checks passed
@andyyang890 andyyang890 deleted the blathers/backport-release-23.2-118815 branch February 7, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Label PR's that are backports to older release branches blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants