Allow submission of changes when the index record is stale

The Gerrit change index is a way to find changes and is not guaranteed
to be aligned in real-time with the underlying change NoteDb status.

When a change index entry is stale, but the change is submittable,
Gerrit just executed a cycle of retries, hoping that the index would
become aligned within the retry period.

Introduce change.backfillMergeSuperSet for allowing the backfill
of change data from NoteDb when a stale change index is preventing
the submit to succeeed.
By default, the backfill does not happen and the submit is retried
multiple times, waiting for the change index be aligned.

By looking at the code, the change to be submitted is looked up in the
change index by project/branch/version-sha1, to obtain the same
ChangeData again from the index in the byCommitsOnBranchNotMerged()
method; whilst the need to look up changes by
project/branch/version-sha1 is mandatory for the dependent changes, it
isn't for the change to be merged.

When executing the logic to merge a change from the
completeWithoutTopic() path, the change-set to be merged is passed as
input parameter and therefore is already known. The use of the index to
find the same ChangeData from a potentially stale change index lookup is
unneeded and, in the best-case scenario, would result in returning the
same data that already exists in memory.

Use the input ChangeSet to backfill the set of changes to be
merged, so that if the change is found in the index, the looked-up entry
is still returned, but if that isn't present because of a stale index,
the merge can still be completed with the information already known.

The case of a temporary stale index is real and can happen in three
configurations:

1. Single Gerrit primary node, with index.indexChangesAsync=true
2. Gerrit HA with more than one Gerrit primary node, when the submit
   happens on the secondary node
3. Gerrit Multi-Site, where the submission happens on a different site
   compared to the one that has received the latest patch-set update.

NOTE: In case of 3, if the node executing the submission isn't
up-to-date with the global-refdb, the ref-update would fail anyway, so
it is still safe to try to execute the submit operation without the risk
to run into a split-brain situation.

Bug: Issue 456521736
Release-Notes: Avoid change N missing from ChangeSet[][] when submitting a change with a stale index entry
Change-Id: I61db3e2b4526be42e4c902ae6ee7e7b9e7bff809
6 files changed
tree: 4b2aa6d4134cc6acfa4c50a7a4a5ecc0ec85905b
  1. .settings/
  2. .ts-out/
  3. antlr3/
  4. contrib/
  5. Documentation/
  6. e2e-tests/
  7. java/
  8. javatests/
  9. lib/
  10. modules/
  11. plugins/
  12. polygerrit-ui/
  13. prolog/
  14. prologtests/
  15. proto/
  16. resources/
  17. tools/
  18. webapp/
  19. .bazelignore
  20. .bazelproject
  21. .bazelrc
  22. .bazelversion
  23. .editorconfig
  24. .git-blame-ignore-revs
  25. .gitignore
  26. .gitmodules
  27. .gitreview
  28. .mailmap
  29. .pydevproject
  30. .zuul.yaml
  31. BUILD
  32. COPYING
  33. INSTALL
  34. Jenkinsfile
  35. MODULE.bazel
  36. package.json
  37. README.md
  38. SUBMITTING_PATCHES
  39. version.bzl
  40. web-dev-server.config.mjs
  41. WORKSPACE
  42. yarn.lock
README.md

Gerrit Code Review

Gerrit is a code review and project management tool for Git based projects.

Build Status Maven Central

Objective

Gerrit makes reviews easier by showing changes in a side-by-side display, and allowing inline comments to be added by any reviewer.

Gerrit simplifies Git based project maintainership by permitting any authorized user to submit changes to the master Git repository, rather than requiring all approved changes to be merged in by hand by the project maintainer.

Documentation

For information about how to install and use Gerrit, refer to the documentation.

Source

Our canonical Git repository is located on googlesource.com. There is a mirror of the repository on Github.

Reporting bugs

Please report bugs on the issue tracker.

Contribute

Gerrit is the work of hundreds of contributors. We appreciate your help!

Please read the contribution guidelines.

Note that we do not accept Pull Requests via the Github mirror.

Getting in contact

The Developer Mailing list is repo-discuss on Google Groups.

License

Gerrit is provided under the Apache License 2.0.

Build

Install Bazel and run the following:

    git clone --recurse-submodules https://gerrit.googlesource.com/gerrit
    cd gerrit && bazel build release

Install binary packages (Deb/Rpm)

The instruction how to configure GerritForge/BinTray repositories is here

On Debian/Ubuntu run:

    apt-get update && apt-get install gerrit=<version>-<release>

NOTE: release is a counter that starts with 1 and indicates the number of packages that have been released with the same version of the software.

On CentOS/RedHat run:

    yum clean all && yum install gerrit-<version>[-<release>]

On Fedora run:

    dnf clean all && dnf install gerrit-<version>[-<release>]

Use pre-built Gerrit images on Docker

Docker images of Gerrit are available on DockerHub

To run a CentOS 8 based Gerrit image:

    docker run -p 8080:8080 gerritcodereview/gerrit[:version]-centos8

To run a Ubuntu 20.04 based Gerrit image:

    docker run -p 8080:8080 gerritcodereview/gerrit[:version]-ubuntu20

NOTE: release is optional. Last released package of the version is installed if the release number is omitted.