Fix JSON representation of Comment to indicate UTC

The default behavior of Gson[1] discards timezone when writing out
Timestamps, producing a string like "Jun 22, 2015 10:11:00 AM" in the
writtenOn field of Comment. This has at least two major problems:

* It uses the local timezone of the server at comment creation time, so
  unless we are absolutely sure of the server's timezone at that time,
  we don't know the absolute instant it's referring to.
* The representation may be ambiguous, because during the 25-hour
  transition away from DST, there are 2 of some times.

Work around this situation by using a new TypeAdapter that stores
timestamps as ISO 8601 instants in UTC time, like
"2015-06-22T17:11:00Z". UTC by definition does not undergo DST, so this
representation unambiguously refers to a single instant.

This format is carefully chosen as one that is known[2] to be readable
by the existing default Gson type adapter. This allows us to start
writing the new format in a multi-master setup in a single update, since
the code to read the new format is already present.

There may be reasons that this new format is not completely ideal; for
example, it still does not record the server's (or perhaps the end
user's) timezone at the time the comment was created. It is explicitly
chosen for ease of use with our specific Gson implementation (though
it is an ISO format, so it's not completely unreasonable). Then again,
the old format was "chosen" for ease of use with Gson, so the new format
is no worse in that regard.

Write some careful tests based on some real-world data of a comment in
ReviewDb on gerrit-review that was added during the US/Pacific DST
transition in 2013[3]. The tests refer to the specific raw value in ms
that I pulled from ReviewDb, and the specific JSON serialization of that
value stored in NoteDb.

[1] http://static.javadoc.io/com.google.code.gson/gson/2.8.0/com/google/gson/GsonBuilder.html
[2] https://github.com/google/gson/issues/650#issuecomment-114298460
[3] https://gerrit-review.googlesource.com/51341

Bug: Issue 5489
Change-Id: I62eb01ac33f609604b2cbd28ea194807559854ce
3 files changed
tree: 22a48195c6aa5af3efad87b69257cd3f4c01059e
  1. .settings/
  2. contrib/
  3. Documentation/
  4. gerrit-acceptance-framework/
  5. gerrit-acceptance-tests/
  6. gerrit-antlr/
  7. gerrit-cache-h2/
  8. gerrit-common/
  9. gerrit-elasticsearch/
  10. gerrit-extension-api/
  11. gerrit-gpg/
  12. gerrit-gwtdebug/
  13. gerrit-gwtexpui/
  14. gerrit-gwtui/
  15. gerrit-gwtui-common/
  16. gerrit-httpd/
  17. gerrit-launcher/
  18. gerrit-lucene/
  19. gerrit-main/
  20. gerrit-oauth/
  21. gerrit-openid/
  22. gerrit-patch-commonsnet/
  23. gerrit-patch-jgit/
  24. gerrit-pgm/
  25. gerrit-plugin-api/
  26. gerrit-plugin-gwtui/
  27. gerrit-prettify/
  28. gerrit-reviewdb/
  29. gerrit-server/
  30. gerrit-sshd/
  31. gerrit-test-util/
  32. gerrit-util-cli/
  33. gerrit-util-http/
  34. gerrit-util-ssl/
  35. gerrit-war/
  36. lib/
  37. plugins/
  38. polygerrit-ui/
  39. ReleaseNotes/
  40. tools/
  41. website/
  42. .bazelproject
  43. .editorconfig
  44. .gitignore
  45. .gitmodules
  46. .mailmap
  47. .pydevproject
  48. BUILD
  49. COPYING
  50. INSTALL
  51. README.md
  52. SUBMITTING_PATCHES
  53. version.bzl
  54. WORKSPACE
README.md

Gerrit Code Review

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

Build Status

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 IRC channel on freenode is #gerrit. An archive is available at: echelog.com.

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 --recursive 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 7 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-centos7[:version]

To run a Ubuntu 15.04 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-ubuntu15.04[:version]

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