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-24.1: apply: fix initial snapshot assertion #131522

Merged
merged 1 commit into from
Sep 30, 2024

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Sep 27, 2024

Backport 1/1 commits from #131503 on behalf of @pav-kv.

/cc @cockroachdb/release


The broad assertion here is that all the entries composing a snapshot must have been applied by someone before (at least the sender of the snapshot has done it, otherwise it couldn’t have sent this snapshot).

And then there is an additional assertion (which failed occasionally before this PR) that there can’t be a snapshot without at least one entry applied. This is generally true, except that there are entries not registered by the "apply" stack: particularly, empty entries that raft leader appends at the start of its term. There is a comment to this extent in the asserter.go code:

// INVARIANT: all commands have a command ID. etcd/raft may commit noop
// proposals on leader changes that do not have a command ID, but we skip
// these during application.
if len(cmdID) == 0 {
fail("applied command without ID")
}

This commit modifies the snapshot assertion to correctly handle this case. It is possible that an initial snapshot sent from leader to followers contains only this dummy entry, and there were no "real" proposals applied.

Fixes the false assertion failure in #118471 (comment)
Related to #116319


Release justification: test deflake

The broad assertion here is that all the entries composing a snapshot
must have been applied by someone before (at least the sender of the
snapshot has done it, otherwise it couldn’t have sent this snapshot).

And then there is an additional assertion (which failed occasionally
before this PR) that there can’t be a snapshot without at least one
entry applied. This is generally true, except that there are entries not
registered by the "apply" stack: particularly, empty entries that raft
leader appends at the start of its term. There is a comment to this
extent in the `asserter.go` code:

https://github.com/cockroachdb/cockroach/blob/5b0371b44009ac2ae3f58ea7ed95b290dd4e8227/pkg/kv/kvserver/apply/asserter.go#L254-L259

This commit modifies the snapshot assertion to correctly handle this
case. It is possible that an initial snapshot sent from leader to
followers contains only this dummy entry, and there were no "real"
proposals applied.

Epic: none
Release note: none
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Sep 27, 2024
Copy link
Author

blathers-crl bot commented Sep 27, 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. 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 requested review from arulajmani, pav-kv and tbg September 27, 2024 17:07
@blathers-crl blathers-crl bot added the backport Label PR's that are backports to older release branches label Sep 27, 2024
Copy link
Author

blathers-crl bot commented Sep 27, 2024

It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR?

🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@pav-kv pav-kv merged commit 8194661 into release-24.1 Sep 30, 2024
19 of 20 checks passed
@pav-kv pav-kv deleted the blathers/backport-release-24.1-131503 branch September 30, 2024 17:47
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.

3 participants