Fix threading issue in Diff cache

We have observed occasional failures in computing diffs. The
computation fails with a Zlib exception making it look like
the pack file is currupted. Fsck, however, tells that the
pack file is fine.

Upon closer investigation, it seems like there is a case
in the diff cache were we process on a different thread
and cancel in case of a timeout. The objects we pass
around (ObjectReader and DiffFormatter) are not thread safe.

The JavaDoc of ObjectReader states that it is not thread
safe and the Dfs implementation restates that. Checking
the implementation also shows that it's not thread safe
since it uses member variables to store intermediary
results. Other implementations might be thread safe, but
if the abstract class doesn't guarantee that, we can't
rely on it.

In Java, a timeout of a future does not guarantee to
have actually terminated the work item when it occurs. So
there could be a situation where the work item has timed out,
but we are still processing anyway. The main thread then
continues to process a different diff in a different region
of the pack. The reused ObjectReader then gets confused as
it races to read different parts of the pack.

This is an attempt to fix the problem by using a pool to
share DiffFormatter instances. DiffFormatters that are closed
will be returned to the pool. If the pool itself is already
closed, the a close call to the DiffFormatter's wrapper
(Handle) will propagate to the DiffFormatter and consequently
the ObjectReader). Closing the pool will close any resources
currently in the pool.

We run into this problem, because the diff cache uses getAll
which sequentially loads many diffs for a single request.

Google-Bug-Id: b/209491483
Release-Notes: Fix threading issue in diff cache
Change-Id: I51bd1a73f573feab0eb58f825f28024852c17e47
(cherry picked from commit 4f5f8c7e80788b168a3a5d74568198d894019de4)
3 files changed
tree: d649099986b92b5ff621f31398794551e7598eee
  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. package.json
  36. README.md
  37. SUBMITTING_PATCHES
  38. version.bzl
  39. WORKSPACE
  40. 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.