Merge branch 'stable-3.4' into stable-3.5 * stable-3.4: Align delete refs to the rest of Gerrit Release-Notes: skip Change-Id: Ide7432445a82dd30a4c8a50a69b75cba58eaeae3
diff --git a/.bazelproject b/.bazelproject index a7f5450..ad7b022 100644 --- a/.bazelproject +++ b/.bazelproject
@@ -16,7 +16,7 @@ targets: //...:all -java_language_level: 8 +java_language_level: 11 workspace_type: java
diff --git a/.bazelrc b/.bazelrc index 4117994..8cf525c 100644 --- a/.bazelrc +++ b/.bazelrc
@@ -2,7 +2,33 @@ build --repository_cache=~/.gerritcodereview/bazel-cache/repository build --action_env=PATH build --disk_cache=~/.gerritcodereview/bazel-cache/cas -build --java_toolchain=//tools:error_prone_warnings_toolchain + +# Builds using remotejdk_11, executes using remotejdk_11 or local_jdk +build --java_language_version=11 +build --java_runtime_version=remotejdk_11 +build --tool_java_language_version=11 +build --tool_java_runtime_version=remotejdk_11 + +# Builds using remotejdk_17, executes using remotejdk_17 or local_jdk +build:java17 --java_language_version=17 +build:java17 --java_runtime_version=remotejdk_17 +build:java17 --tool_java_language_version=17 +build:java17 --tool_java_runtime_version=remotejdk_17 + +# Builds and executes on RBE using remotejdk_11 +build:remote --java_language_version=11 +build:remote --java_runtime_version=remotejdk_11 +build:remote --tool_java_language_version=11 +build:remote --tool_java_runtime_version=remotejdk_11 + +# Builds and executes on RBE using remotejdk_17 +build:remote17 --java_language_version=17 +build:remote17 --java_runtime_version=remotejdk_17 +build:remote17 --tool_java_language_version=17 +build:remote17 --tool_java_runtime_version=remotejdk_17 + +# workaround for https://github.com/bazelbuild/bazel/issues/17956 on MacOS 13.3 and XCode 14.3 +build --host_conlyopt=-std=c90 # Enable strict_action_env flag to. For more information on this feature see # https://groups.google.com/forum/#!topic/bazel-discuss/_VmRfMyyHBk. @@ -15,6 +41,6 @@ test --build_tests_only test --test_output=errors -test --java_toolchain=//tools:error_prone_warnings_toolchain +test --java_toolchain=//tools:error_prone_warnings_toolchain_java11 import %workspace%/tools/remote-bazelrc
diff --git a/.bazelversion b/.bazelversion index af8c8ec..c7cb131 100644 --- a/.bazelversion +++ b/.bazelversion
@@ -1 +1 @@ -4.2.2 +5.3.1
diff --git a/.gitignore b/.gitignore index 00a6217..95f94ba 100644 --- a/.gitignore +++ b/.gitignore
@@ -32,7 +32,13 @@ /node_modules/ /package-lock.json /plugins/* +!/plugins/.eslintignore +!/plugins/.eslintrc.js +!/plugins/.prettierrc.js !/plugins/package.json +!/plugins/rollup.config.js +!/plugins/tsconfig.json +!/plugins/tsconfig-plugins-base.json !/plugins/yarn.lock !/plugins/BUILD !/plugins/codemirror-editor
diff --git a/.gitmodules b/.gitmodules index e5eef1e..6217b4d 100644 --- a/.gitmodules +++ b/.gitmodules
@@ -20,7 +20,7 @@ [submodule "plugins/download-commands"] path = plugins/download-commands url = ../plugins/download-commands - branch = . + branch = master [submodule "plugins/gitiles"] path = plugins/gitiles
diff --git a/.settings/org.eclipse.jdt.core.prefs b/.settings/org.eclipse.jdt.core.prefs index 8efbd11..09ce63b 100644 --- a/.settings/org.eclipse.jdt.core.prefs +++ b/.settings/org.eclipse.jdt.core.prefs
@@ -10,9 +10,9 @@ org.eclipse.jdt.core.compiler.annotation.nullanalysis=disabled org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled org.eclipse.jdt.core.compiler.codegen.methodParameters=do not generate -org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8 +org.eclipse.jdt.core.compiler.codegen.targetPlatform=11 org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve -org.eclipse.jdt.core.compiler.compliance=1.8 +org.eclipse.jdt.core.compiler.compliance=11 org.eclipse.jdt.core.compiler.debug.lineNumber=generate org.eclipse.jdt.core.compiler.debug.localVariable=generate org.eclipse.jdt.core.compiler.debug.sourceFile=generate @@ -29,6 +29,7 @@ org.eclipse.jdt.core.compiler.problem.deprecationWhenOverridingDeprecatedMethod=disabled org.eclipse.jdt.core.compiler.problem.discouragedReference=warning org.eclipse.jdt.core.compiler.problem.emptyStatement=warning +org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled org.eclipse.jdt.core.compiler.problem.enumIdentifier=error org.eclipse.jdt.core.compiler.problem.explicitlyClosedAutoCloseable=warning org.eclipse.jdt.core.compiler.problem.fallthroughCase=warning @@ -87,6 +88,7 @@ org.eclipse.jdt.core.compiler.problem.redundantSuperinterface=ignore org.eclipse.jdt.core.compiler.problem.reportMethodCanBePotentiallyStatic=ignore org.eclipse.jdt.core.compiler.problem.reportMethodCanBeStatic=ignore +org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning org.eclipse.jdt.core.compiler.problem.specialParameterHidingField=disabled org.eclipse.jdt.core.compiler.problem.staticAccessReceiver=warning org.eclipse.jdt.core.compiler.problem.suppressOptionalErrors=disabled @@ -126,4 +128,5 @@ org.eclipse.jdt.core.compiler.problem.unusedWarningToken=warning org.eclipse.jdt.core.compiler.problem.varargsArgumentNeedCast=warning org.eclipse.jdt.core.compiler.processAnnotations=enabled -org.eclipse.jdt.core.compiler.source=1.8 +org.eclipse.jdt.core.compiler.release=enabled +org.eclipse.jdt.core.compiler.source=11
diff --git a/.zuul.yaml b/.zuul.yaml index da200b8..d6dbc34 100644 --- a/.zuul.yaml +++ b/.zuul.yaml
@@ -8,9 +8,6 @@ (i.e., builds of Gerrit itself or plugins) on this branch. required-projects: - jgit - # Remove java_version variable when merging up to master - vars: - java_version: 8 - job: name: gerrit-build
diff --git a/BUILD b/BUILD index 084d383..9633c0f 100644 --- a/BUILD +++ b/BUILD
@@ -4,16 +4,9 @@ package(default_visibility = ["//visibility:public"]) config_setting( - name = "java11", + name = "java17", values = { - "java_toolchain": "@bazel_tools//tools/jdk:toolchain_java11", - }, -) - -config_setting( - name = "java_next", - values = { - "java_toolchain": "//tools:toolchain_vanilla", + "java_language_version": "17", }, )
diff --git a/Documentation/BUILD b/Documentation/BUILD index 11d3efa..af355ca 100644 --- a/Documentation/BUILD +++ b/Documentation/BUILD
@@ -53,6 +53,14 @@ ) license_map( + name = "backend_licenses", + opts = ["--asciidoctor"], + targets = [ + "//java/com/google/gerrit/pgm", + ], +) + +license_map( name = "js_licenses", json_maps = [ "//polygerrit-ui/app/node_modules_licenses:polygerrit-licenses.json", @@ -66,6 +74,8 @@ name = "check_licenses", srcs = ["check_licenses_test.sh"], data = [ + "backend_licenses.gen.txt", + "backend_licenses.txt", "js_licenses.gen.txt", "js_licenses.txt", "licenses.gen.txt",
diff --git a/Documentation/access-control.txt b/Documentation/access-control.txt index 2a019ca..3da69df 100644 --- a/Documentation/access-control.txt +++ b/Documentation/access-control.txt
@@ -477,6 +477,11 @@ `+refs/heads/sandbox/${username}/*+`. If you do, it's also recommended you grant the users the push force permission to be able to clean up stale branches. +If link:config-gerrit.html#auth.userNameCaseInsensitive[auth.userNameCaseInsensitive] +is enabled, the `${username}` is still case sensitive and will use +the capitalization used during account creation. This is done, since +git branches are case sensitive, so that sandbox branches containing +`${username}` are still reachable by the users. [[category_delete]] === Delete Reference
diff --git a/Documentation/backend_licenses.txt b/Documentation/backend_licenses.txt new file mode 100755 index 0000000..586406f --- /dev/null +++ b/Documentation/backend_licenses.txt
@@ -0,0 +1,3157 @@ += Gerrit Code Review - Licenses + +// DO NOT EDIT - GENERATED AUTOMATICALLY. + +Gerrit open source software is licensed under the <<Apache2_0,Apache +License 2.0>>. Executable distributions also include other software +components that are provided under additional licenses. + +[[cryptography]] +== Cryptography Notice + +This distribution includes cryptographic software. The country +in which you currently reside may have restrictions on the import, +possession, use, and/or re-export to another country, of encryption +software. BEFORE using any encryption software, please check +your country's laws, regulations and policies concerning the +import, possession, or use, and re-export of encryption software, +to see if this is permitted. See the +link:http://www.wassenaar.org/[Wassenaar Arrangement] +for more information. + +The U.S. Government Department of Commerce, Bureau of Industry +and Security (BIS), has classified this software as Export +Commodity Control Number (ECCN) 5D002.C.1, which includes +information security software using or performing cryptographic +functions with asymmetric algorithms. The form and manner of +this distribution makes it eligible for export under the License +Exception ENC Technology Software Unrestricted (TSU) exception +(see the BIS Export Administration Regulations, Section 740.13) +for both object code and source code. + +Gerrit includes an SSH daemon (Apache SSHD), to support authenticated +uploads of changes directly from `git push` command line clients. + +Gerrit includes an SSH client (JSch), to support authenticated +replication of changes to remote systems, such as for automatic +updates of mirror servers, or realtime backups. + +== Licenses + + +[[Apache2_0]] +Apache2.0 + +* auto:auto-value +* auto:auto-value-annotations +* auto:auto-value-gson +* commons:codec +* commons:compress +* commons:dbcp +* commons:lang +* commons:lang3 +* commons:net +* commons:pool +* commons:validator +* dropwizard:dropwizard-core +* errorprone:annotations +* flogger:api +* guice:guice +* guice:guice-assistedinject +* guice:guice-library +* guice:guice-servlet +* guice:javax_inject +* httpcomponents:httpclient +* httpcomponents:httpcore +* jetty:http +* jetty:io +* jetty:jmx +* jetty:security +* jetty:server +* jetty:servlet +* jetty:util +* jetty:util-ajax +* log:log4j +* lucene:lucene-analyzers-common +* lucene:lucene-core-and-backward-codecs-merged +* lucene:lucene-misc +* lucene:lucene-queryparser +* mime4j:core +* mime4j:dom +* mina:core +* mina:sshd +* mina:sshd-sftp +* openid:consumer +* openid:nekohtml +* openid:xerces +* blame-cache +* caffeine +* caffeine-guava +* gson +* guava +* guava-failureaccess +* guava-retrying +* html-types +* j2objc +* javaewah +* jsr305 +* mime-util +* servlet-api +* servlet-api-without-neverlink +* soy + +[[Apache2_0_license]] +---- + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +---- + + +[[CC0-1_0]] +CC0-1.0 + +* mina:eddsa + +[[CC0-1_0_license]] +---- +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. + +For more information, please see https://creativecommons.org/publicdomain/zero/1.0/ + +---- + + +[[MPL1_1]] +MPL1.1 + +* juniversalchardet + +[[MPL1_1_license]] +---- + MOZILLA PUBLIC LICENSE + Version 1.1 + + --------------- + +1. Definitions. + + 1.0.1. "Commercial Use" means distribution or otherwise making the + Covered Code available to a third party. + + 1.1. "Contributor" means each entity that creates or contributes to + the creation of Modifications. + + 1.2. "Contributor Version" means the combination of the Original + Code, prior Modifications used by a Contributor, and the Modifications + made by that particular Contributor. + + 1.3. "Covered Code" means the Original Code or Modifications or the + combination of the Original Code and Modifications, in each case + including portions thereof. + + 1.4. "Electronic Distribution Mechanism" means a mechanism generally + accepted in the software development community for the electronic + transfer of data. + + 1.5. "Executable" means Covered Code in any form other than Source + Code. + + 1.6. "Initial Developer" means the individual or entity identified + as the Initial Developer in the Source Code notice required by Exhibit + A. + + 1.7. "Larger Work" means a work which combines Covered Code or + portions thereof with code not governed by the terms of this License. + + 1.8. "License" means this document. + + 1.8.1. "Licensable" means having the right to grant, to the maximum + extent possible, whether at the time of the initial grant or + subsequently acquired, any and all of the rights conveyed herein. + + 1.9. "Modifications" means any addition to or deletion from the + substance or structure of either the Original Code or any previous + Modifications. When Covered Code is released as a series of files, a + Modification is: + A. Any addition to or deletion from the contents of a file + containing Original Code or previous Modifications. + + B. Any new file that contains any part of the Original Code or + previous Modifications. + + 1.10. "Original Code" means Source Code of computer software code + which is described in the Source Code notice required by Exhibit A as + Original Code, and which, at the time of its release under this + License is not already Covered Code governed by this License. + + 1.10.1. "Patent Claims" means any patent claim(s), now owned or + hereafter acquired, including without limitation, method, process, + and apparatus claims, in any patent Licensable by grantor. + + 1.11. "Source Code" means the preferred form of the Covered Code for + making modifications to it, including all modules it contains, plus + any associated interface definition files, scripts used to control + compilation and installation of an Executable, or source code + differential comparisons against either the Original Code or another + well known, available Covered Code of the Contributor's choice. The + Source Code can be in a compressed or archival form, provided the + appropriate decompression or de-archiving software is widely available + for no charge. + + 1.12. "You" (or "Your") means an individual or a legal entity + exercising rights under, and complying with all of the terms of, this + License or a future version of this License issued under Section 6.1. + For legal entities, "You" includes any entity which controls, is + controlled by, or is under common control with You. For purposes of + this definition, "control" means (a) the power, direct or indirect, + to cause the direction or management of such entity, whether by + contract or otherwise, or (b) ownership of more than fifty percent + (50%) of the outstanding shares or beneficial ownership of such + entity. + +2. Source Code License. + + 2.1. The Initial Developer Grant. + The Initial Developer hereby grants You a world-wide, royalty-free, + non-exclusive license, subject to third party intellectual property + claims: + (a) under intellectual property rights (other than patent or + trademark) Licensable by Initial Developer to use, reproduce, + modify, display, perform, sublicense and distribute the Original + Code (or portions thereof) with or without Modifications, and/or + as part of a Larger Work; and + + (b) under Patents Claims infringed by the making, using or + selling of Original Code, to make, have made, use, practice, + sell, and offer for sale, and/or otherwise dispose of the + Original Code (or portions thereof). + + (c) the licenses granted in this Section 2.1(a) and (b) are + effective on the date Initial Developer first distributes + Original Code under the terms of this License. + + (d) Notwithstanding Section 2.1(b) above, no patent license is + granted: 1) for code that You delete from the Original Code; 2) + separate from the Original Code; or 3) for infringements caused + by: i) the modification of the Original Code or ii) the + combination of the Original Code with other software or devices. + + 2.2. Contributor Grant. + Subject to third party intellectual property claims, each Contributor + hereby grants You a world-wide, royalty-free, non-exclusive license + + (a) under intellectual property rights (other than patent or + trademark) Licensable by Contributor, to use, reproduce, modify, + display, perform, sublicense and distribute the Modifications + created by such Contributor (or portions thereof) either on an + unmodified basis, with other Modifications, as Covered Code + and/or as part of a Larger Work; and + + (b) under Patent Claims infringed by the making, using, or + selling of Modifications made by that Contributor either alone + and/or in combination with its Contributor Version (or portions + of such combination), to make, use, sell, offer for sale, have + made, and/or otherwise dispose of: 1) Modifications made by that + Contributor (or portions thereof); and 2) the combination of + Modifications made by that Contributor with its Contributor + Version (or portions of such combination). + + (c) the licenses granted in Sections 2.2(a) and 2.2(b) are + effective on the date Contributor first makes Commercial Use of + the Covered Code. + + (d) Notwithstanding Section 2.2(b) above, no patent license is + granted: 1) for any code that Contributor has deleted from the + Contributor Version; 2) separate from the Contributor Version; + 3) for infringements caused by: i) third party modifications of + Contributor Version or ii) the combination of Modifications made + by that Contributor with other software (except as part of the + Contributor Version) or other devices; or 4) under Patent Claims + infringed by Covered Code in the absence of Modifications made by + that Contributor. + +3. Distribution Obligations. + + 3.1. Application of License. + The Modifications which You create or to which You contribute are + governed by the terms of this License, including without limitation + Section 2.2. The Source Code version of Covered Code may be + distributed only under the terms of this License or a future version + of this License released under Section 6.1, and You must include a + copy of this License with every copy of the Source Code You + distribute. You may not offer or impose any terms on any Source Code + version that alters or restricts the applicable version of this + License or the recipients' rights hereunder. However, You may include + an additional document offering the additional rights described in + Section 3.5. + + 3.2. Availability of Source Code. + Any Modification which You create or to which You contribute must be + made available in Source Code form under the terms of this License + either on the same media as an Executable version or via an accepted + Electronic Distribution Mechanism to anyone to whom you made an + Executable version available; and if made available via Electronic + Distribution Mechanism, must remain available for at least twelve (12) + months after the date it initially became available, or at least six + (6) months after a subsequent version of that particular Modification + has been made available to such recipients. You are responsible for + ensuring that the Source Code version remains available even if the + Electronic Distribution Mechanism is maintained by a third party. + + 3.3. Description of Modifications. + You must cause all Covered Code to which You contribute to contain a + file documenting the changes You made to create that Covered Code and + the date of any change. You must include a prominent statement that + the Modification is derived, directly or indirectly, from Original + Code provided by the Initial Developer and including the name of the + Initial Developer in (a) the Source Code, and (b) in any notice in an + Executable version or related documentation in which You describe the + origin or ownership of the Covered Code. + + 3.4. Intellectual Property Matters + (a) Third Party Claims. + If Contributor has knowledge that a license under a third party's + intellectual property rights is required to exercise the rights + granted by such Contributor under Sections 2.1 or 2.2, + Contributor must include a text file with the Source Code + distribution titled "LEGAL" which describes the claim and the + party making the claim in sufficient detail that a recipient will + know whom to contact. If Contributor obtains such knowledge after + the Modification is made available as described in Section 3.2, + Contributor shall promptly modify the LEGAL file in all copies + Contributor makes available thereafter and shall take other steps + (such as notifying appropriate mailing lists or newsgroups) + reasonably calculated to inform those who received the Covered + Code that new knowledge has been obtained. + + (b) Contributor APIs. + If Contributor's Modifications include an application programming + interface and Contributor has knowledge of patent licenses which + are reasonably necessary to implement that API, Contributor must + also include this information in the LEGAL file. + + (c) Representations. + Contributor represents that, except as disclosed pursuant to + Section 3.4(a) above, Contributor believes that Contributor's + Modifications are Contributor's original creation(s) and/or + Contributor has sufficient rights to grant the rights conveyed by + this License. + + 3.5. Required Notices. + You must duplicate the notice in Exhibit A in each file of the Source + Code. If it is not possible to put such notice in a particular Source + Code file due to its structure, then You must include such notice in a + location (such as a relevant directory) where a user would be likely + to look for such a notice. If You created one or more Modification(s) + You may add your name as a Contributor to the notice described in + Exhibit A. You must also duplicate this License in any documentation + for the Source Code where You describe recipients' rights or ownership + rights relating to Covered Code. You may choose to offer, and to + charge a fee for, warranty, support, indemnity or liability + obligations to one or more recipients of Covered Code. However, You + may do so only on Your own behalf, and not on behalf of the Initial + Developer or any Contributor. You must make it absolutely clear than + any such warranty, support, indemnity or liability obligation is + offered by You alone, and You hereby agree to indemnify the Initial + Developer and every Contributor for any liability incurred by the + Initial Developer or such Contributor as a result of warranty, + support, indemnity or liability terms You offer. + + 3.6. Distribution of Executable Versions. + You may distribute Covered Code in Executable form only if the + requirements of Section 3.1-3.5 have been met for that Covered Code, + and if You include a notice stating that the Source Code version of + the Covered Code is available under the terms of this License, + including a description of how and where You have fulfilled the + obligations of Section 3.2. The notice must be conspicuously included + in any notice in an Executable version, related documentation or + collateral in which You describe recipients' rights relating to the + Covered Code. You may distribute the Executable version of Covered + Code or ownership rights under a license of Your choice, which may + contain terms different from this License, provided that You are in + compliance with the terms of this License and that the license for the + Executable version does not attempt to limit or alter the recipient's + rights in the Source Code version from the rights set forth in this + License. If You distribute the Executable version under a different + license You must make it absolutely clear that any terms which differ + from this License are offered by You alone, not by the Initial + Developer or any Contributor. You hereby agree to indemnify the + Initial Developer and every Contributor for any liability incurred by + the Initial Developer or such Contributor as a result of any such + terms You offer. + + 3.7. Larger Works. + You may create a Larger Work by combining Covered Code with other code + not governed by the terms of this License and distribute the Larger + Work as a single product. In such a case, You must make sure the + requirements of this License are fulfilled for the Covered Code. + +4. Inability to Comply Due to Statute or Regulation. + + If it is impossible for You to comply with any of the terms of this + License with respect to some or all of the Covered Code due to + statute, judicial order, or regulation then You must: (a) comply with + the terms of this License to the maximum extent possible; and (b) + describe the limitations and the code they affect. Such description + must be included in the LEGAL file described in Section 3.4 and must + be included with all distributions of the Source Code. Except to the + extent prohibited by statute or regulation, such description must be + sufficiently detailed for a recipient of ordinary skill to be able to + understand it. + +5. Application of this License. + + This License applies to code to which the Initial Developer has + attached the notice in Exhibit A and to related Covered Code. + +6. Versions of the License. + + 6.1. New Versions. + Netscape Communications Corporation ("Netscape") may publish revised + and/or new versions of the License from time to time. Each version + will be given a distinguishing version number. + + 6.2. Effect of New Versions. + Once Covered Code has been published under a particular version of the + License, You may always continue to use it under the terms of that + version. You may also choose to use such Covered Code under the terms + of any subsequent version of the License published by Netscape. No one + other than Netscape has the right to modify the terms applicable to + Covered Code created under this License. + + 6.3. Derivative Works. + If You create or use a modified version of this License (which you may + only do in order to apply it to code which is not already Covered Code + governed by this License), You must (a) rename Your license so that + the phrases "Mozilla", "MOZILLAPL", "MOZPL", "Netscape", + "MPL", "NPL" or any confusingly similar phrase do not appear in your + license (except to note that your license differs from this License) + and (b) otherwise make it clear that Your version of the license + contains terms which differ from the Mozilla Public License and + Netscape Public License. (Filling in the name of the Initial + Developer, Original Code or Contributor in the notice described in + Exhibit A shall not of themselves be deemed to be modifications of + this License.) + +7. DISCLAIMER OF WARRANTY. + + COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + WITHOUT LIMITATION, WARRANTIES THAT THE COVERED CODE IS FREE OF + DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. + THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE COVERED CODE + IS WITH YOU. SHOULD ANY COVERED CODE PROVE DEFECTIVE IN ANY RESPECT, + YOU (NOT THE INITIAL DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE + COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER + OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF + ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER. + +8. TERMINATION. + + 8.1. This License and the rights granted hereunder will terminate + automatically if You fail to comply with terms herein and fail to cure + such breach within 30 days of becoming aware of the breach. All + sublicenses to the Covered Code which are properly granted shall + survive any termination of this License. Provisions which, by their + nature, must remain in effect beyond the termination of this License + shall survive. + + 8.2. If You initiate litigation by asserting a patent infringement + claim (excluding declatory judgment actions) against Initial Developer + or a Contributor (the Initial Developer or Contributor against whom + You file such action is referred to as "Participant") alleging that: + + (a) such Participant's Contributor Version directly or indirectly + infringes any patent, then any and all rights granted by such + Participant to You under Sections 2.1 and/or 2.2 of this License + shall, upon 60 days notice from Participant terminate prospectively, + unless if within 60 days after receipt of notice You either: (i) + agree in writing to pay Participant a mutually agreeable reasonable + royalty for Your past and future use of Modifications made by such + Participant, or (ii) withdraw Your litigation claim with respect to + the Contributor Version against such Participant. If within 60 days + of notice, a reasonable royalty and payment arrangement are not + mutually agreed upon in writing by the parties or the litigation claim + is not withdrawn, the rights granted by Participant to You under + Sections 2.1 and/or 2.2 automatically terminate at the expiration of + the 60 day notice period specified above. + + (b) any software, hardware, or device, other than such Participant's + Contributor Version, directly or indirectly infringes any patent, then + any rights granted to You by such Participant under Sections 2.1(b) + and 2.2(b) are revoked effective as of the date You first made, used, + sold, distributed, or had made, Modifications made by that + Participant. + + 8.3. If You assert a patent infringement claim against Participant + alleging that such Participant's Contributor Version directly or + indirectly infringes any patent where such claim is resolved (such as + by license or settlement) prior to the initiation of patent + infringement litigation, then the reasonable value of the licenses + granted by such Participant under Sections 2.1 or 2.2 shall be taken + into account in determining the amount or value of any payment or + license. + + 8.4. In the event of termination under Sections 8.1 or 8.2 above, + all end user license agreements (excluding distributors and resellers) + which have been validly granted by You or any distributor hereunder + prior to termination shall survive termination. + +9. LIMITATION OF LIABILITY. + + UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT + (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE INITIAL + DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED CODE, + OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR + ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY + CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, + WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER + COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN + INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF + LIABILITY SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY + RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE LAW + PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW THE + EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO + THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU. + +10. U.S. GOVERNMENT END USERS. + + The Covered Code is a "commercial item," as that term is defined in + 48 C.F.R. 2.101 (Oct. 1995), consisting of "commercial computer + software" and "commercial computer software documentation," as such + terms are used in 48 C.F.R. 12.212 (Sept. 1995). Consistent with 48 + C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), + all U.S. Government End Users acquire Covered Code with only those + rights set forth herein. + +11. MISCELLANEOUS. + + This License represents the complete agreement concerning subject + matter hereof. If any provision of this License is held to be + unenforceable, such provision shall be reformed only to the extent + necessary to make it enforceable. This License shall be governed by + California law provisions (except to the extent applicable law, if + any, provides otherwise), excluding its conflict-of-law provisions. + With respect to disputes in which at least one party is a citizen of, + or an entity chartered or registered to do business in the United + States of America, any litigation relating to this License shall be + subject to the jurisdiction of the Federal Courts of the Northern + District of California, with venue lying in Santa Clara County, + California, with the losing party responsible for costs, including + without limitation, court costs and reasonable attorneys' fees and + expenses. The application of the United Nations Convention on + Contracts for the International Sale of Goods is expressly excluded. + Any law or regulation which provides that the language of a contract + shall be construed against the drafter shall not apply to this + License. + +12. RESPONSIBILITY FOR CLAIMS. + + As between Initial Developer and the Contributors, each party is + responsible for claims and damages arising, directly or indirectly, + out of its utilization of rights under this License and You agree to + work with Initial Developer and Contributors to distribute such + responsibility on an equitable basis. Nothing herein is intended or + shall be deemed to constitute any admission of liability. + +13. MULTIPLE-LICENSED CODE. + + Initial Developer may designate portions of the Covered Code as + "Multiple-Licensed". "Multiple-Licensed" means that the Initial + Developer permits you to utilize portions of the Covered Code under + Your choice of the NPL or the alternative licenses, if any, specified + by the Initial Developer in the file described in Exhibit A. + +EXHIBIT A -Mozilla Public License. + + ``The contents of this file are subject to the Mozilla Public License + Version 1.1 (the "License"); you may not use this file except in + compliance with the License. You may obtain a copy of the License at + http://www.mozilla.org/MPL/ + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the + License for the specific language governing rights and limitations + under the License. + + The Original Code is ______________________________________. + + The Initial Developer of the Original Code is ________________________. + Portions created by ______________________ are Copyright (C) ______ + _______________________. All Rights Reserved. + + Contributor(s): ______________________________________. + + Alternatively, the contents of this file may be used under the terms + of the _____ license (the "[___] License"), in which case the + provisions of [______] License are applicable instead of those + above. If you wish to allow use of your version of this file only + under the terms of the [____] License and not to allow others to use + your version of this file under the MPL, indicate your decision by + deleting the provisions above and replace them with the notice and + other provisions required by the [___] License. If you do not delete + the provisions above, a recipient may use your version of this file + under either the MPL or the [___] License." + + [NOTE: The text of this Exhibit A may differ slightly from the text of + the notices in the Source Code files of the Original Code. You should + use the text of this Exhibit A rather than the text found in the + Original Code Source Code for Your Modifications.] + +---- + + +[[PublicDomain]] +PublicDomain + +* guice:aopalliance + +[[PublicDomain_license]] +---- +This software has been placed in the public domain by its author(s). + +---- + + +[[antlr]] +antlr + +* antlr:antlr27 +* antlr:java-runtime +* antlr:stringtemplate +* antlr:tool + +[[antlr_license]] +---- +Copyright (c) 2003-2008, Terence Parr +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + * Neither the name of the author nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS +FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE +COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN +ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +---- + + +[[args4j]] +args4j + +* args4j + +[[args4j_license]] +---- +Copyright (c) 2013 Kohsuke Kawaguchi and other contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is furnished to do +so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +---- + + +[[autolink]] +autolink + +* autolink + +[[autolink_license]] +---- +The MIT License (MIT) + +Copyright (c) 2015 Robin Stocker + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +---- + + +[[automaton]] +automaton + +* automaton + +[[automaton_license]] +---- +Copyright (c) 2001-2011 Anders Moeller +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + * Neither the name of the JSR305 expert group nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +---- + + +[[bouncycastle]] +bouncycastle + +* bouncycastle:bcpg-neverlink +* bouncycastle:bcpkix-neverlink +* bouncycastle:bcprov-neverlink + +[[bouncycastle_license]] +---- +Copyright (c) 2000 - 2015 The Legion of the Bouncy Castle Inc. +(http://www.bouncycastle.org) + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +---- + + +[[flexmark]] +flexmark + +* flexmark +* flexmark-ext-abbreviation +* flexmark-ext-anchorlink +* flexmark-ext-autolink +* flexmark-ext-definition +* flexmark-ext-emoji +* flexmark-ext-escaped-character +* flexmark-ext-footnotes +* flexmark-ext-gfm-issues +* flexmark-ext-gfm-strikethrough +* flexmark-ext-gfm-tables +* flexmark-ext-gfm-tasklist +* flexmark-ext-gfm-users +* flexmark-ext-ins +* flexmark-ext-jekyll-front-matter +* flexmark-ext-superscript +* flexmark-ext-tables +* flexmark-ext-toc +* flexmark-ext-typographic +* flexmark-ext-wikilink +* flexmark-ext-yaml-front-matter +* flexmark-formatter +* flexmark-html-parser +* flexmark-profile-pegdown +* flexmark-util + +[[flexmark_license]] +---- +Copyright (c) 2015-2016, Atlassian Pty Ltd +All rights reserved. + +Copyright (c) 2016, Vladimir Schneider, +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +---- + + +[[h2]] +h2 + +* h2 + +[[h2_license]] +---- +H2 is dual licensed and available under a modified version of the +MPL 1.1 (Mozilla Public License) or under the (unmodified) EPL 1.0. +---- + +link:http://www.h2database.com/html/license.html[H2 License] + +---- +H2 License - Version 1.0 +1. Definitions + +1.0.1. "Commercial Use" means distribution or otherwise making the + Covered Code available to a third party. + +1.1. "Contributor" means each entity that creates or contributes + to the creation of Modifications. + +1.2. "Contributor Version" means the combination of the Original + Code, prior Modifications used by a Contributor, and the + Modifications made by that particular Contributor. + +1.3. "Covered Code" means the Original Code or Modifications or + the combination of the Original Code and Modifications, in each + case including portions thereof. + +1.4. "Electronic Distribution Mechanism" means a mechanism generally + accepted in the software development community for the electronic + transfer of data. + +1.5. "Executable" means Covered Code in any form other than Source Code. + +1.6. "Initial Developer" means the individual or entity identified + as the Initial Developer in the Source Code notice required + by Exhibit A. + +1.7. "Larger Work" means a work which combines Covered Code or + portions thereof with code not governed by the terms of this + License. + +1.8. "License" means this document. + +1.8.1. "Licensable" means having the right to grant, to the maximum + extent possible, whether at the time of the initial grant + or subsequently acquired, any and all of the rights conveyed + herein. + +1.9. "Modifications" means any addition to or deletion from the + substance or structure of either the Original Code or any + previous Modifications. When Covered Code is released as a + series of files, a Modification is: + +1.9.a. Any addition to or deletion from the contents of a file + containing Original Code or previous Modifications. + +1.9.b. Any new file that contains any part of the Original Code or + previous Modifications. + +1.10. "Original Code" means Source Code of computer software + code which is described in the Source Code notice required + by Exhibit A as Original Code, and which, at the time of + its release under this License is not already Covered Code + governed by this License. + +1.10.1. "Patent Claims" means any patent claim(s), now owned or + hereafter acquired, including without limitation, method, + process, and apparatus claims, in any patent Licensable + by grantor. + +1.11. "Source Code" means the preferred form of the Covered Code + for making modifications to it, including all modules it + contains, plus any associated interface definition files, + scripts used to control compilation and installation of an + Executable, or source code differential comparisons against + either the Original Code or another well known, available + Covered Code of the Contributor's choice. The Source Code can + be in a compressed or archival form, provided the appropriate + decompression or de-archiving software is widely available + for no charge. + +1.12. "You" (or "Your") means an individual or a legal entity + exercising rights under, and complying with all of the terms + of, this License or a future version of this License issued + under Section 6.1. For legal entities, "You" includes any + entity which controls, is controlled by, or is under common + control with You. For purposes of this definition, "control" + means (a) the power, direct or indirect, to cause the direction + or management of such entity, whether by contract or otherwise, + or (b) ownership of more than fifty percent (50%) of the + outstanding shares or beneficial ownership of such entity. + +2. Source Code License + +2.1. The Initial Developer Grant + +The Initial Developer hereby grants You a world-wide, royalty-free, +non-exclusive license, subject to third party intellectual property +claims: + +2.1.a. under intellectual property rights (other than patent + or trademark) Licensable by Initial Developer to use, + reproduce, modify, display, perform, sublicense and distribute + the Original Code (or portions thereof) with or without + Modifications, and/or as part of a Larger Work; and + +2.1.b. under Patents Claims infringed by the making, using or selling + of Original Code, to make, have made, use, practice, sell, + and offer for sale, and/or otherwise dispose of the Original + Code (or portions thereof). + +2.1.c. the licenses granted in this Section 2.1 (a) and (b) are + effective on the date Initial Developer first distributes + Original Code under the terms of this License. + +2.1.d. Notwithstanding Section 2.1 (b) above, no patent license is + granted: 1) for code that You delete from the Original Code; + 2) separate from the Original Code; or 3) for infringements + caused by: i) the modification of the Original Code or ii) + the combination of the Original Code with other software + or devices. + +2.2. Contributor Grant + +Subject to third party intellectual property claims, each Contributor +hereby grants You a world-wide, royalty-free, non-exclusive license + +2.2.a. under intellectual property rights (other than patent or + trademark) Licensable by Contributor, to use, reproduce, + modify, display, perform, sublicense and distribute the + Modifications created by such Contributor (or portions + thereof) either on an unmodified basis, with other + Modifications, as Covered Code and/or as part of a Larger + Work; and + +2.2.b. under Patent Claims infringed by the making, using, or selling + of Modifications made by that Contributor either alone and/or + in combination with its Contributor Version (or portions + of such combination), to make, use, sell, offer for sale, + have made, and/or otherwise dispose of: 1) Modifications + made by that Contributor (or portions thereof); and 2) the + combination of Modifications made by that Contributor with + its Contributor Version (or portions of such combination). + +2.2.c. the licenses granted in Sections 2.2 (a) and 2.2 (b) are + effective on the date Contributor first makes Commercial + Use of the Covered Code. + +2.2.c. Notwithstanding Section 2.2 (b) above, no patent license is + granted: 1) for any code that Contributor has deleted from + the Contributor Version; 2) separate from the Contributor + Version; 3) for infringements caused by: i) third party + modifications of Contributor Version or ii) the combination + of Modifications made by that Contributor with other software + (except as part of the Contributor Version) or other devices; + or 4) under Patent Claims infringed by Covered Code in the + absence of Modifications made by that Contributor. + +3. Distribution Obligations + +3.1. Application of License + +The Modifications which You create or to which You contribute +are governed by the terms of this License, including without +limitation Section 2.2. The Source Code version of Covered Code may +be distributed only under the terms of this License or a future +version of this License released under Section 6.1, and You must +include a copy of this License with every copy of the Source Code +You distribute. You may not offer or impose any terms on any Source +Code version that alters or restricts the applicable version of +this License or the recipients' rights hereunder. However, You +may include an additional document offering the additional rights +described in Section 3.5. + +3.2. Availability of Source Code + +Any Modification which You create or to which You contribute must +be made available in Source Code form under the terms of this +License either on the same media as an Executable version or via +an accepted Electronic Distribution Mechanism to anyone to whom +you made an Executable version available; and if made available +via Electronic Distribution Mechanism, must remain available for +at least twelve (12) months after the date it initially became +available, or at least six (6) months after a subsequent version +of that particular Modification has been made available to such +recipients. You are responsible for ensuring that the Source Code +version remains available even if the Electronic Distribution +Mechanism is maintained by a third party. + +3.3. Description of Modifications + +You must cause all Covered Code to which You contribute to contain +a file documenting the changes You made to create that Covered +Code and the date of any change. You must include a prominent +statement that the Modification is derived, directly or indirectly, +from Original Code provided by the Initial Developer and including +the name of the Initial Developer in (a) the Source Code, and (b) +in any notice in an Executable version or related documentation in +which You describe the origin or ownership of the Covered Code. + +3.4. Intellectual Property Matters + +3.4.a. Third Party Claims: If Contributor has knowledge that + a license under a third party's intellectual property + rights is required to exercise the rights granted by such + Contributor under Sections 2.1 or 2.2, Contributor must + include a text file with the Source Code distribution titled + "LEGAL" which describes the claim and the party making the + claim in sufficient detail that a recipient will know whom + to contact. If Contributor obtains such knowledge after the + Modification is made available as described in Section 3.2, + Contributor shall promptly modify the LEGAL file in all + copies Contributor makes available thereafter and shall take + other steps (such as notifying appropriate mailing lists or + newsgroups) reasonably calculated to inform those who received + the Covered Code that new knowledge has been obtained. + +3.4.b. Contributor APIs: If Contributor's Modifications include + an application programming interface and Contributor has + knowledge of patent licenses which are reasonably necessary + to implement that API, Contributor must also include this + information in the legal file. + +3.4.c. Representations: Contributor represents that, except as + disclosed pursuant to Section 3.4 (a) above, Contributor + believes that Contributor's Modifications are Contributor's + original creation(s) and/or Contributor has sufficient rights + to grant the rights conveyed by this License. + +3.5. Required Notices + +You must duplicate the notice in Exhibit A in each file of +the Source Code. If it is not possible to put such notice in a +particular Source Code file due to its structure, then You must +include such notice in a location (such as a relevant directory) +where a user would be likely to look for such a notice. If You +created one or more Modification(s) You may add your name as a +Contributor to the notice described in Exhibit A. You must also +duplicate this License in any documentation for the Source Code +where You describe recipients' rights or ownership rights relating +to Covered Code. You may choose to offer, and to charge a fee for, +warranty, support, indemnity or liability obligations to one or +more recipients of Covered Code. However, You may do so only on +Your own behalf, and not on behalf of the Initial Developer or +any Contributor. You must make it absolutely clear than any such +warranty, support, indemnity or liability obligation is offered by +You alone, and You hereby agree to indemnify the Initial Developer +and every Contributor for any liability incurred by the Initial +Developer or such Contributor as a result of warranty, support, +indemnity or liability terms You offer. + +3.6. Distribution of Executable Versions + +You may distribute Covered Code in Executable form only if the +requirements of Sections 3.1, 3.2, 3.3, 3.4 and 3.5 have been met +for that Covered Code, and if You include a notice stating that +the Source Code version of the Covered Code is available under the +terms of this License, including a description of how and where +You have fulfilled the obligations of Section 3.2. The notice +must be conspicuously included in any notice in an Executable +version, related documentation or collateral in which You describe +recipients' rights relating to the Covered Code. You may distribute +the Executable version of Covered Code or ownership rights under +a license of Your choice, which may contain terms different from +this License, provided that You are in compliance with the terms +of this License and that the license for the Executable version +does not attempt to limit or alter the recipient's rights in the +Source Code version from the rights set forth in this License. If +You distribute the Executable version under a different license You +must make it absolutely clear that any terms which differ from this +License are offered by You alone, not by the Initial Developer or any +Contributor. You hereby agree to indemnify the Initial Developer and +every Contributor for any liability incurred by the Initial Developer +or such Contributor as a result of any such terms You offer. + +3.7. Larger Works + +You may create a Larger Work by combining Covered Code with other +code not governed by the terms of this License and distribute the +Larger Work as a single product. In such a case, You must make sure +the requirements of this License are fulfilled for the Covered Code. + +4. Inability to Comply Due to Statute or Regulation. + +If it is impossible for You to comply with any of the terms of +this License with respect to some or all of the Covered Code due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description +must be included in the legal file described in Section 3.4 and +must be included with all distributions of the Source Code. Except +to the extent prohibited by statute or regulation, such description +must be sufficiently detailed for a recipient of ordinary skill to +be able to understand it. + +5. Application of this License. + +This License applies to code to which the Initial Developer has +attached the notice in Exhibit A and to related Covered Code. + +6. Versions of the License. + +6.1. New Versions + +The H2 Group may publish revised and/or new versions of the License +from time to time. Each version will be given a distinguishing +version number. + +6.2. Effect of New Versions + +Once Covered Code has been published under a particular version of +the License, You may always continue to use it under the terms of +that version. You may also choose to use such Covered Code under the +terms of any subsequent version of the License published by the H2 +Group. No one other than the H2 Group has the right to modify the +terms applicable to Covered Code created under this License. + +6.3. Derivative Works + +If You create or use a modified version of this License (which you +may only do in order to apply it to code which is not already Covered +Code governed by this License), You must (a) rename Your license so +that the phrases "H2 Group", "H2" or any confusingly similar phrase +do not appear in your license (except to note that your license +differs from this License) and (b) otherwise make it clear that +Your version of the license contains terms which differ from the +H2 License. (Filling in the name of the Initial Developer, Original +Code or Contributor in the notice described in Exhibit A shall not +of themselves be deemed to be modifications of this License.) + +7. Disclaimer of Warranty + +Covered code is provided under this license on an "as is" basis, +without warranty of any kind, either expressed or implied, +including, without limitation, warranties that the covered code +is free of defects, merchantable, fit for a particular purpose or +non-infringing. The entire risk as to the quality and performance +of the covered code is with you. Should any covered code prove +defective in any respect, you (not the initial developer or any +other contributor) assume the cost of any necessary servicing, +repair or correction. This disclaimer of warranty constitutes +an essential part of this license. No use of any covered code is +authorized hereunder except under this disclaimer. + +8. Termination + +8.1. This License and the rights granted hereunder will terminate + automatically if You fail to comply with terms herein and + fail to cure such breach within 30 days of becoming aware + of the breach. All sublicenses to the Covered Code which + are properly granted shall survive any termination of this + License. Provisions which, by their nature, must remain in + effect beyond the termination of this License shall survive. + +8.2. If You initiate litigation by asserting a patent infringement + claim (excluding declaratory judgment actions) against + Initial Developer or a Contributor (the Initial Developer or + Contributor against whom You file such action is referred to as + "Participant") alleging that: + +8.2.a. such Participant's Contributor Version directly or indirectly + infringes any patent, then any and all rights granted by + such Participant to You under Sections 2.1 and/or 2.2 of this + License shall, upon 60 days notice from Participant terminate + prospectively, unless if within 60 days after receipt of + notice You either: (i) agree in writing to pay Participant + a mutually agreeable reasonable royalty for Your past and + future use of Modifications made by such Participant, or (ii) + withdraw Your litigation claim with respect to the Contributor + Version against such Participant. If within 60 days of notice, + a reasonable royalty and payment arrangement are not mutually + agreed upon in writing by the parties or the litigation claim + is not withdrawn, the rights granted by Participant to You + under Sections 2.1 and/or 2.2 automatically terminate at + the expiration of the 60 day notice period specified above. + +8.2.b. any software, hardware, or device, other than such + Participant's Contributor Version, directly or indirectly + infringes any patent, then any rights granted to You by + such Participant under Sections 2.1(b) and 2.2(b) are + revoked effective as of the date You first made, used, + sold, distributed, or had made, Modifications made by that + Participant. + +8.3. If You assert a patent infringement claim against Participant + alleging that such Participant's Contributor Version directly + or indirectly infringes any patent where such claim is resolved + (such as by license or settlement) prior to the initiation of + patent infringement litigation, then the reasonable value of + the licenses granted by such Participant under Sections 2.1 + or 2.2 shall be taken into account in determining the amount + or value of any payment or license. + +8.4. In the event of termination under Sections 8.1 or 8.2 above, + all end user license agreements (excluding distributors and + resellers) which have been validly granted by You or any + distributor hereunder prior to termination shall survive + termination. + +9. Limitation of Liability + +Under no circumstances and under no legal theory, whether tort +(including negligence), contract, or otherwise, shall you, the +initial developer, any other contributor, or any distributor of +covered code, or any supplier of any of such parties, be liable to +any person for any indirect, special, incidental, or consequential +damages of any character including, without limitation, damages for +loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses, even if such party +shall have been informed of the possibility of such damages. This +limitation of liability shall not apply to liability for death or +personal injury resulting from such party's negligence to the extent +applicable law prohibits such limitation. Some jurisdictions do not +allow the exclusion or limitation of incidental or consequential +damages, so this exclusion and limitation may not apply to you. + +10. United States Government End Users + +The Covered Code is a "commercial item", as that term is defined in +48 C.F.R. 2.101 (October 1995), consisting of "commercial computer +software" and "commercial computer software documentation", as such +terms are used in 48 C.F.R. 12.212 (September 1995). Consistent +with 48 C.F.R. 12.212 and 48 C.F.R. 227.7202-1 through 227.7202-4 +(June 1995), all U.S. Government End Users acquire Covered Code +with only those rights set forth herein. + +11. Miscellaneous + +This License represents the complete agreement concerning subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. This License shall be governed +by California law provisions (except to the extent applicable +law, if any, provides otherwise), excluding its conflict-of-law +provisions. With respect to disputes in which at least one party is +a citizen of, or an entity chartered or registered to do business in +United States of America, any litigation relating to this License +shall be subject to the jurisdiction of the Federal Courts of the +Northern District of California, with venue lying in Santa Clara +County, California, with the losing party responsible for costs, +including without limitation, court costs and reasonable attorneys' +fees and expenses. The application of the United Nations Convention +on Contracts for the International Sale of Goods is expressly +excluded. Any law or regulation which provides that the language of +a contract shall be construed against the drafter shall not apply +to this License. + +12. Responsibility for Claims + +As between Initial Developer and the Contributors, each party is +responsible for claims and damages arising, directly or indirectly, +out of its utilization of rights under this License and You agree +to work with Initial Developer and Contributors to distribute such +responsibility on an equitable basis. Nothing herein is intended +or shall be deemed to constitute any admission of liability. + +13. Multiple-Licensed Code + +Initial Developer may designate portions of the Covered Code as +"Multiple-Licensed". "Multiple-Licensed" means that the Initial +Developer permits you to utilize portions of the Covered Code under +Your choice of this or the alternative licenses, if any, specified +by the Initial Developer in the file described in Exhibit A. + +Exhibit A + +Multiple-Licensed under the H2 License, Version 1.0, +and under the Eclipse Public License, Version 1.0 +(http://h2database.com/html/license.html). +Initial Developer: H2 Group +---- + +---- +Eclipse Public License - v 1.0 + +THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE +PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION +OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. + +1. DEFINITIONS + +"Contribution" means: + +a) in the case of the initial Contributor, the initial code and + documentation distributed under this Agreement, and +b) in the case of each subsequent Contributor: + +i) changes to the Program, and + +ii) additions to the Program; + +where such changes and/or additions to the Program originate from +and are distributed by that particular Contributor. A Contribution +'originates' from a Contributor if it was added to the Program +by such Contributor itself or anyone acting on such Contributor's +behalf. Contributions do not include additions to the Program which: +(i) are separate modules of software distributed in conjunction +with the Program under their own license agreement, and (ii) are +not derivative works of the Program. + +"Contributor" means any person or entity that distributes the Program. + +"Licensed Patents " mean patent claims licensable by a Contributor +which are necessarily infringed by the use or sale of its +Contribution alone or when combined with the Program. + +"Program" means the Contributions distributed in accordance with +this Agreement. + +"Recipient" means anyone who receives the Program under this +Agreement, including all Contributors. + +2. GRANT OF RIGHTS + +a) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free copyright + license to reproduce, prepare derivative works of, publicly display, + publicly perform, distribute and sublicense the Contribution of such + Contributor, if any, and such derivative works, in source code and + object code form. + +b) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free patent + license under Licensed Patents to make, use, sell, offer to sell, + import and otherwise transfer the Contribution of such Contributor, + if any, in source code and object code form. This patent license + shall apply to the combination of the Contribution and the Program + if, at the time the Contribution is added by the Contributor, such + addition of the Contribution causes such combination to be covered + by the Licensed Patents. The patent license shall not apply to any + other combinations which include the Contribution. No hardware per + se is licensed hereunder. + +c) Recipient understands that although each Contributor grants the + licenses to its Contributions set forth herein, no assurances are + provided by any Contributor that the Program does not infringe + the patent or other intellectual property rights of any other + entity. Each Contributor disclaims any liability to Recipient + for claims brought by any other entity based on infringement + of intellectual property rights or otherwise. As a condition to + exercising the rights and licenses granted hereunder, each Recipient + hereby assumes sole responsibility to secure any other intellectual + property rights needed, if any. For example, if a third party patent + license is required to allow Recipient to distribute the Program, + it is Recipient's responsibility to acquire that license before + distributing the Program. + +d) Each Contributor represents that to its knowledge it has + sufficient copyright rights in its Contribution, if any, to grant + the copyright license set forth in this Agreement. + +3. REQUIREMENTS + +A Contributor may choose to distribute the Program in object code + form under its own license agreement, provided that: + +a) it complies with the terms and conditions of this Agreement; and + +b) its license agreement: + +i) effectively disclaims on behalf of all Contributors all warranties + and conditions, express and implied, including warranties or + conditions of title and non-infringement, and implied warranties or + conditions of merchantability and fitness for a particular purpose; + +ii) effectively excludes on behalf of all Contributors all liability + for damages, including direct, indirect, special, incidental and + consequential damages, such as lost profits; + +iii) states that any provisions which differ from this Agreement + are offered by that Contributor alone and not by any other + party; and + +iv) states that source code for the Program is available from such + Contributor, and informs licensees how to obtain it in a reasonable + manner on or through a medium customarily used for software exchange. + +When the Program is made available in source code form: + +a) it must be made available under this Agreement; and + +b) a copy of this Agreement must be included with each copy of the Program. + +Contributors may not remove or alter any copyright notices contained +within the Program. + +Each Contributor must identify itself as the originator of its +Contribution, if any, in a manner that reasonably allows subsequent +Recipients to identify the originator of the Contribution. + +4. COMMERCIAL DISTRIBUTION + +Commercial distributors of software may accept certain +responsibilities with respect to end users, business partners and the +like. While this license is intended to facilitate the commercial +use of the Program, the Contributor who includes the Program in a +commercial product offering should do so in a manner which does not +create potential liability for other Contributors. Therefore, if a +Contributor includes the Program in a commercial product offering, +such Contributor ("Commercial Contributor") hereby agrees to defend +and indemnify every other Contributor ("Indemnified Contributor") +against any losses, damages and costs (collectively "Losses") arising +from claims, lawsuits and other legal actions brought by a third +party against the Indemnified Contributor to the extent caused by +the acts or omissions of such Commercial Contributor in connection +with its distribution of the Program in a commercial product +offering. The obligations in this section do not apply to any claims +or Losses relating to any actual or alleged intellectual property +infringement. In order to qualify, an Indemnified Contributor must: +a) promptly notify the Commercial Contributor in writing of such +claim, and b) allow the Commercial Contributor to control, and +cooperate with the Commercial Contributor in, the defense and any +related settlement negotiations. The Indemnified Contributor may +participate in any such claim at its own expense. + +For example, a Contributor might include the Program in a +commercial product offering, Product X. That Contributor is then a +Commercial Contributor. If that Commercial Contributor then makes +performance claims, or offers warranties related to Product X, those +performance claims and warranties are such Commercial Contributor's +responsibility alone. Under this section, the Commercial Contributor +would have to defend claims against the other Contributors related +to those performance claims and warranties, and if a court requires +any other Contributor to pay any damages as a result, the Commercial +Contributor must pay those damages. + +5. NO WARRANTY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS +PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY +WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY +OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely +responsible for determining the appropriateness of using and +distributing the Program and assumes all risks associated with +its exercise of rights under this Agreement , including but not +limited to the risks and costs of program errors, compliance with +applicable laws, damage to or loss of data, programs or equipment, +and unavailability or interruption of operations. + +6. DISCLAIMER OF LIABILITY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT +NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY +RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +7. GENERAL + +If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this Agreement, and without further +action by the parties hereto, such provision shall be reformed +to the minimum extent necessary to make such provision valid and +enforceable. + +If Recipient institutes patent litigation against any entity +(including a cross-claim or counterclaim in a lawsuit) alleging +that the Program itself (excluding combinations of the Program with +other software or hardware) infringes such Recipient's patent(s), +then such Recipient's rights granted under Section 2(b) shall +terminate as of the date such litigation is filed. + +All Recipient's rights under this Agreement shall terminate if +it fails to comply with any of the material terms or conditions +of this Agreement and does not cure such failure in a reasonable +period of time after becoming aware of such noncompliance. If all +Recipient's rights under this Agreement terminate, Recipient agrees +to cease use and distribution of the Program as soon as reasonably +practicable. However, Recipient's obligations under this Agreement +and any licenses granted by Recipient relating to the Program shall +continue and survive. + +Everyone is permitted to copy and distribute copies of this +Agreement, but in order to avoid inconsistency the Agreement is +copyrighted and may only be modified in the following manner. The +Agreement Steward reserves the right to publish new versions +(including revisions) of this Agreement from time to time. No +one other than the Agreement Steward has the right to modify +this Agreement. The Eclipse Foundation is the initial Agreement +Steward. The Eclipse Foundation may assign the responsibility to +serve as the Agreement Steward to a suitable separate entity. Each +new version of the Agreement will be given a distinguishing +version number. The Program (including Contributions) may always be +distributed subject to the version of the Agreement under which it +was received. In addition, after a new version of the Agreement is +published, Contributor may elect to distribute the Program (including +its Contributions) under the new version. Except as expressly stated +in Sections 2(a) and 2(b) above, Recipient receives no rights or +licenses to the intellectual property of any Contributor under +this Agreement, whether expressly, by implication, estoppel or +otherwise. All rights in the Program not expressly granted under +this Agreement are reserved. + +This Agreement is governed by the laws of the State of New York and +the intellectual property laws of the United States of America. No +party to this Agreement will bring a legal action under this +Agreement more than one year after the cause of action arose. Each +party waives its rights to a jury trial in any resulting litigation. +---- + +---- +Export Control Classification Number (ECCN) + +As far as we know, the U.S. Export Control Classification Number +(ECCN) for this software is 5D002. However, for legal reasons, we +can make no warranty that this information is correct. For details, +see also the Apache Software Foundation Export Classifications page. + +---- + + +[[icu4j]] +icu4j + +* icu4j + +[[icu4j_license]] +---- +COPYRIGHT AND PERMISSION NOTICE (ICU 58 and later) + +Copyright © 1991-2016 Unicode, Inc. All rights reserved. +Distributed under the Terms of Use in http://www.unicode.org/copyright.html + +Permission is hereby granted, free of charge, to any person obtaining +a copy of the Unicode data files and any associated documentation +(the "Data Files") or Unicode software and any associated documentation +(the "Software") to deal in the Data Files or Software +without restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, and/or sell copies of +the Data Files or Software, and to permit persons to whom the Data Files +or Software are furnished to do so, provided that either +(a) this copyright and permission notice appear with all copies +of the Data Files or Software, or +(b) this copyright and permission notice appear in associated +Documentation. + +THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT OF THIRD PARTY RIGHTS. +IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS +NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL +DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, +DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER +TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THE DATA FILES OR SOFTWARE. + +Except as contained in this notice, the name of a copyright holder +shall not be used in advertising or otherwise to promote the sale, +use or other dealings in these Data Files or Software without prior +written authorization of the copyright holder. + +--------------------- + +Third-Party Software Licenses + +This section contains third-party software notices and/or additional +terms for licensed third-party software components included within ICU +libraries. + +1. ICU License - ICU 1.8.1 to ICU 57.1 + +COPYRIGHT AND PERMISSION NOTICE + +Copyright (c) 1995-2016 International Business Machines Corporation and others +All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, and/or sell copies of the Software, and to permit persons +to whom the Software is furnished to do so, provided that the above +copyright notice(s) and this permission notice appear in all copies of +the Software and that both the above copyright notice(s) and this +permission notice appear in supporting documentation. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT +OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY +SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER +RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF +CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN +CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +Except as contained in this notice, the name of a copyright holder +shall not be used in advertising or otherwise to promote the sale, use +or other dealings in this Software without prior written authorization +of the copyright holder. + +All trademarks and registered trademarks mentioned herein are the +property of their respective owners. + +2. Chinese/Japanese Word Break Dictionary Data (cjdict.txt) + + # The Google Chrome software developed by Google is licensed under + # the BSD license. Other software included in this distribution is + # provided under other licenses, as set forth below. + # + # The BSD License + # http://opensource.org/licenses/bsd-license.php + # Copyright (C) 2006-2008, Google Inc. + # + # All rights reserved. + # + # Redistribution and use in source and binary forms, with or without + # modification, are permitted provided that the following conditions are met: + # + # Redistributions of source code must retain the above copyright notice, + # this list of conditions and the following disclaimer. + # Redistributions in binary form must reproduce the above + # copyright notice, this list of conditions and the following + # disclaimer in the documentation and/or other materials provided with + # the distribution. + # Neither the name of Google Inc. nor the names of its + # contributors may be used to endorse or promote products derived from + # this software without specific prior written permission. + # + # + # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + # CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + # INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR + # BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + # LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + # + # + # The word list in cjdict.txt are generated by combining three word lists + # listed below with further processing for compound word breaking. The + # frequency is generated with an iterative training against Google web + # corpora. + # + # * Libtabe (Chinese) + # - https://sourceforge.net/project/?group_id=1519 + # - Its license terms and conditions are shown below. + # + # * IPADIC (Japanese) + # - http://chasen.aist-nara.ac.jp/chasen/distribution.html + # - Its license terms and conditions are shown below. + # + # ---------COPYING.libtabe ---- BEGIN-------------------- + # + # /* + # * Copyrighy (c) 1999 TaBE Project. + # * Copyright (c) 1999 Pai-Hsiang Hsiao. + # * All rights reserved. + # * + # * Redistribution and use in source and binary forms, with or without + # * modification, are permitted provided that the following conditions + # * are met: + # * + # * . Redistributions of source code must retain the above copyright + # * notice, this list of conditions and the following disclaimer. + # * . Redistributions in binary form must reproduce the above copyright + # * notice, this list of conditions and the following disclaimer in + # * the documentation and/or other materials provided with the + # * distribution. + # * . Neither the name of the TaBE Project nor the names of its + # * contributors may be used to endorse or promote products derived + # * from this software without specific prior written permission. + # * + # * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + # * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + # * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + # * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + # * REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + # * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + # * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + # * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + # * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + # * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + # * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + # * OF THE POSSIBILITY OF SUCH DAMAGE. + # */ + # + # /* + # * Copyright (c) 1999 Computer Systems and Communication Lab, + # * Institute of Information Science, Academia + # * Sinica. All rights reserved. + # * + # * Redistribution and use in source and binary forms, with or without + # * modification, are permitted provided that the following conditions + # * are met: + # * + # * . Redistributions of source code must retain the above copyright + # * notice, this list of conditions and the following disclaimer. + # * . Redistributions in binary form must reproduce the above copyright + # * notice, this list of conditions and the following disclaimer in + # * the documentation and/or other materials provided with the + # * distribution. + # * . Neither the name of the Computer Systems and Communication Lab + # * nor the names of its contributors may be used to endorse or + # * promote products derived from this software without specific + # * prior written permission. + # * + # * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + # * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + # * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + # * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + # * REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + # * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + # * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + # * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + # * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + # * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + # * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + # * OF THE POSSIBILITY OF SUCH DAMAGE. + # */ + # + # Copyright 1996 Chih-Hao Tsai @ Beckman Institute, + # University of Illinois + # c-tsai4@uiuc.edu http://casper.beckman.uiuc.edu/~c-tsai4 + # + # ---------------COPYING.libtabe-----END-------------------------------- + # + # + # ---------------COPYING.ipadic-----BEGIN------------------------------- + # + # Copyright 2000, 2001, 2002, 2003 Nara Institute of Science + # and Technology. All Rights Reserved. + # + # Use, reproduction, and distribution of this software is permitted. + # Any copy of this software, whether in its original form or modified, + # must include both the above copyright notice and the following + # paragraphs. + # + # Nara Institute of Science and Technology (NAIST), + # the copyright holders, disclaims all warranties with regard to this + # software, including all implied warranties of merchantability and + # fitness, in no event shall NAIST be liable for + # any special, indirect or consequential damages or any damages + # whatsoever resulting from loss of use, data or profits, whether in an + # action of contract, negligence or other tortuous action, arising out + # of or in connection with the use or performance of this software. + # + # A large portion of the dictionary entries + # originate from ICOT Free Software. The following conditions for ICOT + # Free Software applies to the current dictionary as well. + # + # Each User may also freely distribute the Program, whether in its + # original form or modified, to any third party or parties, PROVIDED + # that the provisions of Section 3 ("NO WARRANTY") will ALWAYS appear + # on, or be attached to, the Program, which is distributed substantially + # in the same form as set out herein and that such intended + # distribution, if actually made, will neither violate or otherwise + # contravene any of the laws and regulations of the countries having + # jurisdiction over the User or the intended distribution itself. + # + # NO WARRANTY + # + # The program was produced on an experimental basis in the course of the + # research and development conducted during the project and is provided + # to users as so produced on an experimental basis. Accordingly, the + # program is provided without any warranty whatsoever, whether express, + # implied, statutory or otherwise. The term "warranty" used herein + # includes, but is not limited to, any warranty of the quality, + # performance, merchantability and fitness for a particular purpose of + # the program and the nonexistence of any infringement or violation of + # any right of any third party. + # + # Each user of the program will agree and understand, and be deemed to + # have agreed and understood, that there is no warranty whatsoever for + # the program and, accordingly, the entire risk arising from or + # otherwise connected with the program is assumed by the user. + # + # Therefore, neither ICOT, the copyright holder, or any other + # organization that participated in or was otherwise related to the + # development of the program and their respective officials, directors, + # officers and other employees shall be held liable for any and all + # damages, including, without limitation, general, special, incidental + # and consequential damages, arising out of or otherwise in connection + # with the use or inability to use the program or any product, material + # or result produced or otherwise obtained by using the program, + # regardless of whether they have been advised of, or otherwise had + # knowledge of, the possibility of such damages at any time during the + # project or thereafter. Each user will be deemed to have agreed to the + # foregoing by his or her commencement of use of the program. The term + # "use" as used herein includes, but is not limited to, the use, + # modification, copying and distribution of the program and the + # production of secondary products from the program. + # + # In the case where the program, whether in its original form or + # modified, was distributed or delivered to or received by a user from + # any person, organization or entity other than ICOT, unless it makes or + # grants independently of ICOT any specific warranty to the user in + # writing, such person, organization or entity, will also be exempted + # from and not be held liable to the user for any such damages as noted + # above as far as the program is concerned. + # + # ---------------COPYING.ipadic-----END---------------------------------- + +3. Lao Word Break Dictionary Data (laodict.txt) + + # Copyright (c) 2013 International Business Machines Corporation + # and others. All Rights Reserved. + # + # Project: http://code.google.com/p/lao-dictionary/ + # Dictionary: http://lao-dictionary.googlecode.com/git/Lao-Dictionary.txt + # License: http://lao-dictionary.googlecode.com/git/Lao-Dictionary-LICENSE.txt + # (copied below) + # + # This file is derived from the above dictionary, with slight + # modifications. + # ---------------------------------------------------------------------- + # Copyright (C) 2013 Brian Eugene Wilson, Robert Martin Campbell. + # All rights reserved. + # + # Redistribution and use in source and binary forms, with or without + # modification, + # are permitted provided that the following conditions are met: + # + # + # Redistributions of source code must retain the above copyright notice, this + # list of conditions and the following disclaimer. Redistributions in + # binary form must reproduce the above copyright notice, this list of + # conditions and the following disclaimer in the documentation and/or + # other materials provided with the distribution. + # + # + # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + # INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR + # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED + # OF THE POSSIBILITY OF SUCH DAMAGE. + # -------------------------------------------------------------------------- + +4. Burmese Word Break Dictionary Data (burmesedict.txt) + + # Copyright (c) 2014 International Business Machines Corporation + # and others. All Rights Reserved. + # + # This list is part of a project hosted at: + # github.com/kanyawtech/myanmar-karen-word-lists + # + # -------------------------------------------------------------------------- + # Copyright (c) 2013, LeRoy Benjamin Sharon + # All rights reserved. + # + # Redistribution and use in source and binary forms, with or without + # modification, are permitted provided that the following conditions + # are met: Redistributions of source code must retain the above + # copyright notice, this list of conditions and the following + # disclaimer. Redistributions in binary form must reproduce the + # above copyright notice, this list of conditions and the following + # disclaimer in the documentation and/or other materials provided + # with the distribution. + # + # Neither the name Myanmar Karen Word Lists, nor the names of its + # contributors may be used to endorse or promote products derived + # from this software without specific prior written permission. + # + # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + # CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + # INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS + # BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + # TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + # ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR + # TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF + # THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + # SUCH DAMAGE. + # -------------------------------------------------------------------------- + +5. Time Zone Database + + ICU uses the public domain data and code derived from Time Zone +Database for its time zone support. The ownership of the TZ database +is explained in BCP 175: Procedure for Maintaining the Time Zone +Database section 7. + + # 7. Database Ownership + # + # The TZ database itself is not an IETF Contribution or an IETF + # document. Rather it is a pre-existing and regularly updated work + # that is in the public domain, and is intended to remain in the + # public domain. Therefore, BCPs 78 [RFC5378] and 79 [RFC3979] do + # not apply to the TZ Database or contributions that individuals make + # to it. Should any claims be made and substantiated against the TZ + # Database, the organization that is providing the IANA + # Considerations defined in this RFC, under the memorandum of + # understanding with the IETF, currently ICANN, may act in accordance + # with all competent court orders. No ownership claims will be made + # by ICANN or the IETF Trust on the database or the code. Any person + # making a contribution to the database or code waives all rights to + # future claims in that contribution or in the TZ Database. + +---- + + +[[jgit]] +jgit + +* jgit +* jgit-archive +* jgit-servlet +* jgit-ssh-apache + +[[jgit_license]] +---- +This program and the accompanying materials are made available +under the terms of the Eclipse Distribution License v1.0 which +accompanies this distribution, is reproduced below, and is +available at http://www.eclipse.org/org/documents/edl-v10.php + +All rights reserved. + +Redistribution and use in source and binary forms, with or +without modification, are permitted provided that the following +conditions are met: + +- Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +- Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + +- Neither the name of the Eclipse Foundation, Inc. nor the + names of its contributors may be used to endorse or promote + products derived from this software without specific prior + written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND +CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR +CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, +STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +---- + + +[[jsch]] +jsch + +* jsch + +[[jsch_license]] +---- +Copyright (c) 2002-2012 Atsuhiko Yamanaka, JCraft,Inc. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + 1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the distribution. + + 3. The names of the authors may not be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, +INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JCRAFT, +INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, +OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +---- + + +[[jsoup]] +jsoup + +* jsoup:jsoup + +[[jsoup_license]] +---- +The MIT License + +© 2009-2016, Jonathan Hedley <jonathan@hedley.net> + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +---- + + +[[ow2]] +ow2 + +* ow2:ow2-asm +* ow2:ow2-asm-analysis +* ow2:ow2-asm-commons +* ow2:ow2-asm-tree +* ow2:ow2-asm-util + +[[ow2_license]] +---- +Copyright (c) 2000-2011 INRIA, France Telecom +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holders nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF +THE POSSIBILITY OF SUCH DAMAGE. + +---- + + +[[prologcafe]] +prologcafe + +* prolog:cafeteria +* prolog:compiler +* prolog:io +* prolog:runtime + +[[prologcafe_license]] +---- +Prolog Cafe (A Prolog to Java Translator System) +Copyright (C) 1997-2009 by Mutsunori Banbara and Naoyuki Tamura + +Prolog Cafe is free software; you can redistribute it and/or modify +it under the terms of either: + + * the GNU General Public License as published by the Free Software + Foundation; either version 2 of the License, or (at your option) + any later version, or + + * the Eclipse Public License +---- + +In the context of Gerrit Code Review, Prolog Cafe is consumed under +the <<prologcafe_EPL,EPL>>. Gerrit Code Review uses a fork derived +from the 1.2.5 release and offers the corresponding source code at +link:https://gerrit.googlesource.com/prolog-cafe[]. + +---- + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. +---- + +[[prologcafe_EPL]] +---- +Eclipse Public License - v 1.0 + +THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE +PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION +OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. + +1. DEFINITIONS + +"Contribution" means: + +a) in the case of the initial Contributor, the initial code and + documentation distributed under this Agreement, and +b) in the case of each subsequent Contributor: + +i) changes to the Program, and + +ii) additions to the Program; + +where such changes and/or additions to the Program originate from +and are distributed by that particular Contributor. A Contribution +'originates' from a Contributor if it was added to the Program +by such Contributor itself or anyone acting on such Contributor's +behalf. Contributions do not include additions to the Program which: +(i) are separate modules of software distributed in conjunction +with the Program under their own license agreement, and (ii) are +not derivative works of the Program. + +"Contributor" means any person or entity that distributes the Program. + +"Licensed Patents " mean patent claims licensable by a Contributor +which are necessarily infringed by the use or sale of its +Contribution alone or when combined with the Program. + +"Program" means the Contributions distributed in accordance with +this Agreement. + +"Recipient" means anyone who receives the Program under this +Agreement, including all Contributors. + +2. GRANT OF RIGHTS + +a) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free copyright + license to reproduce, prepare derivative works of, publicly display, + publicly perform, distribute and sublicense the Contribution of such + Contributor, if any, and such derivative works, in source code and + object code form. + +b) Subject to the terms of this Agreement, each Contributor hereby + grants Recipient a non-exclusive, worldwide, royalty-free patent + license under Licensed Patents to make, use, sell, offer to sell, + import and otherwise transfer the Contribution of such Contributor, + if any, in source code and object code form. This patent license + shall apply to the combination of the Contribution and the Program + if, at the time the Contribution is added by the Contributor, such + addition of the Contribution causes such combination to be covered + by the Licensed Patents. The patent license shall not apply to any + other combinations which include the Contribution. No hardware per + se is licensed hereunder. + +c) Recipient understands that although each Contributor grants the + licenses to its Contributions set forth herein, no assurances are + provided by any Contributor that the Program does not infringe + the patent or other intellectual property rights of any other + entity. Each Contributor disclaims any liability to Recipient + for claims brought by any other entity based on infringement + of intellectual property rights or otherwise. As a condition to + exercising the rights and licenses granted hereunder, each Recipient + hereby assumes sole responsibility to secure any other intellectual + property rights needed, if any. For example, if a third party patent + license is required to allow Recipient to distribute the Program, + it is Recipient's responsibility to acquire that license before + distributing the Program. + +d) Each Contributor represents that to its knowledge it has + sufficient copyright rights in its Contribution, if any, to grant + the copyright license set forth in this Agreement. + +3. REQUIREMENTS + +A Contributor may choose to distribute the Program in object code + form under its own license agreement, provided that: + +a) it complies with the terms and conditions of this Agreement; and + +b) its license agreement: + +i) effectively disclaims on behalf of all Contributors all warranties + and conditions, express and implied, including warranties or + conditions of title and non-infringement, and implied warranties or + conditions of merchantability and fitness for a particular purpose; + +ii) effectively excludes on behalf of all Contributors all liability + for damages, including direct, indirect, special, incidental and + consequential damages, such as lost profits; + +iii) states that any provisions which differ from this Agreement + are offered by that Contributor alone and not by any other + party; and + +iv) states that source code for the Program is available from such + Contributor, and informs licensees how to obtain it in a reasonable + manner on or through a medium customarily used for software exchange. + +When the Program is made available in source code form: + +a) it must be made available under this Agreement; and + +b) a copy of this Agreement must be included with each copy of the Program. + +Contributors may not remove or alter any copyright notices contained +within the Program. + +Each Contributor must identify itself as the originator of its +Contribution, if any, in a manner that reasonably allows subsequent +Recipients to identify the originator of the Contribution. + +4. COMMERCIAL DISTRIBUTION + +Commercial distributors of software may accept certain +responsibilities with respect to end users, business partners and the +like. While this license is intended to facilitate the commercial +use of the Program, the Contributor who includes the Program in a +commercial product offering should do so in a manner which does not +create potential liability for other Contributors. Therefore, if a +Contributor includes the Program in a commercial product offering, +such Contributor ("Commercial Contributor") hereby agrees to defend +and indemnify every other Contributor ("Indemnified Contributor") +against any losses, damages and costs (collectively "Losses") arising +from claims, lawsuits and other legal actions brought by a third +party against the Indemnified Contributor to the extent caused by +the acts or omissions of such Commercial Contributor in connection +with its distribution of the Program in a commercial product +offering. The obligations in this section do not apply to any claims +or Losses relating to any actual or alleged intellectual property +infringement. In order to qualify, an Indemnified Contributor must: +a) promptly notify the Commercial Contributor in writing of such +claim, and b) allow the Commercial Contributor to control, and +cooperate with the Commercial Contributor in, the defense and any +related settlement negotiations. The Indemnified Contributor may +participate in any such claim at its own expense. + +For example, a Contributor might include the Program in a +commercial product offering, Product X. That Contributor is then a +Commercial Contributor. If that Commercial Contributor then makes +performance claims, or offers warranties related to Product X, those +performance claims and warranties are such Commercial Contributor's +responsibility alone. Under this section, the Commercial Contributor +would have to defend claims against the other Contributors related +to those performance claims and warranties, and if a court requires +any other Contributor to pay any damages as a result, the Commercial +Contributor must pay those damages. + +5. NO WARRANTY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS +PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY +WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY +OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely +responsible for determining the appropriateness of using and +distributing the Program and assumes all risks associated with +its exercise of rights under this Agreement , including but not +limited to the risks and costs of program errors, compliance with +applicable laws, damage to or loss of data, programs or equipment, +and unavailability or interruption of operations. + +6. DISCLAIMER OF LIABILITY + +EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT +NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY +RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + +7. GENERAL + +If any provision of this Agreement is invalid or unenforceable under +applicable law, it shall not affect the validity or enforceability of +the remainder of the terms of this Agreement, and without further +action by the parties hereto, such provision shall be reformed +to the minimum extent necessary to make such provision valid and +enforceable. + +If Recipient institutes patent litigation against any entity +(including a cross-claim or counterclaim in a lawsuit) alleging +that the Program itself (excluding combinations of the Program with +other software or hardware) infringes such Recipient's patent(s), +then such Recipient's rights granted under Section 2(b) shall +terminate as of the date such litigation is filed. + +All Recipient's rights under this Agreement shall terminate if +it fails to comply with any of the material terms or conditions +of this Agreement and does not cure such failure in a reasonable +period of time after becoming aware of such noncompliance. If all +Recipient's rights under this Agreement terminate, Recipient agrees +to cease use and distribution of the Program as soon as reasonably +practicable. However, Recipient's obligations under this Agreement +and any licenses granted by Recipient relating to the Program shall +continue and survive. + +Everyone is permitted to copy and distribute copies of this +Agreement, but in order to avoid inconsistency the Agreement is +copyrighted and may only be modified in the following manner. The +Agreement Steward reserves the right to publish new versions +(including revisions) of this Agreement from time to time. No +one other than the Agreement Steward has the right to modify +this Agreement. The Eclipse Foundation is the initial Agreement +Steward. The Eclipse Foundation may assign the responsibility to +serve as the Agreement Steward to a suitable separate entity. Each +new version of the Agreement will be given a distinguishing +version number. The Program (including Contributions) may always be +distributed subject to the version of the Agreement under which it +was received. In addition, after a new version of the Agreement is +published, Contributor may elect to distribute the Program (including +its Contributions) under the new version. Except as expressly stated +in Sections 2(a) and 2(b) above, Recipient receives no rights or +licenses to the intellectual property of any Contributor under +this Agreement, whether expressly, by implication, estoppel or +otherwise. All rights in the Program not expressly granted under +this Agreement are reserved. + +This Agreement is governed by the laws of the State of New York and +the intellectual property laws of the United States of America. No +party to this Agreement will bring a legal action under this +Agreement more than one year after the cause of action arose. Each +party waives its rights to a jury trial in any resulting litigation. + +---- + + +[[protobuf]] +protobuf + +* protobuf + +[[protobuf_license]] +---- +Copyright 2008, Google Inc. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Code generated by the Protocol Buffer compiler is owned by the owner +of the input file used when generating it. This code is not +standalone and requires a support library to be linked with it. This +support library is itself covered by the above license. + +---- + + +[[slf4j]] +slf4j + +* log:api +* log:jcl-over-slf4j + +[[slf4j_license]] +---- +Copyright (c) 2004-2008 QOS.ch +All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +---- + + +[[xz]] +xz + +* tukaani-xz + +[[xz_license]] +---- +All the files in this package have been written by Lasse Collin +and/or Igor Pavlov. All these files have been put into the +public domain. You can do whatever you want with these files. +This software is provided "as is", without any warranty. + +---- + + +GERRIT +------ +Part of link:index.html[Gerrit Code Review] +
diff --git a/Documentation/backup.txt b/Documentation/backup.txt index dd47035..9139e71 100644 --- a/Documentation/backup.txt +++ b/Documentation/backup.txt
@@ -45,10 +45,6 @@ It can be recomputed from primary data in the git repositories but reindexing may take a long time hence backing up the index makes sense for production installations. -+ -If you have chosen to use _Elastic Search_ for indexing, -refer to its -link:https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[backup documentation,role=external,window=_blank]. [#optional-backup-cache] Caches::
diff --git a/Documentation/cmd-copy-approvals.txt b/Documentation/cmd-copy-approvals.txt new file mode 100644 index 0000000..ba5344f --- /dev/null +++ b/Documentation/cmd-copy-approvals.txt
@@ -0,0 +1,60 @@ += gerrit copy-approvals + +== NAME +gerrit copy-approvals - Copy all inferred approvals labels to the latest patch-set. + +== SYNOPSIS +[verse] +-- +_ssh_ -p <port> <host> _gerrit copy-approvals_ + [--verbose | -v] + [PROJECT]... +-- + +== DESCRIPTION +Gerrit has historically computed votes using an inference algorithm that +was cumulating them from all the patch-sets. That was not efficient since +it had to take into account copied votes from very old patchsets. +E.g, votes sometimes need to be copied from ps1 to ps10. + +Gerrit copy the approvals from the inferred votes to the latest patch-sets +once a change receives a new label update. + +The copy-approval command scans all the changes of a project and looks for +all votes that have not been copied yet, calculate the inferred score and +apply that as copied label to the latest patch-set. + +NOTE: The label copied as part of this process receives the grant date of +the timestamp of the copy-approval command execution, not the one associated +with the inferred vote. + +== OPTIONS + +--verbose:: +-v:: + Display projects/changes impacted by the label copy operation. + +== ACCESS +Only the user with MAINTAIN_SERVER permissions can run this command. + +== SCRIPTING +This command is intended to be used in scripts. + +== EXAMPLES + +Copy all inferred labels on the project 'foo' +---- +$ ssh -p 29418 review.example.com gerrit copy-approvals foo +---- + +Copy all inferred labels on all projects +---- +$ ssh -p 29418 review.example.com gerrit copy-approvals +---- + +GERRIT +------ +Part of link:index.html[Gerrit Code Review] + +SEARCHBOX +---------
diff --git a/Documentation/cmd-index.txt b/Documentation/cmd-index.txt index 99ff0db..7f1a6e8 100644 --- a/Documentation/cmd-index.txt +++ b/Documentation/cmd-index.txt
@@ -58,6 +58,9 @@ link:cmd-ban-commit.html[gerrit ban-commit]:: Bans a commit from a project's repository. +link:cmd-copy-approvals.html[gerrit copy-approvals]:: + Copy all inferred approvals labels to the latest patch-set. + link:cmd-create-branch.html[gerrit create-branch]:: Create a new project branch. @@ -157,6 +160,9 @@ link:cmd-ls-user-refs.html[gerrit ls-user-refs]:: Lists refs visible for a specified user. +link:cmd-migrate-externalids-to-insensitive.html[gerrit migrate-externalids-to-insensitive]:: + Migrate external-ids to case insensitive. + link:cmd-plugin-install.html[gerrit plugin add]:: Alias for 'gerrit plugin install'. @@ -247,6 +253,18 @@ Given the trace ID an administrator can find the corresponding logs and investigate issues more easily. +[[deadline]] +=== Setting a deadline + +When invoking an SSH command it's possible that the client sets a deadline +after which the request should be aborted. To do this the +`--deadline <deadline>` option must be set on the request. Values must be +specified using standard time unit abbreviations ('ms', 'sec', 'min', etc.). + +---- + $ ssh -p 29418 review.example.com gerrit create-project --deadline 5m foo/bar +---- + GERRIT ------ Part of link:index.html[Gerrit Code Review]
diff --git a/Documentation/cmd-migrate-externalids-to-insensitive.txt b/Documentation/cmd-migrate-externalids-to-insensitive.txt new file mode 100644 index 0000000..b023089 --- /dev/null +++ b/Documentation/cmd-migrate-externalids-to-insensitive.txt
@@ -0,0 +1,44 @@ += gerrit migrate-externalids-to-insensitive + +== NAME +gerrit migrate-externalids-to-insensitive - Migrate external-ids to case insensitive. + +== SYNOPSIS +[verse] +-- +_ssh_ -p <port> <host> _gerrit migrate-externalids-to-insensitive_ +-- + +== DESCRIPTION +This command allows to trigger online conversion of `username` and +`gerrit` external IDs to be handled case insensitively. This is done by +recomputing the name of the note from the sha1 sum of the all lowercase +external ID key, instead of preserving the key capitalization. + +The command requires link:#auth.userNameCaseInsensitive[auth.userNameCaseInsensitive] and +link:#auth.userNameCaseInsensitiveMigrationMode[auth.userNameCaseInsensitiveMigrationMode] to +be set to true to perform the migration. + +After the successful migration +link:#auth.userNameCaseInsensitiveMigrationMode[auth.userNameCaseInsensitiveMigrationMode] is +set to false. + +== ACCESS +Caller must be a member of the privileged 'Administrators' group. + +== SCRIPTING +This command is intended to be used in scripts. + +== EXAMPLES +Start the online external ids migration: + +---- +$ ssh -p 29418 review.example.com gerrit migrate-externalids-to-insensitive +---- + +GERRIT +------ +Part of link:index.html[Gerrit Code Review] + +SEARCHBOX +---------
diff --git a/Documentation/cmd-set-account.txt b/Documentation/cmd-set-account.txt index 6808e017..02eaf83 100644 --- a/Documentation/cmd-set-account.txt +++ b/Documentation/cmd-set-account.txt
@@ -14,7 +14,8 @@ [--delete-ssh-key - | <KEY> | ALL] [--generate-http-password] [--http-password <PASSWORD>] - [--clear-http-password] <USER> + [--clear-http-password] + [--delete-external-id <EXTERNALID>] <USER> -- == DESCRIPTION @@ -106,6 +107,13 @@ --clear-http-password:: Clear the HTTP password for the user account. +--delete-external-id:: + Delete an external ID from a user's account if it exists. + If the external ID provided is 'ALL', all associated + external IDs are deleted from this account. + May be supplied more than once to remove multiple external + IDs from an account in a single command execution. + == EXAMPLES Add an email and SSH key to `watcher`'s account:
diff --git a/Documentation/config-accounts.txt b/Documentation/config-accounts.txt index 9b99960..aca9591 100644 --- a/Documentation/config-accounts.txt +++ b/Documentation/config-accounts.txt
@@ -3,8 +3,7 @@ == Overview -Starting from 2.15 Gerrit accounts are fully stored in -link:note-db.html[NoteDb]. +Gerrit accounts are stored in link:note-db.html[NoteDb]. The account data consists of a sequence number (account ID), account properties (full name, display name, preferred email, registration @@ -112,8 +111,8 @@ Accessing the account data in Git is not fast enough for account queries, since it requires accessing all user branches and parsing all files in each of them. To overcome this Gerrit has a secondary -index for accounts. The account index is either based on -link:config-gerrit.html#index.type[Lucene or Elasticsearch]. +index for accounts. The account index is based on +link:config-gerrit.html#index.type[Lucene]. Via the link:rest-api-accounts.html#query-account[Query Account] REST endpoint link:user-search-accounts.html[generic account queries] are @@ -298,6 +297,13 @@ This ensures that an external ID is used only once (e.g. an external ID can never be assigned to multiple accounts at a point in time). +By default, the SHA-1 sum is computed preserving the case of the external ID. If +auth.userNameCaseInsensitive` is set to `true`, the SHA-1 sum of external IDs +in the `gerrit:` and `username:` schemes are computed from the all lowercase +external ID. This enables case insensitive username handling. The case of the +external ID is however preserved by using the original capitalization in the +note content. + The following commands show how to find the SHA-1 of an external ID: ----
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt index 87e4761..d942aa3 100644 --- a/Documentation/config-gerrit.txt +++ b/Documentation/config-gerrit.txt
@@ -652,6 +652,43 @@ + By default this is set to false. +[[auth.userNameCaseInsensitive]]auth.userNameCaseInsensitive:: ++ +If set the username will be handled case insensitively but case preserving, +i.e. a user can login with `johndoe` or `JohnDoe` for the same account +created for `JohnDoe`. The form of the username used during account creation +will be used wherever the username is displayed. Sandbox branches created +for a user can also only be created for this original form. ++ +Note, that this does not work for all existing accounts, if they were +not originally created with all lowercase, since the note keys of the +external IDs will not match the new scheme. For more details refer to +the link:config-accounts.html#external-ids[External ID documentation]. ++ +Gerrit provides the +link:pgm-ChangeExternalIdCaseSensitivity.html[offline] +and the online link:externalid-case-insensitivity.html#online-migration[online] +tools to migrate existing accounts to match the new scheme. ++ +Naturally, if there were two accounts only different in capitalization, +e.g. `johndoe` and `JohnDoe`, the account `JohnDoe` will not be able +to authenticate anymore after setting this option. If such duplicate +accounts exist the migration tool will fail, since the newly computed +note name would be identical and thus conflict. These duplicates thus +have to be deleted manually by deleting the respective external ID. ++ +For newly initialized sites this option defaults to true. ++ +Default is false. + +[[auth.userNameCaseInsensitiveMigrationMode]]auth.userNameCaseInsensitiveMigrationMode:: ++ +Setting migration mode to true allows to fallback to case sensitive +behaviour if the migrated external ID cannot be found. This allows to +trigger the migration while Gerrit process is running. ++ +Default is false. + [[auth.enableRunAs]]auth.enableRunAs:: + If true HTTP REST APIs will accept the `X-Gerrit-RunAs` HTTP request @@ -789,8 +826,7 @@ [[cache.name.maxAge]]cache.<name>.maxAge:: + -Maximum age to keep an entry in the cache. Entries are removed from -the cache and refreshed from source data every maxAge interval. +Maximum age to keep an entry in the cache. Values should use common unit suffixes to express their setting: + * s, sec, second, seconds @@ -821,18 +857,21 @@ entry is relatively the same, memoryLimit is currently defined to be the number of entries held by the cache (each entry costs 1). + -For caches where the size of an entry can vary significantly between -individual entries (notably `"diff"`, `"diff_intraline"`), memoryLimit -is an approximation of the total number of bytes stored by the cache. -Larger entries that represent bigger patch sets or longer source files -will consume a bigger portion of the memoryLimit. For these caches the -memoryLimit should be set to roughly the amount of RAM (in bytes) the -administrator can dedicate to the cache. +For caches where the size of an entry can vary significantly between individual +entries (notably `"git_modified_files"`, `"modified_files"`, `"git_file_diff"`, +`"gerrit_file_diff"`, `"diff_intraline"`), memoryLimit is an approximation of +the total number of bytes stored by the cache. Larger entries that represent +bigger patch sets or longer source files will consume a bigger portion of the +memoryLimit. For these caches the memoryLimit should be set to roughly the +amount of RAM (in bytes) the administrator can dedicate to the cache. + Default is 1024 for most caches, except: + * `"adv_bases"`: default is `4096` -* `"diff"`: default is `10m` (10 MiB of memory) +* `"git_modified_files"`: default is `10m` (10 MiB of memory) +* `"modified_files"`: default is `10m` (10 MiB of memory) +* `"git_file_diff"`: default is `10m` (10 MiB of memory) +* `"gerrit_file_diff"`: default is `10m` (10 MiB of memory) * `"diff_intraline"`: default is `10m` (10 MiB of memory) * `"diff_summary"`: default is `10m` (10 MiB of memory) * `"external_ids_map"`: default is `2` and should not be changed @@ -881,20 +920,6 @@ + If 0 or negative, disk storage for the cache is disabled. -[[cache.name.expireAfterWrite]]cache.<name>.expireAfterWrite:: -+ -Duration after which a cached value will be evicted and not -read anymore. -+ -Values should use common unit suffixes to express their setting: -+ -* ms, milliseconds -* s, sec, second, seconds -* m, min, minute, minutes -* h, hr, hour, hours -+ -Disabled by default. - [[cache.name.refreshAfterWrite]]cache.<name>.refreshAfterWrite:: + Duration after which we asynchronously refresh the cached value. @@ -935,6 +960,12 @@ + If direct updates are made to `All-Users`, this cache should be flushed. +cache `"approvals"`:: ++ +Cache entries contain approvals for a given patch set. This includes +approvals granted on this patch set as well as approvals copied from +earlier patch sets. + cache `"adv_bases"`:: + Used only for push over smart HTTP when branch level access controls @@ -963,16 +994,45 @@ The cache should be flushed whenever NoteDb change metadata in a repository is modified outside of Gerrit. -cache `"diff"`:: +cache `"changes_by_project"`:: + -Each item caches the differences between two commits, at both the -directory and file levels. Gerrit uses this cache to accelerate -the display of affected file names, as well as file contents. +Ideally, the memorylimit of this cache is large enough to cover all projects. +This should significantly speed up change ref advertisements and git pushes, +especially for projects with lots of changes, and particularly on replicas +where there is no index. + +cache `"git_modified_files"`:: ++ +Each item caches the list of git modified files between two git trees +corresponding to two different commits. This cache does not read the actual +file contents nor does it include the edits (modified regions) of the files. + +cache `"modified_files"`:: ++ +Each item caches the list of modified files between two commits. This cache +is similar to the `git_modified_files` cache but performs extra logic including +filtering out files that are untouched by both commits because they were purely +modified between the parent commits. + +cache `"git_file_diff"`:: ++ +Each item caches the pure git diff between two git trees for a specific file +path. The diff includes all the file attributes (old/new paths, change/patch +types) as well as the list of edits corresponding to the modified regions in +the file. + +cache `"gerrit_file_diff"`:: ++ +Each item caches the diff between two git commits for a specific file path. +This cache is similar to the `git_file_diff` cache but performs extra logic +including identifying the edits that are due to rebase. The diff for the +"commit message" and "merge list" can also be requested from this cache. + Entries in this cache are relatively large, so memoryLimit is an estimate in bytes of memory used. Administrators should try to target cache.diff.memoryLimit to fit all changes users will view in a 1 or 2 -day span. +day span. The same applies for other diff caches: `"git_modified_files"`, +`"modified_files"` and `"git_file_diff"`. cache `"diff_intraline"`:: + @@ -1187,9 +1247,9 @@ ==== [[cache_options]]Cache Options -[[cache.diff.timeout]]cache.diff.timeout:: +[[cache.git_file_diff.timeout]]cache.git_file_diff.timeout:: + -Maximum number of milliseconds to wait for diff data before giving up and +Maximum number of milliseconds to wait for git diff data before giving up and falling back on a simpler diff algorithm that will not be able to break down modified regions into smaller ones. This is a work around for an infinite loop bug in the default difference algorithm implementation. @@ -1326,15 +1386,16 @@ [[change.cacheAutomerge]]change.cacheAutomerge:: + -When reviewing merge commits, the left-hand side shows the output of the -result of JGit's automatic merge algorithm. This option controls whether -this output is cached in the change repository, or if only the diff is -cached in the persistent `diff` cache. +When reviewing merge commits, the left-hand side shows the output of the result +of JGit's automatic merge algorithm. This option controls whether this output is +cached in the change repository, or if only the diff is cached in the persistent +diff caches (`"git_modified_files"`, `modified_files`, `"git_file_diff"`, +`"file_diff"`). + If true, automerge results are stored in the repository under `refs/cache-automerge/*`; the results of diffing the change against its -automerge base are stored in the diff cache. If false, no extra data is -stored in the repository, only the diff cache. This can result in slight +automerge base are stored in the diff caches. If false, no extra data is +stored in the repository, only the diff caches. This can result in slight performance improvements by reducing the number of refs in the repo. + Default is true. @@ -1443,8 +1504,24 @@ query operator. Gerrit does not serve `mergeable` in link:rest-api-changes.html#change-info[ChangeInfo]. +NOTE: Gerrit would only render conflict changes section on change +screen if `API_REF_UPDATED_AND_CHANGE_REINDEX` value is set. + Default is `NEVER`. +[[change.conflictsPredicateEnabled]]change.conflictsPredicateEnabled:: + ++ +This setting determines when Gerrit renders conflict changes section on change +screen and also supports `conflicts` predicate. This computation is expensive, +computing ConflictsPredicate has a runtime complexity of O(nˆ2) with n number +of open changes on a branch. When set to false GUI will silently ignore the +error message and leave the conflict changes section on change screen empty. +See also implications on rendering of conflict changes section in configuration +section:link:#change.mergeabilityComputationBehavior[change.mergeabilityComputationBehavior]. + +Default is true. + [[change.maxSubmittableAtOnce]]change.maxSubmittableAtOnce:: + Maximum number of changes that can be chained together in the same repository @@ -1469,21 +1546,6 @@ + By default true. -[[change.replyLabel]]change.replyLabel:: -+ -Label name for the reply button. In the user interface an ellipsis (…) -is appended. -+ -Default is "Reply". In the user interface it becomes "Reply…". - -[[change.replyTooltip]]change.replyTooltip:: -+ -Tooltip for the reply button. In the user interface a note about the -keyboard shortcut is appended. -+ -Default is "Reply and score". In the user interface it becomes "Reply -and score (Shortcut: a)". - [[change.robotCommentSizeLimit]]change.robotCommentSizeLimit:: + Maximum allowed size in characters of a robot comment. Robot comments which @@ -1827,6 +1889,13 @@ to run a new Gerrit daemon successfully. If not set, defaults to 90 seconds. +[[container.shutdownTimeout]]container.shutdownTimeout:: ++ +The maximum time (in seconds) to wait for a gerrit.sh stop command. +This is added to the highest value between either 'sshd.gracefulStopTimeout' +or 'httpd.gracefulStopTimeout'. If not set, defaults to +30 seconds + [[container.user]]container.user:: + Login name (or UID) of the operating system user the Gerrit JVM @@ -2012,7 +2081,8 @@ scheme = http scheme = anon_http scheme = anon_git - scheme = repo_download + scheme = repo + hide = ssh ---- The download section configures the allowed download methods. @@ -2069,17 +2139,29 @@ necessary to set <<gerrit.canonicalGitUrl,gerrit.canonicalGitUrl>> variable. + -* `repo_download` +* `repo` + Gerrit advertises patch set downloads with the `repo download` command, assuming that all projects managed by this instance are -generally worked on with the repo multi-repository tool. This is -not default, as not all instances will deploy repo. +generally worked on with the +https://gerrit.googlesource.com/git-repo[repo multi-repository tool]. +This is not default, as not all instances will deploy repo. + If `download.scheme` is not specified, SSH, HTTP and Anonymous HTTP downloads are allowed. +[[download.hide]]download.hide:: ++ +Schemes that can be used to download changes, but will not be advertised +in the UI. This can be any scheme that can be configured in <<download.scheme>>. ++ +This is mostly useful in a deprecation scenario during a time where using +a scheme is discouraged, but has to be supported until all clients have +migrated to use a different scheme. ++ +By default, no scheme will be hidden in the UI. + [[download.checkForHiddenChangeRefs]]download.checkForHiddenChangeRefs:: + Whether the download commands should be adapted when the change refs @@ -2292,6 +2374,25 @@ + By default unset. +[[gerrit.installIndexModule]]gerrit.installIndexModule:: ++ +Class name of the Guice modules to load as alternate implementation +for the Gerrit indexes backend. +Classes are resolved using the primary Gerrit class loader, hence the +class needs to be either declared in Gerrit or an additional JAR +located under the `/lib` directory. ++ +NOTE: The `gerrit.installIndexModule` has precedence over the +`index.type`. ++ +By default unset. ++ +Example: +---- +[gerrit] + installIndexModule = com.google.gerrit.elasticsearch.ElasticIndexModule +---- ++ [[gerrit.installModule]]gerrit.installModule:: + Repeatable list of class name of additional Guice modules to load at @@ -3112,23 +3213,13 @@ [[index.type]]index.type:: + -Type of secondary indexing employed by Gerrit. The supported -values are: +*(DEPRECATED)* The only supported value is `LUCENE`, which is the default, +that means a link:http://lucene.apache.org/[Lucene] +index is used. + -* `LUCENE` +For using other indexing backends (e.g. ElasticSearch), refer to +`gerrit.installIndexModule` setting. + -A link:http://lucene.apache.org/[Lucene] index is used. -+ -+ -* `ELASTICSEARCH` look into link:#elasticsearch[Elasticsearch section] -+ -An link:https://www.elastic.co/products/elasticsearch[Elasticsearch,role=external,window=_blank] index is -used. Refer to the link:#elasticsearch[Elasticsearch section] for further -configuration details. - -+ -By default, `LUCENE`. - [[index.threads]]index.threads:: + Number of threads to use for indexing in normal interactive operations. Setting @@ -3172,10 +3263,10 @@ + * `SEARCH_AFTER` + -Index queries are repeated using a search-after object. This type -is supported for Lucene and ElasticSearch. Other index backends can -provide their custom implementations for search-after. Note that, -`SEARCH_AFTER` does not impact using offsets in Gerrit query APIs. +Index queries are repeated using a search-after object. Index +backends can provide their custom implementations for search-after. +Note that, `SEARCH_AFTER` does not impact using offsets in Gerrit +query APIs. _Note: Depending on the index backend and its settings, results may be inaccurate if the data-set is changing during the query execution._ + @@ -3197,11 +3288,6 @@ limit will truncate the list (but will still set `_more_changes` on result lists). Set to 0 for no limit. + -When `index.type` is set to `ELASTICSEARCH`, this value should not exceed -the `index.max_result_window` value configured on the Elasticsearch -server. If a value is not configured during site initialization, defaults to -10000, which is the default value of `index.max_result_window` in Elasticsearch. -+ When `index.type` is set to `LUCENE`, defaults to no limit. [[index.maxPages]]index.maxPages:: @@ -3235,10 +3321,6 @@ Setting link:#index.maxPageSize[index.maxPageSize] that isn't too large, can likely help reduce the impacts of this. + -A large multiplier with an appropriate link:#index.maxPageSize[index.maxPageSize] -should benefit external index backends such as Elasticsearch more, which have -a relatively high query latency. -+ For example, if the limit of the previous query was 500 and pageSizeMultiplier is configured to 5, the next query will have a limit of 2500. + @@ -3321,7 +3403,7 @@ + Whether the scheduled indexer is enabled. If the scheduled indexer is disabled you must implement other means to keep the group index for the -replica up-to-date (e.g. by using ElasticSearch for the indexes). +replica up-to-date. + Defaults to `true`. @@ -3454,95 +3536,6 @@ ---- -[[elasticsearch]] -=== Section elasticsearch - -WARNING: Support for Elasticsearch is still experimental and is not recommended -for production use. For compatibility information, please refer to the -link:https://www.gerritcodereview.com/elasticsearch.html[project homepage,role=external,window=_blank]. - -Note that when Gerrit is configured to use Elasticsearch, the Elasticsearch -server(s) must be reachable during the site initialization. - -[[elasticsearch.prefix]]elasticsearch.prefix:: -+ -This setting can be used to prefix index names to allow multiple Gerrit -instances in a single Elasticsearch cluster. Prefix `gerrit1_` would result in a -change index named `gerrit1_changes_0001`. -+ -Not set by default. - -[[elasticsearch.server]]elasticsearch.server:: -+ -Elasticsearch server URI in the form `http[s]://hostname:port`. The `port` is -optional and defaults to `9200` if not specified. -+ -At least one server must be specified. May be specified multiple times to -configure multiple Elasticsearch servers. -+ -Note that the site initialization program only allows to configure a single -server. To configure multiple servers the `gerrit.config` file must be edited -manually. - -[[elasticsearch.numberOfShards]]elasticsearch.numberOfShards:: -+ -Sets the number of shards to use per index. Refer to the -link:https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#_static_index_settings[ -Elasticsearch documentation,role=external,window=_blank] for details. -+ -Defaults to 1. - -[[elasticsearch.numberOfReplicas]]elasticsearch.numberOfReplicas:: -+ -Sets the number of replicas to use per index. Refer to the -link:https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#dynamic-index-settings[ -Elasticsearch documentation,role=external,window=_blank] for details. -+ -Defaults to 1. - -[[elasticsearch.maxResultWindow]]elasticsearch.maxResultWindow:: -+ -Sets the maximum value of `from + size` for searches to use per index. Refer to the -link:https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#dynamic-index-settings[ -Elasticsearch documentation,role=external,window=_blank] for details. -+ -Defaults to 10000. - -[[elasticsearch.connectTimeout]]elasticsearch.connectTimeout:: -+ -Sets the timeout for connecting to elasticsearch. -+ -Defaults to `1 second`. - -[[elasticsearch.socketTimeout]]elasticsearch.socketTimeout:: -+ -Sets the timeout for the underlying connection. For more information, refer to -link:#httpd.idleTimeout[`httpd.idleTimeout`]. -+ -Defaults to `30 seconds`. - -==== Elasticsearch Security - -When security is enabled in Elasticsearch, the username and password must be provided. -Note that the same username and password are used for all servers. - -For further information about Elasticsearch security, please refer to -link:https://www.elastic.co/guide/en/elasticsearch/reference/current/security-getting-started.html[the documentation,role=external,window=_blank]. -This is the current documentation link. Select another Elasticsearch version -from the dropdown menu available on that page if need be. - -[[elasticsearch.username]]elasticsearch.username:: -+ -Username used to connect to Elasticsearch. -+ -If a password is set, defaults to `elastic`, otherwise not set by default. - -[[elasticsearch.password]]elasticsearch.password:: -+ -Password used to connect to Elasticsearch. -+ -Not set by default. - [[event]] === Section event @@ -4466,9 +4459,29 @@ be specified using standard time unit abbreviations ('ms', 'sec', 'min', etc.). + +After the timeout is exceeded the task processing the receive gets a +cancellation signal that allows the tast to finish gracefully. +link:#receive.cancellationTimeout[receive.cancellationTimeout] +defines how much time the task has to react to the cancellation signal +before it is focefully cancelled. ++ +The receive timeout cannot be overriden by setting a higher +link:user-upload.html#deadline[deadline] on the git push request. ++ Default is 4 minutes. If no unit is specified, milliseconds is assumed. +[[receive.cancellationTimeout]]receive.cancellationTimeout:: ++ +Defines the time that a receive task has to react to a cancellation +signal and finish gracefully after link:#receive.timeout[receive.timeout] +is exceeded. If the receive task is still not terminated after the +cancellation timeout is exceeded the task is forcefully cancelled. +Values can be specified using standard time unit abbreviations ('ms', +'sec', 'min', etc.). ++ +Default is 5 seconds. If no unit is specified, milliseconds is assumed. + [[receive.trustedKey]]receive.trustedKey:: + List of GPG key fingerprints that should be considered trust roots by @@ -4589,8 +4602,7 @@ [[retry.retryWithTraceOnFailure]]retry.retryWithTraceOnFailure:: + Whether Gerrit should automatically retry operations on failure with tracing -enabled. The automatically generated traces can help with debugging. Please -note that only some of the REST endpoints support automatic retry. +enabled. The automatically generated traces can help with debugging. + By default this is set to false. @@ -5422,13 +5434,25 @@ end of the request the performance events are handed over to the link:dev-plugins.html#performance-logger[PerformanceLogger] plugins. This means if performance logging is enabled, the memory footprint of -requests is slightly increased. +requests can be markedly increased. +In one recorded case the impact was an overall heap increase of 40% +(using the metrics-reporter-graphite plugin), in other instances the +heap increase wasn't nearly as dramatic and the impact is most likely +dependent on which plugin is used. + -This setting has no effect if no -link:dev-plugins.html#performance-logger[PerformanceLogger] plugins are -installed, because then performance logging is always disabled. +By default, false. + +[[tracing.exportPerformanceMetrics]]tracing.exportPerformanceMetrics:: + -By default, true. +Whether to export performance metrics. ++ +Performace logged when link:#tracing.performanceLogging[`performanceLogging`] is +enabled, can be exported as metrics. ++ +NOTE: Since the payload returned could be of tens of thousands metrics, +assess the latency of the metrics endpoint before enabling this option. ++ +By default, false. [[tracing.traceid]] ==== Subsection tracing.<trace-id> @@ -5451,13 +5475,27 @@ [[tracing.traceid.requestUriPattern]]tracing.<trace-id>.requestUriPattern:: + Regular expression to match request URIs for which request tracing -should be always enabled. Request URIs are only available for REST -requests. Request URIs never include the '/a' prefix. +should be enabled except if they match +link:tracing.traceid.excludedRequestUriPattern[excludedRequestUriPattern]. +Request URIs are only available for REST requests. Request URIs never include +the '/a' prefix. + May be specified multiple times. + By default, unset (all request URIs are matched). +[[tracing.traceid.excludedRequestUriPattern]]tracing.<trace-id>.excludedRequestUriPattern:: ++ +Regular expression to match request URIs for which request tracing +should not be enabled even if they match +link:#tracing.traceid.requestUriPattern[requestUriPattern]. +Request URIs are only available for REST requests. Request URIs never include +the '/a' prefix. ++ +May be specified multiple times. ++ +By default, unset (no request URIs are excluded). + [[tracing.traceid.account]]tracing.<trace-id>.account:: + Account ID of an account for which request tracing should be always @@ -5476,6 +5514,91 @@ + By default, unset (all projects are matched). +[[deadline.id]] +==== Subsection deadline.<id> + +There can be multiple `deadline.<id>` subsections to configure deadlines for +request executions. For a deadline to apply all conditions of the +`deadline.<id>` subsection must match. The subsection name is the ID of the +deadline configuration and allows to track back an applied deadline to its +configuration. + +Clients can override the deadlines that are configured here by setting a +deadline on the request. + +Deadlines are only supported for `REST`, `SSH` and `GIT_RECEIVE` requests, but +not for `GIT_UPLOAD` requests. + +[[deadline.id.timeout]]deadline.<id>.timeout:: ++ +Timeout after which matching requests should be cancelled. ++ +Values must be specified using standard time unit abbreviations ('ms', 'sec', +'min', etc.). ++ +For some requests additional timeout configurations may apply, e.g. +link:#receive.timeout[receive.timeout] for git pushes. ++ +By default, unset. + +[[deadline.id.isAdvisory]]deadline.<id>.isAdvisory:: ++ +Whether this deadline is an advisory deadline. Advisory deadlines do not cause +requests to be aborted when they are exceeded. Instead, if an advisory deadline +is exceeded, only the `cancellation/advisory_deadline_count` metrics is +incremented and a log is written. This is useful to test how many requests would +be affected by a new deadline configuration. ++ +By default, `false`. + +[[deadline.id.requestType]]deadline.<id>.requestType:: ++ +Type of request to which the deadline applies (can be `GIT_RECEIVE`, `REST` and +`SSH`). ++ +May be specified multiple times. ++ +By default, unset (all request types are matched). + +[[deadline.id.requestUriPattern]]deadline.<id>.requestUriPattern:: ++ +Regular expression to match request URIs to which the deadline applies except if +they match +link:#deadline.id.excludedRequestUriPattern[excludedRequestUriPattern]. Request +URIs are only available for REST requests. Request URIs never include the '/a' +prefix. ++ +May be specified multiple times. ++ +By default, unset (all request URIs are matched). + +[[deadline.id.excludedRequestUriPattern]]deadline.<id>.excludedRequestUriPattern:: ++ +Regular expression to match request URIs to which the deadline should not be +applied even if they match +link:#deadline.id.requestUriPattern[requestUriPattern]. Request URIs are only +available for REST requests. Request URIs never include the '/a' prefix. ++ +May be specified multiple times. ++ +By default, unset (no request URIs are excluded). + +[[deadline.id.account]]deadline.<id>.account:: ++ +Account ID of an account to which the deadline applies. ++ +May be specified multiple times. ++ +By default, unset (all accounts are matched). + +[[deadline.id.projectPattern]]deadline.<id>.projectPattern:: ++ +Regular expression to match project names to which the deadline applies. ++ +May be specified multiple times. ++ +By default, unset (all projects are matched). + [[trackingid]] === Section trackingid @@ -5649,7 +5772,7 @@ Email address that Gerrit refers to itself as when it creates a new Git commit, such as a merge commit during change submission. + -If not set, Gerrit generates this as "gerrit@`hostname`", where +If not set, Gerrit generates this as "gerrit@``hostname``", where `hostname` is the hostname of the system Gerrit is running on. + By default, not set, generating the value at startup.
diff --git a/Documentation/config-labels.txt b/Documentation/config-labels.txt index 9d3446e..5889c75 100644 --- a/Documentation/config-labels.txt +++ b/Documentation/config-labels.txt
@@ -268,6 +268,58 @@ If true, any score for the label is copied forward when a new patch set is uploaded. Defaults to false. +[[label_copyCondition]] +=== `label.Label-Name.copyCondition` + +If set, Gerrit matches patch set approvals against the provided query +string. If the query matches, the approval is copied from one patch set +to the next. The query language is the same as for +link:user-search.html[other queries]. + +This logic is triggered whenever a new patch set is uploaded. + +Gerrit currently supports the following predicates: + +==== changekind:{REWORK,TRIVIAL_REBASE,MERGE_FIRST_PARENT_UPDATE,NO_CODE_CHANGE,NO_CHANGE} + +Matches if the diff between two patch sets was of a certain change kind. + +==== is:{MIN,MAX,ANY} + +Matches votes that are equal to the minimal or maximal voting range. Or any votes. + +==== approverin:link:rest-api-groups.html#group-id[\{group-id\}] + +Matches votes granted by a user who is a member of +link:rest-api-groups.html#group-id[\{group-id\}]. + +Avoid using a group name with spaces (if it has spaces, use the group uuid). +Although supported for convenience, it's better to use group uuid than group +name since using names only works as long as the names are unique (and future +groups with the same name will break the query). + +==== uploaderin:link:rest-api-groups.html#group-id[\{group-id\}] + +Matches votes where the new patch set was uploaded by a member of +link:rest-api-groups.html#group-id[\{group-id\}]. + +Avoid using a group name with spaces (if it has spaces, use the group uuid). +Although supported for convenience, it's better to use group uuid than group +name since using names only works as long as the names are unique (and future +groups with the same name will break the query). + +==== has:unchanged-files + +Matches when the new patch-set includes the same files as the old patch-set. + +Only 'unchanged-files' is supported for 'has'. + +==== Example + +---- +copyCondition = is:MIN OR -change-kind:REWORK OR uploaderin:dead...beef +---- + [[label_copyMinScore]] === `label.Label-Name.copyMinScore`
diff --git a/Documentation/config-project-config.txt b/Documentation/config-project-config.txt index a01df50..4dff685 100644 --- a/Documentation/config-project-config.txt +++ b/Documentation/config-project-config.txt
@@ -165,21 +165,21 @@ a commit for review that doesn't contain a Change-Id in the commit message fails with link:error-missing-changeid.html[missing Change-Id in commit message footer]. - ++ It is recommended to set this option and use a link:user-changeid.html#create[commit-msg hook] (or other client side tooling like EGit) to automatically generate Change-Id's for new commits. This way the Change-Id is automatically in place when changes are reworked or rebased and uploading new patch sets gets easy. - ++ If this option is not set, commits can be uploaded without a Change-Id, but then users have to remember to copy the assigned Change-Id from the change screen and insert it manually into the commit message when they want to upload a second patch set. - ++ Default is `INHERIT`, which means that this property is inherited from the parent project. The global default for new hosts is `true` - ++ This option is deprecated and future releases will behave as if this is always `true`. @@ -262,18 +262,18 @@ [[receive.createNewChangeForAllNotInTarget]]receive.createNewChangeForAllNotInTarget:: + -The `create-new-change-for-all-not-in-target` option provides a -convenience for selecting link:user-upload.html#base[the merge base] -by setting it automatically to the target branch's tip so you can -create new changes for all commits not in the target branch. - +This option provides a convenience for selecting +link:user-upload.html#base[the merge base] by setting it automatically +to the target branch's tip so you can create new changes for all +commits not in the target branch. ++ This option is disabled if the tip of the push is a merge commit. - ++ This option also only works if there are no merge commits in the commit chain, in such cases it fails warning the user that such pushes can only be performed by manually specifying link:user-upload.html#base[bases] - ++ This option is useful if you want to push a change to your personal branch first and for review to another branch for example. Or in cases where a commit is already merged into a branch and you want to create @@ -494,9 +494,9 @@ names in this section defines the branch order. The topmost is considered to be the least stable branch (typically the master branch) and the last one the most stable (typically the last maintained release branch). - ++ Example: - ++ ---- [branchOrder] branch = master @@ -504,13 +504,13 @@ branch = stable-2.8 branch = stable-2.7 ---- - ++ The `branchOrder` section is inheritable. This is useful when multiple or all projects follow the same branch rules. A `branchOrder` section in a child project completely overrides any `branchOrder` section from a parent i.e. there is no merging of `branchOrder` sections. A present but empty `branchOrder` section removes all inherited branch order. - ++ Branches not listed in this section will not be included in the mergeability check. If the `branchOrder` section is not defined then the mergeability of a change into other branches will not be done. @@ -525,9 +525,9 @@ + A boolean indicating if reviewers and CCs that do not currently have a Gerrit account can be added to a change by providing their email address. - ++ This setting only takes affect for changes that are readable by anonymous users. - ++ Default is `INHERIT`, which means that this property is inherited from the parent project. If the property is not set in any parent project, the default value is `FALSE`.
diff --git a/Documentation/config-robot-comments.txt b/Documentation/config-robot-comments.txt index f5185a4..04309e5 100644 --- a/Documentation/config-robot-comments.txt +++ b/Documentation/config-robot-comments.txt
@@ -13,9 +13,8 @@ It is planned to visualize robot comments differently in the web UI so that they can be easily distinguished from human comments. Users should also be able to use filtering on robot comments, so that only part of -the robot comments or no robot comments are shown. In addition it is -planned that robot comments can contain fixes, that users can apply by -a single click. +the robot comments or no robot comments are shown. In addition robot +comments can contain fixes, that users can apply by a single click. == REST endpoints
diff --git a/Documentation/dev-bazel.txt b/Documentation/dev-bazel.txt index c05d3f4..668a846 100644 --- a/Documentation/dev-bazel.txt +++ b/Documentation/dev-bazel.txt
@@ -18,7 +18,7 @@ To build Gerrit from source, you need: * A Linux or macOS system (Windows is not supported at this time) -* A JDK for Java 8|11|... +* A JDK for Java 11 or Java 17 * Python 3 * link:https://github.com/nodesource/distributions/blob/master/README.md[Node.js (including npm),role=external,window=_blank] * Bower (`npm install -g bower`) @@ -48,72 +48,30 @@ `java -version` -[[java-8]] -==== Java 8 support (deprecated) - -Java 8 is a legacy Java release and support for Java 8 will be discontinued -in future gerrit releases. To build Gerrit with Java 8 language level, run: - -``` - $ bazel build :release -``` - [[java-11]] ==== Java 11 support To build Gerrit with Java 11 language level, run: ``` - $ bazel build --java_toolchain=//tools:error_prone_warnings_toolchain_java11 :release + $ bazel build :release ``` -[[java-13]] -==== Java 13 support +[[java-17]] +==== Java 17 support -Java 13 (and newer) is supported through vanilla java toolchain -link:https://docs.bazel.build/versions/master/toolchains.html[Bazel option,role=external,window=_blank]. -To build Gerrit with Java 13 and newer, specify vanilla java toolchain and -provide the path to JDK home: +Java 17 is supported. To build Gerrit with Java 17, run: ``` - $ bazel build \ - --define=ABSOLUTE_JAVABASE=<path-to-java-13> \ - --javabase=@bazel_tools//tools/jdk:absolute_javabase \ - --host_javabase=@bazel_tools//tools/jdk:absolute_javabase \ - --host_java_toolchain=@bazel_tools//tools/jdk:toolchain_vanilla \ - --java_toolchain=@bazel_tools//tools/jdk:toolchain_vanilla \ - :release + $ bazel build --config=java17 :release ``` -To run the tests, `--javabase` option must be passed as well, because -bazel test runs the test using the target javabase: +To run the tests with Java 17, run: ``` - $ bazel test \ - --define=ABSOLUTE_JAVABASE=<path-to-java-13> \ - --javabase=@bazel_tools//tools/jdk:absolute_javabase \ - --host_javabase=@bazel_tools//tools/jdk:absolute_javabase \ - --host_java_toolchain=@bazel_tools//tools/jdk:toolchain_vanilla \ - --java_toolchain=@bazel_tools//tools/jdk:toolchain_vanilla \ - //... + $ bazel test --config=java17 //... ``` -To avoid passing all those options on every Bazel build invocation, -they could be added to ~/.bazelrc resource file: - -``` -$ cat << EOF > ~/.bazelrc -build --define=ABSOLUTE_JAVABASE=<path-to-java-13> -build --javabase=@bazel_tools//tools/jdk:absolute_javabase -build --host_javabase=@bazel_tools//tools/jdk:absolute_javabase -build --host_java_toolchain=@bazel_tools//tools/jdk:toolchain_vanilla -build --java_toolchain=@bazel_tools//tools/jdk:toolchain_vanilla -EOF -``` - -Now, invoking Bazel with just `bazel build :release` would include -all those options. - === Node.js and npm packages See link:https://gerrit.googlesource.com/gerrit/+/master/polygerrit-ui/README.md#installing-node_js-and-npm-packages[Installing Node.js and npm packages,role=external,window=_blank]. @@ -348,12 +306,6 @@ bazel test --test_tag_filters=-flaky //... ---- -To exclude tests that require a Docker host: - ----- - bazel test --test_tag_filters=-docker //... ----- - To exclude tests that require very recent git client version: ---- @@ -372,13 +324,16 @@ bazel test --test_tag_filters=api,git //... ---- +To run the tests against a specific index backend (LUCENE, FAKE): +---- + bazel test --test_env=GERRIT_INDEX_TYPE=LUCENE //... +---- + The following values are currently supported for the group name: * annotation * api -* docker * edit -* elastic * git * git-protocol-v2 * git-upload-archive @@ -411,23 +366,6 @@ Now attach with a debugger to the port `5005`. For example use "Remote Java Application" launch configuration in Eclipe and specify the port `5005`. -[[elasticsearch]] -=== Elasticsearch - -Successfully running the Elasticsearch tests requires Docker, and -may require setting the local virtual memory on -link:https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html[linux,role=external,window=_blank] and -link:https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#_set_vm_max_map_count_to_at_least_262144[macOS,role=external,window=_blank]. - -On macOS, if using link:https://docs.docker.com/docker-for-mac/[Docker Desktop,role=external,window=_blank], -the effective memory value can be set in the Preferences, under the Advanced tab. -The default value usually does not suffice and is causing premature container exits. -That default is currently 2 GB and should be set to at least 5 (GB). - -If Docker is not available, the Elasticsearch tests will be skipped. -Note that Bazel currently does not show -link:https://github.com/bazelbuild/bazel/issues/3476[the skipped tests,role=external,window=_blank]. - [[logging]] === Controlling logging level
diff --git a/Documentation/dev-contributing.txt b/Documentation/dev-contributing.txt index 01857da..fcc8b7e 100644 --- a/Documentation/dev-contributing.txt +++ b/Documentation/dev-contributing.txt
@@ -174,7 +174,8 @@ While the design doc is still in review, contributors may already start with the implementation (e.g. do some prototyping to demonstrate parts of the proposed design), but those changes should not be submitted -while the design wasn't approved yet. +while the design wasn't approved yet. Another way to demonstrate the +design can be to add screenshots or the like, early enough in the doc. By approving a design, the steering committee commits to:
diff --git a/Documentation/dev-crafting-changes.txt b/Documentation/dev-crafting-changes.txt index 15bf785..ac0780d 100644 --- a/Documentation/dev-crafting-changes.txt +++ b/Documentation/dev-crafting-changes.txt
@@ -26,7 +26,9 @@ * Improvements of existing features should also generally go into `master`. But we understand that if you cannot run `master`, it might take a while until you could benefit from it. In that case, - start on the newest `stable-*` branch that you can run. + implement the feature on master and, if you really need it on an + earlier `stable-*` branch, cherry-pick the change and build + Gerrit on your own environent. * Bug-fixes should generally at least cover the oldest affected and still supported version. If you're affected and run an even older version, you're welcome to upload to that older version, even if
diff --git a/Documentation/dev-eclipse.txt b/Documentation/dev-eclipse.txt index e18d7b0..dce5eb0 100644 --- a/Documentation/dev-eclipse.txt +++ b/Documentation/dev-eclipse.txt
@@ -31,9 +31,6 @@ ---- First, generate the Eclipse project by running the `tools/eclipse/project.py` script. -If running Eclipse on Java 8, add the extra parameter -`-e='--java_toolchain=//tools:error_prone_warnings_toolchain'` -for generating a compatible project. Then, in Eclipse, choose 'Import existing project' and select the `gerrit` project from the current working directory.
diff --git a/Documentation/dev-plugins.txt b/Documentation/dev-plugins.txt index 3d0d6f9..eb94ef7 100644 --- a/Documentation/dev-plugins.txt +++ b/Documentation/dev-plugins.txt
@@ -2188,6 +2188,8 @@ DiffWebLinks will appear in the side-by-side and unified diff screen in the header next to the navigation icons. +EditWebLinks will appear in the top-right part of the file diff page. + ProjectWebLinks will appear in the project list in the `Repository Browser` column. @@ -2266,8 +2268,7 @@ DropWizard Metrics,role=external,window=_blank]. Metric reporting plugin implementations are provided for -link:https://gerrit.googlesource.com/plugins/metrics-reporter-jmx/[JMX,role=external,window=_blank], -link:https://gerrit.googlesource.com/plugins/metrics-reporter-elasticsearch/[Elastic Search,role=external,window=_blank], +link:https://gerrit.googlesource.com/plugins/metrics-reporter-jmx/[JMX,role=external,window=_blank] and link:https://gerrit.googlesource.com/plugins/metrics-reporter-graphite/[Graphite,role=external,window=_blank]. There is also a working example of reporting metrics to the console in the @@ -2418,38 +2419,15 @@ If neither resource `Documentation/index.html` or `Documentation/index.md` exists in the plugin JAR, Gerrit will -automatically generate an index page for the plugin's documentation -tree by scanning every `*.md` and `*.html` file in the Documentation/ -directory. +automatically generate an index page. -For any discovered Markdown (`*.md`) file, Gerrit will parse the -header of the file and extract the first level one title. This -title text will be used as display text for a link to the HTML -version of the page. +The generated index page contains 3 sections: -For any discovered HTML (`*.html`) file, Gerrit will use the name -of the file, minus the `*.html` extension, as the link text. Any -hyphens in the file name will be replaced with spaces. - -If a discovered file is named `about.md` or `about.html`, its -content will be inserted in an 'About' section at the top of the -auto-generated index page. If both `about.md` and `about.html` -exist, only the first discovered file will be used. - -If a discovered file name beings with `cmd-` it will be clustered -into a 'Commands' section of the generated index page. - -If a discovered file name beings with `servlet-` it will be clustered -into a 'Servlets' section of the generated index page. - -If a discovered file name beings with `rest-api-` it will be clustered -into a 'REST APIs' section of the generated index page. - -All other files are clustered under a 'Documentation' section. - +1. Manifest section ++ Some optional information from the manifest is extracted and displayed as part of the index page, if present in the manifest: - ++ [width="40%",options="header"] |=================================================== |Field | Source Attribute @@ -2460,6 +2438,49 @@ |API Version | Gerrit-ApiVersion |=================================================== +2. About section ++ +If an `about.md` or `about.html` file exists, its content will be inserted in an +'About' section. ++ +If both `about.md` and `about.html` exist, only the first discovered file will +be used. + +3. TOC section ++ +If a `toc.md` or `toc.html` file exists, its content will be inserted in a +'Documentation' section. ++ +`toc.md` or `toc.html` is a manually maintained index of the documentation pages +that exist in the plugin. Having a manually maintained index has the advantage +that you can group the documentation pages by topic and sort them by importance. ++ +If both `toc.md` and `toc.html` exist, only the first discovered file will +be used. ++ +If no `toc` file is present the TOC section is automatically generated by +scanning every `\*.md` and `*.html` file in the `Documentation/` directory. ++ +For any discovered Markdown (`*.md`) file, Gerrit will parse the +header of the file and extract the first level one title. This +title text will be used as display text for a link to the HTML +version of the page. ++ +For any discovered HTML (`\*.html`) file, Gerrit will use the name +of the file, minus the `*.html` extension, as the link text. Any +hyphens in the file name will be replaced with spaces. ++ +If a discovered file name beings with `cmd-` it will be clustered +into a 'Commands' section of the generated index page. ++ +If a discovered file name beings with `servlet-` it will be clustered +into a 'Servlets' section of the generated index page. ++ +If a discovered file name beings with `rest-api-` it will be clustered +into a 'REST APIs' section of the generated index page. ++ +All other files are clustered under a 'Documentation' section. + [[deployment]] == Deployment @@ -2553,6 +2574,26 @@ } ---- + +[[account-tag]] +== Account Tag Plugins + +Gerrit provides an extension point that enables Plugins to supply additional +tags on an account. + +[source, java] +---- +import com.google.gerrit.entities.Account; +import com.google.gerrit.server.account.AccountTagProvider; +import java.util.List; + +public class MyPlugin implements AccountTagProvider { + public List<String> getTags(Account.Id id) { + // Implement your logic here + } +} +---- + [[ssh-command-creation-interception]] == SSH Command Creation Interception
diff --git a/Documentation/dev-readme.txt b/Documentation/dev-readme.txt index 2748413..f045ab8 100644 --- a/Documentation/dev-readme.txt +++ b/Documentation/dev-readme.txt
@@ -13,12 +13,21 @@ ---- git clone --recurse-submodules https://gerrit.googlesource.com/gerrit - cd gerrit ---- The `--recurse-submodules` option is needed on `git clone` to ensure that the core plugins, which are included as git submodules, are also cloned. +Next setup the commit-hook. This is necessary to ensure that each commit has a +`Change-Id`. + +---- + cd gerrit && ( + cd .git/hooks + ln -s ../../resources/com/google/gerrit/server/tools/root/hooks/commit-msg + ) +---- + === Switching between branches When using `git checkout` without `--recurse-submodules` to switch between
diff --git a/Documentation/dev-release.txt b/Documentation/dev-release.txt index a7240e2..0849c56 100644 --- a/Documentation/dev-release.txt +++ b/Documentation/dev-release.txt
@@ -153,7 +153,7 @@ Tag the plugins: ---- - git submodule foreach '[ "$path" == "modules/jgit" ] || git tag -s -m "v$version" "v$version"' + git submodule foreach '[ "$sm_path" == "modules/jgit" ] || git tag -s -m "v$version" "v$version"' ---- [[build-gerrit]] @@ -324,7 +324,7 @@ Push the new Release Tag on the plugins: ---- - git submodule foreach git push gerrit-review tag v$version + git submodule foreach '[ "$sm_path" == "modules/jgit" ] || git push gerrit-review tag "v$version"' ---- [[upload-documentation]]
diff --git a/Documentation/dev-stars.txt b/Documentation/dev-stars.txt index a83ad44..764e326 100644 --- a/Documentation/dev-stars.txt +++ b/Documentation/dev-stars.txt
@@ -29,9 +29,6 @@ There are link:rest-api-accounts.html#default-star-endpoints[ additional REST endpoints] for the link:#default-star[default star]. -Only the link:#default-star[default star] is shown in the WebUI and -can be updated from there. Other stars do not show up in the WebUI. - [[default-star]] == Default Star @@ -61,36 +58,11 @@ The ignore star is represented by the special star label 'ignore'. -[[reviewed-star]] -== Reviewed Star - -If the "reviewed/<patchset_id>"-star is set by a user, and <patchset_id> -matches the current patch set, the change is always reported as "reviewed" -in the ChangeInfo. - -This allows users to "de-highlight" changes in a dashboard until a new -patchset has been uploaded. - -[[unreviewed-star]] -== Unreviewed Star - -If the "unreviewed/<patchset_id>"-star is set by a user, and <patchset_id> -matches the current patch set, the change is always reported as "unreviewed" -in the ChangeInfo. - -This allows users to "highlight" changes in a dashboard. - [[query-stars]] == Query Stars There are several query operators to find changes with stars: -* link:user-search.html#star[star:<LABEL>]: - Matches any change that was starred by the current user with the - label `<LABEL>`. -* link:user-search.html#has-stars[has:stars]: - Matches any change that was starred by the current user with any - label. * link:user-search.html#is-starred[is:starred] / link:user-search.html#has-star[has:star]: Matches any change that was starred by the current user with the
diff --git a/Documentation/externalid-case-insensitivity.txt b/Documentation/externalid-case-insensitivity.txt new file mode 100644 index 0000000..57f492c --- /dev/null +++ b/Documentation/externalid-case-insensitivity.txt
@@ -0,0 +1,133 @@ +:linkattrs: += Gerrit Code Review - ExternalId case insensitivity + +Gerrit usernames are case insensitive by default: e.g. `johndoe` and `JohnDoe` +represent the same account. However, for installations older than v3.5.x, +the usernames were case sensitive, e.g. `johndoe` and `JohnDoe` can both exist +as separate accounts. This could lead to issues when migrating an account +from LDAP to an internal account, if +xref:config-gerrit.txt#ldap.localUsernameToLowerCase[ldap.localUsernameToLowerCase] +was set. Such usernames can also be rather confusing for users, if they try to +identify authors of comments or changes. + +When Gerrit handles case insensitive usernames (external IDs using the +`gerrit:` or `username:` scheme), their external IDs SHA-1 is always computed +using the lowercase external ID, hence there cannot be any account differing +only in the capitalization of their usernames. + +Gerrit installations older than v3.5.x that are switching to the case-insensitive +username need to migrate all their existing accounts SHA-1s. + +[[migration]] +== Migration + +Migrating external ID notes can take several minutes for large sites(for example +migration ++~++45000 accounts can take up to five minutes), so administrators +choose whether to do the migration offline or online, depending on their +available resources and tolerance for downtime. + +NOTE: Migration is required only on Gerrit primary instances. + +[[offline-migration]] +=== Offline + +To run the offline migration execute following steps: + +* Stop all Gerrit primary instances +* Set the `auth.userNameCaseInsensitive` to false + +---- +[auth] + userNameCaseInsensitive = false +---- + +* Run: +[verse] +-- +_java_ -jar gerrit.war _ChangeExternalIdCaseSensitivity_ + -d <SITE_PATH> + [--batch] +-- + +See: link:pgm-ChangeExternalIdCaseSensitivity.html[] + +* During the migration `auth.userNameCaseInsensitive` will be set to true +on a node which is executing the migration. When the migration is finished, +on all other primary nodes set `auth.userNameCaseInsensitive` to true +* Start all Gerrit primary instances + +[[online-migration]] +=== Online + +To start the online migration, set the `auth.userNameCaseInsensitive` and +`auth.userNameCaseInsensitiveMigrationMode` options in `gerrit.config` and +restart Gerrit: +---- +[auth] + userNameCaseInsensitive = true + userNameCaseInsensitiveMigrationMode = true +---- +* Trigger online migration: +---- +$ ssh -p <port> <host> gerrit migrate-externalids-to-insensitive +---- + +See: link:cmd-migrate-externalids-to-insensitive.html[] + +[online-ha-migration] +== Online migration for high-availability setup + +To start the online migration with a setup containing multiple primary +instances execute following steps: + +* On all Gerrit primary instances set `auth.userNameCaseInsensitive` and +`auth.userNameCaseInsensitiveMigrationMode` and perform a rolling restart +---- +[auth] + userNameCaseInsensitive = true + userNameCaseInsensitiveMigrationMode = true +---- +* Trigger online migration: +---- +$ ssh -p <port> <host> gerrit migrate-externalids-to-insensitive +---- + +See: link:cmd-migrate-externalids-to-insensitive.html[] + +* When the migration is finished, on all other primary nodes set +`auth.userNameCaseInsensitiveMigrationMode` to false and perform a +rolling restart +---- +[auth] + userNameCaseInsensitive = true + userNameCaseInsensitiveMigrationMode = false +---- + +== External ID case insensitivity rollback + +The offline migration tool allows to calculate external ID notes named with the SHA-1 +from the case sensitive external ID. + +To rollback external ID notes migration execute following steps: + +* Stop all Gerrit primary instances +* Set the `auth.userNameCaseInsensitive` to true +---- +[auth] + userNameCaseInsensitive = true +---- + +* Run: +[verse] +-- +_java_ -jar gerrit.war _ChangeExternalIdCaseSensitivity_ + -d <SITE_PATH> + [--batch] +-- + +See: link:pgm-ChangeExternalIdCaseSensitivity.html[] + +* During the migration `auth.userNameCaseInsensitive` will be set to false +on a node which is executing the migration. When the migration is finished, +on all other primary nodes set `auth.userNameCaseInsensitive` to false +* Start all Gerrit primary instances
diff --git a/Documentation/glossary.txt b/Documentation/glossary.txt index 2b40b5b..83362ab 100644 --- a/Documentation/glossary.txt +++ b/Documentation/glossary.txt
@@ -1,6 +1,12 @@ :linkattrs: = Glossary +[[cluster]] +== Cluster +A Gerrit Cluster is a set of Gerrit processes sharing the same +link:config-gerrit.html#gerrit.serverId[ServerId] and associated to the same +set of repositories, accounts, and groups. + [[event]] == Event @@ -32,6 +38,45 @@ API for listening to Gerrit events from plugins, without having any visibility restrictions. +[[multi-primary]] +== Multi-primary +Multi-primary typically refers to configurations where multiple Gerrit primary +processes are running in one or more xref:cluster[clusters] together. + +=== Single cluster multi-primary with shared storage +A variation of multi-primary (a.k.a. HA or high-availability) that shares a file +storage volume for the git repositories. These configurations can use the +link:https://gerrit.googlesource.com/plugins/high-availability[high-availability plugin] +to synchronize or share caches, indexes, events, and web sessions. The +replication plugin also +link:https://gerrit.googlesource.com/plugins/replication/+/refs/heads/master/src/main/resources/Documentation/config.md#configuring-cluster-replication[supports] +synchronizing events using a shared file storage volume. + +[[multi-cluster-multi-primary]] +=== Multiple clusters multi-primary +Multi-cluster (aka multi-site) primaries typically refers to configurations +where multiple Gerrit primary processes are running in different (likely +geographically distributed) clusters (sites). This also typically makes use of +a multi-primary configuration within each cluster. Synchronization across sites +is necessary to detect and prevent split-brain scenarios. These configurations +can use the link:https://gerrit.googlesource.com/plugins/multi-site[multi-site plugin] +to facilitate synchronization. + +[[primary]] +== Primary +A Gerrit primary is the link:pgm-daemon.html[main Gerrit process] permitting +write operations by clients. Most installations of Gerrit have only a single +Gerrit primary running at a time for their service. + +[[replica]] +== Replica +A Gerrit process running with the link:pgm-daemon.html[--replica switch] +provided. This permits read-only git operations by clients. There is no REST +API, WebUI, or search operation available. Replicas can be run in +the same cluster with primaries (likely sharing the storage volume) or in other +clusters/sites (likely facilitated by the +link:https://gerrit.googlesource.com/plugins/replication[replication plugin]). + [[stream-events]] == Stream events
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-change-info-cannot-merge.png b/Documentation/images/gwt-user-review-ui-change-screen-change-info-cannot-merge.png deleted file mode 100644 index 69a28ec..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-change-info-cannot-merge.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-change-info.png b/Documentation/images/gwt-user-review-ui-change-screen-change-info.png deleted file mode 100644 index e92b49d..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-change-info.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-change-update.png b/Documentation/images/gwt-user-review-ui-change-screen-change-update.png deleted file mode 100644 index 227db40..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-change-update.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-commit-info-merge-commit.png b/Documentation/images/gwt-user-review-ui-change-screen-commit-info-merge-commit.png deleted file mode 100644 index 097637e..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-commit-info-merge-commit.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-commit-info.png b/Documentation/images/gwt-user-review-ui-change-screen-commit-info.png deleted file mode 100644 index fe0c1d1..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-commit-info.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-history.png b/Documentation/images/gwt-user-review-ui-change-screen-history.png deleted file mode 100644 index 3fe71d8..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-history.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-included-in-list.png b/Documentation/images/gwt-user-review-ui-change-screen-included-in-list.png deleted file mode 100644 index ad30fe2..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-included-in-list.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-inline-comments.png b/Documentation/images/gwt-user-review-ui-change-screen-inline-comments.png deleted file mode 100644 index a10f40a..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-inline-comments.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-not-current.png b/Documentation/images/gwt-user-review-ui-change-screen-not-current.png deleted file mode 100644 index 9a87c67..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-not-current.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-permalink.png b/Documentation/images/gwt-user-review-ui-change-screen-permalink.png deleted file mode 100644 index a1aede9..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-permalink.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-plugin-extensions.png b/Documentation/images/gwt-user-review-ui-change-screen-plugin-extensions.png deleted file mode 100644 index 120b99c..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-plugin-extensions.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-reply-to-comment.png b/Documentation/images/gwt-user-review-ui-change-screen-reply-to-comment.png deleted file mode 100644 index 07bd8a2..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-reply-to-comment.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-reply.png b/Documentation/images/gwt-user-review-ui-change-screen-reply.png deleted file mode 100644 index 20837ea..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-reply.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-change-screen-replying.png b/Documentation/images/gwt-user-review-ui-change-screen-replying.png deleted file mode 100644 index 0ae85ab..0000000 --- a/Documentation/images/gwt-user-review-ui-change-screen-replying.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-box.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-box.png deleted file mode 100644 index 6de9e75..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-box.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-edit.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-edit.png deleted file mode 100644 index b349d0dc7..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-edit.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-reply.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-reply.png deleted file mode 100644 index 011f986..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment-reply.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment.png deleted file mode 100644 index 2ecc47e..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-comment.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-commented.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-commented.png deleted file mode 100644 index 598d18d..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-commented.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-inline-comments.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-inline-comments.png deleted file mode 100644 index 36f1360..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-inline-comments.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-keyboard-shortcuts.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-keyboard-shortcuts.png deleted file mode 100644 index 6f63f0e4..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-keyboard-shortcuts.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-navigation.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-navigation.png deleted file mode 100644 index 8146b76..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-navigation.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-no-differences.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-no-differences.png deleted file mode 100644 index 5d721a6..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-no-differences.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-patch-sets.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-patch-sets.png deleted file mode 100644 index 9bdd4a9..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-patch-sets.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-project-and-file.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-project-and-file.png deleted file mode 100644 index 836964b..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-project-and-file.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-rename.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-rename.png deleted file mode 100644 index b4d83ba..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-rename.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-replied-done.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-replied-done.png deleted file mode 100644 index 918cdee..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen-replied-done.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen.png b/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen.png deleted file mode 100644 index d76ecef..0000000 --- a/Documentation/images/gwt-user-review-ui-side-by-side-diff-screen.png +++ /dev/null Binary files differ
diff --git a/Documentation/images/user-review-ui-change-screen-change-update.png b/Documentation/images/user-review-ui-change-screen-change-update.png new file mode 100644 index 0000000..fe07ef9 --- /dev/null +++ b/Documentation/images/user-review-ui-change-screen-change-update.png Binary files differ
diff --git a/Documentation/images/user-review-ui-change-screen-plugin-extensions.png b/Documentation/images/user-review-ui-change-screen-plugin-extensions.png new file mode 100644 index 0000000..5d6fee7 --- /dev/null +++ b/Documentation/images/user-review-ui-change-screen-plugin-extensions.png Binary files differ
diff --git a/Documentation/images/user-review-ui-change-screen-reply.png b/Documentation/images/user-review-ui-change-screen-reply.png new file mode 100644 index 0000000..1c50fc5 --- /dev/null +++ b/Documentation/images/user-review-ui-change-screen-reply.png Binary files differ
diff --git a/Documentation/images/user-review-ui-side-by-side-diff-screen-inline-comments.png b/Documentation/images/user-review-ui-side-by-side-diff-screen-inline-comments.png new file mode 100644 index 0000000..047034c --- /dev/null +++ b/Documentation/images/user-review-ui-side-by-side-diff-screen-inline-comments.png Binary files differ
diff --git a/Documentation/images/user-review-ui-side-by-side-diff-screen-patch-sets.png b/Documentation/images/user-review-ui-side-by-side-diff-screen-patch-sets.png new file mode 100644 index 0000000..edbbccb --- /dev/null +++ b/Documentation/images/user-review-ui-side-by-side-diff-screen-patch-sets.png Binary files differ
diff --git a/Documentation/images/user-review-ui-side-by-side-diff-screen-rename.png b/Documentation/images/user-review-ui-side-by-side-diff-screen-rename.png new file mode 100644 index 0000000..0281362e --- /dev/null +++ b/Documentation/images/user-review-ui-side-by-side-diff-screen-rename.png Binary files differ
diff --git a/Documentation/images/user-review-ui-side-by-side-diff-screen-replied-done.png b/Documentation/images/user-review-ui-side-by-side-diff-screen-replied-done.png new file mode 100644 index 0000000..a72011b --- /dev/null +++ b/Documentation/images/user-review-ui-side-by-side-diff-screen-replied-done.png Binary files differ
diff --git a/Documentation/images/user-review-ui-side-by-side-diff-screen.png b/Documentation/images/user-review-ui-side-by-side-diff-screen.png new file mode 100644 index 0000000..74d02e3 --- /dev/null +++ b/Documentation/images/user-review-ui-side-by-side-diff-screen.png Binary files differ
diff --git a/Documentation/index.txt b/Documentation/index.txt index dc94b14..782a6a9 100644 --- a/Documentation/index.txt +++ b/Documentation/index.txt
@@ -77,6 +77,7 @@ . link:pgm-index.html[Server Side Administrative Tools] . link:repository-maintenance.html[Repository Maintenance] . link:user-request-tracing.html[Request Tracing] +. link:user-request-cancellation-and-deadlines.html[Request Cancellation and Deadlines] . link:note-db.html[NoteDb] . link:config-accounts.html[Accounts on NoteDb] . link:config-groups.html[Groups on NoteDb]
diff --git a/Documentation/intro-gerrit-walkthrough-github.txt b/Documentation/intro-gerrit-walkthrough-github.txt index 8f3ff88..173f709 100644 --- a/Documentation/intro-gerrit-walkthrough-github.txt +++ b/Documentation/intro-gerrit-walkthrough-github.txt
@@ -25,7 +25,7 @@ Here’s how getting code reviewed and submitted with Gerrit is different from doing the same with GitHub: -* You need the add a commit-msg hook script when you clone a repo for the first +* You need to add a commit-msg hook script when you clone a repo for the first time using a snippet you can find e.g. https://gerrit-review.googlesource.com/admin/repos/gerrit[here,role=external,window=_blank]; * Your review will be on a single commit instead of a branch. You use `git commit --amend` to modify a code change.
diff --git a/Documentation/intro-user.txt b/Documentation/intro-user.txt index dac1c6b..1f0dfd0 100644 --- a/Documentation/intro-user.txt +++ b/Documentation/intro-user.txt
@@ -686,6 +686,49 @@ It is also possible to link:user-inline-edit.html#create-change[create new changes inline]. +[[roles]] +== Roles + +Making and reviewing changes usually involves multiple users that +assume different roles: + +- Author: ++ +The person who wrote the code change. Recorded as author in the Git +commit. + +- Committer: ++ +The person who created the Git commit, e.g. the person that executed +the `git commit` command. Recorded as committer in the Git commit. + +- Uploader: ++ +The user that uploaded the commit as a patch set to Gerrit, e.g. the +user that executed the `git push` command. For commits that are created through +an action in the web UI the uploader is the user that triggered the action (e.g. +if a commit is created by clicking on the `REBASE` button, the user clicking on +the button becomes the uploader of the newly created commit). ++ +The uploader of the first patch set is the change owner. ++ +The uploader of the latest patch set, the user that uploaded the +current patch set, is relevant when +link:config-labels.html#label_ignoreSelfApproval[self approvals on labels are +ignored], as in this case approvals from the uploader of the latest patch set +are ignored. + +- Change Owner: ++ +The user that created the change, e.g. uploaded the first patch set. + +- Reviewer: ++ +A user that has reviewed the change or has been asked to review the change. + +Often one user assumes several of these roles, but it's possible that each role +is assumed by a different user. + [[project-administration]] == Project Administration @@ -831,8 +874,8 @@ - [[show-change-number]]`Show Change Number In Changes Table`: + -Whether in change lists and dashboards an `ID` column with the numeric -change IDs should be shown. +Whether in change lists and dashboards an `ID` column with the change numbers +should be shown. - [[mute-common-path-prefixes]]`Mute Common Path Prefixes In File List`: +
diff --git a/Documentation/js_licenses.txt b/Documentation/js_licenses.txt index e611ff8..ab79c8f 100644 --- a/Documentation/js_licenses.txt +++ b/Documentation/js_licenses.txt
@@ -250,7 +250,9 @@ [[DefinitelyTyped]] DefinitelyTyped +* @types/resemblejs * @types/resize-observer-browser +* @types/trusted-types [[DefinitelyTyped_license]] ---- @@ -279,6 +281,48 @@ ---- +[[Lit]] +Lit + +* @lit/reactive-element +* lit +* lit-element +* lit-html + +[[Lit_license]] +---- +BSD 3-Clause License + +Copyright (c) 2017 Google LLC. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +---- + + [[Polymer-2014]] Polymer-2014 @@ -367,6 +411,7 @@ * @polymer/paper-dialog-behavior * @polymer/paper-dialog-scrollable * @polymer/paper-dropdown-menu +* @polymer/paper-fab * @polymer/paper-icon-button * @polymer/paper-input * @polymer/paper-item @@ -563,32 +608,65 @@ [[ba-linkify_license]] ---- -Copyright (c) 2009 "Cowboy" Ben Alman - -Permission is hereby granted, free of charge, to any person -obtaining a copy of this software and associated documentation -files (the "Software"), to deal in the Software without -restriction, including without limitation the rights to use, -copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following -conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES -OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT -HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +Copyright (c) 2009 "Cowboy" Ben Alman + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ---- +[[codemirror-minified]] +codemirror-minified + +* codemirror-minified + +[[codemirror-minified_license]] +---- +The MIT License (MIT) + +Copyright (c) 2016 Marijn Haverbeke <marijnh@gmail.com> and others +Copyright (c) 2016 Michael Zhou <zhoumotongxue008@gmail.com> + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +---- + + [[font-roboto-local-fonts-roboto]] font-roboto-local-fonts-roboto @@ -1042,6 +1120,38 @@ ---- +[[immer]] +immer + +* immer + +[[immer_license]] +---- +MIT License + +Copyright (c) 2017 Michel Weststrate + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +---- + + [[isarray]] isarray @@ -1074,84 +1184,6 @@ ---- -[[lit-element]] -lit-element - -* lit-element - -[[lit-element_license]] ----- -BSD 3-Clause License - -Copyright (c) 2017, The Polymer Authors. All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -* Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - ----- - - -[[lit-html]] -lit-html - -* lit-html - -[[lit-html_license]] ----- -BSD 3-Clause License - -Copyright (c) 2017, The Polymer Authors. All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -* Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - ----- - - [[page]] page @@ -1217,6 +1249,35 @@ ---- +[[resemblejs]] +resemblejs + +* resemblejs + +[[resemblejs_license]] +---- +The MIT License (MIT) Copyright © 2013 Huddle + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the “Software”), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +---- + + [[rxjs]] rxjs
diff --git a/Documentation/licenses.txt b/Documentation/licenses.txt index 0719076..735553d 100644 --- a/Documentation/licenses.txt +++ b/Documentation/licenses.txt
@@ -62,11 +62,8 @@ * guice:guice-library * guice:guice-servlet * guice:javax_inject -* httpcomponents:httpasyncclient * httpcomponents:httpclient * httpcomponents:httpcore -* httpcomponents:httpcore-nio -* jackson:jackson-core * jetty:http * jetty:io * jetty:jmx @@ -1114,22 +1111,6 @@ ---- -[[elasticsearch]] -elasticsearch - -* elasticsearch-rest-client:elasticsearch-rest-client - -[[elasticsearch_license]] ----- -Elasticsearch -Copyright 2009-2015 Elasticsearch - -This product includes software developed by The Apache Software -Foundation (http://www.apache.org/). - ----- - - [[flexmark]] flexmark @@ -3210,7 +3191,9 @@ [[DefinitelyTyped]] DefinitelyTyped +* @types/resemblejs * @types/resize-observer-browser +* @types/trusted-types [[DefinitelyTyped_license]] ---- @@ -3239,6 +3222,48 @@ ---- +[[Lit]] +Lit + +* @lit/reactive-element +* lit +* lit-element +* lit-html + +[[Lit_license]] +---- +BSD 3-Clause License + +Copyright (c) 2017 Google LLC. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +---- + + [[Polymer-2014]] Polymer-2014 @@ -3327,6 +3352,7 @@ * @polymer/paper-dialog-behavior * @polymer/paper-dialog-scrollable * @polymer/paper-dropdown-menu +* @polymer/paper-fab * @polymer/paper-icon-button * @polymer/paper-input * @polymer/paper-item @@ -3523,32 +3549,65 @@ [[ba-linkify_license]] ---- -Copyright (c) 2009 "Cowboy" Ben Alman - -Permission is hereby granted, free of charge, to any person -obtaining a copy of this software and associated documentation -files (the "Software"), to deal in the Software without -restriction, including without limitation the rights to use, -copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following -conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES -OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT -HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +Copyright (c) 2009 "Cowboy" Ben Alman + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ---- +[[codemirror-minified]] +codemirror-minified + +* codemirror-minified + +[[codemirror-minified_license]] +---- +The MIT License (MIT) + +Copyright (c) 2016 Marijn Haverbeke <marijnh@gmail.com> and others +Copyright (c) 2016 Michael Zhou <zhoumotongxue008@gmail.com> + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +---- + + [[font-roboto-local-fonts-roboto]] font-roboto-local-fonts-roboto @@ -4002,6 +4061,38 @@ ---- +[[immer]] +immer + +* immer + +[[immer_license]] +---- +MIT License + +Copyright (c) 2017 Michel Weststrate + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +---- + + [[isarray]] isarray @@ -4034,84 +4125,6 @@ ---- -[[lit-element]] -lit-element - -* lit-element - -[[lit-element_license]] ----- -BSD 3-Clause License - -Copyright (c) 2017, The Polymer Authors. All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -* Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - ----- - - -[[lit-html]] -lit-html - -* lit-html - -[[lit-html_license]] ----- -BSD 3-Clause License - -Copyright (c) 2017, The Polymer Authors. All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -* Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -* Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - ----- - - [[page]] page @@ -4177,6 +4190,35 @@ ---- +[[resemblejs]] +resemblejs + +* resemblejs + +[[resemblejs_license]] +---- +The MIT License (MIT) Copyright © 2013 Huddle + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the “Software”), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +---- + + [[rxjs]] rxjs
diff --git a/Documentation/linux-quickstart.txt b/Documentation/linux-quickstart.txt index e34071f..c45de05 100644 --- a/Documentation/linux-quickstart.txt +++ b/Documentation/linux-quickstart.txt
@@ -104,7 +104,7 @@ Now that you have a simple version of Gerrit running, use the installation to explore the user interface and learn about Gerrit. For more detailed installation instructions, see -link:[Standalone Daemon Installation Guide](install.html). +link:install.html[Standalone Daemon Installation Guide]. GERRIT ------
diff --git a/Documentation/metrics.txt b/Documentation/metrics.txt index 7ac804c..5470709 100644 --- a/Documentation/metrics.txt +++ b/Documentation/metrics.txt
@@ -12,26 +12,116 @@ * `build/label`: Version of Gerrit server software. * `events`: Triggered events. +** `type`: + The type of the event. === Actions * `action/retry_attempt_count`: Number of retry attempts made -by RetryHelper to execute an action (0 == single attempt, no retry) + by RetryHelper to execute an action (0 == single attempt, no retry) +** `action_type`: + The type of the action that was retried. +** `operation_name`: + The name of the operation that was retried. +** `cause`: + The original cause that triggered the retry. * `action/retry_timeout_count`: Number of action executions of RetryHelper -that ultimately timed out + that ultimately timed out +** `action_type`: + The type of the action that was retried. +** `operation_name`: + The name of the operation that was retried. +** `cause`: + The original cause that triggered the retry. * `action/auto_retry_count`: Number of automatic retries with tracing +** `action_type`: + The type of the action that was retried. +** `operation_name`: + The name of the operation that was retried. +** `cause`: + The cause for the retry. * `action/failures_on_auto_retry_count`: Number of failures on auto retry +** `action_type`: + The type of the action that was retried. +** `operation_name`: + The name of the operation that was retried. +** `cause`: + The cause for the retry. + +[[cancellations]] +=== Cancellations + +* `cancellation/advisory_deadline_count`: Exceeded advisory deadlines by request +** `request_type`: + The type of the request to which the advisory deadline applied. +** `request_uri`: + The redacted URI of the request to which the advisory deadline applied (only + set for request_type = REST). +** `deadline_id`: + The ID of the advisory deadline. +* `cancellation/cancelled_requests_count`: Number of request cancellations by + request +** `request_type`: + The type of the request that was cancelled. +** `request_uri`: + The redacted URI of the request that was cancelled (only set for + request_type = REST). +** `cancellation_reason`: + The reason why the request was cancelled. +* `cancellation/receive_timeout_count`: Number of requests that are cancelled + because link:config.html#receive.timeout[receive.timout] is exceeded +** `cancellation_type`: + The cancellation type (graceful or forceful). + +[[performance]] +=== Performance + +* `performance/operations`: Latency of performing operations +** `operation_name`: + The operation that was performed. +** `request`: + The request for which the operation was performed (format = '<request-type> + <redacted-request-uri>'). +** `plugin`: + The name of the plugin that performed the operation. +* `performance/operations_count`: Number of performed operations +** `operation_name`: + The operation that was performed. +** `request`: + The request for which the operation was performed (format = '<request-type> + <redacted-request-uri>'). +** `plugin`: + The name of the plugin that performed the operation. + +Performance metrics can be enabled via the +link:config.gerrit.html#tracing.exportPerformanceMetrics[`tracing.exportPerformanceMetrics`] +setting. === Pushes -* `receivecommits/changes`: histogram of number of changes processed -in a single upload, split up by update type (change created/updated, -change autoclosed). -* `receivecommits/latency`: latency per change for processing a push, -split up by update type (create+replace, and autoclose) -* `receivecommits/push_latency`: total latency for processing a push, -split up by update type (create+replace, autoclose, normal) -* `receivecommits/timeout`: number of timeouts during push processing. +* `receivecommits/changes`: histogram of number of changes processed in a single + upload +** `type`: + type of push (create/replace, autoclose) +* `receivecommits/latency_per_push`: processing delay for a processing single + push +** `type`: + type of push (create/replace, autoclose, normal) +* `receivecommits/latency_per_push_per_change`: Processing delay per push + divided by the number of changes in said push. (Only includes pushes which + contain changes.) +** `type`: + type of push (create/replace, autoclose, normal) +* `receivecommits/timeout`: rate of push timeouts +* `receivecommits/ps_revision_missing`: errors due to patch set revision missing +* `receivecommits/push_count`: number of pushes +** `kind`: + The push kind (direct vs. magic). +** `project`: + The name of the project for which the push is done. +** `type`: + The type of the update (CREATE, UPDATE, CREATE/UPDATE, UPDATE_NONFASTFORWARD, + DELETE). === Process @@ -49,25 +139,58 @@ * `proc/jvm/memory/object_pending_finalization_count`: Approximate number of objects needing finalization. * `proc/jvm/gc/count`: Number of GCs. +** `gc_name`: + The name of the garbage collector. * `proc/jvm/gc/time`: Approximate accumulated GC elapsed time. -* `proc/jvm/memory/pool/committed/<pool name>`: Committed amount of memory for pool. -* `proc/jvm/memory/pool/max/<pool name>`: Maximum amount of memory for pool. -* `proc/jvm/memory/pool/used/<pool name>`: Used amount of memory for pool. +** `gc_name`: + The name of the garbage collector. +* `proc/jvm/memory/pool/committed`: Committed amount of memory for pool. +** `pool_name`: + The name of the memory pool. +* `proc/jvm/memory/pool/max`: Maximum amount of memory for pool. +** `pool_name`: + The name of the memory pool. +* `proc/jvm/memory/pool/used`: Used amount of memory for pool. +** `pool_name`: + The name of the memory pool. * `proc/jvm/thread/num_live`: Current live thread count. * `proc/jvm/thread/num_daemon_live`: Current live daemon threads count. -* `proc/jvm/thread/num_peak_live`: Peak live thread count since the Java virtual machine started or peak was reset. -* `proc/jvm/thread/num_total_started`: Total number of threads created and also started since the Java virtual machine started. -* `proc/jvm/thread/num_deadlocked_threads`: Number of threads that are deadlocked waiting for object monitors or ownable synchronizers. - If deadlocks waiting for ownable synchronizers can be monitored depends on the capabilities of the used JVM. +* `proc/jvm/thread/num_peak_live`: Peak live thread count since the Java virtual + machine started or peak was reset. +* `proc/jvm/thread/num_total_started`: Total number of threads created and also + started since the Java virtual machine started. +* `proc/jvm/thread/num_deadlocked_threads`: Number of threads that are + deadlocked waiting for object monitors or ownable synchronizers. + If deadlocks waiting for ownable synchronizers can be monitored depends on the + capabilities of the used JVM. === Caches * `caches/memory_cached`: Memory entries. +** `cache_name`: + The name of the cache. * `caches/memory_hit_ratio`: Memory hit ratio. +** `cache_name`: + The name of the cache. * `caches/memory_eviction_count`: Memory eviction count. +** `cache_name`: + The name of the cache. * `caches/disk_cached`: Disk entries used by persistent cache. +** `cache_name`: + The name of the cache. * `caches/disk_hit_ratio`: Disk hit ratio for persistent cache. -* `caches/refresh_count`: The number of refreshes per cache with an indicator if a reload was necessary. +** `cache_name`: + The name of the cache. +* `caches/refresh_count`: The number of refreshes per cache with an indicator if + a reload was necessary. +** `cache`: + The name of the cache. +** `outdated`: + Whether the cache entry was outdated on reload. +* `caches/diff/timeouts`: The number of git file diff computations that resulted + in timeouts. +* `caches/diff/legacy/timeouts`: The number of git file diff computations (using + the legacy cache) that resulted in timeouts. Cache disk metrics are expensive to compute on larger installations and are not computed by default. They can be enabled via the @@ -76,65 +199,110 @@ === Change -* `change/submit_rule_evaluation`: Latency for evaluating submit rules on a change. -* `change/submit_type_evaluation`: Latency for evaluating the submit type on a change. +* `change/submit_rule_evaluation`: Latency for evaluating submit rules on a + change. +* `change/submit_type_evaluation`: Latency for evaluating the submit type on a + change. +* `change/post_review/draft_handling`: Total number of draft handling option + (KEEP, PUBLISH, PUBLISH_ALL_REVISIONS) selected by users while posting a + review. +** `type`: + The type of the draft handling option (KEEP, PUBLISH, PUBLISH_ALL_REVISIONS). === Comments -* `ported_comments/as_patchset_level`: Total number of comments ported as patchset-level comments. -* `ported_comments/as_file_level`: Total number of comments ported as file-level comments. -* `ported_comments/as_range_comments`: Total number of comments having line/range values in the ported patchset. +* `ported_comments/as_patchset_level`: Total number of comments ported as + patchset-level comments. +* `ported_comments/as_file_level`: Total number of comments ported as file-level + comments. +* `ported_comments/as_range_comments`: Total number of comments having + line/range values in the ported patchset. === HTTP ==== Jetty -* `http/server/jetty/connections/connections`: The current number of open connections -* `http/server/jetty/connections/connections_total`: The total number of connections opened -* `http/server/jetty/connections/connections_duration_max`: The max duration of a connection in ms -* `http/server/jetty/connections/connections_duration_mean`: The mean duration of a connection in ms -* `http/server/jetty/connections/connections_duration_stdev`: The standard deviation of the duration of a connection in ms -* `http/server/jetty/connections/received_messages`: The total number of messages received -* `http/server/jetty/connections/sent_messages`: The total number of messages sent -* `http/server/jetty/connections/received_bytes`: Total number of bytes received by tracked connections -* `http/server/jetty/connections/sent_bytes`: Total number of bytes sent by tracked connections" +* `http/server/jetty/connections/connections`: The current number of open + connections +* `http/server/jetty/connections/connections_total`: The total number of + connections opened +* `http/server/jetty/connections/connections_duration_max`: The max duration of + a connection in ms +* `http/server/jetty/connections/connections_duration_mean`: The mean duration + of a connection in ms +* `http/server/jetty/connections/connections_duration_stdev`: The standard + deviation of the duration of a connection in ms +* `http/server/jetty/connections/received_messages`: The total number of + messages received +* `http/server/jetty/connections/sent_messages`: The total number of messages + sent +* `http/server/jetty/connections/received_bytes`: Total number of bytes received + by tracked connections +* `http/server/jetty/connections/sent_bytes`: Total number of bytes sent by + tracked connections * `http/server/jetty/threadpool/active_threads`: Active threads * `http/server/jetty/threadpool/idle_threads`: Idle threads * `http/server/jetty/threadpool/reserved_threads`: Reserved threads * `http/server/jetty/threadpool/max_pool_size`: Maximum thread pool size * `http/server/jetty/threadpool/min_pool_size`: Minimum thread pool size * `http/server/jetty/threadpool/pool_size`: Current thread pool size -* `http/server/jetty/threadpool/queue_size`: Queued requests waiting for a thread +* `http/server/jetty/threadpool/queue_size`: Queued requests waiting for a + thread +* `http/server/jetty/threadpool/is_low_on_threads`: Whether thread pool is low + on threads ==== LDAP * `ldap/login_latency`: Latency of logins. * `ldap/user_search_latency`: Latency for searching the user account. -* `ldap/group_search_latency`: Latency for querying the group memberships of an account. +* `ldap/group_search_latency`: Latency for querying the group memberships of an + account. * `ldap/group_expansion_latency`: Latency for expanding nested groups. ==== REST API * `http/server/error_count`: Rate of REST API error responses. +** `status`: + HTTP status code * `http/server/success_count`: Rate of REST API success responses. +** `status`: + HTTP status code * `http/server/rest_api/count`: Rate of REST API calls by view. +** `view`: + view implementation class * `http/server/rest_api/change_id_type`: Rate of REST API calls by change ID type. +** `change_id_type`: + The type of the change identifier. * `http/server/rest_api/error_count`: Rate of REST API calls by view. +** `view`: + view implementation class +** `error_code`: + HTTP status code +** `cause`: + The cause of the error. * `http/server/rest_api/server_latency`: REST API call latency by view. +** `view`: + view implementation class * `http/server/rest_api/response_bytes`: Size of REST API response on network -(may be gzip compressed) by view. + (may be gzip compressed) by view. +** `view`: + view implementation class * `http/server/rest_api/change_json/to_change_info_latency`: Latency for -toChangeInfo invocations in ChangeJson. + toChangeInfo invocations in ChangeJson. * `http/server/rest_api/change_json/to_change_infos_latency`: Latency for -toChangeInfos invocations in ChangeJson. + toChangeInfos invocations in ChangeJson. * `http/server/rest_api/change_json/format_query_results_latency`: Latency for -formatQueryResults invocations in ChangeJson. -* `http/server/rest_api/ui_actions/latency`: Latency for RestView#getDescription calls. + formatQueryResults invocations in ChangeJson. +* `http/server/rest_api/ui_actions/latency`: Latency for RestView#getDescription + calls. +** `view`: + view implementation class === Query * `query/query_latency`: Successful query latency, accumulated over the life -of the process. + of the process. +** `index`: index name === Core Queues @@ -153,11 +321,15 @@ Each queue provides the following metrics: * `queue/<queue_name>/pool_size`: Current number of threads in the pool -* `queue/<queue_name>/max_pool_size`: Maximum allowed number of threads in the pool -* `queue/<queue_name>/active_threads`: Number of threads that are actively executing tasks +* `queue/<queue_name>/max_pool_size`: Maximum allowed number of threads in the + pool +* `queue/<queue_name>/active_threads`: Number of threads that are actively + executing tasks * `queue/<queue_name>/scheduled_tasks`: Number of scheduled tasks in the queue -* `queue/<queue_name>/total_scheduled_tasks_count`: Total number of tasks that have been scheduled -* `queue/<queue_name>/total_completed_tasks_count`: Total number of tasks that have completed execution +* `queue/<queue_name>/total_scheduled_tasks_count`: Total number of tasks that + have been scheduled +* `queue/<queue_name>/total_completed_tasks_count`: Total number of tasks that + have completed execution === SSH sessions @@ -169,7 +341,7 @@ * `topic/cross_project_submit`: number of cross-project topic submissions. * `topic/cross_project_submit_completed`: number of cross-project -topic submissions that concluded successfully. + topic submissions that concluded successfully. === JGit @@ -186,23 +358,49 @@ * `load_success_count` : Successful cache loads for JGit block cache. * `miss_count` : Cache misses for JGit block cache. * `miss_ratio` : Cache miss ratio for JGit block cache. -* `cache_used_per_repository` : Bytes of memory retained per repository for the top N repositories -having most data in the cache. The number N of reported repositories is limited to 1000. +* `cache_used_per_repository` : Bytes of memory retained per repository for the + top N repositories having most data in the cache. The number N of reported + repositories is limited to 1000. +** `repository_name`: The name of the repository. === Git * `git/upload-pack/request_count`: Total number of git-upload-pack requests. +** `operation`: + The name of the operation (CLONE, FETCH). +* `git/upload-pack/bitmap_index_misses_count`: Number of bitmap index misses per request. +** `operation`: + The name of the operation (CLONE, FETCH). +* `git/upload-pack/no_bitmap_index`: Total number of requests executed without a bitmap index. +** `operation`: + The name of the operation (CLONE, FETCH). * `git/upload-pack/phase_counting`: Time spent in the 'Counting...' phase. +** `operation`: + The name of the operation (CLONE, FETCH). * `git/upload-pack/phase_compressing`: Time spent in the 'Compressing...' phase. +** `operation`: + The name of the operation (CLONE, FETCH). +* `git/upload-pack/phase_negotiating`: Time spent in the negotiation phase. +** `operation`: + The name of the operation (CLONE, FETCH). +* `git/upload-pack/phase_searching_for_reuse`: Time spent in the 'Finding sources...' while searching for reuse phase. +** `operation`: + The name of the operation (CLONE, FETCH). +* `git/upload-pack/phase_searching_for_sizes`: Time spent in the 'Finding sources...' while searching for sizes phase. +** `operation`: + The name of the operation (CLONE, FETCH). * `git/upload-pack/phase_writing`: Time spent transferring bytes to client. +** `operation`: + The name of the operation (CLONE, FETCH). * `git/upload-pack/pack_bytes`: Distribution of sizes of packs sent to clients. +** `operation`: + The name of the operation (CLONE, FETCH). * `git/auto-merge/num_operations`: Number of auto merge operations and context. +** `operation`: + The type of the operation (CACHE_LOAD, IN_MEMORY_WRITE, ON_DISK_WRITE). * `git/auto-merge/latency`: Latency of auto merge operations and context. - -=== BatchUpdate - -* `batch_update/execute_change_ops`: BatchUpdate change update latency, -excluding reindexing +** `operation`: + The type of the operation (CACHE_LOAD, IN_MEMORY_WRITE, ON_DISK_WRITE). === NoteDb @@ -212,43 +410,63 @@ * `notedb/parse_latency`: NoteDb parse latency for changes. * `notedb/external_id_cache_load_count`: Total number of times the external ID cache loader was called. -* `notedb/external_id_partial_read_latency`: Latency for generating a new external ID - cache state from a prior state. +** `partial`: + Whether the reload was partial. +* `notedb/external_id_partial_read_latency`: Latency for generating a new + external ID cache state from a prior state. * `notedb/external_id_update_count`: Total number of external ID updates. * `notedb/read_all_external_ids_latency`: Latency for reading all -external ID's from NoteDb. + external ID's from NoteDb. * `notedb/read_single_account_config_latency`: Latency for reading a single -account config from NoteDb. + account config from NoteDb. * `notedb/read_single_external_id_latency`: Latency for reading a single -external ID from NoteDb. + external ID from NoteDb. === Permissions -* `permissions/permission_collection/filter_latency`: Latency to filter access sections -by user and ref. +* `permissions/permission_collection/filter_latency`: Latency for access filter + computations in PermissionCollection * `permissions/ref_filter/full_filter_count`: Rate of full ref filter operations -* `permissions/ref_filter/skip_filter_count`: Rate of ref filter operations where -we skip full evaluation because the user can read all refs +* `permissions/ref_filter/skip_filter_count`: Rate of ref filter operations + where we skip full evaluation because the user can read all refs === Reviewer Suggestion * `reviewer_suggestion/query_accounts`: Latency for querying accounts for -reviewer suggestion. + reviewer suggestion. * `reviewer_suggestion/recommend_accounts`: Latency for recommending accounts -for reviewer suggestion. + for reviewer suggestion. * `reviewer_suggestion/load_accounts`: Latency for loading accounts for -reviewer suggestion. + reviewer suggestion. * `reviewer_suggestion/query_groups`: Latency for querying groups for reviewer -suggestion. + suggestion. +* `reviewer_suggestion/filter_visibility`: Latency for removing users that can't + see the change === Repo Sequences * `sequence/next_id_latency`: Latency of requesting IDs from repo sequences. +** `sequence`: + The sequence from which IDs were retrieved. +** `multiple`: + Whether more than one ID was retrieved. === Plugin * `plugin/latency`: Latency for plugin invocation. +** `plugin_name`" + The name of the plugin. +** `class`: + The class of the plugin that was invoked. +** `export_value`: + The export name under which the invoked class is registered. * `plugin/error_count`: Number of plugin errors. +** `plugin_name`" + The name of the plugin. +** `class`: + The class of the plugin that was invoked. +** `export_value`: + The export name under which the invoked class is registered. === Group @@ -257,11 +475,19 @@ === Replication Plugin * `plugins/replication/replication_latency`: Time spent pushing to remote -destination. + destination. +** `destination`: The destination of the replication. * `plugins/replication/replication_delay`: Time spent waiting before pushing to -remote destination. + remote destination. +** `destination`: The destination of the replication. * `plugins/replication/replication_retries`: Number of retries when pushing to -remote destination. + remote destination. +** `destination`: The destination of the replication. +* `plugins/replication/latency_slower_than_threshold`: latency for project to + destination, where latency was slower than threshold +** `slow_threshold`: The threshold. +** `project`: The name of the project. +** `destination`: The destination of the replication. === License
diff --git a/Documentation/note-db.txt b/Documentation/note-db.txt index 7b436a9..0e1dfd0 100644 --- a/Documentation/note-db.txt +++ b/Documentation/note-db.txt
@@ -36,6 +36,67 @@ not available in 3.0, so any upgrade from Gerrit 2.x to 3.x must go through 2.16 to effect the NoteDb upgrade. +== Format + +Each review ("change") in Gerrit is numbered. The different revisions +("patchsets") of a change 12345 are stored under +---- + refs/changes/45/12345/${PATCHSET_NUMBER} +---- + +The revisions are stored as commits to the main project, ie. if you +fetch this ref, you can check out the proposed change. + +A change 12345 has its review metadata under +---- + refs/changes/45/12345/meta +---- +The metadata is a notes branch. The commit messages on the branch hold +modifications to global data of the change (votes, global comments). The inline +comments are in a +link:https://git.eclipse.org/r/plugins/gitiles/jgit/jgit/\+/master/org.eclipse.jgit/src/org/eclipse/jgit/notes/NoteMap.java[NoteMap], +where the key is the commit SHA-1 of the patchset +that the comment refers to, and the value is JSON data. The format of the +JSON is in the +link:https://gerrit.googlesource.com/gerrit/\+/master/java/com/google/gerrit/server/notedb/RevisionNoteData.java[RevisionNoteData] +which contains +link:https://gerrit.googlesource.com/gerrit/\+/master/java/com/google/gerrit/entities/Comment.java[Comment] entities. + +For example: +---- + { + "key": { + "uuid": "c7be1334_47885e36", + "filename": +"java/com/google/gerrit/server/restapi/project/CommitsCollection.java", + "patchSetId": 7 + }, + "lineNbr": 158, + "author": { + "id": 1026112 + }, + "writtenOn": "2019-11-06T09:00:50Z", + "side": 1, + "message": "nit: factor this out in a variable, use +toImmutableList as collector", + "range": { + "startLine": 156, + "startChar": 32, + "endLine": 158, + "endChar": 66 + }, + "revId": "071c601d6ee1a2a9f520415fd9efef8e00f9cf60", + "serverId": "173816e5-2b9a-37c3-8a2e-48639d4f1153", + "unresolved": true + }, +---- + +Automated systems may post "robot comments" instead of normal +comments, which are an extension of the previous comment, defined in +the +link:https://gerrit.googlesource.com/gerrit/\+/master/java/com/google/gerrit/entities/RobotComment.java[RobotComment] +class. + [[migration]] == Migration
diff --git a/Documentation/pg-plugin-dev.txt b/Documentation/pg-plugin-dev.txt index dc7986f..dc65da6 100644 --- a/Documentation/pg-plugin-dev.txt +++ b/Documentation/pg-plugin-dev.txt
@@ -34,6 +34,33 @@ link:https://gerrit.googlesource.com/gerrit/+/master/polygerrit-ui/app/samples/[polygerrit-ui/app/samples/] directory of the source tree. +== TypeScript API == + +Gerrit provides a TypeScript plugin API. + +For a plugin built inline, its `tsconfig.json` can extends Gerrit plugin +TypeScript configuration: + +`tsconfig.json`: +``` json +{ + "extends": "../tsconfig-plugins-base.json" +} +``` + +For standalone plugins (outside of a Gerrit tree), a TypeScript plugin API is +published: +link:https://www.npmjs.com/package/@gerritcodereview/typescript-api[@gerritcodereview/typescript-api]. +It provides a TypeScript configuration `tsconfig-plugins-base.json` which can +be used in your plugin `tsconfig.json`: + +``` json +{ + "extends": "node_modules/@gerritcodereview/typescript-api/tsconfig-plugins-base.json", + // your custom configuration and overrides +} +``` + [[low-level-api-concepts]] == Low-level DOM API concepts
diff --git a/Documentation/pgm-ChangeExternalIdCaseSensitivity.txt b/Documentation/pgm-ChangeExternalIdCaseSensitivity.txt new file mode 100644 index 0000000..1fb4b97 --- /dev/null +++ b/Documentation/pgm-ChangeExternalIdCaseSensitivity.txt
@@ -0,0 +1,71 @@ += ChangeExternalIdCaseSensitivity + +== NAME +ChangeExternalIdCaseSensitivity - Convert `username` and `gerrit` +external IDs to be handled case insensitively + +== SYNOPSIS +[verse] +-- +_java_ -jar gerrit.war _ChangeExternalIdCaseSensitivity_ + -d <SITE_PATH> + [--batch] + [--dryrun] +-- + +== DESCRIPTION +Convert `username` and `gerrit` external IDs to be handled case +insensitively or case sensitively. This is done by recomputing +the name of the note from the sha1 sum of the all lowercase +external ID key or of the key with its original capitalization +respectively. + +The tool uses the `auth.userNameCaseInsensitive` option to determine, +whether the migration should be performed to case insensitive or case sensitive +usernames, i.e. if the option is set to `false`, migration will be performed to +make external IDs case insensitive and if set to `true` to case sensitive. + +== OPTIONS + +-d:: +--site-path:: + Path of the Gerrit site + +--batch:: + No user interaction is required. The tool won't ask for confirmation before migrating. + +--dryrun:: + Whether to perform the conversion without persisting it. + +== CONTEXT +This command can only be run offline with direct access to the server's +site. + +== EXAMPLES +To convert the external IDs to be case insensitive: + +---- + $ git config -f $SITE/etc/gerrit.config --get auth.userNameCaseInsensitive + > false + $ java -jar gerrit.war ChangeExternalIdCaseSensitivity -d site_path +---- + +To convert the external IDs to be case sensitive again: + +---- + $ git config -f $SITE/etc/gerrit.config --get auth.userNameCaseInsensitive + > true + $ java -jar gerrit.war ChangeExternalIdCaseSensitivity -d site_path +---- + + +== SEE ALSO + +* Configuration parameter link:config-gerrit.html#auth.userNameCaseInsensitive[auth.userNameCaseInsensitive] + +GERRIT +------ +Part of link:index.html[Gerrit Code Review] + +SEARCHBOX +---------
diff --git a/Documentation/pgm-SwitchSecureStore.txt b/Documentation/pgm-SwitchSecureStore.txt index 47de1be..818ce2b 100644 --- a/Documentation/pgm-SwitchSecureStore.txt +++ b/Documentation/pgm-SwitchSecureStore.txt
@@ -7,7 +7,7 @@ [verse] -- _java_ -jar gerrit.war _SwitchSecureStore_ - [--new-secure-store-lib] + [--new-secure-store-lib=<PATH_TO_JAR>] -- == DESCRIPTION
diff --git a/Documentation/pgm-index.txt b/Documentation/pgm-index.txt index dde0231..8f4cbda 100644 --- a/Documentation/pgm-index.txt +++ b/Documentation/pgm-index.txt
@@ -38,6 +38,9 @@ link:pgm-LocalUsernamesToLowerCase.html[LocalUsernamesToLowerCase]:: Convert the local username of every account to lower case. +link:pgm-ChangeExternalIdCaseSensitivity.html[ChangeExternalIdCaseSensitivity]:: + Convert external IDs to be case insensitive. + link:pgm-MigrateAccountPatchReviewDb.html[MigrateAccountPatchReviewDb]:: Migrates AccountPatchReviewDb from one database backend to another.
diff --git a/Documentation/pgm-init.txt b/Documentation/pgm-init.txt index 9f592486..4b346fe 100644 --- a/Documentation/pgm-init.txt +++ b/Documentation/pgm-init.txt
@@ -16,10 +16,11 @@ [--list-plugins] [--install-plugin=<PLUGIN_NAME>] [--install-all-plugins] - [--secure-store-lib] + [--secure-store-lib=<PATH_TO_JAR>] [--dev] [--skip-all-downloads] [--skip-download=<LIBRARY_NAME>] + [--reindex-threads=<N>] -- == DESCRIPTION @@ -37,11 +38,6 @@ install, reasonable configuration defaults are chosen based on the whims of the Gerrit developers. On upgrades, the existing settings in `gerrit.config` are respected. -+ -If during a schema migration unused objects (e.g. tables, columns) -are detected, they are *not* automatically dropped; a list of SQL -statements to drop these objects is provided. To drop the unused -objects these SQL statements must be executed manually. --delete-caches:: Force deletion of all persistent cache files. Note that @@ -102,6 +98,11 @@ --show-cache-stats:: Show cache statistics at the end of program. +--reindex-threads:: + Number of threads to use for reindex after init. Defaults to 1. Can be + set to -1 to skip reindex after init. Skipping reindex will also not + automatically start the daemon. + == CONTEXT This command can only be run on a server which has direct local access to the managed Git repositories.
diff --git a/Documentation/pgm-reindex.txt b/Documentation/pgm-reindex.txt index b74829d..183c132 100644 --- a/Documentation/pgm-reindex.txt +++ b/Documentation/pgm-reindex.txt
@@ -39,6 +39,12 @@ --show-cache-stats:: Show cache statistics at the end of program. +--build-bloom-filter:: + Whether to build bloom filters for H2 disk caches. When using fully + populated disk caches on large Gerrit sites, it is recommended that + bloom filters are disabled to improve performance. + + == CONTEXT The secondary index must be enabled. See link:config-gerrit.html#index.type[index.type].
diff --git a/Documentation/project-configuration.txt b/Documentation/project-configuration.txt index e583f45..3c88c2e 100644 --- a/Documentation/project-configuration.txt +++ b/Documentation/project-configuration.txt
@@ -5,7 +5,7 @@ There are several ways to create a new project in Gerrit: -- in the Web UI under 'Projects' > 'Create Project' +- click 'CREATE NEW' in the Web UI under 'BROWSE' > 'Repositories' - via the link:rest-api-projects.html#create-project[Create Project] REST endpoint - via the link:cmd-create-project.html[create-project] SSH command @@ -58,7 +58,7 @@ There are several ways to create a new branch in a project: -- in the Web UI under 'Projects' > 'List' > <project> > 'Branches' +- in the Web UI under 'BROWSE' > 'Repositories' > <project> > 'Branches' - via the link:rest-api-projects.html#create-branch[Create Branch] REST endpoint - via the link:cmd-create-branch.html[create-branch] SSH command @@ -84,7 +84,7 @@ There are several ways to delete a branch: -- in the Web UI under 'Projects' > 'List' > <project> > 'Branches' +- in the Web UI under 'BROWSE' > 'Repositories' > <project> > 'Branches' - via the link:rest-api-projects.html#delete-branch[Delete Branch] REST endpoint - by using a git client @@ -114,10 +114,11 @@ For convenience reasons, when the repository is cloned Git creates a local branch for this default branch and checks it out. -Project owners can set `HEAD` +Project owners can set `HEAD` several ways: -- in the Web UI under 'Projects' > 'List' > <project> > 'Branches' or +- in the Web UI under 'BROWSE' > 'Repositories' > <project> > 'Branches' - via the link:rest-api-projects.html#set-head[Set HEAD] REST endpoint +- via the link:cmd-set-head.html[Set HEAD] SSH command GERRIT
diff --git a/Documentation/prolog-cookbook.txt b/Documentation/prolog-cookbook.txt index 189ccfc..c083f28 100644 --- a/Documentation/prolog-cookbook.txt +++ b/Documentation/prolog-cookbook.txt
@@ -23,6 +23,11 @@ `rules.enable=false` in the Gerrit config file (see link:config-gerrit.html#_a_id_rules_a_section_rules[rules section]) +[NOTE] +Gerrit's default submit rule is skipped if a project contains prolog rules. +The prolog submit rules are responsible for returning the necessary labels in +this case. + link:https://groups.google.com/d/topic/repo-discuss/wJxTGhlHZMM/discussion[This discussion thread,role=external,window=_blank] explains why Prolog was chosen for the purpose of writing project specific submit rules.
diff --git a/Documentation/repository-maintenance.txt b/Documentation/repository-maintenance.txt index 1672436..4bf84b5 100644 --- a/Documentation/repository-maintenance.txt +++ b/Documentation/repository-maintenance.txt
@@ -28,7 +28,7 @@ Unlike a typical server database, access to Git repositories is not marshalled through a single process or a set of inter communicating -processes. Unfortuntatlely the design of the on-disk layout of a Git +processes. Unfortunately the design of the on-disk layout of a Git repository does not allow for 100% race free operations when accessed by multiple actors concurrently. These design shortcomings are more likely to impact the operations of busy repositories since racy conditions are
diff --git a/Documentation/rest-api-accounts.txt b/Documentation/rest-api-accounts.txt index 8aa3173..ae0c0a6 100644 --- a/Documentation/rest-api-accounts.txt +++ b/Documentation/rest-api-accounts.txt
@@ -1342,6 +1342,8 @@ "date_format": "STD", "time_format": "HHMM_12", "size_bar_in_change_table": true, + "disable_keyboard_shortcuts": true, + "disable_token_highlighting": true, "diff_view": "SIDE_BY_SIDE", "mute_common_path_prefixes": true, "my": [ @@ -1392,6 +1394,8 @@ "size_bar_in_change_table": true, "diff_view": "SIDE_BY_SIDE", "publish_comments_on_push": true, + "disable_keyboard_shortcuts": true, + "disable_token_highlighting": true, "work_in_progress_by_default": true, "mute_common_path_prefixes": true, "my": [ @@ -1760,7 +1764,7 @@ [ { "identity": "username:john", - "email": "john.doe@example.com", + "email_address": "john.doe@example.com", "trusted": true } ] @@ -1777,7 +1781,16 @@ Only external ids belonging to the caller may be deleted. Users that have link:access-control.html#capability_modifyAccount[Modify Account] can delete -external ids that belong to other accounts. +external ids that belong to other accounts. External ids in the 'username:' +scheme can only be deleted by users that have +link:access-control.html#capability_administrateServer[Administrate Server] +or both +link:access-control.html#capability_maintainServer[Maintain Server] and +link:access-control.html#capability__modifyAccount[Modify Account] +since the user may not be able to login anymore, after the removal of the +external id with scheme 'username:'. Users cannot delete their own external id +with scheme 'username:' in order to prevent they can lock themselves out +since they may not be able to login anymore. .Request ---- @@ -1999,7 +2012,7 @@ -- Star a change with the default label. Changes starred with the default -label are returned for the search query `is:starred` or `starredby:USER` +label are returned for the search query `is:starred` or `has:star` and automatically notify the user whenever updates are made to the change. @@ -2031,131 +2044,6 @@ HTTP/1.1 204 No Content ---- -[[star-endpoints]] -== Star Endpoints - -[[get-starred-changes]] -=== Get Starred Changes --- -'GET /accounts/link:#account-id[\{account-id\}]/stars.changes' --- - -Gets the changes that were starred with any label by the identified -user account. This URL endpoint is functionally identical to the -changes query `GET /changes/?q=has:stars`. The result is a list of -link:rest-api-changes.html#change-info[ChangeInfo] entities. - -.Request ----- - GET /a/accounts/self/stars.changes ----- - -.Response ----- - HTTP/1.1 200 OK - Content-Disposition: attachment - Content-Type: application/json; charset=UTF-8 - - )]}' - [ - { - "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", - "project": "myProject", - "branch": "master", - "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", - "subject": "Implementing Feature X", - "status": "NEW", - "created": "2013-02-01 09:59:32.126000000", - "updated": "2013-02-21 11:16:36.775000000", - "stars": [ - "ignore", - "risky" - ], - "mergeable": true, - "submittable": false, - "insertions": 145, - "deletions": 12, - "_number": 3965, - "owner": { - "name": "John Doe" - } - } - ] ----- - -[[get-stars]] -=== Get Star Labels From Change --- -'GET /accounts/link:#account-id[\{account-id\}]/stars.changes/link:rest-api-changes.html#change-id[\{change-id\}]' --- - -Get star labels from a change. - -.Request ----- - GET /a/accounts/self/stars.changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940 HTTP/1.0 ----- - -As response the star labels that the user applied on the change are -returned. The labels are lexicographically sorted. - -.Response ----- - HTTP/1.1 200 OK - Content-Disposition: attachment - Content-Type: application/json; charset=UTF-8 - - )]}' - [ - "blue", - "green", - "red" - ] ----- - -[[set-stars]] -=== Update Star Labels On Change --- -'POST /accounts/link:#account-id[\{account-id\}]/stars.changes/link:rest-api-changes.html#change-id[\{change-id\}]' --- - -Update star labels on a change. The star labels to be added/removed -must be specified in the request body as link:#stars-input[StarsInput] -entity. Starred changes are returned for the search query `has:stars`. - -.Request ----- - POST /a/accounts/self/stars.changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940 HTTP/1.0 - Content-Type: application/json; charset=UTF-8 - - { - "add": [ - "blue", - "red" - ], - "remove": [ - "yellow" - ] - } ----- - -As response the star labels that the user applied on the change are -returned. The labels are lexicographically sorted. - -.Response ----- - HTTP/1.1 200 OK - Content-Disposition: attachment - Content-Type: application/json; charset=UTF-8 - - )]}' - [ - "blue", - "green", - "red" - ] ----- - [[ids]] == IDs @@ -2250,7 +2138,7 @@ |============================ |Field Name ||Description |`identity` ||The account external id. -|`email` |optional|The email address for the external id. +|`email_address` |optional|The email address for the external id. |`trusted` |not set if `false`| Whether the external id is trusted. |`can_delete` |not set if `false`| @@ -2818,6 +2706,8 @@ Allowed values are `AUTO_MERGE` and `FIRST_PARENT`. |`disable_keyboard_shortcuts` |not set if `false`| Whether to disable all keyboard shortcuts. +|`disable_token_highlighting` [not set if `false`] +Whether to disable token highlighting on hover. |`publish_comments_on_push` |not set if `false`| Whether to link:user-upload.html#publish-comments[publish draft comments] on push by default. @@ -2883,6 +2773,8 @@ The base which should be pre-selected in the 'Diff Against' drop-down list when the change screen is opened for a merge commit. Allowed values are `AUTO_MERGE` and `FIRST_PARENT`. +|`disable_keyboard_shortcuts` |not set if `false`| +Whether to disable all keyboard shortcuts. |============================================ [[query-limit-info]] @@ -2913,18 +2805,6 @@ |`valid` ||Whether the SSH key is valid. |============================= -[[stars-input]] -=== StarsInput -The `StarsInput` entity contains star labels that should be added to -or removed from a change. - -[options="header",cols="1,^1,5"] -|======================== -|Field Name ||Description -|`add` |optional|List of labels to add to the change. -|`remove` |optional|List of labels to remove from the change. -|======================== - [[username-input]] === UsernameInput The `UsernameInput` entity contains information for setting the
diff --git a/Documentation/rest-api-changes.txt b/Documentation/rest-api-changes.txt index 8da7a9d..5df78cc 100644 --- a/Documentation/rest-api-changes.txt +++ b/Documentation/rest-api-changes.txt
@@ -239,6 +239,12 @@ current user. -- +[[submit-requirements]] +-- +* `SUBMIT_REQUIREMENTS`: detailed result of the evaluated submit requirements + for this change. +-- + [[current-revision]] -- * `CURRENT_REVISION`: describe the current revision (patch set) @@ -594,8 +600,9 @@ ---- As a response, two link:#change-info[ChangeInfo] entities are returned -that describe information added and removed from the `old` change state. -Only fields that differ between the change's two states are returned. +that describe information added and removed from the `old` change state, and +the two link:#change-info[ChangeInfo] entities that generated the diff are +returned. Only fields that differ between the change's two states are returned. .Response ---- @@ -619,9 +626,55 @@ "topic": "new-topic" }, "removed": { - "updated": "2013-02-20 12:05:34.111000000", + "updated": "2013-02-01 09:59:32.126000000", "topic": "old-topic" - } + }, + "old_change_info": { + "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", + "project": "myProject", + "branch": "master", + "attention_set": [], + "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", + "subject": "Implementing Feature X", + "status": "NEW", + "topic": "old-topic", + "created": "2013-02-01 09:59:32.126000000", + "updated": "2013-02-01 09:59:32.126000000", + "mergeable": true, + "insertions": 34, + "deletions": 101, + "_number": 3965, + "owner": { + "name": "John Doe" + } + }, + "new_change_info": { + "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", + "project": "myProject", + "branch": "master", + "attention_set": [ + { + "account": { + "name": "John Doe" + }, + "last_update": "2013-02-21 11:16:36.775000000", + "reason": "reviewer or cc replied" + } + ], + "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", + "subject": "Implementing Feature X", + "status": "NEW", + "topic": "new-topic", + "created": "2013-02-01 09:59:32.126000000", + "updated": "2013-02-21 11:16:36.775000000", + "mergeable": true, + "insertions": 34, + "deletions": 101, + "_number": 3965, + "owner": { + "name": "John Doe" + } + }, } ---- @@ -1741,6 +1794,18 @@ As response a link:#change-info[ChangeInfo] entity is returned that describes the submitted/merged change. +Submission may submit multiple changes, but we still only return one ChangeInfo +object. To query for all submitted changes, please use the submission_id that is +part of the response. + +Changes that will also be submitted: +1. All changes of the same topic if +link:config-gerrit.html#change.submitWholeTopic[`change.submitWholeTopic`] +configuration is set to true. +2. All dependent changes. +3. The closure of the above (e.g if a dependent change has a topic, all changes +of *that* topic will also be submitted). + .Response ---- HTTP/1.1 200 OK @@ -2543,42 +2608,6 @@ PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/unignore HTTP/1.0 ---- -[[mark-as-reviewed]] -=== Mark as Reviewed --- -'PUT /changes/link:#change-id[\{change-id\}]/reviewed' --- - -Marks a change as reviewed. - -This allows users to "de-highlight" changes in their dashboard until a new -patch set is uploaded. - -This differs from the link:#ignore[ignore] endpoint, which will mute -emails and hide the change from dashboard completely until it is -link:#unignore[unignored] again. - - -.Request ----- - PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/reviewed HTTP/1.0 ----- - -[[mark-as-unreviewed]] -=== Mark as Unreviewed --- -'PUT /changes/link:#change-id[\{change-id\}]/unreviewed' --- - -Marks a change as unreviewed. - -This allows users to "highlight" changes in their dashboard - -.Request ----- - PUT /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/unreviewed HTTP/1.0 ----- - [[get-hashtags]] === Get Hashtags -- @@ -2789,6 +2818,53 @@ } ---- +[[check-submit-requirement]] +=== Check Submit Requirement +-- +'POST /changes/link:#change-id[\{change-id\}]/check.submit_requirement' +-- + +Tests a submit requirement and returns the result as a +link:#submit-requirement-result-info[SubmitRequirementResultInfo]. The request +body must contain a link:#submit-requirement-input[SubmitRequirementInput]. + +Note that this endpoint does not modify the change resource. + +.Request +---- + POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/check.submit_requirement HTTP/1.0 + Content-Type: application/json; charset=UTF-8 + + { + "name": "Code-Review", + "submittability_expression": "label:Code-Review=+2" + } +---- + +As response a link:#submit-requirement-result-info[SubmitRequirementResultInfo] +entity is returned that describes the submit requirement result. + +.Response +---- + HTTP/1.1 200 OK + Content-Disposition: attachment + Content-Type: application/json; charset=UTF-8 + + )]}' + { + "name": "Code-Review", + "status": "SATISFIED", + "submittability_expression_result": { + "expression": "label:Code-Review=+2", + "fulfilled": true, + "passingAtoms": [ + "label:Code-Review=+2" + ] + }, + "is_legacy": false + } +---- + [[edit-endpoints]] == Change Edit Endpoints @@ -3246,6 +3322,8 @@ * are visible to the calling user * are not already reviewer on the change * don't own the change +* are not service users (unless + link:config.html#suggest.skipServiceUsers[skipServiceUsers] is set to `false`) Groups can be excluded from the results by specifying the 'exclude-groups' request parameter: @@ -3360,7 +3438,7 @@ } ---- -As response an link:#add-reviewer-result[AddReviewerResult] entity is +As response an link:#reviewer-result[ReviewerResult] entity is returned that describes the newly added reviewers. .Response @@ -3573,6 +3651,9 @@ Deletes a single vote from a change. Note, that even when the last vote of a reviewer is removed the reviewer itself is still listed on the change. +If another user removed a user's vote, the user with the deleted vote will be +added to the attention set. + .Request ---- DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/reviewers/John%20Doe/votes/Code-Review HTTP/1.0 @@ -3804,8 +3885,8 @@ } ---- -The response is a flat map of possible revision actions mapped to their -link:#action-info[ActionInfo]. +The response is a flat map of possible revision REST endpoint names +mapped to their link:#action-info[ActionInfo]. [[get-review]] === Get Review @@ -4163,7 +4244,7 @@ Each element of the `reviewers` list is an instance of link:#reviewer-input[ReviewerInput]. The corresponding result of adding each reviewer will be returned in a map of inputs to -link:#add-reviewer-result[AddReviewerResult]s. +link:#reviewer-result[ReviewerResult]s. .Response ---- @@ -4403,14 +4484,27 @@ -- Submits a revision. +Submitting a change also removes all users from the link:#attention-set[attention set]. .Request ---- POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/submit HTTP/1.0 ---- -As response a link:#submit-info[SubmitInfo] entity is returned that -describes the status of the submitted change. +As response a link:#change-info[ChangeInfo] entity is returned that +describes the submitted/merged change. + +Submission may submit multiple changes, but we still only return one ChangeInfo +object. To query for all submitted changes, please use the submission_id that is +part of the response. + +Changes that will also be submitted: +1. All changes of the same topic if +link:config-gerrit.html#change.submitWholeTopic[`change.submitWholeTopic`] +configuration is set to true. +2. All dependent changes. +3. The closure of the above (e.g if a dependent change has a topic, all changes +of *that* topic will also be submitted). .Response ---- @@ -4420,7 +4514,19 @@ )]}' { - "status": "MERGED" + "id": "myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940", + "project": "myProject", + "branch": "master", + "change_id": "I8473b95934b5732ac55d26311a706c9c2bde9940", + "subject": "Implementing Feature X", + "status": "MERGED", + "created": "2013-02-01 09:59:32.126000000", + "updated": "2013-02-21 11:16:36.775000000", + "submitted": "2013-02-21 11:16:36.615000000", + "_number": 3965, + "owner": { + "name": "John Doe" + } } ---- @@ -5800,6 +5906,11 @@ link:#cherrypick-input[CherryPickInput] entity. If the commit message does not specify a Change-Id, a new one is picked for the destination change. +When cherry-picking a change into a branch that already contains the Change-Id +that we want to cherry-pick, the cherry-pick will create a new patch-set on the +destination's branch's appropriate Change-Id. If the change is closed on the +destination branch, the cherry-pick will fail. + .Request ---- POST /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/cherrypick HTTP/1.0 @@ -5937,6 +6048,9 @@ Note, that even when the last vote of a reviewer is removed the reviewer itself is still listed on the change. +If another user removed a user's vote, the user with the deleted vote will be +added to the attention set. + .Request ---- DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/revisions/674ac754f91e64a0efb8087e59a176484bd534d1/reviewers/John%20Doe/votes/Code-Review HTTP/1.0 @@ -6115,6 +6229,9 @@ * The change is marked ready for review. * As an owner/uploader, when someone replies on your change. * As a reviewer, when the owner/uploader replies. +* When the user's vote is deleted by another user. +* The rules above (except manually adding to the attention set) don't apply + for changes that are work in progress. Users are removed from the attention set if one the following apply: @@ -6143,16 +6260,25 @@ [[change-id]] === \{change-id\} Identifier that uniquely identifies one change. It contains the URL-encoded -project name as well as the change number: "'$$<project>~<numericId>$$'" +project name as well as the change number: "'$$<project>~<changeNumber>$$'" -Gerrit also supports the following identifiers: +==== Alternative identifiers +Gerrit also supports an array of other change identifiers. + +[NOTE] +Even though these identifiers will work in the majority of cases it is highly +recommended to use "'$$<project>~<changeNumber>$$'" whenever possible. +Since these identifiers require additional lookups from index and caches, to +be translated to the "'$$<project>~<changeNumber>$$'" identifier, they +may result in both false-positives and false-negatives. +Furthermore the additional lookup mean that they come with a performance penalty. * an ID of the change in the format "'$$<project>~<branch>~<Change-Id>$$'", where for the branch the `refs/heads/` prefix can be omitted ("$$myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940$$") * a Change-Id if it uniquely identifies one change ("I8473b95934b5732ac55d26311a706c9c2bde9940") -* a numeric change ID ("4247") +* a change number if it uniquely identifies one change ("4247") [[change-message-id]] === \{change-message-id\} @@ -6258,33 +6384,6 @@ at the server or permissions are modified. Not present if false. |==================================== -[[add-reviewer-result]] -=== AddReviewerResult -The `AddReviewerResult` entity describes the result of adding a -reviewer to a change. - -[options="header",cols="1,^1,5"] -|=========================== -|Field Name ||Description -|`input` || -Value of the `reviewer` field from link:#reviewer-input[ReviewerInput] -set while adding the reviewer. -|`reviewers` |optional| -The newly added reviewers as a list of link:#reviewer-info[ -ReviewerInfo] entities. -|`ccs` |optional| -The newly CCed accounts as a list of link:#reviewer-info[ -ReviewerInfo] entities. This field will only appear if the requested -`state` for the reviewer was `CC` *and* NoteDb is enabled on the -server. -|`error` |optional| -Error message explaining why the reviewer could not be added. + -If a group was specified in the input and an error is returned, it -means that none of the members were added as reviewer. -|`confirm` |`false` if not set| -Whether adding the reviewer requires confirmation. -|=========================== - [[approval-info]] === ApprovalInfo The `ApprovalInfo` entity contains information about an approval from a @@ -6340,7 +6439,13 @@ |Field Name ||Description |`account` || link:rest-api-accounts.html#account-info[AccountInfo] entity. |`last_update` || The link:rest-api.html#timestamp[timestamp] of the last update. -|`reason` || The reason of for adding or removing the user. +|`reason` || +The reason for adding or removing the user. +If the update was caused by another user, that account is represented by +account ID in reason as `<GERRIT_ACCOUNT_18419>` and the corresponding +link:rest-api-accounts.html#account-info[AccountInfo] can be found in `reason_account` field. +|`reason_account` || +link:rest-api-accounts.html#account-info[AccountInfo] of the user who caused the update. |=========================== [[attention-set-input]] @@ -6429,8 +6534,7 @@ The assignee of the change as an link:rest-api-accounts.html#account-info[ AccountInfo] entity. |`hashtags` |optional| -List of hashtags that are set on the change (only populated when NoteDb -is enabled). +List of hashtags that are set on the change. |`change_id` ||The Change-Id of the change. |`subject` || The subject of the change (header line of the commit message). @@ -6477,7 +6581,9 @@ |`unresolved_comment_count` |optional| Number of unresolved inline comment threads across all patch sets. Not set if the current change index doesn't have the data. -|`_number` ||The legacy numeric ID of the change. +|`_number` || +The change number. (The underscore is just a relict of a prior +attempt to deprecate the change number.) |`owner` || The owner of the change as an link:rest-api-accounts.html#account-info[ AccountInfo] entity. @@ -6485,9 +6591,16 @@ Actions the caller might be able to perform on this revision. The information is a map of view name to link:#action-info[ActionInfo] entities. +|`submit_records` || +List of the link:rest-api-changes.html#submit-record-info[SubmitRecordInfo] +containing the submit records for the change at the latest patchset. |`requirements` |optional| List of the link:rest-api-changes.html#requirement[requirements] to be met before this change -can be submitted. +can be submitted. This field is deprecated in favour of `submit_requirements`. +|`submit_requirements` |optional| +List of the link:#submit-requirement-result-info[SubmitRequirementResultInfo] +containing the evaluated submit requirements for the change. +Only set if link:#submit-requirements[`SUBMIT_REQUIREMENTS`] is requested. |`labels` |optional| The labels of the change as a map that maps the label names to link:#label-info[LabelInfo] entries. + @@ -6556,15 +6669,15 @@ |`has_review_started` |optional, not set if `false`| When present, change has been marked Ready at some point in time. |`revert_of` |optional| -The numeric Change-Id of the change that this change reverts. +The change number of the change that this change reverts. |`submission_id` |optional| ID of the submission of this change. Only set if the status is `MERGED`. -This ID is equal to the numeric ID of the change that triggered the submission. -If the change that triggered the submission also has a topic, it will be -"<id>-<topic>" of the change that triggered the submission. +This ID is equal to the change number of the change that triggered the +submission. If the change that triggered the submission also has a topic, +it will be "<id>-<topic>" of the change that triggered the submission. The callers must not rely on the format of the submission ID. |`cherry_pick_of_change` |optional| -The numeric Change-Id of the change that this change was cherry-picked from. +The change number of the change that this change was cherry-picked from. Only set if the cherry-pick has been done through the Gerrit REST API (and not if a cherry-picked commit was pushed). |`cherry_pick_of_patch_set`|optional| @@ -6622,6 +6735,14 @@ |`new_branch` |optional, default to `false`| Allow creating a new branch when set to `true`. Using this option is only possible for non-merge commits (if the `merge` field is not set). +|`validation_options` |optional| +Map with key-value pairs that are forwarded as options to the commit validation +listeners (e.g. can be used to skip certain validations). Which validation +options are supported depends on the installed commit validation listeners. +Gerrit core doesn't support any validation options, but commit validation +listeners that are implemented in plugins may. Please refer to the +documentation of the installed plugins to learn whether they support validation +options. Unknown validation options are silently ignored. |`merge` |optional| The detail of a merge commit as a link:#merge-input[MergeInput] entity. If set, the target branch (see `branch` field) must exist (it is not @@ -6664,7 +6785,12 @@ Set if the message was posted on behalf of another user. |`date` || The link:rest-api.html#timestamp[timestamp] this message was posted. -|`message` ||The text left by the user. +|`message` || +The text left by the user or Gerrit system. Accounts are served as account IDs +inlined in the text as `<GERRIT_ACCOUNT_18419>`. +All accounts, used in message, can be found in `accountsInMessage` +field. +|`accountsInMessage` ||Accounts, used in `message`. |`tag` |optional| Value of the `tag` field from link:#review-input[ReviewInput] set while posting the review. Votes/comments that contain `tag` with @@ -6893,7 +7019,10 @@ The subject of the commit (header line of the commit message). |`message` ||The commit message. |`web_links` |optional| -Links to the commit in external sites as a list of +Links to the patch set in external sites as a list of +link:#web-link-info[WebLinkInfo] entities. +|`resolve_conflicts_web_links` |optional| +Links to the commit in external sites for resolving conflicts as a list of link:#web-link-info[WebLinkInfo] entities. |=========================== @@ -7069,6 +7198,9 @@ |`web_links` |optional| Links to the file diff in external sites as a list of link:rest-api-changes.html#diff-web-link-info[DiffWebLinkInfo] entries. +|`edit_web_links` |optional| +Links to edit the file in external sites as a list of +link:rest-api-changes.html#web-link-info[WebLinkInfo] entries. |`binary` |not set if `false`|Whether the file is binary. |========================== @@ -7278,7 +7410,8 @@ [[included-in-info]] === IncludedInInfo The `IncludedInInfo` entity contains information about the branches a -change was merged into and tags it was tagged with. +change was merged into and tags it was tagged with. The branch or tag +must have 'refs/head/' or 'refs/tags/' prefix respectively. [options="header",cols="1,^1,5"] |======================= @@ -7670,8 +7803,8 @@ RevertSubmission endpoint is `revert-{submission_id}-{timestamp.now}`. Topic can't contain quotation marks. |`work_in_progress` |optional| -When present, change is marked as Work In Progress. This will also override -the notify value to `OWNER`. + +When present, change is marked as Work In Progress. The `notify` input is +used if it's present, otherwise it will be overridden to `OWNER`. + If not set, the default is false. |============================= @@ -7756,6 +7889,13 @@ Only `KEEP` is allowed when used in conjunction with `on_behalf_of`. + If not set, the default is `KEEP`. If `on_behalf_of` is set, then no other value besides `KEEP` is allowed. +|`draft_ids_to_publish` |optional| +List of draft IDs to be published. The draft IDs should belong to the current +user and be valid. If `drafts` is set to `PUBLISH`, then draft IDs should +contain drafts for the same revision that is requested for review. If `drafts` +is set to `KEEP`, then `draft_ids_to_publish` will be ignored and no draft +comments will be published. + +If not set, the default is to publish all drafts according to the `drafts` field. |`notify` |optional| Notify handling that defines to whom email notifications should be sent after the review is stored. + @@ -7773,7 +7913,7 @@ have been granted `labelAs-NAME` permission for all keys of labels. |`reviewers` |optional| A list of link:rest-api-changes.html#reviewer-input[ReviewerInput] -representing reviewers that should be added to the change. +representing reviewers that should be added/removed to/from the change. |`ready` |optional| If true, and if the change is work in progress, then start review. It is an error for both `ready` and `work_in_progress` to be true. @@ -7806,8 +7946,8 @@ additions were rejected. |`reviewers` |optional| Map of account or group identifier to -link:rest-api-changes.html#add-reviewer-result[AddReviewerResult] -representing the outcome of adding as a reviewer. +link:rest-api-changes.html#reviewer-result[ReviewerResult] +representing the outcome of adding/removing a reviewer. Absent if no reviewer additions were requested. |`ready` |optional| If true, the change was moved from WIP to ready for review as a result of this @@ -7838,24 +7978,25 @@ [[reviewer-input]] === ReviewerInput -The `ReviewerInput` entity contains information for adding a reviewer -to a change. +The `ReviewerInput` entity contains information for adding or removing +reviewers to/from the change. [options="header",cols="1,^1,5"] |============================= |Field Name ||Description |`reviewer` || The link:rest-api-accounts.html#account-id[ID] of one account that -should be added as reviewer or the link:rest-api-groups.html#group-id[ +should be added/removed as reviewer or the link:rest-api-groups.html#group-id[ ID] of one internal group for which all members should be added as reviewers. + If an ID identifies both an account and a group, only the account is added as reviewer to the change. External groups, such as LDAP groups, will be silently omitted from a link:#set-review[set-review] or -link:rest-api-changes.html#add-reviewer[add-reviewer] call. +link:rest-api-changes.html#add-reviewer[add-reviewer] call. A group can only be +specified for adding reviewers, not for removing them. |`state` |optional| -Add reviewer in this state. Possible reviewer states are `REVIEWER` -and `CC`. If not given, defaults to `REVIEWER`. +Add reviewer in this state. Possible reviewer states are `REVIEWER`, +`CC` and `REMOVED`. If not given, defaults to `REVIEWER`. |`confirmed` |optional| Whether adding the reviewer is confirmed. + The Gerrit server may be configured to @@ -7872,6 +8013,37 @@ link:#notify-info[NotifyInfo] entity. |============================= +[[reviewer-result]] +=== ReviewerResult +The `ReviewerResult` entity describes the result of modifying reviewers of +a change. + +[options="header",cols="1,^1,5"] +|=========================== +|Field Name ||Description +|`input` || +Value of the `reviewer` field from link:#reviewer-input[ReviewerInput] +set while adding the reviewer. +|`reviewers` |optional| +The newly added reviewers as a list of link:#reviewer-info[ +ReviewerInfo] entities. +|`ccs` |optional| +The newly CCed accounts as a list of +link:rest-api-accounts.html#account-info[AccountInfo] entities. This field will +only appear if the requested `state` for the reviewer was `CC`. +|`removed` |optional| +The newly removed accounts as a list of +link:rest-api-accounts.html#account-info[AccountInfo] entities. +This field will only appear if the requested `state` for the reviewer was +`REMOVED`. +|`error` |optional| +Error message explaining why the reviewer could not be added. + +If a group was specified in the input and an error is returned, it +means that none of the members were added as reviewer. +|`confirm` |`false` if not set| +Whether adding the reviewer requires confirmation. +|=========================== + [[revision-info]] === RevisionInfo The `RevisionInfo` entity contains information about a patch set. @@ -8003,27 +8175,6 @@ to return results from the input rule. |=========================== -[[submit-info]] -=== SubmitInfo -The `SubmitInfo` entity contains information about the change status -after submitting. - -[options="header",cols="1,^1,5"] -|========================== -|Field Name ||Description -|`status` || -The status of the change after submitting is `MERGED`. -|`on_behalf_of`|optional| -The link:rest-api-accounts.html#account-id[\{account-id\}] of the user on -whose behalf the action should be done. To use this option the caller must -have been granted both `Submit` and `Submit (On Behalf Of)` permissions. -The user named by `on_behalf_of` does not need to be granted the `Submit` -permission. This feature is aimed for CI solutions: the CI account can be -granted both permissions, so individual users don't need `Submit` permission -themselves. Still the changes can be submitted on behalf of real users and -not with the identity of the CI account. -|========================== - [[submit-input]] === SubmitInput The `SubmitInput` entity contains information for submitting a change. @@ -8085,6 +8236,117 @@ the failure of the rule predicate. |=========================== +[[submit-record-info]] +=== SubmitRecordInfo +The `SubmitRecordInfo` entity describes results from a submit_rule. + +[options="header",cols="1,^1,5"] +|=========================== +|Field Name ||Description +|`rule_name`|| +The name of the submit rule that created this submit record. The submit rule is +specified in the form of "$plugin~$rule" where `$plugin` is the plugin name +and `$rule` is the name of the class that implemented the submit rule. +|`status`|| +`OK`, the change can be submitted. + +`NOT_READY`, additional labels are required before submit. + +`CLOSED`, closed changes cannot be submitted. + +`FORCED`, the change was submitted bypassing the submit rule. + +`RULE_ERROR`, rule code failed with an error. +|`labels`|optional| +A list of labels, each containing the following fields. + + * `label`: the label name. + + * `status`: the label status: {`OK`, `REJECT`, `MAY`, `NEED`, `IMPOSSIBLE`}. + + * `appliedBy`: the link:rest-api-accounts.html#account-info[AccountInfo] + that applied the vote to the label. +|`requirements`|optional| +List of the link:rest-api-changes.html#requirement[requirements] to be met +before this change can be submitted. +|`error_message`|optional| +When status is RULE_ERROR this message provides some text describing +the failure of the rule predicate. +|=========================== + +[[submit-requirement-expression-info]] +=== SubmitRequirementExpressionInfo +The `SubmitRequirementExpressionInfo` describes the result of evaluating a +single submit requirement expression, for example `label:code-review=+2`. + +[options="header",cols="1,6"] +|=========================== +|Field Name |Description +|`expression`| +The submit requirement expression as a string, for example +`branch:refs/heads/foo and label:verified=+1`. +|`fulfilled`| +True if the submit requirement is fulfilled for the change. +|`passing_atoms`| +A list of passing atoms as strings. For the above expression, +`passing_atoms` can contain ["branch:refs/heads/foo"] if the branch predicate is +fulfilled for the change. +|`failing_atoms`| +A list of failing atoms. This is similar to `passing_atoms` except that it +contains the list of predicates that are not fulfilled for the change. +|=========================== + +[[submit-requirement-input]] +=== SubmitRequirementInput +The `SubmitRequirementInput` entity describes a submit requirement. + +[options="header",cols="1,^1,5"] +|=========================== +|Field Name ||Description +|`name`|| +The submit requirement name. +|`description`|optional| +Description of the submit requirement. +|`applicability_expression`|optional| +Query expression that can be evaluated on any change. If evaluated to true on a +change, the submit requirement is then applicable for this change. +If not specified, the submit requirement is applicable for all changes. +|`submittability_expression`|| +Query expression that can be evaluated on any change. If evaluated to true on a +change, the submit requirement is fulfilled and not blocking change submission. +|`override_expression`|optional| +Query expression that can be evaluated on any change. If evaluated to true on a +change, the submit requirement is overridden and not blocking change submission. +|`allow_override_in_child_projects`|optional| +Whether this submit requirement can be overridden in child projects. Default is +`true`. +|=========================== + +[[submit-requirement-result-info]] +=== SubmitRequirementResultInfo +The `SubmitRequirementResultInfo` describes the result of evaluating a +submit requirement on a change. + +[options="header",cols="1,^1,5"] +|=========================== +|Field Name ||Description +|`name`|| +The submit requirement name. +|`description`|optional| +Description of the submit requirement. +|`status`|| +Status describing the result of evaluating the submit requirement. The status +is one of (`SATISFIED`, `UNSATISFIED`, `OVERRIDDEN`, `NOT_APPLICABLE`, `ERROR`). +|`is_legacy`|| +If true, this submit requirement result was created from a legacy +link:#submit-record[SubmitRecord]. Otherwise, it was created by evaluating a +submit requirement. +|`applicability_expression_result`|optional| +A link:#submit-requirement-expression-info[SubmitRequirementExpressionInfo] +containing the result of evaluating the applicability expression. Not set if the +submit requirement did not define an applicability expression. +|`submittability_expression_result`|| +A link:#submit-requirement-expression-info[SubmitRequirementExpressionInfo] +containing the result of evaluating the submittability expression. +|`override_expression_result`|optional| +A link:#submit-requirement-expression-info[SubmitRequirementExpressionInfo] +containing the result of evaluating the override expression. Not set if the +submit requirement did not define an override expression. +|=========================== + [[submitted-together-info]] === SubmittedTogetherInfo The `SubmittedTogetherInfo` entity contains information about a
diff --git a/Documentation/rest-api-config.txt b/Documentation/rest-api-config.txt index 41a8729..bab3ff0 100644 --- a/Documentation/rest-api-config.txt +++ b/Documentation/rest-api-config.txt
@@ -1552,12 +1552,6 @@ |`allow_blame` |not set if `false`| link:config-gerrit.html#change.allowBlame[Whether blame on side by side diff is allowed]. -|`reply_label` || -link:config-gerrit.html#change.replyTooltip[Label name for the reply -button]. -|`reply_tooltip` || -link:config-gerrit.html#change.replyTooltip[Tooltip for the reply -button]. |`update_delay` || link:config-gerrit.html#change.updateDelay[How often in seconds the web interface should poll for updates to the currently open change]. @@ -1875,7 +1869,7 @@ [[index-changes-input]] === IndexChangesInput -The `IndexChangesInput` contains a list of numerical changes IDs to index. +The `IndexChangesInput` contains a list of change numbers of changes to index. [options="header",cols="1,^2,4"] |================================ @@ -2077,10 +2071,11 @@ |`start_time` ||The start time of the task. |`delay` ||The remaining delay of the task. |`command` ||The command of the task. +|`queue_name` ||The work queue the task is associated with. |`remote_name`|optional| The remote name. May only be set for tasks that are associated with a project. -|`project` |optional|The project the task is associated with. +|`project_name` |optional|The project the task is associated with. |==================================== [[task-summary-info]]
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt index 725920e..82b6553 100644 --- a/Documentation/rest-api-projects.txt +++ b/Documentation/rest-api-projects.txt
@@ -1541,6 +1541,47 @@ } ---- +[[commits-included-in]] +=== Get Commits Included In Refs +-- +'GET /projects/link:#project-name[\{project-name\}]/commits:in' +-- + +Gets refs in which the specified commits were merged into. Returns a map of commits +to sets of full ref names. + +One or more `commit` query parameters are required and each specifies a +commit-id (SHA-1 in 40 digit hex representation). Commits will not be contained +in the map if they do not exist or are not reachable from visible, specified refs. + +One or more `ref` query parameters are required and each specifies a full ref name. +Refs which are not visible to the calling user according to the project's read +permissions and refs which do not exist will be filtered out from the result. + +.Request +---- + GET /projects/work%2Fmy-project/commits:in?commit=a8a477efffbbf3b44169bb9a1d3a334cbbd9aa96&commit=6d2a3adb10e844c33617fc948dbeb88e868d396e&ref=refs/heads/master&ref=refs/heads/branch1 HTTP/1.0 +---- + +.Response +---- + HTTP/1.1 200 OK + Content-Disposition: attachment + Content-Type: application/json;charset=UTF-8 + + )]}' + { + "a8a477efffbbf3b44169bb9a1d3a334cbbd9aa96": [ + "refs/heads/master" + ], + "6d2a3adb10e844c33617fc948dbeb88e868d396e": [ + "refs/heads/branch1", + "refs/heads/master" + ] + } + +---- + [[branch-endpoints]] == Branch Endpoints @@ -2624,6 +2665,11 @@ If the commit message is not set, the commit message of the source commit will be used. +When cherry-picking a commit into a branch that already contains the Change-Id +that we want to cherry-pick, the cherry-pick will create a new patch-set on the +destination's branch's appropriate Change-Id. If the change is closed on the +destination branch, the cherry-pick will fail. + .Request ---- POST /projects/work%2Fmy-project/commits/a8a477efffbbf3b44169bb9a1d3a334cbbd9aa96/cherrypick HTTP/1.0 @@ -3962,6 +4008,8 @@ |`copy_any_score`|`false` if not set| Whether link:config-labels.html#label_copyAnyScore[copyAnyScore] is set on the label. +|`copy_condition`|optional| +See link:config-labels.html#label_copyCondition[copyCondition]. |`copy_min_score`|`false` if not set| Whether link:config-labels.html#label_copyMinScore[copyMinScore] is set on the label. @@ -4032,6 +4080,10 @@ |`copy_any_score`|optional| Whether link:config-labels.html#label_copyAnyScore[copyAnyScore] is set on the label. +|`copy_condition`|optional| +See link:config-labels.html#label_copyCondition[copyCondition]. +|`unset_copy_condition`|optional| +If true, clears the value stored in `copy_condition`. |`copy_min_score`|optional| Whether link:config-labels.html#label_copyMinScore[copyMinScore] is set on the label.
diff --git a/Documentation/rest-api.txt b/Documentation/rest-api.txt index eabcaa9..469bee5 100644 --- a/Documentation/rest-api.txt +++ b/Documentation/rest-api.txt
@@ -244,6 +244,60 @@ Given the trace ID an administrator can find the corresponding logs and investigate issues more easily. +[[deadline]] +=== Setting a deadline + +When invoking a REST endpoint it's possible that the client sets a deadline +after which the request should be aborted. To do this the `X-Gerrit-Deadline` +header must be set on the request. Values must be specified using standard time +unit abbreviations ('ms', 'sec', 'min', etc.). + +.Example Request +---- + GET /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940/suggest_reviewers?q=J + X-Gerrit-Deadline: 5m +---- + + +Setting a deadline on the request overrides any +link:config-gerrit.html#deadline.id[server-side deadline] that has been +configured on the host. + +[[updated-refs]] +=== X-Gerrit-UpdatedRef +This is only enabled when "X-Gerrit-UpdatedRef-Enabled" is set to "true" in the +request header. + +For each write REST request, we return X-Gerrit-UpdatedRef headers as the refs +that were updated in the current request (involved in a ref transaction in the +current request). + +The format of those headers is `PROJECT_NAME\~REF_NAME\~OLD_SHA-1\~NEW_SHA-1`. +The project and ref names are URL-encoded, and must use %7E for '~'. + +A new SHA-1 of `0000000000000000000000000000000000000000` is treated as a +deleted ref. +If the new SHA-1 is not `0000000000000000000000000000000000000000`, the ref was +either updated or created. +If the old SHA-1 is `0000000000000000000000000000000000000000`, the ref was +created. + +.Example Request +---- + DELETE /changes/myProject~master~I8473b95934b5732ac55d26311a706c9c2bde9940 +---- + +.Example Response +---- +HTTP/1.1 204 NO CONTENT + Content-Disposition: attachment + Content-Type: application/json; charset=UTF-8 + X-Gerrit-UpdatedRef: myProject~refs%2Fchanges%2F01%2F1%2F1~deadbeefdeadbeefdeadbeefdeadbeefdeadbeef~0000000000000000000000000000000000000000 + X-Gerrit-UpdatedRef: myProject~refs%2Fchanges%2F01%2F1%2Fmeta~deadbeefdeadbeefdeadbeefdeadbeefdeadbeef~0000000000000000000000000000000000000000 + + )]}' +---- + GERRIT ------ Part of link:index.html[Gerrit Code Review]
diff --git a/Documentation/user-attention-set.txt b/Documentation/user-attention-set.txt index 95e1258..1f67fc7 100644 --- a/Documentation/user-attention-set.txt +++ b/Documentation/user-attention-set.txt
@@ -47,8 +47,11 @@ attention set. * For merged and abandoned changes the owner is added only when a human creates an unresolved comment. +* If another user removed a user's vote, the user with the deleted vote will be + added to the attention set. * Only owner, uploader, reviewers and ccs can be in the attention set. * The rules for service accounts are different, see link:#bots[Bots]. +* Users are not added by automatic rules when the change is work in progress. *!IMPORTANT!* These rules are not meant to be super smart and to always do the right thing, e.g. if the change owner sends a reply, then they are often
diff --git a/Documentation/user-notify.txt b/Documentation/user-notify.txt index 5ee3136..0e658c7 100644 --- a/Documentation/user-notify.txt +++ b/Documentation/user-notify.txt
@@ -10,7 +10,7 @@ == Recipient Type Those are the available recipient types: -+ + * `to`: The standard To field is used; addresses are visible to all. * `cc`: The standard CC field is used; addresses are visible to all. * `bcc`: SMTP RCPT TO is used to hide the address. @@ -190,7 +190,7 @@ [[Gerrit-Change-Number]]Gerrit-Change-Number:: -The change number footer states the numeric ID of the change, for +The change number footer states the change number of the change, for example `92191`. [[Gerrit-PatchSet]]Gerrit-PatchSet::
diff --git a/Documentation/user-privacy.txt b/Documentation/user-privacy.txt index d61ee76..afedb7e 100644 --- a/Documentation/user-privacy.txt +++ b/Documentation/user-privacy.txt
@@ -8,7 +8,7 @@ |=== | Note: Gerrit has extensive support for link:config-plugins.html[plugins] which extend Gerrits functionality, and these plugins could access, export, or - maniuplate user data. This document only focuses on the behavior of Gerrit + manipulate user data. This document only focuses on the behavior of Gerrit core and its link:dev-core-plugins.html[core plugins]. |=== @@ -98,11 +98,6 @@ * Remove a user's e-mail from all existing commits * Remove a user's username -There is also a known -link:https://bugs.chromium.org/p/gerrit/issues/detail?id=14185[bug] where a -user's username is stored in metadata for link:user-attention-set.html[Attention -Set]. - ## Open Source Software Limitations @@ -110,4 +105,4 @@ required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific -language governing permissions and limitations under the License. \ No newline at end of file +language governing permissions and limitations under the License.
diff --git a/Documentation/user-request-cancellation-and-deadlines.txt b/Documentation/user-request-cancellation-and-deadlines.txt new file mode 100644 index 0000000..7c39f16 --- /dev/null +++ b/Documentation/user-request-cancellation-and-deadlines.txt
@@ -0,0 +1,186 @@ +:linkattrs: += Request Cancellation and Deadlines + +[[motivation]] +== Motivation + +Protect the Gerrit service by aborting requests that were cancelled or for which +the deadline has exceeded. If these requests are not aborted, it can happen that +too many of these requests are accumulated so that the server runs out of +resources (e.g. threads). + +[[request-cancellation]] +== Request Cancellation + +If a user cancels a request by disconnecting, ideally Gerrit should detect this +and abort the request execution to avoid doing unnecessary work. If nobody is +waiting for the response, Gerrit shouldn't spend resources to compute it. + +Detecting cancelled requests is not easily possible with all protocols that a +client may use. At the moment Gerrit only detects request cancellations for git +pushes, but not for other request types (in particular cancelled requests are +not detected for REST calls over HTTP, SSH commands and git clone/fetch). + +[[server-side-deadlines]] +== Server-side deadlines + +To limit the maximal execution time for requests, administrators can +link:config-gerrit.html#deadline.id[configure server-side deadlines]. If a +server-side deadline is exceeded by a matching request, the request is +automatically aborted. In this case the client gets a proper error message +informing the user about the exceeded deadline. + +Clients may override server-side deadlines by setting a +link:#client-provided-deadlines[deadline] on the request. This means, if a +request fails due to an exceeded server-side deadline, the client may repeat the +request with a higher deadline or no deadline (deadline = 0) to get unblocked. + +Server-side deadlines are meant to protect the Gerrit service against resource +exhaustion due to performence issues with a particular request. E.g. imagine a +situation where requests for a certain REST endpoint are very slow. If more and +more of such requests get stuck and are not being aborted, the Gerrit service +may run out of threads, causing an outage for the entire Gerrit service. +Server-side deadlines may prevent this because the slow requests get aborted +after the deadline is exceeded, and hence the server resources are freed up. + +In some cases server-side deadlines may also lead to a better user experience, +as it's better to tell the user that there is a performance issue, that prevents +the execution of the request, than letting them wait indefinitely. + +Finally server-side deadlines can help ops engineers to detect performance +issues more reliably and more quicky. For this alerts may be setup that are +based on the link:metrics.html#cancellations[cancellation metrics]. + +[[receive-timeout]] +=== Receive Timeout + +For git pushes it is possible to configure a +link:config-gerrit.html#receive.timeout[hard timeout]. In contrast to +server-side deadlines, this timeout is not overridable by +link:#client-provided-deadlines[client-provided deadlines]. + +[[client-provided-deadlines]] +== Client-provided deadlines + +Clients can set a deadline on requests to limit the maximal execution time that +they are willing to wait for a response. If the request doesn't finish within +this deadline the request is aborted and the client receives an error, with a +message telling them that the deadline has been exceeded. + +How to set a deadline on a request depends on the request type: + +[options="header",cols="1,6"] +|======================= +|Request Type |How to set a deadline? +|REST over HTTP |Set the link:rest-api.html#deadline[X-Gerrit-Deadline header]. +|SSH command |Set the link:cmd-index.html#deadline[deadline option]. +|git push |Set the link:user-upload.html#deadline[deadline push option]. +|git clone/fetch|Not supported. +|======================= + +[[override-server-side-deadline]] +=== Override server-side deadline + +By setting a deadline on a request it is possible to override any +link:#server-side-deadlines[server-side deadline], e.g. in order to increase it. +Setting the deadline to `0` disables any server-side deadline. This allows +clients to get unblocked if a request has previously failed due to an exceeded +deadline. + +[NOTE] +It is stronly discouraged for clients to permanently override +link:#server-side-deadlines[server-side deadlines] with a higher deadline or to +permanently disable them by always setting the deadline to `0`. If this becomes +necessary the caller should get in touch with the Gerrit administrators to +increase the server-side deadlines or resolve the performance issue in another +way. + +[NOTE] +It's not possible for clients to override the link:#receive-timeout[receive +timeout] that is enforced on git push. + +[[faqs]] +== FAQs + +[[deadline-exceeded-what-to-do]] +=== My request failed due to an execeeded deadline, what can I do? + +To get unblocked, you may repeat the request with deadlines disabled. To do this +set the deadline to `0` on the request as explained +link:#override-server-side-deadline[above]. + +If doing this becomes required frequently, please get in touch with the Gerrit +administrators in order to investigate the performance issue and increase the +server-side deadline if necessary. + +[NOTE] +Setting deadlines for requests that are done from the Gerrit web UI is not +possible. If exceeded deadlines occur frequently here, please get in touch with +the Gerrit administrators in order to investigate the performance issue. + +[[push-fails-due-to-exceeded-deadline-but-cannot-be-overridden]] +=== My git push fails due to an exceeded deadline and I cannot override the deadline, what can I do? + +As explained link:#receive-timeout[above] a configured receive timeout cannot be +overridden by clients. If pushes fail due to this timeout, get in touch with the +Gerrit administrators in order to investigate the performance issue and increase +the receive timeout if necessary. + +[[when-are-requests-aborted]] +=== How quickly does a request get aborted when it is cancelled or a deadline is exceeded? + +In order to know if a request should be aborted, Gerrit needs to explicitly +check whether the request is cancelled or whether a deadline is exceeded. +Gerrit does this check at the beginning and end of all performance critical +steps and sub-steps. This means, the request is only aborted the next time such +a step starts or finishes, which can also be never (e.g. if the request is stuck +inside of a step). + +[NOTE] +Technically the check whether a request should be aborted is done whenever the +execution time of an operation or sub-step is captured, either by a timer +metric or a `TraceTimer` ('TraceTimer` is the class that logs the execution time +when the request is being link:user-request-tracing.html[traced]). + +[[how-are-requests-aborted]] +=== How does Gerrit abort requests? + +The exact response that is returned to the client depends on the request type +and the cancellation reason: + +[options="header",cols="1,3,3"] +|======================= +|Request Type |Cancellation Reason|Response +|REST over HTTP |Client Disconnected|The response is '499 Client Closed Request'. +| |Server-side deadline exceeded|The response is '408 Server Deadline Exceeded'. +| |Client-provided deadline exceeded|The response is '408 Client Provided Deadline Exceeded'. +|SSH command |Client Disconnected|The error message is 'Client Closed Request'. +| |Server-side deadline exceeded|The error message is 'Server Deadline Exceeded'. +| |Client-provided deadline exceeded|The error message is 'Client Provided Deadline Exceeded'. +|git push |Client Disconnected|The error status is 'Client Closed Request'. +| |Server-side deadline exceeded|The error status is 'Server Deadline Exceeded'. +| |Client-provided deadline exceeded|The error status is 'Client Provided Deadline Exceeded'. +|git clone/fetch|Not supported. +|======================= + +This means clients always get a proper error message telling the user why the +request has been aborted. + +Errors due to aborted requests are usually not counted as internal server errors, +but the link:metrics.html#cancellations[cancellation metrics] may be used to +setup alerting for performance issues. + +[NOTE] +During a request, cancellations can occur at any time. This means for non-atomic +operations, it can happen that the operation is cancelled after some steps have +already been successfully performed and before all steps have been executed, +potentially leaving behind an inconsistent state (same as when a request fails +due to an error). However for important steps, such a NoteDb updates that span +multiple repositories, Gerrit ensures that they are not torn by cancellations. + +GERRIT +------ +Part of link:index.html[Gerrit Code Review] + +SEARCHBOX +---------
diff --git a/Documentation/user-request-tracing.txt b/Documentation/user-request-tracing.txt index e684b85..303242df 100644 --- a/Documentation/user-request-tracing.txt +++ b/Documentation/user-request-tracing.txt
@@ -148,3 +148,10 @@ * permission checks (e.g. which rule is responsible for a deny) * timer metrics * all other logs + +GERRIT +------ +Part of link:index.html[Gerrit Code Review] + +SEARCHBOX +---------
diff --git a/Documentation/user-review-ui.txt b/Documentation/user-review-ui.txt index b33bea8..6f5f7297 100644 --- a/Documentation/user-review-ui.txt +++ b/Documentation/user-review-ui.txt
@@ -218,7 +218,7 @@ ** [[plugin-actions]]Further actions may be available if plugins are installed. + -image::images/user-review-ui-change-screen-change-info-actions.png[width=600, link="images/user-review-ui-change-screen-change-info-actions.png"] +image::images/user-review-ui-change-screen-change-info-actions.png[width=400, link="images/user-review-ui-change-screen-change-info-actions.png"] - [[labels]]Labels & Votes: + @@ -251,6 +251,7 @@ The list of commits that are being integrated into the destination branch by submitting the merge commit. + [[patch-sets]] === Patch Sets @@ -258,7 +259,7 @@ set is currently viewed can be seen from the `Patch Sets` drop-down panel in the change header. -image::images/user-review-ui-change-screen-patch-sets.png[width=487, link="images/user-review-ui-change-screen-patch-sets.png"] +image::images/user-review-ui-change-screen-patch-sets.png[width=300, link="images/user-review-ui-change-screen-patch-sets.png"] [[download]] @@ -417,7 +418,7 @@ currently viewed patch set; one can add a summary comment, publish inline draft comments, and vote on the labels. -image::images/gwt-user-review-ui-change-screen-reply.png[width=800, link="images/gwt-user-review-ui-change-screen-reply.png"] +image::images/user-review-ui-change-screen-reply.png[width=800, link="images/user-review-ui-change-screen-reply.png"] Clicking on the `Reply...` button opens a popup panel. @@ -428,11 +429,8 @@ items, and lines starting with "> " as block quotes (also see replying to link:#reply-to-message[messages] and link:#reply-inline-comment[inline comments]). -Note that you can set the text and tooltip of the button in -link:config-gerrit.html#change.replyLabel[gerrit.config]. - [[vote]] -If the current patch set is viewed, radio buttons are displayed for +If the current patch set is viewed, buttons are displayed for each label on which the user is allowed to vote. Voting on non-current patch sets is not possible. @@ -443,8 +441,6 @@ The `Post` button publishes the comments and the votes. -image::images/gwt-user-review-ui-change-screen-replying.png[width=800, link="images/gwt-user-review-ui-change-screen-replying.png"] - [[quick-approve]] If a user can approve a label that is still required, a quick approve button appears in the change header that allows to add this missing @@ -462,7 +458,7 @@ comments; a summary comment is only added if the reply popup panel is open when the quick approve button is clicked. -image::images/user-review-ui-change-screen-quick-approve.png[width=800, link="images/gwt-user-review-ui-change-screen-quick-approve.png"] +image::images/user-review-ui-change-screen-quick-approve.png[width=800, link="images/user-review-ui-change-screen-quick-approve.png"] [[history]] === History @@ -473,32 +469,6 @@ message is added when a new patch set is uploaded or when a review was done. -Messages with new comments from other users, that were published after -the current user last reviewed this change, are automatically expanded. - -image::images/gwt-user-review-ui-change-screen-history.png[width=800, link="images/gwt-user-review-ui-change-screen-history.png"] - -[[reply-to-message]] -It is possible to directly reply to a change message by clicking on the -reply icon in the right upper corner of a change message. This opens -the reply popup panel and prefills the text box with the quoted comment. -Then the reply can be written below the quoted comment or inserted -inline. Lines starting with "> " will be rendered as a block quote. -Please note that for a correct rendering it is important to leave a blank -line between a quoted block and the reply to it. - -image::images/gwt-user-review-ui-change-screen-reply-to-comment.png[width=800, link="images/gwt-user-review-ui-change-screen-reply-to-comment.png"] - -[[inline-comments-in-history]] -Inline comments are directly displayed in the change history and there -are links to navigate to the inline comments. - -image::images/gwt-user-review-ui-change-screen-inline-comments.png[width=800, link="images/gwt-user-review-ui-change-screen-inline-comments.png"] - -[[expand-all]] -The `Expand All` button expands all messages; the `Collapse All` button -collapses all messages. - [[update-notification]] === Update Notification @@ -510,16 +480,16 @@ it is 30 seconds. Polling may also be completely disabled by the administrator. -image::images/gwt-user-review-ui-change-screen-change-update.png[width=800, link="images/gwt-user-review-ui-change-screen-change-update.png"] +image::images/user-review-ui-change-screen-change-update.png[width=400, link="images/user-review-ui-change-screen-change-update.png"] [[plugin-extensions]] === Plugin Extensions -Gerrit plugins may extend the change screen; they can add buttons for -additional actions to the change info block and display arbitrary UI -controls below the change info block. +Gerrit plugins may extend the change screen. Java plugins in the +backend can add additional actions to the triple-dot menu block. +Frontend plugins can change the UI controls in arbitrary ways. -image::images/gwt-user-review-ui-change-screen-plugin-extensions.png[width=800, link="images/gwt-user-review-ui-change-screen-plugin-extensions.png"] +image::images/user-review-ui-change-screen-plugin-extensions.png[width=300, link="images/user-review-ui-change-screen-plugin-extensions.png"] [[side-by-side]] == Side-by-Side Diff Screen @@ -530,17 +500,8 @@ This screen allows to review a patch and to comment on it. -image::images/gwt-user-review-ui-side-by-side-diff-screen.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen.png"] +image::images/user-review-ui-side-by-side-diff-screen.png[width=800, link="images/user-review-ui-side-by-side-diff-screen.png"] -[[side-by-side-header]] -In the screen header the project name and the name of the viewed patch -file are shown. - -If a Git web browser is configured on the server, the project name and -the file path are displayed as links to the project and the folder in -the Git web browser. - -image::images/gwt-user-review-ui-side-by-side-diff-screen-project-and-file.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-project-and-file.png"] [[side-by-side-mark-reviewed]] The checkbox in front of the file name allows the @@ -548,7 +509,7 @@ diff preference allows to control whether the files should be automatically marked as reviewed when they are viewed. -image::images/user-review-ui-side-by-side-diff-screen-reviewed.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-reviewed.png"] +image::images/user-review-ui-side-by-side-diff-screen-reviewed.png[width=800, link="images/user-review-ui-side-by-side-diff-screen-reviewed.png"] [[patch-set-selection]] In the header, on each side, the list of patch sets is shown. Clicking @@ -568,34 +529,20 @@ version before, may see what has changed since that version by comparing the old patch against the current patch. -image::images/gwt-user-review-ui-side-by-side-diff-screen-patch-sets.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-patch-sets.png"] +image::images/user-review-ui-side-by-side-diff-screen-patch-sets.png[width=400, link="images/user-review-ui-side-by-side-diff-screen-patch-sets.png"] [[download-file]] The download icon next to the patch set list allows to download the patch. Unless the mime type of the file is configured as safe, the download file is a zip archive that contains the patch file. -[[no-differences]] -If the compared patches are identical, this is highlighted by a red -`No Differences` label in the screen header. - -image::images/gwt-user-review-ui-side-by-side-diff-screen-no-differences.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-no-differences.png"] [[side-by-side-rename]] If a file was renamed, the old and new file paths are shown in the header together with a similarity index that shows how much of the file content is unmodified. -image::images/gwt-user-review-ui-side-by-side-diff-screen-rename.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-rename.png"] - -[[navigation]] -For navigating between the patches in a patch set there are navigation -buttons on the right side of the screen header. The left arrow button -navigates to the previous patch; the right arrow button navigates to -the next patch. The arrow up button leads back to the change screen. In -all cases the selection for the patch set comparison is kept. - -image::images/gwt-user-review-ui-side-by-side-diff-screen-navigation.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-navigation.png"] +image::images/user-review-ui-side-by-side-diff-screen-rename.png[width=400, link="images/user-review-ui-side-by-side-diff-screen-rename.png"] [[inline-comments]] === Inline Comments @@ -611,26 +558,9 @@ attach several comments to the same code. [[line-links]] -The lines of the patch file are linkable. To link to a certain line in -the patch file, '@<line-number>' must be appended to the patch link, -e.g. `http://host:8080/#/c/56857/2/Documentation/user-review-ui.txt@665`. -To link to a line in the old file version, '@a<line-number>' must be -appended to the patch link. These links can be used to directly link to -certain inline comments. - -If the diff preference link:#expand-all-comments[Expand All Comments] -is set to `Expand`, all inline comments will be automatically expanded. - -image::images/gwt-user-review-ui-side-by-side-diff-screen-inline-comments.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-inline-comments.png"] - -[[comment]] -In the header of the comment box, the name of the comment author and -the timestamp of the comment are shown. If avatars are configured on -the server, the avatar image of the comment author is displayed in the -top left corner. Below the actual comment there are buttons to reply to -the comment. - -image::images/gwt-user-review-ui-side-by-side-diff-screen-comment-box.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-comment-box.png"] +The lines of the patch file are linkable: simply append +'#<linenumber>' to the URL, or click on the line-number. This not only +opens a draft comment box, but also sets the URL fragment. [[reply-inline-comment]] Clicking on the `Reply` button opens an editor to type the reply. @@ -640,38 +570,25 @@ note that for a correct rendering it is important to leave a blank line between a quoted block and the reply to it. -Clicking on the `Save` button saves the comment as a draft. To make it -visible to other users it must be published from the change screen by -link:#reply[replying] to the change. +image::images/user-review-ui-side-by-side-diff-screen-inline-comments.png[width=800, link="images/user-review-ui-side-by-side-diff-screen-inline-comments.png"] -The `Cancel` button cancels the editing and discards any changes to the -draft comment. - -Clicking on the `Discard` button deletes the inline draft comment. - -image::images/gwt-user-review-ui-side-by-side-diff-screen-comment-reply.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-comment-reply.png"] - -[[draft-inline-comment]] -Draft comments are marked by the text "Draft" in the header in the -place of the comment author. - -A draft comment can be edited by clicking on the `Edit` button, or -deleted by clicking on the `Discard` button. - -image::images/gwt-user-review-ui-side-by-side-diff-screen-comment-edit.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-comment-edit.png"] +Comments are first saved as drafts, and you can revisit the drafts as +you read through code review. Finally, they should be published by +clicking the "Reply". [[done]] -Clicking on the `Done` button is a quick way to reply with "Done" to a -comment. This is used to mark a comment as addressed by a follow-up -patch set. +Comments can be unresolved (something should be changed) or resolved +(informational). If you have addressed an unresolved comment in a next +patchset, you can quickly resolve the comment by clicking "Done" (if it was +resolved in a next patchset) or "Ack" (if you acknowledge the comment, +but don't want to make changes). -image::images/gwt-user-review-ui-side-by-side-diff-screen-replied-done.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-replied-done.png"] +image::images/user-review-ui-side-by-side-diff-screen-replied-done.png[width=400, link="images/user-review-ui-side-by-side-diff-screen-replied-done.png"] [[add-inline-comment]] To add a new inline comment there are several possibilities: - select a code block and press 'c' -- select a code block and click on the popup comment icon - go to a line, by clicking on it or by link:#key-navigation[key navigation], and press 'c' - click on a line number @@ -686,23 +603,12 @@ ** triple-click on a line to select it ** triple-click and drag with the mouse to select a code block line-wise -- by keys (the same keys that are used for visual selection in Vim): -** press 'v' + arrow keys (or 'h', 'j', 'k', 'l') to select a block -** press 'V' + arrow keys (or 'j', 'k') to select a code block line-wise -** type 'bvw' to select a word - -image::images/gwt-user-review-ui-side-by-side-diff-screen-comment.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-comment.png"] - For typing the new comment, a new comment box is shown under the code that is commented. -Clicking on the `Save` button saves the new comment as a draft. To make -it visible to other users it must be published from the change screen -by link:#reply[replying] to the change. - -Clicking on the `Discard` button deletes the new comment. - -image::images/gwt-user-review-ui-side-by-side-diff-screen-commented.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-commented.png"] +Clicking on the `Save` button saves the new comment as a draft. To +make it visible to other users it must be published from the change +screen by link:#reply[replying] to the change. [[file-level-comments]] === File Level Comments @@ -710,7 +616,7 @@ File level comments are added by clicking the 'File' header at the top of the file. -image::images/user-review-ui-side-by-side-diff-screen-file-level-comment.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-file-level-comment.png"] +image::images/user-review-ui-side-by-side-diff-screen-file-level-comment.png[width=400, link="images/user-review-ui-side-by-side-diff-screen-file-level-comment.png"] [[diff-preferences]] === Diff Preferences @@ -720,7 +626,7 @@ preferences. The diff preferences can be accessed by clicking on the settings icon in the screen header. -image::images/user-review-ui-side-by-side-diff-screen-preferences.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-preferences.png"] +image::images/user-review-ui-side-by-side-diff-screen-preferences.png[width=800, link="images/user-review-ui-side-by-side-diff-screen-preferences.png"] The following diff preferences can be configured: @@ -767,7 +673,7 @@ If many lines are skipped there are additional links to expand the context by ten lines before and after the skipped block. + -image::images/user-review-ui-side-by-side-diff-screen-expand-skipped-lines.png[width=800, link="images/gwt-user-review-ui-side-by-side-diff-screen-expand-skipped-lines.png"] +image::images/user-review-ui-side-by-side-diff-screen-expand-skipped-lines.png[width=800, link="images/user-review-ui-side-by-side-diff-screen-expand-skipped-lines.png"] - [[syntax-highlighting]]`Syntax Highlighting`: + @@ -797,7 +703,7 @@ a popup that shows a list of available keyboard shortcuts. -image::images/user-review-ui-change-screen-keyboard-shortcuts.png[width=800, link="images/gwt-user-review-ui-change-screen-keyboard-shortcuts.png"] +image::images/user-review-ui-change-screen-keyboard-shortcuts.png[width=800, link="images/user-review-ui-change-screen-keyboard-shortcuts.png"] In addition, Vim-like commands can be used to link:#key-navigation[
diff --git a/Documentation/user-search.txt b/Documentation/user-search.txt index 8055f5f..ccc83eb 100644 --- a/Documentation/user-search.txt +++ b/Documentation/user-search.txt
@@ -28,13 +28,13 @@ [options="header"] |============================================================= |Description | Examples -|Legacy numerical id | 15183 +|Change Id | 15183 |Full or abbreviated Change-Id | Ic0ff33 |Full or abbreviated commit SHA-1 | d81b32ef |Email address | user@example.com |============================================================= -For change searches (i.e. those using a numerical id, Change-Id, or commit +For change searches (i.e. those using a change number, Change-Id, or commit SHA-1), if the search results in a single change that change will be presented instead of a list. @@ -107,15 +107,13 @@ [[change]] change:'ID':: + -Either a legacy numerical 'ID' such as 15183, or a newer style -Change-Id that was scraped out of the commit message. +Either a change number such as 15183, or a Change-Id from the Change-Id footer. [[conflicts]] conflicts:'ID':: + Changes that conflict with change 'ID'. Change 'ID' can be specified -as a legacy numerical 'ID' such as 15183, or a newer style Change-Id -that was scraped out of the commit message. +as a change number such as 15183, or a Change-Id from the Change-Id footer. [[destination]] destination:'[name=]NAME[,user=USER]':: @@ -136,6 +134,19 @@ + Changes originally submitted by a user in 'GROUP'. +[[uploader]] +uploader:'USER':: ++ +Changes where the latest patch set was uploaded by 'USER'. +The special case of `uploader:self` will find changes uploaded +by the caller. + +[[uploaderin]] +uploaderin:'GROUP':: ++ +Changes where the latest patch set was uploaded by a user in +'GROUP'. + [[query]] query:'[name=]NAME[,user=USER]':: + @@ -160,7 +171,7 @@ [[revertof]] revertof:'ID':: + -Changes that revert the change specified by the numeric 'ID'. +Changes that revert the change specified by the change number. [[submissionid]] submissionid:'ID':: @@ -193,8 +204,8 @@ [[parentof]] parentof:'ID':: Changes which are parent to the change specified by 'ID'. Change 'ID' can be -specified as a legacy numerical 'ID' such as 15183, or a Change-Id that can be -picked from the commit message. This operator will return immediate parents +specified as a change number such as 15183, or a Change-Id from the 'Change-Id' +footer of the commit message. This operator will return immediate parents and will not return grand parents or higher level ancestors of the given change. [[parentproject]] @@ -251,6 +262,16 @@ often combined with 'branch:' and 'project:' operators to select all related changes in a series. +[[inhashtag]] +inhashtag:'HASHTAG':: ++ +Changes where any hashtag contains 'HASHTAG', using a full-text search. ++ +If 'HASHTAG' starts with `^` it matches hashtag names by regular +expression patterns. The +link:http://www.brics.dk/automaton/[dk.brics.automaton +library,role=external,window=_blank] is used for evaluation of such patterns. + [[hashtag]] hashtag:'HASHTAG':: + @@ -311,7 +332,7 @@ + Matches any change touching file at 'PATH'. By default exact path matching is used, but regular expressions can be enabled by starting -with `^`. For example, to match all XML files use `file:^.*\.xml$`. +with `^`. For example, to match all XML files use `file:"^.*\.xml$"`. The link:http://www.brics.dk/automaton/[dk.brics.automaton library,role=external,window=_blank] is used for the evaluation of such patterns. + @@ -321,8 +342,7 @@ files, use `file:^.*\.java`. + The entire regular expression pattern, including the `^` character, -should be double quoted when using more complex construction (like -ones using a bracket expression). For example, to match all XML +should be double quoted. For example, to match all XML files named like 'name1.xml', 'name2.xml', and 'name3.xml' use `file:"^name[1-3].xml"`. + @@ -397,6 +417,8 @@ + 'star:star' is the same as 'has:star' and 'is:starred'. +Only "ignore" and "star" are supported labels. + [[has]] has:draft:: + @@ -408,11 +430,6 @@ Same as 'is:starred' and 'star:star', true if the change has been starred by the current user with the default label. -[[has-stars]] -has:stars:: -+ -True if the change has been starred by the current user with any label. - has:edit:: + True if the change has inline edit created by the current user. @@ -421,6 +438,11 @@ + True if the change has unresolved comments. +has:attention:: ++ +True if the change has attention by the current user. + + [[is]] is:assigned:: + @@ -436,6 +458,10 @@ + True if the change does not have an assignee. +is:attention:: ++ +True if the change has attention by the current user. + is:watched:: + True if this change matches one of the current user's watch filters, @@ -451,6 +477,12 @@ True on any change where the current user is the change owner. Same as `owner:self`. +is:uploader:: ++ +True on any change where the current user is the uploader of +the latest patch set. +Same as `uploader:self`. + is:reviewer:: + True on any change where the current user is a reviewer. @@ -521,6 +553,16 @@ + True if the change is a merge commit. +[[cherrypick]] +is:cherrypick:: ++ +True if the change is a cherrypick of an another change. + +This is limited to changes which are cherrypicked using REST API +or WebUI only. It is not able to identify changes which are +cherry-picked locally using the git cherry-pick command and then +pushed to Gerrit. + [[status]] status:open, status:pending, status:new:: + @@ -600,6 +642,22 @@ only applies to the top-level status; individual label statuses can be searched link:#labels[by label]. +[[rule]] +rule:'SUBMIT_RULE_NAME':: ++ +Changes where 'SUBMIT_RULE_NAME' returns a submit record with status in {OK, +FORCED}. This means that the submit rule has passed and is not blocking the +change submission. 'SUBMIT_RULE_NAME' should be in the form of +'$plugin_name~$rule_name'. For gerrit core rules, 'SUBMIT_RULE_NAME' should +be in the form of '$rule_name' (example: `DefaultSubmitRule`), or +'gerrit~$rule_name' (example: `gerrit~DefaultSubmitRule`). + +rule:'SUBMIT_RULE_NAME'='STATUS':: ++ +Changes where 'SUBMIT_RULE_NAME' returns a submit record with status equals to +'STATUS'. The status can be any of the statuses that are documented for the +`status` field of link:rest-api-changes.html#submit-record[SubmitRecord]. + [[unresolved]] unresolved:'RELATION''NUMBER':: + @@ -696,6 +754,22 @@ to one of the fields in the link:rest-api-changes.html#submit-record[SubmitRecord] REST API entity. +`label:Code-Review\<=-1`:: ++ +Matches changes with either a -1, -2, or any lower score. + +`label:Code-Review=MAX`:: ++ +Matches changes with label voted with the highest possible score. + +`label:Code-Review=MIN`:: ++ +Matches changes with label voted with the lowest possible score. + +`label:Code-Review=ANY`:: ++ +Matches changes with label voted with any score. + `label:Non-Author-Code-Review=need`:: + Matches changes where the submit rules indicate that a label named @@ -720,15 +794,20 @@ The special "owner" parameter corresponds to the change owner. Matches all changes that have a +2 vote from the change owner. +`label:Code-Review=+2,user=non_uploader`:: +`label:Code-Review=ok,user=non_uploader`:: +`label:Code-Review=+2,non_uploader`:: +`label:Code-Review=ok,non_uploader`:: ++ +The special "non_uploader" parameter corresponds to any user who's not the +uploader of the latest patchset. Matches all changes that have a +2 vote from +a non upoader. + `label:Code-Review=+1,group=ldap/linux.workflow`:: + Matches changes with a +1 code review where the reviewer is in the ldap/linux.workflow group. -`label:Code-Review\<=-1`:: -+ -Matches changes with either a -1, -2, or any lower score. - `is:open label:Code-Review+2 label:Verified+1 NOT label:Verified-1 NOT label:Code-Review-2`:: `is:open label:Code-Review=ok label:Verified=ok`:: + @@ -767,24 +846,6 @@ Magical internal flag to prove the current user has access to read the change. This flag is always added to any query. -starredby:'USER':: -+ -Matches changes that have been starred by 'USER' with the default label. -The special case `starredby:self` applies to the caller. - -watchedby:'USER':: -+ -Matches changes that 'USER' has configured watch filters for. -The special case `watchedby:self` applies to the caller. - -draftby:'USER':: -+ -Matches changes that 'USER' has left unpublished draft comments on. -Since the drafts are unpublished, it is not possible to see the -draft text, or even how many drafts there are. The special case -of `draftby:self` will find changes where the caller has created -a draft comment. - [[limit]] limit:'CNT':: +
diff --git a/Documentation/user-upload.txt b/Documentation/user-upload.txt index 0670968..2bfc62d 100644 --- a/Documentation/user-upload.txt +++ b/Documentation/user-upload.txt
@@ -460,6 +460,23 @@ Given the trace ID an administrator can find the corresponding logs and investigate issues more easily. +[[deadline]] +==== Setting a deadline + +When pushing to Gerrit it's possible that the client sets a deadline after which +the push should be aborted. To do this the `deadline=<deadline>` push option +must be set on the git push. Values must be specified using standard time unit +abbreviations ('ms', 'sec', 'min', etc.). + +---- + git push -o deadline=10m ssh://john.doe@git.example.com:29418/kernel/common HEAD:refs/for/master +---- + +Setting a deadline for the push overrides any +link:config-gerrit.html#deadline.id[server-side deadline] that has been +configured on the host, but not the link:config.html#receive.timeout[receive +timeout]. + [[push_replace]] === Replace Changes @@ -622,6 +639,20 @@ point, which could be slow and create lots of unintended new changes. To create multiple new changes, run push multiple times. +[[ignore-attention-set]] +=== Ignore automatic attention set rules + +Normally, we add users to the attention set based on several rules such as adding +reviewers, replying, and many others. The full rule list is in +link:user-attention-set.html[Attention Set]. + +--ignore-automatic-attention-set-rules (also known as -ias and +-ignore-attention-set) can be used to keep the attention set as it were before +the push. + +---- + git push ssh://john.doe@git.example.com:29418/kernel/common my-merged-commit:refs/for/master%ias +---- == repo upload
diff --git a/WORKSPACE b/WORKSPACE index a75ea45..13dcddb 100644 --- a/WORKSPACE +++ b/WORKSPACE
@@ -30,7 +30,7 @@ load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive", "http_file") load("//tools/bzl:maven_jar.bzl", "GERRIT", "MAVEN_LOCAL", "maven_jar") load("//plugins:external_plugin_deps.bzl", "external_plugin_deps") -load("//tools:nongoogle.bzl", "TESTCONTAINERS_VERSION", "declare_nongoogle_deps") +load("//tools:nongoogle.bzl", "declare_nongoogle_deps") http_archive( name = "platforms", @@ -100,6 +100,19 @@ firefox = True, ) +http_archive( + name = "rules_pkg", + sha256 = "038f1caa773a7e35b3663865ffb003169c6a71dc995e39bf4815792f385d837d", + urls = [ + "https://mirror.bazel.build/github.com/bazelbuild/rules_pkg/releases/download/0.4.0/rules_pkg-0.4.0.tar.gz", + "https://github.com/bazelbuild/rules_pkg/releases/download/0.4.0/rules_pkg-0.4.0.tar.gz", + ], +) + +load("@rules_pkg//:deps.bzl", "rules_pkg_dependencies") + +rules_pkg_dependencies() + # Golang support for PolyGerrit local dev server. http_archive( name = "io_bazel_rules_go", @@ -136,6 +149,10 @@ importpath = "github.com/howeyc/fsnotify", ) +register_toolchains("//tools:error_prone_warnings_toolchain_java11_definition") + +register_toolchains("//tools:error_prone_warnings_toolchain_java17_definition") + # JGit external repository consumed from git submodule local_repository( name = "jgit", @@ -279,8 +296,8 @@ # When upgrading commons-compress, also upgrade tukaani-xz maven_jar( name = "commons-compress", - artifact = "org.apache.commons:commons-compress:1.18", - sha1 = "1191f9f2bc0c47a8cce69193feb1ff0a8bcb37d5", + artifact = "org.apache.commons:commons-compress:1.22", + sha1 = "691a8b4e6cf4248c3bc72c8b719337d5cb7359fa", ) maven_jar( @@ -601,24 +618,24 @@ sha1 = "eff48ed53995db2dadf0456426cc1f8700136f86", ) -AUTO_VALUE_GSON_VERSION = "1.3.0" +AUTO_VALUE_GSON_VERSION = "1.3.1" maven_jar( name = "auto-value-gson-runtime", artifact = "com.ryanharter.auto.value:auto-value-gson-runtime:" + AUTO_VALUE_GSON_VERSION, - sha1 = "a69a9db5868bb039bd80f60661a771b643eaba59", + sha1 = "addda2ae6cce9f855788274df5de55dde4de7b71", ) maven_jar( name = "auto-value-gson-extension", artifact = "com.ryanharter.auto.value:auto-value-gson-extension:" + AUTO_VALUE_GSON_VERSION, - sha1 = "6a61236d17b58b05e32b4c532bcb348280d2212b", + sha1 = "0c4c01a3e10e5b10df2e5f5697efa4bb3f453ac1", ) maven_jar( name = "auto-value-gson-factory", artifact = "com.ryanharter.auto.value:auto-value-gson-factory:" + AUTO_VALUE_GSON_VERSION, - sha1 = "b1f01918c0d6cb1f5482500e6b9e62589334dbb0", + sha1 = "9ed8d79144ee8d60cc94cc11f847b5ed8ee9f19c", ) maven_jar( @@ -635,38 +652,6 @@ declare_nongoogle_deps() -LUCENE_VERS = "6.6.5" - -maven_jar( - name = "lucene-core", - artifact = "org.apache.lucene:lucene-core:" + LUCENE_VERS, - sha1 = "2983f80b1037e098209657b0ca9176827892d0c0", -) - -maven_jar( - name = "lucene-analyzers-common", - artifact = "org.apache.lucene:lucene-analyzers-common:" + LUCENE_VERS, - sha1 = "6094f91071d90570b7f5f8ce481d5de7d2d2e9d5", -) - -maven_jar( - name = "backward-codecs", - artifact = "org.apache.lucene:lucene-backward-codecs:" + LUCENE_VERS, - sha1 = "460a19e8d1aa7d31e9614cf528a6cb508c9e823d", -) - -maven_jar( - name = "lucene-misc", - artifact = "org.apache.lucene:lucene-misc:" + LUCENE_VERS, - sha1 = "ce3a1b7b6a92b9af30791356a4bd46d1cea6cc1e", -) - -maven_jar( - name = "lucene-queryparser", - artifact = "org.apache.lucene:lucene-queryparser:" + LUCENE_VERS, - sha1 = "2db9ca0086a4b8e0b9bc9f08a9b420303168e37c", -) - maven_jar( name = "mime-util", artifact = "eu.medsea.mimeutil:mime-util:2.1.3", @@ -722,7 +707,7 @@ sha1 = "f7be08ec23c21485b9b5a1cf1654c2ec8c58168d", ) -GITILES_VERS = "0.4" +GITILES_VERS = "0.4-1" GITILES_REPO = GERRIT @@ -731,14 +716,14 @@ artifact = "com.google.gitiles:blame-cache:" + GITILES_VERS, attach_source = False, repository = GITILES_REPO, - sha1 = "567198123898aa86bd854d3fcb044dc7a1845741", + sha1 = "0df80c6b8822147e1f116fd7804b8a0de544f402", ) maven_jar( name = "gitiles-servlet", artifact = "com.google.gitiles:gitiles-servlet:" + GITILES_VERS, repository = GITILES_REPO, - sha1 = "0dd832a6df108af0c75ae29b752fda64ccbd6886", + sha1 = "60870897d22b840e65623fd024eabd9cc9706ebe", ) # prettify must match the version used in Gitiles @@ -761,24 +746,30 @@ ) # When updating Bouncy Castle, also update it in bazlets. -BC_VERS = "1.61" +BC_VERS = "1.72" maven_jar( name = "bcprov", - artifact = "org.bouncycastle:bcprov-jdk15on:" + BC_VERS, - sha1 = "00df4b474e71be02c1349c3292d98886f888d1f7", + artifact = "org.bouncycastle:bcprov-jdk18on:" + BC_VERS, + sha1 = "d8dc62c28a3497d29c93fee3e71c00b27dff41b4", ) maven_jar( name = "bcpg", - artifact = "org.bouncycastle:bcpg-jdk15on:" + BC_VERS, - sha1 = "422656435514ab8a28752b117d5d2646660a0ace", + artifact = "org.bouncycastle:bcpg-jdk18on:" + BC_VERS, + sha1 = "1a36a1740d07869161f6f0d01fae8d72dd1d8320", ) maven_jar( name = "bcpkix", - artifact = "org.bouncycastle:bcpkix-jdk15on:" + BC_VERS, - sha1 = "89bb3aa5b98b48e584eee2a7401b7682a46779b4", + artifact = "org.bouncycastle:bcpkix-jdk18on:" + BC_VERS, + sha1 = "bb3fdb5162ccd5085e8d7e57fada4d8eaa571f5a", +) + +maven_jar( + name = "bcutil", + artifact = "org.bouncycastle:bcutil-jdk18on:" + BC_VERS, + sha1 = "41f19a69ada3b06fa48781120d8bebe1ba955c77", ) maven_jar( @@ -787,12 +778,6 @@ sha1 = "fd369423346b2f1525c413e33f8cf95b09c92cbd", ) -# Base the following org.apache.httpcomponents versions on what -# elasticsearch-rest-client explicitly depends on, except for -# commons-codec (non-http) which is not necessary yet. Note that -# below httpcore version(s) differs from the HTTPCOMP_VERS range, -# upstream: that specific dependency has no HTTPCOMP_VERS version -# equivalent currently. HTTPCOMP_VERS = "4.5.2" maven_jar( @@ -891,12 +876,6 @@ ) maven_jar( - name = "javax-annotation", - artifact = "javax.annotation:javax.annotation-api:1.3.2", - sha1 = "934c04d3cfef185a8008e7bf34331b79730a9d43", -) - -maven_jar( name = "mockito", artifact = "org.mockito:mockito-core:3.3.3", sha1 = "4878395d4e63173f3825e17e5e0690e8054445f1", @@ -934,16 +913,28 @@ exports_directories_only = False, frozen_lockfile = False, package_json = "//:package.json", + package_path = "", symlink_node_modules = True, yarn_lock = "//:yarn.lock", ) yarn_install( name = "ui_npm", - args = ["--prod"], + args = [ + "--prod", + # By default, yarn install all optional dependencies. + # In some cases, it installs a lot of additional dependencies which + # are not required (for example, "resemblejs" has one optional + # dependencies "canvas" that leads to tens of additional dependencies). + # Each additional dependency requires a license even if it is not used + # in our code. We want to ensure that all optional dependencies are + # explicitly added to package.json. + "--ignore-optional", + ], exports_directories_only = False, frozen_lockfile = False, package_json = "//:polygerrit-ui/app/package.json", + package_path = "polygerrit-ui/app", symlink_node_modules = True, yarn_lock = "//:polygerrit-ui/app/yarn.lock", ) @@ -953,6 +944,7 @@ exports_directories_only = False, frozen_lockfile = False, package_json = "//:polygerrit-ui/package.json", + package_path = "polygerrit-ui", symlink_node_modules = True, yarn_lock = "//:polygerrit-ui/yarn.lock", ) @@ -962,6 +954,7 @@ exports_directories_only = False, frozen_lockfile = False, package_json = "//:tools/node_tools/package.json", + package_path = "tools/node_tools", symlink_node_modules = True, yarn_lock = "//:tools/node_tools/yarn.lock", ) @@ -972,215 +965,9 @@ exports_directories_only = False, frozen_lockfile = False, package_json = "//:plugins/package.json", + package_path = "plugins", symlink_node_modules = True, yarn_lock = "//:plugins/yarn.lock", ) -load("//tools/bzl:js.bzl", "bower_archive", "npm_binary") - -# NPM binaries bundled along with their dependencies. -# -# For full instructions on adding new binaries to the build, see -# http://gerrit-review.googlesource.com/Documentation/dev-bazel.html#npm-binary -npm_binary( - name = "bower", -) - -npm_binary( - name = "polymer-bundler", - repository = GERRIT, -) - -npm_binary( - name = "crisper", - repository = GERRIT, -) - -# bower_archive() seed components. -bower_archive( - name = "iron-autogrow-textarea", - package = "polymerelements/iron-autogrow-textarea", - sha1 = "2f04c7e2a72d462de36093ab2b4889db20f699f6", - version = "2.2.0", -) - -bower_archive( - name = "es6-promise", - package = "stefanpenner/es6-promise", - sha1 = "a3a797bb22132f1ef75f9a2556173f81870c2e53", - version = "3.3.0", -) - -bower_archive( - name = "fetch", - package = "fetch", - sha1 = "1b05a2bb40c73232c2909dc196de7519fe4db7a9", - version = "1.0.0", -) - -bower_archive( - name = "iron-dropdown", - package = "polymerelements/iron-dropdown", - sha1 = "3902ba164552b1bfc59e6fa692efa4a1fd8dd4ea", - version = "2.2.1", -) - -bower_archive( - name = "iron-input", - package = "polymerelements/iron-input", - sha1 = "f79952ff4f6f103c0a2cbd3dacf25935257ff392", - version = "2.1.3", -) - -bower_archive( - name = "iron-overlay-behavior", - package = "polymerelements/iron-overlay-behavior", - sha1 = "c2d2eac1b162420d9475ade2f16d5db8959b93fc", - version = "2.3.4", -) - -bower_archive( - name = "iron-selector", - package = "polymerelements/iron-selector", - sha1 = "3f3fcb55f6bd606ea493f99eab9daae21f7a6139", - version = "2.1.0", -) - -bower_archive( - name = "paper-button", - package = "polymerelements/paper-button", - sha1 = "bcb783d74e1177c1d0836340e7c0280699d1438c", - version = "2.1.3", -) - -bower_archive( - name = "paper-input", - package = "polymerelements/paper-input", - sha1 = "c1a81a4173d22e72e8ab609eb3715a75273396b3", - version = "2.2.3", -) - -bower_archive( - name = "paper-tabs", - package = "polymerelements/paper-tabs", - sha1 = "589b8e6efa0f171c93233137c8ea013dcea0ffc7", - version = "2.1.1", -) - -bower_archive( - name = "iron-icon", - package = "polymerelements/iron-icon", - sha1 = "d21e7d4f1bdc6de881390f888e28d53155eeb551", - version = "2.1.0", -) - -bower_archive( - name = "iron-iconset-svg", - package = "polymerelements/iron-iconset-svg", - sha1 = "07c0ce02ce6479856758893416a3709009db7f22", - version = "2.2.1", -) - -bower_archive( - name = "moment", - package = "moment/moment", - sha1 = "fc8ce2c799bab21f6ced7aff928244f4ca8880aa", - version = "2.13.0", -) - -bower_archive( - name = "page", - package = "visionmedia/page.js", - sha1 = "4a31889cd75cc5e7f68a4c7f256eecaf27102eee", - version = "1.11.4", -) - -bower_archive( - name = "paper-item", - package = "polymerelements/paper-item", - sha1 = "c3bad022cf182d2bf1c8a44374c7fcb1409afbfa", - version = "2.1.1", -) - -bower_archive( - name = "paper-listbox", - package = "polymerelements/paper-listbox", - sha1 = "78247cc32bb776f204efef17cff3095878036a40", - version = "2.1.1", -) - -bower_archive( - name = "paper-toggle-button", - package = "polymerelements/paper-toggle-button", - sha1 = "9927960afb0062726ec1b585ef3e32764c3bbac9", - version = "2.1.1", -) - -bower_archive( - name = "polymer", - package = "polymer/polymer", - sha1 = "d06e17a1d8dc6187ee5aa8c5b3501da10901c82f", - version = "2.7.2", -) - -bower_archive( - name = "polymer-resin", - package = "polymer/polymer-resin", - sha1 = "94c29926c20ea3a9b636f26b3e0d689ead8137e5", - version = "2.0.1", -) - -bower_archive( - name = "resemblejs", - package = "rsmbl/Resemble.js", - sha1 = "49d5f022417c389b630d6f7ee667aa9540075c42", - version = "2.10.1", -) - -bower_archive( - name = "codemirror-minified", - package = "Dominator008/codemirror-minified", - sha1 = "904bae2a8716087fd21e92324e8a136a0c4a99b7", - version = "5.62.2", -) - -# bower test stuff - -bower_archive( - name = "iron-test-helpers", - package = "polymerelements/iron-test-helpers", - sha1 = "882be2d4c8714b39299b5f7bf25253c4e8a40761", - version = "2.0.1", -) - -bower_archive( - name = "test-fixture", - package = "polymerelements/test-fixture", - sha1 = "7d72ddfebf555a2dd1fc60a85427d9026b509723", - version = "3.0.0", -) - -bower_archive( - name = "web-component-tester", - package = "polymer/web-component-tester", - sha1 = "d84f6a13bde5f8fd39ee208d43f33925410530d7", - version = "6.5.1", -) - external_plugin_deps() - -# When upgrading elasticsearch-rest-client, also upgrade httpcore-nio -# and httpasyncclient as necessary in tools/nongoogle.bzl. Consider -# also the other org.apache.httpcomponents dependencies in -# WORKSPACE. -maven_jar( - name = "elasticsearch-rest-client", - artifact = "org.elasticsearch.client:elasticsearch-rest-client:7.8.1", - sha1 = "59feefe006a96a39f83b0dfb6780847e06c1d0a8", -) - -maven_jar( - name = "testcontainers-elasticsearch", - artifact = "org.testcontainers:elasticsearch:" + TESTCONTAINERS_VERSION, - sha1 = "6b778a270b7529fcb9b7a6f62f3ae9d38544ce2f", -)
diff --git a/contrib/find-duplicate-usernames.sh b/contrib/find-duplicate-usernames.sh index b59e5be..7a5750f 100755 --- a/contrib/find-duplicate-usernames.sh +++ b/contrib/find-duplicate-usernames.sh
@@ -29,6 +29,18 @@ usage fi +if [ -z "$(git ls-remote . refs/meta/external-ids)" ]; then + cat <<EOF +Could not find 'refs/meta/external-ids' in the local repository. + +Please fetch it using: + + git fetch "$(git remote)" refs/meta/external-ids:refs/meta/external-ids + +EOF + exit 1 +fi + # 1. find lines with user name and subsequent line in external-ids notes branch # example output of git grep -A1 "\[externalId \"username:" refs/meta/external-ids: # refs/meta/external-ids:00/1d/abd037e437f71d42134e6ad532a06948a2ba:[externalId "username:johndoe"] @@ -45,12 +57,12 @@ # 7. flip columns # 8. uniq case-insensitive, only show duplicates, avoid comparing first field # 9. flip columns back -git grep -A1 "\[externalId \"$1:" refs/meta/external-ids \ +git grep -A1 "\[externalId \"$1:" refs/meta/external-ids -- \ | sed -E "/$1/,/accountId/!d" \ | paste -d ' ' - - \ | tr \"= : \ | cut -d: --output-delimiter="" -f 5,8 \ | sort -f \ - | sed -E "s/(.*) (.*)/\2 \1/" \ + | sed -E "s/(.*) ([0-9]+)/\2 \1/" \ | uniq -Di -f1 \ - | sed -E "s/(.*) (.*)/\2 \1/" + | sed -E "s/([0-9]+) (.*)/\2 \1/"
diff --git a/contrib/ui-api-proxy.go b/contrib/ui-api-proxy.go deleted file mode 100644 index 1ae1c1a..0000000 --- a/contrib/ui-api-proxy.go +++ /dev/null
@@ -1,65 +0,0 @@ -// ui-api-proxy is a reverse http proxy that allows the UI to be served from -// a different host than the API. This allows testing new UI features served -// from localhost but using live production data. -// -// Run the binary, download & install the Go tools available at -// http://golang.org/doc/install . To run, execute `go run ui-api-proxy.go`. -// For a description of the available flags, execute -// `go run ui-api-proxy.go --help`. -package main - -import ( - "flag" - "fmt" - "log" - "net" - "net/http" - "net/http/httputil" - "net/url" - "strings" - "time" -) - -var ( - ui = flag.String("ui", "http://localhost:8080", "host to which ui requests will be forwarded") - api = flag.String("api", "https://gerrit-review.googlesource.com", "host to which api requests will be forwarded") - port = flag.Int("port", 0, "port on which to run this server") -) - -func main() { - flag.Parse() - - uiURL, err := url.Parse(*ui) - if err != nil { - log.Fatalf("proxy: parsing ui addr %q failed: %v\n", *ui, err) - } - apiURL, err := url.Parse(*api) - if err != nil { - log.Fatalf("proxy: parsing api addr %q failed: %v\n", *api, err) - } - - l, err := net.Listen("tcp", fmt.Sprintf("127.0.0.1:%v", *port)) - if err != nil { - log.Fatalln("proxy: listen failed: ", err) - } - defer l.Close() - fmt.Printf("OK\nListening on http://%v/\n", l.Addr()) - - err = http.Serve(l, &httputil.ReverseProxy{ - FlushInterval: 500 * time.Millisecond, - Director: func(r *http.Request) { - if strings.HasPrefix(r.URL.Path, "/changes/") || strings.HasPrefix(r.URL.Path, "/projects/") { - r.URL.Scheme, r.URL.Host = apiURL.Scheme, apiURL.Host - } else { - r.URL.Scheme, r.URL.Host = uiURL.Scheme, uiURL.Host - } - if r.URL.Scheme == "" { - r.URL.Scheme = "http" - } - r.Host, r.URL.Opaque, r.URL.RawQuery = r.URL.Host, r.RequestURI, "" - }, - }) - if err != nil { - log.Fatalln("proxy: serve failed: ", err) - } -}
diff --git a/e2e-tests/src/test/resources/hooks/commit-msg b/e2e-tests/src/test/resources/hooks/commit-msg deleted file mode 100644 index b05a671..0000000 --- a/e2e-tests/src/test/resources/hooks/commit-msg +++ /dev/null
@@ -1,43 +0,0 @@ -#!/bin/sh -# -# Part of Gerrit Code Review (https://www.gerritcodereview.com/) -# -# Copyright (C) 2009 The Android Open Source Project -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# avoid [[ which is not POSIX sh. -if test "$#" != 1 ; then - echo "$0 requires an argument." - exit 1 -fi - -if test ! -f "$1" ; then - echo "file does not exist: $1" - exit 1 -fi - -if test ! -s "$1" ; then - echo "file is empty: $1" - exit 1 -fi - -# $RANDOM will be undefined if not using bash, so don't use set -u -random=$( (whoami ; hostname ; date; cat $1 ; echo $RANDOM) | git hash-object --stdin) -dest="$1.tmp.${random}" - -# Avoid the --in-place option which only appeared in Git 2.8 -# Avoid the --if-exists option which only appeared in Git 2.15 -cat "$1" \ -| git -c trailer.ifexists=doNothing interpret-trailers --trailer "Change-Id: I${random}" > "${dest}" \ -&& mv "${dest}" "$1"
diff --git a/e2e-tests/src/test/resources/hooks/commit-msg b/e2e-tests/src/test/resources/hooks/commit-msg new file mode 120000 index 0000000..6066256 --- /dev/null +++ b/e2e-tests/src/test/resources/hooks/commit-msg
@@ -0,0 +1 @@ +../../../../../resources/com/google/gerrit/server/tools/root/hooks/commit-msg \ No newline at end of file
diff --git a/java/com/google/gerrit/acceptance/AbstractDaemonTest.java b/java/com/google/gerrit/acceptance/AbstractDaemonTest.java index 426c806..3934a6a 100644 --- a/java/com/google/gerrit/acceptance/AbstractDaemonTest.java +++ b/java/com/google/gerrit/acceptance/AbstractDaemonTest.java
@@ -15,6 +15,7 @@ package com.google.gerrit.acceptance; import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.collect.ImmutableList.toImmutableList; import static com.google.common.truth.OptionalSubject.optionals; import static com.google.common.truth.Truth.assertThat; import static com.google.common.truth.Truth.assertWithMessage; @@ -58,6 +59,7 @@ import com.google.gerrit.entities.BranchNameKey; import com.google.gerrit.entities.Change; import com.google.gerrit.entities.EmailHeader; +import com.google.gerrit.entities.EmailHeader.StringEmailHeader; import com.google.gerrit.entities.GroupDescription; import com.google.gerrit.entities.GroupReference; import com.google.gerrit.entities.InternalGroup; @@ -70,6 +72,7 @@ import com.google.gerrit.entities.PermissionRule.Action; import com.google.gerrit.entities.Project; import com.google.gerrit.entities.RefNames; +import com.google.gerrit.entities.SubmitRequirement; import com.google.gerrit.extensions.api.GerritApi; import com.google.gerrit.extensions.api.changes.ChangeApi; import com.google.gerrit.extensions.api.changes.ReviewInput; @@ -83,6 +86,7 @@ import com.google.gerrit.extensions.client.ListChangesOption; import com.google.gerrit.extensions.client.ProjectWatchInfo; import com.google.gerrit.extensions.client.SubmitType; +import com.google.gerrit.extensions.common.AccountInfo; import com.google.gerrit.extensions.common.ChangeInfo; import com.google.gerrit.extensions.common.ChangeType; import com.google.gerrit.extensions.common.CommentInfo; @@ -103,6 +107,7 @@ import com.google.gerrit.server.account.Accounts; import com.google.gerrit.server.account.GroupBackend; import com.google.gerrit.server.account.GroupCache; +import com.google.gerrit.server.account.externalids.ExternalId; import com.google.gerrit.server.change.BatchAbandon; import com.google.gerrit.server.change.ChangeFinder; import com.google.gerrit.server.change.ChangeResource; @@ -127,6 +132,8 @@ import com.google.gerrit.server.notedb.AbstractChangeNotes; import com.google.gerrit.server.notedb.ChangeNoteUtil; import com.google.gerrit.server.notedb.ChangeNotes; +import com.google.gerrit.server.notedb.ChangeNotesCommit; +import com.google.gerrit.server.notedb.ChangeNotesCommit.ChangeNotesRevWalk; import com.google.gerrit.server.plugins.PluginGuiceEnvironment; import com.google.gerrit.server.plugins.TestServerPlugin; import com.google.gerrit.server.project.ProjectCache; @@ -168,6 +175,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.Objects; import java.util.Optional; import java.util.regex.Pattern; import java.util.stream.Collectors; @@ -195,7 +203,6 @@ import org.eclipse.jgit.util.FS; import org.eclipse.jgit.util.SystemReader; import org.junit.After; -import org.junit.AfterClass; import org.junit.Before; import org.junit.ClassRule; import org.junit.Rule; @@ -297,6 +304,8 @@ protected TestRepository<InMemoryRepository> testRepo; protected String resourcePrefix; protected Description description; + protected GerritServer.Description testMethodDescription; + protected boolean testRequiresSsh; protected BlockStrategy noSleepBlockStrategy = t -> {}; // Don't sleep in tests. @@ -343,22 +352,29 @@ } @After + public void verifyNoPiiInChangeNotes() throws RestApiException, IOException { + if (testMethodDescription.verifyNoPiiInChangeNotes()) { + verifyNoAccountDetailsInChangeNotes(); + } + } + + @After public void closeEventRecorder() { if (eventRecorder != null) { eventRecorder.close(); } } - @AfterClass + @ConfigSuite.AfterConfig public static void stopCommonServer() throws Exception { if (commonServer != null) { try { commonServer.close(); - } catch (Throwable t) { + } catch (Exception e) { throw new AssertionError( "Error stopping common server in " + (firstTest != null ? firstTest.getTestClass().getName() : "unknown test class"), - t); + e); } finally { commonServer = null; } @@ -430,6 +446,7 @@ GerritServer.Description.forTestClass(description, configName); GerritServer.Description methodDesc = GerritServer.Description.forTestMethod(description, configName); + testMethodDescription = methodDesc; testRequiresSsh = classDesc.useSshAnnotation() || methodDesc.useSshAnnotation(); if (!testRequiresSsh) { @@ -462,7 +479,7 @@ toClose = Collections.synchronizedList(new ArrayList<>()); admin = accountCreator.admin(); - user = accountCreator.user(); + user = accountCreator.user1(); // Evict and reindex accounts in case tests modify them. reindexAccount(admin.id()); @@ -698,6 +715,58 @@ } } + /** + * Verify that NoteDB commits do not persist user-sensitive information, by running checks for all + * commits in {@link RefNames#changeMetaRef} for all changes, created during the test. + * + * <p>These tests prevent regression, assuming appropriate test coverage for new features. The + * verification is disabled by default and can be enabled using {@link VerifyNoPiiInChangeNotes} + * annotation either on test class or method. + */ + protected void verifyNoAccountDetailsInChangeNotes() throws RestApiException, IOException { + List<ChangeInfo> allChanges = gApi.changes().query().get(); + + List<AccountState> allAccounts = accounts.all(); + for (ChangeInfo change : allChanges) { + try (Repository repo = repoManager.openRepository(Project.nameKey(change.project))) { + String metaRefName = + RefNames.changeMetaRef(Change.Id.tryParse(change._number.toString()).get()); + ObjectId metaTip = repo.getRefDatabase().exactRef(metaRefName).getObjectId(); + ChangeNotesRevWalk revWalk = ChangeNotesCommit.newRevWalk(repo); + revWalk.reset(); + revWalk.markStart(revWalk.parseCommit(metaTip)); + ChangeNotesCommit commit; + while ((commit = revWalk.next()) != null) { + String fullMessage = commit.getFullMessage(); + for (AccountState accountState : allAccounts) { + Account account = accountState.account(); + assertThat(fullMessage).doesNotContain(account.getName()); + if (account.fullName() != null) { + assertThat(fullMessage).doesNotContain(account.fullName()); + } + if (account.displayName() != null) { + assertThat(fullMessage).doesNotContain(account.displayName()); + } + if (account.preferredEmail() != null) { + assertThat(fullMessage).doesNotContain(account.preferredEmail()); + } + if (accountState.userName().isPresent()) { + assertThat(fullMessage).doesNotContain(accountState.userName().get()); + } + List<String> allEmails = + accountState.externalIds().stream() + .map(ExternalId::email) + .filter(Objects::nonNull) + .collect(toImmutableList()); + for (String email : allEmails) { + assertThat(fullMessage).doesNotContain(email); + } + } + } + } + } + } + protected TestRepository<?>.CommitBuilder commitBuilder() throws Exception { return testRepo.branch("HEAD").commit().insertChangeId(); } @@ -959,6 +1028,10 @@ return gApi.changes().id(id).get(options); } + protected AccountInfo getAccountInfo(Account.Id accountId) throws RestApiException { + return gApi.accounts().id(accountId.get()).get(); + } + protected List<ChangeInfo> query(String q) throws RestApiException { return gApi.changes().query(q).get(); } @@ -1173,7 +1246,7 @@ protected void assertMailReplyTo(Message message, String email) throws Exception { assertThat(message.headers()).containsKey("Reply-To"); - EmailHeader.String replyTo = (EmailHeader.String) message.headers().get("Reply-To"); + StringEmailHeader replyTo = (StringEmailHeader) message.headers().get("Reply-To"); assertThat(replyTo.getString()).contains(email); } @@ -1267,6 +1340,7 @@ assertThat(diff.diffHeader).isNotNull(); assertThat(diff.intralineStatus).isNull(); assertThat(diff.webLinks).isNull(); + assertThat(diff.editWebLinks).isNull(); assertThat(diff.metaA).isNull(); assertThat(diff.metaB).isNotNull(); @@ -1526,6 +1600,14 @@ ObjectId.fromString(get(changeId, ListChangesOption.CURRENT_REVISION).currentRevision)); } + protected void configSubmitRequirement( + Project.NameKey project, SubmitRequirement submitRequirement) throws Exception { + try (ProjectConfigUpdate u = updateProject(project)) { + u.getConfig().upsertSubmitRequirement(submitRequirement); + u.save(); + } + } + protected void configLabel(String label, LabelFunction func) throws Exception { configLabel(label, func, ImmutableList.of()); }
diff --git a/java/com/google/gerrit/acceptance/AbstractNotificationTest.java b/java/com/google/gerrit/acceptance/AbstractNotificationTest.java index 452df67..6c9a2b1 100644 --- a/java/com/google/gerrit/acceptance/AbstractNotificationTest.java +++ b/java/com/google/gerrit/acceptance/AbstractNotificationTest.java
@@ -31,6 +31,7 @@ import com.google.gerrit.entities.Address; import com.google.gerrit.entities.EmailHeader; import com.google.gerrit.entities.EmailHeader.AddressList; +import com.google.gerrit.entities.EmailHeader.StringEmailHeader; import com.google.gerrit.entities.NotifyConfig.NotifyType; import com.google.gerrit.extensions.api.changes.RecipientType; import com.google.gerrit.extensions.api.changes.ReviewInput; @@ -135,13 +136,13 @@ fact("expected to have message sent with", "X-Gerrit-MessageType header")); } EmailHeader header = message.headers().get("X-Gerrit-MessageType"); - if (!header.equals(new EmailHeader.String(messageType))) { + if (!header.equals(new StringEmailHeader(messageType))) { failWithoutActual( fact("expected message of type", messageType), fact( "actual", - header instanceof EmailHeader.String - ? ((EmailHeader.String) header).getString() + header instanceof StringEmailHeader + ? ((StringEmailHeader) header).getString() : header)); }
diff --git a/java/com/google/gerrit/acceptance/AbstractPluginLogFileTest.java b/java/com/google/gerrit/acceptance/AbstractPluginLogFileTest.java index 60def29..f22ddea 100644 --- a/java/com/google/gerrit/acceptance/AbstractPluginLogFileTest.java +++ b/java/com/google/gerrit/acceptance/AbstractPluginLogFileTest.java
@@ -34,7 +34,7 @@ import org.kohsuke.args4j.Option; public class AbstractPluginLogFileTest extends AbstractDaemonTest { - protected static class Module extends AbstractModule { + protected static class TestModule extends AbstractModule { @Override public void configure() { bind(com.google.gerrit.server.DynamicOptions.DynamicBean.class)
diff --git a/java/com/google/gerrit/acceptance/AccountCreator.java b/java/com/google/gerrit/acceptance/AccountCreator.java index 1b0954e..c67991d 100644 --- a/java/com/google/gerrit/acceptance/AccountCreator.java +++ b/java/com/google/gerrit/acceptance/AccountCreator.java
@@ -29,8 +29,9 @@ import com.google.gerrit.server.account.GroupCache; import com.google.gerrit.server.account.ServiceUserClassifier; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; +import com.google.gerrit.server.group.db.GroupDelta; import com.google.gerrit.server.group.db.GroupsUpdate; -import com.google.gerrit.server.group.db.InternalGroupUpdate; import com.google.gerrit.server.notedb.Sequences; import com.google.inject.Inject; import com.google.inject.Provider; @@ -52,18 +53,21 @@ private final Provider<AccountsUpdate> accountsUpdateProvider; private final GroupCache groupCache; private final Provider<GroupsUpdate> groupsUpdateProvider; + private final ExternalIdFactory externalIdFactory; @Inject AccountCreator( Sequences sequences, @ServerInitiated Provider<AccountsUpdate> accountsUpdateProvider, GroupCache groupCache, - @ServerInitiated Provider<GroupsUpdate> groupsUpdateProvider) { + @ServerInitiated Provider<GroupsUpdate> groupsUpdateProvider, + ExternalIdFactory externalIdFactory) { accounts = new HashMap<>(); this.sequences = sequences; this.accountsUpdateProvider = accountsUpdateProvider; this.groupCache = groupCache; this.groupsUpdateProvider = groupsUpdateProvider; + this.externalIdFactory = externalIdFactory; } public synchronized TestAccount create( @@ -84,11 +88,11 @@ String httpPass = null; if (username != null) { httpPass = "http-pass"; - extIds.add(ExternalId.createUsername(username, id, httpPass)); + extIds.add(externalIdFactory.createUsername(username, id, httpPass)); } if (email != null) { - extIds.add(ExternalId.createEmail(id, email)); + extIds.add(externalIdFactory.createEmail(id, email)); } accountsUpdateProvider @@ -145,8 +149,8 @@ return create("admin2", "admin2@example.com", "Administrator2", null, "Administrators"); } - public TestAccount user() throws Exception { - return create("user", "user@example.com", "User", null); + public TestAccount user1() throws Exception { + return create("user1", "user1@example.com", "User1", null); } public TestAccount user2() throws Exception { @@ -168,10 +172,10 @@ private void addGroupMember(AccountGroup.UUID groupUuid, Account.Id accountId) throws IOException, NoSuchGroupException, ConfigInvalidException { - InternalGroupUpdate groupUpdate = - InternalGroupUpdate.builder() + GroupDelta groupDelta = + GroupDelta.builder() .setMemberModification(memberIds -> Sets.union(memberIds, ImmutableSet.of(accountId))) .build(); - groupsUpdateProvider.get().updateGroup(groupUuid, groupUpdate); + groupsUpdateProvider.get().updateGroup(groupUuid, groupDelta); } }
diff --git a/java/com/google/gerrit/acceptance/BUILD b/java/com/google/gerrit/acceptance/BUILD index 5ee1a08..12c6837 100644 --- a/java/com/google/gerrit/acceptance/BUILD +++ b/java/com/google/gerrit/acceptance/BUILD
@@ -55,6 +55,7 @@ "//lib/bouncycastle:bcpg", "//lib/bouncycastle:bcpkix", "//lib/bouncycastle:bcprov", + "//lib/bouncycastle:bcutil", "//prolog:gerrit-prolog-common", ] @@ -65,6 +66,7 @@ "//java/com/google/gerrit/pgm/util", "//java/com/google/gerrit/truth", "//java/com/google/gerrit/acceptance/config", + "//java/com/google/gerrit/acceptance/testsuite/group", "//java/com/google/gerrit/acceptance/testsuite/project", "//java/com/google/gerrit/server/fixes/testing", "//java/com/google/gerrit/server/data", @@ -75,12 +77,12 @@ "//java/com/google/gerrit/extensions/restapi/testing:restapi-test-util", "//java/com/google/gerrit/gpg/testing:gpg-test-util", "//java/com/google/gerrit/git/testing", + "//java/com/google/gerrit/index/testing", ] PGM_DEPLOY_ENV = [ "//lib:caffeine", "//lib:caffeine-guava", - "//lib/jackson:jackson-core", "//lib/prolog:cafeteria", ]
diff --git a/java/com/google/gerrit/acceptance/ExtensionRegistry.java b/java/com/google/gerrit/acceptance/ExtensionRegistry.java index d72ee3f..3844788 100644 --- a/java/com/google/gerrit/acceptance/ExtensionRegistry.java +++ b/java/com/google/gerrit/acceptance/ExtensionRegistry.java
@@ -25,6 +25,8 @@ import com.google.gerrit.extensions.events.GitReferenceUpdatedListener; import com.google.gerrit.extensions.events.GroupIndexedListener; import com.google.gerrit.extensions.events.ProjectIndexedListener; +import com.google.gerrit.extensions.events.ReviewerAddedListener; +import com.google.gerrit.extensions.events.ReviewerDeletedListener; import com.google.gerrit.extensions.events.RevisionCreatedListener; import com.google.gerrit.extensions.events.TopicEditedListener; import com.google.gerrit.extensions.events.WorkInProgressStateChangedListener; @@ -32,9 +34,11 @@ import com.google.gerrit.extensions.registration.DynamicSet; import com.google.gerrit.extensions.registration.PrivateInternals_DynamicMapImpl; import com.google.gerrit.extensions.registration.RegistrationHandle; +import com.google.gerrit.extensions.webui.EditWebLink; import com.google.gerrit.extensions.webui.FileHistoryWebLink; import com.google.gerrit.extensions.webui.FileWebLink; import com.google.gerrit.extensions.webui.PatchSetWebLink; +import com.google.gerrit.extensions.webui.ResolveConflictsWebLink; import com.google.gerrit.server.ExceptionHook; import com.google.gerrit.server.account.GroupBackend; import com.google.gerrit.server.change.ChangeETagComputation; @@ -76,6 +80,8 @@ private final DynamicSet<GitReferenceUpdatedListener> refUpdatedListeners; private final DynamicSet<FileHistoryWebLink> fileHistoryWebLinks; private final DynamicSet<PatchSetWebLink> patchSetWebLinks; + private final DynamicSet<ResolveConflictsWebLink> resolveConflictsWebLinks; + private final DynamicSet<EditWebLink> editWebLinks; private final DynamicSet<FileWebLink> fileWebLinks; private final DynamicSet<RevisionCreatedListener> revisionCreatedListeners; private final DynamicSet<GroupBackend> groupBackends; @@ -89,6 +95,8 @@ private final DynamicMap<ProjectConfigEntry> pluginConfigEntries; private final DynamicSet<PluginPushOption> pluginPushOptions; private final DynamicSet<OnPostReview> onPostReviews; + private final DynamicSet<ReviewerAddedListener> reviewerAddedListeners; + private final DynamicSet<ReviewerDeletedListener> reviewerDeletedListeners; @Inject ExtensionRegistry( @@ -111,6 +119,8 @@ DynamicSet<GitReferenceUpdatedListener> refUpdatedListeners, DynamicSet<FileHistoryWebLink> fileHistoryWebLinks, DynamicSet<PatchSetWebLink> patchSetWebLinks, + DynamicSet<ResolveConflictsWebLink> resolveConflictsWebLinks, + DynamicSet<EditWebLink> editWebLinks, DynamicSet<FileWebLink> fileWebLinks, DynamicSet<RevisionCreatedListener> revisionCreatedListeners, DynamicSet<GroupBackend> groupBackends, @@ -122,7 +132,9 @@ DynamicMap<PluginProjectPermissionDefinition> pluginProjectPermissionDefinitions, DynamicMap<ProjectConfigEntry> pluginConfigEntries, DynamicSet<PluginPushOption> pluginPushOption, - DynamicSet<OnPostReview> onPostReviews) { + DynamicSet<OnPostReview> onPostReviews, + DynamicSet<ReviewerAddedListener> reviewerAddedListeners, + DynamicSet<ReviewerDeletedListener> reviewerDeletedListeners) { this.accountIndexedListeners = accountIndexedListeners; this.changeIndexedListeners = changeIndexedListeners; this.groupIndexedListeners = groupIndexedListeners; @@ -142,7 +154,9 @@ this.refUpdatedListeners = refUpdatedListeners; this.fileHistoryWebLinks = fileHistoryWebLinks; this.patchSetWebLinks = patchSetWebLinks; + this.editWebLinks = editWebLinks; this.fileWebLinks = fileWebLinks; + this.resolveConflictsWebLinks = resolveConflictsWebLinks; this.revisionCreatedListeners = revisionCreatedListeners; this.groupBackends = groupBackends; this.accountActivationValidationListeners = accountActivationValidationListeners; @@ -154,6 +168,8 @@ this.pluginConfigEntries = pluginConfigEntries; this.pluginPushOptions = pluginPushOption; this.onPostReviews = onPostReviews; + this.reviewerAddedListeners = reviewerAddedListeners; + this.reviewerDeletedListeners = reviewerDeletedListeners; } public Registration newRegistration() { @@ -244,6 +260,14 @@ return add(patchSetWebLinks, patchSetWebLink); } + public Registration add(ResolveConflictsWebLink resolveConflictsWebLink) { + return add(resolveConflictsWebLinks, resolveConflictsWebLink); + } + + public Registration add(EditWebLink editWebLink) { + return add(editWebLinks, editWebLink); + } + public Registration add(FileWebLink fileWebLink) { return add(fileWebLinks, fileWebLink); } @@ -294,6 +318,14 @@ return add(onPostReviews, onPostReview); } + public Registration add(ReviewerAddedListener reviewerAddedListener) { + return add(reviewerAddedListeners, reviewerAddedListener); + } + + public Registration add(ReviewerDeletedListener reviewerDeletedListener) { + return add(reviewerDeletedListeners, reviewerDeletedListener); + } + private <T> Registration add(DynamicSet<T> dynamicSet, T extension) { return add(dynamicSet, extension, "gerrit"); }
diff --git a/java/com/google/gerrit/acceptance/FakeGroupAuditService.java b/java/com/google/gerrit/acceptance/FakeGroupAuditService.java index 48dc408..a1c28b9 100644 --- a/java/com/google/gerrit/acceptance/FakeGroupAuditService.java +++ b/java/com/google/gerrit/acceptance/FakeGroupAuditService.java
@@ -39,7 +39,7 @@ @Singleton public class FakeGroupAuditService extends AuditService { - public static class Module extends AbstractModule { + public static class FakeGroupAuditServiceModule extends AbstractModule { @Override public void configure() { DynamicSet.setOf(binder(), GroupAuditListener.class);
diff --git a/java/com/google/gerrit/acceptance/FakeSubmitRule.java b/java/com/google/gerrit/acceptance/FakeSubmitRule.java new file mode 100644 index 0000000..1fbb9cf --- /dev/null +++ b/java/com/google/gerrit/acceptance/FakeSubmitRule.java
@@ -0,0 +1,34 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.acceptance; + +import com.google.gerrit.entities.SubmitRecord; +import com.google.gerrit.entities.SubmitRecord.Status; +import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.rules.SubmitRule; +import com.google.inject.Singleton; +import java.util.Optional; + +/** Fake submit rule that returns OK if the change contains one or more hashtags. */ +@Singleton +public class FakeSubmitRule implements SubmitRule { + @Override + public Optional<SubmitRecord> evaluate(ChangeData cd) { + SubmitRecord record = new SubmitRecord(); + record.status = cd.hashtags().isEmpty() ? Status.NOT_READY : Status.OK; + record.ruleName = FakeSubmitRule.class.getSimpleName(); + return Optional.of(record); + } +}
diff --git a/java/com/google/gerrit/acceptance/GerritServer.java b/java/com/google/gerrit/acceptance/GerritServer.java index 1a7a5b2..fb7189a 100644 --- a/java/com/google/gerrit/acceptance/GerritServer.java +++ b/java/com/google/gerrit/acceptance/GerritServer.java
@@ -23,6 +23,9 @@ import com.google.common.base.MoreObjects; import com.google.common.base.Strings; import com.google.common.collect.ImmutableList; +import com.google.gerrit.acceptance.FakeGroupAuditService.FakeGroupAuditServiceModule; +import com.google.gerrit.acceptance.ReindexGroupsAtStartup.ReindexGroupsAtStartupModule; +import com.google.gerrit.acceptance.ReindexProjectsAtStartup.ReindexProjectsAtStartupModule; import com.google.gerrit.acceptance.config.ConfigAnnotationParser; import com.google.gerrit.acceptance.config.GerritConfig; import com.google.gerrit.acceptance.config.GerritConfigs; @@ -43,22 +46,26 @@ import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperations; import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperationsImpl; import com.google.gerrit.common.Nullable; +import com.google.gerrit.extensions.annotations.Exports; import com.google.gerrit.extensions.config.FactoryModule; +import com.google.gerrit.index.IndexType; +import com.google.gerrit.index.testing.FakeIndexModule; import com.google.gerrit.lucene.LuceneIndexModule; import com.google.gerrit.pgm.Daemon; import com.google.gerrit.pgm.Init; import com.google.gerrit.server.config.GerritRuntime; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.config.SitePath; -import com.google.gerrit.server.experiments.ConfigExperimentFeatures; -import com.google.gerrit.server.git.receive.AsyncReceiveCommits; +import com.google.gerrit.server.experiments.ConfigExperimentFeatures.ConfigExperimentFeaturesModule; +import com.google.gerrit.server.git.receive.AsyncReceiveCommits.AsyncReceiveCommitsModule; +import com.google.gerrit.server.git.validators.CommitValidationListener; import com.google.gerrit.server.index.options.AutoFlush; import com.google.gerrit.server.schema.JdbcAccountPatchReviewStore; import com.google.gerrit.server.ssh.NoSshModule; import com.google.gerrit.server.util.ReplicaUtil; import com.google.gerrit.server.util.SocketUtil; import com.google.gerrit.server.util.SystemLog; -import com.google.gerrit.testing.FakeEmailSender; +import com.google.gerrit.testing.FakeEmailSender.FakeEmailSenderModule; import com.google.gerrit.testing.InMemoryRepositoryManager; import com.google.gerrit.testing.SshMode; import com.google.gerrit.testing.TestLoggingActivator; @@ -110,6 +117,8 @@ public abstract static class Description { public static Description forTestClass( org.junit.runner.Description testDesc, String configName) { + VerifyNoPiiInChangeNotes verifyNoPiiInChangeNotes = + get(VerifyNoPiiInChangeNotes.class, testDesc.getTestClass()); return new AutoValue_GerritServer_Description( testDesc, configName, @@ -118,6 +127,7 @@ has(Sandboxed.class, testDesc.getTestClass()), has(SkipProjectClone.class, testDesc.getTestClass()), has(UseSsh.class, testDesc.getTestClass()), + verifyNoPiiInChangeNotes != null && verifyNoPiiInChangeNotes.value(), false, // @UseSystemTime is only valid on methods. get(UseClockStep.class, testDesc.getTestClass()), get(UseTimezone.class, testDesc.getTestClass()), @@ -137,6 +147,11 @@ // on class level. useClockStep = get(UseClockStep.class, testDesc.getTestClass()); } + VerifyNoPiiInChangeNotes verifyNoPiiInChangeNotes = + testDesc.getAnnotation(VerifyNoPiiInChangeNotes.class); + if (verifyNoPiiInChangeNotes == null) { + verifyNoPiiInChangeNotes = get(VerifyNoPiiInChangeNotes.class, testDesc.getTestClass()); + } return new AutoValue_GerritServer_Description( testDesc, @@ -152,6 +167,7 @@ || has(SkipProjectClone.class, testDesc.getTestClass()), testDesc.getAnnotation(UseSsh.class) != null || has(UseSsh.class, testDesc.getTestClass()), + verifyNoPiiInChangeNotes != null && verifyNoPiiInChangeNotes.value(), testDesc.getAnnotation(UseSystemTime.class) != null, useClockStep, testDesc.getAnnotation(UseTimezone.class) != null @@ -197,6 +213,8 @@ abstract boolean useSshAnnotation(); + abstract boolean verifyNoPiiInChangeNotes(); + boolean useSsh() { return useSshAnnotation() && SshMode.useSsh(); } @@ -279,7 +297,6 @@ * @param baseConfig default config values; merged with config from {@code desc} and then written * into {@code site/etc/gerrit.config}. * @param site temp directory where site will live. - * @throws Exception */ public static void init(Description desc, Config baseConfig, Path site) throws Exception { checkArgument(!desc.memory(), "can't initialize site path for in-memory test: %s", desc); @@ -292,6 +309,12 @@ gerritConfig.load(); gerritConfig.merge(cfg); mergeTestConfig(gerritConfig); + String configuredIndexBackend = cfg.getString("index", null, "type"); + if (configuredIndexBackend == null) { + // Propagate index type to pgms that run off of the gerrit.config file on local disk. + IndexType indexType = IndexType.fromEnvironment().orElse(new IndexType("fake")); + gerritConfig.setString("index", null, "type", indexType.isLucene() ? "lucene" : "fake"); + } gerritConfig.save(); Init init = new Init(); @@ -327,7 +350,6 @@ * @param testSysModule additional Guice module to use. * @param testSshModule additional Guice module to use. * @return started server. - * @throws Exception */ public static GerritServer initAndStart( TemporaryFolder temporaryFolder, @@ -364,7 +386,6 @@ * @param additionalArgs additional command-line arguments for the daemon program; only allowed if * the test is not in-memory. * @return started server. - * @throws Exception */ public static GerritServer start( Description desc, @@ -390,15 +411,24 @@ } }, site); - daemon.setEmailModuleForTesting(new FakeEmailSender.Module()); + daemon.setEmailModuleForTesting(new FakeEmailSenderModule()); daemon.setAuditEventModuleForTesting( - MoreObjects.firstNonNull(testAuditModule, new FakeGroupAuditService.Module())); + MoreObjects.firstNonNull(testAuditModule, new FakeGroupAuditServiceModule())); if (testSysModule != null) { daemon.addAdditionalSysModuleForTesting(testSysModule); } if (testSshModule != null) { daemon.addAdditionalSshModuleForTesting(testSshModule); } + daemon.addAdditionalSysModuleForTesting( + new AbstractModule() { + @Override + protected void configure() { + bind(CommitValidationListener.class) + .annotatedWith(Exports.named("object-visibility-listener")) + .to(GitObjectVisibilityChecker.class); + } + }); daemon.setEnableHttpd(desc.httpd()); // Assure that SSHD is enabled if HTTPD is not required, otherwise the Gerrit server would not // even start. @@ -432,9 +462,29 @@ cfg.setString("gitweb", null, "cgi", ""); cfg.setString( "accountPatchReviewDb", null, "url", JdbcAccountPatchReviewStore.TEST_IN_MEMORY_URL); - daemon.setLuceneModule( - LuceneIndexModule.singleVersionAllLatest( - 0, ReplicaUtil.isReplica(baseConfig), AutoFlush.ENABLED)); + + String configuredIndexBackend = cfg.getString("index", null, "type"); + IndexType indexType; + if (configuredIndexBackend != null) { + // Explicitly configured index backend from gerrit.config trumps any other ways to configure + // index backends so that Reindex tests can be explicit about the backend they want to test + // against. + indexType = new IndexType(configuredIndexBackend); + } else { + // Allow configuring the index backend based on sys/env variables so that integration tests + // can be run against different index backends. + indexType = IndexType.fromEnvironment().orElse(new IndexType("fake")); + } + if (indexType.isLucene()) { + daemon.setIndexModule( + LuceneIndexModule.singleVersionAllLatest( + 0, ReplicaUtil.isReplica(baseConfig), AutoFlush.ENABLED)); + } else { + daemon.setIndexModule(FakeIndexModule.latestVersion(false)); + } + + daemon.setEnableHttpd(desc.httpd()); + daemon.setInMemory(true); daemon.setDatabaseForTesting( ImmutableList.of( new InMemoryTestingDatabaseModule(cfg, site, inMemoryRepoManager), @@ -444,9 +494,9 @@ bind(GerritRuntime.class).toInstance(GerritRuntime.DAEMON); } }, - new ConfigExperimentFeatures.Module())); + new ConfigExperimentFeaturesModule())); daemon.addAdditionalSysModuleForTesting( - new ReindexProjectsAtStartup.Module(), new ReindexGroupsAtStartup.Module()); + new ReindexProjectsAtStartupModule(), new ReindexGroupsAtStartupModule()); daemon.start(); return new GerritServer(desc, null, createTestInjector(daemon), daemon, null); } @@ -459,6 +509,8 @@ String[] additionalArgs) throws Exception { requireNonNull(site); + daemon.addAdditionalSysModuleForTesting( + new ReindexProjectsAtStartupModule(), new ReindexGroupsAtStartupModule()); ExecutorService daemonService = Executors.newSingleThreadExecutor(); String[] args = Stream.concat( @@ -537,7 +589,7 @@ factory(PushOneCommit.Factory.class); install(InProcessProtocol.module()); install(new NoSshModule()); - install(new AsyncReceiveCommits.Module()); + install(new AsyncReceiveCommitsModule()); factory(ProjectResetter.Builder.Factory.class); }
diff --git a/java/com/google/gerrit/acceptance/GitObjectVisibilityChecker.java b/java/com/google/gerrit/acceptance/GitObjectVisibilityChecker.java new file mode 100644 index 0000000..afa1b1d --- /dev/null +++ b/java/com/google/gerrit/acceptance/GitObjectVisibilityChecker.java
@@ -0,0 +1,71 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.acceptance; + +import com.google.gerrit.exceptions.StorageException; +import com.google.gerrit.server.events.CommitReceivedEvent; +import com.google.gerrit.server.git.GitRepositoryManager; +import com.google.gerrit.server.git.validators.CommitValidationException; +import com.google.gerrit.server.git.validators.CommitValidationListener; +import com.google.gerrit.server.git.validators.CommitValidationMessage; +import com.google.inject.Inject; +import com.google.inject.Singleton; +import java.io.IOException; +import java.util.Collections; +import java.util.List; +import org.eclipse.jgit.lib.ObjectReader; +import org.eclipse.jgit.lib.Repository; + +/** + * Checker that ensures that all Git commits that should be validated are readable using any {@link + * ObjectReader} on the repo. It is easy for users of the JGit API to forget to call {@code flush} + * on ObjectInserter which creates an illegal state for CommitValidators. This safeguard makes sure + * that any functionality tested in acceptance tests got this right. + */ +@Singleton +public class GitObjectVisibilityChecker implements CommitValidationListener { + private final GitRepositoryManager gitRepositoryManager; + + @Inject + GitObjectVisibilityChecker(GitRepositoryManager gitRepositoryManager) { + this.gitRepositoryManager = gitRepositoryManager; + } + + @Override + public List<CommitValidationMessage> onCommitReceived(CommitReceivedEvent receiveEvent) + throws CommitValidationException { + try { + try (Repository repo = gitRepositoryManager.openRepository(receiveEvent.getProjectNameKey()); + ObjectReader reader = repo.newObjectReader()) { + if (!reader.has(receiveEvent.commit)) { + throw new IllegalStateException( + String.format( + "Commit %s was not visible using a new object reader in the repo. " + + "This creates an illegal state for commit validators. You must flush any ObjectReaders " + + "before performing the ref transaction.", + receiveEvent.commit)); + } + } + } catch (IOException e) { + throw new StorageException(e); + } + return Collections.emptyList(); + } + + @Override + public boolean shouldValidateAllCommits() { + return true; + } +}
diff --git a/java/com/google/gerrit/acceptance/InMemoryTestingDatabaseModule.java b/java/com/google/gerrit/acceptance/InMemoryTestingDatabaseModule.java index c2b21fb..9a652e3 100644 --- a/java/com/google/gerrit/acceptance/InMemoryTestingDatabaseModule.java +++ b/java/com/google/gerrit/acceptance/InMemoryTestingDatabaseModule.java
@@ -22,7 +22,11 @@ import com.google.gerrit.lifecycle.LifecycleModule; import com.google.gerrit.metrics.MetricMaker; import com.google.gerrit.metrics.MetricsReservoirConfig; +import com.google.gerrit.server.config.AllProjectsConfigProvider; +import com.google.gerrit.server.config.FileBasedAllProjectsConfigProvider; +import com.google.gerrit.server.config.FileBasedGlobalPluginConfigProvider; import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.config.GlobalPluginConfigProvider; import com.google.gerrit.server.config.MetricsReservoirConfigImpl; import com.google.gerrit.server.config.SitePath; import com.google.gerrit.server.config.SitePaths; @@ -57,6 +61,8 @@ @Override protected void configure() { bind(Config.class).annotatedWith(GerritServerConfig.class).toInstance(cfg); + bind(GlobalPluginConfigProvider.class).to(FileBasedGlobalPluginConfigProvider.class); + bind(AllProjectsConfigProvider.class).to(FileBasedAllProjectsConfigProvider.class); bind(Path.class).annotatedWith(SitePath.class).toInstance(sitePath); if (repoManager != null) {
diff --git a/java/com/google/gerrit/acceptance/PushOneCommit.java b/java/com/google/gerrit/acceptance/PushOneCommit.java index 67e26ec..d46fb78 100644 --- a/java/com/google/gerrit/acceptance/PushOneCommit.java +++ b/java/com/google/gerrit/acceptance/PushOneCommit.java
@@ -30,7 +30,7 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; -import com.google.gerrit.server.ApprovalsUtil; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.notedb.ReviewerStateInternal; import com.google.gerrit.server.query.change.ChangeData; @@ -282,6 +282,11 @@ return this; } + public PushOneCommit noParent() throws Exception { + commitBuilder.noParents(); + return this; + } + public PushOneCommit addSymlink(String path, String target) throws Exception { RevBlob blobId = testRepo.blob(target); commitBuilder.edit(
diff --git a/java/com/google/gerrit/acceptance/ReindexGroupsAtStartup.java b/java/com/google/gerrit/acceptance/ReindexGroupsAtStartup.java index 0b2282e..ba1c3cd 100644 --- a/java/com/google/gerrit/acceptance/ReindexGroupsAtStartup.java +++ b/java/com/google/gerrit/acceptance/ReindexGroupsAtStartup.java
@@ -34,7 +34,7 @@ private final Groups groups; private final Config cfg; - public static class Module extends LifecycleModule { + public static class ReindexGroupsAtStartupModule extends LifecycleModule { @Override protected void configure() { listener().to(ReindexGroupsAtStartup.class).in(Scopes.SINGLETON);
diff --git a/java/com/google/gerrit/acceptance/ReindexProjectsAtStartup.java b/java/com/google/gerrit/acceptance/ReindexProjectsAtStartup.java index 2f0ffcb..991136f 100644 --- a/java/com/google/gerrit/acceptance/ReindexProjectsAtStartup.java +++ b/java/com/google/gerrit/acceptance/ReindexProjectsAtStartup.java
@@ -26,7 +26,7 @@ private final ProjectIndexer projectIndexer; private final GitRepositoryManager repoMgr; - public static class Module extends LifecycleModule { + public static class ReindexProjectsAtStartupModule extends LifecycleModule { @Override protected void configure() { listener().to(ReindexProjectsAtStartup.class).in(Scopes.SINGLETON);
diff --git a/java/com/google/gerrit/acceptance/RestSession.java b/java/com/google/gerrit/acceptance/RestSession.java index 7ee1b26..342cbd0 100644 --- a/java/com/google/gerrit/acceptance/RestSession.java +++ b/java/com/google/gerrit/acceptance/RestSession.java
@@ -37,17 +37,17 @@ } public RestResponse get(String endPoint) throws IOException { - return getWithHeader(endPoint, null); + return getWithHeaders(endPoint); } public RestResponse getJsonAccept(String endPoint) throws IOException { - return getWithHeader(endPoint, new BasicHeader(ACCEPT, "application/json")); + return getWithHeaders(endPoint, new BasicHeader(ACCEPT, "application/json")); } - public RestResponse getWithHeader(String endPoint, Header header) throws IOException { + public RestResponse getWithHeaders(String endPoint, Header... headers) throws IOException { Request get = Request.Get(getUrl(endPoint)); - if (header != null) { - get.addHeader(header); + if (headers != null) { + get.setHeaders(headers); } return execute(get); } @@ -57,22 +57,22 @@ } public RestResponse put(String endPoint) throws IOException { - return put(endPoint, null); + return put(endPoint, /* content = */ null); } public RestResponse put(String endPoint, Object content) throws IOException { - return putWithHeader(endPoint, null, content); + return putWithHeaders(endPoint, content); } - public RestResponse putWithHeader(String endPoint, Header header) throws IOException { - return putWithHeader(endPoint, header, null); + public RestResponse putWithHeaders(String endPoint, Header... headers) throws IOException { + return putWithHeaders(endPoint, /* content= */ null, headers); } - public RestResponse putWithHeader(String endPoint, Header header, Object content) + public RestResponse putWithHeaders(String endPoint, Object content, Header... headers) throws IOException { Request put = Request.Put(getUrl(endPoint)); - if (header != null) { - put.addHeader(header); + if (headers != null) { + put.setHeaders(headers); } if (content != null) { addContentToRequest(put, content); @@ -91,18 +91,18 @@ } public RestResponse post(String endPoint) throws IOException { - return post(endPoint, null); + return post(endPoint, /* content = */ null); } public RestResponse post(String endPoint, Object content) throws IOException { - return postWithHeader(endPoint, null, content); + return postWithHeaders(endPoint, content); } - public RestResponse postWithHeader(String endPoint, Header header, Object content) + public RestResponse postWithHeaders(String endPoint, Object content, Header... headers) throws IOException { Request post = Request.Post(getUrl(endPoint)); - if (header != null) { - post.addHeader(header); + if (headers != null) { + post.setHeaders(headers); } if (content != null) { addContentToRequest(post, content); @@ -119,6 +119,14 @@ return execute(Request.Delete(getUrl(endPoint))); } + public RestResponse deleteWithHeaders(String endPoint, Header... headers) throws IOException { + Request delete = Request.Delete(getUrl(endPoint)); + if (headers != null) { + delete.setHeaders(headers); + } + return execute(delete); + } + private String getUrl(String endPoint) { return url + (account != null ? "/a" : "") + endPoint; }
diff --git a/java/com/google/gerrit/acceptance/SshSessionJsch.java b/java/com/google/gerrit/acceptance/SshSessionJsch.java index a86c2d6..fa4d1d1 100644 --- a/java/com/google/gerrit/acceptance/SshSessionJsch.java +++ b/java/com/google/gerrit/acceptance/SshSessionJsch.java
@@ -40,9 +40,9 @@ import org.bouncycastle.openssl.jcajce.JcaPEMWriter; import org.bouncycastle.openssl.jcajce.JcaPKCS8Generator; import org.bouncycastle.util.io.pem.PemObject; -import org.eclipse.jgit.transport.JschConfigSessionFactory; -import org.eclipse.jgit.transport.OpenSshConfig.Host; import org.eclipse.jgit.transport.SshSessionFactory; +import org.eclipse.jgit.transport.ssh.jsch.JschConfigSessionFactory; +import org.eclipse.jgit.transport.ssh.jsch.OpenSshConfig.Host; import org.eclipse.jgit.util.FS; public class SshSessionJsch extends SshSession {
diff --git a/java/com/google/gerrit/acceptance/SshSessionMina.java b/java/com/google/gerrit/acceptance/SshSessionMina.java index 4d8691b..3b0ba3b 100644 --- a/java/com/google/gerrit/acceptance/SshSessionMina.java +++ b/java/com/google/gerrit/acceptance/SshSessionMina.java
@@ -107,13 +107,11 @@ @Override public int execAndReturnStatus(String command) throws Exception { Process process = getMinaSession().exec(command, 0); - InputStream in = process.getInputStream(); InputStream err = process.getErrorStream(); Scanner s = new Scanner(err, UTF_8.name()).useDelimiter("\\A"); error = s.hasNext() ? s.next() : null; - s = new Scanner(in, UTF_8.name()).useDelimiter("\\A"); try { return process.exitValue(); } catch (IllegalThreadStateException e) {
diff --git a/java/com/google/gerrit/acceptance/TestMetricMaker.java b/java/com/google/gerrit/acceptance/TestMetricMaker.java index d60ef1a..2620f99 100644 --- a/java/com/google/gerrit/acceptance/TestMetricMaker.java +++ b/java/com/google/gerrit/acceptance/TestMetricMaker.java
@@ -34,11 +34,11 @@ * * <pre> * public class MyTest extends AbstractDaemonTest { - * @Inject private TestMetricMaker testMetricMaker; + * {@literal @}Inject private TestMetricMaker testMetricMaker; * * ... * - * @Test + * {@literal @}Test * public void testFoo() throws Exception { * testMetricMaker.reset(); * doSomething();
diff --git a/java/com/google/gerrit/acceptance/VerifyNoPiiInChangeNotes.java b/java/com/google/gerrit/acceptance/VerifyNoPiiInChangeNotes.java new file mode 100644 index 0000000..1bdaa6e --- /dev/null +++ b/java/com/google/gerrit/acceptance/VerifyNoPiiInChangeNotes.java
@@ -0,0 +1,35 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.acceptance; + +import static java.lang.annotation.ElementType.METHOD; +import static java.lang.annotation.ElementType.TYPE; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +/** + * Annotation for the acceptance tests, inherited from {@link AbstractDaemonTest}, to enable + * verification that NoteDB commits do not persist user-sensitive information. See {@link + * AbstractDaemonTest#verifyNoAccountDetailsInChangeNotes}. + * + * <p>Disabled by default, can be enabled per test class/test method. + */ +@Target({TYPE, METHOD}) +@Retention(RUNTIME) +public @interface VerifyNoPiiInChangeNotes { + boolean value() default false; +}
diff --git a/java/com/google/gerrit/acceptance/config/GlobalPluginConfig.java b/java/com/google/gerrit/acceptance/config/GlobalPluginConfig.java index ae88e37..87063c9 100644 --- a/java/com/google/gerrit/acceptance/config/GlobalPluginConfig.java +++ b/java/com/google/gerrit/acceptance/config/GlobalPluginConfig.java
@@ -28,12 +28,12 @@ /** Name of the plugin, corresponding to {@code $site/etc/@pluginName.config}. */ String pluginName(); - /** @see GerritConfig#name() */ + /** See {@link GerritConfig#name()} */ String name(); - /** @see GerritConfig#value() */ + /** See {@link GerritConfig#value()} */ String value() default ""; - /** @see GerritConfig#values() */ + /** See {@link GerritConfig#values()} */ String[] values() default ""; }
diff --git a/java/com/google/gerrit/acceptance/testsuite/account/AccountOperationsImpl.java b/java/com/google/gerrit/acceptance/testsuite/account/AccountOperationsImpl.java index 8c1eebd..c6457a4 100644 --- a/java/com/google/gerrit/acceptance/testsuite/account/AccountOperationsImpl.java +++ b/java/com/google/gerrit/acceptance/testsuite/account/AccountOperationsImpl.java
@@ -21,15 +21,18 @@ import com.google.common.collect.Sets; import com.google.gerrit.entities.Account; import com.google.gerrit.server.ServerInitiated; +import com.google.gerrit.server.account.AccountDelta; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.account.Accounts; import com.google.gerrit.server.account.AccountsUpdate; -import com.google.gerrit.server.account.InternalAccountUpdate; +import com.google.gerrit.server.account.AccountsUpdate.ConfigureDeltaFromState; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; import com.google.gerrit.server.notedb.Sequences; import com.google.inject.Inject; import java.io.IOException; import java.util.Optional; +import java.util.function.Consumer; import org.eclipse.jgit.errors.ConfigInvalidException; /** @@ -42,13 +45,18 @@ private final Accounts accounts; private final AccountsUpdate accountsUpdate; private final Sequences seq; + private final ExternalIdFactory externalIdFactory; @Inject public AccountOperationsImpl( - Accounts accounts, @ServerInitiated AccountsUpdate accountsUpdate, Sequences seq) { + Accounts accounts, + @ServerInitiated AccountsUpdate accountsUpdate, + Sequences seq, + ExternalIdFactory externalIdFactory) { this.accounts = accounts; this.accountsUpdate = accountsUpdate; this.seq = seq; + this.externalIdFactory = externalIdFactory; } @Override @@ -61,24 +69,17 @@ return TestAccountCreation.builder(this::createAccount); } - private Account.Id createAccount(TestAccountCreation accountCreation) throws Exception { - AccountsUpdate.AccountUpdater accountUpdater = - (accountState, updateBuilder) -> - fillBuilder(updateBuilder, accountCreation, accountState.account().id()); - AccountState createdAccount = createAccount(accountUpdater); + private Account.Id createAccount(TestAccountCreation testAccountCreation) throws Exception { + Account.Id accountId = Account.id(seq.nextAccountId()); + Consumer<AccountDelta.Builder> accountCreation = + deltaBuilder -> initAccountDelta(deltaBuilder, testAccountCreation, accountId); + AccountState createdAccount = + accountsUpdate.insert("Create Test Account", accountId, accountCreation); return createdAccount.account().id(); } - private AccountState createAccount(AccountsUpdate.AccountUpdater accountUpdater) - throws IOException, ConfigInvalidException { - Account.Id accountId = Account.id(seq.nextAccountId()); - return accountsUpdate.insert("Create Test Account", accountId, accountUpdater); - } - - private static void fillBuilder( - InternalAccountUpdate.Builder builder, - TestAccountCreation accountCreation, - Account.Id accountId) { + private void initAccountDelta( + AccountDelta.Builder builder, TestAccountCreation accountCreation, Account.Id accountId) { accountCreation.fullname().ifPresent(builder::setFullName); accountCreation.preferredEmail().ifPresent(e -> setPreferredEmail(builder, accountId, e)); String httpPassword = accountCreation.httpPassword().orElse(null); @@ -89,22 +90,19 @@ .secondaryEmails() .forEach( secondaryEmail -> - builder.addExternalId(ExternalId.createEmail(accountId, secondaryEmail))); + builder.addExternalId(externalIdFactory.createEmail(accountId, secondaryEmail))); } - private static InternalAccountUpdate.Builder setPreferredEmail( - InternalAccountUpdate.Builder builder, Account.Id accountId, String preferredEmail) { - return builder + private void setPreferredEmail( + AccountDelta.Builder builder, Account.Id accountId, String preferredEmail) { + builder .setPreferredEmail(preferredEmail) - .addExternalId(ExternalId.createEmail(accountId, preferredEmail)); + .addExternalId(externalIdFactory.createEmail(accountId, preferredEmail)); } - private static InternalAccountUpdate.Builder setUsername( - InternalAccountUpdate.Builder builder, - Account.Id accountId, - String username, - String httpPassword) { - return builder.addExternalId(ExternalId.createUsername(username, accountId, httpPassword)); + private void setUsername( + AccountDelta.Builder builder, Account.Id accountId, String username, String httpPassword) { + builder.addExternalId(externalIdFactory.createUsername(username, accountId, httpPassword)); } private class PerAccountOperationsImpl implements PerAccountOperations { @@ -155,21 +153,19 @@ private void updateAccount(TestAccountUpdate accountUpdate) throws IOException, ConfigInvalidException { - AccountsUpdate.AccountUpdater accountUpdater = - (accountState, updateBuilder) -> fillBuilder(updateBuilder, accountUpdate, accountState); - Optional<AccountState> updatedAccount = updateAccount(accountUpdater); + ConfigureDeltaFromState configureDeltaFromState = + (accountState, deltaBuilder) -> fillBuilder(deltaBuilder, accountUpdate, accountState); + Optional<AccountState> updatedAccount = updateAccount(configureDeltaFromState); checkState(updatedAccount.isPresent(), "Tried to update non-existing test account"); } - private Optional<AccountState> updateAccount(AccountsUpdate.AccountUpdater accountUpdater) + private Optional<AccountState> updateAccount(ConfigureDeltaFromState configureDeltaFromState) throws IOException, ConfigInvalidException { - return accountsUpdate.update("Update Test Account", accountId, accountUpdater); + return accountsUpdate.update("Update Test Account", accountId, configureDeltaFromState); } private void fillBuilder( - InternalAccountUpdate.Builder builder, - TestAccountUpdate accountUpdate, - AccountState accountState) { + AccountDelta.Builder builder, TestAccountUpdate accountUpdate, AccountState accountState) { accountUpdate.fullname().ifPresent(builder::setFullName); accountUpdate.preferredEmail().ifPresent(e -> setPreferredEmail(builder, accountId, e)); String httpPassword = accountUpdate.httpPassword().orElse(null); @@ -200,7 +196,7 @@ } private void setSecondaryEmails( - InternalAccountUpdate.Builder builder, + AccountDelta.Builder builder, TestAccountUpdate accountUpdate, AccountState accountState, ImmutableSet<String> newSecondaryEmails) { @@ -212,14 +208,14 @@ .collect(toImmutableSet())); builder.addExternalIds( newSecondaryEmails.stream() - .map(secondaryEmail -> ExternalId.createEmail(accountId, secondaryEmail)) + .map(secondaryEmail -> externalIdFactory.createEmail(accountId, secondaryEmail)) .collect(toImmutableSet())); if (accountUpdate.preferredEmail().isPresent()) { builder.addExternalId( - ExternalId.createEmail(accountId, accountUpdate.preferredEmail().get())); + externalIdFactory.createEmail(accountId, accountUpdate.preferredEmail().get())); } else if (accountState.account().preferredEmail() != null) { builder.addExternalId( - ExternalId.createEmail(accountId, accountState.account().preferredEmail())); + externalIdFactory.createEmail(accountId, accountState.account().preferredEmail())); } } @@ -235,8 +231,8 @@ if (testAccountInvalidation.preferredEmailWithoutExternalId().isPresent()) { updateAccount( - (account, updateBuilder) -> - updateBuilder.setPreferredEmail( + (account, deltaBuilder) -> + deltaBuilder.setPreferredEmail( testAccountInvalidation.preferredEmailWithoutExternalId().get())); } }
diff --git a/java/com/google/gerrit/acceptance/testsuite/change/ChangeKindCreator.java b/java/com/google/gerrit/acceptance/testsuite/change/ChangeKindCreator.java new file mode 100644 index 0000000..1038a14 --- /dev/null +++ b/java/com/google/gerrit/acceptance/testsuite/change/ChangeKindCreator.java
@@ -0,0 +1,339 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.acceptance.testsuite.change; + +import static com.google.common.truth.Truth.assertThat; +import static com.google.common.truth.Truth.assertWithMessage; +import static org.eclipse.jgit.lib.Constants.HEAD; + +import com.google.common.collect.ImmutableList; +import com.google.gerrit.acceptance.GitUtil; +import com.google.gerrit.acceptance.PushOneCommit; +import com.google.gerrit.acceptance.TestAccount; +import com.google.gerrit.acceptance.testsuite.project.ProjectOperations; +import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperations; +import com.google.gerrit.entities.LabelId; +import com.google.gerrit.entities.Project; +import com.google.gerrit.extensions.api.GerritApi; +import com.google.gerrit.extensions.api.changes.CherryPickInput; +import com.google.gerrit.extensions.api.changes.ReviewInput; +import com.google.gerrit.extensions.api.changes.RevisionApi; +import com.google.gerrit.extensions.client.ChangeKind; +import com.google.gerrit.extensions.client.ListChangesOption; +import com.google.gerrit.extensions.common.ChangeInfo; +import com.google.gerrit.extensions.common.CommitInfo; +import com.google.inject.Inject; +import java.util.List; +import org.eclipse.jgit.internal.storage.dfs.InMemoryRepository; +import org.eclipse.jgit.junit.TestRepository; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.lib.PersonIdent; +import org.eclipse.jgit.revwalk.RevCommit; + +/** Helper to create changes of a certain {@link ChangeKind}. */ +public class ChangeKindCreator { + private GerritApi gApi; + private PushOneCommit.Factory pushFactory; + private RequestScopeOperations requestScopeOperations; + private ProjectOperations projectOperations; + + @Inject + private ChangeKindCreator( + GerritApi gApi, + PushOneCommit.Factory pushFactory, + RequestScopeOperations requestScopeOperations, + ProjectOperations projectOperations) { + this.gApi = gApi; + this.pushFactory = pushFactory; + this.requestScopeOperations = requestScopeOperations; + this.projectOperations = projectOperations; + } + + /** Creates a change with the given {@link ChangeKind} and returns the change id. */ + public String createChange( + ChangeKind kind, TestRepository<InMemoryRepository> testRepo, TestAccount user) + throws Exception { + switch (kind) { + case NO_CODE_CHANGE: + case REWORK: + case TRIVIAL_REBASE: + case NO_CHANGE: + return createChange(testRepo, user).getChangeId(); + case MERGE_FIRST_PARENT_UPDATE: + return createChangeForMergeCommit(testRepo, user); + default: + throw new IllegalStateException("unexpected change kind: " + kind); + } + } + + /** Updates a change with the given {@link ChangeKind}. */ + public void updateChange( + String changeId, + ChangeKind changeKind, + TestRepository<InMemoryRepository> testRepo, + TestAccount user, + Project.NameKey project) + throws Exception { + switch (changeKind) { + case NO_CODE_CHANGE: + noCodeChange(changeId, testRepo, user); + return; + case REWORK: + rework(changeId, testRepo, user); + return; + case TRIVIAL_REBASE: + trivialRebase(changeId, testRepo, user, project); + return; + case MERGE_FIRST_PARENT_UPDATE: + updateFirstParent(changeId, testRepo, user); + return; + case NO_CHANGE: + noChange(changeId, testRepo, user); + return; + default: + assertWithMessage("unexpected change kind: " + changeKind).fail(); + } + } + + /** + * Creates a cherry pick of the provided change with the given {@link ChangeKind} and returns the + * change id. + */ + public String cherryPick( + String changeId, + ChangeKind changeKind, + TestRepository<InMemoryRepository> testRepo, + TestAccount user, + Project.NameKey project) + throws Exception { + switch (changeKind) { + case REWORK: + case TRIVIAL_REBASE: + break; + case NO_CODE_CHANGE: + case NO_CHANGE: + case MERGE_FIRST_PARENT_UPDATE: + default: + assertWithMessage("unexpected change kind: " + changeKind).fail(); + } + + testRepo.reset(projectOperations.project(project).getHead("master")); + PushOneCommit.Result r = + pushFactory + .create( + user.newIdent(), + testRepo, + PushOneCommit.SUBJECT, + "other.txt", + "new content " + System.nanoTime()) + .to("refs/for/master"); + r.assertOkStatus(); + vote(user, r.getChangeId(), 2, 1); + merge(r); + + String subject = + ChangeKind.TRIVIAL_REBASE.equals(changeKind) + ? PushOneCommit.SUBJECT + : "Reworked change " + System.nanoTime(); + CherryPickInput in = new CherryPickInput(); + in.destination = "master"; + in.message = String.format("%s\n\nChange-Id: %s", subject, changeId); + ChangeInfo c = gApi.changes().id(changeId).current().cherryPick(in).get(); + return c.changeId; + } + + /** Creates a change that is a merge {@link ChangeKind} and returns the change id. */ + public String createChangeForMergeCommit( + TestRepository<InMemoryRepository> testRepo, TestAccount user) throws Exception { + ObjectId initial = testRepo.getRepository().exactRef(HEAD).getLeaf().getObjectId(); + + PushOneCommit.Result parent1 = createChange("parent 1", "p1.txt", "content 1", testRepo, user); + + testRepo.reset(initial); + PushOneCommit.Result parent2 = createChange("parent 2", "p2.txt", "content 2", testRepo, user); + + testRepo.reset(parent1.getCommit()); + + PushOneCommit merge = pushFactory.create(user.newIdent(), testRepo); + merge.setParents(ImmutableList.of(parent1.getCommit(), parent2.getCommit())); + PushOneCommit.Result result = merge.to("refs/for/master"); + result.assertOkStatus(); + return result.getChangeId(); + } + + /** Update the first parent of a merge. */ + public void updateFirstParent( + String changeId, TestRepository<InMemoryRepository> testRepo, TestAccount user) + throws Exception { + ChangeInfo c = detailedChange(changeId); + List<CommitInfo> parents = c.revisions.get(c.currentRevision).commit.parents; + String parent1 = parents.get(0).commit; + String parent2 = parents.get(1).commit; + RevCommit commitParent2 = testRepo.getRevWalk().parseCommit(ObjectId.fromString(parent2)); + + testRepo.reset(parent1); + PushOneCommit.Result newParent1 = + createChange("new parent 1", "p1-1.txt", "content 1-1", testRepo, user); + + PushOneCommit merge = pushFactory.create(user.newIdent(), testRepo, changeId); + merge.setParents(ImmutableList.of(newParent1.getCommit(), commitParent2)); + PushOneCommit.Result result = merge.to("refs/for/master"); + result.assertOkStatus(); + + assertThat(getChangeKind(changeId)).isEqualTo(ChangeKind.MERGE_FIRST_PARENT_UPDATE); + } + + /** Update the second parent of a merge. */ + public void updateSecondParent( + String changeId, TestRepository<InMemoryRepository> testRepo, TestAccount user) + throws Exception { + ChangeInfo c = detailedChange(changeId); + List<CommitInfo> parents = c.revisions.get(c.currentRevision).commit.parents; + String parent1 = parents.get(0).commit; + String parent2 = parents.get(1).commit; + RevCommit commitParent1 = testRepo.getRevWalk().parseCommit(ObjectId.fromString(parent1)); + + testRepo.reset(parent2); + PushOneCommit.Result newParent2 = + createChange("new parent 2", "p2-2.txt", "content 2-2", testRepo, user); + + PushOneCommit merge = pushFactory.create(user.newIdent(), testRepo, changeId); + merge.setParents(ImmutableList.of(commitParent1, newParent2.getCommit())); + PushOneCommit.Result result = merge.to("refs/for/master"); + result.assertOkStatus(); + + assertThat(getChangeKind(changeId)).isEqualTo(ChangeKind.REWORK); + } + + private void noCodeChange( + String changeId, TestRepository<InMemoryRepository> testRepo, TestAccount user) + throws Exception { + TestRepository<?>.CommitBuilder commitBuilder = + testRepo.amendRef("HEAD").insertChangeId(changeId.substring(1)); + commitBuilder + .message("New subject " + System.nanoTime()) + .author(user.newIdent()) + .committer(new PersonIdent(user.newIdent(), testRepo.getDate())); + commitBuilder.create(); + GitUtil.pushHead(testRepo, "refs/for/master", false); + assertThat(getChangeKind(changeId)).isEqualTo(ChangeKind.NO_CODE_CHANGE); + } + + private void noChange( + String changeId, TestRepository<InMemoryRepository> testRepo, TestAccount user) + throws Exception { + ChangeInfo change = gApi.changes().id(changeId).get(); + String commitMessage = change.revisions.get(change.currentRevision).commit.message; + + TestRepository<?>.CommitBuilder commitBuilder = + testRepo.amendRef("HEAD").insertChangeId(changeId.substring(1)); + commitBuilder + .message(commitMessage) + .author(user.newIdent()) + .committer(new PersonIdent(user.newIdent(), testRepo.getDate())); + commitBuilder.create(); + GitUtil.pushHead(testRepo, "refs/for/master", false); + assertThat(getChangeKind(changeId)).isEqualTo(ChangeKind.NO_CHANGE); + } + + private void rework( + String changeId, TestRepository<InMemoryRepository> testRepo, TestAccount user) + throws Exception { + PushOneCommit push = + pushFactory.create( + user.newIdent(), + testRepo, + PushOneCommit.SUBJECT, + PushOneCommit.FILE_NAME, + "new content " + System.nanoTime(), + changeId); + push.to("refs/for/master").assertOkStatus(); + assertThat(getChangeKind(changeId)).isEqualTo(ChangeKind.REWORK); + } + + private void trivialRebase( + String changeId, + TestRepository<InMemoryRepository> testRepo, + TestAccount user, + Project.NameKey project) + throws Exception { + requestScopeOperations.setApiUser(user.id()); + testRepo.reset(projectOperations.project(project).getHead("master")); + PushOneCommit push = + pushFactory.create( + user.newIdent(), + testRepo, + "Other Change", + "a" + System.nanoTime() + ".txt", + PushOneCommit.FILE_CONTENT); + PushOneCommit.Result r = push.to("refs/for/master"); + r.assertOkStatus(); + RevisionApi revision = gApi.changes().id(r.getChangeId()).current(); + ReviewInput in = new ReviewInput().label(LabelId.CODE_REVIEW, 2).label(LabelId.VERIFIED, 1); + revision.review(in); + revision.submit(); + + gApi.changes().id(changeId).current().rebase(); + assertThat(getChangeKind(changeId)).isEqualTo(ChangeKind.TRIVIAL_REBASE); + } + + private ChangeKind getChangeKind(String changeId) throws Exception { + ChangeInfo c = gApi.changes().id(changeId).get(ListChangesOption.CURRENT_REVISION); + return c.revisions.get(c.currentRevision).kind; + } + + private PushOneCommit.Result createChange( + TestRepository<InMemoryRepository> testRepo, TestAccount user) throws Exception { + PushOneCommit push = pushFactory.create(user.newIdent(), testRepo); + PushOneCommit.Result result = push.to("refs/for/master"); + result.assertOkStatus(); + return result; + } + + private ChangeInfo detailedChange(String changeId) throws Exception { + return gApi.changes() + .id(changeId) + .get( + ListChangesOption.DETAILED_LABELS, + ListChangesOption.CURRENT_REVISION, + ListChangesOption.CURRENT_COMMIT); + } + + private PushOneCommit.Result createChange( + String subject, + String fileName, + String content, + TestRepository<InMemoryRepository> testRepo, + TestAccount user) + throws Exception { + PushOneCommit push = pushFactory.create(user.newIdent(), testRepo, subject, fileName, content); + return push.to("refs/for/master"); + } + + private void vote(TestAccount user, String changeId, int codeReviewVote, int verifiedVote) + throws Exception { + requestScopeOperations.setApiUser(user.id()); + ReviewInput in = + new ReviewInput() + .label(LabelId.CODE_REVIEW, codeReviewVote) + .label(LabelId.VERIFIED, verifiedVote); + gApi.changes().id(changeId).current().review(in); + } + + private void merge(PushOneCommit.Result r) throws Exception { + gApi.changes().id(r.getChangeId()).current().review(ReviewInput.approve()); + gApi.changes().id(r.getChangeId()).current().submit(); + } +}
diff --git a/java/com/google/gerrit/acceptance/testsuite/group/BUILD b/java/com/google/gerrit/acceptance/testsuite/group/BUILD new file mode 100644 index 0000000..d4f1175 --- /dev/null +++ b/java/com/google/gerrit/acceptance/testsuite/group/BUILD
@@ -0,0 +1,25 @@ +load("@rules_java//java:defs.bzl", "java_library") + +package(default_testonly = 1) + +java_library( + name = "group", + srcs = glob(["*.java"]), + visibility = ["//visibility:public"], + deps = [ + "//java/com/google/gerrit/acceptance:function", + "//java/com/google/gerrit/common:annotations", + "//java/com/google/gerrit/common:server", + "//java/com/google/gerrit/entities", + "//java/com/google/gerrit/exceptions", + "//java/com/google/gerrit/extensions:api", + "//java/com/google/gerrit/server", + "//lib:guava", + "//lib:jgit", + "//lib:jgit-junit", + "//lib/auto:auto-value", + "//lib/auto:auto-value-annotations", + "//lib/commons:lang3", + "//lib/guice", + ], +)
diff --git a/java/com/google/gerrit/acceptance/testsuite/group/GroupOperationsImpl.java b/java/com/google/gerrit/acceptance/testsuite/group/GroupOperationsImpl.java index cde5134..dcf1158 100644 --- a/java/com/google/gerrit/acceptance/testsuite/group/GroupOperationsImpl.java +++ b/java/com/google/gerrit/acceptance/testsuite/group/GroupOperationsImpl.java
@@ -23,10 +23,10 @@ import com.google.gerrit.server.GerritPersonIdent; import com.google.gerrit.server.ServerInitiated; import com.google.gerrit.server.account.GroupUuid; +import com.google.gerrit.server.group.db.GroupDelta; import com.google.gerrit.server.group.db.Groups; import com.google.gerrit.server.group.db.GroupsUpdate; import com.google.gerrit.server.group.db.InternalGroupCreation; -import com.google.gerrit.server.group.db.InternalGroupUpdate; import com.google.gerrit.server.notedb.Sequences; import com.google.inject.Inject; import java.io.IOException; @@ -71,9 +71,8 @@ private AccountGroup.UUID createNewGroup(TestGroupCreation groupCreation) throws ConfigInvalidException, IOException { InternalGroupCreation internalGroupCreation = toInternalGroupCreation(groupCreation); - InternalGroupUpdate internalGroupUpdate = toInternalGroupUpdate(groupCreation); - InternalGroup internalGroup = - groupsUpdate.createGroup(internalGroupCreation, internalGroupUpdate); + GroupDelta groupDelta = toGroupDelta(groupCreation); + InternalGroup internalGroup = groupsUpdate.createGroup(internalGroupCreation, groupDelta); return internalGroup.getGroupUUID(); } @@ -89,8 +88,8 @@ .build(); } - private static InternalGroupUpdate toInternalGroupUpdate(TestGroupCreation groupCreation) { - InternalGroupUpdate.Builder builder = InternalGroupUpdate.builder(); + private static GroupDelta toGroupDelta(TestGroupCreation groupCreation) { + GroupDelta.Builder builder = GroupDelta.builder(); groupCreation.description().ifPresent(builder::setDescription); groupCreation.ownerGroupUuid().ifPresent(builder::setOwnerGroupUUID); groupCreation.visibleToAll().ifPresent(builder::setVisibleToAll); @@ -147,12 +146,12 @@ private void updateGroup(TestGroupUpdate groupUpdate) throws DuplicateKeyException, NoSuchGroupException, ConfigInvalidException, IOException { - InternalGroupUpdate internalGroupUpdate = toInternalGroupUpdate(groupUpdate); - groupsUpdate.updateGroup(groupUuid, internalGroupUpdate); + GroupDelta groupDelta = toGroupDelta(groupUpdate); + groupsUpdate.updateGroup(groupUuid, groupDelta); } - private InternalGroupUpdate toInternalGroupUpdate(TestGroupUpdate groupUpdate) { - InternalGroupUpdate.Builder builder = InternalGroupUpdate.builder(); + private GroupDelta toGroupDelta(TestGroupUpdate groupUpdate) { + GroupDelta.Builder builder = GroupDelta.builder(); groupUpdate.name().map(AccountGroup::nameKey).ifPresent(builder::setName); groupUpdate.description().ifPresent(builder::setDescription); groupUpdate.ownerGroupUuid().ifPresent(builder::setOwnerGroupUUID);
diff --git a/java/com/google/gerrit/acceptance/testsuite/project/ProjectOperations.java b/java/com/google/gerrit/acceptance/testsuite/project/ProjectOperations.java index 738be4d..2dd3f91 100644 --- a/java/com/google/gerrit/acceptance/testsuite/project/ProjectOperations.java +++ b/java/com/google/gerrit/acceptance/testsuite/project/ProjectOperations.java
@@ -81,11 +81,11 @@ * * <p>Example: * - * <pre> + * <pre>{@code * projectOperations.forInvalidation() * .addProjectConfigUpdater(cfg -> cfg.setString("invalidSection", null, "foo", "bar")) * .invalidate(); - * </pre> + * }</pre> * * <p><strong>Note:</strong> The invalidation will fail with an exception if the project to * invalidate doesn't exist.
diff --git a/java/com/google/gerrit/acceptance/testsuite/project/ProjectOperationsImpl.java b/java/com/google/gerrit/acceptance/testsuite/project/ProjectOperationsImpl.java index 394f0f8..18da4b3 100644 --- a/java/com/google/gerrit/acceptance/testsuite/project/ProjectOperationsImpl.java +++ b/java/com/google/gerrit/acceptance/testsuite/project/ProjectOperationsImpl.java
@@ -23,7 +23,6 @@ import com.google.common.base.Throwables; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; -import com.google.gerrit.acceptance.testsuite.project.TestProjectCreation.Builder; import com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.TestCapability; import com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.TestLabelPermission; import com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.TestPermission; @@ -81,7 +80,7 @@ } @Override - public Builder newProject() { + public TestProjectCreation.Builder newProject() { return TestProjectCreation.builder(this::createNewProject); }
diff --git a/java/com/google/gerrit/auth/BUILD b/java/com/google/gerrit/auth/BUILD index e844696..f04334d 100644 --- a/java/com/google/gerrit/auth/BUILD +++ b/java/com/google/gerrit/auth/BUILD
@@ -12,8 +12,6 @@ srcs = glob( ["**/*.java"], ), - resource_strip_prefix = "resources", - resources = ["//resources/com/google/gerrit/server"], visibility = ["//visibility:public"], deps = [ "//java/com/google/gerrit/common:annotations",
diff --git a/java/com/google/gerrit/auth/ldap/LdapRealm.java b/java/com/google/gerrit/auth/ldap/LdapRealm.java index 9305914..9a9f309 100644 --- a/java/com/google/gerrit/auth/ldap/LdapRealm.java +++ b/java/com/google/gerrit/auth/ldap/LdapRealm.java
@@ -32,6 +32,7 @@ import com.google.gerrit.server.account.EmailExpander; import com.google.gerrit.server.account.GroupBackends; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.auth.AuthenticationUnavailableException; import com.google.gerrit.server.auth.NoSuchUserException; @@ -346,10 +347,12 @@ static class UserLoader extends CacheLoader<String, Optional<Account.Id>> { private final ExternalIds externalIds; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject - UserLoader(ExternalIds externalIds) { + UserLoader(ExternalIds externalIds, ExternalIdKeyFactory externalIdKeyFactory) { this.externalIds = externalIds; + this.externalIdKeyFactory = externalIdKeyFactory; } @Override @@ -358,7 +361,7 @@ TraceContext.newTimer( "Loading account for username", Metadata.builder().username(username).build())) { return externalIds - .get(ExternalId.Key.create(SCHEME_GERRIT, username)) + .get(externalIdKeyFactory.create(SCHEME_GERRIT, username)) .map(ExternalId::accountId); } }
diff --git a/java/com/google/gerrit/common/PluginData.java b/java/com/google/gerrit/common/PluginData.java index c440de1..289d93a 100644 --- a/java/com/google/gerrit/common/PluginData.java +++ b/java/com/google/gerrit/common/PluginData.java
@@ -10,7 +10,7 @@ // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and -// limitations under the License.package com.google.gerrit.common; +// limitations under the License. package com.google.gerrit.common;
diff --git a/java/com/google/gerrit/common/data/GarbageCollectionResult.java b/java/com/google/gerrit/common/data/GarbageCollectionResult.java index 5e3601e..b995979 100644 --- a/java/com/google/gerrit/common/data/GarbageCollectionResult.java +++ b/java/com/google/gerrit/common/data/GarbageCollectionResult.java
@@ -20,17 +20,17 @@ /** A list of errors occurred during GC. */ public class GarbageCollectionResult { - protected List<Error> errors; + protected List<GcError> errors; public GarbageCollectionResult() { errors = new ArrayList<>(); } - public void addError(Error e) { + public void addError(GcError e) { errors.add(e); } - public List<Error> getErrors() { + public List<GcError> getErrors() { return errors; } @@ -38,7 +38,7 @@ return !errors.isEmpty(); } - public static class Error { + public static class GcError { public enum Type { /** Git garbage collection was already scheduled for this project */ GC_ALREADY_SCHEDULED, @@ -53,9 +53,9 @@ protected Type type; protected Project.NameKey projectName; - protected Error() {} + protected GcError() {} - public Error(Type type, Project.NameKey projectName) { + public GcError(Type type, Project.NameKey projectName) { this.type = type; this.projectName = projectName; }
diff --git a/java/com/google/gerrit/common/data/GitwebType.java b/java/com/google/gerrit/common/data/GitwebType.java index 9cc408b..e69eacf 100644 --- a/java/com/google/gerrit/common/data/GitwebType.java +++ b/java/com/google/gerrit/common/data/GitwebType.java
@@ -29,7 +29,7 @@ private char pathSeparator = '/'; private boolean urlEncode = true; - /** @return name displayed in links. */ + /** Returns name displayed in links. */ public String getLinkName() { return name; } @@ -43,7 +43,7 @@ this.name = name; } - /** @return parameterized string for the branch URL. */ + /** Returns parameterized string for the branch URL. */ public String getBranch() { return branch; } @@ -57,7 +57,7 @@ branch = str; } - /** @return parameterized string for the tag URL. */ + /** Returns parameterized string for the tag URL. */ public String getTag() { return tag; } @@ -71,7 +71,7 @@ tag = str; } - /** @return parameterized string for the file URL. */ + /** Returns parameterized string for the file URL. */ public String getFile() { return file; } @@ -85,7 +85,7 @@ file = str; } - /** @return parameterized string for the file history URL. */ + /** Returns parameterized string for the file history URL. */ public String getFileHistory() { return fileHistory; } @@ -99,7 +99,7 @@ fileHistory = str; } - /** @return parameterized string for the project URL. */ + /** Returns parameterized string for the project URL. */ public String getProject() { return project; } @@ -113,7 +113,7 @@ project = str; } - /** @return parameterized string for the revision URL. */ + /** Returns parameterized string for the revision URL. */ public String getRevision() { return revision; } @@ -127,7 +127,7 @@ revision = str; } - /** @return parameterized string for the root tree URL. */ + /** Returns parameterized string for the root tree URL. */ public String getRootTree() { return rootTree; } @@ -141,7 +141,7 @@ rootTree = str; } - /** @return path separator used for branch and project names. */ + /** Returns path separator used for branch and project names. */ public char getPathSeparator() { return pathSeparator; } @@ -155,7 +155,7 @@ this.pathSeparator = separator; } - /** @return whether to URL encode path segments. */ + /** Returns whether to URL encode path segments. */ public boolean getUrlEncode() { return urlEncode; }
diff --git a/java/com/google/gerrit/common/data/GlobalCapability.java b/java/com/google/gerrit/common/data/GlobalCapability.java index 51d9ecd..253266d 100644 --- a/java/com/google/gerrit/common/data/GlobalCapability.java +++ b/java/com/google/gerrit/common/data/GlobalCapability.java
@@ -109,6 +109,9 @@ /** Can perform streaming of Gerrit events. */ public static final String STREAM_EVENTS = "streamEvents"; + /** Can query permissions for any (project, user) pair */ + public static final String VIEW_ACCESS = "viewAccess"; + /** Can view all accounts, regardless of {@code accounts.visibility}. */ public static final String VIEW_ALL_ACCOUNTS = "viewAllAccounts"; @@ -124,9 +127,6 @@ /** Can view all pending tasks in the queue (not just the filtered set). */ public static final String VIEW_QUEUE = "viewQueue"; - /** Can query permissions for any (project, user) pair */ - public static final String VIEW_ACCESS = "viewAccess"; - private static final List<String> NAMES_ALL; private static final List<String> NAMES_LC; private static final String[] RANGE_NAMES = { @@ -152,12 +152,12 @@ NAMES_ALL.add(RUN_AS); NAMES_ALL.add(RUN_GC); NAMES_ALL.add(STREAM_EVENTS); + NAMES_ALL.add(VIEW_ACCESS); NAMES_ALL.add(VIEW_ALL_ACCOUNTS); NAMES_ALL.add(VIEW_CACHES); NAMES_ALL.add(VIEW_CONNECTIONS); NAMES_ALL.add(VIEW_PLUGINS); NAMES_ALL.add(VIEW_QUEUE); - NAMES_ALL.add(VIEW_ACCESS); NAMES_LC = new ArrayList<>(NAMES_ALL.size()); for (String name : NAMES_ALL) { @@ -165,17 +165,17 @@ } } - /** @return all valid capability names. */ + /** Returns all valid capability names. */ public static Collection<String> getAllNames() { return Collections.unmodifiableList(NAMES_ALL); } - /** @return true if the name is recognized as a capability name. */ + /** Returns true if the name is recognized as a capability name. */ public static boolean isGlobalCapability(String varName) { return NAMES_LC.contains(varName.toLowerCase()); } - /** @return true if the capability should have a range attached. */ + /** Returns true if the capability should have a range attached. */ public static boolean hasRange(String varName) { for (String n : RANGE_NAMES) { if (n.equalsIgnoreCase(varName)) { @@ -189,7 +189,7 @@ return Collections.unmodifiableList(Arrays.asList(RANGE_NAMES)); } - /** @return the valid range for the capability if it has one, otherwise null. */ + /** Returns the valid range for the capability if it has one, otherwise null. */ public static PermissionRange.WithDefaults getRange(String varName) { if (QUERY_LIMIT.equalsIgnoreCase(varName)) { return new PermissionRange.WithDefaults(
diff --git a/java/com/google/gerrit/elasticsearch/AbstractElasticIndex.java b/java/com/google/gerrit/elasticsearch/AbstractElasticIndex.java deleted file mode 100644 index 187c83b..0000000 --- a/java/com/google/gerrit/elasticsearch/AbstractElasticIndex.java +++ /dev/null
@@ -1,435 +0,0 @@ -// Copyright (C) 2014 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import static com.google.common.base.Preconditions.checkArgument; -import static com.google.common.collect.ImmutableList.toImmutableList; -import static com.google.gson.FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES; -import static java.nio.charset.StandardCharsets.UTF_8; - -import com.google.common.collect.ArrayListMultimap; -import com.google.common.collect.ImmutableList; -import com.google.common.collect.ImmutableMap; -import com.google.common.collect.ListMultimap; -import com.google.common.collect.Lists; -import com.google.common.collect.Streams; -import com.google.common.flogger.FluentLogger; -import com.google.common.io.BaseEncoding; -import com.google.common.io.CharStreams; -import com.google.gerrit.common.Nullable; -import com.google.gerrit.elasticsearch.ElasticMapping.MappingProperties; -import com.google.gerrit.elasticsearch.builders.QueryBuilder; -import com.google.gerrit.elasticsearch.builders.SearchSourceBuilder; -import com.google.gerrit.elasticsearch.bulk.DeleteRequest; -import com.google.gerrit.entities.converter.ProtoConverter; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.FieldDef; -import com.google.gerrit.index.FieldType; -import com.google.gerrit.index.Index; -import com.google.gerrit.index.QueryOptions; -import com.google.gerrit.index.Schema; -import com.google.gerrit.index.query.DataSource; -import com.google.gerrit.index.query.FieldBundle; -import com.google.gerrit.index.query.HasCardinality; -import com.google.gerrit.index.query.ListResultSet; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.index.query.ResultSet; -import com.google.gerrit.proto.Protos; -import com.google.gerrit.server.config.SitePaths; -import com.google.gerrit.server.index.IndexUtils; -import com.google.gson.Gson; -import com.google.gson.GsonBuilder; -import com.google.gson.JsonArray; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.gson.JsonParser; -import com.google.protobuf.MessageLite; -import java.io.IOException; -import java.io.InputStream; -import java.io.InputStreamReader; -import java.io.Reader; -import java.io.UnsupportedEncodingException; -import java.net.URLEncoder; -import java.sql.Timestamp; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Set; -import java.util.function.Function; -import org.apache.http.HttpEntity; -import org.apache.http.HttpStatus; -import org.apache.http.StatusLine; -import org.apache.http.client.methods.HttpPost; -import org.apache.http.entity.ContentType; -import org.apache.http.nio.entity.NStringEntity; -import org.elasticsearch.client.Request; -import org.elasticsearch.client.Response; - -abstract class AbstractElasticIndex<K, V> implements Index<K, V> { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - protected static final String BULK = "_bulk"; - protected static final String MAPPINGS = "mappings"; - protected static final String ORDER = "order"; - protected static final String DESC_SORT_ORDER = "desc"; - protected static final String ASC_SORT_ORDER = "asc"; - protected static final String UNMAPPED_TYPE = "unmapped_type"; - protected static final String SEARCH = "_search"; - protected static final String SETTINGS = "settings"; - - protected static byte[] decodeBase64(String base64String) { - return BaseEncoding.base64().decode(base64String); - } - - protected static <T> List<T> decodeProtos( - JsonObject doc, String fieldName, ProtoConverter<?, T> converter) { - JsonArray field = doc.getAsJsonArray(fieldName); - if (field == null) { - return null; - } - return Streams.stream(field) - .map(JsonElement::getAsString) - .map(AbstractElasticIndex::decodeBase64) - .map(bytes -> parseProtoFrom(bytes, converter)) - .collect(toImmutableList()); - } - - protected static <P extends MessageLite, T> T parseProtoFrom( - byte[] bytes, ProtoConverter<P, T> converter) { - P message = Protos.parseUnchecked(converter.getParser(), bytes); - return converter.fromProto(message); - } - - static String getContent(Response response) throws IOException { - HttpEntity responseEntity = response.getEntity(); - String content = ""; - if (responseEntity != null) { - InputStream contentStream = responseEntity.getContent(); - try (Reader reader = new InputStreamReader(contentStream, UTF_8)) { - content = CharStreams.toString(reader); - } - } - return content; - } - - private final ElasticConfiguration config; - private final Schema<V> schema; - private final SitePaths sitePaths; - private final String indexNameRaw; - - protected final ElasticRestClientProvider client; - protected final String indexName; - protected final Gson gson; - protected final ElasticQueryBuilder queryBuilder; - - AbstractElasticIndex( - ElasticConfiguration config, - SitePaths sitePaths, - Schema<V> schema, - ElasticRestClientProvider client, - String indexName) { - this.config = config; - this.sitePaths = sitePaths; - this.schema = schema; - this.gson = new GsonBuilder().setFieldNamingPolicy(LOWER_CASE_WITH_UNDERSCORES).create(); - this.queryBuilder = new ElasticQueryBuilder(); - this.indexName = config.getIndexName(indexName, schema.getVersion()); - this.indexNameRaw = indexName; - this.client = client; - } - - @Override - public Schema<V> getSchema() { - return schema; - } - - @Override - public void close() { - // Do nothing. Client is closed by the provider. - } - - @Override - public void markReady(boolean ready) { - IndexUtils.setReady(sitePaths, indexNameRaw, schema.getVersion(), ready); - } - - @Override - public void delete(K id) { - String uri = getURI(BULK); - Response response = postRequest(uri, getDeleteActions(id), getRefreshParam()); - int statusCode = response.getStatusLine().getStatusCode(); - if (statusCode != HttpStatus.SC_OK) { - throw new StorageException( - String.format("Failed to delete %s from index %s: %s", id, indexName, statusCode)); - } - } - - @Override - public void insert(V obj) { - // TODO: Implement real insert() if it helps performance - replace(obj); - } - - @Override - public void deleteAll() { - // Delete the index, if it exists. - String endpoint = indexName + client.adapter().indicesExistParams(); - Response response = performRequest("HEAD", endpoint); - int statusCode = response.getStatusLine().getStatusCode(); - if (statusCode == HttpStatus.SC_OK) { - response = performRequest("DELETE", indexName); - statusCode = response.getStatusLine().getStatusCode(); - if (statusCode != HttpStatus.SC_OK) { - throw new StorageException( - String.format("Failed to delete index %s: %s", indexName, statusCode)); - } - } - - // Recreate the index. - String indexCreationFields = concatJsonString(getSettings(), getMappings()); - response = performRequest("PUT", indexName, indexCreationFields); - statusCode = response.getStatusLine().getStatusCode(); - if (statusCode != HttpStatus.SC_OK) { - String error = String.format("Failed to create index %s: %s", indexName, statusCode); - throw new StorageException(error); - } - } - - protected abstract String getDeleteActions(K id); - - protected abstract String getMappings(); - - private String getSettings() { - return gson.toJson(ImmutableMap.of(SETTINGS, ElasticSetting.createSetting(config))); - } - - protected abstract String getId(V v); - - protected String getMappingsForSingleType(MappingProperties properties) { - return getMappingsFor(properties); - } - - protected String getMappingsFor(MappingProperties properties) { - JsonObject mappings = new JsonObject(); - - mappings.add(MAPPINGS, gson.toJsonTree(properties)); - return gson.toJson(mappings); - } - - protected String getDeleteRequest(K id) { - return new DeleteRequest(id.toString(), indexName).toString(); - } - - protected abstract V fromDocument(JsonObject doc, Set<String> fields); - - protected FieldBundle toFieldBundle(JsonObject doc) { - Map<String, FieldDef<V, ?>> allFields = getSchema().getFields(); - ListMultimap<String, Object> rawFields = ArrayListMultimap.create(); - for (Map.Entry<String, JsonElement> element : - doc.get(client.adapter().rawFieldsKey()).getAsJsonObject().entrySet()) { - checkArgument( - allFields.containsKey(element.getKey()), "Unrecognized field " + element.getKey()); - FieldType<?> type = allFields.get(element.getKey()).getType(); - Iterable<JsonElement> innerItems = - element.getValue().isJsonArray() - ? element.getValue().getAsJsonArray() - : Collections.singleton(element.getValue()); - for (JsonElement inner : innerItems) { - if (type == FieldType.EXACT || type == FieldType.FULL_TEXT || type == FieldType.PREFIX) { - rawFields.put(element.getKey(), inner.getAsString()); - } else if (type == FieldType.INTEGER || type == FieldType.INTEGER_RANGE) { - rawFields.put(element.getKey(), inner.getAsInt()); - } else if (type == FieldType.LONG) { - rawFields.put(element.getKey(), inner.getAsLong()); - } else if (type == FieldType.TIMESTAMP) { - rawFields.put(element.getKey(), new Timestamp(inner.getAsLong())); - } else if (type == FieldType.STORED_ONLY) { - rawFields.put(element.getKey(), decodeBase64(inner.getAsString())); - } else { - throw FieldType.badFieldType(type); - } - } - } - return new FieldBundle(rawFields); - } - - protected String toAction(String type, String id, String action) { - JsonObject properties = new JsonObject(); - properties.addProperty("_id", id); - properties.addProperty("_index", indexName); - properties.addProperty("_type", type); - - JsonObject jsonAction = new JsonObject(); - jsonAction.add(action, properties); - return jsonAction.toString() + System.lineSeparator(); - } - - protected void addNamedElement(String name, JsonObject element, JsonArray array) { - JsonObject arrayElement = new JsonObject(); - arrayElement.add(name, element); - array.add(arrayElement); - } - - protected Map<String, String> getRefreshParam() { - Map<String, String> params = new HashMap<>(); - params.put("refresh", "true"); - return params; - } - - protected String getSearch(SearchSourceBuilder searchSource, JsonArray sortArray) { - JsonObject search = new JsonParser().parse(searchSource.toString()).getAsJsonObject(); - search.add("sort", sortArray); - return gson.toJson(search); - } - - protected JsonArray getSortArray(String idFieldName) { - JsonObject properties = new JsonObject(); - properties.addProperty(ORDER, ASC_SORT_ORDER); - - JsonArray sortArray = new JsonArray(); - addNamedElement(idFieldName, properties, sortArray); - return sortArray; - } - - protected String getURI(String request) { - try { - return URLEncoder.encode(indexName, UTF_8.toString()) + "/" + request; - } catch (UnsupportedEncodingException e) { - throw new StorageException(e); - } - } - - protected Response postRequest(String uri, Object payload) { - return performRequest("POST", uri, payload); - } - - protected Response postRequest(String uri, Object payload, Map<String, String> params) { - return performRequest("POST", uri, payload, params); - } - - private String concatJsonString(String target, String addition) { - return target.substring(0, target.length() - 1) + "," + addition.substring(1); - } - - private Response performRequest(String method, String uri) { - return performRequest(method, uri, null); - } - - private Response performRequest(String method, String uri, @Nullable Object payload) { - return performRequest(method, uri, payload, Collections.emptyMap()); - } - - private Response performRequest( - String method, String uri, @Nullable Object payload, Map<String, String> params) { - Request request = new Request(method, uri.startsWith("/") ? uri : "/" + uri); - if (payload != null) { - String payloadStr = payload instanceof String ? (String) payload : payload.toString(); - request.setEntity(new NStringEntity(payloadStr, ContentType.APPLICATION_JSON)); - } - for (Map.Entry<String, String> entry : params.entrySet()) { - request.addParameter(entry.getKey(), entry.getValue()); - } - try { - return client.get().performRequest(request); - } catch (IOException e) { - throw new StorageException(e); - } - } - - protected class ElasticQuerySource implements DataSource<V> { - private final QueryOptions opts; - private final Predicate<V> predicate; - private final String search; - - ElasticQuerySource(Predicate<V> p, QueryOptions opts, JsonArray sortArray) - throws QueryParseException { - this.opts = opts; - this.predicate = p; - QueryBuilder qb = queryBuilder.toQueryBuilder(p); - SearchSourceBuilder searchSource = - new SearchSourceBuilder(client.adapter()) - .query(qb) - .size(opts.pageSize()) - .fields(Lists.newArrayList(opts.fields())); - searchSource = - opts.searchAfter() != null - ? searchSource.searchAfter((JsonArray) opts.searchAfter()).trackTotalHits(false) - : searchSource.from(opts.start()); - search = getSearch(searchSource, sortArray); - } - - @Override - public int getCardinality() { - if (predicate instanceof HasCardinality) { - return ((HasCardinality) predicate).getCardinality(); - } - return 10; - } - - @Override - public ResultSet<V> read() { - return readImpl(doc -> AbstractElasticIndex.this.fromDocument(doc, opts.fields())); - } - - @Override - public ResultSet<FieldBundle> readRaw() { - return readImpl(AbstractElasticIndex.this::toFieldBundle); - } - - private <T> ResultSet<T> readImpl(Function<JsonObject, T> mapper) { - try { - String uri = getURI(SEARCH); - JsonArray searchAfter = null; - Response response = - performRequest(HttpPost.METHOD_NAME, uri, search, Collections.emptyMap()); - StatusLine statusLine = response.getStatusLine(); - if (statusLine.getStatusCode() == HttpStatus.SC_OK) { - String content = getContent(response); - JsonObject obj = - new JsonParser().parse(content).getAsJsonObject().getAsJsonObject("hits"); - if (obj.get("hits") != null) { - JsonArray json = obj.getAsJsonArray("hits"); - ImmutableList.Builder<T> results = ImmutableList.builderWithExpectedSize(json.size()); - JsonObject hit = null; - for (int i = 0; i < json.size(); i++) { - hit = json.get(i).getAsJsonObject(); - T mapperResult = mapper.apply(hit); - if (mapperResult != null) { - results.add(mapperResult); - } - } - if (hit != null && hit.get("sort") != null) { - searchAfter = hit.getAsJsonArray("sort"); - } - JsonArray finalSearchAfter = searchAfter; - return new ListResultSet<T>(results.build()) { - @Override - public Object searchAfter() { - return finalSearchAfter; - } - }; - } - } else { - logger.atSevere().log(statusLine.getReasonPhrase()); - } - return new ListResultSet<>(ImmutableList.of()); - } catch (IOException e) { - throw new StorageException(e); - } - } - } -}
diff --git a/java/com/google/gerrit/elasticsearch/BUILD b/java/com/google/gerrit/elasticsearch/BUILD deleted file mode 100644 index 8bab80b..0000000 --- a/java/com/google/gerrit/elasticsearch/BUILD +++ /dev/null
@@ -1,33 +0,0 @@ -load("@rules_java//java:defs.bzl", "java_library") - -java_library( - name = "elasticsearch", - srcs = glob(["**/*.java"]), - visibility = ["//visibility:public"], - deps = [ - "//java/com/google/gerrit/common:annotations", - "//java/com/google/gerrit/entities", - "//java/com/google/gerrit/exceptions", - "//java/com/google/gerrit/extensions:api", - "//java/com/google/gerrit/index", - "//java/com/google/gerrit/index:query_exception", - "//java/com/google/gerrit/index/project", - "//java/com/google/gerrit/lifecycle", - "//java/com/google/gerrit/proto", - "//java/com/google/gerrit/server", - "//lib:gson", - "//lib:guava", - "//lib:jgit", - "//lib:protobuf", - "//lib/commons:lang", - "//lib/elasticsearch-rest-client", - "//lib/flogger:api", - "//lib/guice", - "//lib/guice:guice-assistedinject", - "//lib/httpcomponents:httpasyncclient", - "//lib/httpcomponents:httpclient", - "//lib/httpcomponents:httpcore", - "//lib/httpcomponents:httpcore-nio", - "//lib/jackson:jackson-core", - ], -)
diff --git a/java/com/google/gerrit/elasticsearch/ElasticAccountIndex.java b/java/com/google/gerrit/elasticsearch/ElasticAccountIndex.java deleted file mode 100644 index 8967789..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticAccountIndex.java +++ /dev/null
@@ -1,143 +0,0 @@ -// Copyright (C) 2016 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.common.collect.ImmutableSet; -import com.google.gerrit.elasticsearch.ElasticMapping.MappingProperties; -import com.google.gerrit.elasticsearch.bulk.BulkRequest; -import com.google.gerrit.elasticsearch.bulk.IndexRequest; -import com.google.gerrit.elasticsearch.bulk.UpdateRequest; -import com.google.gerrit.entities.Account; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.QueryOptions; -import com.google.gerrit.index.Schema; -import com.google.gerrit.index.query.DataSource; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.server.account.AccountCache; -import com.google.gerrit.server.account.AccountState; -import com.google.gerrit.server.config.SitePaths; -import com.google.gerrit.server.index.IndexUtils; -import com.google.gerrit.server.index.account.AccountField; -import com.google.gerrit.server.index.account.AccountIndex; -import com.google.gson.JsonArray; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.inject.Inject; -import com.google.inject.Provider; -import com.google.inject.assistedinject.Assisted; -import java.util.Set; -import org.apache.http.HttpStatus; -import org.elasticsearch.client.Response; - -public class ElasticAccountIndex extends AbstractElasticIndex<Account.Id, AccountState> - implements AccountIndex { - static class AccountMapping { - final MappingProperties accounts; - - AccountMapping(Schema<AccountState> schema, ElasticQueryAdapter adapter) { - this.accounts = ElasticMapping.createMapping(schema, adapter); - } - } - - private static final String ACCOUNTS = "accounts"; - - private final AccountMapping mapping; - private final Provider<AccountCache> accountCache; - private final Schema<AccountState> schema; - - @Inject - ElasticAccountIndex( - ElasticConfiguration cfg, - SitePaths sitePaths, - Provider<AccountCache> accountCache, - ElasticRestClientProvider client, - @Assisted Schema<AccountState> schema) { - super(cfg, sitePaths, schema, client, ACCOUNTS); - this.accountCache = accountCache; - this.mapping = new AccountMapping(schema, client.adapter()); - this.schema = schema; - } - - @Override - public void replace(AccountState as) { - BulkRequest bulk = - new IndexRequest(getId(as), indexName) - .add(new UpdateRequest<>(schema, as, ImmutableSet.of())); - - String uri = getURI(BULK); - Response response = postRequest(uri, bulk, getRefreshParam()); - int statusCode = response.getStatusLine().getStatusCode(); - if (statusCode != HttpStatus.SC_OK) { - throw new StorageException( - String.format( - "Failed to replace account %s in index %s: %s", - as.account().id(), indexName, statusCode)); - } - } - - @Override - public DataSource<AccountState> getSource(Predicate<AccountState> p, QueryOptions opts) - throws QueryParseException { - JsonArray sortArray = - getSortArray( - schema.useLegacyNumericFields() - ? AccountField.ID.getName() - : AccountField.ID_STR.getName()); - return new ElasticQuerySource( - p, - opts.filterFields(o -> IndexUtils.accountFields(o, schema.useLegacyNumericFields())), - sortArray); - } - - @Override - protected String getDeleteActions(Account.Id a) { - return getDeleteRequest(a); - } - - @Override - protected String getMappings() { - return getMappingsForSingleType(mapping.accounts); - } - - @Override - protected String getId(AccountState as) { - return as.account().id().toString(); - } - - @Override - protected AccountState fromDocument(JsonObject json, Set<String> fields) { - JsonElement source = json.get("_source"); - if (source == null) { - source = json.getAsJsonObject().get("fields"); - } - - Account.Id id = - Account.id( - source - .getAsJsonObject() - .get( - schema.useLegacyNumericFields() - ? AccountField.ID.getName() - : AccountField.ID_STR.getName()) - .getAsInt()); - // Use the AccountCache rather than depending on any stored fields in the document (of which - // there shouldn't be any). The most expensive part to compute anyway is the effective group - // IDs, and we don't have a good way to reindex when those change. - // If the account doesn't exist return an empty AccountState to represent the missing account - // to account the fact that the account exists in the index. - return accountCache.get().getEvenIfMissing(id); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticChangeIndex.java b/java/com/google/gerrit/elasticsearch/ElasticChangeIndex.java deleted file mode 100644 index 162654d..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticChangeIndex.java +++ /dev/null
@@ -1,431 +0,0 @@ -// Copyright (C) 2014 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import static java.nio.charset.StandardCharsets.UTF_8; -import static java.util.Objects.requireNonNull; - -import com.google.common.collect.FluentIterable; -import com.google.common.collect.ImmutableListMultimap; -import com.google.common.collect.ImmutableSet; -import com.google.common.collect.Iterables; -import com.google.common.collect.ListMultimap; -import com.google.common.collect.MultimapBuilder; -import com.google.common.collect.Sets; -import com.google.gerrit.elasticsearch.ElasticMapping.MappingProperties; -import com.google.gerrit.elasticsearch.bulk.BulkRequest; -import com.google.gerrit.elasticsearch.bulk.IndexRequest; -import com.google.gerrit.elasticsearch.bulk.UpdateRequest; -import com.google.gerrit.entities.Account; -import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.Project; -import com.google.gerrit.entities.converter.ChangeProtoConverter; -import com.google.gerrit.entities.converter.PatchSetApprovalProtoConverter; -import com.google.gerrit.entities.converter.PatchSetProtoConverter; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.FieldDef; -import com.google.gerrit.index.QueryOptions; -import com.google.gerrit.index.RefState; -import com.google.gerrit.index.Schema; -import com.google.gerrit.index.query.DataSource; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.server.ReviewerByEmailSet; -import com.google.gerrit.server.ReviewerSet; -import com.google.gerrit.server.StarredChangesUtil; -import com.google.gerrit.server.change.MergeabilityComputationBehavior; -import com.google.gerrit.server.config.GerritServerConfig; -import com.google.gerrit.server.config.SitePaths; -import com.google.gerrit.server.index.IndexUtils; -import com.google.gerrit.server.index.change.ChangeField; -import com.google.gerrit.server.index.change.ChangeIndex; -import com.google.gerrit.server.project.SubmitRuleOptions; -import com.google.gerrit.server.query.change.ChangeData; -import com.google.gson.JsonArray; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.inject.Inject; -import com.google.inject.assistedinject.Assisted; -import java.sql.Timestamp; -import java.time.Instant; -import java.time.format.DateTimeFormatter; -import java.util.Collections; -import java.util.Optional; -import java.util.Set; -import org.apache.http.HttpStatus; -import org.eclipse.jgit.lib.Config; -import org.elasticsearch.client.Response; - -/** Secondary index implementation using Elasticsearch. */ -class ElasticChangeIndex extends AbstractElasticIndex<Change.Id, ChangeData> - implements ChangeIndex { - static class ChangeMapping { - final MappingProperties changes; - final MappingProperties openChanges; - final MappingProperties closedChanges; - - ChangeMapping(Schema<ChangeData> schema, ElasticQueryAdapter adapter) { - MappingProperties mapping = ElasticMapping.createMapping(schema, adapter); - this.changes = mapping; - this.openChanges = mapping; - this.closedChanges = mapping; - } - } - - private static final String CHANGES = "changes"; - - private final ChangeMapping mapping; - private final ChangeData.Factory changeDataFactory; - private final Schema<ChangeData> schema; - private final FieldDef<ChangeData, ?> idField; - private final ImmutableSet<String> skipFields; - - @Inject - ElasticChangeIndex( - ElasticConfiguration cfg, - ChangeData.Factory changeDataFactory, - SitePaths sitePaths, - ElasticRestClientProvider clientBuilder, - @GerritServerConfig Config gerritConfig, - @Assisted Schema<ChangeData> schema) { - super(cfg, sitePaths, schema, clientBuilder, CHANGES); - this.changeDataFactory = changeDataFactory; - this.schema = schema; - this.mapping = new ChangeMapping(schema, client.adapter()); - this.idField = - this.schema.useLegacyNumericFields() ? ChangeField.LEGACY_ID : ChangeField.LEGACY_ID_STR; - this.skipFields = - MergeabilityComputationBehavior.fromConfig(gerritConfig).includeInIndex() - ? ImmutableSet.of() - : ImmutableSet.of(ChangeField.MERGEABLE.getName()); - } - - @Override - public void replace(ChangeData cd) { - BulkRequest bulk = - new IndexRequest(getId(cd), indexName).add(new UpdateRequest<>(schema, cd, skipFields)); - - String uri = getURI(BULK); - Response response = postRequest(uri, bulk, getRefreshParam()); - int statusCode = response.getStatusLine().getStatusCode(); - if (statusCode != HttpStatus.SC_OK) { - throw new StorageException( - String.format( - "Failed to replace change %s in index %s: %s", cd.getId(), indexName, statusCode)); - } - } - - @Override - public DataSource<ChangeData> getSource(Predicate<ChangeData> p, QueryOptions opts) - throws QueryParseException { - QueryOptions filteredOpts = - opts.filterFields(o -> IndexUtils.changeFields(o, schema.useLegacyNumericFields())); - return new ElasticQuerySource(p, filteredOpts, getSortArray()); - } - - private JsonArray getSortArray() { - JsonObject properties = new JsonObject(); - properties.addProperty(ORDER, DESC_SORT_ORDER); - - JsonArray sortArray = new JsonArray(); - addNamedElement(ChangeField.UPDATED.getName(), properties, sortArray); - addNamedElement(ChangeField.MERGED_ON.getName(), getMergedOnSortOptions(), sortArray); - addNamedElement(idField.getName(), properties, sortArray); - return sortArray; - } - - private JsonObject getMergedOnSortOptions() { - JsonObject sortOptions = new JsonObject(); - sortOptions.addProperty(ORDER, DESC_SORT_ORDER); - // Ignore the sort field if it does not exist in index. Otherwise the search would fail on open - // changes, because the corresponding documents do not have mergedOn field. - sortOptions.addProperty(UNMAPPED_TYPE, ElasticMapping.TIMESTAMP_FIELD_TYPE); - return sortOptions; - } - - @Override - protected String getDeleteActions(Change.Id c) { - return getDeleteRequest(c); - } - - @Override - protected String getMappings() { - return getMappingsFor(mapping.changes); - } - - @Override - protected String getId(ChangeData cd) { - return cd.getId().toString(); - } - - @Override - protected ChangeData fromDocument(JsonObject json, Set<String> fields) { - JsonElement sourceElement = json.get("_source"); - if (sourceElement == null) { - sourceElement = json.getAsJsonObject().get("fields"); - } - JsonObject source = sourceElement.getAsJsonObject(); - JsonElement c = source.get(ChangeField.CHANGE.getName()); - - if (c == null) { - int id = source.get(idField.getName()).getAsInt(); - // IndexUtils#changeFields ensures either CHANGE or PROJECT is always present. - String projectName = requireNonNull(source.get(ChangeField.PROJECT.getName()).getAsString()); - return changeDataFactory.create(Project.nameKey(projectName), Change.id(id)); - } - - ChangeData cd = - changeDataFactory.create( - parseProtoFrom(decodeBase64(c.getAsString()), ChangeProtoConverter.INSTANCE)); - - // Any decoding that is done here must also be done in {@link LuceneChangeIndex}. - - // Patch sets. - cd.setPatchSets( - decodeProtos(source, ChangeField.PATCH_SET.getName(), PatchSetProtoConverter.INSTANCE)); - - // Approvals. - if (source.get(ChangeField.APPROVAL.getName()) != null) { - cd.setCurrentApprovals( - decodeProtos( - source, ChangeField.APPROVAL.getName(), PatchSetApprovalProtoConverter.INSTANCE)); - } else if (fields.contains(ChangeField.APPROVAL.getName())) { - cd.setCurrentApprovals(Collections.emptyList()); - } - - // Added & Deleted. - JsonElement addedElement = source.get(ChangeField.ADDED.getName()); - JsonElement deletedElement = source.get(ChangeField.DELETED.getName()); - if (addedElement != null && deletedElement != null) { - // Changed lines. - int added = addedElement.getAsInt(); - int deleted = deletedElement.getAsInt(); - cd.setChangedLines(added, deleted); - } - - // Star. - JsonElement starredElement = source.get(ChangeField.STAR.getName()); - if (starredElement != null) { - ListMultimap<Account.Id, String> stars = MultimapBuilder.hashKeys().arrayListValues().build(); - JsonArray starBy = starredElement.getAsJsonArray(); - if (starBy.size() > 0) { - for (int i = 0; i < starBy.size(); i++) { - String[] indexableFields = starBy.get(i).getAsString().split(":"); - Optional<Account.Id> id = Account.Id.tryParse(indexableFields[0]); - if (id.isPresent()) { - stars.put(id.get(), indexableFields[1]); - } - } - } - cd.setStars(stars); - } - - // Mergeable. - JsonElement mergeableElement = source.get(ChangeField.MERGEABLE.getName()); - if (mergeableElement != null && !skipFields.contains(ChangeField.MERGEABLE.getName())) { - String mergeable = mergeableElement.getAsString(); - if ("1".equals(mergeable)) { - cd.setMergeable(true); - } else if ("0".equals(mergeable)) { - cd.setMergeable(false); - } - } - - // Reviewed-by. - if (source.get(ChangeField.REVIEWEDBY.getName()) != null) { - JsonArray reviewedBy = source.get(ChangeField.REVIEWEDBY.getName()).getAsJsonArray(); - if (reviewedBy.size() > 0) { - Set<Account.Id> accounts = Sets.newHashSetWithExpectedSize(reviewedBy.size()); - for (int i = 0; i < reviewedBy.size(); i++) { - int aId = reviewedBy.get(i).getAsInt(); - if (reviewedBy.size() == 1 && aId == ChangeField.NOT_REVIEWED) { - break; - } - accounts.add(Account.id(aId)); - } - cd.setReviewedBy(accounts); - } - } else if (fields.contains(ChangeField.REVIEWEDBY.getName())) { - cd.setReviewedBy(Collections.emptySet()); - } - - // Hashtag. - if (source.get(ChangeField.HASHTAG.getName()) != null) { - JsonArray hashtagArray = source.get(ChangeField.HASHTAG.getName()).getAsJsonArray(); - if (hashtagArray.size() > 0) { - Set<String> hashtags = Sets.newHashSetWithExpectedSize(hashtagArray.size()); - for (int i = 0; i < hashtagArray.size(); i++) { - hashtags.add(hashtagArray.get(i).getAsString()); - } - cd.setHashtags(hashtags); - } - } else if (fields.contains(ChangeField.HASHTAG.getName())) { - cd.setHashtags(Collections.emptySet()); - } - - // Star. - if (source.get(ChangeField.STAR.getName()) != null) { - JsonArray starArray = source.get(ChangeField.STAR.getName()).getAsJsonArray(); - if (starArray.size() > 0) { - ListMultimap<Account.Id, String> stars = - MultimapBuilder.hashKeys().arrayListValues().build(); - for (int i = 0; i < starArray.size(); i++) { - StarredChangesUtil.StarField starField = - StarredChangesUtil.StarField.parse(starArray.get(i).getAsString()); - stars.put(starField.accountId(), starField.label()); - } - cd.setStars(stars); - } - } else if (fields.contains(ChangeField.STAR.getName())) { - cd.setStars(ImmutableListMultimap.of()); - } - - // Reviewer. - if (source.get(ChangeField.REVIEWER.getName()) != null) { - cd.setReviewers( - ChangeField.parseReviewerFieldValues( - cd.getId(), - FluentIterable.from(source.get(ChangeField.REVIEWER.getName()).getAsJsonArray()) - .transform(JsonElement::getAsString))); - } else if (fields.contains(ChangeField.REVIEWER.getName())) { - cd.setReviewers(ReviewerSet.empty()); - } - - // Reviewer-by-email. - if (source.get(ChangeField.REVIEWER_BY_EMAIL.getName()) != null) { - cd.setReviewersByEmail( - ChangeField.parseReviewerByEmailFieldValues( - cd.getId(), - FluentIterable.from( - source.get(ChangeField.REVIEWER_BY_EMAIL.getName()).getAsJsonArray()) - .transform(JsonElement::getAsString))); - } else if (fields.contains(ChangeField.REVIEWER_BY_EMAIL.getName())) { - cd.setReviewersByEmail(ReviewerByEmailSet.empty()); - } - - // Pending-reviewer. - if (source.get(ChangeField.PENDING_REVIEWER.getName()) != null) { - cd.setPendingReviewers( - ChangeField.parseReviewerFieldValues( - cd.getId(), - FluentIterable.from( - source.get(ChangeField.PENDING_REVIEWER.getName()).getAsJsonArray()) - .transform(JsonElement::getAsString))); - } else if (fields.contains(ChangeField.PENDING_REVIEWER.getName())) { - cd.setPendingReviewers(ReviewerSet.empty()); - } - - // Pending-reviewer-by-email. - if (source.get(ChangeField.PENDING_REVIEWER_BY_EMAIL.getName()) != null) { - cd.setPendingReviewersByEmail( - ChangeField.parseReviewerByEmailFieldValues( - cd.getId(), - FluentIterable.from( - source.get(ChangeField.PENDING_REVIEWER_BY_EMAIL.getName()).getAsJsonArray()) - .transform(JsonElement::getAsString))); - } else if (fields.contains(ChangeField.PENDING_REVIEWER_BY_EMAIL.getName())) { - cd.setPendingReviewersByEmail(ReviewerByEmailSet.empty()); - } - - // Stored-submit-record-strict. - decodeSubmitRecords( - source, - ChangeField.STORED_SUBMIT_RECORD_STRICT.getName(), - ChangeField.SUBMIT_RULE_OPTIONS_STRICT, - cd); - - // Stored-submit-record-lenient. - decodeSubmitRecords( - source, - ChangeField.STORED_SUBMIT_RECORD_LENIENT.getName(), - ChangeField.SUBMIT_RULE_OPTIONS_LENIENT, - cd); - - // Ref-state. - if (fields.contains(ChangeField.REF_STATE.getName())) { - cd.setRefStates(RefState.parseStates(getByteArray(source, ChangeField.REF_STATE.getName()))); - } - - // Ref-state-pattern. - if (fields.contains(ChangeField.REF_STATE_PATTERN.getName())) { - cd.setRefStatePatterns(getByteArray(source, ChangeField.REF_STATE_PATTERN.getName())); - } - - // Unresolved-comment-count. - decodeUnresolvedCommentCount(source, ChangeField.UNRESOLVED_COMMENT_COUNT.getName(), cd); - - // Attention set. - if (fields.contains(ChangeField.ATTENTION_SET_FULL.getName())) { - ChangeField.parseAttentionSet( - FluentIterable.from(source.getAsJsonArray(ChangeField.ATTENTION_SET_FULL.getName())) - .transform(ElasticChangeIndex::decodeBase64JsonElement) - .toSet(), - cd); - } - - if (fields.contains(ChangeField.MERGED_ON.getName())) { - decodeMergedOn(source, cd); - } - - return cd; - } - - private Iterable<byte[]> getByteArray(JsonObject source, String name) { - JsonElement element = source.get(name); - return element != null - ? Iterables.transform(element.getAsJsonArray(), e -> decodeBase64(e.getAsString())) - : Collections.emptyList(); - } - - private void decodeSubmitRecords( - JsonObject doc, String fieldName, SubmitRuleOptions opts, ChangeData out) { - JsonArray records = doc.getAsJsonArray(fieldName); - if (records == null) { - return; - } - ChangeField.parseSubmitRecords( - FluentIterable.from(records) - .transform(ElasticChangeIndex::decodeBase64JsonElement) - .toList(), - opts, - out); - } - - private static String decodeBase64JsonElement(JsonElement input) { - return new String(decodeBase64(input.getAsString()), UTF_8); - } - - private void decodeUnresolvedCommentCount(JsonObject doc, String fieldName, ChangeData out) { - JsonElement count = doc.get(fieldName); - if (count == null) { - return; - } - out.setUnresolvedCommentCount(count.getAsInt()); - } - - private void decodeMergedOn(JsonObject doc, ChangeData out) { - JsonElement mergedOnField = doc.get(ChangeField.MERGED_ON.getName()); - - Timestamp mergedOn = null; - if (mergedOnField != null) { - // Parse from ElasticMapping.TIMESTAMP_FIELD_FORMAT. - // We currently use built-in ISO-based dateOptionalTime. - // https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#built-in-date-formats - DateTimeFormatter isoFormatter = DateTimeFormatter.ISO_INSTANT; - mergedOn = Timestamp.from(Instant.from(isoFormatter.parse(mergedOnField.getAsString()))); - } - out.setMergedOn(mergedOn); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticConfiguration.java b/java/com/google/gerrit/elasticsearch/ElasticConfiguration.java deleted file mode 100644 index c443529..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticConfiguration.java +++ /dev/null
@@ -1,137 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import static com.google.common.base.MoreObjects.firstNonNull; - -import com.google.common.base.Strings; -import com.google.common.flogger.FluentLogger; -import com.google.gerrit.server.config.GerritServerConfig; -import com.google.inject.Inject; -import com.google.inject.ProvisionException; -import com.google.inject.Singleton; -import java.net.URI; -import java.net.URISyntaxException; -import java.util.ArrayList; -import java.util.List; -import java.util.concurrent.TimeUnit; -import org.apache.http.HttpHost; -import org.eclipse.jgit.lib.Config; -import org.elasticsearch.client.RestClientBuilder; - -@Singleton -class ElasticConfiguration { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - static final String SECTION_ELASTICSEARCH = "elasticsearch"; - static final String KEY_PASSWORD = "password"; - static final String KEY_USERNAME = "username"; - static final String KEY_PREFIX = "prefix"; - static final String KEY_SERVER = "server"; - static final String KEY_NUMBER_OF_SHARDS = "numberOfShards"; - static final String KEY_NUMBER_OF_REPLICAS = "numberOfReplicas"; - static final String KEY_MAX_RESULT_WINDOW = "maxResultWindow"; - static final String KEY_CONNECT_TIMEOUT = "connectTimeout"; - static final String KEY_SOCKET_TIMEOUT = "socketTimeout"; - - static final String DEFAULT_PORT = "9200"; - static final String DEFAULT_USERNAME = "elastic"; - static final int DEFAULT_NUMBER_OF_SHARDS = 1; - static final int DEFAULT_NUMBER_OF_REPLICAS = 1; - static final int DEFAULT_MAX_RESULT_WINDOW = 10000; - static final int DEFAULT_CONNECT_TIMEOUT = RestClientBuilder.DEFAULT_CONNECT_TIMEOUT_MILLIS; - static final int DEFAULT_SOCKET_TIMEOUT = RestClientBuilder.DEFAULT_SOCKET_TIMEOUT_MILLIS; - - private final Config cfg; - private final List<HttpHost> hosts; - - final String username; - final String password; - final int numberOfShards; - final int numberOfReplicas; - final int maxResultWindow; - final int connectTimeout; - final int socketTimeout; - final String prefix; - - @Inject - ElasticConfiguration(@GerritServerConfig Config cfg) { - this.cfg = cfg; - this.password = cfg.getString(SECTION_ELASTICSEARCH, null, KEY_PASSWORD); - this.username = - password == null - ? null - : firstNonNull( - cfg.getString(SECTION_ELASTICSEARCH, null, KEY_USERNAME), DEFAULT_USERNAME); - this.prefix = Strings.nullToEmpty(cfg.getString(SECTION_ELASTICSEARCH, null, KEY_PREFIX)); - this.numberOfShards = - cfg.getInt(SECTION_ELASTICSEARCH, null, KEY_NUMBER_OF_SHARDS, DEFAULT_NUMBER_OF_SHARDS); - this.numberOfReplicas = - cfg.getInt(SECTION_ELASTICSEARCH, null, KEY_NUMBER_OF_REPLICAS, DEFAULT_NUMBER_OF_REPLICAS); - this.maxResultWindow = - cfg.getInt(SECTION_ELASTICSEARCH, null, KEY_MAX_RESULT_WINDOW, DEFAULT_MAX_RESULT_WINDOW); - this.connectTimeout = - (int) - cfg.getTimeUnit( - SECTION_ELASTICSEARCH, - null, - KEY_CONNECT_TIMEOUT, - DEFAULT_CONNECT_TIMEOUT, - TimeUnit.MILLISECONDS); - this.socketTimeout = - (int) - cfg.getTimeUnit( - SECTION_ELASTICSEARCH, - null, - KEY_SOCKET_TIMEOUT, - DEFAULT_SOCKET_TIMEOUT, - TimeUnit.MILLISECONDS); - this.hosts = new ArrayList<>(); - for (String server : cfg.getStringList(SECTION_ELASTICSEARCH, null, KEY_SERVER)) { - try { - URI uri = new URI(server); - int port = uri.getPort(); - HttpHost httpHost = - new HttpHost( - uri.getHost(), port == -1 ? Integer.valueOf(DEFAULT_PORT) : port, uri.getScheme()); - this.hosts.add(httpHost); - } catch (URISyntaxException | IllegalArgumentException e) { - logger.atSevere().log("Invalid server URI %s: %s", server, e.getMessage()); - } - } - - if (hosts.isEmpty()) { - throw new ProvisionException("No valid Elasticsearch servers configured"); - } - - logger.atInfo().log("Elasticsearch servers: %s", hosts); - } - - Config getConfig() { - return cfg; - } - - HttpHost[] getHosts() { - return hosts.toArray(new HttpHost[hosts.size()]); - } - - String getIndexName(String name, int schemaVersion) { - return String.format("%s%s_%04d", prefix, name, schemaVersion); - } - - int getNumberOfShards() { - return numberOfShards; - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticException.java b/java/com/google/gerrit/elasticsearch/ElasticException.java deleted file mode 100644 index d4baf75..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticException.java +++ /dev/null
@@ -1,27 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -class ElasticException extends RuntimeException { - private static final long serialVersionUID = 1L; - - ElasticException(String message) { - super(message); - } - - ElasticException(String message, Throwable cause) { - super(message, cause); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticGroupIndex.java b/java/com/google/gerrit/elasticsearch/ElasticGroupIndex.java deleted file mode 100644 index 781ed43..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticGroupIndex.java +++ /dev/null
@@ -1,126 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.common.collect.ImmutableSet; -import com.google.gerrit.elasticsearch.ElasticMapping.MappingProperties; -import com.google.gerrit.elasticsearch.bulk.BulkRequest; -import com.google.gerrit.elasticsearch.bulk.IndexRequest; -import com.google.gerrit.elasticsearch.bulk.UpdateRequest; -import com.google.gerrit.entities.AccountGroup; -import com.google.gerrit.entities.InternalGroup; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.QueryOptions; -import com.google.gerrit.index.Schema; -import com.google.gerrit.index.query.DataSource; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.server.account.GroupCache; -import com.google.gerrit.server.config.SitePaths; -import com.google.gerrit.server.index.IndexUtils; -import com.google.gerrit.server.index.group.GroupField; -import com.google.gerrit.server.index.group.GroupIndex; -import com.google.gson.JsonArray; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.inject.Inject; -import com.google.inject.Provider; -import com.google.inject.assistedinject.Assisted; -import java.util.Set; -import org.apache.http.HttpStatus; -import org.elasticsearch.client.Response; - -public class ElasticGroupIndex extends AbstractElasticIndex<AccountGroup.UUID, InternalGroup> - implements GroupIndex { - static class GroupMapping { - final MappingProperties groups; - - GroupMapping(Schema<InternalGroup> schema, ElasticQueryAdapter adapter) { - this.groups = ElasticMapping.createMapping(schema, adapter); - } - } - - private static final String GROUPS = "groups"; - - private final GroupMapping mapping; - private final Provider<GroupCache> groupCache; - private final Schema<InternalGroup> schema; - - @Inject - ElasticGroupIndex( - ElasticConfiguration cfg, - SitePaths sitePaths, - Provider<GroupCache> groupCache, - ElasticRestClientProvider client, - @Assisted Schema<InternalGroup> schema) { - super(cfg, sitePaths, schema, client, GROUPS); - this.groupCache = groupCache; - this.mapping = new GroupMapping(schema, client.adapter()); - this.schema = schema; - } - - @Override - public void replace(InternalGroup group) { - BulkRequest bulk = - new IndexRequest(getId(group), indexName) - .add(new UpdateRequest<>(schema, group, ImmutableSet.of())); - - String uri = getURI(BULK); - Response response = postRequest(uri, bulk, getRefreshParam()); - int statusCode = response.getStatusLine().getStatusCode(); - if (statusCode != HttpStatus.SC_OK) { - throw new StorageException( - String.format( - "Failed to replace group %s in index %s: %s", - group.getGroupUUID().get(), indexName, statusCode)); - } - } - - @Override - public DataSource<InternalGroup> getSource(Predicate<InternalGroup> p, QueryOptions opts) - throws QueryParseException { - JsonArray sortArray = getSortArray(GroupField.UUID.getName()); - return new ElasticQuerySource(p, opts.filterFields(IndexUtils::groupFields), sortArray); - } - - @Override - protected String getDeleteActions(AccountGroup.UUID g) { - return getDeleteRequest(g); - } - - @Override - protected String getMappings() { - return getMappingsForSingleType(mapping.groups); - } - - @Override - protected String getId(InternalGroup group) { - return group.getGroupUUID().get(); - } - - @Override - protected InternalGroup fromDocument(JsonObject json, Set<String> fields) { - JsonElement source = json.get("_source"); - if (source == null) { - source = json.getAsJsonObject().get("fields"); - } - - AccountGroup.UUID uuid = - AccountGroup.uuid(source.getAsJsonObject().get(GroupField.UUID.getName()).getAsString()); - // Use the GroupCache rather than depending on any stored fields in the - // document (of which there shouldn't be any). - return groupCache.get().get(uuid).orElse(null); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticIndexModule.java b/java/com/google/gerrit/elasticsearch/ElasticIndexModule.java deleted file mode 100644 index 15d6126..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticIndexModule.java +++ /dev/null
@@ -1,69 +0,0 @@ -// Copyright (C) 2014 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.gerrit.index.project.ProjectIndex; -import com.google.gerrit.server.index.AbstractIndexModule; -import com.google.gerrit.server.index.VersionManager; -import com.google.gerrit.server.index.account.AccountIndex; -import com.google.gerrit.server.index.change.ChangeIndex; -import com.google.gerrit.server.index.group.GroupIndex; -import java.util.Map; - -public class ElasticIndexModule extends AbstractIndexModule { - public static ElasticIndexModule singleVersionWithExplicitVersions( - Map<String, Integer> versions, int threads, boolean slave) { - return new ElasticIndexModule(versions, threads, slave); - } - - public static ElasticIndexModule latestVersion(boolean slave) { - return new ElasticIndexModule(null, 0, slave); - } - - private ElasticIndexModule(Map<String, Integer> singleVersions, int threads, boolean slave) { - super(singleVersions, threads, slave); - } - - @Override - public void configure() { - super.configure(); - install(ElasticRestClientProvider.module()); - } - - @Override - protected Class<? extends AccountIndex> getAccountIndex() { - return ElasticAccountIndex.class; - } - - @Override - protected Class<? extends ChangeIndex> getChangeIndex() { - return ElasticChangeIndex.class; - } - - @Override - protected Class<? extends GroupIndex> getGroupIndex() { - return ElasticGroupIndex.class; - } - - @Override - protected Class<? extends ProjectIndex> getProjectIndex() { - return ElasticProjectIndex.class; - } - - @Override - protected Class<? extends VersionManager> getVersionManager() { - return ElasticIndexVersionManager.class; - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticIndexVersionDiscovery.java b/java/com/google/gerrit/elasticsearch/ElasticIndexVersionDiscovery.java deleted file mode 100644 index 100022a..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticIndexVersionDiscovery.java +++ /dev/null
@@ -1,61 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import static java.util.stream.Collectors.toList; - -import com.google.common.flogger.FluentLogger; -import com.google.gson.JsonParser; -import com.google.inject.Inject; -import com.google.inject.Singleton; -import java.io.IOException; -import java.util.List; -import org.apache.http.HttpStatus; -import org.apache.http.StatusLine; -import org.elasticsearch.client.Request; -import org.elasticsearch.client.Response; - -@Singleton -class ElasticIndexVersionDiscovery { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - private final ElasticRestClientProvider client; - - @Inject - ElasticIndexVersionDiscovery(ElasticRestClientProvider client) { - this.client = client; - } - - List<String> discover(String prefix, String indexName) throws IOException { - String name = prefix + indexName + "_"; - Request request = new Request("GET", client.adapter().getVersionDiscoveryUrl(name)); - Response response = client.get().performRequest(request); - - StatusLine statusLine = response.getStatusLine(); - if (statusLine.getStatusCode() != HttpStatus.SC_OK) { - String message = - String.format( - "Failed to discover index versions for %s: %d: %s", - name, statusLine.getStatusCode(), statusLine.getReasonPhrase()); - logger.atSevere().log(message); - throw new IOException(message); - } - - return new JsonParser() - .parse(AbstractElasticIndex.getContent(response)).getAsJsonObject().entrySet().stream() - .map(e -> e.getKey().replace(name, "")) - .collect(toList()); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticIndexVersionManager.java b/java/com/google/gerrit/elasticsearch/ElasticIndexVersionManager.java deleted file mode 100644 index b9d86d5..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticIndexVersionManager.java +++ /dev/null
@@ -1,82 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.common.base.Strings; -import com.google.common.flogger.FluentLogger; -import com.google.common.primitives.Ints; -import com.google.gerrit.index.Index; -import com.google.gerrit.index.IndexDefinition; -import com.google.gerrit.index.Schema; -import com.google.gerrit.server.config.GerritServerConfig; -import com.google.gerrit.server.config.SitePaths; -import com.google.gerrit.server.index.GerritIndexStatus; -import com.google.gerrit.server.index.OnlineUpgradeListener; -import com.google.gerrit.server.index.VersionManager; -import com.google.gerrit.server.plugincontext.PluginSetContext; -import com.google.inject.Inject; -import com.google.inject.Singleton; -import java.io.IOException; -import java.util.Collection; -import java.util.List; -import java.util.TreeMap; -import org.eclipse.jgit.lib.Config; - -@Singleton -public class ElasticIndexVersionManager extends VersionManager { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - private final String prefix; - private final ElasticIndexVersionDiscovery versionDiscovery; - - @Inject - ElasticIndexVersionManager( - @GerritServerConfig Config cfg, - SitePaths sitePaths, - PluginSetContext<OnlineUpgradeListener> listeners, - Collection<IndexDefinition<?, ?, ?>> defs, - ElasticIndexVersionDiscovery versionDiscovery) { - super(sitePaths, listeners, defs, VersionManager.getOnlineUpgrade(cfg)); - this.versionDiscovery = versionDiscovery; - prefix = Strings.nullToEmpty(cfg.getString("elasticsearch", null, "prefix")); - } - - @Override - protected <K, V, I extends Index<K, V>> TreeMap<Integer, Version<V>> scanVersions( - IndexDefinition<K, V, I> def, GerritIndexStatus cfg) { - TreeMap<Integer, Version<V>> versions = new TreeMap<>(); - try { - List<String> discovered = versionDiscovery.discover(prefix, def.getName()); - logger.atFine().log("Discovered versions for %s: %s", def.getName(), discovered); - for (String version : discovered) { - Integer v = Ints.tryParse(version); - if (v == null || version.length() != 4) { - logger.atWarning().log("Unrecognized version in index %s: %s", def.getName(), version); - continue; - } - versions.put(v, new Version<>(null, v, true, cfg.getReady(def.getName(), v))); - } - } catch (IOException e) { - logger.atSevere().withCause(e).log("Error scanning index: %s", def.getName()); - } - - for (Schema<V> schema : def.getSchemas().values()) { - int v = schema.getVersion(); - boolean exists = versions.containsKey(v); - versions.put(v, new Version<>(schema, v, exists, cfg.getReady(def.getName(), v))); - } - return versions; - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticMapping.java b/java/com/google/gerrit/elasticsearch/ElasticMapping.java deleted file mode 100644 index edd05c9..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticMapping.java +++ /dev/null
@@ -1,123 +0,0 @@ -// Copyright (C) 2016 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.common.collect.ImmutableMap; -import com.google.gerrit.index.FieldDef; -import com.google.gerrit.index.FieldType; -import com.google.gerrit.index.Schema; -import java.util.Map; - -class ElasticMapping { - - protected static final String TIMESTAMP_FIELD_TYPE = "date"; - protected static final String TIMESTAMP_FIELD_FORMAT = "dateOptionalTime"; - - static MappingProperties createMapping(Schema<?> schema, ElasticQueryAdapter adapter) { - ElasticMapping.Builder mapping = new ElasticMapping.Builder(adapter); - for (FieldDef<?, ?> field : schema.getFields().values()) { - String name = field.getName(); - FieldType<?> fieldType = field.getType(); - if (fieldType == FieldType.EXACT) { - mapping.addExactField(name); - } else if (fieldType == FieldType.TIMESTAMP) { - mapping.addTimestamp(name); - } else if (fieldType == FieldType.INTEGER - || fieldType == FieldType.INTEGER_RANGE - || fieldType == FieldType.LONG) { - mapping.addNumber(name); - } else if (fieldType == FieldType.FULL_TEXT) { - mapping.addStringWithAnalyzer(name); - } else if (fieldType == FieldType.PREFIX || fieldType == FieldType.STORED_ONLY) { - mapping.addString(name); - } else { - throw new IllegalStateException("Unsupported field type: " + fieldType.getName()); - } - } - return mapping.build(); - } - - static class Builder { - private final ElasticQueryAdapter adapter; - private final ImmutableMap.Builder<String, FieldProperties> fields = - new ImmutableMap.Builder<>(); - - Builder(ElasticQueryAdapter adapter) { - this.adapter = adapter; - } - - MappingProperties build() { - MappingProperties properties = new MappingProperties(); - properties.properties = fields.build(); - return properties; - } - - Builder addExactField(String name) { - FieldProperties key = new FieldProperties(adapter.exactFieldType()); - key.index = adapter.indexProperty(); - FieldProperties properties; - properties = new FieldProperties(adapter.exactFieldType()); - properties.fields = ImmutableMap.of("key", key); - fields.put(name, properties); - return this; - } - - Builder addTimestamp(String name) { - FieldProperties properties = new FieldProperties(TIMESTAMP_FIELD_TYPE); - properties.type = TIMESTAMP_FIELD_TYPE; - properties.format = TIMESTAMP_FIELD_FORMAT; - fields.put(name, properties); - return this; - } - - Builder addNumber(String name) { - fields.put(name, new FieldProperties("long")); - return this; - } - - Builder addString(String name) { - fields.put(name, new FieldProperties(adapter.stringFieldType())); - return this; - } - - Builder addStringWithAnalyzer(String name) { - FieldProperties key = new FieldProperties(adapter.stringFieldType()); - key.analyzer = "custom_with_char_filter"; - fields.put(name, key); - return this; - } - - Builder add(String name, String type) { - fields.put(name, new FieldProperties(type)); - return this; - } - } - - static class MappingProperties { - Map<String, FieldProperties> properties; - } - - static class FieldProperties { - String type; - String index; - String format; - String analyzer; - Map<String, FieldProperties> fields; - - FieldProperties(String type) { - this.type = type; - } - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticProjectIndex.java b/java/com/google/gerrit/elasticsearch/ElasticProjectIndex.java deleted file mode 100644 index b8bfc38..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticProjectIndex.java +++ /dev/null
@@ -1,130 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.common.collect.ImmutableSet; -import com.google.gerrit.elasticsearch.ElasticMapping.MappingProperties; -import com.google.gerrit.elasticsearch.bulk.BulkRequest; -import com.google.gerrit.elasticsearch.bulk.IndexRequest; -import com.google.gerrit.elasticsearch.bulk.UpdateRequest; -import com.google.gerrit.entities.Project; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.QueryOptions; -import com.google.gerrit.index.Schema; -import com.google.gerrit.index.project.ProjectData; -import com.google.gerrit.index.project.ProjectField; -import com.google.gerrit.index.project.ProjectIndex; -import com.google.gerrit.index.query.DataSource; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.server.config.SitePaths; -import com.google.gerrit.server.index.IndexUtils; -import com.google.gerrit.server.project.ProjectCache; -import com.google.gerrit.server.project.ProjectState; -import com.google.gson.JsonArray; -import com.google.gson.JsonElement; -import com.google.gson.JsonObject; -import com.google.inject.Inject; -import com.google.inject.Provider; -import com.google.inject.assistedinject.Assisted; -import java.util.Optional; -import java.util.Set; -import org.apache.http.HttpStatus; -import org.elasticsearch.client.Response; - -public class ElasticProjectIndex extends AbstractElasticIndex<Project.NameKey, ProjectData> - implements ProjectIndex { - static class ProjectMapping { - MappingProperties projects; - - ProjectMapping(Schema<ProjectData> schema, ElasticQueryAdapter adapter) { - this.projects = ElasticMapping.createMapping(schema, adapter); - } - } - - static final String PROJECTS = "projects"; - - private final ProjectMapping mapping; - private final Provider<ProjectCache> projectCache; - private final Schema<ProjectData> schema; - - @Inject - ElasticProjectIndex( - ElasticConfiguration cfg, - SitePaths sitePaths, - Provider<ProjectCache> projectCache, - ElasticRestClientProvider client, - @Assisted Schema<ProjectData> schema) { - super(cfg, sitePaths, schema, client, PROJECTS); - this.projectCache = projectCache; - this.schema = schema; - this.mapping = new ProjectMapping(schema, client.adapter()); - } - - @Override - public void replace(ProjectData projectState) { - BulkRequest bulk = - new IndexRequest(projectState.getProject().getName(), indexName) - .add(new UpdateRequest<>(schema, projectState, ImmutableSet.of())); - - String uri = getURI(BULK); - Response response = postRequest(uri, bulk, getRefreshParam()); - int statusCode = response.getStatusLine().getStatusCode(); - if (statusCode != HttpStatus.SC_OK) { - throw new StorageException( - String.format( - "Failed to replace project %s in index %s: %s", - projectState.getProject().getName(), indexName, statusCode)); - } - } - - @Override - public DataSource<ProjectData> getSource(Predicate<ProjectData> p, QueryOptions opts) - throws QueryParseException { - JsonArray sortArray = getSortArray(ProjectField.NAME.getName()); - return new ElasticQuerySource(p, opts.filterFields(IndexUtils::projectFields), sortArray); - } - - @Override - protected String getDeleteActions(Project.NameKey nameKey) { - return getDeleteRequest(nameKey); - } - - @Override - protected String getMappings() { - return getMappingsForSingleType(mapping.projects); - } - - @Override - protected String getId(ProjectData projectState) { - return projectState.getProject().getName(); - } - - @Override - protected ProjectData fromDocument(JsonObject json, Set<String> fields) { - JsonElement source = json.get("_source"); - if (source == null) { - source = json.getAsJsonObject().get("fields"); - } - - Project.NameKey nameKey = - Project.nameKey(source.getAsJsonObject().get(ProjectField.NAME.getName()).getAsString()); - Optional<ProjectState> state = projectCache.get().get(nameKey); - if (!state.isPresent()) { - return null; - } - return state.get().toProjectData(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticQueryAdapter.java b/java/com/google/gerrit/elasticsearch/ElasticQueryAdapter.java deleted file mode 100644 index 19d9901..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticQueryAdapter.java +++ /dev/null
@@ -1,63 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -public class ElasticQueryAdapter { - private static final String INDICES = "?allow_no_indices=false"; - - private final String searchFilteringName; - private final String exactFieldType; - private final String stringFieldType; - private final String indexProperty; - private final String rawFieldsKey; - private final String versionDiscoveryUrl; - - ElasticQueryAdapter() { - this.versionDiscoveryUrl = "/%s*"; - this.searchFilteringName = "_source"; - this.exactFieldType = "keyword"; - this.stringFieldType = "text"; - this.indexProperty = "true"; - this.rawFieldsKey = "_source"; - } - - public String searchFilteringName() { - return searchFilteringName; - } - - String indicesExistParams() { - return INDICES; - } - - String exactFieldType() { - return exactFieldType; - } - - String stringFieldType() { - return stringFieldType; - } - - String indexProperty() { - return indexProperty; - } - - String rawFieldsKey() { - return rawFieldsKey; - } - - String getVersionDiscoveryUrl(String name) { - return String.format(versionDiscoveryUrl, name); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticQueryBuilder.java b/java/com/google/gerrit/elasticsearch/ElasticQueryBuilder.java deleted file mode 100644 index 40ac603..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticQueryBuilder.java +++ /dev/null
@@ -1,163 +0,0 @@ -// Copyright (C) 2014 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.gerrit.elasticsearch.builders.BoolQueryBuilder; -import com.google.gerrit.elasticsearch.builders.QueryBuilder; -import com.google.gerrit.elasticsearch.builders.QueryBuilders; -import com.google.gerrit.index.FieldDef; -import com.google.gerrit.index.FieldType; -import com.google.gerrit.index.query.AndPredicate; -import com.google.gerrit.index.query.IndexPredicate; -import com.google.gerrit.index.query.IntegerRangePredicate; -import com.google.gerrit.index.query.NotPredicate; -import com.google.gerrit.index.query.OrPredicate; -import com.google.gerrit.index.query.PostFilterPredicate; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.index.query.RegexPredicate; -import com.google.gerrit.index.query.TimestampRangePredicate; -import java.time.Instant; - -public class ElasticQueryBuilder { - - <T> QueryBuilder toQueryBuilder(Predicate<T> p) throws QueryParseException { - if (p instanceof AndPredicate) { - return and(p); - } else if (p instanceof OrPredicate) { - return or(p); - } else if (p instanceof NotPredicate) { - return not(p); - } else if (p instanceof IndexPredicate) { - return fieldQuery((IndexPredicate<T>) p); - } else if (p instanceof PostFilterPredicate) { - return QueryBuilders.matchAllQuery(); - } else { - throw new QueryParseException("cannot create query for index: " + p); - } - } - - private <T> BoolQueryBuilder and(Predicate<T> p) throws QueryParseException { - BoolQueryBuilder b = QueryBuilders.boolQuery(); - for (Predicate<T> c : p.getChildren()) { - b.must(toQueryBuilder(c)); - } - return b; - } - - private <T> BoolQueryBuilder or(Predicate<T> p) throws QueryParseException { - BoolQueryBuilder q = QueryBuilders.boolQuery(); - for (Predicate<T> c : p.getChildren()) { - q.should(toQueryBuilder(c)); - } - return q; - } - - private <T> QueryBuilder not(Predicate<T> p) throws QueryParseException { - Predicate<T> n = p.getChild(0); - if (n instanceof TimestampRangePredicate) { - return notTimestamp((TimestampRangePredicate<T>) n); - } - - // Lucene does not support negation, start with all and subtract. - BoolQueryBuilder q = QueryBuilders.boolQuery(); - q.must(QueryBuilders.matchAllQuery()); - q.mustNot(toQueryBuilder(n)); - return q; - } - - private <T> QueryBuilder fieldQuery(IndexPredicate<T> p) throws QueryParseException { - FieldType<?> type = p.getType(); - FieldDef<?, ?> field = p.getField(); - String name = field.getName(); - String value = p.getValue(); - - if (type == FieldType.INTEGER) { - // QueryBuilder encodes integer fields as prefix coded bits, - // which elasticsearch's queryString can't handle. - // Create integer terms with string representations instead. - return QueryBuilders.termQuery(name, value); - } else if (type == FieldType.INTEGER_RANGE) { - return intRangeQuery(p); - } else if (type == FieldType.TIMESTAMP) { - return timestampQuery(p); - } else if (type == FieldType.EXACT) { - return exactQuery(p); - } else if (type == FieldType.PREFIX) { - return QueryBuilders.matchPhrasePrefixQuery(name, value); - } else if (type == FieldType.FULL_TEXT) { - return QueryBuilders.matchPhraseQuery(name, value); - } else { - throw FieldType.badFieldType(p.getType()); - } - } - - private <T> QueryBuilder intRangeQuery(IndexPredicate<T> p) throws QueryParseException { - if (p instanceof IntegerRangePredicate) { - IntegerRangePredicate<T> r = (IntegerRangePredicate<T>) p; - int minimum = r.getMinimumValue(); - int maximum = r.getMaximumValue(); - if (minimum == maximum) { - // Just fall back to a standard integer query. - return QueryBuilders.termQuery(p.getField().getName(), minimum); - } - return QueryBuilders.rangeQuery(p.getField().getName()).gte(minimum).lte(maximum); - } - throw new QueryParseException("not an integer range: " + p); - } - - private <T> QueryBuilder notTimestamp(TimestampRangePredicate<T> r) throws QueryParseException { - if (r.getMinTimestamp().getTime() == 0) { - return QueryBuilders.rangeQuery(r.getField().getName()) - .gt(Instant.ofEpochMilli(r.getMaxTimestamp().getTime())); - } - throw new QueryParseException("cannot negate: " + r); - } - - private <T> QueryBuilder timestampQuery(IndexPredicate<T> p) throws QueryParseException { - if (p instanceof TimestampRangePredicate) { - TimestampRangePredicate<T> r = (TimestampRangePredicate<T>) p; - if (r.getMaxTimestamp().getTime() == Long.MAX_VALUE) { - // The time range only has the start value, search from the start to the max supported value - // Long.MAX_VALUE - return QueryBuilders.rangeQuery(r.getField().getName()) - .gte(Instant.ofEpochMilli(r.getMinTimestamp().getTime())); - } - return QueryBuilders.rangeQuery(r.getField().getName()) - .gte(Instant.ofEpochMilli(r.getMinTimestamp().getTime())) - .lte(Instant.ofEpochMilli(r.getMaxTimestamp().getTime())); - } - throw new QueryParseException("not a timestamp: " + p); - } - - private <T> QueryBuilder exactQuery(IndexPredicate<T> p) { - String name = p.getField().getName(); - String value = p.getValue(); - - if (!p.getField().isRepeatable() && value.isEmpty()) { - return new BoolQueryBuilder().mustNot(QueryBuilders.existsQuery(name)); - } else if (p instanceof RegexPredicate) { - if (value.startsWith("^")) { - value = value.substring(1); - } - if (value.endsWith("$") && !value.endsWith("\\$") && !value.endsWith("\\\\$")) { - value = value.substring(0, value.length() - 1); - } - return QueryBuilders.regexpQuery(name + ".key", value); - } else { - return QueryBuilders.termQuery(name + ".key", value); - } - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticRestClientProvider.java b/java/com/google/gerrit/elasticsearch/ElasticRestClientProvider.java deleted file mode 100644 index b41f365..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticRestClientProvider.java +++ /dev/null
@@ -1,157 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.common.flogger.FluentLogger; -import com.google.gerrit.extensions.events.LifecycleListener; -import com.google.gerrit.lifecycle.LifecycleModule; -import com.google.gson.JsonParser; -import com.google.inject.Inject; -import com.google.inject.Provider; -import com.google.inject.Singleton; -import java.io.IOException; -import org.apache.http.HttpStatus; -import org.apache.http.StatusLine; -import org.apache.http.auth.AuthScope; -import org.apache.http.auth.UsernamePasswordCredentials; -import org.apache.http.client.CredentialsProvider; -import org.apache.http.client.config.RequestConfig; -import org.apache.http.impl.client.BasicCredentialsProvider; -import org.apache.http.impl.nio.client.HttpAsyncClientBuilder; -import org.elasticsearch.client.Request; -import org.elasticsearch.client.Response; -import org.elasticsearch.client.RestClient; -import org.elasticsearch.client.RestClientBuilder; - -@Singleton -class ElasticRestClientProvider implements Provider<RestClient>, LifecycleListener { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - private final ElasticConfiguration cfg; - - private volatile RestClient client; - private ElasticQueryAdapter adapter; - - @Inject - ElasticRestClientProvider(ElasticConfiguration cfg) { - this.cfg = cfg; - } - - public static LifecycleModule module() { - return new LifecycleModule() { - @Override - protected void configure() { - listener().to(ElasticRestClientProvider.class); - } - }; - } - - @Override - public RestClient get() { - if (client == null) { - synchronized (this) { - if (client == null) { - client = build(); - ElasticVersion version = getVersion(); - logger.atInfo().log("Elasticsearch integration version %s", version); - adapter = new ElasticQueryAdapter(); - } - } - } - return client; - } - - @Override - public void start() {} - - @Override - public void stop() { - if (client != null) { - try { - client.close(); - } catch (IOException e) { - // Ignore. We can't do anything about it. - } - } - } - - ElasticQueryAdapter adapter() { - get(); // Make sure we're connected - return adapter; - } - - public static class FailedToGetVersion extends ElasticException { - private static final long serialVersionUID = 1L; - private static final String MESSAGE = "Failed to get Elasticsearch version"; - - FailedToGetVersion(StatusLine status) { - super(String.format("%s: %d %s", MESSAGE, status.getStatusCode(), status.getReasonPhrase())); - } - - FailedToGetVersion(Throwable cause) { - super(MESSAGE, cause); - } - } - - private ElasticVersion getVersion() throws ElasticException { - try { - Response response = client.performRequest(new Request("GET", "/")); - StatusLine statusLine = response.getStatusLine(); - if (statusLine.getStatusCode() != HttpStatus.SC_OK) { - throw new FailedToGetVersion(statusLine); - } - String version = - new JsonParser() - .parse(AbstractElasticIndex.getContent(response)) - .getAsJsonObject() - .get("version") - .getAsJsonObject() - .get("number") - .getAsString(); - logger.atInfo().log("Connected to Elasticsearch version %s", version); - return ElasticVersion.forVersion(version); - } catch (IOException e) { - throw new FailedToGetVersion(e); - } - } - - private RestClient build() { - RestClientBuilder builder = RestClient.builder(cfg.getHosts()); - setConfiguredTimeouts(builder); - setConfiguredCredentialsIfAny(builder); - return builder.build(); - } - - private void setConfiguredTimeouts(RestClientBuilder builder) { - builder.setRequestConfigCallback( - (RequestConfig.Builder requestConfigBuilder) -> - requestConfigBuilder - .setConnectTimeout(cfg.connectTimeout) - .setSocketTimeout(cfg.socketTimeout)); - } - - private void setConfiguredCredentialsIfAny(RestClientBuilder builder) { - String username = cfg.username; - String password = cfg.password; - if (username != null && password != null) { - CredentialsProvider credentialsProvider = new BasicCredentialsProvider(); - credentialsProvider.setCredentials( - AuthScope.ANY, new UsernamePasswordCredentials(username, password)); - builder.setHttpClientConfigCallback( - (HttpAsyncClientBuilder httpClientBuilder) -> - httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider)); - } - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticSetting.java b/java/com/google/gerrit/elasticsearch/ElasticSetting.java deleted file mode 100644 index 7ec0566..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticSetting.java +++ /dev/null
@@ -1,97 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.common.collect.ImmutableMap; -import java.util.Map; - -class ElasticSetting { - /** The custom char mappings of "." to " " and "_" to " " in the form of UTF-8 */ - private static final ImmutableMap<String, String> CUSTOM_CHAR_MAPPING = - ImmutableMap.of("\\u002E", "\\u0020", "\\u005F", "\\u0020"); - - static SettingProperties createSetting(ElasticConfiguration config) { - return new ElasticSetting.Builder().addCharFilter().addAnalyzer().build(config); - } - - static class Builder { - private final ImmutableMap.Builder<String, FieldProperties> fields = - new ImmutableMap.Builder<>(); - - SettingProperties build(ElasticConfiguration config) { - SettingProperties properties = new SettingProperties(); - properties.analysis = fields.build(); - properties.numberOfShards = config.getNumberOfShards(); - properties.numberOfReplicas = config.numberOfReplicas; - properties.maxResultWindow = config.maxResultWindow; - return properties; - } - - Builder addCharFilter() { - FieldProperties charMapping = new FieldProperties("mapping"); - charMapping.mappings = getCustomCharMappings(CUSTOM_CHAR_MAPPING); - - FieldProperties charFilter = new FieldProperties(); - charFilter.customMapping = charMapping; - fields.put("char_filter", charFilter); - return this; - } - - Builder addAnalyzer() { - FieldProperties customAnalyzer = new FieldProperties("custom"); - customAnalyzer.tokenizer = "standard"; - customAnalyzer.charFilter = new String[] {"custom_mapping"}; - customAnalyzer.filter = new String[] {"lowercase"}; - - FieldProperties analyzer = new FieldProperties(); - analyzer.customWithCharFilter = customAnalyzer; - fields.put("analyzer", analyzer); - return this; - } - - private static String[] getCustomCharMappings(ImmutableMap<String, String> map) { - int mappingIndex = 0; - int numOfMappings = map.size(); - String[] mapping = new String[numOfMappings]; - for (Map.Entry<String, String> e : map.entrySet()) { - mapping[mappingIndex++] = e.getKey() + "=>" + e.getValue(); - } - return mapping; - } - } - - static class SettingProperties { - Map<String, FieldProperties> analysis; - Integer numberOfShards; - Integer numberOfReplicas; - Integer maxResultWindow; - } - - static class FieldProperties { - String tokenizer; - String type; - String[] charFilter; - String[] filter; - String[] mappings; - FieldProperties customMapping; - FieldProperties customWithCharFilter; - - FieldProperties() {} - - FieldProperties(String type) { - this.type = type; - } - } -}
diff --git a/java/com/google/gerrit/elasticsearch/ElasticVersion.java b/java/com/google/gerrit/elasticsearch/ElasticVersion.java deleted file mode 100644 index 47fa383..0000000 --- a/java/com/google/gerrit/elasticsearch/ElasticVersion.java +++ /dev/null
@@ -1,65 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch; - -import com.google.common.base.Joiner; -import java.util.regex.Pattern; - -public enum ElasticVersion { - V7_16("7.16.*"); - - private final String version; - private final Pattern pattern; - - ElasticVersion(String version) { - this.version = version; - this.pattern = Pattern.compile(version); - } - - public static class UnsupportedVersion extends ElasticException { - private static final long serialVersionUID = 1L; - - UnsupportedVersion(String version) { - super( - String.format( - "Unsupported version: [%s]. Supported versions: %s", version, supportedVersions())); - } - } - - /** - * Convert a version String to an ElasticVersion if supported. - * - * @param version for which to return an ElasticVersion - * @return the corresponding ElasticVersion if supported - * @throws UnsupportedVersion - */ - public static ElasticVersion forVersion(String version) { - for (ElasticVersion value : ElasticVersion.values()) { - if (value.pattern.matcher(version).matches()) { - return value; - } - } - throw new UnsupportedVersion(version); - } - - public static String supportedVersions() { - return Joiner.on(", ").join(ElasticVersion.values()); - } - - @Override - public String toString() { - return version; - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/BoolQueryBuilder.java b/java/com/google/gerrit/elasticsearch/builders/BoolQueryBuilder.java deleted file mode 100644 index a204919..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/BoolQueryBuilder.java +++ /dev/null
@@ -1,89 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; - -/** - * A Query that matches documents matching boolean combinations of other queries. - * - * <p>A trimmed down version of org.elasticsearch.index.query.BoolQueryBuilder. - */ -public class BoolQueryBuilder extends QueryBuilder { - - private final List<QueryBuilder> mustClauses = new ArrayList<>(); - - private final List<QueryBuilder> mustNotClauses = new ArrayList<>(); - - private final List<QueryBuilder> filterClauses = new ArrayList<>(); - - private final List<QueryBuilder> shouldClauses = new ArrayList<>(); - - /** - * Adds a query that <b>must</b> appear in the matching documents and will contribute to scoring. - */ - public BoolQueryBuilder must(QueryBuilder queryBuilder) { - mustClauses.add(queryBuilder); - return this; - } - - /** - * Adds a query that <b>must not</b> appear in the matching documents and will not contribute to - * scoring. - */ - public BoolQueryBuilder mustNot(QueryBuilder queryBuilder) { - mustNotClauses.add(queryBuilder); - return this; - } - - /** - * Adds a query that <i>should</i> appear in the matching documents. For a boolean query with no - * <tt>MUST</tt> clauses one or more <code>SHOULD</code> clauses must match a document for the - * BooleanQuery to match. - */ - public BoolQueryBuilder should(QueryBuilder queryBuilder) { - shouldClauses.add(queryBuilder); - return this; - } - - @Override - protected void doXContent(XContentBuilder builder) throws IOException { - builder.startObject("bool"); - doXArrayContent("must", mustClauses, builder); - doXArrayContent("filter", filterClauses, builder); - doXArrayContent("must_not", mustNotClauses, builder); - doXArrayContent("should", shouldClauses, builder); - builder.endObject(); - } - - private void doXArrayContent(String field, List<QueryBuilder> clauses, XContentBuilder builder) - throws IOException { - if (clauses.isEmpty()) { - return; - } - if (clauses.size() == 1) { - builder.field(field); - clauses.get(0).toXContent(builder); - } else { - builder.startArray(field); - for (QueryBuilder clause : clauses) { - clause.toXContent(builder); - } - builder.endArray(); - } - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/ExistsQueryBuilder.java b/java/com/google/gerrit/elasticsearch/builders/ExistsQueryBuilder.java deleted file mode 100644 index 1b058d7..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/ExistsQueryBuilder.java +++ /dev/null
@@ -1,38 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; - -/** - * Constructs a query that only match on documents that the field has a value in them. - * - * <p>A trimmed down version of org.elasticsearch.index.query.ExistsQueryBuilder. - */ -class ExistsQueryBuilder extends QueryBuilder { - - private final String name; - - ExistsQueryBuilder(String name) { - this.name = name; - } - - @Override - protected void doXContent(XContentBuilder builder) throws IOException { - builder.startObject("exists"); - builder.field("field", name); - builder.endObject(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/MatchAllQueryBuilder.java b/java/com/google/gerrit/elasticsearch/builders/MatchAllQueryBuilder.java deleted file mode 100644 index a3b303c..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/MatchAllQueryBuilder.java +++ /dev/null
@@ -1,31 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; - -/** - * A query that matches on all documents. - * - * <p>A trimmed down version of org.elasticsearch.index.query.MatchAllQueryBuilder. - */ -class MatchAllQueryBuilder extends QueryBuilder { - - @Override - protected void doXContent(XContentBuilder builder) throws IOException { - builder.startObject("match_all"); - builder.endObject(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/MatchQueryBuilder.java b/java/com/google/gerrit/elasticsearch/builders/MatchQueryBuilder.java deleted file mode 100644 index c0becd1..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/MatchQueryBuilder.java +++ /dev/null
@@ -1,62 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; -import java.util.Locale; - -/** - * Match query is a query that analyzes the text and constructs a query as the result of the - * analysis. It can construct different queries based on the type provided. - * - * <p>A trimmed down version of org.elasticsearch.index.query.MatchQueryBuilder. - */ -class MatchQueryBuilder extends QueryBuilder { - - enum Type { - /** The text is analyzed and used as a phrase query. */ - MATCH_PHRASE, - /** The text is analyzed and used in a phrase query, with the last term acting as a prefix. */ - MATCH_PHRASE_PREFIX; - - @Override - public String toString() { - return name().toLowerCase(Locale.US); - } - } - - private final String name; - - private final Object text; - - private Type type; - - /** Constructs a new text query. */ - MatchQueryBuilder(String name, Object text) { - this.name = name; - this.text = text; - } - - /** Sets the type of the text query. */ - MatchQueryBuilder type(Type type) { - this.type = type; - return this; - } - - @Override - protected void doXContent(XContentBuilder builder) throws IOException { - builder.startObject(type.toString()).field(name, text).endObject(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/QueryBuilder.java b/java/com/google/gerrit/elasticsearch/builders/QueryBuilder.java deleted file mode 100644 index d6f154e..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/QueryBuilder.java +++ /dev/null
@@ -1,31 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; - -/** A trimmed down version of org.elasticsearch.index.query.QueryBuilder. */ -public abstract class QueryBuilder { - - protected QueryBuilder() {} - - protected void toXContent(XContentBuilder builder) throws IOException { - builder.startObject(); - doXContent(builder); - builder.endObject(); - } - - protected abstract void doXContent(XContentBuilder builder) throws IOException; -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/QueryBuilders.java b/java/com/google/gerrit/elasticsearch/builders/QueryBuilders.java deleted file mode 100644 index 940146f..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/QueryBuilders.java +++ /dev/null
@@ -1,103 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -/** - * A static factory for simple "import static" usage. - * - * <p>A trimmed down version of org.elasticsearch.index.query.QueryBuilders. - */ -public abstract class QueryBuilders { - - /** A query that match on all documents. */ - public static MatchAllQueryBuilder matchAllQuery() { - return new MatchAllQueryBuilder(); - } - - /** - * Creates a text query with type "PHRASE" for the provided field name and text. - * - * @param name The field name. - * @param text The query text (to be analyzed). - */ - public static MatchQueryBuilder matchPhraseQuery(String name, Object text) { - return new MatchQueryBuilder(name, text).type(MatchQueryBuilder.Type.MATCH_PHRASE); - } - - /** - * Creates a match query with type "PHRASE_PREFIX" for the provided field name and text. - * - * @param name The field name. - * @param text The query text (to be analyzed). - */ - public static MatchQueryBuilder matchPhrasePrefixQuery(String name, Object text) { - return new MatchQueryBuilder(name, text).type(MatchQueryBuilder.Type.MATCH_PHRASE_PREFIX); - } - - /** - * A Query that matches documents containing a term. - * - * @param name The name of the field - * @param value The value of the term - */ - public static TermQueryBuilder termQuery(String name, String value) { - return new TermQueryBuilder(name, value); - } - - /** - * A Query that matches documents containing a term. - * - * @param name The name of the field - * @param value The value of the term - */ - public static TermQueryBuilder termQuery(String name, int value) { - return new TermQueryBuilder(name, value); - } - - /** - * A Query that matches documents within an range of terms. - * - * @param name The field name - */ - public static RangeQueryBuilder rangeQuery(String name) { - return new RangeQueryBuilder(name); - } - - /** - * A Query that matches documents containing terms with a specified regular expression. - * - * @param name The name of the field - * @param regexp The regular expression - */ - public static RegexpQueryBuilder regexpQuery(String name, String regexp) { - return new RegexpQueryBuilder(name, regexp); - } - - /** A Query that matches documents matching boolean combinations of other queries. */ - public static BoolQueryBuilder boolQuery() { - return new BoolQueryBuilder(); - } - - /** - * A filter to filter only documents where a field exists in them. - * - * @param name The name of the field - */ - public static ExistsQueryBuilder existsQuery(String name) { - return new ExistsQueryBuilder(name); - } - - private QueryBuilders() {} -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/QuerySourceBuilder.java b/java/com/google/gerrit/elasticsearch/builders/QuerySourceBuilder.java deleted file mode 100644 index 1cb5c82..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/QuerySourceBuilder.java +++ /dev/null
@@ -1,32 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; - -/** A trimmed down and modified version of org.elasticsearch.action.support.QuerySourceBuilder. */ -class QuerySourceBuilder { - - private final QueryBuilder queryBuilder; - - QuerySourceBuilder(QueryBuilder queryBuilder) { - this.queryBuilder = queryBuilder; - } - - void innerToXContent(XContentBuilder builder) throws IOException { - builder.field("query"); - queryBuilder.toXContent(builder); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/RangeQueryBuilder.java b/java/com/google/gerrit/elasticsearch/builders/RangeQueryBuilder.java deleted file mode 100644 index 32dbc0e..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/RangeQueryBuilder.java +++ /dev/null
@@ -1,89 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; - -/** - * A Query that matches documents within an range of terms. - * - * <p>A trimmed down version of org.elasticsearch.index.query.RangeQueryBuilder. - */ -public class RangeQueryBuilder extends QueryBuilder { - - private final String name; - private Object from; - private Object to; - private boolean includeLower = true; - private boolean includeUpper = true; - - /** - * A Query that matches documents within an range of terms. - * - * @param name The field name - */ - RangeQueryBuilder(String name) { - this.name = name; - } - - /** The from part of the range query. Null indicates unbounded. */ - public RangeQueryBuilder gt(Object from) { - this.from = from; - this.includeLower = false; - return this; - } - - /** The from part of the range query. Null indicates unbounded. */ - public RangeQueryBuilder gte(Object from) { - this.from = from; - this.includeLower = true; - return this; - } - - /** The from part of the range query. Null indicates unbounded. */ - public RangeQueryBuilder gte(int from) { - this.from = from; - this.includeLower = true; - return this; - } - - /** The to part of the range query. Null indicates unbounded. */ - public RangeQueryBuilder lte(Object to) { - this.to = to; - this.includeUpper = true; - return this; - } - - /** The to part of the range query. Null indicates unbounded. */ - public RangeQueryBuilder lte(int to) { - this.to = to; - this.includeUpper = true; - return this; - } - - @Override - protected void doXContent(XContentBuilder builder) throws IOException { - builder.startObject("range"); - builder.startObject(name); - - builder.field("from", from); - builder.field("to", to); - builder.field("include_lower", includeLower); - builder.field("include_upper", includeUpper); - - builder.endObject(); - builder.endObject(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/RegexpQueryBuilder.java b/java/com/google/gerrit/elasticsearch/builders/RegexpQueryBuilder.java deleted file mode 100644 index b81ec20..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/RegexpQueryBuilder.java +++ /dev/null
@@ -1,51 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; - -/** - * A Query that does fuzzy matching for a specific value. - * - * <p>A trimmed down version of org.elasticsearch.index.query.RegexpQueryBuilder. - */ -class RegexpQueryBuilder extends QueryBuilder { - - private final String name; - private final String regexp; - - /** - * Constructs a new term query. - * - * @param name The name of the field - * @param regexp The regular expression - */ - RegexpQueryBuilder(String name, String regexp) { - this.name = name; - this.regexp = regexp; - } - - @Override - protected void doXContent(XContentBuilder builder) throws IOException { - builder.startObject("regexp"); - builder.startObject(name); - - builder.field("value", regexp); - builder.field("flags_value", 65535); - - builder.endObject(); - builder.endObject(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/SearchAfterBuilder.java b/java/com/google/gerrit/elasticsearch/builders/SearchAfterBuilder.java deleted file mode 100644 index 0951217..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/SearchAfterBuilder.java +++ /dev/null
@@ -1,45 +0,0 @@ -// Copyright (C) 2022 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import com.google.gson.JsonArray; -import com.google.gson.JsonPrimitive; -import java.io.IOException; - -/** - * A trimmed down and modified version of org.elasticsearch.search.searchafter.SearchAfterBuilder. - */ -public final class SearchAfterBuilder { - private JsonArray sortValues; - - public SearchAfterBuilder(JsonArray sortValues) { - this.sortValues = sortValues; - } - - public void innerToXContent(XContentBuilder builder) throws IOException { - builder.startArray("search_after"); - for (int i = 0; i < sortValues.size(); i++) { - JsonPrimitive value = sortValues.get(i).getAsJsonPrimitive(); - if (value.isNumber()) { - builder.value(value.getAsLong()); - } else if (value.isBoolean()) { - builder.value(value.getAsBoolean()); - } else { - builder.value(value.getAsString()); - } - } - builder.endArray(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/SearchSourceBuilder.java b/java/com/google/gerrit/elasticsearch/builders/SearchSourceBuilder.java deleted file mode 100644 index 7e4ea93..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/SearchSourceBuilder.java +++ /dev/null
@@ -1,135 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import com.google.gerrit.elasticsearch.ElasticQueryAdapter; -import com.google.gson.JsonArray; -import java.io.IOException; -import java.util.List; - -/** - * A search source builder allowing to easily build search source. - * - * <p>A trimmed down and modified version of org.elasticsearch.search.builder.SearchSourceBuilder. - */ -public class SearchSourceBuilder { - private final ElasticQueryAdapter adapter; - - private QuerySourceBuilder querySourceBuilder; - - private SearchAfterBuilder searchAfterBuilder; - - private int from = -1; - - private int size = -1; - - private boolean trackTotalHits = true; - - private List<String> fieldNames; - - /** Constructs a new search source builder. */ - public SearchSourceBuilder(ElasticQueryAdapter adapter) { - this.adapter = adapter; - } - - /** Constructs a new search source builder with a search query. */ - public SearchSourceBuilder query(QueryBuilder query) { - if (this.querySourceBuilder == null) { - this.querySourceBuilder = new QuerySourceBuilder(query); - } - return this; - } - - /** From index to start the search from. Defaults to <tt>0</tt>. */ - public SearchSourceBuilder from(int from) { - this.from = from; - return this; - } - - public SearchSourceBuilder searchAfter(JsonArray sortValues) { - this.searchAfterBuilder = new SearchAfterBuilder(sortValues); - return this; - } - - /** The number of search hits to return. Defaults to <tt>10</tt>. */ - public SearchSourceBuilder size(int size) { - this.size = size; - return this; - } - - public SearchSourceBuilder trackTotalHits(boolean track) { - this.trackTotalHits = track; - return this; - } - - /** - * Sets the fields to load and return as part of the search request. If none are specified, the - * source of the document will be returned. - */ - public SearchSourceBuilder fields(List<String> fields) { - this.fieldNames = fields; - return this; - } - - @Override - public final String toString() { - try { - XContentBuilder builder = new XContentBuilder(); - toXContent(builder); - return builder.string(); - } catch (IOException ioe) { - return ""; - } - } - - private void toXContent(XContentBuilder builder) throws IOException { - builder.startObject(); - innerToXContent(builder); - builder.endObject(); - } - - private void innerToXContent(XContentBuilder builder) throws IOException { - if (from != -1) { - builder.field("from", from); - } - if (size != -1) { - builder.field("size", size); - } - - if (!trackTotalHits) { - builder.field("track_total_hits", false); - } - - if (querySourceBuilder != null) { - querySourceBuilder.innerToXContent(builder); - } - - if (fieldNames != null) { - if (fieldNames.size() == 1) { - builder.field(adapter.searchFilteringName(), fieldNames.get(0)); - } else { - builder.startArray(adapter.searchFilteringName()); - for (String fieldName : fieldNames) { - builder.value(fieldName); - } - builder.endArray(); - } - } - - if (searchAfterBuilder != null) { - searchAfterBuilder.innerToXContent(builder); - } - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/TermQueryBuilder.java b/java/com/google/gerrit/elasticsearch/builders/TermQueryBuilder.java deleted file mode 100644 index 2b407c6..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/TermQueryBuilder.java +++ /dev/null
@@ -1,67 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import java.io.IOException; - -/** - * A Query that matches documents containing a term. - * - * <p>A trimmed down version of org.elasticsearch.index.query.TermQueryBuilder. - */ -class TermQueryBuilder extends QueryBuilder { - - private final String name; - - private final Object value; - - /** - * Constructs a new term query. - * - * @param name The name of the field - * @param value The value of the term - */ - TermQueryBuilder(String name, String value) { - this(name, (Object) value); - } - - /** - * Constructs a new term query. - * - * @param name The name of the field - * @param value The value of the term - */ - TermQueryBuilder(String name, int value) { - this(name, (Object) value); - } - - /** - * Constructs a new term query. - * - * @param name The name of the field - * @param value The value of the term - */ - private TermQueryBuilder(String name, Object value) { - this.name = name; - this.value = value; - } - - @Override - protected void doXContent(XContentBuilder builder) throws IOException { - builder.startObject("term"); - builder.field(name, value); - builder.endObject(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/builders/XContentBuilder.java b/java/com/google/gerrit/elasticsearch/builders/XContentBuilder.java deleted file mode 100644 index 853596d..0000000 --- a/java/com/google/gerrit/elasticsearch/builders/XContentBuilder.java +++ /dev/null
@@ -1,170 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project, 2009-2015 Elasticsearch -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.builders; - -import static java.nio.charset.StandardCharsets.UTF_8; -import static java.time.format.DateTimeFormatter.ISO_INSTANT; - -import com.fasterxml.jackson.core.JsonEncoding; -import com.fasterxml.jackson.core.JsonFactory; -import com.fasterxml.jackson.core.JsonGenerator; -import com.fasterxml.jackson.core.json.JsonReadFeature; -import com.fasterxml.jackson.core.json.JsonWriteFeature; -import java.io.ByteArrayOutputStream; -import java.io.Closeable; -import java.io.IOException; -import java.util.Date; - -/** A trimmed down and modified version of org.elasticsearch.common.xcontent.XContentBuilder. */ -public final class XContentBuilder implements Closeable { - - private final JsonGenerator generator; - - private final ByteArrayOutputStream bos = new ByteArrayOutputStream(); - - /** - * Constructs a new builder. Make sure to call {@link #close()} when the builder is done with. - * Inspired from org.elasticsearch.common.xcontent.json.JsonXContent static block. - */ - public XContentBuilder() throws IOException { - this.generator = - JsonFactory.builder() - .configure(JsonReadFeature.ALLOW_UNQUOTED_FIELD_NAMES, true) - .configure(JsonWriteFeature.QUOTE_FIELD_NAMES, true) - .configure(JsonReadFeature.ALLOW_JAVA_COMMENTS, true) - .configure(JsonFactory.Feature.FAIL_ON_SYMBOL_HASH_OVERFLOW, false) - .build() - .createGenerator(bos, JsonEncoding.UTF8); - } - - public XContentBuilder startObject(String name) throws IOException { - field(name); - startObject(); - return this; - } - - public XContentBuilder startObject() throws IOException { - generator.writeStartObject(); - return this; - } - - public XContentBuilder endObject() throws IOException { - generator.writeEndObject(); - return this; - } - - public void startArray(String name) throws IOException { - field(name); - startArray(); - } - - private void startArray() throws IOException { - generator.writeStartArray(); - } - - public void endArray() throws IOException { - generator.writeEndArray(); - } - - public XContentBuilder field(String name) throws IOException { - generator.writeFieldName(name); - return this; - } - - public XContentBuilder field(String name, String value) throws IOException { - field(name); - generator.writeString(value); - return this; - } - - public XContentBuilder field(String name, int value) throws IOException { - field(name); - generator.writeNumber(value); - return this; - } - - public XContentBuilder field(String name, Iterable<?> value) throws IOException { - startArray(name); - for (Object o : value) { - value(o); - } - endArray(); - return this; - } - - public XContentBuilder field(String name, Object value) throws IOException { - field(name); - writeValue(value); - return this; - } - - public XContentBuilder value(Object value) throws IOException { - writeValue(value); - return this; - } - - public XContentBuilder field(String name, boolean value) throws IOException { - field(name); - generator.writeBoolean(value); - return this; - } - - public XContentBuilder value(String value) throws IOException { - generator.writeString(value); - return this; - } - - @Override - public void close() { - try { - generator.close(); - } catch (IOException e) { - // ignore - } - } - - /** Returns a string representation of the builder (only applicable for text based xcontent). */ - public String string() { - close(); - byte[] bytesArray = bos.toByteArray(); - return new String(bytesArray, UTF_8); - } - - private void writeValue(Object value) throws IOException { - if (value == null) { - generator.writeNull(); - return; - } - Class<?> type = value.getClass(); - if (type == String.class) { - generator.writeString((String) value); - } else if (type == Integer.class) { - generator.writeNumber(((Integer) value)); - } else if (type == Long.class) { - generator.writeNumber(((Long) value)); - } else if (type == byte[].class) { - generator.writeBinary((byte[]) value); - } else if (value instanceof Date) { - generator.writeString(ISO_INSTANT.format(((Date) value).toInstant())); - } else { - // if this is a "value" object, like enum, DistanceUnit, ..., just toString it - // yea, it can be misleading when toString a Java class, but really, jackson should be used in - // that case - generator.writeString(value.toString()); - // throw new ElasticsearchIllegalArgumentException("type not supported for generic value - // conversion: " + type); - } - } -}
diff --git a/java/com/google/gerrit/elasticsearch/bulk/ActionRequest.java b/java/com/google/gerrit/elasticsearch/bulk/ActionRequest.java deleted file mode 100644 index 16b821c..0000000 --- a/java/com/google/gerrit/elasticsearch/bulk/ActionRequest.java +++ /dev/null
@@ -1,41 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.bulk; - -import com.google.gson.JsonObject; - -abstract class ActionRequest extends BulkRequest { - - private final String action; - private final String id; - private final String index; - - protected ActionRequest(String action, String id, String index) { - this.action = action; - this.id = id; - this.index = index; - } - - @Override - protected String getRequest() { - JsonObject properties = new JsonObject(); - properties.addProperty("_id", id); - properties.addProperty("_index", index); - - JsonObject jsonAction = new JsonObject(); - jsonAction.add(action, properties); - return jsonAction.toString() + System.lineSeparator(); - } -}
diff --git a/java/com/google/gerrit/elasticsearch/bulk/BulkRequest.java b/java/com/google/gerrit/elasticsearch/bulk/BulkRequest.java deleted file mode 100644 index be5ad8d..0000000 --- a/java/com/google/gerrit/elasticsearch/bulk/BulkRequest.java +++ /dev/null
@@ -1,43 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.bulk; - -import java.util.ArrayList; -import java.util.List; - -public abstract class BulkRequest { - - private final List<BulkRequest> requests = new ArrayList<>(); - - protected BulkRequest() { - add(this); - } - - public BulkRequest add(BulkRequest request) { - requests.add(request); - return this; - } - - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - for (BulkRequest request : requests) { - builder.append(request.getRequest()); - } - return builder.toString(); - } - - protected abstract String getRequest(); -}
diff --git a/java/com/google/gerrit/elasticsearch/bulk/UpdateRequest.java b/java/com/google/gerrit/elasticsearch/bulk/UpdateRequest.java deleted file mode 100644 index 196b8d6..0000000 --- a/java/com/google/gerrit/elasticsearch/bulk/UpdateRequest.java +++ /dev/null
@@ -1,63 +0,0 @@ -// Copyright (C) 2018 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.elasticsearch.bulk; - -import static java.util.stream.Collectors.toList; - -import com.google.common.collect.ImmutableSet; -import com.google.common.collect.Iterables; -import com.google.common.collect.Streams; -import com.google.gerrit.elasticsearch.builders.XContentBuilder; -import com.google.gerrit.index.Schema; -import com.google.gerrit.index.Schema.Values; -import java.io.IOException; - -public class UpdateRequest<V> extends BulkRequest { - - private final Schema<V> schema; - private final V v; - private final ImmutableSet<String> skipFields; - - public UpdateRequest(Schema<V> schema, V v, ImmutableSet<String> skipFields) { - this.schema = schema; - this.v = v; - this.skipFields = skipFields; - } - - @Override - protected String getRequest() { - try (XContentBuilder closeable = new XContentBuilder()) { - XContentBuilder builder = closeable.startObject(); - for (Values<V> values : schema.buildFields(v, skipFields)) { - String name = values.getField().getName(); - if (values.getField().isRepeatable()) { - builder.field(name, Streams.stream(values.getValues()).collect(toList())); - } else { - Object element = Iterables.getOnlyElement(values.getValues(), ""); - if (shouldAddElement(element)) { - builder.field(name, element); - } - } - } - return builder.endObject().string() + System.lineSeparator(); - } catch (IOException e) { - return e.toString(); - } - } - - private boolean shouldAddElement(Object element) { - return !(element instanceof String) || !((String) element).isEmpty(); - } -}
diff --git a/java/com/google/gerrit/entities/AccessSection.java b/java/com/google/gerrit/entities/AccessSection.java index d97bca8..8ae0a5d 100644 --- a/java/com/google/gerrit/entities/AccessSection.java +++ b/java/com/google/gerrit/entities/AccessSection.java
@@ -18,12 +18,14 @@ import static java.util.Objects.requireNonNull; import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; import com.google.common.collect.ImmutableList; import com.google.gerrit.common.Nullable; import java.util.ArrayList; import java.util.List; import java.util.Optional; import java.util.function.Consumer; +import java.util.regex.Pattern; /** Portion of a {@link Project} describing access rules. */ @AutoValue @@ -42,6 +44,20 @@ /** Name of the access section. It could be a ref pattern or something else. */ public abstract String getName(); + /** + * A compiled regular expression in case {@link #getName()} is a regular expression. This is + * memoized to save callers from compiling patterns for every use. + */ + @Memoized + public Optional<Pattern> getNamePattern() { + if (isValidRefSectionName(getName()) + && getName().startsWith(REGEX_PREFIX) + && !getName().contains("${")) { + return Optional.of(Pattern.compile(getName())); + } + return Optional.empty(); + } + public abstract ImmutableList<Permission> getPermissions(); public static AccessSection create(String name) { @@ -52,7 +68,7 @@ return new AutoValue_AccessSection.Builder().setName(name).setPermissions(ImmutableList.of()); } - /** @return true if the name is likely to be a valid reference section name. */ + /** Returns true if the name is likely to be a valid reference section name. */ public static boolean isValidRefSectionName(String name) { return name.startsWith("refs/") || name.startsWith("^refs/"); }
diff --git a/java/com/google/gerrit/entities/AccountGroup.java b/java/com/google/gerrit/entities/AccountGroup.java index 0b2a346..001a544 100644 --- a/java/com/google/gerrit/entities/AccountGroup.java +++ b/java/com/google/gerrit/entities/AccountGroup.java
@@ -54,7 +54,7 @@ return uuid(); } - /** @return true if the UUID is for a group managed within Gerrit. */ + /** Returns true if the UUID is for a group managed within Gerrit. */ public boolean isInternalGroup() { return get().matches("^[0-9a-f]{40}$"); }
diff --git a/java/com/google/gerrit/entities/Address.java b/java/com/google/gerrit/entities/Address.java index 2324330..5d63476 100644 --- a/java/com/google/gerrit/entities/Address.java +++ b/java/com/google/gerrit/entities/Address.java
@@ -15,6 +15,7 @@ package com.google.gerrit.entities; import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; import com.google.gerrit.common.Nullable; /** Represents an address (name + email) in an email message. */ @@ -66,8 +67,9 @@ public abstract String email(); + @Memoized @Override - public final int hashCode() { + public int hashCode() { return email().hashCode(); }
diff --git a/java/com/google/gerrit/entities/CachedProjectConfig.java b/java/com/google/gerrit/entities/CachedProjectConfig.java index 2a94bc8..76e35db 100644 --- a/java/com/google/gerrit/entities/CachedProjectConfig.java +++ b/java/com/google/gerrit/entities/CachedProjectConfig.java
@@ -18,6 +18,7 @@ import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; +import com.google.common.collect.ImmutableSortedMap; import com.google.common.flogger.FluentLogger; import java.util.Collection; import java.util.List; @@ -69,7 +70,7 @@ public abstract AccountsSection getAccountsSection(); /** Returns a map of {@link AccessSection}s keyed by their name. */ - public abstract ImmutableMap<String, AccessSection> getAccessSections(); + public abstract ImmutableSortedMap<String, AccessSection> getAccessSections(); /** Returns the {@link AccessSection} with to the given name. */ public Optional<AccessSection> getAccessSection(String refName) { @@ -95,6 +96,9 @@ /** Returns the {@link LabelType}s keyed by their name. */ public abstract ImmutableMap<String, LabelType> getLabelSections(); + /** Returns the {@link SubmitRequirement}s keyed by their name. */ + public abstract ImmutableMap<String, SubmitRequirement> getSubmitRequirementSections(); + /** Returns configured {@link ConfiguredMimeTypes}s. */ public abstract ConfiguredMimeTypes getMimeTypes(); @@ -169,6 +173,11 @@ return this; } + public Builder addSubmitRequirementSection(SubmitRequirement submitRequirement) { + submitRequirementSectionsBuilder().put(submitRequirement.name(), submitRequirement); + return this; + } + public abstract Builder setMimeTypes(ConfiguredMimeTypes value); public Builder addSubscribeSection(SubscribeSection subscribeSection) { @@ -227,7 +236,7 @@ protected abstract ImmutableMap.Builder<AccountGroup.UUID, GroupReference> groupsBuilder(); - protected abstract ImmutableMap.Builder<String, AccessSection> accessSectionsBuilder(); + protected abstract ImmutableSortedMap.Builder<String, AccessSection> accessSectionsBuilder(); protected abstract ImmutableMap.Builder<String, ContributorAgreement> contributorAgreementsBuilder(); @@ -236,6 +245,9 @@ protected abstract ImmutableMap.Builder<String, LabelType> labelSectionsBuilder(); + protected abstract ImmutableMap.Builder<String, SubmitRequirement> + submitRequirementSectionsBuilder(); + protected abstract ImmutableMap.Builder<Project.NameKey, SubscribeSection> subscribeSectionsBuilder();
diff --git a/java/com/google/gerrit/entities/Change.java b/java/com/google/gerrit/entities/Change.java index ca13db9..d1826bc 100644 --- a/java/com/google/gerrit/entities/Change.java +++ b/java/com/google/gerrit/entities/Change.java
@@ -443,9 +443,6 @@ /** Globally assigned unique identifier of the change */ protected Key changeKey; - /** optimistic locking */ - protected int rowVersion; - /** When this change was first introduced into the database. */ protected Timestamp createdOn; @@ -526,7 +523,6 @@ assignee = other.assignee; changeId = other.changeId; changeKey = other.changeKey; - rowVersion = other.rowVersion; createdOn = other.createdOn; lastUpdatedOn = other.lastUpdatedOn; owner = other.owner; @@ -587,10 +583,6 @@ lastUpdatedOn = now; } - public int getRowVersion() { - return rowVersion; - } - public Account.Id getOwner() { return owner; }
diff --git a/java/com/google/gerrit/entities/ChangeMessage.java b/java/com/google/gerrit/entities/ChangeMessage.java index f34cc7d..cb56c31 100644 --- a/java/com/google/gerrit/entities/ChangeMessage.java +++ b/java/com/google/gerrit/entities/ChangeMessage.java
@@ -19,8 +19,16 @@ import java.sql.Timestamp; import java.util.Objects; -/** A message attached to a {@link Change}. */ +/** + * A message attached to a {@link Change}. This message is persisted in data storage, that is why it + * must have template form that does not contain Gerrit user identifiable information. Hence, it + * requires processing to convert it to user-facing form. + * + * <p>These messages are normally auto-generated by gerrit operations, but might also incorporate + * user input. + */ public final class ChangeMessage { + public static Key key(Change.Id changeId, String uuid) { return new AutoValue_ChangeMessage_Key(changeId, uuid); } @@ -40,7 +48,10 @@ /** When this comment was drafted. */ protected Timestamp writtenOn; - /** The text left by the user. */ + /** + * The text left by the user or Gerrit system in template form, that is free of Gerrit User + * Identifiable Information and can be persisted in data storage. + */ @Nullable protected String message; /** Which patchset (if any) was this message generated from? */ @@ -54,11 +65,29 @@ protected ChangeMessage() {} - public ChangeMessage(final ChangeMessage.Key k, Account.Id a, Timestamp wo, PatchSet.Id psid) { - key = k; - author = a; - writtenOn = wo; - patchset = psid; + public static ChangeMessage create( + final ChangeMessage.Key k, @Nullable Account.Id a, Timestamp wo, @Nullable PatchSet.Id psid) { + return create(k, a, wo, psid, /*messageTemplate=*/ null, /*realAuthor=*/ null, /*tag=*/ null); + } + + public static ChangeMessage create( + final ChangeMessage.Key k, + @Nullable Account.Id a, + Timestamp wo, + @Nullable PatchSet.Id psid, + @Nullable String messageTemplate, + @Nullable Account.Id realAuthor, + @Nullable String tag) { + ChangeMessage message = new ChangeMessage(); + message.key = k; + message.author = a; + message.writtenOn = wo; + message.patchset = psid; + message.message = messageTemplate; + // Use null for same real author, as before the column was added. + message.realAuthor = Objects.equals(a, realAuthor) ? null : realAuthor; + message.tag = tag; + return message; } public ChangeMessage.Key getKey() { @@ -70,54 +99,27 @@ return author; } - public void setAuthor(Account.Id accountId) { - if (author != null) { - throw new IllegalStateException("Cannot modify author once assigned"); - } - author = accountId; - } - public Account.Id getRealAuthor() { return realAuthor != null ? realAuthor : getAuthor(); } - public void setRealAuthor(Account.Id id) { - // Use null for same real author, as before the column was added. - realAuthor = Objects.equals(getAuthor(), id) ? null : id; - } - public Timestamp getWrittenOn() { return writtenOn; } - public void setWrittenOn(Timestamp ts) { - writtenOn = ts; - } - + /** Message template, as persisted in data storage. */ public String getMessage() { return message; } - public void setMessage(String s) { - message = s; - } - public String getTag() { return tag; } - public void setTag(String tag) { - this.tag = tag; - } - public PatchSet.Id getPatchSetId() { return patchset; } - public void setPatchSetId(PatchSet.Id id) { - patchset = id; - } - @Override public boolean equals(Object o) { if (!(o instanceof ChangeMessage)) {
diff --git a/java/com/google/gerrit/entities/Comment.java b/java/com/google/gerrit/entities/Comment.java index 37b8620..92bcaf6 100644 --- a/java/com/google/gerrit/entities/Comment.java +++ b/java/com/google/gerrit/entities/Comment.java
@@ -88,7 +88,7 @@ Key k = (Key) o; return Objects.equals(uuid, k.uuid) && Objects.equals(filename, k.filename) - && Objects.equals(patchSetId, k.patchSetId); + && patchSetId == k.patchSetId; } return false; } @@ -113,7 +113,7 @@ @Override public boolean equals(Object o) { if (o instanceof Identity) { - return Objects.equals(id, ((Identity) o).id); + return id == ((Identity) o).id; } return false; } @@ -180,10 +180,10 @@ public boolean equals(Object o) { if (o instanceof Range) { Range r = (Range) o; - return Objects.equals(startLine, r.startLine) - && Objects.equals(startChar, r.startChar) - && Objects.equals(endLine, r.endLine) - && Objects.equals(endChar, r.endChar); + return startLine == r.startLine + && startChar == r.startChar + && endLine == r.endLine + && endChar == r.endChar; } return false; }
diff --git a/java/com/google/gerrit/entities/CoreDownloadSchemes.java b/java/com/google/gerrit/entities/CoreDownloadSchemes.java index 9bcd365..85e55a0 100644 --- a/java/com/google/gerrit/entities/CoreDownloadSchemes.java +++ b/java/com/google/gerrit/entities/CoreDownloadSchemes.java
@@ -20,7 +20,6 @@ public static final String ANON_HTTP = "anonymous http"; public static final String HTTP = "http"; public static final String SSH = "ssh"; - public static final String REPO_DOWNLOAD = "repo"; public static final String REPO = "repo"; private CoreDownloadSchemes() {}
diff --git a/java/com/google/gerrit/entities/EmailHeader.java b/java/com/google/gerrit/entities/EmailHeader.java index 71414c7..d2be65e 100644 --- a/java/com/google/gerrit/entities/EmailHeader.java +++ b/java/com/google/gerrit/entities/EmailHeader.java
@@ -31,14 +31,14 @@ public abstract void write(Writer w) throws IOException; - public static class String extends EmailHeader { - private final java.lang.String value; + public static class StringEmailHeader extends EmailHeader { + private final String value; - public String(java.lang.String v) { + public StringEmailHeader(String v) { value = v; } - public java.lang.String getString() { + public String getString() { return value; } @@ -63,16 +63,17 @@ @Override public boolean equals(Object o) { - return (o instanceof String) && Objects.equals(value, ((String) o).value); + return (o instanceof StringEmailHeader) + && Objects.equals(value, ((StringEmailHeader) o).value); } @Override - public java.lang.String toString() { + public String toString() { return MoreObjects.toStringHelper(this).addValue(value).toString(); } } - public static boolean needsQuotedPrintable(java.lang.String value) { + public static boolean needsQuotedPrintable(String value) { for (int i = 0; i < value.length(); i++) { if (value.charAt(i) < ' ' || '~' < value.charAt(i)) { return true; @@ -99,7 +100,7 @@ } } - public static java.lang.String quotedPrintable(java.lang.String value) { + public static String quotedPrintable(String value) { final StringBuilder r = new StringBuilder(); r.append("=?UTF-8?Q?"); @@ -109,7 +110,7 @@ r.append('_'); } else if (needsQuotedPrintableWithinPhrase(cp)) { - byte[] buf = new java.lang.String(Character.toChars(cp)).getBytes(UTF_8); + byte[] buf = new String(Character.toChars(cp)).getBytes(UTF_8); for (byte b : buf) { r.append('='); r.append(Integer.toHexString((b >>> 4) & 0x0f).toUpperCase()); @@ -156,11 +157,11 @@ @Override public boolean equals(Object o) { - return (o instanceof Date) && Objects.equals(value, ((Date) o).value); + return (o instanceof Date) && value.getTime() == ((Date) o).value.getTime(); } @Override - public java.lang.String toString() { + public String toString() { return MoreObjects.toStringHelper(this).addValue(value).toString(); } } @@ -182,7 +183,7 @@ list.add(addr); } - public void remove(java.lang.String email) { + public void remove(String email) { list.removeIf(address -> address.email().equals(email)); } @@ -197,7 +198,7 @@ boolean firstAddress = true; boolean needComma = false; for (Address addr : list) { - java.lang.String s = addr.toHeaderString(); + String s = addr.toHeaderString(); if (firstAddress) { firstAddress = false; } else if (72 < len + s.length()) { @@ -226,7 +227,7 @@ } @Override - public java.lang.String toString() { + public String toString() { return MoreObjects.toStringHelper(this).addValue(list).toString(); } }
diff --git a/java/com/google/gerrit/entities/GroupDescription.java b/java/com/google/gerrit/entities/GroupDescription.java index e950257..7054bed 100644 --- a/java/com/google/gerrit/entities/GroupDescription.java +++ b/java/com/google/gerrit/entities/GroupDescription.java
@@ -22,22 +22,22 @@ public class GroupDescription { /** The Basic information required to be exposed by any Group. */ public interface Basic { - /** @return the non-null UUID of the group. */ + /** Returns the non-null UUID of the group. */ AccountGroup.UUID getGroupUUID(); - /** @return the non-null name of the group. */ + /** Returns the non-null name of the group. */ String getName(); /** - * @return optional email address to send to the group's members. If provided, Gerrit will use - * this email address to send change notifications to the group. + * Returns optional email address to send to the group's members. If provided, Gerrit will use + * this email address to send change notifications to the group. */ @Nullable String getEmailAddress(); /** - * @return optional URL to information about the group. Typically a URL to a web page that - * permits users to apply to join the group, or manage their membership. + * Returns optional URL to information about the group. Typically a URL to a web page that + * permits users to apply to join the group, or manage their membership. */ @Nullable String getUrl();
diff --git a/java/com/google/gerrit/entities/GroupReference.java b/java/com/google/gerrit/entities/GroupReference.java index 208ba0f..125153e 100644 --- a/java/com/google/gerrit/entities/GroupReference.java +++ b/java/com/google/gerrit/entities/GroupReference.java
@@ -17,6 +17,7 @@ import static java.util.Objects.requireNonNull; import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; import com.google.gerrit.common.Nullable; /** Describes a group within a projects {@link AccessSection}s. */ @@ -78,8 +79,9 @@ return "?"; } + @Memoized @Override - public final int hashCode() { + public int hashCode() { return uuid(this).hashCode(); }
diff --git a/java/com/google/gerrit/entities/ImmutableConfig.java b/java/com/google/gerrit/entities/ImmutableConfig.java index a5efc14..83a44d1 100644 --- a/java/com/google/gerrit/entities/ImmutableConfig.java +++ b/java/com/google/gerrit/entities/ImmutableConfig.java
@@ -51,27 +51,27 @@ return cfg; } - /** @see Config#getSections() */ + /** See {@link Config#getSections()} */ public Set<String> getSections() { return cfg.getSections(); } - /** @see Config#getNames(String) */ + /** See {@link Config#getNames(String)} */ public Set<String> getNames(String section) { return cfg.getNames(section); } - /** @see Config#getNames(String, String) */ + /** See {@link Config#getNames(String, String)} */ public Set<String> getNames(String section, String subsection) { return cfg.getNames(section, subsection); } - /** @see Config#getStringList(String, String, String) */ + /** See {@link Config#getStringList(String, String, String)} */ public String[] getStringList(String section, String subsection, String name) { return cfg.getStringList(section, subsection, name); } - /** @see Config#getSubsections(String) */ + /** See {@link Config#getSubsections(String)} */ public Set<String> getSubsections(String section) { return cfg.getSubsections(section); }
diff --git a/java/com/google/gerrit/entities/LabelType.java b/java/com/google/gerrit/entities/LabelType.java index 9649642..d254752 100644 --- a/java/com/google/gerrit/entities/LabelType.java +++ b/java/com/google/gerrit/entities/LabelType.java
@@ -24,6 +24,7 @@ import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.Optional; @AutoValue public abstract class LabelType { @@ -128,6 +129,8 @@ public abstract boolean isCanOverride(); + public abstract Optional<String> getCopyCondition(); + @Nullable public abstract ImmutableList<String> getRefPatterns(); @@ -239,6 +242,8 @@ public abstract Builder setCopyAnyScore(boolean copyAnyScore); + public abstract Builder setCopyCondition(@Nullable String copyCondition); + public abstract Builder setCopyMinScore(boolean copyMinScore); public abstract Builder setCopyMaxScore(boolean copyMaxScore);
diff --git a/java/com/google/gerrit/entities/LabelTypes.java b/java/com/google/gerrit/entities/LabelTypes.java index 1c38c59..55a9976 100644 --- a/java/com/google/gerrit/entities/LabelTypes.java +++ b/java/com/google/gerrit/entities/LabelTypes.java
@@ -20,6 +20,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; +import java.util.Optional; public class LabelTypes { protected List<LabelType> labelTypes; @@ -36,12 +37,12 @@ return labelTypes; } - public LabelType byLabel(LabelId labelId) { - return byLabel().get(labelId.get().toLowerCase()); + public Optional<LabelType> byLabel(LabelId labelId) { + return Optional.ofNullable(byLabel().get(labelId.get().toLowerCase())); } - public LabelType byLabel(String labelName) { - return byLabel().get(labelName.toLowerCase()); + public Optional<LabelType> byLabel(String labelName) { + return Optional.ofNullable(byLabel().get(labelName.toLowerCase())); } private Map<String, LabelType> byLabel() {
diff --git a/java/com/google/gerrit/entities/NotifyConfig.java b/java/com/google/gerrit/entities/NotifyConfig.java index 17da81f..5c0a3db 100644 --- a/java/com/google/gerrit/entities/NotifyConfig.java +++ b/java/com/google/gerrit/entities/NotifyConfig.java
@@ -15,6 +15,7 @@ package com.google.gerrit.entities; import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; import com.google.common.base.Strings; import com.google.common.collect.ImmutableSet; import com.google.gerrit.common.Nullable; @@ -106,8 +107,9 @@ return getName().compareTo(o.getName()); } + @Memoized @Override - public final int hashCode() { + public int hashCode() { return getName().hashCode(); }
diff --git a/java/com/google/gerrit/entities/Patch.java b/java/com/google/gerrit/entities/Patch.java index 856765b..2d28046 100644 --- a/java/com/google/gerrit/entities/Patch.java +++ b/java/com/google/gerrit/entities/Patch.java
@@ -78,25 +78,27 @@ public abstract String fileName(); } - /** Type of modification made to the file path. */ + /** + * Type of modification made to the file path. Ordering of values matters (used by diff cache). + */ public enum ChangeType implements CodedEnum { /** Path is being created/introduced by this patch. */ ADDED('A'), - /** Path already exists, and has updated content. */ - MODIFIED('M'), - - /** Path existed, but is being removed by this patch. */ - DELETED('D'), - /** Path existed at the source but was moved. */ RENAMED('R'), + /** Path already exists, and has updated content. */ + MODIFIED('M'), + /** Path was copied from the source. */ COPIED('C'), /** Sufficient amount of content changed to claim the file was rewritten. */ - REWRITE('W'); + REWRITE('W'), + + /** Path existed, but is being removed by this patch. */ + DELETED('D'); private final char code;
diff --git a/java/com/google/gerrit/entities/PatchSet.java b/java/com/google/gerrit/entities/PatchSet.java index 5c8f7eb..acbf697 100644 --- a/java/com/google/gerrit/entities/PatchSet.java +++ b/java/com/google/gerrit/entities/PatchSet.java
@@ -22,6 +22,7 @@ import com.google.common.base.Splitter; import com.google.common.collect.ImmutableList; import com.google.common.primitives.Ints; +import com.google.errorprone.annotations.InlineMe; import java.sql.Timestamp; import java.util.List; import java.util.Optional; @@ -41,6 +42,9 @@ * @deprecated use isChangeRef instead. */ @Deprecated + @InlineMe( + replacement = "PatchSet.isChangeRef(name)", + imports = "com.google.gerrit.entities.PatchSet") public static boolean isRef(String name) { return isChangeRef(name); } @@ -93,6 +97,12 @@ return PatchSet.id(Change.id(changeId), patchSetId); } + /** Parse a PatchSet.Id from an edit ref. */ + public static PatchSet.Id fromEditRef(String ref) { + Change.Id changeId = Change.Id.fromEditRefPart(ref); + return PatchSet.id(changeId, Ints.tryParse(ref.substring(ref.lastIndexOf('/') + 1))); + } + static int fromRef(String ref, int changeIdEnd) { // Patch set ID. int ps = changeIdEnd + 1;
diff --git a/java/com/google/gerrit/entities/PatchSetApproval.java b/java/com/google/gerrit/entities/PatchSetApproval.java index a4bb251..f853f77 100644 --- a/java/com/google/gerrit/entities/PatchSetApproval.java +++ b/java/com/google/gerrit/entities/PatchSetApproval.java
@@ -41,7 +41,7 @@ } public static Builder builder() { - return new AutoValue_PatchSetApproval.Builder().postSubmit(false); + return new AutoValue_PatchSetApproval.Builder().postSubmit(false).copied(false); } @AutoValue.Builder @@ -72,6 +72,8 @@ public abstract Builder postSubmit(boolean isPostSubmit); + public abstract Builder copied(boolean isCopied); + abstract PatchSetApproval autoBuild(); public PatchSetApproval build() { @@ -111,10 +113,12 @@ public abstract boolean postSubmit(); + public abstract boolean copied(); + public abstract Builder toBuilder(); public PatchSetApproval copyWithPatchSet(PatchSet.Id psId) { - return toBuilder().key(key(psId, key().accountId(), key().labelId())).build(); + return toBuilder().key(key(psId, key().accountId(), key().labelId())).copied(true).build(); } public PatchSet.Id patchSetId() {
diff --git a/java/com/google/gerrit/entities/Permission.java b/java/com/google/gerrit/entities/Permission.java index 322c79e..95164bd 100644 --- a/java/com/google/gerrit/entities/Permission.java +++ b/java/com/google/gerrit/entities/Permission.java
@@ -95,7 +95,7 @@ LABEL_AS_INDEX = NAMES_LC.indexOf(Permission.LABEL_AS.toLowerCase()); } - /** @return true if the name is recognized as a permission name. */ + /** Returns true if the name is recognized as a permission name. */ public static boolean isPermission(String varName) { return isLabel(varName) || isLabelAs(varName) || NAMES_LC.contains(varName.toLowerCase()); } @@ -104,22 +104,22 @@ return isLabel(varName) || isLabelAs(varName); } - /** @return true if the permission name is actually for a review label. */ + /** Returns true if the permission name is actually for a review label. */ public static boolean isLabel(String varName) { return varName.startsWith(LABEL) && LABEL.length() < varName.length(); } - /** @return true if the permission is for impersonated review labels. */ + /** Returns true if the permission is for impersonated review labels. */ public static boolean isLabelAs(String var) { return var.startsWith(LABEL_AS) && LABEL_AS.length() < var.length(); } - /** @return permission name for the given review label. */ + /** Returns permission name for the given review label. */ public static String forLabel(String labelName) { return LABEL + labelName; } - /** @return permission name to apply a label for another user. */ + /** Returns permission name to apply a label for another user. */ public static String forLabelAs(String labelName) { return LABEL_AS + labelName; }
diff --git a/java/com/google/gerrit/entities/PermissionRange.java b/java/com/google/gerrit/entities/PermissionRange.java index fa9f4c2..d283069 100644 --- a/java/com/google/gerrit/entities/PermissionRange.java +++ b/java/com/google/gerrit/entities/PermissionRange.java
@@ -46,7 +46,7 @@ defaultMax = max; } - /** @return all values between {@link #getMin()} and {@link #getMax()} */ + /** Returns all values between {@link #getMin()} and {@link #getMax()} */ public List<Integer> getValuesAsList() { ArrayList<Integer> r = new ArrayList<>(getRangeSize()); for (int i = min; i <= max; i++) { @@ -55,7 +55,7 @@ return r; } - /** @return number of values between {@link #getMin()} and {@link #getMax()} */ + /** Returns number of values between {@link #getMin()} and {@link #getMax()} */ public int getRangeSize() { return max - min; }
diff --git a/java/com/google/gerrit/entities/Project.java b/java/com/google/gerrit/entities/Project.java index ef3cbeb..617b827 100644 --- a/java/com/google/gerrit/entities/Project.java +++ b/java/com/google/gerrit/entities/Project.java
@@ -150,6 +150,7 @@ return builder; } + @Nullable public String getName() { return getNameKey() != null ? getNameKey().get() : null; } @@ -183,7 +184,7 @@ @Override public final String toString() { - return Optional.of(getName()).orElse("<null>"); + return Optional.ofNullable(getName()).orElse("<null>"); } public abstract Builder toBuilder();
diff --git a/java/com/google/gerrit/entities/SubmitRecord.java b/java/com/google/gerrit/entities/SubmitRecord.java index 860997f..4142b42 100644 --- a/java/com/google/gerrit/entities/SubmitRecord.java +++ b/java/com/google/gerrit/entities/SubmitRecord.java
@@ -68,7 +68,9 @@ } } - public Status status; + // Name of the rule that created this submit record, formatted as '$pluginName~$ruleName' + public String ruleName; + public SubmitRecord.Status status; public List<Label> labels; public List<LegacySubmitRequirement> requirements; public String errorMessage; @@ -111,7 +113,7 @@ } public String label; - public Status status; + public Label.Status status; public Account.Id appliedBy; /** @@ -158,6 +160,7 @@ */ public SubmitRecord deepCopy() { SubmitRecord copy = new SubmitRecord(); + copy.ruleName = ruleName; copy.status = status; copy.errorMessage = errorMessage; if (labels != null) {
diff --git a/java/com/google/gerrit/entities/SubmitRequirement.java b/java/com/google/gerrit/entities/SubmitRequirement.java new file mode 100644 index 0000000..13e0b53 --- /dev/null +++ b/java/com/google/gerrit/entities/SubmitRequirement.java
@@ -0,0 +1,91 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.entities; + +import com.google.auto.value.AutoValue; +import com.google.gson.Gson; +import com.google.gson.TypeAdapter; +import java.util.Optional; + +/** Entity describing a requirement that should be met for a change to become submittable. */ +@AutoValue +public abstract class SubmitRequirement { + /** Requirement name. */ + public abstract String name(); + + /** Description of what this requirement means. */ + public abstract Optional<String> description(); + + /** + * Expression of the condition that makes the requirement applicable. The expression should be + * evaluated for a specific {@link Change} and if it returns false, the requirement becomes + * irrelevant for the change (i.e. {@link #submittabilityExpression()} and {@link + * #overrideExpression()} become irrelevant). + * + * <p>An empty {@link Optional} indicates that the requirement is applicable for any change. + */ + public abstract Optional<SubmitRequirementExpression> applicabilityExpression(); + + /** + * Expression of the condition that allows the submission of a change. The expression should be + * evaluated for a specific {@link Change} and if it returns true, the requirement becomes + * fulfilled for the change. + */ + public abstract SubmitRequirementExpression submittabilityExpression(); + + /** + * Expression that, if evaluated to true, causes the submit requirement to be fulfilled, + * regardless of the submittability expression. This expression should be evaluated for a specific + * {@link Change}. + * + * <p>An empty {@link Optional} indicates that the requirement is not overridable. + */ + public abstract Optional<SubmitRequirementExpression> overrideExpression(); + + /** + * Boolean value indicating if the {@link SubmitRequirement} definition can be overridden in child + * projects. Default is false. + */ + public abstract boolean allowOverrideInChildProjects(); + + public static SubmitRequirement.Builder builder() { + return new AutoValue_SubmitRequirement.Builder(); + } + + public static TypeAdapter<SubmitRequirement> typeAdapter(Gson gson) { + return new AutoValue_SubmitRequirement.GsonTypeAdapter(gson); + } + + @AutoValue.Builder + public abstract static class Builder { + + public abstract Builder setName(String name); + + public abstract Builder setDescription(Optional<String> description); + + public abstract Builder setApplicabilityExpression( + Optional<SubmitRequirementExpression> applicabilityExpression); + + public abstract Builder setSubmittabilityExpression( + SubmitRequirementExpression submittabilityExpression); + + public abstract Builder setOverrideExpression( + Optional<SubmitRequirementExpression> overrideExpression); + + public abstract Builder setAllowOverrideInChildProjects(boolean allowOverrideInChildProjects); + + public abstract SubmitRequirement build(); + } +}
diff --git a/java/com/google/gerrit/entities/SubmitRequirementExpression.java b/java/com/google/gerrit/entities/SubmitRequirementExpression.java new file mode 100644 index 0000000..2af1379 --- /dev/null +++ b/java/com/google/gerrit/entities/SubmitRequirementExpression.java
@@ -0,0 +1,50 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.entities; + +import com.google.auto.value.AutoValue; +import com.google.common.base.Strings; +import com.google.gerrit.common.Nullable; +import com.google.gson.Gson; +import com.google.gson.TypeAdapter; +import java.util.Optional; + +/** Describe a applicability, blocking or override expression of a {@link SubmitRequirement}. */ +@AutoValue +public abstract class SubmitRequirementExpression { + + public static SubmitRequirementExpression create(String expression) { + return new AutoValue_SubmitRequirementExpression(expression); + } + + /** + * Creates a new {@link SubmitRequirementExpression}. + * + * @param expression String representation of the expression + * @return empty {@link Optional} if the input expression is null or empty, or an Optional + * containing the expression otherwise. + */ + public static Optional<SubmitRequirementExpression> of(@Nullable String expression) { + return Optional.ofNullable(Strings.emptyToNull(expression)) + .map(SubmitRequirementExpression::create); + } + + /** Returns the underlying String representing this {@link SubmitRequirementExpression}. */ + public abstract String expressionString(); + + public static TypeAdapter<SubmitRequirementExpression> typeAdapter(Gson gson) { + return new AutoValue_SubmitRequirementExpression.GsonTypeAdapter(gson); + } +}
diff --git a/java/com/google/gerrit/entities/SubmitRequirementExpressionResult.java b/java/com/google/gerrit/entities/SubmitRequirementExpressionResult.java new file mode 100644 index 0000000..900b2e2 --- /dev/null +++ b/java/com/google/gerrit/entities/SubmitRequirementExpressionResult.java
@@ -0,0 +1,182 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.entities; + +import com.google.auto.value.AutoValue; +import com.google.common.collect.ImmutableList; +import com.google.gson.Gson; +import com.google.gson.TypeAdapter; +import java.util.Optional; + +/** Result of evaluating a submit requirement expression on a given Change. */ +@AutoValue +public abstract class SubmitRequirementExpressionResult { + + /** Submit requirement expression for which this result is evaluated. */ + public abstract SubmitRequirementExpression expression(); + + /** Status of evaluation. */ + public abstract Status status(); + + /** + * Optional error message. Populated if the evaluator fails to evaluate the expression for a + * certain change. + */ + public abstract Optional<String> errorMessage(); + + /** + * List leaf predicates that are fulfilled, for example the expression + * + * <p><i>label:code-review=+2 and branch:refs/heads/master</i> + * + * <p>has two leaf predicates: + * + * <ul> + * <li>label:code-review=+2 + * <li>branch:refs/heads/master + * </ul> + * + * This method will return the leaf predicates that were fulfilled, for example if only the first + * predicate was fulfilled, the returned list will be equal to ["label:code-review=+2"]. + */ + public abstract ImmutableList<String> passingAtoms(); + + /** + * List of leaf predicates that are not fulfilled. See {@link #passingAtoms()} for more details. + */ + public abstract ImmutableList<String> failingAtoms(); + + public static SubmitRequirementExpressionResult create( + SubmitRequirementExpression expression, PredicateResult predicateResult) { + return create( + expression, + predicateResult.status() ? Status.PASS : Status.FAIL, + predicateResult.getPassingAtoms(), + predicateResult.getFailingAtoms()); + } + + public static SubmitRequirementExpressionResult create( + SubmitRequirementExpression expression, + Status status, + ImmutableList<String> passingAtoms, + ImmutableList<String> failingAtoms) { + return new AutoValue_SubmitRequirementExpressionResult( + expression, status, Optional.empty(), passingAtoms, failingAtoms); + } + + public static SubmitRequirementExpressionResult error( + SubmitRequirementExpression expression, String errorMessage) { + return new AutoValue_SubmitRequirementExpressionResult( + expression, + Status.ERROR, + Optional.of(errorMessage), + ImmutableList.of(), + ImmutableList.of()); + } + + public static TypeAdapter<SubmitRequirementExpressionResult> typeAdapter(Gson gson) { + return new AutoValue_SubmitRequirementExpressionResult.GsonTypeAdapter(gson); + } + + public enum Status { + /** Submit requirement expression is fulfilled for a given change. */ + PASS, + + /** Submit requirement expression is failing for a given change. */ + FAIL, + + /** Submit requirement expression contains invalid syntax and is not parsable. */ + ERROR + } + + /** + * Entity detailing the result of evaluating a predicate. + * + * <p>Example - branch:refs/heads/foo and has:unresolved + * + * <p>The above predicate is an "And" predicate having two child predicates: + * + * <ul> + * <li>branch:refs/heads/foo + * <li>has:unresolved + * </ul> + * + * <p>Each child predicate as well as the parent contains the result of its evaluation. + */ + @AutoValue + public abstract static class PredicateResult { + abstract ImmutableList<PredicateResult> childPredicateResults(); + + /** We only set this field for leaf predicates. */ + public abstract String predicateString(); + + /** true if the predicate is passing for a given change. */ + abstract boolean status(); + + /** Returns a list of leaf predicate results whose {@link PredicateResult#status()} is true. */ + ImmutableList<String> getPassingAtoms() { + return getAtoms(/* status= */ true).stream() + .map(PredicateResult::predicateString) + .collect(ImmutableList.toImmutableList()); + } + + /** Returns a list of leaf predicate results whose {@link PredicateResult#status()} is false. */ + ImmutableList<String> getFailingAtoms() { + return getAtoms(/* status= */ false).stream() + .map(PredicateResult::predicateString) + .collect(ImmutableList.toImmutableList()); + } + + /** + * Returns the list of leaf {@link PredicateResult} whose {@link #status()} is equal to the + * {@code status} parameter. + */ + private ImmutableList<PredicateResult> getAtoms(boolean status) { + ImmutableList.Builder<PredicateResult> atomsList = ImmutableList.builder(); + getAtomsRecursively(atomsList, status); + return atomsList.build(); + } + + private void getAtomsRecursively(ImmutableList.Builder<PredicateResult> list, boolean status) { + if (!predicateString().isEmpty() && status() == status) { + list.add(this); + return; + } + childPredicateResults().forEach(c -> c.getAtomsRecursively(list, status)); + } + + public static Builder builder() { + return new AutoValue_SubmitRequirementExpressionResult_PredicateResult.Builder(); + } + + @AutoValue.Builder + public abstract static class Builder { + public abstract Builder childPredicateResults(ImmutableList<PredicateResult> value); + + protected abstract ImmutableList.Builder<PredicateResult> childPredicateResultsBuilder(); + + public abstract Builder predicateString(String value); + + public abstract Builder status(boolean value); + + public Builder addChildPredicateResult(PredicateResult result) { + childPredicateResultsBuilder().add(result); + return this; + } + + public abstract PredicateResult build(); + } + } +}
diff --git a/java/com/google/gerrit/entities/SubmitRequirementResult.java b/java/com/google/gerrit/entities/SubmitRequirementResult.java new file mode 100644 index 0000000..13625c1 --- /dev/null +++ b/java/com/google/gerrit/entities/SubmitRequirementResult.java
@@ -0,0 +1,167 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.entities; + +import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; +import com.google.gson.Gson; +import com.google.gson.TypeAdapter; +import java.util.Optional; +import org.eclipse.jgit.lib.ObjectId; + +/** Result of evaluating a {@link SubmitRequirement} on a given Change. */ +@AutoValue +public abstract class SubmitRequirementResult { + /** Submit requirement for which this result is evaluated. */ + public abstract SubmitRequirement submitRequirement(); + + /** Result of evaluating a {@link SubmitRequirement#applicabilityExpression()} on a change. */ + public abstract Optional<SubmitRequirementExpressionResult> applicabilityExpressionResult(); + + /** + * Result of evaluating a {@link SubmitRequirement#submittabilityExpression()} ()} on a change. + */ + public abstract SubmitRequirementExpressionResult submittabilityExpressionResult(); + + /** Result of evaluating a {@link SubmitRequirement#overrideExpression()} ()} on a change. */ + public abstract Optional<SubmitRequirementExpressionResult> overrideExpressionResult(); + + /** SHA-1 of the patchset commit ID for which the submit requirement was evaluated. */ + public abstract ObjectId patchSetCommitId(); + + /** + * Whether this result was created from a legacy {@link SubmitRecord}, or by evaluating a {@link + * SubmitRequirement}. + * + * <p>If equals {@link Optional#empty()}, we treat the result as non-legacy (false). + */ + public abstract Optional<Boolean> legacy(); + + public boolean isLegacy() { + return legacy().orElse(false); + } + + @Memoized + public Status status() { + if (assertError(submittabilityExpressionResult()) + || assertError(applicabilityExpressionResult()) + || assertError(overrideExpressionResult())) { + return Status.ERROR; + } else if (assertFail(applicabilityExpressionResult())) { + return Status.NOT_APPLICABLE; + } else if (assertPass(overrideExpressionResult())) { + return Status.OVERRIDDEN; + } else if (assertPass(submittabilityExpressionResult())) { + return Status.SATISFIED; + } else { + return Status.UNSATISFIED; + } + } + + /** Returns true if the submit requirement is fulfilled and can allow change submission. */ + @Memoized + public boolean fulfilled() { + Status s = status(); + return s == Status.SATISFIED || s == Status.OVERRIDDEN || s == Status.NOT_APPLICABLE; + } + + public static Builder builder() { + return new AutoValue_SubmitRequirementResult.Builder(); + } + + public static TypeAdapter<SubmitRequirementResult> typeAdapter(Gson gson) { + return new AutoValue_SubmitRequirementResult.GsonTypeAdapter(gson); + } + + public enum Status { + /** Submit requirement is fulfilled. */ + SATISFIED, + + /** + * Submit requirement is not satisfied. Happens when {@link + * SubmitRequirement#submittabilityExpression()} evaluates to false. + */ + UNSATISFIED, + + /** + * Submit requirement is overridden. Happens when {@link SubmitRequirement#overrideExpression()} + * evaluates to true. + */ + OVERRIDDEN, + + /** + * Submit requirement is not applicable for a given change. Happens when {@link + * SubmitRequirement#applicabilityExpression()} evaluates to false. + */ + NOT_APPLICABLE, + + /** + * Any of the applicability, blocking or override expressions contain invalid syntax and are not + * parsable. + */ + ERROR + } + + @AutoValue.Builder + public abstract static class Builder { + public abstract Builder submitRequirement(SubmitRequirement submitRequirement); + + public abstract Builder applicabilityExpressionResult( + Optional<SubmitRequirementExpressionResult> value); + + public abstract Builder submittabilityExpressionResult(SubmitRequirementExpressionResult value); + + public abstract Builder overrideExpressionResult( + Optional<SubmitRequirementExpressionResult> value); + + public abstract Builder patchSetCommitId(ObjectId value); + + public abstract Builder legacy(Optional<Boolean> value); + + public abstract SubmitRequirementResult build(); + } + + private boolean assertPass(Optional<SubmitRequirementExpressionResult> expressionResult) { + return assertStatus(expressionResult, SubmitRequirementExpressionResult.Status.PASS); + } + + private boolean assertPass(SubmitRequirementExpressionResult expressionResult) { + return assertStatus(expressionResult, SubmitRequirementExpressionResult.Status.PASS); + } + + private boolean assertFail(Optional<SubmitRequirementExpressionResult> expressionResult) { + return assertStatus(expressionResult, SubmitRequirementExpressionResult.Status.FAIL); + } + + private boolean assertError(Optional<SubmitRequirementExpressionResult> expressionResult) { + return assertStatus(expressionResult, SubmitRequirementExpressionResult.Status.ERROR); + } + + private boolean assertError(SubmitRequirementExpressionResult expressionResult) { + return assertStatus(expressionResult, SubmitRequirementExpressionResult.Status.ERROR); + } + + private boolean assertStatus( + SubmitRequirementExpressionResult expressionResult, + SubmitRequirementExpressionResult.Status status) { + return expressionResult.status() == status; + } + + private boolean assertStatus( + Optional<SubmitRequirementExpressionResult> expressionResult, + SubmitRequirementExpressionResult.Status status) { + return expressionResult.isPresent() && assertStatus(expressionResult.get(), status); + } +}
diff --git a/java/com/google/gerrit/entities/SubscribeSection.java b/java/com/google/gerrit/entities/SubscribeSection.java index b95517c..574cae8 100644 --- a/java/com/google/gerrit/entities/SubscribeSection.java +++ b/java/com/google/gerrit/entities/SubscribeSection.java
@@ -99,9 +99,10 @@ public ImmutableSet<BranchNameKey> getDestinationBranches( BranchNameKey src, Collection<Ref> allRefsInRefsHeads) { Set<BranchNameKey> ret = new HashSet<>(); - logger.atFine().log("Inspecting SubscribeSection %s", this); - for (RefSpec r : matchingRefSpecs()) { - logger.atFine().log("Inspecting [matching] ref %s", r); + + ImmutableList<RefSpec> matching = matchingRefSpecs(); + ImmutableList<RefSpec> multiMatch = multiMatchRefSpecs(); + for (RefSpec r : matching) { if (!r.matchSource(src.branch())) { continue; } @@ -118,8 +119,7 @@ } } - for (RefSpec r : multiMatchRefSpecs()) { - logger.atFine().log("Inspecting [all] ref %s", r); + for (RefSpec r : multiMatch) { if (!r.matchSource(src.branch())) { continue; } @@ -133,7 +133,9 @@ } } } - logger.atFine().log("Returning possible branches: %s for project %s", ret, project()); + logger.atFine().log( + "getDestinationBranches(%s): %s. matching refs: %s, multimatch refs: %s", + this, ret, matching, multiMatch); return ImmutableSet.copyOf(ret); }
diff --git a/java/com/google/gerrit/entities/converter/ChangeMessageProtoConverter.java b/java/com/google/gerrit/entities/converter/ChangeMessageProtoConverter.java index 19c121249..eb2a381 100644 --- a/java/com/google/gerrit/entities/converter/ChangeMessageProtoConverter.java +++ b/java/com/google/gerrit/entities/converter/ChangeMessageProtoConverter.java
@@ -48,6 +48,8 @@ if (writtenOn != null) { builder.setWrittenOn(writtenOn.getTime()); } + // Build proto with template representation of the message. Templates are parsed when message is + // extracted from cache. String message = changeMessage.getMessage(); if (message != null) { builder.setMessage(message); @@ -79,16 +81,15 @@ Timestamp writtenOn = proto.hasWrittenOn() ? new Timestamp(proto.getWrittenOn()) : null; PatchSet.Id patchSetId = proto.hasPatchset() ? patchSetIdConverter.fromProto(proto.getPatchset()) : null; - ChangeMessage changeMessage = new ChangeMessage(key, author, writtenOn, patchSetId); - if (proto.hasMessage()) { - changeMessage.setMessage(proto.getMessage()); - } - if (proto.hasTag()) { - changeMessage.setTag(proto.getTag()); - } - if (proto.hasRealAuthor()) { - changeMessage.setRealAuthor(accountIdConverter.fromProto(proto.getRealAuthor())); - } + // Only template representation of the message is stored in entity. Templates should be replaced + // before being served to the users. + String messageTemplate = proto.hasMessage() ? proto.getMessage() : null; + String tag = proto.hasTag() ? proto.getTag() : null; + Account.Id realAuthor = + proto.hasRealAuthor() ? accountIdConverter.fromProto(proto.getRealAuthor()) : null; + ChangeMessage changeMessage = + ChangeMessage.create(key, author, writtenOn, patchSetId, messageTemplate, realAuthor, tag); + return changeMessage; }
diff --git a/java/com/google/gerrit/entities/converter/ChangeProtoConverter.java b/java/com/google/gerrit/entities/converter/ChangeProtoConverter.java index 25e68f9..689b4aa 100644 --- a/java/com/google/gerrit/entities/converter/ChangeProtoConverter.java +++ b/java/com/google/gerrit/entities/converter/ChangeProtoConverter.java
@@ -43,7 +43,6 @@ Entities.Change.Builder builder = Entities.Change.newBuilder() .setChangeId(changeIdConverter.toProto(change.getId())) - .setRowVersion(change.getRowVersion()) .setChangeKey(changeKeyConverter.toProto(change.getKey())) .setCreatedOn(change.getCreatedOn().getTime()) .setLastUpdatedOn(change.getLastUpdatedOn().getTime())
diff --git a/java/com/google/gerrit/entities/converter/PatchSetApprovalProtoConverter.java b/java/com/google/gerrit/entities/converter/PatchSetApprovalProtoConverter.java index 78a35ff..9e77025 100644 --- a/java/com/google/gerrit/entities/converter/PatchSetApprovalProtoConverter.java +++ b/java/com/google/gerrit/entities/converter/PatchSetApprovalProtoConverter.java
@@ -39,7 +39,8 @@ .setKey(patchSetApprovalKeyProtoConverter.toProto(patchSetApproval.key())) .setValue(patchSetApproval.value()) .setGranted(patchSetApproval.granted().getTime()) - .setPostSubmit(patchSetApproval.postSubmit()); + .setPostSubmit(patchSetApproval.postSubmit()) + .setCopied(patchSetApproval.copied()); patchSetApproval.tag().ifPresent(builder::setTag); Account.Id realAccountId = patchSetApproval.realAccountId(); @@ -61,7 +62,8 @@ .key(patchSetApprovalKeyProtoConverter.fromProto(proto.getKey())) .value(proto.getValue()) .granted(new Timestamp(proto.getGranted())) - .postSubmit(proto.getPostSubmit()); + .postSubmit(proto.getPostSubmit()) + .copied(proto.getCopied()); if (proto.hasTag()) { builder.tag(proto.getTag()); }
diff --git a/java/com/google/gerrit/extensions/BUILD b/java/com/google/gerrit/extensions/BUILD index 21949f7..f36018b 100644 --- a/java/com/google/gerrit/extensions/BUILD +++ b/java/com/google/gerrit/extensions/BUILD
@@ -34,6 +34,7 @@ "//java/com/google/gerrit/common:annotations", "//lib:guava", "//lib/auto:auto-value-annotations", + "//lib/errorprone:annotations", "//lib/guice", "//lib/guice:guice-assistedinject", ],
diff --git a/java/com/google/gerrit/extensions/api/accounts/AccountApi.java b/java/com/google/gerrit/extensions/api/accounts/AccountApi.java index 6df9889..9c9c282 100644 --- a/java/com/google/gerrit/extensions/api/accounts/AccountApi.java +++ b/java/com/google/gerrit/extensions/api/accounts/AccountApi.java
@@ -14,7 +14,6 @@ package com.google.gerrit.extensions.api.accounts; -import com.google.gerrit.extensions.api.changes.StarsInput; import com.google.gerrit.extensions.client.DiffPreferencesInfo; import com.google.gerrit.extensions.client.EditPreferencesInfo; import com.google.gerrit.extensions.client.GeneralPreferencesInfo; @@ -23,7 +22,6 @@ import com.google.gerrit.extensions.common.AccountExternalIdInfo; import com.google.gerrit.extensions.common.AccountInfo; import com.google.gerrit.extensions.common.AgreementInfo; -import com.google.gerrit.extensions.common.ChangeInfo; import com.google.gerrit.extensions.common.EmailInfo; import com.google.gerrit.extensions.common.GpgKeyInfo; import com.google.gerrit.extensions.common.GroupInfo; @@ -32,7 +30,6 @@ import com.google.gerrit.extensions.restapi.RestApiException; import java.util.List; import java.util.Map; -import java.util.SortedSet; public interface AccountApi { AccountInfo get() throws RestApiException; @@ -67,12 +64,6 @@ void unstarChange(String changeId) throws RestApiException; - void setStars(String changeId, StarsInput input) throws RestApiException; - - SortedSet<String> getStars(String changeId) throws RestApiException; - - List<ChangeInfo> getStarredChanges() throws RestApiException; - List<GroupInfo> getGroups() throws RestApiException; List<EmailInfo> getEmails() throws RestApiException; @@ -221,21 +212,6 @@ } @Override - public void setStars(String changeId, StarsInput input) throws RestApiException { - throw new NotImplementedException(); - } - - @Override - public SortedSet<String> getStars(String changeId) throws RestApiException { - throw new NotImplementedException(); - } - - @Override - public List<ChangeInfo> getStarredChanges() throws RestApiException { - throw new NotImplementedException(); - } - - @Override public List<GroupInfo> getGroups() throws RestApiException { throw new NotImplementedException(); }
diff --git a/java/com/google/gerrit/extensions/api/accounts/Accounts.java b/java/com/google/gerrit/extensions/api/accounts/Accounts.java index 15fca9a..285b385 100644 --- a/java/com/google/gerrit/extensions/api/accounts/Accounts.java +++ b/java/com/google/gerrit/extensions/api/accounts/Accounts.java
@@ -38,7 +38,11 @@ */ AccountApi id(String id) throws RestApiException; - /** @see #id(String) */ + /** + * Look up an account by ID. #id(String) + * + * <p>See #id(String) + */ AccountApi id(int id) throws RestApiException; /**
diff --git a/java/com/google/gerrit/extensions/api/changes/ChangeApi.java b/java/com/google/gerrit/extensions/api/changes/ChangeApi.java index 7cbfebd..2224649 100644 --- a/java/com/google/gerrit/extensions/api/changes/ChangeApi.java +++ b/java/com/google/gerrit/extensions/api/changes/ChangeApi.java
@@ -29,6 +29,8 @@ import com.google.gerrit.extensions.common.PureRevertInfo; import com.google.gerrit.extensions.common.RevertSubmissionInfo; import com.google.gerrit.extensions.common.RobotCommentInfo; +import com.google.gerrit.extensions.common.SubmitRequirementInput; +import com.google.gerrit.extensions.common.SubmitRequirementResultInfo; import com.google.gerrit.extensions.common.SuggestedReviewerInfo; import com.google.gerrit.extensions.restapi.NotImplementedException; import com.google.gerrit.extensions.restapi.RestApiException; @@ -140,14 +142,6 @@ boolean ignored() throws RestApiException; /** - * Mark this change as reviewed/unreviewed. - * - * @param reviewed flag to decide if this change should be marked as reviewed ({@code true}) or - * unreviewed ({@code false}) - */ - void markAsReviewed(boolean reviewed) throws RestApiException; - - /** * Create a new change that reverts this change. * * @see Changes#id(int) @@ -205,13 +199,13 @@ IncludedInInfo includedIn() throws RestApiException; - default AddReviewerResult addReviewer(String reviewer) throws RestApiException { - AddReviewerInput in = new AddReviewerInput(); + default ReviewerResult addReviewer(String reviewer) throws RestApiException { + ReviewerInput in = new ReviewerInput(); in.reviewer = reviewer; return addReviewer(in); } - AddReviewerResult addReviewer(AddReviewerInput in) throws RestApiException; + ReviewerResult addReviewer(ReviewerInput in) throws RestApiException; SuggestedReviewersRequest suggestReviewers() throws RestApiException; @@ -332,7 +326,6 @@ * Get hashtags on a change. * * @return hashtags - * @throws RestApiException */ Set<String> getHashtags() throws RestApiException; @@ -367,7 +360,6 @@ * * @return comments in a map keyed by path; comments have the {@code revision} field set to * indicate their patch set. - * @throws RestApiException * @deprecated Callers should use {@link #commentsRequest()} instead */ @Deprecated @@ -380,7 +372,6 @@ * * @return comments as a list; comments have the {@code revision} field set to indicate their * patch set. - * @throws RestApiException * @deprecated Callers should use {@link #commentsRequest()} instead */ @Deprecated @@ -401,7 +392,6 @@ * * @return robot comments in a map keyed by path; robot comments have the {@code revision} field * set to indicate their patch set. - * @throws RestApiException */ Map<String, List<RobotCommentInfo>> robotComments() throws RestApiException; @@ -410,7 +400,6 @@ * * @return drafts in a map keyed by path; comments have the {@code revision} field set to indicate * their patch set. - * @throws RestApiException */ default Map<String, List<CommentInfo>> drafts() throws RestApiException { return draftsRequest().get(); @@ -421,7 +410,6 @@ * * @return drafts as a list; comments have the {@code revision} field set to indicate their patch * set. - * @throws RestApiException */ default List<CommentInfo> draftsAsList() throws RestApiException { return draftsRequest().getAsList(); @@ -439,6 +427,10 @@ ChangeInfo check(FixInput fix) throws RestApiException; + /** Returns the result of evaluating the {@link SubmitRequirementInput} input on the change. */ + SubmitRequirementResultInfo checkSubmitRequirement(SubmitRequirementInput input) + throws RestApiException; + void index() throws RestApiException; /** Check if this change is a pure revert of the change stored in revertOf. */ @@ -451,7 +443,6 @@ * Get all messages of a change with detailed account info. * * @return a list of messages sorted by their creation time. - * @throws RestApiException */ List<ChangeMessageInfo> messages() throws RestApiException; @@ -474,7 +465,6 @@ * * @return comments in a map keyed by path; comments have the {@code revision} field set to * indicate their patch set. - * @throws RestApiException */ public abstract Map<String, List<CommentInfo>> get() throws RestApiException; @@ -643,7 +633,7 @@ } @Override - public AddReviewerResult addReviewer(AddReviewerInput in) throws RestApiException { + public ReviewerResult addReviewer(ReviewerInput in) throws RestApiException { throw new NotImplementedException(); } @@ -777,6 +767,12 @@ } @Override + public SubmitRequirementResultInfo checkSubmitRequirement(SubmitRequirementInput input) + throws RestApiException { + throw new NotImplementedException(); + } + + @Override public void index() throws RestApiException { throw new NotImplementedException(); } @@ -814,11 +810,6 @@ } @Override - public void markAsReviewed(boolean reviewed) throws RestApiException { - throw new NotImplementedException(); - } - - @Override public PureRevertInfo pureRevert() throws RestApiException { throw new NotImplementedException(); }
diff --git a/java/com/google/gerrit/extensions/api/changes/FileApi.java b/java/com/google/gerrit/extensions/api/changes/FileApi.java index 26f9452..e20ac56 100644 --- a/java/com/google/gerrit/extensions/api/changes/FileApi.java +++ b/java/com/google/gerrit/extensions/api/changes/FileApi.java
@@ -29,10 +29,18 @@ /** Diff against the revision's parent version of the file. */ DiffInfo diff() throws RestApiException; - /** @param base revision id of the revision to be used as the diff base */ + /** + * Diff against the specified base + * + * @param base revision id of the revision to be used as the diff base + */ DiffInfo diff(String base) throws RestApiException; - /** @param parent 1-based parent number to diff against */ + /** + * Diff against the specified parent + * + * @param parent 1-based parent number to diff against + */ DiffInfo diff(int parent) throws RestApiException; /**
diff --git a/java/com/google/gerrit/extensions/api/changes/ReviewInput.java b/java/com/google/gerrit/extensions/api/changes/ReviewInput.java index fd445b6..11999ab 100644 --- a/java/com/google/gerrit/extensions/api/changes/ReviewInput.java +++ b/java/com/google/gerrit/extensions/api/changes/ReviewInput.java
@@ -46,6 +46,9 @@ */ public DraftHandling drafts; + /** A list of draft IDs that should be published. */ + public List<String> draftIdsToPublish; + /** Who to send email notifications to after review is stored. */ public NotifyHandling notify; @@ -62,8 +65,8 @@ */ public String onBehalfOf; - /** Reviewers that should be added to this change. */ - public List<AddReviewerInput> reviewers; + /** Reviewers that should be added to this change or removed from it. */ + public List<ReviewerInput> reviewers; /** * If true mark the change as work in progress. It is an error for both {@link #workInProgress} @@ -155,7 +158,7 @@ } public ReviewInput reviewer(String reviewer, ReviewerState state, boolean confirmed) { - AddReviewerInput input = new AddReviewerInput(); + ReviewerInput input = new ReviewerInput(); input.reviewer = reviewer; input.state = state; input.confirmed = confirmed;
diff --git a/java/com/google/gerrit/extensions/api/changes/ReviewResult.java b/java/com/google/gerrit/extensions/api/changes/ReviewResult.java index ff88bbe..95bea5b 100644 --- a/java/com/google/gerrit/extensions/api/changes/ReviewResult.java +++ b/java/com/google/gerrit/extensions/api/changes/ReviewResult.java
@@ -29,7 +29,7 @@ * Map of account or group identifier to outcome of adding as a reviewer. Null if no reviewer * additions were requested. */ - @Nullable public Map<String, AddReviewerResult> reviewers; + @Nullable public Map<String, ReviewerResult> reviewers; /** * Boolean indicating whether the change was moved out of WIP by this review. Either true or null.
diff --git a/java/com/google/gerrit/extensions/api/changes/AddReviewerInput.java b/java/com/google/gerrit/extensions/api/changes/ReviewerInput.java similarity index 97% rename from java/com/google/gerrit/extensions/api/changes/AddReviewerInput.java rename to java/com/google/gerrit/extensions/api/changes/ReviewerInput.java index bc8b28a..a7b511b 100644 --- a/java/com/google/gerrit/extensions/api/changes/AddReviewerInput.java +++ b/java/com/google/gerrit/extensions/api/changes/ReviewerInput.java
@@ -20,7 +20,7 @@ import com.google.gerrit.extensions.restapi.DefaultInput; import java.util.Map; -public class AddReviewerInput { +public class ReviewerInput { @DefaultInput public String reviewer; public Boolean confirmed; public ReviewerState state;
diff --git a/java/com/google/gerrit/extensions/api/changes/AddReviewerResult.java b/java/com/google/gerrit/extensions/api/changes/ReviewerResult.java similarity index 74% rename from java/com/google/gerrit/extensions/api/changes/AddReviewerResult.java rename to java/com/google/gerrit/extensions/api/changes/ReviewerResult.java index a23281a..1713674 100644 --- a/java/com/google/gerrit/extensions/api/changes/AddReviewerResult.java +++ b/java/com/google/gerrit/extensions/api/changes/ReviewerResult.java
@@ -18,17 +18,17 @@ import com.google.gerrit.extensions.common.AccountInfo; import java.util.List; -/** Result object representing the outcome of a request to add a reviewer. */ -public class AddReviewerResult { - /** The identifier of an account or group that was to be added as a reviewer. */ +/** Result object representing the outcome of a request to add/remove a reviewer. */ +public class ReviewerResult { + /** The identifier of an account or group that was to be added/removed as a reviewer. */ public String input; - /** If non-null, a string describing why the reviewer could not be added. */ + /** If non-null, a string describing why the reviewer could not be added/removed. */ @Nullable public String error; /** * Non-null and true if the reviewer cannot be added without explicit confirmation. This may be - * the case for groups of a certain size. + * the case for groups of a certain size. For removals, it's always false. */ @Nullable public Boolean confirm; @@ -39,17 +39,20 @@ @Nullable public List<ReviewerInfo> reviewers; /** - * List of accounts CCed on the change. The size of this list may be greater than one (e.g. when a - * group is CCed). Null if no accounts were CCed or if reviewers is non-null. + * List of new accounts CCed on the change. The size of this list may be greater than one (e.g. + * when a group is CCed). Null if no accounts were CCed. */ @Nullable public List<AccountInfo> ccs; + /** An account removed from the change. Null if no accounts were removed. */ + @Nullable public AccountInfo removed; + /** * Constructs a partially initialized result for the given reviewer. * * @param input String identifier of an account or group, from user request */ - public AddReviewerResult(String input) { + public ReviewerResult(String input) { this.input = input; } @@ -59,7 +62,7 @@ * @param reviewer String identifier of an account or group * @param error Error message */ - public AddReviewerResult(String reviewer, String error) { + public ReviewerResult(String reviewer, String error) { this(reviewer); this.error = error; } @@ -69,7 +72,7 @@ * * @param confirm Whether confirmation is needed. */ - public AddReviewerResult(String reviewer, boolean confirm) { + public ReviewerResult(String reviewer, boolean confirm) { this(reviewer); this.confirm = confirm; }
diff --git a/java/com/google/gerrit/extensions/api/changes/RevisionApi.java b/java/com/google/gerrit/extensions/api/changes/RevisionApi.java index 73e6a4e..1307516 100644 --- a/java/com/google/gerrit/extensions/api/changes/RevisionApi.java +++ b/java/com/google/gerrit/extensions/api/changes/RevisionApi.java
@@ -44,12 +44,12 @@ ReviewResult review(ReviewInput in) throws RestApiException; - default void submit() throws RestApiException { + default ChangeInfo submit() throws RestApiException { SubmitInput in = new SubmitInput(); - submit(in); + return submit(in); } - void submit(SubmitInput in) throws RestApiException; + ChangeInfo submit(SubmitInput in) throws RestApiException; default BinaryResult submitPreview() throws RestApiException { return submitPreview("zip"); @@ -160,7 +160,6 @@ * * @param format the format of the archive * @return the archive as {@link BinaryResult} - * @throws RestApiException */ BinaryResult getArchive(ArchiveFormat format) throws RestApiException; @@ -200,7 +199,7 @@ } @Override - public void submit(SubmitInput in) throws RestApiException { + public ChangeInfo submit(SubmitInput in) throws RestApiException { throw new NotImplementedException(); }
diff --git a/java/com/google/gerrit/extensions/api/changes/StarsInput.java b/java/com/google/gerrit/extensions/api/changes/StarsInput.java deleted file mode 100644 index 1207d27..0000000 --- a/java/com/google/gerrit/extensions/api/changes/StarsInput.java +++ /dev/null
@@ -1,33 +0,0 @@ -// Copyright (C) 2016 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.extensions.api.changes; - -import java.util.Set; - -public class StarsInput { - public Set<String> add; - public Set<String> remove; - - public StarsInput() {} - - public StarsInput(Set<String> add) { - this.add = add; - } - - public StarsInput(Set<String> add, Set<String> remove) { - this.add = add; - this.remove = remove; - } -}
diff --git a/java/com/google/gerrit/extensions/api/config/Config.java b/java/com/google/gerrit/extensions/api/config/Config.java index eb7288d..041e1dd 100644 --- a/java/com/google/gerrit/extensions/api/config/Config.java +++ b/java/com/google/gerrit/extensions/api/config/Config.java
@@ -17,7 +17,7 @@ import com.google.gerrit.extensions.restapi.NotImplementedException; public interface Config { - /** @return An API for getting server related configurations. */ + /** Returns an API for getting server related configurations. */ Server server(); /**
diff --git a/java/com/google/gerrit/extensions/api/config/ConsistencyCheckInfo.java b/java/com/google/gerrit/extensions/api/config/ConsistencyCheckInfo.java index e582f1b..9fb57ad 100644 --- a/java/com/google/gerrit/extensions/api/config/ConsistencyCheckInfo.java +++ b/java/com/google/gerrit/extensions/api/config/ConsistencyCheckInfo.java
@@ -14,6 +14,7 @@ package com.google.gerrit.extensions.api.config; +import com.google.errorprone.annotations.FormatMethod; import java.util.List; import java.util.Objects; @@ -80,10 +81,12 @@ return status.name() + ": " + message; } + @FormatMethod public static ConsistencyProblemInfo warning(String fmt, Object... args) { return new ConsistencyProblemInfo(Status.WARNING, String.format(fmt, args)); } + @FormatMethod public static ConsistencyProblemInfo error(String fmt, Object... args) { return new ConsistencyProblemInfo(Status.ERROR, String.format(fmt, args)); }
diff --git a/java/com/google/gerrit/extensions/api/config/Server.java b/java/com/google/gerrit/extensions/api/config/Server.java index 70d1bff..8b69ded 100644 --- a/java/com/google/gerrit/extensions/api/config/Server.java +++ b/java/com/google/gerrit/extensions/api/config/Server.java
@@ -24,7 +24,7 @@ import java.util.List; public interface Server { - /** @return Version of server. */ + /** Returns version of server. */ String getVersion() throws RestApiException; ServerInfo getInfo() throws RestApiException;
diff --git a/java/com/google/gerrit/extensions/api/groups/GroupApi.java b/java/com/google/gerrit/extensions/api/groups/GroupApi.java index 067f120..e1b3a9f 100644 --- a/java/com/google/gerrit/extensions/api/groups/GroupApi.java +++ b/java/com/google/gerrit/extensions/api/groups/GroupApi.java
@@ -24,53 +24,49 @@ import java.util.List; public interface GroupApi { - /** @return group info with no {@code ListGroupsOption}s set. */ + /** Returns group info with no {@code ListGroupsOption}s set. */ GroupInfo get() throws RestApiException; - /** @return group info with all {@code ListGroupsOption}s set. */ + /** Returns group info with all {@code ListGroupsOption}s set. */ GroupInfo detail() throws RestApiException; - /** @return group name. */ + /** Returns group name. */ String name() throws RestApiException; /** * Set group name. * * @param name new name. - * @throws RestApiException */ void name(String name) throws RestApiException; - /** @return owning group info. */ + /** Returns owning group info. */ GroupInfo owner() throws RestApiException; /** * Set group owner. * * @param owner identifier of new group owner. - * @throws RestApiException */ void owner(String owner) throws RestApiException; - /** @return group description. */ + /** Returns group description. */ String description() throws RestApiException; /** * Set group decsription. * * @param description new description. - * @throws RestApiException */ void description(String description) throws RestApiException; - /** @return group options. */ + /** Returns group options. */ GroupOptionsInfo options() throws RestApiException; /** * Set group options. * * @param options new options. - * @throws RestApiException */ void options(GroupOptionsInfo options) throws RestApiException; @@ -78,7 +74,6 @@ * List group members, non-recursively. * * @return group members. - * @throws RestApiException */ List<AccountInfo> members() throws RestApiException; @@ -87,7 +82,6 @@ * * @param recursive whether to recursively included groups. * @return group members. - * @throws RestApiException */ List<AccountInfo> members(boolean recursive) throws RestApiException; @@ -96,7 +90,6 @@ * * @param members list of member identifiers, in any format accepted by {@link * com.google.gerrit.extensions.api.accounts.Accounts#id(String)} - * @throws RestApiException */ void addMembers(List<String> members) throws RestApiException; @@ -105,7 +98,6 @@ * * @param members list of member identifiers, in any format accepted by {@link * com.google.gerrit.extensions.api.accounts.Accounts#id(String)} - * @throws RestApiException */ default void addMembers(String... members) throws RestApiException { addMembers(Arrays.asList(members)); @@ -116,7 +108,6 @@ * * @param members list of member identifiers, in any format accepted by {@link * com.google.gerrit.extensions.api.accounts.Accounts#id(String)} - * @throws RestApiException */ void removeMembers(List<String> members) throws RestApiException; @@ -125,7 +116,6 @@ * * @param members list of member identifiers, in any format accepted by {@link * com.google.gerrit.extensions.api.accounts.Accounts#id(String)} - * @throws RestApiException */ default void removeMembers(String... members) throws RestApiException { removeMembers(Arrays.asList(members)); @@ -135,7 +125,6 @@ * Lists the subgroups of this group. * * @return the found subgroups - * @throws RestApiException */ List<GroupInfo> includedGroups() throws RestApiException; @@ -143,7 +132,6 @@ * Adds subgroups to this group. * * @param groups list of group identifiers, in any format accepted by {@link Groups#id(String)} - * @throws RestApiException */ void addGroups(List<String> groups) throws RestApiException; @@ -151,7 +139,6 @@ * Adds subgroups to this group. * * @param groups list of group identifiers, in any format accepted by {@link Groups#id(String)} - * @throws RestApiException */ default void addGroups(String... groups) throws RestApiException { addGroups(Arrays.asList(groups)); @@ -161,7 +148,6 @@ * Removes subgroups from this group. * * @param groups list of group identifiers, in any format accepted by {@link Groups#id(String)} - * @throws RestApiException */ void removeGroups(List<String> groups) throws RestApiException; @@ -169,7 +155,6 @@ * Removes subgroups from this group. * * @param groups list of group identifiers, in any format accepted by {@link Groups#id(String)} - * @throws RestApiException */ default void removeGroups(String... groups) throws RestApiException { removeGroups(Arrays.asList(groups)); @@ -179,7 +164,6 @@ * Returns the audit log of the group. * * @return list of audit events of the group. - * @throws RestApiException */ List<? extends GroupAuditEventInfo> auditLog() throws RestApiException; @@ -187,8 +171,6 @@ * Reindexes the group. * * <p>Only supported for internal groups. - * - * @throws RestApiException */ void index() throws RestApiException;
diff --git a/java/com/google/gerrit/extensions/api/groups/Groups.java b/java/com/google/gerrit/extensions/api/groups/Groups.java index 81b5f47..1a46930 100644 --- a/java/com/google/gerrit/extensions/api/groups/Groups.java +++ b/java/com/google/gerrit/extensions/api/groups/Groups.java
@@ -47,7 +47,7 @@ /** Create a new group. */ GroupApi create(GroupInput input) throws RestApiException; - /** @return new request for listing groups. */ + /** Returns new request for listing groups. */ ListRequest list(); /**
diff --git a/java/com/google/gerrit/extensions/api/projects/ProjectApi.java b/java/com/google/gerrit/extensions/api/projects/ProjectApi.java index 9873995..59475a4 100644 --- a/java/com/google/gerrit/extensions/api/projects/ProjectApi.java +++ b/java/com/google/gerrit/extensions/api/projects/ProjectApi.java
@@ -24,7 +24,10 @@ import com.google.gerrit.extensions.common.ProjectInfo; import com.google.gerrit.extensions.restapi.NotImplementedException; import com.google.gerrit.extensions.restapi.RestApiException; +import java.util.Collection; import java.util.List; +import java.util.Map; +import java.util.Set; public interface ProjectApi { ProjectApi create() throws RestApiException; @@ -51,6 +54,9 @@ ConfigInfo config(ConfigInput in) throws RestApiException; + Map<String, Set<String>> commitsIn(Collection<String> commits, Collection<String> refs) + throws RestApiException; + ListRefsRequest<BranchInfo> branches(); ListRefsRequest<TagInfo> tags(); @@ -289,6 +295,12 @@ } @Override + public Map<String, Set<String>> commitsIn(Collection<String> commits, Collection<String> refs) + throws RestApiException { + throw new NotImplementedException(); + } + + @Override public void description(DescriptionInput in) throws RestApiException { throw new NotImplementedException(); }
diff --git a/java/com/google/gerrit/extensions/auth/oauth/OAuthServiceProvider.java b/java/com/google/gerrit/extensions/auth/oauth/OAuthServiceProvider.java index 417f55a..c3d760b 100644 --- a/java/com/google/gerrit/extensions/auth/oauth/OAuthServiceProvider.java +++ b/java/com/google/gerrit/extensions/auth/oauth/OAuthServiceProvider.java
@@ -40,9 +40,7 @@ * After establishing of secure communication channel, this method supossed to access the * protected resoure and retrieve the username. * - * @param token * @return OAuth user information - * @throws IOException */ OAuthUserInfo getUserInfo(OAuthToken token) throws IOException;
diff --git a/java/com/google/gerrit/extensions/client/Comment.java b/java/com/google/gerrit/extensions/client/Comment.java index 634992e..5cd13db 100644 --- a/java/com/google/gerrit/extensions/client/Comment.java +++ b/java/com/google/gerrit/extensions/client/Comment.java
@@ -70,10 +70,10 @@ public boolean equals(Object o) { if (o instanceof Range) { Range r = (Range) o; - return Objects.equals(startLine, r.startLine) - && Objects.equals(startCharacter, r.startCharacter) - && Objects.equals(endLine, r.endLine) - && Objects.equals(endCharacter, r.endCharacter); + return startLine == r.startLine + && startCharacter == r.startCharacter + && endLine == r.endLine + && endCharacter == r.endCharacter; } return false; }
diff --git a/java/com/google/gerrit/extensions/client/GeneralPreferencesInfo.java b/java/com/google/gerrit/extensions/client/GeneralPreferencesInfo.java index 21b319e..b26f435 100644 --- a/java/com/google/gerrit/extensions/client/GeneralPreferencesInfo.java +++ b/java/com/google/gerrit/extensions/client/GeneralPreferencesInfo.java
@@ -148,6 +148,7 @@ public DefaultBase defaultBaseForMerges; public Boolean publishCommentsOnPush; public Boolean disableKeyboardShortcuts; + public Boolean disableTokenHighlighting; public Boolean workInProgressByDefault; public List<MenuItem> my; public List<String> changeTable; @@ -207,6 +208,7 @@ p.defaultBaseForMerges = DefaultBase.FIRST_PARENT; p.publishCommentsOnPush = false; p.disableKeyboardShortcuts = false; + p.disableTokenHighlighting = false; p.workInProgressByDefault = false; return p; }
diff --git a/java/com/google/gerrit/extensions/client/ListChangesOption.java b/java/com/google/gerrit/extensions/client/ListChangesOption.java index 6071cc7..f1f7831 100644 --- a/java/com/google/gerrit/extensions/client/ListChangesOption.java +++ b/java/com/google/gerrit/extensions/client/ListChangesOption.java
@@ -85,7 +85,10 @@ * Skip diffstat computation that compute the insertions field (number of lines inserted) and * deletions field (number of lines deleted) */ - SKIP_DIFFSTAT(23); + SKIP_DIFFSTAT(23), + + /** Include the evaluated submit requirements for the caller. */ + SUBMIT_REQUIREMENTS(24); private final int value;
diff --git a/java/com/google/gerrit/extensions/client/ListOption.java b/java/com/google/gerrit/extensions/client/ListOption.java index dba2eee..098966a 100644 --- a/java/com/google/gerrit/extensions/client/ListOption.java +++ b/java/com/google/gerrit/extensions/client/ListOption.java
@@ -14,6 +14,7 @@ package com.google.gerrit.extensions.client; +import com.google.gerrit.extensions.restapi.BadRequestException; import java.lang.reflect.InvocationTargetException; import java.util.EnumSet; import java.util.Set; @@ -22,6 +23,22 @@ public interface ListOption { int getValue(); + static <T extends Enum<T> & ListOption> EnumSet<T> fromHexString(Class<T> clazz, String hex) + throws BadRequestException { + int parsed; + try { + parsed = Integer.parseInt(hex, 16); + } catch (IllegalArgumentException e) { + throw new BadRequestException("not a hex-encoded 32-bit integer: " + hex, e); + } + + try { + return fromBits(clazz, parsed); + } catch (IllegalArgumentException e) { + throw new BadRequestException(e.getMessage()); + } + } + static <T extends Enum<T> & ListOption> EnumSet<T> fromBits(Class<T> clazz, int v) { EnumSet<T> r = EnumSet.noneOf(clazz); T[] values; @@ -43,7 +60,7 @@ } if (v != 0) { throw new IllegalArgumentException( - "unknown " + clazz.getName() + ": " + Integer.toHexString(v)); + "unknown " + clazz.getSimpleName() + ": " + Integer.toHexString(v)); } return r; }
diff --git a/java/com/google/gerrit/extensions/client/ProjectWatchInfo.java b/java/com/google/gerrit/extensions/client/ProjectWatchInfo.java index 3c20ff7..8f5af76 100644 --- a/java/com/google/gerrit/extensions/client/ProjectWatchInfo.java +++ b/java/com/google/gerrit/extensions/client/ProjectWatchInfo.java
@@ -54,6 +54,7 @@ } @Override + @SuppressWarnings("OrphanedFormatString") public String toString() { StringBuilder b = new StringBuilder(); b.append(project);
diff --git a/java/com/google/gerrit/extensions/common/AccountInfo.java b/java/com/google/gerrit/extensions/common/AccountInfo.java index 60ba18d..4701e86 100644 --- a/java/com/google/gerrit/extensions/common/AccountInfo.java +++ b/java/com/google/gerrit/extensions/common/AccountInfo.java
@@ -27,10 +27,13 @@ * are defined in {@link AccountDetailInfo}. */ public class AccountInfo { - /** Tags are additional properties of an account. */ - public enum Tag { + /** + * Tags are additional properties of an account. These are just tags known to Gerrit core. Plugins + * may define their own. + */ + public static final class Tags { /** Tag indicating that this account is a service user. */ - SERVICE_USER + public static final String SERVICE_USER = "SERVICE_USER"; } /** The numeric ID of the account. */ @@ -74,7 +77,7 @@ public Boolean inactive; /** Tags, such as whether this account is a service user. */ - public List<Tag> tags; + public List<String> tags; public AccountInfo(Integer id) { this._accountId = id;
diff --git a/java/com/google/gerrit/extensions/common/AttentionSetInfo.java b/java/com/google/gerrit/extensions/common/AttentionSetInfo.java index ba865fb..d34ba6d 100644 --- a/java/com/google/gerrit/extensions/common/AttentionSetInfo.java +++ b/java/com/google/gerrit/extensions/common/AttentionSetInfo.java
@@ -14,6 +14,7 @@ package com.google.gerrit.extensions.common; +import com.google.gerrit.common.Nullable; import java.sql.Timestamp; import java.util.Objects; @@ -32,27 +33,40 @@ /** The human readable reason why the user was added. */ public String reason; - public AttentionSetInfo(AccountInfo account, Timestamp lastUpdate, String reason) { + /** + * The user that might be mentioned in {@link #reason} as the one who caused the update. This is + * needed since {@link #reason} contains the account in pseudonymized form and is expanded in the + * frontend. {@code null} if there is no such account. + */ + @Nullable public AccountInfo reasonAccount; + + public AttentionSetInfo( + AccountInfo account, + Timestamp lastUpdate, + String reason, + @Nullable AccountInfo reasonAccount) { this.account = account; this.lastUpdate = lastUpdate; this.reason = reason; + this.reasonAccount = reasonAccount; } + protected AttentionSetInfo() {} + @Override public boolean equals(Object o) { if (o instanceof AttentionSetInfo) { AttentionSetInfo attentionSetInfo = (AttentionSetInfo) o; return Objects.equals(account, attentionSetInfo.account) && Objects.equals(lastUpdate, attentionSetInfo.lastUpdate) - && Objects.equals(reason, attentionSetInfo.reason); + && Objects.equals(reason, attentionSetInfo.reason) + && Objects.equals(reasonAccount, attentionSetInfo.reasonAccount); } return false; } @Override public int hashCode() { - return Objects.hash(account, lastUpdate, reason); + return Objects.hash(account, lastUpdate, reason, reasonAccount); } - - protected AttentionSetInfo() {} }
diff --git a/java/com/google/gerrit/extensions/common/ChangeConfigInfo.java b/java/com/google/gerrit/extensions/common/ChangeConfigInfo.java index b387017..fc09b49 100644 --- a/java/com/google/gerrit/extensions/common/ChangeConfigInfo.java +++ b/java/com/google/gerrit/extensions/common/ChangeConfigInfo.java
@@ -19,8 +19,6 @@ public Boolean allowBlame; public Boolean showAssigneeInChangesTable; public Boolean disablePrivateChanges; - public String replyLabel; - public String replyTooltip; public int updateDelay; public Boolean submitWholeTopic; public String mergeabilityComputationBehavior;
diff --git a/java/com/google/gerrit/extensions/common/ChangeInfo.java b/java/com/google/gerrit/extensions/common/ChangeInfo.java index 9e915f5..2bb3dd7 100644 --- a/java/com/google/gerrit/extensions/common/ChangeInfo.java +++ b/java/com/google/gerrit/extensions/common/ChangeInfo.java
@@ -112,6 +112,8 @@ public List<PluginDefinedInfo> plugins; public Collection<TrackingIdInfo> trackingIds; public Collection<LegacySubmitRequirementInfo> requirements; + public Collection<SubmitRecordInfo> submitRecords; + public Collection<SubmitRequirementResultInfo> submitRequirements; public ChangeInfo() {}
diff --git a/java/com/google/gerrit/extensions/common/ChangeInfoDiffer.java b/java/com/google/gerrit/extensions/common/ChangeInfoDiffer.java index 0fff0ba..ad112d3 100644 --- a/java/com/google/gerrit/extensions/common/ChangeInfoDiffer.java +++ b/java/com/google/gerrit/extensions/common/ChangeInfoDiffer.java
@@ -63,20 +63,23 @@ */ public static ChangeInfoDifference getDifference( ChangeInfo oldChangeInfo, ChangeInfo newChangeInfo) { - return ChangeInfoDifference.create( - /* added= */ getAdded(oldChangeInfo, newChangeInfo), - /* removed= */ getAdded(newChangeInfo, oldChangeInfo)); + return ChangeInfoDifference.builder() + .setOldChangeInfo(oldChangeInfo) + .setNewChangeInfo(newChangeInfo) + .setAdded(getAdded(oldChangeInfo, newChangeInfo)) + .setRemoved(getAdded(newChangeInfo, oldChangeInfo)) + .build(); } @SuppressWarnings("unchecked") // reflection is used to construct instances of T private static <T> T getAdded(T oldValue, T newValue) { if (newValue instanceof Collection) { - List result = getAddedForCollection((Collection<?>) oldValue, (Collection<?>) newValue); + List<?> result = getAddedForCollection((Collection<?>) oldValue, (Collection<?>) newValue); return (T) result; } if (newValue instanceof Map) { - Map result = getAddedForMap((Map<?, ?>) oldValue, (Map<?, ?>) newValue); + Map<?, ?> result = getAddedForMap((Map<?, ?>) oldValue, (Map<?, ?>) newValue); return (T) result; } @@ -143,7 +146,7 @@ } } - /** @return {@code null} if nothing has been added to {@code oldCollection} */ + /** Returns {@code null} if nothing has been added to {@code oldCollection} */ private static ImmutableList<?> getAddedForCollection( Collection<?> oldCollection, Collection<?> newCollection) { ImmutableList<?> notInOldCollection = getAdditions(oldCollection, newCollection); @@ -165,7 +168,7 @@ return duplicatesMap.values().stream().flatMap(Collection::stream).collect(toImmutableList()); } - /** @return {@code null} if nothing has been added to {@code oldMap} */ + /** Returns {@code null} if nothing has been added to {@code oldMap} */ private static ImmutableMap<Object, Object> getAddedForMap(Map<?, ?> oldMap, Map<?, ?> newMap) { ImmutableMap.Builder<Object, Object> additionsBuilder = ImmutableMap.builder(); for (Map.Entry<?, ?> entry : newMap.entrySet()) {
diff --git a/java/com/google/gerrit/extensions/common/ChangeInfoDifference.java b/java/com/google/gerrit/extensions/common/ChangeInfoDifference.java index 269c673..997c3ee 100644 --- a/java/com/google/gerrit/extensions/common/ChangeInfoDifference.java +++ b/java/com/google/gerrit/extensions/common/ChangeInfoDifference.java
@@ -20,11 +20,29 @@ @AutoValue public abstract class ChangeInfoDifference { + public abstract ChangeInfo oldChangeInfo(); + + public abstract ChangeInfo newChangeInfo(); + public abstract ChangeInfo added(); public abstract ChangeInfo removed(); - public static ChangeInfoDifference create(ChangeInfo added, ChangeInfo removed) { - return new AutoValue_ChangeInfoDifference(added, removed); + public static Builder builder() { + return new AutoValue_ChangeInfoDifference.Builder(); + } + + @AutoValue.Builder + public abstract static class Builder { + + public abstract Builder setOldChangeInfo(ChangeInfo oldChangeInfo); + + public abstract Builder setNewChangeInfo(ChangeInfo newChangeInfo); + + public abstract Builder setAdded(ChangeInfo added); + + public abstract Builder setRemoved(ChangeInfo removed); + + public abstract ChangeInfoDifference build(); } }
diff --git a/java/com/google/gerrit/extensions/common/ChangeInput.java b/java/com/google/gerrit/extensions/common/ChangeInput.java index 1949ff4..ea12ef1 100644 --- a/java/com/google/gerrit/extensions/common/ChangeInput.java +++ b/java/com/google/gerrit/extensions/common/ChangeInput.java
@@ -33,6 +33,7 @@ public String baseChange; public String baseCommit; public Boolean newBranch; + public Map<String, String> validationOptions; public MergeInput merge; public AccountInput author;
diff --git a/java/com/google/gerrit/extensions/common/ChangeMessageInfo.java b/java/com/google/gerrit/extensions/common/ChangeMessageInfo.java index 10456ff..c1cb1627 100644 --- a/java/com/google/gerrit/extensions/common/ChangeMessageInfo.java +++ b/java/com/google/gerrit/extensions/common/ChangeMessageInfo.java
@@ -15,8 +15,10 @@ package com.google.gerrit.extensions.common; import java.sql.Timestamp; +import java.util.Collection; import java.util.Objects; +/** Represent {@link com.google.gerrit.entities.ChangeMessage} in the REST API. */ public class ChangeMessageInfo { public String id; public String tag; @@ -24,6 +26,7 @@ public AccountInfo realAuthor; public Timestamp date; public String message; + public Collection<AccountInfo> accountsInMessage; public Integer _revisionNumber; public ChangeMessageInfo() {} @@ -42,6 +45,7 @@ && Objects.equals(realAuthor, cmi.realAuthor) && Objects.equals(date, cmi.date) && Objects.equals(message, cmi.message) + && Objects.equals(accountsInMessage, cmi.accountsInMessage) && Objects.equals(_revisionNumber, cmi._revisionNumber); } return false; @@ -49,7 +53,8 @@ @Override public int hashCode() { - return Objects.hash(id, tag, author, realAuthor, date, message, _revisionNumber); + return Objects.hash( + id, tag, author, realAuthor, date, message, accountsInMessage, _revisionNumber); } @Override @@ -69,6 +74,8 @@ + _revisionNumber + ", message=[" + message - + "]}"; + + "], accountsForTemplate=" + + accountsInMessage + + "}"; } }
diff --git a/java/com/google/gerrit/extensions/common/CommitInfo.java b/java/com/google/gerrit/extensions/common/CommitInfo.java index 1fd8755..202b829 100644 --- a/java/com/google/gerrit/extensions/common/CommitInfo.java +++ b/java/com/google/gerrit/extensions/common/CommitInfo.java
@@ -29,6 +29,7 @@ public String subject; public String message; public List<WebLinkInfo> webLinks; + public List<WebLinkInfo> resolveConflictsWebLinks; @Override public boolean equals(Object o) { @@ -42,12 +43,14 @@ && Objects.equals(committer, c.committer) && Objects.equals(subject, c.subject) && Objects.equals(message, c.message) - && Objects.equals(webLinks, c.webLinks); + && Objects.equals(webLinks, c.webLinks) + && Objects.equals(resolveConflictsWebLinks, c.resolveConflictsWebLinks); } @Override public int hashCode() { - return Objects.hash(commit, parents, author, committer, subject, message, webLinks); + return Objects.hash( + commit, parents, author, committer, subject, message, webLinks, resolveConflictsWebLinks); } @Override @@ -64,6 +67,9 @@ if (webLinks != null) { helper.add("webLinks", webLinks); } + if (resolveConflictsWebLinks != null) { + helper.add("resolveConflictsWebLinks", resolveConflictsWebLinks); + } return helper.toString(); } }
diff --git a/java/com/google/gerrit/extensions/common/DiffInfo.java b/java/com/google/gerrit/extensions/common/DiffInfo.java index 2511e96..5a9b82b 100644 --- a/java/com/google/gerrit/extensions/common/DiffInfo.java +++ b/java/com/google/gerrit/extensions/common/DiffInfo.java
@@ -32,6 +32,8 @@ public List<ContentEntry> content; // Links to the file diff in external sites public List<DiffWebLinkInfo> webLinks; + // Links to edit the file in external sites + public List<WebLinkInfo> editWebLinks; // Binary file public Boolean binary;
diff --git a/java/com/google/gerrit/extensions/common/FileInfo.java b/java/com/google/gerrit/extensions/common/FileInfo.java index 510c2ad..c732663 100644 --- a/java/com/google/gerrit/extensions/common/FileInfo.java +++ b/java/com/google/gerrit/extensions/common/FileInfo.java
@@ -44,4 +44,24 @@ public int hashCode() { return Objects.hash(status, binary, oldPath, linesInserted, linesDeleted, sizeDelta, size); } + + @Override + public String toString() { + return "FileInfo{" + + "status=" + + status + + ", binary=" + + binary + + ", oldPath=" + + oldPath + + ", linesInserted=" + + linesInserted + + ", linesDeleted=" + + linesDeleted + + ", sizeDelta=" + + sizeDelta + + ", size=" + + size + + "}"; + } }
diff --git a/java/com/google/gerrit/extensions/common/LabelDefinitionInfo.java b/java/com/google/gerrit/extensions/common/LabelDefinitionInfo.java index 9a6d086..6f733d6 100644 --- a/java/com/google/gerrit/extensions/common/LabelDefinitionInfo.java +++ b/java/com/google/gerrit/extensions/common/LabelDefinitionInfo.java
@@ -26,6 +26,7 @@ public List<String> branches; public Boolean canOverride; public Boolean copyAnyScore; + public String copyCondition; public Boolean copyMinScore; public Boolean copyMaxScore; public Boolean copyAllScoresIfListOfFilesDidNotChange;
diff --git a/java/com/google/gerrit/extensions/common/LabelDefinitionInput.java b/java/com/google/gerrit/extensions/common/LabelDefinitionInput.java index 87cae86..38b76c1 100644 --- a/java/com/google/gerrit/extensions/common/LabelDefinitionInput.java +++ b/java/com/google/gerrit/extensions/common/LabelDefinitionInput.java
@@ -25,6 +25,8 @@ public List<String> branches; public Boolean canOverride; public Boolean copyAnyScore; + public String copyCondition; + public Boolean unsetCopyCondition; public Boolean copyMinScore; public Boolean copyMaxScore; public Boolean copyAllScoresIfListOfFilesDidNotChange;
diff --git a/java/com/google/gerrit/extensions/common/SubmitRecordInfo.java b/java/com/google/gerrit/extensions/common/SubmitRecordInfo.java new file mode 100644 index 0000000..e591963 --- /dev/null +++ b/java/com/google/gerrit/extensions/common/SubmitRecordInfo.java
@@ -0,0 +1,48 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.extensions.common; + +import java.util.List; + +/** API response containing a {@link com.google.gerrit.entities.SubmitRecord} entity. */ +public class SubmitRecordInfo { + public enum Status { + OK, + NOT_READY, + CLOSED, + FORCED, + RULE_ERROR + } + + public static class Label { + public enum Status { + OK, + REJECT, + NEED, + MAY, + IMPOSSIBLE + } + + public String label; + public Label.Status status; + public AccountInfo appliedBy; + } + + public String ruleName; + public Status status; + public List<Label> labels; + public List<LegacySubmitRequirementInfo> requirements; + public String errorMessage; +}
diff --git a/java/com/google/gerrit/extensions/common/SubmitRequirementExpressionInfo.java b/java/com/google/gerrit/extensions/common/SubmitRequirementExpressionInfo.java new file mode 100644 index 0000000..4d1fce2 --- /dev/null +++ b/java/com/google/gerrit/extensions/common/SubmitRequirementExpressionInfo.java
@@ -0,0 +1,39 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.extensions.common; + +import java.util.List; + +/** Result of evaluating a single submit requirement expression. */ +public class SubmitRequirementExpressionInfo { + + /** Submit requirement expression as a String. */ + public String expression; + + /** A boolean indicating if the expression is fulfilled on a change. */ + public boolean fulfilled; + + /** + * A list of all atoms that are passing, for example query "branch:refs/heads/foo and project:bar" + * has two atoms: ["branch:refs/heads/foo", "project:bar"]. + */ + public List<String> passingAtoms; + + /** + * A list of all atoms that are failing, for example query "branch:refs/heads/foo and project:bar" + * has two atoms: ["branch:refs/heads/foo", "project:bar"]. + */ + public List<String> failingAtoms; +}
diff --git a/java/com/google/gerrit/extensions/common/SubmitRequirementInput.java b/java/com/google/gerrit/extensions/common/SubmitRequirementInput.java new file mode 100644 index 0000000..96045d4 --- /dev/null +++ b/java/com/google/gerrit/extensions/common/SubmitRequirementInput.java
@@ -0,0 +1,45 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.extensions.common; + +/** API Input describing a submit requirement entity. */ +public class SubmitRequirementInput { + /** Submit requirement name. */ + public String name; + + /** Submit requirement description. */ + public String description; + + /** + * Query expression that can be evaluated on any change. If evaluated to true on a change, the + * submit requirement is then applicable on this change. + */ + public String applicabilityExpression; + + /** + * Query expression that can be evaluated on any change. If evaluated to true on a change, the + * submit requirement is fulfilled and not blocking change submission. + */ + public String submittabilityExpression; + + /** + * Query expression that can be evaluated on any change. If evaluated to true on a change, the + * submit requirement is overridden and not blocking change submission. + */ + public String overrideExpression; + + /** Whether this submit requirement can be overridden in child projects. */ + public Boolean allowOverrideInChildProjects; +}
diff --git a/java/com/google/gerrit/extensions/common/SubmitRequirementResultInfo.java b/java/com/google/gerrit/extensions/common/SubmitRequirementResultInfo.java new file mode 100644 index 0000000..3d50f13 --- /dev/null +++ b/java/com/google/gerrit/extensions/common/SubmitRequirementResultInfo.java
@@ -0,0 +1,67 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.extensions.common; + +/** Result of evaluating a submit requirement on a change. */ +public class SubmitRequirementResultInfo { + public enum Status { + /** Submit requirement is fulfilled. */ + SATISFIED, + + /** + * Submit requirement is not satisfied. Happens when {@code submittabilityExpressionResult} is + * not fulfilled. + */ + UNSATISFIED, + + /** + * Submit requirement is overridden. Happens when {@code overrideExpressionResult} is fulfilled. + */ + OVERRIDDEN, + + /** + * Submit requirement is not applicable for the change. Happens when {@code + * applicabilityExpressionResult} is not fulfilled. + */ + NOT_APPLICABLE, + + /** + * Any of the applicability, submittability or override expressions contain invalid syntax and + * are not parsable. + */ + ERROR + } + + /** Submit requirement name. */ + public String name; + + /** Submit requirement description. */ + public String description; + + /** Overall result (status) of evaluating this submit requirement. */ + public Status status; + + /** Whether this result was created from a legacy submit record. */ + public boolean isLegacy; + + /** Result of evaluating the applicability expression. */ + public SubmitRequirementExpressionInfo applicabilityExpressionResult; + + /** Result of evaluating the submittability expression. */ + public SubmitRequirementExpressionInfo submittabilityExpressionResult; + + /** Result of evaluating the override expression. */ + public SubmitRequirementExpressionInfo overrideExpressionResult; +}
diff --git a/java/com/google/gerrit/extensions/common/TestSubmitRuleInfo.java b/java/com/google/gerrit/extensions/common/TestSubmitRuleInfo.java index deb03b0..2af9a767 100644 --- a/java/com/google/gerrit/extensions/common/TestSubmitRuleInfo.java +++ b/java/com/google/gerrit/extensions/common/TestSubmitRuleInfo.java
@@ -19,7 +19,7 @@ import java.util.Objects; public class TestSubmitRuleInfo { - /** @see com.google.gerrit.entities.SubmitRecord.Status */ + /** See {@link com.google.gerrit.entities.SubmitRecord.Status} */ public String status; public String errorMessage;
diff --git a/java/com/google/gerrit/extensions/common/testing/CommitInfoSubject.java b/java/com/google/gerrit/extensions/common/testing/CommitInfoSubject.java index d344e18..71fc564 100644 --- a/java/com/google/gerrit/extensions/common/testing/CommitInfoSubject.java +++ b/java/com/google/gerrit/extensions/common/testing/CommitInfoSubject.java
@@ -20,6 +20,7 @@ import com.google.common.truth.Correspondence; import com.google.common.truth.FailureMetadata; +import com.google.common.truth.IterableSubject; import com.google.common.truth.StringSubject; import com.google.common.truth.Subject; import com.google.gerrit.extensions.common.CommitInfo; @@ -68,6 +69,16 @@ return check("message").that(commitInfo.message); } + public IterableSubject webLinks() { + isNotNull(); + return check("webLinks").that(commitInfo.webLinks); + } + + public IterableSubject resolveConflictsWebLinks() { + isNotNull(); + return check("resolveConflictsWebLinks").that(commitInfo.resolveConflictsWebLinks); + } + public static Correspondence<CommitInfo, String> hasCommit() { return NullAwareCorrespondence.transforming(commitInfo -> commitInfo.commit, "hasCommit"); }
diff --git a/java/com/google/gerrit/extensions/common/testing/DiffInfoSubject.java b/java/com/google/gerrit/extensions/common/testing/DiffInfoSubject.java index e258134..b800d17 100644 --- a/java/com/google/gerrit/extensions/common/testing/DiffInfoSubject.java +++ b/java/com/google/gerrit/extensions/common/testing/DiffInfoSubject.java
@@ -74,6 +74,11 @@ return check("webLinks").that(diffInfo.webLinks); } + public IterableSubject editWebLinks() { + isNotNull(); + return check("editWebLinks").that(diffInfo.editWebLinks); + } + public BooleanSubject binary() { isNotNull(); return check("binary").that(diffInfo.binary);
diff --git a/java/com/google/gerrit/extensions/conditions/BooleanCondition.java b/java/com/google/gerrit/extensions/conditions/BooleanCondition.java index 162dd99..9c354fb 100644 --- a/java/com/google/gerrit/extensions/conditions/BooleanCondition.java +++ b/java/com/google/gerrit/extensions/conditions/BooleanCondition.java
@@ -48,7 +48,7 @@ BooleanCondition() {} - /** @return evaluate the condition and return its value. */ + /** Evaluates the condition and return its value. */ public abstract boolean value(); /** @@ -63,7 +63,9 @@ * Reduce evaluation tree by cutting off branches that evaluate trivially and replacing them with * a leave note corresponding to the value the branch evaluated to. * - * <p><code> + * <p> + * + * <pre>{@code * Example 1 (T=True, F=False, C=non-trivial check): * OR * / \ => T @@ -76,7 +78,7 @@ * AND * / \ => F * T F - * </code> + * }</pre> * * <p>There is no guarantee that the resulting tree is minimal. The only guarantee made is that * branches that evaluate trivially will be cut off and replaced by primitive values.
diff --git a/java/com/google/gerrit/extensions/config/DownloadScheme.java b/java/com/google/gerrit/extensions/config/DownloadScheme.java index d81657a..15801d4 100644 --- a/java/com/google/gerrit/extensions/config/DownloadScheme.java +++ b/java/com/google/gerrit/extensions/config/DownloadScheme.java
@@ -26,12 +26,15 @@ */ public abstract String getUrl(String project); - /** @return whether this scheme requires authentication */ + /** Returns whether this scheme requires authentication */ public abstract boolean isAuthRequired(); - /** @return whether this scheme supports authentication */ + /** Returns whether this scheme supports authentication */ public abstract boolean isAuthSupported(); - /** @return whether the download scheme is enabled */ + /** Returns whether the download scheme is enabled */ public abstract boolean isEnabled(); + + /** Returns whether the download scheme is hidden in the UI */ + public abstract boolean isHidden(); }
diff --git a/java/com/google/gerrit/extensions/events/GarbageCollectorListener.java b/java/com/google/gerrit/extensions/events/GarbageCollectorListener.java index edb3e69..45c33c9 100644 --- a/java/com/google/gerrit/extensions/events/GarbageCollectorListener.java +++ b/java/com/google/gerrit/extensions/events/GarbageCollectorListener.java
@@ -22,8 +22,9 @@ public interface GarbageCollectorListener { interface Event extends ProjectEvent { /** - * @return Properties describing the result of the garbage collection performed by JGit. - * @see org.eclipse.jgit.api.GarbageCollectCommand#call() + * Returns properties describing the result of the garbage collection performed by JGit. + * + * <p>See {@link org.eclipse.jgit.api.GarbageCollectCommand#call } */ Properties getStatistics(); }
diff --git a/java/com/google/gerrit/extensions/restapi/BinaryResult.java b/java/com/google/gerrit/extensions/restapi/BinaryResult.java index bdddfd9..2ee376e 100644 --- a/java/com/google/gerrit/extensions/restapi/BinaryResult.java +++ b/java/com/google/gerrit/extensions/restapi/BinaryResult.java
@@ -63,7 +63,7 @@ private boolean base64; private String attachmentName; - /** @return the MIME type of the result, for HTTP clients. */ + /** Returns the MIME type of the result, for HTTP clients. */ public String getContentType() { Charset enc = getCharacterEncoding(); if (enc != null) { @@ -100,7 +100,7 @@ return this; } - /** @return length in bytes of the result; -1 if not known. */ + /** Returns length in bytes of the result; -1 if not known. */ public long getContentLength() { return contentLength; } @@ -111,7 +111,7 @@ return this; } - /** @return true if this result can be gzip compressed to clients. */ + /** Returns true if this result can be gzip compressed to clients. */ public boolean canGzip() { return gzip; } @@ -122,7 +122,7 @@ return this; } - /** @return true if the result must be base64 encoded. */ + /** Returns true if the result must be base64 encoded. */ public boolean isBase64() { return base64; }
diff --git a/java/com/google/gerrit/extensions/restapi/IdString.java b/java/com/google/gerrit/extensions/restapi/IdString.java index 736c3ba..b2538fa 100644 --- a/java/com/google/gerrit/extensions/restapi/IdString.java +++ b/java/com/google/gerrit/extensions/restapi/IdString.java
@@ -36,17 +36,17 @@ urlEncoded = s; } - /** @return the decoded value of the string. */ + /** Returns the decoded value of the string. */ public String get() { return Url.decode(urlEncoded); } - /** @return true if the string is the empty string. */ + /** Returns true if the string is the empty string. */ public boolean isEmpty() { return urlEncoded.isEmpty(); } - /** @return the original URL encoding supplied by the client. */ + /** Returns the original URL encoding supplied by the client. */ public String encoded() { return urlEncoded; }
diff --git a/java/com/google/gerrit/extensions/restapi/PreconditionFailedException.java b/java/com/google/gerrit/extensions/restapi/PreconditionFailedException.java index a3f156b..1b88b1a 100644 --- a/java/com/google/gerrit/extensions/restapi/PreconditionFailedException.java +++ b/java/com/google/gerrit/extensions/restapi/PreconditionFailedException.java
@@ -25,10 +25,9 @@ /** * @param msg message to return to the client describing the error. - * @cause original cause of the failed precondition. + * @param cause original cause of the failed precondition. */ public PreconditionFailedException(String msg, Throwable cause) { - super(msg); - initCause(cause); + super(msg, cause); } }
diff --git a/java/com/google/gerrit/extensions/restapi/RestResource.java b/java/com/google/gerrit/extensions/restapi/RestResource.java index cc5d48d..3c8144a 100644 --- a/java/com/google/gerrit/extensions/restapi/RestResource.java +++ b/java/com/google/gerrit/extensions/restapi/RestResource.java
@@ -26,7 +26,7 @@ /** A resource with a last modification date. */ public interface HasLastModified { - /** @return time for the Last-Modified header. HTTP truncates the header value to seconds. */ + /** Returns time for the Last-Modified header. HTTP truncates the header value to seconds. */ Timestamp getLastModified(); }
diff --git a/java/com/google/gerrit/extensions/webui/EditWebLink.java b/java/com/google/gerrit/extensions/webui/EditWebLink.java new file mode 100644 index 0000000..cd70feb --- /dev/null +++ b/java/com/google/gerrit/extensions/webui/EditWebLink.java
@@ -0,0 +1,36 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.extensions.webui; + +import com.google.gerrit.extensions.annotations.ExtensionPoint; +import com.google.gerrit.extensions.common.WebLinkInfo; + +@ExtensionPoint +public interface EditWebLink extends WebLink { + + /** + * {@link com.google.gerrit.extensions.common.WebLinkInfo} describing a link from a file to an + * external service for editing. + * + * <p>In order for the web link to be visible {@link WebLinkInfo#url} and {@link WebLinkInfo#name} + * must be set. + * + * @param projectName name of the project + * @param revision name of the revision (e.g. branch or commit ID) + * @param fileName name of the file + * @return WebLinkInfo that links to project in external service, null if there should be no link. + */ + WebLinkInfo getEditWebLink(String projectName, String revision, String fileName); +}
diff --git a/java/com/google/gerrit/extensions/webui/ResolveConflictsWebLink.java b/java/com/google/gerrit/extensions/webui/ResolveConflictsWebLink.java new file mode 100644 index 0000000..19402a9 --- /dev/null +++ b/java/com/google/gerrit/extensions/webui/ResolveConflictsWebLink.java
@@ -0,0 +1,40 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.extensions.webui; + +import com.google.gerrit.extensions.annotations.ExtensionPoint; +import com.google.gerrit.extensions.common.WebLinkInfo; + +@ExtensionPoint +public interface ResolveConflictsWebLink extends WebLink { + + /** + * {@link com.google.gerrit.extensions.common.WebLinkInfo} describing a link from a patch set to + * an external service for the purpose of resolving merge conflicts. + * + * <p>In order for the web link to be visible {@link + * com.google.gerrit.extensions.common.WebLinkInfo#url} and {@link + * com.google.gerrit.extensions.common.WebLinkInfo#name} must be set. + * + * @param projectName name of the project + * @param commit commit of the patch set + * @param commitMessage the commit message of the change + * @param branchName target branch of the change + * @return WebLinkInfo that links to patch set in external service, {@code null} if there should + * be no link. + */ + WebLinkInfo getResolveConflictsWebLink( + String projectName, String commit, String commitMessage, String branchName); +}
diff --git a/java/com/google/gerrit/extensions/webui/UiAction.java b/java/com/google/gerrit/extensions/webui/UiAction.java index b9d15d2..2f21bf3 100644 --- a/java/com/google/gerrit/extensions/webui/UiAction.java +++ b/java/com/google/gerrit/extensions/webui/UiAction.java
@@ -30,7 +30,7 @@ * the same as {@code setVisible(false)}. */ @Nullable - Description getDescription(R resource); + Description getDescription(R resource) throws Exception; /** Describes an action invokable through the web interface. */ class Description {
diff --git a/java/com/google/gerrit/extensions/webui/WebUiPlugin.java b/java/com/google/gerrit/extensions/webui/WebUiPlugin.java index 2d49e1c..4f129b0 100644 --- a/java/com/google/gerrit/extensions/webui/WebUiPlugin.java +++ b/java/com/google/gerrit/extensions/webui/WebUiPlugin.java
@@ -44,7 +44,7 @@ private String pluginName; - /** @return installed name of the plugin that provides this UI feature. */ + /** Returns installed name of the plugin that provides this UI feature. */ public final String getPluginName() { return pluginName; } @@ -54,7 +54,7 @@ this.pluginName = pluginName; } - /** @return path to initialization script within the plugin's JAR. */ + /** Returns path to initialization script within the plugin's JAR. */ public abstract String getJavaScriptResourcePath(); @Override
diff --git a/java/com/google/gerrit/git/GitUpdateFailureException.java b/java/com/google/gerrit/git/GitUpdateFailureException.java index 76ef217..7fcb828 100644 --- a/java/com/google/gerrit/git/GitUpdateFailureException.java +++ b/java/com/google/gerrit/git/GitUpdateFailureException.java
@@ -46,12 +46,12 @@ .collect(toImmutableList()); } - /** @return the names of the refs for which the update failed. */ + /** Returns the names of the refs for which the update failed. */ public ImmutableList<String> getFailedRefs() { return failures.stream().map(GitUpdateFailure::ref).collect(toImmutableList()); } - /** @return the failures that caused this exception. */ + /** Returns the failures that caused this exception. */ @UsedAt(UsedAt.Project.GOOGLE) public ImmutableList<GitUpdateFailure> getFailures() { return failures;
diff --git a/java/com/google/gerrit/gpg/CheckResult.java b/java/com/google/gerrit/gpg/CheckResult.java index 8655b2a..2743e74 100644 --- a/java/com/google/gerrit/gpg/CheckResult.java +++ b/java/com/google/gerrit/gpg/CheckResult.java
@@ -62,22 +62,22 @@ this.problems = problems; } - /** @return whether the result has status {@link Status#OK} or better. */ + /** Returns whether the result has status {@link Status#OK} or better. */ public boolean isOk() { return status.compareTo(Status.OK) >= 0; } - /** @return whether the result has status {@link Status#TRUSTED} or better. */ + /** Returns whether the result has status {@link Status#TRUSTED} or better. */ public boolean isTrusted() { return status.compareTo(Status.TRUSTED) >= 0; } - /** @return the status enum value associated with the object. */ + /** Returns the status enum value associated with the object. */ public Status getStatus() { return status; } - /** @return any problems encountered during checking. */ + /** Returns any problems encountered during checking. */ public List<String> getProblems() { return problems; }
diff --git a/java/com/google/gerrit/gpg/GerritPublicKeyChecker.java b/java/com/google/gerrit/gpg/GerritPublicKeyChecker.java index 9477cb6..71dff97 100644 --- a/java/com/google/gerrit/gpg/GerritPublicKeyChecker.java +++ b/java/com/google/gerrit/gpg/GerritPublicKeyChecker.java
@@ -26,6 +26,7 @@ import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.config.UrlFormatter; import com.google.gerrit.server.query.account.InternalAccountQuery; @@ -62,17 +63,20 @@ private final IdentifiedUser.GenericFactory userFactory; private final int maxTrustDepth; private final ImmutableMap<Long, Fingerprint> trusted; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject Factory( @GerritServerConfig Config cfg, Provider<InternalAccountQuery> accountQueryProvider, IdentifiedUser.GenericFactory userFactory, - DynamicItem<UrlFormatter> urlFormatter) { + DynamicItem<UrlFormatter> urlFormatter, + ExternalIdKeyFactory externalIdKeyFactory) { this.accountQueryProvider = accountQueryProvider; this.urlFormatter = urlFormatter; this.userFactory = userFactory; this.maxTrustDepth = cfg.getInt("receive", null, "maxTrustDepth", 0); + this.externalIdKeyFactory = externalIdKeyFactory; String[] strs = cfg.getStringList("receive", null, "trustedKey"); if (strs.length != 0) { @@ -103,6 +107,7 @@ private final Provider<InternalAccountQuery> accountQueryProvider; private final DynamicItem<UrlFormatter> urlFormatter; private final IdentifiedUser.GenericFactory userFactory; + private final ExternalIdKeyFactory externalIdKeyFactory; private IdentifiedUser expectedUser; @@ -113,6 +118,7 @@ if (factory.trusted != null) { enableTrust(factory.maxTrustDepth, factory.trusted); } + this.externalIdKeyFactory = factory.externalIdKeyFactory; } /** @@ -247,7 +253,8 @@ return sb.toString(); } - static ExternalId.Key toExtIdKey(PGPPublicKey key) { - return ExternalId.Key.create(SCHEME_GPGKEY, BaseEncoding.base16().encode(key.getFingerprint())); + ExternalId.Key toExtIdKey(PGPPublicKey key) { + return externalIdKeyFactory.create( + SCHEME_GPGKEY, BaseEncoding.base16().encode(key.getFingerprint())); } }
diff --git a/java/com/google/gerrit/gpg/PushCertificateChecker.java b/java/com/google/gerrit/gpg/PushCertificateChecker.java index 82b3892..36a4af7 100644 --- a/java/com/google/gerrit/gpg/PushCertificateChecker.java +++ b/java/com/google/gerrit/gpg/PushCertificateChecker.java
@@ -154,8 +154,11 @@ protected abstract Repository getRepository() throws IOException; /** + * Specifies whether this repository should be closed before returning froms {@link + * #check(PushCertificate)} + * * @param repo a repository previously returned by {@link #getRepository()}. - * @return whether this repository should be closed before returning from {@link + * @return true if this repository should be closed before returning from {@link * #check(PushCertificate)}. */ protected abstract boolean shouldClose(Repository repo);
diff --git a/java/com/google/gerrit/gpg/server/DeleteGpgKey.java b/java/com/google/gerrit/gpg/server/DeleteGpgKey.java index 1be37f5..e0c921d 100644 --- a/java/com/google/gerrit/gpg/server/DeleteGpgKey.java +++ b/java/com/google/gerrit/gpg/server/DeleteGpgKey.java
@@ -32,6 +32,7 @@ import com.google.gerrit.server.UserInitiated; import com.google.gerrit.server.account.AccountsUpdate; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.mail.send.DeleteKeySender; import com.google.inject.Inject; @@ -53,6 +54,7 @@ private final Provider<AccountsUpdate> accountsUpdateProvider; private final ExternalIds externalIds; private final DeleteKeySender.Factory deleteKeySenderFactory; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject DeleteGpgKey( @@ -60,12 +62,14 @@ Provider<PublicKeyStore> storeProvider, @UserInitiated Provider<AccountsUpdate> accountsUpdateProvider, ExternalIds externalIds, - DeleteKeySender.Factory deleteKeySenderFactory) { + DeleteKeySender.Factory deleteKeySenderFactory, + ExternalIdKeyFactory externalIdKeyFactory) { this.serverIdent = serverIdent; this.storeProvider = storeProvider; this.accountsUpdateProvider = accountsUpdateProvider; this.externalIds = externalIds; this.deleteKeySenderFactory = deleteKeySenderFactory; + this.externalIdKeyFactory = externalIdKeyFactory; } @Override @@ -73,7 +77,8 @@ throws RestApiException, PGPException, IOException, ConfigInvalidException { PGPPublicKey key = rsrc.getKeyRing().getPublicKey(); String fingerprint = BaseEncoding.base16().encode(key.getFingerprint()); - Optional<ExternalId> extId = externalIds.get(ExternalId.Key.create(SCHEME_GPGKEY, fingerprint)); + Optional<ExternalId> extId = + externalIds.get(externalIdKeyFactory.create(SCHEME_GPGKEY, fingerprint)); if (!extId.isPresent()) { throw new ResourceNotFoundException(fingerprint); }
diff --git a/java/com/google/gerrit/gpg/server/PostGpgKeys.java b/java/com/google/gerrit/gpg/server/PostGpgKeys.java index 1b5e06a..d46b344 100644 --- a/java/com/google/gerrit/gpg/server/PostGpgKeys.java +++ b/java/com/google/gerrit/gpg/server/PostGpgKeys.java
@@ -53,6 +53,8 @@ import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.account.AccountsUpdate; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.mail.send.AddKeySender; import com.google.gerrit.server.mail.send.DeleteKeySender; @@ -93,6 +95,8 @@ private final ExternalIds externalIds; private final Provider<AccountsUpdate> accountsUpdateProvider; private final RetryHelper retryHelper; + private final ExternalIdFactory externalIdFactory; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject PostGpgKeys( @@ -105,7 +109,9 @@ Provider<InternalAccountQuery> accountQueryProvider, ExternalIds externalIds, @UserInitiated Provider<AccountsUpdate> accountsUpdateProvider, - RetryHelper retryHelper) { + RetryHelper retryHelper, + ExternalIdFactory externalIdFactory, + ExternalIdKeyFactory externalIdKeyFactory) { this.serverIdent = serverIdent; this.self = self; this.storeProvider = storeProvider; @@ -116,6 +122,8 @@ this.externalIds = externalIds; this.accountsUpdateProvider = accountsUpdateProvider; this.retryHelper = retryHelper; + this.externalIdFactory = externalIdFactory; + this.externalIdKeyFactory = externalIdKeyFactory; } @Override @@ -140,7 +148,7 @@ throw new ResourceConflictException("GPG key already associated with another account"); } } else { - newExtIds.add(ExternalId.create(extIdKey, rsrc.getUser().getAccountId())); + newExtIds.add(externalIdFactory.create(extIdKey, rsrc.getUser().getAccountId())); } } @@ -287,7 +295,7 @@ } private ExternalId.Key toExtIdKey(byte[] fp) { - return ExternalId.Key.create(SCHEME_GPGKEY, BaseEncoding.base16().encode(fp)); + return externalIdKeyFactory.create(SCHEME_GPGKEY, BaseEncoding.base16().encode(fp)); } private Account getAccountByExternalId(ExternalId.Key extIdKey) {
diff --git a/java/com/google/gerrit/gpg/testing/TestKeys.java b/java/com/google/gerrit/gpg/testing/TestKeys.java index de66889..0423474 100644 --- a/java/com/google/gerrit/gpg/testing/TestKeys.java +++ b/java/com/google/gerrit/gpg/testing/TestKeys.java
@@ -436,13 +436,13 @@ /** * A key with an additional user ID. * - * <pre> + * <pre>{@code * pub 2048R/98C51DBF 2015-07-30 * Key fingerprint = 42B3 294D 1924 D7EB AF4A A99F 5024 BB44 98C5 1DBF * uid foo:myId * uid Testuser Five <test5@example.com> * sub 2048R/C781A9E3 2015-07-30 - * </pre> + * }</pre> */ public static TestKey validKeyWithSecondUserId() { return new TestKey( @@ -1033,13 +1033,13 @@ /** * Master Key without expiration with subkey with expiration. * - * <pre> + * <pre>{@code * pub rsa1024 2018-11-17 [C] * 5734 2C37 982A 843B 19C0 622B 6AAF 2D26 B481 02DB * uid [ultimate] Testuser 10 <testuser10@example.com> * sub rsa1024 2018-11-17 [S] [expires: 2065-11-05] * 0A4A 9660 1B96 2DFC E898 E686 4305 C92E 626E B485 - * </pre> + * }</pre> */ public static TestKey validKeyWithoutExpirationWithSubkeyWithExpiration() throws Exception { return new TestKey(
diff --git a/java/com/google/gerrit/httpd/BUILD b/java/com/google/gerrit/httpd/BUILD index cd3ebb9..ea7c609 100644 --- a/java/com/google/gerrit/httpd/BUILD +++ b/java/com/google/gerrit/httpd/BUILD
@@ -20,6 +20,7 @@ "//java/com/google/gerrit/metrics", "//java/com/google/gerrit/server", "//java/com/google/gerrit/server/audit", + "//java/com/google/gerrit/server/cancellation", "//java/com/google/gerrit/server/git/receive", "//java/com/google/gerrit/server/ioutil", "//java/com/google/gerrit/server/logging",
diff --git a/java/com/google/gerrit/httpd/CacheBasedWebSession.java b/java/com/google/gerrit/httpd/CacheBasedWebSession.java index f302095..5b62f96 100644 --- a/java/com/google/gerrit/httpd/CacheBasedWebSession.java +++ b/java/com/google/gerrit/httpd/CacheBasedWebSession.java
@@ -22,8 +22,6 @@ import com.google.gerrit.common.UsedAt; import com.google.gerrit.entities.Account; import com.google.gerrit.extensions.restapi.BadRequestException; -import com.google.gerrit.httpd.WebSessionManager.Key; -import com.google.gerrit.httpd.WebSessionManager.Val; import com.google.gerrit.httpd.restapi.ParameterParser; import com.google.gerrit.server.AccessPath; import com.google.gerrit.server.AnonymousUser; @@ -35,15 +33,13 @@ import com.google.gerrit.server.account.externalids.ExternalId; import com.google.gerrit.server.config.AuthConfig; import com.google.inject.Provider; -import com.google.inject.servlet.RequestScoped; import java.util.EnumSet; import javax.servlet.http.Cookie; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.eclipse.jgit.http.server.GitSmartHttpTools; -@RequestScoped -public abstract class CacheBasedWebSession implements WebSession { +public abstract class CacheBasedWebSession extends WebSession { @VisibleForTesting public static final String ACCOUNT_COOKIE = "GerritAccount"; @UsedAt(UsedAt.Project.PLUGIN_WEBSESSION_FLATFILE) @@ -59,8 +55,8 @@ private final AccountCache byIdCache; private Cookie outCookie; - private Key key; - private Val val; + private WebSessionManager.Key key; + private WebSessionManager.Val val; private CurrentUser user; protected CacheBasedWebSession( @@ -104,7 +100,7 @@ } private void authFromCookie(String cookie) { - key = new Key(cookie); + key = new WebSessionManager.Key(cookie); val = manager.get(key); String token = request.getHeader(XsrfConstants.XSRF_HEADER_NAME); if (val != null && token != null && token.equals(val.getAuth())) { @@ -113,7 +109,7 @@ } private void authFromQueryParameter(String accessToken) { - key = new Key(accessToken); + key = new WebSessionManager.Key(accessToken); val = manager.get(key); if (val != null) { okPaths.add(AccessPath.REST_API); @@ -207,8 +203,8 @@ /** Set the user account for this current request only. */ @Override public void setUserAccountId(Account.Id id) { - key = new Key("id:" + id); - val = new Val(id, 0, false, null, 0, null, null); + key = new WebSessionManager.Key("id:" + id); + val = new WebSessionManager.Val(id, 0, false, null, 0, null, null); user = identified.runAs(id, user, PropertyMap.EMPTY); }
diff --git a/java/com/google/gerrit/httpd/GetUserFilter.java b/java/com/google/gerrit/httpd/GetUserFilter.java index 2199411..68db98a 100644 --- a/java/com/google/gerrit/httpd/GetUserFilter.java +++ b/java/com/google/gerrit/httpd/GetUserFilter.java
@@ -40,13 +40,13 @@ public static final String USER_ATTR_KEY = "User"; - public static class Module extends ServletModule { + public static class GetUserFilterModule extends ServletModule { private final boolean reqEnabled; private final boolean resEnabled; @Inject - Module(@GerritServerConfig Config cfg) { + GetUserFilterModule(@GerritServerConfig Config cfg) { reqEnabled = cfg.getBoolean("http", "addUserAsRequestAttribute", true); resEnabled = cfg.getBoolean("http", "addUserAsResponseHeader", false); }
diff --git a/java/com/google/gerrit/httpd/GitOverHttpServlet.java b/java/com/google/gerrit/httpd/GitOverHttpServlet.java index 06f96c5..5ed0629 100644 --- a/java/com/google/gerrit/httpd/GitOverHttpServlet.java +++ b/java/com/google/gerrit/httpd/GitOverHttpServlet.java
@@ -14,7 +14,6 @@ package com.google.gerrit.httpd; -import static javax.servlet.http.HttpServletResponse.SC_INTERNAL_SERVER_ERROR; import static org.eclipse.jgit.http.server.GitSmartHttpTools.sendError; import com.google.common.annotations.VisibleForTesting; @@ -136,11 +135,11 @@ URL_REGEX = url.toString(); } - static class Module extends AbstractModule { + static class GitOverHttpServletModule extends AbstractModule { private final boolean enableReceive; - Module(boolean enableReceive) { + GitOverHttpServletModule(boolean enableReceive) { this.enableReceive = enableReceive; } @@ -506,7 +505,7 @@ if (!rsp.isCommitted()) { rsp.reset(); String msg = e instanceof PackProtocolException ? e.getMessage() : null; - sendError(req, rsp, SC_INTERNAL_SERVER_ERROR, msg); + sendError(req, rsp, UploadPackErrorHandler.statusCodeForThrowable(e), msg); } } }
diff --git a/java/com/google/gerrit/httpd/GitReferenceUpdatedTracker.java b/java/com/google/gerrit/httpd/GitReferenceUpdatedTracker.java new file mode 100644 index 0000000..ee28df9 --- /dev/null +++ b/java/com/google/gerrit/httpd/GitReferenceUpdatedTracker.java
@@ -0,0 +1,55 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.httpd; + +import com.google.gerrit.extensions.events.GitReferenceUpdatedListener; +import com.google.gerrit.extensions.registration.DynamicItem; +import com.google.inject.Inject; +import com.google.inject.ProvisionException; +import com.google.inject.Singleton; + +/** + * Stores the updated refs whenever they are updated, so that we can export this information in the + * response headers. + * + * <p>This is only working for HTTP requests. {@link WebSession} is not bound outside of HTTP + * requests. + */ +@Singleton +public class GitReferenceUpdatedTracker implements GitReferenceUpdatedListener { + + private final DynamicItem<WebSession> webSession; + + @Inject + GitReferenceUpdatedTracker(DynamicItem<WebSession> webSession) { + this.webSession = webSession; + } + + @Override + public void onGitReferenceUpdated(GitReferenceUpdatedListener.Event event) { + WebSession currentSession = null; + try { + currentSession = webSession.get(); + } catch (ProvisionException ex) { + // We couldn't bind the current session properly. This is expected to happen at any point we + // perform ref updates without an HTTP request (git push for example). + // If we can't get a WebSession, we don't need to track the updated references. + return; + } + if (currentSession != null) { + currentSession.addRefUpdatedEvents(event); + } + } +}
diff --git a/java/com/google/gerrit/httpd/HttpdModule.java b/java/com/google/gerrit/httpd/HttpdModule.java new file mode 100644 index 0000000..1f1ec2f --- /dev/null +++ b/java/com/google/gerrit/httpd/HttpdModule.java
@@ -0,0 +1,14 @@ +package com.google.gerrit.httpd; + +import com.google.gerrit.extensions.annotations.Exports; +import com.google.gerrit.extensions.config.FactoryModule; +import com.google.gerrit.extensions.events.GitReferenceUpdatedListener; + +public class HttpdModule extends FactoryModule { + @Override + protected void configure() { + bind(GitReferenceUpdatedListener.class) + .annotatedWith(Exports.named(GitReferenceUpdatedTracker.class.getSimpleName())) + .to(GitReferenceUpdatedTracker.class); + } +}
diff --git a/java/com/google/gerrit/httpd/ProjectBasicAuthFilter.java b/java/com/google/gerrit/httpd/ProjectBasicAuthFilter.java index de989ac..a421139 100644 --- a/java/com/google/gerrit/httpd/ProjectBasicAuthFilter.java +++ b/java/com/google/gerrit/httpd/ProjectBasicAuthFilter.java
@@ -76,17 +76,23 @@ private final AccountCache accountCache; private final AccountManager accountManager; private final AuthConfig authConfig; + private final AuthRequest.Factory authRequestFactory; + private final PasswordVerifier passwordVerifier; @Inject ProjectBasicAuthFilter( DynamicItem<WebSession> session, AccountCache accountCache, AccountManager accountManager, - AuthConfig authConfig) { + AuthConfig authConfig, + AuthRequest.Factory authRequestFactory, + PasswordVerifier passwordVerifier) { this.session = session; this.accountCache = accountCache; this.accountManager = accountManager; this.authConfig = authConfig; + this.authRequestFactory = authRequestFactory; + this.passwordVerifier = passwordVerifier; } @Override @@ -155,7 +161,7 @@ GitBasicAuthPolicy gitBasicAuthPolicy = authConfig.getGitBasicAuthPolicy(); if (gitBasicAuthPolicy == GitBasicAuthPolicy.HTTP || gitBasicAuthPolicy == GitBasicAuthPolicy.HTTP_LDAP) { - if (PasswordVerifier.checkPassword(who.externalIds(), username, password)) { + if (passwordVerifier.checkPassword(who.externalIds(), username, password)) { logger.atFine().log( "HTTP:%s %s username/password authentication succeeded", req.getMethod(), req.getRequestURI()); @@ -167,7 +173,7 @@ return failAuthentication(rsp, username, req); } - AuthRequest whoAuth = AuthRequest.forUser(username); + AuthRequest whoAuth = authRequestFactory.createForUser(username); whoAuth.setPassword(password); try { @@ -177,7 +183,7 @@ "HTTP:%s %s Realm authentication succeeded", req.getMethod(), req.getRequestURI()); return true; } catch (NoSuchUserException e) { - if (PasswordVerifier.checkPassword(who.externalIds(), username, password)) { + if (passwordVerifier.checkPassword(who.externalIds(), username, password)) { return succeedAuthentication(who, null); } logger.atWarning().withCause(e).log(authenticationFailedMsg(username, req));
diff --git a/java/com/google/gerrit/httpd/ProjectOAuthFilter.java b/java/com/google/gerrit/httpd/ProjectOAuthFilter.java index dab36c4..fa53053 100644 --- a/java/com/google/gerrit/httpd/ProjectOAuthFilter.java +++ b/java/com/google/gerrit/httpd/ProjectOAuthFilter.java
@@ -76,6 +76,7 @@ private final AccountManager accountManager; private final String gitOAuthProvider; private final boolean userNameToLowerCase; + private final AuthRequest.Factory authRequestFactory; private String defaultAuthPlugin; private String defaultAuthProvider; @@ -86,13 +87,15 @@ DynamicMap<OAuthLoginProvider> pluginsProvider, AccountCache accountCache, AccountManager accountManager, - @GerritServerConfig Config gerritConfig) { + @GerritServerConfig Config gerritConfig, + AuthRequest.Factory authRequestFactory) { this.session = session; this.loginProviders = pluginsProvider; this.accountCache = accountCache; this.accountManager = accountManager; this.gitOAuthProvider = gerritConfig.getString("auth", null, "gitOAuthProvider"); this.userNameToLowerCase = gerritConfig.getBoolean("auth", null, "userNameToLowerCase", false); + this.authRequestFactory = authRequestFactory; } @Override @@ -162,7 +165,7 @@ } Account account = who.get().account(); - AuthRequest authRequest = AuthRequest.forExternalUser(authInfo.username); + AuthRequest authRequest = authRequestFactory.createForExternalUser(authInfo.username); authRequest.setEmailAddress(account.preferredEmail()); authRequest.setDisplayName(account.fullName()); authRequest.setPassword(authInfo.tokenOrSecret);
diff --git a/java/com/google/gerrit/httpd/RequestMetricsFilter.java b/java/com/google/gerrit/httpd/RequestMetricsFilter.java index c97b9ad..0ff1a79 100644 --- a/java/com/google/gerrit/httpd/RequestMetricsFilter.java +++ b/java/com/google/gerrit/httpd/RequestMetricsFilter.java
@@ -55,17 +55,17 @@ startedMemory = threadMxBean.getCurrentThreadAllocatedBytes(); } - /** @return total CPU time in milliseconds for executing request */ + /** Returns total CPU time in milliseconds for executing request */ public long getTotalCpuTime() { return (threadMxBean.getCurrentThreadCpuTime() - startedTotalCpu) / 1_000_000; } - /** @return CPU time in user mode in milliseconds for executing request */ + /** Returns CPU time in user mode in milliseconds for executing request */ public long getUserCpuTime() { return (threadMxBean.getCurrentThreadUserTime() - startedUserCpu) / 1_000_000; } - /** @return memory allocated in bytes for executing request */ + /** Returns memory allocated in bytes for executing request */ public long getAllocatedMemory() { return startedMemory == -1 ? -1
diff --git a/java/com/google/gerrit/httpd/RequireSslFilter.java b/java/com/google/gerrit/httpd/RequireSslFilter.java index d8e6f84..a4a87e2 100644 --- a/java/com/google/gerrit/httpd/RequireSslFilter.java +++ b/java/com/google/gerrit/httpd/RequireSslFilter.java
@@ -33,11 +33,11 @@ /** Requires the connection to use SSL, redirects if not. */ @Singleton public class RequireSslFilter implements Filter { - public static class Module extends ServletModule { + public static class RequireSslFilterModule extends ServletModule { private final boolean wantSsl; @Inject - Module(@Nullable @CanonicalWebUrl String canonicalUrl) { + RequireSslFilterModule(@Nullable @CanonicalWebUrl String canonicalUrl) { this.wantSsl = canonicalUrl != null && canonicalUrl.startsWith("https:"); }
diff --git a/java/com/google/gerrit/httpd/RunAsFilter.java b/java/com/google/gerrit/httpd/RunAsFilter.java index 135de42..b93f7ed 100644 --- a/java/com/google/gerrit/httpd/RunAsFilter.java +++ b/java/com/google/gerrit/httpd/RunAsFilter.java
@@ -49,7 +49,7 @@ private static final FluentLogger logger = FluentLogger.forEnclosingClass(); private static final String RUN_AS = "X-Gerrit-RunAs"; - static class Module extends ServletModule { + static class RunAsFilterModule extends ServletModule { @Override protected void configureServlets() { filter("/*").through(RunAsFilter.class);
diff --git a/java/com/google/gerrit/httpd/UrlModule.java b/java/com/google/gerrit/httpd/UrlModule.java index ac73d22..029efba 100644 --- a/java/com/google/gerrit/httpd/UrlModule.java +++ b/java/com/google/gerrit/httpd/UrlModule.java
@@ -21,6 +21,7 @@ import com.google.gerrit.entities.Change; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.client.AuthType; +import com.google.gerrit.httpd.RunAsFilter.RunAsFilterModule; import com.google.gerrit.httpd.raw.AuthorizationCheckServlet; import com.google.gerrit.httpd.raw.CatServlet; import com.google.gerrit.httpd.raw.SshInfoServlet; @@ -79,7 +80,7 @@ // Must be after RequireIdentifiedUserFilter so auth happens before checking // for RunAs capability. - install(new RunAsFilter.Module()); + install(new RunAsFilterModule()); serveRegex("^/(?:a/)?tools/(.*)$").with(ToolServlet.class);
diff --git a/java/com/google/gerrit/httpd/WebModule.java b/java/com/google/gerrit/httpd/WebModule.java index 5e3c76a..79dde85 100644 --- a/java/com/google/gerrit/httpd/WebModule.java +++ b/java/com/google/gerrit/httpd/WebModule.java
@@ -16,6 +16,7 @@ import static com.google.gerrit.extensions.registration.PrivateInternals_DynamicTypes.registerInParentInjectors; +import com.google.gerrit.httpd.GitOverHttpServlet.GitOverHttpServletModule; import com.google.gerrit.httpd.auth.become.BecomeAnyAccountModule; import com.google.gerrit.httpd.auth.container.HttpAuthModule; import com.google.gerrit.httpd.auth.container.HttpsClientSslCertModule; @@ -27,7 +28,7 @@ import com.google.gerrit.server.config.GerritOptions; import com.google.gerrit.server.config.GerritRequestModule; import com.google.gerrit.server.config.GitwebCgiConfig; -import com.google.gerrit.server.git.receive.AsyncReceiveCommits; +import com.google.gerrit.server.git.receive.AsyncReceiveCommits.AsyncReceiveCommitsModule; import com.google.gerrit.server.util.RequestScopePropagator; import com.google.inject.Inject; import com.google.inject.ProvisionException; @@ -56,13 +57,13 @@ install(new UrlModule(authConfig)); } install(new GerritRequestModule()); - install(new GitOverHttpServlet.Module(options.enableMasterFeatures())); + install(new GitOverHttpServletModule(options.enableMasterFeatures())); if (gitwebCgiConfig.getGitwebCgi() != null) { install(new GitwebModule()); } - install(new AsyncReceiveCommits.Module()); + install(new AsyncReceiveCommitsModule()); bind(SocketAddress.class) .annotatedWith(RemotePeer.class) @@ -74,6 +75,10 @@ listener().toInstance(registerInParentInjectors()); install(UniversalWebLoginFilter.module()); + + // Static injection was unfortunately the best solution in this place. However, it is to be + // avoided if possible. + requestStaticInjection(WebSessionManager.Val.class); } private void installAuthModule() {
diff --git a/java/com/google/gerrit/httpd/WebSession.java b/java/com/google/gerrit/httpd/WebSession.java index daf30ff..df8402e 100644 --- a/java/com/google/gerrit/httpd/WebSession.java +++ b/java/com/google/gerrit/httpd/WebSession.java
@@ -16,30 +16,61 @@ import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; +import com.google.gerrit.extensions.events.GitReferenceUpdatedListener; import com.google.gerrit.server.AccessPath; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.account.AuthResult; +import com.google.inject.servlet.RequestScoped; +import java.util.List; +import java.util.concurrent.CopyOnWriteArrayList; -public interface WebSession { - boolean isSignedIn(); +/** + * A thread safe class that contains details about a specific user web session. + * + * <p>WARNING: All implementors must have {@link RequestScoped} annotation to maintain thread + * safety. + */ +public abstract class WebSession { + public abstract boolean isSignedIn(); @Nullable - String getXGerritAuth(); + public abstract String getXGerritAuth(); - boolean isValidXGerritAuth(String keyIn); + public abstract boolean isValidXGerritAuth(String keyIn); - CurrentUser getUser(); + public abstract CurrentUser getUser(); - void login(AuthResult res, boolean rememberMe); + public abstract void login(AuthResult res, boolean rememberMe); /** Set the user account for this current request only. */ - void setUserAccountId(Account.Id id); + public abstract void setUserAccountId(Account.Id id); - boolean isAccessPathOk(AccessPath path); + public abstract boolean isAccessPathOk(AccessPath path); - void setAccessPathOk(AccessPath path, boolean ok); + public abstract void setAccessPathOk(AccessPath path, boolean ok); - void logout(); + public abstract void logout(); - String getSessionId(); + public abstract String getSessionId(); + + /** + * Store and return the ref updates in this session. This class is {@link RequestScoped}, hence + * this is thread safe. + * + * <p>The same session could perform separate requests one after another, so resetting the ref + * updates is necessary between requests. + */ + private List<GitReferenceUpdatedListener.Event> refUpdatedEvents = new CopyOnWriteArrayList<>(); + + public List<GitReferenceUpdatedListener.Event> getRefUpdatedEvents() { + return refUpdatedEvents; + } + + public void addRefUpdatedEvents(GitReferenceUpdatedListener.Event event) { + refUpdatedEvents.add(event); + } + + public void resetRefUpdatedEvents() { + refUpdatedEvents.clear(); + } }
diff --git a/java/com/google/gerrit/httpd/WebSessionManager.java b/java/com/google/gerrit/httpd/WebSessionManager.java index c0900ec..87bf3a6 100644 --- a/java/com/google/gerrit/httpd/WebSessionManager.java +++ b/java/com/google/gerrit/httpd/WebSessionManager.java
@@ -32,6 +32,7 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Account; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.config.ConfigUtil; import com.google.gerrit.server.config.GerritServerConfig; import com.google.inject.Inject; @@ -186,6 +187,8 @@ public static final class Val implements Serializable { static final long serialVersionUID = 2L; + @Inject private static transient ExternalIdKeyFactory externalIdKeyFactory; + private transient Account.Id accountId; private transient long refreshCookieAt; private transient boolean persistentCookie; @@ -295,7 +298,7 @@ persistentCookie = readVarInt32(in) != 0; continue; case 4: - externalId = ExternalId.Key.parse(readString(in)); + externalId = externalIdKeyFactory.parse(readString(in)); continue; case 5: sessionId = readString(in);
diff --git a/java/com/google/gerrit/httpd/auth/become/BecomeAnyAccountLoginServlet.java b/java/com/google/gerrit/httpd/auth/become/BecomeAnyAccountLoginServlet.java index 97bb44b..2f760f0 100644 --- a/java/com/google/gerrit/httpd/auth/become/BecomeAnyAccountLoginServlet.java +++ b/java/com/google/gerrit/httpd/auth/become/BecomeAnyAccountLoginServlet.java
@@ -31,7 +31,7 @@ import com.google.gerrit.server.account.Accounts; import com.google.gerrit.server.account.AuthRequest; import com.google.gerrit.server.account.AuthResult; -import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.query.account.InternalAccountQuery; import com.google.gerrit.util.http.CacheHeaders; import com.google.inject.Inject; @@ -62,6 +62,8 @@ private final AccountManager accountManager; private final SiteHeaderFooter headers; private final Provider<InternalAccountQuery> queryProvider; + private final ExternalIdKeyFactory externalIdKeyFactory; + private final AuthRequest.Factory authRequestFactory; @Inject BecomeAnyAccountLoginServlet( @@ -70,13 +72,17 @@ AccountCache ac, AccountManager am, SiteHeaderFooter shf, - Provider<InternalAccountQuery> qp) { + Provider<InternalAccountQuery> qp, + ExternalIdKeyFactory eikf, + AuthRequest.Factory arf) { webSession = ws; accounts = a; accountCache = ac; accountManager = am; headers = shf; queryProvider = qp; + externalIdKeyFactory = eikf; + authRequestFactory = arf; } @Override @@ -220,7 +226,8 @@ private AuthResult create() throws IOException { try { return accountManager.authenticate( - new AuthRequest(ExternalId.Key.create(SCHEME_UUID, UUID.randomUUID().toString()))); + authRequestFactory.create( + externalIdKeyFactory.create(SCHEME_UUID, UUID.randomUUID().toString()))); } catch (AccountException e) { getServletContext().log("cannot create new account", e); return null;
diff --git a/java/com/google/gerrit/httpd/auth/container/HttpAuthFilter.java b/java/com/google/gerrit/httpd/auth/container/HttpAuthFilter.java index e20c9b9..acb3282 100644 --- a/java/com/google/gerrit/httpd/auth/container/HttpAuthFilter.java +++ b/java/com/google/gerrit/httpd/auth/container/HttpAuthFilter.java
@@ -26,6 +26,7 @@ import com.google.gerrit.httpd.RemoteUserUtil; import com.google.gerrit.httpd.WebSession; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.util.http.CacheHeaders; import com.google.gerrit.util.http.RequestUtil; @@ -64,10 +65,16 @@ private final String emailHeader; private final String externalIdHeader; private final boolean userNameToLowerCase; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject - HttpAuthFilter(DynamicItem<WebSession> webSession, AuthConfig authConfig) throws IOException { + HttpAuthFilter( + DynamicItem<WebSession> webSession, + AuthConfig authConfig, + ExternalIdKeyFactory externalIdKeyFactory) + throws IOException { this.sessionProvider = webSession; + this.externalIdKeyFactory = externalIdKeyFactory; final String pageName = "LoginRedirect.html"; final String doc = HtmlDomUtil.readFile(getClass(), pageName); @@ -124,9 +131,9 @@ return false; } - private static boolean correctUser(String user, WebSession session) { + private boolean correctUser(String user, WebSession session) { Optional<ExternalId.Key> id = session.getUser().getLastLoginExternalIdKey(); - return id.map(i -> i.equals(ExternalId.Key.create(SCHEME_GERRIT, user))).orElse(false); + return id.map(i -> i.equals(externalIdKeyFactory.create(SCHEME_GERRIT, user))).orElse(false); } String getRemoteUser(HttpServletRequest req) {
diff --git a/java/com/google/gerrit/httpd/auth/container/HttpLoginServlet.java b/java/com/google/gerrit/httpd/auth/container/HttpLoginServlet.java index 1b7e477..53f33b5 100644 --- a/java/com/google/gerrit/httpd/auth/container/HttpLoginServlet.java +++ b/java/com/google/gerrit/httpd/auth/container/HttpLoginServlet.java
@@ -28,7 +28,7 @@ import com.google.gerrit.server.account.AccountManager; import com.google.gerrit.server.account.AuthRequest; import com.google.gerrit.server.account.AuthResult; -import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.util.http.CacheHeaders; import com.google.inject.Inject; @@ -61,6 +61,8 @@ private final AccountManager accountManager; private final HttpAuthFilter authFilter; private final AuthConfig authConfig; + private final ExternalIdKeyFactory externalIdKeyFactory; + private final AuthRequest.Factory authRequestFactory; @Inject HttpLoginServlet( @@ -68,12 +70,16 @@ final CanonicalWebUrl urlProvider, final AccountManager accountManager, final HttpAuthFilter authFilter, - final AuthConfig authConfig) { + final AuthConfig authConfig, + final ExternalIdKeyFactory externalIdKeyFactory, + final AuthRequest.Factory authRequestFactory) { this.webSession = webSession; this.urlProvider = urlProvider; this.accountManager = accountManager; this.authFilter = authFilter; this.authConfig = authConfig; + this.externalIdKeyFactory = externalIdKeyFactory; + this.authRequestFactory = authRequestFactory; } @Override @@ -109,7 +115,7 @@ return; } - final AuthRequest areq = AuthRequest.forUser(user); + final AuthRequest areq = authRequestFactory.createForUser(user); areq.setDisplayName(authFilter.getRemoteDisplayname(req)); areq.setEmailAddress(authFilter.getRemoteEmail(req)); final AuthResult arsp; @@ -154,7 +160,7 @@ throws AccountException, IOException, ConfigInvalidException { accountManager.updateLink( arsp.getAccountId(), - new AuthRequest(ExternalId.Key.create(SCHEME_EXTERNAL, remoteAuthToken))); + authRequestFactory.create(externalIdKeyFactory.create(SCHEME_EXTERNAL, remoteAuthToken))); } private void replace(Document doc, String name, String value) {
diff --git a/java/com/google/gerrit/httpd/auth/container/HttpsClientSslCertAuthFilter.java b/java/com/google/gerrit/httpd/auth/container/HttpsClientSslCertAuthFilter.java index 40807c0..820c7a2 100644 --- a/java/com/google/gerrit/httpd/auth/container/HttpsClientSslCertAuthFilter.java +++ b/java/com/google/gerrit/httpd/auth/container/HttpsClientSslCertAuthFilter.java
@@ -42,12 +42,16 @@ private final DynamicItem<WebSession> webSession; private final AccountManager accountManager; + private final AuthRequest.Factory authRequestFactory; @Inject HttpsClientSslCertAuthFilter( - final DynamicItem<WebSession> webSession, AccountManager accountManager) { + final DynamicItem<WebSession> webSession, + AccountManager accountManager, + final AuthRequest.Factory authRequestFactory) { this.webSession = webSession; this.accountManager = accountManager; + this.authRequestFactory = authRequestFactory; } @Override @@ -70,7 +74,7 @@ } else { throw new ServletException("Couldn't extract username from your certificate"); } - final AuthRequest areq = AuthRequest.forUser(userName); + final AuthRequest areq = authRequestFactory.createForUser(userName); final AuthResult arsp; try { arsp = accountManager.authenticate(areq);
diff --git a/java/com/google/gerrit/httpd/auth/ldap/LdapLoginServlet.java b/java/com/google/gerrit/httpd/auth/ldap/LdapLoginServlet.java index a09866e..6caa760 100644 --- a/java/com/google/gerrit/httpd/auth/ldap/LdapLoginServlet.java +++ b/java/com/google/gerrit/httpd/auth/ldap/LdapLoginServlet.java
@@ -56,17 +56,20 @@ private final DynamicItem<WebSession> webSession; private final CanonicalWebUrl urlProvider; private final SiteHeaderFooter headers; + private final AuthRequest.Factory authRequestFactory; @Inject LdapLoginServlet( AccountManager accountManager, DynamicItem<WebSession> webSession, CanonicalWebUrl urlProvider, - SiteHeaderFooter headers) { + SiteHeaderFooter headers, + AuthRequest.Factory authRequestFactory) { this.accountManager = accountManager; this.webSession = webSession; this.urlProvider = urlProvider; this.headers = headers; + this.authRequestFactory = authRequestFactory; } private void sendForm( @@ -115,7 +118,7 @@ return; } - AuthRequest areq = AuthRequest.forUser(username); + AuthRequest areq = authRequestFactory.createForUser(username); areq.setPassword(password); AuthResult ares;
diff --git a/java/com/google/gerrit/httpd/auth/oauth/OAuthSession.java b/java/com/google/gerrit/httpd/auth/oauth/OAuthSession.java index 70ed79b..297505a 100644 --- a/java/com/google/gerrit/httpd/auth/oauth/OAuthSession.java +++ b/java/com/google/gerrit/httpd/auth/oauth/OAuthSession.java
@@ -35,7 +35,7 @@ import com.google.gerrit.server.account.AccountManager; import com.google.gerrit.server.account.AuthRequest; import com.google.gerrit.server.account.AuthResult; -import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.servlet.SessionScoped; @@ -65,6 +65,8 @@ private Account.Id accountId; private String redirectToken; private boolean linkMode; + private final ExternalIdKeyFactory externalIdKeyFactory; + private final AuthRequest.Factory authRequestFactory; @Inject OAuthSession( @@ -72,13 +74,17 @@ Provider<IdentifiedUser> identifiedUser, AccountManager accountManager, CanonicalWebUrl urlProvider, - OAuthTokenCache tokenCache) { + OAuthTokenCache tokenCache, + ExternalIdKeyFactory externalIdKeyFactory, + AuthRequest.Factory authRequestFactory) { this.state = generateRandomState(); this.identifiedUser = identifiedUser; this.webSession = webSession; this.accountManager = accountManager; this.urlProvider = urlProvider; this.tokenCache = tokenCache; + this.externalIdKeyFactory = externalIdKeyFactory; + this.authRequestFactory = authRequestFactory; } boolean isLoggedIn() { @@ -126,7 +132,7 @@ private void authenticateAndRedirect( HttpServletRequest req, HttpServletResponse rsp, OAuthToken token) throws IOException { - AuthRequest areq = new AuthRequest(ExternalId.Key.parse(user.getExternalId())); + AuthRequest areq = authRequestFactory.create(externalIdKeyFactory.parse(user.getExternalId())); AuthResult arsp; try { String claimedIdentifier = user.getClaimedIdentity(); @@ -184,7 +190,7 @@ } else if (claimedId.isPresent() && !actualId.isPresent()) { // Claimed account already exists: link to it. // - logger.atInfo().log("OAuth2: linking claimed identity to %s", claimedId.get().toString()); + logger.atInfo().log("OAuth2: linking claimed identity to %s", claimedId.get()); try { accountManager.link(claimedId.get(), req); } catch (ConfigInvalidException e) {
diff --git a/java/com/google/gerrit/httpd/auth/openid/OAuthSessionOverOpenID.java b/java/com/google/gerrit/httpd/auth/openid/OAuthSessionOverOpenID.java index b987c68..df0062c 100644 --- a/java/com/google/gerrit/httpd/auth/openid/OAuthSessionOverOpenID.java +++ b/java/com/google/gerrit/httpd/auth/openid/OAuthSessionOverOpenID.java
@@ -32,8 +32,9 @@ import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.account.AccountException; import com.google.gerrit.server.account.AccountManager; +import com.google.gerrit.server.account.AuthRequest; import com.google.gerrit.server.account.AuthResult; -import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.servlet.SessionScoped; @@ -63,18 +64,24 @@ private OAuthUserInfo user; private String redirectToken; private boolean linkMode; + private final ExternalIdKeyFactory externalIdKeyFactory; + private final AuthRequest.Factory authRequestFactory; @Inject OAuthSessionOverOpenID( DynamicItem<WebSession> webSession, Provider<IdentifiedUser> identifiedUser, AccountManager accountManager, - CanonicalWebUrl urlProvider) { + CanonicalWebUrl urlProvider, + ExternalIdKeyFactory externalIdKeyFactory, + AuthRequest.Factory authRequestFactory) { this.state = generateRandomState(); this.webSession = webSession; this.identifiedUser = identifiedUser; this.accountManager = accountManager; this.urlProvider = urlProvider; + this.externalIdKeyFactory = externalIdKeyFactory; + this.authRequestFactory = authRequestFactory; } boolean isLoggedIn() { @@ -117,8 +124,7 @@ private void authenticateAndRedirect(HttpServletRequest req, HttpServletResponse rsp) throws IOException { com.google.gerrit.server.account.AuthRequest areq = - new com.google.gerrit.server.account.AuthRequest( - ExternalId.Key.parse(user.getExternalId())); + authRequestFactory.create(externalIdKeyFactory.parse(user.getExternalId())); AuthResult arsp; try { String claimedIdentifier = user.getClaimedIdentity();
diff --git a/java/com/google/gerrit/httpd/auth/openid/OpenIdServiceImpl.java b/java/com/google/gerrit/httpd/auth/openid/OpenIdServiceImpl.java index c655b6c..fcd16ae 100644 --- a/java/com/google/gerrit/httpd/auth/openid/OpenIdServiceImpl.java +++ b/java/com/google/gerrit/httpd/auth/openid/OpenIdServiceImpl.java
@@ -28,7 +28,7 @@ import com.google.gerrit.server.UrlEncoded; import com.google.gerrit.server.account.AccountException; import com.google.gerrit.server.account.AccountManager; -import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.auth.openid.OpenIdProviderPattern; import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.server.config.ConfigUtil; @@ -92,6 +92,8 @@ private final ConsumerManager manager; private final List<OpenIdProviderPattern> allowedOpenIDs; private final List<String> openIdDomains; + private final ExternalIdKeyFactory externalIdKeyFactory; + private final com.google.gerrit.server.account.AuthRequest.Factory authRequestFactory; /** Maximum age, in seconds, before forcing re-authentication of account. */ private final int papeMaxAuthAge; @@ -104,7 +106,9 @@ @GerritServerConfig Config config, AuthConfig ac, AccountManager am, - ProxyProperties proxyProperties) { + ProxyProperties proxyProperties, + ExternalIdKeyFactory externalIdKeyFactory, + com.google.gerrit.server.account.AuthRequest.Factory authRequestFactory) { if (proxyProperties.getProxyUrl() != null) { final org.openid4java.util.ProxyProperties proxy = new org.openid4java.util.ProxyProperties(); @@ -132,6 +136,8 @@ "maxOpenIdSessionAge", -1, TimeUnit.SECONDS); + this.externalIdKeyFactory = externalIdKeyFactory; + this.authRequestFactory = authRequestFactory; } @SuppressWarnings("unchecked") @@ -310,7 +316,7 @@ } final com.google.gerrit.server.account.AuthRequest areq = - new com.google.gerrit.server.account.AuthRequest(ExternalId.Key.parse(openidIdentifier)); + authRequestFactory.create(externalIdKeyFactory.parse(openidIdentifier)); if (sregRsp != null) { areq.setDisplayName(sregRsp.getAttributeValue("fullname")); @@ -388,8 +394,7 @@ // was missing due to a bug in Gerrit. Link the claimed. // final com.google.gerrit.server.account.AuthRequest linkReq = - new com.google.gerrit.server.account.AuthRequest( - ExternalId.Key.parse(claimedIdentifier)); + authRequestFactory.create(externalIdKeyFactory.parse(claimedIdentifier)); linkReq.setDisplayName(areq.getDisplayName()); linkReq.setEmailAddress(areq.getEmailAddress()); accountManager.link(actualId.get(), linkReq); @@ -425,8 +430,7 @@ webSession.get().login(arsp, remember); if (arsp.isNew() && claimedIdentifier != null) { final com.google.gerrit.server.account.AuthRequest linkReq = - new com.google.gerrit.server.account.AuthRequest( - ExternalId.Key.parse(claimedIdentifier)); + authRequestFactory.create(externalIdKeyFactory.parse(claimedIdentifier)); linkReq.setDisplayName(areq.getDisplayName()); linkReq.setEmailAddress(areq.getEmailAddress()); accountManager.link(arsp.getAccountId(), linkReq);
diff --git a/java/com/google/gerrit/httpd/init/BUILD b/java/com/google/gerrit/httpd/init/BUILD index adfbdcc..990b5d7 100644 --- a/java/com/google/gerrit/httpd/init/BUILD +++ b/java/com/google/gerrit/httpd/init/BUILD
@@ -6,7 +6,6 @@ visibility = ["//visibility:public"], deps = [ "//java/com/google/gerrit/auth", - "//java/com/google/gerrit/elasticsearch", "//java/com/google/gerrit/extensions:api", "//java/com/google/gerrit/gpg", "//java/com/google/gerrit/httpd",
diff --git a/java/com/google/gerrit/httpd/init/WebAppInitializer.java b/java/com/google/gerrit/httpd/init/WebAppInitializer.java index 2ed342f..6488f2e 100644 --- a/java/com/google/gerrit/httpd/init/WebAppInitializer.java +++ b/java/com/google/gerrit/httpd/init/WebAppInitializer.java
@@ -19,7 +19,6 @@ import com.google.common.base.Splitter; import com.google.common.flogger.FluentLogger; import com.google.gerrit.auth.AuthModule; -import com.google.gerrit.elasticsearch.ElasticIndexModule; import com.google.gerrit.extensions.client.AuthType; import com.google.gerrit.gpg.GpgModule; import com.google.gerrit.httpd.AllRequestFilter; @@ -28,10 +27,11 @@ import com.google.gerrit.httpd.GitOverHttpModule; import com.google.gerrit.httpd.H2CacheBasedWebSession; import com.google.gerrit.httpd.HttpCanonicalWebUrlProvider; +import com.google.gerrit.httpd.HttpdModule; import com.google.gerrit.httpd.RequestCleanupFilter; import com.google.gerrit.httpd.RequestContextFilter; import com.google.gerrit.httpd.RequestMetricsFilter; -import com.google.gerrit.httpd.RequireSslFilter; +import com.google.gerrit.httpd.RequireSslFilter.RequireSslFilterModule; import com.google.gerrit.httpd.SetThreadNameFilter; import com.google.gerrit.httpd.WebModule; import com.google.gerrit.httpd.WebSshGlueModule; @@ -45,23 +45,24 @@ import com.google.gerrit.lifecycle.LifecycleModule; import com.google.gerrit.lucene.LuceneIndexModule; import com.google.gerrit.metrics.dropwizard.DropWizardMetricMaker; -import com.google.gerrit.pgm.util.LogFileCompressor; +import com.google.gerrit.pgm.util.LogFileCompressor.LogFileCompressorModule; import com.google.gerrit.server.LibModuleLoader; import com.google.gerrit.server.LibModuleType; import com.google.gerrit.server.ModuleOverloader; -import com.google.gerrit.server.StartupChecks; -import com.google.gerrit.server.account.AccountDeactivator; -import com.google.gerrit.server.account.InternalAccountDirectory; +import com.google.gerrit.server.StartupChecks.StartupChecksModule; +import com.google.gerrit.server.account.AccountDeactivator.AccountDeactivatorModule; +import com.google.gerrit.server.account.InternalAccountDirectory.InternalAccountDirectoryModule; +import com.google.gerrit.server.account.externalids.ExternalIdCaseSensitivityMigrator; import com.google.gerrit.server.api.GerritApiModule; import com.google.gerrit.server.api.PluginApiModule; import com.google.gerrit.server.audit.AuditModule; import com.google.gerrit.server.cache.h2.H2CacheModule; import com.google.gerrit.server.cache.mem.DefaultMemoryCacheModule; -import com.google.gerrit.server.change.ChangeCleanupRunner; +import com.google.gerrit.server.change.ChangeCleanupRunner.ChangeCleanupRunnerModule; import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.server.config.AuthConfigModule; import com.google.gerrit.server.config.CanonicalWebUrlModule; -import com.google.gerrit.server.config.DefaultUrlFormatter; +import com.google.gerrit.server.config.DefaultUrlFormatter.DefaultUrlFormatterModule; import com.google.gerrit.server.config.DownloadConfig; import com.google.gerrit.server.config.GerritGlobalModule; import com.google.gerrit.server.config.GerritInstanceNameModule; @@ -71,44 +72,45 @@ import com.google.gerrit.server.config.GerritServerConfigModule; import com.google.gerrit.server.config.SitePath; import com.google.gerrit.server.config.SysExecutorModule; -import com.google.gerrit.server.events.EventBroker; -import com.google.gerrit.server.events.StreamEventsApiListener; +import com.google.gerrit.server.events.EventBroker.EventBrokerModule; +import com.google.gerrit.server.events.StreamEventsApiListener.StreamEventsApiListenerModule; +import com.google.gerrit.server.git.ChangesByProjectCache; import com.google.gerrit.server.git.GarbageCollectionModule; import com.google.gerrit.server.git.GitRepositoryManagerModule; -import com.google.gerrit.server.git.SearchingChangeCacheImpl; import com.google.gerrit.server.git.SystemReaderInstaller; -import com.google.gerrit.server.git.WorkQueue; +import com.google.gerrit.server.git.WorkQueue.WorkQueueModule; import com.google.gerrit.server.index.IndexModule; -import com.google.gerrit.server.index.OnlineUpgrader; +import com.google.gerrit.server.index.OnlineUpgrader.OnlineUpgraderModule; import com.google.gerrit.server.index.VersionManager; import com.google.gerrit.server.index.options.AutoFlush; -import com.google.gerrit.server.mail.SignedTokenEmailTokenVerifier; -import com.google.gerrit.server.mail.receive.MailReceiver; -import com.google.gerrit.server.mail.send.SmtpEmailSender; +import com.google.gerrit.server.mail.SignedTokenEmailTokenVerifier.SignedTokenEmailTokenVerifierModule; +import com.google.gerrit.server.mail.receive.MailReceiver.MailReceiverModule; +import com.google.gerrit.server.mail.send.SmtpEmailSender.SmtpEmailSenderModule; import com.google.gerrit.server.mime.MimeUtil2Module; import com.google.gerrit.server.patch.DiffExecutorModule; import com.google.gerrit.server.permissions.DefaultPermissionBackendModule; import com.google.gerrit.server.plugins.PluginGuiceEnvironment; import com.google.gerrit.server.plugins.PluginModule; -import com.google.gerrit.server.project.DefaultProjectNameLockManager; +import com.google.gerrit.server.project.DefaultProjectNameLockManager.DefaultProjectNameLockManagerModule; import com.google.gerrit.server.restapi.RestApiModule; -import com.google.gerrit.server.schema.JdbcAccountPatchReviewStore; +import com.google.gerrit.server.schema.JdbcAccountPatchReviewStore.JdbcAccountPatchReviewStoreModule; import com.google.gerrit.server.schema.NoteDbSchemaVersionCheck; import com.google.gerrit.server.schema.SchemaModule; import com.google.gerrit.server.securestore.SecureStoreClassName; import com.google.gerrit.server.ssh.NoSshModule; import com.google.gerrit.server.ssh.SshAddressesModule; -import com.google.gerrit.server.submit.LocalMergeSuperSetComputation; -import com.google.gerrit.server.submit.SubscriptionGraph; -import com.google.gerrit.server.update.SuperprojectUpdateSubmissionListener; +import com.google.gerrit.server.submit.LocalMergeSuperSetComputation.LocalMergeSuperSetComputationModule; +import com.google.gerrit.server.submit.SubscriptionGraph.SubscriptionGraphModule; +import com.google.gerrit.server.update.SuperprojectUpdateSubmissionListener.SuperprojectUpdateSubmissionListenerModule; import com.google.gerrit.sshd.SshHostKeyModule; import com.google.gerrit.sshd.SshKeyCacheImpl; import com.google.gerrit.sshd.SshModule; import com.google.gerrit.sshd.SshSessionFactoryInitializer; import com.google.gerrit.sshd.commands.DefaultCommandModule; +import com.google.gerrit.sshd.commands.ExternalIdCommandsModule; import com.google.gerrit.sshd.commands.IndexCommandsModule; import com.google.gerrit.sshd.commands.SequenceCommandsModule; -import com.google.gerrit.sshd.plugin.LfsPluginAuthCommand; +import com.google.gerrit.sshd.plugin.LfsPluginAuthCommand.LfsPluginAuthCommandModule; import com.google.inject.AbstractModule; import com.google.inject.CreationException; import com.google.inject.Guice; @@ -122,6 +124,8 @@ import com.google.inject.spi.Message; import com.google.inject.util.Providers; import java.io.IOException; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; import java.nio.file.Path; import java.nio.file.Paths; import java.util.ArrayList; @@ -206,7 +210,7 @@ buf.append("\nResolve above errors before continuing."); buf.append("\nComplete stack trace follows:"); } - logger.atSevere().withCause(first.getCause()).log(buf.toString()); + logger.atSevere().withCause(first.getCause()).log("%s", buf); throw new CreationException(Collections.singleton(first)); } @@ -288,35 +292,35 @@ modules.add(new AuthConfigModule()); return cfgInjector.createChildInjector( ModuleOverloader.override( - modules, LibModuleLoader.loadModules(cfgInjector, LibModuleType.DB_MODULE))); + modules, LibModuleLoader.loadModules(cfgInjector, LibModuleType.DB_MODULE_TYPE))); } private Injector createSysInjector() { final List<Module> modules = new ArrayList<>(); modules.add(new DropWizardMetricMaker.RestModule()); - modules.add(new LogFileCompressor.Module()); - modules.add(new EventBroker.Module()); - modules.add(new JdbcAccountPatchReviewStore.Module(config)); + modules.add(new LogFileCompressorModule()); + modules.add(new EventBrokerModule()); + modules.add(new JdbcAccountPatchReviewStoreModule(config)); modules.add(cfgInjector.getInstance(GitRepositoryManagerModule.class)); - modules.add(new StreamEventsApiListener.Module()); + modules.add(new StreamEventsApiListenerModule()); modules.add(new SysExecutorModule()); modules.add(new DiffExecutorModule()); modules.add(new MimeUtil2Module()); modules.add(cfgInjector.getInstance(GerritGlobalModule.class)); modules.add(new GerritApiModule()); modules.add(new PluginApiModule()); - modules.add(new SearchingChangeCacheImpl.Module()); - modules.add(new InternalAccountDirectory.Module()); + modules.add(new ChangesByProjectCache.Module(ChangesByProjectCache.UseIndex.TRUE, config)); + modules.add(new InternalAccountDirectoryModule()); modules.add(new DefaultPermissionBackendModule()); modules.add(new DefaultMemoryCacheModule()); modules.add(new H2CacheModule()); - modules.add(cfgInjector.getInstance(MailReceiver.Module.class)); - modules.add(new SmtpEmailSender.Module()); - modules.add(new SignedTokenEmailTokenVerifier.Module()); - modules.add(new LocalMergeSuperSetComputation.Module()); + modules.add(cfgInjector.getInstance(MailReceiverModule.class)); + modules.add(new SmtpEmailSenderModule()); + modules.add(new SignedTokenEmailTokenVerifierModule()); + modules.add(new LocalMergeSuperSetComputationModule()); modules.add(new AuditModule()); modules.add(new GpgModule(config)); - modules.add(new StartupChecks.Module()); + modules.add(new StartupChecksModule()); // Index module shutdown must happen before work queue shutdown, otherwise // work queue can get stuck waiting on index futures that will never return. @@ -324,13 +328,13 @@ modules.add(new PluginModule()); if (VersionManager.getOnlineUpgrade(config)) { - modules.add(new OnlineUpgrader.Module()); + modules.add(new OnlineUpgraderModule()); } modules.add(new OAuthRestModule()); modules.add(new RestApiModule()); - modules.add(new SubscriptionGraph.Module()); - modules.add(new SuperprojectUpdateSubmissionListener.Module()); - modules.add(new WorkQueue.Module()); + modules.add(new SubscriptionGraphModule()); + modules.add(new SuperprojectUpdateSubmissionListenerModule()); + modules.add(new WorkQueueModule()); modules.add(new GerritInstanceNameModule()); modules.add( new CanonicalWebUrlModule() { @@ -339,7 +343,7 @@ return HttpCanonicalWebUrlProvider.class; } }); - modules.add(new DefaultUrlFormatter.Module()); + modules.add(new DefaultUrlFormatterModule()); SshSessionFactoryInitializer.init(config); modules.add(SshKeyCacheImpl.module()); @@ -347,24 +351,36 @@ new AbstractModule() { @Override protected void configure() { - bind(GerritOptions.class).toInstance(new GerritOptions(false, false, "")); + bind(GerritOptions.class).toInstance(new GerritOptions(false, false)); bind(GerritRuntime.class).toInstance(GerritRuntime.DAEMON); } }); modules.add(new GarbageCollectionModule()); - modules.add(new ChangeCleanupRunner.Module()); - modules.add(new AccountDeactivator.Module()); - modules.add(new DefaultProjectNameLockManager.Module()); + modules.add(new ChangeCleanupRunnerModule()); + modules.add(new AccountDeactivatorModule()); + modules.add(new DefaultProjectNameLockManagerModule()); + modules.add(new ExternalIdCaseSensitivityMigrator.ExternalIdCaseSensitivityMigratorModule()); return dbInjector.createChildInjector( ModuleOverloader.override( - modules, LibModuleLoader.loadModules(cfgInjector, LibModuleType.SYS_MODULE))); + modules, LibModuleLoader.loadModules(cfgInjector, LibModuleType.SYS_MODULE_TYPE))); } private Module createIndexModule() { if (indexType.isLucene()) { return LuceneIndexModule.latestVersion(false, AutoFlush.ENABLED); - } else if (indexType.isElasticsearch()) { - return ElasticIndexModule.latestVersion(false); + } else if (indexType.isFake()) { + // Use Reflection so that we can omit the fake index binary in production code. Test code does + // compile the component in. + try { + Class<?> clazz = Class.forName("com.google.gerrit.index.testing.FakeIndexModule"); + Method m = clazz.getMethod("latestVersion", boolean.class); + return (Module) m.invoke(null, false); + } catch (NoSuchMethodException + | ClassNotFoundException + | IllegalAccessException + | InvocationTargetException e) { + throw new IllegalStateException("can't create index", e); + } } else { throw new IllegalStateException("unsupported index.type = " + indexType); } @@ -382,9 +398,10 @@ new DefaultCommandModule( false, sysInjector.getInstance(DownloadConfig.class), - sysInjector.getInstance(LfsPluginAuthCommand.Module.class))); + sysInjector.getInstance(LfsPluginAuthCommandModule.class))); modules.add(new IndexCommandsModule(sysInjector)); modules.add(new SequenceCommandsModule()); + modules.add(new ExternalIdCommandsModule()); return sysInjector.createChildInjector(modules); } @@ -394,11 +411,12 @@ modules.add(RequestMetricsFilter.module()); modules.add(sysInjector.getInstance(GerritAuthModule.class)); modules.add(sysInjector.getInstance(GitOverHttpModule.class)); + modules.add(sysInjector.getInstance(HttpdModule.class)); modules.add(RequestCleanupFilter.module()); modules.add(SetThreadNameFilter.module()); modules.add(AllRequestFilter.module()); modules.add(sysInjector.getInstance(WebModule.class)); - modules.add(sysInjector.getInstance(RequireSslFilter.Module.class)); + modules.add(sysInjector.getInstance(RequireSslFilterModule.class)); if (sshInjector != null) { modules.add(sshInjector.getInstance(WebSshGlueModule.class)); } else { @@ -415,7 +433,7 @@ } modules.add(new AuthModule(authConfig)); - modules.add(sysInjector.getInstance(GetUserFilter.Module.class)); + modules.add(sysInjector.getInstance(GetUserFilter.GetUserFilterModule.class)); // StaticModule contains a "/*" wildcard, place it last. GerritOptions opts = sysInjector.getInstance(GerritOptions.class);
diff --git a/java/com/google/gerrit/httpd/plugins/HttpPluginServlet.java b/java/com/google/gerrit/httpd/plugins/HttpPluginServlet.java index 43eb3a0..97752a0 100644 --- a/java/com/google/gerrit/httpd/plugins/HttpPluginServlet.java +++ b/java/com/google/gerrit/httpd/plugins/HttpPluginServlet.java
@@ -358,6 +358,33 @@ return cachedResource != null && cachedResource.isUnchanged(lastUpdateTime); } + private void appendPageAsSection( + PluginContentScanner scanner, PluginEntry pluginEntry, String sectionTitle, StringBuilder md) + throws IOException { + InputStreamReader isr = new InputStreamReader(scanner.getInputStream(pluginEntry), UTF_8); + StringBuilder content = new StringBuilder(); + try (BufferedReader reader = new BufferedReader(isr)) { + String line; + while ((line = reader.readLine()) != null) { + line = StringUtils.stripEnd(line, null); + if (line.isEmpty()) { + content.append("\n"); + } else { + content.append(line).append("\n"); + } + } + } + + // Only append the section if there was anything in it + if (content.toString().trim().length() > 0) { + md.append("## "); + md.append(sectionTitle); + md.append(" ##\n"); + md.append("\n").append(content); + md.append("\n"); + } + } + private void appendEntriesSection( PluginContentScanner scanner, List<PluginEntry> entries, @@ -400,6 +427,7 @@ List<PluginEntry> restApis = new ArrayList<>(); List<PluginEntry> docs = new ArrayList<>(); PluginEntry about = null; + PluginEntry toc = null; Predicate<PluginEntry> filter = entry -> { @@ -437,6 +465,14 @@ "Plugin %s: Multiple 'about' documents found; using %s", pluginName, about.getName().substring(prefix.length())); } + } else if (name.startsWith("toc.")) { + if (toc == null) { + toc = entry; + } else { + logger.atWarning().log( + "Plugin %s: Multiple 'toc' documents found; using %s", + pluginName, toc.getName().substring(prefix.length())); + } } else { docs.add(entry); } @@ -451,31 +487,17 @@ appendPluginInfoTable(md, scanner.getManifest().getMainAttributes()); if (about != null) { - InputStreamReader isr = new InputStreamReader(scanner.getInputStream(about), UTF_8); - StringBuilder aboutContent = new StringBuilder(); - try (BufferedReader reader = new BufferedReader(isr)) { - String line; - while ((line = reader.readLine()) != null) { - line = StringUtils.stripEnd(line, null); - if (line.isEmpty()) { - aboutContent.append("\n"); - } else { - aboutContent.append(line).append("\n"); - } - } - } - - // Only append the About section if there was anything in it - if (aboutContent.toString().trim().length() > 0) { - md.append("## About ##\n"); - md.append("\n").append(aboutContent); - } + appendPageAsSection(scanner, about, "About", md); } - appendEntriesSection(scanner, docs, "Documentation", md, prefix, 0); - appendEntriesSection(scanner, servlets, "Servlets", md, prefix, "servlet-".length()); - appendEntriesSection(scanner, restApis, "REST APIs", md, prefix, "rest-api-".length()); - appendEntriesSection(scanner, cmds, "Commands", md, prefix, "cmd-".length()); + if (toc != null) { + appendPageAsSection(scanner, toc, "Documentation", md); + } else { + appendEntriesSection(scanner, docs, "Documentation", md, prefix, 0); + appendEntriesSection(scanner, servlets, "Servlets", md, prefix, "servlet-".length()); + appendEntriesSection(scanner, restApis, "REST APIs", md, prefix, "rest-api-".length()); + appendEntriesSection(scanner, cmds, "Commands", md, prefix, "cmd-".length()); + } sendMarkdownAsHtml(md.toString(), pluginName, cacheKey, res, lastModifiedTime); }
diff --git a/java/com/google/gerrit/httpd/raw/IndexHtmlUtil.java b/java/com/google/gerrit/httpd/raw/IndexHtmlUtil.java index 8d52f5a..445a73a 100644 --- a/java/com/google/gerrit/httpd/raw/IndexHtmlUtil.java +++ b/java/com/google/gerrit/httpd/raw/IndexHtmlUtil.java
@@ -27,6 +27,7 @@ import com.google.gerrit.extensions.api.GerritApi; import com.google.gerrit.extensions.api.accounts.AccountApi; import com.google.gerrit.extensions.api.config.Server; +import com.google.gerrit.extensions.client.ListOption; import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.json.OutputFormat; @@ -90,13 +91,13 @@ switch (page) { case CHANGE: data.put( - "defaultChangeDetailHex", IndexPreloadingUtil.getDefaultChangeDetailOptionsAsHex()); + "defaultChangeDetailHex", ListOption.toHex(IndexPreloadingUtil.CHANGE_DETAIL_OPTIONS)); data.put( "changeRequestsPath", IndexPreloadingUtil.computeChangeRequestsPath(requestedPath, page).get()); break; case DIFF: - data.put("defaultDiffDetailHex", IndexPreloadingUtil.getDefaultDiffDetailOptionsAsHex()); + data.put("defaultDiffDetailHex", ListOption.toHex(IndexPreloadingUtil.DIFF_OPTIONS)); data.put( "changeRequestsPath", IndexPreloadingUtil.computeChangeRequestsPath(requestedPath, page).get()); @@ -120,7 +121,7 @@ serializeObject(GSON, accountApi.getEditPreferences())); data.put("userIsAuthenticated", true); if (page == RequestedPage.DASHBOARD) { - data.put("defaultDashboardHex", IndexPreloadingUtil.getDefaultDashboardHex(serverApi)); + data.put("defaultDashboardHex", ListOption.toHex(IndexPreloadingUtil.DASHBOARD_OPTIONS)); data.put("dashboardQuery", IndexPreloadingUtil.computeDashboardQueryList(serverApi)); } } catch (AuthException e) {
diff --git a/java/com/google/gerrit/httpd/raw/IndexPreloadingUtil.java b/java/com/google/gerrit/httpd/raw/IndexPreloadingUtil.java index f1da6b7..3bdcb1a 100644 --- a/java/com/google/gerrit/httpd/raw/IndexPreloadingUtil.java +++ b/java/com/google/gerrit/httpd/raw/IndexPreloadingUtil.java
@@ -24,16 +24,13 @@ import com.google.gerrit.common.UsedAt.Project; import com.google.gerrit.extensions.api.config.Server; import com.google.gerrit.extensions.client.ListChangesOption; -import com.google.gerrit.extensions.client.ListOption; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.extensions.restapi.Url; import java.net.URI; import java.net.URISyntaxException; import java.util.ArrayList; -import java.util.EnumSet; import java.util.List; import java.util.Optional; -import java.util.Set; import java.util.regex.Matcher; import java.util.regex.Pattern; import java.util.stream.Stream; @@ -69,7 +66,7 @@ "is:open owner:${user} -is:wip -is:ignored limit:25"; public static final String DASHBOARD_INCOMING_QUERY = "is:open -owner:${user} -is:wip -is:ignored (reviewer:${user} OR assignee:${user}) limit:25"; - public static final String CC_QUERY = "is:open -is:ignored cc:${user} limit:10"; + public static final String CC_QUERY = "is:open -is:ignored -is:wip cc:${user} limit:10"; public static final String DASHBOARD_RECENTLY_CLOSED_QUERY = "is:closed -is:ignored (-is:wip OR owner:self) " + "(owner:${user} OR reviewer:${user} OR assignee:${user} " @@ -91,43 +88,26 @@ NEW_USER) .map(query -> query.replaceAll("\\$\\{user}", "self")) .collect(toImmutableList()); + public static final ImmutableSet<ListChangesOption> DASHBOARD_OPTIONS = + ImmutableSet.of(ListChangesOption.LABELS, ListChangesOption.DETAILED_ACCOUNTS); - public static String getDefaultChangeDetailOptionsAsHex() { - Set<ListChangesOption> options = - ImmutableSet.of( - ListChangesOption.ALL_COMMITS, - ListChangesOption.ALL_REVISIONS, - ListChangesOption.CHANGE_ACTIONS, - ListChangesOption.DETAILED_LABELS, - ListChangesOption.DOWNLOAD_COMMANDS, - ListChangesOption.MESSAGES, - ListChangesOption.SUBMITTABLE, - ListChangesOption.WEB_LINKS, - ListChangesOption.SKIP_DIFFSTAT); + public static final ImmutableSet<ListChangesOption> CHANGE_DETAIL_OPTIONS = + ImmutableSet.of( + ListChangesOption.ALL_COMMITS, + ListChangesOption.ALL_REVISIONS, + ListChangesOption.CHANGE_ACTIONS, + ListChangesOption.DETAILED_LABELS, + ListChangesOption.DOWNLOAD_COMMANDS, + ListChangesOption.MESSAGES, + ListChangesOption.SUBMITTABLE, + ListChangesOption.WEB_LINKS, + ListChangesOption.SKIP_DIFFSTAT); - return ListOption.toHex(options); - } - - public static String getDefaultDiffDetailOptionsAsHex() { - Set<ListChangesOption> options = - ImmutableSet.of( - ListChangesOption.ALL_COMMITS, - ListChangesOption.ALL_REVISIONS, - ListChangesOption.SKIP_DIFFSTAT); - - return ListOption.toHex(options); - } - - public static String getDefaultDashboardHex(Server serverApi) throws RestApiException { - Set<ListChangesOption> options = EnumSet.noneOf(ListChangesOption.class); - options.add(ListChangesOption.LABELS); - options.add(ListChangesOption.DETAILED_ACCOUNTS); - - if (!isEnabledAttentionSet(serverApi)) { - options.add(ListChangesOption.REVIEWED); - } - return ListOption.toHex(options); - } + public static final ImmutableSet<ListChangesOption> DIFF_OPTIONS = + ImmutableSet.of( + ListChangesOption.ALL_COMMITS, + ListChangesOption.ALL_REVISIONS, + ListChangesOption.SKIP_DIFFSTAT); public static String getPath(@Nullable String requestedURL) throws URISyntaxException { if (requestedURL == null) {
diff --git a/java/com/google/gerrit/httpd/raw/StaticModule.java b/java/com/google/gerrit/httpd/raw/StaticModule.java index bb1eb92..aa32169 100644 --- a/java/com/google/gerrit/httpd/raw/StaticModule.java +++ b/java/com/google/gerrit/httpd/raw/StaticModule.java
@@ -225,8 +225,7 @@ @GerritServerConfig Config cfg, GerritApi gerritApi, ExperimentFeatures experimentFeatures) { - String cdnPath = - options.useDevCdn() ? options.devCdn() : cfg.getString("gerrit", null, "cdnPath"); + String cdnPath = options.devCdn().orElse(cfg.getString("gerrit", null, "cdnPath")); String faviconPath = cfg.getString("gerrit", null, "faviconPath"); return new IndexServlet(canonicalUrl, cdnPath, faviconPath, gerritApi, experimentFeatures); } @@ -273,7 +272,7 @@ if (warFs == null) { unpackedWar = makeWarTempDir(); development = true; - } else if (options.useDevCdn()) { + } else if (options.devCdn().isPresent()) { unpackedWar = null; development = true; } else {
diff --git a/java/com/google/gerrit/httpd/restapi/ParameterParser.java b/java/com/google/gerrit/httpd/restapi/ParameterParser.java index 3ab409e..315c9c8 100644 --- a/java/com/google/gerrit/httpd/restapi/ParameterParser.java +++ b/java/com/google/gerrit/httpd/restapi/ParameterParser.java
@@ -56,9 +56,18 @@ public class ParameterParser { public static final String TRACE_PARAMETER = "trace"; + public static final String EXPERIMENT_PARAMETER = "experiment"; private static final ImmutableSet<String> RESERVED_KEYS = - ImmutableSet.of("pp", "prettyPrint", "strict", "callback", "alt", "fields", TRACE_PARAMETER); + ImmutableSet.of( + "pp", + "prettyPrint", + "strict", + "callback", + "alt", + "fields", + TRACE_PARAMETER, + EXPERIMENT_PARAMETER); @AutoValue public abstract static class QueryParams {
diff --git a/java/com/google/gerrit/httpd/restapi/RestApiServlet.java b/java/com/google/gerrit/httpd/restapi/RestApiServlet.java index 269d1c4..cfb5458 100644 --- a/java/com/google/gerrit/httpd/restapi/RestApiServlet.java +++ b/java/com/google/gerrit/httpd/restapi/RestApiServlet.java
@@ -46,6 +46,7 @@ import static javax.servlet.http.HttpServletResponse.SC_NOT_MODIFIED; import static javax.servlet.http.HttpServletResponse.SC_OK; import static javax.servlet.http.HttpServletResponse.SC_PRECONDITION_FAILED; +import static javax.servlet.http.HttpServletResponse.SC_REQUEST_TIMEOUT; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Joiner; @@ -66,6 +67,7 @@ import com.google.gerrit.common.Nullable; import com.google.gerrit.common.RawInputUtil; import com.google.gerrit.entities.Project; +import com.google.gerrit.extensions.events.GitReferenceUpdatedListener; import com.google.gerrit.extensions.registration.DynamicItem; import com.google.gerrit.extensions.registration.DynamicMap; import com.google.gerrit.extensions.registration.DynamicSet; @@ -97,19 +99,26 @@ import com.google.gerrit.extensions.restapi.RestView; import com.google.gerrit.extensions.restapi.TopLevelResource; import com.google.gerrit.extensions.restapi.UnprocessableEntityException; +import com.google.gerrit.extensions.restapi.Url; import com.google.gerrit.httpd.WebSession; import com.google.gerrit.httpd.restapi.ParameterParser.QueryParams; import com.google.gerrit.json.OutputFormat; import com.google.gerrit.server.AccessPath; import com.google.gerrit.server.AnonymousUser; +import com.google.gerrit.server.CancellationMetrics; import com.google.gerrit.server.CurrentUser; +import com.google.gerrit.server.DeadlineChecker; import com.google.gerrit.server.DynamicOptions; import com.google.gerrit.server.ExceptionHook; +import com.google.gerrit.server.InvalidDeadlineException; import com.google.gerrit.server.OptionUtil; import com.google.gerrit.server.RequestInfo; import com.google.gerrit.server.RequestListener; import com.google.gerrit.server.audit.ExtendedHttpAuditEvent; import com.google.gerrit.server.cache.PerThreadCache; +import com.google.gerrit.server.cancellation.RequestCancelledException; +import com.google.gerrit.server.cancellation.RequestStateContext; +import com.google.gerrit.server.cancellation.RequestStateProvider; import com.google.gerrit.server.change.ChangeFinder; import com.google.gerrit.server.change.RevisionResource; import com.google.gerrit.server.config.GerritServerConfig; @@ -203,7 +212,12 @@ private static final String FORM_TYPE = "application/x-www-form-urlencoded"; + @VisibleForTesting public static final String X_GERRIT_DEADLINE = "X-Gerrit-Deadline"; @VisibleForTesting public static final String X_GERRIT_TRACE = "X-Gerrit-Trace"; + @VisibleForTesting public static final String X_GERRIT_UPDATED_REF = "X-Gerrit-UpdatedRef"; + + @VisibleForTesting + public static final String X_GERRIT_UPDATED_REF_ENABLED = "X-Gerrit-UpdatedRef-Enabled"; private static final String X_REQUESTED_WITH = "X-Requested-With"; private static final String X_GERRIT_AUTH = "X-Gerrit-Auth"; @@ -219,6 +233,7 @@ public static final String XD_METHOD = "$m"; public static final int SC_UNPROCESSABLE_ENTITY = 422; public static final int SC_TOO_MANY_REQUESTS = 429; + public static final int SC_CLIENT_CLOSED_REQUEST = 499; private static final int HEAP_EST_SIZE = 10 * 8 * 1024; // Presize 10 blocks. private static final String PLAIN_TEXT = "text/plain"; @@ -256,6 +271,8 @@ final Injector injector; final DynamicMap<DynamicOptions.DynamicBean> dynamicBeans; final ExperimentFeatures experimentFeatures; + final DeadlineChecker.Factory deadlineCheckerFactory; + final CancellationMetrics cancellationMetrics; @Inject Globals( @@ -274,7 +291,9 @@ PluginSetContext<ExceptionHook> exceptionHooks, Injector injector, DynamicMap<DynamicOptions.DynamicBean> dynamicBeans, - ExperimentFeatures experimentFeatures) { + ExperimentFeatures experimentFeatures, + DeadlineChecker.Factory deadlineCheckerFactory, + CancellationMetrics cancellationMetrics) { this.currentUser = currentUser; this.webSession = webSession; this.paramParser = paramParser; @@ -292,6 +311,8 @@ this.injector = injector; this.dynamicBeans = dynamicBeans; this.experimentFeatures = experimentFeatures; + this.deadlineCheckerFactory = deadlineCheckerFactory; + this.cancellationMetrics = cancellationMetrics; } private static Pattern makeAllowOrigin(Config cfg) { @@ -338,9 +359,10 @@ ViewData viewData = null; try (TraceContext traceContext = enableTracing(req, res)) { - List<IdString> path = splitPath(req); + String requestUri = requestUri(req); try (PerThreadCache ignored = PerThreadCache.create()) { + List<IdString> path = splitPath(req); RequestInfo requestInfo = createRequestInfo(traceContext, requestUri(req), path); globals.requestListeners.runEach(l -> l.onRequest(requestInfo)); @@ -349,8 +371,13 @@ // plugins happens before the client sees the response. This is needed for being able to // test performance logging from an acceptance test (see // TraceIT#performanceLoggingForRestCall()). - try (PerformanceLogContext performanceLogContext = - new PerformanceLogContext(globals.config, globals.performanceLoggers)) { + try (RequestStateContext requestStateContext = + RequestStateContext.open() + .addRequestStateProvider( + globals.deadlineCheckerFactory.create( + requestInfo, req.getHeader(X_GERRIT_DEADLINE))); + PerformanceLogContext performanceLogContext = + new PerformanceLogContext(globals.config, globals.performanceLoggers)) { traceRequestData(req); if (isCorsPreflight(req)) { @@ -592,6 +619,11 @@ } else { throw new ResourceNotFoundException(); } + String isUpdatedRefEnabled = req.getHeader(X_GERRIT_UPDATED_REF_ENABLED); + if (!Strings.isNullOrEmpty(isUpdatedRefEnabled) + && Boolean.valueOf(isUpdatedRefEnabled)) { + setXGerritUpdatedRefResponseHeaders(req, res); + } if (response instanceof Response.Redirect) { CacheHeaders.setNotCacheable(res); @@ -698,31 +730,51 @@ messageOr(e, "Quota limit reached"), e.caching(), e); + } catch (InvalidDeadlineException e) { + cause = Optional.of(e); + responseBytes = + replyError(req, res, statusCode = SC_BAD_REQUEST, messageOr(e, "Bad Request"), e); } catch (Exception e) { cause = Optional.of(e); - statusCode = SC_INTERNAL_SERVER_ERROR; - Optional<ExceptionHook.Status> status = getStatus(e); - statusCode = status.map(ExceptionHook.Status::statusCode).orElse(SC_INTERNAL_SERVER_ERROR); - - if (res.isCommitted()) { - responseBytes = 0; - if (statusCode == SC_INTERNAL_SERVER_ERROR) { - logger.atSevere().withCause(e).log( - "Error in %s %s, response already committed", req.getMethod(), uriForLogging(req)); - } else { - logger.atWarning().log( - "Response for %s %s already committed, wanted to set status %d", - req.getMethod(), uriForLogging(req), statusCode); - } + Optional<RequestCancelledException> requestCancelledException = + RequestCancelledException.getFromCausalChain(e); + if (requestCancelledException.isPresent()) { + RequestStateProvider.Reason cancellationReason = + requestCancelledException.get().getCancellationReason(); + globals.cancellationMetrics.countCancelledRequest( + RequestInfo.RequestType.REST, requestUri, cancellationReason); + statusCode = getCancellationStatusCode(cancellationReason); + responseBytes = + replyError( + req, res, statusCode, getCancellationMessage(requestCancelledException.get()), e); } else { - res.reset(); - traceContext.getTraceId().ifPresent(traceId -> res.addHeader(X_GERRIT_TRACE, traceId)); + statusCode = SC_INTERNAL_SERVER_ERROR; - if (status.isPresent()) { - responseBytes = reply(req, res, e, status.get(), getUserMessages(traceContext, e)); + Optional<ExceptionHook.Status> status = getStatus(e); + statusCode = + status.map(ExceptionHook.Status::statusCode).orElse(SC_INTERNAL_SERVER_ERROR); + + if (res.isCommitted()) { + responseBytes = 0; + if (statusCode == SC_INTERNAL_SERVER_ERROR) { + logger.atSevere().withCause(e).log( + "Error in %s %s, response already committed", + req.getMethod(), uriForLogging(req)); + } else { + logger.atWarning().log( + "Response for %s %s already committed, wanted to set status %d", + req.getMethod(), uriForLogging(req), statusCode); + } } else { - responseBytes = replyInternalServerError(req, res, e, getUserMessages(traceContext, e)); + res.reset(); + TraceContext.getTraceId().ifPresent(traceId -> res.addHeader(X_GERRIT_TRACE, traceId)); + + if (status.isPresent()) { + responseBytes = reply(req, res, e, status.get(), getUserMessages(e)); + } else { + responseBytes = replyInternalServerError(req, res, e, getUserMessages(e)); + } } } } finally { @@ -753,6 +805,33 @@ } } + /** + * Fill in the refs that were updated during this request in the response header. The updated refs + * will be in the form of "project~ref~updated_SHA-1". + */ + private void setXGerritUpdatedRefResponseHeaders( + HttpServletRequest request, HttpServletResponse response) { + for (GitReferenceUpdatedListener.Event refUpdate : + globals.webSession.get().getRefUpdatedEvents()) { + String refUpdateFormat = + String.format( + "%s~%s~%s~%s", + // encode the project and ref names since they may contain `~` + Url.encode(refUpdate.getProjectName()), + Url.encode(refUpdate.getRefName()), + refUpdate.getOldObjectId(), + refUpdate.getNewObjectId()); + + if (isRead(request)) { + logger.atWarning().log( + "request %s performed a ref update %s although the request is a READ request", + request.getRequestURL(), refUpdateFormat); + } + response.addHeader(X_GERRIT_UPDATED_REF, refUpdateFormat); + } + globals.webSession.get().resetRefUpdatedEvents(); + } + private String getEtagWithRetry( HttpServletRequest req, TraceContext traceContext, @@ -904,7 +983,7 @@ throws Exception { RetryableAction<T> retryableAction = globals.retryHelper.action(actionType, caller, action); AtomicReference<Optional<String>> traceId = new AtomicReference<>(Optional.empty()); - if (!traceContext.isTracing()) { + if (!TraceContext.isTracing()) { // enable automatic retry with tracing in case of non-recoverable failure retryableAction .retryWithTrace(t -> !(t instanceof RestApiException)) @@ -1347,7 +1426,6 @@ * @param config config parameters for the JSON formatting * @param result the object that should be formatted as JSON * @return the length of the response - * @throws IOException */ public static long replyJson( @Nullable HttpServletRequest req, @@ -1737,6 +1815,10 @@ logger.atFinest().log( "Received REST request: %s %s (parameters: %s)", req.getMethod(), req.getRequestURI(), getParameterNames(req)); + Optional.ofNullable(req.getHeader(X_GERRIT_DEADLINE)) + .ifPresent( + clientProvidedDeadline -> + logger.atFine().log("%s = %s", X_GERRIT_DEADLINE, clientProvidedDeadline)); logger.atFinest().log("Calling user: %s", globals.currentUser.get().getLoggableName()); logger.atFinest().log( "Groups: %s", lazy(() -> globals.currentUser.get().getEffectiveGroups().getKnownGroups())); @@ -1792,9 +1874,9 @@ .findFirst(); } - private ImmutableList<String> getUserMessages(TraceContext traceContext, Throwable err) { + private ImmutableList<String> getUserMessages(Throwable err) { return globals.exceptionHooks.stream() - .flatMap(h -> h.getUserMessages(err, traceContext.getTraceId().orElse(null)).stream()) + .flatMap(h -> h.getUserMessages(err, TraceContext.getTraceId().orElse(null)).stream()) .collect(toImmutableList()); } @@ -1887,7 +1969,6 @@ * set to {@code true} if the reply may contain sensitive data * @param text the text reply * @return the length of the response - * @throws IOException */ static long replyText( @Nullable HttpServletRequest req, HttpServletResponse res, boolean allowTracing, String text) @@ -1901,6 +1982,28 @@ return replyBinaryResult(req, res, BinaryResult.create(text).setContentType(PLAIN_TEXT)); } + private static int getCancellationStatusCode(RequestStateProvider.Reason cancellationReason) { + switch (cancellationReason) { + case CLIENT_CLOSED_REQUEST: + return SC_CLIENT_CLOSED_REQUEST; + case CLIENT_PROVIDED_DEADLINE_EXCEEDED: + case SERVER_DEADLINE_EXCEEDED: + return SC_REQUEST_TIMEOUT; + } + logger.atSevere().log("Unexpected cancellation reason: %s", cancellationReason); + return SC_INTERNAL_SERVER_ERROR; + } + + private static String getCancellationMessage( + RequestCancelledException requestCancelledException) { + StringBuilder msg = new StringBuilder(requestCancelledException.formatCancellationReason()); + if (requestCancelledException.getCancellationMessage().isPresent()) { + msg.append("\n\n"); + msg.append(requestCancelledException.getCancellationMessage().get()); + } + return msg.toString(); + } + private static boolean acceptsGzip(HttpServletRequest req) { if (req != null) { String accepts = req.getHeader(HttpHeaders.ACCEPT_ENCODING);
diff --git a/java/com/google/gerrit/index/FieldDef.java b/java/com/google/gerrit/index/FieldDef.java index 63f6887..76aa7cc 100644 --- a/java/com/google/gerrit/index/FieldDef.java +++ b/java/com/google/gerrit/index/FieldDef.java
@@ -15,6 +15,7 @@ package com.google.gerrit.index; import static com.google.common.base.Preconditions.checkArgument; +import static com.google.common.base.Preconditions.checkState; import static java.util.Objects.requireNonNull; import com.google.common.base.CharMatcher; @@ -22,6 +23,7 @@ import com.google.gerrit.exceptions.StorageException; import java.io.IOException; import java.sql.Timestamp; +import java.util.Optional; /** * Definition of a field stored in the secondary index. @@ -65,6 +67,11 @@ T get(I input) throws IOException; } + @FunctionalInterface + public interface Setter<I, T> { + void set(I object, T value); + } + public static class Builder<T> { private final FieldType<T> type; private final String name; @@ -81,11 +88,20 @@ } public <I> FieldDef<I, T> build(Getter<I, T> getter) { - return new FieldDef<>(name, type, stored, false, getter); + return new FieldDef<>(name, type, stored, false, getter, null); + } + + public <I> FieldDef<I, T> build(Getter<I, T> getter, Setter<I, T> setter) { + return new FieldDef<>(name, type, stored, false, getter, setter); } public <I> FieldDef<I, Iterable<T>> buildRepeatable(Getter<I, Iterable<T>> getter) { - return new FieldDef<>(name, type, stored, true, getter); + return new FieldDef<>(name, type, stored, true, getter, null); + } + + public <I> FieldDef<I, Iterable<T>> buildRepeatable( + Getter<I, Iterable<T>> getter, Setter<I, Iterable<T>> setter) { + return new FieldDef<>(name, type, stored, true, getter, setter); } } @@ -96,9 +112,15 @@ private final boolean repeatable; private final Getter<I, T> getter; + private final Optional<Setter<I, T>> setter; private FieldDef( - String name, FieldType<?> type, boolean stored, boolean repeatable, Getter<I, T> getter) { + String name, + FieldType<?> type, + boolean stored, + boolean repeatable, + Getter<I, T> getter, + @Nullable Setter<I, T> setter) { checkArgument( !(repeatable && type == FieldType.INTEGER_RANGE), "Range queries against repeated fields are unsupported"); @@ -107,6 +129,7 @@ this.stored = stored; this.repeatable = repeatable; this.getter = requireNonNull(getter); + this.setter = Optional.ofNullable(setter); } private static String checkName(String name) { @@ -115,17 +138,17 @@ return name; } - /** @return name of the field. */ + /** Returns name of the field. */ public String getName() { return name; } - /** @return type of the field; for repeatable fields, the inner type, not the iterable type. */ + /** Returns type of the field; for repeatable fields, the inner type, not the iterable type. */ public FieldType<?> getType() { return type; } - /** @return whether the field should be stored in the index. */ + /** Returns whether the field should be stored in the index. */ public boolean isStored() { return stored; } @@ -145,7 +168,42 @@ } } - /** @return whether the field is repeatable. */ + /** + * Set the field contents back to an object. Used to reconstruct fields from indexed values. No-op + * if the field can't be reconstructed. + * + * @param object input object. + * @param doc indexed document + * @return {@code true} if the field was set, {@code false} otherwise + */ + @SuppressWarnings("unchecked") + public boolean setIfPossible(I object, StoredValue doc) { + if (!setter.isPresent()) { + return false; + } + + if (FieldType.STRING_TYPES.stream().anyMatch(t -> t.getName().equals(getType().getName()))) { + setter.get().set(object, (T) (isRepeatable() ? doc.asStrings() : doc.asString())); + return true; + } else if (FieldType.INTEGER_TYPES.stream() + .anyMatch(t -> t.getName().equals(getType().getName()))) { + setter.get().set(object, (T) (isRepeatable() ? doc.asIntegers() : doc.asInteger())); + return true; + } else if (FieldType.LONG.getName().equals(getType().getName())) { + setter.get().set(object, (T) (isRepeatable() ? doc.asLongs() : doc.asLong())); + return true; + } else if (FieldType.STORED_ONLY.getName().equals(getType().getName())) { + setter.get().set(object, (T) (isRepeatable() ? doc.asByteArrays() : doc.asByteArray())); + return true; + } else if (FieldType.TIMESTAMP.getName().equals(getType().getName())) { + checkState(!isRepeatable(), "can't repeat timestamp values"); + setter.get().set(object, (T) doc.asTimestamp()); + return true; + } + return false; + } + + /** Returns whether the field is repeatable. */ public boolean isRepeatable() { return repeatable; }
diff --git a/java/com/google/gerrit/index/FieldType.java b/java/com/google/gerrit/index/FieldType.java index 0db0284..c4c55f23 100644 --- a/java/com/google/gerrit/index/FieldType.java +++ b/java/com/google/gerrit/index/FieldType.java
@@ -14,6 +14,7 @@ package com.google.gerrit.index; +import com.google.common.collect.ImmutableList; import java.sql.Timestamp; /** Document field types supported by the secondary index system. */ @@ -42,6 +43,14 @@ /** A field that is only stored as raw bytes and cannot be queried. */ public static final FieldType<byte[]> STORED_ONLY = new FieldType<>("STORED_ONLY"); + /** List of all types that are stored as {@link String} in the index. */ + public static final ImmutableList<FieldType<String>> STRING_TYPES = + ImmutableList.of(EXACT, PREFIX, FULL_TEXT); + + /** List of all types that are stored as {@link Integer} in the index. */ + public static final ImmutableList<FieldType<Integer>> INTEGER_TYPES = + ImmutableList.of(INTEGER_RANGE, INTEGER); + private final String name; private FieldType(String name) {
diff --git a/java/com/google/gerrit/index/Index.java b/java/com/google/gerrit/index/Index.java index e662bc8..cc3117d 100644 --- a/java/com/google/gerrit/index/Index.java +++ b/java/com/google/gerrit/index/Index.java
@@ -33,7 +33,7 @@ * <p>Implementations must be thread-safe and should batch inserts/updates where appropriate. */ public interface Index<K, V> { - /** @return the schema version used by this index. */ + /** Returns the schema version used by this index. */ Schema<V> getSchema(); /** Close this index. */ @@ -145,4 +145,12 @@ * @param ready whether the index is ready */ void markReady(boolean ready); + + /** + * Returns whether the index is enabled. {@code true} by default, but could be overridden by + * implementations. + */ + default boolean isEnabled() { + return true; + } }
diff --git a/java/com/google/gerrit/index/IndexConfig.java b/java/com/google/gerrit/index/IndexConfig.java index 420a057..c21f32e 100644 --- a/java/com/google/gerrit/index/IndexConfig.java +++ b/java/com/google/gerrit/index/IndexConfig.java
@@ -121,44 +121,44 @@ } /** - * @return maximum limit supported by the underlying index, or limited for performance reasons. + * Returns maximum limit supported by the underlying index, or limited for performance reasons. */ public abstract int maxLimit(); /** - * @return maximum number of pages (limit / start) supported by the underlying index, or limited - * for performance reasons. + * Returns maximum number of pages (limit / start) supported by the underlying index, or limited + * for performance reasons. */ public abstract int maxPages(); /** - * @return maximum number of total index query terms supported by the underlying index, or limited - * for performance reasons. + * Returns maximum number of total index query terms supported by the underlying index, or limited + * for performance reasons. */ public abstract int maxTerms(); - /** @return index type. */ + /** Returns index type. */ public abstract String type(); /** - * @return whether different subsets of changes may be stored in different physical sub-indexes. + * Returns whether different subsets of changes may be stored in different physical sub-indexes. */ public abstract boolean separateChangeSubIndexes(); /** - * @return pagination type to use when index queries are repeated to obtain the next set of - * results. + * Returns pagination type to use when index queries are repeated to obtain the next set of + * results. */ public abstract PaginationType paginationType(); /** - * @return multiplier to be used to determine the limit when queries are repeated to obtain the - * next set of results. + * Returns multiplier to be used to determine the limit when queries are repeated to obtain the + * next set of results. */ public abstract int pageSizeMultiplier(); /** - * @return maximum allowed limit when repeating index queries to obtain the next set of results. + * Returns maximum allowed limit when repeating index queries to obtain the next set of results. */ public abstract int maxPageSize(); }
diff --git a/java/com/google/gerrit/index/IndexType.java b/java/com/google/gerrit/index/IndexType.java index ee44deb..75f8351 100644 --- a/java/com/google/gerrit/index/IndexType.java +++ b/java/com/google/gerrit/index/IndexType.java
@@ -14,24 +14,58 @@ package com.google.gerrit.index; +import static com.google.common.base.Preconditions.checkArgument; + +import com.google.common.base.Strings; import com.google.common.collect.ImmutableSet; import com.google.gerrit.common.Nullable; +import java.util.Optional; /** * Index types supported by the secondary index. * - * <p>The explicitly known index types are Lucene (the default) and Elasticsearch. + * <p>The explicitly known index types are Lucene (the default) and a fake index used in tests. * * <p>The third supported index type is any other type String value, deemed as custom. This is for * configuring index types that are internal or not to be disclosed. Supporting custom index types * allows to not break that case upon core implementation changes. */ public class IndexType { + public static final String SYS_PROP = "gerrit.index.type"; + private static final String ENV_VAR = "GERRIT_INDEX_TYPE"; + private static final String LUCENE = "lucene"; - private static final String ELASTICSEARCH = "elasticsearch"; + private static final String FAKE = "fake"; private final String type; + /** + * Returns the index type in case it was set by an environment variable. This is useful to run + * tests against a certain index backend. + */ + public static Optional<IndexType> fromEnvironment() { + String value = System.getenv(ENV_VAR); + if (Strings.isNullOrEmpty(value)) { + value = System.getProperty(SYS_PROP); + } + if (Strings.isNullOrEmpty(value)) { + return Optional.empty(); + } + value = value.toUpperCase().replace("-", "_"); + IndexType type = new IndexType(value); + if (!Strings.isNullOrEmpty(System.getenv(ENV_VAR))) { + checkArgument( + type != null, "Invalid value for env variable %s: %s", ENV_VAR, System.getenv(ENV_VAR)); + } else { + checkArgument( + type != null, + "Invalid value for system property %s: %s", + SYS_PROP, + System.getProperty(SYS_PROP)); + } + return Optional.of(type); + } + public IndexType(@Nullable String type) { this.type = type == null ? getDefault() : type.toLowerCase(); } @@ -41,15 +75,15 @@ } public static ImmutableSet<String> getKnownTypes() { - return ImmutableSet.of(LUCENE, ELASTICSEARCH); + return ImmutableSet.of(LUCENE, FAKE); } public boolean isLucene() { return type.equals(LUCENE); } - public boolean isElasticsearch() { - return type.equals(ELASTICSEARCH); + public boolean isFake() { + return type.equals(FAKE); } @Override
diff --git a/java/com/google/gerrit/index/QueryOptions.java b/java/com/google/gerrit/index/QueryOptions.java index 91c8d1a..40677a1 100644 --- a/java/com/google/gerrit/index/QueryOptions.java +++ b/java/com/google/gerrit/index/QueryOptions.java
@@ -73,7 +73,10 @@ int backendLimit = config().maxLimit(); int limit = Ints.saturatedCast((long) limit() + start()); limit = Math.min(limit, backendLimit); - int pageSize = Math.min(Ints.saturatedCast((long) pageSize() + start()), backendLimit); + int pageSize = + Math.min( + Math.min(Ints.saturatedCast((long) pageSize() + start()), config().maxPageSize()), + backendLimit); return create(config(), 0, null, pageSize, pageSizeMultiplier(), limit, fields()); } @@ -125,4 +128,8 @@ limit(), filter.apply(this)); } + + public int getLimitBasedOnPaginationType() { + return PaginationType.NONE == config().paginationType() ? limit() : pageSize(); + } }
diff --git a/java/com/google/gerrit/index/Schema.java b/java/com/google/gerrit/index/Schema.java index ec14a15..a14e583 100644 --- a/java/com/google/gerrit/index/Schema.java +++ b/java/com/google/gerrit/index/Schema.java
@@ -134,7 +134,7 @@ return fields; } - /** @return all fields in this schema where {@link FieldDef#isStored()} is true. */ + /** Returns all fields in this schema where {@link FieldDef#isStored()} is true. */ public final ImmutableMap<String, FieldDef<T, ?>> getStoredFields() { return storedFields; }
diff --git a/java/com/google/gerrit/index/StoredValue.java b/java/com/google/gerrit/index/StoredValue.java new file mode 100644 index 0000000..fe790c5 --- /dev/null +++ b/java/com/google/gerrit/index/StoredValue.java
@@ -0,0 +1,50 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.index; + +import java.sql.Timestamp; + +/** + * Representation of a field stored on the index. Used to load field values from different index + * backends. + */ +public interface StoredValue { + /** Returns the {@link String} value of the field. */ + String asString(); + + /** Returns the {@link String} values of the field. */ + Iterable<String> asStrings(); + + /** Returns the {@link Integer} value of the field. */ + Integer asInteger(); + + /** Returns the {@link Integer} values of the field. */ + Iterable<Integer> asIntegers(); + + /** Returns the {@link Long} value of the field. */ + Long asLong(); + + /** Returns the {@link Long} values of the field. */ + Iterable<Long> asLongs(); + + /** Returns the {@link Timestamp} value of the field. */ + Timestamp asTimestamp(); + + /** Returns the {@code byte[]} value of the field. */ + byte[] asByteArray(); + + /** Returns the {@code byte[]} values of the field. */ + Iterable<byte[]> asByteArrays(); +}
diff --git a/java/com/google/gerrit/index/project/IndexedProjectQuery.java b/java/com/google/gerrit/index/project/IndexedProjectQuery.java index 5fc74ca..52d08d6 100644 --- a/java/com/google/gerrit/index/project/IndexedProjectQuery.java +++ b/java/com/google/gerrit/index/project/IndexedProjectQuery.java
@@ -14,11 +14,14 @@ package com.google.gerrit.index.project; +import static com.google.common.base.Preconditions.checkState; + import com.google.gerrit.entities.Project; import com.google.gerrit.index.Index; import com.google.gerrit.index.QueryOptions; import com.google.gerrit.index.query.DataSource; import com.google.gerrit.index.query.IndexedQuery; +import com.google.gerrit.index.query.Matchable; import com.google.gerrit.index.query.Predicate; import com.google.gerrit.index.query.QueryParseException; @@ -27,11 +30,27 @@ * com.google.gerrit.index.IndexRewriter}. See {@link IndexedQuery}. */ public class IndexedProjectQuery extends IndexedQuery<Project.NameKey, ProjectData> - implements DataSource<ProjectData> { + implements DataSource<ProjectData>, Matchable<ProjectData> { public IndexedProjectQuery( Index<Project.NameKey, ProjectData> index, Predicate<ProjectData> pred, QueryOptions opts) throws QueryParseException { super(index, pred, opts.convertForBackend()); } + + @Override + public boolean match(ProjectData object) { + Predicate<ProjectData> pred = getChild(0); + checkState( + pred.isMatchable(), + "match invoked, but child predicate %s doesn't implement %s", + pred, + Matchable.class.getName()); + return pred.asMatchable().match(object); + } + + @Override + public int getCost() { + return 1; + } }
diff --git a/java/com/google/gerrit/index/query/AndSource.java b/java/com/google/gerrit/index/query/AndSource.java index ebd115b..f4c1464 100644 --- a/java/com/google/gerrit/index/query/AndSource.java +++ b/java/com/google/gerrit/index/query/AndSource.java
@@ -16,7 +16,6 @@ import static com.google.common.base.Preconditions.checkArgument; -import com.google.common.collect.ImmutableList; import com.google.gerrit.index.IndexConfig; import java.util.Collection; import java.util.List; @@ -24,36 +23,17 @@ public class AndSource<T> extends AndPredicate<T> implements DataSource<T> { protected final DataSource<T> source; - private final IsVisibleToPredicate<T> isVisibleToPredicate; private final int start; private final int cardinality; private final IndexConfig indexConfig; public AndSource(Collection<? extends Predicate<T>> that, IndexConfig indexConfig) { - this(that, null, 0, indexConfig); + this(that, 0, indexConfig); } - public AndSource( - Predicate<T> that, IsVisibleToPredicate<T> isVisibleToPredicate, IndexConfig indexConfig) { - this(that, isVisibleToPredicate, 0, indexConfig); - } - - public AndSource( - Predicate<T> that, - IsVisibleToPredicate<T> isVisibleToPredicate, - int start, - IndexConfig indexConfig) { - this(ImmutableList.of(that), isVisibleToPredicate, start, indexConfig); - } - - public AndSource( - Collection<? extends Predicate<T>> that, - IsVisibleToPredicate<T> isVisibleToPredicate, - int start, - IndexConfig indexConfig) { + public AndSource(Collection<? extends Predicate<T>> that, int start, IndexConfig indexConfig) { super(that); checkArgument(start >= 0, "negative start: %s", start); - this.isVisibleToPredicate = isVisibleToPredicate; this.start = start; this.indexConfig = indexConfig; @@ -93,16 +73,7 @@ } @Override - public boolean isMatchable() { - return isVisibleToPredicate != null || super.isMatchable(); - } - - @Override public boolean match(T object) { - if (isVisibleToPredicate != null && !isVisibleToPredicate.match(object)) { - return false; - } - if (super.isMatchable() && !super.match(object)) { return false; }
diff --git a/java/com/google/gerrit/index/query/DataSource.java b/java/com/google/gerrit/index/query/DataSource.java index 087d1fe..eb04099 100644 --- a/java/com/google/gerrit/index/query/DataSource.java +++ b/java/com/google/gerrit/index/query/DataSource.java
@@ -15,9 +15,9 @@ package com.google.gerrit.index.query; public interface DataSource<T> extends HasCardinality { - /** @return read from the database and return the results. */ + /** Returns read from the database and return the results. */ ResultSet<T> read(); - /** @return read from the database and return the raw results. */ + /** Returns read from the database and return the raw results. */ ResultSet<FieldBundle> readRaw(); }
diff --git a/java/com/google/gerrit/index/query/HasCardinality.java b/java/com/google/gerrit/index/query/HasCardinality.java index ac6640a..140ba4b 100644 --- a/java/com/google/gerrit/index/query/HasCardinality.java +++ b/java/com/google/gerrit/index/query/HasCardinality.java
@@ -15,6 +15,6 @@ package com.google.gerrit.index.query; public interface HasCardinality { - /** @return an estimate of the number of results a source can return. */ + /** Returns an estimate of the number of results a source can return. */ int getCardinality(); }
diff --git a/java/com/google/gerrit/index/query/IndexPredicate.java b/java/com/google/gerrit/index/query/IndexPredicate.java index aac6682..18d7fbc 100644 --- a/java/com/google/gerrit/index/query/IndexPredicate.java +++ b/java/com/google/gerrit/index/query/IndexPredicate.java
@@ -14,11 +14,29 @@ package com.google.gerrit.index.query; +import static com.google.common.collect.ImmutableSet.toImmutableSet; + +import com.google.common.base.CharMatcher; +import com.google.common.base.Splitter; +import com.google.common.collect.ImmutableSet; +import com.google.common.primitives.Ints; +import com.google.common.primitives.Longs; import com.google.gerrit.index.FieldDef; import com.google.gerrit.index.FieldType; +import java.util.Objects; +import java.util.Set; +import java.util.stream.StreamSupport; /** Predicate that is mapped to a field in the index. */ -public abstract class IndexPredicate<I> extends OperatorPredicate<I> { +public abstract class IndexPredicate<I> extends OperatorPredicate<I> implements Matchable<I> { + /** + * Text segmentation to be applied to both the query string and the indexed field for full-text + * queries. This is inspired by http://unicode.org/reports/tr29/ which is what Lucene uses, but + * complexity was reduced to the bare minimum at the cost of small discrepancies to the Unicode + * spec. + */ + private static final Splitter FULL_TEXT_SPLITTER = Splitter.on(CharMatcher.anyOf(" ,.-:\\/_\n")); + private final FieldDef<I, ?> def; protected IndexPredicate(FieldDef<I, ?> def, String value) { @@ -38,4 +56,69 @@ public FieldType<?> getType() { return def.getType(); } + + /** + * This method matches documents without calling an index subsystem. For primitive fields (e.g. + * integer, long) , the matching logic is consistent across this method and all known index + * implementations. For text fields (i.e. prefix and full-text) the semantics vary between this + * implementation and known index implementations: + * <li>Prefix: Lucene as well as {@link #match(Object)} matches terms as true prefixes (prefix:foo + * -> `foo bar` matches, but `baz foo bar` does not match). The index implementation at Google + * tokenizes both the query and the indexed text and matches tokens individually (prefix:fo ba + * -> `baz foo bar` matches). + * <li>Full text: Lucene uses a {@code PhraseQuery} to search for terms in full text fields + * in-order. The index implementation at Google as well as {@link #match(Object)} tokenizes + * both the query and the indexed text and matches tokens individually. + * + * @return true if the predicate matches the provided {@code I}. + */ + @Override + public boolean match(I doc) { + if (getField().isRepeatable()) { + Iterable<?> values = (Iterable<?>) getField().get(doc); + for (Object v : values) { + if (matchesSingleObject(v)) { + return true; + } + } + return false; + } + return matchesSingleObject(getField().get(doc)); + } + + @Override + public int getCost() { + return 1; + } + + private boolean matchesSingleObject(Object fieldValueFromObject) { + String fieldTypeName = getField().getType().getName(); + if (fieldTypeName.equals(FieldType.INTEGER.getName())) { + return Objects.equals(fieldValueFromObject, Ints.tryParse(value)); + } else if (fieldTypeName.equals(FieldType.EXACT.getName())) { + return Objects.equals(fieldValueFromObject, value); + } else if (fieldTypeName.equals(FieldType.LONG.getName())) { + return Objects.equals(fieldValueFromObject, Longs.tryParse(value)); + } else if (fieldTypeName.equals(FieldType.PREFIX.getName())) { + return String.valueOf(fieldValueFromObject).startsWith(value); + } else if (fieldTypeName.equals(FieldType.FULL_TEXT.getName())) { + Set<String> tokenizedField = tokenizeString(String.valueOf(fieldValueFromObject)); + Set<String> tokenizedValue = tokenizeString(value); + return !tokenizedValue.isEmpty() && tokenizedField.containsAll(tokenizedValue); + } else if (fieldTypeName.equals(FieldType.STORED_ONLY.getName())) { + throw new IllegalStateException("can't filter for storedOnly field " + getField().getName()); + } else if (fieldTypeName.equals(FieldType.TIMESTAMP.getName())) { + throw new IllegalStateException("timestamp queries must be handled in subclasses"); + } else if (fieldTypeName.equals(FieldType.INTEGER_RANGE.getName())) { + throw new IllegalStateException("integer range queries must be handled in subclasses"); + } else { + throw new IllegalStateException("unrecognized field " + fieldTypeName); + } + } + + private static ImmutableSet<String> tokenizeString(String value) { + return StreamSupport.stream(FULL_TEXT_SPLITTER.split(value.toLowerCase()).spliterator(), false) + .filter(s -> !s.trim().isEmpty()) + .collect(toImmutableSet()); + } }
diff --git a/java/com/google/gerrit/index/query/IntegerRangePredicate.java b/java/com/google/gerrit/index/query/IntegerRangePredicate.java index 6780867..850c4a5 100644 --- a/java/com/google/gerrit/index/query/IntegerRangePredicate.java +++ b/java/com/google/gerrit/index/query/IntegerRangePredicate.java
@@ -31,6 +31,7 @@ protected abstract Integer getValueInt(T object); + @Override public boolean match(T object) { Integer valueInt = getValueInt(object); if (valueInt == null) {
diff --git a/java/com/google/gerrit/index/query/InternalQuery.java b/java/com/google/gerrit/index/query/InternalQuery.java index 48e214e..5c003bc 100644 --- a/java/com/google/gerrit/index/query/InternalQuery.java +++ b/java/com/google/gerrit/index/query/InternalQuery.java
@@ -42,7 +42,7 @@ */ public class InternalQuery<T, Q extends InternalQuery<T, Q>> { private final QueryProcessor<T> queryProcessor; - private final IndexCollection<?, T, ? extends Index<?, T>> indexes; + protected final IndexCollection<?, T, ? extends Index<?, T>> indexes; protected final IndexConfig indexConfig;
diff --git a/java/com/google/gerrit/index/query/Matchable.java b/java/com/google/gerrit/index/query/Matchable.java index 7a16ae8..f416149 100644 --- a/java/com/google/gerrit/index/query/Matchable.java +++ b/java/com/google/gerrit/index/query/Matchable.java
@@ -18,6 +18,6 @@ /** Does this predicate match this object? */ boolean match(T object); - /** @return a cost estimate to run this predicate, higher figures cost more. */ + /** Returns a cost estimate to run this predicate, higher figures cost more. */ int getCost(); }
diff --git a/java/com/google/gerrit/index/query/PaginatingSource.java b/java/com/google/gerrit/index/query/PaginatingSource.java index 8390cbb..84572d7 100644 --- a/java/com/google/gerrit/index/query/PaginatingSource.java +++ b/java/com/google/gerrit/index/query/PaginatingSource.java
@@ -92,6 +92,9 @@ r.add(data); } pageResultSize++; + if (r.size() > limit) { + break; + } } nextStart += pageResultSize; searchAfter = next.searchAfter();
diff --git a/java/com/google/gerrit/index/query/Predicate.java b/java/com/google/gerrit/index/query/Predicate.java index b5ed82d..9dc7689 100644 --- a/java/com/google/gerrit/index/query/Predicate.java +++ b/java/com/google/gerrit/index/query/Predicate.java
@@ -18,9 +18,12 @@ import static com.google.common.base.Preconditions.checkState; import com.google.common.collect.Iterables; +import java.util.ArrayList; import java.util.Collection; import java.util.Collections; +import java.util.LinkedList; import java.util.List; +import java.util.Queue; /** * An abstract predicate tree for any form of query. @@ -41,6 +44,32 @@ * @param <T> type of object the predicate can evaluate in memory. */ public abstract class Predicate<T> { + /** Query String that was used to create this predicate. Only set from the Antlr query parser. */ + private String predicateString = null; + + /** + * Boolean indicating if this predicate is a leaf predicate in a composite expression. Only set + * from the Antlr query parser. + */ + private boolean isLeaf = false; + + /** Sets the {@link #predicateString} field. This can only be set once. */ + void setPredicateString(String predicateString) { + this.predicateString = this.predicateString == null ? predicateString : this.predicateString; + } + + public String getPredicateString() { + return predicateString; + } + + void setLeaf(boolean isLeaf) { + this.isLeaf = isLeaf; + } + + public boolean isLeaf() { + return isLeaf; + } + /** A predicate that matches any input, always, with no cost. */ @SuppressWarnings("unchecked") public static <T> Predicate<T> any() { @@ -120,6 +149,19 @@ return leafCount; } + /** Returns a list of this predicate and all its descendants. */ + public List<Predicate<T>> getFlattenedPredicateList() { + List<Predicate<T>> result = new ArrayList<>(); + Queue<Predicate<T>> queue = new LinkedList<>(); + queue.add(this); + while (!queue.isEmpty()) { + Predicate<T> current = queue.poll(); + result.add(current); + current.getChildren().forEach(p -> queue.add(p)); + } + return result; + } + /** Create a copy of this predicate, with new children. */ public abstract Predicate<T> copy(Collection<? extends Predicate<T>> children); @@ -127,13 +169,18 @@ return this instanceof Matchable; } + /** Whether this predicate can be used in search queries. */ + public boolean supportedForQueries() { + return true; + } + @SuppressWarnings("unchecked") public Matchable<T> asMatchable() { checkState(isMatchable(), "not matchable"); return (Matchable<T>) this; } - /** @return a cost estimate to run this predicate, higher figures cost more. */ + /** Returns a cost estimate to run this predicate, higher figures cost more. */ public int estimateCost() { if (!isMatchable()) { return 1;
diff --git a/java/com/google/gerrit/index/query/QueryBuilder.java b/java/com/google/gerrit/index/query/QueryBuilder.java index 85dcf3e..ffa7ce4 100644 --- a/java/com/google/gerrit/index/query/QueryBuilder.java +++ b/java/com/google/gerrit/index/query/QueryBuilder.java
@@ -46,6 +46,9 @@ import java.util.Collections; import java.util.List; import java.util.Map; +import org.antlr.runtime.CharStream; +import org.antlr.runtime.CommonToken; +import org.antlr.runtime.tree.CommonTree; import org.antlr.runtime.tree.Tree; /** @@ -246,23 +249,62 @@ } private Predicate<T> toPredicate(Tree r) throws QueryParseException, IllegalArgumentException { + Predicate<T> result; switch (r.getType()) { case AND: - return and(children(r)); + result = and(children(r)); + break; case OR: - return or(children(r)); + result = or(children(r)); + break; case NOT: - return not(toPredicate(onlyChildOf(r))); + result = not(toPredicate(onlyChildOf(r))); + break; case DEFAULT_FIELD: - return defaultField(concatenateChildText(r)); + result = defaultField(concatenateChildText(r)); + break; case FIELD_NAME: - return operator(r.getText(), concatenateChildText(r)); + result = operator(r.getText(), concatenateChildText(r)); + break; default: throw error("Unsupported operator: " + r); } + result.setPredicateString(getPredicateString(r)); + return result; + } + + /** + * Reconstruct the query sub-expression that was passed as input to the query parser from the tree + * input parameter. + */ + private static String getPredicateString(Tree r) { + CommonTree ct = (CommonTree) r; + CommonToken token = (CommonToken) ct.getToken(); + CharStream inputStream = token.getInputStream(); + int leftIdx = getLeftIndex(r); + int rightIdx = getRightIndex(r); + if (inputStream == null) { + return ""; + } + return inputStream.substring(leftIdx, rightIdx); + } + + private static int getLeftIndex(Tree r) { + CommonTree ct = (CommonTree) r; + CommonToken token = (CommonToken) ct.getToken(); + return token.getStartIndex(); + } + + private static int getRightIndex(Tree r) { + CommonTree ct = (CommonTree) r; + if (ct.getChildCount() == 0) { + CommonToken token = (CommonToken) ct.getToken(); + return token.getStopIndex(); + } + return getRightIndex(ct.getChild(ct.getChildCount() - 1)); } private static String concatenateChildText(Tree r) throws QueryParseException { @@ -367,7 +409,10 @@ @Override public Predicate<T> create(Q builder, String value) throws QueryParseException { try { - return (Predicate<T>) method.invoke(builder, value); + Predicate<T> predicate = (Predicate<T>) method.invoke(builder, value); + // All operator predicates are leaf predicates. + predicate.setLeaf(true); + return predicate; } catch (RuntimeException | IllegalAccessException e) { throw error("Error in operator " + name + ":" + value, e); } catch (InvocationTargetException e) {
diff --git a/java/com/google/gerrit/index/query/QueryProcessor.java b/java/com/google/gerrit/index/query/QueryProcessor.java index 4b14290..b7584c6 100644 --- a/java/com/google/gerrit/index/query/QueryProcessor.java +++ b/java/com/google/gerrit/index/query/QueryProcessor.java
@@ -61,7 +61,7 @@ protected static class Metrics { final Timer1<String> executionTime; - Metrics(MetricMaker metricMaker) { + protected Metrics(MetricMaker metricMaker) { executionTime = metricMaker.newTimer( "query/query_latency", @@ -95,14 +95,14 @@ private Set<String> requestedFields; protected QueryProcessor( - MetricMaker metricMaker, + Metrics metrics, SchemaDefinitions<T> schemaDef, IndexConfig indexConfig, IndexCollection<?, T, ? extends Index<?, T>> indexes, IndexRewriter<T> rewriter, String limitField, IntSupplier userQueryLimit) { - this.metrics = new Metrics(metricMaker); + this.metrics = metrics; this.schemaDef = schemaDef; this.indexConfig = indexConfig; this.indexes = indexes; @@ -228,6 +228,7 @@ List<DataSource<T>> sources = new ArrayList<>(cnt); int queryCount = 0; for (Predicate<T> q : queries) { + checkSupportedForQueries(q); int limit = getEffectiveLimit(q); limits.add(limit); int initialPageSize = getInitialPageSize(limit); @@ -324,6 +325,15 @@ return out; } + private void checkSupportedForQueries(Predicate<T> predicate) throws QueryParseException { + List<Predicate<T>> descendants = predicate.getFlattenedPredicateList(); + for (Predicate<T> p : descendants) { + if (!p.supportedForQueries()) { + throw new QueryParseException(String.format("Operator '%s' cannot be used in queries", p)); + } + } + } + private static <T> ImmutableList<QueryResult<T>> disabledResults( List<String> queryStrings, List<Predicate<T>> queries) { return IntStream.range(0, queries.size())
diff --git a/java/com/google/gerrit/index/query/QueryResult.java b/java/com/google/gerrit/index/query/QueryResult.java index 33fcef0..d03a68b 100644 --- a/java/com/google/gerrit/index/query/QueryResult.java +++ b/java/com/google/gerrit/index/query/QueryResult.java
@@ -34,19 +34,19 @@ return new AutoValue_QueryResult<>(query, predicate, ImmutableList.copyOf(entities), more); } - /** @return the original query string, or null if the query was created programmatically. */ + /** Returns the original query string, or null if the query was created programmatically. */ @Nullable public abstract String query(); - /** @return the predicate after all rewriting and other modification by the query subsystem. */ + /** Returns the predicate after all rewriting and other modification by the query subsystem. */ public abstract Predicate<T> predicate(); - /** @return the query results. */ + /** Returns the query results. */ public abstract ImmutableList<T> entities(); /** - * @return whether the query could be retried with a higher start/limit to produce more results. - * Never true if {@link #entities()} is empty. + * Returns whether the query could be retried with a higher start/limit to produce more results. + * Never true if {@link #entities()} is empty. */ public abstract boolean more(); }
diff --git a/java/com/google/gerrit/index/testing/AbstractFakeIndex.java b/java/com/google/gerrit/index/testing/AbstractFakeIndex.java new file mode 100644 index 0000000..9101ae5 --- /dev/null +++ b/java/com/google/gerrit/index/testing/AbstractFakeIndex.java
@@ -0,0 +1,380 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.index.testing; + +import static com.google.common.collect.ImmutableList.toImmutableList; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableListMultimap; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.Iterables; +import com.google.gerrit.entities.Account; +import com.google.gerrit.entities.AccountGroup; +import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.InternalGroup; +import com.google.gerrit.entities.Project; +import com.google.gerrit.index.FieldDef; +import com.google.gerrit.index.Index; +import com.google.gerrit.index.QueryOptions; +import com.google.gerrit.index.Schema; +import com.google.gerrit.index.project.ProjectData; +import com.google.gerrit.index.project.ProjectIndex; +import com.google.gerrit.index.query.DataSource; +import com.google.gerrit.index.query.FieldBundle; +import com.google.gerrit.index.query.ListResultSet; +import com.google.gerrit.index.query.Predicate; +import com.google.gerrit.index.query.ResultSet; +import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.change.MergeabilityComputationBehavior; +import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.config.SitePaths; +import com.google.gerrit.server.index.IndexUtils; +import com.google.gerrit.server.index.account.AccountIndex; +import com.google.gerrit.server.index.change.ChangeField; +import com.google.gerrit.server.index.change.ChangeIndex; +import com.google.gerrit.server.index.group.GroupIndex; +import com.google.gerrit.server.query.change.ChangeData; +import com.google.inject.Inject; +import com.google.inject.assistedinject.Assisted; +import java.sql.Timestamp; +import java.util.Comparator; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.IntStream; +import java.util.stream.Stream; +import org.eclipse.jgit.annotations.Nullable; +import org.eclipse.jgit.lib.Config; + +/** + * Fake secondary index implementation for usage in tests. All values are kept in-memory. + * + * <p>This class is thread-safe. + */ +public abstract class AbstractFakeIndex<K, V, D> implements Index<K, V> { + private final Schema<V> schema; + /** + * SitePaths (config files) are used to signal that an index is ready. This implementation is + * consistent with other index backends. + */ + private final SitePaths sitePaths; + + private final String indexName; + private final Map<K, D> indexedDocuments; + private int queryCount; + + AbstractFakeIndex(Schema<V> schema, SitePaths sitePaths, String indexName) { + this.schema = schema; + this.sitePaths = sitePaths; + this.indexName = indexName; + this.indexedDocuments = new HashMap<>(); + this.queryCount = 0; + } + + @Override + public Schema<V> getSchema() { + return schema; + } + + @Override + public void close() { + // No-op + } + + @Override + public void replace(V doc) { + synchronized (indexedDocuments) { + indexedDocuments.put(keyFor(doc), docFor(doc)); + } + } + + @Override + public void delete(K key) { + synchronized (indexedDocuments) { + indexedDocuments.remove(key); + } + } + + @Override + public void deleteAll() { + synchronized (indexedDocuments) { + indexedDocuments.clear(); + } + } + + public int getQueryCount() { + return queryCount; + } + + @Override + public DataSource<V> getSource(Predicate<V> p, QueryOptions opts) { + List<V> results; + synchronized (indexedDocuments) { + Stream<V> valueStream = + indexedDocuments.values().stream() + .map(doc -> valueFor(doc)) + .filter(doc -> p.asMatchable().match(doc)) + .sorted(sortingComparator()); + if (opts.searchAfter() != null) { + ImmutableList<V> valueList = valueStream.collect(toImmutableList()); + int fromIndex = + IntStream.range(0, valueList.size()) + .filter(i -> keyFor(valueList.get(i)).equals(opts.searchAfter())) + .findFirst() + .orElse(-1) + + 1; + int toIndex = Math.min(fromIndex + opts.getLimitBasedOnPaginationType(), valueList.size()); + results = valueList.subList(fromIndex, toIndex); + } else { + results = + valueStream + .skip(opts.start()) + .limit(opts.getLimitBasedOnPaginationType()) + .collect(toImmutableList()); + } + queryCount++; + } + return new DataSource<V>() { + @Override + public int getCardinality() { + return results.size(); + } + + @Override + public ResultSet<V> read() { + return new ListResultSet<>(results) { + @Override + public Object searchAfter() { + @Nullable V last = Iterables.getLast(results, null); + return last != null ? keyFor(last) : null; + } + }; + } + + @Override + public ResultSet<FieldBundle> readRaw() { + ImmutableList.Builder<FieldBundle> fieldBundles = ImmutableList.builder(); + K searchAfter = null; + for (V result : results) { + ImmutableListMultimap.Builder<String, Object> fields = ImmutableListMultimap.builder(); + for (FieldDef<V, ?> field : getSchema().getFields().values()) { + if (field.get(result) == null) { + continue; + } + if (field.isRepeatable()) { + fields.putAll(field.getName(), (Iterable<?>) field.get(result)); + } else { + fields.put(field.getName(), field.get(result)); + } + } + fieldBundles.add(new FieldBundle(fields.build())); + searchAfter = keyFor(result); + } + ImmutableList<FieldBundle> resultSet = fieldBundles.build(); + K finalSearchAfter = searchAfter; + return new ListResultSet<>(resultSet) { + @Override + public Object searchAfter() { + return finalSearchAfter; + } + }; + } + }; + } + + @Override + public void markReady(boolean ready) { + IndexUtils.setReady(sitePaths, indexName, schema.getVersion(), ready); + } + + /** Method to get a key from a document. */ + protected abstract K keyFor(V doc); + + /** Method to get a document the index should hold on to from a Gerrit Java data type. */ + protected abstract D docFor(V value); + + /** Method to a Gerrit Java data type from a document that the index was holding on to. */ + protected abstract V valueFor(D doc); + + /** Comparator representing the default search order. */ + protected abstract Comparator<V> sortingComparator(); + + /** + * Fake implementation of {@link ChangeIndex} where all filtering happens in-memory. + * + * <p>This index is special in that ChangeData is a mutable object. Therefore we can't just hold + * onto the object that the caller wanted us to index. We also can't just create a new ChangeData + * from scratch because there are tests that assert that certain computations (e.g. diffs) are + * only done once. So we do what the prod indices do: We read and write fields using FieldDef. + */ + public static class FakeChangeIndex + extends AbstractFakeIndex<Change.Id, ChangeData, Map<String, Object>> implements ChangeIndex { + private final ChangeData.Factory changeDataFactory; + private final boolean skipMergable; + + @Inject + FakeChangeIndex( + SitePaths sitePaths, + ChangeData.Factory changeDataFactory, + @Assisted Schema<ChangeData> schema, + @GerritServerConfig Config cfg) { + super(schema, sitePaths, "changes"); + this.changeDataFactory = changeDataFactory; + this.skipMergable = !MergeabilityComputationBehavior.fromConfig(cfg).includeInIndex(); + } + + @Override + protected Change.Id keyFor(ChangeData value) { + return value.getId(); + } + + @Override + protected Comparator<ChangeData> sortingComparator() { + Comparator<ChangeData> lastUpdated = + Comparator.comparing(cd -> cd.change().getLastUpdatedOn()); + Comparator<ChangeData> merged = + Comparator.comparing(cd -> cd.getMergedOn().orElse(new Timestamp(0))); + Comparator<ChangeData> id = Comparator.comparing(cd -> cd.getId().get()); + return lastUpdated.thenComparing(merged).thenComparing(id).reversed(); + } + + @Override + protected Map<String, Object> docFor(ChangeData value) { + ImmutableMap.Builder<String, Object> doc = ImmutableMap.builder(); + for (FieldDef<ChangeData, ?> field : getSchema().getFields().values()) { + if (ChangeField.MERGEABLE.getName().equals(field.getName()) && skipMergable) { + continue; + } + Object docifiedValue = field.get(value); + if (docifiedValue != null) { + doc.put(field.getName(), field.get(value)); + } + } + return doc.build(); + } + + @Override + protected ChangeData valueFor(Map<String, Object> doc) { + ChangeData cd = + changeDataFactory.create( + Project.nameKey((String) doc.get(ChangeField.PROJECT.getName())), + Change.id(Integer.valueOf((String) doc.get(ChangeField.LEGACY_ID_STR.getName())))); + for (FieldDef<ChangeData, ?> field : getSchema().getFields().values()) { + field.setIfPossible(cd, new FakeStoredValue(doc.get(field.getName()))); + } + return cd; + } + + @Override + public void insert(ChangeData obj) {} + } + + /** Fake implementation of {@link AccountIndex} where all filtering happens in-memory. */ + public static class FakeAccountIndex + extends AbstractFakeIndex<Account.Id, AccountState, AccountState> implements AccountIndex { + @Inject + FakeAccountIndex(SitePaths sitePaths, @Assisted Schema<AccountState> schema) { + super(schema, sitePaths, "accounts"); + } + + @Override + protected Account.Id keyFor(AccountState value) { + return value.account().id(); + } + + @Override + protected AccountState docFor(AccountState value) { + return value; + } + + @Override + protected AccountState valueFor(AccountState doc) { + return doc; + } + + @Override + protected Comparator<AccountState> sortingComparator() { + return Comparator.comparing(a -> a.account().id().get()); + } + + @Override + public void insert(AccountState obj) {} + } + + /** Fake implementation of {@link GroupIndex} where all filtering happens in-memory. */ + public static class FakeGroupIndex + extends AbstractFakeIndex<AccountGroup.UUID, InternalGroup, InternalGroup> + implements GroupIndex { + @Inject + FakeGroupIndex(SitePaths sitePaths, @Assisted Schema<InternalGroup> schema) { + super(schema, sitePaths, "groups"); + } + + @Override + protected AccountGroup.UUID keyFor(InternalGroup value) { + return value.getGroupUUID(); + } + + @Override + protected InternalGroup docFor(InternalGroup value) { + return value; + } + + @Override + protected InternalGroup valueFor(InternalGroup doc) { + return doc; + } + + @Override + protected Comparator<InternalGroup> sortingComparator() { + return Comparator.comparing(g -> g.getId().get()); + } + + @Override + public void insert(InternalGroup obj) {} + } + + /** Fake implementation of {@link ProjectIndex} where all filtering happens in-memory. */ + public static class FakeProjectIndex + extends AbstractFakeIndex<Project.NameKey, ProjectData, ProjectData> implements ProjectIndex { + @Inject + FakeProjectIndex(SitePaths sitePaths, @Assisted Schema<ProjectData> schema) { + super(schema, sitePaths, "projects"); + } + + @Override + protected Project.NameKey keyFor(ProjectData value) { + return value.getProject().getNameKey(); + } + + @Override + protected ProjectData docFor(ProjectData value) { + return value; + } + + @Override + protected ProjectData valueFor(ProjectData doc) { + return doc; + } + + @Override + protected Comparator<ProjectData> sortingComparator() { + return Comparator.comparing(p -> p.getProject().getName()); + } + + @Override + public void insert(ProjectData obj) {} + } +}
diff --git a/java/com/google/gerrit/index/testing/BUILD b/java/com/google/gerrit/index/testing/BUILD new file mode 100644 index 0000000..a30eaca --- /dev/null +++ b/java/com/google/gerrit/index/testing/BUILD
@@ -0,0 +1,27 @@ +load("@rules_java//java:defs.bzl", "java_library") + +java_library( + name = "testing", + testonly = True, + srcs = glob( + ["**/*.java"], + ), + visibility = ["//visibility:public"], + deps = [ + "//java/com/google/gerrit/common:annotations", + "//java/com/google/gerrit/entities", + "//java/com/google/gerrit/exceptions", + "//java/com/google/gerrit/index", + "//java/com/google/gerrit/index:query_exception", + "//java/com/google/gerrit/index/project", + "//java/com/google/gerrit/proto", + "//java/com/google/gerrit/server", + "//java/com/google/gerrit/server/logging", + "//lib:guava", + "//lib:jgit", + "//lib:protobuf", + "//lib/flogger:api", + "//lib/guice", + "//lib/guice:guice-assistedinject", + ], +)
diff --git a/java/com/google/gerrit/index/testing/FakeIndexModule.java b/java/com/google/gerrit/index/testing/FakeIndexModule.java new file mode 100644 index 0000000..126ff10 --- /dev/null +++ b/java/com/google/gerrit/index/testing/FakeIndexModule.java
@@ -0,0 +1,69 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.index.testing; + +import com.google.common.collect.ImmutableMap; +import com.google.gerrit.index.project.ProjectIndex; +import com.google.gerrit.server.index.AbstractIndexModule; +import com.google.gerrit.server.index.VersionManager; +import com.google.gerrit.server.index.account.AccountIndex; +import com.google.gerrit.server.index.change.ChangeIndex; +import com.google.gerrit.server.index.group.GroupIndex; +import java.util.Map; + +/** Module to bind {@link FakeIndexModule}. */ +public class FakeIndexModule extends AbstractIndexModule { + public static FakeIndexModule singleVersionAllLatest(int threads, boolean secondary) { + return new FakeIndexModule(ImmutableMap.of(), threads, secondary); + } + + public static FakeIndexModule singleVersionWithExplicitVersions( + Map<String, Integer> versions, int threads, boolean secondary) { + return new FakeIndexModule(versions, threads, secondary); + } + + public static FakeIndexModule latestVersion(boolean secondary) { + return new FakeIndexModule(null, -1 /* direct executor */, secondary); + } + + private FakeIndexModule(Map<String, Integer> singleVersions, int threads, boolean secondary) { + super(singleVersions, threads, secondary); + } + + @Override + protected Class<? extends AccountIndex> getAccountIndex() { + return AbstractFakeIndex.FakeAccountIndex.class; + } + + @Override + protected Class<? extends ChangeIndex> getChangeIndex() { + return AbstractFakeIndex.FakeChangeIndex.class; + } + + @Override + protected Class<? extends GroupIndex> getGroupIndex() { + return AbstractFakeIndex.FakeGroupIndex.class; + } + + @Override + protected Class<? extends ProjectIndex> getProjectIndex() { + return AbstractFakeIndex.FakeProjectIndex.class; + } + + @Override + protected Class<? extends VersionManager> getVersionManager() { + return FakeIndexVersionManager.class; + } +}
diff --git a/java/com/google/gerrit/pgm/init/index/elasticsearch/ElasticIndexModuleOnInit.java b/java/com/google/gerrit/index/testing/FakeIndexModuleOnInit.java similarity index 65% rename from java/com/google/gerrit/pgm/init/index/elasticsearch/ElasticIndexModuleOnInit.java rename to java/com/google/gerrit/index/testing/FakeIndexModuleOnInit.java index f086ab1..75d8de2 100644 --- a/java/com/google/gerrit/pgm/init/index/elasticsearch/ElasticIndexModuleOnInit.java +++ b/java/com/google/gerrit/index/testing/FakeIndexModuleOnInit.java
@@ -1,4 +1,4 @@ -// Copyright (C) 2017 The Android Open Source Project +// Copyright (C) 2021 The Android Open Source Project // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,30 +12,26 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.pgm.init.index.elasticsearch; +package com.google.gerrit.index.testing; -import com.google.gerrit.elasticsearch.ElasticAccountIndex; -import com.google.gerrit.elasticsearch.ElasticGroupIndex; -import com.google.gerrit.pgm.init.index.IndexModuleOnInit; +import com.google.gerrit.index.testing.AbstractFakeIndex.FakeAccountIndex; +import com.google.gerrit.index.testing.AbstractFakeIndex.FakeGroupIndex; import com.google.gerrit.server.index.account.AccountIndex; import com.google.gerrit.server.index.group.GroupIndex; import com.google.inject.AbstractModule; import com.google.inject.assistedinject.FactoryModuleBuilder; -public class ElasticIndexModuleOnInit extends AbstractModule { - +public class FakeIndexModuleOnInit extends AbstractModule { @Override protected void configure() { install( new FactoryModuleBuilder() - .implement(AccountIndex.class, ElasticAccountIndex.class) + .implement(AccountIndex.class, FakeAccountIndex.class) .build(AccountIndex.Factory.class)); install( new FactoryModuleBuilder() - .implement(GroupIndex.class, ElasticGroupIndex.class) + .implement(GroupIndex.class, FakeGroupIndex.class) .build(GroupIndex.Factory.class)); - - install(new IndexModuleOnInit()); } }
diff --git a/java/com/google/gerrit/index/testing/FakeIndexVersionManager.java b/java/com/google/gerrit/index/testing/FakeIndexVersionManager.java new file mode 100644 index 0000000..5044e38 --- /dev/null +++ b/java/com/google/gerrit/index/testing/FakeIndexVersionManager.java
@@ -0,0 +1,75 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.index.testing; + +import com.google.common.collect.Iterables; +import com.google.gerrit.index.Index; +import com.google.gerrit.index.IndexDefinition; +import com.google.gerrit.index.Schema; +import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.config.SitePaths; +import com.google.gerrit.server.index.GerritIndexStatus; +import com.google.gerrit.server.index.OnlineUpgradeListener; +import com.google.gerrit.server.index.VersionManager; +import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.inject.Inject; +import com.google.inject.Singleton; +import java.util.Collection; +import java.util.TreeMap; +import org.eclipse.jgit.lib.Config; + +/** Fake version manager for {@link AbstractFakeIndex}. */ +@Singleton +public class FakeIndexVersionManager extends VersionManager { + + @Inject + FakeIndexVersionManager( + @GerritServerConfig Config cfg, + SitePaths sitePaths, + PluginSetContext<OnlineUpgradeListener> listeners, + Collection<IndexDefinition<?, ?, ?>> defs) { + super(sitePaths, listeners, defs, VersionManager.getOnlineUpgrade(cfg)); + } + + @Override + protected <K, V, I extends Index<K, V>> TreeMap<Integer, Version<V>> scanVersions( + IndexDefinition<K, V, I> def, GerritIndexStatus cfg) { + TreeMap<Integer, Version<V>> versions = new TreeMap<>(); + for (Schema<V> schema : def.getSchemas().values()) { + int v = schema.getVersion(); + boolean exists = versions.containsKey(v); + versions.put(v, new Version<>(schema, v, exists, cfg.getReady(def.getName(), v))); + } + return versions; + } + + @Override + protected <K, V, I extends Index<K, V>> void initIndex( + IndexDefinition<K, V, I> def, GerritIndexStatus cfg) { + // Set latest versions ready. + if (def.getSchemas().isEmpty()) { + super.initIndex(def, cfg); + return; + } + Schema<V> schema = Iterables.getLast(def.getSchemas().values()); + try { + cfg.setReady(def.getName(), schema.getVersion(), true); + cfg.save(); + } catch (Exception e) { + throw new IllegalStateException(e); + } + super.initIndex(def, cfg); + } +}
diff --git a/java/com/google/gerrit/index/testing/FakeStoredValue.java b/java/com/google/gerrit/index/testing/FakeStoredValue.java new file mode 100644 index 0000000..5091068 --- /dev/null +++ b/java/com/google/gerrit/index/testing/FakeStoredValue.java
@@ -0,0 +1,76 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.index.testing; + +import com.google.gerrit.index.StoredValue; +import java.sql.Timestamp; + +/** Bridge to recover fields from the fake index. */ +public class FakeStoredValue implements StoredValue { + private final Object field; + + public FakeStoredValue(Object field) { + this.field = field; + } + + @Override + public String asString() { + return (String) field; + } + + @Override + @SuppressWarnings("unchecked") + public Iterable<String> asStrings() { + return (Iterable<String>) field; + } + + @Override + public Integer asInteger() { + return (Integer) field; + } + + @Override + @SuppressWarnings("unchecked") + public Iterable<Integer> asIntegers() { + return (Iterable<Integer>) field; + } + + @Override + public Long asLong() { + return (Long) field; + } + + @Override + @SuppressWarnings("unchecked") + public Iterable<Long> asLongs() { + return (Iterable<Long>) field; + } + + @Override + public Timestamp asTimestamp() { + return (Timestamp) field; + } + + @Override + public byte[] asByteArray() { + return (byte[]) field; + } + + @Override + @SuppressWarnings("unchecked") + public Iterable<byte[]> asByteArrays() { + return (Iterable<byte[]>) field; + } +}
diff --git a/java/com/google/gerrit/json/OutputFormat.java b/java/com/google/gerrit/json/OutputFormat.java index 3e7c319..c5504bb 100644 --- a/java/com/google/gerrit/json/OutputFormat.java +++ b/java/com/google/gerrit/json/OutputFormat.java
@@ -42,12 +42,12 @@ */ JSON_COMPACT; - /** @return true when the format is either JSON or JSON_COMPACT. */ + /** Returns true when the format is either JSON or JSON_COMPACT. */ public boolean isJson() { return this == JSON_COMPACT || this == JSON; } - /** @return a new Gson instance configured according to the format. */ + /** Returns a new Gson instance configured according to the format. */ public GsonBuilder newGsonBuilder() { if (!isJson()) { throw new IllegalStateException(String.format("%s is not JSON", this)); @@ -63,7 +63,7 @@ return gb; } - /** @return a new Gson instance configured according to the format. */ + /** Returns a new Gson instance configured according to the format. */ public Gson newGson() { return newGsonBuilder().create(); }
diff --git a/java/com/google/gerrit/lifecycle/LifecycleManager.java b/java/com/google/gerrit/lifecycle/LifecycleManager.java index 4f09a09..42123d7 100644 --- a/java/com/google/gerrit/lifecycle/LifecycleManager.java +++ b/java/com/google/gerrit/lifecycle/LifecycleManager.java
@@ -107,7 +107,7 @@ LifecycleListener obj = listeners.get(i).get(); try { obj.stop(); - } catch (Throwable err) { + } catch (RuntimeException err) { logger.atWarning().withCause(err).log("Failed to stop %s", obj.getClass()); } startedIndex = i - 1;
diff --git a/java/com/google/gerrit/lifecycle/LifecycleModule.java b/java/com/google/gerrit/lifecycle/LifecycleModule.java index 0fb4653..efe1518 100644 --- a/java/com/google/gerrit/lifecycle/LifecycleModule.java +++ b/java/com/google/gerrit/lifecycle/LifecycleModule.java
@@ -24,13 +24,16 @@ /** Module to support registering a unique LifecyleListener. */ public abstract class LifecycleModule extends FactoryModule { /** - * @return a unique listener binding. - * <p>To create a listener binding use: - * <pre> + * Returns a unique listener binding. + * + * <p>To create a listener binding use: + * + * <pre> * listener().to(MyListener.class); * </pre> - * where {@code MyListener} is a {@link Singleton} implementing the {@link LifecycleListener} - * interface. + * + * where {@code MyListener} is a {@link Singleton} implementing the {@link LifecycleListener} + * interface. */ protected LinkedBindingBuilder<LifecycleListener> listener() { final Annotation id = UniqueAnnotations.create();
diff --git a/java/com/google/gerrit/lucene/LuceneChangeIndex.java b/java/com/google/gerrit/lucene/LuceneChangeIndex.java index 3fc4de2..07d1334 100644 --- a/java/com/google/gerrit/lucene/LuceneChangeIndex.java +++ b/java/com/google/gerrit/lucene/LuceneChangeIndex.java
@@ -15,7 +15,6 @@ package com.google.gerrit.lucene; import static com.google.common.collect.ImmutableList.toImmutableList; -import static com.google.common.collect.ImmutableSet.toImmutableSet; import static com.google.gerrit.lucene.AbstractLuceneIndex.sortFieldName; import static com.google.gerrit.server.git.QueueProvider.QueueType.INTERACTIVE; import static com.google.gerrit.server.index.change.ChangeField.LEGACY_ID; @@ -24,11 +23,8 @@ import static com.google.gerrit.server.index.change.ChangeIndexRewriter.CLOSED_STATUSES; import static com.google.gerrit.server.index.change.ChangeIndexRewriter.OPEN_STATUSES; import static java.util.Objects.requireNonNull; -import static java.util.stream.Collectors.toList; import com.google.common.base.Throwables; -import com.google.common.collect.Collections2; -import com.google.common.collect.FluentIterable; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Iterables; @@ -38,19 +34,14 @@ import com.google.common.flogger.FluentLogger; import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListeningExecutorService; -import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; import com.google.gerrit.entities.converter.ChangeProtoConverter; -import com.google.gerrit.entities.converter.PatchSetApprovalProtoConverter; -import com.google.gerrit.entities.converter.PatchSetProtoConverter; import com.google.gerrit.entities.converter.ProtoConverter; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.index.FieldDef; import com.google.gerrit.index.PaginationType; import com.google.gerrit.index.QueryOptions; -import com.google.gerrit.index.RefState; import com.google.gerrit.index.Schema; import com.google.gerrit.index.query.FieldBundle; import com.google.gerrit.index.query.HasCardinality; @@ -58,7 +49,6 @@ import com.google.gerrit.index.query.QueryParseException; import com.google.gerrit.index.query.ResultSet; import com.google.gerrit.proto.Protos; -import com.google.gerrit.server.StarredChangesUtil; import com.google.gerrit.server.change.MergeabilityComputationBehavior; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.config.SitePaths; @@ -68,7 +58,6 @@ import com.google.gerrit.server.index.change.ChangeIndex; import com.google.gerrit.server.index.change.ChangeIndexRewriter; import com.google.gerrit.server.index.options.AutoFlush; -import com.google.gerrit.server.project.SubmitRuleOptions; import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.query.change.ChangeDataSource; import com.google.inject.Inject; @@ -76,10 +65,8 @@ import com.google.protobuf.MessageLite; import java.io.IOException; import java.nio.file.Path; -import java.sql.Timestamp; import java.util.ArrayList; import java.util.Arrays; -import java.util.Collection; import java.util.HashMap; import java.util.Iterator; import java.util.List; @@ -88,7 +75,6 @@ import java.util.concurrent.Callable; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; -import java.util.function.Consumer; import java.util.function.Function; import org.apache.lucene.document.Document; import org.apache.lucene.index.IndexWriter; @@ -125,34 +111,10 @@ private static final String CHANGES = "changes"; private static final String CHANGES_OPEN = "open"; private static final String CHANGES_CLOSED = "closed"; - private static final String ADDED_FIELD = ChangeField.ADDED.getName(); - private static final String APPROVAL_FIELD = ChangeField.APPROVAL.getName(); private static final String CHANGE_FIELD = ChangeField.CHANGE.getName(); - private static final String DELETED_FIELD = ChangeField.DELETED.getName(); - private static final String MERGEABLE_FIELD = ChangeField.MERGEABLE.getName(); - private static final String PATCH_SET_FIELD = ChangeField.PATCH_SET.getName(); - private static final String PENDING_REVIEWER_FIELD = ChangeField.PENDING_REVIEWER.getName(); - private static final String PENDING_REVIEWER_BY_EMAIL_FIELD = - ChangeField.PENDING_REVIEWER_BY_EMAIL.getName(); - private static final String REF_STATE_FIELD = ChangeField.REF_STATE.getName(); - private static final String REF_STATE_PATTERN_FIELD = ChangeField.REF_STATE_PATTERN.getName(); - private static final String REVIEWEDBY_FIELD = ChangeField.REVIEWEDBY.getName(); - private static final String REVIEWER_FIELD = ChangeField.REVIEWER.getName(); - private static final String REVIEWER_BY_EMAIL_FIELD = ChangeField.REVIEWER_BY_EMAIL.getName(); - private static final String HASHTAG_FIELD = ChangeField.HASHTAG_CASE_AWARE.getName(); - private static final String STAR_FIELD = ChangeField.STAR.getName(); - private static final String SUBMIT_RECORD_LENIENT_FIELD = - ChangeField.STORED_SUBMIT_RECORD_LENIENT.getName(); - private static final String SUBMIT_RECORD_STRICT_FIELD = - ChangeField.STORED_SUBMIT_RECORD_STRICT.getName(); - private static final String TOTAL_COMMENT_COUNT_FIELD = ChangeField.TOTAL_COMMENT_COUNT.getName(); - private static final String UNRESOLVED_COMMENT_COUNT_FIELD = - ChangeField.UNRESOLVED_COMMENT_COUNT.getName(); - private static final String ATTENTION_SET_FULL_FIELD = ChangeField.ATTENTION_SET_FULL.getName(); - private static final String MERGED_ON_FIELD = ChangeField.MERGED_ON.getName(); @FunctionalInterface - static interface IdTerm { + interface IdTerm { Term get(String name, int id); } @@ -165,7 +127,7 @@ } @FunctionalInterface - static interface ChangeIdExtractor { + interface ChangeIdExtractor { Change.Id extract(IndexableField f); } @@ -620,231 +582,14 @@ cd = changeDataFactory.create(Project.nameKey(project.stringValue()), extractor.extract(f)); } - // Any decoding that is done here must also be done in {@link ElasticChangeIndex}. - - if (fields.contains(PATCH_SET_FIELD)) { - decodePatchSets(doc, cd); + for (FieldDef<ChangeData, ?> field : getSchema().getFields().values()) { + if (fields.contains(field.getName()) && doc.get(field.getName()) != null) { + field.setIfPossible(cd, new LuceneStoredValue(doc.get(field.getName()))); + } } - if (fields.contains(APPROVAL_FIELD)) { - decodeApprovals(doc, cd); - } - if (fields.contains(ADDED_FIELD) && fields.contains(DELETED_FIELD)) { - decodeChangedLines(doc, cd); - } - if (fields.contains(MERGEABLE_FIELD)) { - decodeMergeable(doc, cd); - } - if (fields.contains(REVIEWEDBY_FIELD)) { - decodeReviewedBy(doc, cd); - } - if (fields.contains(HASHTAG_FIELD)) { - decodeHashtags(doc, cd); - } - if (fields.contains(STAR_FIELD)) { - decodeStar(doc, cd); - } - if (fields.contains(REVIEWER_FIELD)) { - decodeReviewers(doc, cd); - } - if (fields.contains(REVIEWER_BY_EMAIL_FIELD)) { - decodeReviewersByEmail(doc, cd); - } - if (fields.contains(PENDING_REVIEWER_FIELD)) { - decodePendingReviewers(doc, cd); - } - if (fields.contains(PENDING_REVIEWER_BY_EMAIL_FIELD)) { - decodePendingReviewersByEmail(doc, cd); - } - if (fields.contains(ATTENTION_SET_FULL_FIELD)) { - decodeAttentionSet(doc, cd); - } - decodeSubmitRecords( - doc, SUBMIT_RECORD_STRICT_FIELD, ChangeField.SUBMIT_RULE_OPTIONS_STRICT, cd); - decodeSubmitRecords( - doc, SUBMIT_RECORD_LENIENT_FIELD, ChangeField.SUBMIT_RULE_OPTIONS_LENIENT, cd); - if (fields.contains(REF_STATE_FIELD)) { - decodeRefStates(doc, cd); - } - if (fields.contains(REF_STATE_PATTERN_FIELD)) { - decodeRefStatePatterns(doc, cd); - } - if (fields.contains(MERGED_ON_FIELD)) { - decodeMergedOn(doc, cd); - } - - decodeUnresolvedCommentCount(doc, cd); - decodeTotalCommentCount(doc, cd); return cd; } - private void decodePatchSets(ListMultimap<String, IndexableField> doc, ChangeData cd) { - List<PatchSet> patchSets = decodeProtos(doc, PATCH_SET_FIELD, PatchSetProtoConverter.INSTANCE); - if (!patchSets.isEmpty()) { - // Will be an empty list for schemas prior to when this field was stored; - // this cannot be valid since a change needs at least one patch set. - cd.setPatchSets(patchSets); - } - } - - private void decodeApprovals(ListMultimap<String, IndexableField> doc, ChangeData cd) { - cd.setCurrentApprovals( - decodeProtos(doc, APPROVAL_FIELD, PatchSetApprovalProtoConverter.INSTANCE)); - } - - private void decodeChangedLines(ListMultimap<String, IndexableField> doc, ChangeData cd) { - IndexableField added = Iterables.getFirst(doc.get(ADDED_FIELD), null); - IndexableField deleted = Iterables.getFirst(doc.get(DELETED_FIELD), null); - if (added != null && deleted != null) { - cd.setChangedLines(added.numericValue().intValue(), deleted.numericValue().intValue()); - } else { - // No ChangedLines stored, likely due to failure during reindexing, for - // example due to LargeObjectException. But we know the field was - // requested, so update ChangeData to prevent callers from trying to - // lazily load it, as that would probably also fail. - cd.setNoChangedLines(); - } - } - - private void decodeMergeable(ListMultimap<String, IndexableField> doc, ChangeData cd) { - IndexableField f = Iterables.getFirst(doc.get(MERGEABLE_FIELD), null); - if (f != null && !skipFields.contains(MERGEABLE_FIELD)) { - String mergeable = f.stringValue(); - if ("1".equals(mergeable)) { - cd.setMergeable(true); - } else if ("0".equals(mergeable)) { - cd.setMergeable(false); - } - } - } - - private void decodeReviewedBy(ListMultimap<String, IndexableField> doc, ChangeData cd) { - Collection<IndexableField> reviewedBy = doc.get(REVIEWEDBY_FIELD); - if (!reviewedBy.isEmpty()) { - Set<Account.Id> accounts = Sets.newHashSetWithExpectedSize(reviewedBy.size()); - for (IndexableField r : reviewedBy) { - int id = r.numericValue().intValue(); - if (reviewedBy.size() == 1 && id == ChangeField.NOT_REVIEWED) { - break; - } - accounts.add(Account.id(id)); - } - cd.setReviewedBy(accounts); - } - } - - private void decodeHashtags(ListMultimap<String, IndexableField> doc, ChangeData cd) { - Collection<IndexableField> hashtag = doc.get(HASHTAG_FIELD); - Set<String> hashtags = Sets.newHashSetWithExpectedSize(hashtag.size()); - for (IndexableField r : hashtag) { - hashtags.add(r.binaryValue().utf8ToString()); - } - cd.setHashtags(hashtags); - } - - private void decodeStar(ListMultimap<String, IndexableField> doc, ChangeData cd) { - Collection<IndexableField> star = doc.get(STAR_FIELD); - ListMultimap<Account.Id, String> stars = MultimapBuilder.hashKeys().arrayListValues().build(); - for (IndexableField r : star) { - StarredChangesUtil.StarField starField = StarredChangesUtil.StarField.parse(r.stringValue()); - if (starField != null) { - stars.put(starField.accountId(), starField.label()); - } - } - cd.setStars(stars); - } - - private void decodeReviewers(ListMultimap<String, IndexableField> doc, ChangeData cd) { - cd.setReviewers( - ChangeField.parseReviewerFieldValues( - cd.getId(), - FluentIterable.from(doc.get(REVIEWER_FIELD)).transform(IndexableField::stringValue))); - } - - private void decodeReviewersByEmail(ListMultimap<String, IndexableField> doc, ChangeData cd) { - cd.setReviewersByEmail( - ChangeField.parseReviewerByEmailFieldValues( - cd.getId(), - FluentIterable.from(doc.get(REVIEWER_BY_EMAIL_FIELD)) - .transform(IndexableField::stringValue))); - } - - private void decodePendingReviewers(ListMultimap<String, IndexableField> doc, ChangeData cd) { - cd.setPendingReviewers( - ChangeField.parseReviewerFieldValues( - cd.getId(), - FluentIterable.from(doc.get(PENDING_REVIEWER_FIELD)) - .transform(IndexableField::stringValue))); - } - - private void decodePendingReviewersByEmail( - ListMultimap<String, IndexableField> doc, ChangeData cd) { - cd.setPendingReviewersByEmail( - ChangeField.parseReviewerByEmailFieldValues( - cd.getId(), - FluentIterable.from(doc.get(PENDING_REVIEWER_BY_EMAIL_FIELD)) - .transform(IndexableField::stringValue))); - } - - private void decodeAttentionSet(ListMultimap<String, IndexableField> doc, ChangeData cd) { - ChangeField.parseAttentionSet( - doc.get(ATTENTION_SET_FULL_FIELD).stream() - .map(field -> field.binaryValue().utf8ToString()) - .collect(toImmutableSet()), - cd); - } - - private void decodeSubmitRecords( - ListMultimap<String, IndexableField> doc, - String field, - SubmitRuleOptions opts, - ChangeData cd) { - ChangeField.parseSubmitRecords( - Collections2.transform(doc.get(field), f -> f.binaryValue().utf8ToString()), opts, cd); - } - - private void decodeRefStates(ListMultimap<String, IndexableField> doc, ChangeData cd) { - cd.setRefStates(RefState.parseStates(copyAsBytes(doc.get(REF_STATE_FIELD)))); - } - - private void decodeRefStatePatterns(ListMultimap<String, IndexableField> doc, ChangeData cd) { - cd.setRefStatePatterns(copyAsBytes(doc.get(REF_STATE_PATTERN_FIELD))); - } - - private void decodeUnresolvedCommentCount( - ListMultimap<String, IndexableField> doc, ChangeData cd) { - decodeIntField(doc, UNRESOLVED_COMMENT_COUNT_FIELD, cd::setUnresolvedCommentCount); - } - - private void decodeTotalCommentCount(ListMultimap<String, IndexableField> doc, ChangeData cd) { - decodeIntField(doc, TOTAL_COMMENT_COUNT_FIELD, cd::setTotalCommentCount); - } - - private static void decodeIntField( - ListMultimap<String, IndexableField> doc, String fieldName, Consumer<Integer> consumer) { - IndexableField f = Iterables.getFirst(doc.get(fieldName), null); - if (f != null && f.numericValue() != null) { - consumer.accept(f.numericValue().intValue()); - } - } - - private void decodeMergedOn(ListMultimap<String, IndexableField> doc, ChangeData cd) { - IndexableField mergedOnField = - Iterables.getFirst(doc.get(MERGED_ON_FIELD), /* defaultValue= */ null); - Timestamp mergedOn = null; - if (mergedOnField != null && mergedOnField.numericValue() != null) { - mergedOn = new Timestamp(mergedOnField.numericValue().longValue()); - } - cd.setMergedOn(mergedOn); - } - - private static <T> List<T> decodeProtos( - ListMultimap<String, IndexableField> doc, String fieldName, ProtoConverter<?, T> converter) { - return doc.get(fieldName).stream() - .map(IndexableField::binaryValue) - .map(bytesRef -> parseProtoFrom(bytesRef, converter)) - .collect(toImmutableList()); - } - private static <P extends MessageLite, T> T parseProtoFrom( BytesRef bytesRef, ProtoConverter<P, T> converter) { P message = @@ -852,16 +597,4 @@ converter.getParser(), bytesRef.bytes, bytesRef.offset, bytesRef.length); return converter.fromProto(message); } - - private static List<byte[]> copyAsBytes(Collection<IndexableField> fields) { - return fields.stream() - .map( - f -> { - BytesRef ref = f.binaryValue(); - byte[] b = new byte[ref.length]; - System.arraycopy(ref.bytes, ref.offset, b, 0, ref.length); - return b; - }) - .collect(toList()); - } }
diff --git a/java/com/google/gerrit/lucene/LuceneIndexModule.java b/java/com/google/gerrit/lucene/LuceneIndexModule.java index 73256b1..3aa9c6e 100644 --- a/java/com/google/gerrit/lucene/LuceneIndexModule.java +++ b/java/com/google/gerrit/lucene/LuceneIndexModule.java
@@ -18,6 +18,7 @@ import com.google.common.collect.ImmutableMap; import com.google.gerrit.index.IndexConfig; import com.google.gerrit.index.project.ProjectIndex; +import com.google.gerrit.server.ModuleImpl; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.index.AbstractIndexModule; import com.google.gerrit.server.index.VersionManager; @@ -29,6 +30,7 @@ import org.apache.lucene.search.BooleanQuery; import org.eclipse.jgit.lib.Config; +@ModuleImpl(name = AbstractIndexModule.INDEX_MODULE) public class LuceneIndexModule extends AbstractIndexModule { private final AutoFlush autoFlush;
diff --git a/java/com/google/gerrit/lucene/LuceneStoredValue.java b/java/com/google/gerrit/lucene/LuceneStoredValue.java new file mode 100644 index 0000000..efe489b --- /dev/null +++ b/java/com/google/gerrit/lucene/LuceneStoredValue.java
@@ -0,0 +1,95 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.lucene; + +import static com.google.common.collect.ImmutableList.toImmutableList; +import static java.util.stream.Collectors.toList; + +import com.google.common.collect.Iterables; +import com.google.gerrit.index.StoredValue; +import java.sql.Timestamp; +import java.util.List; +import org.apache.lucene.index.IndexableField; +import org.apache.lucene.util.BytesRef; + +/** Bridge to recover fields from the lucene index. */ +public class LuceneStoredValue implements StoredValue { + /** + * Lucene represents repeated fields as a list of {@link IndexableField}, so we hold onto a list + * here to cover both repeated and non-repeated fields. + */ + private final List<IndexableField> field; + + LuceneStoredValue(List<IndexableField> field) { + this.field = field; + } + + @Override + public String asString() { + return Iterables.getFirst(asStrings(), null); + } + + @Override + public Iterable<String> asStrings() { + return field.stream().map(f -> f.stringValue()).collect(toImmutableList()); + } + + @Override + public Integer asInteger() { + return Iterables.getFirst(asIntegers(), null); + } + + @Override + public Iterable<Integer> asIntegers() { + return field.stream().map(f -> f.numericValue().intValue()).collect(toImmutableList()); + } + + @Override + public Long asLong() { + return Iterables.getFirst(asLongs(), null); + } + + @Override + public Iterable<Long> asLongs() { + return field.stream().map(f -> f.numericValue().longValue()).collect(toImmutableList()); + } + + @Override + public Timestamp asTimestamp() { + return asLong() == null ? null : new Timestamp(asLong()); + } + + @Override + public byte[] asByteArray() { + return Iterables.getFirst(asByteArrays(), null); + } + + @Override + public Iterable<byte[]> asByteArrays() { + return copyAsBytes(field); + } + + private static List<byte[]> copyAsBytes(List<IndexableField> fields) { + return fields.stream() + .map( + f -> { + BytesRef ref = f.binaryValue(); + byte[] b = new byte[ref.length]; + System.arraycopy(ref.bytes, ref.offset, b, 0, ref.length); + return b; + }) + .collect(toList()); + } +}
diff --git a/java/com/google/gerrit/lucene/WrappableSearcherManager.java b/java/com/google/gerrit/lucene/WrappableSearcherManager.java index 4044b90..c164b29 100644 --- a/java/com/google/gerrit/lucene/WrappableSearcherManager.java +++ b/java/com/google/gerrit/lucene/WrappableSearcherManager.java
@@ -53,7 +53,6 @@ * {@link #maybeRefresh}. Finally, be sure to call {@link #close} once you are done. * * @see SearcherFactory - * @lucene.experimental */ // This file was copied from: // https://github.com/apache/lucene-solr/blob/lucene_solr_5_0/lucene/core/src/java/org/apache/lucene/search/SearcherManager.java
diff --git a/java/com/google/gerrit/mail/HtmlParser.java b/java/com/google/gerrit/mail/HtmlParser.java index ba73bdd..97fe06e 100644 --- a/java/com/google/gerrit/mail/HtmlParser.java +++ b/java/com/google/gerrit/mail/HtmlParser.java
@@ -143,7 +143,7 @@ if (!Strings.isNullOrEmpty(content)) { ParserUtil.appendOrAddNewComment( new MailComment( - content, null, null, MailComment.CommentType.CHANGE_MESSAGE, isLink), + content, null, null, MailComment.CommentType.PATCHSET_LEVEL, isLink), parsedComments); } } else if (lastEncounteredComment == null) {
diff --git a/java/com/google/gerrit/mail/MailComment.java b/java/com/google/gerrit/mail/MailComment.java index 3e7da10..cea856c 100644 --- a/java/com/google/gerrit/mail/MailComment.java +++ b/java/com/google/gerrit/mail/MailComment.java
@@ -20,7 +20,7 @@ /** A comment parsed from inbound email */ public class MailComment { public enum CommentType { - CHANGE_MESSAGE, + PATCHSET_LEVEL, FILE_COMMENT, INLINE_COMMENT }
diff --git a/java/com/google/gerrit/mail/TextParser.java b/java/com/google/gerrit/mail/TextParser.java index a33c66f..c43d200 100644 --- a/java/com/google/gerrit/mail/TextParser.java +++ b/java/com/google/gerrit/mail/TextParser.java
@@ -30,7 +30,7 @@ /** * Parses comments from plaintext email. * - * @param email @param email the message as received from the email service + * @param email the message as received from the email service * @param comments list of {@link HumanComment}s previously persisted on the change that caused * the original notification email to be sent out. Ordering must be the same as in the * outbound email @@ -77,7 +77,7 @@ // This is not a comment, try to advance the file/comment pointers and // add previous comment to list if applicable if (currentComment != null) { - if (currentComment.type == MailComment.CommentType.CHANGE_MESSAGE) { + if (currentComment.type == MailComment.CommentType.PATCHSET_LEVEL) { currentComment.message = ParserUtil.trimQuotation(currentComment.message); } if (!Strings.isNullOrEmpty(currentComment.message)) { @@ -115,7 +115,7 @@ if (lastEncounteredComment == null) { if (lastEncounteredFileName == null) { // Change message - currentComment.type = MailComment.CommentType.CHANGE_MESSAGE; + currentComment.type = MailComment.CommentType.PATCHSET_LEVEL; } else { // File comment not sent in reply to another comment currentComment.type = MailComment.CommentType.FILE_COMMENT;
diff --git a/java/com/google/gerrit/metrics/BUILD b/java/com/google/gerrit/metrics/BUILD index 3cc056b..0cb0275 100644 --- a/java/com/google/gerrit/metrics/BUILD +++ b/java/com/google/gerrit/metrics/BUILD
@@ -8,6 +8,7 @@ "//java/com/google/gerrit/common:server", "//java/com/google/gerrit/extensions:api", "//java/com/google/gerrit/lifecycle", + "//java/com/google/gerrit/server/cancellation", "//java/com/google/gerrit/server/logging", "//lib:guava", "//lib:jgit",
diff --git a/java/com/google/gerrit/metrics/Description.java b/java/com/google/gerrit/metrics/Description.java index 10568bc..f5963af 100644 --- a/java/com/google/gerrit/metrics/Description.java +++ b/java/com/google/gerrit/metrics/Description.java
@@ -133,27 +133,27 @@ return this; } - /** @return true if the metric value never changes after startup. */ + /** Returns true if the metric value never changes after startup. */ public boolean isConstant() { return TRUE_VALUE.equals(annotations.get(CONSTANT)); } - /** @return true if the metric may be interpreted as a rate over time. */ + /** Returns true if the metric may be interpreted as a rate over time. */ public boolean isRate() { return TRUE_VALUE.equals(annotations.get(RATE)); } - /** @return true if the metric is an instantaneous sample. */ + /** Returns true if the metric is an instantaneous sample. */ public boolean isGauge() { return TRUE_VALUE.equals(annotations.get(GAUGE)); } - /** @return true if the metric accumulates over the lifespan of the process. */ + /** Returns true if the metric accumulates over the lifespan of the process. */ public boolean isCumulative() { return TRUE_VALUE.equals(annotations.get(CUMULATIVE)); } - /** @return the suggested field ordering. */ + /** Returns the suggested field ordering. */ public FieldOrdering getFieldOrdering() { String o = annotations.get(FIELD_ORDERING); return o != null ? FieldOrdering.valueOf(o) : FieldOrdering.AT_END; @@ -187,7 +187,7 @@ return u; } - /** @return immutable copy of all annotations (configurable properties). */ + /** Returns an immutable copy of all annotations (configurable properties). */ public ImmutableMap<String, String> getAnnotations() { return ImmutableMap.copyOf(annotations); }
diff --git a/java/com/google/gerrit/metrics/Field.java b/java/com/google/gerrit/metrics/Field.java index bdae854..5508819 100644 --- a/java/com/google/gerrit/metrics/Field.java +++ b/java/com/google/gerrit/metrics/Field.java
@@ -102,19 +102,19 @@ .metadataMapper(metadataMapper); } - /** @return name of this field within the metric. */ + /** Returns name of this field within the metric. */ public abstract String name(); - /** @return type of value used within the field. */ + /** Returns type of value used within the field. */ public abstract Class<T> valueType(); - /** @return mapper that maps a field value to a field in the {@link Metadata} class. */ + /** Returns mapper that maps a field value to a field in the {@link Metadata} class. */ public abstract BiConsumer<Metadata.Builder, T> metadataMapper(); - /** @return description text for the field explaining its range of values. */ + /** Returns description text for the field explaining its range of values. */ public abstract Optional<String> description(); - /** @return formatter to format field values. */ + /** Returns formatter to format field values. */ public abstract Function<T, String> formatter(); @AutoValue.Builder
diff --git a/java/com/google/gerrit/metrics/Timer0.java b/java/com/google/gerrit/metrics/Timer0.java index d0033a4..72ebc67 100644 --- a/java/com/google/gerrit/metrics/Timer0.java +++ b/java/com/google/gerrit/metrics/Timer0.java
@@ -18,6 +18,7 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.extensions.registration.RegistrationHandle; +import com.google.gerrit.server.cancellation.RequestStateContext; import com.google.gerrit.server.logging.LoggingContext; import com.google.gerrit.server.logging.PerformanceLogRecord; import java.util.concurrent.TimeUnit; @@ -48,6 +49,8 @@ } } + private boolean suppressLogging; + protected final String name; public Timer0(String name) { @@ -60,6 +63,7 @@ * @return timer context */ public Context start() { + RequestStateContext.abortIfCancelled(); return new Context(this); } @@ -71,10 +75,21 @@ */ public final void record(long value, TimeUnit unit) { long durationMs = unit.toMillis(value); - LoggingContext.getInstance() - .addPerformanceLogRecord(() -> PerformanceLogRecord.create(name, durationMs)); - logger.atFinest().log("%s took %dms", name, durationMs); + + if (!suppressLogging) { + LoggingContext.getInstance() + .addPerformanceLogRecord(() -> PerformanceLogRecord.create(name, durationMs)); + logger.atFinest().log("%s took %dms", name, durationMs); + } + doRecord(value, unit); + RequestStateContext.abortIfCancelled(); + } + + /** Suppress logging (debug log and performance log) when values are recorded. */ + public final Timer0 suppressLogging() { + this.suppressLogging = true; + return this; } /**
diff --git a/java/com/google/gerrit/metrics/Timer1.java b/java/com/google/gerrit/metrics/Timer1.java index a8fb1a2..eefd462 100644 --- a/java/com/google/gerrit/metrics/Timer1.java +++ b/java/com/google/gerrit/metrics/Timer1.java
@@ -18,6 +18,7 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.extensions.registration.RegistrationHandle; +import com.google.gerrit.server.cancellation.RequestStateContext; import com.google.gerrit.server.logging.LoggingContext; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.PerformanceLogRecord; @@ -53,6 +54,8 @@ } } + private boolean suppressLogging; + protected final String name; protected final Field<F1> field; @@ -68,6 +71,7 @@ * @return timer context */ public Context<F1> start(F1 fieldValue) { + RequestStateContext.abortIfCancelled(); return new Context<>(this, fieldValue); } @@ -85,11 +89,20 @@ field.metadataMapper().accept(metadataBuilder, fieldValue); Metadata metadata = metadataBuilder.build(); - LoggingContext.getInstance() - .addPerformanceLogRecord(() -> PerformanceLogRecord.create(name, durationMs, metadata)); + if (!suppressLogging) { + LoggingContext.getInstance() + .addPerformanceLogRecord(() -> PerformanceLogRecord.create(name, durationMs, metadata)); + logger.atFinest().log("%s (%s = %s) took %dms", name, field.name(), fieldValue, durationMs); + } - logger.atFinest().log("%s (%s = %s) took %dms", name, field.name(), fieldValue, durationMs); doRecord(fieldValue, value, unit); + RequestStateContext.abortIfCancelled(); + } + + /** Suppress logging (debug log and performance log) when values are recorded. */ + public final Timer1<F1> suppressLogging() { + this.suppressLogging = true; + return this; } /**
diff --git a/java/com/google/gerrit/metrics/Timer2.java b/java/com/google/gerrit/metrics/Timer2.java index 8a4a793..09878ad 100644 --- a/java/com/google/gerrit/metrics/Timer2.java +++ b/java/com/google/gerrit/metrics/Timer2.java
@@ -18,6 +18,7 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.extensions.registration.RegistrationHandle; +import com.google.gerrit.server.cancellation.RequestStateContext; import com.google.gerrit.server.logging.LoggingContext; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.PerformanceLogRecord; @@ -56,6 +57,8 @@ } } + private boolean suppressLogging; + protected final String name; protected final Field<F1> field1; protected final Field<F2> field2; @@ -74,6 +77,7 @@ * @return timer context */ public Context<F1, F2> start(F1 fieldValue1, F2 fieldValue2) { + RequestStateContext.abortIfCancelled(); return new Context<>(this, fieldValue1, fieldValue2); } @@ -93,13 +97,22 @@ field2.metadataMapper().accept(metadataBuilder, fieldValue2); Metadata metadata = metadataBuilder.build(); - LoggingContext.getInstance() - .addPerformanceLogRecord(() -> PerformanceLogRecord.create(name, durationMs, metadata)); + if (!suppressLogging) { + LoggingContext.getInstance() + .addPerformanceLogRecord(() -> PerformanceLogRecord.create(name, durationMs, metadata)); + logger.atFinest().log( + "%s (%s = %s, %s = %s) took %dms", + name, field1.name(), fieldValue1, field2.name(), fieldValue2, durationMs); + } - logger.atFinest().log( - "%s (%s = %s, %s = %s) took %dms", - name, field1.name(), fieldValue1, field2.name(), fieldValue2, durationMs); doRecord(fieldValue1, fieldValue2, value, unit); + RequestStateContext.abortIfCancelled(); + } + + /** Suppress logging (debug log and performance log) when values are recorded. */ + public final Timer2<F1, F2> suppressLogging() { + this.suppressLogging = true; + return this; } /**
diff --git a/java/com/google/gerrit/metrics/Timer3.java b/java/com/google/gerrit/metrics/Timer3.java index 2044da6..5d5c424 100644 --- a/java/com/google/gerrit/metrics/Timer3.java +++ b/java/com/google/gerrit/metrics/Timer3.java
@@ -18,6 +18,7 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.extensions.registration.RegistrationHandle; +import com.google.gerrit.server.cancellation.RequestStateContext; import com.google.gerrit.server.logging.LoggingContext; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.PerformanceLogRecord; @@ -59,6 +60,8 @@ } } + private boolean suppressLogging; + protected final String name; protected final Field<F1> field1; protected final Field<F2> field2; @@ -80,6 +83,7 @@ * @return timer context */ public Context<F1, F2, F3> start(F1 fieldValue1, F2 fieldValue2, F3 fieldValue3) { + RequestStateContext.abortIfCancelled(); return new Context<>(this, fieldValue1, fieldValue2, fieldValue3); } @@ -102,20 +106,29 @@ field3.metadataMapper().accept(metadataBuilder, fieldValue3); Metadata metadata = metadataBuilder.build(); - LoggingContext.getInstance() - .addPerformanceLogRecord(() -> PerformanceLogRecord.create(name, durationMs, metadata)); + if (!suppressLogging) { + LoggingContext.getInstance() + .addPerformanceLogRecord(() -> PerformanceLogRecord.create(name, durationMs, metadata)); + logger.atFinest().log( + "%s (%s = %s, %s = %s, %s = %s) took %dms", + name, + field1.name(), + fieldValue1, + field2.name(), + fieldValue2, + field3.name(), + fieldValue3, + durationMs); + } - logger.atFinest().log( - "%s (%s = %s, %s = %s, %s = %s) took %dms", - name, - field1.name(), - fieldValue1, - field2.name(), - fieldValue2, - field3.name(), - fieldValue3, - durationMs); doRecord(fieldValue1, fieldValue2, fieldValue3, value, unit); + RequestStateContext.abortIfCancelled(); + } + + /** Suppress logging (debug log and performance log) when values are recorded. */ + public final Timer3<F1, F2, F3> suppressLogging() { + this.suppressLogging = true; + return this; } /**
diff --git a/java/com/google/gerrit/metrics/TimerContext.java b/java/com/google/gerrit/metrics/TimerContext.java index 62eb030..a3754c5 100644 --- a/java/com/google/gerrit/metrics/TimerContext.java +++ b/java/com/google/gerrit/metrics/TimerContext.java
@@ -29,7 +29,7 @@ */ public abstract void record(long elapsed); - /** @return the start time in system time nanoseconds. */ + /** Returns the start time in system time nanoseconds. */ public long getStartTime() { return startNanos; }
diff --git a/java/com/google/gerrit/metrics/dropwizard/BUILD b/java/com/google/gerrit/metrics/dropwizard/BUILD index 4b3859f..dbb8f5e 100644 --- a/java/com/google/gerrit/metrics/dropwizard/BUILD +++ b/java/com/google/gerrit/metrics/dropwizard/BUILD
@@ -12,6 +12,7 @@ "//lib:args4j", "//lib:guava", "//lib/dropwizard:dropwizard-core", + "//lib/flogger:api", "//lib/guice", ], )
diff --git a/java/com/google/gerrit/metrics/dropwizard/BucketedCallback.java b/java/com/google/gerrit/metrics/dropwizard/BucketedCallback.java index b3860f7..da9ec70 100644 --- a/java/com/google/gerrit/metrics/dropwizard/BucketedCallback.java +++ b/java/com/google/gerrit/metrics/dropwizard/BucketedCallback.java
@@ -110,7 +110,7 @@ } } - private String submetric(Object key) { + String submetric(Object key) { return DropWizardMetricMaker.name(ordering, name, name(key)); }
diff --git a/java/com/google/gerrit/metrics/dropwizard/CallbackMetricImpl1.java b/java/com/google/gerrit/metrics/dropwizard/CallbackMetricImpl1.java index d718035..bd3caf9 100644 --- a/java/com/google/gerrit/metrics/dropwizard/CallbackMetricImpl1.java +++ b/java/com/google/gerrit/metrics/dropwizard/CallbackMetricImpl1.java
@@ -15,13 +15,17 @@ package com.google.gerrit.metrics.dropwizard; import com.codahale.metrics.MetricRegistry; +import com.google.common.flogger.FluentLogger; import com.google.gerrit.metrics.CallbackMetric1; import com.google.gerrit.metrics.Description; import com.google.gerrit.metrics.Field; +import java.util.concurrent.TimeUnit; import java.util.function.Function; /** Optimized version of {@link BucketedCallback} for single dimension. */ class CallbackMetricImpl1<F1, V> extends BucketedCallback<V> { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + CallbackMetricImpl1( DropWizardMetricMaker metrics, MetricRegistry registry, @@ -44,9 +48,14 @@ @Override public void set(F1 field1, V value) { - BucketedCallback<V>.ValueGauge cell = getOrCreate(field1); - cell.value = value; - cell.set = true; + try { + BucketedCallback<V>.ValueGauge cell = getOrCreate(field1); + cell.value = value; + cell.set = true; + } catch (IllegalArgumentException e) { + logger.atWarning().withCause(e).atMostEvery(1, TimeUnit.HOURS).log( + "Unable to register duplicate metric: %s", submetric(field1)); + } } @Override
diff --git a/java/com/google/gerrit/metrics/proc/JGitMetricModule.java b/java/com/google/gerrit/metrics/proc/JGitMetricModule.java index e8611b3..d64bd19 100644 --- a/java/com/google/gerrit/metrics/proc/JGitMetricModule.java +++ b/java/com/google/gerrit/metrics/proc/JGitMetricModule.java
@@ -184,7 +184,9 @@ + "having most data in the cache.") .setGauge() .setUnit("byte"), - Field.ofString("repository_name", Metadata.Builder::projectName).build()); + Field.ofString("repository_name", Metadata.Builder::projectName) + .description("The name of the repository.") + .build()); metrics.newTrigger( repoEnt, () -> {
diff --git a/java/com/google/gerrit/pgm/BUILD b/java/com/google/gerrit/pgm/BUILD index 387ff2d..3a1de5e 100644 --- a/java/com/google/gerrit/pgm/BUILD +++ b/java/com/google/gerrit/pgm/BUILD
@@ -10,7 +10,6 @@ "//java/com/google/gerrit/auth", "//java/com/google/gerrit/common:annotations", "//java/com/google/gerrit/common:server", - "//java/com/google/gerrit/elasticsearch", "//java/com/google/gerrit/entities", "//java/com/google/gerrit/exceptions", "//java/com/google/gerrit/extensions:api",
diff --git a/java/com/google/gerrit/pgm/ChangeExternalIdCaseSensitivity.java b/java/com/google/gerrit/pgm/ChangeExternalIdCaseSensitivity.java new file mode 100644 index 0000000..2b7f23e --- /dev/null +++ b/java/com/google/gerrit/pgm/ChangeExternalIdCaseSensitivity.java
@@ -0,0 +1,156 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.pgm; + +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.extensions.config.FactoryModule; +import com.google.gerrit.extensions.registration.DynamicMap; +import com.google.gerrit.lifecycle.LifecycleManager; +import com.google.gerrit.pgm.init.api.ConsoleUI; +import com.google.gerrit.pgm.util.SiteProgram; +import com.google.gerrit.server.account.externalids.DisabledExternalIdCache; +import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdCaseSensitivityMigrator; +import com.google.gerrit.server.account.externalids.ExternalIdUpsertPreprocessor; +import com.google.gerrit.server.account.externalids.ExternalIds; +import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.extensions.events.GitReferenceUpdated; +import com.google.gerrit.server.git.meta.MetaDataUpdate; +import com.google.gerrit.server.index.account.AccountSchemaDefinitions; +import com.google.gerrit.server.schema.NoteDbSchemaVersionCheck; +import com.google.inject.Inject; +import com.google.inject.Injector; +import com.google.inject.Key; +import com.google.inject.assistedinject.FactoryModuleBuilder; +import java.io.IOException; +import java.util.Collection; +import org.eclipse.jgit.errors.ConfigInvalidException; +import org.eclipse.jgit.lib.Config; +import org.eclipse.jgit.lib.ProgressMonitor; +import org.eclipse.jgit.lib.TextProgressMonitor; +import org.eclipse.jgit.storage.file.FileBasedConfig; +import org.eclipse.jgit.util.FS; +import org.kohsuke.args4j.Option; + +/** + * Changes the case sensitivity of `username:` and `gerrit:` external IDs by recomputing the SHA-1 + * sums used as note names. + */ +public class ChangeExternalIdCaseSensitivity extends SiteProgram { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + @Option(name = "--batch", usage = "Don't ask for confirmation before migrating.") + private boolean batch; + + @Option(name = "--dryrun", usage = "Do a dryrun of the migration.") + private boolean dryrun; + + private final LifecycleManager manager = new LifecycleManager(); + private final TextProgressMonitor monitor = new TextProgressMonitor(); + + private Config globalConfig; + private boolean isUserNameCaseInsensitive; + private ConsoleUI ui; + + @Inject private ExternalIds externalIds; + @Inject private ExternalIdCaseSensitivityMigrator.Factory migratorFactory; + + @Override + public int run() throws Exception { + mustHaveValidSite(); + ui = ConsoleUI.getInstance(batch); + + Injector dbInjector = createDbInjector(); + manager.add(dbInjector, dbInjector.createChildInjector(NoteDbSchemaVersionCheck.module())); + dbInjector + .createChildInjector( + new FactoryModule() { + @Override + protected void configure() { + bind(GitReferenceUpdated.class).toInstance(GitReferenceUpdated.DISABLED); + install( + new FactoryModuleBuilder() + .build(ExternalIdCaseSensitivityMigrator.Factory.class)); + factory(MetaDataUpdate.InternalFactory.class); + DynamicMap.mapOf(binder(), ExternalIdUpsertPreprocessor.class); + + // The ChangeExternalIdCaseSensitivity program needs to access all external IDs only + // once to update them. After the update they are not accessed again. Hence the + // LocalUsernamesToLowerCase program doesn't benefit from caching external IDs and + // the external ID cache can be disabled. + install(DisabledExternalIdCache.module()); + } + }) + .injectMembers(this); + globalConfig = dbInjector.getInstance(Key.get(Config.class, GerritServerConfig.class)); + + this.isUserNameCaseInsensitive = + globalConfig.getBoolean("auth", "userNameCaseInsensitive", false); + + String message = + "auth.userNameCaseInsensitive is set to %b. " + + "External IDs will be migrated to be case %ssensitive. Continue?"; + if (!ui.yesno( + true, message, isUserNameCaseInsensitive, isUserNameCaseInsensitive ? "" : "in")) { + return 0; + } + + Collection<ExternalId> todo = externalIds.all(); + monitor.beginTask("Converting external ID note names", todo.size()); + + manager.start(); + try { + migratorFactory + .create(!isUserNameCaseInsensitive, dryrun) + .migrate(todo, () -> monitor.update(1)); + } finally { + manager.stop(); + monitor.endTask(); + } + + int exitCode; + if (!dryrun) { + updateGerritConfig(); + + exitCode = reindexAccounts(); + } else { + exitCode = 0; + } + return exitCode; + } + + private void updateGerritConfig() throws IOException, ConfigInvalidException { + logger.atInfo().log("Setting auth.userNameCaseInsensitive to true in gerrit.config."); + FileBasedConfig config = + new FileBasedConfig( + globalConfig, getSitePath().resolve("etc/gerrit.config").toFile(), FS.DETECTED); + config.load(); + config.setBoolean("auth", null, "userNameCaseInsensitive", !isUserNameCaseInsensitive); + config.save(); + } + + private int reindexAccounts() throws Exception { + monitor.beginTask("Reindex accounts", ProgressMonitor.UNKNOWN); + String[] reindexArgs = { + "--site-path", getSitePath().toString(), "--index", AccountSchemaDefinitions.NAME + }; + logger.atInfo().log( + "Migration complete, reindexing accounts with: reindex %s", String.join(" ", reindexArgs)); + Reindex reindexPgm = new Reindex(); + int exitCode = reindexPgm.main(reindexArgs); + monitor.endTask(); + return exitCode; + } +}
diff --git a/java/com/google/gerrit/pgm/CopyApprovals.java b/java/com/google/gerrit/pgm/CopyApprovals.java new file mode 100644 index 0000000..f62d60c --- /dev/null +++ b/java/com/google/gerrit/pgm/CopyApprovals.java
@@ -0,0 +1,138 @@ +// Copyright (C) 2022 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.pgm; + +import com.google.gerrit.extensions.config.FactoryModule; +import com.google.gerrit.index.IndexType; +import com.google.gerrit.lifecycle.LifecycleManager; +import com.google.gerrit.lucene.LuceneIndexModule; +import com.google.gerrit.pgm.util.BatchProgramModule; +import com.google.gerrit.pgm.util.SiteProgram; +import com.google.gerrit.server.LibModuleLoader; +import com.google.gerrit.server.ModuleOverloader; +import com.google.gerrit.server.approval.RecursiveApprovalCopier; +import com.google.gerrit.server.change.ChangeResource; +import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.index.IndexModule; +import com.google.gerrit.server.index.options.AutoFlush; +import com.google.gerrit.server.index.options.IsFirstInsertForEntry; +import com.google.gerrit.server.plugins.PluginGuiceEnvironment; +import com.google.gerrit.server.util.ReplicaUtil; +import com.google.inject.AbstractModule; +import com.google.inject.Inject; +import com.google.inject.Injector; +import com.google.inject.Key; +import com.google.inject.Module; +import com.google.inject.multibindings.OptionalBinder; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.eclipse.jgit.lib.Config; + +public class CopyApprovals extends SiteProgram { + + private Injector dbInjector; + private Injector sysInjector; + private Injector cfgInjector; + private Config globalConfig; + + @Inject private RecursiveApprovalCopier recursiveApprovalCopier; + + @Override + public int run() throws Exception { + mustHaveValidSite(); + dbInjector = createDbInjector(); + cfgInjector = dbInjector.createChildInjector(); + globalConfig = dbInjector.getInstance(Key.get(Config.class, GerritServerConfig.class)); + LifecycleManager dbManager = new LifecycleManager(); + dbManager.add(dbInjector); + dbManager.start(); + + sysInjector = createSysInjector(); + sysInjector.getInstance(PluginGuiceEnvironment.class).setDbCfgInjector(dbInjector, cfgInjector); + LifecycleManager sysManager = new LifecycleManager(); + sysManager.add(sysInjector); + sysManager.start(); + + sysInjector.injectMembers(this); + + try { + recursiveApprovalCopier.persistStandalone(); + return 0; + } catch (Exception e) { + throw die(e.getMessage(), e); + } finally { + sysManager.stop(); + dbManager.stop(); + } + } + + private Injector createSysInjector() { + Map<String, Integer> versions = new HashMap<>(); + boolean replica = ReplicaUtil.isReplica(globalConfig); + List<Module> modules = new ArrayList<>(); + Module indexModule; + IndexType indexType = IndexModule.getIndexType(dbInjector); + if (indexType.isLucene()) { + indexModule = + LuceneIndexModule.singleVersionWithExplicitVersions( + versions, 1, replica, AutoFlush.DISABLED); + } else if (indexType.isFake()) { + // Use Reflection so that we can omit the fake index binary in production code. Test code does + // compile the component in. + try { + Class<?> clazz = Class.forName("com.google.gerrit.index.testing.FakeIndexModule"); + Method m = + clazz.getMethod( + "singleVersionWithExplicitVersions", Map.class, int.class, boolean.class); + indexModule = (Module) m.invoke(null, versions, 1, replica); + } catch (NoSuchMethodException + | ClassNotFoundException + | IllegalAccessException + | InvocationTargetException e) { + throw new IllegalStateException("can't create index", e); + } + } else { + throw new IllegalStateException("unsupported index.type = " + indexType); + } + modules.add(indexModule); + modules.add( + new AbstractModule() { + @Override + protected void configure() { + super.configure(); + OptionalBinder.newOptionalBinder(binder(), IsFirstInsertForEntry.class) + .setBinding() + .toInstance(IsFirstInsertForEntry.YES); + } + }); + + modules.add( + new FactoryModule() { + @Override + protected void configure() { + factory(ChangeResource.Factory.class); + } + }); + modules.add(new BatchProgramModule(dbInjector)); + + return dbInjector.createChildInjector( + ModuleOverloader.override( + modules, LibModuleLoader.loadReindexModules(cfgInjector, versions, 1, replica))); + } +}
diff --git a/java/com/google/gerrit/pgm/Daemon.java b/java/com/google/gerrit/pgm/Daemon.java index 5c407c3..3b31f4b 100644 --- a/java/com/google/gerrit/pgm/Daemon.java +++ b/java/com/google/gerrit/pgm/Daemon.java
@@ -23,19 +23,19 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.auth.AuthModule; import com.google.gerrit.common.Nullable; -import com.google.gerrit.elasticsearch.ElasticIndexModule; import com.google.gerrit.extensions.client.AuthType; import com.google.gerrit.gpg.GpgModule; import com.google.gerrit.httpd.AllRequestFilter; import com.google.gerrit.httpd.GerritAuthModule; -import com.google.gerrit.httpd.GetUserFilter; +import com.google.gerrit.httpd.GetUserFilter.GetUserFilterModule; import com.google.gerrit.httpd.GitOverHttpModule; import com.google.gerrit.httpd.H2CacheBasedWebSession; import com.google.gerrit.httpd.HttpCanonicalWebUrlProvider; +import com.google.gerrit.httpd.HttpdModule; import com.google.gerrit.httpd.RequestCleanupFilter; import com.google.gerrit.httpd.RequestContextFilter; import com.google.gerrit.httpd.RequestMetricsFilter; -import com.google.gerrit.httpd.RequireSslFilter; +import com.google.gerrit.httpd.RequireSslFilter.RequireSslFilterModule; import com.google.gerrit.httpd.SetThreadNameFilter; import com.google.gerrit.httpd.WebModule; import com.google.gerrit.httpd.WebSshGlueModule; @@ -50,28 +50,29 @@ import com.google.gerrit.metrics.dropwizard.DropWizardMetricMaker; import com.google.gerrit.pgm.http.jetty.JettyEnv; import com.google.gerrit.pgm.http.jetty.JettyModule; -import com.google.gerrit.pgm.http.jetty.ProjectQoSFilter; +import com.google.gerrit.pgm.http.jetty.ProjectQoSFilter.ProjectQoSFilterModule; import com.google.gerrit.pgm.util.ErrorLogFile; -import com.google.gerrit.pgm.util.LogFileCompressor; +import com.google.gerrit.pgm.util.LogFileCompressor.LogFileCompressorModule; import com.google.gerrit.pgm.util.RuntimeShutdown; import com.google.gerrit.pgm.util.SiteProgram; import com.google.gerrit.server.LibModuleLoader; import com.google.gerrit.server.LibModuleType; import com.google.gerrit.server.ModuleOverloader; -import com.google.gerrit.server.StartupChecks; -import com.google.gerrit.server.account.AccountDeactivator; -import com.google.gerrit.server.account.InternalAccountDirectory; +import com.google.gerrit.server.StartupChecks.StartupChecksModule; +import com.google.gerrit.server.account.AccountDeactivator.AccountDeactivatorModule; +import com.google.gerrit.server.account.InternalAccountDirectory.InternalAccountDirectoryModule; +import com.google.gerrit.server.account.externalids.ExternalIdCaseSensitivityMigrator; import com.google.gerrit.server.api.GerritApiModule; import com.google.gerrit.server.api.PluginApiModule; import com.google.gerrit.server.audit.AuditModule; import com.google.gerrit.server.cache.h2.H2CacheModule; import com.google.gerrit.server.cache.mem.DefaultMemoryCacheModule; -import com.google.gerrit.server.change.ChangeCleanupRunner; +import com.google.gerrit.server.change.ChangeCleanupRunner.ChangeCleanupRunnerModule; import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.server.config.AuthConfigModule; import com.google.gerrit.server.config.CanonicalWebUrlModule; import com.google.gerrit.server.config.CanonicalWebUrlProvider; -import com.google.gerrit.server.config.DefaultUrlFormatter; +import com.google.gerrit.server.config.DefaultUrlFormatter.DefaultUrlFormatterModule; import com.google.gerrit.server.config.DownloadConfig; import com.google.gerrit.server.config.GerritGlobalModule; import com.google.gerrit.server.config.GerritInstanceIdModule; @@ -80,27 +81,28 @@ import com.google.gerrit.server.config.GerritRuntime; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.config.SysExecutorModule; -import com.google.gerrit.server.events.EventBroker; -import com.google.gerrit.server.events.StreamEventsApiListener; +import com.google.gerrit.server.events.EventBroker.EventBrokerModule; +import com.google.gerrit.server.events.StreamEventsApiListener.StreamEventsApiListenerModule; +import com.google.gerrit.server.git.ChangesByProjectCache; import com.google.gerrit.server.git.GarbageCollectionModule; -import com.google.gerrit.server.git.SearchingChangeCacheImpl; -import com.google.gerrit.server.git.WorkQueue; -import com.google.gerrit.server.group.PeriodicGroupIndexer; +import com.google.gerrit.server.git.WorkQueue.WorkQueueModule; +import com.google.gerrit.server.group.PeriodicGroupIndexer.PeriodicGroupIndexerModule; +import com.google.gerrit.server.index.AbstractIndexModule; import com.google.gerrit.server.index.IndexModule; -import com.google.gerrit.server.index.OnlineUpgrader; +import com.google.gerrit.server.index.OnlineUpgrader.OnlineUpgraderModule; import com.google.gerrit.server.index.VersionManager; import com.google.gerrit.server.index.options.AutoFlush; -import com.google.gerrit.server.mail.SignedTokenEmailTokenVerifier; -import com.google.gerrit.server.mail.receive.MailReceiver; -import com.google.gerrit.server.mail.send.SmtpEmailSender; +import com.google.gerrit.server.mail.SignedTokenEmailTokenVerifier.SignedTokenEmailTokenVerifierModule; +import com.google.gerrit.server.mail.receive.MailReceiver.MailReceiverModule; +import com.google.gerrit.server.mail.send.SmtpEmailSender.SmtpEmailSenderModule; import com.google.gerrit.server.mime.MimeUtil2Module; import com.google.gerrit.server.patch.DiffExecutorModule; import com.google.gerrit.server.permissions.DefaultPermissionBackendModule; import com.google.gerrit.server.plugins.PluginGuiceEnvironment; import com.google.gerrit.server.plugins.PluginModule; -import com.google.gerrit.server.project.DefaultProjectNameLockManager; +import com.google.gerrit.server.project.DefaultProjectNameLockManager.DefaultProjectNameLockManagerModule; import com.google.gerrit.server.restapi.RestApiModule; -import com.google.gerrit.server.schema.JdbcAccountPatchReviewStore; +import com.google.gerrit.server.schema.JdbcAccountPatchReviewStore.JdbcAccountPatchReviewStoreModule; import com.google.gerrit.server.schema.NoteDbSchemaVersionCheck; import com.google.gerrit.server.securestore.DefaultSecureStore; import com.google.gerrit.server.securestore.SecureStore; @@ -109,17 +111,18 @@ import com.google.gerrit.server.ssh.NoSshKeyCache; import com.google.gerrit.server.ssh.NoSshModule; import com.google.gerrit.server.ssh.SshAddressesModule; -import com.google.gerrit.server.submit.LocalMergeSuperSetComputation; -import com.google.gerrit.server.submit.SubscriptionGraph; -import com.google.gerrit.server.update.SuperprojectUpdateSubmissionListener; +import com.google.gerrit.server.submit.LocalMergeSuperSetComputation.LocalMergeSuperSetComputationModule; +import com.google.gerrit.server.submit.SubscriptionGraph.SubscriptionGraphModule; +import com.google.gerrit.server.update.SuperprojectUpdateSubmissionListener.SuperprojectUpdateSubmissionListenerModule; import com.google.gerrit.sshd.SshHostKeyModule; import com.google.gerrit.sshd.SshKeyCacheImpl; import com.google.gerrit.sshd.SshModule; import com.google.gerrit.sshd.SshSessionFactoryInitializer; import com.google.gerrit.sshd.commands.DefaultCommandModule; +import com.google.gerrit.sshd.commands.ExternalIdCommandsModule; import com.google.gerrit.sshd.commands.IndexCommandsModule; import com.google.gerrit.sshd.commands.SequenceCommandsModule; -import com.google.gerrit.sshd.plugin.LfsPluginAuthCommand; +import com.google.gerrit.sshd.plugin.LfsPluginAuthCommand.LfsPluginAuthCommandModule; import com.google.inject.AbstractModule; import com.google.inject.Guice; import com.google.inject.Injector; @@ -128,6 +131,8 @@ import com.google.inject.Provider; import com.google.inject.Stage; import java.io.IOException; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; import java.nio.file.Files; import java.nio.file.Path; import java.util.ArrayList; @@ -178,7 +183,7 @@ private String devCdn = ""; @Option(name = "--dev-cdn", usage = "Use specified cdn for serving static content.") - private void setDevCdn(String cdn) { + void setDevCdn(String cdn) { if (cdn == null) { cdn = ""; } @@ -207,7 +212,7 @@ private Injector httpdInjector; private Path runFile; private boolean inMemoryTest; - private AbstractModule luceneModule; + private AbstractModule indexModule; private Module emailModule; private List<Module> testSysModules = new ArrayList<>(); private List<Module> testSshModules = new ArrayList<>(); @@ -311,7 +316,7 @@ RuntimeShutdown.waitFor(); } return 0; - } catch (Throwable err) { + } catch (RuntimeException err) { logger.atSevere().withCause(err).log("Unable to start daemon"); return 1; } @@ -340,9 +345,13 @@ } @VisibleForTesting - public void setLuceneModule(LuceneIndexModule m) { - luceneModule = m; - inMemoryTest = true; + public void setIndexModule(AbstractIndexModule m) { + indexModule = m; + } + + @VisibleForTesting + public void setInMemory(boolean inMemory) { + this.inMemoryTest = inMemory; } @VisibleForTesting @@ -425,18 +434,18 @@ final List<Module> modules = new ArrayList<>(); modules.add(NoteDbSchemaVersionCheck.module()); modules.add(new DropWizardMetricMaker.RestModule()); - modules.add(new LogFileCompressor.Module()); + modules.add(new LogFileCompressorModule()); // Index module shutdown must happen before work queue shutdown, otherwise // work queue can get stuck waiting on index futures that will never return. modules.add(createIndexModule()); - modules.add(new SubscriptionGraph.Module()); - modules.add(new SuperprojectUpdateSubmissionListener.Module()); - modules.add(new WorkQueue.Module()); - modules.add(new StreamEventsApiListener.Module()); - modules.add(new EventBroker.Module()); - modules.add(new JdbcAccountPatchReviewStore.Module(config)); + modules.add(new SubscriptionGraphModule()); + modules.add(new SuperprojectUpdateSubmissionListenerModule()); + modules.add(new WorkQueueModule()); + modules.add(new StreamEventsApiListenerModule()); + modules.add(new EventBrokerModule()); + modules.add(new JdbcAccountPatchReviewStoreModule(config)); modules.add(new SysExecutorModule()); modules.add(new DiffExecutorModule()); modules.add(new MimeUtil2Module()); @@ -444,31 +453,34 @@ modules.add(new GerritApiModule()); modules.add(new PluginApiModule()); - modules.add(new SearchingChangeCacheImpl.Module(replica)); - modules.add(new InternalAccountDirectory.Module()); + modules.add( + new ChangesByProjectCache.Module( + replica ? ChangesByProjectCache.UseIndex.FALSE : ChangesByProjectCache.UseIndex.TRUE, + config)); + modules.add(new InternalAccountDirectoryModule()); modules.add(new DefaultPermissionBackendModule()); modules.add(new DefaultMemoryCacheModule()); modules.add(new H2CacheModule()); - modules.add(cfgInjector.getInstance(MailReceiver.Module.class)); + modules.add(cfgInjector.getInstance(MailReceiverModule.class)); if (emailModule != null) { modules.add(emailModule); } else { - modules.add(new SmtpEmailSender.Module()); + modules.add(new SmtpEmailSenderModule()); } if (auditEventModule != null) { modules.add(auditEventModule); } else { modules.add(new AuditModule()); } - modules.add(new SignedTokenEmailTokenVerifier.Module()); + modules.add(new SignedTokenEmailTokenVerifierModule()); modules.add(new PluginModule()); if (VersionManager.getOnlineUpgrade(config)) { - modules.add(new OnlineUpgrader.Module()); + modules.add(new OnlineUpgraderModule()); } modules.add(new OAuthRestModule()); modules.add(new RestApiModule()); modules.add(new GpgModule(config)); - modules.add(new StartupChecks.Module()); + modules.add(new StartupChecksModule()); modules.add(new GerritInstanceNameModule()); modules.add(new GerritInstanceIdModule()); if (MoreObjects.firstNonNull(httpd, true)) { @@ -488,7 +500,7 @@ } }); } - modules.add(new DefaultUrlFormatter.Module()); + modules.add(new DefaultUrlFormatterModule()); SshSessionFactoryInitializer.init(config); if (sshd) { modules.add(SshKeyCacheImpl.module()); @@ -510,32 +522,47 @@ }); modules.add(new GarbageCollectionModule()); if (replica) { - modules.add(new PeriodicGroupIndexer.Module()); + modules.add(new PeriodicGroupIndexerModule()); } else { - modules.add(new AccountDeactivator.Module()); - modules.add(new ChangeCleanupRunner.Module()); + modules.add(new AccountDeactivatorModule()); + modules.add(new ChangeCleanupRunnerModule()); } - modules.add(new LocalMergeSuperSetComputation.Module()); - modules.add(new DefaultProjectNameLockManager.Module()); + modules.add(new LocalMergeSuperSetComputationModule()); + modules.add(new DefaultProjectNameLockManagerModule()); - List<Module> libModules = LibModuleLoader.loadModules(cfgInjector, LibModuleType.SYS_MODULE); + List<Module> libModules = + LibModuleLoader.loadModules(cfgInjector, LibModuleType.SYS_MODULE_TYPE); + libModules.addAll(LibModuleLoader.loadModules(cfgInjector, LibModuleType.INDEX_MODULE_TYPE)); libModules.addAll(testSysModules); AuthConfig authConfig = cfgInjector.getInstance(AuthConfig.class); modules.add(new AuthModule(authConfig)); + modules.add(new ExternalIdCaseSensitivityMigrator.ExternalIdCaseSensitivityMigratorModule()); + return cfgInjector.createChildInjector(ModuleOverloader.override(modules, libModules)); } private Module createIndexModule() { - if (luceneModule != null) { - return luceneModule; + if (indexModule != null) { + return indexModule; } if (indexType.isLucene()) { return LuceneIndexModule.latestVersion(replica, AutoFlush.ENABLED); } - if (indexType.isElasticsearch()) { - return ElasticIndexModule.latestVersion(replica); + if (indexType.isFake()) { + // Use Reflection so that we can omit the fake index binary in production code. Test code does + // compile the component in. + try { + Class<?> clazz = Class.forName("com.google.gerrit.index.testing.FakeIndexModule"); + Method m = clazz.getMethod("latestVersion", boolean.class); + return (Module) m.invoke(null, replica); + } catch (NoSuchMethodException + | ClassNotFoundException + | IllegalAccessException + | InvocationTargetException e) { + throw new IllegalStateException("can't create index", e); + } } throw new IllegalStateException("unsupported index.type = " + indexType); } @@ -556,12 +583,13 @@ new DefaultCommandModule( replica, sysInjector.getInstance(DownloadConfig.class), - sysInjector.getInstance(LfsPluginAuthCommand.Module.class))); + sysInjector.getInstance(LfsPluginAuthCommandModule.class))); modules.addAll(testSshModules); if (!replica) { modules.add(new IndexCommandsModule(sysInjector)); modules.add(new SequenceCommandsModule()); + modules.add(new ExternalIdCommandsModule()); } return sysInjector.createChildInjector(modules); } @@ -586,14 +614,15 @@ modules.add(H2CacheBasedWebSession.module()); modules.add(sysInjector.getInstance(GerritAuthModule.class)); modules.add(sysInjector.getInstance(GitOverHttpModule.class)); + modules.add(sysInjector.getInstance(HttpdModule.class)); if (sshd) { - modules.add(new ProjectQoSFilter.Module()); + modules.add(new ProjectQoSFilterModule()); } modules.add(RequestCleanupFilter.module()); modules.add(AllRequestFilter.module()); modules.add(SetThreadNameFilter.module()); modules.add(sysInjector.getInstance(WebModule.class)); - modules.add(sysInjector.getInstance(RequireSslFilter.Module.class)); + modules.add(sysInjector.getInstance(RequireSslFilterModule.class)); modules.add(new HttpPluginModule()); if (sshd) { modules.add(sshInjector.getInstance(WebSshGlueModule.class)); @@ -609,7 +638,7 @@ modules.add(new OAuthModule()); } - modules.add(sysInjector.getInstance(GetUserFilter.Module.class)); + modules.add(sysInjector.getInstance(GetUserFilterModule.class)); // StaticModule contains a "/*" wildcard, place it last. GerritOptions opts = sysInjector.getInstance(GerritOptions.class);
diff --git a/java/com/google/gerrit/pgm/DeleteZombieDrafts.java b/java/com/google/gerrit/pgm/DeleteZombieDrafts.java index c08e999..57f8394 100644 --- a/java/com/google/gerrit/pgm/DeleteZombieDrafts.java +++ b/java/com/google/gerrit/pgm/DeleteZombieDrafts.java
@@ -21,7 +21,6 @@ import com.google.gerrit.server.config.GerritServerConfigModule; import com.google.gerrit.server.config.SitePath; import com.google.gerrit.server.notedb.DeleteZombieCommentsRefs; -import com.google.gerrit.server.notedb.DeleteZombieCommentsRefs.Factory; import com.google.gerrit.server.schema.SchemaModule; import com.google.gerrit.server.securestore.SecureStoreClassName; import com.google.inject.AbstractModule; @@ -54,7 +53,7 @@ mustHaveValidSite(); Injector sysInjector = getSysInjector(); DeleteZombieCommentsRefs cleanup = - sysInjector.getInstance(Factory.class).create(cleanupPercentage); + sysInjector.getInstance(DeleteZombieCommentsRefs.Factory.class).create(cleanupPercentage); cleanup.execute(); return 0; }
diff --git a/java/com/google/gerrit/pgm/Init.java b/java/com/google/gerrit/pgm/Init.java index 2a746b8..c05bff5 100644 --- a/java/com/google/gerrit/pgm/Init.java +++ b/java/com/google/gerrit/pgm/Init.java
@@ -163,7 +163,7 @@ }); modules.add(new GerritServerConfigModule()); Guice.createInjector(modules).injectMembers(this); - if (!ReplicaUtil.isReplica(run.flags.cfg)) { + if (reindexThreads != -1 && !ReplicaUtil.isReplica(run.flags.cfg)) { List<String> indicesToReindex = new ArrayList<>(); for (SchemaDefinitions<?> schemaDef : schemaDefs) { if (!indexStatus.exists(schemaDef.getName())) { @@ -226,7 +226,7 @@ } void start(SiteRun run) throws Exception { - if (run.flags.autoStart) { + if (reindexThreads != -1 && run.flags.autoStart) { if (HostPlatform.isWin32()) { System.err.println("Automatic startup not supported on Win32."); } else {
diff --git a/java/com/google/gerrit/pgm/LocalUsernamesToLowerCase.java b/java/com/google/gerrit/pgm/LocalUsernamesToLowerCase.java index 8e2f70f..f651994 100644 --- a/java/com/google/gerrit/pgm/LocalUsernamesToLowerCase.java +++ b/java/com/google/gerrit/pgm/LocalUsernamesToLowerCase.java
@@ -22,6 +22,7 @@ import com.google.gerrit.pgm.util.SiteProgram; import com.google.gerrit.server.account.externalids.DisabledExternalIdCache; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; import com.google.gerrit.server.account.externalids.ExternalIdNotes; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.config.AllUsersName; @@ -52,6 +53,7 @@ @Inject private AllUsersName allUsersName; @Inject private Provider<MetaDataUpdate.Server> metaDataUpdateServerFactory; @Inject private ExternalIdNotes.FactoryNoReindex externalIdNotesFactory; + @Inject private ExternalIdFactory externalIdFactory; @Inject private ExternalIds externalIds; @Override @@ -105,7 +107,7 @@ String localUserLowerCase = localUser.toLowerCase(Locale.US); if (!localUser.equals(localUserLowerCase)) { ExternalId extIdLowerCase = - ExternalId.create( + externalIdFactory.create( SCHEME_GERRIT, localUserLowerCase, extId.accountId(),
diff --git a/java/com/google/gerrit/pgm/Reindex.java b/java/com/google/gerrit/pgm/Reindex.java index 9e7ce47..ecfca0d 100644 --- a/java/com/google/gerrit/pgm/Reindex.java +++ b/java/com/google/gerrit/pgm/Reindex.java
@@ -20,7 +20,6 @@ import com.google.common.cache.Cache; import com.google.common.collect.Sets; import com.google.gerrit.common.Die; -import com.google.gerrit.elasticsearch.ElasticIndexModule; import com.google.gerrit.extensions.config.FactoryModule; import com.google.gerrit.extensions.registration.DynamicMap; import com.google.gerrit.index.Index; @@ -31,6 +30,8 @@ import com.google.gerrit.lucene.LuceneIndexModule; import com.google.gerrit.pgm.util.BatchProgramModule; import com.google.gerrit.pgm.util.SiteProgram; +import com.google.gerrit.server.LibModuleLoader; +import com.google.gerrit.server.ModuleOverloader; import com.google.gerrit.server.cache.CacheDisplay; import com.google.gerrit.server.cache.CacheInfo; import com.google.gerrit.server.change.ChangeResource; @@ -38,6 +39,7 @@ import com.google.gerrit.server.index.IndexModule; import com.google.gerrit.server.index.change.ChangeSchemaDefinitions; import com.google.gerrit.server.index.options.AutoFlush; +import com.google.gerrit.server.index.options.BuildBloomFilter; import com.google.gerrit.server.index.options.IsFirstInsertForEntry; import com.google.gerrit.server.plugins.PluginGuiceEnvironment; import com.google.gerrit.server.util.ReplicaUtil; @@ -49,6 +51,8 @@ import com.google.inject.multibindings.OptionalBinder; import java.io.StringWriter; import java.io.Writer; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; @@ -86,6 +90,9 @@ @Option(name = "--show-cache-stats", usage = "Show cache statistics at the end.") private boolean showCacheStats; + @Option(name = "--build-bloom-filter", usage = "Build bloom filter for H2 disk caches.") + private boolean buildBloomFilter; + private Injector dbInjector; private Injector sysInjector; private Injector cfgInjector; @@ -174,9 +181,21 @@ indexModule = LuceneIndexModule.singleVersionWithExplicitVersions( versions, threads, replica, AutoFlush.DISABLED); - } else if (indexType.isElasticsearch()) { - indexModule = - ElasticIndexModule.singleVersionWithExplicitVersions(versions, threads, replica); + } else if (indexType.isFake()) { + // Use Reflection so that we can omit the fake index binary in production code. Test code does + // compile the component in. + try { + Class<?> clazz = Class.forName("com.google.gerrit.index.testing.FakeIndexModule"); + Method m = + clazz.getMethod( + "singleVersionWithExplicitVersions", Map.class, int.class, boolean.class); + indexModule = (Module) m.invoke(null, versions, threads, replica); + } catch (NoSuchMethodException + | ClassNotFoundException + | IllegalAccessException + | InvocationTargetException e) { + throw new IllegalStateException("can't create index", e); + } } else { throw new IllegalStateException("unsupported index.type = " + indexType); } @@ -189,6 +208,9 @@ OptionalBinder.newOptionalBinder(binder(), IsFirstInsertForEntry.class) .setBinding() .toInstance(IsFirstInsertForEntry.YES); + OptionalBinder.newOptionalBinder(binder(), BuildBloomFilter.class) + .setBinding() + .toInstance(buildBloomFilter ? BuildBloomFilter.TRUE : BuildBloomFilter.FALSE); } }); modules.add(new BatchProgramModule(dbInjector)); @@ -200,7 +222,9 @@ } }); - return dbInjector.createChildInjector(modules); + return dbInjector.createChildInjector( + ModuleOverloader.override( + modules, LibModuleLoader.loadReindexModules(cfgInjector, versions, threads, replica))); } private void overrideConfig() {
diff --git a/java/com/google/gerrit/pgm/SetPasswd.java b/java/com/google/gerrit/pgm/SetPasswd.java index c6ece21..c3f6a7b 100644 --- a/java/com/google/gerrit/pgm/SetPasswd.java +++ b/java/com/google/gerrit/pgm/SetPasswd.java
@@ -16,13 +16,12 @@ import com.google.gerrit.pgm.init.api.ConsoleUI; import com.google.gerrit.pgm.init.api.Section; -import com.google.gerrit.pgm.init.api.Section.Factory; import com.google.inject.Inject; public class SetPasswd { private ConsoleUI ui; - private Factory sections; + private Section.Factory sections; @Inject public SetPasswd(ConsoleUI ui, Section.Factory sections) {
diff --git a/java/com/google/gerrit/pgm/http/jetty/JettyServer.java b/java/com/google/gerrit/pgm/http/jetty/JettyServer.java index 89b4228..6f3514f 100644 --- a/java/com/google/gerrit/pgm/http/jetty/JettyServer.java +++ b/java/com/google/gerrit/pgm/http/jetty/JettyServer.java
@@ -547,7 +547,7 @@ filterHolder.setInitParameters(initParams); } app.addFilter(filterHolder, "/*", EnumSet.of(DispatcherType.REQUEST, DispatcherType.ASYNC)); - } catch (Throwable e) { + } catch (Exception e) { throw new IllegalArgumentException( "Unable to instantiate front-end HTTP Filter " + filterClassName, e); }
diff --git a/java/com/google/gerrit/pgm/http/jetty/ProjectQoSFilter.java b/java/com/google/gerrit/pgm/http/jetty/ProjectQoSFilter.java index 1cca789..1a5b4c4 100644 --- a/java/com/google/gerrit/pgm/http/jetty/ProjectQoSFilter.java +++ b/java/com/google/gerrit/pgm/http/jetty/ProjectQoSFilter.java
@@ -71,7 +71,7 @@ private static final String FILTER_RE = "^/(.*)/(git-upload-pack|git-receive-pack)$"; private static final Pattern URI_PATTERN = Pattern.compile(FILTER_RE); - public static class Module extends ServletModule { + public static class ProjectQoSFilterModule extends ServletModule { @Override protected void configureServlets() { bind(QueueProvider.class).to(CommandExecutorQueueProvider.class);
diff --git a/java/com/google/gerrit/pgm/init/AccountsOnInit.java b/java/com/google/gerrit/pgm/init/AccountsOnInit.java index 536ddcd..d9e3a6a 100644 --- a/java/com/google/gerrit/pgm/init/AccountsOnInit.java +++ b/java/com/google/gerrit/pgm/init/AccountsOnInit.java
@@ -22,9 +22,9 @@ import com.google.gerrit.pgm.init.api.AllUsersNameOnInitProvider; import com.google.gerrit.pgm.init.api.InitFlags; import com.google.gerrit.server.GerritPersonIdentProvider; +import com.google.gerrit.server.account.AccountDelta; import com.google.gerrit.server.account.AccountProperties; import com.google.gerrit.server.account.Accounts; -import com.google.gerrit.server.account.InternalAccountUpdate; import com.google.gerrit.server.config.SitePaths; import com.google.inject.Inject; import java.io.File; @@ -69,7 +69,7 @@ Config accountConfig = new Config(); AccountProperties.writeToAccountConfig( - InternalAccountUpdate.builder() + AccountDelta.builder() .setActive(!account.inactive()) .setFullName(account.fullName()) .setPreferredEmail(account.preferredEmail())
diff --git a/java/com/google/gerrit/pgm/init/BUILD b/java/com/google/gerrit/pgm/init/BUILD index 62c9526..5849711 100644 --- a/java/com/google/gerrit/pgm/init/BUILD +++ b/java/com/google/gerrit/pgm/init/BUILD
@@ -9,7 +9,6 @@ deps = [ "//java/com/google/gerrit/common:annotations", "//java/com/google/gerrit/common:server", - "//java/com/google/gerrit/elasticsearch", "//java/com/google/gerrit/entities", "//java/com/google/gerrit/exceptions", "//java/com/google/gerrit/extensions:api",
diff --git a/java/com/google/gerrit/pgm/init/BaseInit.java b/java/com/google/gerrit/pgm/init/BaseInit.java index 62ff66a..c1f5753 100644 --- a/java/com/google/gerrit/pgm/init/BaseInit.java +++ b/java/com/google/gerrit/pgm/init/BaseInit.java
@@ -32,7 +32,7 @@ import com.google.gerrit.pgm.init.api.InstallPlugins; import com.google.gerrit.pgm.init.api.LibraryDownload; import com.google.gerrit.pgm.init.index.IndexManagerOnInit; -import com.google.gerrit.pgm.init.index.elasticsearch.ElasticIndexModuleOnInit; +import com.google.gerrit.pgm.init.index.IndexModuleOnInit; import com.google.gerrit.pgm.init.index.lucene.LuceneIndexModuleOnInit; import com.google.gerrit.pgm.util.SiteProgram; import com.google.gerrit.server.config.GerritServerConfigModule; @@ -57,6 +57,7 @@ import com.google.inject.util.Providers; import java.io.FileNotFoundException; import java.io.IOException; +import java.lang.reflect.InvocationTargetException; import java.nio.file.FileVisitResult; import java.nio.file.Files; import java.nio.file.Path; @@ -162,7 +163,6 @@ * Invoked before site init is called. * * @param init initializer instance. - * @throws Exception */ protected boolean beforeInit(SiteInit init) throws Exception { return false; @@ -172,7 +172,6 @@ * Invoked after site init is called. * * @param run completed run instance. - * @throws Exception */ protected void afterInit(SiteRun run) throws Exception {} @@ -416,8 +415,19 @@ IndexType indexType = IndexModule.getIndexType(dbInjector); if (indexType.isLucene()) { modules.add(new LuceneIndexModuleOnInit()); - } else if (indexType.isElasticsearch()) { - modules.add(new ElasticIndexModuleOnInit()); + } else if (indexType.isFake()) { + try { + Class<?> clazz = Class.forName("com.google.gerrit.index.testing.FakeIndexModuleOnInit"); + Module indexOnInitModule = (Module) clazz.getDeclaredConstructor().newInstance(); + modules.add(indexOnInitModule); + } catch (InstantiationException + | IllegalAccessException + | ClassNotFoundException + | NoSuchMethodException + | InvocationTargetException e) { + throw new IllegalStateException("unable to create fake index", e); + } + modules.add(new IndexModuleOnInit()); } else { throw new IllegalStateException("unsupported index.type = " + indexType); }
diff --git a/java/com/google/gerrit/pgm/init/ExternalIdsOnInit.java b/java/com/google/gerrit/pgm/init/ExternalIdsOnInit.java index 9519653..9b4d5bb 100644 --- a/java/com/google/gerrit/pgm/init/ExternalIdsOnInit.java +++ b/java/com/google/gerrit/pgm/init/ExternalIdsOnInit.java
@@ -18,8 +18,10 @@ import com.google.gerrit.pgm.init.api.InitFlags; import com.google.gerrit.server.GerritPersonIdentProvider; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; import com.google.gerrit.server.account.externalids.ExternalIdNotes; import com.google.gerrit.server.config.AllUsersName; +import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.server.config.SitePaths; import com.google.gerrit.server.extensions.events.GitReferenceUpdated; import com.google.gerrit.server.git.meta.MetaDataUpdate; @@ -39,12 +41,21 @@ private final InitFlags flags; private final SitePaths site; private final AllUsersName allUsers; + private final ExternalIdFactory externalIdFactory; + private final AuthConfig authConfig; @Inject - public ExternalIdsOnInit(InitFlags flags, SitePaths site, AllUsersNameOnInitProvider allUsers) { + public ExternalIdsOnInit( + InitFlags flags, + SitePaths site, + AllUsersNameOnInitProvider allUsers, + ExternalIdFactory externalIdFactory, + AuthConfig authConfig) { this.flags = flags; this.site = site; this.allUsers = new AllUsersName(allUsers.get()); + this.externalIdFactory = externalIdFactory; + this.authConfig = authConfig; } public synchronized void insert(String commitMessage, Collection<ExternalId> extIds) @@ -52,7 +63,12 @@ File path = getPath(); if (path != null) { try (Repository allUsersRepo = new FileRepository(path)) { - ExternalIdNotes extIdNotes = ExternalIdNotes.loadNoCacheUpdate(allUsers, allUsersRepo); + ExternalIdNotes extIdNotes = + ExternalIdNotes.loadNoCacheUpdate( + allUsers, + allUsersRepo, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()); extIdNotes.insert(extIds); try (MetaDataUpdate metaDataUpdate = new MetaDataUpdate(GitReferenceUpdated.DISABLED, allUsers, allUsersRepo)) {
diff --git a/java/com/google/gerrit/pgm/init/GroupsOnInit.java b/java/com/google/gerrit/pgm/init/GroupsOnInit.java index 95572b6..2f12abb 100644 --- a/java/com/google/gerrit/pgm/init/GroupsOnInit.java +++ b/java/com/google/gerrit/pgm/init/GroupsOnInit.java
@@ -34,8 +34,8 @@ import com.google.gerrit.server.git.meta.MetaDataUpdate; import com.google.gerrit.server.group.db.AuditLogFormatter; import com.google.gerrit.server.group.db.GroupConfig; +import com.google.gerrit.server.group.db.GroupDelta; import com.google.gerrit.server.group.db.GroupNameNotes; -import com.google.gerrit.server.group.db.InternalGroupUpdate; import com.google.inject.Inject; import java.io.File; import java.io.IOException; @@ -139,9 +139,9 @@ InternalGroup group = groupConfig.getLoadedGroup().orElseThrow(() -> new NoSuchGroupException(groupUuid)); - InternalGroupUpdate groupUpdate = getMemberAdditionUpdate(account); + GroupDelta groupDelta = getMemberAdditionDelta(account); AuditLogFormatter auditLogFormatter = getAuditLogFormatter(account); - groupConfig.setGroupUpdate(groupUpdate, auditLogFormatter); + groupConfig.setGroupDelta(groupDelta, auditLogFormatter); commit(repository, groupConfig, group.getCreatedOn()); } @@ -153,8 +153,8 @@ return RepositoryCache.FileKey.resolve(basePath.resolve(allUsers.get()).toFile(), FS.DETECTED); } - private static InternalGroupUpdate getMemberAdditionUpdate(Account account) { - return InternalGroupUpdate.builder() + private static GroupDelta getMemberAdditionDelta(Account account) { + return GroupDelta.builder() .setMemberModification(members -> Sets.union(members, ImmutableSet.of(account.id()))) .build(); }
diff --git a/java/com/google/gerrit/pgm/init/InitAdminUser.java b/java/com/google/gerrit/pgm/init/InitAdminUser.java index 2e32066..d6a0133 100644 --- a/java/com/google/gerrit/pgm/init/InitAdminUser.java +++ b/java/com/google/gerrit/pgm/init/InitAdminUser.java
@@ -29,6 +29,7 @@ import com.google.gerrit.server.account.AccountSshKey; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; import com.google.gerrit.server.index.account.AccountIndex; import com.google.gerrit.server.index.account.AccountIndexCollection; import com.google.gerrit.server.index.group.GroupIndex; @@ -52,6 +53,7 @@ private final ExternalIdsOnInit externalIds; private final SequencesOnInit sequencesOnInit; private final GroupsOnInit groupsOnInit; + private final ExternalIdFactory externalIdFactory; private AccountIndexCollection accountIndexCollection; private GroupIndexCollection groupIndexCollection; @@ -63,7 +65,8 @@ VersionedAuthorizedKeysOnInit.Factory authorizedKeysFactory, ExternalIdsOnInit externalIds, SequencesOnInit sequencesOnInit, - GroupsOnInit groupsOnInit) { + GroupsOnInit groupsOnInit, + ExternalIdFactory externalIdFactory) { this.flags = flags; this.ui = ui; this.accounts = accounts; @@ -71,6 +74,7 @@ this.externalIds = externalIds; this.sequencesOnInit = sequencesOnInit; this.groupsOnInit = groupsOnInit; + this.externalIdFactory = externalIdFactory; } @Override @@ -107,10 +111,10 @@ String email = readEmail(sshKey); List<ExternalId> extIds = new ArrayList<>(2); - extIds.add(ExternalId.createUsername(username, id, httpPassword)); + extIds.add(externalIdFactory.createUsername(username, id, httpPassword)); if (email != null) { - extIds.add(ExternalId.createEmail(id, email)); + extIds.add(externalIdFactory.createEmail(id, email)); } externalIds.insert("Add external IDs for initial admin user", extIds);
diff --git a/java/com/google/gerrit/pgm/init/InitAuth.java b/java/com/google/gerrit/pgm/init/InitAuth.java index c15cff3..948ec49 100644 --- a/java/com/google/gerrit/pgm/init/InitAuth.java +++ b/java/com/google/gerrit/pgm/init/InitAuth.java
@@ -26,6 +26,7 @@ import com.google.gerrit.pgm.init.api.InitFlags; import com.google.gerrit.pgm.init.api.InitStep; import com.google.gerrit.pgm.init.api.Section; +import com.google.gerrit.server.config.SitePaths; import com.google.gerrit.server.mail.SignedToken; import com.google.inject.Inject; import com.google.inject.Singleton; @@ -42,11 +43,13 @@ private final Section ldap; private final Section receive; private final InitFlags flags; + private final SitePaths site; @Inject - InitAuth(InitFlags flags, ConsoleUI ui, Section.Factory sections) { + InitAuth(InitFlags flags, ConsoleUI ui, final SitePaths site, Section.Factory sections) { this.flags = flags; this.ui = ui; + this.site = site; this.auth = sections.get("auth", null); this.ldap = sections.get("ldap", null); this.receive = sections.get(RECEIVE, null); @@ -62,6 +65,10 @@ } initSignedPush(); + + if (site.isNew) { + initUserNameCaseSensitivity(); + } } private void initAuthType() { @@ -156,4 +163,9 @@ boolean enable = ui.yesno(def, "Enable signed push support"); receive.set("enableSignedPush", Boolean.toString(enable)); } + + private void initUserNameCaseSensitivity() { + boolean enableCaseInsensitivity = ui.yesno(true, "Use case insensitive usernames"); + auth.set("userNameCaseInsensitive", Boolean.toString(enableCaseInsensitivity)); + } }
diff --git a/java/com/google/gerrit/pgm/init/InitIndex.java b/java/com/google/gerrit/pgm/init/InitIndex.java index d78d8a1..a6254fd 100644 --- a/java/com/google/gerrit/pgm/init/InitIndex.java +++ b/java/com/google/gerrit/pgm/init/InitIndex.java
@@ -39,7 +39,6 @@ private final SitePaths site; private final InitFlags initFlags; private final Section gerrit; - private final Section.Factory sections; @Inject InitIndex(ConsoleUI ui, Section.Factory sections, SitePaths site, InitFlags initFlags) { @@ -48,7 +47,6 @@ this.gerrit = sections.get("gerrit", null); this.site = site; this.initFlags = initFlags; - this.sections = sections; } @Override @@ -58,14 +56,6 @@ new IndexType( index.select("Type", "type", IndexType.getDefault(), IndexType.getKnownTypes())); - if (type.isElasticsearch()) { - Section elasticsearch = sections.get("elasticsearch", null); - elasticsearch.string("Index Prefix", "prefix", "gerrit_"); - elasticsearch.string("Server", "server", "http://localhost:9200"); - index.string("Result window size", "maxLimit", "10000"); - index.string("Result page size", "maxPageSize", "10000"); - } - if ((site.isNew || isEmptySite()) && type.isLucene()) { for (SchemaDefinitions<?> def : IndexModule.ALL_SCHEMA_DEFS) { IndexUtils.setReady(site, def.getName(), def.getLatest().getVersion(), true);
diff --git a/java/com/google/gerrit/pgm/init/InitJGitConfig.java b/java/com/google/gerrit/pgm/init/InitJGitConfig.java index bad55b4..b68e9f7 100644 --- a/java/com/google/gerrit/pgm/init/InitJGitConfig.java +++ b/java/com/google/gerrit/pgm/init/InitJGitConfig.java
@@ -53,7 +53,8 @@ ConfigConstants.CONFIG_RECEIVE_SECTION, null, ConfigConstants.CONFIG_KEY_AUTOGC, false); jgitConfig.save(); ui.error( - "Auto-configured \"receive.autogc = false\" to disable auto-gc after git-receive-pack."); + "Auto-configured \"receive.autogc = false\" to disable auto-gc after" + + " git-receive-pack."); } else if (jgitConfig.getBoolean( ConfigConstants.CONFIG_RECEIVE_SECTION, ConfigConstants.CONFIG_KEY_AUTOGC, true)) { ui.error( @@ -72,12 +73,9 @@ ConfigConstants.CONFIG_PROTOCOL_SECTION, null, ConfigConstants.CONFIG_KEY_VERSION); if (!TransferConfig.ProtocolVersion.V2.version().equals(version)) { ui.error( - String.format( - "HINT: JGit option \"%s.%s = %s\". It's recommended to activate git\n" - + "wire protocol version 2 to improve git fetch performance.", - ConfigConstants.CONFIG_PROTOCOL_SECTION, - ConfigConstants.CONFIG_KEY_VERSION, - version)); + "HINT: JGit option \"%s.%s = %s\". It's recommended to activate git\n" + + "wire protocol version 2 to improve git fetch performance.", + ConfigConstants.CONFIG_PROTOCOL_SECTION, ConfigConstants.CONFIG_KEY_VERSION, version); } } } catch (IOException e) {
diff --git a/java/com/google/gerrit/pgm/init/PluginsDistribution.java b/java/com/google/gerrit/pgm/init/PluginsDistribution.java index 73720c4..65c96ec 100644 --- a/java/com/google/gerrit/pgm/init/PluginsDistribution.java +++ b/java/com/google/gerrit/pgm/init/PluginsDistribution.java
@@ -24,6 +24,8 @@ public interface Processor { /** + * Processes the plugin + * * @param pluginName the name of the plugin (without the .jar extension) * @param in the content of the plugin .jar file. Implementors don't have to close this stream. * @throws IOException implementations will typically propagate any IOException caused by
diff --git a/java/com/google/gerrit/pgm/init/SitePathInitializer.java b/java/com/google/gerrit/pgm/init/SitePathInitializer.java index ddc4f79..236d185 100644 --- a/java/com/google/gerrit/pgm/init/SitePathInitializer.java +++ b/java/com/google/gerrit/pgm/init/SitePathInitializer.java
@@ -27,7 +27,6 @@ import com.google.gerrit.pgm.init.api.InitFlags; import com.google.gerrit.pgm.init.api.InitStep; import com.google.gerrit.pgm.init.api.Section; -import com.google.gerrit.pgm.init.api.Section.Factory; import com.google.gerrit.server.config.SitePaths; import com.google.gerrit.server.mail.EmailModule; import com.google.inject.Binding; @@ -46,7 +45,7 @@ private final InitFlags flags; private final SitePaths site; private final List<InitStep> steps; - private final Factory sectionFactory; + private final Section.Factory sectionFactory; private final SecureStoreInitData secureStoreInitData; @Inject
diff --git a/java/com/google/gerrit/pgm/init/api/AllProjectsConfig.java b/java/com/google/gerrit/pgm/init/api/AllProjectsConfig.java index 5ca239e..abd7d43 100644 --- a/java/com/google/gerrit/pgm/init/api/AllProjectsConfig.java +++ b/java/com/google/gerrit/pgm/init/api/AllProjectsConfig.java
@@ -15,15 +15,16 @@ package com.google.gerrit.pgm.init.api; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Project; import com.google.gerrit.entities.RefNames; +import com.google.gerrit.server.config.AllProjectsConfigProvider; import com.google.gerrit.server.config.AllProjectsName; import com.google.gerrit.server.config.SitePaths; import com.google.gerrit.server.project.GroupList; import com.google.gerrit.server.project.ProjectConfig; import com.google.inject.Inject; import java.io.IOException; +import java.util.Optional; import org.eclipse.jgit.errors.ConfigInvalidException; import org.eclipse.jgit.lib.CommitBuilder; import org.eclipse.jgit.lib.Config; @@ -34,16 +35,18 @@ public class AllProjectsConfig extends VersionedMetaDataOnInit { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - @Nullable private final StoredConfig baseConfig; + private final Optional<StoredConfig> baseConfig; private Config cfg; private GroupList groupList; @Inject - AllProjectsConfig(AllProjectsNameOnInitProvider allProjects, SitePaths site, InitFlags flags) { + AllProjectsConfig( + AllProjectsNameOnInitProvider allProjects, + AllProjectsConfigProvider allProjectsConfigProvider, + SitePaths site, + InitFlags flags) { super(flags, site, allProjects.get(), RefNames.REFS_CONFIG); - this.baseConfig = - ProjectConfig.Factory.getBaseConfig( - site, new AllProjectsName(allProjects.get()), Project.nameKey(allProjects.get())); + this.baseConfig = allProjectsConfigProvider.get(new AllProjectsName(allProjects.get())); } public Config getConfig() { @@ -62,8 +65,8 @@ @Override protected void onLoad() throws IOException, ConfigInvalidException { - if (baseConfig != null) { - baseConfig.load(); + if (baseConfig.isPresent()) { + baseConfig.get().load(); } groupList = readGroupList(); cfg = readConfig(ProjectConfig.PROJECT_CONFIG, baseConfig);
diff --git a/java/com/google/gerrit/pgm/init/api/BUILD b/java/com/google/gerrit/pgm/init/api/BUILD index 693d319..733b9e3 100644 --- a/java/com/google/gerrit/pgm/init/api/BUILD +++ b/java/com/google/gerrit/pgm/init/api/BUILD
@@ -11,6 +11,7 @@ "//java/com/google/gerrit/server", "//lib:guava", "//lib:jgit", + "//lib/errorprone:annotations", "//lib/flogger:api", "//lib/guice", "//lib/guice:guice-assistedinject",
diff --git a/java/com/google/gerrit/pgm/init/api/ConsoleUI.java b/java/com/google/gerrit/pgm/init/api/ConsoleUI.java index ea39a44..dffdde7 100644 --- a/java/com/google/gerrit/pgm/init/api/ConsoleUI.java +++ b/java/com/google/gerrit/pgm/init/api/ConsoleUI.java
@@ -14,6 +14,8 @@ package com.google.gerrit.pgm.init.api; +import com.google.errorprone.annotations.FormatMethod; +import com.google.errorprone.annotations.FormatString; import com.google.gerrit.common.Die; import java.io.Console; import java.util.EnumSet; @@ -37,7 +39,7 @@ return new Die("aborted by user"); } - /** @return true if this is a batch UI that has no user interaction. */ + /** Returns true if this is a batch UI that has no user interaction. */ public abstract boolean isBatch(); /** Display a header message before a series of prompts. */ @@ -75,6 +77,7 @@ public abstract String password(String fmt, Object... args); /** Display an error message on the system stderr. */ + @FormatMethod public void error(String format, Object... args) { System.err.println(String.format(format, args)); System.err.flush(); @@ -97,6 +100,7 @@ } @Override + @FormatMethod public boolean yesno(Boolean def, String fmt, Object... args) { final String prompt = String.format(fmt, args); for (; ; ) { @@ -135,7 +139,8 @@ } @Override - public String readString(String def, String fmt, Object... args) { + @FormatMethod + public String readString(String def, @FormatString String fmt, Object... args) { final String prompt = String.format(fmt, args); String r; if (def != null) { @@ -154,7 +159,9 @@ } @Override - public String readString(String def, Set<String> allowedValues, String fmt, Object... args) { + @FormatMethod + public String readString( + String def, Set<String> allowedValues, @FormatString String fmt, Object... args) { for (; ; ) { String r = readString(def, fmt, args); if (allowedValues.contains(r.toLowerCase())) { @@ -171,6 +178,7 @@ } @Override + @FormatMethod public String password(String fmt, Object... args) { final String prompt = String.format(fmt, args); for (; ; ) { @@ -195,6 +203,7 @@ } @Override + @FormatMethod public <T extends Enum<?>, A extends EnumSet<? extends T>> T readEnum( T def, A options, String fmt, Object... args) { final String prompt = String.format(fmt, args);
diff --git a/java/com/google/gerrit/pgm/init/api/GitRepositoryManagerOnInit.java b/java/com/google/gerrit/pgm/init/api/GitRepositoryManagerOnInit.java index a937c4b..8e69eb9 100644 --- a/java/com/google/gerrit/pgm/init/api/GitRepositoryManagerOnInit.java +++ b/java/com/google/gerrit/pgm/init/api/GitRepositoryManagerOnInit.java
@@ -15,6 +15,7 @@ package com.google.gerrit.pgm.init.api; import com.google.gerrit.entities.Project; +import com.google.gerrit.entities.Project.NameKey; import com.google.gerrit.server.config.SitePaths; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.inject.Inject; @@ -41,6 +42,18 @@ } @Override + public Status getRepositoryStatus(NameKey name) { + try { + openRepository(name); + } catch (RepositoryNotFoundException e) { + return Status.NON_EXISTENT; + } catch (IOException e) { + return Status.UNAVAILABLE; + } + return Status.ACTIVE; + } + + @Override public Repository openRepository(Project.NameKey name) throws RepositoryNotFoundException, IOException { return new FileRepository(getPath(name));
diff --git a/java/com/google/gerrit/pgm/init/index/IndexModuleOnInit.java b/java/com/google/gerrit/pgm/init/index/IndexModuleOnInit.java index 80de1e5..d1d0729 100644 --- a/java/com/google/gerrit/pgm/init/index/IndexModuleOnInit.java +++ b/java/com/google/gerrit/pgm/init/index/IndexModuleOnInit.java
@@ -50,8 +50,7 @@ @Override protected void configure() { - // The AccountIndex implementations (LuceneAccountIndex and - // ElasticAccountIndex) need AccountCache only for reading from the index. + // The LuceneAccountIndex needs AccountCache only for reading from the index. // On init we only want to write to the index, hence we don't need the // account cache. bind(AccountCache.class).toProvider(Providers.of(null)); @@ -63,8 +62,8 @@ bind(AccountIndexCollection.class); - // The GroupIndex implementations (LuceneGroupIndex and ElasticGroupIndex) - // need GroupCache only for reading from the index. On init we only want to + // The LuceneGroupIndex needs GroupCache only for reading from the index. On init we only want + // to // write to the index, hence we don't need the group cache. bind(GroupCache.class).toProvider(Providers.of(null));
diff --git a/java/com/google/gerrit/pgm/util/BatchProgramModule.java b/java/com/google/gerrit/pgm/util/BatchProgramModule.java index 8fb5663..48392b5 100644 --- a/java/com/google/gerrit/pgm/util/BatchProgramModule.java +++ b/java/com/google/gerrit/pgm/util/BatchProgramModule.java
@@ -28,6 +28,7 @@ import com.google.gerrit.extensions.restapi.RestView; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.IdentifiedUser; +import com.google.gerrit.server.InternalUser; import com.google.gerrit.server.LibModuleLoader; import com.google.gerrit.server.LibModuleType; import com.google.gerrit.server.ModuleOverloader; @@ -39,7 +40,8 @@ import com.google.gerrit.server.account.GroupIncludeCacheImpl; import com.google.gerrit.server.account.Realm; import com.google.gerrit.server.account.ServiceUserClassifierImpl; -import com.google.gerrit.server.account.externalids.ExternalIdModule; +import com.google.gerrit.server.account.externalids.ExternalIdCacheModule; +import com.google.gerrit.server.approval.ApprovalCacheImpl; import com.google.gerrit.server.cache.CacheRemovalListener; import com.google.gerrit.server.cache.h2.H2CacheModule; import com.google.gerrit.server.cache.mem.DefaultMemoryCacheModule; @@ -52,7 +54,7 @@ import com.google.gerrit.server.config.CanonicalWebUrl; import com.google.gerrit.server.config.CanonicalWebUrlProvider; import com.google.gerrit.server.config.DefaultPreferencesCacheImpl; -import com.google.gerrit.server.config.DefaultUrlFormatter; +import com.google.gerrit.server.config.DefaultUrlFormatter.DefaultUrlFormatterModule; import com.google.gerrit.server.config.EnablePeerIPInReflogRecord; import com.google.gerrit.server.config.EnablePeerIPInReflogRecordProvider; import com.google.gerrit.server.config.GerritServerConfig; @@ -63,13 +65,14 @@ import com.google.gerrit.server.extensions.events.GitReferenceUpdated; import com.google.gerrit.server.extensions.events.RevisionCreated; import com.google.gerrit.server.extensions.events.WorkInProgressStateChanged; +import com.google.gerrit.server.git.ChangesByProjectCache; import com.google.gerrit.server.git.MergeUtil; import com.google.gerrit.server.git.PureRevertCache; -import com.google.gerrit.server.git.SearchingChangeCacheImpl; import com.google.gerrit.server.git.TagCache; import com.google.gerrit.server.mail.send.ReplacePatchSetSender; import com.google.gerrit.server.notedb.NoteDbModule; import com.google.gerrit.server.patch.DiffExecutorModule; +import com.google.gerrit.server.patch.DiffOperationsImpl; import com.google.gerrit.server.patch.PatchListCacheImpl; import com.google.gerrit.server.permissions.DefaultPermissionBackendModule; import com.google.gerrit.server.permissions.SectionSortCache; @@ -78,12 +81,16 @@ import com.google.gerrit.server.project.CommitResource; import com.google.gerrit.server.project.ProjectCacheImpl; import com.google.gerrit.server.project.ProjectState; +import com.google.gerrit.server.project.SubmitRequirementsEvaluatorImpl; import com.google.gerrit.server.project.SubmitRuleEvaluator; +import com.google.gerrit.server.query.approval.ApprovalModule; import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.query.change.ChangeIsVisibleToPredicate; +import com.google.gerrit.server.query.change.ChangeQueryBuilder; +import com.google.gerrit.server.query.change.ConflictsCacheImpl; import com.google.gerrit.server.restapi.group.GroupModule; -import com.google.gerrit.server.rules.DefaultSubmitRule; -import com.google.gerrit.server.rules.IgnoreSelfApprovalRule; +import com.google.gerrit.server.rules.DefaultSubmitRule.DefaultSubmitRuleModule; +import com.google.gerrit.server.rules.IgnoreSelfApprovalRule.IgnoreSelfApprovalRuleModule; import com.google.gerrit.server.rules.PrologModule; import com.google.gerrit.server.rules.SubmitRule; import com.google.gerrit.server.update.BatchUpdate; @@ -115,7 +122,8 @@ modules.add(new SysExecutorModule()); modules.add(BatchUpdate.module()); modules.add(PatchListCacheImpl.module()); - modules.add(new DefaultUrlFormatter.Module()); + modules.add(new DefaultUrlFormatterModule()); + modules.add(DiffOperationsImpl.module()); // There is the concept of LifecycleModule, in Gerrit's own extension to Guice, which has these: // listener().to(SomeClassImplementingLifecycleListener.class); @@ -145,15 +153,11 @@ bind(Realm.class).to(FakeRealm.class); bind(IdentifiedUser.class).toProvider(Providers.of(null)); bind(ReplacePatchSetSender.Factory.class).toProvider(Providers.of(null)); - bind(CurrentUser.class).to(IdentifiedUser.class); + bind(CurrentUser.class).to(InternalUser.class); factory(MergeUtil.Factory.class); factory(PatchSetInserter.Factory.class); factory(RebaseChangeOp.Factory.class); - // As Reindex is a batch program, don't assume the index is available for - // the change cache. - bind(SearchingChangeCacheImpl.class).toProvider(Providers.of(null)); - bind(new TypeLiteral<ImmutableSet<GroupReference>>() {}) .annotatedWith(AdministrateServerGroups.class) .toInstance(ImmutableSet.of()); @@ -165,13 +169,17 @@ .toInstance(Collections.emptySet()); modules.add(new BatchGitModule()); + modules.add( + new ChangesByProjectCache.Module(ChangesByProjectCache.UseIndex.FALSE, getConfig())); modules.add(new DefaultPermissionBackendModule()); modules.add(new DefaultMemoryCacheModule()); modules.add(new H2CacheModule()); - modules.add(new ExternalIdModule()); + modules.add(new ExternalIdCacheModule()); modules.add(new GroupModule()); modules.add(new NoteDbModule()); modules.add(AccountCacheImpl.module()); + modules.add(ApprovalCacheImpl.module()); + modules.add(ConflictsCacheImpl.module()); modules.add(DefaultPreferencesCacheImpl.module()); modules.add(GroupCacheImpl.module()); modules.add(GroupIncludeCacheImpl.module()); @@ -182,17 +190,23 @@ modules.add(ServiceUserClassifierImpl.module()); modules.add(TagCache.module()); modules.add(PureRevertCache.module()); + modules.add(new ApprovalModule()); + modules.add(SubmitRequirementsEvaluatorImpl.module()); factory(CapabilityCollection.Factory.class); factory(ChangeData.AssistedFactory.class); factory(ChangeIsVisibleToPredicate.Factory.class); factory(ProjectState.Factory.class); + DynamicMap.mapOf(binder(), ChangeQueryBuilder.ChangeOperatorFactory.class); + DynamicMap.mapOf(binder(), ChangeQueryBuilder.ChangeHasOperandFactory.class); + DynamicMap.mapOf(binder(), ChangeQueryBuilder.ChangeIsOperandFactory.class); + // Submit rules DynamicSet.setOf(binder(), SubmitRule.class); factory(SubmitRuleEvaluator.Factory.class); modules.add(new PrologModule(getConfig())); - modules.add(new DefaultSubmitRule.Module()); - modules.add(new IgnoreSelfApprovalRule.Module()); + modules.add(new DefaultSubmitRuleModule()); + modules.add(new IgnoreSelfApprovalRuleModule()); bind(ChangeJson.Factory.class).toProvider(Providers.of(null)); bind(EventUtil.class).toProvider(Providers.of(null)); @@ -202,7 +216,8 @@ bind(AccountVisibility.class).toProvider(AccountVisibilityProvider.class).in(SINGLETON); ModuleOverloader.override( - modules, LibModuleLoader.loadModules(parentInjector, LibModuleType.SYS_BATCH_MODULE)) + modules, + LibModuleLoader.loadModules(parentInjector, LibModuleType.SYS_BATCH_MODULE_TYPE)) .stream() .forEach(this::install); }
diff --git a/java/com/google/gerrit/pgm/util/LogFileCompressor.java b/java/com/google/gerrit/pgm/util/LogFileCompressor.java index 413e0fa..5e49312 100644 --- a/java/com/google/gerrit/pgm/util/LogFileCompressor.java +++ b/java/com/google/gerrit/pgm/util/LogFileCompressor.java
@@ -42,7 +42,7 @@ public class LogFileCompressor implements Runnable { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - public static class Module extends LifecycleModule { + public static class LogFileCompressorModule extends LifecycleModule { @Override protected void configure() { listener().to(Lifecycle.class);
diff --git a/java/com/google/gerrit/pgm/util/SiteProgram.java b/java/com/google/gerrit/pgm/util/SiteProgram.java index c3be0a4..ff0b31e 100644 --- a/java/com/google/gerrit/pgm/util/SiteProgram.java +++ b/java/com/google/gerrit/pgm/util/SiteProgram.java
@@ -28,7 +28,7 @@ import com.google.gerrit.server.config.GerritRuntime; import com.google.gerrit.server.config.GerritServerConfigModule; import com.google.gerrit.server.config.SitePath; -import com.google.gerrit.server.experiments.ConfigExperimentFeatures; +import com.google.gerrit.server.experiments.ConfigExperimentFeatures.ConfigExperimentFeaturesModule; import com.google.gerrit.server.git.GitRepositoryManagerModule; import com.google.gerrit.server.git.SystemReaderInstaller; import com.google.gerrit.server.schema.SchemaModule; @@ -52,7 +52,7 @@ name = "--site-path", aliases = {"-d"}, usage = "Local directory containing site data") - private void setSitePath(String path) { + void setSitePath(String path) { sitePath = Paths.get(path).normalize(); } @@ -64,7 +64,7 @@ this.sitePath = sitePath.normalize(); } - /** @return the site path specified on the command line. */ + /** Returns the site path specified on the command line. */ protected Path getSitePath() { return sitePath; } @@ -76,12 +76,12 @@ } } - /** @return provides database connectivity and site path. */ + /** Provides database connectivity and site path. */ protected Injector createDbInjector() { return createDbInjector(false); } - /** @return provides database connectivity and site path. */ + /** Provides database connectivity and site path. */ protected Injector createDbInjector(boolean enableMetrics) { List<Module> modules = new ArrayList<>(); @@ -131,13 +131,13 @@ modules.add(cfgInjector.getInstance(GitRepositoryManagerModule.class)); // The only implementation of experiments is available in all programs that can use // gerrit.config - modules.add(new ConfigExperimentFeatures.Module()); + modules.add(new ConfigExperimentFeaturesModule()); try { return Guice.createInjector( PRODUCTION, ModuleOverloader.override( - modules, LibModuleLoader.loadModules(cfgInjector, LibModuleType.DB_MODULE))); + modules, LibModuleLoader.loadModules(cfgInjector, LibModuleType.DB_MODULE_TYPE))); } catch (CreationException ce) { Message first = ce.getErrorMessages().iterator().next(); Throwable why = first.getCause();
diff --git a/java/com/google/gerrit/server/BUILD b/java/com/google/gerrit/server/BUILD index 404906d..7080417 100644 --- a/java/com/google/gerrit/server/BUILD +++ b/java/com/google/gerrit/server/BUILD
@@ -55,6 +55,7 @@ "//java/com/google/gerrit/proto", "//java/com/google/gerrit/server/cache/serialize", "//java/com/google/gerrit/server/cache/serialize/entities", + "//java/com/google/gerrit/server/cancellation", "//java/com/google/gerrit/server/data", "//java/com/google/gerrit/server/git/receive:ref_cache", "//java/com/google/gerrit/server/ioutil", @@ -131,6 +132,7 @@ "//lib/ow2:ow2-asm-util", "//lib/prolog:runtime", "//proto:cache_java_proto", + "//proto:entities_java_proto", ], )
diff --git a/java/com/google/gerrit/server/CancellationMetrics.java b/java/com/google/gerrit/server/CancellationMetrics.java new file mode 100644 index 0000000..f534ccb --- /dev/null +++ b/java/com/google/gerrit/server/CancellationMetrics.java
@@ -0,0 +1,117 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server; + +import com.google.gerrit.common.UsedAt; +import com.google.gerrit.metrics.Counter1; +import com.google.gerrit.metrics.Counter3; +import com.google.gerrit.metrics.Description; +import com.google.gerrit.metrics.Field; +import com.google.gerrit.metrics.MetricMaker; +import com.google.gerrit.server.cancellation.RequestStateProvider; +import com.google.gerrit.server.logging.Metadata; +import com.google.inject.Inject; +import com.google.inject.Singleton; + +/** Metrics for request cancellations and deadlines. */ +@Singleton +public class CancellationMetrics { + private final Counter3<String, String, String> advisoryDeadlineCount; + private final Counter3<String, String, RequestStateProvider.Reason> cancelledRequestsCount; + private final Counter1<String> receiveTimeoutCount; + + @Inject + CancellationMetrics(MetricMaker metrics) { + this.advisoryDeadlineCount = + metrics.newCounter( + "cancellation/advisory_deadline_count", + new Description("Exceeded advisory deadlines by request").setRate(), + Field.ofString("request_type", Metadata.Builder::requestType) + .description("The type of the request to which the advisory deadline applied.") + .build(), + Field.ofString("request_uri", Metadata.Builder::restViewName) + .description( + "The redacted URI of the request to which the advisory deadline applied" + + " (only set for request_type = REST).") + .build(), + Field.ofString("deadline_id", (metadataBuilder, resolveAllUsers) -> {}) + .description("The ID of the advisory deadline.") + .build()); + + this.cancelledRequestsCount = + metrics.newCounter( + "cancellation/cancelled_requests_count", + new Description("Number of request cancellations by request").setRate(), + Field.ofString("request_type", Metadata.Builder::requestType) + .description("The type of the request that was cancelled.") + .build(), + Field.ofString("request_uri", Metadata.Builder::restViewName) + .description( + "The redacted URI of the request that was cancelled" + + " (only set for request_type = REST).") + .build(), + Field.ofEnum( + RequestStateProvider.Reason.class, + "cancellation_reason", + Metadata.Builder::cancellationReason) + .description("The reason why the request was cancelled.") + .build()); + + this.receiveTimeoutCount = + metrics.newCounter( + "cancellation/receive_timeout_count", + new Description( + "Number of requests that are cancelled because receive.timout is exceeded") + .setRate(), + Field.ofString("cancellation_type", (metadataBuilder, resolveAllUsers) -> {}) + .description("The cancellation type (graceful or forceful).") + .build()); + } + + public void countAdvisoryDeadline(RequestInfo requestInfo, String deadlineId) { + advisoryDeadlineCount.increment( + requestInfo.requestType(), requestInfo.redactedRequestUri().orElse(""), deadlineId); + } + + public void countCancelledRequest( + RequestInfo requestInfo, RequestStateProvider.Reason cancellationReason) { + cancelledRequestsCount.increment( + requestInfo.requestType(), requestInfo.redactedRequestUri().orElse(""), cancellationReason); + } + + public void countCancelledRequest( + RequestInfo.RequestType requestType, + String requestUri, + RequestStateProvider.Reason cancellationReason) { + cancelledRequestsCount.increment( + requestType.name(), RequestInfo.redactRequestUri(requestUri), cancellationReason); + } + + @UsedAt(UsedAt.Project.GOOGLE) + public void countCancelledRequest( + String requestType, + String redactedRequestUri, + RequestStateProvider.Reason cancellationReason) { + cancelledRequestsCount.increment(requestType, redactedRequestUri, cancellationReason); + } + + public void countGracefulReceiveTimeout() { + receiveTimeoutCount.increment("graceful"); + } + + public void countForcefulReceiveTimeout() { + receiveTimeoutCount.increment("forceful"); + } +}
diff --git a/java/com/google/gerrit/server/ChangeMessagesUtil.java b/java/com/google/gerrit/server/ChangeMessagesUtil.java index 32edadb..8366b09 100644 --- a/java/com/google/gerrit/server/ChangeMessagesUtil.java +++ b/java/com/google/gerrit/server/ChangeMessagesUtil.java
@@ -14,8 +14,7 @@ package com.google.gerrit.server; -import static com.google.common.base.Preconditions.checkState; -import static java.util.Objects.requireNonNull; +import static com.google.common.collect.ImmutableSet.toImmutableSet; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; @@ -26,12 +25,12 @@ import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.notedb.ChangeUpdate; import com.google.gerrit.server.update.ChangeContext; +import com.google.gerrit.server.util.AccountTemplateUtil; +import com.google.inject.Inject; import com.google.inject.Singleton; -import java.sql.Timestamp; import java.util.List; -import java.util.Objects; -/** Utility functions to manipulate ChangeMessages. */ +/** Utility functions to manipulate {@link ChangeMessage}. */ @Singleton public class ChangeMessagesUtil { public static final String AUTOGENERATED_TAG_PREFIX = "autogenerated:"; @@ -68,41 +67,50 @@ public static final String TAG_UPLOADED_WIP_PATCH_SET = AUTOGENERATED_BY_GERRIT_TAG_PREFIX + "newWipPatchSet"; - public static ChangeMessage newMessage(ChangeContext ctx, String body, @Nullable String tag) { - return newMessage(ctx.getChange().currentPatchSetId(), ctx.getUser(), ctx.getWhen(), body, tag); + private final AccountTemplateUtil accountTemplateUtil; + + @Inject + ChangeMessagesUtil(AccountTemplateUtil accountTemplateUtil) { + this.accountTemplateUtil = accountTemplateUtil; } - public static ChangeMessage newMessage( - PatchSet.Id psId, CurrentUser user, Timestamp when, String body, @Nullable String tag) { - requireNonNull(psId); - Account.Id accountId = user.isInternalUser() ? null : user.getAccountId(); - ChangeMessage m = - new ChangeMessage( - ChangeMessage.key(psId.changeId(), ChangeUtil.messageUuid()), accountId, when, psId); - m.setMessage(body); - m.setTag(tag); - user.updateRealAccountId(m::setRealAuthor); - return m; + /** + * Sets {@code messageTemplate} and {@code tag}, that should be applied by the {@code update}. + * + * <p>The {@code messageTemplate} is persisted in storage and should not contain user identifiable + * information. See {@link ChangeMessage}. + * + * @param update update that sets {@code messageTemplate}. + * @param messageTemplate message in template form, that should be applied by the update. + * @param tag tag that should be applied by the update. + * @return message built from {@code messageTemplate}. Templates are replaced, so it might contain + * user identifiable information. + */ + public String setChangeMessage( + ChangeUpdate update, String messageTemplate, @Nullable String tag) { + update.setChangeMessage(messageTemplate); + update.setTag(tag); + return accountTemplateUtil.replaceTemplates(messageTemplate); + } + + /** See {@link #setChangeMessage(ChangeUpdate, String, String)}. */ + public String setChangeMessage(ChangeContext ctx, String messageTemplate, @Nullable String tag) { + return setChangeMessage( + ctx.getUpdate(ctx.getChange().currentPatchSetId()), messageTemplate, tag); } public static String uploadedPatchSetTag(boolean workInProgress) { return workInProgress ? TAG_UPLOADED_WIP_PATCH_SET : TAG_UPLOADED_PATCH_SET; } + /** + * Returns {@link ChangeMessage}s from {@link ChangeNotes}, loads {@link ChangeNotes} from data + * storage (cache or NoteDB), if it was not loaded yet. + */ public List<ChangeMessage> byChange(ChangeNotes notes) { return notes.load().getChangeMessages(); } - public void addChangeMessage(ChangeUpdate update, ChangeMessage changeMessage) { - checkState( - Objects.equals(changeMessage.getAuthor(), update.getNullableAccountId()), - "cannot store change message by %s in update by %s", - changeMessage.getAuthor(), - update.getNullableAccountId()); - update.setChangeMessage(changeMessage.getMessage()); - update.setTag(changeMessage.getTag()); - } - /** * Replace an existing change message with the provided new message. * @@ -119,8 +127,9 @@ } /** + * Determines whether the tag starts with the autogenerated prefix + * * @param tag value of a tag, or null. - * @return whether the tag starts with the autogenerated prefix. */ public static boolean isAutogenerated(@Nullable String tag) { return tag != null && tag.startsWith(AUTOGENERATED_TAG_PREFIX); @@ -144,6 +153,25 @@ if (realAuthor != null) { cmi.realAuthor = accountLoader.get(realAuthor); } + cmi.accountsInMessage = + AccountTemplateUtil.parseTemplates(message.getMessage()).stream() + .map(accountLoader::get) + .collect(toImmutableSet()); return cmi; } + + /** + * {@link ChangeMessage} is served in template form to {@link + * com.google.gerrit.extensions.api.changes.ChangeApi}. Serve message with replaced templates to + * the legacy {@link com.google.gerrit.extensions.api.changes.ChangeMessageApi} endpoints. + * TODO(mariasavtchouk): remove this, after {@link + * com.google.gerrit.extensions.api.changes.ChangeMessageApi} is deprecated (gate with + * experiment). + */ + public ChangeMessageInfo createChangeMessageInfoWithReplacedTemplates( + ChangeMessage message, AccountLoader accountLoader) { + ChangeMessageInfo changeMessageInfo = createChangeMessageInfo(message, accountLoader); + changeMessageInfo.message = accountTemplateUtil.replaceTemplates(message.getMessage()); + return changeMessageInfo; + } }
diff --git a/java/com/google/gerrit/server/ChangeUtil.java b/java/com/google/gerrit/server/ChangeUtil.java index 46e8d33..d9edf42 100644 --- a/java/com/google/gerrit/server/ChangeUtil.java +++ b/java/com/google/gerrit/server/ChangeUtil.java
@@ -53,7 +53,7 @@ public static final Ordering<PatchSet> PS_ID_ORDER = Ordering.from(comparingInt(PatchSet::number)); - /** @return a new unique identifier for change message entities. */ + /** Returns a new unique identifier for change message entities. */ public static String messageUuid() { byte[] buf = new byte[8]; UUID_RANDOM.nextBytes(buf);
diff --git a/java/com/google/gerrit/server/CommentsUtil.java b/java/com/google/gerrit/server/CommentsUtil.java index b752791..ba9f6d6 100644 --- a/java/com/google/gerrit/server/CommentsUtil.java +++ b/java/com/google/gerrit/server/CommentsUtil.java
@@ -42,8 +42,9 @@ import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.notedb.ChangeUpdate; -import com.google.gerrit.server.patch.PatchListCache; -import com.google.gerrit.server.patch.PatchListNotAvailableException; +import com.google.gerrit.server.patch.DiffNotAvailableException; +import com.google.gerrit.server.patch.DiffOperations; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import com.google.gerrit.server.update.ChangeContext; import com.google.inject.Inject; import com.google.inject.Singleton; @@ -52,6 +53,7 @@ import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.Map; import java.util.Optional; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Ref; @@ -108,21 +110,21 @@ private static final Ordering<Comparable<?>> NULLS_FIRST = Ordering.natural().nullsFirst(); + private final DiffOperations diffOperations; private final GitRepositoryManager repoManager; private final AllUsersName allUsers; private final String serverId; - private final PatchListCache patchListCache; @Inject CommentsUtil( + DiffOperations diffOperations, GitRepositoryManager repoManager, AllUsersName allUsers, - @GerritServerId String serverId, - PatchListCache patchListCache) { + @GerritServerId String serverId) { + this.diffOperations = diffOperations; this.repoManager = repoManager; this.allUsers = allUsers; this.serverId = serverId; - this.patchListCache = patchListCache; } public HumanComment newHumanComment( @@ -411,7 +413,7 @@ int parentNumber = Math.abs(side); return resolveParentCommit(change.getProject(), patchset, parentNumber); } - return Optional.of(resolveAutoMergeCommit(change, patchset)); + return Optional.ofNullable(resolveAutoMergeCommit(change, patchset)); } return Optional.of(patchset.commitId()); } @@ -429,12 +431,18 @@ } } + @Nullable private ObjectId resolveAutoMergeCommit(Change change, PatchSet patchset) { try { // TODO(ghareeb): Adjust after the auto-merge code was moved out of the diff caches. Also // unignore the test in PortedCommentsIT. - return patchListCache.getOldId(change, patchset, null); - } catch (PatchListNotAvailableException e) { + Map<String, FileDiffOutput> modifiedFiles = + diffOperations.listModifiedFilesAgainstParent( + change.getProject(), patchset.commitId(), /* parentNum= */ 0); + return modifiedFiles.isEmpty() + ? null + : modifiedFiles.values().iterator().next().oldCommitId(); + } catch (DiffNotAvailableException e) { throw new StorageException(e); } } @@ -442,8 +450,6 @@ /** * Get NoteDb draft refs for a change. * - * <p>Works if NoteDb is not enabled, but the results are not meaningful. - * * <p>This is just a simple ref scan, so the results may potentially include refs for zombie draft * comments. A zombie draft is one which has been published but the write to delete the draft ref * from All-Users failed.
diff --git a/java/com/google/gerrit/server/CurrentUser.java b/java/com/google/gerrit/server/CurrentUser.java index 7012944..0b5600d 100644 --- a/java/com/google/gerrit/server/CurrentUser.java +++ b/java/com/google/gerrit/server/CurrentUser.java
@@ -103,7 +103,7 @@ return Optional.empty(); } - /** @return unique name of the user for logging, never {@code null} */ + /** Returns unique name of the user for logging, never {@code null} */ public String getLoggableName() { return getUserName().orElseGet(() -> getClass().getSimpleName()); }
diff --git a/java/com/google/gerrit/server/DeadlineChecker.java b/java/com/google/gerrit/server/DeadlineChecker.java new file mode 100644 index 0000000..f41b1e3 --- /dev/null +++ b/java/com/google/gerrit/server/DeadlineChecker.java
@@ -0,0 +1,336 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server; + +import static java.util.Comparator.comparing; +import static java.util.Objects.requireNonNull; +import static java.util.concurrent.TimeUnit.MILLISECONDS; +import static java.util.concurrent.TimeUnit.MINUTES; +import static java.util.concurrent.TimeUnit.NANOSECONDS; +import static java.util.stream.Collectors.toMap; + +import com.google.auto.value.AutoValue; +import com.google.common.base.Strings; +import com.google.common.collect.ImmutableList; +import com.google.common.flogger.FluentLogger; +import com.google.common.primitives.Longs; +import com.google.gerrit.common.Nullable; +import com.google.gerrit.server.cancellation.RequestStateProvider; +import com.google.gerrit.server.config.ConfigUtil; +import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.util.time.TimeUtil; +import com.google.inject.assistedinject.Assisted; +import com.google.inject.assistedinject.AssistedInject; +import java.util.HashSet; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.concurrent.TimeUnit; +import java.util.function.Function; +import org.eclipse.jgit.lib.Config; + +/** + * {@link RequestStateProvider} that checks whether a client provided deadline is exceeded. + * + * <p>Should be registered at most once per request. + */ +public class DeadlineChecker implements RequestStateProvider { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + private static String SECTION_DEADLINE = "deadline"; + + /** + * Creates a formatter that formats a timeout as {@code <TIMEOUT_NAME>=<TIMEOUT><TIME_UNIT>}. + * + * <p>If the timeout is 1 minute or greater, minutes is used as a time unit. Otherwise + * milliseconds is just as a time unit. + * + * @param timeoutName the name of the timeout + */ + public static Function<Long, String> getTimeoutFormatter(String timeoutName) { + requireNonNull(timeoutName, "timeoutName"); + return timeout -> { + String formattedTimeout = MILLISECONDS.convert(timeout, NANOSECONDS) + "ms"; + long timeoutInMinutes = MINUTES.convert(timeout, NANOSECONDS); + if (timeoutInMinutes > 0) { + formattedTimeout = timeoutInMinutes + "m"; + } + return String.format("%s=%s", timeoutName, formattedTimeout); + }; + } + + public interface Factory { + DeadlineChecker create(RequestInfo requestInfo, @Nullable String clientProvidedTimeoutValue) + throws InvalidDeadlineException; + + DeadlineChecker create( + long start, RequestInfo requestInfo, @Nullable String clientProvidedTimeoutValue) + throws InvalidDeadlineException; + } + + private final CancellationMetrics cancellationsMetrics; + + /** The start time of the request in nanoseconds. */ + private final long start; + + private final RequestInfo requestInfo; + private final RequestStateProvider.Reason cancellationReason; + private final String timeoutName; + + /** + * Timeout in nanoseconds after which the request should be aborted. + * + * <p>{@code 0} means that no timeout should be applied. + */ + private final long timeout; + + /** + * The deadline in nanoseconds after which a request should be aborted. + * + * <p>deadline = start + timeout + * + * <p>{@link Optional#empty()} if no timeout was set. + */ + private final Optional<Long> deadline; + + /** + * Matching server side deadlines that have been configured as as advisory. + * + * <p>If any of these deadlines is exceeded the request is not be aborted. Instead the {@code + * cancellation/advisory_deadline_count} metric is incremented and a log is written. + */ + private final Map<String, ServerDeadline> advisoryDeadlines; + + /** + * Creates a {@link DeadlineChecker}. + * + * <p>No deadline is enforced if the client provided deadline value is {@code null} or {@code 0}. + * + * @param requestInfo the request that was received from a user + * @param clientProvidedTimeoutValue the timeout value that the client provided, must represent a + * numerical time unit (e.g. "5m"), if no time unit is specified milliseconds are assumed, may + * be {@code null} + * @throws InvalidDeadlineException thrown if the client provided deadline value cannot be parsed, + * e.g. because it uses a bad time unit + */ + @AssistedInject + DeadlineChecker( + @GerritServerConfig Config serverConfig, + CancellationMetrics cancellationsMetrics, + @Assisted RequestInfo requestInfo, + @Assisted @Nullable String clientProvidedTimeoutValue) + throws InvalidDeadlineException { + this( + serverConfig, + cancellationsMetrics, + TimeUtil.nowNanos(), + requestInfo, + clientProvidedTimeoutValue); + } + + /** + * Creates a {@link DeadlineChecker}. + * + * <p>No deadline is enforced if the client provided deadline value is {@code null} or {@code 0}. + * + * @param start the start time of the request in nanoseconds + * @param requestInfo the request that was received from a user + * @param clientProvidedTimeoutValue the timeout value that the client provided, must represent a + * numerical time unit (e.g. "5m"), if no time unit is specified milliseconds are assumed, may + * be {@code null} + * @throws InvalidDeadlineException thrown if the client provided deadline value cannot be parsed, + * e.g. because it uses a bad time unit + */ + @AssistedInject + DeadlineChecker( + @GerritServerConfig Config serverConfig, + CancellationMetrics cancellationsMetrics, + @Assisted long start, + @Assisted RequestInfo requestInfo, + @Assisted @Nullable String clientProvidedTimeoutValue) + throws InvalidDeadlineException { + this.cancellationsMetrics = cancellationsMetrics; + this.start = start; + this.requestInfo = requestInfo; + + ImmutableList<RequestConfig> deadlineConfigs = + RequestConfig.parseConfigs(serverConfig, SECTION_DEADLINE); + advisoryDeadlines = getAdvisoryDeadlines(deadlineConfigs, requestInfo); + Optional<ServerDeadline> serverSideDeadline = + getServerSideDeadline(deadlineConfigs, requestInfo); + Optional<Long> clientedProvidedTimeout = parseTimeout(clientProvidedTimeoutValue); + logDeadlines(serverSideDeadline, clientedProvidedTimeout); + + this.cancellationReason = + clientedProvidedTimeout.isPresent() + ? RequestStateProvider.Reason.CLIENT_PROVIDED_DEADLINE_EXCEEDED + : RequestStateProvider.Reason.SERVER_DEADLINE_EXCEEDED; + this.timeoutName = + clientedProvidedTimeout + .map(clientTimeout -> "client.timeout") + .orElse( + serverSideDeadline + .map(serverDeadline -> serverDeadline.id() + ".timeout") + .orElse("timeout")); + this.timeout = + clientedProvidedTimeout.orElse(serverSideDeadline.map(ServerDeadline::timeout).orElse(0L)); + this.deadline = timeout > 0 ? Optional.of(start + timeout) : Optional.empty(); + } + + private void logDeadlines( + Optional<ServerDeadline> serverSideDeadline, Optional<Long> clientedProvidedTimeout) { + if (serverSideDeadline.isPresent()) { + if (clientedProvidedTimeout.isPresent()) { + logger.atFine().log( + "client provided deadline (timeout=%sms) overrides server deadline %s (timeout=%sms)", + TimeUnit.MILLISECONDS.convert(clientedProvidedTimeout.get(), TimeUnit.NANOSECONDS), + serverSideDeadline.get().id(), + TimeUnit.MILLISECONDS.convert( + serverSideDeadline.get().timeout(), TimeUnit.NANOSECONDS)); + } else { + logger.atFine().log( + "applying server deadline %s (timeout = %sms)", + serverSideDeadline.get().id(), + TimeUnit.MILLISECONDS.convert( + serverSideDeadline.get().timeout(), TimeUnit.NANOSECONDS)); + } + } else if (clientedProvidedTimeout.isPresent()) { + logger.atFine().log( + "applying client provided deadline (timeout = %sms)", + TimeUnit.MILLISECONDS.convert(clientedProvidedTimeout.get(), TimeUnit.NANOSECONDS)); + } + } + + private Optional<ServerDeadline> getServerSideDeadline( + ImmutableList<RequestConfig> deadlineConfigs, RequestInfo requestInfo) { + return deadlineConfigs.stream() + .filter(deadlineConfig -> deadlineConfig.matches(requestInfo)) + .map(ServerDeadline::readFrom) + .filter(ServerDeadline::hasTimeout) + .filter(deadline -> !deadline.isAdvisory()) + // let the stricter deadline (the lower deadline) take precedence + .sorted(comparing(ServerDeadline::timeout)) + .findFirst(); + } + + private Map<String, ServerDeadline> getAdvisoryDeadlines( + ImmutableList<RequestConfig> deadlineConfigs, RequestInfo requestInfo) { + return deadlineConfigs.stream() + .filter(deadlineConfig -> deadlineConfig.matches(requestInfo)) + .map(ServerDeadline::readFrom) + .filter(ServerDeadline::hasTimeout) + .filter(ServerDeadline::isAdvisory) + .collect(toMap(ServerDeadline::id, Function.identity())); + } + + @Override + public void checkIfCancelled(OnCancelled onCancelled) { + long now = TimeUtil.nowNanos(); + + Set<String> exceededAdvisoryDeadlines = new HashSet<>(); + advisoryDeadlines + .values() + .forEach( + advisoryDeadline -> { + if (now > start + advisoryDeadline.timeout()) { + exceededAdvisoryDeadlines.add(advisoryDeadline.id()); + logger.atFine().log( + "advisory deadline exceeded (%s)", + getTimeoutFormatter(advisoryDeadline.id() + ".timeout") + .apply(advisoryDeadline.timeout())); + cancellationsMetrics.countAdvisoryDeadline(requestInfo, advisoryDeadline.id()); + } + }); + // remove advisory deadlines which have already been reported as exceeded so that they don't get + // reported again for this request + exceededAdvisoryDeadlines.forEach(advisoryDeadlines::remove); + + if (deadline.isPresent() && now > deadline.get()) { + onCancelled.onCancel(cancellationReason, getTimeoutFormatter(timeoutName).apply(timeout)); + } + } + + /** + * Parses the given timeout value. + * + * @param timeoutValue the timeout that should be parsed, must represent a numerical time unit + * (e.g. "5m"), if no time unit is specified minutes are assumed, may be {@code null} + * @return the parsed timeout in nanoseconds, {@code 0} if no timeout should be applied + * @throws InvalidDeadlineException thrown if the provided deadline value cannot be parsed, e.g. + * because it uses a bad time unit + */ + private static Optional<Long> parseTimeout(@Nullable String timeoutValue) + throws InvalidDeadlineException { + if (Strings.isNullOrEmpty(timeoutValue)) { + return Optional.empty(); + } + + if ("0".equals(timeoutValue)) { + return Optional.of(0L); + } + + // If no time unit was specified, assume milliseconds. + if (Longs.tryParse(timeoutValue) != null) { + throw new InvalidDeadlineException(String.format("Missing time unit: %s", timeoutValue)); + } + + try { + long parsedTimeout = + ConfigUtil.getTimeUnit(timeoutValue, /* defaultValue= */ -1, TimeUnit.NANOSECONDS); + if (parsedTimeout == -1) { + throw new InvalidDeadlineException(String.format("Invalid value: %s", timeoutValue)); + } + return Optional.of(parsedTimeout); + } catch (IllegalArgumentException e) { + throw new InvalidDeadlineException(e.getMessage(), e); + } + } + + @AutoValue + abstract static class ServerDeadline { + abstract String id(); + + abstract long timeout(); + + abstract boolean isAdvisory(); + + boolean hasTimeout() { + return timeout() > 0; + } + + static ServerDeadline readFrom(RequestConfig requestConfig) { + String timeoutValue = + requestConfig.cfg().getString(requestConfig.section(), requestConfig.id(), "timeout"); + boolean isAdvisory = + requestConfig + .cfg() + .getBoolean( + requestConfig.section(), + requestConfig.id(), + "isAdvisory", + /* defaultValue= */ false); + try { + Optional<Long> timeout = parseTimeout(timeoutValue); + return new AutoValue_DeadlineChecker_ServerDeadline( + requestConfig.id(), timeout.orElse(0L), isAdvisory); + } catch (InvalidDeadlineException e) { + logger.atWarning().log( + "Ignoring invalid deadline configuration %s.%s.timeout: %s", + requestConfig.section(), requestConfig.id(), e.getMessage()); + return new AutoValue_DeadlineChecker_ServerDeadline(requestConfig.id(), 0, isAdvisory); + } + } + } +}
diff --git a/java/com/google/gerrit/server/IdentifiedUser.java b/java/com/google/gerrit/server/IdentifiedUser.java index 24ea9d2..eb3e324 100644 --- a/java/com/google/gerrit/server/IdentifiedUser.java +++ b/java/com/google/gerrit/server/IdentifiedUser.java
@@ -343,15 +343,15 @@ } /** - * @return the user's user name; null if one has not been selected/assigned or if the user name is - * empty. + * Returns the user's user name; null if one has not been selected/assigned or if the user name is + * empty. */ @Override public Optional<String> getUserName() { return state().userName(); } - /** @return unique name of the user for logging, never {@code null} */ + /** Returns unique name of the user for logging, never {@code null} */ @Override public String getLoggableName() { return getUserName()
diff --git a/java/com/google/gerrit/server/InvalidDeadlineException.java b/java/com/google/gerrit/server/InvalidDeadlineException.java new file mode 100644 index 0000000..d23b289 --- /dev/null +++ b/java/com/google/gerrit/server/InvalidDeadlineException.java
@@ -0,0 +1,30 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server; + +/** Exception that is thrown is a deadline cannot be parsed. */ +public class InvalidDeadlineException extends Exception { + private static final long serialVersionUID = 1L; + + private static final String MESSAGE_PREFIX = "Invalid deadline. "; + + public InvalidDeadlineException(String message) { + super(MESSAGE_PREFIX + message); + } + + public InvalidDeadlineException(String message, Throwable cause) { + super(MESSAGE_PREFIX + message, cause); + } +}
diff --git a/java/com/google/gerrit/server/LibModuleLoader.java b/java/com/google/gerrit/server/LibModuleLoader.java index 0a6fb9f..f7e04b4 100644 --- a/java/com/google/gerrit/server/LibModuleLoader.java +++ b/java/com/google/gerrit/server/LibModuleLoader.java
@@ -18,12 +18,15 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.index.options.AutoFlush; import com.google.inject.Injector; import com.google.inject.Key; import com.google.inject.Module; import com.google.inject.ProvisionException; +import java.lang.reflect.Method; import java.util.Arrays; import java.util.List; +import java.util.Map; import org.eclipse.jgit.lib.Config; /** Loads configured Guice modules from {@code gerrit.installModule}. */ @@ -37,6 +40,38 @@ .collect(toList()); } + public static List<Module> loadReindexModules( + Injector parent, Map<String, Integer> versions, int threads, boolean replica) { + Config cfg = getConfig(parent); + return Arrays.stream( + cfg.getStringList( + "gerrit", null, "install" + LibModuleType.INDEX_MODULE_TYPE.getConfigKey())) + .map(m -> createReindexModule(m, versions, threads, replica)) + .collect(toList()); + } + + private static Module createReindexModule( + String className, Map<String, Integer> versions, int threads, boolean replica) { + Class<Module> clazz = loadModule(className); + try { + + Method m = + clazz.getMethod( + "singleVersionWithExplicitVersions", + Map.class, + int.class, + boolean.class, + AutoFlush.class); + + Module module = (Module) m.invoke(null, versions, threads, replica, AutoFlush.DISABLED); + logger.atInfo().log("Installed module %s", className); + return module; + } catch (Exception e) { + logger.atSevere().withCause(e).log("Unable to load libModule for %s", className); + throw new IllegalStateException(e); + } + } + private static Config getConfig(Injector i) { return i.getInstance(Key.get(Config.class, GerritServerConfig.class)); }
diff --git a/java/com/google/gerrit/server/LibModuleType.java b/java/com/google/gerrit/server/LibModuleType.java index b9cb196..57206aa 100644 --- a/java/com/google/gerrit/server/LibModuleType.java +++ b/java/com/google/gerrit/server/LibModuleType.java
@@ -18,13 +18,16 @@ public enum LibModuleType { /** Module for the sysInjector. */ - SYS_MODULE("Module"), + SYS_MODULE_TYPE("Module"), /** BatchModule for the sysInjector */ - SYS_BATCH_MODULE("BatchModule"), + SYS_BATCH_MODULE_TYPE("BatchModule"), /** Module for the dbInjector. */ - DB_MODULE("DbModule"); + DB_MODULE_TYPE("DbModule"), + + /** Module for the implementation of the indexing backend. */ + INDEX_MODULE_TYPE("IndexModule"); private final String configKey;
diff --git a/java/com/google/gerrit/server/PatchSetUtil.java b/java/com/google/gerrit/server/PatchSetUtil.java index 005ae3b..326ddf4 100644 --- a/java/com/google/gerrit/server/PatchSetUtil.java +++ b/java/com/google/gerrit/server/PatchSetUtil.java
@@ -29,6 +29,7 @@ import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.restapi.ResourceConflictException; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.notedb.ChangeUpdate; @@ -149,10 +150,11 @@ projectCache.get(notes.getProjectName()).orElseThrow(illegalState(notes.getProjectName())); ApprovalsUtil approvalsUtil = approvalsUtilProvider.get(); - for (PatchSetApproval ap : - approvalsUtil.byPatchSet(notes, change.currentPatchSetId(), null, null)) { - LabelType type = projectState.getLabelTypes(notes).byLabel(ap.label()); - if (type != null && ap.value() == 1 && type.getFunction() == LabelFunction.PATCH_SET_LOCK) { + for (PatchSetApproval ap : approvalsUtil.byPatchSet(notes, change.currentPatchSetId())) { + Optional<LabelType> type = projectState.getLabelTypes(notes).byLabel(ap.label()); + if (type.isPresent() + && ap.value() == 1 + && type.get().getFunction() == LabelFunction.PATCH_SET_LOCK) { return true; } }
diff --git a/java/com/google/gerrit/server/PerformanceMetrics.java b/java/com/google/gerrit/server/PerformanceMetrics.java new file mode 100644 index 0000000..845ed80 --- /dev/null +++ b/java/com/google/gerrit/server/PerformanceMetrics.java
@@ -0,0 +1,91 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server; + +import com.google.gerrit.common.Nullable; +import com.google.gerrit.metrics.Counter3; +import com.google.gerrit.metrics.Description; +import com.google.gerrit.metrics.Field; +import com.google.gerrit.metrics.MetricMaker; +import com.google.gerrit.metrics.Timer3; +import com.google.gerrit.server.logging.Metadata; +import com.google.gerrit.server.logging.PerformanceLogger; +import com.google.gerrit.server.logging.TraceContext; +import com.google.inject.Inject; +import com.google.inject.Singleton; +import java.util.concurrent.TimeUnit; + +/** Performance logger that records the execution times as a metric. */ +@Singleton +public class PerformanceMetrics implements PerformanceLogger { + private static final String OPERATION_LATENCY_METRIC_NAME = "performance/operations"; + private static final String OPERATION_COUNT_METRIC_NAME = "performance/operations_count"; + + public final Timer3<String, String, String> operationsLatency; + public final Counter3<String, String, String> operationsCounter; + + @Inject + PerformanceMetrics(MetricMaker metricMaker) { + Field<String> operationNameField = + Field.ofString( + "operation_name", + (metadataBuilder, fieldValue) -> metadataBuilder.operationName(fieldValue)) + .description("The operation that was performed.") + .build(); + Field<String> requestField = + Field.ofString("request", (metadataBuilder, fieldValue) -> {}) + .description( + "The request for which the operation was performed" + + " (format = '<request-type> <redacted-request-uri>').") + .build(); + Field<String> pluginField = + Field.ofString( + "plugin", (metadataBuilder, fieldValue) -> metadataBuilder.pluginName(fieldValue)) + .description("The name of the plugin that performed the operation.") + .build(); + + this.operationsLatency = + metricMaker + .newTimer( + OPERATION_LATENCY_METRIC_NAME, + new Description("Latency of performing operations") + .setCumulative() + .setUnit(Description.Units.MILLISECONDS), + operationNameField, + requestField, + pluginField) + .suppressLogging(); + this.operationsCounter = + metricMaker.newCounter( + OPERATION_COUNT_METRIC_NAME, + new Description("Number of performed operations").setRate(), + operationNameField, + requestField, + pluginField); + } + + @Override + public void log(String operation, long durationMs) { + log(operation, durationMs, /* metadata= */ null); + } + + @Override + public void log(String operation, long durationMs, @Nullable Metadata metadata) { + String requestTag = TraceContext.getTag(TraceRequestListener.TAG_REQUEST).orElse(""); + String pluginTag = TraceContext.getPluginTag().orElse(""); + operationsLatency.record(operation, requestTag, pluginTag, durationMs, TimeUnit.MILLISECONDS); + operationsCounter.increment(operation, requestTag, pluginTag); + } +}
diff --git a/java/com/google/gerrit/server/PublishCommentsOp.java b/java/com/google/gerrit/server/PublishCommentsOp.java index 358ce92..84afe8c 100644 --- a/java/com/google/gerrit/server/PublishCommentsOp.java +++ b/java/com/google/gerrit/server/PublishCommentsOp.java
@@ -14,8 +14,8 @@ package com.google.gerrit.server; +import com.google.common.base.Strings; import com.google.common.collect.ImmutableMap; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.HumanComment; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; @@ -31,7 +31,7 @@ import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; import com.google.gerrit.server.update.CommentsRejectedException; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RepoView; import com.google.gerrit.server.util.LabelVote; import com.google.inject.Inject; @@ -49,7 +49,6 @@ public class PublishCommentsOp implements BatchUpdateOp { private final PatchSetUtil psUtil; private final ChangeNotes.Factory changeNotesFactory; - private final ChangeMessagesUtil cmUtil; private final CommentAdded commentAdded; private final CommentsUtil commentsUtil; private final EmailReviewComments.Factory email; @@ -57,9 +56,10 @@ private final Project.NameKey projectNameKey; private final PatchSet.Id psId; private final PublishCommentUtil publishCommentUtil; + private final ChangeMessagesUtil changeMessagesUtil; private List<HumanComment> comments = new ArrayList<>(); - private ChangeMessage message; + private String mailMessage; private IdentifiedUser user; public interface Factory { @@ -69,15 +69,14 @@ @Inject public PublishCommentsOp( ChangeNotes.Factory changeNotesFactory, - ChangeMessagesUtil cmUtil, CommentAdded commentAdded, CommentsUtil commentsUtil, EmailReviewComments.Factory email, PatchSetUtil psUtil, PublishCommentUtil publishCommentUtil, + ChangeMessagesUtil changeMessagesUtil, @Assisted PatchSet.Id psId, @Assisted Project.NameKey projectNameKey) { - this.cmUtil = cmUtil; this.changeNotesFactory = changeNotesFactory; this.commentAdded = commentAdded; this.commentsUtil = commentsUtil; @@ -86,6 +85,7 @@ this.publishCommentUtil = publishCommentUtil; this.psUtil = psUtil; this.projectNameKey = projectNameKey; + this.changeMessagesUtil = changeMessagesUtil; } @Override @@ -104,12 +104,12 @@ // We do it this way so that the execution results in 2 different commits in NoteDb ChangeUpdate changeUpdate = ctx.getDistinctUpdate(psId); publishCommentUtil.publish(ctx, changeUpdate, comments, null); - return insertMessage(ctx, changeUpdate); + return insertMessage(changeUpdate); } @Override - public void postUpdate(Context ctx) { - if (message == null || comments.isEmpty()) { + public void postUpdate(PostUpdateContext ctx) { + if (Strings.isNullOrEmpty(mailMessage) || comments.isEmpty()) { return; } ChangeNotes changeNotes = changeNotesFactory.createChecked(projectNameKey, psId.changeId()); @@ -124,20 +124,30 @@ String.format("Repository %s not found", ctx.getProject().get()), ex); } email - .create(notify, changeNotes, ps, user, message, comments, null, labelDelta, repoView) + .create( + notify, + changeNotes, + ps, + user, + mailMessage, + ctx.getWhen(), + comments, + null, + labelDelta, + repoView) .sendAsync(); } commentAdded.fire( - changeNotes.getChange(), + ctx.getChangeData(changeNotes), ps, ctx.getAccount(), - message.getMessage(), + mailMessage, ImmutableMap.of(), ImmutableMap.of(), ctx.getWhen()); } - private boolean insertMessage(ChangeContext ctx, ChangeUpdate changeUpdate) { + private boolean insertMessage(ChangeUpdate changeUpdate) { StringBuilder buf = new StringBuilder(); if (comments.size() == 1) { buf.append("\n\n(1 comment)"); @@ -147,10 +157,9 @@ if (buf.length() == 0) { return false; } - message = - ChangeMessagesUtil.newMessage( - psId, user, ctx.getWhen(), "Patch Set " + psId.get() + ":" + buf, null); - cmUtil.addChangeMessage(changeUpdate, message); + mailMessage = + changeMessagesUtil.setChangeMessage( + changeUpdate, "Patch Set " + psId.get() + ":" + buf, null); return true; } }
diff --git a/java/com/google/gerrit/server/RequestCleanup.java b/java/com/google/gerrit/server/RequestCleanup.java index f405c57..e07d148 100644 --- a/java/com/google/gerrit/server/RequestCleanup.java +++ b/java/com/google/gerrit/server/RequestCleanup.java
@@ -44,7 +44,7 @@ for (Iterator<Runnable> i = cleanup.iterator(); i.hasNext(); ) { try { i.next().run(); - } catch (Throwable err) { + } catch (Exception err) { logger.atSevere().withCause(err).log("Failed to execute per-request cleanup"); } i.remove();
diff --git a/java/com/google/gerrit/server/RequestConfig.java b/java/com/google/gerrit/server/RequestConfig.java new file mode 100644 index 0000000..83cea5b --- /dev/null +++ b/java/com/google/gerrit/server/RequestConfig.java
@@ -0,0 +1,227 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server; + +import com.google.auto.value.AutoValue; +import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableSet; +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.entities.Account; +import java.util.Optional; +import java.util.regex.Pattern; +import java.util.regex.PatternSyntaxException; +import org.eclipse.jgit.errors.ConfigInvalidException; +import org.eclipse.jgit.lib.Config; + +/** + * Represents a configuration on request level that matches requests by request type, URI pattern, + * caller and/or project pattern. + */ +@AutoValue +public abstract class RequestConfig { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + public static ImmutableList<RequestConfig> parseConfigs(Config cfg, String section) { + ImmutableList.Builder<RequestConfig> requestConfigs = ImmutableList.builder(); + + for (String id : cfg.getSubsections(section)) { + try { + RequestConfig.Builder requestConfig = RequestConfig.builder(cfg, section, id); + requestConfig.requestTypes(parseRequestTypes(cfg, section, id)); + requestConfig.requestUriPatterns(parseRequestUriPatterns(cfg, section, id)); + requestConfig.excludedRequestUriPatterns(parseExcludedRequestUriPatterns(cfg, section, id)); + requestConfig.accountIds(parseAccounts(cfg, section, id)); + requestConfig.projectPatterns(parseProjectPatterns(cfg, section, id)); + requestConfigs.add(requestConfig.build()); + } catch (ConfigInvalidException e) { + logger.atWarning().log("Ignoring invalid %s configuration:\n %s", section, e.getMessage()); + } + } + + return requestConfigs.build(); + } + + private static ImmutableSet<String> parseRequestTypes(Config cfg, String section, String id) { + return ImmutableSet.copyOf(cfg.getStringList(section, id, "requestType")); + } + + private static ImmutableSet<Pattern> parseRequestUriPatterns( + Config cfg, String section, String id) throws ConfigInvalidException { + return parsePatterns(cfg, section, id, "requestUriPattern"); + } + + private static ImmutableSet<Pattern> parseExcludedRequestUriPatterns( + Config cfg, String section, String id) throws ConfigInvalidException { + return parsePatterns(cfg, section, id, "excludedRequestUriPattern"); + } + + private static ImmutableSet<Account.Id> parseAccounts(Config cfg, String section, String id) + throws ConfigInvalidException { + ImmutableSet.Builder<Account.Id> accountIds = ImmutableSet.builder(); + String[] accounts = cfg.getStringList(section, id, "account"); + for (String account : accounts) { + Optional<Account.Id> accountId = Account.Id.tryParse(account); + if (!accountId.isPresent()) { + throw new ConfigInvalidException( + String.format( + "Invalid request config ('%s.%s.account = %s'): invalid account ID", + section, id, account)); + } + accountIds.add(accountId.get()); + } + return accountIds.build(); + } + + private static ImmutableSet<Pattern> parseProjectPatterns(Config cfg, String section, String id) + throws ConfigInvalidException { + return parsePatterns(cfg, section, id, "projectPattern"); + } + + private static ImmutableSet<Pattern> parsePatterns( + Config cfg, String section, String id, String name) throws ConfigInvalidException { + ImmutableSet.Builder<Pattern> patterns = ImmutableSet.builder(); + String[] patternRegExs = cfg.getStringList(section, id, name); + for (String patternRegEx : patternRegExs) { + try { + patterns.add(Pattern.compile(patternRegEx)); + } catch (PatternSyntaxException e) { + throw new ConfigInvalidException( + String.format( + "Invalid request config ('%s.%s.%s = %s'): %s", + section, id, name, patternRegEx, e.getMessage())); + } + } + return patterns.build(); + } + + /** the config from which this request config was read */ + abstract Config cfg(); + + /** the section from which this request config was read */ + abstract String section(); + + /** ID of the config, also the subsection from which this request config was read */ + abstract String id(); + + /** request types that should be matched */ + abstract ImmutableSet<String> requestTypes(); + + /** pattern matching request URIs */ + abstract ImmutableSet<Pattern> requestUriPatterns(); + + /** pattern matching request URIs to be excluded */ + abstract ImmutableSet<Pattern> excludedRequestUriPatterns(); + + /** accounts IDs matching calling user */ + abstract ImmutableSet<Account.Id> accountIds(); + + /** pattern matching projects names */ + abstract ImmutableSet<Pattern> projectPatterns(); + + private static Builder builder(Config cfg, String section, String id) { + return new AutoValue_RequestConfig.Builder().cfg(cfg).section(section).id(id); + } + + /** + * Whether this request config matches a given request. + * + * @param requestInfo request info + * @return whether this request config matches + */ + boolean matches(RequestInfo requestInfo) { + // If in the request config request types are set and none of them matches, then the request is + // not matched. + if (!requestTypes().isEmpty() + && requestTypes().stream() + .noneMatch(type -> type.equalsIgnoreCase(requestInfo.requestType()))) { + return false; + } + + // If in the request config request URI patterns are set and none of them matches, then the + // request is not matched. + if (!requestUriPatterns().isEmpty()) { + if (!requestInfo.requestUri().isPresent()) { + // The request has no request URI, hence it cannot match a request URI pattern. + return false; + } + + if (requestUriPatterns().stream() + .noneMatch(p -> p.matcher(requestInfo.requestUri().get()).matches())) { + return false; + } + } + + // If the request URI matches an excluded request URI pattern, then the request is not matched. + if (requestInfo.requestUri().isPresent() + && excludedRequestUriPatterns().stream() + .anyMatch(p -> p.matcher(requestInfo.requestUri().get()).matches())) { + return false; + } + + // If in the request config accounts are set and none of them matches, then the request is not + // matched. + if (!accountIds().isEmpty()) { + try { + if (accountIds().stream() + .noneMatch(id -> id.equals(requestInfo.callingUser().getAccountId()))) { + return false; + } + } catch (UnsupportedOperationException e) { + // The calling user is not logged in, hence it cannot match an account. + return false; + } + } + + // If in the request config project patterns are set and none of them matches, then the request + // is not matched. + if (!projectPatterns().isEmpty()) { + if (!requestInfo.project().isPresent()) { + // The request is not for a project, hence it cannot match a project pattern. + return false; + } + + if (projectPatterns().stream() + .noneMatch(p -> p.matcher(requestInfo.project().get().get()).matches())) { + return false; + } + } + + // For any match criteria (request type, request URI pattern, account, project pattern) that + // was specified in the request config, at least one of the configured value matched the + // request. + return true; + } + + @AutoValue.Builder + abstract static class Builder { + abstract Builder cfg(Config cfg); + + abstract Builder section(String section); + + abstract Builder id(String id); + + abstract Builder requestTypes(ImmutableSet<String> requestTypes); + + abstract Builder requestUriPatterns(ImmutableSet<Pattern> requestUriPatterns); + + abstract Builder excludedRequestUriPatterns(ImmutableSet<Pattern> excludedRequestUriPatterns); + + abstract Builder accountIds(ImmutableSet<Account.Id> accountIds); + + abstract Builder projectPatterns(ImmutableSet<Pattern> projectPatterns); + + abstract RequestConfig build(); + } +}
diff --git a/java/com/google/gerrit/server/RequestInfo.java b/java/com/google/gerrit/server/RequestInfo.java index f369239..791e228 100644 --- a/java/com/google/gerrit/server/RequestInfo.java +++ b/java/com/google/gerrit/server/RequestInfo.java
@@ -14,7 +14,13 @@ package com.google.gerrit.server; +import static com.google.common.base.Preconditions.checkState; +import static java.util.Objects.requireNonNull; + import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; +import com.google.common.base.Splitter; +import com.google.gerrit.common.UsedAt; import com.google.gerrit.entities.Project; import com.google.gerrit.server.logging.TraceContext; import java.util.Optional; @@ -54,6 +60,16 @@ */ public abstract Optional<String> requestUri(); + /** + * Redacted request URI. + * + * <p>Request URI where resource IDs are replaced by '*'. + */ + @Memoized + public Optional<String> redactedRequestUri() { + return requestUri().map(RequestInfo::redactRequestUri); + } + /** The user that has sent the request. */ public abstract CurrentUser callingUser(); @@ -67,12 +83,75 @@ */ public abstract Optional<Project.NameKey> project(); + @Memoized + public String formatForLogging() { + StringBuilder sb = new StringBuilder(); + sb.append(requestType()); + redactedRequestUri().ifPresent(redactedRequestUri -> sb.append(' ').append(redactedRequestUri)); + return sb.toString(); + } + + /** + * Redacts resource IDs from the given request URI. + * + * <p>resource IDs in the request URI are replaced with '*'. + * + * @param requestUri a REST URI that has path segments that alternate between view name and + * resource IDs (e.g. "/<view>", "/<view>/<id>", "/<view>/<id>/<view>", + * "/<view>/<id>/<view>/<id>", "/<view>/<id>/<view>/<id>/<view>" etc.), must be given without + * the '/a' prefix + * @return the redacted request URI + */ + static String redactRequestUri(String requestUri) { + requireNonNull(requestUri, "requestUri"); + checkState( + !requestUri.startsWith("/a/"), "request URI must not start with '/a/': %s", requestUri); + + StringBuilder redactedRequestUri = new StringBuilder(); + + boolean hasLeadingSlash = false; + boolean hasTrailingSlash = false; + if (requestUri.startsWith("/")) { + hasLeadingSlash = true; + requestUri = requestUri.substring(1); + } + if (requestUri.endsWith("/")) { + hasTrailingSlash = true; + requestUri = requestUri.substring(0, requestUri.length() - 1); + } + + boolean idPathSegment = false; + for (String pathSegment : Splitter.on('/').split(requestUri)) { + if (!idPathSegment) { + redactedRequestUri.append("/" + pathSegment); + idPathSegment = true; + } else { + redactedRequestUri.append("/"); + if (!pathSegment.isEmpty()) { + redactedRequestUri.append("*"); + } + idPathSegment = false; + } + } + + if (!hasLeadingSlash) { + redactedRequestUri.deleteCharAt(0); + } + if (hasTrailingSlash) { + redactedRequestUri.append('/'); + } + + return redactedRequestUri.toString(); + } + public static RequestInfo.Builder builder( RequestType requestType, CurrentUser callingUser, TraceContext traceContext) { - return new AutoValue_RequestInfo.Builder() - .requestType(requestType) - .callingUser(callingUser) - .traceContext(traceContext); + return builder().requestType(requestType).callingUser(callingUser).traceContext(traceContext); + } + + @UsedAt(UsedAt.Project.GOOGLE) + public static RequestInfo.Builder builder() { + return new AutoValue_RequestInfo.Builder(); } @AutoValue.Builder
diff --git a/java/com/google/gerrit/server/StarredChangesUtil.java b/java/com/google/gerrit/server/StarredChangesUtil.java index fd53586..cad935b 100644 --- a/java/com/google/gerrit/server/StarredChangesUtil.java +++ b/java/com/google/gerrit/server/StarredChangesUtil.java
@@ -27,7 +27,6 @@ import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.common.collect.ImmutableSortedSet; -import com.google.common.collect.Sets; import com.google.common.flogger.FluentLogger; import com.google.common.primitives.Ints; import com.google.gerrit.common.Nullable; @@ -57,7 +56,6 @@ import java.util.Collection; import java.util.HashSet; import java.util.List; -import java.util.Optional; import java.util.Set; import java.util.SortedSet; import java.util.TreeSet; @@ -161,8 +159,6 @@ public static final String DEFAULT_LABEL = "star"; public static final String IGNORE_LABEL = "ignore"; - public static final String REVIEWED_LABEL = "reviewed"; - public static final String UNREVIEWED_LABEL = "unreviewed"; public static final ImmutableSortedSet<String> DEFAULT_LABELS = ImmutableSortedSet.of(DEFAULT_LABEL); @@ -350,40 +346,6 @@ return isIgnoredBy(rsrc.getChange().getId(), rsrc.getUser().asIdentifiedUser().getAccountId()); } - private static String getReviewedLabel(Change change) { - return getReviewedLabel(change.currentPatchSetId().get()); - } - - private static String getReviewedLabel(int ps) { - return REVIEWED_LABEL + "/" + ps; - } - - private static String getUnreviewedLabel(Change change) { - return getUnreviewedLabel(change.currentPatchSetId().get()); - } - - private static String getUnreviewedLabel(int ps) { - return UNREVIEWED_LABEL + "/" + ps; - } - - public void markAsReviewed(ChangeResource rsrc) throws IllegalLabelException { - star( - rsrc.getUser().asIdentifiedUser().getAccountId(), - rsrc.getProject(), - rsrc.getChange().getId(), - ImmutableSet.of(getReviewedLabel(rsrc.getChange())), - ImmutableSet.of(getUnreviewedLabel(rsrc.getChange()))); - } - - public void markAsUnreviewed(ChangeResource rsrc) throws IllegalLabelException { - star( - rsrc.getUser().asIdentifiedUser().getAccountId(), - rsrc.getProject(), - rsrc.getChange().getId(), - ImmutableSet.of(getUnreviewedLabel(rsrc.getChange())), - ImmutableSet.of(getReviewedLabel(rsrc.getChange()))); - } - public static StarRef readLabels(Repository repo, String refName) throws IOException { try (TraceTimer traceTimer = TraceContext.newTimer( @@ -428,23 +390,6 @@ if (labels.containsAll(ImmutableSet.of(DEFAULT_LABEL, IGNORE_LABEL))) { throw new MutuallyExclusiveLabelsException(DEFAULT_LABEL, IGNORE_LABEL); } - - Set<Integer> reviewedPatchSets = getStarredPatchSets(labels, REVIEWED_LABEL); - Set<Integer> unreviewedPatchSets = getStarredPatchSets(labels, UNREVIEWED_LABEL); - Optional<Integer> ps = - Sets.intersection(reviewedPatchSets, unreviewedPatchSets).stream().findFirst(); - if (ps.isPresent()) { - throw new MutuallyExclusiveLabelsException( - getReviewedLabel(ps.get()), getUnreviewedLabel(ps.get())); - } - } - - public static Set<Integer> getStarredPatchSets(Set<String> labels, String label) { - return labels.stream() - .filter(l -> l.startsWith(label + "/")) - .filter(l -> Ints.tryParse(l.substring(label.length() + 1)) != null) - .map(l -> Integer.valueOf(l.substring(label.length() + 1))) - .collect(toSet()); } private static void validateLabels(Collection<String> labels) throws InvalidLabelsException {
diff --git a/java/com/google/gerrit/server/StartupChecks.java b/java/com/google/gerrit/server/StartupChecks.java index 9bf94ae..3b9892b 100644 --- a/java/com/google/gerrit/server/StartupChecks.java +++ b/java/com/google/gerrit/server/StartupChecks.java
@@ -25,7 +25,7 @@ @Singleton public class StartupChecks implements LifecycleListener { - public static class Module extends LifecycleModule { + public static class StartupChecksModule extends LifecycleModule { @Override protected void configure() { DynamicSet.setOf(binder(), StartupCheck.class);
diff --git a/java/com/google/gerrit/server/TraceRequestListener.java b/java/com/google/gerrit/server/TraceRequestListener.java index 20c9f57..6cc0982 100644 --- a/java/com/google/gerrit/server/TraceRequestListener.java +++ b/java/com/google/gerrit/server/TraceRequestListener.java
@@ -14,19 +14,11 @@ package com.google.gerrit.server; -import com.google.auto.value.AutoValue; import com.google.common.collect.ImmutableList; -import com.google.common.collect.ImmutableSet; -import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Account; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.logging.RequestId; import com.google.inject.Inject; import com.google.inject.Singleton; -import java.util.Optional; -import java.util.regex.Pattern; -import java.util.regex.PatternSyntaxException; -import org.eclipse.jgit.errors.ConfigInvalidException; import org.eclipse.jgit.lib.Config; /** @@ -36,20 +28,22 @@ */ @Singleton public class TraceRequestListener implements RequestListener { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + public static String TAG_REQUEST = "request"; - private final Config cfg; - private final ImmutableList<TraceConfig> traceConfigs; + private static String TAG_PROJECT = "project"; + private static String SECTION_TRACING = "tracing"; + + private final ImmutableList<RequestConfig> traceConfigs; @Inject TraceRequestListener(@GerritServerConfig Config cfg) { - this.cfg = cfg; - this.traceConfigs = parseTraceConfigs(); + this.traceConfigs = RequestConfig.parseConfigs(cfg, SECTION_TRACING); } @Override public void onRequest(RequestInfo requestInfo) { - requestInfo.project().ifPresent(p -> requestInfo.traceContext().addTag("project", p)); + requestInfo.traceContext().addTag(TAG_REQUEST, requestInfo.formatForLogging()); + requestInfo.project().ifPresent(p -> requestInfo.traceContext().addTag(TAG_PROJECT, p)); traceConfigs.stream() .filter(traceConfig -> traceConfig.matches(requestInfo)) .forEach( @@ -57,172 +51,6 @@ requestInfo .traceContext() .forceLogging() - .addTag(RequestId.Type.TRACE_ID, traceConfig.traceId())); - } - - private ImmutableList<TraceConfig> parseTraceConfigs() { - ImmutableList.Builder<TraceConfig> traceConfigs = ImmutableList.builder(); - - for (String traceId : cfg.getSubsections("tracing")) { - try { - TraceConfig.Builder traceConfig = TraceConfig.builder(); - traceConfig.traceId(traceId); - traceConfig.requestTypes(parseRequestTypes(traceId)); - traceConfig.requestUriPatterns(parseRequestUriPatterns(traceId)); - traceConfig.accountIds(parseAccounts(traceId)); - traceConfig.projectPatterns(parseProjectPatterns(traceId)); - traceConfigs.add(traceConfig.build()); - } catch (ConfigInvalidException e) { - logger.atWarning().log("Ignoring invalid tracing configuration:\n %s", e.getMessage()); - } - } - - return traceConfigs.build(); - } - - private ImmutableSet<String> parseRequestTypes(String traceId) { - return ImmutableSet.copyOf(cfg.getStringList("tracing", traceId, "requestType")); - } - - private ImmutableSet<Pattern> parseRequestUriPatterns(String traceId) - throws ConfigInvalidException { - return parsePatterns(traceId, "requestUriPattern"); - } - - private ImmutableSet<Account.Id> parseAccounts(String traceId) throws ConfigInvalidException { - ImmutableSet.Builder<Account.Id> accountIds = ImmutableSet.builder(); - String[] accounts = cfg.getStringList("tracing", traceId, "account"); - for (String account : accounts) { - Optional<Account.Id> accountId = Account.Id.tryParse(account); - if (!accountId.isPresent()) { - throw new ConfigInvalidException( - String.format( - "Invalid tracing config ('tracing.%s.account = %s'): invalid account ID", - traceId, account)); - } - accountIds.add(accountId.get()); - } - return accountIds.build(); - } - - private ImmutableSet<Pattern> parseProjectPatterns(String traceId) throws ConfigInvalidException { - return parsePatterns(traceId, "projectPattern"); - } - - private ImmutableSet<Pattern> parsePatterns(String traceId, String name) - throws ConfigInvalidException { - ImmutableSet.Builder<Pattern> patterns = ImmutableSet.builder(); - String[] patternRegExs = cfg.getStringList("tracing", traceId, name); - for (String patternRegEx : patternRegExs) { - try { - patterns.add(Pattern.compile(patternRegEx)); - } catch (PatternSyntaxException e) { - throw new ConfigInvalidException( - String.format( - "Invalid tracing config ('tracing.%s.%s = %s'): %s", - traceId, name, patternRegEx, e.getMessage())); - } - } - return patterns.build(); - } - - @AutoValue - abstract static class TraceConfig { - /** ID for the trace */ - abstract String traceId(); - - /** request types that should be traced */ - abstract ImmutableSet<String> requestTypes(); - - /** pattern matching request URIs */ - abstract ImmutableSet<Pattern> requestUriPatterns(); - - /** accounts IDs matching calling user */ - abstract ImmutableSet<Account.Id> accountIds(); - - /** pattern matching projects names */ - abstract ImmutableSet<Pattern> projectPatterns(); - - static Builder builder() { - return new AutoValue_TraceRequestListener_TraceConfig.Builder(); - } - - /** - * Whether this trace config matches a given request. - * - * @param requestInfo request info - * @return whether this trace config matches - */ - boolean matches(RequestInfo requestInfo) { - // If in the trace config request types are set and none of them matches, then the request is - // not matched. - if (!requestTypes().isEmpty() - && requestTypes().stream() - .noneMatch(type -> type.equalsIgnoreCase(requestInfo.requestType()))) { - return false; - } - - // If in the trace config request URI patterns are set and none of them matches, then the - // request is not matched. - if (!requestUriPatterns().isEmpty()) { - if (!requestInfo.requestUri().isPresent()) { - // The request has no request URI, hence it cannot match a request URI pattern. - return false; - } - - if (requestUriPatterns().stream() - .noneMatch(p -> p.matcher(requestInfo.requestUri().get()).matches())) { - return false; - } - } - - // If in the trace config accounts are set and none of them matches, then the request is not - // matched. - if (!accountIds().isEmpty()) { - try { - if (accountIds().stream() - .noneMatch(id -> id.equals(requestInfo.callingUser().getAccountId()))) { - return false; - } - } catch (UnsupportedOperationException e) { - // The calling user is not logged in, hence it cannot match an account. - return false; - } - } - - // If in the trace config project patterns are set and none of them matches, then the request - // is not matched. - if (!projectPatterns().isEmpty()) { - if (!requestInfo.project().isPresent()) { - // The request is not for a project, hence it cannot match a project pattern. - return false; - } - - if (projectPatterns().stream() - .noneMatch(p -> p.matcher(requestInfo.project().get().get()).matches())) { - return false; - } - } - - // For any match criteria (request type, request URI pattern, account, project pattern) that - // was specified in the trace config, at least one of the configured value matched the - // request. - return true; - } - - @AutoValue.Builder - abstract static class Builder { - abstract Builder traceId(String traceId); - - abstract Builder requestTypes(ImmutableSet<String> requestTypes); - - abstract Builder requestUriPatterns(ImmutableSet<Pattern> requestUriPatterns); - - abstract Builder accountIds(ImmutableSet<Account.Id> accountIds); - - abstract Builder projectPatterns(ImmutableSet<Pattern> projectPatterns); - - abstract TraceConfig build(); - } + .addTag(RequestId.Type.TRACE_ID, traceConfig.id())); } }
diff --git a/java/com/google/gerrit/server/WebLinks.java b/java/com/google/gerrit/server/WebLinks.java index 785cd1c..2cf2326 100644 --- a/java/com/google/gerrit/server/WebLinks.java +++ b/java/com/google/gerrit/server/WebLinks.java
@@ -27,11 +27,13 @@ import com.google.gerrit.extensions.registration.DynamicSet; import com.google.gerrit.extensions.webui.BranchWebLink; import com.google.gerrit.extensions.webui.DiffWebLink; +import com.google.gerrit.extensions.webui.EditWebLink; import com.google.gerrit.extensions.webui.FileHistoryWebLink; import com.google.gerrit.extensions.webui.FileWebLink; import com.google.gerrit.extensions.webui.ParentWebLink; import com.google.gerrit.extensions.webui.PatchSetWebLink; import com.google.gerrit.extensions.webui.ProjectWebLink; +import com.google.gerrit.extensions.webui.ResolveConflictsWebLink; import com.google.gerrit.extensions.webui.TagWebLink; import com.google.gerrit.extensions.webui.WebLink; import com.google.inject.Inject; @@ -55,7 +57,9 @@ }; private final DynamicSet<PatchSetWebLink> patchSetLinks; + private final DynamicSet<ResolveConflictsWebLink> resolveConflictsLinks; private final DynamicSet<ParentWebLink> parentLinks; + private final DynamicSet<EditWebLink> editLinks; private final DynamicSet<FileWebLink> fileLinks; private final DynamicSet<FileHistoryWebLink> fileHistoryLinks; private final DynamicSet<DiffWebLink> diffLinks; @@ -66,7 +70,9 @@ @Inject public WebLinks( DynamicSet<PatchSetWebLink> patchSetLinks, + DynamicSet<ResolveConflictsWebLink> resolveConflictsLinks, DynamicSet<ParentWebLink> parentLinks, + DynamicSet<EditWebLink> editLinks, DynamicSet<FileWebLink> fileLinks, DynamicSet<FileHistoryWebLink> fileLogLinks, DynamicSet<DiffWebLink> diffLinks, @@ -74,7 +80,9 @@ DynamicSet<BranchWebLink> branchLinks, DynamicSet<TagWebLink> tagLinks) { this.patchSetLinks = patchSetLinks; + this.resolveConflictsLinks = resolveConflictsLinks; this.parentLinks = parentLinks; + this.editLinks = editLinks; this.fileLinks = fileLinks; this.fileHistoryLinks = fileLogLinks; this.diffLinks = diffLinks; @@ -84,11 +92,12 @@ } /** + * Returns links for patch sets + * * @param project Project name. * @param commit SHA1 of commit. * @param commitMessage the commit message of the commit. * @param branchName branch of the commit. - * @return Links for patch sets. */ public ImmutableList<WebLinkInfo> getPatchSetLinks( Project.NameKey project, String commit, String commitMessage, String branchName) { @@ -98,11 +107,28 @@ } /** + * Returns links for resolving conflicts + * + * @param project Project name. + * @param commit SHA1 of commit. + * @param commitMessage the commit message of the commit. + * @param branchName branch of the commit. + */ + public ImmutableList<WebLinkInfo> getResolveConflictsLinks( + Project.NameKey project, String commit, String commitMessage, String branchName) { + return filterLinks( + resolveConflictsLinks, + webLink -> + webLink.getResolveConflictsWebLink(project.get(), commit, commitMessage, branchName)); + } + + /** + * Returns links for patch sets + * * @param project Project name. * @param revision SHA1 of the parent revision. * @param commitMessage the commit message of the parent revision. * @param branchName branch of the revision (and parent revision). - * @return Links for patch sets. */ public ImmutableList<WebLinkInfo> getParentLinks( Project.NameKey project, String revision, String commitMessage, String branchName) { @@ -112,11 +138,25 @@ } /** + * Returns links for editing + * + * @param project Project name. + * @param revision SHA1 of revision. + * @param file File name. + */ + public ImmutableList<WebLinkInfo> getEditLinks(String project, String revision, String file) { + return Patch.isMagic(file) + ? ImmutableList.of() + : filterLinks(editLinks, webLink -> webLink.getEditWebLink(project, revision, file)); + } + + /** + * Returns links for files + * * @param project Project name. * @param revision Name of the revision (e.g. branch or commit ID) * @param hash SHA1 of revision. * @param file File name. - * @return Links for files. */ public ImmutableList<WebLinkInfo> getFileLinks( String project, String revision, String hash, String file) { @@ -126,10 +166,11 @@ } /** + * Returns links for file history + * * @param project Project name. * @param revision SHA1 of revision. * @param file File name. - * @return Links for file history */ public ImmutableList<WebLinkInfo> getFileHistoryLinks( String project, String revision, String file) { @@ -143,6 +184,8 @@ } /** + * Returns links for file diffs + * * @param project Project name. * @param patchSetIdA Patch set ID of side A, <code>null</code> if no base patch set was selected. * @param revisionA SHA1 of revision of side A. @@ -150,7 +193,6 @@ * @param patchSetIdB Patch set ID of side B. * @param revisionB SHA1 of revision of side B. * @param fileB File name of side B. - * @return Links for file diffs. */ public ImmutableList<DiffWebLinkInfo> getDiffLinks( String project, @@ -181,26 +223,29 @@ } /** + * Returns links for projects + * * @param project Project name. - * @return Links for projects. */ public ImmutableList<WebLinkInfo> getProjectLinks(String project) { return filterLinks(projectLinks, webLink -> webLink.getProjectWeblink(project)); } /** + * Returns links for branches + * * @param project Project name * @param branch Branch name - * @return Links for branches. */ public ImmutableList<WebLinkInfo> getBranchLinks(String project, String branch) { return filterLinks(branchLinks, webLink -> webLink.getBranchWebLink(project, branch)); } /** + * Returns links for the tag + * * @param project Project name * @param tag Tag name - * @return Links for tags. */ public ImmutableList<WebLinkInfo> getTagLinks(String project, String tag) { return filterLinks(tagLinks, webLink -> webLink.getTagWebLink(project, tag));
diff --git a/java/com/google/gerrit/server/account/AccountAttributeLoader.java b/java/com/google/gerrit/server/account/AccountAttributeLoader.java new file mode 100644 index 0000000..ae57941 --- /dev/null +++ b/java/com/google/gerrit/server/account/AccountAttributeLoader.java
@@ -0,0 +1,49 @@ +// Copyright (C) 2022 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.account; + +import com.google.gerrit.common.Nullable; +import com.google.gerrit.entities.Account; +import com.google.gerrit.server.data.AccountAttribute; +import com.google.inject.Inject; +import java.util.HashMap; +import java.util.Map; + +public class AccountAttributeLoader { + + public interface Factory { + AccountAttributeLoader create(); + } + + private final InternalAccountDirectory directory; + private final Map<Account.Id, AccountAttribute> created = new HashMap<>(); + + @Inject + AccountAttributeLoader(InternalAccountDirectory directory) { + this.directory = directory; + } + + @Nullable + public synchronized AccountAttribute get(@Nullable Account.Id id) { + if (id == null) { + return null; + } + return created.computeIfAbsent(id, k -> new AccountAttribute(k.get())); + } + + public void fill() { + directory.fillAccountAttributeInfo(created.values()); + } +}
diff --git a/java/com/google/gerrit/server/account/AccountCacheImpl.java b/java/com/google/gerrit/server/account/AccountCacheImpl.java index 93e0488..093af68 100644 --- a/java/com/google/gerrit/server/account/AccountCacheImpl.java +++ b/java/com/google/gerrit/server/account/AccountCacheImpl.java
@@ -24,7 +24,7 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.RefNames; import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.cache.CacheModule; import com.google.gerrit.server.config.AllUsersName; @@ -45,7 +45,6 @@ import java.util.Optional; import java.util.Set; import java.util.concurrent.ExecutionException; -import org.eclipse.jgit.errors.ConfigInvalidException; import org.eclipse.jgit.lib.Ref; import org.eclipse.jgit.lib.Repository; @@ -77,6 +76,7 @@ private final GitRepositoryManager repoManager; private final AllUsersName allUsersName; private final DefaultPreferencesCache defaultPreferenceCache; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject AccountCacheImpl( @@ -85,12 +85,14 @@ LoadingCache<CachedAccountDetails.Key, CachedAccountDetails> accountDetailsCache, GitRepositoryManager repoManager, AllUsersName allUsersName, - DefaultPreferencesCache defaultPreferenceCache) { + DefaultPreferencesCache defaultPreferenceCache, + ExternalIdKeyFactory externalIdKeyFactory) { this.externalIds = externalIds; this.accountDetailsCache = accountDetailsCache; this.repoManager = repoManager; this.allUsersName = allUsersName; this.defaultPreferenceCache = defaultPreferenceCache; + this.externalIdKeyFactory = externalIdKeyFactory; } @Override @@ -141,10 +143,10 @@ public Optional<AccountState> getByUsername(String username) { try { return externalIds - .get(ExternalId.Key.create(SCHEME_USERNAME, username)) + .get(externalIdKeyFactory.create(SCHEME_USERNAME, username)) .map(e -> get(e.accountId())) .orElseGet(Optional::empty); - } catch (IOException | ConfigInvalidException e) { + } catch (IOException e) { logger.atWarning().withCause(e).log("Cannot load AccountState for username %s", username); return Optional.empty(); }
diff --git a/java/com/google/gerrit/server/account/AccountConfig.java b/java/com/google/gerrit/server/account/AccountConfig.java index e95bc1c..45f1f35 100644 --- a/java/com/google/gerrit/server/account/AccountConfig.java +++ b/java/com/google/gerrit/server/account/AccountConfig.java
@@ -84,7 +84,7 @@ private Optional<ObjectId> externalIdsRev; private ProjectWatches projectWatches; private StoredPreferences preferences; - private Optional<InternalAccountUpdate> accountUpdate = Optional.empty(); + private Optional<AccountDelta> accountDelta = Optional.empty(); private List<ValidationError> validationErrors; public AccountConfig(Account.Id accountId, AllUsersName allUsersName, Repository allUsersRepo) { @@ -158,9 +158,9 @@ this.loadedAccountProperties = Optional.of( new AccountProperties(account.id(), account.registeredOn(), new Config(), null)); - this.accountUpdate = + this.accountDelta = Optional.of( - InternalAccountUpdate.builder() + AccountDelta.builder() .setActive(account.isActive()) .setFullName(account.fullName()) .setDisplayName(account.displayName()) @@ -196,8 +196,8 @@ return loadedAccountProperties.map(AccountProperties::getAccount).get(); } - public AccountConfig setAccountUpdate(InternalAccountUpdate accountUpdate) { - this.accountUpdate = Optional.of(accountUpdate); + public AccountConfig setAccountDelta(AccountDelta accountDelta) { + this.accountDelta = Optional.of(accountDelta); return this; } @@ -283,45 +283,44 @@ saveProjectWatches(); savePreferences(); - accountUpdate = Optional.empty(); + accountDelta = Optional.empty(); return true; } private void saveAccount() throws IOException { - if (accountUpdate.isPresent()) { + if (accountDelta.isPresent()) { saveConfig( - AccountProperties.ACCOUNT_CONFIG, - loadedAccountProperties.get().save(accountUpdate.get())); + AccountProperties.ACCOUNT_CONFIG, loadedAccountProperties.get().save(accountDelta.get())); } } private void saveProjectWatches() throws IOException { - if (accountUpdate.isPresent() - && (!accountUpdate.get().getDeletedProjectWatches().isEmpty() - || !accountUpdate.get().getUpdatedProjectWatches().isEmpty())) { + if (accountDelta.isPresent() + && (!accountDelta.get().getDeletedProjectWatches().isEmpty() + || !accountDelta.get().getUpdatedProjectWatches().isEmpty())) { Map<ProjectWatchKey, Set<NotifyType>> newProjectWatches = new HashMap<>(projectWatches.getProjectWatches()); - accountUpdate.get().getDeletedProjectWatches().forEach(newProjectWatches::remove); - accountUpdate.get().getUpdatedProjectWatches().forEach(newProjectWatches::put); + accountDelta.get().getDeletedProjectWatches().forEach(newProjectWatches::remove); + accountDelta.get().getUpdatedProjectWatches().forEach(newProjectWatches::put); saveConfig(ProjectWatches.WATCH_CONFIG, projectWatches.save(newProjectWatches)); } } private void savePreferences() throws IOException, ConfigInvalidException { - if (!accountUpdate.isPresent() - || (!accountUpdate.get().getGeneralPreferences().isPresent() - && !accountUpdate.get().getDiffPreferences().isPresent() - && !accountUpdate.get().getEditPreferences().isPresent())) { + if (!accountDelta.isPresent() + || (!accountDelta.get().getGeneralPreferences().isPresent() + && !accountDelta.get().getDiffPreferences().isPresent() + && !accountDelta.get().getEditPreferences().isPresent())) { return; } saveConfig( StoredPreferences.PREFERENCES_CONFIG, preferences.saveGeneralPreferences( - accountUpdate.get().getGeneralPreferences(), - accountUpdate.get().getDiffPreferences(), - accountUpdate.get().getEditPreferences())); + accountDelta.get().getGeneralPreferences(), + accountDelta.get().getDiffPreferences(), + accountDelta.get().getEditPreferences())); } private void checkLoaded() {
diff --git a/java/com/google/gerrit/server/account/AccountDeactivator.java b/java/com/google/gerrit/server/account/AccountDeactivator.java index ea327f8..a4d7608 100644 --- a/java/com/google/gerrit/server/account/AccountDeactivator.java +++ b/java/com/google/gerrit/server/account/AccountDeactivator.java
@@ -33,7 +33,7 @@ public class AccountDeactivator implements Runnable { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - public static class Module extends LifecycleModule { + public static class AccountDeactivatorModule extends LifecycleModule { @Override protected void configure() { listener().to(Lifecycle.class);
diff --git a/java/com/google/gerrit/server/account/InternalAccountUpdate.java b/java/com/google/gerrit/server/account/AccountDelta.java similarity index 96% rename from java/com/google/gerrit/server/account/InternalAccountUpdate.java rename to java/com/google/gerrit/server/account/AccountDelta.java index 4f9202f..fac3233 100644 --- a/java/com/google/gerrit/server/account/InternalAccountUpdate.java +++ b/java/com/google/gerrit/server/account/AccountDelta.java
@@ -33,23 +33,23 @@ import java.util.Set; /** - * Class to prepare updates to an account. + * Data holder for updates to be applied to an account. * - * <p>Account updates are done through {@link AccountsUpdate}. This class should be used to tell - * {@link AccountsUpdate} how an account should be modified. + * <p>Instances of this type are passed to {@link AccountsUpdate}, which modifies the account + * accordingly. * - * <p>This class allows to prepare updates of account properties, external IDs, preferences + * <p>Updates can be applied to account properties (name, email etc.), external IDs, preferences * (general, diff and edit preferences) and project watches. The account ID and the registration * date cannot be updated. * - * <p>For the account properties there are getters in this class and the setters in the {@link - * Builder} that correspond to the fields in {@link Account}. + * <p>For the account properties there are getters in this class and setters in the {@link Builder} + * that correspond to the fields in {@link Account}. */ @AutoValue -public abstract class InternalAccountUpdate { +public abstract class AccountDelta { public static Builder builder() { return new Builder.WrapperThatConvertsNullStringArgsToEmptyStrings( - new AutoValue_InternalAccountUpdate.Builder()); + new AutoValue_AccountDelta.Builder()); } /** @@ -162,13 +162,13 @@ public abstract Optional<EditPreferencesInfo> getEditPreferences(); /** - * Class to build an account update. + * Class to build an {@link AccountDelta}. * * <p>Account data is only updated if the corresponding setter is invoked. If a setter is not * invoked the corresponding data stays unchanged. To unset string values the setter can be * invoked with either {@code null} or an empty string ({@code null} is converted to an empty * string by using the {@link WrapperThatConvertsNullStringArgsToEmptyStrings} wrapper, see {@link - * InternalAccountUpdate#builder()}). + * AccountDelta#builder()}). */ @AutoValue.Builder public abstract static class Builder { @@ -447,12 +447,8 @@ */ public abstract Builder setEditPreferences(EditPreferencesInfo editPreferences); - /** - * Builds the account update. - * - * @return the account update - */ - public abstract InternalAccountUpdate build(); + /** Builds the instance. */ + public abstract AccountDelta build(); /** * Wrapper for {@link Builder} that converts {@code null} string arguments to empty strings for @@ -525,7 +521,7 @@ } @Override - public InternalAccountUpdate build() { + public AccountDelta build() { return delegate.build(); }
diff --git a/java/com/google/gerrit/server/account/AccountDirectory.java b/java/com/google/gerrit/server/account/AccountDirectory.java index 98b2ca9..10aecd3 100644 --- a/java/com/google/gerrit/server/account/AccountDirectory.java +++ b/java/com/google/gerrit/server/account/AccountDirectory.java
@@ -15,6 +15,7 @@ package com.google.gerrit.server.account; import com.google.gerrit.extensions.common.AccountInfo; +import com.google.gerrit.server.data.AccountAttribute; import com.google.gerrit.server.permissions.PermissionBackendException; import java.util.Set; @@ -24,7 +25,7 @@ * <p>Implementations supply data to Gerrit about user accounts. */ public abstract class AccountDirectory { - /** Fields to be populated for a REST API response. */ + /** Fields to be populated for SSH or REST API response. */ public enum FillOptions { /** Full name or username. */ NAME, @@ -59,4 +60,6 @@ public abstract void fillAccountInfo(Iterable<? extends AccountInfo> in, Set<FillOptions> options) throws PermissionBackendException; + + public abstract void fillAccountAttributeInfo(Iterable<? extends AccountAttribute> in); }
diff --git a/java/com/google/gerrit/server/account/AccountLimits.java b/java/com/google/gerrit/server/account/AccountLimits.java index 1845f5b..5549d28 100644 --- a/java/com/google/gerrit/server/account/AccountLimits.java +++ b/java/com/google/gerrit/server/account/AccountLimits.java
@@ -51,7 +51,7 @@ user = currentUser; } - /** @return which priority queue the user's tasks should be submitted to. */ + /** Returns which priority queue the user's tasks should be submitted to. */ public QueueProvider.QueueType getQueueType() { // If a non-generic group (that is not Anonymous Users or Registered Users) // grants us INTERACTIVE permission, use the INTERACTIVE queue even if @@ -99,7 +99,7 @@ return getRange(GlobalCapability.QUERY_LIMIT).getMax(); } - /** @return true if the user has a permission rule specifying the range. */ + /** Returns true if the user has a permission rule specifying the range. */ public boolean hasExplicitRange(String permission) { return GlobalCapability.hasRange(permission) && !getRules(permission).isEmpty(); }
diff --git a/java/com/google/gerrit/server/account/AccountManager.java b/java/com/google/gerrit/server/account/AccountManager.java index 47c6efb..891a467 100644 --- a/java/com/google/gerrit/server/account/AccountManager.java +++ b/java/com/google/gerrit/server/account/AccountManager.java
@@ -34,14 +34,15 @@ import com.google.gerrit.extensions.client.AccountFieldName; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.ServerInitiated; -import com.google.gerrit.server.account.AccountsUpdate.AccountUpdater; import com.google.gerrit.server.account.externalids.DuplicateExternalIdKeyException; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.auth.NoSuchUserException; import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.group.db.GroupDelta; import com.google.gerrit.server.group.db.GroupsUpdate; -import com.google.gerrit.server.group.db.InternalGroupUpdate; import com.google.gerrit.server.notedb.Sequences; import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.ssh.SshKeyCache; @@ -78,6 +79,8 @@ private final GroupsUpdate.Factory groupsUpdateFactory; private final boolean autoUpdateAccountActiveStatus; private final SetInactiveFlag setInactiveFlag; + private final ExternalIdFactory externalIdFactory; + private final ExternalIdKeyFactory externalIdKeyFactory; @VisibleForTesting @Inject @@ -93,7 +96,9 @@ ProjectCache projectCache, ExternalIds externalIds, GroupsUpdate.Factory groupsUpdateFactory, - SetInactiveFlag setInactiveFlag) { + SetInactiveFlag setInactiveFlag, + ExternalIdFactory externalIdFactory, + ExternalIdKeyFactory externalIdKeyFactory) { this.sequences = sequences; this.accounts = accounts; this.accountsUpdateProvider = accountsUpdateProvider; @@ -109,13 +114,15 @@ this.autoUpdateAccountActiveStatus = cfg.getBoolean("auth", "autoUpdateAccountActiveStatus", false); this.setInactiveFlag = setInactiveFlag; + this.externalIdFactory = externalIdFactory; + this.externalIdKeyFactory = externalIdKeyFactory; } - /** @return user identified by this external identity string */ + /** Returns a user identified by this external identity string */ public Optional<Account.Id> lookup(String externalId) throws AccountException { try { - return externalIds.get(ExternalId.Key.parse(externalId)).map(ExternalId::accountId); - } catch (IOException | ConfigInvalidException e) { + return externalIds.get(externalIdKeyFactory.parse(externalId)).map(ExternalId::accountId); + } catch (IOException e) { throw new AccountException("Cannot lookup account " + externalId, e); } } @@ -221,7 +228,7 @@ private void update(AuthRequest who, ExternalId extId) throws IOException, ConfigInvalidException, AccountException { IdentifiedUser user = userFactory.create(extId.accountId()); - List<Consumer<InternalAccountUpdate.Builder>> accountUpdates = new ArrayList<>(); + List<Consumer<AccountDelta.Builder>> accountUpdates = new ArrayList<>(); // If the email address was modified by the authentication provider, // update our records to match the changed email. @@ -230,7 +237,7 @@ String oldEmail = extId.email(); if (newEmail != null && !newEmail.equals(oldEmail)) { ExternalId extIdWithNewEmail = - ExternalId.create(extId.key(), extId.accountId(), newEmail, extId.password()); + externalIdFactory.create(extId.key(), extId.accountId(), newEmail, extId.password()); checkEmailNotUsed(extId.accountId(), extIdWithNewEmail); accountUpdates.add(u -> u.replaceExternalId(extId, extIdWithNewEmail)); @@ -257,14 +264,16 @@ } if (!accountUpdates.isEmpty()) { - accountsUpdateProvider - .get() - .update( - "Update Account on Login", - user.getAccountId(), - AccountUpdater.joinConsumers(accountUpdates)) - .orElseThrow( - () -> new StorageException("Account " + user.getAccountId() + " has been deleted")); + Optional<AccountState> updatedAccount = + accountsUpdateProvider + .get() + .update( + "Update Account on Login", + user.getAccountId(), + AccountsUpdate.joinConsumers(accountUpdates)); + if (!updatedAccount.isPresent()) { + throw new StorageException("Account " + user.getAccountId() + " has been deleted"); + } } } @@ -274,7 +283,7 @@ logger.atFine().log("Assigning new Id %s to account", newId); ExternalId extId = - ExternalId.createWithEmail(who.getExternalIdKey(), newId, who.getEmailAddress()); + externalIdFactory.createWithEmail(who.getExternalIdKey(), newId, who.getEmailAddress()); logger.atFine().log("Created external Id: %s", extId); checkEmailNotUsed(newId, extId); ExternalId userNameExtId = @@ -349,7 +358,7 @@ "Cannot assign user name \"%s\" to account %s; name does not conform.", username, accountId)); } - return ExternalId.create(SCHEME_USERNAME, username, accountId); + return externalIdFactory.create(SCHEME_USERNAME, username, accountId); } private void checkEmailNotUsed(Account.Id accountId, ExternalId extIdToBeCreated) @@ -382,13 +391,13 @@ throws IOException, ConfigInvalidException, AccountException { // The user initiated this request by logging in. -> Attribute all modifications to that user. GroupsUpdate groupsUpdate = groupsUpdateFactory.create(user); - InternalGroupUpdate groupUpdate = - InternalGroupUpdate.builder() + GroupDelta groupDelta = + GroupDelta.builder() .setMemberModification( memberIds -> Sets.union(memberIds, ImmutableSet.of(user.getAccountId()))) .build(); try { - groupsUpdate.updateGroup(groupUuid, groupUpdate); + groupsUpdate.updateGroup(groupUuid, groupDelta); } catch (NoSuchGroupException e) { throw new AccountException(String.format("Group %s not found", groupUuid), e); } @@ -415,7 +424,7 @@ update(who, extId); } else { ExternalId newExtId = - ExternalId.createWithEmail(who.getExternalIdKey(), to, who.getEmailAddress()); + externalIdFactory.createWithEmail(who.getExternalIdKey(), to, who.getEmailAddress()); checkEmailNotUsed(to, newExtId); accountsUpdateProvider .get()
diff --git a/javatests/com/google/gerrit/acceptance/pgm/ReindexIT.java b/java/com/google/gerrit/server/account/AccountModule.java similarity index 68% copy from javatests/com/google/gerrit/acceptance/pgm/ReindexIT.java copy to java/com/google/gerrit/server/account/AccountModule.java index 223851e..c1305cf 100644 --- a/javatests/com/google/gerrit/acceptance/pgm/ReindexIT.java +++ b/java/com/google/gerrit/server/account/AccountModule.java
@@ -1,4 +1,4 @@ -// Copyright (C) 2014 The Android Open Source Project +// Copyright (C) 2021 The Android Open Source Project // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,11 +12,13 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.acceptance.pgm; +package com.google.gerrit.server.account; -import com.google.inject.Injector; +import com.google.inject.AbstractModule; -public class ReindexIT extends AbstractReindexTests { +public class AccountModule extends AbstractModule { @Override - public void configureIndex(Injector injector) {} + protected void configure() { + bind(AuthRequest.Factory.class); + } }
diff --git a/java/com/google/gerrit/server/account/AccountProperties.java b/java/com/google/gerrit/server/account/AccountProperties.java index 5ae5567..9b7ca81 100644 --- a/java/com/google/gerrit/server/account/AccountProperties.java +++ b/java/com/google/gerrit/server/account/AccountProperties.java
@@ -103,21 +103,19 @@ account = accountBuilder.build(); } - Config save(InternalAccountUpdate accountUpdate) { - writeToAccountConfig(accountUpdate, accountConfig); + Config save(AccountDelta accountDelta) { + writeToAccountConfig(accountDelta, accountConfig); return accountConfig; } - public static void writeToAccountConfig(InternalAccountUpdate accountUpdate, Config cfg) { - accountUpdate.getActive().ifPresent(active -> setActive(cfg, active)); - accountUpdate.getFullName().ifPresent(fullName -> set(cfg, KEY_FULL_NAME, fullName)); - accountUpdate - .getDisplayName() - .ifPresent(displayName -> set(cfg, KEY_DISPLAY_NAME, displayName)); - accountUpdate + public static void writeToAccountConfig(AccountDelta accountDelta, Config cfg) { + accountDelta.getActive().ifPresent(active -> setActive(cfg, active)); + accountDelta.getFullName().ifPresent(fullName -> set(cfg, KEY_FULL_NAME, fullName)); + accountDelta.getDisplayName().ifPresent(displayName -> set(cfg, KEY_DISPLAY_NAME, displayName)); + accountDelta .getPreferredEmail() .ifPresent(preferredEmail -> set(cfg, KEY_PREFERRED_EMAIL, preferredEmail)); - accountUpdate.getStatus().ifPresent(status -> set(cfg, KEY_STATUS, status)); + accountDelta.getStatus().ifPresent(status -> set(cfg, KEY_STATUS, status)); } /**
diff --git a/java/com/google/gerrit/server/account/AccountResolver.java b/java/com/google/gerrit/server/account/AccountResolver.java index 2665b9a..68f5a85 100644 --- a/java/com/google/gerrit/server/account/AccountResolver.java +++ b/java/com/google/gerrit/server/account/AccountResolver.java
@@ -27,12 +27,16 @@ import com.google.common.collect.ImmutableSet; import com.google.common.collect.Streams; import com.google.gerrit.entities.Account; +import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.extensions.restapi.UnprocessableEntityException; import com.google.gerrit.index.Schema; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.account.externalids.ExternalId; import com.google.gerrit.server.config.AnonymousCowardName; +import com.google.gerrit.server.permissions.GlobalPermission; +import com.google.gerrit.server.permissions.PermissionBackend; +import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.query.account.InternalAccountQuery; import com.google.inject.Inject; import com.google.inject.Provider; @@ -437,7 +441,15 @@ // up with a reasonable result list. // TODO(dborowitz): This doesn't match the documentation; consider whether it's possible to be // more strict here. - return accountQueryProvider.get().enforceVisibility(true).byDefault(input).stream(); + boolean canSeeSecondaryEmails = false; + try { + permissionBackend.user(self.get()).check(GlobalPermission.MODIFY_ACCOUNT); + canSeeSecondaryEmails = true; + } catch (AuthException | PermissionBackendException e) { + // remains false + } + return accountQueryProvider.get().enforceVisibility(true) + .byDefault(input, canSeeSecondaryEmails).stream(); } @Override @@ -473,6 +485,7 @@ private final Provider<InternalAccountQuery> accountQueryProvider; private final Realm realm; private final String anonymousCowardName; + private final PermissionBackend permissionBackend; @Inject AccountResolver( @@ -482,15 +495,17 @@ IdentifiedUser.GenericFactory userFactory, Provider<CurrentUser> self, Provider<InternalAccountQuery> accountQueryProvider, + PermissionBackend permissionBackend, Realm realm, @AnonymousCowardName String anonymousCowardName) { - this.realm = realm; this.accountCache = accountCache; + this.emails = emails; this.accountControlFactory = accountControlFactory; this.userFactory = userFactory; this.self = self; this.accountQueryProvider = accountQueryProvider; - this.emails = emails; + this.permissionBackend = permissionBackend; + this.realm = realm; this.anonymousCowardName = anonymousCowardName; } @@ -531,6 +546,19 @@ return searchImpl(input, searchers, visibilitySupplierCanSee(), accountActivityPredicate); } + /** + * As opposed to {@link #resolve}, the returned result includes all inactive accounts for the + * input search. + * + * <p>This can be used to resolve Gerrit Account from email to its {@link + * com.google.gerrit.entities.Account.Id}, to make sure that if {@link Account} with such email + * exists in Gerrit (even inactive), user data (email address) won't be recorded as it is, but + * instead will be stored as a link to the corresponding Gerrit Account. + */ + public Result resolveIncludeInactive(String input) throws ConfigInvalidException, IOException { + return searchImpl(input, searchers, visibilitySupplierCanSee(), all()); + } + public Result resolveIgnoreVisibility(String input) throws ConfigInvalidException, IOException { return searchImpl(input, searchers, visibilitySupplierAll(), accountActivityPredicate()); }
diff --git a/java/com/google/gerrit/server/account/AccountTagProvider.java b/java/com/google/gerrit/server/account/AccountTagProvider.java new file mode 100644 index 0000000..ddb1331 --- /dev/null +++ b/java/com/google/gerrit/server/account/AccountTagProvider.java
@@ -0,0 +1,14 @@ +package com.google.gerrit.server.account; + +import com.google.gerrit.entities.Account; +import com.google.gerrit.extensions.annotations.ExtensionPoint; +import java.util.List; + +/** + * An extension point for plugins to define their own account tags in addition to the ones defined + * at {@link com.google.gerrit.extensions.common.AccountInfo.Tags}. + */ +@ExtensionPoint +public interface AccountTagProvider { + List<String> getTags(Account.Id id); +}
diff --git a/java/com/google/gerrit/server/account/AccountsUpdate.java b/java/com/google/gerrit/server/account/AccountsUpdate.java index 1b3aa96..93738b0 100644 --- a/java/com/google/gerrit/server/account/AccountsUpdate.java +++ b/java/com/google/gerrit/server/account/AccountsUpdate.java
@@ -14,16 +14,17 @@ package com.google.gerrit.server.account; +import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkState; import static java.util.Objects.requireNonNull; +import static java.util.stream.Collectors.toList; import static java.util.stream.Collectors.toSet; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; import com.google.common.base.Throwables; +import com.google.common.collect.ImmutableList; import com.google.common.collect.Iterables; -import com.google.common.collect.Lists; -import com.google.common.util.concurrent.Runnables; import com.google.gerrit.entities.Account; import com.google.gerrit.exceptions.DuplicateKeyException; import com.google.gerrit.exceptions.StorageException; @@ -49,6 +50,7 @@ import com.google.inject.assistedinject.AssistedInject; import java.io.IOException; import java.sql.Timestamp; +import java.util.ArrayList; import java.util.List; import java.util.Objects; import java.util.Optional; @@ -63,18 +65,17 @@ /** * Creates and updates accounts. * - * <p>This class should be used for all account updates. It supports updating account properties, - * external IDs, preferences (general, diff and edit preferences) and project watches. + * <p>This class should be used for all account updates. See {@link AccountDelta} for what can be + * updated. * - * <p>Updates to one account are always atomic. Batch updating several accounts within one - * transaction is not supported. + * <p>Batch updates of multiple different accounts can be performed atomically, see {@link + * #updateBatch(List)}. Batch creation is not supported. * * <p>For any account update the caller must provide a commit message, the account ID and an {@link - * AccountUpdater}. The account updater allows to read the current {@link AccountState} and to - * prepare updates to the account by calling setters on the provided {@link - * InternalAccountUpdate.Builder}. If the current account state is of no interest the caller may - * also provide a {@link Consumer} for {@link InternalAccountUpdate.Builder} instead of the account - * updater. + * ConfigureDeltaFromState}. The account updater reads the current {@link AccountState} and prepares + * updates to the account by calling setters on the provided {@link AccountDelta.Builder}. If the + * current account state is of no interest the caller may also provide a {@link Consumer} for {@link + * AccountDelta.Builder} instead of the account updater. * * <p>The provided commit message is used for the update of the user branch. Using a precise and * unique commit message allows to identify the code from which an update was made when looking at a @@ -148,37 +149,35 @@ } /** - * Updater for an account. + * Account updates are commonly performed by evaluating the current account state and creating a + * delta to be applied to it in a later step. This is done by implementing this interface. * - * <p>Allows to read the current state of an account and to prepare updates to it. + * <p>If the current account state is not needed, use a {@link Consumer} of {@link + * AccountDelta.Builder} instead. */ @FunctionalInterface - public interface AccountUpdater { + public interface ConfigureDeltaFromState { /** - * Prepare updates to an account. + * Receives the current {@link AccountState} (which is immutable) and configures an {@link + * AccountDelta.Builder} with changes to the account. * - * <p>Use the provided account only to read the current state of the account. Don't do updates - * to the account. For updates use the provided account update builder. - * - * @param accountState the account that is being updated - * @param update account update builder + * @param accountState the state of the account that is being updated + * @param delta the changes to be applied */ - void update(AccountState accountState, InternalAccountUpdate.Builder update) throws IOException; + void configure(AccountState accountState, AccountDelta.Builder delta) throws IOException; + } - static AccountUpdater join(List<AccountUpdater> updaters) { - return (accountState, update) -> { - for (AccountUpdater updater : updaters) { - updater.update(accountState, update); - } - }; - } + /** Data holder for the set of arguments required to update an account. Used for batch updates. */ + public static class UpdateArguments { + private final String message; + private final Account.Id accountId; + private final ConfigureDeltaFromState configureDeltaFromState; - static AccountUpdater joinConsumers(List<Consumer<InternalAccountUpdate.Builder>> consumers) { - return join(Lists.transform(consumers, AccountUpdater::fromConsumer)); - } - - static AccountUpdater fromConsumer(Consumer<InternalAccountUpdate.Builder> consumer) { - return (a, u) -> consumer.accept(u); + public UpdateArguments( + String message, Account.Id accountId, ConfigureDeltaFromState configureDeltaFromState) { + this.message = message; + this.accountId = accountId; + this.configureDeltaFromState = configureDeltaFromState; } } @@ -193,13 +192,19 @@ private final PersonIdent committerIdent; private final PersonIdent authorIdent; - // Invoked after reading the account config. + /** Invoked after reading the account config. */ private final Runnable afterReadRevision; - // Invoked after updating the account but before committing the changes. + /** Invoked after updating the account but before committing the changes. */ private final Runnable beforeCommit; + /** Single instance that accumulates updates from the batch. */ + private ExternalIdNotes externalIdNotes; + + private static final Runnable DO_NOTHING = () -> {}; + @AssistedInject + @SuppressWarnings("BindingAnnotationWithoutInject") AccountsUpdate( GitRepositoryManager repoManager, GitReferenceUpdated gitRefUpdated, @@ -220,11 +225,12 @@ extIdNotesLoader, serverIdent, createPersonIdent(serverIdent, Optional.empty()), - Runnables.doNothing(), - Runnables.doNothing()); + DO_NOTHING, + DO_NOTHING); } @AssistedInject + @SuppressWarnings("BindingAnnotationWithoutInject") AccountsUpdate( GitRepositoryManager repoManager, GitReferenceUpdated gitRefUpdated, @@ -246,8 +252,8 @@ extIdNotesLoader, serverIdent, createPersonIdent(serverIdent, Optional.of(currentUser)), - Runnables.doNothing(), - Runnables.doNothing()); + DO_NOTHING, + DO_NOTHING); } @VisibleForTesting @@ -279,29 +285,32 @@ this.beforeCommit = requireNonNull(beforeCommit, "beforeCommit"); } + /** Returns an instance that runs all specified consumers. */ + public static ConfigureDeltaFromState joinConsumers( + List<Consumer<AccountDelta.Builder>> consumers) { + return (accountStateIgnored, update) -> consumers.forEach(c -> c.accept(update)); + } + + private static ConfigureDeltaFromState fromConsumer(Consumer<AccountDelta.Builder> consumer) { + return (a, u) -> consumer.accept(u); + } + private static PersonIdent createPersonIdent( PersonIdent serverIdent, Optional<IdentifiedUser> user) { - if (!user.isPresent()) { - return serverIdent; - } - return user.get().newCommitterIdent(serverIdent.getWhen(), serverIdent.getTimeZone()); + return user.isPresent() + ? user.get().newCommitterIdent(serverIdent.getWhen(), serverIdent.getTimeZone()) + : serverIdent; } /** - * Inserts a new account. - * - * @param message commit message for the account creation, must not be {@code null or empty} - * @param accountId ID of the new account - * @param init consumer to populate the new account - * @return the newly created account - * @throws DuplicateKeyException if the account already exists - * @throws IOException if creating the user branch fails due to an IO error - * @throws ConfigInvalidException if any of the account fields has an invalid value + * Like {@link #insert(String, Account.Id, ConfigureDeltaFromState)}, but using a {@link Consumer} + * instead, i.e. the update does not depend on the current account state (which, for insertion, + * would only contain the account ID). */ public AccountState insert( - String message, Account.Id accountId, Consumer<InternalAccountUpdate.Builder> init) + String message, Account.Id accountId, Consumer<AccountDelta.Builder> init) throws IOException, ConfigInvalidException { - return insert(message, accountId, AccountUpdater.fromConsumer(init)); + return insert(message, accountId, fromConsumer(init)); } /** @@ -309,57 +318,48 @@ * * @param message commit message for the account creation, must not be {@code null or empty} * @param accountId ID of the new account - * @param updater updater to populate the new account + * @param init to populate the new account * @return the newly created account * @throws DuplicateKeyException if the account already exists * @throws IOException if creating the user branch fails due to an IO error * @throws ConfigInvalidException if any of the account fields has an invalid value */ - public AccountState insert(String message, Account.Id accountId, AccountUpdater updater) + public AccountState insert(String message, Account.Id accountId, ConfigureDeltaFromState init) throws IOException, ConfigInvalidException { - return updateAccount( - r -> { - AccountConfig accountConfig = read(r, accountId); - Account account = - accountConfig.getNewAccount(new Timestamp(committerIdent.getWhen().getTime())); - AccountState accountState = AccountState.forAccount(account); - InternalAccountUpdate.Builder updateBuilder = InternalAccountUpdate.builder(); - updater.update(accountState, updateBuilder); + return execute( + ImmutableList.of( + repo -> { + AccountConfig accountConfig = read(repo, accountId); + Account account = + accountConfig.getNewAccount( + new Timestamp(committerIdent.getWhen().getTime())); + AccountState accountState = AccountState.forAccount(account); + AccountDelta.Builder deltaBuilder = AccountDelta.builder(); + init.configure(accountState, deltaBuilder); - InternalAccountUpdate update = updateBuilder.build(); - accountConfig.setAccountUpdate(update); - ExternalIdNotes extIdNotes = - createExternalIdNotes(r, accountConfig.getExternalIdsRev(), accountId, update); - CachedPreferences defaultPreferences = - CachedPreferences.fromConfig(VersionedDefaultPreferences.get(r, allUsersName)); + AccountDelta accountDelta = deltaBuilder.build(); + accountConfig.setAccountDelta(accountDelta); + externalIdNotes = + createExternalIdNotes( + repo, accountConfig.getExternalIdsRev(), accountId, accountDelta); + CachedPreferences defaultPreferences = + CachedPreferences.fromConfig( + VersionedDefaultPreferences.get(repo, allUsersName)); - UpdatedAccount updatedAccounts = - new UpdatedAccount( - externalIds, message, accountConfig, extIdNotes, defaultPreferences); - updatedAccounts.setCreated(true); - return updatedAccounts; - }) + return new UpdatedAccount(message, accountConfig, defaultPreferences, true); + })) + .get(0) .get(); } /** - * Gets the account and updates it atomically. - * - * <p>Changing the registration date of an account is not supported. - * - * @param message commit message for the account update, must not be {@code null or empty} - * @param accountId ID of the account - * @param update consumer to update the account, only invoked if the account exists - * @return the updated account, {@link Optional#empty()} if the account doesn't exist - * @throws IOException if updating the user branch fails due to an IO error - * @throws LockFailureException if updating the user branch still fails due to concurrent updates - * after the retry timeout exceeded - * @throws ConfigInvalidException if any of the account fields has an invalid value + * Like {@link #update(String, Account.Id, ConfigureDeltaFromState)}, but using a {@link Consumer} + * instead, i.e. the update does not depend on the current account state. */ public Optional<AccountState> update( - String message, Account.Id accountId, Consumer<InternalAccountUpdate.Builder> update) - throws LockFailureException, IOException, ConfigInvalidException { - return update(message, accountId, AccountUpdater.fromConsumer(update)); + String message, Account.Id accountId, Consumer<AccountDelta.Builder> update) + throws IOException, ConfigInvalidException { + return update(message, accountId, fromConsumer(update)); } /** @@ -369,41 +369,77 @@ * * @param message commit message for the account update, must not be {@code null or empty} * @param accountId ID of the account - * @param updater updater to update the account, only invoked if the account exists + * @param configureDeltaFromState deltaBuilder to update the account, only invoked if the account + * exists * @return the updated account, {@link Optional#empty} if the account doesn't exist * @throws IOException if updating the user branch fails due to an IO error * @throws LockFailureException if updating the user branch still fails due to concurrent updates * after the retry timeout exceeded * @throws ConfigInvalidException if any of the account fields has an invalid value */ - public Optional<AccountState> update(String message, Account.Id accountId, AccountUpdater updater) + public Optional<AccountState> update( + String message, Account.Id accountId, ConfigureDeltaFromState configureDeltaFromState) throws LockFailureException, IOException, ConfigInvalidException { - return updateAccount( - r -> { - AccountConfig accountConfig = read(r, accountId); - CachedPreferences defaultPreferences = - CachedPreferences.fromConfig(VersionedDefaultPreferences.get(r, allUsersName)); - Optional<AccountState> account = - AccountState.fromAccountConfig(externalIds, accountConfig, defaultPreferences); - if (!account.isPresent()) { - return null; - } + return updateBatch( + ImmutableList.of(new UpdateArguments(message, accountId, configureDeltaFromState))) + .get(0); + } - InternalAccountUpdate.Builder updateBuilder = InternalAccountUpdate.builder(); - updater.update(account.get(), updateBuilder); + private ExecutableUpdate createExecutableUpdate(UpdateArguments updateArguments) { + return repo -> { + AccountConfig accountConfig = read(repo, updateArguments.accountId); + CachedPreferences defaultPreferences = + CachedPreferences.fromConfig(VersionedDefaultPreferences.get(repo, allUsersName)); + Optional<AccountState> accountState = + AccountState.fromAccountConfig(externalIds, accountConfig, defaultPreferences); + if (!accountState.isPresent()) { + return null; + } - InternalAccountUpdate update = updateBuilder.build(); - accountConfig.setAccountUpdate(update); - ExternalIdNotes extIdNotes = - createExternalIdNotes(r, accountConfig.getExternalIdsRev(), accountId, update); - CachedPreferences cachedDefaultPreferences = - CachedPreferences.fromConfig(VersionedDefaultPreferences.get(r, allUsersName)); + AccountDelta.Builder deltaBuilder = AccountDelta.builder(); + updateArguments.configureDeltaFromState.configure(accountState.get(), deltaBuilder); - UpdatedAccount updatedAccounts = - new UpdatedAccount( - externalIds, message, accountConfig, extIdNotes, cachedDefaultPreferences); - return updatedAccounts; - }); + AccountDelta delta = deltaBuilder.build(); + accountConfig.setAccountDelta(delta); + ExternalIdNotes.checkSameAccount( + Iterables.concat( + delta.getCreatedExternalIds(), + delta.getUpdatedExternalIds(), + delta.getDeletedExternalIds()), + updateArguments.accountId); + + if (externalIdNotes == null) { + externalIdNotes = + extIdNotesLoader.load( + repo, accountConfig.getExternalIdsRev().orElse(ObjectId.zeroId())); + } + externalIdNotes.replace(delta.getDeletedExternalIds(), delta.getCreatedExternalIds()); + externalIdNotes.upsert(delta.getUpdatedExternalIds()); + + CachedPreferences cachedDefaultPreferences = + CachedPreferences.fromConfig(VersionedDefaultPreferences.get(repo, allUsersName)); + + return new UpdatedAccount( + updateArguments.message, accountConfig, cachedDefaultPreferences, false); + }; + } + + /** + * Updates multiple different accounts atomically. This will only store a single new value (aka + * set of all external IDs of the host) in the external ID cache, which is important for storage + * economy. All {@code updates} must be for different accounts. + * + * <p>NOTE on error handling: Since updates are executed in multiple stages, with some stages + * resulting from the union of all individual updates, we cannot point to the update that caused + * the error. Callers should be aware that a single "update of death" (or a set of updates that + * together have this property) will always prevent the entire batch from being executed. + */ + public ImmutableList<Optional<AccountState>> updateBatch(List<UpdateArguments> updates) + throws IOException, ConfigInvalidException { + checkArgument( + updates.stream().map(u -> u.accountId.get()).distinct().count() == updates.size(), + "updates must all be for different accounts"); + return execute(updates.stream().map(this::createExecutableUpdate).collect(toList())); } private AccountConfig read(Repository allUsersRepo, Account.Id accountId) @@ -413,26 +449,35 @@ return accountConfig; } - private Optional<AccountState> updateAccount(AccountUpdate accountUpdate) + private ImmutableList<Optional<AccountState>> execute(List<ExecutableUpdate> executableUpdates) throws IOException, ConfigInvalidException { - return executeAccountUpdate( + List<Optional<AccountState>> accountState = new ArrayList<>(); + List<UpdatedAccount> updatedAccounts = new ArrayList<>(); + executeWithRetry( () -> { - try (Repository allUsersRepo = repoManager.openRepository(allUsersName)) { - UpdatedAccount updatedAccount = accountUpdate.update(allUsersRepo); - if (updatedAccount == null) { - return Optional.empty(); - } + // Reset state for retry. + externalIdNotes = null; + accountState.clear(); + updatedAccounts.clear(); - commit(allUsersRepo, updatedAccount); - return Optional.of(updatedAccount.getAccount()); + try (Repository allUsersRepo = repoManager.openRepository(allUsersName)) { + for (ExecutableUpdate executableUpdate : executableUpdates) { + updatedAccounts.add(executableUpdate.execute(allUsersRepo)); + } + commit( + allUsersRepo, updatedAccounts.stream().filter(Objects::nonNull).collect(toList())); + for (UpdatedAccount ua : updatedAccounts) { + accountState.add(ua == null ? Optional.empty() : ua.getAccountState()); + } } + return null; }); + return ImmutableList.copyOf(accountState); } - private Optional<AccountState> executeAccountUpdate(Action<Optional<AccountState>> action) - throws IOException, ConfigInvalidException { + private void executeWithRetry(Action<Void> action) throws IOException, ConfigInvalidException { try { - return retryHelper.accountUpdate("updateAccount", action).call(); + retryHelper.accountUpdate("updateAccount", action).call(); } catch (Exception e) { Throwables.throwIfUnchecked(e); Throwables.throwIfInstanceOf(e, IOException.class); @@ -442,10 +487,7 @@ } private ExternalIdNotes createExternalIdNotes( - Repository allUsersRepo, - Optional<ObjectId> rev, - Account.Id accountId, - InternalAccountUpdate update) + Repository allUsersRepo, Optional<ObjectId> rev, Account.Id accountId, AccountDelta update) throws IOException, ConfigInvalidException, DuplicateKeyException { ExternalIdNotes.checkSameAccount( Iterables.concat( @@ -460,73 +502,56 @@ return extIdNotes; } - private void commit(Repository allUsersRepo, UpdatedAccount updatedAccount) throws IOException { + private void commit(Repository allUsersRepo, List<UpdatedAccount> updatedAccounts) + throws IOException { + if (updatedAccounts.isEmpty()) { + return; + } + beforeCommit.run(); BatchRefUpdate batchRefUpdate = allUsersRepo.getRefDatabase().newBatchUpdate(); - if (updatedAccount.isCreated()) { - commitNewAccountConfig( - updatedAccount.getMessage(), - allUsersRepo, - batchRefUpdate, - updatedAccount.getAccountConfig()); - } else { + String externalIdUpdateMessage = + updatedAccounts.size() == 1 + ? Iterables.getOnlyElement(updatedAccounts).message + : "Batch update for " + updatedAccounts.size() + " accounts"; + for (UpdatedAccount updatedAccount : updatedAccounts) { + // These updates are all for different refs (because batches never update the same account + // more than once), so there can be multiple commits in the same batch, all with the same base + // revision in their AccountConfig. commitAccountConfig( - updatedAccount.getMessage(), + updatedAccount.message, allUsersRepo, batchRefUpdate, - updatedAccount.getAccountConfig()); - } + updatedAccount.accountConfig, + updatedAccount.created /* allowEmptyCommit */); + // When creating a new account we must allow empty commits so that the user branch gets + // created with an empty commit when no account properties are set and hence no + // 'account.config' file will be created. - commitExternalIdUpdates( - updatedAccount.getMessage(), - allUsersRepo, - batchRefUpdate, - updatedAccount.getExternalIdNotes()); + // These update the same ref, so they need to be stacked on top of one another using the same + // ExternalIdNotes instance. + commitExternalIdUpdates(externalIdUpdateMessage, allUsersRepo, batchRefUpdate); + } RefUpdateUtil.executeChecked(batchRefUpdate, allUsersRepo); - // Skip accounts that are updated when evicting the account cache via ExternalIdNotes to avoid - // double reindexing. The updated accounts will already be reindexed by ReindexAfterRefUpdate. - Set<Account.Id> accountsThatWillBeReindexByReindexAfterRefUpdate = - getUpdatedAccounts(batchRefUpdate); - updatedAccount - .getExternalIdNotes() - .updateCaches(accountsThatWillBeReindexByReindexAfterRefUpdate); + Set<Account.Id> accountsToSkipForReindex = getUpdatedAccountIds(batchRefUpdate); + extIdNotesLoader.updateExternalIdCacheAndMaybeReindexAccounts( + externalIdNotes, accountsToSkipForReindex); gitRefUpdated.fire( - allUsersName, batchRefUpdate, currentUser.map(user -> user.state()).orElse(null)); + allUsersName, batchRefUpdate, currentUser.map(IdentifiedUser::state).orElse(null)); } - private static Set<Account.Id> getUpdatedAccounts(BatchRefUpdate batchRefUpdate) { + private static Set<Account.Id> getUpdatedAccountIds(BatchRefUpdate batchRefUpdate) { return batchRefUpdate.getCommands().stream() .map(c -> Account.Id.fromRef(c.getRefName())) .filter(Objects::nonNull) .collect(toSet()); } - private void commitNewAccountConfig( - String message, - Repository allUsersRepo, - BatchRefUpdate batchRefUpdate, - AccountConfig accountConfig) - throws IOException { - // When creating a new account we must allow empty commits so that the user branch gets created - // with an empty commit when no account properties are set and hence no 'account.config' file - // will be created. - commitAccountConfig(message, allUsersRepo, batchRefUpdate, accountConfig, true); - } - - private void commitAccountConfig( - String message, - Repository allUsersRepo, - BatchRefUpdate batchRefUpdate, - AccountConfig accountConfig) - throws IOException { - commitAccountConfig(message, allUsersRepo, batchRefUpdate, accountConfig, false); - } - private void commitAccountConfig( String message, Repository allUsersRepo, @@ -541,13 +566,9 @@ } private void commitExternalIdUpdates( - String message, - Repository allUsersRepo, - BatchRefUpdate batchRefUpdate, - ExternalIdNotes extIdNotes) - throws IOException { + String message, Repository allUsersRepo, BatchRefUpdate batchRefUpdate) throws IOException { try (MetaDataUpdate md = createMetaDataUpdate(message, allUsersRepo, batchRefUpdate)) { - extIdNotes.commit(md); + externalIdNotes.commit(md); } } @@ -566,57 +587,31 @@ } @FunctionalInterface - private static interface AccountUpdate { - UpdatedAccount update(Repository allUsersRepo) throws IOException, ConfigInvalidException; + private interface ExecutableUpdate { + UpdatedAccount execute(Repository allUsersRepo) throws IOException, ConfigInvalidException; } - private static class UpdatedAccount { - private final ExternalIds externalIds; - private final String message; - private final AccountConfig accountConfig; - private final ExternalIdNotes extIdNotes; - private final CachedPreferences defaultPreferences; + private class UpdatedAccount { + final String message; + final AccountConfig accountConfig; + final CachedPreferences defaultPreferences; + final boolean created; - private boolean created; - - private UpdatedAccount( - ExternalIds externalIds, + UpdatedAccount( String message, AccountConfig accountConfig, - ExternalIdNotes extIdNotes, - CachedPreferences defaultPreferences) { + CachedPreferences defaultPreferences, + boolean created) { checkState(!Strings.isNullOrEmpty(message), "message for account update must be set"); - this.externalIds = requireNonNull(externalIds); this.message = requireNonNull(message); this.accountConfig = requireNonNull(accountConfig); - this.extIdNotes = requireNonNull(extIdNotes); this.defaultPreferences = defaultPreferences; - } - - public String getMessage() { - return message; - } - - public AccountConfig getAccountConfig() { - return accountConfig; - } - - public AccountState getAccount() throws IOException { - return AccountState.fromAccountConfig( - externalIds, accountConfig, extIdNotes, defaultPreferences) - .get(); - } - - public ExternalIdNotes getExternalIdNotes() { - return extIdNotes; - } - - public void setCreated(boolean created) { this.created = created; } - public boolean isCreated() { - return created; + Optional<AccountState> getAccountState() throws IOException { + return AccountState.fromAccountConfig( + externalIds, accountConfig, externalIdNotes, defaultPreferences); } } }
diff --git a/java/com/google/gerrit/server/account/AuthRequest.java b/java/com/google/gerrit/server/account/AuthRequest.java index ddb54a6..50ed532 100644 --- a/java/com/google/gerrit/server/account/AuthRequest.java +++ b/java/com/google/gerrit/server/account/AuthRequest.java
@@ -21,6 +21,9 @@ import com.google.common.base.Strings; import com.google.gerrit.common.Nullable; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; +import com.google.inject.Inject; +import com.google.inject.Singleton; import java.util.Optional; /** @@ -32,31 +35,52 @@ * not all OpenID providers return them, and not all non-OpenID systems can use them. */ public class AuthRequest { - /** Create a request for a local username, such as from LDAP. */ - public static AuthRequest forUser(String username) { - AuthRequest r = new AuthRequest(ExternalId.Key.create(SCHEME_GERRIT, username)); - r.setUserName(username); - return r; + @Singleton + public static class Factory { + private final ExternalIdKeyFactory externalIdKeyFactory; + + @Inject + public Factory(ExternalIdKeyFactory externalIdKeyFactory) { + this.externalIdKeyFactory = externalIdKeyFactory; + } + + public AuthRequest create(ExternalId.Key externalIdKey) { + return new AuthRequest(externalIdKey, externalIdKeyFactory); + } + + /** Create a request for a local username, such as from LDAP. */ + public AuthRequest createForUser(String username) { + AuthRequest r = + new AuthRequest( + externalIdKeyFactory.create(SCHEME_GERRIT, username), externalIdKeyFactory); + r.setUserName(username); + return r; + } + + /** Create a request for an external username. */ + public AuthRequest createForExternalUser(String username) { + AuthRequest r = + new AuthRequest( + externalIdKeyFactory.create(SCHEME_EXTERNAL, username), externalIdKeyFactory); + r.setUserName(username); + return r; + } + + /** + * Create a request for an email address registration. + * + * <p>This type of request should be used only to attach a new email address to an existing user + * account. + */ + public AuthRequest createForEmail(String email) { + AuthRequest r = + new AuthRequest(externalIdKeyFactory.create(SCHEME_MAILTO, email), externalIdKeyFactory); + r.setEmailAddress(email); + return r; + } } - /** Create a request for an external username. */ - public static AuthRequest forExternalUser(String username) { - AuthRequest r = new AuthRequest(ExternalId.Key.create(SCHEME_EXTERNAL, username)); - r.setUserName(username); - return r; - } - - /** - * Create a request for an email address registration. - * - * <p>This type of request should be used only to attach a new email address to an existing user - * account. - */ - public static AuthRequest forEmail(String email) { - AuthRequest r = new AuthRequest(ExternalId.Key.create(SCHEME_MAILTO, email)); - r.setEmailAddress(email); - return r; - } + private final ExternalIdKeyFactory externalIdKeyFactory; private ExternalId.Key externalId; private String password; @@ -69,8 +93,9 @@ private boolean authProvidesAccountActiveStatus; private boolean active; - public AuthRequest(ExternalId.Key externalId) { + private AuthRequest(ExternalId.Key externalId, ExternalIdKeyFactory externalIdKeyFactory) { this.externalId = externalId; + this.externalIdKeyFactory = externalIdKeyFactory; } public ExternalId.Key getExternalIdKey() { @@ -86,7 +111,7 @@ public void setLocalUser(String localUser) { if (externalId.isScheme(SCHEME_GERRIT)) { - externalId = ExternalId.Key.create(SCHEME_GERRIT, localUser); + externalId = externalIdKeyFactory.create(SCHEME_GERRIT, localUser); } }
diff --git a/java/com/google/gerrit/server/account/GroupBackend.java b/java/com/google/gerrit/server/account/GroupBackend.java index d6360c5..e02c27b 100644 --- a/java/com/google/gerrit/server/account/GroupBackend.java +++ b/java/com/google/gerrit/server/account/GroupBackend.java
@@ -26,7 +26,7 @@ /** Implementations of GroupBackend provide lookup and membership accessors to a group system. */ @ExtensionPoint public interface GroupBackend { - /** @return {@code true} if the backend can operate on the UUID. */ + /** Returns {@code true} if the backend can operate on the UUID. */ boolean handles(AccountGroup.UUID uuid); /** @@ -38,12 +38,36 @@ @Nullable GroupDescription.Basic get(AccountGroup.UUID uuid); - /** @return suggestions for the group name sorted by name. */ + /** Returns suggestions for the group name sorted by name. */ Collection<GroupReference> suggest(String name, @Nullable ProjectState project); - /** @return the group membership checker for the backend. */ + /** Returns the group membership checker for the backend. */ GroupMembership membershipsOf(CurrentUser user); - /** @return {@code true} if the group with the given UUID is visible to all registered users. */ + /** Returns {@code true} if the group with the given UUID is visible to all registered users. */ boolean isVisibleToAll(AccountGroup.UUID uuid); + + default boolean isOrContainsExternalGroup(AccountGroup.UUID groupId) { + if (groupId != null) { + GroupDescription.Basic groupDescription = get(groupId); + if (!(groupDescription instanceof GroupDescription.Internal) + || containsExternalSubGroups((GroupDescription.Internal) groupDescription)) { + return true; + } + } + return false; + } + + private boolean containsExternalSubGroups(GroupDescription.Internal internalGroup) { + for (AccountGroup.UUID subGroupUuid : internalGroup.getSubgroups()) { + GroupDescription.Basic subGroupDescription = get(subGroupUuid); + if (!(subGroupDescription instanceof GroupDescription.Internal)) { + return true; + } + if (containsExternalSubGroups((GroupDescription.Internal) subGroupDescription)) { + return true; + } + } + return false; + } }
diff --git a/java/com/google/gerrit/server/account/GroupCache.java b/java/com/google/gerrit/server/account/GroupCache.java index aaae95a..1e28d7d 100644 --- a/java/com/google/gerrit/server/account/GroupCache.java +++ b/java/com/google/gerrit/server/account/GroupCache.java
@@ -103,6 +103,10 @@ */ void evict(AccountGroup.UUID groupUuid); - /** @see #evict(AccountGroup.UUID); */ + /** + * Removes the association of the given UUIDs with groups + * + * <p>See {@link #evict(AccountGroup.UUID)} + */ void evict(Collection<AccountGroup.UUID> groupUuid); }
diff --git a/java/com/google/gerrit/server/account/GroupCacheImpl.java b/java/com/google/gerrit/server/account/GroupCacheImpl.java index eaec9ba..36f725f 100644 --- a/java/com/google/gerrit/server/account/GroupCacheImpl.java +++ b/java/com/google/gerrit/server/account/GroupCacheImpl.java
@@ -283,7 +283,7 @@ List<Cache.GroupKeyProto> keyList = new ArrayList<>(); try (TraceTimer ignored = TraceContext.newTimer( - "Loading group from serialized cache", + "Building keys to load group(s) from serialized cache", Metadata.builder().cacheName(BYUUID_NAME_PERSISTED).build()); Repository allUsers = repoManager.openRepository(allUsersName)) { while (uuidIterator.hasNext()) { @@ -302,8 +302,13 @@ keyList.add(key); } } - persistedCache.getAll(keyList).entrySet().stream() - .forEach(g -> toReturn.put(g.getKey().getUuid(), Optional.of(g.getValue()))); + try (TraceTimer ignored = + TraceContext.newTimer( + "Loading group(s) from serialized cache", + Metadata.builder().cacheName(BYUUID_NAME_PERSISTED).build())) { + persistedCache.getAll(keyList).entrySet().stream() + .forEach(g -> toReturn.put(g.getKey().getUuid(), Optional.of(g.getValue()))); + } return toReturn; } }
diff --git a/java/com/google/gerrit/server/account/GroupIncludeCache.java b/java/com/google/gerrit/server/account/GroupIncludeCache.java index 6547619..d92d9fc 100644 --- a/java/com/google/gerrit/server/account/GroupIncludeCache.java +++ b/java/com/google/gerrit/server/account/GroupIncludeCache.java
@@ -37,7 +37,7 @@ */ Collection<AccountGroup.UUID> parentGroupsOf(AccountGroup.UUID groupId); - /** @return set of any UUIDs that are not internal groups. */ + /** Returns set of any UUIDs that are not internal groups. */ Collection<AccountGroup.UUID> allExternalMembers(); void evictGroupsWithMember(Account.Id memberId);
diff --git a/java/com/google/gerrit/server/account/InternalAccountDirectory.java b/java/com/google/gerrit/server/account/InternalAccountDirectory.java index 13b71cf..f7b0b60 100644 --- a/java/com/google/gerrit/server/account/InternalAccountDirectory.java +++ b/java/com/google/gerrit/server/account/InternalAccountDirectory.java
@@ -14,22 +14,25 @@ package com.google.gerrit.server.account; +import static com.google.common.collect.Streams.stream; import static java.util.stream.Collectors.toList; import static java.util.stream.Collectors.toSet; +import static java.util.stream.Stream.concat; import com.google.common.base.Strings; -import com.google.common.collect.ImmutableList; import com.google.common.collect.Sets; -import com.google.common.collect.Streams; import com.google.gerrit.entities.Account; import com.google.gerrit.extensions.common.AccountInfo; +import com.google.gerrit.extensions.common.AccountInfo.Tags; import com.google.gerrit.extensions.common.AvatarInfo; import com.google.gerrit.extensions.registration.DynamicItem; +import com.google.gerrit.extensions.registration.DynamicMap; import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.account.externalids.ExternalId; import com.google.gerrit.server.avatar.AvatarProvider; +import com.google.gerrit.server.data.AccountAttribute; import com.google.gerrit.server.permissions.GlobalPermission; import com.google.gerrit.server.permissions.PermissionBackend; import com.google.gerrit.server.permissions.PermissionBackendException; @@ -45,12 +48,16 @@ import java.util.Map; import java.util.Objects; import java.util.Set; +import java.util.stream.Stream; @Singleton public class InternalAccountDirectory extends AccountDirectory { static final Set<FillOptions> ID_ONLY = Collections.unmodifiableSet(EnumSet.of(FillOptions.ID)); + static final Set<FillOptions> ALL_ACCOUNT_ATTRIBUTES = + Collections.unmodifiableSet( + EnumSet.of(FillOptions.NAME, FillOptions.EMAIL, FillOptions.USERNAME)); - public static class Module extends AbstractModule { + public static class InternalAccountDirectoryModule extends AbstractModule { @Override protected void configure() { bind(AccountDirectory.class).to(InternalAccountDirectory.class); @@ -63,6 +70,7 @@ private final Provider<CurrentUser> self; private final PermissionBackend permissionBackend; private final ServiceUserClassifier serviceUserClassifier; + private final DynamicMap<AccountTagProvider> accountTagProviders; @Inject InternalAccountDirectory( @@ -71,13 +79,15 @@ IdentifiedUser.GenericFactory userFactory, Provider<CurrentUser> self, PermissionBackend permissionBackend, - ServiceUserClassifier serviceUserClassifier) { + ServiceUserClassifier serviceUserClassifier, + DynamicMap<AccountTagProvider> accountTagProviders) { this.accountCache = accountCache; this.avatar = avatar; this.userFactory = userFactory; this.self = self; this.permissionBackend = permissionBackend; this.serviceUserClassifier = serviceUserClassifier; + this.accountTagProviders = accountTagProviders; } @Override @@ -102,7 +112,7 @@ Set<FillOptions> fillOptionsWithoutSecondaryEmails = Sets.difference(options, EnumSet.of(FillOptions.SECONDARY_EMAILS)); - Set<Account.Id> ids = Streams.stream(in).map(a -> Account.id(a._accountId)).collect(toSet()); + Set<Account.Id> ids = stream(in).map(a -> Account.id(a._accountId)).collect(toSet()); Map<Account.Id, AccountState> accountStates = accountCache.get(ids); for (AccountInfo info : in) { Account.Id id = Account.id(info._accountId); @@ -123,6 +133,44 @@ } } + @Override + public void fillAccountAttributeInfo(Iterable<? extends AccountAttribute> in) { + Set<Account.Id> ids = stream(in).map(a -> Account.id(a.accountId)).collect(toSet()); + Map<Account.Id, AccountState> accountStates = accountCache.get(ids); + for (AccountAttribute accountAttribute : in) { + Account.Id id = Account.id(accountAttribute.accountId); + AccountState accountState = accountStates.get(id); + if (accountState != null) { + fill(accountAttribute, accountState, ALL_ACCOUNT_ATTRIBUTES); + } else { + accountAttribute.accountId = null; + } + } + } + + private void fill( + AccountAttribute accountAttribute, AccountState accountState, Set<FillOptions> options) { + Account account = accountState.account(); + if (options.contains(FillOptions.NAME)) { + accountAttribute.name = Strings.emptyToNull(account.fullName()); + if (accountAttribute.name == null) { + accountAttribute.name = accountState.userName().orElse(null); + } + } + if (options.contains(FillOptions.EMAIL)) { + accountAttribute.email = account.preferredEmail(); + } + if (options.contains(FillOptions.USERNAME)) { + accountAttribute.username = accountState.userName().orElse(null); + } + if (options.contains(FillOptions.ID)) { + accountAttribute.accountId = account.id().get(); + } else { + // Was previously set to look up account for filling. + accountAttribute.accountId = null; + } + } + private void fill(AccountInfo info, AccountState accountState, Set<FillOptions> options) { Account account = accountState.account(); if (options.contains(FillOptions.ID)) { @@ -160,10 +208,10 @@ } if (options.contains(FillOptions.TAGS)) { - info.tags = - serviceUserClassifier.isServiceUser(account.id()) - ? ImmutableList.of(AccountInfo.Tag.SERVICE_USER) - : null; + List<String> tags = getTags(account.id()); + if (!tags.isEmpty()) { + info.tags = tags; + } } if (options.contains(FillOptions.AVATARS)) { @@ -194,6 +242,15 @@ .collect(toList()); } + private List<String> getTags(Account.Id id) { + Stream<String> tagsFromProviders = + stream(accountTagProviders.iterator()) + .flatMap(accountTagProvider -> accountTagProvider.get().getTags(id).stream()); + Stream<String> tagsFromServiceUserClassifier = + serviceUserClassifier.isServiceUser(id) ? Stream.of(Tags.SERVICE_USER) : Stream.empty(); + return concat(tagsFromProviders, tagsFromServiceUserClassifier).collect(toList()); + } + private static void addAvatar( AvatarProvider provider, AccountInfo account, IdentifiedUser user, int size) { String url = provider.getUrl(user, size);
diff --git a/java/com/google/gerrit/server/account/Realm.java b/java/com/google/gerrit/server/account/Realm.java index d56ed07..3f642f7 100644 --- a/java/com/google/gerrit/server/account/Realm.java +++ b/java/com/google/gerrit/server/account/Realm.java
@@ -41,10 +41,10 @@ void onCreateAccount(AuthRequest who, Account account); - /** @return true if the user has the given email address. */ + /** Returns true if the user has the given email address. */ boolean hasEmailAddress(IdentifiedUser who, String email); - /** @return all known email addresses for the identified user. */ + /** Returns all known email addresses for the identified user. */ Set<String> getEmailAddresses(IdentifiedUser who); /** @@ -56,19 +56,13 @@ */ Account.Id lookup(String accountName) throws IOException; - /** - * @return true if the account is active. - * @throws NamingException - * @throws LoginException - * @throws AccountException - * @throws IOException - */ + /** Returns true if the account is active. */ default boolean isActive(@SuppressWarnings("unused") String username) throws LoginException, NamingException, AccountException, IOException { return true; } - /** @return true if the account is backed by the realm, false otherwise. */ + /** Returns true if the account is backed by the realm, false otherwise. */ default boolean accountBelongsToRealm( @SuppressWarnings("unused") Collection<ExternalId> externalIds) { return false;
diff --git a/java/com/google/gerrit/server/account/ServiceUserClassifierImpl.java b/java/com/google/gerrit/server/account/ServiceUserClassifierImpl.java index 27ac9f4..db030f9 100644 --- a/java/com/google/gerrit/server/account/ServiceUserClassifierImpl.java +++ b/java/com/google/gerrit/server/account/ServiceUserClassifierImpl.java
@@ -76,7 +76,7 @@ .get(toTraverse.remove(0)) .orElseThrow(() -> new IllegalStateException("invalid subgroup")); if (seen.contains(currentGroup.getGroupUUID())) { - logger.atWarning().log( + logger.atFine().log( "Skipping %s because it's a cyclic subgroup", currentGroup.getGroupUUID()); continue; }
diff --git a/java/com/google/gerrit/server/account/SetInactiveFlag.java b/java/com/google/gerrit/server/account/SetInactiveFlag.java index 4b68198..5babebd 100644 --- a/java/com/google/gerrit/server/account/SetInactiveFlag.java +++ b/java/com/google/gerrit/server/account/SetInactiveFlag.java
@@ -55,26 +55,30 @@ throws RestApiException, IOException, ConfigInvalidException { AtomicBoolean alreadyInactive = new AtomicBoolean(false); AtomicReference<Optional<RestApiException>> exception = new AtomicReference<>(Optional.empty()); - accountsUpdateProvider - .get() - .update( - "Deactivate Account via API", - accountId, - (a, u) -> { - if (!a.account().isActive()) { - alreadyInactive.set(true); - } else { - try { - accountActivationValidationListeners.runEach( - l -> l.validateDeactivation(a), ValidationException.class); - } catch (ValidationException e) { - exception.set(Optional.of(new ResourceConflictException(e.getMessage(), e))); - return; - } - u.setActive(false); - } - }) - .orElseThrow(() -> new ResourceNotFoundException("account not found")); + Optional<AccountState> updatedAccount = + accountsUpdateProvider + .get() + .update( + "Deactivate Account via API", + accountId, + (a, u) -> { + if (!a.account().isActive()) { + alreadyInactive.set(true); + } else { + try { + accountActivationValidationListeners.runEach( + l -> l.validateDeactivation(a), ValidationException.class); + } catch (ValidationException e) { + exception.set(Optional.of(new ResourceConflictException(e.getMessage(), e))); + return; + } + u.setActive(false); + } + }); + if (!updatedAccount.isPresent()) { + throw new ResourceNotFoundException("account not found"); + } + if (exception.get().isPresent()) { throw exception.get().get(); } @@ -94,26 +98,30 @@ throws RestApiException, IOException, ConfigInvalidException { AtomicBoolean alreadyActive = new AtomicBoolean(false); AtomicReference<Optional<RestApiException>> exception = new AtomicReference<>(Optional.empty()); - accountsUpdateProvider - .get() - .update( - "Activate Account via API", - accountId, - (a, u) -> { - if (a.account().isActive()) { - alreadyActive.set(true); - } else { - try { - accountActivationValidationListeners.runEach( - l -> l.validateActivation(a), ValidationException.class); - } catch (ValidationException e) { - exception.set(Optional.of(new ResourceConflictException(e.getMessage(), e))); - return; - } - u.setActive(true); - } - }) - .orElseThrow(() -> new ResourceNotFoundException("account not found")); + Optional<AccountState> updatedAccount = + accountsUpdateProvider + .get() + .update( + "Activate Account via API", + accountId, + (a, u) -> { + if (a.account().isActive()) { + alreadyActive.set(true); + } else { + try { + accountActivationValidationListeners.runEach( + l -> l.validateActivation(a), ValidationException.class); + } catch (ValidationException e) { + exception.set(Optional.of(new ResourceConflictException(e.getMessage(), e))); + return; + } + u.setActive(true); + } + }); + if (!updatedAccount.isPresent()) { + throw new ResourceNotFoundException("account not found"); + } + if (exception.get().isPresent()) { throw exception.get().get(); }
diff --git a/java/com/google/gerrit/server/account/VersionedAuthorizedKeys.java b/java/com/google/gerrit/server/account/VersionedAuthorizedKeys.java index 30021e6..555a2c1 100644 --- a/java/com/google/gerrit/server/account/VersionedAuthorizedKeys.java +++ b/java/com/google/gerrit/server/account/VersionedAuthorizedKeys.java
@@ -206,7 +206,6 @@ * * @param pub the public SSH key to be added * @return the new SSH key - * @throws InvalidSshKeyException */ private AccountSshKey addKey(String pub) throws InvalidSshKeyException { checkLoaded();
diff --git a/java/com/google/gerrit/server/account/externalids/AllExternalIds.java b/java/com/google/gerrit/server/account/externalids/AllExternalIds.java index 4da2a9e..e718bcb 100644 --- a/java/com/google/gerrit/server/account/externalids/AllExternalIds.java +++ b/java/com/google/gerrit/server/account/externalids/AllExternalIds.java
@@ -14,41 +14,38 @@ package com.google.gerrit.server.account.externalids; -import static com.google.common.collect.ImmutableSetMultimap.toImmutableSetMultimap; -import static java.util.stream.Collectors.toList; - import com.google.auto.value.AutoValue; import com.google.common.base.Strings; +import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSetMultimap; -import com.google.common.collect.SetMultimap; import com.google.gerrit.entities.Account; import com.google.gerrit.proto.Protos; import com.google.gerrit.server.cache.proto.Cache.AllExternalIdsProto; import com.google.gerrit.server.cache.proto.Cache.AllExternalIdsProto.ExternalIdProto; import com.google.gerrit.server.cache.serialize.CacheSerializer; import com.google.gerrit.server.cache.serialize.ObjectIdConverter; -import java.util.Collection; +import java.util.stream.Stream; /** Cache value containing all external IDs. */ @AutoValue public abstract class AllExternalIds { - static AllExternalIds create(SetMultimap<Account.Id, ExternalId> byAccount) { - return new AutoValue_AllExternalIds( - ImmutableSetMultimap.copyOf(byAccount), byEmailCopy(byAccount.values())); + static AllExternalIds create(Stream<ExternalId> externalIds) { + ImmutableMap.Builder<ExternalId.Key, ExternalId> byKey = ImmutableMap.builder(); + ImmutableSetMultimap.Builder<Account.Id, ExternalId> byAccount = ImmutableSetMultimap.builder(); + ImmutableSetMultimap.Builder<String, ExternalId> byEmail = ImmutableSetMultimap.builder(); + externalIds.forEach( + id -> { + byKey.put(id.key(), id); + byAccount.put(id.accountId(), id); + if (!Strings.isNullOrEmpty(id.email())) { + byEmail.put(id.email(), id); + } + }); + + return new AutoValue_AllExternalIds(byKey.build(), byAccount.build(), byEmail.build()); } - static AllExternalIds create(Collection<ExternalId> externalIds) { - return new AutoValue_AllExternalIds( - externalIds.stream().collect(toImmutableSetMultimap(ExternalId::accountId, e -> e)), - byEmailCopy(externalIds)); - } - - private static ImmutableSetMultimap<String, ExternalId> byEmailCopy( - Collection<ExternalId> externalIds) { - return externalIds.stream() - .filter(e -> !Strings.isNullOrEmpty(e.email())) - .collect(toImmutableSetMultimap(ExternalId::email, e -> e)); - } + public abstract ImmutableMap<ExternalId.Key, ExternalId> byKey(); public abstract ImmutableSetMultimap<Account.Id, ExternalId> byAccount(); @@ -71,7 +68,8 @@ ExternalIdProto.Builder b = ExternalIdProto.newBuilder() .setKey(externalId.key().get()) - .setAccountId(externalId.accountId().get()); + .setAccountId(externalId.accountId().get()) + .setIsCaseInsensitive(externalId.isCaseInsensitive()); if (externalId.email() != null) { b.setEmail(externalId.email()); } @@ -89,13 +87,12 @@ ObjectIdConverter idConverter = ObjectIdConverter.create(); return create( Protos.parseUnchecked(AllExternalIdsProto.parser(), in).getExternalIdList().stream() - .map(proto -> toExternalId(idConverter, proto)) - .collect(toList())); + .map(proto -> toExternalId(idConverter, proto))); } private static ExternalId toExternalId(ObjectIdConverter idConverter, ExternalIdProto proto) { return ExternalId.create( - ExternalId.Key.parse(proto.getKey()), + ExternalId.Key.parse(proto.getKey(), proto.getIsCaseInsensitive()), Account.id(proto.getAccountId()), // ExternalId treats null and empty strings the same, so no need to distinguish here. proto.getEmail(),
diff --git a/java/com/google/gerrit/server/account/externalids/DisabledExternalIdCache.java b/java/com/google/gerrit/server/account/externalids/DisabledExternalIdCache.java index e1e9c70..1cd3de8 100644 --- a/java/com/google/gerrit/server/account/externalids/DisabledExternalIdCache.java +++ b/java/com/google/gerrit/server/account/externalids/DisabledExternalIdCache.java
@@ -21,6 +21,7 @@ import com.google.inject.Module; import java.io.IOException; import java.util.Collection; +import java.util.Optional; import org.eclipse.jgit.lib.ObjectId; public class DisabledExternalIdCache implements ExternalIdCache { @@ -42,6 +43,11 @@ Collection<ExternalId> toAdd) {} @Override + public Optional<ExternalId> byKey(ExternalId.Key key) throws IOException { + throw new UnsupportedOperationException(); + } + + @Override public ImmutableSet<ExternalId> byAccount(Account.Id accountId) { throw new UnsupportedOperationException(); }
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalId.java b/java/com/google/gerrit/server/account/externalids/ExternalId.java index 71ce4d8..0a51171 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalId.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalId.java
@@ -17,35 +17,29 @@ import static com.google.common.base.Preconditions.checkState; import static com.google.common.collect.ImmutableSet.toImmutableSet; import static java.nio.charset.StandardCharsets.UTF_8; -import static java.util.Objects.requireNonNull; import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; import com.google.common.collect.ImmutableSet; -import com.google.common.collect.Iterables; -import com.google.common.flogger.FluentLogger; import com.google.common.hash.Hashing; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; import com.google.gerrit.extensions.client.AuthType; import com.google.gerrit.git.ObjectIds; -import com.google.gerrit.server.account.HashedPassword; import java.io.Serializable; import java.util.Collection; +import java.util.Locale; import java.util.Objects; import java.util.Optional; -import java.util.Set; import java.util.regex.Pattern; import java.util.stream.Stream; -import org.eclipse.jgit.errors.ConfigInvalidException; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.ObjectId; @AutoValue public abstract class ExternalId implements Serializable { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - // If these regular expressions are modified the same modifications should be done to the // corresponding regular expressions in the // com.google.gerrit.client.account.UsernameField class. @@ -106,10 +100,10 @@ private static final long serialVersionUID = 1L; - private static final String EXTERNAL_ID_SECTION = "externalId"; - private static final String ACCOUNT_ID_KEY = "accountId"; - private static final String EMAIL_KEY = "email"; - private static final String PASSWORD_KEY = "password"; + static final String EXTERNAL_ID_SECTION = "externalId"; + static final String ACCOUNT_ID_KEY = "accountId"; + static final String EMAIL_KEY = "email"; + static final String PASSWORD_KEY = "password"; /** * Scheme used to label accounts created, when using the LDAP-based authentication types {@link @@ -120,6 +114,8 @@ * <p>The name {@code gerrit:} was a very poor choice. * * <p>Scheme names must not contain colons (':'). + * + * <p>Will be handled case insensitive, if auth.userNameCaseInsensitive = true. */ public static final String SCHEME_GERRIT = "gerrit"; @@ -129,7 +125,11 @@ /** Scheme used to represent only an email address. */ public static final String SCHEME_MAILTO = "mailto"; - /** Scheme for the username used to authenticate an account, e.g. over SSH. */ + /** + * Scheme for the username used to authenticate an account, e.g. over SSH. + * + * <p>Will be handled case insensitive, if auth.userNameCaseInsensitive = true. + */ public static final String SCHEME_USERNAME = "username"; /** Scheme used for GPG public keys. */ @@ -156,10 +156,12 @@ * * @param scheme the scheme name, must not contain colons (':'), can be {@code null} * @param id the external ID, must not contain colons (':') + * @param isCaseInsensitive whether the external ID key is matched case insensitively * @return the created external ID key */ - public static Key create(@Nullable String scheme, String id) { - return new AutoValue_ExternalId_Key(Strings.emptyToNull(scheme), id); + @VisibleForTesting + public static Key create(@Nullable String scheme, String id, boolean isCaseInsensitive) { + return new AutoValue_ExternalId_Key(Strings.emptyToNull(scheme), id, isCaseInsensitive); } /** @@ -167,29 +169,43 @@ * * @return the parsed external ID key */ - public static Key parse(String externalId) { + @VisibleForTesting + public static Key parse(String externalId, boolean isCaseInsensitive) { int c = externalId.indexOf(':'); if (c < 1 || c >= externalId.length() - 1) { - return create(null, externalId); + return create(null, externalId, isCaseInsensitive); } - return create(externalId.substring(0, c), externalId.substring(c + 1)); + return create(externalId.substring(0, c), externalId.substring(c + 1), isCaseInsensitive); } public abstract @Nullable String scheme(); public abstract String id(); + public abstract boolean isCaseInsensitive(); + public boolean isScheme(String scheme) { return scheme.equals(scheme()); } + @Memoized + public ObjectId sha1() { + return sha1(isCaseInsensitive()); + } + /** * Returns the SHA1 of the external ID that is used as note ID in the refs/meta/external-ids * notes branch. */ @SuppressWarnings("deprecation") // Use Hashing.sha1 for compatibility. - public ObjectId sha1() { - return ObjectId.fromRaw(Hashing.sha1().hashString(get(), UTF_8).asBytes()); + private ObjectId sha1(Boolean isCaseInsensitive) { + String keyString = isCaseInsensitive ? get().toLowerCase(Locale.US) : get(); + return ObjectId.fromRaw(Hashing.sha1().hashString(keyString, UTF_8).asBytes()); + } + + @Memoized + public ObjectId caseSensitiveSha1() { + return sha1(false); } /** @@ -211,100 +227,27 @@ return get(); } + @Override + public final boolean equals(Object obj) { + if (!(obj instanceof ExternalId.Key)) { + return false; + } + ExternalId.Key o = (ExternalId.Key) obj; + + return sha1().equals(o.sha1()); + } + + @Override + @Memoized + public int hashCode() { + return Objects.hash(sha1()); + } + public static ImmutableSet<ExternalId.Key> from(Collection<ExternalId> extIds) { return extIds.stream().map(ExternalId::key).collect(toImmutableSet()); } } - /** - * Creates an external ID. - * - * @param scheme the scheme name, must not contain colons (':') - * @param id the external ID, must not contain colons (':') - * @param accountId the ID of the account to which the external ID belongs - * @return the created external ID - */ - public static ExternalId create(String scheme, String id, Account.Id accountId) { - return create(Key.create(scheme, id), accountId, null, null); - } - - /** - * Creates an external ID. - * - * @param scheme the scheme name, must not contain colons (':') - * @param id the external ID, must not contain colons (':') - * @param accountId the ID of the account to which the external ID belongs - * @param email the email of the external ID, may be {@code null} - * @param hashedPassword the hashed password of the external ID, may be {@code null} - * @return the created external ID - */ - public static ExternalId create( - String scheme, - String id, - Account.Id accountId, - @Nullable String email, - @Nullable String hashedPassword) { - return create(Key.create(scheme, id), accountId, email, hashedPassword); - } - - public static ExternalId create(Key key, Account.Id accountId) { - return create(key, accountId, null, null); - } - - public static ExternalId create( - Key key, Account.Id accountId, @Nullable String email, @Nullable String hashedPassword) { - return create( - key, accountId, Strings.emptyToNull(email), Strings.emptyToNull(hashedPassword), null); - } - - public static ExternalId createWithPassword( - Key key, Account.Id accountId, @Nullable String email, @Nullable String plainPassword) { - plainPassword = Strings.emptyToNull(plainPassword); - String hashedPassword = - plainPassword != null ? HashedPassword.fromPassword(plainPassword).encode() : null; - return create(key, accountId, email, hashedPassword); - } - - /** - * Create a external ID for a username (scheme "username"). - * - * @param id the external ID, must not contain colons (':') - * @param accountId the ID of the account to which the external ID belongs - * @param plainPassword the plain HTTP password, may be {@code null} - * @return the created external ID - */ - public static ExternalId createUsername( - String id, Account.Id accountId, @Nullable String plainPassword) { - return createWithPassword(Key.create(SCHEME_USERNAME, id), accountId, null, plainPassword); - } - - /** - * Creates an external ID with an email. - * - * @param scheme the scheme name, must not contain colons (':') - * @param id the external ID, must not contain colons (':') - * @param accountId the ID of the account to which the external ID belongs - * @param email the email of the external ID, may be {@code null} - * @return the created external ID - */ - public static ExternalId createWithEmail( - String scheme, String id, Account.Id accountId, @Nullable String email) { - return createWithEmail(Key.create(scheme, id), accountId, email); - } - - public static ExternalId createWithEmail(Key key, Account.Id accountId, @Nullable String email) { - return create(key, accountId, Strings.emptyToNull(email), null); - } - - public static ExternalId createEmail(Account.Id accountId, String email) { - return createWithEmail(SCHEME_MAILTO, email, accountId, requireNonNull(email)); - } - - static ExternalId create(ExternalId extId, @Nullable ObjectId blobId) { - return new AutoValue_ExternalId( - extId.key(), extId.accountId(), extId.email(), extId.password(), blobId); - } - @VisibleForTesting public static ExternalId create( Key key, @@ -313,116 +256,20 @@ @Nullable String hashedPassword, @Nullable ObjectId blobId) { return new AutoValue_ExternalId( - key, accountId, Strings.emptyToNull(email), Strings.emptyToNull(hashedPassword), blobId); - } - - /** - * Parses an external ID from a byte array that contain the external ID as an Git config file - * text. - * - * <p>The Git config must have exactly one externalId subsection with an accountId and optionally - * email and password: - * - * <pre> - * [externalId "username:jdoe"] - * accountId = 1003407 - * email = jdoe@example.com - * password = bcrypt:4:LCbmSBDivK/hhGVQMfkDpA==:XcWn0pKYSVU/UJgOvhidkEtmqCp6oKB7 - * </pre> - */ - public static ExternalId parse(String noteId, byte[] raw, ObjectId blobId) - throws ConfigInvalidException { - Config externalIdConfig = new Config(); - try { - externalIdConfig.fromText(new String(raw, UTF_8)); - } catch (ConfigInvalidException e) { - throw invalidConfig(noteId, e.getMessage()); - } - - return parse(noteId, externalIdConfig, blobId); - } - - public static ExternalId parse(String noteId, Config externalIdConfig, ObjectId blobId) - throws ConfigInvalidException { - requireNonNull(blobId); - - Set<String> externalIdKeys = externalIdConfig.getSubsections(EXTERNAL_ID_SECTION); - if (externalIdKeys.size() != 1) { - throw invalidConfig( - noteId, - String.format( - "Expected exactly 1 '%s' section, found %d", - EXTERNAL_ID_SECTION, externalIdKeys.size())); - } - - String externalIdKeyStr = Iterables.getOnlyElement(externalIdKeys); - Key externalIdKey = Key.parse(externalIdKeyStr); - if (externalIdKey == null) { - throw invalidConfig(noteId, String.format("External ID %s is invalid", externalIdKeyStr)); - } - - if (!externalIdKey.sha1().getName().equals(noteId)) { - throw invalidConfig( - noteId, - String.format( - "SHA1 of external ID '%s' does not match note ID '%s'", externalIdKeyStr, noteId)); - } - - String email = externalIdConfig.getString(EXTERNAL_ID_SECTION, externalIdKeyStr, EMAIL_KEY); - String password = - externalIdConfig.getString(EXTERNAL_ID_SECTION, externalIdKeyStr, PASSWORD_KEY); - int accountId = readAccountId(noteId, externalIdConfig, externalIdKeyStr); - - return create( - externalIdKey, - Account.id(accountId), + key, + accountId, + key.isCaseInsensitive(), Strings.emptyToNull(email), - Strings.emptyToNull(password), + Strings.emptyToNull(hashedPassword), blobId); } - private static int readAccountId(String noteId, Config externalIdConfig, String externalIdKeyStr) - throws ConfigInvalidException { - String accountIdStr = - externalIdConfig.getString(EXTERNAL_ID_SECTION, externalIdKeyStr, ACCOUNT_ID_KEY); - if (accountIdStr == null) { - throw invalidConfig( - noteId, - String.format( - "Value for '%s.%s.%s' is missing, expected account ID", - EXTERNAL_ID_SECTION, externalIdKeyStr, ACCOUNT_ID_KEY)); - } - - try { - int accountId = - externalIdConfig.getInt(EXTERNAL_ID_SECTION, externalIdKeyStr, ACCOUNT_ID_KEY, -1); - if (accountId < 0) { - throw invalidConfig( - noteId, - String.format( - "Value %s for '%s.%s.%s' is invalid, expected account ID", - accountIdStr, EXTERNAL_ID_SECTION, externalIdKeyStr, ACCOUNT_ID_KEY)); - } - return accountId; - } catch (IllegalArgumentException e) { - String msg = - String.format( - "Value %s for '%s.%s.%s' is invalid, expected account ID", - accountIdStr, EXTERNAL_ID_SECTION, externalIdKeyStr, ACCOUNT_ID_KEY); - logger.atSevere().withCause(e).log(msg); - throw invalidConfig(noteId, msg); - } - } - - private static ConfigInvalidException invalidConfig(String noteId, String message) { - return new ConfigInvalidException( - String.format("Invalid external ID config for note '%s': %s", noteId, message)); - } - public abstract Key key(); public abstract Account.Id accountId(); + public abstract boolean isCaseInsensitive(); + public abstract @Nullable String email(); public abstract @Nullable String password(); @@ -463,13 +310,15 @@ ExternalId o = (ExternalId) obj; return Objects.equals(key(), o.key()) && Objects.equals(accountId(), o.accountId()) + && isCaseInsensitive() == o.isCaseInsensitive() && Objects.equals(email(), o.email()) && Objects.equals(password(), o.password()); } + @Memoized @Override - public final int hashCode() { - return Objects.hash(key(), accountId(), email(), password()); + public int hashCode() { + return Objects.hash(key(), accountId(), isCaseInsensitive(), email(), password()); } /** @@ -486,7 +335,8 @@ * </pre> */ @Override - public final String toString() { + @Memoized + public String toString() { Config c = new Config(); writeToConfig(c); return c.toText();
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdCache.java b/java/com/google/gerrit/server/account/externalids/ExternalIdCache.java index 92e7c71..0029557 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalIdCache.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdCache.java
@@ -19,10 +19,12 @@ import com.google.gerrit.entities.Account; import java.io.IOException; import java.util.Collection; +import java.util.Optional; import org.eclipse.jgit.lib.ObjectId; /** - * Caches external IDs of all accounts. + * Caches external IDs of all accounts. Note that the granularity is "revision" only, so each update + * will cache a new value containing <b>all</b> external IDs. * * <p>On each cache access the SHA1 of the refs/meta/external-ids branch is read to verify that the * cache is up to date. @@ -30,12 +32,23 @@ * <p>All returned collections are unmodifiable. */ interface ExternalIdCache { + + /** + * Updates the cache. + * + * @param oldNotesRev current revision against which the below updates are applied + * @param newNotesRev key for the new cache revision + * @param toRemove external IDs to remove + * @param toAdd external IDs to add + */ void onReplace( ObjectId oldNotesRev, ObjectId newNotesRev, Collection<ExternalId> toRemove, Collection<ExternalId> toAdd); + Optional<ExternalId> byKey(ExternalId.Key key) throws IOException; + ImmutableSet<ExternalId> byAccount(Account.Id accountId) throws IOException; ImmutableSet<ExternalId> byAccount(Account.Id accountId, ObjectId rev) throws IOException;
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdCacheImpl.java b/java/com/google/gerrit/server/account/externalids/ExternalIdCacheImpl.java index 9084de7..e6db593 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalIdCacheImpl.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdCacheImpl.java
@@ -26,6 +26,7 @@ import com.google.inject.name.Named; import java.io.IOException; import java.util.Collection; +import java.util.Optional; import java.util.concurrent.ExecutionException; import java.util.concurrent.locks.Lock; import java.util.concurrent.locks.ReentrantLock; @@ -73,6 +74,11 @@ } @Override + public Optional<ExternalId> byKey(ExternalId.Key key) throws IOException { + return Optional.ofNullable(get().byKey().get(key)); + } + + @Override public ImmutableSet<ExternalId> byAccount(Account.Id accountId) throws IOException { return get().byAccount().get(accountId); } @@ -135,7 +141,7 @@ m = MultimapBuilder.hashKeys().hashSetValues().build(); } update.accept(m); - extIdsByAccount.put(newNotesRev, AllExternalIds.create(m)); + extIdsByAccount.put(newNotesRev, AllExternalIds.create(m.values().stream())); } catch (ExecutionException e) { logger.atWarning().withCause(e).log("Cannot update external IDs"); } finally {
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdCacheLoader.java b/java/com/google/gerrit/server/account/externalids/ExternalIdCacheLoader.java index 8887e06..72d703b 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalIdCacheLoader.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdCacheLoader.java
@@ -17,6 +17,7 @@ import com.google.common.base.CharMatcher; import com.google.common.cache.Cache; import com.google.common.cache.CacheLoader; +import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.common.collect.ImmutableSetMultimap; import com.google.common.flogger.FluentLogger; @@ -72,6 +73,7 @@ private final Timer0 reloadDifferential; private final boolean enablePartialReloads; private final boolean isPersistentCache; + private final ExternalIdFactory externalIdFactory; @Inject ExternalIdCacheLoader( @@ -81,7 +83,8 @@ @Named(ExternalIdCacheImpl.CACHE_NAME) Provider<Cache<ObjectId, AllExternalIds>> externalIdCache, MetricMaker metricMaker, - @GerritServerConfig Config config) { + @GerritServerConfig Config config, + ExternalIdFactory externalIdFactory) { this.externalIdReader = externalIdReader; this.externalIdCache = externalIdCache; this.gitRepositoryManager = gitRepositoryManager; @@ -92,7 +95,9 @@ new Description("Total number of external ID cache reloads from Git.") .setRate() .setUnit("updates"), - Field.ofBoolean("partial", Metadata.Builder::partial).build()); + Field.ofBoolean("partial", Metadata.Builder::partial) + .description("Whether the reload was partial.") + .build()); this.reloadDifferential = metricMaker.newTimer( "notedb/external_id_partial_read_latency", @@ -104,6 +109,7 @@ config.getBoolean("cache", ExternalIdCacheImpl.CACHE_NAME, "enablePartialReloads", true); this.isPersistentCache = config.getInt("cache", ExternalIdCacheImpl.CACHE_NAME, "diskLimit", 0) > 0; + this.externalIdFactory = externalIdFactory; } @Override @@ -215,12 +221,13 @@ * @param additions map of name to blob ID for each external ID that should be added * @param removals set of name {@link ObjectId}s that should be removed */ - private static AllExternalIds buildAllExternalIds( + private AllExternalIds buildAllExternalIds( Repository repo, AllExternalIds oldExternalIds, Map<ObjectId, ObjectId> additions, Set<ObjectId> removals) throws IOException { + ImmutableMap.Builder<ExternalId.Key, ExternalId> byKey = ImmutableMap.builder(); ImmutableSetMultimap.Builder<Account.Id, ExternalId> byAccount = ImmutableSetMultimap.builder(); ImmutableSetMultimap.Builder<String, ExternalId> byEmail = ImmutableSetMultimap.builder(); @@ -230,6 +237,7 @@ continue; } + byKey.put(externalId.key(), externalId); byAccount.put(externalId.accountId(), externalId); if (externalId.email() != null) { byEmail.put(externalId.email(), externalId); @@ -242,7 +250,7 @@ ExternalId parsedExternalId; try { parsedExternalId = - ExternalId.parse( + externalIdFactory.parse( nameToBlob.getKey().name(), reader.open(nameToBlob.getValue()).getCachedBytes(), nameToBlob.getValue()); @@ -252,13 +260,14 @@ continue; } + byKey.put(parsedExternalId.key(), parsedExternalId); byAccount.put(parsedExternalId.accountId(), parsedExternalId); if (parsedExternalId.email() != null) { byEmail.put(parsedExternalId.email(), parsedExternalId); } } } - return new AutoValue_AllExternalIds(byAccount.build(), byEmail.build()); + return new AutoValue_AllExternalIds(byKey.build(), byAccount.build(), byEmail.build()); } private AllExternalIds reloadAllExternalIds(ObjectId notesRev) @@ -269,7 +278,7 @@ Metadata.builder().revision(notesRev.name()).build())) { ImmutableSet<ExternalId> externalIds = externalIdReader.all(notesRev); externalIds.forEach(ExternalId::checkThatBlobIdIsSet); - AllExternalIds allExternalIds = AllExternalIds.create(externalIds); + AllExternalIds allExternalIds = AllExternalIds.create(externalIds.stream()); reloadCounter.increment(false); return allExternalIds; }
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdCacheModule.java b/java/com/google/gerrit/server/account/externalids/ExternalIdCacheModule.java new file mode 100644 index 0000000..f0ad1b2 --- /dev/null +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdCacheModule.java
@@ -0,0 +1,47 @@ +// Copyright (C) 2017 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.account.externalids; + +import com.google.gerrit.server.cache.CacheModule; +import com.google.gerrit.server.cache.serialize.ObjectIdCacheSerializer; +import com.google.inject.TypeLiteral; +import java.time.Duration; +import org.eclipse.jgit.lib.ObjectId; + +public class ExternalIdCacheModule extends CacheModule { + @Override + protected void configure() { + persist(ExternalIdCacheImpl.CACHE_NAME, ObjectId.class, new TypeLiteral<AllExternalIds>() {}) + // The cached data is potentially pretty large and we are always only interested + // in the latest value. However, due to a race condition, it is possible for different + // threads to observe different values of the meta ref, and hence request different keys + // from the cache. Extend the cache size by 1 to cover this case, but expire the extra + // object after a short period of time, since it may be a potentially large amount of + // memory. + // When loading a new value because the primary data advanced, we want to leverage the old + // cache state to recompute only what changed. This doesn't affect cache size though as + // Guava calls the loader first and evicts later on. + .maximumWeight(2) + .expireFromMemoryAfterAccess(Duration.ofMinutes(1)) + .loader(ExternalIdCacheLoader.class) + .diskLimit(-1) + .version(1) + .keySerializer(ObjectIdCacheSerializer.INSTANCE) + .valueSerializer(AllExternalIds.Serializer.INSTANCE); + + bind(ExternalIdCacheImpl.class); + bind(ExternalIdCache.class).to(ExternalIdCacheImpl.class); + } +}
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdCaseSensitivityMigrator.java b/java/com/google/gerrit/server/account/externalids/ExternalIdCaseSensitivityMigrator.java new file mode 100644 index 0000000..a59e935 --- /dev/null +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdCaseSensitivityMigrator.java
@@ -0,0 +1,138 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.account.externalids; + +import static com.google.gerrit.server.account.externalids.ExternalId.SCHEME_GERRIT; +import static com.google.gerrit.server.account.externalids.ExternalId.SCHEME_USERNAME; + +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.exceptions.DuplicateKeyException; +import com.google.gerrit.server.config.AllUsersName; +import com.google.gerrit.server.git.GitRepositoryManager; +import com.google.gerrit.server.git.meta.MetaDataUpdate; +import com.google.inject.AbstractModule; +import com.google.inject.Inject; +import com.google.inject.Provider; +import com.google.inject.assistedinject.Assisted; +import com.google.inject.assistedinject.FactoryModuleBuilder; +import java.io.IOException; +import java.util.Collection; +import java.util.Collections; +import org.eclipse.jgit.errors.ConfigInvalidException; +import org.eclipse.jgit.errors.RepositoryNotFoundException; +import org.eclipse.jgit.lib.Repository; + +public class ExternalIdCaseSensitivityMigrator { + + public static class ExternalIdCaseSensitivityMigratorModule extends AbstractModule { + @Override + public void configure() { + install(new FactoryModuleBuilder().build(ExternalIdCaseSensitivityMigrator.Factory.class)); + } + } + + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + public interface Factory { + ExternalIdCaseSensitivityMigrator create( + @Assisted("isUserNameCaseInsensitive") Boolean isUserNameCaseInsensitive, + @Assisted("dryRun") Boolean dryRun); + } + + private GitRepositoryManager repoManager; + private AllUsersName allUsersName; + private Provider<MetaDataUpdate.Server> metaDataUpdateServerFactory; + private ExternalIdNotes.FactoryNoReindex externalIdNotesFactory; + + private ExternalIdFactory externalIdFactory; + private Boolean isUserNameCaseInsensitive; + private Boolean dryRun; + + @Inject + public ExternalIdCaseSensitivityMigrator( + GitRepositoryManager repoManager, + AllUsersName allUsersName, + Provider<MetaDataUpdate.Server> metaDataUpdateServerFactory, + ExternalIdNotes.FactoryNoReindex externalIdNotesFactory, + ExternalIdFactory externalIdFactory, + @Assisted("isUserNameCaseInsensitive") Boolean isUserNameCaseInsensitive, + @Assisted("dryRun") Boolean dryRun) { + this.repoManager = repoManager; + this.allUsersName = allUsersName; + this.metaDataUpdateServerFactory = metaDataUpdateServerFactory; + this.externalIdNotesFactory = externalIdNotesFactory; + this.externalIdFactory = externalIdFactory; + + this.isUserNameCaseInsensitive = isUserNameCaseInsensitive; + this.dryRun = dryRun; + } + + private void recomputeExternalIdNoteId(ExternalIdNotes extIdNotes, ExternalId extId) + throws DuplicateKeyException, IOException { + if (extId.isScheme(SCHEME_GERRIT) || extId.isScheme(SCHEME_USERNAME)) { + ExternalIdKeyFactory keyFactory = + new ExternalIdKeyFactory( + new ExternalIdKeyFactory.Config() { + @Override + public boolean isUserNameCaseInsensitive() { + return isUserNameCaseInsensitive; + } + }); + ExternalId.Key updatedKey = keyFactory.create(extId.key().scheme(), extId.key().id()); + ExternalId.Key oldKey = + keyFactory.create(extId.key().scheme(), extId.key().id(), !isUserNameCaseInsensitive); + if (!oldKey.sha1().getName().equals(updatedKey.sha1().getName()) + && !extId.key().sha1().getName().equals(updatedKey.sha1().getName())) { + logger.atInfo().log("Converting note name of external ID: %s", oldKey); + ExternalId updatedExtId = + externalIdFactory.create( + updatedKey, extId.accountId(), extId.email(), extId.password(), extId.blobId()); + ExternalId oldExtId = + externalIdFactory.create( + oldKey, extId.accountId(), extId.email(), extId.password(), extId.blobId()); + extIdNotes.replace( + Collections.singleton(oldExtId), + Collections.singleton(updatedExtId), + (externalId) -> externalId.key().sha1()); + } + } + } + + public void migrate(Collection<ExternalId> todo, Runnable monitor) + throws RepositoryNotFoundException, IOException, ConfigInvalidException { + try (Repository repo = repoManager.openRepository(allUsersName)) { + ExternalIdNotes extIdNotes = externalIdNotesFactory.load(repo); + for (ExternalId extId : todo) { + recomputeExternalIdNoteId(extIdNotes, extId); + monitor.run(); + } + if (!dryRun) { + try (MetaDataUpdate metaDataUpdate = + metaDataUpdateServerFactory.get().create(allUsersName)) { + metaDataUpdate.setMessage( + String.format( + "Migration to case %ssensitive usernames", + isUserNameCaseInsensitive ? "" : "in")); + extIdNotes.commit(metaDataUpdate); + } catch (Exception e) { + logger.atSevere().withCause(e).log(e.getMessage()); + } + } + } catch (DuplicateExternalIdKeyException e) { + logger.atSevere().withCause(e).log(e.getMessage()); + throw e; + } + } +}
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdFactory.java b/java/com/google/gerrit/server/account/externalids/ExternalIdFactory.java new file mode 100644 index 0000000..bd9c7df --- /dev/null +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdFactory.java
@@ -0,0 +1,335 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.account.externalids; + +import static java.nio.charset.StandardCharsets.UTF_8; +import static java.util.Objects.requireNonNull; + +import com.google.common.base.Strings; +import com.google.common.collect.Iterables; +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.common.Nullable; +import com.google.gerrit.entities.Account; +import com.google.gerrit.server.account.HashedPassword; +import com.google.gerrit.server.config.AuthConfig; +import java.util.Set; +import javax.inject.Inject; +import javax.inject.Singleton; +import org.eclipse.jgit.errors.ConfigInvalidException; +import org.eclipse.jgit.lib.Config; +import org.eclipse.jgit.lib.ObjectId; + +@Singleton +public class ExternalIdFactory { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + private final ExternalIdKeyFactory externalIdKeyFactory; + private AuthConfig authConfig; + + @Inject + public ExternalIdFactory(ExternalIdKeyFactory externalIdKeyFactory, AuthConfig authConfig) { + this.externalIdKeyFactory = externalIdKeyFactory; + this.authConfig = authConfig; + } + + /** + * Creates an external ID. + * + * @param scheme the scheme name, must not contain colons (':'). E.g. {@link + * ExternalId#SCHEME_USERNAME}. + * @param id the external ID, must not contain colons (':') + * @param accountId the ID of the account to which the external ID belongs + * @return the created external ID + */ + public ExternalId create(String scheme, String id, Account.Id accountId) { + return create(externalIdKeyFactory.create(scheme, id), accountId, null, null); + } + + /** + * Creates an external ID. + * + * @param scheme the scheme name, must not contain colons (':'). E.g. {@link + * ExternalId#SCHEME_USERNAME}. + * @param id the external ID, must not contain colons (':') + * @param accountId the ID of the account to which the external ID belongs + * @param email the email of the external ID, may be {@code null} + * @param hashedPassword the hashed password of the external ID, may be {@code null} + * @return the created external ID + */ + public ExternalId create( + String scheme, + String id, + Account.Id accountId, + @Nullable String email, + @Nullable String hashedPassword) { + return create(externalIdKeyFactory.create(scheme, id), accountId, email, hashedPassword); + } + + /** + * Creates an external ID. + * + * @param key the external Id key + * @param accountId the ID of the account to which the external ID belongs + * @return the created external ID + */ + public ExternalId create(ExternalId.Key key, Account.Id accountId) { + return create(key, accountId, null, null); + } + + /** + * Creates an external ID. + * + * @param key the external Id key + * @param accountId the ID of the account to which the external ID belongs + * @param email the email of the external ID, may be {@code null} + * @param hashedPassword the hashed password of the external ID, may be {@code null} + * @return the created external ID + */ + public ExternalId create( + ExternalId.Key key, + Account.Id accountId, + @Nullable String email, + @Nullable String hashedPassword) { + return create( + key, accountId, Strings.emptyToNull(email), Strings.emptyToNull(hashedPassword), null); + } + + /** + * Creates an external ID adding a hashed password computed from a plain password. + * + * @param key the external Id key + * @param accountId the ID of the account to which the external ID belongs + * @param email the email of the external ID, may be {@code null} + * @param plainPassword the plain HTTP password, may be {@code null} + * @return the created external ID + */ + public ExternalId createWithPassword( + ExternalId.Key key, + Account.Id accountId, + @Nullable String email, + @Nullable String plainPassword) { + plainPassword = Strings.emptyToNull(plainPassword); + String hashedPassword = + plainPassword != null ? HashedPassword.fromPassword(plainPassword).encode() : null; + return create(key, accountId, email, hashedPassword); + } + + /** + * Create a external ID for a username (scheme "username"). + * + * @param id the external ID, must not contain colons (':') + * @param accountId the ID of the account to which the external ID belongs + * @param plainPassword the plain HTTP password, may be {@code null} + * @return the created external ID + */ + public ExternalId createUsername( + String id, Account.Id accountId, @Nullable String plainPassword) { + return createWithPassword( + externalIdKeyFactory.create(ExternalId.SCHEME_USERNAME, id), + accountId, + null, + plainPassword); + } + + /** + * Creates an external ID with an email. + * + * @param scheme the scheme name, must not contain colons (':'). E.g. {@link + * ExternalId#SCHEME_USERNAME}. + * @param id the external ID, must not contain colons (':') + * @param accountId the ID of the account to which the external ID belongs + * @param email the email of the external ID, may be {@code null} + * @return the created external ID + */ + public ExternalId createWithEmail( + String scheme, String id, Account.Id accountId, @Nullable String email) { + return createWithEmail(externalIdKeyFactory.create(scheme, id), accountId, email); + } + + /** + * Creates an external ID with an email. + * + * @param key the external Id key + * @param accountId the ID of the account to which the external ID belongs + * @param email the email of the external ID, may be {@code null} + * @return the created external ID + */ + public ExternalId createWithEmail( + ExternalId.Key key, Account.Id accountId, @Nullable String email) { + return create(key, accountId, Strings.emptyToNull(email), null); + } + + /** + * Creates an external ID using the `mailto`-scheme. + * + * @param accountId the ID of the account to which the external ID belongs + * @param email the email of the external ID, may be {@code null} + * @return the created external ID + */ + public ExternalId createEmail(Account.Id accountId, String email) { + return createWithEmail(ExternalId.SCHEME_MAILTO, email, accountId, requireNonNull(email)); + } + + ExternalId create(ExternalId extId, @Nullable ObjectId blobId) { + return create(extId.key(), extId.accountId(), extId.email(), extId.password(), blobId); + } + + /** + * Creates an external ID. + * + * @param key the external Id key + * @param accountId the ID of the account to which the external ID belongs + * @param email the email of the external ID, may be {@code null} + * @param hashedPassword the hashed password of the external ID, may be {@code null} + * @param blobId the ID of the note blob in the external IDs branch that stores this external ID. + * {@code null} if the external ID was created in code and is not yet stored in Git. + * @return the created external ID + */ + public ExternalId create( + ExternalId.Key key, + Account.Id accountId, + @Nullable String email, + @Nullable String hashedPassword, + @Nullable ObjectId blobId) { + return ExternalId.create( + key, accountId, Strings.emptyToNull(email), Strings.emptyToNull(hashedPassword), blobId); + } + + /** + * Parses an external ID from a byte array that contains the external ID as a Git config file + * text. + * + * <p>The Git config must have exactly one externalId subsection with an accountId and optionally + * email and password: + * + * <pre> + * [externalId "username:jdoe"] + * accountId = 1003407 + * email = jdoe@example.com + * password = bcrypt:4:LCbmSBDivK/hhGVQMfkDpA==:XcWn0pKYSVU/UJgOvhidkEtmqCp6oKB7 + * </pre> + * + * @param noteId the SHA-1 sum of the external ID used as the note's ID + * @param raw a byte array that contains the external ID as a Git config file text. + * @param blobId the ID of the note blob in the external IDs branch that stores this external ID. + * {@code null} if the external ID was created in code and is not yet stored in Git. + * @return the parsed external ID + */ + public ExternalId parse(String noteId, byte[] raw, ObjectId blobId) + throws ConfigInvalidException { + requireNonNull(blobId); + + Config externalIdConfig = new Config(); + try { + externalIdConfig.fromText(new String(raw, UTF_8)); + } catch (ConfigInvalidException e) { + throw invalidConfig(noteId, e.getMessage()); + } + + Set<String> externalIdKeys = externalIdConfig.getSubsections(ExternalId.EXTERNAL_ID_SECTION); + if (externalIdKeys.size() != 1) { + throw invalidConfig( + noteId, + String.format( + "Expected exactly 1 '%s' section, found %d", + ExternalId.EXTERNAL_ID_SECTION, externalIdKeys.size())); + } + + String externalIdKeyStr = Iterables.getOnlyElement(externalIdKeys); + ExternalId.Key externalIdKey = externalIdKeyFactory.parse(externalIdKeyStr); + if (externalIdKey == null) { + throw invalidConfig(noteId, String.format("External ID %s is invalid", externalIdKeyStr)); + } + + if (!externalIdKey.sha1().getName().equals(noteId)) { + if (!authConfig.isUserNameCaseInsensitiveMigrationMode()) { + throw invalidConfig( + noteId, + String.format( + "SHA1 of external ID '%s' does not match note ID '%s'", externalIdKeyStr, noteId)); + } + + if (!externalIdKey.caseSensitiveSha1().getName().equals(noteId)) { + throw invalidConfig( + noteId, + String.format( + "Neither case sensitive nor case insensitive SHA1 of external ID '%s' match note ID '%s'", + externalIdKeyStr, noteId)); + } + externalIdKey = + externalIdKeyFactory.create(externalIdKey.scheme(), externalIdKey.id(), false); + } + + String email = + externalIdConfig.getString( + ExternalId.EXTERNAL_ID_SECTION, externalIdKeyStr, ExternalId.EMAIL_KEY); + String password = + externalIdConfig.getString( + ExternalId.EXTERNAL_ID_SECTION, externalIdKeyStr, ExternalId.PASSWORD_KEY); + int accountId = readAccountId(noteId, externalIdConfig, externalIdKeyStr); + + return create( + externalIdKey, + Account.id(accountId), + Strings.emptyToNull(email), + Strings.emptyToNull(password), + blobId); + } + + private static int readAccountId(String noteId, Config externalIdConfig, String externalIdKeyStr) + throws ConfigInvalidException { + String accountIdStr = + externalIdConfig.getString( + ExternalId.EXTERNAL_ID_SECTION, externalIdKeyStr, ExternalId.ACCOUNT_ID_KEY); + if (accountIdStr == null) { + throw invalidConfig( + noteId, + String.format( + "Value for '%s.%s.%s' is missing, expected account ID", + ExternalId.EXTERNAL_ID_SECTION, externalIdKeyStr, ExternalId.ACCOUNT_ID_KEY)); + } + + try { + int accountId = + externalIdConfig.getInt( + ExternalId.EXTERNAL_ID_SECTION, externalIdKeyStr, ExternalId.ACCOUNT_ID_KEY, -1); + if (accountId < 0) { + throw invalidConfig( + noteId, + String.format( + "Value %s for '%s.%s.%s' is invalid, expected account ID", + accountIdStr, + ExternalId.EXTERNAL_ID_SECTION, + externalIdKeyStr, + ExternalId.ACCOUNT_ID_KEY)); + } + return accountId; + } catch (IllegalArgumentException e) { + String msg = + String.format( + "Value %s for '%s.%s.%s' is invalid, expected account ID", + accountIdStr, + ExternalId.EXTERNAL_ID_SECTION, + externalIdKeyStr, + ExternalId.ACCOUNT_ID_KEY); + logger.atSevere().withCause(e).log(msg); + throw invalidConfig(noteId, msg); + } + } + + private static ConfigInvalidException invalidConfig(String noteId, String message) { + return new ConfigInvalidException( + String.format("Invalid external ID config for note '%s': %s", noteId, message)); + } +}
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdKeyFactory.java b/java/com/google/gerrit/server/account/externalids/ExternalIdKeyFactory.java new file mode 100644 index 0000000..68d8b0c --- /dev/null +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdKeyFactory.java
@@ -0,0 +1,103 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.account.externalids; + +import com.google.common.annotations.VisibleForTesting; +import com.google.gerrit.common.Nullable; +import com.google.gerrit.server.config.AuthConfig; +import com.google.inject.ImplementedBy; +import javax.inject.Inject; +import javax.inject.Singleton; + +@Singleton +public class ExternalIdKeyFactory { + @ImplementedBy(ConfigImpl.class) + public interface Config { + boolean isUserNameCaseInsensitive(); + } + + /** + * Default implementation {@link Config} + * + * <p>Internally in google we are using different implementation. + */ + @Singleton + public static class ConfigImpl implements Config { + private final boolean isUserNameCaseInsensitive; + + @VisibleForTesting + @Inject + public ConfigImpl(AuthConfig authConfig) { + this.isUserNameCaseInsensitive = authConfig.isUserNameCaseInsensitive(); + } + + @Override + public boolean isUserNameCaseInsensitive() { + return isUserNameCaseInsensitive; + } + } + + private final boolean isUserNameCaseInsensitive; + + @Inject + public ExternalIdKeyFactory(Config config) { + this.isUserNameCaseInsensitive = config.isUserNameCaseInsensitive(); + } + + /** + * Creates an external ID key. + * + * @param scheme the scheme name, must not contain colons (':'). E.g. {@link + * ExternalId#SCHEME_USERNAME}. + * @param id the external ID, must not contain colons (':') + * @return the created external ID key + */ + public ExternalId.Key create(@Nullable String scheme, String id) { + return create(scheme, id, isUserNameCaseInsensitive); + } + + /** + * Creates an external ID key. + * + * @param scheme the scheme name, must not contain colons (':'). E.g. {@link + * ExternalId#SCHEME_USERNAME}. + * @param id the external ID, must not contain colons (':') + * @param userNameCaseInsensitive whether the external ID key is matched case insensitively + * @return the created external ID key + */ + public ExternalId.Key create( + @Nullable String scheme, String id, boolean userNameCaseInsensitive) { + if (scheme != null + && (scheme.equals(ExternalId.SCHEME_USERNAME) || scheme.equals(ExternalId.SCHEME_GERRIT))) { + return ExternalId.Key.create(scheme, id, userNameCaseInsensitive); + } + + return ExternalId.Key.create(scheme, id, false); + } + + /** + * Parses an external ID key from its String representation + * + * @param externalId String representation of external ID key (e.g. username:johndoe) + * @return the external Id key object + */ + public ExternalId.Key parse(String externalId) { + int c = externalId.indexOf(':'); + if (c < 1 || c >= externalId.length() - 1) { + return create(null, externalId); + } + return create(externalId.substring(0, c), externalId.substring(c + 1)); + } +}
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdModule.java b/java/com/google/gerrit/server/account/externalids/ExternalIdModule.java index 3e5d7b8..da7b357 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalIdModule.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdModule.java
@@ -1,4 +1,4 @@ -// Copyright (C) 2017 The Android Open Source Project +// Copyright (C) 2021 The Android Open Source Project // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -14,34 +14,13 @@ package com.google.gerrit.server.account.externalids; -import com.google.gerrit.server.cache.CacheModule; -import com.google.gerrit.server.cache.serialize.ObjectIdCacheSerializer; -import com.google.inject.TypeLiteral; -import java.time.Duration; -import org.eclipse.jgit.lib.ObjectId; +import com.google.inject.AbstractModule; -public class ExternalIdModule extends CacheModule { +public class ExternalIdModule extends AbstractModule { @Override protected void configure() { - persist(ExternalIdCacheImpl.CACHE_NAME, ObjectId.class, new TypeLiteral<AllExternalIds>() {}) - // The cached data is potentially pretty large and we are always only interested - // in the latest value. However, due to a race condition, it is possible for different - // threads to observe different values of the meta ref, and hence request different keys - // from the cache. Extend the cache size by 1 to cover this case, but expire the extra - // object after a short period of time, since it may be a potentially large amount of - // memory. - // When loading a new value because the primary data advanced, we want to leverage the old - // cache state to recompute only what changed. This doesn't affect cache size though as - // Guava calls the loader first and evicts later on. - .maximumWeight(2) - .expireFromMemoryAfterAccess(Duration.ofMinutes(1)) - .loader(ExternalIdCacheLoader.class) - .diskLimit(-1) - .version(1) - .keySerializer(ObjectIdCacheSerializer.INSTANCE) - .valueSerializer(AllExternalIds.Serializer.INSTANCE); - - bind(ExternalIdCacheImpl.class); - bind(ExternalIdCache.class).to(ExternalIdCacheImpl.class); + bind(ExternalIdFactory.class); + bind(ExternalIdKeyFactory.class); + bind(PasswordVerifier.class); } }
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdNotes.java b/java/com/google/gerrit/server/account/externalids/ExternalIdNotes.java index e999c93..aa37451 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalIdNotes.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdNotes.java
@@ -17,7 +17,6 @@ import static com.google.common.base.Preconditions.checkState; import static java.nio.charset.StandardCharsets.UTF_8; import static java.util.Objects.requireNonNull; -import static java.util.stream.Collectors.joining; import static java.util.stream.Collectors.toSet; import static org.eclipse.jgit.lib.Constants.OBJ_BLOB; @@ -30,14 +29,15 @@ import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.RefNames; +import com.google.gerrit.extensions.registration.DynamicMap; import com.google.gerrit.git.ObjectIds; import com.google.gerrit.metrics.Counter0; import com.google.gerrit.metrics.Description; import com.google.gerrit.metrics.DisabledMetricMaker; import com.google.gerrit.metrics.MetricMaker; -import com.google.gerrit.server.account.AccountCache; import com.google.gerrit.server.account.AccountsUpdate; import com.google.gerrit.server.config.AllUsersName; +import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.server.git.meta.MetaDataUpdate; import com.google.gerrit.server.git.meta.VersionedMetaData; import com.google.gerrit.server.index.account.AccountIndexer; @@ -54,6 +54,7 @@ import java.util.List; import java.util.Optional; import java.util.Set; +import java.util.function.Function; import org.eclipse.jgit.errors.ConfigInvalidException; import org.eclipse.jgit.lib.BlobBasedConfig; import org.eclipse.jgit.lib.CommitBuilder; @@ -86,21 +87,46 @@ * <p>On save the staged external ID updates are performed (see {@link #onSave(CommitBuilder)}). * * <p>After committing the external IDs a cache update can be requested which also reindexes the - * accounts for which external IDs have been updated (see {@link #updateCaches()}). + * accounts for which external IDs have been updated (see {@link + * ExternalIdNotesLoader#updateExternalIdCacheAndMaybeReindexAccounts(ExternalIdNotes, + * Collection)}). */ public class ExternalIdNotes extends VersionedMetaData { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); private static final int MAX_NOTE_SZ = 1 << 19; - public interface ExternalIdNotesLoader { + public abstract static class ExternalIdNotesLoader { + protected final ExternalIdCache externalIdCache; + protected final MetricMaker metricMaker; + protected final AllUsersName allUsersName; + protected final DynamicMap<ExternalIdUpsertPreprocessor> upsertPreprocessors; + protected final ExternalIdFactory externalIdFactory; + protected final AuthConfig authConfig; + + protected ExternalIdNotesLoader( + ExternalIdCache externalIdCache, + MetricMaker metricMaker, + AllUsersName allUsersName, + DynamicMap<ExternalIdUpsertPreprocessor> upsertPreprocessors, + ExternalIdFactory externalIdFactory, + AuthConfig authConfig) { + this.externalIdCache = externalIdCache; + this.metricMaker = metricMaker; + this.allUsersName = allUsersName; + this.upsertPreprocessors = upsertPreprocessors; + this.externalIdFactory = externalIdFactory; + this.authConfig = authConfig; + } + /** * Loads the external ID notes from the current tip of the {@code refs/meta/external-ids} * branch. * * @param allUsersRepo the All-Users repository */ - ExternalIdNotes load(Repository allUsersRepo) throws IOException, ConfigInvalidException; + public abstract ExternalIdNotes load(Repository allUsersRepo) + throws IOException, ConfigInvalidException; /** * Loads the external ID notes from the specified revision of the {@code refs/meta/external-ids} @@ -112,42 +138,98 @@ * assumed that the {@code refs/meta/external-ids} branch doesn't exist and the loaded * external IDs will be empty */ - ExternalIdNotes load(Repository allUsersRepo, @Nullable ObjectId rev) + public abstract ExternalIdNotes load(Repository allUsersRepo, @Nullable ObjectId rev) throws IOException, ConfigInvalidException; + + /** + * Updates the external ID cache. Subclasses of type {@link Factory} will also reindex the + * accounts for which external IDs were modified, while subclasses of type {@link + * FactoryNoReindex} will skip this. + * + * <p>Must only be called after committing changes. + * + * @param externalIdNotes the committed updates that should be applied to the cache. This first + * and last element must be the updates commited first and last, respectively. + * @param accountsToSkipForReindex accounts that should not be reindexed. This is to avoid + * double reindexing when updated accounts will already be reindexed by + * ReindexAfterRefUpdate. + */ + public void updateExternalIdCacheAndMaybeReindexAccounts( + ExternalIdNotes externalIdNotes, Collection<Account.Id> accountsToSkipForReindex) + throws IOException { + checkState(externalIdNotes.oldRev != null, "no changes committed yet"); + + // readOnly is ignored here (legacy behavior). + + // Aggregate all updates. + ExternalIdCacheUpdates updates = new ExternalIdCacheUpdates(); + for (CacheUpdate cacheUpdate : externalIdNotes.cacheUpdates) { + cacheUpdate.execute(updates); + } + + // Perform the cache update. + if (!externalIdNotes.noCacheUpdate) { + // Regardless of noCacheUpdate it's still possible that the ExternalIdCache instance is of + // type DisabledExternalIdCache, making this call a no-op. + externalIdCache.onReplace( + externalIdNotes.oldRev, + externalIdNotes.getRevision(), + updates.getRemoved(), + updates.getAdded()); + } + + // Reindex accounts (if the subclass implements reindexAccount()). + if (!externalIdNotes.noReindex) { + Streams.concat(updates.getAdded().stream(), updates.getRemoved().stream()) + .map(ExternalId::accountId) + .filter(i -> !accountsToSkipForReindex.contains(i)) + .distinct() + .forEach(this::reindexAccount); + } + + // Reset instance state. + externalIdNotes.cacheUpdates.clear(); + externalIdNotes.keysToAdd.clear(); + externalIdNotes.oldRev = null; + } + + protected abstract void reindexAccount(Account.Id id); } @Singleton - public static class Factory implements ExternalIdNotesLoader { - private final ExternalIdCache externalIdCache; - private final AccountCache accountCache; + public static class Factory extends ExternalIdNotesLoader { + private final Provider<AccountIndexer> accountIndexer; - private final MetricMaker metricMaker; - private final AllUsersName allUsersName; @Inject Factory( ExternalIdCache externalIdCache, - AccountCache accountCache, Provider<AccountIndexer> accountIndexer, MetricMaker metricMaker, - AllUsersName allUsersName) { - this.externalIdCache = externalIdCache; - this.accountCache = accountCache; + AllUsersName allUsersName, + DynamicMap<ExternalIdUpsertPreprocessor> upsertPreprocessors, + ExternalIdFactory externalIdFactory, + AuthConfig authConfig) { + super( + externalIdCache, + metricMaker, + allUsersName, + upsertPreprocessors, + externalIdFactory, + authConfig); this.accountIndexer = accountIndexer; - this.metricMaker = metricMaker; - this.allUsersName = allUsersName; } @Override public ExternalIdNotes load(Repository allUsersRepo) throws IOException, ConfigInvalidException { return new ExternalIdNotes( - externalIdCache, - accountCache, - accountIndexer, metricMaker, allUsersName, - allUsersRepo) + allUsersRepo, + upsertPreprocessors, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()) .load(); } @@ -155,35 +237,52 @@ public ExternalIdNotes load(Repository allUsersRepo, @Nullable ObjectId rev) throws IOException, ConfigInvalidException { return new ExternalIdNotes( - externalIdCache, - accountCache, - accountIndexer, metricMaker, allUsersName, - allUsersRepo) + allUsersRepo, + upsertPreprocessors, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()) .load(rev); } + + @Override + protected void reindexAccount(Account.Id id) { + accountIndexer.get().index(id); + } } @Singleton - public static class FactoryNoReindex implements ExternalIdNotesLoader { - private final ExternalIdCache externalIdCache; - private final MetricMaker metricMaker; - private final AllUsersName allUsersName; + public static class FactoryNoReindex extends ExternalIdNotesLoader { @Inject FactoryNoReindex( - ExternalIdCache externalIdCache, MetricMaker metricMaker, AllUsersName allUsersName) { - this.externalIdCache = externalIdCache; - this.metricMaker = metricMaker; - this.allUsersName = allUsersName; + ExternalIdCache externalIdCache, + MetricMaker metricMaker, + AllUsersName allUsersName, + DynamicMap<ExternalIdUpsertPreprocessor> upsertPreprocessors, + ExternalIdFactory externalIdFactory, + AuthConfig authConfig) { + super( + externalIdCache, + metricMaker, + allUsersName, + upsertPreprocessors, + externalIdFactory, + authConfig); } @Override public ExternalIdNotes load(Repository allUsersRepo) throws IOException, ConfigInvalidException { return new ExternalIdNotes( - externalIdCache, null, null, metricMaker, allUsersName, allUsersRepo) + metricMaker, + allUsersName, + allUsersRepo, + upsertPreprocessors, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()) + .setNoReindex() .load(); } @@ -191,28 +290,20 @@ public ExternalIdNotes load(Repository allUsersRepo, @Nullable ObjectId rev) throws IOException, ConfigInvalidException { return new ExternalIdNotes( - externalIdCache, null, null, metricMaker, allUsersName, allUsersRepo) + metricMaker, + allUsersName, + allUsersRepo, + upsertPreprocessors, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()) + .setNoReindex() .load(rev); } - } - /** - * Loads the external ID notes for reading only. The external ID notes are loaded from the current - * tip of the {@code refs/meta/external-ids} branch. - * - * @return read-only {@link ExternalIdNotes} instance - */ - public static ExternalIdNotes loadReadOnly(AllUsersName allUsersName, Repository allUsersRepo) - throws IOException, ConfigInvalidException { - return new ExternalIdNotes( - new DisabledExternalIdCache(), - null, - null, - new DisabledMetricMaker(), - allUsersName, - allUsersRepo) - .setReadOnly() - .load(); + @Override + protected void reindexAccount(Account.Id id) { + // Do not reindex. + } } /** @@ -226,16 +317,22 @@ * @return read-only {@link ExternalIdNotes} instance */ public static ExternalIdNotes loadReadOnly( - AllUsersName allUsersName, Repository allUsersRepo, @Nullable ObjectId rev) + AllUsersName allUsersName, + Repository allUsersRepo, + @Nullable ObjectId rev, + ExternalIdFactory externalIdFactory, + boolean isUserNameCaseInsensitiveMigrationMode) throws IOException, ConfigInvalidException { return new ExternalIdNotes( - new DisabledExternalIdCache(), - null, - null, new DisabledMetricMaker(), allUsersName, - allUsersRepo) + allUsersRepo, + DynamicMap.emptyMap(), + externalIdFactory, + isUserNameCaseInsensitiveMigrationMode) .setReadOnly() + .setNoCacheUpdate() + .setNoReindex() .load(rev); } @@ -250,54 +347,82 @@ * @return {@link ExternalIdNotes} instance that doesn't updates caches on save */ public static ExternalIdNotes loadNoCacheUpdate( - AllUsersName allUsersName, Repository allUsersRepo) + AllUsersName allUsersName, + Repository allUsersRepo, + ExternalIdFactory externalIdFactory, + boolean isUserNameCaseInsensitiveMigrationMode) throws IOException, ConfigInvalidException { return new ExternalIdNotes( - new DisabledExternalIdCache(), - null, - null, new DisabledMetricMaker(), allUsersName, - allUsersRepo) + allUsersRepo, + DynamicMap.emptyMap(), + externalIdFactory, + isUserNameCaseInsensitiveMigrationMode) + .setNoCacheUpdate() + .setNoReindex() .load(); } - private final ExternalIdCache externalIdCache; - @Nullable private final AccountCache accountCache; - @Nullable private final Provider<AccountIndexer> accountIndexer; private final AllUsersName allUsersName; private final Counter0 updateCount; private final Repository repo; + private final DynamicMap<ExternalIdUpsertPreprocessor> upsertPreprocessors; private final CallerFinder callerFinder; + private final ExternalIdFactory externalIdFactory; private NoteMap noteMap; private ObjectId oldRev; - // Staged note map updates that should be executed on save. - private List<NoteMapUpdate> noteMapUpdates = new ArrayList<>(); + /** Staged note map updates that should be executed on save. */ + private final List<NoteMapUpdate> noteMapUpdates = new ArrayList<>(); - // Staged cache updates that should be executed after external ID changes have been committed. - private List<CacheUpdate> cacheUpdates = new ArrayList<>(); + /** Staged cache updates that should be executed after external ID changes have been committed. */ + private final List<CacheUpdate> cacheUpdates = new ArrayList<>(); + + /** + * When performing batch updates (cf. {@link AccountsUpdate#updateBatch(List)} we need to ensure + * the batch does not introduce duplicates. In addition to checking against the status quo in + * {@link #noteMap} (cf. {@link #checkExternalIdKeysDontExist(Collection)}), which is sufficient + * for single updates, we also need to check for duplicates among the batch updates. As the actual + * updates are computed lazily just before applying them, we unfortunately need to track keys + * explicitly here even though they are already implicit in the lambdas that constitute the + * updates. + */ + private final Set<ExternalId.Key> keysToAdd = new HashSet<>(); private Runnable afterReadRevision; private boolean readOnly = false; + private boolean noCacheUpdate = false; + private boolean noReindex = false; + private boolean isUserNameCaseInsensitiveMigrationMode = false; + protected final Function<ExternalId, ObjectId> defaultNoteIdResolver = + (extId) -> { + ObjectId noteId = extId.key().sha1(); + try { + if (isUserNameCaseInsensitiveMigrationMode && !noteMap.contains(noteId)) { + noteId = extId.key().caseSensitiveSha1(); + } + } catch (IOException e) { + return noteId; + } + return noteId; + }; private ExternalIdNotes( - ExternalIdCache externalIdCache, - @Nullable AccountCache accountCache, - @Nullable Provider<AccountIndexer> accountIndexer, MetricMaker metricMaker, AllUsersName allUsersName, - Repository allUsersRepo) { - this.externalIdCache = requireNonNull(externalIdCache, "externalIdCache"); - this.accountCache = accountCache; - this.accountIndexer = accountIndexer; + Repository allUsersRepo, + DynamicMap<ExternalIdUpsertPreprocessor> upsertPreprocessors, + ExternalIdFactory externalIdFactory, + boolean isUserNameCaseInsensitiveMigrationMode) { this.updateCount = metricMaker.newCounter( "notedb/external_id_update_count", new Description("Total number of external ID updates.").setRate().setUnit("updates")); this.allUsersName = requireNonNull(allUsersName, "allUsersRepo"); this.repo = requireNonNull(allUsersRepo, "allUsersRepo"); + this.upsertPreprocessors = upsertPreprocessors; this.callerFinder = CallerFinder.builder() // 1. callers that come through ExternalIds @@ -311,6 +436,8 @@ // 3. direct callers .addTarget(ExternalIdNotes.class) .build(); + this.externalIdFactory = externalIdFactory; + this.isUserNameCaseInsensitiveMigrationMode = isUserNameCaseInsensitiveMigrationMode; } public ExternalIdNotes setAfterReadRevision(Runnable afterReadRevision) { @@ -319,7 +446,17 @@ } private ExternalIdNotes setReadOnly() { - this.readOnly = true; + readOnly = true; + return this; + } + + private ExternalIdNotes setNoCacheUpdate() { + noCacheUpdate = true; + return this; + } + + private ExternalIdNotes setNoReindex() { + noReindex = true; return this; } @@ -372,16 +509,26 @@ */ public Optional<ExternalId> get(ExternalId.Key key) throws IOException, ConfigInvalidException { checkLoaded(); + ObjectId noteId = getNoteId(key); + if (noteMap.contains(noteId)) { + + try (RevWalk rw = new RevWalk(repo)) { + ObjectId noteDataId = noteMap.get(noteId); + byte[] raw = readNoteData(rw, noteDataId); + return Optional.of(externalIdFactory.parse(noteId.name(), raw, noteDataId)); + } + } + return Optional.empty(); + } + + protected ObjectId getNoteId(ExternalId.Key key) throws IOException { ObjectId noteId = key.sha1(); - if (!noteMap.contains(noteId)) { - return Optional.empty(); + + if (!noteMap.contains(noteId) && isUserNameCaseInsensitiveMigrationMode) { + noteId = key.caseSensitiveSha1(); } - try (RevWalk rw = new RevWalk(repo)) { - ObjectId noteDataId = noteMap.get(noteId); - byte[] raw = readNoteData(rw, noteDataId); - return Optional.of(ExternalId.parse(noteId.name(), raw, noteDataId)); - } + return noteId; } /** @@ -414,7 +561,7 @@ for (Note note : noteMap) { byte[] raw = readNoteData(rw, note.getData()); try { - b.add(ExternalId.parse(note.getName(), raw, note.getData())); + b.add(externalIdFactory.parse(note.getName(), raw, note.getData())); } catch (ConfigInvalidException | RuntimeException e) { logger.atSevere().withCause(e).log( "Ignoring invalid external ID note %s", note.getName()); @@ -456,13 +603,15 @@ Set<ExternalId> newExtIds = new HashSet<>(); noteMapUpdates.add( - (rw, n, f) -> { + (rw, n) -> { for (ExternalId extId : extIds) { - ExternalId insertedExtId = upsert(rw, inserter, noteMap, f, extId); + ExternalId insertedExtId = upsert(rw, inserter, noteMap, extId); + preprocessUpsert(insertedExtId); newExtIds.add(insertedExtId); } }); cacheUpdates.add(cu -> cu.add(newExtIds)); + incrementalDuplicateDetection(extIds); } /** @@ -484,13 +633,15 @@ Set<ExternalId> removedExtIds = get(ExternalId.Key.from(extIds)); Set<ExternalId> updatedExtIds = new HashSet<>(); noteMapUpdates.add( - (rw, n, f) -> { + (rw, n) -> { for (ExternalId extId : extIds) { - ExternalId updatedExtId = upsert(rw, inserter, noteMap, f, extId); + ExternalId updatedExtId = upsert(rw, inserter, noteMap, extId); + preprocessUpsert(updatedExtId); updatedExtIds.add(updatedExtId); } }); cacheUpdates.add(cu -> cu.remove(removedExtIds).add(updatedExtIds)); + incrementalDuplicateDetection(extIds); } /** @@ -514,9 +665,9 @@ checkLoaded(); Set<ExternalId> removedExtIds = new HashSet<>(); noteMapUpdates.add( - (rw, n, f) -> { + (rw, n) -> { for (ExternalId extId : extIds) { - remove(rw, noteMap, f, extId); + remove(rw, noteMap, extId); removedExtIds.add(extId); } }); @@ -543,9 +694,9 @@ checkLoaded(); Set<ExternalId> removedExtIds = new HashSet<>(); noteMapUpdates.add( - (rw, n, f) -> { + (rw, n) -> { for (ExternalId.Key extIdKey : extIdKeys) { - ExternalId removedExtId = remove(rw, noteMap, f, extIdKey, accountId); + ExternalId removedExtId = remove(rw, noteMap, extIdKey, accountId); removedExtIds.add(removedExtId); } }); @@ -561,15 +712,21 @@ checkLoaded(); Set<ExternalId> removedExtIds = new HashSet<>(); noteMapUpdates.add( - (rw, n, f) -> { + (rw, n) -> { for (ExternalId.Key extIdKey : extIdKeys) { - ExternalId extId = remove(rw, noteMap, f, extIdKey, null); + ExternalId extId = remove(rw, noteMap, extIdKey, null); removedExtIds.add(extId); } }); cacheUpdates.add(cu -> cu.remove(removedExtIds)); } + public void replace( + Account.Id accountId, Collection<ExternalId.Key> toDelete, Collection<ExternalId> toAdd) + throws IOException, DuplicateExternalIdKeyException { + replace(accountId, toDelete, toAdd, defaultNoteIdResolver); + } + /** * Replaces external IDs for an account by external ID keys. * @@ -582,7 +739,10 @@ * the specified account. */ public void replace( - Account.Id accountId, Collection<ExternalId.Key> toDelete, Collection<ExternalId> toAdd) + Account.Id accountId, + Collection<ExternalId.Key> toDelete, + Collection<ExternalId> toAdd, + Function<ExternalId, ObjectId> noteIdResolver) throws IOException, DuplicateExternalIdKeyException { checkLoaded(); checkSameAccount(toAdd, accountId); @@ -591,20 +751,22 @@ Set<ExternalId> removedExtIds = new HashSet<>(); Set<ExternalId> updatedExtIds = new HashSet<>(); noteMapUpdates.add( - (rw, n, f) -> { + (rw, n) -> { for (ExternalId.Key extIdKey : toDelete) { - ExternalId removedExtId = remove(rw, noteMap, f, extIdKey, accountId); + ExternalId removedExtId = remove(rw, noteMap, extIdKey, accountId); if (removedExtId != null) { removedExtIds.add(removedExtId); } } for (ExternalId extId : toAdd) { - ExternalId insertedExtId = upsert(rw, inserter, noteMap, f, extId); + ExternalId insertedExtId = upsert(rw, inserter, noteMap, extId, noteIdResolver); + preprocessUpsert(insertedExtId); updatedExtIds.add(insertedExtId); } }); cacheUpdates.add(cu -> cu.add(updatedExtIds).remove(removedExtIds)); + incrementalDuplicateDetection(toAdd); } /** @@ -625,18 +787,20 @@ Set<ExternalId> removedExtIds = new HashSet<>(); Set<ExternalId> updatedExtIds = new HashSet<>(); noteMapUpdates.add( - (rw, n, f) -> { + (rw, n) -> { for (ExternalId.Key extIdKey : toDelete) { - ExternalId removedExtId = remove(rw, noteMap, f, extIdKey, null); + ExternalId removedExtId = remove(rw, noteMap, extIdKey, null); removedExtIds.add(removedExtId); } for (ExternalId extId : toAdd) { - ExternalId insertedExtId = upsert(rw, inserter, noteMap, f, extId); + ExternalId insertedExtId = upsert(rw, inserter, noteMap, extId); + preprocessUpsert(insertedExtId); updatedExtIds.add(insertedExtId); } }); cacheUpdates.add(cu -> cu.add(updatedExtIds).remove(removedExtIds)); + incrementalDuplicateDetection(toAdd); } /** @@ -672,6 +836,32 @@ replace(accountId, toDelete.stream().map(ExternalId::key).collect(toSet()), toAdd); } + /** + * Replaces external IDs. + * + * <p>Deletion of external IDs is done before adding the new external IDs. This means if an + * external ID is specified for deletion and an external ID with the same key is specified to be + * added, the old external ID with that key is deleted first and then the new external ID is added + * (so the external ID for that key is replaced). + * + * @throws IllegalStateException is thrown if the specified external IDs belong to different + * accounts. + */ + public void replace( + Collection<ExternalId> toDelete, + Collection<ExternalId> toAdd, + Function<ExternalId, ObjectId> noteIdResolver) + throws IOException, DuplicateExternalIdKeyException { + Account.Id accountId = checkSameAccount(Iterables.concat(toDelete, toAdd)); + if (accountId == null) { + // toDelete and toAdd are empty -> nothing to do + return; + } + + replace( + accountId, toDelete.stream().map(ExternalId::key).collect(toSet()), toAdd, noteIdResolver); + } + @Override protected void onLoad() throws IOException, ConfigInvalidException { if (revision != null) { @@ -695,66 +885,6 @@ return commit; } - /** - * Updates the caches (external ID cache, account cache) and reindexes the accounts for which - * external IDs were modified. - * - * <p>Must only be called after committing changes. - * - * <p>No-op if this instance was created by {@link #loadNoCacheUpdate(AllUsersName, Repository)}. - * - * <p>No eviction from account cache and no reindex if this instance was created by {@link - * FactoryNoReindex}. - */ - public void updateCaches() throws IOException { - updateCaches(ImmutableSet.of()); - } - - /** - * Updates the caches (external ID cache, account cache) and reindexes the accounts for which - * external IDs were modified. - * - * <p>Must only be called after committing changes. - * - * <p>No-op if this instance was created by {@link #loadNoCacheUpdate(AllUsersName, Repository)}. - * - * <p>No eviction from account cache if this instance was created by {@link FactoryNoReindex}. - * - * @param accountsToSkip set of accounts that should not be evicted from the account cache, in - * this case the caller must take care to evict them otherwise - */ - public void updateCaches(Collection<Account.Id> accountsToSkip) throws IOException { - checkState(oldRev != null, "no changes committed yet"); - - ExternalIdCacheUpdates externalIdCacheUpdates = new ExternalIdCacheUpdates(); - for (CacheUpdate cacheUpdate : cacheUpdates) { - cacheUpdate.execute(externalIdCacheUpdates); - } - - externalIdCache.onReplace( - oldRev, - getRevision(), - externalIdCacheUpdates.getRemoved(), - externalIdCacheUpdates.getAdded()); - - if (accountCache != null || accountIndexer != null) { - for (Account.Id id : - Streams.concat( - externalIdCacheUpdates.getAdded().stream(), - externalIdCacheUpdates.getRemoved().stream()) - .map(ExternalId::accountId) - .filter(i -> !accountsToSkip.contains(i)) - .collect(toSet())) { - if (accountIndexer != null) { - accountIndexer.get().index(id); - } - } - } - - cacheUpdates.clear(); - oldRev = null; - } - @Override protected boolean onSave(CommitBuilder commit) throws IOException, ConfigInvalidException { checkState(!readOnly, "Updating external IDs is disabled"); @@ -770,21 +900,14 @@ } try (RevWalk rw = new RevWalk(reader)) { - Set<String> footers = new HashSet<>(); for (NoteMapUpdate noteMapUpdate : noteMapUpdates) { try { - noteMapUpdate.execute(rw, noteMap, footers); + noteMapUpdate.execute(rw, noteMap); } catch (DuplicateExternalIdKeyException e) { throw new IOException(e); } } noteMapUpdates.clear(); - if (!footers.isEmpty()) { - commit.setMessage( - footers.stream() - .sorted() - .collect(joining("\n", commit.getMessage().trim() + "\n\n", ""))); - } RevTree oldTree = revision != null ? rw.parseTree(revision) : null; ObjectId newTreeId = noteMap.writeTree(inserter); @@ -829,23 +952,48 @@ return accountId; } + private void incrementalDuplicateDetection(Collection<ExternalId> externalIds) { + externalIds.stream() + .map(ExternalId::key) + .forEach( + key -> { + if (!keysToAdd.add(key)) { + throw new DuplicateExternalIdKeyException(key); + } + }); + } + /** - * Insert or updates an new external ID and sets it in the note map. + * Inserts or updates a new external ID and sets it in the note map. * - * <p>If the external ID already exists it is overwritten. + * <p>If the external ID already exists, it is overwritten. */ - private static ExternalId upsert( - RevWalk rw, ObjectInserter ins, NoteMap noteMap, Set<String> footers, ExternalId extId) + private ExternalId upsert(RevWalk rw, ObjectInserter ins, NoteMap noteMap, ExternalId extId) + throws IOException, ConfigInvalidException { + return upsert(rw, ins, noteMap, extId, defaultNoteIdResolver); + } + + /** + * Inserts or updates a new external ID and sets it in the note map. + * + * <p>If the external ID already exists, it is overwritten. + */ + private ExternalId upsert( + RevWalk rw, + ObjectInserter ins, + NoteMap noteMap, + ExternalId extId, + Function<ExternalId, ObjectId> noteIdResolver) throws IOException, ConfigInvalidException { ObjectId noteId = extId.key().sha1(); Config c = new Config(); - if (noteMap.contains(extId.key().sha1())) { + ObjectId resolvedNoteId = noteIdResolver.apply(extId); + if (noteMap.contains(resolvedNoteId)) { + noteId = resolvedNoteId; ObjectId noteDataId = noteMap.get(noteId); byte[] raw = readNoteData(rw, noteDataId); try { c = new BlobBasedConfig(null, raw); - ExternalId oldExtId = ExternalId.parse(noteId.name(), c, noteDataId); - addFooters(footers, oldExtId); } catch (ConfigInvalidException e) { throw new ConfigInvalidException( String.format("Invalid external id config for note %s: %s", noteId, e.getMessage())); @@ -855,9 +1003,7 @@ byte[] raw = c.toText().getBytes(UTF_8); ObjectId noteData = ins.insert(OBJ_BLOB, raw); noteMap.set(noteId, noteData); - ExternalId newExtId = ExternalId.create(extId, noteData); - addFooters(footers, newExtId); - return newExtId; + return externalIdFactory.create(extId, noteData); } /** @@ -866,25 +1012,23 @@ * @throws IllegalStateException is thrown if there is an existing external ID that has the same * key, but otherwise doesn't match the specified external ID. */ - private static ExternalId remove( - RevWalk rw, NoteMap noteMap, Set<String> footers, ExternalId extId) + private void remove(RevWalk rw, NoteMap noteMap, ExternalId extId) throws IOException, ConfigInvalidException { - ObjectId noteId = extId.key().sha1(); + ObjectId noteId = getNoteId(extId.key()); + if (!noteMap.contains(noteId)) { - return null; + return; } ObjectId noteDataId = noteMap.get(noteId); byte[] raw = readNoteData(rw, noteDataId); - ExternalId actualExtId = ExternalId.parse(noteId.name(), raw, noteDataId); + ExternalId actualExtId = externalIdFactory.parse(noteId.name(), raw, noteDataId); checkState( extId.equals(actualExtId), "external id %s should be removed, but it doesn't match the actual external id %s", extId.toString(), actualExtId.toString()); noteMap.remove(noteId); - addFooters(footers, actualExtId); - return actualExtId; } /** @@ -895,21 +1039,18 @@ * @return the external ID that was removed, {@code null} if no external ID with the specified key * exists */ - private static ExternalId remove( - RevWalk rw, - NoteMap noteMap, - Set<String> footers, - ExternalId.Key extIdKey, - Account.Id expectedAccountId) + private ExternalId remove( + RevWalk rw, NoteMap noteMap, ExternalId.Key extIdKey, Account.Id expectedAccountId) throws IOException, ConfigInvalidException { - ObjectId noteId = extIdKey.sha1(); + ObjectId noteId = getNoteId(extIdKey); + if (!noteMap.contains(noteId)) { return null; } ObjectId noteDataId = noteMap.get(noteId); byte[] raw = readNoteData(rw, noteDataId); - ExternalId extId = ExternalId.parse(noteId.name(), raw, noteDataId); + ExternalId extId = externalIdFactory.parse(noteId.name(), raw, noteDataId); if (expectedAccountId != null) { checkState( expectedAccountId.equals(extId.accountId()), @@ -920,17 +1061,9 @@ extId.accountId().get()); } noteMap.remove(noteId); - addFooters(footers, extId); return extId; } - private static void addFooters(Set<String> footers, ExternalId extId) { - footers.add("Account: " + extId.accountId().get()); - if (extId.email() != null) { - footers.add("Email: " + extId.email()); - } - } - private void checkExternalIdsDontExist(Collection<ExternalId> extIds) throws DuplicateExternalIdKeyException, IOException { checkExternalIdKeysDontExist(ExternalId.Key.from(extIds)); @@ -957,9 +1090,13 @@ checkState(noteMap != null, "External IDs not loaded yet"); } + private void preprocessUpsert(ExternalId extId) { + upsertPreprocessors.forEach(p -> p.get().upsert(extId)); + } + @FunctionalInterface private interface NoteMapUpdate { - void execute(RevWalk rw, NoteMap noteMap, Set<String> footers) + void execute(RevWalk rw, NoteMap noteMap) throws IOException, ConfigInvalidException, DuplicateExternalIdKeyException; } @@ -969,15 +1106,15 @@ } private static class ExternalIdCacheUpdates { - private final Set<ExternalId> added = new HashSet<>(); - private final Set<ExternalId> removed = new HashSet<>(); + final Set<ExternalId> added = new HashSet<>(); + final Set<ExternalId> removed = new HashSet<>(); ExternalIdCacheUpdates add(Collection<ExternalId> extIds) { this.added.addAll(extIds); return this; } - public Set<ExternalId> getAdded() { + Set<ExternalId> getAdded() { return ImmutableSet.copyOf(added); } @@ -986,7 +1123,7 @@ return this; } - public Set<ExternalId> getRemoved() { + Set<ExternalId> getRemoved() { return ImmutableSet.copyOf(removed); } }
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdReader.java b/java/com/google/gerrit/server/account/externalids/ExternalIdReader.java index c055313..e5aace0 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalIdReader.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdReader.java
@@ -23,6 +23,7 @@ import com.google.gerrit.metrics.MetricMaker; import com.google.gerrit.metrics.Timer0; import com.google.gerrit.server.config.AllUsersName; +import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.inject.Inject; import com.google.inject.Singleton; @@ -69,10 +70,16 @@ private boolean failOnLoad = false; private final Timer0 readAllLatency; private final Timer0 readSingleLatency; + private final ExternalIdFactory externalIdFactory; + private final AuthConfig authConfig; @Inject ExternalIdReader( - GitRepositoryManager repoManager, AllUsersName allUsersName, MetricMaker metricMaker) { + GitRepositoryManager repoManager, + AllUsersName allUsersName, + MetricMaker metricMaker, + ExternalIdFactory externalIdFactory, + AuthConfig authConfig) { this.repoManager = repoManager; this.allUsersName = allUsersName; this.readAllLatency = @@ -87,6 +94,8 @@ new Description("Latency for reading a single external ID from NoteDb.") .setCumulative() .setUnit(Units.MILLISECONDS)); + this.externalIdFactory = externalIdFactory; + this.authConfig = authConfig; } @VisibleForTesting @@ -106,7 +115,13 @@ try (Timer0.Context ctx = readAllLatency.start(); Repository repo = repoManager.openRepository(allUsersName)) { - return ExternalIdNotes.loadReadOnly(allUsersName, repo).all(); + return ExternalIdNotes.loadReadOnly( + allUsersName, + repo, + null, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()) + .all(); } } @@ -125,7 +140,13 @@ try (Timer0.Context ctx = readAllLatency.start(); Repository repo = repoManager.openRepository(allUsersName)) { - return ExternalIdNotes.loadReadOnly(allUsersName, repo, rev).all(); + return ExternalIdNotes.loadReadOnly( + allUsersName, + repo, + rev, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()) + .all(); } } @@ -135,7 +156,13 @@ try (Timer0.Context ctx = readSingleLatency.start(); Repository repo = repoManager.openRepository(allUsersName)) { - return ExternalIdNotes.loadReadOnly(allUsersName, repo).get(key); + return ExternalIdNotes.loadReadOnly( + allUsersName, + repo, + null, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()) + .get(key); } } @@ -146,7 +173,13 @@ try (Timer0.Context ctx = readSingleLatency.start(); Repository repo = repoManager.openRepository(allUsersName)) { - return ExternalIdNotes.loadReadOnly(allUsersName, repo, rev).get(key); + return ExternalIdNotes.loadReadOnly( + allUsersName, + repo, + rev, + externalIdFactory, + authConfig.isUserNameCaseInsensitiveMigrationMode()) + .get(key); } }
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdUpsertPreprocessor.java b/java/com/google/gerrit/server/account/externalids/ExternalIdUpsertPreprocessor.java new file mode 100644 index 0000000..c0697db --- /dev/null +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdUpsertPreprocessor.java
@@ -0,0 +1,30 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.account.externalids; + +import com.google.gerrit.extensions.annotations.ExtensionPoint; + +/** + * This optional preprocessor is called in {@link ExternalIdNotes} before an update is committed. + */ +@ExtensionPoint +public interface ExternalIdUpsertPreprocessor { + /** + * Called when inserting or updating an external ID. {@link ExternalId#blobId()} is set. The + * upsert can be blocked by throwing {@link com.google.gerrit.exceptions.StorageException}, e.g. + * when a precondition or preparatory work fails. + */ + void upsert(ExternalId extId); +}
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIds.java b/java/com/google/gerrit/server/account/externalids/ExternalIds.java index 302a25e..9450ff5 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalIds.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalIds.java
@@ -19,6 +19,7 @@ import com.google.common.collect.ImmutableSet; import com.google.common.collect.ImmutableSetMultimap; import com.google.gerrit.entities.Account; +import com.google.gerrit.server.config.AuthConfig; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -35,11 +36,19 @@ public class ExternalIds { private final ExternalIdReader externalIdReader; private final ExternalIdCache externalIdCache; + private final AuthConfig authConfig; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject - public ExternalIds(ExternalIdReader externalIdReader, ExternalIdCache externalIdCache) { + public ExternalIds( + ExternalIdReader externalIdReader, + ExternalIdCache externalIdCache, + ExternalIdKeyFactory externalIdKeyFactory, + AuthConfig authConfig) { this.externalIdReader = externalIdReader; this.externalIdCache = externalIdCache; + this.externalIdKeyFactory = externalIdKeyFactory; + this.authConfig = authConfig; } /** Returns all external IDs. */ @@ -53,8 +62,16 @@ } /** Returns the specified external ID. */ - public Optional<ExternalId> get(ExternalId.Key key) throws IOException, ConfigInvalidException { - return externalIdReader.get(key); + public Optional<ExternalId> get(ExternalId.Key key) throws IOException { + Optional<ExternalId> externalId = Optional.empty(); + if (authConfig.isUserNameCaseInsensitiveMigrationMode()) { + externalId = + externalIdCache.byKey(externalIdKeyFactory.create(key.scheme(), key.id(), false)); + } + if (!externalId.isPresent()) { + externalId = externalIdCache.byKey(key); + } + return externalId; } /** Returns the specified external ID from the given revision. */
diff --git a/java/com/google/gerrit/server/account/externalids/ExternalIdsConsistencyChecker.java b/java/com/google/gerrit/server/account/externalids/ExternalIdsConsistencyChecker.java index 815f7d0..4e67e3d 100644 --- a/java/com/google/gerrit/server/account/externalids/ExternalIdsConsistencyChecker.java +++ b/java/com/google/gerrit/server/account/externalids/ExternalIdsConsistencyChecker.java
@@ -43,29 +43,32 @@ private final AllUsersName allUsers; private final AccountCache accountCache; private final OutgoingEmailValidator validator; + private final ExternalIdFactory externalIdFactory; @Inject ExternalIdsConsistencyChecker( GitRepositoryManager repoManager, AllUsersName allUsers, AccountCache accountCache, - OutgoingEmailValidator validator) { + OutgoingEmailValidator validator, + ExternalIdFactory externalIdFactory) { this.repoManager = repoManager; this.allUsers = allUsers; this.accountCache = accountCache; this.validator = validator; + this.externalIdFactory = externalIdFactory; } public List<ConsistencyProblemInfo> check() throws IOException, ConfigInvalidException { try (Repository repo = repoManager.openRepository(allUsers)) { - return check(ExternalIdNotes.loadReadOnly(allUsers, repo)); + return check(ExternalIdNotes.loadReadOnly(allUsers, repo, null, externalIdFactory, false)); } } public List<ConsistencyProblemInfo> check(ObjectId rev) throws IOException, ConfigInvalidException { try (Repository repo = repoManager.openRepository(allUsers)) { - return check(ExternalIdNotes.loadReadOnly(allUsers, repo, rev)); + return check(ExternalIdNotes.loadReadOnly(allUsers, repo, rev, externalIdFactory, false)); } } @@ -79,7 +82,7 @@ for (Note note : noteMap) { byte[] raw = ExternalIdNotes.readNoteData(rw, note.getData()); try { - ExternalId extId = ExternalId.parse(note.getName(), raw, note.getData()); + ExternalId extId = externalIdFactory.parse(note.getName(), raw, note.getData()); problems.addAll(validateExternalId(extId)); if (extId.email() != null) {
diff --git a/java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java b/java/com/google/gerrit/server/account/externalids/OnlineExternalIdCaseSensivityMigratiorExecutor.java similarity index 60% copy from java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java copy to java/com/google/gerrit/server/account/externalids/OnlineExternalIdCaseSensivityMigratiorExecutor.java index 6451b0f..8a3e4f1 100644 --- a/java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java +++ b/java/com/google/gerrit/server/account/externalids/OnlineExternalIdCaseSensivityMigratiorExecutor.java
@@ -1,4 +1,4 @@ -// Copyright (C) 2018 The Android Open Source Project +// Copyright (C) 2021 The Android Open Source Project // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,11 +12,13 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.elasticsearch.bulk; +package com.google.gerrit.server.account.externalids; -public class DeleteRequest extends ActionRequest { +import static java.lang.annotation.RetentionPolicy.RUNTIME; - public DeleteRequest(String id, String index) { - super("delete", id, index); - } -} +import com.google.inject.BindingAnnotation; +import java.lang.annotation.Retention; + +@Retention(RUNTIME) +@BindingAnnotation +public @interface OnlineExternalIdCaseSensivityMigratiorExecutor {}
diff --git a/java/com/google/gerrit/server/account/externalids/OnlineExternalIdCaseSensivityMigrator.java b/java/com/google/gerrit/server/account/externalids/OnlineExternalIdCaseSensivityMigrator.java new file mode 100644 index 0000000..e52991b --- /dev/null +++ b/java/com/google/gerrit/server/account/externalids/OnlineExternalIdCaseSensivityMigrator.java
@@ -0,0 +1,117 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.account.externalids; + +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.config.SitePath; +import com.google.gerrit.server.index.ReindexerAlreadyRunningException; +import com.google.gerrit.server.index.VersionManager; +import com.google.inject.Inject; +import com.google.inject.Singleton; +import java.io.IOException; +import java.nio.file.Path; +import java.util.Collection; +import java.util.concurrent.Executor; +import java.util.concurrent.ExecutorService; +import org.eclipse.jgit.errors.ConfigInvalidException; +import org.eclipse.jgit.lib.Config; +import org.eclipse.jgit.lib.ProgressMonitor; +import org.eclipse.jgit.lib.TextProgressMonitor; +import org.eclipse.jgit.storage.file.FileBasedConfig; +import org.eclipse.jgit.util.FS; + +@Singleton +public class OnlineExternalIdCaseSensivityMigrator { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + private Executor executor; + private ExternalIdCaseSensitivityMigrator.Factory migratorFactory; + private ExternalIds externalIds; + private VersionManager versionManager; + private Config globalConfig; + private Path sitePath; + private final TextProgressMonitor monitor = new TextProgressMonitor(); + private boolean isUserNameCaseInsensitive; + private boolean isUserNameCaseInsensitiveMigrationMode; + + @Inject + public OnlineExternalIdCaseSensivityMigrator( + @OnlineExternalIdCaseSensivityMigratiorExecutor ExecutorService executor, + ExternalIdCaseSensitivityMigrator.Factory migratorFactory, + ExternalIds externalIds, + VersionManager versionManager, + @GerritServerConfig Config globalConfig, + @SitePath Path sitePath) { + this.migratorFactory = migratorFactory; + this.externalIds = externalIds; + this.versionManager = versionManager; + this.globalConfig = globalConfig; + this.sitePath = sitePath; + this.executor = executor; + this.isUserNameCaseInsensitiveMigrationMode = + globalConfig.getBoolean("auth", "userNameCaseInsensitiveMigrationMode", false); + this.isUserNameCaseInsensitive = + globalConfig.getBoolean("auth", "userNameCaseInsensitive", false); + } + + public void migrate() { + if (!isUserNameCaseInsensitive || !isUserNameCaseInsensitiveMigrationMode) { + logger.atSevere().log( + "External IDs online migration requires auth.userNameCaseInsensitive and auth.userNameCaseInsensitiveMigrationMode to be set to true. Skipping migration!"); + return; + } + executor.execute( + () -> { + try { + Collection<ExternalId> todo = externalIds.all(); + try { + monitor.beginTask("Converting external ID note names", todo.size()); + migratorFactory + .create(isUserNameCaseInsensitive, false) + .migrate(todo, () -> monitor.update(1)); + } finally { + monitor.endTask(); + } + try { + updateGerritConfig(); + monitor.beginTask("Reindex accounts", ProgressMonitor.UNKNOWN); + versionManager.startReindexer("accounts", true); + } finally { + monitor.endTask(); + } + logger.atInfo().log("External IDs migration completed!"); + } catch (IOException | ConfigInvalidException e) { + logger.atSevere().withCause(e).log( + "Exception during the external ids migration, cause %s", e.getMessage()); + } catch (ReindexerAlreadyRunningException e) { + logger.atSevere().log("Failed to reindex external ids: %s", e.getMessage()); + } + }); + } + + private void updateGerritConfig() throws IOException, ConfigInvalidException { + logger.atInfo().log( + "Setting auth.userNameCaseInsensitiveMigrationMode to false in gerrit.config."); + + FileBasedConfig config = + new FileBasedConfig( + globalConfig, sitePath.resolve("etc/gerrit.config").toFile(), FS.DETECTED); + config.load(); + config.setBoolean("auth", null, "userNameCaseInsensitiveMigrationMode", false); + + config.save(); + } +}
diff --git a/java/com/google/gerrit/server/account/externalids/PasswordVerifier.java b/java/com/google/gerrit/server/account/externalids/PasswordVerifier.java index 3f2f774..eb2bea9 100644 --- a/java/com/google/gerrit/server/account/externalids/PasswordVerifier.java +++ b/java/com/google/gerrit/server/account/externalids/PasswordVerifier.java
@@ -20,24 +20,47 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; import com.google.gerrit.server.account.HashedPassword; +import com.google.gerrit.server.config.AuthConfig; +import com.google.inject.Inject; import java.util.Collection; /** Checks if a given username and password match a user's external IDs. */ public class PasswordVerifier { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + private final ExternalIdKeyFactory externalIdKeyFactory; + + private AuthConfig authConfig; + + @Inject + public PasswordVerifier(ExternalIdKeyFactory externalIdKeyFactory, AuthConfig authConfig) { + this.externalIdKeyFactory = externalIdKeyFactory; + this.authConfig = authConfig; + } + /** Returns {@code true} if there is an external ID matching both the username and password. */ - public static boolean checkPassword( + public boolean checkPassword( Collection<ExternalId> externalIds, String username, @Nullable String password) { if (password == null) { return false; } + for (ExternalId id : externalIds) { // Only process the "username:$USER" entry, which is unique. - if (!id.isScheme(SCHEME_USERNAME) || !username.equals(id.key().id())) { + if (!id.isScheme(SCHEME_USERNAME)) { continue; } + if (!id.key().equals(externalIdKeyFactory.create(SCHEME_USERNAME, username))) { + if (!authConfig.isUserNameCaseInsensitiveMigrationMode()) { + continue; + } + + if (!id.key().equals(externalIdKeyFactory.create(SCHEME_USERNAME, username, false))) { + continue; + } + } + String hashedStr = id.password(); if (!Strings.isNullOrEmpty(hashedStr)) { try {
diff --git a/java/com/google/gerrit/server/account/externalids/testing/ExternalIdTestUtil.java b/java/com/google/gerrit/server/account/externalids/testing/ExternalIdTestUtil.java index b8040f7..a42afc3 100644 --- a/java/com/google/gerrit/server/account/externalids/testing/ExternalIdTestUtil.java +++ b/java/com/google/gerrit/server/account/externalids/testing/ExternalIdTestUtil.java
@@ -45,7 +45,9 @@ rw, ident, (ins, noteMap) -> { - ExternalId extId = ExternalId.create(ExternalId.Key.parse(externalId), accountId); + ExternalId extId = + ExternalId.create( + ExternalId.Key.parse(externalId, false), accountId, null, null, null); ObjectId noteId = extId.key().sha1(); Config c = new Config(); extId.writeToConfig(c); @@ -65,8 +67,10 @@ rw, ident, (ins, noteMap) -> { - ExternalId extId = ExternalId.create(ExternalId.Key.parse(externalId), accountId); - ObjectId noteId = ExternalId.Key.parse(externalId + "x").sha1(); + ExternalId extId = + ExternalId.create( + ExternalId.Key.parse(externalId, false), accountId, null, null, null); + ObjectId noteId = ExternalId.Key.parse(externalId + "x", false).sha1(); Config c = new Config(); extId.writeToConfig(c); byte[] raw = c.toText().getBytes(UTF_8); @@ -83,7 +87,7 @@ rw, ident, (ins, noteMap) -> { - ObjectId noteId = ExternalId.Key.parse(externalId).sha1(); + ObjectId noteId = ExternalId.Key.parse(externalId, false).sha1(); byte[] raw = "bad-config".getBytes(UTF_8); ObjectId dataBlob = ins.insert(OBJ_BLOB, raw); noteMap.set(noteId, dataBlob); @@ -98,7 +102,7 @@ rw, ident, (ins, noteMap) -> { - ObjectId noteId = ExternalId.Key.parse(externalId).sha1(); + ObjectId noteId = ExternalId.Key.parse(externalId, false).sha1(); byte[] raw = "".getBytes(UTF_8); ObjectId dataBlob = ins.insert(OBJ_BLOB, raw); noteMap.set(noteId, dataBlob);
diff --git a/java/com/google/gerrit/server/api/GerritApiModule.java b/java/com/google/gerrit/server/api/GerritApiModule.java index 9e60107..37fde47 100644 --- a/java/com/google/gerrit/server/api/GerritApiModule.java +++ b/java/com/google/gerrit/server/api/GerritApiModule.java
@@ -16,16 +16,21 @@ import com.google.gerrit.extensions.api.GerritApi; import com.google.gerrit.extensions.config.FactoryModule; +import com.google.gerrit.server.api.accounts.AccountsModule; +import com.google.gerrit.server.api.changes.ChangesModule; +import com.google.gerrit.server.api.config.ConfigModule; +import com.google.gerrit.server.api.groups.GroupsModule; +import com.google.gerrit.server.api.projects.ProjectsModule; public class GerritApiModule extends FactoryModule { @Override protected void configure() { bind(GerritApi.class).to(GerritApiImpl.class); - install(new com.google.gerrit.server.api.accounts.Module()); - install(new com.google.gerrit.server.api.changes.Module()); - install(new com.google.gerrit.server.api.config.Module()); - install(new com.google.gerrit.server.api.groups.Module()); - install(new com.google.gerrit.server.api.projects.Module()); + install(new AccountsModule()); + install(new ChangesModule()); + install(new ConfigModule()); + install(new GroupsModule()); + install(new ProjectsModule()); } }
diff --git a/java/com/google/gerrit/server/api/accounts/AccountApiImpl.java b/java/com/google/gerrit/server/api/accounts/AccountApiImpl.java index 1eee10f..b23782f 100644 --- a/java/com/google/gerrit/server/api/accounts/AccountApiImpl.java +++ b/java/com/google/gerrit/server/api/accounts/AccountApiImpl.java
@@ -28,7 +28,6 @@ import com.google.gerrit.extensions.api.accounts.GpgKeyApi; import com.google.gerrit.extensions.api.accounts.SshKeyInput; import com.google.gerrit.extensions.api.accounts.StatusInput; -import com.google.gerrit.extensions.api.changes.StarsInput; import com.google.gerrit.extensions.client.DiffPreferencesInfo; import com.google.gerrit.extensions.client.EditPreferencesInfo; import com.google.gerrit.extensions.client.GeneralPreferencesInfo; @@ -37,7 +36,6 @@ import com.google.gerrit.extensions.common.AccountExternalIdInfo; import com.google.gerrit.extensions.common.AccountInfo; import com.google.gerrit.extensions.common.AgreementInfo; -import com.google.gerrit.extensions.common.ChangeInfo; import com.google.gerrit.extensions.common.EmailInfo; import com.google.gerrit.extensions.common.GpgKeyInfo; import com.google.gerrit.extensions.common.GroupInfo; @@ -86,13 +84,11 @@ import com.google.gerrit.server.restapi.account.SetPreferences; import com.google.gerrit.server.restapi.account.SshKeys; import com.google.gerrit.server.restapi.account.StarredChanges; -import com.google.gerrit.server.restapi.account.Stars; import com.google.gerrit.server.restapi.change.ChangesCollection; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; import java.util.List; import java.util.Map; -import java.util.SortedSet; public class AccountApiImpl implements AccountApi { interface Factory { @@ -115,9 +111,6 @@ private final DeleteWatchedProjects deleteWatchedProjects; private final StarredChanges.Create starredChangesCreate; private final StarredChanges.Delete starredChangesDelete; - private final Stars stars; - private final Stars.Get starsGet; - private final Stars.Post starsPost; private final GetEmails getEmails; private final CreateEmail createEmail; private final DeleteEmail deleteEmail; @@ -159,9 +152,6 @@ DeleteWatchedProjects deleteWatchedProjects, StarredChanges.Create starredChangesCreate, StarredChanges.Delete starredChangesDelete, - Stars stars, - Stars.Get starsGet, - Stars.Post starsPost, GetEmails getEmails, CreateEmail createEmail, DeleteEmail deleteEmail, @@ -202,9 +192,6 @@ this.deleteWatchedProjects = deleteWatchedProjects; this.starredChangesCreate = starredChangesCreate; this.starredChangesDelete = starredChangesDelete; - this.stars = stars; - this.starsGet = starsGet; - this.starsPost = starsPost; this.getEmails = getEmails; this.createEmail = createEmail; this.deleteEmail = deleteEmail; @@ -384,35 +371,6 @@ } @Override - public void setStars(String changeId, StarsInput input) throws RestApiException { - try { - AccountResource.Star rsrc = stars.parse(account, IdString.fromUrl(changeId)); - starsPost.apply(rsrc, input); - } catch (Exception e) { - throw asRestApiException("Cannot post stars", e); - } - } - - @Override - public SortedSet<String> getStars(String changeId) throws RestApiException { - try { - AccountResource.Star rsrc = stars.parse(account, IdString.fromUrl(changeId)); - return starsGet.apply(rsrc).value(); - } catch (Exception e) { - throw asRestApiException("Cannot get stars", e); - } - } - - @Override - public List<ChangeInfo> getStarredChanges() throws RestApiException { - try { - return stars.list().apply(account).value(); - } catch (Exception e) { - throw asRestApiException("Cannot get starred changes", e); - } - } - - @Override public List<GroupInfo> getGroups() throws RestApiException { try { return getGroups.apply(account).value();
diff --git a/java/com/google/gerrit/server/api/accounts/Module.java b/java/com/google/gerrit/server/api/accounts/AccountsModule.java similarity index 94% rename from java/com/google/gerrit/server/api/accounts/Module.java rename to java/com/google/gerrit/server/api/accounts/AccountsModule.java index 15c6ddb..70513b6 100644 --- a/java/com/google/gerrit/server/api/accounts/Module.java +++ b/java/com/google/gerrit/server/api/accounts/AccountsModule.java
@@ -17,7 +17,7 @@ import com.google.gerrit.extensions.api.accounts.Accounts; import com.google.gerrit.extensions.config.FactoryModule; -public class Module extends FactoryModule { +public class AccountsModule extends FactoryModule { @Override protected void configure() { bind(Accounts.class).to(AccountsImpl.class);
diff --git a/java/com/google/gerrit/server/api/changes/ChangeApiImpl.java b/java/com/google/gerrit/server/api/changes/ChangeApiImpl.java index 0b340b8..a49061d 100644 --- a/java/com/google/gerrit/server/api/changes/ChangeApiImpl.java +++ b/java/com/google/gerrit/server/api/changes/ChangeApiImpl.java
@@ -21,8 +21,6 @@ import com.google.gerrit.common.Nullable; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.AbandonInput; -import com.google.gerrit.extensions.api.changes.AddReviewerInput; -import com.google.gerrit.extensions.api.changes.AddReviewerResult; import com.google.gerrit.extensions.api.changes.AssigneeInput; import com.google.gerrit.extensions.api.changes.AttentionSetApi; import com.google.gerrit.extensions.api.changes.AttentionSetInput; @@ -39,6 +37,8 @@ import com.google.gerrit.extensions.api.changes.RevertInput; import com.google.gerrit.extensions.api.changes.ReviewerApi; import com.google.gerrit.extensions.api.changes.ReviewerInfo; +import com.google.gerrit.extensions.api.changes.ReviewerInput; +import com.google.gerrit.extensions.api.changes.ReviewerResult; import com.google.gerrit.extensions.api.changes.RevisionApi; import com.google.gerrit.extensions.api.changes.SubmittedTogetherInfo; import com.google.gerrit.extensions.api.changes.SubmittedTogetherOption; @@ -56,6 +56,8 @@ import com.google.gerrit.extensions.common.PureRevertInfo; import com.google.gerrit.extensions.common.RevertSubmissionInfo; import com.google.gerrit.extensions.common.RobotCommentInfo; +import com.google.gerrit.extensions.common.SubmitRequirementInput; +import com.google.gerrit.extensions.common.SubmitRequirementResultInfo; import com.google.gerrit.extensions.common.SuggestedReviewerInfo; import com.google.gerrit.extensions.registration.DynamicMap; import com.google.gerrit.extensions.restapi.BadRequestException; @@ -74,6 +76,7 @@ import com.google.gerrit.server.restapi.change.ChangeIncludedIn; import com.google.gerrit.server.restapi.change.ChangeMessages; import com.google.gerrit.server.restapi.change.Check; +import com.google.gerrit.server.restapi.change.CheckSubmitRequirement; import com.google.gerrit.server.restapi.change.CreateMergePatchSet; import com.google.gerrit.server.restapi.change.DeleteAssignee; import com.google.gerrit.server.restapi.change.DeleteChange; @@ -91,8 +94,6 @@ import com.google.gerrit.server.restapi.change.ListChangeDrafts; import com.google.gerrit.server.restapi.change.ListChangeRobotComments; import com.google.gerrit.server.restapi.change.ListReviewers; -import com.google.gerrit.server.restapi.change.MarkAsReviewed; -import com.google.gerrit.server.restapi.change.MarkAsUnreviewed; import com.google.gerrit.server.restapi.change.Move; import com.google.gerrit.server.restapi.change.PostHashtags; import com.google.gerrit.server.restapi.change.PostPrivate; @@ -166,14 +167,13 @@ private final Provider<ListChangeDrafts> listDraftsProvider; private final ChangeEditApiImpl.Factory changeEditApi; private final Check check; + private final CheckSubmitRequirement checkSubmitRequirement; private final Index index; private final Move move; private final PostPrivate postPrivate; private final DeletePrivate deletePrivate; private final Ignore ignore; private final Unignore unignore; - private final MarkAsReviewed markAsReviewed; - private final MarkAsUnreviewed markAsUnreviewed; private final SetWorkInProgress setWip; private final SetReadyForReview setReady; private final PutMessage putMessage; @@ -222,14 +222,13 @@ Provider<ListChangeDrafts> listDraftsProvider, ChangeEditApiImpl.Factory changeEditApi, Check check, + CheckSubmitRequirement checkSubmitRequirement, Index index, Move move, PostPrivate postPrivate, DeletePrivate deletePrivate, Ignore ignore, Unignore unignore, - MarkAsReviewed markAsReviewed, - MarkAsUnreviewed markAsUnreviewed, SetWorkInProgress setWip, SetReadyForReview setReady, PutMessage putMessage, @@ -276,14 +275,13 @@ this.listDraftsProvider = listDraftsProvider; this.changeEditApi = changeEditApi; this.check = check; + this.checkSubmitRequirement = checkSubmitRequirement; this.index = index; this.move = move; this.postPrivate = postPrivate; this.deletePrivate = deletePrivate; this.ignore = ignore; this.unignore = unignore; - this.markAsReviewed = markAsReviewed; - this.markAsUnreviewed = markAsUnreviewed; this.setWip = setWip; this.setReady = setReady; this.putMessage = putMessage; @@ -467,7 +465,7 @@ } @Override - public AddReviewerResult addReviewer(AddReviewerInput in) throws RestApiException { + public ReviewerResult addReviewer(ReviewerInput in) throws RestApiException { try { return postReviewers.apply(change, in).value(); } catch (Exception e) { @@ -716,6 +714,16 @@ } @Override + public SubmitRequirementResultInfo checkSubmitRequirement(SubmitRequirementInput input) + throws RestApiException { + try { + return checkSubmitRequirement.apply(change, input).value(); + } catch (Exception e) { + throw asRestApiException("Cannot check submit requirement", e); + } + } + + @Override public void index() throws RestApiException { try { index.apply(change, new Input()); @@ -749,22 +757,6 @@ } @Override - public void markAsReviewed(boolean reviewed) throws RestApiException { - // TODO(dborowitz): Convert to RetryingRestModifyView. Needs to plumb BatchUpdate.Factory into - // StarredChangesUtil. - try { - if (reviewed) { - markAsReviewed.apply(change, new Input()); - } else { - markAsUnreviewed.apply(change, new Input()); - } - } catch (StorageException | IllegalLabelException e) { - throw asRestApiException( - "Cannot mark change as " + (reviewed ? "reviewed" : "unreviewed"), e); - } - } - - @Override public PureRevertInfo pureRevert() throws RestApiException { return pureRevert(null); }
diff --git a/java/com/google/gerrit/server/api/changes/Module.java b/java/com/google/gerrit/server/api/changes/ChangesModule.java similarity index 96% rename from java/com/google/gerrit/server/api/changes/Module.java rename to java/com/google/gerrit/server/api/changes/ChangesModule.java index f54d1fe..729396b 100644 --- a/java/com/google/gerrit/server/api/changes/Module.java +++ b/java/com/google/gerrit/server/api/changes/ChangesModule.java
@@ -17,7 +17,7 @@ import com.google.gerrit.extensions.api.changes.Changes; import com.google.gerrit.extensions.config.FactoryModule; -public class Module extends FactoryModule { +public class ChangesModule extends FactoryModule { @Override protected void configure() { bind(Changes.class).to(ChangesImpl.class);
diff --git a/java/com/google/gerrit/server/api/changes/RevisionApiImpl.java b/java/com/google/gerrit/server/api/changes/RevisionApiImpl.java index 573f2f5..764c46d 100644 --- a/java/com/google/gerrit/server/api/changes/RevisionApiImpl.java +++ b/java/com/google/gerrit/server/api/changes/RevisionApiImpl.java
@@ -57,9 +57,9 @@ import com.google.gerrit.extensions.restapi.IdString; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.extensions.restapi.RestModifyView; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.account.AccountDirectory.FillOptions; import com.google.gerrit.server.account.AccountLoader; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.FileResource; import com.google.gerrit.server.change.RebaseUtil; import com.google.gerrit.server.change.RevisionResource; @@ -261,9 +261,9 @@ } @Override - public void submit(SubmitInput in) throws RestApiException { + public ChangeInfo submit(SubmitInput in) throws RestApiException { try { - submit.apply(revision, in); + return submit.apply(revision, in).value(); } catch (Exception e) { throw asRestApiException("Cannot submit change", e); } @@ -642,7 +642,7 @@ ListMultimapBuilder.treeKeys().arrayListValues().build(); try { Iterable<PatchSetApproval> approvals = - approvalsUtil.byPatchSet(revision.getNotes(), revision.getPatchSet().id(), null, null); + approvalsUtil.byPatchSet(revision.getNotes(), revision.getPatchSet().id()); AccountLoader accountLoader = accountLoaderFactory.create( EnumSet.of(
diff --git a/java/com/google/gerrit/server/api/config/Module.java b/java/com/google/gerrit/server/api/config/ConfigModule.java similarity index 94% rename from java/com/google/gerrit/server/api/config/Module.java rename to java/com/google/gerrit/server/api/config/ConfigModule.java index b37aa1c..9340ae1 100644 --- a/java/com/google/gerrit/server/api/config/Module.java +++ b/java/com/google/gerrit/server/api/config/ConfigModule.java
@@ -18,7 +18,7 @@ import com.google.gerrit.extensions.api.config.Server; import com.google.gerrit.extensions.config.FactoryModule; -public class Module extends FactoryModule { +public class ConfigModule extends FactoryModule { @Override protected void configure() { bind(Config.class).to(ConfigImpl.class);
diff --git a/java/com/google/gerrit/server/api/groups/Module.java b/java/com/google/gerrit/server/api/groups/GroupsModule.java similarity index 94% rename from java/com/google/gerrit/server/api/groups/Module.java rename to java/com/google/gerrit/server/api/groups/GroupsModule.java index 7d7af4e..58925e6 100644 --- a/java/com/google/gerrit/server/api/groups/Module.java +++ b/java/com/google/gerrit/server/api/groups/GroupsModule.java
@@ -17,7 +17,7 @@ import com.google.gerrit.extensions.api.groups.Groups; import com.google.gerrit.extensions.config.FactoryModule; -public class Module extends FactoryModule { +public class GroupsModule extends FactoryModule { @Override protected void configure() { bind(Groups.class).to(GroupsImpl.class);
diff --git a/java/com/google/gerrit/server/api/projects/ProjectApiImpl.java b/java/com/google/gerrit/server/api/projects/ProjectApiImpl.java index 6d7fc15..9521759 100644 --- a/java/com/google/gerrit/server/api/projects/ProjectApiImpl.java +++ b/java/com/google/gerrit/server/api/projects/ProjectApiImpl.java
@@ -63,6 +63,7 @@ import com.google.gerrit.server.restapi.project.CheckAccess; import com.google.gerrit.server.restapi.project.ChildProjectsCollection; import com.google.gerrit.server.restapi.project.CommitsCollection; +import com.google.gerrit.server.restapi.project.CommitsIncludedInRefs; import com.google.gerrit.server.restapi.project.CreateAccessChange; import com.google.gerrit.server.restapi.project.CreateProject; import com.google.gerrit.server.restapi.project.DeleteBranches; @@ -88,8 +89,11 @@ import com.google.inject.Provider; import com.google.inject.assistedinject.Assisted; import com.google.inject.assistedinject.AssistedInject; +import java.util.Collection; import java.util.Collections; import java.util.List; +import java.util.Map; +import java.util.Set; public class ProjectApiImpl implements ProjectApi { interface Factory { @@ -116,6 +120,7 @@ private final CreateAccessChange createAccessChange; private final GetConfig getConfig; private final PutConfig putConfig; + private final CommitsIncludedInRefs commitsIncludedInRefs; private final Provider<ListBranches> listBranches; private final Provider<ListTags> listTags; private final DeleteBranches deleteBranches; @@ -154,6 +159,7 @@ CreateAccessChange createAccessChange, GetConfig getConfig, PutConfig putConfig, + CommitsIncludedInRefs commitsIncludedInRefs, Provider<ListBranches> listBranches, Provider<ListTags> listTags, DeleteBranches deleteBranches, @@ -191,6 +197,7 @@ createAccessChange, getConfig, putConfig, + commitsIncludedInRefs, listBranches, listTags, deleteBranches, @@ -232,6 +239,7 @@ CreateAccessChange createAccessChange, GetConfig getConfig, PutConfig putConfig, + CommitsIncludedInRefs commitsIncludedInRefs, Provider<ListBranches> listBranches, Provider<ListTags> listTags, DeleteBranches deleteBranches, @@ -269,6 +277,7 @@ createAccessChange, getConfig, putConfig, + commitsIncludedInRefs, listBranches, listTags, deleteBranches, @@ -309,6 +318,7 @@ CreateAccessChange createAccessChange, GetConfig getConfig, PutConfig putConfig, + CommitsIncludedInRefs commitsIncludedInRefs, Provider<ListBranches> listBranches, Provider<ListTags> listTags, DeleteBranches deleteBranches, @@ -346,6 +356,7 @@ this.setAccess = setAccess; this.getConfig = getConfig; this.putConfig = putConfig; + this.commitsIncludedInRefs = commitsIncludedInRefs; this.listBranches = listBranches; this.listTags = listTags; this.deleteBranches = deleteBranches; @@ -483,6 +494,18 @@ } @Override + public Map<String, Set<String>> commitsIn(Collection<String> commits, Collection<String> refs) + throws RestApiException { + try { + commitsIncludedInRefs.addCommits(commits); + commitsIncludedInRefs.addRefs(refs); + return commitsIncludedInRefs.apply(project).value(); + } catch (Exception e) { + throw asRestApiException("Cannot list commits included in refs", e); + } + } + + @Override public ListRefsRequest<BranchInfo> branches() { return new ListRefsRequest<BranchInfo>() { @Override
diff --git a/java/com/google/gerrit/server/api/projects/Module.java b/java/com/google/gerrit/server/api/projects/ProjectsModule.java similarity index 95% rename from java/com/google/gerrit/server/api/projects/Module.java rename to java/com/google/gerrit/server/api/projects/ProjectsModule.java index 8df5495..987c71f 100644 --- a/java/com/google/gerrit/server/api/projects/Module.java +++ b/java/com/google/gerrit/server/api/projects/ProjectsModule.java
@@ -17,7 +17,7 @@ import com.google.gerrit.extensions.api.projects.Projects; import com.google.gerrit.extensions.config.FactoryModule; -public class Module extends FactoryModule { +public class ProjectsModule extends FactoryModule { @Override protected void configure() { bind(Projects.class).to(ProjectsImpl.class);
diff --git a/java/com/google/gerrit/server/approval/ApprovalCache.java b/java/com/google/gerrit/server/approval/ApprovalCache.java new file mode 100644 index 0000000..5637249 --- /dev/null +++ b/java/com/google/gerrit/server/approval/ApprovalCache.java
@@ -0,0 +1,28 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.approval; + +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.entities.PatchSetApproval; +import com.google.gerrit.server.notedb.ChangeNotes; + +/** + * Cache that holds approvals per patch set and NoteDb state. This includes approvals copied forward + * from older patch sets. + */ +public interface ApprovalCache { + /** Returns {@link PatchSetApproval}s for the given patch set. */ + Iterable<PatchSetApproval> get(ChangeNotes notes, PatchSet.Id psId); +}
diff --git a/java/com/google/gerrit/server/approval/ApprovalCacheImpl.java b/java/com/google/gerrit/server/approval/ApprovalCacheImpl.java new file mode 100644 index 0000000..fd31da9 --- /dev/null +++ b/java/com/google/gerrit/server/approval/ApprovalCacheImpl.java
@@ -0,0 +1,133 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.approval; + +import com.google.common.cache.CacheLoader; +import com.google.common.cache.LoadingCache; +import com.google.common.collect.ImmutableList; +import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.entities.PatchSetApproval; +import com.google.gerrit.entities.Project; +import com.google.gerrit.entities.converter.PatchSetApprovalProtoConverter; +import com.google.gerrit.exceptions.StorageException; +import com.google.gerrit.proto.Entities; +import com.google.gerrit.server.cache.CacheModule; +import com.google.gerrit.server.cache.proto.Cache; +import com.google.gerrit.server.cache.serialize.ObjectIdCacheSerializer; +import com.google.gerrit.server.cache.serialize.ProtobufSerializer; +import com.google.gerrit.server.notedb.ChangeNotes; +import com.google.inject.Inject; +import com.google.inject.Module; +import com.google.inject.Singleton; +import com.google.inject.name.Named; +import com.google.protobuf.ByteString; +import java.util.concurrent.ExecutionException; + +/** Implementation of the {@link ApprovalCache} interface */ +public class ApprovalCacheImpl implements ApprovalCache { + private static final String CACHE_NAME = "approvals"; + + public static Module module() { + return new CacheModule() { + @Override + protected void configure() { + bind(ApprovalCache.class).to(ApprovalCacheImpl.class); + persist( + CACHE_NAME, + Cache.PatchSetApprovalsKeyProto.class, + Cache.AllPatchSetApprovalsProto.class) + .version(2) + .loader(Loader.class) + .keySerializer(new ProtobufSerializer<>(Cache.PatchSetApprovalsKeyProto.parser())) + .valueSerializer(new ProtobufSerializer<>(Cache.AllPatchSetApprovalsProto.parser())); + } + }; + } + + private final LoadingCache<Cache.PatchSetApprovalsKeyProto, Cache.AllPatchSetApprovalsProto> + cache; + + @Inject + ApprovalCacheImpl( + @Named(CACHE_NAME) + LoadingCache<Cache.PatchSetApprovalsKeyProto, Cache.AllPatchSetApprovalsProto> cache) { + this.cache = cache; + } + + @Override + public Iterable<PatchSetApproval> get(ChangeNotes notes, PatchSet.Id psId) { + try { + return fromProto( + cache.get( + Cache.PatchSetApprovalsKeyProto.newBuilder() + .setChangeId(notes.getChangeId().get()) + .setPatchSetId(psId.get()) + .setProject(notes.getProjectName().get()) + .setId( + ByteString.copyFrom( + ObjectIdCacheSerializer.INSTANCE.serialize(notes.getMetaId()))) + .build())); + } catch (ExecutionException e) { + throw new StorageException(e); + } + } + + @Singleton + static class Loader + extends CacheLoader<Cache.PatchSetApprovalsKeyProto, Cache.AllPatchSetApprovalsProto> { + private final ApprovalInference approvalInference; + private final ChangeNotes.Factory changeNotesFactory; + + @Inject + Loader(ApprovalInference approvalInference, ChangeNotes.Factory changeNotesFactory) { + this.approvalInference = approvalInference; + this.changeNotesFactory = changeNotesFactory; + } + + @Override + public Cache.AllPatchSetApprovalsProto load(Cache.PatchSetApprovalsKeyProto key) + throws Exception { + Change.Id changeId = Change.id(key.getChangeId()); + return toProto( + approvalInference.forPatchSet( + changeNotesFactory.createChecked( + Project.nameKey(key.getProject()), + changeId, + ObjectIdCacheSerializer.INSTANCE.deserialize(key.getId().toByteArray())), + PatchSet.id(changeId, key.getPatchSetId()), + null + /* revWalk= */ , + null + /* repoConfig= */ )); + } + } + + private static Iterable<PatchSetApproval> fromProto(Cache.AllPatchSetApprovalsProto proto) { + ImmutableList.Builder<PatchSetApproval> builder = ImmutableList.builder(); + for (Entities.PatchSetApproval psa : proto.getApprovalList()) { + builder.add(PatchSetApprovalProtoConverter.INSTANCE.fromProto(psa)); + } + return builder.build(); + } + + private static Cache.AllPatchSetApprovalsProto toProto(Iterable<PatchSetApproval> autoValue) { + Cache.AllPatchSetApprovalsProto.Builder builder = Cache.AllPatchSetApprovalsProto.newBuilder(); + for (PatchSetApproval psa : autoValue) { + builder.addApproval(PatchSetApprovalProtoConverter.INSTANCE.toProto(psa)); + } + return builder.build(); + } +}
diff --git a/java/com/google/gerrit/server/ApprovalInference.java b/java/com/google/gerrit/server/approval/ApprovalInference.java similarity index 68% rename from java/com/google/gerrit/server/ApprovalInference.java rename to java/com/google/gerrit/server/approval/ApprovalInference.java index 04d874c..695997a 100644 --- a/java/com/google/gerrit/server/ApprovalInference.java +++ b/java/com/google/gerrit/server/approval/ApprovalInference.java
@@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.server; +package com.google.gerrit.server.approval; import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkState; @@ -26,35 +26,35 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.LabelType; import com.google.gerrit.entities.LabelTypes; -import com.google.gerrit.entities.Patch.ChangeType; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetApproval; -import com.google.gerrit.entities.Project; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.client.ChangeKind; +import com.google.gerrit.index.query.QueryParseException; import com.google.gerrit.server.change.ChangeKindCache; import com.google.gerrit.server.change.LabelNormalizer; -import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.TraceContext; import com.google.gerrit.server.logging.TraceContext.TraceTimer; import com.google.gerrit.server.notedb.ChangeNotes; -import com.google.gerrit.server.patch.PatchList; -import com.google.gerrit.server.patch.PatchListCache; -import com.google.gerrit.server.patch.PatchListKey; -import com.google.gerrit.server.patch.PatchListNotAvailableException; +import com.google.gerrit.server.patch.DiffNotAvailableException; +import com.google.gerrit.server.patch.DiffOperations; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.project.ProjectState; +import com.google.gerrit.server.query.approval.ApprovalContext; +import com.google.gerrit.server.query.approval.ApprovalQueryBuilder; +import com.google.gerrit.server.query.approval.ListOfFilesUnchangedPredicate; +import com.google.gerrit.server.util.ManualRequestContext; +import com.google.gerrit.server.util.OneOffRequestContext; import com.google.inject.Inject; import com.google.inject.Singleton; -import java.io.IOException; import java.util.Collection; import java.util.Collections; import java.util.Map; -import java.util.stream.Collectors; +import java.util.Optional; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.ObjectId; -import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.revwalk.RevWalk; /** @@ -63,30 +63,37 @@ * asserting a change's kind and checking the project config for allowed forward-inference. * * <p>The result of a copy may either be stored, as when stamping approvals in the database at - * submit time, or refreshed on demand, as when reading approvals from the NoteDb. + * submit time, or refreshed on demand, as when reading approvals from the NoteDb. TODO(ghareeb): + * migrate to new diff cache */ @Singleton -public class ApprovalInference { +class ApprovalInference { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + private final DiffOperations diffOperations; private final ProjectCache projectCache; private final ChangeKindCache changeKindCache; private final LabelNormalizer labelNormalizer; - private final PatchListCache patchListCache; - private final GitRepositoryManager repositoryManager; + private final ApprovalQueryBuilder approvalQueryBuilder; + private final OneOffRequestContext requestContext; + private final ListOfFilesUnchangedPredicate listOfFilesUnchangedPredicate; @Inject ApprovalInference( + DiffOperations diffOperations, ProjectCache projectCache, ChangeKindCache changeKindCache, LabelNormalizer labelNormalizer, - PatchListCache patchListCache, - GitRepositoryManager repositoryManager) { + ApprovalQueryBuilder approvalQueryBuilder, + OneOffRequestContext requestContext, + ListOfFilesUnchangedPredicate listOfFilesUnchangedPredicate) { + this.diffOperations = diffOperations; this.projectCache = projectCache; this.changeKindCache = changeKindCache; this.labelNormalizer = labelNormalizer; - this.patchListCache = patchListCache; - this.repositoryManager = repositoryManager; + this.approvalQueryBuilder = approvalQueryBuilder; + this.requestContext = requestContext; + this.listOfFilesUnchangedPredicate = listOfFilesUnchangedPredicate; } /** @@ -95,47 +102,46 @@ */ Iterable<PatchSetApproval> forPatchSet( ChangeNotes notes, PatchSet.Id psId, @Nullable RevWalk rw, @Nullable Config repoConfig) { + PatchSet patchset = notes.getPatchSets().get(psId); + if (patchset == null) { + return Collections.emptyList(); + } + return forPatchSet(notes, patchset, rw, repoConfig); + } + + Iterable<PatchSetApproval> forPatchSet( + ChangeNotes notes, PatchSet ps, @Nullable RevWalk rw, @Nullable Config repoConfig) { ProjectState project; try (TraceTimer traceTimer = TraceContext.newTimer( "Computing labels for patch set", Metadata.builder() .changeId(notes.load().getChangeId().get()) - .patchSetId(psId.get()) + .patchSetId(ps.id().get()) .build())) { project = projectCache .get(notes.getProjectName()) .orElseThrow(illegalState(notes.getProjectName())); Collection<PatchSetApproval> approvals = - getForPatchSetWithoutNormalization(notes, project, psId, rw, repoConfig); + getForPatchSetWithoutNormalization(notes, project, ps, rw, repoConfig); return labelNormalizer.normalize(notes, approvals).getNormalized(); } } - private static boolean canCopy( + private boolean canCopyBasedOnBooleanLabelConfigs( ProjectState project, PatchSetApproval psa, PatchSet.Id psId, ChangeKind kind, LabelType type, - @Nullable PatchList patchListCurrentPatchset, - @Nullable PatchList patchListPriorPatchset) { + @Nullable Map<String, FileDiffOutput> baseVsCurrentDiff, + @Nullable Map<String, FileDiffOutput> baseVsPriorDiff, + @Nullable Map<String, FileDiffOutput> priorVsCurrentDiff) { int n = psa.key().patchSetId().get(); checkArgument(n != psId.get()); - if (type == null) { - logger.atFine().log( - "approval %d on label %s of patch set %d of change %d cannot be copied" - + " to patch set %d because the label no longer exists on project %s", - psa.value(), - psa.label(), - n, - psa.key().patchSetId().changeId().get(), - psId.get(), - project.getName()); - return false; - } else if (type.isCopyMinScore() && type.isMaxNegative(psa)) { + if (type.isCopyMinScore() && type.isMaxNegative(psa)) { logger.atFine().log( "veto approval %s on label %s of patch set %d of change %d can be copied" + " to patch set %d because the label has set copyMinScore = true on project %s", @@ -181,7 +187,8 @@ project.getName()); return true; } else if (type.isCopyAllScoresIfListOfFilesDidNotChange() - && didListOfFilesNotChange(patchListCurrentPatchset, patchListPriorPatchset)) { + && listOfFilesUnchangedPredicate.match( + baseVsCurrentDiff, baseVsPriorDiff, priorVsCurrentDiff)) { logger.atFine().log( "approval %d on label %s of patch set %d of change %d can be copied" + " to patch set %d because the label has set " @@ -313,24 +320,35 @@ } } - private static boolean didListOfFilesNotChange(PatchList oldPatchList, PatchList newPatchList) { - Map<String, ChangeType> fileToChangeTypePs1 = getFileToChangeType(oldPatchList); - Map<String, ChangeType> fileToChangeTypePs2 = getFileToChangeType(newPatchList); - return fileToChangeTypePs1.equals(fileToChangeTypePs2); - } - - private static Map<String, ChangeType> getFileToChangeType(PatchList ps) { - return ps.getPatches().stream() - .collect( - Collectors.toMap( - f -> f.getNewName() != null ? f.getNewName() : f.getOldName(), - f -> f.getChangeType())); + private boolean canCopyBasedOnCopyCondition( + ChangeNotes changeNotes, + PatchSetApproval psa, + PatchSet patchSet, + LabelType type, + ChangeKind changeKind) { + if (!type.getCopyCondition().isPresent()) { + return false; + } + ApprovalContext ctx = ApprovalContext.create(changeNotes, psa, patchSet, changeKind); + try { + // Use a request context to run checks as an internal user with expanded visibility. This is + // so that the output of the copy condition does not depend on who is running the current + // request (e.g. a group used in this query might not be visible to the person sending this + // request). + try (ManualRequestContext ignored = requestContext.open()) { + return approvalQueryBuilder.parse(type.getCopyCondition().get()).asMatchable().match(ctx); + } + } catch (QueryParseException e) { + logger.atWarning().withCause(e).log( + "Unable to copy label because config is invalid. This should have been caught before."); + return false; + } } private Collection<PatchSetApproval> getForPatchSetWithoutNormalization( ChangeNotes notes, ProjectState project, - PatchSet.Id psId, + PatchSet patchSet, @Nullable RevWalk rw, @Nullable Config repoConfig) { checkState( @@ -339,15 +357,11 @@ project.getNameKey(), notes.getProjectName()); - PatchSet ps = notes.load().getPatchSets().get(psId); - if (ps == null) { - return Collections.emptyList(); - } - + PatchSet.Id psId = patchSet.id(); // Add approvals on the given patch set to the result Table<String, Account.Id, PatchSetApproval> resultByUser = HashBasedTable.create(); ImmutableList<PatchSetApproval> approvalsForGivenPatchSet = - notes.load().getApprovals().get(ps.id()); + notes.load().getApprovals().get(patchSet.id()); approvalsForGivenPatchSet.forEach(psa -> resultByUser.put(psa.label(), psa.accountId(), psa)); // Bail out immediately if this is the first patch set. Return only approvals granted on the @@ -370,63 +384,87 @@ Iterable<PatchSetApproval> priorApprovals = getForPatchSetWithoutNormalization( - notes, project, priorPatchSet.getValue().id(), rw, repoConfig); + notes, project, priorPatchSet.getValue(), rw, repoConfig); if (!priorApprovals.iterator().hasNext()) { return resultByUser.values(); } // Add labels from the previous patch set to the result in case the label isn't already there // and settings as well as change kind allow copying. - ChangeKind kind = + ChangeKind changeKind = changeKindCache.getChangeKind( project.getNameKey(), rw, repoConfig, priorPatchSet.getValue().commitId(), - ps.commitId()); + patchSet.commitId()); logger.atFine().log( "change kind for patch set %d of change %d against prior patch set %s is %s", - ps.id().get(), ps.id().changeId().get(), priorPatchSet.getValue().id().changeId(), kind); - PatchList patchListCurrentPatchset = null; - PatchList patchListPriorPatchset = null; + patchSet.id().get(), + patchSet.id().changeId().get(), + priorPatchSet.getValue().id().changeId(), + changeKind); + + Map<String, FileDiffOutput> baseVsCurrent = null; + Map<String, FileDiffOutput> baseVsPrior = null; + Map<String, FileDiffOutput> priorVsCurrent = null; LabelTypes labelTypes = project.getLabelTypes(); for (PatchSetApproval psa : priorApprovals) { if (resultByUser.contains(psa.label(), psa.accountId())) { continue; } - LabelType type = labelTypes.byLabel(psa.labelId()); - // Only compute patchList if there is a relevant label, since this is expensive. - if (patchListCurrentPatchset == null - && type != null - && type.isCopyAllScoresIfListOfFilesDidNotChange()) { - patchListCurrentPatchset = getPatchList(project, ps); - patchListPriorPatchset = getPatchList(project, priorPatchSet.getValue()); + Optional<LabelType> type = labelTypes.byLabel(psa.labelId()); + // Only compute modified files if there is a relevant label, since this is expensive. + if (baseVsCurrent == null + && type.isPresent() + && type.get().isCopyAllScoresIfListOfFilesDidNotChange()) { + baseVsCurrent = listModifiedFiles(project, patchSet); + baseVsPrior = listModifiedFiles(project, priorPatchSet.getValue()); + priorVsCurrent = + listModifiedFiles(project, priorPatchSet.getValue().commitId(), patchSet.commitId()); } - if (!canCopy( - project, psa, ps.id(), kind, type, patchListCurrentPatchset, patchListPriorPatchset)) { + if (!type.isPresent()) { + logger.atFine().log( + "approval %d on label %s of patch set %d of change %d cannot be copied" + + " to patch set %d because the label no longer exists on project %s", + psa.value(), + psa.label(), + psa.key().patchSetId().get(), + psa.key().patchSetId().changeId().get(), + psId.get(), + project.getName()); continue; } - resultByUser.put(psa.label(), psa.accountId(), psa.copyWithPatchSet(ps.id())); + if (!canCopyBasedOnBooleanLabelConfigs( + project, + psa, + patchSet.id(), + changeKind, + type.get(), + baseVsCurrent, + baseVsPrior, + priorVsCurrent) + && !canCopyBasedOnCopyCondition(notes, psa, patchSet, type.get(), changeKind)) { + continue; + } + resultByUser.put(psa.label(), psa.accountId(), psa.copyWithPatchSet(patchSet.id())); } return resultByUser.values(); } /** - * Gets the {@link PatchList} between a patch-set and the base. Can be used to compute difference - * in files between two patch-sets by using both {@link PatchList}s of those 2 patch-sets. + * Gets the modified files between the two latest patch-sets. Can be used to compute difference in + * files between those two patch-sets . */ - private PatchList getPatchList(ProjectState project, PatchSet ps) { - // Compare against the base: - // * For merge commits the comparison is done against the 1st parent, which is the destination - // branch. - // * For non-merge commits the comparison is done against the only parent, or an empty base if - // no parent exists. - PatchListKey key = - PatchListKey.againstBase( - ps.commitId(), getParentCount(project.getNameKey(), ps.commitId())); + private Map<String, FileDiffOutput> listModifiedFiles(ProjectState project, PatchSet ps) { try { - return patchListCache.get(key, project.getNameKey()); - } catch (PatchListNotAvailableException ex) { + Integer parentNum = + listOfFilesUnchangedPredicate.isInitialCommit(project.getNameKey(), ps.commitId()) + ? 0 + : 1; + return diffOperations.listModifiedFilesAgainstParent( + project.getNameKey(), ps.commitId(), parentNum); + } catch (DiffNotAvailableException ex) { throw new StorageException( "failed to compute difference in files, so won't copy" + " votes on labels even if list of files is the same and " @@ -435,12 +473,20 @@ } } - private int getParentCount(Project.NameKey project, ObjectId objectId) { - try (Repository repo = repositoryManager.openRepository(project); - RevWalk revWalk = new RevWalk(repo)) { - return revWalk.parseCommit(objectId).getParentCount(); - } catch (IOException ex) { - throw new StorageException(ex); + /** + * Gets the modified files between two commits corresponding to different patchsets of the same + * change. + */ + private Map<String, FileDiffOutput> listModifiedFiles( + ProjectState project, ObjectId sourceCommit, ObjectId targetCommit) { + try { + return diffOperations.listModifiedFiles(project.getNameKey(), sourceCommit, targetCommit); + } catch (DiffNotAvailableException ex) { + throw new StorageException( + "failed to compute difference in files, so won't copy" + + " votes on labels even if list of files is the same and " + + "copyAllIfListOfFilesDidNotChange", + ex); } } }
diff --git a/java/com/google/gerrit/server/ApprovalsUtil.java b/java/com/google/gerrit/server/approval/ApprovalsUtil.java similarity index 78% rename from java/com/google/gerrit/server/ApprovalsUtil.java rename to java/com/google/gerrit/server/approval/ApprovalsUtil.java index 411768d..7744f49 100644 --- a/java/com/google/gerrit/server/ApprovalsUtil.java +++ b/java/com/google/gerrit/server/approval/ApprovalsUtil.java
@@ -12,7 +12,7 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.server; +package com.google.gerrit.server.approval; import static com.google.common.base.Preconditions.checkArgument; import static com.google.gerrit.server.notedb.ReviewerStateInternal.CC; @@ -20,11 +20,14 @@ import static com.google.gerrit.server.project.ProjectCache.illegalState; import com.google.common.annotations.VisibleForTesting; +import com.google.common.collect.HashBasedTable; import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableSet; import com.google.common.collect.Iterables; import com.google.common.collect.ListMultimap; import com.google.common.collect.Lists; import com.google.common.collect.Sets; +import com.google.common.collect.Table; import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; @@ -39,6 +42,10 @@ import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.extensions.restapi.BadRequestException; import com.google.gerrit.extensions.restapi.RestApiException; +import com.google.gerrit.server.CurrentUser; +import com.google.gerrit.server.ReviewerSet; +import com.google.gerrit.server.ReviewerStatusUpdate; +import com.google.gerrit.server.change.LabelNormalizer; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.notedb.ChangeUpdate; import com.google.gerrit.server.notedb.ReviewerStateInternal; @@ -58,6 +65,7 @@ import java.util.List; import java.util.Map; import java.util.Objects; +import java.util.Optional; import java.util.Set; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.revwalk.RevWalk; @@ -94,16 +102,22 @@ private final ApprovalInference approvalInference; private final PermissionBackend permissionBackend; private final ProjectCache projectCache; + private final ApprovalCache approvalCache; + private final LabelNormalizer labelNormalizer; @VisibleForTesting @Inject public ApprovalsUtil( ApprovalInference approvalInference, PermissionBackend permissionBackend, - ProjectCache projectCache) { + ProjectCache projectCache, + ApprovalCache approvalCache, + LabelNormalizer labelNormalizer) { this.approvalInference = approvalInference; this.permissionBackend = permissionBackend; this.projectCache = projectCache; + this.approvalCache = approvalCache; + this.labelNormalizer = labelNormalizer; } /** @@ -271,7 +285,6 @@ * @param ps patch set being approved. * @param user user adding approvals. * @param approvals approvals to add. - * @throws RestApiException */ public Iterable<PatchSetApproval> addApprovalsForNewPatchSet( ChangeUpdate update, @@ -293,8 +306,12 @@ List<PatchSetApproval> cells = new ArrayList<>(approvals.size()); Date ts = update.getWhen(); for (Map.Entry<String, Short> vote : approvals.entrySet()) { - LabelType lt = labelTypes.byLabel(vote.getKey()); - cells.add(newApproval(ps.id(), user, lt.getLabelId(), vote.getValue(), ts).build()); + Optional<LabelType> lt = labelTypes.byLabel(vote.getKey()); + if (!lt.isPresent()) { + throw new BadRequestException( + String.format("label \"%s\" is not a configured label", vote.getKey())); + } + cells.add(newApproval(ps.id(), user, lt.get().getLabelId(), vote.getValue(), ts).build()); } for (PatchSetApproval psa : cells) { update.putApproval(psa.label(), psa.value()); @@ -304,11 +321,11 @@ public static void checkLabel(LabelTypes labelTypes, String name, Short value) throws BadRequestException { - LabelType label = labelTypes.byLabel(name); - if (label == null) { + Optional<LabelType> label = labelTypes.byLabel(name); + if (!label.isPresent()) { throw new BadRequestException(String.format("label \"%s\" is not a configured label", name)); } - if (label.getValue(value) == null) { + if (label.get().getValue(value) == null) { throw new BadRequestException( String.format("label \"%s\": %d is not a valid value", name, value)); } @@ -333,11 +350,66 @@ return notes.load().getApprovals(); } + public ListMultimap<PatchSet.Id, PatchSetApproval> byChangeWithCopied(ChangeNotes notes) { + return notes.load().getApprovalsWithCopied(); + } + public Iterable<PatchSetApproval> byPatchSet( ChangeNotes notes, PatchSet.Id psId, @Nullable RevWalk rw, @Nullable Config repoConfig) { return approvalInference.forPatchSet(notes, psId, rw, repoConfig); } + public Iterable<PatchSetApproval> byPatchSet(ChangeNotes notes, PatchSet patchSet) { + return approvalInference.forPatchSet(notes, patchSet, /* rw= */ null, /* repoConfig= */ null); + } + + /** + * This method should only be used when we want to dynamically compute the approvals. Generally, + * the copied approvals are available in {@link ChangeNotes}. However, if the patch-set is just + * being created, we need to dynamically compute the approvals so that we can persist them in + * storage. The {@link RevWalk} and {@link Config} objects that are being used to create the new + * patch-set are required for this method. Here we also add those votes to the provided {@link + * ChangeUpdate} object. + */ + public void persistCopiedApprovals( + ChangeNotes notes, + PatchSet patchSet, + RevWalk revWalk, + Config repoConfig, + ChangeUpdate changeUpdate) { + Set<PatchSetApproval> current = + ImmutableSet.copyOf(notes.getApprovalsWithCopied().get(notes.getCurrentPatchSet().id())); + Iterable<PatchSetApproval> currentNormalized = + labelNormalizer.normalize(notes, current).getNormalized(); + Set<PatchSetApproval> inferred = + ImmutableSet.copyOf(approvalInference.forPatchSet(notes, patchSet, revWalk, repoConfig)); + + // Exempt granted timestamp from comparisson, otherwise, we would persist the copied + // labels every time this method is called. + Table<LabelId, Account.Id, Short> approvalTable = HashBasedTable.create(); + for (PatchSetApproval psa : currentNormalized) { + Account.Id id = psa.accountId(); + approvalTable.put(psa.labelId(), id, psa.value()); + } + + for (PatchSetApproval psa : inferred) { + if (psa.value() != 0) { + if (approvalTable.contains(psa.labelId(), psa.accountId())) { + Short v = approvalTable.get(psa.labelId(), psa.accountId()); + if (v.shortValue() != psa.value()) { + changeUpdate.putCopiedApproval(psa); + } + } else { + changeUpdate.putCopiedApproval(psa); + } + } + } + } + + public Iterable<PatchSetApproval> byPatchSet(ChangeNotes notes, PatchSet.Id psId) { + return approvalCache.get(notes, psId); + } + public Iterable<PatchSetApproval> byPatchSetUser( ChangeNotes notes, PatchSet.Id psId, @@ -347,6 +419,11 @@ return filterApprovals(byPatchSet(notes, psId, rw, repoConfig), accountId); } + public Iterable<PatchSetApproval> byPatchSetUser( + ChangeNotes notes, PatchSet.Id psId, Account.Id accountId) { + return filterApprovals(byPatchSet(notes, psId), accountId); + } + public PatchSetApproval getSubmitter(ChangeNotes notes, PatchSet.Id c) { if (c == null) { return null;
diff --git a/java/com/google/gerrit/server/approval/RecursiveApprovalCopier.java b/java/com/google/gerrit/server/approval/RecursiveApprovalCopier.java new file mode 100644 index 0000000..d5ee143 --- /dev/null +++ b/java/com/google/gerrit/server/approval/RecursiveApprovalCopier.java
@@ -0,0 +1,314 @@ +// Copyright (C) 2022 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.approval; + +import static com.google.common.collect.ImmutableList.toImmutableList; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.Lists; +import com.google.common.flogger.FluentLogger; +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.ListenableFuture; +import com.google.common.util.concurrent.ListeningExecutorService; +import com.google.common.util.concurrent.MoreExecutors; +import com.google.gerrit.common.Nullable; +import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.Project; +import com.google.gerrit.entities.RefNames; +import com.google.gerrit.extensions.restapi.RestApiException; +import com.google.gerrit.git.RefUpdateUtil; +import com.google.gerrit.server.FanOutExecutor; +import com.google.gerrit.server.InternalUser; +import com.google.gerrit.server.extensions.events.GitReferenceUpdated; +import com.google.gerrit.server.git.GitRepositoryManager; +import com.google.gerrit.server.notedb.ChangeNotes; +import com.google.gerrit.server.notedb.ChangeUpdate; +import com.google.gerrit.server.update.BatchUpdate; +import com.google.gerrit.server.update.BatchUpdateOp; +import com.google.gerrit.server.update.ChangeContext; +import com.google.gerrit.server.update.UpdateException; +import com.google.gerrit.server.util.time.TimeUtil; +import com.google.inject.Inject; +import java.io.IOException; +import java.util.Collection; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.function.Consumer; +import org.eclipse.jgit.errors.RepositoryNotFoundException; +import org.eclipse.jgit.internal.storage.file.RefDirectory; +import org.eclipse.jgit.lib.BatchRefUpdate; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.RefDatabase; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.transport.ReceiveCommand; + +public class RecursiveApprovalCopier { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + private static final int SLICE_MAX_REFS = 1000; + + private final BatchUpdate.Factory batchUpdateFactory; + private final GitRepositoryManager repositoryManager; + private final InternalUser.Factory internalUserFactory; + private final ApprovalsUtil approvalsUtil; + private final ChangeNotes.Factory changeNotesFactory; + private final GitReferenceUpdated gitRefUpdated; + private final ListeningExecutorService executor; + + private final ConcurrentHashMap<Project.NameKey, List<ReceiveCommand>> pendingRefUpdates = + new ConcurrentHashMap<>(); + + private volatile boolean failedForAtLeastOneProject; + + private final AtomicInteger totalCopyApprovalsTasks = new AtomicInteger(); + private final AtomicInteger finishedCopyApprovalsTasks = new AtomicInteger(); + + private final AtomicInteger totalRefUpdates = new AtomicInteger(); + private final AtomicInteger finishedRefUpdates = new AtomicInteger(); + + @Inject + public RecursiveApprovalCopier( + BatchUpdate.Factory batchUpdateFactory, + GitRepositoryManager repositoryManager, + InternalUser.Factory internalUserFactory, + ApprovalsUtil approvalsUtil, + ChangeNotes.Factory changeNotesFactory, + GitReferenceUpdated gitRefUpdated, + @FanOutExecutor ExecutorService executor) { + this.batchUpdateFactory = batchUpdateFactory; + this.repositoryManager = repositoryManager; + this.internalUserFactory = internalUserFactory; + this.approvalsUtil = approvalsUtil; + this.changeNotesFactory = changeNotesFactory; + this.gitRefUpdated = gitRefUpdated; + this.executor = MoreExecutors.listeningDecorator(executor); + } + + /** + * This method assumes it is used as a standalone program having exclusive access to the Git + * repositories. Therefore, it will (safely) skip locking of the loose refs when performing batch + * ref-updates. + */ + public void persistStandalone() + throws RepositoryNotFoundException, IOException, InterruptedException, ExecutionException { + persist(repositoryManager.list(), null, false); + + if (failedForAtLeastOneProject) { + throw new RuntimeException("There were errors, check the logs for details"); + } + } + + public void persist(Project.NameKey project, @Nullable Consumer<Change> labelsCopiedListener) + throws IOException, RepositoryNotFoundException, InterruptedException, ExecutionException { + persist(ImmutableList.of(project), labelsCopiedListener, true); + } + + private void persist( + Collection<Project.NameKey> projects, + @Nullable Consumer<Change> labelsCopiedListener, + boolean shouldLockLooseRefs) + throws InterruptedException, ExecutionException, RepositoryNotFoundException, IOException { + List<ListenableFuture<Void>> copyApprovalsTasks = new LinkedList<>(); + for (Project.NameKey project : projects) { + copyApprovalsTasks.addAll(submitCopyApprovalsTasks(project, labelsCopiedListener)); + } + Futures.successfulAsList(copyApprovalsTasks).get(); + + List<ListenableFuture<Void>> batchRefUpdateTasks = + submitBatchRefUpdateTasks(shouldLockLooseRefs); + Futures.successfulAsList(batchRefUpdateTasks).get(); + } + + private List<ListenableFuture<Void>> submitCopyApprovalsTasks( + Project.NameKey project, @Nullable Consumer<Change> labelsCopiedListener) + throws RepositoryNotFoundException, IOException { + List<ListenableFuture<Void>> futures = new LinkedList<>(); + try (Repository repository = repositoryManager.openRepository(project)) { + ImmutableList<Ref> allMetaRefs = + repository.getRefDatabase().getRefsByPrefix(RefNames.REFS_CHANGES).stream() + .filter(r -> r.getName().endsWith(RefNames.META_SUFFIX)) + .collect(toImmutableList()); + + totalCopyApprovalsTasks.addAndGet(allMetaRefs.size()); + + for (List<Ref> slice : Lists.partition(allMetaRefs, SLICE_MAX_REFS)) { + futures.add( + executor.submit( + () -> { + copyApprovalsForSlice(project, slice, labelsCopiedListener); + return null; + })); + } + } + return futures; + } + + private void copyApprovalsForSlice( + Project.NameKey project, List<Ref> slice, @Nullable Consumer<Change> labelsCopiedListener) + throws Exception { + try { + copyApprovalsForSlice(project, slice, labelsCopiedListener, false); + } catch (Exception e) { + failedForAtLeastOneProject = true; + logger.atSevere().withCause(e).log( + "Error in a slice of project %s, will retry and skip corrupt meta-refs", project); + copyApprovalsForSlice(project, slice, labelsCopiedListener, true); + } + logProgress(); + } + + private void copyApprovalsForSlice( + Project.NameKey project, + List<Ref> slice, + @Nullable Consumer<Change> labelsCopiedListener, + boolean checkForCorruptMetaRefs) + throws Exception { + logger.atInfo().log("copy-approvals for a slice of %s project", project); + try (BatchUpdate bu = + batchUpdateFactory.create(project, internalUserFactory.create(), TimeUtil.nowTs())) { + for (Ref metaRef : slice) { + Change.Id changeId = Change.Id.fromRef(metaRef.getName()); + if (checkForCorruptMetaRefs && isCorrupt(project, changeId)) { + logger.atSevere().log("skipping corrupt meta-ref %s", metaRef.getName()); + continue; + } + bu.addOp( + changeId, + new RecursiveApprovalCopier.PersistCopiedVotesOp(approvalsUtil, labelsCopiedListener)); + } + + BatchRefUpdate bru = bu.prepareRefUpdates(); + if (bru != null) { + List<ReceiveCommand> cmds = bru.getCommands(); + pendingRefUpdates.compute( + project, + (p, u) -> { + if (u == null) { + return new LinkedList<>(cmds); + } + u.addAll(cmds); + return u; + }); + totalRefUpdates.addAndGet(cmds.size()); + } + + finishedCopyApprovalsTasks.addAndGet(slice.size()); + } + } + + private List<ListenableFuture<Void>> submitBatchRefUpdateTasks(boolean shouldLockLooseRefs) { + logger.atInfo().log("submitting batch ref-update tasks"); + List<ListenableFuture<Void>> futures = new LinkedList<>(); + for (Map.Entry<Project.NameKey, List<ReceiveCommand>> e : pendingRefUpdates.entrySet()) { + Project.NameKey project = e.getKey(); + List<ReceiveCommand> updates = e.getValue(); + futures.add( + executor.submit( + () -> { + executeRefUpdates(project, updates, shouldLockLooseRefs); + return null; + })); + } + return futures; + } + + private void executeRefUpdates( + Project.NameKey project, List<ReceiveCommand> updates, boolean shouldLockLooseRefs) + throws RepositoryNotFoundException, IOException { + logger.atInfo().log( + "executing batch ref-update for project %s, size %d", project, updates.size()); + try (Repository repository = repositoryManager.openRepository(project)) { + RefDatabase refdb = repository.getRefDatabase(); + BatchRefUpdate bu; + if (refdb instanceof RefDirectory) { + bu = ((RefDirectory) refdb).newBatchUpdate(shouldLockLooseRefs); + } else { + bu = refdb.newBatchUpdate(); + } + bu.addCommand(updates); + RefUpdateUtil.executeChecked(bu, repository); + gitRefUpdated.fire(project, bu, null); + + finishedRefUpdates.addAndGet(updates.size()); + logProgress(); + } + } + + private boolean isCorrupt(Project.NameKey project, Change.Id changeId) { + Change c = ChangeNotes.Factory.newChange(project, changeId); + try { + changeNotesFactory.createForBatchUpdate(c, true); + return false; + } catch (Exception e) { + logger.atSevere().withCause(e).log(e.getMessage()); + return true; + } + } + + public void persist(Change change) throws UpdateException, RestApiException { + Project.NameKey project = change.getProject(); + try (BatchUpdate bu = + batchUpdateFactory.create(project, internalUserFactory.create(), TimeUtil.nowTs())) { + Change.Id changeId = change.getId(); + bu.addOp(changeId, new PersistCopiedVotesOp(approvalsUtil, null)); + bu.execute(); + } + } + + private void logProgress() { + logger.atInfo().log( + "copy-approvals tasks done: %d/%d, ref-update tasks done: %d/%d", + finishedCopyApprovalsTasks.get(), + totalCopyApprovalsTasks.get(), + finishedRefUpdates.get(), + totalRefUpdates.get()); + } + + private static class PersistCopiedVotesOp implements BatchUpdateOp { + private final ApprovalsUtil approvalsUtil; + private final Consumer<Change> listener; + + PersistCopiedVotesOp( + ApprovalsUtil approvalsUtil, @Nullable Consumer<Change> labelsCopiedListener) { + this.approvalsUtil = approvalsUtil; + this.listener = labelsCopiedListener; + } + + @Override + public boolean updateChange(ChangeContext ctx) throws IOException { + Change change = ctx.getChange(); + ChangeUpdate update = ctx.getUpdate(change.currentPatchSetId(), change.getLastUpdatedOn()); + approvalsUtil.persistCopiedApprovals( + ctx.getNotes(), + ctx.getNotes().getCurrentPatchSet(), + ctx.getRevWalk(), + ctx.getRepoView().getConfig(), + update); + + boolean labelsCopied = update.hasCopiedApprovals(); + + if (labelsCopied && listener != null) { + listener.accept(change); + } + + return labelsCopied; + } + } +}
diff --git a/java/com/google/gerrit/server/args4j/AccountIdHandler.java b/java/com/google/gerrit/server/args4j/AccountIdHandler.java index 73a970b..5df4d28 100644 --- a/java/com/google/gerrit/server/args4j/AccountIdHandler.java +++ b/java/com/google/gerrit/server/args4j/AccountIdHandler.java
@@ -44,12 +44,14 @@ private final AccountResolver accountResolver; private final AccountManager accountManager; private final AuthType authType; + private final AuthRequest.Factory authRequestFactory; @Inject public AccountIdHandler( AccountResolver accountResolver, AccountManager accountManager, AuthConfig authConfig, + AuthRequest.Factory authRequestFactory, @Assisted CmdLineParser parser, @Assisted OptionDef option, @Assisted Setter<Account.Id> setter) { @@ -57,6 +59,7 @@ this.accountResolver = accountResolver; this.accountManager = accountManager; this.authType = authConfig.getAuthType(); + this.authRequestFactory = authRequestFactory; } @Override @@ -105,7 +108,7 @@ } try { - AuthRequest req = AuthRequest.forUser(user); + AuthRequest req = authRequestFactory.createForUser(user); req.setSkipAuthentication(true); return accountManager.authenticate(req).getAccountId(); } catch (AccountException e) {
diff --git a/java/com/google/gerrit/server/audit/BUILD b/java/com/google/gerrit/server/audit/BUILD index 3faa259..f19cb8b 100644 --- a/java/com/google/gerrit/server/audit/BUILD +++ b/java/com/google/gerrit/server/audit/BUILD
@@ -5,8 +5,6 @@ srcs = glob( ["**/*.java"], ), - resource_strip_prefix = "resources", - resources = ["//resources/com/google/gerrit/server"], visibility = ["//visibility:public"], deps = [ "//java/com/google/gerrit/entities",
diff --git a/java/com/google/gerrit/server/auth/AuthBackend.java b/java/com/google/gerrit/server/auth/AuthBackend.java index 9ec3366..424ee43 100644 --- a/java/com/google/gerrit/server/auth/AuthBackend.java +++ b/java/com/google/gerrit/server/auth/AuthBackend.java
@@ -20,7 +20,7 @@ @ExtensionPoint public interface AuthBackend { - /** @return an identifier that uniquely describes the backend. */ + /** Returns an identifier that uniquely describes the backend. */ String getDomain(); /**
diff --git a/java/com/google/gerrit/server/auth/AuthUser.java b/java/com/google/gerrit/server/auth/AuthUser.java index 987f086..9e1c5ec 100644 --- a/java/com/google/gerrit/server/auth/AuthUser.java +++ b/java/com/google/gerrit/server/auth/AuthUser.java
@@ -52,18 +52,18 @@ this.username = username; } - /** @return the globally unique identifier. */ + /** Returns the globally unique identifier. */ public final UUID getUUID() { return uuid; } - /** @return the backend specific user name, or null if one does not exist. */ + /** Returns the backend specific user name, or null if one does not exist. */ @Nullable public final String getUsername() { return username; } - /** @return {@code true} if {@link #getUsername()} is not null. */ + /** Returns {@code true} if {@link #getUsername()} is not null. */ public final boolean hasUsername() { return getUsername() != null; }
diff --git a/java/com/google/gerrit/server/auth/InternalAuthBackend.java b/java/com/google/gerrit/server/auth/InternalAuthBackend.java index 2f8886b..ce536f6 100644 --- a/java/com/google/gerrit/server/auth/InternalAuthBackend.java +++ b/java/com/google/gerrit/server/auth/InternalAuthBackend.java
@@ -26,11 +26,14 @@ public class InternalAuthBackend implements AuthBackend { private final AccountCache accountCache; private final AuthConfig authConfig; + private final PasswordVerifier passwordVerifier; @Inject - InternalAuthBackend(AccountCache accountCache, AuthConfig authConfig) { + InternalAuthBackend( + AccountCache accountCache, AuthConfig authConfig, PasswordVerifier passwordVerifier) { this.accountCache = accountCache; this.authConfig = authConfig; + this.passwordVerifier = passwordVerifier; } @Override @@ -63,7 +66,7 @@ + ": account inactive or not provisioned in Gerrit"); } - if (!PasswordVerifier.checkPassword(who.externalIds(), username, req.getPassword().get())) { + if (!passwordVerifier.checkPassword(who.externalIds(), username, req.getPassword().get())) { throw new InvalidCredentialsException(); } return new AuthUser(AuthUser.UUID.create(username), username);
diff --git a/java/com/google/gerrit/server/cache/CacheInfo.java b/java/com/google/gerrit/server/cache/CacheInfo.java index d6eb065..832ca04 100644 --- a/java/com/google/gerrit/server/cache/CacheInfo.java +++ b/java/com/google/gerrit/server/cache/CacheInfo.java
@@ -90,7 +90,7 @@ space = bytes(value); } - private static String bytes(double value) { + public static String bytes(double value) { value /= 1024; String suffix = "k";
diff --git a/java/com/google/gerrit/server/cache/CacheMetrics.java b/java/com/google/gerrit/server/cache/CacheMetrics.java index 12194e7..f1fd4a8 100644 --- a/java/com/google/gerrit/server/cache/CacheMetrics.java +++ b/java/com/google/gerrit/server/cache/CacheMetrics.java
@@ -35,7 +35,9 @@ @Singleton public class CacheMetrics { private static final Field<String> F_NAME = - Field.ofString("cache_name", Metadata.Builder::cacheName).build(); + Field.ofString("cache_name", Metadata.Builder::cacheName) + .description("The name of the cache.") + .build(); @Inject public CacheMetrics(
diff --git a/java/com/google/gerrit/server/cache/ForwardingRemovalListener.java b/java/com/google/gerrit/server/cache/ForwardingRemovalListener.java index 357cbbb..852d8a3 100644 --- a/java/com/google/gerrit/server/cache/ForwardingRemovalListener.java +++ b/java/com/google/gerrit/server/cache/ForwardingRemovalListener.java
@@ -26,9 +26,6 @@ /** * This listener dispatches removal events to all other RemovalListeners attached via the DynamicSet * API. - * - * @param <K> - * @param <V> */ @SuppressWarnings("rawtypes") public class ForwardingRemovalListener<K, V> implements RemovalListener<K, V> {
diff --git a/java/com/google/gerrit/server/cache/PerThreadCache.java b/java/com/google/gerrit/server/cache/PerThreadCache.java index b4f79d1..8ae9710 100644 --- a/java/com/google/gerrit/server/cache/PerThreadCache.java +++ b/java/com/google/gerrit/server/cache/PerThreadCache.java
@@ -43,19 +43,9 @@ * <p>Lastly, this class offers a cache, that requires callers to also provide a {@code Supplier} in * case the object is not present in the cache, while {@code CurrentUser} provides a storage where * just retrieving stored values is a valid operation. - * - * <p>To prevent OOM errors on requests that would cache a lot of objects, this class enforces an - * internal limit after which no new elements are cached. All {@code get} calls are served by - * invoking the {@code Supplier} after that. */ public class PerThreadCache implements AutoCloseable { private static final ThreadLocal<PerThreadCache> CACHE = new ThreadLocal<>(); - /** - * Cache at maximum 25 values per thread. This value was chosen arbitrarily. Some endpoints (like - * ListProjects) break the assumption that the data cached in a request is limited. To prevent - * this class from accumulating an unbound number of objects, we enforce this limit. - */ - private static final int PER_THREAD_CACHE_SIZE = 25; /** * Unique key for key-value mappings stored in PerThreadCache. The key is based on the value's @@ -68,7 +58,7 @@ /** * Returns a key based on the value's class and an identifier that uniquely identify the value. - * The identifier needs to implement {@code equals()} and {@hashCode()}. + * The identifier needs to implement {@code equals()} and {@code hashCode()}. */ public static <T> Key<T> create(Class<T> clazz, Object identifier) { return new Key<>(clazz, ImmutableList.of(identifier)); @@ -76,7 +66,7 @@ /** * Returns a key based on the value's class and a set of identifiers that uniquely identify the - * value. Identifiers need to implement {@code equals()} and {@hashCode()}. + * value. Identifiers need to implement {@code equals()} and {@code hashCode()}. */ public static <T> Key<T> create(Class<T> clazz, Object... identifiers) { return new Key<>(clazz, ImmutableList.copyOf(identifiers)); @@ -119,7 +109,7 @@ return cache != null ? cache.get(key, loader) : loader.get(); } - private final Map<Key<?>, Object> cache = Maps.newHashMapWithExpectedSize(PER_THREAD_CACHE_SIZE); + private final Map<Key<?>, Object> cache = Maps.newHashMap(); private PerThreadCache() {} @@ -132,9 +122,7 @@ T value = (T) cache.get(key); if (value == null) { value = loader.get(); - if (cache.size() < PER_THREAD_CACHE_SIZE) { - cache.put(key, value); - } + cache.put(key, value); } return value; }
diff --git a/java/com/google/gerrit/server/cache/PerThreadProjectCache.java b/java/com/google/gerrit/server/cache/PerThreadProjectCache.java new file mode 100644 index 0000000..86f1d2d --- /dev/null +++ b/java/com/google/gerrit/server/cache/PerThreadProjectCache.java
@@ -0,0 +1,64 @@ +// Copyright (C) 2023 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.cache; + +import com.google.common.collect.Maps; +import com.google.gerrit.entities.Project; +import java.util.Map; +import java.util.function.Supplier; + +/** + * To prevent OOM errors on requests that would cache a lot of objects, this class enforces an + * internal limit after which no new elements are cached. All {@code computeIfAbsentWithinLimit} + * calls are served by invoking the {@code Supplier} after that. + */ +public class PerThreadProjectCache { + private static final PerThreadCache.Key<PerThreadProjectCache> PER_THREAD_PROJECT_CACHE_KEY = + PerThreadCache.Key.create(PerThreadProjectCache.class); + /** + * Cache at maximum 25 values per thread. This value was chosen arbitrarily. Some endpoints (like + * ListProjects) break the assumption that the data cached in a request is limited. To prevent + * this class from accumulating an unbound number of objects, we enforce this limit. + */ + private static final int PER_THREAD_PROJECT_CACHE_SIZE = 25; + + private final Map<PerThreadCache.Key<Project.NameKey>, Object> valueByNameKey = + Maps.newHashMapWithExpectedSize(PER_THREAD_PROJECT_CACHE_SIZE); + + private PerThreadProjectCache() {} + + public static <T> T getOrCompute(PerThreadCache.Key<Project.NameKey> key, Supplier<T> loader) { + PerThreadCache perThreadCache = PerThreadCache.get(); + if (perThreadCache != null) { + PerThreadProjectCache perThreadProjectCache = + perThreadCache.get(PER_THREAD_PROJECT_CACHE_KEY, PerThreadProjectCache::new); + return perThreadProjectCache.computeIfAbsentWithinLimit(key, loader); + } + return loader.get(); + } + + protected <T> T computeIfAbsentWithinLimit( + PerThreadCache.Key<Project.NameKey> key, Supplier<T> loader) { + @SuppressWarnings("unchecked") + T value = (T) valueByNameKey.get(key); + if (value == null) { + value = loader.get(); + if (valueByNameKey.size() < PER_THREAD_PROJECT_CACHE_SIZE) { + valueByNameKey.put(key, value); + } + } + return value; + } +}
diff --git a/java/com/google/gerrit/server/cache/h2/H2CacheFactory.java b/java/com/google/gerrit/server/cache/h2/H2CacheFactory.java index 16d62b3..dc7a247 100644 --- a/java/com/google/gerrit/server/cache/h2/H2CacheFactory.java +++ b/java/com/google/gerrit/server/cache/h2/H2CacheFactory.java
@@ -14,11 +14,15 @@ package com.google.gerrit.server.cache.h2; +import static java.util.concurrent.TimeUnit.SECONDS; + +import com.google.common.base.Strings; import com.google.common.cache.Cache; import com.google.common.cache.CacheLoader; import com.google.common.cache.LoadingCache; import com.google.common.flogger.FluentLogger; import com.google.common.util.concurrent.ThreadFactoryBuilder; +import com.google.gerrit.common.Nullable; import com.google.gerrit.extensions.events.LifecycleListener; import com.google.gerrit.extensions.registration.DynamicMap; import com.google.gerrit.server.cache.CacheBackend; @@ -27,13 +31,17 @@ import com.google.gerrit.server.cache.PersistentCacheDef; import com.google.gerrit.server.cache.h2.H2CacheImpl.SqlStore; import com.google.gerrit.server.cache.h2.H2CacheImpl.ValueHolder; +import com.google.gerrit.server.config.ConfigUtil; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.config.SitePaths; +import com.google.gerrit.server.index.options.BuildBloomFilter; +import com.google.gerrit.server.index.options.IsFirstInsertForEntry; import com.google.gerrit.server.logging.LoggingContextAwareExecutorService; import com.google.gerrit.server.logging.LoggingContextAwareScheduledExecutorService; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.Singleton; +import java.time.Duration; import java.util.LinkedList; import java.util.List; import java.util.Map; @@ -58,32 +66,43 @@ private final ScheduledExecutorService cleanup; private final long h2CacheSize; private final boolean h2AutoServer; + private final boolean isOfflineReindex; + private final boolean buildBloomFilter; @Inject H2CacheFactory( MemoryCacheFactory memCacheFactory, @GerritServerConfig Config cfg, SitePaths site, - DynamicMap<Cache<?, ?>> cacheMap) { + DynamicMap<Cache<?, ?>> cacheMap, + @Nullable IsFirstInsertForEntry isFirstInsertForEntry, + @Nullable BuildBloomFilter buildBloomFilter) { super(memCacheFactory, cfg, site); h2CacheSize = cfg.getLong("cache", null, "h2CacheSize", -1); h2AutoServer = cfg.getBoolean("cache", null, "h2AutoServer", false); caches = new LinkedList<>(); this.cacheMap = cacheMap; + this.isOfflineReindex = + isFirstInsertForEntry != null && isFirstInsertForEntry.equals(IsFirstInsertForEntry.YES); + this.buildBloomFilter = + !(buildBloomFilter != null && buildBloomFilter.equals(BuildBloomFilter.FALSE)); if (diskEnabled) { executor = new LoggingContextAwareExecutorService( Executors.newFixedThreadPool( 1, new ThreadFactoryBuilder().setNameFormat("DiskCache-Store-%d").build())); + cleanup = - new LoggingContextAwareScheduledExecutorService( - Executors.newScheduledThreadPool( - 1, - new ThreadFactoryBuilder() - .setNameFormat("DiskCache-Prune-%d") - .setDaemon(true) - .build())); + isOfflineReindex + ? null + : new LoggingContextAwareScheduledExecutorService( + Executors.newScheduledThreadPool( + 1, + new ThreadFactoryBuilder() + .setNameFormat("DiskCache-Prune-%d") + .setDaemon(true) + .build())); } else { executor = null; cleanup = null; @@ -95,9 +114,11 @@ if (executor != null) { for (H2CacheImpl<?, ?> cache : caches) { executor.execute(cache::start); - @SuppressWarnings("unused") - Future<?> possiblyIgnoredError = - cleanup.schedule(() -> cache.prune(cleanup), 30, TimeUnit.SECONDS); + if (cleanup != null) { + @SuppressWarnings("unused") + Future<?> possiblyIgnoredError = + cleanup.schedule(() -> cache.prune(cleanup), 30, TimeUnit.SECONDS); + } } } } @@ -106,7 +127,9 @@ public void stop() { if (executor != null) { try { - cleanup.shutdownNow(); + if (cleanup != null) { + cleanup.shutdownNow(); + } List<Runnable> pending = executor.shutdownNow(); if (executor.awaitTermination(15, TimeUnit.MINUTES)) { @@ -190,6 +213,22 @@ if (h2AutoServer) { url.append(";AUTO_SERVER=TRUE"); } + Duration refreshAfterWrite = def.refreshAfterWrite(); + if (has(def.configKey(), "refreshAfterWrite")) { + long refreshAfterWriteInSec = + ConfigUtil.getTimeUnit(config, "cache", def.configKey(), "refreshAfterWrite", 0, SECONDS); + if (refreshAfterWriteInSec != 0) { + refreshAfterWrite = Duration.ofSeconds(refreshAfterWriteInSec); + } + } + Duration expireAfterWrite = def.expireAfterWrite(); + if (has(def.configKey(), "maxAge")) { + long expireAfterWriteInsec = + ConfigUtil.getTimeUnit(config, "cache", def.configKey(), "maxAge", 0, SECONDS); + if (expireAfterWriteInsec != 0) { + expireAfterWrite = Duration.ofSeconds(expireAfterWriteInsec); + } + } return new SqlStore<>( url.toString(), def.keyType(), @@ -197,7 +236,12 @@ def.valueSerializer(), def.version(), maxSize, - def.expireAfterWrite(), - def.expireFromMemoryAfterAccess()); + expireAfterWrite, + refreshAfterWrite, + buildBloomFilter); + } + + private boolean has(String name, String var) { + return !Strings.isNullOrEmpty(config.getString("cache", name, var)); } }
diff --git a/java/com/google/gerrit/server/cache/h2/H2CacheImpl.java b/java/com/google/gerrit/server/cache/h2/H2CacheImpl.java index 7a53600..5c6fd70 100644 --- a/java/com/google/gerrit/server/cache/h2/H2CacheImpl.java +++ b/java/com/google/gerrit/server/cache/h2/H2CacheImpl.java
@@ -20,6 +20,7 @@ import com.google.common.cache.CacheLoader; import com.google.common.cache.CacheStats; import com.google.common.cache.LoadingCache; +import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.common.flogger.FluentLogger; import com.google.common.hash.BloomFilter; @@ -27,6 +28,7 @@ import com.google.common.util.concurrent.Futures; import com.google.common.util.concurrent.ListenableFuture; import com.google.gerrit.common.Nullable; +import com.google.gerrit.server.cache.CacheInfo; import com.google.gerrit.server.cache.PersistentCache; import com.google.gerrit.server.cache.serialize.CacheSerializer; import com.google.gerrit.server.logging.Metadata; @@ -44,7 +46,10 @@ import java.sql.Timestamp; import java.time.Duration; import java.time.Instant; +import java.util.ArrayList; import java.util.Calendar; +import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.concurrent.ArrayBlockingQueue; import java.util.concurrent.BlockingQueue; @@ -137,6 +142,23 @@ } @Override + public ImmutableMap<K, V> getAll(Iterable<? extends K> keys) throws ExecutionException { + if (mem instanceof LoadingCache) { + ImmutableMap.Builder<K, V> result = ImmutableMap.builder(); + LoadingCache<K, ValueHolder<V>> asLoadingCache = (LoadingCache<K, ValueHolder<V>>) mem; + ImmutableMap<K, ValueHolder<V>> values = asLoadingCache.getAll(keys); + for (Map.Entry<K, ValueHolder<V>> entry : values.entrySet()) { + result.put(entry.getKey(), entry.getValue().value); + if (store.needsRefresh(entry.getValue().created)) { + asLoadingCache.refresh(entry.getKey()); + } + } + return result.build(); + } + throw new UnsupportedOperationException(); + } + + @Override public V get(K key, Callable<? extends V> valueLoader) throws ExecutionException { return mem.get( key, @@ -265,6 +287,40 @@ } @Override + public Map<K, ValueHolder<V>> loadAll(Iterable<? extends K> keys) throws Exception { + try (TraceTimer timer = TraceContext.newTimer("Loading multiple values from cache")) { + List<K> notInMemory = new ArrayList<>(); + Map<K, ValueHolder<V>> result = new HashMap<>(); + for (K key : keys) { + if (!store.mightContain(key)) { + notInMemory.add(key); + continue; + } + ValueHolder<V> h = store.getIfPresent(key); + if (h != null) { + result.put(key, h); + } else { + notInMemory.add(key); + } + } + try { + Map<K, V> remaining = loader.loadAll(notInMemory); + Instant instant = Instant.ofEpochMilli(TimeUtil.nowMs()); + storeInDatabase(remaining, instant); + remaining + .entrySet() + .forEach(e -> result.put(e.getKey(), new ValueHolder<>(e.getValue(), instant))); + } catch (UnsupportedLoadingOperationException e) { + // Fallback to the default load() if loadAll() is not implemented + for (K k : notInMemory) { + result.put(k, load(k)); // No need to storeInDatabase here; load(k) does that. + } + } + return result; + } + } + + @Override public ListenableFuture<ValueHolder<V>> reload(K key, ValueHolder<V> oldValue) throws Exception { ListenableFuture<V> reloadedValue = loader.reload(key, oldValue.value); @@ -285,6 +341,15 @@ return Futures.transform(reloadedValue, v -> new ValueHolder<>(v, TimeUtil.now()), executor); } + + private void storeInDatabase(Map<K, V> entries, Instant instant) { + executor.execute( + () -> { + for (Map.Entry<K, V> entry : entries.entrySet()) { + store.put(entry.getKey(), new ValueHolder<>(entry.getValue(), instant)); + } + }); + } } static class SqlStore<K, V> { @@ -300,6 +365,7 @@ private final AtomicLong missCount = new AtomicLong(); private volatile BloomFilter<K> bloomFilter; private int estimatedSize; + private boolean buildBloomFilter; SqlStore( String jdbcUrl, @@ -309,7 +375,8 @@ int version, long maxSize, @Nullable Duration expireAfterWrite, - @Nullable Duration refreshAfterWrite) { + @Nullable Duration refreshAfterWrite, + boolean buildBloomFilter) { this.url = jdbcUrl; this.keyType = createKeyType(keyType, keySerializer); this.valueSerializer = valueSerializer; @@ -317,6 +384,7 @@ this.maxSize = maxSize; this.expireAfterWrite = expireAfterWrite; this.refreshAfterWrite = refreshAfterWrite; + this.buildBloomFilter = buildBloomFilter; int cores = Runtime.getRuntime().availableProcessors(); int keep = Math.min(cores, 16); @@ -333,7 +401,7 @@ } synchronized void open() { - if (bloomFilter == null) { + if (buildBloomFilter && bloomFilter == null) { bloomFilter = buildBloomFilter(); } } @@ -347,7 +415,7 @@ boolean mightContain(K key) { BloomFilter<K> b = bloomFilter; - if (b == null) { + if (buildBloomFilter && b == null) { synchronized (this) { b = bloomFilter; if (b == null) { @@ -593,12 +661,19 @@ try (ResultSet r = s.executeQuery("SELECT SUM(space) FROM data")) { used = r.next() ? r.getLong(1) : 0; } + String formattedMaxSize = CacheInfo.EntriesInfo.bytes(maxSize); if (used <= maxSize) { + logger.atFine().log( + "Cache %s size (%s) is less than maxSize (%s), not pruning", + url, CacheInfo.EntriesInfo.bytes(used), formattedMaxSize); return; } try (ResultSet r = s.executeQuery("SELECT k, space, created FROM data ORDER BY accessed")) { + logger.atInfo().log( + "Cache %s size (%s) is greater than maxSize (%s), pruning", + url, CacheInfo.EntriesInfo.bytes(used), formattedMaxSize); while (maxSize < used && r.next()) { K key = keyType.get(r, 1); Timestamp created = r.getTimestamp(3); @@ -609,6 +684,9 @@ used -= r.getLong(2); } } + logger.atInfo().log( + "Done pruning cache %s, size (%s) is now less than maxSize (%s)", + url, CacheInfo.EntriesInfo.bytes(used), formattedMaxSize); } } } catch (IOException | SQLException e) {
diff --git a/java/com/google/gerrit/server/cache/serialize/JavaCacheSerializer.java b/java/com/google/gerrit/server/cache/serialize/JavaCacheSerializer.java index ee71846..57aea22 100644 --- a/java/com/google/gerrit/server/cache/serialize/JavaCacheSerializer.java +++ b/java/com/google/gerrit/server/cache/serialize/JavaCacheSerializer.java
@@ -42,7 +42,7 @@ } } - @SuppressWarnings("unchecked") + @SuppressWarnings({"unchecked", "BanSerializableRead"}) @Override public T deserialize(byte[] in) { Object object;
diff --git a/java/com/google/gerrit/server/cache/serialize/entities/CachedProjectConfigSerializer.java b/java/com/google/gerrit/server/cache/serialize/entities/CachedProjectConfigSerializer.java index 40ef794..28a5f98 100644 --- a/java/com/google/gerrit/server/cache/serialize/entities/CachedProjectConfigSerializer.java +++ b/java/com/google/gerrit/server/cache/serialize/entities/CachedProjectConfigSerializer.java
@@ -82,6 +82,9 @@ proto.getLabelSectionsList().stream() .map(LabelTypeSerializer::deserialize) .forEach(builder::addLabelSection); + proto.getSubmitRequirementSectionsList().stream() + .map(SubmitRequirementSerializer::deserialize) + .forEach(builder::addSubmitRequirementSection); proto.getSubscribeSectionsList().stream() .map(SubscribeSectionSerializer::deserialize) .forEach(builder::addSubscribeSection); @@ -152,6 +155,9 @@ autoValue.getLabelSections().values().stream() .map(LabelTypeSerializer::serialize) .forEach(builder::addLabelSections); + autoValue.getSubmitRequirementSections().values().stream() + .map(SubmitRequirementSerializer::serialize) + .forEach(builder::addSubmitRequirementSections); autoValue.getSubscribeSections().values().stream() .map(SubscribeSectionSerializer::serialize) .forEach(builder::addSubscribeSections);
diff --git a/java/com/google/gerrit/server/cache/serialize/entities/LabelTypeSerializer.java b/java/com/google/gerrit/server/cache/serialize/entities/LabelTypeSerializer.java index 4627cdb..c00961f 100644 --- a/java/com/google/gerrit/server/cache/serialize/entities/LabelTypeSerializer.java +++ b/java/com/google/gerrit/server/cache/serialize/entities/LabelTypeSerializer.java
@@ -18,6 +18,7 @@ import com.google.common.base.Converter; import com.google.common.base.Enums; +import com.google.common.base.Strings; import com.google.common.collect.ImmutableList; import com.google.common.primitives.Shorts; import com.google.gerrit.entities.LabelFunction; @@ -39,6 +40,7 @@ .setAllowPostSubmit(proto.getAllowPostSubmit()) .setIgnoreSelfApproval(proto.getIgnoreSelfApproval()) .setDefaultValue(Shorts.saturatedCast(proto.getDefaultValue())) + .setCopyCondition(Strings.emptyToNull(proto.getCopyCondition())) .setCopyAnyScore(proto.getCopyAnyScore()) .setCopyMinScore(proto.getCopyMinScore()) .setCopyMaxScore(proto.getCopyMaxScore()) @@ -67,6 +69,7 @@ .map(LabelValueSerializer::serialize) .collect(toImmutableList())) .setFunction(FUNCTION_CONVERTER.reverse().convert(autoValue.getFunction())) + .setCopyCondition(autoValue.getCopyCondition().orElse("")) .setCopyAnyScore(autoValue.isCopyAnyScore()) .setCopyMinScore(autoValue.isCopyMinScore()) .setCopyMaxScore(autoValue.isCopyMaxScore())
diff --git a/java/com/google/gerrit/server/cache/serialize/entities/SubmitRequirementExpressionResultSerializer.java b/java/com/google/gerrit/server/cache/serialize/entities/SubmitRequirementExpressionResultSerializer.java new file mode 100644 index 0000000..4e997b4 --- /dev/null +++ b/java/com/google/gerrit/server/cache/serialize/entities/SubmitRequirementExpressionResultSerializer.java
@@ -0,0 +1,45 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.cache.serialize.entities; + +import com.google.common.collect.ImmutableList; +import com.google.gerrit.entities.SubmitRequirementExpression; +import com.google.gerrit.entities.SubmitRequirementExpressionResult; +import com.google.gerrit.server.cache.proto.Cache.SubmitRequirementExpressionResultProto; + +/** + * Serializer of a {@link SubmitRequirementExpressionResult} to {@link + * SubmitRequirementExpressionResultProto}. + */ +public class SubmitRequirementExpressionResultSerializer { + public static SubmitRequirementExpressionResult deserialize( + SubmitRequirementExpressionResultProto proto) { + return SubmitRequirementExpressionResult.create( + SubmitRequirementExpression.create(proto.getExpression()), + SubmitRequirementExpressionResult.Status.valueOf(proto.getStatus()), + proto.getPassingAtomsList().stream().collect(ImmutableList.toImmutableList()), + proto.getFailingAtomsList().stream().collect(ImmutableList.toImmutableList())); + } + + public static SubmitRequirementExpressionResultProto serialize( + SubmitRequirementExpressionResult r) { + return SubmitRequirementExpressionResultProto.newBuilder() + .setExpression(r.expression().expressionString()) + .setStatus(r.status().name()) + .addAllPassingAtoms(r.passingAtoms()) + .addAllFailingAtoms(r.failingAtoms()) + .build(); + } +}
diff --git a/java/com/google/gerrit/server/cache/serialize/entities/SubmitRequirementSerializer.java b/java/com/google/gerrit/server/cache/serialize/entities/SubmitRequirementSerializer.java new file mode 100644 index 0000000..47a377f --- /dev/null +++ b/java/com/google/gerrit/server/cache/serialize/entities/SubmitRequirementSerializer.java
@@ -0,0 +1,52 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.cache.serialize.entities; + +import com.google.common.base.Strings; +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementExpression; +import com.google.gerrit.server.cache.proto.Cache; +import java.util.Optional; + +/** Serializer for {@link com.google.gerrit.entities.SubmitRequirement}. */ +public class SubmitRequirementSerializer { + public static SubmitRequirement deserialize(Cache.SubmitRequirementProto proto) { + return SubmitRequirement.builder() + .setName(proto.getName()) + .setDescription(Optional.ofNullable(Strings.emptyToNull(proto.getDescription()))) + .setApplicabilityExpression( + SubmitRequirementExpression.of(proto.getApplicabilityExpression())) + .setSubmittabilityExpression( + SubmitRequirementExpression.create(proto.getSubmittabilityExpression())) + .setOverrideExpression(SubmitRequirementExpression.of(proto.getOverrideExpression())) + .setAllowOverrideInChildProjects(proto.getAllowOverrideInChildProjects()) + .build(); + } + + public static Cache.SubmitRequirementProto serialize(SubmitRequirement submitRequirement) { + SubmitRequirementExpression emptyExpression = SubmitRequirementExpression.create(""); + return Cache.SubmitRequirementProto.newBuilder() + .setName(submitRequirement.name()) + .setDescription(submitRequirement.description().orElse("")) + .setApplicabilityExpression( + submitRequirement.applicabilityExpression().orElse(emptyExpression).expressionString()) + .setSubmittabilityExpression( + submitRequirement.submittabilityExpression().expressionString()) + .setOverrideExpression( + submitRequirement.overrideExpression().orElse(emptyExpression).expressionString()) + .setAllowOverrideInChildProjects(submitRequirement.allowOverrideInChildProjects()) + .build(); + } +}
diff --git a/java/com/google/gerrit/server/cancellation/BUILD b/java/com/google/gerrit/server/cancellation/BUILD new file mode 100644 index 0000000..05530a5 --- /dev/null +++ b/java/com/google/gerrit/server/cancellation/BUILD
@@ -0,0 +1,14 @@ +load("@rules_java//java:defs.bzl", "java_library") + +java_library( + name = "cancellation", + srcs = glob( + ["*.java"], + ), + visibility = ["//visibility:public"], + deps = [ + "//java/com/google/gerrit/common:annotations", + "//lib:guava", + "//lib/commons:lang", + ], +)
diff --git a/java/com/google/gerrit/server/cancellation/RequestCancelledException.java b/java/com/google/gerrit/server/cancellation/RequestCancelledException.java new file mode 100644 index 0000000..d89701f --- /dev/null +++ b/java/com/google/gerrit/server/cancellation/RequestCancelledException.java
@@ -0,0 +1,80 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.cancellation; + +import com.google.common.base.Throwables; +import com.google.gerrit.common.Nullable; +import java.util.Optional; +import org.apache.commons.lang.WordUtils; + +/** Exception to signal that the current request is cancelled and should be aborted. */ +public class RequestCancelledException extends RuntimeException { + private static final long serialVersionUID = 1L; + + /** + * Checks whether the given exception was caused by {@link RequestCancelledException}. If yes, the + * {@link RequestCancelledException} is returned. If not, {@link Optional#empty()} is returned. + */ + public static Optional<RequestCancelledException> getFromCausalChain(Throwable e) { + return Throwables.getCausalChain(e).stream() + .filter(RequestCancelledException.class::isInstance) + .map(RequestCancelledException.class::cast) + .findFirst(); + } + + private final RequestStateProvider.Reason cancellationReason; + private final Optional<String> cancellationMessage; + + /** + * Create a {@code RequestCancelledException}. + * + * @param cancellationReason the reason why the request is cancelled + * @param cancellationMessage an optional message providing details about the cancellation + */ + public RequestCancelledException( + RequestStateProvider.Reason cancellationReason, @Nullable String cancellationMessage) { + super(createMessage(cancellationReason, cancellationMessage)); + this.cancellationReason = cancellationReason; + this.cancellationMessage = Optional.ofNullable(cancellationMessage); + } + + private static String createMessage( + RequestStateProvider.Reason cancellationReason, @Nullable String message) { + StringBuilder messageBuilder = new StringBuilder(); + messageBuilder.append(String.format("Request cancelled: %s", cancellationReason.name())); + if (message != null) { + messageBuilder.append(String.format(" (%s)", message)); + } + return messageBuilder.toString(); + } + + /** Returns the reason why the request is cancelled. */ + public RequestStateProvider.Reason getCancellationReason() { + return cancellationReason; + } + + /** Returns the cancellation reason as a user-readable string. */ + public String formatCancellationReason() { + return WordUtils.capitalizeFully(cancellationReason.name().replaceAll("_", " ")); + } + + /** + * Returns a message providing details about the cancellation, or {@link Optional#empty()} if none + * is available. + */ + public Optional<String> getCancellationMessage() { + return cancellationMessage; + } +}
diff --git a/java/com/google/gerrit/server/cancellation/RequestStateContext.java b/java/com/google/gerrit/server/cancellation/RequestStateContext.java new file mode 100644 index 0000000..390c76f --- /dev/null +++ b/java/com/google/gerrit/server/cancellation/RequestStateContext.java
@@ -0,0 +1,179 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.cancellation; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.collect.ImmutableSet; +import java.util.HashSet; +import java.util.Set; + +/** + * Context that allows to register {@link RequestStateProvider}s. + * + * <p>The registered {@link RequestStateProvider}s are stored in {@link ThreadLocal} so that they + * can be accessed during the request execution (via {@link #getRequestStateProviders()}. + * + * <p>On {@link #close()} the {@link RequestStateProvider}s that have been registered by this {@code + * RequestStateContext} instance are removed from {@link ThreadLocal}. + * + * <p>Nesting {@code RequestStateContext}s is possible. + * + * <p>Currently there is no logic to automatically copy the {@link RequestStateContext} to + * background threads, but implementing this may be considered in the future. This means that by + * default we only support cancellation of the main thread, but not of background threads. That's + * fine as all significant work is being done in the main thread. + * + * <p>{@link com.google.gerrit.server.util.RequestContext} is also a context that is available for + * the time of the request, but it is not suitable to manage registrations of {@link + * RequestStateProvider}s. Hence {@link RequestStateProvider} registrations are managed by a + * separate context, which is this class, {@link RequestStateContext}: + * + * <ul> + * <li>{@link com.google.gerrit.server.util.RequestContext} is an interface that has many + * implementations and hence cannot manage a {@link ThreadLocal} state. + * <li>{@link com.google.gerrit.server.util.RequestContext} is not an {@link AutoCloseable} and + * hence cannot cleanup any {@link ThreadLocal} state on close (turning it into an {@link + * AutoCloseable} would require a large refactoring). + * <li>Despite the name {@link com.google.gerrit.server.util.RequestContext} is not only used for + * requests scopes but also for other scopes that are not a request (e.g. plugin invocations, + * email sending, manual scopes). + * <li>{@link com.google.gerrit.server.util.RequestContext} is not copied to background and should + * not be, but for {@link RequestStateContext} we may consider doing this in the future. + * </ul> + */ +public class RequestStateContext implements AutoCloseable { + /** The {@link RequestStateProvider}s that have been registered for the thread. */ + private static final ThreadLocal<Set<RequestStateProvider>> threadLocalRequestStateProviders = + new ThreadLocal<>(); + + /** Whether currently a non-cancellable operation is being performed. */ + private static final ThreadLocal<Boolean> inNonCancellableOperation = new ThreadLocal<>(); + + /** + * Aborts the current request by throwing a {@link RequestCancelledException} if any of the + * registered {@link RequestStateProvider}s reports the request as cancelled. + * + * <p>If an atomic operation is currently being performed, request cancellations are ignored and + * the request doesn't get aborted. + * + * @throws RequestCancelledException thrown if the current request is cancelled and should be + * aborted + * @see #startNonCancellableOperation() + */ + public static void abortIfCancelled() throws RequestCancelledException { + if (inNonCancellableOperation.get() != null && inNonCancellableOperation.get()) { + // Do not cancel the request while an atomic operation is being performed. + return; + } + + getRequestStateProviders() + .forEach( + requestStateProvider -> + requestStateProvider.checkIfCancelled( + (reason, message) -> { + throw new RequestCancelledException(reason, message); + })); + } + + /** + * Starts a non-cancellable operation. + * + * <p>If the request was cancelled while the non-cancellable operation was running, it gets + * aborted on close of the returned {@link AutoCloseable}. + * + * @return {@link AutoCloseable} that finishes the non-cancellable operation on close. + */ + public static NonCancellableOperationContext startNonCancellableOperation() { + if (inNonCancellableOperation.get() != null && inNonCancellableOperation.get()) { + // atomic operation is already in progress + return () -> {}; + } + + inNonCancellableOperation.set(true); + return () -> { + inNonCancellableOperation.remove(); + abortIfCancelled(); + }; + } + + /** Returns the {@link RequestStateProvider}s that have been registered for the thread. */ + @VisibleForTesting + static ImmutableSet<RequestStateProvider> getRequestStateProviders() { + if (threadLocalRequestStateProviders.get() == null) { + return ImmutableSet.of(); + } + return ImmutableSet.copyOf(threadLocalRequestStateProviders.get()); + } + + /** Opens a {@code RequestStateContext}. */ + public static RequestStateContext open() { + return new RequestStateContext(); + } + + /** + * The {@link RequestStateProvider}s that have been registered by this {@code + * RequestStateContext}. + */ + private Set<RequestStateProvider> requestStateProviders = new HashSet<>(); + + private RequestStateContext() {} + + /** + * Registers a {@link RequestStateProvider}. + * + * @param requestStateProvider the {@link RequestStateProvider} that should be registered + * @return the {@code RequestStateContext} instance for chaining calls + */ + public RequestStateContext addRequestStateProvider(RequestStateProvider requestStateProvider) { + if (threadLocalRequestStateProviders.get() == null) { + threadLocalRequestStateProviders.set(new HashSet<>()); + } + if (threadLocalRequestStateProviders.get().add(requestStateProvider)) { + requestStateProviders.add(requestStateProvider); + } + return this; + } + + /** + * Closes this {@code RequestStateContext}. + * + * <p>Ensures that all {@link RequestStateProvider}s that have been registered by this {@code + * RequestStateContext} instance are removed from {@link #threadLocalRequestStateProviders}. + * + * <p>If no {@link RequestStateProvider}s remain in {@link #threadLocalRequestStateProviders}, + * {@link #threadLocalRequestStateProviders} is unset. + */ + @Override + public void close() { + if (threadLocalRequestStateProviders.get() != null) { + requestStateProviders.forEach( + requestStateProvider -> + threadLocalRequestStateProviders.get().remove(requestStateProvider)); + if (threadLocalRequestStateProviders.get().isEmpty()) { + threadLocalRequestStateProviders.remove(); + } + } + } + + /** + * Context for running a non-cancellable operation. + * + * <p>While open, the current request cannot be cancelled. + */ + public interface NonCancellableOperationContext extends AutoCloseable { + @Override + void close(); + } +}
diff --git a/java/com/google/gerrit/server/cancellation/RequestStateProvider.java b/java/com/google/gerrit/server/cancellation/RequestStateProvider.java new file mode 100644 index 0000000..683ca1d --- /dev/null +++ b/java/com/google/gerrit/server/cancellation/RequestStateProvider.java
@@ -0,0 +1,60 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.cancellation; + +import com.google.gerrit.common.Nullable; + +/** Interface that provides information about the state of the current request. */ +public interface RequestStateProvider { + /** + * Checks whether the current request is cancelled. + * + * <p>Invoked by Gerrit to check whether the current request is cancelled and should be aborted. + * + * <p>If the current request is cancelled {@link OnCancelled#onCancel(Reason, String)} is invoked + * on the provided callback. + * + * @param onCancelled callback that should be invoked if the request is cancelled + */ + void checkIfCancelled(OnCancelled onCancelled); + + /** Callback interface to be invoked if a request is cancelled. */ + @FunctionalInterface + interface OnCancelled { + /** + * Callback that is invoked if the request is cancelled. + * + * @param reason the reason for the cancellation of the request + * @param message an optional message providing details about the cancellation + */ + void onCancel(Reason reason, @Nullable String message); + } + + /** Reason why a request is cancelled. */ + enum Reason { + /** The client got disconnected or has cancelled the request. */ + CLIENT_CLOSED_REQUEST, + + /** The deadline that the client provided for the request exceeded. */ + CLIENT_PROVIDED_DEADLINE_EXCEEDED, + + /** + * A server-side deadline for the request exceeded. + * + * <p>Server-side deadlines are usually configurable, but may also be hard-coded. + */ + SERVER_DEADLINE_EXCEEDED; + } +}
diff --git a/java/com/google/gerrit/server/change/AbandonOp.java b/java/com/google/gerrit/server/change/AbandonOp.java index 6c39ed0..10e1f92 100644 --- a/java/com/google/gerrit/server/change/AbandonOp.java +++ b/java/com/google/gerrit/server/change/AbandonOp.java
@@ -18,7 +18,6 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.extensions.restapi.ResourceConflictException; import com.google.gerrit.server.ChangeMessagesUtil; @@ -32,7 +31,7 @@ import com.google.gerrit.server.notedb.ChangeUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; @@ -50,7 +49,7 @@ private Change change; private PatchSet patchSet; - private ChangeMessage message; + private String mailMessage; public interface Factory { AbandonOp create( @@ -94,24 +93,22 @@ change.setLastUpdatedOn(ctx.getWhen()); update.setStatus(change.getStatus()); - message = newMessage(ctx); - cmUtil.addChangeMessage(update, message); + mailMessage = cmUtil.setChangeMessage(ctx, commentMessage(), ChangeMessagesUtil.TAG_ABANDON); return true; } - private ChangeMessage newMessage(ChangeContext ctx) { + private String commentMessage() { StringBuilder msg = new StringBuilder(); msg.append("Abandoned"); if (!Strings.nullToEmpty(msgTxt).trim().isEmpty()) { msg.append("\n\n"); msg.append(msgTxt.trim()); } - - return ChangeMessagesUtil.newMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_ABANDON); + return msg.toString(); } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { NotifyResolver.Result notify = ctx.getNotify(change.getId()); try { ReplyToChangeSender emailSender = @@ -119,7 +116,7 @@ if (accountState != null) { emailSender.setFrom(accountState.account().id()); } - emailSender.setChangeMessage(message.getMessage(), ctx.getWhen()); + emailSender.setChangeMessage(mailMessage, ctx.getWhen()); emailSender.setNotify(notify); emailSender.setMessageId( messageIdGenerator.fromChangeUpdate(ctx.getRepoView(), patchSet.id())); @@ -127,6 +124,12 @@ } catch (Exception e) { logger.atSevere().withCause(e).log("Cannot email update for change %s", change.getId()); } - changeAbandoned.fire(change, patchSet, accountState, msgTxt, ctx.getWhen(), notify.handling()); + changeAbandoned.fire( + ctx.getChangeData(change), + patchSet, + accountState, + msgTxt, + ctx.getWhen(), + notify.handling()); } }
diff --git a/java/com/google/gerrit/server/change/AbandonUtil.java b/java/com/google/gerrit/server/change/AbandonUtil.java index 1bc1fad..d030ec1 100644 --- a/java/com/google/gerrit/server/change/AbandonUtil.java +++ b/java/com/google/gerrit/server/change/AbandonUtil.java
@@ -93,7 +93,7 @@ try { batchAbandon.batchAbandon(updateFactory, project, internalUser, changes, message); count += changes.size(); - } catch (Throwable e) { + } catch (Exception e) { StringBuilder msg = new StringBuilder("Failed to auto-abandon inactive change(s):"); for (ChangeData change : changes) { msg.append(" ").append(change.getId().get());
diff --git a/java/com/google/gerrit/server/change/AddReviewersOp.java b/java/com/google/gerrit/server/change/AddReviewersOp.java index ff8e5c6..cbbd01a 100644 --- a/java/com/google/gerrit/server/change/AddReviewersOp.java +++ b/java/com/google/gerrit/server/change/AddReviewersOp.java
@@ -23,7 +23,6 @@ import static java.util.Objects.requireNonNull; import static java.util.stream.Collectors.toList; -import com.google.auto.value.AutoValue; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Lists; @@ -31,20 +30,18 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Address; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.extensions.client.ReviewerState; import com.google.gerrit.extensions.restapi.RestApiException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.PatchSetUtil; import com.google.gerrit.server.account.AccountCache; import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.extensions.events.ReviewerAdded; import com.google.gerrit.server.notedb.ReviewerStateInternal; import com.google.gerrit.server.project.ProjectCache; -import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; import java.io.IOException; @@ -52,7 +49,7 @@ import java.util.List; import java.util.Set; -public class AddReviewersOp implements BatchUpdateOp { +public class AddReviewersOp extends ReviewerOp { public interface Factory { /** @@ -75,56 +72,25 @@ boolean forGroup); } - @AutoValue - public abstract static class Result { - public abstract ImmutableList<PatchSetApproval> addedReviewers(); - - public abstract ImmutableList<Address> addedReviewersByEmail(); - - public abstract ImmutableList<Account.Id> addedCCs(); - - public abstract ImmutableList<Address> addedCCsByEmail(); - - static Builder builder() { - return new AutoValue_AddReviewersOp_Result.Builder(); - } - - @AutoValue.Builder - abstract static class Builder { - abstract Builder setAddedReviewers(Iterable<PatchSetApproval> addedReviewers); - - abstract Builder setAddedReviewersByEmail(Iterable<Address> addedReviewersByEmail); - - abstract Builder setAddedCCs(Iterable<Account.Id> addedCCs); - - abstract Builder setAddedCCsByEmail(Iterable<Address> addedCCsByEmail); - - abstract Result build(); - } - } - private final ApprovalsUtil approvalsUtil; private final PatchSetUtil psUtil; private final ReviewerAdded reviewerAdded; private final AccountCache accountCache; private final ProjectCache projectCache; - private final AddReviewersEmail addReviewersEmail; + private final ModifyReviewersEmail modifyReviewersEmail; private final Set<Account.Id> accountIds; private final Collection<Address> addresses; private final ReviewerState state; private final boolean forGroup; - // Unlike addedCCs, addedReviewers is a PatchSetApproval because the AddReviewerResult returned + // Unlike addedCCs, addedReviewers is a PatchSetApproval because the ReviewerResult returned // via the REST API is supposed to include vote information. private List<PatchSetApproval> addedReviewers = ImmutableList.of(); private Collection<Address> addedReviewersByEmail = ImmutableList.of(); private Collection<Account.Id> addedCCs = ImmutableList.of(); private Collection<Address> addedCCsByEmail = ImmutableList.of(); - private boolean sendEmail = true; private Change change; - private PatchSet patchSet; - private Result opResult; @Inject AddReviewersOp( @@ -133,7 +99,7 @@ ReviewerAdded reviewerAdded, AccountCache accountCache, ProjectCache projectCache, - AddReviewersEmail addReviewersEmail, + ModifyReviewersEmail modifyReviewersEmail, @Assisted Set<Account.Id> accountIds, @Assisted Collection<Address> addresses, @Assisted ReviewerState state, @@ -144,7 +110,7 @@ this.reviewerAdded = reviewerAdded; this.accountCache = accountCache; this.projectCache = projectCache; - this.addReviewersEmail = addReviewersEmail; + this.modifyReviewersEmail = modifyReviewersEmail; this.accountIds = accountIds; this.addresses = addresses; @@ -152,17 +118,6 @@ this.forGroup = forGroup; } - // TODO(dborowitz): This mutable setter is ugly, but a) it's less ugly than adding boolean args - // all the way through the constructor stack, and b) this class is slated to be completely - // rewritten. - public void suppressEmail() { - this.sendEmail = false; - } - - void setPatchSet(PatchSet patchSet) { - this.patchSet = requireNonNull(patchSet); - } - @Override public boolean updateChange(ChangeContext ctx) throws RestApiException, IOException { change = ctx.getChange(); @@ -238,7 +193,7 @@ } @Override - public void postUpdate(Context ctx) throws Exception { + public void postUpdate(PostUpdateContext ctx) throws Exception { opResult = Result.builder() .setAddedReviewers(addedReviewers) @@ -247,13 +202,15 @@ .setAddedCCsByEmail(addedCCsByEmail) .build(); if (sendEmail) { - addReviewersEmail.emailReviewersAsync( + modifyReviewersEmail.emailReviewersAsync( ctx.getUser().asIdentifiedUser(), change, Lists.transform(addedReviewers, PatchSetApproval::accountId), addedCCs, + ImmutableSet.of(), addedReviewersByEmail, addedCCsByEmail, + ImmutableSet.of(), ctx.getNotify(change.getId())); } if (!addedReviewers.isEmpty()) { @@ -262,12 +219,13 @@ .map(r -> accountCache.get(r.accountId())) .flatMap(Streams::stream) .collect(toList()); - reviewerAdded.fire(change, patchSet, reviewers, ctx.getAccount(), ctx.getWhen()); + eventSender = + () -> + reviewerAdded.fire( + ctx.getChangeData(change), patchSet, reviewers, ctx.getAccount(), ctx.getWhen()); + if (sendEvent) { + sendEvent(); + } } } - - public Result getResult() { - checkState(opResult != null, "Batch update wasn't executed yet"); - return opResult; - } }
diff --git a/java/com/google/gerrit/server/change/AddToAttentionSetOp.java b/java/com/google/gerrit/server/change/AddToAttentionSetOp.java index 8053b30..a980c32 100644 --- a/java/com/google/gerrit/server/change/AddToAttentionSetOp.java +++ b/java/com/google/gerrit/server/change/AddToAttentionSetOp.java
@@ -27,7 +27,7 @@ import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.util.AttentionSetEmail; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; @@ -101,7 +101,7 @@ } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { if (!notify) { return; }
diff --git a/java/com/google/gerrit/server/change/ChangeCleanupRunner.java b/java/com/google/gerrit/server/change/ChangeCleanupRunner.java index 6cf7a8f..a080d15 100644 --- a/java/com/google/gerrit/server/change/ChangeCleanupRunner.java +++ b/java/com/google/gerrit/server/change/ChangeCleanupRunner.java
@@ -30,7 +30,7 @@ public class ChangeCleanupRunner implements Runnable { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - public static class Module extends LifecycleModule { + public static class ChangeCleanupRunnerModule extends LifecycleModule { @Override protected void configure() { listener().to(Lifecycle.class);
diff --git a/java/com/google/gerrit/server/change/ChangeFinder.java b/java/com/google/gerrit/server/change/ChangeFinder.java index ba104d8..9f253de 100644 --- a/java/com/google/gerrit/server/change/ChangeFinder.java +++ b/java/com/google/gerrit/server/change/ChangeFinder.java
@@ -96,6 +96,7 @@ .setRate() .setUnit("requests"), Field.ofEnum(ChangeIdType.class, "change_id_type", Metadata.Builder::changeIdType) + .description("The type of the change identifier.") .build()); }
diff --git a/java/com/google/gerrit/server/change/ChangeInserter.java b/java/com/google/gerrit/server/change/ChangeInserter.java index fb027bd..85482e4 100644 --- a/java/com/google/gerrit/server/change/ChangeInserter.java +++ b/java/com/google/gerrit/server/change/ChangeInserter.java
@@ -18,7 +18,7 @@ import static com.google.common.collect.ImmutableList.toImmutableList; import static com.google.common.collect.ImmutableSet.toImmutableSet; import static com.google.gerrit.entities.Change.INITIAL_PATCH_SET_ID; -import static com.google.gerrit.server.change.ReviewerAdder.newAddReviewerInputFromCommitIdentity; +import static com.google.gerrit.server.change.ReviewerModifier.newReviewerInputFromCommitIdentity; import static com.google.gerrit.server.notedb.ReviewerStateInternal.REVIEWER; import static com.google.gerrit.server.project.ProjectCache.illegalState; import static java.util.Objects.requireNonNull; @@ -32,7 +32,6 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.BranchNameKey; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.LabelType; import com.google.gerrit.entities.LabelTypes; import com.google.gerrit.entities.PatchSet; @@ -46,13 +45,13 @@ import com.google.gerrit.extensions.restapi.ResourceConflictException; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.extensions.restapi.UnprocessableEntityException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.PatchSetUtil; -import com.google.gerrit.server.change.ReviewerAdder.InternalAddReviewerInput; -import com.google.gerrit.server.change.ReviewerAdder.ReviewerAddition; -import com.google.gerrit.server.change.ReviewerAdder.ReviewerAdditionList; +import com.google.gerrit.server.approval.ApprovalsUtil; +import com.google.gerrit.server.change.ReviewerModifier.InternalReviewerInput; +import com.google.gerrit.server.change.ReviewerModifier.ReviewerModification; +import com.google.gerrit.server.change.ReviewerModifier.ReviewerModificationList; import com.google.gerrit.server.config.SendEmailExecutor; import com.google.gerrit.server.config.UrlFormatter; import com.google.gerrit.server.events.CommitReceivedEvent; @@ -74,6 +73,7 @@ import com.google.gerrit.server.update.ChangeContext; import com.google.gerrit.server.update.Context; import com.google.gerrit.server.update.InsertChangeOp; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RepoContext; import com.google.gerrit.server.util.CommitMessageUtil; import com.google.gerrit.server.util.RequestScopePropagator; @@ -112,7 +112,7 @@ private final CommitValidators.Factory commitValidatorsFactory; private final RevisionCreated revisionCreated; private final CommentAdded commentAdded; - private final ReviewerAdder reviewerAdder; + private final ReviewerModifier reviewerModifier; private final MessageIdGenerator messageIdGenerator; private final DynamicItem<UrlFormatter> urlFormatter; private final AutoMerger autoMerger; @@ -131,6 +131,7 @@ private boolean isPrivate; private boolean workInProgress; private List<String> groups = Collections.emptyList(); + private ImmutableListMultimap<String, String> validationOptions = ImmutableListMultimap.of(); private boolean validate = true; private Map<String, Short> approvals; private RequestScopePropagator requestScopePropagator; @@ -138,17 +139,17 @@ private boolean sendMail; private boolean updateRef; private Change.Id revertOf; - private ImmutableList<InternalAddReviewerInput> reviewerInputs; + private ImmutableList<InternalReviewerInput> reviewerInputs; // Fields set during the insertion process. private ReceiveCommand cmd; private Change change; - private ChangeMessage changeMessage; + private String changeMessage; private PatchSetInfo patchSetInfo; private PatchSet patchSet; private String pushCert; private ProjectState projectState; - private ReviewerAdditionList reviewerAdditions; + private ReviewerModificationList reviewerAdditions; @Inject ChangeInserter( @@ -163,7 +164,7 @@ CommitValidators.Factory commitValidatorsFactory, CommentAdded commentAdded, RevisionCreated revisionCreated, - ReviewerAdder reviewerAdder, + ReviewerModifier reviewerModifier, MessageIdGenerator messageIdGenerator, DynamicItem<UrlFormatter> urlFormatter, AutoMerger autoMerger, @@ -181,7 +182,7 @@ this.commitValidatorsFactory = commitValidatorsFactory; this.revisionCreated = revisionCreated; this.commentAdded = commentAdded; - this.reviewerAdder = reviewerAdder; + this.reviewerModifier = reviewerModifier; this.messageIdGenerator = messageIdGenerator; this.urlFormatter = urlFormatter; this.autoMerger = autoMerger; @@ -280,8 +281,8 @@ Streams.concat( Streams.stream(reviewers) .distinct() - .map(id -> newAddReviewerInput(id, ReviewerState.REVIEWER)), - Streams.stream(ccs).distinct().map(id -> newAddReviewerInput(id, ReviewerState.CC))) + .map(id -> newReviewerInput(id, ReviewerState.REVIEWER)), + Streams.stream(ccs).distinct().map(id -> newReviewerInput(id, ReviewerState.CC))) .collect(toImmutableList()); return this; } @@ -305,11 +306,21 @@ public ChangeInserter setGroups(List<String> groups) { requireNonNull(groups, "groups may not be empty"); - checkState(patchSet == null, "setGroups(Iterable<String>) only valid before creating change"); + checkState(patchSet == null, "setGroups(List<String>) only valid before creating change"); this.groups = groups; return this; } + public ChangeInserter setValidationOptions( + ImmutableListMultimap<String, String> validationOptions) { + checkState( + patchSet == null, + "setValidationOptions(ImmutableListMultimap<String, String>) only valid before creating a" + + " change"); + this.validationOptions = validationOptions; + return this; + } + public ChangeInserter setFireRevisionCreated(boolean fireRevisionCreated) { this.fireRevisionCreated = fireRevisionCreated; return this; @@ -361,7 +372,7 @@ return this; } - public ChangeMessage getChangeMessage() { + public String getChangeMessage() { if (message == null) { return null; } @@ -443,8 +454,9 @@ } reviewerAdditions = - reviewerAdder.prepare(ctx.getNotes(), ctx.getUser(), getReviewerInputs(), true); - Optional<ReviewerAddition> reviewerError = reviewerAdditions.getFailures().stream().findFirst(); + reviewerModifier.prepare(ctx.getNotes(), ctx.getUser(), getReviewerInputs(), true); + Optional<ReviewerModification> reviewerError = + reviewerAdditions.getFailures().stream().findFirst(); if (reviewerError.isPresent()) { throw new UnprocessableEntityException(reviewerError.get().result.error); } @@ -463,19 +475,14 @@ } if (message != null) { changeMessage = - ChangeMessagesUtil.newMessage( - patchSet.id(), - ctx.getUser(), - patchSet.createdOn(), - message, - ChangeMessagesUtil.uploadedPatchSetTag(workInProgress)); - cmUtil.addChangeMessage(update, changeMessage); + cmUtil.setChangeMessage( + update, message, ChangeMessagesUtil.uploadedPatchSetTag(workInProgress)); } return true; } @Override - public void postUpdate(Context ctx) throws Exception { + public void postUpdate(PostUpdateContext ctx) throws Exception { reviewerAdditions.postUpdate(ctx); NotifyResolver.Result notify = ctx.getNotify(change.getId()); if (sendMail && notify.shouldNotify()) { @@ -528,7 +535,8 @@ * show a transition from an oldValue of 0 to the new value. */ if (fireRevisionCreated) { - revisionCreated.fire(change, patchSet, ctx.getAccount(), ctx.getWhen(), notify); + revisionCreated.fire( + ctx.getChangeData(change), patchSet, ctx.getAccount(), ctx.getWhen(), notify); if (approvals != null && !approvals.isEmpty()) { List<LabelType> labels = projectState.getLabelTypes(change.getDest()).getLabelTypes(); Map<String, Short> allApprovals = new HashMap<>(); @@ -544,7 +552,13 @@ } } commentAdded.fire( - change, patchSet, ctx.getAccount(), null, allApprovals, oldApprovals, ctx.getWhen()); + ctx.getChangeData(change), + patchSet, + ctx.getAccount(), + null, + allApprovals, + oldApprovals, + ctx.getWhen()); } } } @@ -560,7 +574,7 @@ cmd, projectState.getProject(), change.getDest().branch(), - ImmutableListMultimap.of(), + validationOptions, ctx.getRepoView().getConfig(), ctx.getRevWalk().getObjectReader(), commitId, @@ -580,35 +594,34 @@ } } - private static InternalAddReviewerInput newAddReviewerInput( - String reviewer, ReviewerState state) { + private static InternalReviewerInput newReviewerInput(String reviewer, ReviewerState state) { // Disable individual emails when adding reviewers, as all reviewers will receive the single // bulk new change email. - InternalAddReviewerInput input = - ReviewerAdder.newAddReviewerInput(reviewer, state, NotifyHandling.NONE); + InternalReviewerInput input = + ReviewerModifier.newReviewerInput(reviewer, state, NotifyHandling.NONE); // Ignore failures for reasons like the reviewer being inactive or being unable to see the // change. This is required for the push path, where it automatically sets reviewers from // certain commit footers: putting a nonexistent user in a footer should not cause an error. In // theory we could provide finer control to do this for some reviewers and not others, but it's // not worth complicating the ChangeInserter interface further at this time. - input.otherFailureBehavior = ReviewerAdder.FailureBehavior.IGNORE; + input.otherFailureBehavior = ReviewerModifier.FailureBehavior.IGNORE; return input; } - private ImmutableList<InternalAddReviewerInput> getReviewerInputs() { + private ImmutableList<InternalReviewerInput> getReviewerInputs() { return Streams.concat( reviewerInputs.stream(), Streams.stream( - newAddReviewerInputFromCommitIdentity( + newReviewerInputFromCommitIdentity( change, patchSetInfo.getCommitId(), patchSetInfo.getAuthor().getAccount(), NotifyHandling.NONE, change.getOwner())), Streams.stream( - newAddReviewerInputFromCommitIdentity( + newReviewerInputFromCommitIdentity( change, patchSetInfo.getCommitId(), patchSetInfo.getCommitter().getAccount(),
diff --git a/java/com/google/gerrit/server/change/ChangeJson.java b/java/com/google/gerrit/server/change/ChangeJson.java index 029f231..328c5de 100644 --- a/java/com/google/gerrit/server/change/ChangeJson.java +++ b/java/com/google/gerrit/server/change/ChangeJson.java
@@ -31,6 +31,7 @@ import static com.google.gerrit.extensions.client.ListChangesOption.REVIEWER_UPDATES; import static com.google.gerrit.extensions.client.ListChangesOption.SKIP_DIFFSTAT; import static com.google.gerrit.extensions.client.ListChangesOption.SUBMITTABLE; +import static com.google.gerrit.extensions.client.ListChangesOption.SUBMIT_REQUIREMENTS; import static com.google.gerrit.extensions.client.ListChangesOption.TRACKING_IDS; import static com.google.gerrit.server.ChangeMessagesUtil.createChangeMessageInfo; import static com.google.gerrit.server.util.AttentionSetUtil.additionsOnly; @@ -59,6 +60,8 @@ import com.google.gerrit.entities.RefNames; import com.google.gerrit.entities.SubmitRecord; import com.google.gerrit.entities.SubmitRecord.Status; +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementResult; import com.google.gerrit.entities.SubmitTypeRecord; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.FixInput; @@ -66,7 +69,6 @@ import com.google.gerrit.extensions.client.ReviewerState; import com.google.gerrit.extensions.common.AccountInfo; import com.google.gerrit.extensions.common.ApprovalInfo; -import com.google.gerrit.extensions.common.AttentionSetInfo; import com.google.gerrit.extensions.common.ChangeInfo; import com.google.gerrit.extensions.common.ChangeMessageInfo; import com.google.gerrit.extensions.common.LabelInfo; @@ -75,6 +77,8 @@ import com.google.gerrit.extensions.common.ProblemInfo; import com.google.gerrit.extensions.common.ReviewerUpdateInfo; import com.google.gerrit.extensions.common.RevisionInfo; +import com.google.gerrit.extensions.common.SubmitRecordInfo; +import com.google.gerrit.extensions.common.SubmitRequirementResultInfo; import com.google.gerrit.extensions.common.TrackingIdInfo; import com.google.gerrit.extensions.restapi.Url; import com.google.gerrit.index.RefState; @@ -92,8 +96,11 @@ import com.google.gerrit.server.StarredChangesUtil; import com.google.gerrit.server.account.AccountInfoComparator; import com.google.gerrit.server.account.AccountLoader; +import com.google.gerrit.server.cancellation.RequestCancelledException; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.config.TrackingFooters; +import com.google.gerrit.server.experiments.ExperimentFeatures; +import com.google.gerrit.server.experiments.ExperimentFeaturesConstants; import com.google.gerrit.server.index.change.ChangeField; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.notedb.ReviewerStateInternal; @@ -105,12 +112,12 @@ import com.google.gerrit.server.project.SubmitRuleOptions; import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.query.change.ChangeData.ChangedLines; +import com.google.gerrit.server.util.AttentionSetUtil; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.Singleton; import com.google.inject.assistedinject.Assisted; import java.io.IOException; -import java.sql.Timestamp; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; @@ -248,6 +255,7 @@ TrackingFooters trackingFooters, Metrics metrics, RevisionJson.Factory revisionJsonFactory, + ExperimentFeatures experimentFeatures, @GerritServerConfig Config cfg, @Assisted Iterable<ListChangesOption> options, @Assisted Optional<PluginDefinedInfosFactory> pluginDefinedInfosFactory) { @@ -266,7 +274,9 @@ this.revisionJson = revisionJsonFactory.create(options); this.options = Sets.immutableEnumSet(options); this.includeMergeable = MergeabilityComputationBehavior.fromConfig(cfg).includeInApi(); - this.lazyLoad = containsAnyOf(this.options, REQUIRE_LAZY_LOAD); + this.lazyLoad = + containsAnyOf(this.options, REQUIRE_LAZY_LOAD) + || lazyloadSubmitRequirements(this.options, experimentFeatures); this.pluginDefinedInfosFactory = pluginDefinedInfosFactory; logger.atFine().log("options = %s", options); @@ -362,11 +372,56 @@ return reqInfos; } + private Collection<SubmitRecordInfo> submitRecordsFor(ChangeData cd) { + List<SubmitRecordInfo> submitRecordInfos = new ArrayList<>(); + for (SubmitRecord record : cd.submitRecords(SUBMIT_RULE_OPTIONS_STRICT)) { + submitRecordInfos.add(submitRecordToInfo(record)); + } + return submitRecordInfos; + } + + private Collection<SubmitRequirementResultInfo> submitRequirementsFor(ChangeData cd) { + Collection<SubmitRequirementResultInfo> reqInfos = new ArrayList<>(); + Map<SubmitRequirement, SubmitRequirementResult> requirements = cd.submitRequirements(); + for (Map.Entry<SubmitRequirement, SubmitRequirementResult> entry : requirements.entrySet()) { + reqInfos.add(SubmitRequirementsJson.toInfo(entry.getKey(), entry.getValue())); + } + return reqInfos; + } + private static LegacySubmitRequirementInfo requirementToInfo( LegacySubmitRequirement req, Status status) { return new LegacySubmitRequirementInfo(status.name(), req.fallbackText(), req.type()); } + private SubmitRecordInfo submitRecordToInfo(SubmitRecord record) { + SubmitRecordInfo info = new SubmitRecordInfo(); + if (record.status != null) { + info.status = SubmitRecordInfo.Status.valueOf(record.status.name()); + } + info.ruleName = record.ruleName; + info.errorMessage = record.errorMessage; + if (record.labels != null) { + info.labels = new ArrayList<>(); + for (SubmitRecord.Label label : record.labels) { + SubmitRecordInfo.Label labelInfo = new SubmitRecordInfo.Label(); + labelInfo.label = label.label; + if (label.status != null) { + labelInfo.status = SubmitRecordInfo.Label.Status.valueOf(label.status.name()); + } + labelInfo.appliedBy = accountLoader.get(label.appliedBy); + info.labels.add(labelInfo); + } + } + if (record.requirements != null) { + info.requirements = new ArrayList<>(); + for (LegacySubmitRequirement requirement : record.requirements) { + info.requirements.add(requirementToInfo(requirement, record.status)); + } + } + return info; + } + private static void finish(ChangeInfo info) { info.id = Joiner.on('~') @@ -462,6 +517,11 @@ cache.put(Change.id(info._number), info); } } catch (RuntimeException e) { + Optional<RequestCancelledException> requestCancelledException = + RequestCancelledException.getFromCausalChain(e); + if (requestCancelledException.isPresent()) { + throw e; + } logger.atWarning().withCause(e).log( "Omitting corrupt change %s from results", cd.getId()); } @@ -549,11 +609,7 @@ .collect( toImmutableMap( a -> a.account().get(), - a -> - new AttentionSetInfo( - accountLoader.get(a.account()), - Timestamp.from(a.timestamp()), - a.reason()))); + a -> AttentionSetUtil.createAttentionSetInfo(a, accountLoader))); } out.assignee = in.getAssignee() != null ? accountLoader.get(in.getAssignee()) : null; out.hashtags = cd.hashtags(); @@ -612,6 +668,10 @@ out.labels = labelsJson.labelsFor(accountLoader, cd, has(LABELS), has(DETAILED_LABELS)); out.requirements = requirementsFor(cd); + out.submitRecords = submitRecordsFor(cd); + if (has(SUBMIT_REQUIREMENTS)) { + out.submitRequirements = submitRequirementsFor(cd); + } if (out.labels != null && has(DETAILED_LABELS)) { // If limited to specific patch sets but not the current patch set, don't @@ -883,4 +943,20 @@ } return ImmutableListMultimap.of(); } + + private static boolean lazyloadSubmitRequirements( + Set<ListChangesOption> changeOptions, ExperimentFeatures experimentFeatures) { + // TODO(ghareeb,hiesel): Remove this method. + // We are testing the new submit requirements with users in lieu of upgrading the change index + // to a version that supports the new requirements. + // Upgrading now, before the feature is finalized would be counter productive, because the index + // format might change while we iterate over the feature. + // Allowing changes to lazyload parameters will slow down dashboards for users who have this + // feature enabled, but will backfill submit requirements that weren't loaded from the index by + // simply computing them. + return changeOptions.contains(SUBMIT_REQUIREMENTS) + && experimentFeatures.isFeatureEnabled( + ExperimentFeaturesConstants + .GERRIT_BACKEND_REQUEST_FEATURE_ENABLE_SUBMIT_REQUIREMENTS_BACKFILLING_ON_DASHBOARD); + } }
diff --git a/java/com/google/gerrit/server/change/ChangeMessages.java b/java/com/google/gerrit/server/change/ChangeMessages.java index 6f2e1ef..787f036 100644 --- a/java/com/google/gerrit/server/change/ChangeMessages.java +++ b/java/com/google/gerrit/server/change/ChangeMessages.java
@@ -31,6 +31,7 @@ public String reviewerInvalid; public String reviewerNotFoundUserOrGroup; + public String groupRemovalIsNotAllowed; public String groupIsNotAllowed; public String groupHasTooManyMembers; public String groupManyMembersConfirmation;
diff --git a/java/com/google/gerrit/server/change/ChangeResource.java b/java/com/google/gerrit/server/change/ChangeResource.java index 3729b59..970f1b5 100644 --- a/java/com/google/gerrit/server/change/ChangeResource.java +++ b/java/com/google/gerrit/server/change/ChangeResource.java
@@ -30,12 +30,12 @@ import com.google.gerrit.extensions.restapi.RestResource; import com.google.gerrit.extensions.restapi.RestResource.HasETag; import com.google.gerrit.extensions.restapi.RestView; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.PatchSetUtil; import com.google.gerrit.server.StarredChangesUtil; import com.google.gerrit.server.account.AccountCache; import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.TraceContext; import com.google.gerrit.server.logging.TraceContext.TraceTimer; @@ -140,7 +140,7 @@ return changeData.getId(); } - /** @return true if {@link #getUser()} is the change's owner. */ + /** Returns true if {@link #getUser()} is the change's owner. */ public boolean isUserOwner() { Account.Id owner = getChange().getOwner(); return user.isIdentifiedUser() && user.asIdentifiedUser().getAccountId().equals(owner); @@ -167,7 +167,6 @@ public void prepareETag(Hasher h, CurrentUser user) { h.putInt(JSON_FORMAT_VERSION) .putLong(getChange().getLastUpdatedOn().getTime()) - .putInt(getChange().getRowVersion()) .putInt(user.isIdentifiedUser() ? user.getAccountId().get() : 0); if (user.isIdentifiedUser()) {
diff --git a/java/com/google/gerrit/server/change/DeleteChangeOp.java b/java/com/google/gerrit/server/change/DeleteChangeOp.java index 14298d5..c7ddf19 100644 --- a/java/com/google/gerrit/server/change/DeleteChangeOp.java +++ b/java/com/google/gerrit/server/change/DeleteChangeOp.java
@@ -27,6 +27,7 @@ import com.google.gerrit.server.StarredChangesUtil; import com.google.gerrit.server.extensions.events.ChangeDeleted; import com.google.gerrit.server.plugincontext.PluginItemContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; import com.google.gerrit.server.update.RepoContext; @@ -49,6 +50,7 @@ private final PatchSetUtil psUtil; private final StarredChangesUtil starredChangesUtil; private final PluginItemContext<AccountPatchReviewStore> accountPatchReviewStore; + private final ChangeData.Factory changeDataFactory; private final ChangeDeleted changeDeleted; private final Change.Id id; @@ -57,11 +59,13 @@ PatchSetUtil psUtil, StarredChangesUtil starredChangesUtil, PluginItemContext<AccountPatchReviewStore> accountPatchReviewStore, + ChangeData.Factory changeDataFactory, ChangeDeleted changeDeleted, @Assisted Change.Id id) { this.psUtil = psUtil; this.starredChangesUtil = starredChangesUtil; this.accountPatchReviewStore = accountPatchReviewStore; + this.changeDataFactory = changeDataFactory; this.changeDeleted = changeDeleted; this.id = id; } @@ -90,7 +94,7 @@ .map(p -> p.commitId().name()) .orElse("n/a"))); ctx.deleteChange(); - changeDeleted.fire(ctx.getChange(), ctx.getAccount(), ctx.getWhen()); + changeDeleted.fire(changeDataFactory.create(ctx.getChange()), ctx.getAccount(), ctx.getWhen()); return true; }
diff --git a/java/com/google/gerrit/server/change/DeleteReviewerByEmailOp.java b/java/com/google/gerrit/server/change/DeleteReviewerByEmailOp.java index 255e13a..b512a2d 100644 --- a/java/com/google/gerrit/server/change/DeleteReviewerByEmailOp.java +++ b/java/com/google/gerrit/server/change/DeleteReviewerByEmailOp.java
@@ -17,19 +17,18 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Address; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.PatchSet; -import com.google.gerrit.server.ChangeUtil; +import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.mail.send.DeleteReviewerSender; import com.google.gerrit.server.mail.send.MessageIdGenerator; -import com.google.gerrit.server.update.BatchUpdateOp; +import com.google.gerrit.server.notedb.ChangeUpdate; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; import java.util.Collections; -public class DeleteReviewerByEmailOp implements BatchUpdateOp { +public class DeleteReviewerByEmailOp extends ReviewerOp { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); public interface Factory { @@ -38,19 +37,21 @@ private final DeleteReviewerSender.Factory deleteReviewerSenderFactory; private final MessageIdGenerator messageIdGenerator; + private final ChangeMessagesUtil changeMessagesUtil; private final Address reviewer; - - private ChangeMessage changeMessage; + private String mailMessage; private Change change; @Inject DeleteReviewerByEmailOp( DeleteReviewerSender.Factory deleteReviewerSenderFactory, MessageIdGenerator messageIdGenerator, + ChangeMessagesUtil changeMessagesUtil, @Assisted Address reviewer) { this.deleteReviewerSenderFactory = deleteReviewerSenderFactory; this.messageIdGenerator = messageIdGenerator; + this.changeMessagesUtil = changeMessagesUtil; this.reviewer = reviewer; } @@ -58,38 +59,38 @@ public boolean updateChange(ChangeContext ctx) { change = ctx.getChange(); PatchSet.Id psId = ctx.getChange().currentPatchSetId(); + ChangeUpdate update = ctx.getUpdate(psId); + update.removeReviewerByEmail(reviewer); + // The reviewer is not a registered Gerrit user, thus the email address can be used in + // ChangeMessage without replacement (it does not classify as Gerrit user identifiable + // information). String msg = "Removed reviewer " + reviewer; - changeMessage = - new ChangeMessage( - ChangeMessage.key(change.getId(), ChangeUtil.messageUuid()), - ctx.getAccountId(), - ctx.getWhen(), - psId); - changeMessage.setMessage(msg); - - ctx.getUpdate(psId).setChangeMessage(msg); - ctx.getUpdate(psId).removeReviewerByEmail(reviewer); + mailMessage = + changeMessagesUtil.setChangeMessage(ctx, msg, ChangeMessagesUtil.TAG_DELETE_REVIEWER); return true; } @Override - public void postUpdate(Context ctx) { - try { - NotifyResolver.Result notify = ctx.getNotify(change.getId()); - if (!notify.shouldNotify()) { - return; + public void postUpdate(PostUpdateContext ctx) { + opResult = Result.builder().setDeletedReviewerByEmail(reviewer).build(); + if (sendEmail) { + try { + NotifyResolver.Result notify = ctx.getNotify(change.getId()); + if (!notify.shouldNotify()) { + return; + } + DeleteReviewerSender emailSender = + deleteReviewerSenderFactory.create(ctx.getProject(), change.getId()); + emailSender.setFrom(ctx.getAccountId()); + emailSender.addReviewersByEmail(Collections.singleton(reviewer)); + emailSender.setChangeMessage(mailMessage, ctx.getWhen()); + emailSender.setNotify(notify); + emailSender.setMessageId( + messageIdGenerator.fromChangeUpdate(ctx.getRepoView(), change.currentPatchSetId())); + emailSender.send(); + } catch (Exception err) { + logger.atSevere().withCause(err).log("Cannot email update for change %s", change.getId()); } - DeleteReviewerSender emailSender = - deleteReviewerSenderFactory.create(ctx.getProject(), change.getId()); - emailSender.setFrom(ctx.getAccountId()); - emailSender.addReviewersByEmail(Collections.singleton(reviewer)); - emailSender.setChangeMessage(changeMessage.getMessage(), changeMessage.getWrittenOn()); - emailSender.setNotify(notify); - emailSender.setMessageId( - messageIdGenerator.fromChangeUpdate(ctx.getRepoView(), change.currentPatchSetId())); - emailSender.send(); - } catch (Exception err) { - logger.atSevere().withCause(err).log("Cannot email update for change %s", change.getId()); } } }
diff --git a/java/com/google/gerrit/server/change/DeleteReviewerOp.java b/java/com/google/gerrit/server/change/DeleteReviewerOp.java index bf00d27..1e40429 100644 --- a/java/com/google/gerrit/server/change/DeleteReviewerOp.java +++ b/java/com/google/gerrit/server/change/DeleteReviewerOp.java
@@ -20,10 +20,8 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.LabelType; import com.google.gerrit.entities.LabelTypes; -import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.Project; import com.google.gerrit.exceptions.EmailException; @@ -31,11 +29,12 @@ import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.extensions.restapi.ResourceNotFoundException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.PatchSetUtil; +import com.google.gerrit.server.account.AccountCache; import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.extensions.events.ReviewerDeleted; import com.google.gerrit.server.mail.send.DeleteReviewerSender; import com.google.gerrit.server.mail.send.MessageIdGenerator; @@ -44,42 +43,42 @@ import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.project.RemoveReviewerControl; -import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RepoView; +import com.google.gerrit.server.util.AccountTemplateUtil; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.assistedinject.Assisted; import java.io.IOException; +import java.sql.Timestamp; import java.util.Collections; import java.util.HashMap; import java.util.Map; -public class DeleteReviewerOp implements BatchUpdateOp { +public class DeleteReviewerOp extends ReviewerOp { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); public interface Factory { - DeleteReviewerOp create(AccountState reviewerAccount, DeleteReviewerInput input); + DeleteReviewerOp create(Account reviewerAccount, DeleteReviewerInput input); } private final ApprovalsUtil approvalsUtil; private final PatchSetUtil psUtil; private final ChangeMessagesUtil cmUtil; - private final IdentifiedUser.GenericFactory userFactory; private final ReviewerDeleted reviewerDeleted; private final Provider<IdentifiedUser> user; private final DeleteReviewerSender.Factory deleteReviewerSenderFactory; private final RemoveReviewerControl removeReviewerControl; private final ProjectCache projectCache; private final MessageIdGenerator messageIdGenerator; + private final AccountCache accountCache; - private final AccountState reviewer; + private final Account reviewer; private final DeleteReviewerInput input; - ChangeMessage changeMessage; + String mailMessage; Change currChange; - PatchSet currPs; Map<String, Short> newApprovals = new HashMap<>(); Map<String, Short> oldApprovals = new HashMap<>(); @@ -88,25 +87,25 @@ ApprovalsUtil approvalsUtil, PatchSetUtil psUtil, ChangeMessagesUtil cmUtil, - IdentifiedUser.GenericFactory userFactory, ReviewerDeleted reviewerDeleted, Provider<IdentifiedUser> user, DeleteReviewerSender.Factory deleteReviewerSenderFactory, RemoveReviewerControl removeReviewerControl, ProjectCache projectCache, MessageIdGenerator messageIdGenerator, - @Assisted AccountState reviewerAccount, + AccountCache accountCache, + @Assisted Account reviewerAccount, @Assisted DeleteReviewerInput input) { this.approvalsUtil = approvalsUtil; this.psUtil = psUtil; this.cmUtil = cmUtil; - this.userFactory = userFactory; this.reviewerDeleted = reviewerDeleted; this.user = user; this.deleteReviewerSenderFactory = deleteReviewerSenderFactory; this.removeReviewerControl = removeReviewerControl; this.projectCache = projectCache; this.messageIdGenerator = messageIdGenerator; + this.accountCache = accountCache; this.reviewer = reviewerAccount; this.input = input; } @@ -114,15 +113,18 @@ @Override public boolean updateChange(ChangeContext ctx) throws AuthException, ResourceNotFoundException, PermissionBackendException, IOException { - Account.Id reviewerId = reviewer.account().id(); + Account.Id reviewerId = reviewer.id(); // Check of removing this reviewer (even if there is no vote processed by the loop below) is OK removeReviewerControl.checkRemoveReviewer(ctx.getNotes(), ctx.getUser(), reviewerId); if (!approvalsUtil.getReviewers(ctx.getNotes()).all().contains(reviewerId)) { - throw new ResourceNotFoundException(); + throw new ResourceNotFoundException( + String.format( + "Reviewer %s doesn't exist in the change, hence can't delete it", + reviewer.getName())); } currChange = ctx.getChange(); - currPs = psUtil.current(ctx.getNotes()); + setPatchSet(psUtil.current(ctx.getNotes())); LabelTypes labelTypes = projectCache @@ -141,21 +143,23 @@ ? "cc" : "reviewer"; StringBuilder msg = new StringBuilder(); - msg.append(String.format("Removed %s %s", ccOrReviewer, reviewer.account().fullName())); + msg.append( + String.format( + "Removed %s %s", ccOrReviewer, AccountTemplateUtil.getAccountTemplate(reviewer.id()))); StringBuilder removedVotesMsg = new StringBuilder(); removedVotesMsg.append(" with the following votes:\n\n"); boolean votesRemoved = false; for (PatchSetApproval a : approvals(ctx, reviewerId)) { // Check if removing this vote is OK removeReviewerControl.checkRemoveReviewer(ctx.getNotes(), ctx.getUser(), a); - if (a.patchSetId().equals(currPs.id()) && a.value() != 0) { + if (a.patchSetId().equals(patchSet.id()) && a.value() != 0) { oldApprovals.put(a.label(), a.value()); removedVotesMsg .append("* ") .append(a.label()) .append(formatLabelValue(a.value())) .append(" by ") - .append(userFactory.create(a.accountId()).getNameEmail()) + .append(AccountTemplateUtil.getAccountTemplate(a.accountId())) .append("\n"); votesRemoved = true; } @@ -166,44 +170,55 @@ } else { msg.append("."); } - ChangeUpdate update = ctx.getUpdate(currPs.id()); + ChangeUpdate update = ctx.getUpdate(patchSet.id()); update.removeReviewer(reviewerId); - changeMessage = - ChangeMessagesUtil.newMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_DELETE_REVIEWER); - cmUtil.addChangeMessage(update, changeMessage); - + mailMessage = + cmUtil.setChangeMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_DELETE_REVIEWER); return true; } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { + opResult = Result.builder().setDeletedReviewer(reviewer.id()).build(); + NotifyResolver.Result notify = ctx.getNotify(currChange.getId()); - if (input.notify == null - && currChange.isWorkInProgress() - && !oldApprovals.isEmpty() - && notify.handling().compareTo(NotifyHandling.OWNER) < 0) { - // Override NotifyHandling from the context to notify owner if votes were removed on a WIP - // change. - notify = notify.withHandling(NotifyHandling.OWNER); - } - try { - if (notify.shouldNotify()) { - emailReviewers(ctx.getProject(), currChange, changeMessage, notify, ctx.getRepoView()); + if (sendEmail) { + if (input.notify == null + && currChange.isWorkInProgress() + && !oldApprovals.isEmpty() + && notify.handling().compareTo(NotifyHandling.OWNER) < 0) { + // Override NotifyHandling from the context to notify owner if votes were removed on a WIP + // change. + notify = notify.withHandling(NotifyHandling.OWNER); } - } catch (Exception err) { - logger.atSevere().withCause(err).log("Cannot email update for change %s", currChange.getId()); + try { + if (notify.shouldNotify()) { + emailReviewers( + ctx.getProject(), currChange, mailMessage, ctx.getWhen(), notify, ctx.getRepoView()); + } + } catch (Exception err) { + logger.atSevere().withCause(err).log( + "Cannot email update for change %s", currChange.getId()); + } } - reviewerDeleted.fire( - currChange, - currPs, - reviewer, - ctx.getAccount(), - changeMessage.getMessage(), - newApprovals, - oldApprovals, - notify.handling(), - ctx.getWhen()); + + NotifyHandling notifyHandling = notify.handling(); + eventSender = + () -> + reviewerDeleted.fire( + ctx.getChangeData(currChange), + patchSet, + accountCache.get(reviewer.id()).orElse(AccountState.forAccount(reviewer)), + ctx.getAccount(), + mailMessage, + newApprovals, + oldApprovals, + notifyHandling, + ctx.getWhen()); + if (sendEvent) { + sendEvent(); + } } private Iterable<PatchSetApproval> approvals(ChangeContext ctx, Account.Id accountId) { @@ -222,20 +237,21 @@ private void emailReviewers( Project.NameKey projectName, Change change, - ChangeMessage changeMessage, + String mailMessage, + Timestamp timestamp, NotifyResolver.Result notify, RepoView repoView) throws EmailException { Account.Id userId = user.get().getAccountId(); - if (userId.equals(reviewer.account().id())) { + if (userId.equals(reviewer.id())) { // The user knows they removed themselves, don't bother emailing them. return; } DeleteReviewerSender emailSender = deleteReviewerSenderFactory.create(projectName, change.getId()); emailSender.setFrom(userId); - emailSender.addReviewers(Collections.singleton(reviewer.account().id())); - emailSender.setChangeMessage(changeMessage.getMessage(), changeMessage.getWrittenOn()); + emailSender.addReviewers(Collections.singleton(reviewer.id())); + emailSender.setChangeMessage(mailMessage, timestamp); emailSender.setNotify(notify); emailSender.setMessageId( messageIdGenerator.fromChangeUpdate(repoView, change.currentPatchSetId()));
diff --git a/java/com/google/gerrit/server/change/DeleteReviewersUtil.java b/java/com/google/gerrit/server/change/DeleteReviewersUtil.java new file mode 100644 index 0000000..79ed043 --- /dev/null +++ b/java/com/google/gerrit/server/change/DeleteReviewersUtil.java
@@ -0,0 +1,84 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.change; + +import com.google.gerrit.entities.Account; +import com.google.gerrit.entities.Address; +import com.google.gerrit.extensions.api.changes.DeleteReviewerInput; +import com.google.gerrit.extensions.api.changes.ReviewerInput; +import com.google.gerrit.extensions.restapi.AuthException; +import com.google.gerrit.extensions.restapi.ResourceNotFoundException; +import com.google.gerrit.server.account.AccountResolver; +import com.google.gerrit.server.approval.ApprovalsUtil; +import com.google.gerrit.server.notedb.ChangeNotes; +import com.google.gerrit.server.update.BatchUpdate; +import com.google.inject.Inject; +import java.io.IOException; +import java.util.Collection; +import org.eclipse.jgit.errors.ConfigInvalidException; + +public class DeleteReviewersUtil { + private final DeleteReviewerOp.Factory deleteReviewerOpFactory; + private final DeleteReviewerByEmailOp.Factory deleteReviewerByEmailOpFactory; + private final AccountResolver accountResolver; + private final ApprovalsUtil approvalsUtil; + + @Inject + DeleteReviewersUtil( + DeleteReviewerOp.Factory deleteReviewerOpFactory, + DeleteReviewerByEmailOp.Factory deleteReviewerByEmailOpFactory, + AccountResolver accountResolver, + ApprovalsUtil approvalsUtil) { + this.deleteReviewerOpFactory = deleteReviewerOpFactory; + this.deleteReviewerByEmailOpFactory = deleteReviewerByEmailOpFactory; + this.accountResolver = accountResolver; + this.approvalsUtil = approvalsUtil; + } + + public void addDeleteReviewerOpToBatchUpdate( + BatchUpdate batchUpdate, ChangeNotes changeNotes, ReviewerInput reviewerInput) + throws IOException, ConfigInvalidException, AuthException, ResourceNotFoundException { + + try { + AccountResolver.Result result = + accountResolver.resolveIgnoreVisibility(reviewerInput.reviewer); + if (fetchAccountIds(changeNotes).contains(result.asUniqueUser().getAccountId())) { + DeleteReviewerInput deleteReviewerInput = new DeleteReviewerInput(); + deleteReviewerInput.notify = reviewerInput.notify; + deleteReviewerInput.notifyDetails = reviewerInput.notifyDetails; + batchUpdate.addOp( + changeNotes.getChangeId(), + deleteReviewerOpFactory.create(result.asUnique().account(), deleteReviewerInput)); + return; + } + return; + } catch (AccountResolver.UnresolvableAccountException e) { + if (e.isSelf()) { + throw new AuthException(e.getMessage(), e); + } + } + Address address = Address.tryParse(reviewerInput.reviewer); + if (address != null && changeNotes.getReviewersByEmail().all().contains(address)) { + batchUpdate.addOp(changeNotes.getChangeId(), deleteReviewerByEmailOpFactory.create(address)); + return; + } + + throw new ResourceNotFoundException(reviewerInput.reviewer); + } + + private Collection<Account.Id> fetchAccountIds(ChangeNotes changeNotes) { + return approvalsUtil.getReviewers(changeNotes).all(); + } +}
diff --git a/java/com/google/gerrit/server/change/EmailReviewComments.java b/java/com/google/gerrit/server/change/EmailReviewComments.java index cacfbe7..3c7ea44 100644 --- a/java/com/google/gerrit/server/change/EmailReviewComments.java +++ b/java/com/google/gerrit/server/change/EmailReviewComments.java
@@ -18,7 +18,6 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.Comment; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.server.CurrentUser; @@ -34,6 +33,7 @@ import com.google.gerrit.server.util.ThreadLocalRequestContext; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; +import java.sql.Timestamp; import java.util.List; import java.util.concurrent.ExecutorService; import java.util.concurrent.Future; @@ -45,28 +45,30 @@ // TODO(dborowitz/wyatta): Rationalize these arguments so HTML and text templates are operating // on the same set of inputs. /** + * Creates handle for sending email + * * @param notify setting for handling notification. * @param notes change notes. * @param patchSet patch set corresponding to the top-level op * @param user user the email should come from. - * @param message used by text template only: the full ChangeMessage that will go in the - * database. The contents of this message typically include the "Patch set N" header and "(M - * comments)". + * @param message used by text template only. The contents of this message typically include the + * "Patch set N" header and "(M comments)". + * @param timestamp timestamp when the comments were added. * @param comments inline comments. * @param patchSetComment used by HTML template only: some quasi-human-generated text. The * contents should *not* include a "Patch set N" header or "(M comments)" footer, as these * will be added automatically in soy in a structured way. * @param labels labels applied as part of this review operation. - * @return handle for sending email. */ EmailReviewComments create( NotifyResolver.Result notify, ChangeNotes notes, PatchSet patchSet, IdentifiedUser user, - ChangeMessage message, + @Assisted("message") String message, + Timestamp timestamp, List<? extends Comment> comments, - String patchSetComment, + @Assisted("patchSetComment") String patchSetComment, List<LabelVote> labels, RepoView repoView); } @@ -81,7 +83,8 @@ private final ChangeNotes notes; private final PatchSet patchSet; private final IdentifiedUser user; - private final ChangeMessage message; + private final String message; + private final Timestamp timestamp; private final List<? extends Comment> comments; private final String patchSetComment; private final List<LabelVote> labels; @@ -98,9 +101,10 @@ @Assisted ChangeNotes notes, @Assisted PatchSet patchSet, @Assisted IdentifiedUser user, - @Assisted ChangeMessage message, + @Assisted("message") String message, + @Assisted Timestamp timestamp, @Assisted List<? extends Comment> comments, - @Nullable @Assisted String patchSetComment, + @Nullable @Assisted("patchSetComment") String patchSetComment, @Assisted List<LabelVote> labels, @Assisted RepoView repoView) { this.sendEmailsExecutor = executor; @@ -113,6 +117,7 @@ this.patchSet = patchSet; this.user = user; this.message = message; + this.timestamp = timestamp; this.comments = COMMENT_ORDER.sortedCopy(comments); this.patchSetComment = patchSetComment; this.labels = labels; @@ -132,7 +137,7 @@ commentSenderFactory.create(notes.getProjectName(), notes.getChangeId()); emailSender.setFrom(user.getAccountId()); emailSender.setPatchSet(patchSet, patchSetInfoFactory.get(notes.getProjectName(), patchSet)); - emailSender.setChangeMessage(message.getMessage(), message.getWrittenOn()); + emailSender.setChangeMessage(message, timestamp); emailSender.setComments(comments); emailSender.setPatchSetComment(patchSetComment); emailSender.setLabels(labels);
diff --git a/java/com/google/gerrit/server/change/FileContentUtil.java b/java/com/google/gerrit/server/change/FileContentUtil.java index 49c1fe2..c54b902 100644 --- a/java/com/google/gerrit/server/change/FileContentUtil.java +++ b/java/com/google/gerrit/server/change/FileContentUtil.java
@@ -76,8 +76,6 @@ * @param parent A 1-based parent index to get the content from instead. Null if the content * should be obtained from {@code revstr} instead. * @return Content of the file as {@code BinaryResult}. - * @throws ResourceNotFoundException - * @throws IOException */ public BinaryResult getContent( ProjectState project, ObjectId revstr, String path, @Nullable Integer parent)
diff --git a/java/com/google/gerrit/server/change/FileInfoJson.java b/java/com/google/gerrit/server/change/FileInfoJson.java index ad6f9c7..ab557dc 100644 --- a/java/com/google/gerrit/server/change/FileInfoJson.java +++ b/java/com/google/gerrit/server/change/FileInfoJson.java
@@ -46,7 +46,8 @@ * * @param change a Gerrit change. * @param objectId a commit SHA-1 identifying a patchset commit. - * @param parentNum an integer identifying the parent number used for comparison. + * @param parentNum 1-based integer identifying the parent number used for comparison. If zero, + * the only parent will be used or the auto-merge if {@code newCommit} is a merge commit. * @return a mapping of the file paths to their related diff information. */ default Map<String, FileInfo> getFileInfoMap(Change change, ObjectId objectId, int parentNum) @@ -74,7 +75,8 @@ * * @param project a project identifying a repository. * @param objectId a commit SHA-1 identifying a patchset commit. - * @param parentNum an integer identifying the parent number used for comparison. + * @param parentNum 1-based integer identifying the parent number used for comparison. If zero, + * the only parent will be used or the auto-merge if {@code newCommit} is a merge commit. * @return a mapping of the file paths to their related diff information. */ Map<String, FileInfo> getFileInfoMap(Project.NameKey project, ObjectId objectId, int parentNum)
diff --git a/java/com/google/gerrit/server/change/FileInfoJsonComparingImpl.java b/java/com/google/gerrit/server/change/FileInfoJsonComparingImpl.java deleted file mode 100644 index 228d631..0000000 --- a/java/com/google/gerrit/server/change/FileInfoJsonComparingImpl.java +++ /dev/null
@@ -1,160 +0,0 @@ -// Copyright (C) 2021 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.change; - -import com.google.common.annotations.VisibleForTesting; -import com.google.common.flogger.FluentLogger; -import com.google.gerrit.common.Nullable; -import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.PatchSet; -import com.google.gerrit.entities.Project; -import com.google.gerrit.extensions.common.FileInfo; -import com.google.gerrit.extensions.restapi.ResourceConflictException; -import com.google.gerrit.metrics.Counter1; -import com.google.gerrit.metrics.Description; -import com.google.gerrit.metrics.Field; -import com.google.gerrit.metrics.MetricMaker; -import com.google.gerrit.server.logging.Metadata; -import com.google.gerrit.server.patch.DiffExecutor; -import com.google.gerrit.server.patch.PatchListNotAvailableException; -import com.google.inject.Inject; -import com.google.inject.Singleton; -import java.util.Map; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Future; -import org.eclipse.jgit.lib.ObjectId; - -/** - * Implementation of FileInfoJson which uses {@link FileInfoJsonOldImpl}, but also runs {@link - * FileInfoJsonNewImpl} asynchronously and compares the results. This implementation is temporary - * and will be used to verify that the results are the same. - */ -public class FileInfoJsonComparingImpl implements FileInfoJson { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - private final FileInfoJsonOldImpl oldImpl; - private final FileInfoJsonNewImpl newImpl; - private final ExecutorService executor; - private final Metrics metrics; - - /** - * TODO(ghareeb): These metrics are temporary for launching the new diff cache redesign and are - * not documented. These will be removed soon. - */ - @VisibleForTesting - @Singleton - static class Metrics { - private enum Status { - MATCH, - MISMATCH, - ERROR - } - - final Counter1<Status> diffs; - - @Inject - Metrics(MetricMaker metricMaker) { - diffs = - metricMaker.newCounter( - "diff/list_files/dark_launch", - new Description( - "Total number of matching, non-matching, or error in list-files diffs in the old and new diff cache implementations.") - .setRate() - .setUnit("count"), - Field.ofEnum(Status.class, "type", Metadata.Builder::eventType).build()); - } - } - - @Inject - public FileInfoJsonComparingImpl( - FileInfoJsonOldImpl oldImpl, - FileInfoJsonNewImpl newImpl, - @DiffExecutor ExecutorService executor, - Metrics metrics) { - this.oldImpl = oldImpl; - this.newImpl = newImpl; - this.executor = executor; - this.metrics = metrics; - } - - @Override - public Map<String, FileInfo> getFileInfoMap( - Change change, ObjectId objectId, @Nullable PatchSet base) - throws ResourceConflictException, PatchListNotAvailableException { - Map<String, FileInfo> result = oldImpl.getFileInfoMap(change, objectId, base); - @SuppressWarnings("unused") - Future<?> ignored = - executor.submit( - () -> { - try { - Map<String, FileInfo> fileInfoNew = newImpl.getFileInfoMap(change, objectId, base); - compareAndLogMetrics( - result, - fileInfoNew, - String.format( - "Mismatch comparing old and new diff implementations for change: %s, objectId: %s and base: %s", - change, objectId, base == null ? "none" : base.id())); - } catch (ResourceConflictException | PatchListNotAvailableException e) { - // If an exception happens while evaluating the new diff, increment the non-matching - // counter - metrics.diffs.increment(Metrics.Status.ERROR); - logger.atWarning().withCause(e).log( - "Error comparing old and new diff implementations."); - } - }); - return result; - } - - @Override - public Map<String, FileInfo> getFileInfoMap( - Project.NameKey project, ObjectId objectId, int parentNum) - throws ResourceConflictException, PatchListNotAvailableException { - Map<String, FileInfo> result = oldImpl.getFileInfoMap(project, objectId, parentNum); - @SuppressWarnings("unused") - Future<?> ignored = - executor.submit( - () -> { - try { - Map<String, FileInfo> resultNew = - newImpl.getFileInfoMap(project, objectId, parentNum); - compareAndLogMetrics( - result, - resultNew, - String.format( - "Mismatch comparing old and new diff implementations for project: %s, objectId: %s and parentNum: %d", - project, objectId, parentNum)); - } catch (ResourceConflictException | PatchListNotAvailableException e) { - // If an exception happens while evaluating the new diff, increment the non-matching - // ctr - metrics.diffs.increment(Metrics.Status.ERROR); - logger.atWarning().withCause(e).log( - "Error comparing old and new diff implementations."); - } - }); - return result; - } - - private void compareAndLogMetrics( - Map<String, FileInfo> fileInfoMapOld, - Map<String, FileInfo> fileInfoMapNew, - String warningMessage) { - if (fileInfoMapOld.equals(fileInfoMapNew)) { - metrics.diffs.increment(Metrics.Status.MATCH); - return; - } - metrics.diffs.increment(Metrics.Status.MISMATCH); - logger.atWarning().log(warningMessage); - } -}
diff --git a/java/com/google/gerrit/server/change/FileInfoJsonNewImpl.java b/java/com/google/gerrit/server/change/FileInfoJsonImpl.java similarity index 89% rename from java/com/google/gerrit/server/change/FileInfoJsonNewImpl.java rename to java/com/google/gerrit/server/change/FileInfoJsonImpl.java index 1ca2c93..b729c11 100644 --- a/java/com/google/gerrit/server/change/FileInfoJsonNewImpl.java +++ b/java/com/google/gerrit/server/change/FileInfoJsonImpl.java
@@ -32,12 +32,12 @@ import org.eclipse.jgit.errors.NoMergeBaseException; import org.eclipse.jgit.lib.ObjectId; -/** Implementation of {@link FileInfoJson} using the new diff cache {@link DiffOperations}. */ -public class FileInfoJsonNewImpl implements FileInfoJson { +/** Implementation of {@link FileInfoJson} using {@link DiffOperations}. */ +public class FileInfoJsonImpl implements FileInfoJson { private final DiffOperations diffs; @Inject - FileInfoJsonNewImpl(DiffOperations diffOperations) { + FileInfoJsonImpl(DiffOperations diffOperations) { this.diffs = diffOperations; } @@ -47,8 +47,11 @@ throws ResourceConflictException, PatchListNotAvailableException { try { if (base == null) { + // Setting parentNum=0 requests the default parent, which is the only parent for + // single-parent commits, or the auto-merge otherwise return asFileInfo( - diffs.listModifiedFilesAgainstParent(change.getProject(), objectId, null)); + diffs.listModifiedFilesAgainstParent( + change.getProject(), objectId, /* parentNum= */ 0)); } return asFileInfo(diffs.listModifiedFiles(change.getProject(), base.commitId(), objectId)); } catch (DiffNotAvailableException e) { @@ -63,7 +66,7 @@ throws ResourceConflictException, PatchListNotAvailableException { try { Map<String, FileDiffOutput> modifiedFiles = - diffs.listModifiedFilesAgainstParent(project, objectId, parent + 1); + diffs.listModifiedFilesAgainstParent(project, objectId, parent); return asFileInfo(modifiedFiles); } catch (DiffNotAvailableException e) { convertException(e);
diff --git a/java/com/google/gerrit/server/change/FileInfoJsonModule.java b/java/com/google/gerrit/server/change/FileInfoJsonModule.java index de116bb..b8e05f0 100644 --- a/java/com/google/gerrit/server/change/FileInfoJsonModule.java +++ b/java/com/google/gerrit/server/change/FileInfoJsonModule.java
@@ -14,31 +14,12 @@ package com.google.gerrit.server.change; -import com.google.gerrit.server.config.GerritServerConfig; import com.google.inject.AbstractModule; -import org.eclipse.jgit.lib.Config; public class FileInfoJsonModule extends AbstractModule { - /** Use the new diff cache implementation {@link FileInfoJsonNewImpl}. */ - private final boolean useNewDiffCache; - - /** Used to dark launch the new diff cache with the list files endpoint. */ - private final boolean runNewDiffCacheAsync; - - public FileInfoJsonModule(@GerritServerConfig Config cfg) { - this.useNewDiffCache = - cfg.getBoolean("cache", "diff_cache", "runNewDiffCache_ListFiles", false); - this.runNewDiffCacheAsync = - cfg.getBoolean("cache", "diff_cache", "runNewDiffCacheAsync_listFiles", false); - } @Override public void configure() { - if (runNewDiffCacheAsync) { - bind(FileInfoJson.class).to(FileInfoJsonComparingImpl.class); - return; - } - bind(FileInfoJson.class) - .to(useNewDiffCache ? FileInfoJsonNewImpl.class : FileInfoJsonOldImpl.class); + bind(FileInfoJson.class).to(FileInfoJsonImpl.class); } }
diff --git a/java/com/google/gerrit/server/change/FileInfoJsonOldImpl.java b/java/com/google/gerrit/server/change/FileInfoJsonOldImpl.java deleted file mode 100644 index 55d162a..0000000 --- a/java/com/google/gerrit/server/change/FileInfoJsonOldImpl.java +++ /dev/null
@@ -1,128 +0,0 @@ -// Copyright (C) 2021 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.change; - -import com.google.gerrit.common.Nullable; -import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.Patch; -import com.google.gerrit.entities.PatchSet; -import com.google.gerrit.entities.Project; -import com.google.gerrit.extensions.client.DiffPreferencesInfo; -import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; -import com.google.gerrit.extensions.common.FileInfo; -import com.google.gerrit.extensions.restapi.ResourceConflictException; -import com.google.gerrit.server.patch.PatchList; -import com.google.gerrit.server.patch.PatchListCache; -import com.google.gerrit.server.patch.PatchListEntry; -import com.google.gerrit.server.patch.PatchListKey; -import com.google.gerrit.server.patch.PatchListNotAvailableException; -import com.google.inject.Inject; -import com.google.inject.Singleton; -import java.util.Map; -import java.util.TreeMap; -import java.util.concurrent.ExecutionException; -import org.eclipse.jgit.errors.NoMergeBaseException; -import org.eclipse.jgit.lib.ObjectId; - -/** Implementation of {@link FileInfoJson} using the old diff cache {@link PatchListCache}. */ -@Deprecated -@Singleton -class FileInfoJsonOldImpl implements FileInfoJson { - private final PatchListCache patchListCache; - - @Inject - FileInfoJsonOldImpl(PatchListCache patchListCache) { - this.patchListCache = patchListCache; - } - - @Override - public Map<String, FileInfo> getFileInfoMap( - Change change, ObjectId objectId, @Nullable PatchSet base) - throws ResourceConflictException, PatchListNotAvailableException { - ObjectId a = base != null ? base.commitId() : null; - return toFileInfoMap(change, PatchListKey.againstCommit(a, objectId, Whitespace.IGNORE_NONE)); - } - - @Override - public Map<String, FileInfo> getFileInfoMap( - Project.NameKey project, ObjectId objectId, int parentNum) - throws ResourceConflictException, PatchListNotAvailableException { - PatchListKey key = - parentNum == -1 - ? PatchListKey.againstDefaultBase(objectId, Whitespace.IGNORE_NONE) - : PatchListKey.againstParentNum( - parentNum + 1, objectId, DiffPreferencesInfo.Whitespace.IGNORE_NONE); - return toFileInfoMap(project, key); - } - - private Map<String, FileInfo> toFileInfoMap(Change change, PatchListKey key) - throws ResourceConflictException, PatchListNotAvailableException { - return toFileInfoMap(change.getProject(), key); - } - - Map<String, FileInfo> toFileInfoMap(Project.NameKey project, PatchListKey key) - throws ResourceConflictException, PatchListNotAvailableException { - PatchList list; - try { - list = patchListCache.get(key, project); - } catch (PatchListNotAvailableException e) { - Throwable cause = e.getCause(); - if (cause instanceof ExecutionException) { - cause = cause.getCause(); - } - if (cause instanceof NoMergeBaseException) { - throw new ResourceConflictException( - String.format("Cannot create auto merge commit: %s", e.getMessage()), e); - } - throw e; - } - - Map<String, FileInfo> files = new TreeMap<>(); - for (PatchListEntry e : list.getPatches()) { - FileInfo fileInfo = new FileInfo(); - fileInfo.status = - e.getChangeType() != Patch.ChangeType.MODIFIED ? e.getChangeType().getCode() : null; - fileInfo.oldPath = e.getOldName(); - fileInfo.sizeDelta = e.getSizeDelta(); - fileInfo.size = e.getSize(); - if (e.getPatchType() == Patch.PatchType.BINARY) { - fileInfo.binary = true; - } else { - fileInfo.linesInserted = e.getInsertions() > 0 ? e.getInsertions() : null; - fileInfo.linesDeleted = e.getDeletions() > 0 ? e.getDeletions() : null; - } - - FileInfo o = files.put(e.getNewName(), fileInfo); - if (o != null) { - // This should only happen on a delete-add break created by JGit - // when the file was rewritten and too little content survived. Write - // a single record with data from both sides. - fileInfo.status = Patch.ChangeType.REWRITE.getCode(); - fileInfo.sizeDelta = o.sizeDelta; - fileInfo.size = o.size; - if (o.binary != null && o.binary) { - fileInfo.binary = true; - } - if (o.linesInserted != null) { - fileInfo.linesInserted = o.linesInserted; - } - if (o.linesDeleted != null) { - fileInfo.linesDeleted = o.linesDeleted; - } - } - } - return files; - } -}
diff --git a/java/com/google/gerrit/server/change/GetRelatedChangesUtil.java b/java/com/google/gerrit/server/change/GetRelatedChangesUtil.java new file mode 100644 index 0000000..b1f9726 --- /dev/null +++ b/java/com/google/gerrit/server/change/GetRelatedChangesUtil.java
@@ -0,0 +1,119 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.change; + +import static com.google.common.base.Preconditions.checkArgument; +import static java.util.stream.Collectors.toSet; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.index.IndexConfig; +import com.google.gerrit.server.permissions.PermissionBackendException; +import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.query.change.InternalChangeQuery; +import com.google.inject.Inject; +import com.google.inject.Provider; +import com.google.inject.Singleton; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import java.util.Set; + +/** Utility class that gets the ancestor changes and the descendent changes of a specific change. */ +@Singleton +public class GetRelatedChangesUtil { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + private final Provider<InternalChangeQuery> queryProvider; + private final RelatedChangesSorter sorter; + private final IndexConfig indexConfig; + private final ChangeData.Factory changeDataFactory; + + @Inject + GetRelatedChangesUtil( + Provider<InternalChangeQuery> queryProvider, + RelatedChangesSorter sorter, + IndexConfig indexConfig, + ChangeData.Factory changeDataFactory) { + this.queryProvider = queryProvider; + this.sorter = sorter; + this.indexConfig = indexConfig; + this.changeDataFactory = changeDataFactory; + } + + /** + * Gets related changes of a specific change revision. + * + * @param changeData the change of the inputted revision. + * @param basePs the revision that the method checks for related changes. + * @return list of related changes, sorted via {@link RelatedChangesSorter} + */ + public List<RelatedChangesSorter.PatchSetData> getRelated(ChangeData changeData, PatchSet basePs) + throws IOException, PermissionBackendException { + Set<String> groups = getAllGroups(changeData.patchSets()); + logger.atFine().log("groups = %s", groups); + if (groups.isEmpty()) { + return Collections.emptyList(); + } + + List<ChangeData> cds = + InternalChangeQuery.byProjectGroups( + queryProvider, indexConfig, changeData.project(), groups); + if (cds.isEmpty()) { + return Collections.emptyList(); + } + if (cds.size() == 1 && cds.get(0).getId().equals(changeData.getId())) { + return Collections.emptyList(); + } + + cds = reloadChangeIfStale(cds, changeData, basePs); + + return sorter.sort(cds, basePs); + } + + private List<ChangeData> reloadChangeIfStale( + List<ChangeData> changeDatasFromIndex, ChangeData wantedChange, PatchSet wantedPs) { + checkArgument( + wantedChange.getId().equals(wantedPs.id().changeId()), + "change of wantedPs (%s) doesn't match wantedChange (%s)", + wantedPs.id().changeId(), + wantedChange.getId()); + + List<ChangeData> changeDatas = new ArrayList<>(changeDatasFromIndex.size() + 1); + changeDatas.addAll(changeDatasFromIndex); + + // Reload the change in case the patch set is absent. + changeDatas.stream() + .filter( + cd -> cd.getId().equals(wantedPs.id().changeId()) && cd.patchSet(wantedPs.id()) == null) + .forEach(ChangeData::reloadChange); + + if (changeDatas.stream().noneMatch(cd -> cd.getId().equals(wantedPs.id().changeId()))) { + // The change of the wanted patch set is missing in the result from the index. + // Load it from NoteDb and add it to the result. + changeDatas.add(changeDataFactory.create(wantedChange.change())); + } + + return changeDatas; + } + + @VisibleForTesting + public static Set<String> getAllGroups(Collection<PatchSet> patchSets) { + return patchSets.stream().flatMap(ps -> ps.groups().stream()).collect(toSet()); + } +}
diff --git a/java/com/google/gerrit/server/change/IncludedIn.java b/java/com/google/gerrit/server/change/IncludedIn.java index c06ce82..94498d7 100644 --- a/java/com/google/gerrit/server/change/IncludedIn.java +++ b/java/com/google/gerrit/server/change/IncludedIn.java
@@ -21,6 +21,7 @@ import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSortedSet; import com.google.common.collect.ListMultimap; +import com.google.common.collect.Lists; import com.google.common.collect.MultimapBuilder; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.api.changes.IncludedInInfo; @@ -37,10 +38,15 @@ import com.google.inject.Singleton; import java.io.IOException; import java.util.Collection; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; import org.eclipse.jgit.errors.IncorrectObjectTypeException; import org.eclipse.jgit.errors.MissingObjectException; +import org.eclipse.jgit.lib.Constants; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.RefDatabase; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.revwalk.RevCommit; import org.eclipse.jgit.revwalk.RevWalk; @@ -75,13 +81,26 @@ throw new ResourceConflictException(err.getMessage()); } - IncludedInResolver.Result d = IncludedInResolver.resolve(r, rw, rev); + RefDatabase refDb = r.getRefDatabase(); + Collection<Ref> tags = refDb.getRefsByPrefix(Constants.R_TAGS); + Collection<Ref> branches = refDb.getRefsByPrefix(Constants.R_HEADS); + List<Ref> allTagsAndBranches = Lists.newArrayListWithCapacity(tags.size() + branches.size()); + allTagsAndBranches.addAll(tags); + allTagsAndBranches.addAll(branches); + + Set<String> allMatchingTagsAndBranches = + rw.getMergedInto(rev, IncludedInUtil.getSortedRefs(allTagsAndBranches, rw)).stream() + .map(Ref::getName) + .collect(Collectors.toSet()); // Filter branches and tags according to their visbility by the user ImmutableSortedSet<String> filteredBranches = - sortedShortNames(filterReadableRefs(project, d.branches())); + sortedShortNames( + filterReadableRefs( + project, getMatchingRefNames(allMatchingTagsAndBranches, branches))); ImmutableSortedSet<String> filteredTags = - sortedShortNames(filterReadableRefs(project, d.tags())); + sortedShortNames( + filterReadableRefs(project, getMatchingRefNames(allMatchingTagsAndBranches, tags))); ListMultimap<String, String> external = MultimapBuilder.hashKeys().arrayListValues().build(); externalIncludedIn.runEach( @@ -115,6 +134,18 @@ } } + /** + * Returns the short names of refs which are as well in the matchingRefs list as well as in the + * allRef list. + */ + private static ImmutableList<Ref> getMatchingRefNames( + Set<String> matchingRefs, Collection<Ref> allRefs) { + return allRefs.stream() + .filter(r -> matchingRefs.contains(r.getName())) + .distinct() + .collect(toImmutableList()); + } + private ImmutableSortedSet<String> sortedShortNames(Collection<String> refs) { return refs.stream() .map(Repository::shortenRefName)
diff --git a/java/com/google/gerrit/server/change/IncludedInRefs.java b/java/com/google/gerrit/server/change/IncludedInRefs.java new file mode 100644 index 0000000..f069251 --- /dev/null +++ b/java/com/google/gerrit/server/change/IncludedInRefs.java
@@ -0,0 +1,139 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.change; + +import static java.util.stream.Collectors.toSet; + +import com.google.gerrit.entities.Project; +import com.google.gerrit.extensions.restapi.AuthException; +import com.google.gerrit.extensions.restapi.BadRequestException; +import com.google.gerrit.extensions.restapi.ResourceConflictException; +import com.google.gerrit.extensions.restapi.ResourceNotFoundException; +import com.google.gerrit.server.git.GitRepositoryManager; +import com.google.gerrit.server.permissions.PermissionBackend; +import com.google.gerrit.server.permissions.PermissionBackend.RefFilterOptions; +import com.google.gerrit.server.permissions.PermissionBackendException; +import com.google.inject.Inject; +import java.io.IOException; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; +import org.eclipse.jgit.errors.IncorrectObjectTypeException; +import org.eclipse.jgit.errors.MissingObjectException; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.RefDatabase; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevWalk; + +public class IncludedInRefs { + protected final GitRepositoryManager repoManager; + protected final PermissionBackend permissionBackend; + + @Inject + IncludedInRefs(GitRepositoryManager repoManager, PermissionBackend permissionBackend) { + this.repoManager = repoManager; + this.permissionBackend = permissionBackend; + } + + public Map<String, Set<String>> apply( + Project.NameKey project, Set<String> commits, Set<String> refNames) + throws ResourceConflictException, BadRequestException, IOException, + PermissionBackendException, ResourceNotFoundException, AuthException { + try (Repository repo = repoManager.openRepository(project)) { + Set<Ref> visibleRefs = getVisibleRefs(repo, refNames, project); + + if (!visibleRefs.isEmpty()) { + try (RevWalk revWalk = new RevWalk(repo)) { + revWalk.setRetainBody(false); + Set<RevCommit> revCommits = getRevCommits(commits, revWalk); + + if (!revCommits.isEmpty()) { + return commitsIncludedIn( + revCommits, IncludedInUtil.getSortedRefs(visibleRefs, revWalk), revWalk); + } + } + } + } + return Collections.EMPTY_MAP; + } + + private Set<Ref> getVisibleRefs(Repository repo, Set<String> refNames, Project.NameKey project) + throws PermissionBackendException { + RefDatabase refDb = repo.getRefDatabase(); + Set<Ref> refs = new HashSet<>(); + for (String refName : refNames) { + try { + Ref ref = refDb.exactRef(refName); + if (ref != null) { + refs.add(ref); + } + } catch (IOException e) { + // Ignore and continue to process rest of the refs so as to keep + // the behavior similar to the ref not being visible to the user. + // This will ensure that there is no information leak about the + // ref when the ref is corrupted and is not visible to the user. + } + } + return filterReadableRefs(project, refs, repo); + } + + private Set<RevCommit> getRevCommits(Set<String> commits, RevWalk revWalk) throws IOException { + Set<RevCommit> revCommits = new HashSet<>(); + for (String commit : commits) { + try { + revCommits.add(revWalk.parseCommit(ObjectId.fromString(commit))); + } catch (MissingObjectException | IncorrectObjectTypeException | IllegalArgumentException e) { + // Ignore and continue to process the rest of the commits so as to keep + // the behavior similar to the commit not being included in any of the + // visible specified refs. This will ensure that there is no information + // leak about the commit when the commit is not visible to the user. + } + } + return revCommits; + } + + private Map<String, Set<String>> commitsIncludedIn( + Collection<RevCommit> commits, Collection<Ref> refs, RevWalk revWalk) throws IOException { + Map<String, Set<String>> refsByCommit = new HashMap<>(); + for (RevCommit commit : commits) { + List<Ref> matchingRefs = revWalk.getMergedInto(commit, refs); + if (matchingRefs.size() > 0) { + refsByCommit.put( + commit.getName(), matchingRefs.stream().map(Ref::getName).collect(toSet())); + } + } + return refsByCommit; + } + + /** + * Filter readable refs according to the caller's refs visibility. + * + * @param project specific Gerrit project. + * @param inputRefs a list of refs + * @param repo repository opened for the Gerrit project. + * @return set of visible refs to the caller + */ + private Set<Ref> filterReadableRefs(Project.NameKey project, Set<Ref> inputRefs, Repository repo) + throws PermissionBackendException { + PermissionBackend.ForProject perm = permissionBackend.currentUser().project(project); + return perm.filter(inputRefs, repo, RefFilterOptions.defaults()).stream().collect(toSet()); + } +}
diff --git a/java/com/google/gerrit/server/change/IncludedInResolver.java b/java/com/google/gerrit/server/change/IncludedInResolver.java deleted file mode 100644 index 3891700..0000000 --- a/java/com/google/gerrit/server/change/IncludedInResolver.java +++ /dev/null
@@ -1,215 +0,0 @@ -// Copyright (C) 2013 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.change; - -import static java.util.Comparator.comparing; -import static java.util.stream.Collectors.toList; - -import com.google.auto.value.AutoValue; -import com.google.common.collect.ImmutableList; -import com.google.common.collect.LinkedListMultimap; -import com.google.common.collect.ListMultimap; -import com.google.common.collect.Lists; -import com.google.common.flogger.FluentLogger; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; -import java.util.HashSet; -import java.util.List; -import java.util.Set; -import org.eclipse.jgit.errors.IncorrectObjectTypeException; -import org.eclipse.jgit.errors.MissingObjectException; -import org.eclipse.jgit.lib.Constants; -import org.eclipse.jgit.lib.Ref; -import org.eclipse.jgit.lib.RefDatabase; -import org.eclipse.jgit.lib.Repository; -import org.eclipse.jgit.revwalk.RevCommit; -import org.eclipse.jgit.revwalk.RevFlag; -import org.eclipse.jgit.revwalk.RevWalk; - -/** Resolve in which tags and branches a commit is included. */ -public class IncludedInResolver { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - public static Result resolve(Repository repo, RevWalk rw, RevCommit commit) throws IOException { - RevFlag flag = newFlag(rw); - try { - return new IncludedInResolver(repo, rw, commit, flag).resolve(); - } finally { - rw.disposeFlag(flag); - } - } - - public static boolean includedInAny( - final Repository repo, RevWalk rw, RevCommit commit, Collection<Ref> refs) - throws IOException { - if (refs.isEmpty()) { - return false; - } - RevFlag flag = newFlag(rw); - try { - return new IncludedInResolver(repo, rw, commit, flag).includedInOne(refs); - } finally { - rw.disposeFlag(flag); - } - } - - private static RevFlag newFlag(RevWalk rw) { - return rw.newFlag("CONTAINS_TARGET"); - } - - private final Repository repo; - private final RevWalk rw; - private final RevCommit target; - - private final RevFlag containsTarget; - private ListMultimap<RevCommit, String> commitToRef; - private List<RevCommit> tipsByCommitTime; - - private IncludedInResolver( - Repository repo, RevWalk rw, RevCommit target, RevFlag containsTarget) { - this.repo = repo; - this.rw = rw; - this.target = target; - this.containsTarget = containsTarget; - } - - private Result resolve() throws IOException { - RefDatabase refDb = repo.getRefDatabase(); - Collection<Ref> tags = refDb.getRefsByPrefix(Constants.R_TAGS); - Collection<Ref> branches = refDb.getRefsByPrefix(Constants.R_HEADS); - List<Ref> allTagsAndBranches = Lists.newArrayListWithCapacity(tags.size() + branches.size()); - allTagsAndBranches.addAll(tags); - allTagsAndBranches.addAll(branches); - parseCommits(allTagsAndBranches); - Set<String> allMatchingTagsAndBranches = includedIn(tipsByCommitTime, 0); - - return new AutoValue_IncludedInResolver_Result( - getMatchingRefNames(allMatchingTagsAndBranches, branches), - getMatchingRefNames(allMatchingTagsAndBranches, tags)); - } - - private boolean includedInOne(Collection<Ref> refs) throws IOException { - parseCommits(refs); - List<RevCommit> before = new ArrayList<>(); - List<RevCommit> after = new ArrayList<>(); - partition(before, after); - rw.reset(); - // It is highly likely that the target is reachable from the "after" set - // Within the "before" set we are trying to handle cases arising from clock skew - return !includedIn(after, 1).isEmpty() || !includedIn(before, 1).isEmpty(); - } - - /** Resolves which tip refs include the target commit. */ - private Set<String> includedIn(Collection<RevCommit> tips, int limit) - throws IOException, MissingObjectException, IncorrectObjectTypeException { - Set<String> result = new HashSet<>(); - for (RevCommit tip : tips) { - boolean commitFound = false; - rw.resetRetain(RevFlag.UNINTERESTING, containsTarget); - rw.markStart(tip); - for (RevCommit commit : rw) { - if (commit.equals(target) || commit.has(containsTarget)) { - commitFound = true; - tip.add(containsTarget); - result.addAll(commitToRef.get(tip)); - break; - } - } - if (!commitFound) { - rw.markUninteresting(tip); - } else if (0 < limit && limit < result.size()) { - break; - } - } - return result; - } - - /** - * Partition the reference tips into two sets: - * - * <ul> - * <li>before = commits with time < target.getCommitTime() - * <li>after = commits with time >= target.getCommitTime() - * </ul> - * - * Each of the before/after lists is sorted by the commit time. - * - * @param before - * @param after - */ - private void partition(List<RevCommit> before, List<RevCommit> after) { - int insertionPoint = - Collections.binarySearch(tipsByCommitTime, target, comparing(RevCommit::getCommitTime)); - if (insertionPoint < 0) { - insertionPoint = -(insertionPoint + 1); - } - if (0 < insertionPoint) { - before.addAll(tipsByCommitTime.subList(0, insertionPoint)); - } - if (insertionPoint < tipsByCommitTime.size()) { - after.addAll(tipsByCommitTime.subList(insertionPoint, tipsByCommitTime.size())); - } - } - - /** - * Returns the short names of refs which are as well in the matchingRefs list as well as in the - * allRef list. - */ - private static ImmutableList<Ref> getMatchingRefNames( - Set<String> matchingRefs, Collection<Ref> allRefs) { - return allRefs.stream() - .filter(r -> matchingRefs.contains(r.getName())) - .distinct() - .collect(ImmutableList.toImmutableList()); - } - - /** Parse commit of ref and store the relation between ref and commit. */ - private void parseCommits(Collection<Ref> refs) throws IOException { - if (commitToRef != null) { - return; - } - commitToRef = LinkedListMultimap.create(); - for (Ref ref : refs) { - final RevCommit commit; - try { - commit = rw.parseCommit(ref.getObjectId()); - } catch (IncorrectObjectTypeException notCommit) { - // Its OK for a tag reference to point to a blob or a tree, this - // is common in the Linux kernel or git.git repository. - // - continue; - } catch (MissingObjectException notHere) { - // Log the problem with this branch, but keep processing. - // - logger.atWarning().log( - "Reference %s in %s points to dangling object %s", - ref.getName(), repo.getDirectory(), ref.getObjectId()); - continue; - } - commitToRef.put(commit, ref.getName()); - } - tipsByCommitTime = - commitToRef.keySet().stream().sorted(comparing(RevCommit::getCommitTime)).collect(toList()); - } - - @AutoValue - public abstract static class Result { - public abstract ImmutableList<Ref> branches(); - - public abstract ImmutableList<Ref> tags(); - } -}
diff --git a/java/com/google/gerrit/server/change/IncludedInUtil.java b/java/com/google/gerrit/server/change/IncludedInUtil.java new file mode 100644 index 0000000..6f75e0f --- /dev/null +++ b/java/com/google/gerrit/server/change/IncludedInUtil.java
@@ -0,0 +1,49 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.change; + +import static java.util.Comparator.comparing; +import static java.util.stream.Collectors.toList; + +import java.io.IOException; +import java.util.Collection; +import java.util.List; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.revwalk.RevWalk; + +public class IncludedInUtil { + + /** + * Sorts the collection of {@code Ref} instances by its tip commit time. + * + * @param refs collection to be sorted + * @param revWalk {@code RevWalk} instance for parsing ref's tip commit + * @return sorted list of refs + */ + public static List<Ref> getSortedRefs(Collection<Ref> refs, RevWalk revWalk) { + return refs.stream() + .sorted( + comparing( + ref -> { + try { + return revWalk.parseCommit(ref.getObjectId()).getCommitTime(); + } catch (IOException e) { + // Ignore and continue to sort + } + return 0; + })) + .collect(toList()); + } +}
diff --git a/java/com/google/gerrit/server/change/LabelNormalizer.java b/java/com/google/gerrit/server/change/LabelNormalizer.java index 30343d4..aeb9db0 100644 --- a/java/com/google/gerrit/server/change/LabelNormalizer.java +++ b/java/com/google/gerrit/server/change/LabelNormalizer.java
@@ -33,6 +33,7 @@ import com.google.inject.Singleton; import java.util.Collection; import java.util.List; +import java.util.Optional; /** * Normalizes votes on labels according to project config. @@ -76,10 +77,11 @@ } /** + * Returns copies of approvals normalized to the defined ranges for the label type. Approvals for + * unknown labels are not included in the output + * * @param notes change notes containing the given approvals. * @param approvals list of approvals. - * @return copies of approvals normalized to the defined ranges for the label type. Approvals for - * unknown labels are not included in the output. */ public Result normalize(ChangeNotes notes, Collection<PatchSetApproval> approvals) { List<PatchSetApproval> unchanged = Lists.newArrayListWithCapacity(approvals.size()); @@ -101,12 +103,12 @@ unchanged.add(psa); continue; } - LabelType label = labelTypes.byLabel(psa.labelId()); - if (label == null) { + Optional<LabelType> label = labelTypes.byLabel(psa.labelId()); + if (!label.isPresent()) { deleted.add(psa); continue; } - PatchSetApproval copy = applyTypeFloor(label, psa); + PatchSetApproval copy = applyTypeFloor(label.get(), psa); if (copy.value() != psa.value()) { updated.add(copy); } else {
diff --git a/java/com/google/gerrit/server/change/LabelsJson.java b/java/com/google/gerrit/server/change/LabelsJson.java index acff03c..5ce121b 100644 --- a/java/com/google/gerrit/server/change/LabelsJson.java +++ b/java/com/google/gerrit/server/change/LabelsJson.java
@@ -57,6 +57,7 @@ import java.util.LinkedHashMap; import java.util.List; import java.util.Map; +import java.util.Optional; import java.util.Set; import java.util.TreeMap; @@ -103,9 +104,9 @@ for (SubmitRecord rec : submitRecords(cd)) { if (rec.labels != null) { for (SubmitRecord.Label r : rec.labels) { - LabelType type = labelTypes.byLabel(r.label); - if (type != null && (!isMerged || type.isAllowPostSubmit())) { - toCheck.put(type.getName(), type); + Optional<LabelType> type = labelTypes.byLabel(r.label); + if (type.isPresent() && (!isMerged || type.get().isAllowPostSubmit())) { + toCheck.put(type.get().getName(), type.get()); } } } @@ -120,18 +121,18 @@ continue; } for (SubmitRecord.Label r : rec.labels) { - LabelType type = labelTypes.byLabel(r.label); - if (type == null || (isMerged && !type.isAllowPostSubmit())) { + Optional<LabelType> type = labelTypes.byLabel(r.label); + if (!type.isPresent() || (isMerged && !type.get().isAllowPostSubmit())) { continue; } - for (LabelValue v : type.getValues()) { - boolean ok = can.contains(new LabelPermission.WithValue(type, v)); + for (LabelValue v : type.get().getValues()) { + boolean ok = can.contains(new LabelPermission.WithValue(type.get(), v)); if (isMerged) { if (labels == null) { labels = currentLabels(filterApprovalsBy, cd); } - short prev = labels.getOrDefault(type.getName(), (short) 0); + short prev = labels.getOrDefault(type.get().getName(), (short) 0); ok &= v.getValue() >= prev; } if (ok) { @@ -176,21 +177,21 @@ setAllApprovals(accountLoader, cd, labels); } for (Map.Entry<String, LabelWithStatus> e : labels.entrySet()) { - LabelType type = labelTypes.byLabel(e.getKey()); - if (type == null) { + Optional<LabelType> type = labelTypes.byLabel(e.getKey()); + if (!type.isPresent()) { continue; } if (standard) { for (PatchSetApproval psa : cd.currentApprovals()) { - if (type.matches(psa)) { + if (type.get().matches(psa)) { short val = psa.value(); Account.Id accountId = psa.accountId(); - setLabelScores(accountLoader, type, e.getValue(), val, accountId); + setLabelScores(accountLoader, type.get(), e.getValue(), val, accountId); } } } if (detailed) { - setLabelValues(type, e.getValue()); + setLabelValues(type.get(), e.getValue()); } } return labels; @@ -261,9 +262,9 @@ MultimapBuilder.hashKeys().hashSetValues().build(); for (PatchSetApproval a : cd.currentApprovals()) { allUsers.add(a.accountId()); - LabelType type = labelTypes.byLabel(a.labelId()); - if (type != null) { - labelNames.add(type.getName()); + Optional<LabelType> type = labelTypes.byLabel(a.labelId()); + if (type.isPresent()) { + labelNames.add(type.get().getName()); // Not worth the effort to distinguish between votable/non-votable for 0 // values on closed changes, since they can't vote anyway. current.put(a.accountId(), a); @@ -292,8 +293,8 @@ if (detailed) { labels.entrySet().stream() - .filter(e -> labelTypes.byLabel(e.getKey()) != null) - .forEach(e -> setLabelValues(labelTypes.byLabel(e.getKey()), e.getValue())); + .filter(e -> labelTypes.byLabel(e.getKey()).isPresent()) + .forEach(e -> setLabelValues(labelTypes.byLabel(e.getKey()).get(), e.getValue())); } for (Account.Id accountId : allUsers) { @@ -308,16 +309,16 @@ } } for (PatchSetApproval psa : current.get(accountId)) { - LabelType type = labelTypes.byLabel(psa.labelId()); - if (type == null) { + Optional<LabelType> type = labelTypes.byLabel(psa.labelId()); + if (!type.isPresent()) { continue; } short val = psa.value(); - ApprovalInfo info = byLabel.get(type.getName()); + ApprovalInfo info = byLabel.get(type.get().getName()); if (info != null) { info.value = Integer.valueOf(val); - info.permittedVotingRange = pvr.getOrDefault(type.getName(), null); + info.permittedVotingRange = pvr.getOrDefault(type.get().getName(), null); info.date = psa.granted(); info.tag = psa.tag().orElse(null); if (psa.postSubmit()) { @@ -328,7 +329,7 @@ continue; } - setLabelScores(accountLoader, type, labels.get(type.getName()), val, accountId); + setLabelScores(accountLoader, type.get(), labels.get(type.get().getName()), val, accountId); } } return labels; @@ -428,24 +429,24 @@ PermissionBackend.ForChange perm = permissionBackend.absentUser(accountId).change(cd); Map<String, VotingRangeInfo> pvr = getPermittedVotingRanges(permittedLabels(accountId, cd)); for (Map.Entry<String, LabelWithStatus> e : labels.entrySet()) { - LabelType lt = labelTypes.byLabel(e.getKey()); - if (lt == null) { + Optional<LabelType> lt = labelTypes.byLabel(e.getKey()); + if (!lt.isPresent()) { // Ignore submit record for undefined label; likely the submit rule // author didn't intend for the label to show up in the table. continue; } Integer value; - VotingRangeInfo permittedVotingRange = pvr.getOrDefault(lt.getName(), null); + VotingRangeInfo permittedVotingRange = pvr.getOrDefault(lt.get().getName(), null); String tag = null; Timestamp date = null; - PatchSetApproval psa = current.get(accountId, lt.getName()); + PatchSetApproval psa = current.get(accountId, lt.get().getName()); if (psa != null) { value = Integer.valueOf(psa.value()); if (value == 0) { // This may be a dummy approval that was inserted when the reviewer // was added. Explicitly check whether the user can vote on this // label. - value = perm.test(new LabelPermission(lt)) ? 0 : null; + value = perm.test(new LabelPermission(lt.get())) ? 0 : null; } tag = psa.tag().orElse(null); date = psa.granted(); @@ -456,7 +457,7 @@ // Either the user cannot vote on this label, or they were added as a // reviewer but have not responded yet. Explicitly check whether the // user can vote on this label. - value = perm.test(new LabelPermission(lt)) ? 0 : null; + value = perm.test(new LabelPermission(lt.get())) ? 0 : null; } addApproval( e.getValue().label(),
diff --git a/java/com/google/gerrit/server/change/AddReviewersEmail.java b/java/com/google/gerrit/server/change/ModifyReviewersEmail.java similarity index 80% rename from java/com/google/gerrit/server/change/AddReviewersEmail.java rename to java/com/google/gerrit/server/change/ModifyReviewersEmail.java index 4a3f638..cb747f6 100644 --- a/java/com/google/gerrit/server/change/AddReviewersEmail.java +++ b/java/com/google/gerrit/server/change/ModifyReviewersEmail.java
@@ -24,8 +24,8 @@ import com.google.gerrit.entities.Project; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.config.SendEmailExecutor; -import com.google.gerrit.server.mail.send.AddReviewerSender; import com.google.gerrit.server.mail.send.MessageIdGenerator; +import com.google.gerrit.server.mail.send.ModifyReviewerSender; import com.google.inject.Inject; import com.google.inject.Singleton; import java.util.Collection; @@ -33,16 +33,16 @@ import java.util.concurrent.Future; @Singleton -public class AddReviewersEmail { +public class ModifyReviewersEmail { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - private final AddReviewerSender.Factory addReviewerSenderFactory; + private final ModifyReviewerSender.Factory addReviewerSenderFactory; private final ExecutorService sendEmailsExecutor; private final MessageIdGenerator messageIdGenerator; @Inject - AddReviewersEmail( - AddReviewerSender.Factory addReviewerSenderFactory, + ModifyReviewersEmail( + ModifyReviewerSender.Factory addReviewerSenderFactory, @SendEmailExecutor ExecutorService sendEmailsExecutor, MessageIdGenerator messageIdGenerator) { this.addReviewerSenderFactory = addReviewerSenderFactory; @@ -55,19 +55,25 @@ Change change, Collection<Account.Id> added, Collection<Account.Id> copied, + Collection<Account.Id> removed, Collection<Address> addedByEmail, Collection<Address> copiedByEmail, + Collection<Address> removedByEmail, NotifyResolver.Result notify) { - // The user knows they added themselves, don't bother emailing them. + // The user knows they added/removed themselves, don't bother emailing them. Account.Id userId = user.getAccountId(); ImmutableList<Account.Id> immutableToMail = added.stream().filter(id -> !id.equals(userId)).collect(toImmutableList()); ImmutableList<Account.Id> immutableToCopy = copied.stream().filter(id -> !id.equals(userId)).collect(toImmutableList()); + ImmutableList<Account.Id> immutableToRemove = + removed.stream().filter(id -> !id.equals(userId)).collect(toImmutableList()); if (immutableToMail.isEmpty() && immutableToCopy.isEmpty() + && immutableToRemove.isEmpty() && addedByEmail.isEmpty() - && copiedByEmail.isEmpty()) { + && copiedByEmail.isEmpty() + && removedByEmail.isEmpty()) { return; } @@ -77,13 +83,14 @@ Project.NameKey projectNameKey = change.getProject(); ImmutableList<Address> immutableAddedByEmail = ImmutableList.copyOf(addedByEmail); ImmutableList<Address> immutableCopiedByEmail = ImmutableList.copyOf(copiedByEmail); + ImmutableList<Address> immutableRemovedByEmail = ImmutableList.copyOf(removedByEmail); @SuppressWarnings("unused") Future<?> possiblyIgnoredError = sendEmailsExecutor.submit( () -> { try { - AddReviewerSender emailSender = + ModifyReviewerSender emailSender = addReviewerSenderFactory.create(projectNameKey, cId); emailSender.setNotify(notify); emailSender.setFrom(userId); @@ -91,6 +98,8 @@ emailSender.addReviewersByEmail(immutableAddedByEmail); emailSender.addExtraCC(immutableToCopy); emailSender.addExtraCCByEmail(immutableCopiedByEmail); + emailSender.addRemovedReviewers(immutableToRemove); + emailSender.addRemovedByEmailReviewers(immutableRemovedByEmail); emailSender.setMessageId( messageIdGenerator.fromChangeUpdate( change.getProject(), change.currentPatchSetId()));
diff --git a/java/com/google/gerrit/server/change/PatchSetInserter.java b/java/com/google/gerrit/server/change/PatchSetInserter.java index d2bf3fe..209901d 100644 --- a/java/com/google/gerrit/server/change/PatchSetInserter.java +++ b/java/com/google/gerrit/server/change/PatchSetInserter.java
@@ -23,18 +23,17 @@ import com.google.common.collect.ImmutableListMultimap; import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetInfo; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.extensions.restapi.BadRequestException; import com.google.gerrit.extensions.restapi.ResourceConflictException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.PatchSetUtil; import com.google.gerrit.server.ReviewerSet; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.events.CommitReceivedEvent; import com.google.gerrit.server.extensions.events.RevisionCreated; import com.google.gerrit.server.extensions.events.WorkInProgressStateChanged; @@ -53,7 +52,7 @@ import com.google.gerrit.server.ssh.NoSshInfo; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RepoContext; import com.google.gerrit.server.validators.ValidationException; import com.google.inject.Inject; @@ -105,12 +104,13 @@ private boolean allowClosed; private boolean sendEmail = true; private String topic; + private boolean storeCopiedVotes = true; // Fields set during some phase of BatchUpdate.Op. private Change change; private PatchSet patchSet; private PatchSetInfo patchSetInfo; - private ChangeMessage changeMessage; + private String mailMessage; private ReviewerSet oldReviewers; private boolean oldWorkInProgressState; @@ -204,6 +204,17 @@ return this; } + /** + * We always want to store copied votes except when the change is getting submitted and a new + * patch-set is created on submit (using submit strategies such as "REBASE_ALWAYS"). In such + * cases, we already store the votes of the new patch-sets in SubmitStrategyOp#saveApprovals. We + * should not also store the copied votes. + */ + public PatchSetInserter setStoreCopiedVotes(boolean storeCopiedVotes) { + this.storeCopiedVotes = storeCopiedVotes; + return this; + } + public Change getChange() { checkState(change != null, "getChange() only valid after executing update"); return change; @@ -260,14 +271,9 @@ } if (message != null) { - changeMessage = - ChangeMessagesUtil.newMessage( - patchSet.id(), - ctx.getUser(), - ctx.getWhen(), - message, - ChangeMessagesUtil.uploadedPatchSetTag(change.isWorkInProgress())); - changeMessage.setMessage(message); + mailMessage = + cmUtil.setChangeMessage( + update, message, ChangeMessagesUtil.uploadedPatchSetTag(change.isWorkInProgress())); } oldWorkInProgressState = change.isWorkInProgress(); @@ -283,9 +289,6 @@ change.setStatus(Change.Status.NEW); } change.setCurrentPatchSet(patchSetInfo); - if (changeMessage != null) { - cmUtil.addChangeMessage(update, changeMessage); - } if (topic != null) { change.setTopic(topic); try { @@ -294,20 +297,27 @@ throw new BadRequestException(ex.getMessage()); } } + + // Approvals that are being set in the new patch-set during this operation are not available yet + // outside of the scope of this method. Only copied approvals are set here. + if (storeCopiedVotes) { + approvalsUtil.byPatchSet(ctx.getNotes(), patchSet).forEach(a -> update.putCopiedApproval(a)); + } + return true; } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { NotifyResolver.Result notify = ctx.getNotify(change.getId()); if (notify.shouldNotify() && sendEmail) { - requireNonNull(changeMessage); + requireNonNull(mailMessage); try { ReplacePatchSetSender emailSender = replacePatchSetFactory.create(ctx.getProject(), change.getId()); emailSender.setFrom(ctx.getAccountId()); emailSender.setPatchSet(patchSet, patchSetInfo); - emailSender.setChangeMessage(changeMessage.getMessage(), ctx.getWhen()); + emailSender.setChangeMessage(mailMessage, ctx.getWhen()); emailSender.addReviewers(oldReviewers.byState(REVIEWER)); emailSender.addExtraCC(oldReviewers.byState(CC)); emailSender.setNotify(notify); @@ -321,11 +331,12 @@ } if (fireRevisionCreated) { - revisionCreated.fire(change, patchSet, ctx.getAccount(), ctx.getWhen(), notify); + revisionCreated.fire( + ctx.getChangeData(change), patchSet, ctx.getAccount(), ctx.getWhen(), notify); } if (workInProgress != null && oldWorkInProgressState != workInProgress) { - wipStateChanged.fire(change, patchSet, ctx.getAccount(), ctx.getWhen()); + wipStateChanged.fire(ctx.getChangeData(change), patchSet, ctx.getAccount(), ctx.getWhen()); } }
diff --git a/java/com/google/gerrit/server/change/RebaseChangeOp.java b/java/com/google/gerrit/server/change/RebaseChangeOp.java index b43996e..3e67cca 100644 --- a/java/com/google/gerrit/server/change/RebaseChangeOp.java +++ b/java/com/google/gerrit/server/change/RebaseChangeOp.java
@@ -41,7 +41,7 @@ import com.google.gerrit.server.project.ProjectState; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RepoContext; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; @@ -92,6 +92,7 @@ private boolean detailedCommitMessage; private boolean postMessage = true; private boolean sendEmail = true; + private boolean storeCopiedVotes = true; private boolean matchAuthorToCommitterDate = false; private CodeReviewCommit rebasedCommit; @@ -169,6 +170,17 @@ return this; } + /** + * We always want to store copied votes except when the change is getting submitted and a new + * patch-set is created on submit (using submit strategies such as "REBASE_ALWAYS"). In such + * cases, we already store the votes of the new patch-sets in SubmitStrategyOp#saveApprovals. We + * should not also store the copied votes. + */ + public RebaseChangeOp setStoreCopiedVotes(boolean storeCopiedVotes) { + this.storeCopiedVotes = storeCopiedVotes; + return this; + } + public RebaseChangeOp setSendEmail(boolean sendEmail) { this.sendEmail = sendEmail; return this; @@ -219,7 +231,10 @@ .setFireRevisionCreated(fireRevisionCreated) .setCheckAddPatchSetPermission(checkAddPatchSetPermission) .setValidate(validate) - .setSendEmail(sendEmail); + .setSendEmail(sendEmail) + // The votes are automatically copied and they don't count as copied votes. See + // method's javadoc. + .setStoreCopiedVotes(storeCopiedVotes); if (!rebasedCommit.getFilesWithGitConflicts().isEmpty() && !notes.getChange().isWorkInProgress()) { @@ -240,6 +255,8 @@ patchSetInserter.setGroups(GroupCollector.getDefaultGroups(rebasedCommit)); } } + + ctx.getRevWalk().getObjectReader().getCreatedFromInserter().flush(); patchSetInserter.updateRepo(ctx); } @@ -270,7 +287,7 @@ } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { patchSetInserter.postUpdate(ctx); }
diff --git a/java/com/google/gerrit/server/restapi/change/RelatedChangesSorter.java b/java/com/google/gerrit/server/change/RelatedChangesSorter.java similarity index 95% rename from java/com/google/gerrit/server/restapi/change/RelatedChangesSorter.java rename to java/com/google/gerrit/server/change/RelatedChangesSorter.java index 1d550f1..547452e 100644 --- a/java/com/google/gerrit/server/restapi/change/RelatedChangesSorter.java +++ b/java/com/google/gerrit/server/change/RelatedChangesSorter.java
@@ -11,14 +11,14 @@ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. - -package com.google.gerrit.server.restapi.change; +package com.google.gerrit.server.change; import static com.google.common.base.Preconditions.checkArgument; import static java.util.Objects.requireNonNull; import static java.util.stream.Collectors.toMap; import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.ImmutableList; import com.google.common.collect.ListMultimap; @@ -29,6 +29,7 @@ import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.restapi.AuthException; +import com.google.gerrit.server.change.RelatedChangesSorter.PatchSetData; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.permissions.ChangePermission; import com.google.gerrit.server.permissions.PermissionBackend; @@ -56,7 +57,7 @@ import org.eclipse.jgit.revwalk.RevWalk; @Singleton -class RelatedChangesSorter { +public class RelatedChangesSorter { private final GitRepositoryManager repoManager; private final PermissionBackend permissionBackend; private final ProjectCache projectCache; @@ -246,28 +247,29 @@ } @AutoValue - abstract static class PatchSetData { + public abstract static class PatchSetData { @VisibleForTesting static PatchSetData create(ChangeData cd, PatchSet ps, RevCommit commit) { return new AutoValue_RelatedChangesSorter_PatchSetData(cd, ps, commit); } - abstract ChangeData data(); + public abstract ChangeData data(); - abstract PatchSet patchSet(); + public abstract PatchSet patchSet(); - abstract RevCommit commit(); + public abstract RevCommit commit(); - PatchSet.Id psId() { + public PatchSet.Id psId() { return patchSet().id(); } - Change.Id id() { + public Change.Id id() { return psId().changeId(); } + @Memoized @Override - public final int hashCode() { + public int hashCode() { return Objects.hash(patchSet().id(), commit()); }
diff --git a/java/com/google/gerrit/server/change/RemoveFromAttentionSetOp.java b/java/com/google/gerrit/server/change/RemoveFromAttentionSetOp.java index e532409..50ee9d4 100644 --- a/java/com/google/gerrit/server/change/RemoveFromAttentionSetOp.java +++ b/java/com/google/gerrit/server/change/RemoveFromAttentionSetOp.java
@@ -28,7 +28,7 @@ import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.util.AttentionSetEmail; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; @@ -101,7 +101,7 @@ } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { if (!notify) { return; }
diff --git a/java/com/google/gerrit/server/change/ReviewerJson.java b/java/com/google/gerrit/server/change/ReviewerJson.java index 761b57d..6189708 100644 --- a/java/com/google/gerrit/server/change/ReviewerJson.java +++ b/java/com/google/gerrit/server/change/ReviewerJson.java
@@ -27,8 +27,8 @@ import com.google.gerrit.entities.SubmitRecord; import com.google.gerrit.extensions.api.changes.ReviewerInfo; import com.google.gerrit.extensions.restapi.AuthException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.account.AccountLoader; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.permissions.LabelPermission; import com.google.gerrit.server.permissions.PermissionBackend; import com.google.gerrit.server.permissions.PermissionBackendException; @@ -38,6 +38,7 @@ import com.google.inject.Singleton; import java.util.Collection; import java.util.List; +import java.util.Optional; import java.util.TreeMap; @Singleton @@ -94,7 +95,7 @@ out, reviewerAccountId, cd, - approvalsUtil.byPatchSetUser(cd.notes(), psId, reviewerAccountId, null, null)); + approvalsUtil.byPatchSetUser(cd.notes(), psId, reviewerAccountId)); } public ReviewerInfo format( @@ -107,10 +108,8 @@ out.approvals = new TreeMap<>(labelTypes.nameComparator()); for (PatchSetApproval ca : approvals) { - LabelType at = labelTypes.byLabel(ca.labelId()); - if (at != null) { - out.approvals.put(at.getName(), formatValue(ca.value())); - } + Optional<LabelType> at = labelTypes.byLabel(ca.labelId()); + at.ifPresent(lt -> out.approvals.put(lt.getName(), formatValue(ca.value()))); } // Add dummy approvals for all permitted labels for the user even if they @@ -125,13 +124,13 @@ } for (SubmitRecord.Label label : rec.labels) { String name = label.label; - LabelType type = labelTypes.byLabel(name); - if (out.approvals.containsKey(name) || type == null) { + Optional<LabelType> type = labelTypes.byLabel(name); + if (out.approvals.containsKey(name) || !type.isPresent()) { continue; } try { - perm.check(new LabelPermission(type)); + perm.check(new LabelPermission(type.get())); out.approvals.put(name, formatValue((short) 0)); } catch (AuthException e) { // Do nothing.
diff --git a/java/com/google/gerrit/server/change/ReviewerAdder.java b/java/com/google/gerrit/server/change/ReviewerModifier.java similarity index 69% rename from java/com/google/gerrit/server/change/ReviewerAdder.java rename to java/com/google/gerrit/server/change/ReviewerModifier.java index 5d55b4d..fffb107 100644 --- a/java/com/google/gerrit/server/change/ReviewerAdder.java +++ b/java/com/google/gerrit/server/change/ReviewerModifier.java
@@ -19,12 +19,14 @@ import static com.google.common.collect.ImmutableList.toImmutableList; import static com.google.common.collect.ImmutableSet.toImmutableSet; import static com.google.gerrit.extensions.client.ReviewerState.CC; +import static com.google.gerrit.extensions.client.ReviewerState.REMOVED; import static com.google.gerrit.server.project.ProjectCache.illegalState; import static java.util.Comparator.comparing; import static java.util.Objects.requireNonNull; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Iterables; import com.google.common.collect.Lists; import com.google.common.collect.Ordering; import com.google.common.collect.Streams; @@ -39,10 +41,11 @@ import com.google.gerrit.entities.GroupDescription; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetApproval; -import com.google.gerrit.extensions.api.changes.AddReviewerInput; -import com.google.gerrit.extensions.api.changes.AddReviewerResult; +import com.google.gerrit.extensions.api.changes.DeleteReviewerInput; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.api.changes.ReviewerInfo; +import com.google.gerrit.extensions.api.changes.ReviewerInput; +import com.google.gerrit.extensions.api.changes.ReviewerResult; import com.google.gerrit.extensions.client.ReviewerState; import com.google.gerrit.extensions.common.AccountInfo; import com.google.gerrit.extensions.restapi.AuthException; @@ -69,7 +72,7 @@ import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.inject.Inject; import com.google.inject.Provider; import java.io.IOException; @@ -85,7 +88,7 @@ import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.ObjectId; -public class ReviewerAdder { +public class ReviewerModifier { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); public static final int DEFAULT_MAX_REVIEWERS_WITHOUT_CHECK = 10; @@ -102,9 +105,9 @@ } // TODO(dborowitz): Subclassing is not the right way to do this. We should instead use an internal - // type in the public interfaces of ReviewerAdder, rather than passing around the REST API type + // type in the public interfaces of ReviewerModifier, rather than passing around the REST API type // internally. - public static class InternalAddReviewerInput extends AddReviewerInput { + public static class InternalReviewerInput extends ReviewerInput { /** * Behavior when identifying reviewers fails for any reason <em>besides</em> the input not * resolving to an account/group/email. @@ -112,22 +115,16 @@ public FailureBehavior otherFailureBehavior = FailureBehavior.FAIL; } - public static InternalAddReviewerInput newAddReviewerInput( - Account.Id reviewer, ReviewerState state, NotifyHandling notify) { - // AccountResolver always resolves by ID if the input string is numeric. - return newAddReviewerInput(reviewer.toString(), state, notify); - } - - public static InternalAddReviewerInput newAddReviewerInput( + public static InternalReviewerInput newReviewerInput( String reviewer, ReviewerState state, NotifyHandling notify) { - InternalAddReviewerInput in = new InternalAddReviewerInput(); + InternalReviewerInput in = new InternalReviewerInput(); in.reviewer = reviewer; in.state = state; in.notify = notify; return in; } - public static Optional<InternalAddReviewerInput> newAddReviewerInputFromCommitIdentity( + public static Optional<InternalReviewerInput> newReviewerInputFromCommitIdentity( Change change, ObjectId commitId, @Nullable Account.Id accountId, @@ -142,7 +139,7 @@ "Adding account %d from author/committer identity of commit %s as cc to change %d", accountId.get(), commitId.name(), change.getChangeId()); - InternalAddReviewerInput in = new InternalAddReviewerInput(); + InternalReviewerInput in = new InternalReviewerInput(); in.reviewer = accountId.toString(); in.state = CC; in.notify = notify; @@ -161,9 +158,11 @@ private final Provider<AnonymousUser> anonymousProvider; private final AddReviewersOp.Factory addReviewersOpFactory; private final OutgoingEmailValidator validator; + private final DeleteReviewerOp.Factory deleteReviewerOpFactory; + private final DeleteReviewerByEmailOp.Factory deleteReviewerByEmailOpFactory; @Inject - ReviewerAdder( + ReviewerModifier( AccountResolver accountResolver, PermissionBackend permissionBackend, GroupResolver groupResolver, @@ -174,7 +173,9 @@ ProjectCache projectCache, Provider<AnonymousUser> anonymousProvider, AddReviewersOp.Factory addReviewersOpFactory, - OutgoingEmailValidator validator) { + OutgoingEmailValidator validator, + DeleteReviewerOp.Factory deleteReviewerOpFactory, + DeleteReviewerByEmailOp.Factory deleteReviewerByEmailOpFactory) { this.accountResolver = accountResolver; this.permissionBackend = permissionBackend; this.groupResolver = groupResolver; @@ -186,10 +187,12 @@ this.anonymousProvider = anonymousProvider; this.addReviewersOpFactory = addReviewersOpFactory; this.validator = validator; + this.deleteReviewerOpFactory = deleteReviewerOpFactory; + this.deleteReviewerByEmailOpFactory = deleteReviewerByEmailOpFactory; } /** - * Prepare application of a single {@link AddReviewerInput}. + * Prepare application of a single {@link ReviewerInput}. * * @param notes change notes. * @param user user performing the reviewer addition. @@ -198,12 +201,9 @@ * @return handle describing the addition operation. If the {@code op} field is present, this * operation may be added to a {@code BatchUpdate}. Otherwise, the {@code error} field * contains information about an error that occurred - * @throws IOException - * @throws PermissionBackendException - * @throws ConfigInvalidException */ - public ReviewerAddition prepare( - ChangeNotes notes, CurrentUser user, AddReviewerInput input, boolean allowGroup) + public ReviewerModification prepare( + ChangeNotes notes, CurrentUser user, ReviewerInput input, boolean allowGroup) throws IOException, PermissionBackendException, ConfigInvalidException { try (TraceContext.TraceTimer ignored = TraceContext.newTimer(getClass().getSimpleName() + "#prepare", Metadata.empty())) { @@ -215,9 +215,9 @@ .orElseThrow(illegalState(notes.getProjectName())) .is(BooleanProjectConfig.ENABLE_REVIEWER_BY_EMAIL); - ReviewerAddition byAccountId = addByAccountId(input, notes, user); + ReviewerModification byAccountId = byAccountId(input, notes, user); - ReviewerAddition wholeGroup = null; + ReviewerModification wholeGroup = null; if (!byAccountId.exactMatchFound) { wholeGroup = addWholeGroup(input, notes, user, confirmed, allowGroup, allowByEmail); if (wholeGroup != null && wholeGroup.exactMatchFound) { @@ -245,25 +245,24 @@ } } - public ReviewerAddition ccCurrentUser(CurrentUser user, RevisionResource revision) { - return new ReviewerAddition( - newAddReviewerInput(user.getUserName().orElse(null), CC, NotifyHandling.NONE), + public ReviewerModification ccCurrentUser(CurrentUser user, RevisionResource revision) { + return new ReviewerModification( + newReviewerInput(user.getUserName().orElse(null), CC, NotifyHandling.NONE), revision.getNotes(), revision.getUser(), - ImmutableSet.of(user.getAccountId()), + ImmutableSet.of(user.asIdentifiedUser().getAccount()), null, true, false); } @Nullable - private ReviewerAddition addByAccountId( - AddReviewerInput input, ChangeNotes notes, CurrentUser user) + private ReviewerModification byAccountId(ReviewerInput input, ChangeNotes notes, CurrentUser user) throws PermissionBackendException, IOException, ConfigInvalidException { IdentifiedUser reviewerUser; boolean exactMatchFound = false; try { - reviewerUser = accountResolver.resolve(input.reviewer).asUniqueUser(); + reviewerUser = accountResolver.resolveIncludeInactive(input.reviewer).asUniqueUser(); if (input.reviewer.equalsIgnoreCase(reviewerUser.getName()) || input.reviewer.equals(String.valueOf(reviewerUser.getAccountId()))) { exactMatchFound = true; @@ -275,11 +274,11 @@ } if (isValidReviewer(notes.getChange().getDest(), reviewerUser.getAccount())) { - return new ReviewerAddition( + return new ReviewerModification( input, notes, user, - ImmutableSet.of(reviewerUser.getAccountId()), + ImmutableSet.of(reviewerUser.getAccount()), null, exactMatchFound, false); @@ -291,8 +290,8 @@ } @Nullable - private ReviewerAddition addWholeGroup( - AddReviewerInput input, + private ReviewerModification addWholeGroup( + ReviewerInput input, ChangeNotes notes, CurrentUser user, boolean confirmed, @@ -325,7 +324,14 @@ MessageFormat.format(ChangeMessages.get().groupIsNotAllowed, group.getName())); } - Set<Account.Id> reviewers = new HashSet<>(); + if (input.state().equals(REMOVED)) { + return fail( + input, + FailureType.OTHER, + MessageFormat.format(ChangeMessages.get().groupRemovalIsNotAllowed, group.getName())); + } + + Set<Account> reviewers = new HashSet<>(); Set<Account> members; try { members = groupMembers.listAccounts(group.getGroupUUID(), notes.getProjectName()); @@ -362,15 +368,15 @@ for (Account member : members) { if (isValidReviewer(notes.getChange().getDest(), member)) { - reviewers.add(member.id()); + reviewers.add(member); } } - return new ReviewerAddition(input, notes, user, reviewers, null, true, true); + return new ReviewerModification(input, notes, user, reviewers, null, true, true); } @Nullable - private ReviewerAddition addByEmail(AddReviewerInput input, ChangeNotes notes, CurrentUser user) + private ReviewerModification addByEmail(ReviewerInput input, ChangeNotes notes, CurrentUser user) throws PermissionBackendException { try { permissionBackend.user(anonymousProvider.get()).change(notes).check(ChangePermission.READ); @@ -388,7 +394,7 @@ FailureType.NOT_FOUND, MessageFormat.format(ChangeMessages.get().reviewerInvalid, input.reviewer)); } - return new ReviewerAddition(input, notes, user, null, ImmutableList.of(adr), true, false); + return new ReviewerModification(input, notes, user, null, ImmutableList.of(adr), true, false); } private boolean isValidReviewer(BranchNameKey branch, Account member) @@ -404,32 +410,32 @@ } } - private ReviewerAddition fail(AddReviewerInput input, FailureType failureType, String error) { + private ReviewerModification fail(ReviewerInput input, FailureType failureType, String error) { return fail(input, failureType, false, error); } - private ReviewerAddition fail( - AddReviewerInput input, FailureType failureType, boolean confirm, String error) { - ReviewerAddition addition = new ReviewerAddition(input, failureType); + private ReviewerModification fail( + ReviewerInput input, FailureType failureType, boolean confirm, String error) { + ReviewerModification addition = new ReviewerModification(input, failureType); addition.result.confirm = confirm ? true : null; addition.result.error = error; return addition; } - public class ReviewerAddition { - public final AddReviewerResult result; - @Nullable public final AddReviewersOp op; - public final ImmutableSet<Account.Id> reviewers; + public class ReviewerModification { + public final ReviewerResult result; + @Nullable public final ReviewerOp op; + public final ImmutableSet<Account> reviewers; public final ImmutableSet<Address> reviewersByEmail; @Nullable final IdentifiedUser caller; final boolean exactMatchFound; - private final AddReviewerInput input; + private final ReviewerInput input; @Nullable private final FailureType failureType; - private ReviewerAddition(AddReviewerInput input, FailureType failureType) { + private ReviewerModification(ReviewerInput input, FailureType failureType) { this.input = input; this.failureType = requireNonNull(failureType); - result = new AddReviewerResult(input.reviewer); + result = new ReviewerResult(input.reviewer); op = null; reviewers = ImmutableSet.of(); reviewersByEmail = ImmutableSet.of(); @@ -437,11 +443,11 @@ exactMatchFound = false; } - private ReviewerAddition( - AddReviewerInput input, + private ReviewerModification( + ReviewerInput input, ChangeNotes notes, CurrentUser caller, - @Nullable Iterable<Account.Id> reviewers, + @Nullable Iterable<Account> reviewers, @Nullable Iterable<Address> reviewersByEmail, boolean exactMatchFound, boolean forGroup) { @@ -451,21 +457,47 @@ this.input = input; this.failureType = null; - result = new AddReviewerResult(input.reviewer); + result = new ReviewerResult(input.reviewer); // Always silently ignore adding the owner as any type of reviewer on their own change. They // may still be implicitly added as a reviewer if they vote, but not via the reviewer API. this.reviewers = omitOwner(notes, reviewers); this.reviewersByEmail = reviewersByEmail == null ? ImmutableSet.of() : ImmutableSet.copyOf(reviewersByEmail); this.caller = caller.asIdentifiedUser(); - op = addReviewersOpFactory.create(this.reviewers, this.reviewersByEmail, state(), forGroup); + if (state().equals(REMOVED)) { + // only one is set. + checkState( + (this.reviewers.size() == 1 && this.reviewersByEmail.isEmpty()) + || (this.reviewers.isEmpty() && this.reviewersByEmail.size() == 1)); + if (this.reviewers.size() >= 1) { + checkState(this.reviewers.size() == 1); + DeleteReviewerInput deleteReviewerInput = new DeleteReviewerInput(); + deleteReviewerInput.notify = input.notify; + deleteReviewerInput.notifyDetails = input.notifyDetails; + op = + deleteReviewerOpFactory.create( + Iterables.getOnlyElement(this.reviewers.asList()), deleteReviewerInput); + } else { + checkState(this.reviewersByEmail.size() == 1); + op = + deleteReviewerByEmailOpFactory.create( + Iterables.getOnlyElement(this.reviewersByEmail.asList())); + } + } else { + op = + addReviewersOpFactory.create( + this.reviewers.stream().map(Account::id).collect(toImmutableSet()), + this.reviewersByEmail, + state(), + forGroup); + } this.exactMatchFound = exactMatchFound; } - private ImmutableSet<Account.Id> omitOwner(ChangeNotes notes, Iterable<Account.Id> reviewers) { + private ImmutableSet<Account> omitOwner(ChangeNotes notes, Iterable<Account> reviewers) { return reviewers != null ? Streams.stream(reviewers) - .filter(id -> !id.equals(notes.getChange().getOwner())) + .filter(account -> !account.id().equals(notes.getChange().getOwner())) .collect(toImmutableSet()) : ImmutableSet.of(); } @@ -476,31 +508,52 @@ // Generate result details and fill AccountLoader. This occurs outside // the Op because the accounts are in a different table. - AddReviewersOp.Result opResult = op.getResult(); - if (state() == CC) { - result.ccs = Lists.newArrayListWithCapacity(opResult.addedCCs().size()); - for (Account.Id accountId : opResult.addedCCs()) { - result.ccs.add(json.format(new ReviewerInfo(accountId.get()), accountId, cd)); - } - accountLoaderFactory.create(true).fill(result.ccs); - for (Address a : opResult.addedCCsByEmail()) { - result.ccs.add(new AccountInfo(a.name(), a.email())); - } - } else { - result.reviewers = Lists.newArrayListWithCapacity(opResult.addedReviewers().size()); - for (PatchSetApproval psa : opResult.addedReviewers()) { - // New reviewers have value 0, don't bother normalizing. - result.reviewers.add( - json.format( - new ReviewerInfo(psa.accountId().get()), - psa.accountId(), - cd, - ImmutableList.of(psa))); - } - accountLoaderFactory.create(true).fill(result.reviewers); - for (Address a : opResult.addedReviewersByEmail()) { - result.reviewers.add(ReviewerInfo.byEmail(a.name(), a.email())); - } + ReviewerOp.Result opResult = op.getResult(); + switch (state()) { + case CC: + result.ccs = Lists.newArrayListWithCapacity(opResult.addedCCs().size()); + for (Account.Id accountId : opResult.addedCCs()) { + result.ccs.add(json.format(new ReviewerInfo(accountId.get()), accountId, cd)); + } + accountLoaderFactory.create(true).fill(result.ccs); + for (Address a : opResult.addedCCsByEmail()) { + result.ccs.add(new AccountInfo(a.name(), a.email())); + } + break; + case REVIEWER: + result.reviewers = Lists.newArrayListWithCapacity(opResult.addedReviewers().size()); + for (PatchSetApproval psa : opResult.addedReviewers()) { + // New reviewers have value 0, don't bother normalizing. + result.reviewers.add( + json.format( + new ReviewerInfo(psa.accountId().get()), + psa.accountId(), + cd, + ImmutableList.of(psa))); + } + accountLoaderFactory.create(true).fill(result.reviewers); + for (Address a : opResult.addedReviewersByEmail()) { + result.reviewers.add(ReviewerInfo.byEmail(a.name(), a.email())); + } + break; + case REMOVED: + if (opResult.deletedReviewer().isPresent()) { + result.removed = + json.format( + new ReviewerInfo(opResult.deletedReviewer().get().get()), + opResult.deletedReviewer().get(), + cd); + accountLoaderFactory.create(true).fill(ImmutableList.of(result.removed)); + } else if (opResult.deletedReviewerByEmail().isPresent()) { + result.removed = + new AccountInfo( + opResult.deletedReviewerByEmail().get().name(), + opResult.deletedReviewerByEmail().get().email()); + } + break; + default: + throw new IllegalStateException( + String.format("Illegal ReviewerState argument is %s", state().name())); } } @@ -515,8 +568,8 @@ public boolean isIgnorableFailure() { checkState(failureType != null); FailureBehavior behavior = - (input instanceof InternalAddReviewerInput) - ? ((InternalAddReviewerInput) input).otherFailureBehavior + (input instanceof InternalReviewerInput) + ? ((InternalReviewerInput) input).otherFailureBehavior : FailureBehavior.FAIL; return failureType == FailureType.OTHER && behavior == FailureBehavior.IGNORE; } @@ -526,10 +579,10 @@ return !SystemGroupBackend.isSystemGroup(groupUUID); } - public ReviewerAdditionList prepare( + public ReviewerModificationList prepare( ChangeNotes notes, CurrentUser user, - Iterable<? extends AddReviewerInput> inputs, + Iterable<? extends ReviewerInput> inputs, boolean allowGroup) throws IOException, PermissionBackendException, ConfigInvalidException { // Process CC ops before reviewer ops, so a user that appears in both lists ends up as a @@ -539,39 +592,39 @@ // TODO(dborowitz): Consider changing interface to allow excluding reviewers that were // previously processed, to proactively prevent overlap so we don't have to rely on this subtle // behavior. - ImmutableList<AddReviewerInput> sorted = + ImmutableList<ReviewerInput> sorted = Streams.stream(inputs) .sorted( comparing( - AddReviewerInput::state, + ReviewerInput::state, Ordering.explicit(ReviewerState.CC, ReviewerState.REVIEWER))) .collect(toImmutableList()); - List<ReviewerAddition> additions = new ArrayList<>(); - for (AddReviewerInput input : sorted) { - ReviewerAddition addition = prepare(notes, user, input, allowGroup); + List<ReviewerModification> additions = new ArrayList<>(); + for (ReviewerInput input : sorted) { + ReviewerModification addition = prepare(notes, user, input, allowGroup); if (addition.op != null) { // Assume any callers preparing a list of batch insertions are handling their own email. addition.op.suppressEmail(); } additions.add(addition); } - return new ReviewerAdditionList(additions); + return new ReviewerModificationList(additions); } // TODO(dborowitz): This class works, but ultimately feels wrong. It seems like an op but isn't // really an op, it's a collection of ops, and it's only called from the body of other ops. We // could make this class an op, but we would still have AddReviewersOp. Better would probably be - // to design a single op that supports combining multiple AddReviewerInputs together. That would + // to design a single op that supports combining multiple ReviewerInputs together. That would // probably also subsume the Addition class itself, which would be a good thing. - public static class ReviewerAdditionList { - private final ImmutableList<ReviewerAddition> additions; + public static class ReviewerModificationList { + private final ImmutableList<ReviewerModification> modifications; - private ReviewerAdditionList(List<ReviewerAddition> additions) { - this.additions = ImmutableList.copyOf(additions); + private ReviewerModificationList(List<ReviewerModification> modifications) { + this.modifications = ImmutableList.copyOf(modifications); } - public ImmutableList<ReviewerAddition> getFailures() { - return additions.stream() + public ImmutableList<ReviewerModification> getFailures() { + return modifications.stream() .filter(a -> a.isFailure() && !a.isIgnorableFailure()) .collect(toImmutableList()); } @@ -579,15 +632,15 @@ // We never call updateRepo on the addition ops, which is only ok because it's a no-op. public void updateChange(ChangeContext ctx, PatchSet patchSet) - throws RestApiException, IOException { - for (ReviewerAddition addition : additions()) { + throws RestApiException, IOException, PermissionBackendException { + for (ReviewerModification addition : modifications()) { addition.op.setPatchSet(patchSet); addition.op.updateChange(ctx); } } - public void postUpdate(Context ctx) throws Exception { - for (ReviewerAddition addition : additions()) { + public void postUpdate(PostUpdateContext ctx) throws Exception { + for (ReviewerModification addition : modifications()) { if (addition.op != null) { addition.op.postUpdate(ctx); } @@ -596,20 +649,20 @@ public <T> ImmutableSet<T> flattenResults( Function<AddReviewersOp.Result, ? extends Collection<T>> func) { - additions() + modifications() .forEach( a -> checkArgument( a.op != null && a.op.getResult() != null, "missing result on %s", a)); - return additions().stream() + return modifications().stream() .map(a -> a.op.getResult()) .map(func) .flatMap(Collection::stream) .collect(toImmutableSet()); } - private ImmutableList<ReviewerAddition> additions() { - return additions.stream() + private ImmutableList<ReviewerModification> modifications() { + return modifications.stream() .filter( a -> { if (a.isFailure()) {
diff --git a/java/com/google/gerrit/server/change/ReviewerOp.java b/java/com/google/gerrit/server/change/ReviewerOp.java new file mode 100644 index 0000000..12227c2 --- /dev/null +++ b/java/com/google/gerrit/server/change/ReviewerOp.java
@@ -0,0 +1,109 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.change; + +import static com.google.common.base.Preconditions.checkState; +import static java.util.Objects.requireNonNull; + +import com.google.auto.value.AutoValue; +import com.google.common.collect.ImmutableList; +import com.google.gerrit.entities.Account; +import com.google.gerrit.entities.Address; +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.entities.PatchSetApproval; +import com.google.gerrit.extensions.restapi.RestApiException; +import com.google.gerrit.server.permissions.PermissionBackendException; +import com.google.gerrit.server.update.BatchUpdateOp; +import com.google.gerrit.server.update.ChangeContext; +import java.io.IOException; +import java.util.Optional; + +public class ReviewerOp implements BatchUpdateOp { + protected boolean sendEmail = true; + protected boolean sendEvent = true; + protected Runnable eventSender = () -> {}; + protected PatchSet patchSet; + protected Result opResult; + + // TODO(dborowitz): This mutable setter is ugly, but a) it's less ugly than adding boolean args + // all the way through the constructor stack, and b) this class is slated to be completely + // rewritten. + public void suppressEmail() { + this.sendEmail = false; + } + + public void suppressEvent() { + this.sendEvent = false; + } + + public void sendEvent() { + eventSender.run(); + } + + void setPatchSet(PatchSet patchSet) { + this.patchSet = requireNonNull(patchSet); + } + + @AutoValue + public abstract static class Result { + public abstract ImmutableList<PatchSetApproval> addedReviewers(); + + public abstract ImmutableList<Address> addedReviewersByEmail(); + + public abstract ImmutableList<Account.Id> addedCCs(); + + public abstract ImmutableList<Address> addedCCsByEmail(); + + public abstract Optional<Account.Id> deletedReviewer(); + + public abstract Optional<Address> deletedReviewerByEmail(); + + static Builder builder() { + return new AutoValue_ReviewerOp_Result.Builder() + .setAddedReviewers(ImmutableList.of()) + .setAddedReviewersByEmail(ImmutableList.of()) + .setAddedCCs(ImmutableList.of()) + .setAddedCCsByEmail(ImmutableList.of()); + } + + @AutoValue.Builder + abstract static class Builder { + abstract Builder setAddedReviewers(Iterable<PatchSetApproval> addedReviewers); + + abstract Builder setAddedReviewersByEmail(Iterable<Address> addedReviewersByEmail); + + abstract Builder setAddedCCs(Iterable<Account.Id> addedCCs); + + abstract Builder setAddedCCsByEmail(Iterable<Address> addedCCsByEmail); + + abstract Builder setDeletedReviewerByEmail(Address deletedReviewerByEmail); + + abstract Builder setDeletedReviewer(Account.Id deletedReviewer); + + abstract Result build(); + } + } + + public Result getResult() { + checkState(opResult != null, "Batch update wasn't executed yet"); + return opResult; + } + + @Override + public boolean updateChange(ChangeContext ctx) + throws RestApiException, IOException, PermissionBackendException { + return false; + } +}
diff --git a/java/com/google/gerrit/server/change/RevisionJson.java b/java/com/google/gerrit/server/change/RevisionJson.java index b702440..fe45aa5 100644 --- a/java/com/google/gerrit/server/change/RevisionJson.java +++ b/java/com/google/gerrit/server/change/RevisionJson.java
@@ -182,9 +182,14 @@ info.message = commit.getFullMessage(); if (addLinks) { - ImmutableList<WebLinkInfo> links = + ImmutableList<WebLinkInfo> patchSetLinks = webLinks.getPatchSetLinks(project, commit.name(), commit.getFullMessage(), branchName); - info.webLinks = links.isEmpty() ? null : links; + info.webLinks = patchSetLinks.isEmpty() ? null : patchSetLinks; + ImmutableList<WebLinkInfo> resolveConflictsLinks = + webLinks.getResolveConflictsLinks( + project, commit.name(), commit.getFullMessage(), branchName); + info.resolveConflictsWebLinks = + resolveConflictsLinks.isEmpty() ? null : resolveConflictsLinks; } for (RevCommit parent : commit.getParents()) { @@ -244,6 +249,7 @@ String schemeName = e.getExportName(); DownloadScheme scheme = e.getProvider().get(); if (!scheme.isEnabled() + || scheme.isHidden() || (scheme.isAuthRequired() && !userProvider.get().isIdentifiedUser())) { continue; }
diff --git a/java/com/google/gerrit/server/change/SetAssigneeOp.java b/java/com/google/gerrit/server/change/SetAssigneeOp.java index 411c9b6..fd3e972 100644 --- a/java/com/google/gerrit/server/change/SetAssigneeOp.java +++ b/java/com/google/gerrit/server/change/SetAssigneeOp.java
@@ -18,7 +18,6 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.extensions.restapi.ResourceConflictException; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.server.ChangeMessagesUtil; @@ -30,7 +29,8 @@ import com.google.gerrit.server.plugincontext.PluginSetContext; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; +import com.google.gerrit.server.util.AccountTemplateUtil; import com.google.gerrit.server.validators.AssigneeValidationListener; import com.google.gerrit.server.validators.ValidationException; import com.google.inject.Inject; @@ -98,29 +98,27 @@ update.setAssignee(newAssignee.getAccountId()); // reviewdb change.setAssignee(newAssignee.getAccountId()); - addMessage(ctx, update); + addMessage(ctx); return true; } - private void addMessage(ChangeContext ctx, ChangeUpdate update) { + private void addMessage(ChangeContext ctx) { StringBuilder msg = new StringBuilder(); msg.append("Assignee "); if (oldAssignee == null) { msg.append("added: "); - msg.append(newAssignee.getNameEmail()); + msg.append(AccountTemplateUtil.getAccountTemplate(newAssignee.getAccountId())); } else { msg.append("changed from: "); - msg.append(oldAssignee.getNameEmail()); + msg.append(AccountTemplateUtil.getAccountTemplate(oldAssignee.getAccountId())); msg.append(" to: "); - msg.append(newAssignee.getNameEmail()); + msg.append(AccountTemplateUtil.getAccountTemplate(newAssignee.getAccountId())); } - ChangeMessage cmsg = - ChangeMessagesUtil.newMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_SET_ASSIGNEE); - cmUtil.addChangeMessage(update, cmsg); + cmUtil.setChangeMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_SET_ASSIGNEE); } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { try { SetAssigneeSender emailSender = setAssigneeSenderFactory.create( @@ -134,6 +132,9 @@ "Cannot send email to new assignee of change %s", change.getId()); } assigneeChanged.fire( - change, ctx.getAccount(), oldAssignee != null ? oldAssignee.state() : null, ctx.getWhen()); + ctx.getChangeData(change), + ctx.getAccount(), + oldAssignee != null ? oldAssignee.state() : null, + ctx.getWhen()); } }
diff --git a/java/com/google/gerrit/server/change/SetHashtagsOp.java b/java/com/google/gerrit/server/change/SetHashtagsOp.java index 712e1f3..bfc4834 100644 --- a/java/com/google/gerrit/server/change/SetHashtagsOp.java +++ b/java/com/google/gerrit/server/change/SetHashtagsOp.java
@@ -22,7 +22,6 @@ import com.google.common.collect.Ordering; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.extensions.api.changes.HashtagsInput; import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.extensions.restapi.BadRequestException; @@ -35,7 +34,7 @@ import com.google.gerrit.server.plugincontext.PluginSetContext; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.validators.HashtagValidationListener; import com.google.gerrit.server.validators.ValidationException; import com.google.inject.Inject; @@ -106,7 +105,7 @@ updated.addAll(toAdd); updated.removeAll(toRemove); update.setHashtags(updated); - addMessage(ctx, update); + addMessage(ctx); } updatedHashtags = ImmutableSortedSet.copyOf(updated); @@ -116,13 +115,11 @@ } } - private void addMessage(ChangeContext ctx, ChangeUpdate update) { + private void addMessage(ChangeContext ctx) { StringBuilder msg = new StringBuilder(); appendHashtagMessage(msg, "added", toAdd); appendHashtagMessage(msg, "removed", toRemove); - ChangeMessage cmsg = - ChangeMessagesUtil.newMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_SET_HASHTAGS); - cmUtil.addChangeMessage(update, cmsg); + cmUtil.setChangeMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_SET_HASHTAGS); } private void appendHashtagMessage(StringBuilder b, String action, Set<String> hashtags) { @@ -144,10 +141,15 @@ } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { if (updated() && fireEvent) { hashtagsEdited.fire( - change, ctx.getAccount(), updatedHashtags, toAdd, toRemove, ctx.getWhen()); + ctx.getChangeData(change), + ctx.getAccount(), + updatedHashtags, + toAdd, + toRemove, + ctx.getWhen()); } }
diff --git a/java/com/google/gerrit/server/change/SetPrivateOp.java b/java/com/google/gerrit/server/change/SetPrivateOp.java index 382a4f6..1274a5ed 100644 --- a/java/com/google/gerrit/server/change/SetPrivateOp.java +++ b/java/com/google/gerrit/server/change/SetPrivateOp.java
@@ -17,7 +17,6 @@ import com.google.common.base.Strings; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.extensions.common.InputWithMessage; import com.google.gerrit.extensions.restapi.BadRequestException; @@ -30,7 +29,7 @@ import com.google.gerrit.server.notedb.ChangeUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; @@ -83,18 +82,18 @@ change.setPrivate(isPrivate); change.setLastUpdatedOn(ctx.getWhen()); update.setPrivate(isPrivate); - addMessage(ctx, update); + addMessage(ctx); return true; } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { if (!isNoOp) { - privateStateChanged.fire(change, ps, ctx.getAccount(), ctx.getWhen()); + privateStateChanged.fire(ctx.getChangeData(change), ps, ctx.getAccount(), ctx.getWhen()); } } - private void addMessage(ChangeContext ctx, ChangeUpdate update) { + private void addMessage(ChangeContext ctx) { Change c = ctx.getChange(); StringBuilder buf = new StringBuilder(c.isPrivate() ? "Set private" : "Unset private"); @@ -104,13 +103,9 @@ buf.append(m); } - ChangeMessage cmsg = - ChangeMessagesUtil.newMessage( - ctx, - buf.toString(), - c.isPrivate() - ? ChangeMessagesUtil.TAG_SET_PRIVATE - : ChangeMessagesUtil.TAG_UNSET_PRIVATE); - cmUtil.addChangeMessage(update, cmsg); + cmUtil.setChangeMessage( + ctx, + buf.toString(), + c.isPrivate() ? ChangeMessagesUtil.TAG_SET_PRIVATE : ChangeMessagesUtil.TAG_UNSET_PRIVATE); } }
diff --git a/java/com/google/gerrit/server/change/SetTopicOp.java b/java/com/google/gerrit/server/change/SetTopicOp.java index c4a49b0..ee35d1d 100644 --- a/java/com/google/gerrit/server/change/SetTopicOp.java +++ b/java/com/google/gerrit/server/change/SetTopicOp.java
@@ -17,14 +17,13 @@ import com.google.common.base.Strings; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.extensions.restapi.BadRequestException; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.extensions.events.TopicEdited; import com.google.gerrit.server.notedb.ChangeUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.validators.ValidationException; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; @@ -74,16 +73,14 @@ } catch (ValidationException ex) { throw new BadRequestException(ex.getMessage()); } - ChangeMessage cmsg = - ChangeMessagesUtil.newMessage(ctx, summary, ChangeMessagesUtil.TAG_SET_TOPIC); - cmUtil.addChangeMessage(update, cmsg); + cmUtil.setChangeMessage(ctx, summary, ChangeMessagesUtil.TAG_SET_TOPIC); return true; } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { if (change != null) { - topicEdited.fire(change, ctx.getAccount(), oldTopicName, ctx.getWhen()); + topicEdited.fire(ctx.getChangeData(change), ctx.getAccount(), oldTopicName, ctx.getWhen()); } } }
diff --git a/java/com/google/gerrit/server/change/SubmitRequirementsJson.java b/java/com/google/gerrit/server/change/SubmitRequirementsJson.java new file mode 100644 index 0000000..8eeec62 --- /dev/null +++ b/java/com/google/gerrit/server/change/SubmitRequirementsJson.java
@@ -0,0 +1,63 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.change; + +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementExpression; +import com.google.gerrit.entities.SubmitRequirementExpressionResult; +import com.google.gerrit.entities.SubmitRequirementResult; +import com.google.gerrit.extensions.common.SubmitRequirementExpressionInfo; +import com.google.gerrit.extensions.common.SubmitRequirementResultInfo; + +/** + * Produces submit requirements related entities like {@link SubmitRequirementResultInfo}s, which + * are serialized to JSON afterwards. + */ +public class SubmitRequirementsJson { + private SubmitRequirementsJson() {} + + public static SubmitRequirementResultInfo toInfo( + SubmitRequirement req, SubmitRequirementResult result) { + SubmitRequirementResultInfo info = new SubmitRequirementResultInfo(); + info.name = req.name(); + info.description = req.description().orElse(null); + if (req.applicabilityExpression().isPresent()) { + info.applicabilityExpressionResult = + submitRequirementExpressionToInfo( + req.applicabilityExpression().get(), result.applicabilityExpressionResult().get()); + } + if (req.overrideExpression().isPresent()) { + info.overrideExpressionResult = + submitRequirementExpressionToInfo( + req.overrideExpression().get(), result.overrideExpressionResult().get()); + } + info.submittabilityExpressionResult = + submitRequirementExpressionToInfo( + req.submittabilityExpression(), result.submittabilityExpressionResult()); + info.status = SubmitRequirementResultInfo.Status.valueOf(result.status().toString()); + info.isLegacy = result.isLegacy(); + return info; + } + + private static SubmitRequirementExpressionInfo submitRequirementExpressionToInfo( + SubmitRequirementExpression expression, SubmitRequirementExpressionResult result) { + SubmitRequirementExpressionInfo info = new SubmitRequirementExpressionInfo(); + info.expression = expression.expressionString(); + info.fulfilled = result.status().equals(SubmitRequirementExpressionResult.Status.PASS); + info.passingAtoms = result.passingAtoms(); + info.failingAtoms = result.failingAtoms(); + return info; + } +}
diff --git a/java/com/google/gerrit/server/change/WorkInProgressOp.java b/java/com/google/gerrit/server/change/WorkInProgressOp.java index f0ebb80..1409170 100644 --- a/java/com/google/gerrit/server/change/WorkInProgressOp.java +++ b/java/com/google/gerrit/server/change/WorkInProgressOp.java
@@ -18,7 +18,6 @@ import com.google.common.collect.ImmutableList; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -30,7 +29,7 @@ import com.google.gerrit.server.notedb.ChangeUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RepoView; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; @@ -65,7 +64,7 @@ private Change change; private ChangeNotes notes; private PatchSet ps; - private ChangeMessage cmsg; + private String mailMessage; @Inject WorkInProgressOp( @@ -99,11 +98,11 @@ } change.setLastUpdatedOn(ctx.getWhen()); update.setWorkInProgress(workInProgress); - addMessage(ctx, update); + addMessage(ctx); return true; } - private void addMessage(ChangeContext ctx, ChangeUpdate update) { + private void addMessage(ChangeContext ctx) { Change c = ctx.getChange(); StringBuilder buf = new StringBuilder(c.isWorkInProgress() ? "Set Work In Progress" : "Set Ready For Review"); @@ -114,20 +113,18 @@ buf.append(m); } - cmsg = - ChangeMessagesUtil.newMessage( + mailMessage = + cmUtil.setChangeMessage( ctx, buf.toString(), c.isWorkInProgress() ? ChangeMessagesUtil.TAG_SET_WIP : ChangeMessagesUtil.TAG_SET_READY); - - cmUtil.addChangeMessage(update, cmsg); } @Override - public void postUpdate(Context ctx) { - stateChanged.fire(change, ps, ctx.getAccount(), ctx.getWhen()); + public void postUpdate(PostUpdateContext ctx) { + stateChanged.fire(ctx.getChangeData(change), ps, ctx.getAccount(), ctx.getWhen()); NotifyResolver.Result notify = ctx.getNotify(change.getId()); if (workInProgress || notify.handling().compareTo(NotifyHandling.OWNER_REVIEWERS) < 0 @@ -147,9 +144,10 @@ notes, ps, ctx.getIdentifiedUser(), - cmsg, + mailMessage, + ctx.getWhen(), ImmutableList.of(), - cmsg.getMessage(), + mailMessage, ImmutableList.of(), repoView) .sendAsync();
diff --git a/java/com/google/gerrit/server/comment/CommentContextCacheImpl.java b/java/com/google/gerrit/server/comment/CommentContextCacheImpl.java index e12b538..5be41d4 100644 --- a/java/com/google/gerrit/server/comment/CommentContextCacheImpl.java +++ b/java/com/google/gerrit/server/comment/CommentContextCacheImpl.java
@@ -99,25 +99,26 @@ Iterable<CommentContextKey> inputKeys) { ImmutableMap.Builder<CommentContextKey, CommentContext> result = ImmutableMap.builder(); - List<CommentContextKey> adjustedKeys = + // We do two transformations to the input keys: first we adjust the max context padding, and + // second we hash the file path. The transformed keys are used to request context from the + // cache. Keeping a map of the original inputKeys to the transformed keys + Map<CommentContextKey, CommentContextKey> inputKeysToCacheKeys = Streams.stream(inputKeys) - .map(CommentContextCacheImpl::adjustMaxContextPadding) - .collect(ImmutableList.toImmutableList()); - - // Convert the input keys to the same keys but with their file paths hashed - Map<CommentContextKey, CommentContextKey> keysToCacheKeys = - adjustedKeys.stream() .collect( Collectors.toMap( Function.identity(), - k -> k.toBuilder().path(Loader.hashPath(k.path())).build())); + k -> + adjustMaxContextPadding(k) + .toBuilder() + .path(Loader.hashPath(k.path())) + .build())); try { ImmutableMap<CommentContextKey, CommentContext> allContext = - contextCache.getAll(keysToCacheKeys.values()); + contextCache.getAll(inputKeysToCacheKeys.values()); for (CommentContextKey inputKey : inputKeys) { - CommentContextKey cacheKey = keysToCacheKeys.get(adjustMaxContextPadding(inputKey)); + CommentContextKey cacheKey = inputKeysToCacheKeys.get(inputKey); result.put(inputKey, allContext.get(cacheKey)); } return result.build(); @@ -255,14 +256,17 @@ List<HumanComment> allComments = Streams.concat(humanComments.stream(), drafts.stream()).collect(Collectors.toList()); CommentContextLoader loader = factory.create(project); - Map<ContextInput, CommentContextKey> commentsToKeys = new HashMap<>(); + Map<CommentContextKey, ContextInput> keysToComments = new HashMap<>(); for (CommentContextKey key : keys) { Comment comment = getCommentForKey(allComments, key); - commentsToKeys.put(ContextInput.fromComment(comment, key.contextPadding()), key); + keysToComments.put(key, ContextInput.fromComment(comment, key.contextPadding())); } - Map<ContextInput, CommentContext> allContext = loader.getContext(commentsToKeys.keySet()); - return allContext.entrySet().stream() - .collect(Collectors.toMap(e -> commentsToKeys.get(e.getKey()), Map.Entry::getValue)); + Map<ContextInput, CommentContext> allContext = + loader.getContext( + keysToComments.values().stream().distinct().collect(Collectors.toList())); + return keys.stream() + .collect( + Collectors.toMap(Function.identity(), k -> allContext.get(keysToComments.get(k)))); } /**
diff --git a/java/com/google/gerrit/server/comment/CommentContextLoader.java b/java/com/google/gerrit/server/comment/CommentContextLoader.java index a5aca48..8fbb259 100644 --- a/java/com/google/gerrit/server/comment/CommentContextLoader.java +++ b/java/com/google/gerrit/server/comment/CommentContextLoader.java
@@ -46,6 +46,8 @@ import java.util.List; import java.util.Map; import java.util.Optional; +import org.eclipse.jgit.errors.IncorrectObjectTypeException; +import org.eclipse.jgit.errors.MissingObjectException; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.ObjectReader; import org.eclipse.jgit.lib.Repository; @@ -101,7 +103,16 @@ try (Repository repo = repoManager.openRepository(project); RevWalk rw = new RevWalk(repo)) { for (ObjectId commitId : commentsByCommitId.keySet()) { - RevCommit commit = rw.parseCommit(commitId); + RevCommit commit; + try { + commit = rw.parseCommit(commitId); + } catch (IncorrectObjectTypeException | MissingObjectException e) { + logger.atWarning().log("Commit %s is missing or has an incorrect object type", commitId); + commentsByCommitId + .get(commitId) + .forEach(contextInput -> result.put(contextInput, CommentContext.empty())); + continue; + } for (ContextInput contextInput : commentsByCommitId.get(commitId)) { Optional<Range> range = getStartAndEndLines(contextInput); if (!range.isPresent()) {
diff --git a/java/com/google/gerrit/server/config/AllProjectsConfigProvider.java b/java/com/google/gerrit/server/config/AllProjectsConfigProvider.java new file mode 100644 index 0000000..27ae41f --- /dev/null +++ b/java/com/google/gerrit/server/config/AllProjectsConfigProvider.java
@@ -0,0 +1,8 @@ +package com.google.gerrit.server.config; + +import java.util.Optional; +import org.eclipse.jgit.lib.StoredConfig; + +public interface AllProjectsConfigProvider { + Optional<StoredConfig> get(AllProjectsName allProjectsName); +}
diff --git a/java/com/google/gerrit/server/config/AuthConfig.java b/java/com/google/gerrit/server/config/AuthConfig.java index de57d04..b6ffcee 100644 --- a/java/com/google/gerrit/server/config/AuthConfig.java +++ b/java/com/google/gerrit/server/config/AuthConfig.java
@@ -64,6 +64,8 @@ private final boolean cookieSecure; private final SignedToken emailReg; private final boolean allowRegisterNewEmail; + private final boolean userNameCaseInsensitive; + private final boolean userNameCaseInsensitiveMigrationMode; private GitBasicAuthPolicy gitBasicAuthPolicy; @Inject @@ -95,6 +97,9 @@ useContributorAgreements = cfg.getBoolean("auth", "contributoragreements", false); userNameToLowerCase = cfg.getBoolean("auth", "userNameToLowerCase", false); allowRegisterNewEmail = cfg.getBoolean("auth", "allowRegisterNewEmail", true); + userNameCaseInsensitive = cfg.getBoolean("auth", "userNameCaseInsensitive", false); + userNameCaseInsensitiveMigrationMode = + cfg.getBoolean("auth", "userNameCaseInsensitiveMigrationMode", false); if (gitBasicAuthPolicy == GitBasicAuthPolicy.HTTP_LDAP && authType != AuthType.LDAP @@ -227,7 +232,7 @@ return trustContainerAuth; } - /** @return true if users with Run As capability can impersonate others. */ + /** Returns true if users with Run As capability can impersonate others. */ public boolean isRunAsEnabled() { return enableRunAs; } @@ -237,6 +242,16 @@ return userNameToLowerCase; } + /** Whether user name should be matched case insenitive */ + public boolean isUserNameCaseInsensitive() { + return userNameCaseInsensitive; + } + + /** Whether user name case insensitive migration is in progress */ + public boolean isUserNameCaseInsensitiveMigrationMode() { + return userNameCaseInsensitiveMigrationMode; + } + public GitBasicAuthPolicy getGitBasicAuthPolicy() { return gitBasicAuthPolicy; }
diff --git a/java/com/google/gerrit/server/config/CapabilityConstants.java b/java/com/google/gerrit/server/config/CapabilityConstants.java index 4ab97f8..59819bb 100644 --- a/java/com/google/gerrit/server/config/CapabilityConstants.java +++ b/java/com/google/gerrit/server/config/CapabilityConstants.java
@@ -39,10 +39,10 @@ public String runAs; public String runGC; public String streamEvents; + public String viewAccess; public String viewAllAccounts; public String viewCaches; public String viewConnections; public String viewPlugins; public String viewQueue; - public String viewAccess; }
diff --git a/java/com/google/gerrit/server/config/ConfigUpdatedEvent.java b/java/com/google/gerrit/server/config/ConfigUpdatedEvent.java index b37e489..4032e63 100644 --- a/java/com/google/gerrit/server/config/ConfigUpdatedEvent.java +++ b/java/com/google/gerrit/server/config/ConfigUpdatedEvent.java
@@ -32,9 +32,9 @@ * <p>1. Help the callers figure out if any action should be taken, depending on which entries are * updated in gerrit.config. * - * <p>2. Provide the callers with a mechanism to accept/reject the entries of interest: @see - * accept(Set<ConfigKey> entries), @see accept(String section), @see reject(Set<ConfigKey> entries) - * (+ various overloaded versions of these) + * <p>2. Provide the callers with a mechanism to accept/reject the entries of interest: {@link + * #accept(Set)}, {@link #accept(String)}, {@link #reject(Set)} (+ various overloaded versions of + * these) */ public class ConfigUpdatedEvent { public static final ImmutableMultimap<UpdateResult, ConfigUpdateEntry> NO_UPDATES =
diff --git a/java/com/google/gerrit/server/config/ConfigUtil.java b/java/com/google/gerrit/server/config/ConfigUtil.java index 27ded63..c44b0fd 100644 --- a/java/com/google/gerrit/server/config/ConfigUtil.java +++ b/java/com/google/gerrit/server/config/ConfigUtil.java
@@ -282,7 +282,6 @@ * @param sub subsection * @param s instance of class with config values * @param defaults instance of class with default values - * @throws ConfigInvalidException */ public static <T> void storeSection(Config cfg, String section, String sub, T s, T defaults) throws ConfigInvalidException { @@ -341,7 +340,6 @@ * @param i instance to merge during the load. When present, the boolean fields are not nullified * when their values are false * @return loaded instance - * @throws ConfigInvalidException */ public static <T> T loadSection(Config cfg, String section, String sub, T s, T defaults, T i) throws ConfigInvalidException {
diff --git a/java/com/google/gerrit/server/config/DefaultUrlFormatter.java b/java/com/google/gerrit/server/config/DefaultUrlFormatter.java index 060ee3f..095fa3e 100644 --- a/java/com/google/gerrit/server/config/DefaultUrlFormatter.java +++ b/java/com/google/gerrit/server/config/DefaultUrlFormatter.java
@@ -25,7 +25,7 @@ public class DefaultUrlFormatter implements UrlFormatter { private final Provider<String> canonicalWebUrlProvider; - public static class Module extends AbstractModule { + public static class DefaultUrlFormatterModule extends AbstractModule { @Override protected void configure() { DynamicItem.itemOf(binder(), UrlFormatter.class);
diff --git a/java/com/google/gerrit/server/config/DownloadConfig.java b/java/com/google/gerrit/server/config/DownloadConfig.java index 58ce098..7e80409 100644 --- a/java/com/google/gerrit/server/config/DownloadConfig.java +++ b/java/com/google/gerrit/server/config/DownloadConfig.java
@@ -14,7 +14,9 @@ package com.google.gerrit.server.config; +import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.ImmutableSet; +import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.CoreDownloadSchemes; import com.google.gerrit.extensions.client.GeneralPreferencesInfo.DownloadCommand; import com.google.gerrit.server.change.ArchiveFormatInternal; @@ -23,8 +25,11 @@ import java.lang.reflect.Field; import java.lang.reflect.Modifier; import java.util.ArrayList; +import java.util.Arrays; import java.util.EnumSet; +import java.util.HashSet; import java.util.List; +import java.util.Set; import org.eclipse.jgit.lib.Config; /** @@ -35,12 +40,16 @@ */ @Singleton public class DownloadConfig { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + private final ImmutableSet<String> downloadSchemes; + private final ImmutableSet<String> hiddenSchemes; private final ImmutableSet<DownloadCommand> downloadCommands; private final ImmutableSet<ArchiveFormatInternal> archiveFormats; @Inject - DownloadConfig(@GerritServerConfig Config cfg) { + @VisibleForTesting + public DownloadConfig(@GerritServerConfig Config cfg) { String[] allSchemes = cfg.getStringList("download", null, "scheme"); if (allSchemes.length == 0) { downloadSchemes = @@ -51,13 +60,18 @@ for (String s : allSchemes) { String core = toCoreScheme(s); if (core == null) { - throw new IllegalArgumentException("not a core download scheme: " + s); + logger.atWarning().log("not a core download scheme: " + s); + continue; } normalized.add(core); } downloadSchemes = ImmutableSet.copyOf(normalized); } + Set<String> hidden = new HashSet<>(Arrays.asList(cfg.getStringList("download", null, "hide"))); + hidden.retainAll(downloadSchemes); + hiddenSchemes = ImmutableSet.copyOf(hidden); + DownloadCommand[] downloadCommandValues = DownloadCommand.values(); List<DownloadCommand> allCommands = ConfigUtil.getEnumList(cfg, "download", null, "command", downloadCommandValues, null); @@ -104,6 +118,11 @@ return downloadSchemes; } + /** Scheme hidden in the UI. */ + public ImmutableSet<String> getHiddenSchemes() { + return hiddenSchemes; + } + /** Command used to download. */ public ImmutableSet<DownloadCommand> getDownloadCommands() { return downloadCommands;
diff --git a/java/com/google/gerrit/server/config/FileBasedAllProjectsConfigProvider.java b/java/com/google/gerrit/server/config/FileBasedAllProjectsConfigProvider.java new file mode 100644 index 0000000..ebb0e50 --- /dev/null +++ b/java/com/google/gerrit/server/config/FileBasedAllProjectsConfigProvider.java
@@ -0,0 +1,33 @@ +package com.google.gerrit.server.config; + +import com.google.common.annotations.VisibleForTesting; +import com.google.gerrit.server.project.ProjectConfig; +import com.google.inject.Inject; +import java.util.Optional; +import javax.inject.Singleton; +import org.eclipse.jgit.lib.StoredConfig; +import org.eclipse.jgit.storage.file.FileBasedConfig; +import org.eclipse.jgit.util.FS; + +@Singleton +public class FileBasedAllProjectsConfigProvider implements AllProjectsConfigProvider { + private final SitePaths sitePaths; + + @VisibleForTesting + @Inject + public FileBasedAllProjectsConfigProvider(SitePaths sitePaths) { + this.sitePaths = sitePaths; + } + + @Override + public Optional<StoredConfig> get(AllProjectsName allProjectsName) { + return Optional.of( + new FileBasedConfig( + sitePaths + .etc_dir + .resolve(allProjectsName.get()) + .resolve(ProjectConfig.PROJECT_CONFIG) + .toFile(), + FS.DETECTED)); + } +}
diff --git a/java/com/google/gerrit/server/config/FileBasedGlobalPluginConfigProvider.java b/java/com/google/gerrit/server/config/FileBasedGlobalPluginConfigProvider.java new file mode 100644 index 0000000..098d2c2 --- /dev/null +++ b/java/com/google/gerrit/server/config/FileBasedGlobalPluginConfigProvider.java
@@ -0,0 +1,57 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.config; + +import com.google.common.flogger.FluentLogger; +import com.google.inject.Inject; +import com.google.inject.Singleton; +import java.io.IOException; +import java.nio.file.Path; +import org.eclipse.jgit.errors.ConfigInvalidException; +import org.eclipse.jgit.lib.Config; +import org.eclipse.jgit.storage.file.FileBasedConfig; +import org.eclipse.jgit.util.FS; + +@Singleton +public class FileBasedGlobalPluginConfigProvider implements GlobalPluginConfigProvider { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + private final SitePaths site; + + @Inject + FileBasedGlobalPluginConfigProvider(SitePaths site) { + this.site = site; + } + + @Override + public Config get(String pluginName) { + Path pluginConfigFile = site.etc_dir.resolve(pluginName + ".config"); + FileBasedConfig cfg = new FileBasedConfig(pluginConfigFile.toFile(), FS.DETECTED); + if (!cfg.getFile().exists()) { + logger.atInfo().log("No %s; assuming defaults", pluginConfigFile.toAbsolutePath()); + return cfg; + } + + try { + cfg.load(); + } catch (ConfigInvalidException e) { + // This is an error in user input, don't spam logs with a stack trace. + logger.atWarning().log( + "Failed to load %s: %s", pluginConfigFile.toAbsolutePath(), e.getMessage()); + } catch (IOException e) { + logger.atWarning().withCause(e).log("Failed to load %s", pluginConfigFile.toAbsolutePath()); + } + return cfg; + } +}
diff --git a/java/com/google/gerrit/server/config/GerritGlobalModule.java b/java/com/google/gerrit/server/config/GerritGlobalModule.java index 3fd017c..75df0e8 100644 --- a/java/com/google/gerrit/server/config/GerritGlobalModule.java +++ b/java/com/google/gerrit/server/config/GerritGlobalModule.java
@@ -66,23 +66,26 @@ import com.google.gerrit.extensions.validators.CommentValidator; import com.google.gerrit.extensions.webui.BranchWebLink; import com.google.gerrit.extensions.webui.DiffWebLink; +import com.google.gerrit.extensions.webui.EditWebLink; import com.google.gerrit.extensions.webui.FileHistoryWebLink; import com.google.gerrit.extensions.webui.FileWebLink; import com.google.gerrit.extensions.webui.ParentWebLink; import com.google.gerrit.extensions.webui.PatchSetWebLink; import com.google.gerrit.extensions.webui.ProjectWebLink; +import com.google.gerrit.extensions.webui.ResolveConflictsWebLink; import com.google.gerrit.extensions.webui.TagWebLink; import com.google.gerrit.extensions.webui.TopMenu; import com.google.gerrit.extensions.webui.WebUiPlugin; import com.google.gerrit.server.AnonymousUser; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.CmdLineParserModule; import com.google.gerrit.server.CreateGroupPermissionSyncer; +import com.google.gerrit.server.DeadlineChecker; import com.google.gerrit.server.DynamicOptions; import com.google.gerrit.server.ExceptionHook; import com.google.gerrit.server.ExceptionHookImpl; import com.google.gerrit.server.ExternalUser; import com.google.gerrit.server.IdentifiedUser; +import com.google.gerrit.server.PerformanceMetrics; import com.google.gerrit.server.RequestListener; import com.google.gerrit.server.TraceRequestListener; import com.google.gerrit.server.account.AccountCacheImpl; @@ -90,6 +93,8 @@ import com.google.gerrit.server.account.AccountDeactivator; import com.google.gerrit.server.account.AccountExternalIdCreator; import com.google.gerrit.server.account.AccountManager; +import com.google.gerrit.server.account.AccountModule; +import com.google.gerrit.server.account.AccountTagProvider; import com.google.gerrit.server.account.AccountVisibilityProvider; import com.google.gerrit.server.account.CapabilityCollection; import com.google.gerrit.server.account.EmailExpander; @@ -98,7 +103,11 @@ import com.google.gerrit.server.account.GroupIncludeCacheImpl; import com.google.gerrit.server.account.ServiceUserClassifierImpl; import com.google.gerrit.server.account.VersionedAuthorizedKeys; +import com.google.gerrit.server.account.externalids.ExternalIdCacheModule; import com.google.gerrit.server.account.externalids.ExternalIdModule; +import com.google.gerrit.server.account.externalids.ExternalIdUpsertPreprocessor; +import com.google.gerrit.server.approval.ApprovalCacheImpl; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.auth.AuthBackend; import com.google.gerrit.server.auth.UniversalAuthBackend; import com.google.gerrit.server.avatar.AvatarProvider; @@ -125,6 +134,7 @@ import com.google.gerrit.server.git.GitModule; import com.google.gerrit.server.git.MergeUtil; import com.google.gerrit.server.git.MergedByPushOp; +import com.google.gerrit.server.git.MultiProgressMonitor; import com.google.gerrit.server.git.NotesBranchUtil; import com.google.gerrit.server.git.PureRevertCache; import com.google.gerrit.server.git.ReceivePackInitializer; @@ -163,6 +173,7 @@ import com.google.gerrit.server.mime.FileTypeRegistry; import com.google.gerrit.server.mime.MimeUtilFileTypeRegistry; import com.google.gerrit.server.notedb.NoteDbModule; +import com.google.gerrit.server.notedb.StoreSubmitRequirementsOp; import com.google.gerrit.server.patch.DiffOperationsImpl; import com.google.gerrit.server.patch.PatchListCacheImpl; import com.google.gerrit.server.patch.PatchScriptFactory; @@ -176,7 +187,9 @@ import com.google.gerrit.server.project.ProjectCacheImpl; import com.google.gerrit.server.project.ProjectNameLockManager; import com.google.gerrit.server.project.ProjectState; +import com.google.gerrit.server.project.SubmitRequirementsEvaluatorImpl; import com.google.gerrit.server.project.SubmitRuleEvaluator; +import com.google.gerrit.server.query.approval.ApprovalModule; import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.query.change.ChangeIsVisibleToPredicate; import com.google.gerrit.server.query.change.ChangeQueryBuilder; @@ -185,8 +198,8 @@ import com.google.gerrit.server.restapi.change.OnPostReview; import com.google.gerrit.server.restapi.change.SuggestReviewers; import com.google.gerrit.server.restapi.group.GroupModule; -import com.google.gerrit.server.rules.DefaultSubmitRule; -import com.google.gerrit.server.rules.IgnoreSelfApprovalRule; +import com.google.gerrit.server.rules.DefaultSubmitRule.DefaultSubmitRuleModule; +import com.google.gerrit.server.rules.IgnoreSelfApprovalRule.IgnoreSelfApprovalRuleModule; import com.google.gerrit.server.rules.PrologModule; import com.google.gerrit.server.rules.RulesCache; import com.google.gerrit.server.rules.SubmitRule; @@ -235,6 +248,7 @@ bind(RulesCache.class); bind(BlameCache.class).to(BlameCacheImpl.class); install(AccountCacheImpl.module()); + install(ApprovalCacheImpl.module()); install(BatchUpdate.module()); install(ChangeKindCacheImpl.module()); install(ChangeFinder.module()); @@ -252,28 +266,34 @@ install(TagCache.module()); install(PureRevertCache.module()); install(CommentContextCacheImpl.module()); + install(SubmitRequirementsEvaluatorImpl.module()); install(new AccessControlModule()); + install(new AccountModule()); install(new CmdLineParserModule()); install(new EmailModule()); + install(new ExternalIdCacheModule()); install(new ExternalIdModule()); install(new GitModule()); install(new GroupDbModule()); install(new GroupModule()); install(new NoteDbModule()); install(new PrologModule(cfg)); - install(new DefaultSubmitRule.Module()); - install(new IgnoreSelfApprovalRule.Module()); + install(new DefaultSubmitRuleModule()); + install(new IgnoreSelfApprovalRuleModule()); install(new ReceiveCommitsModule()); install(new SshAddressesModule()); - install(new FileInfoJsonModule(cfg)); + install(new FileInfoJsonModule()); install(ThreadLocalRequestContext.module()); + install(new ApprovalModule()); factory(CapabilityCollection.Factory.class); factory(ChangeData.AssistedFactory.class); factory(ChangeJson.AssistedFactory.class); factory(ChangeIsVisibleToPredicate.Factory.class); + factory(DeadlineChecker.Factory.class); factory(MergeUtil.Factory.class); + factory(MultiProgressMonitor.Factory.class); factory(PatchScriptFactory.Factory.class); factory(PatchScriptFactoryForAutoFix.Factory.class); factory(ProjectState.Factory.class); @@ -391,10 +411,12 @@ DynamicMap.mapOf(binder(), ProjectConfigEntry.class); DynamicSet.setOf(binder(), PluginPushOption.class); DynamicSet.setOf(binder(), PatchSetWebLink.class); + DynamicSet.setOf(binder(), ResolveConflictsWebLink.class); DynamicSet.setOf(binder(), ParentWebLink.class); DynamicSet.setOf(binder(), FileWebLink.class); DynamicSet.setOf(binder(), FileHistoryWebLink.class); DynamicSet.setOf(binder(), DiffWebLink.class); + DynamicSet.setOf(binder(), EditWebLink.class); DynamicSet.setOf(binder(), ProjectWebLink.class); DynamicSet.setOf(binder(), BranchWebLink.class); DynamicSet.setOf(binder(), TagWebLink.class); @@ -410,6 +432,9 @@ DynamicSet.setOf(binder(), SubmitRule.class); DynamicSet.setOf(binder(), QuotaEnforcer.class); DynamicSet.setOf(binder(), PerformanceLogger.class); + if (cfg.getBoolean("tracing", "exportPerformanceMetrics", false)) { + DynamicSet.bind(binder(), PerformanceLogger.class).to(PerformanceMetrics.class); + } DynamicSet.setOf(binder(), RequestListener.class); DynamicSet.bind(binder(), RequestListener.class).to(TraceRequestListener.class); DynamicSet.setOf(binder(), ChangeETagComputation.class); @@ -417,6 +442,7 @@ DynamicSet.bind(binder(), ExceptionHook.class).to(ExceptionHookImpl.class); DynamicSet.setOf(binder(), MailSoyTemplateProvider.class); DynamicSet.setOf(binder(), OnPostReview.class); + DynamicMap.mapOf(binder(), AccountTagProvider.class); DynamicMap.mapOf(binder(), MailFilter.class); bind(MailFilter.class).annotatedWith(Exports.named("ListMailFilter")).to(ListMailFilter.class); @@ -458,6 +484,7 @@ factory(MergedByPushOp.Factory.class); factory(GitModules.Factory.class); factory(VersionedAuthorizedKeys.Factory.class); + factory(StoreSubmitRequirementsOp.Factory.class); bind(AccountManager.class); bind(SubscriptionGraph.Factory.class).to(ConfiguredSubscriptionGraphFactory.class); @@ -468,5 +495,6 @@ bind(ReloadPluginListener.class) .annotatedWith(UniqueAnnotations.create()) .to(PluginConfigFactory.class); + DynamicMap.mapOf(binder(), ExternalIdUpsertPreprocessor.class); } }
diff --git a/java/com/google/gerrit/server/config/GerritIsReplica.java b/java/com/google/gerrit/server/config/GerritIsReplica.java index 154fdcd..ab6aa8b 100644 --- a/java/com/google/gerrit/server/config/GerritIsReplica.java +++ b/java/com/google/gerrit/server/config/GerritIsReplica.java
@@ -19,7 +19,7 @@ import com.google.inject.BindingAnnotation; import java.lang.annotation.Retention; -/* Marker on {@link Boolean} indicating whether Gerrit is run as a read-only replica. */ +/** Marker on {@link Boolean} indicating whether Gerrit is run as a read-only replica. */ @Retention(RUNTIME) @BindingAnnotation public @interface GerritIsReplica {}
diff --git a/java/com/google/gerrit/server/config/GerritOptions.java b/java/com/google/gerrit/server/config/GerritOptions.java index d9edf23..0390620 100644 --- a/java/com/google/gerrit/server/config/GerritOptions.java +++ b/java/com/google/gerrit/server/config/GerritOptions.java
@@ -14,15 +14,23 @@ package com.google.gerrit.server.config; +import com.google.common.base.Strings; +import com.google.gerrit.common.Nullable; +import java.util.Optional; + public class GerritOptions { private final boolean headless; private final boolean slave; - private final String devCdn; + private final Optional<String> devCdn; - public GerritOptions(boolean headless, boolean slave, String devCdn) { + public GerritOptions(boolean headless, boolean slave) { + this(headless, slave, null); + } + + public GerritOptions(boolean headless, boolean slave, @Nullable String devCdn) { this.headless = headless; this.slave = slave; - this.devCdn = devCdn; + this.devCdn = headless ? Optional.empty() : Optional.ofNullable(Strings.emptyToNull(devCdn)); } public boolean headless() { @@ -33,11 +41,7 @@ return !slave; } - public String devCdn() { + public Optional<String> devCdn() { return devCdn; } - - public boolean useDevCdn() { - return !headless && devCdn.length() > 0; - } }
diff --git a/java/com/google/gerrit/server/config/GerritServerConfigModule.java b/java/com/google/gerrit/server/config/GerritServerConfigModule.java index 3777a55..8ddcdac 100644 --- a/java/com/google/gerrit/server/config/GerritServerConfigModule.java +++ b/java/com/google/gerrit/server/config/GerritServerConfigModule.java
@@ -20,8 +20,6 @@ import com.google.gerrit.server.securestore.SecureStore; import com.google.gerrit.server.securestore.SecureStoreProvider; import com.google.inject.AbstractModule; -import com.google.inject.Guice; -import com.google.inject.Injector; import com.google.inject.ProvisionException; import java.io.IOException; import java.nio.file.Path; @@ -42,22 +40,13 @@ } private static String getSecureStoreFromGerritConfig(Path sitePath) { - AbstractModule m = - new AbstractModule() { - @Override - protected void configure() { - bind(Path.class).annotatedWith(SitePath.class).toInstance(sitePath); - bind(SitePaths.class); - } - }; - Injector injector = Guice.createInjector(m); - SitePaths site = injector.getInstance(SitePaths.class); - FileBasedConfig cfg = new FileBasedConfig(site.gerrit_config.toFile(), FS.DETECTED); - if (!cfg.getFile().exists()) { - return DefaultSecureStore.class.getName(); - } - try { + SitePaths site = new SitePaths(sitePath); + FileBasedConfig cfg = new FileBasedConfig(site.gerrit_config.toFile(), FS.DETECTED); + if (!cfg.getFile().exists()) { + return DefaultSecureStore.class.getName(); + } + cfg.load(); String className = cfg.getString("gerrit", null, "secureStoreClass"); return nullToDefault(className); @@ -77,6 +66,8 @@ bind(Config.class) .annotatedWith(GerritServerConfig.class) .toProvider(GerritServerConfigProvider.class); + bind(AllProjectsConfigProvider.class).to(FileBasedAllProjectsConfigProvider.class); + bind(GlobalPluginConfigProvider.class).to(FileBasedGlobalPluginConfigProvider.class); bind(SecureStore.class).toProvider(SecureStoreProvider.class).in(SINGLETON); bind(Boolean.class) .annotatedWith(GerritIsReplica.class)
diff --git a/java/com/google/gerrit/server/config/GitwebCgiConfig.java b/java/com/google/gerrit/server/config/GitwebCgiConfig.java index d7fb83c..1ed0f16 100644 --- a/java/com/google/gerrit/server/config/GitwebCgiConfig.java +++ b/java/com/google/gerrit/server/config/GitwebCgiConfig.java
@@ -118,22 +118,22 @@ this.logoPng = null; } - /** @return local path to the CGI executable; null if we shouldn't execute. */ + /** Returns local path to the CGI executable; null if we shouldn't execute. */ public Path getGitwebCgi() { return cgi; } - /** @return local path of the {@code gitweb.css} matching the CGI. */ + /** Returns local path of the {@code gitweb.css} matching the CGI. */ public Path getGitwebCss() { return css; } - /** @return local path of the {@code gitweb.js} for the CGI. */ + /** Returns local path of the {@code gitweb.js} for the CGI. */ public Path getGitwebJs() { return js; } - /** @return local path of the {@code git-logo.png} for the CGI. */ + /** Returns local path of the {@code git-logo.png} for the CGI. */ public Path getGitLogoPng() { return logoPng; }
diff --git a/java/com/google/gerrit/server/config/GitwebConfig.java b/java/com/google/gerrit/server/config/GitwebConfig.java index b1089f8..99bd62d 100644 --- a/java/com/google/gerrit/server/config/GitwebConfig.java +++ b/java/com/google/gerrit/server/config/GitwebConfig.java
@@ -32,6 +32,7 @@ import com.google.gerrit.extensions.webui.ParentWebLink; import com.google.gerrit.extensions.webui.PatchSetWebLink; import com.google.gerrit.extensions.webui.ProjectWebLink; +import com.google.gerrit.extensions.webui.ResolveConflictsWebLink; import com.google.gerrit.extensions.webui.TagWebLink; import com.google.inject.AbstractModule; import com.google.inject.Inject; @@ -81,6 +82,7 @@ if (!isNullOrEmpty(type.getRevision())) { DynamicSet.bind(binder(), PatchSetWebLink.class).to(GitwebLinks.class); DynamicSet.bind(binder(), ParentWebLink.class).to(GitwebLinks.class); + DynamicSet.bind(binder(), ResolveConflictsWebLink.class).to(GitwebLinks.class); } if (!isNullOrEmpty(type.getProject())) { @@ -209,16 +211,16 @@ } } - /** @return GitwebType for gitweb viewer. */ + /** Returns GitwebType for gitweb viewer. */ @Nullable public GitwebType getGitwebType() { return type; } /** - * @return URL of the entry point into gitweb. This URL may be relative to our context if gitweb - * is hosted by ourselves; or absolute if its hosted elsewhere; or null if gitweb has not been - * configured. + * Returns URL of the entry point into gitweb. This URL may be relative to our context if gitweb + * is hosted by ourselves; or absolute if its hosted elsewhere; or null if gitweb has not been + * configured. */ public String getUrl() { return url; @@ -258,6 +260,7 @@ PatchSetWebLink, ParentWebLink, ProjectWebLink, + ResolveConflictsWebLink, TagWebLink { private final String url; private final GitwebType type; @@ -343,6 +346,13 @@ } @Override + public WebLinkInfo getResolveConflictsWebLink( + String projectName, String commit, String commitMessage, String branchName) { + // For Gitweb treat resolve conflicts links the same as patch set links + return getPatchSetWebLink(projectName, commit, commitMessage, branchName); + } + + @Override public WebLinkInfo getParentWebLink( String projectName, String commit, String commitMessage, String branchName) { // For Gitweb treat parent revision links the same as patch set links
diff --git a/java/com/google/gerrit/elasticsearch/bulk/IndexRequest.java b/java/com/google/gerrit/server/config/GlobalPluginConfigProvider.java similarity index 70% rename from java/com/google/gerrit/elasticsearch/bulk/IndexRequest.java rename to java/com/google/gerrit/server/config/GlobalPluginConfigProvider.java index d90b80f..847708a 100644 --- a/java/com/google/gerrit/elasticsearch/bulk/IndexRequest.java +++ b/java/com/google/gerrit/server/config/GlobalPluginConfigProvider.java
@@ -1,4 +1,4 @@ -// Copyright (C) 2018 The Android Open Source Project +// Copyright (C) 2021 The Android Open Source Project // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,11 +12,10 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.elasticsearch.bulk; +package com.google.gerrit.server.config; -public class IndexRequest extends ActionRequest { +import org.eclipse.jgit.lib.Config; - public IndexRequest(String id, String index) { - super("index", id, index); - } +public interface GlobalPluginConfigProvider { + Config get(String pluginName); }
diff --git a/java/com/google/gerrit/server/config/PluginConfigFactory.java b/java/com/google/gerrit/server/config/PluginConfigFactory.java index 2d0f9a5..bd4b661 100644 --- a/java/com/google/gerrit/server/config/PluginConfigFactory.java +++ b/java/com/google/gerrit/server/config/PluginConfigFactory.java
@@ -16,7 +16,6 @@ import static com.google.gerrit.server.project.ProjectCache.noSuchProject; -import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Project; import com.google.gerrit.server.plugins.Plugin; import com.google.gerrit.server.plugins.ReloadPluginListener; @@ -28,48 +27,37 @@ import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.Singleton; -import java.io.File; -import java.io.IOException; -import java.nio.file.Path; import java.util.HashMap; import java.util.Map; -import org.eclipse.jgit.errors.ConfigInvalidException; -import org.eclipse.jgit.internal.storage.file.FileSnapshot; import org.eclipse.jgit.lib.Config; -import org.eclipse.jgit.storage.file.FileBasedConfig; -import org.eclipse.jgit.util.FS; @Singleton public class PluginConfigFactory implements ReloadPluginListener { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - private static final String EXTENSION = ".config"; - private final SitePaths site; + private final GlobalPluginConfigProvider globalPluginConfigProvider; private final Provider<Config> cfgProvider; private final ProjectCache projectCache; private final ProjectState.Factory projectStateFactory; private final SecureStore secureStore; private final Map<String, Config> pluginConfigs; - private volatile FileSnapshot cfgSnapshot; private volatile Config cfg; @Inject PluginConfigFactory( - SitePaths site, @GerritServerConfig Provider<Config> cfgProvider, + GlobalPluginConfigProvider globalPluginConfigProvider, ProjectCache projectCache, ProjectState.Factory projectStateFactory, SecureStore secureStore) { - this.site = site; + this.globalPluginConfigProvider = globalPluginConfigProvider; this.cfgProvider = cfgProvider; this.projectCache = projectCache; this.projectStateFactory = projectStateFactory; this.secureStore = secureStore; this.pluginConfigs = new HashMap<>(); - this.cfgSnapshot = FileSnapshot.save(site.gerrit_config.toFile()); this.cfg = cfgProvider.get(); } @@ -103,12 +91,10 @@ * @return the plugin configuration from the 'gerrit.config' file */ public PluginConfig getFromGerritConfig(String pluginName, boolean refresh) { - if (refresh && secureStore.isOutdated()) { - secureStore.reload(); - } - File configFile = site.gerrit_config.toFile(); - if (refresh && cfgSnapshot.isModified(configFile)) { - cfgSnapshot = FileSnapshot.save(configFile); + if (refresh) { + if (secureStore.isOutdated()) { + secureStore.reload(); + } cfg = cfgProvider.get(); } return PluginConfig.createFromGerritConfig(pluginName, cfg); @@ -217,25 +203,9 @@ return pluginConfigs.get(pluginName); } - Path pluginConfigFile = site.etc_dir.resolve(pluginName + ".config"); - FileBasedConfig cfg = new FileBasedConfig(pluginConfigFile.toFile(), FS.DETECTED); + Config cfg = globalPluginConfigProvider.get(pluginName); GlobalPluginConfig pluginConfig = new GlobalPluginConfig(pluginName, cfg, secureStore); pluginConfigs.put(pluginName, pluginConfig); - if (!cfg.getFile().exists()) { - logger.atInfo().log("No %s; assuming defaults", pluginConfigFile.toAbsolutePath()); - return pluginConfig; - } - - try { - cfg.load(); - } catch (ConfigInvalidException e) { - // This is an error in user input, don't spam logs with a stack trace. - logger.atWarning().log( - "Failed to load %s: %s", pluginConfigFile.toAbsolutePath(), e.getMessage()); - } catch (IOException e) { - logger.atWarning().withCause(e).log("Failed to load %s", pluginConfigFile.toAbsolutePath()); - } - return pluginConfig; }
diff --git a/java/com/google/gerrit/server/config/ProjectConfigEntry.java b/java/com/google/gerrit/server/config/ProjectConfigEntry.java index fcfa5e9..c09988e3 100644 --- a/java/com/google/gerrit/server/config/ProjectConfigEntry.java +++ b/java/com/google/gerrit/server/config/ProjectConfigEntry.java
@@ -206,16 +206,18 @@ } /** + * Returns whether the project is editable + * * @param project project state. - * @return whether the project is editable. */ public boolean isEditable(ProjectState project) { return true; } /** + * Returns any warning associated with the project + * * @param project project state. - * @return any warning associated with the project. */ public String getWarning(ProjectState project) { return null;
diff --git a/java/com/google/gerrit/server/data/AccountAttribute.java b/java/com/google/gerrit/server/data/AccountAttribute.java index 19605a2..9be221b 100644 --- a/java/com/google/gerrit/server/data/AccountAttribute.java +++ b/java/com/google/gerrit/server/data/AccountAttribute.java
@@ -18,4 +18,11 @@ public String name; public String email; public String username; + public Integer accountId; + + public AccountAttribute(Integer id) { + this.accountId = id; + } + + public AccountAttribute() {} }
diff --git a/java/com/google/gerrit/server/diff/DiffInfoCreator.java b/java/com/google/gerrit/server/diff/DiffInfoCreator.java index c29ffc8..606e42b 100644 --- a/java/com/google/gerrit/server/diff/DiffInfoCreator.java +++ b/java/com/google/gerrit/server/diff/DiffInfoCreator.java
@@ -73,6 +73,8 @@ ImmutableList<DiffWebLinkInfo> links = webLinksProvider.getDiffLinks(); result.webLinks = links.isEmpty() ? null : links; + ImmutableList<WebLinkInfo> editLinks = webLinksProvider.getEditWebLinks(); + result.editWebLinks = editLinks.isEmpty() ? null : editLinks; if (ps.isBinary()) { result.binary = true; @@ -156,8 +158,8 @@ FileContentUtil.resolveContentType( state, side.fileName(), fileInfo.mode, fileInfo.mimeType); result.lines = fileInfo.content.getSize(); - ImmutableList<WebLinkInfo> links = webLinksProvider.getFileWebLinks(side.type()); - result.webLinks = links.isEmpty() ? null : links; + ImmutableList<WebLinkInfo> fileLinks = webLinksProvider.getFileWebLinks(side.type()); + result.webLinks = fileLinks.isEmpty() ? null : fileLinks; result.commitId = fileInfo.commitId; return Optional.of(result); }
diff --git a/java/com/google/gerrit/server/diff/DiffWebLinksProvider.java b/java/com/google/gerrit/server/diff/DiffWebLinksProvider.java index 0f71b17..2590ebc 100644 --- a/java/com/google/gerrit/server/diff/DiffWebLinksProvider.java +++ b/java/com/google/gerrit/server/diff/DiffWebLinksProvider.java
@@ -24,6 +24,9 @@ /** Returns links associated with the diff view */ ImmutableList<DiffWebLinkInfo> getDiffLinks(); - /** Returns links associated with the diff side */ + /** Returns edit links associated with the diff view */ + ImmutableList<WebLinkInfo> getEditWebLinks(); + + /** Returns file links associated with the diff side */ ImmutableList<WebLinkInfo> getFileWebLinks(DiffSide.Type fileInfoType); }
diff --git a/java/com/google/gerrit/server/edit/ChangeEditUtil.java b/java/com/google/gerrit/server/edit/ChangeEditUtil.java index 56f9643..3540081 100644 --- a/java/com/google/gerrit/server/edit/ChangeEditUtil.java +++ b/java/com/google/gerrit/server/edit/ChangeEditUtil.java
@@ -146,9 +146,6 @@ * @param edit change edit to publish * @param notify Notify handling that defines to whom email notifications should be sent after the * change edit is published. - * @throws IOException - * @throws UpdateException - * @throws RestApiException */ public void publish( BatchUpdate.Factory updateFactory, @@ -209,7 +206,6 @@ * Delete change edit. * * @param edit change edit to delete - * @throws IOException */ public void delete(ChangeEdit edit) throws IOException { Change change = edit.getChange();
diff --git a/java/com/google/gerrit/server/events/EventBroker.java b/java/com/google/gerrit/server/events/EventBroker.java index 0fcb64e..4001a48 100644 --- a/java/com/google/gerrit/server/events/EventBroker.java +++ b/java/com/google/gerrit/server/events/EventBroker.java
@@ -47,7 +47,7 @@ public class EventBroker implements EventDispatcher { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - public static class Module extends LifecycleModule { + public static class EventBrokerModule extends LifecycleModule { @Override protected void configure() { DynamicItem.itemOf(binder(), EventDispatcher.class);
diff --git a/java/com/google/gerrit/server/events/EventFactory.java b/java/com/google/gerrit/server/events/EventFactory.java index addeb59..8b19ecb 100644 --- a/java/com/google/gerrit/server/events/EventFactory.java +++ b/java/com/google/gerrit/server/events/EventFactory.java
@@ -35,11 +35,12 @@ import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.registration.DynamicItem; import com.google.gerrit.index.IndexConfig; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.GerritPersonIdent; +import com.google.gerrit.server.account.AccountAttributeLoader; import com.google.gerrit.server.account.AccountCache; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.account.Emails; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.ChangeKindCache; import com.google.gerrit.server.config.UrlFormatter; import com.google.gerrit.server.data.AccountAttribute; @@ -56,13 +57,13 @@ import com.google.gerrit.server.data.SubmitRequirementAttribute; import com.google.gerrit.server.data.TrackingIdAttribute; import com.google.gerrit.server.notedb.ChangeNotes; -import com.google.gerrit.server.patch.PatchList; -import com.google.gerrit.server.patch.PatchListCache; -import com.google.gerrit.server.patch.PatchListEntry; -import com.google.gerrit.server.patch.PatchListNotAvailableException; -import com.google.gerrit.server.patch.PatchListObjectTooLargeException; +import com.google.gerrit.server.patch.DiffNotAvailableException; +import com.google.gerrit.server.patch.DiffOperations; +import com.google.gerrit.server.patch.FilePathAdapter; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.query.change.InternalChangeQuery; +import com.google.gerrit.server.util.AccountTemplateUtil; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.Singleton; @@ -71,6 +72,7 @@ import java.util.Collection; import java.util.List; import java.util.Map; +import java.util.Optional; import java.util.Set; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.PersonIdent; @@ -83,40 +85,43 @@ private final AccountCache accountCache; private final DynamicItem<UrlFormatter> urlFormatter; + private final DiffOperations diffOperations; private final Emails emails; - private final PatchListCache patchListCache; private final Provider<PersonIdent> myIdent; private final ChangeData.Factory changeDataFactory; private final ApprovalsUtil approvalsUtil; private final ChangeKindCache changeKindCache; private final Provider<InternalChangeQuery> queryProvider; private final IndexConfig indexConfig; + private final AccountTemplateUtil accountTemplateUtil; @Inject EventFactory( AccountCache accountCache, Emails emails, DynamicItem<UrlFormatter> urlFormatter, - PatchListCache patchListCache, + DiffOperations diffOperations, @GerritPersonIdent Provider<PersonIdent> myIdent, ChangeData.Factory changeDataFactory, ApprovalsUtil approvalsUtil, ChangeKindCache changeKindCache, Provider<InternalChangeQuery> queryProvider, - IndexConfig indexConfig) { + IndexConfig indexConfig, + AccountTemplateUtil accountTemplateUtil) { this.accountCache = accountCache; this.urlFormatter = urlFormatter; this.emails = emails; - this.patchListCache = patchListCache; + this.diffOperations = diffOperations; this.myIdent = myIdent; this.changeDataFactory = changeDataFactory; this.approvalsUtil = approvalsUtil; this.changeKindCache = changeKindCache; this.queryProvider = queryProvider; this.indexConfig = indexConfig; + this.accountTemplateUtil = accountTemplateUtil; } - public ChangeAttribute asChangeAttribute(Change change) { + public ChangeAttribute asChangeAttribute(Change change, AccountAttributeLoader accountLoader) { ChangeAttribute a = new ChangeAttribute(); a.project = change.getProject().get(); a.branch = change.getDest().shortName(); @@ -125,8 +130,8 @@ a.number = change.getId().get(); a.subject = change.getSubject(); a.url = getChangeUrl(change); - a.owner = asAccountAttribute(change.getOwner()); - a.assignee = asAccountAttribute(change.getAssignee()); + a.owner = asAccountAttribute(change.getOwner(), accountLoader); + a.assignee = asAccountAttribute(change.getAssignee(), accountLoader); a.status = change.getStatus(); a.createdOn = change.getCreatedOn().getTime() / 1000L; a.wip = change.isWorkInProgress() ? true : null; @@ -140,7 +145,7 @@ /** Create a {@link ChangeAttribute} instance from the specified change. */ public ChangeAttribute asChangeAttribute(Change change, ChangeNotes notes) { - ChangeAttribute a = asChangeAttribute(change); + ChangeAttribute a = asChangeAttribute(change, (AccountAttributeLoader) null); addHashTags(a, notes); addCommitMessage(a, notes); return a; @@ -166,25 +171,27 @@ } /** Add allReviewers to an existing {@link ChangeAttribute}. */ - public void addAllReviewers(ChangeAttribute a, ChangeNotes notes) { + public void addAllReviewers( + ChangeAttribute a, ChangeNotes notes, AccountAttributeLoader accountLoader) { Collection<Account.Id> reviewers = approvalsUtil.getReviewers(notes).all(); if (!reviewers.isEmpty()) { a.allReviewers = Lists.newArrayListWithCapacity(reviewers.size()); for (Account.Id id : reviewers) { - a.allReviewers.add(asAccountAttribute(id)); + a.allReviewers.add(asAccountAttribute(id, accountLoader)); } } } /** Add submitRecords to an existing {@link ChangeAttribute}. */ - public void addSubmitRecords(ChangeAttribute ca, List<SubmitRecord> submitRecords) { + public void addSubmitRecords( + ChangeAttribute ca, List<SubmitRecord> submitRecords, AccountAttributeLoader accountLoader) { ca.submitRecords = new ArrayList<>(); for (SubmitRecord submitRecord : submitRecords) { SubmitRecordAttribute sa = new SubmitRecordAttribute(); sa.status = submitRecord.status.name(); if (submitRecord.status != SubmitRecord.Status.RULE_ERROR) { - addSubmitRecordLabels(submitRecord, sa); + addSubmitRecordLabels(submitRecord, sa, accountLoader); addSubmitRecordRequirements(submitRecord, sa); } ca.submitRecords.add(sa); @@ -195,7 +202,8 @@ } } - private void addSubmitRecordLabels(SubmitRecord submitRecord, SubmitRecordAttribute sa) { + private void addSubmitRecordLabels( + SubmitRecord submitRecord, SubmitRecordAttribute sa, AccountAttributeLoader accountLoader) { if (submitRecord.labels != null && !submitRecord.labels.isEmpty()) { sa.labels = new ArrayList<>(); for (SubmitRecord.Label lbl : submitRecord.labels) { @@ -203,7 +211,7 @@ la.label = lbl.label; la.status = lbl.status.name(); if (lbl.appliedBy != null) { - la.by = asAccountAttribute(lbl.appliedBy); + la.by = asAccountAttribute(lbl.appliedBy, accountLoader); } sa.labels.add(la); } @@ -352,8 +360,9 @@ ChangeAttribute ca, Collection<PatchSet> ps, Map<PatchSet.Id, Collection<PatchSetApproval>> approvals, - LabelTypes labelTypes) { - addPatchSets(revWalk, ca, ps, approvals, false, null, labelTypes); + LabelTypes labelTypes, + AccountAttributeLoader accountLoader) { + addPatchSets(revWalk, ca, ps, approvals, false, null, labelTypes, accountLoader); } public void addPatchSets( @@ -363,13 +372,14 @@ Map<PatchSet.Id, Collection<PatchSetApproval>> approvals, boolean includeFiles, Change change, - LabelTypes labelTypes) { + LabelTypes labelTypes, + AccountAttributeLoader accountLoader) { if (!ps.isEmpty()) { ca.patchSets = new ArrayList<>(ps.size()); for (PatchSet p : ps) { - PatchSetAttribute psa = asPatchSetAttribute(revWalk, change, p); + PatchSetAttribute psa = asPatchSetAttribute(revWalk, change, p, accountLoader); if (approvals != null) { - addApprovals(psa, p.id(), approvals, labelTypes); + addApprovals(psa, p.id(), approvals, labelTypes, accountLoader); } ca.patchSets.add(psa); if (includeFiles) { @@ -380,13 +390,15 @@ } public void addPatchSetComments( - PatchSetAttribute patchSetAttribute, Collection<HumanComment> comments) { + PatchSetAttribute patchSetAttribute, + Collection<HumanComment> comments, + AccountAttributeLoader accountLoader) { for (HumanComment comment : comments) { if (comment.key.patchSetId == patchSetAttribute.number) { if (patchSetAttribute.comments == null) { patchSetAttribute.comments = new ArrayList<>(); } - patchSetAttribute.comments.add(asPatchSetLineAttribute(comment)); + patchSetAttribute.comments.add(asPatchSetLineAttribute(comment, accountLoader)); } } } @@ -394,43 +406,52 @@ public void addPatchSetFileNames( PatchSetAttribute patchSetAttribute, Change change, PatchSet patchSet) { try { - PatchList patchList = patchListCache.get(change, patchSet); - for (PatchListEntry patch : patchList.getPatches()) { + Map<String, FileDiffOutput> modifiedFiles = + diffOperations.listModifiedFilesAgainstParent( + change.getProject(), patchSet.commitId(), /* parentNum= */ 0); + + for (FileDiffOutput diff : modifiedFiles.values()) { if (patchSetAttribute.files == null) { patchSetAttribute.files = new ArrayList<>(); } PatchAttribute p = new PatchAttribute(); - p.file = patch.getNewName(); - p.fileOld = patch.getOldName(); - p.type = patch.getChangeType(); - p.deletions -= patch.getDeletions(); - p.insertions = patch.getInsertions(); + p.file = FilePathAdapter.getNewPath(diff.oldPath(), diff.newPath(), diff.changeType()); + p.fileOld = FilePathAdapter.getOldPath(diff.oldPath(), diff.changeType()); + p.type = diff.changeType(); + p.deletions -= diff.deletions(); + p.insertions = diff.insertions(); patchSetAttribute.files.add(p); } - } catch (PatchListObjectTooLargeException e) { - logger.atWarning().log("Cannot get patch list: %s", e.getMessage()); - } catch (PatchListNotAvailableException e) { + } catch (DiffNotAvailableException e) { logger.atSevere().withCause(e).log("Cannot get patch list"); } } - public void addComments(ChangeAttribute ca, Collection<ChangeMessage> messages) { + public void addComments( + ChangeAttribute ca, + Collection<ChangeMessage> messages, + AccountAttributeLoader accountLoader) { if (!messages.isEmpty()) { ca.comments = new ArrayList<>(); for (ChangeMessage message : messages) { - ca.comments.add(asMessageAttribute(message)); + ca.comments.add(asMessageAttribute(message, accountLoader)); } } } - /** Create a PatchSetAttribute for the given patchset suitable for serialization to JSON. */ public PatchSetAttribute asPatchSetAttribute(RevWalk revWalk, Change change, PatchSet patchSet) { + return asPatchSetAttribute(revWalk, change, patchSet, null); + } + + /** Create a PatchSetAttribute for the given patchset suitable for serialization to JSON. */ + public PatchSetAttribute asPatchSetAttribute( + RevWalk revWalk, Change change, PatchSet patchSet, AccountAttributeLoader accountLoader) { PatchSetAttribute p = new PatchSetAttribute(); p.revision = patchSet.commitId().name(); p.number = patchSet.number(); p.ref = patchSet.refName(); - p.uploader = asAccountAttribute(patchSet.uploader()); + p.uploader = asAccountAttribute(patchSet.uploader(), accountLoader); p.createdOn = patchSet.createdOn().getTime() / 1000L; PatchSet.Id pId = patchSet.id(); try { @@ -447,18 +468,20 @@ p.author.name = author.getName(); p.author.username = ""; } else { - p.author = asAccountAttribute(author.getAccount()); + p.author = asAccountAttribute(author.getAccount(), accountLoader); } - PatchList patchList = patchListCache.get(change, patchSet); - p.sizeDeletions = patchList.getDeletions(); - p.sizeInsertions = patchList.getInsertions(); + Map<String, FileDiffOutput> modifiedFiles = + diffOperations.listModifiedFilesAgainstParent( + change.getProject(), patchSet.commitId(), /* parentNum= */ 0); + for (FileDiffOutput fileDiff : modifiedFiles.values()) { + p.sizeDeletions += fileDiff.deletions(); + p.sizeInsertions += fileDiff.insertions(); + } p.kind = changeKindCache.getChangeKind(change, patchSet); } catch (IOException | StorageException e) { logger.atSevere().withCause(e).log("Cannot load patch set data for %s", patchSet.id()); - } catch (PatchListObjectTooLargeException e) { - logger.atWarning().log("Cannot get size information for %s: %s", pId, e.getMessage()); - } catch (PatchListNotAvailableException e) { + } catch (DiffNotAvailableException e) { logger.atSevere().withCause(e).log("Cannot get size information for %s.", pId); } return p; @@ -468,20 +491,24 @@ PatchSetAttribute p, PatchSet.Id id, Map<PatchSet.Id, Collection<PatchSetApproval>> all, - LabelTypes labelTypes) { + LabelTypes labelTypes, + AccountAttributeLoader accountLoader) { Collection<PatchSetApproval> list = all.get(id); if (list != null) { - addApprovals(p, list, labelTypes); + addApprovals(p, list, labelTypes, accountLoader); } } public void addApprovals( - PatchSetAttribute p, Collection<PatchSetApproval> list, LabelTypes labelTypes) { + PatchSetAttribute p, + Collection<PatchSetApproval> list, + LabelTypes labelTypes, + AccountAttributeLoader accountLoader) { if (!list.isEmpty()) { p.approvals = new ArrayList<>(list.size()); for (PatchSetApproval a : list) { if (a.value() != 0) { - p.approvals.add(asApprovalAttribute(a, labelTypes)); + p.approvals.add(asApprovalAttribute(a, labelTypes, accountLoader)); } } if (p.approvals.isEmpty()) { @@ -490,6 +517,10 @@ } } + public AccountAttribute asAccountAttribute(Account.Id id, AccountAttributeLoader accountLoader) { + return accountLoader != null ? accountLoader.get(id) : asAccountAttribute(id); + } + /** Create an AuthorAttribute for the given account suitable for serialization to JSON. */ public AccountAttribute asAccountAttribute(Account.Id id) { if (id == null) { @@ -521,35 +552,36 @@ * @param labelTypes label types for the containing project * @return object suitable for serialization to JSON */ - public ApprovalAttribute asApprovalAttribute(PatchSetApproval approval, LabelTypes labelTypes) { + public ApprovalAttribute asApprovalAttribute( + PatchSetApproval approval, LabelTypes labelTypes, AccountAttributeLoader accountLoader) { ApprovalAttribute a = new ApprovalAttribute(); a.type = approval.labelId().get(); a.value = Short.toString(approval.value()); - a.by = asAccountAttribute(approval.accountId()); + a.by = asAccountAttribute(approval.accountId(), accountLoader); a.grantedOn = approval.granted().getTime() / 1000L; a.oldValue = null; - LabelType lt = labelTypes.byLabel(approval.labelId()); - if (lt != null) { - a.description = lt.getName(); - } + Optional<LabelType> lt = labelTypes.byLabel(approval.labelId()); + lt.ifPresent(l -> a.description = l.getName()); return a; } - public MessageAttribute asMessageAttribute(ChangeMessage message) { + public MessageAttribute asMessageAttribute( + ChangeMessage message, AccountAttributeLoader accountLoader) { MessageAttribute a = new MessageAttribute(); a.timestamp = message.getWrittenOn().getTime() / 1000L; a.reviewer = message.getAuthor() != null - ? asAccountAttribute(message.getAuthor()) + ? asAccountAttribute(message.getAuthor(), accountLoader) : asAccountAttribute(myIdent.get()); - a.message = message.getMessage(); + a.message = accountTemplateUtil.replaceTemplates(message.getMessage()); return a; } - public PatchSetCommentAttribute asPatchSetLineAttribute(HumanComment c) { + public PatchSetCommentAttribute asPatchSetLineAttribute( + HumanComment c, AccountAttributeLoader accountLoader) { PatchSetCommentAttribute a = new PatchSetCommentAttribute(); - a.reviewer = asAccountAttribute(c.author.getId()); + a.reviewer = asAccountAttribute(c.author.getId(), accountLoader); a.file = c.key.filename; a.line = c.lineNbr; a.message = c.message;
diff --git a/java/com/google/gerrit/server/events/EventsMetrics.java b/java/com/google/gerrit/server/events/EventsMetrics.java index 3c87cca..6d48c37 100644 --- a/java/com/google/gerrit/server/events/EventsMetrics.java +++ b/java/com/google/gerrit/server/events/EventsMetrics.java
@@ -32,7 +32,9 @@ metricMaker.newCounter( "events", new Description("Triggered events").setRate().setUnit("triggered events"), - Field.ofString("type", Metadata.Builder::eventType).build()); + Field.ofString("type", Metadata.Builder::eventType) + .description("The type of the event.") + .build()); } @Override
diff --git a/java/com/google/gerrit/server/events/StreamEventsApiListener.java b/java/com/google/gerrit/server/events/StreamEventsApiListener.java index 439f53e..abacb85 100644 --- a/java/com/google/gerrit/server/events/StreamEventsApiListener.java +++ b/java/com/google/gerrit/server/events/StreamEventsApiListener.java
@@ -23,7 +23,6 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.BranchNameKey; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.LabelType; import com.google.gerrit.entities.LabelTypes; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; @@ -90,7 +89,7 @@ VoteDeletedListener { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - public static class Module extends AbstractModule { + public static class StreamEventsApiListenerModule extends AbstractModule { @Override protected void configure() { DynamicSet.bind(binder(), AssigneeChangedListener.class).to(StreamEventsApiListener.class); @@ -202,10 +201,7 @@ a.oldValue = Short.toString(oldApprovals.get(approval.getKey())); } } - LabelType lt = labelTypes.byLabel(approval.getKey()); - if (lt != null) { - a.description = lt.getName(); - } + labelTypes.byLabel(approval.getKey()).ifPresent(lt -> a.description = lt.getName()); if (approval.getValue() != null) { a.value = Short.toString(approval.getValue()); }
diff --git a/java/com/google/gerrit/server/experiments/ConfigExperimentFeatures.java b/java/com/google/gerrit/server/experiments/ConfigExperimentFeatures.java index f526935..227deb5 100644 --- a/java/com/google/gerrit/server/experiments/ConfigExperimentFeatures.java +++ b/java/com/google/gerrit/server/experiments/ConfigExperimentFeatures.java
@@ -31,7 +31,7 @@ @Singleton public class ConfigExperimentFeatures implements ExperimentFeatures { - public static class Module extends AbstractModule { + public static class ConfigExperimentFeaturesModule extends AbstractModule { @Override protected void configure() { bind(ExperimentFeatures.class).to(ConfigExperimentFeatures.class);
diff --git a/java/com/google/gerrit/server/experiments/ExperimentFeaturesConstants.java b/java/com/google/gerrit/server/experiments/ExperimentFeaturesConstants.java index 0f85578..1486559 100644 --- a/java/com/google/gerrit/server/experiments/ExperimentFeaturesConstants.java +++ b/java/com/google/gerrit/server/experiments/ExperimentFeaturesConstants.java
@@ -25,6 +25,26 @@ public static String GERRIT_BACKEND_REQUEST_FEATURE_REMOVE_REVISION_ETAG = "GerritBackendRequestFeature__remove_revision_etag"; + /** Enable storing submit requirements in NoteDb when the change is merged. */ + public static final String GERRIT_BACKEND_REQUEST_FEATURE_STORE_SUBMIT_REQUIREMENTS_ON_MERGE = + "GerritBackendRequestFeature__store_submit_requirements_on_merge"; + + /** + * Allow legacy {@link com.google.gerrit.entities.SubmitRecord}s to be converted and returned as + * submit requirements by the {@link + * com.google.gerrit.server.project.SubmitRequirementsEvaluator}. + */ + public static final String GERRIT_BACKEND_REQUEST_FEATURE_ENABLE_SUBMIT_REQUIREMENTS = + "GerritBackendRequestFeature__enable_submit_requirements"; + + /** + * Allow SubmitRequirements to be computed freshly on dashboards irrespective of the value we + * retrieved from the change index. + */ + public static final String + GERRIT_BACKEND_REQUEST_FEATURE_ENABLE_SUBMIT_REQUIREMENTS_BACKFILLING_ON_DASHBOARD = + "GerritBackendRequestFeature__enable_submit_requirements_backfilling_on_dashboard"; + /** Features, enabled by default in the current release. */ public static final ImmutableSet<String> DEFAULT_ENABLED_FEATURES = ImmutableSet.of(UI_FEATURE_PATCHSET_COMMENTS);
diff --git a/java/com/google/gerrit/server/extensions/events/AssigneeChanged.java b/java/com/google/gerrit/server/extensions/events/AssigneeChanged.java index 2189690..e31a1b5 100644 --- a/java/com/google/gerrit/server/extensions/events/AssigneeChanged.java +++ b/java/com/google/gerrit/server/extensions/events/AssigneeChanged.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.common.AccountInfo; @@ -23,6 +22,7 @@ import com.google.gerrit.extensions.events.AssigneeChangedListener; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.sql.Timestamp; @@ -42,14 +42,14 @@ } public void fire( - Change change, AccountState accountState, AccountState oldAssignee, Timestamp when) { + ChangeData changeData, AccountState accountState, AccountState oldAssignee, Timestamp when) { if (listeners.isEmpty()) { return; } try { Event event = new Event( - util.changeInfo(change), + util.changeInfo(changeData), util.accountInfo(accountState), util.accountInfo(oldAssignee), when);
diff --git a/java/com/google/gerrit/server/extensions/events/ChangeAbandoned.java b/java/com/google/gerrit/server/extensions/events/ChangeAbandoned.java index c7a9283..cbe7c6b 100644 --- a/java/com/google/gerrit/server/extensions/events/ChangeAbandoned.java +++ b/java/com/google/gerrit/server/extensions/events/ChangeAbandoned.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -29,6 +28,7 @@ import com.google.gerrit.server.patch.PatchListObjectTooLargeException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -49,7 +49,7 @@ } public void fire( - Change change, + ChangeData changeData, PatchSet ps, AccountState abandoner, String reason, @@ -61,8 +61,8 @@ try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), ps), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), ps), util.accountInfo(abandoner), reason, when,
diff --git a/java/com/google/gerrit/server/extensions/events/ChangeDeleted.java b/java/com/google/gerrit/server/extensions/events/ChangeDeleted.java index 1ed6209..23a4583 100644 --- a/java/com/google/gerrit/server/extensions/events/ChangeDeleted.java +++ b/java/com/google/gerrit/server/extensions/events/ChangeDeleted.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.common.AccountInfo; @@ -23,6 +22,7 @@ import com.google.gerrit.extensions.events.ChangeDeletedListener; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.sql.Timestamp; @@ -41,12 +41,12 @@ this.util = util; } - public void fire(Change change, AccountState deleter, Timestamp when) { + public void fire(ChangeData changeData, AccountState deleter, Timestamp when) { if (listeners.isEmpty()) { return; } try { - Event event = new Event(util.changeInfo(change), util.accountInfo(deleter), when); + Event event = new Event(util.changeInfo(changeData), util.accountInfo(deleter), when); listeners.runEach(l -> l.onChangeDeleted(event)); } catch (StorageException e) { logger.atSevere().withCause(e).log("Couldn't fire event");
diff --git a/java/com/google/gerrit/server/extensions/events/ChangeMerged.java b/java/com/google/gerrit/server/extensions/events/ChangeMerged.java index 06d0008..e4896df 100644 --- a/java/com/google/gerrit/server/extensions/events/ChangeMerged.java +++ b/java/com/google/gerrit/server/extensions/events/ChangeMerged.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -29,6 +28,7 @@ import com.google.gerrit.server.patch.PatchListObjectTooLargeException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -49,15 +49,19 @@ } public void fire( - Change change, PatchSet ps, AccountState merger, String newRevisionId, Timestamp when) { + ChangeData changeData, + PatchSet ps, + AccountState merger, + String newRevisionId, + Timestamp when) { if (listeners.isEmpty()) { return; } try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), ps), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), ps), util.accountInfo(merger), newRevisionId, when);
diff --git a/java/com/google/gerrit/server/extensions/events/ChangeRestored.java b/java/com/google/gerrit/server/extensions/events/ChangeRestored.java index 1af56d0..8bd222a 100644 --- a/java/com/google/gerrit/server/extensions/events/ChangeRestored.java +++ b/java/com/google/gerrit/server/extensions/events/ChangeRestored.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -29,6 +28,7 @@ import com.google.gerrit.server.patch.PatchListObjectTooLargeException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -49,15 +49,15 @@ } public void fire( - Change change, PatchSet ps, AccountState restorer, String reason, Timestamp when) { + ChangeData changeData, PatchSet ps, AccountState restorer, String reason, Timestamp when) { if (listeners.isEmpty()) { return; } try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), ps), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), ps), util.accountInfo(restorer), reason, when);
diff --git a/java/com/google/gerrit/server/extensions/events/ChangeReverted.java b/java/com/google/gerrit/server/extensions/events/ChangeReverted.java index d608c52..4a46eb0 100644 --- a/java/com/google/gerrit/server/extensions/events/ChangeReverted.java +++ b/java/com/google/gerrit/server/extensions/events/ChangeReverted.java
@@ -15,12 +15,12 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.common.ChangeInfo; import com.google.gerrit.extensions.events.ChangeRevertedListener; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.sql.Timestamp; @@ -39,12 +39,12 @@ this.util = util; } - public void fire(Change change, Change revertChange, Timestamp when) { + public void fire(ChangeData changeData, ChangeData revertChangeData, Timestamp when) { if (listeners.isEmpty()) { return; } try { - Event event = new Event(util.changeInfo(change), util.changeInfo(revertChange), when); + Event event = new Event(util.changeInfo(changeData), util.changeInfo(revertChangeData), when); listeners.runEach(l -> l.onChangeReverted(event)); } catch (StorageException e) { logger.atSevere().withCause(e).log("Couldn't fire event");
diff --git a/java/com/google/gerrit/server/extensions/events/CommentAdded.java b/java/com/google/gerrit/server/extensions/events/CommentAdded.java index 151298c..20c54cf 100644 --- a/java/com/google/gerrit/server/extensions/events/CommentAdded.java +++ b/java/com/google/gerrit/server/extensions/events/CommentAdded.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -30,6 +29,7 @@ import com.google.gerrit.server.patch.PatchListObjectTooLargeException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -51,7 +51,7 @@ } public void fire( - Change change, + ChangeData changeData, PatchSet ps, AccountState author, String comment, @@ -64,8 +64,8 @@ try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), ps), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), ps), util.accountInfo(author), comment, util.approvals(author, approvals, when),
diff --git a/java/com/google/gerrit/server/extensions/events/EventUtil.java b/java/com/google/gerrit/server/extensions/events/EventUtil.java index a35140a..f0d038a 100644 --- a/java/com/google/gerrit/server/extensions/events/EventUtil.java +++ b/java/com/google/gerrit/server/extensions/events/EventUtil.java
@@ -18,7 +18,6 @@ import com.google.common.collect.Sets; import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Account; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.client.ListChangesOption; @@ -84,8 +83,8 @@ this.changeOptions = parseChangeListOptions(gerritConfig); } - public ChangeInfo changeInfo(Change change) { - return changeJsonFactory.create(changeOptions).format(change); + public ChangeInfo changeInfo(ChangeData changeData) { + return changeJsonFactory.create(changeOptions).format(changeData); } public RevisionInfo revisionInfo(Project project, PatchSet ps)
diff --git a/java/com/google/gerrit/server/extensions/events/HashtagsEdited.java b/java/com/google/gerrit/server/extensions/events/HashtagsEdited.java index 5d9c5c2..846257c 100644 --- a/java/com/google/gerrit/server/extensions/events/HashtagsEdited.java +++ b/java/com/google/gerrit/server/extensions/events/HashtagsEdited.java
@@ -16,7 +16,6 @@ import com.google.common.collect.ImmutableSortedSet; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.common.AccountInfo; @@ -24,6 +23,7 @@ import com.google.gerrit.extensions.events.HashtagsEditedListener; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.sql.Timestamp; @@ -45,7 +45,7 @@ } public void fire( - Change change, + ChangeData changeData, AccountState editor, ImmutableSortedSet<String> hashtags, Set<String> added, @@ -57,7 +57,12 @@ try { Event event = new Event( - util.changeInfo(change), util.accountInfo(editor), hashtags, added, removed, when); + util.changeInfo(changeData), + util.accountInfo(editor), + hashtags, + added, + removed, + when); listeners.runEach(l -> l.onHashtagsEdited(event)); } catch (StorageException e) { logger.atSevere().withCause(e).log("Couldn't fire event");
diff --git a/java/com/google/gerrit/server/extensions/events/PrivateStateChanged.java b/java/com/google/gerrit/server/extensions/events/PrivateStateChanged.java index bcc6b8e..d81068c 100644 --- a/java/com/google/gerrit/server/extensions/events/PrivateStateChanged.java +++ b/java/com/google/gerrit/server/extensions/events/PrivateStateChanged.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -28,6 +27,7 @@ import com.google.gerrit.server.patch.PatchListNotAvailableException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -47,15 +47,15 @@ this.util = util; } - public void fire(Change change, PatchSet patchSet, AccountState account, Timestamp when) { + public void fire(ChangeData changeData, PatchSet patchSet, AccountState account, Timestamp when) { if (listeners.isEmpty()) { return; } try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), patchSet), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), patchSet), util.accountInfo(account), when); listeners.runEach(l -> l.onPrivateStateChanged(event));
diff --git a/java/com/google/gerrit/server/extensions/events/ReviewerAdded.java b/java/com/google/gerrit/server/extensions/events/ReviewerAdded.java index 35e7828..ba73ca1 100644 --- a/java/com/google/gerrit/server/extensions/events/ReviewerAdded.java +++ b/java/com/google/gerrit/server/extensions/events/ReviewerAdded.java
@@ -16,7 +16,6 @@ import com.google.common.collect.Lists; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -30,6 +29,7 @@ import com.google.gerrit.server.patch.PatchListObjectTooLargeException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -51,7 +51,7 @@ } public void fire( - Change change, + ChangeData changeData, PatchSet patchSet, List<AccountState> reviewers, AccountState adder, @@ -63,8 +63,8 @@ try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), patchSet), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), patchSet), Lists.transform(reviewers, util::accountInfo), util.accountInfo(adder), when);
diff --git a/java/com/google/gerrit/server/extensions/events/ReviewerDeleted.java b/java/com/google/gerrit/server/extensions/events/ReviewerDeleted.java index 147f980..80037bc 100644 --- a/java/com/google/gerrit/server/extensions/events/ReviewerDeleted.java +++ b/java/com/google/gerrit/server/extensions/events/ReviewerDeleted.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -30,6 +29,7 @@ import com.google.gerrit.server.patch.PatchListObjectTooLargeException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -51,7 +51,7 @@ } public void fire( - Change change, + ChangeData changeData, PatchSet patchSet, AccountState reviewer, AccountState remover, @@ -66,8 +66,8 @@ try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), patchSet), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), patchSet), util.accountInfo(reviewer), util.accountInfo(remover), message,
diff --git a/java/com/google/gerrit/server/extensions/events/RevisionCreated.java b/java/com/google/gerrit/server/extensions/events/RevisionCreated.java index 8179e9a..4c78216 100644 --- a/java/com/google/gerrit/server/extensions/events/RevisionCreated.java +++ b/java/com/google/gerrit/server/extensions/events/RevisionCreated.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -30,6 +29,7 @@ import com.google.gerrit.server.patch.PatchListObjectTooLargeException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -44,7 +44,7 @@ new RevisionCreated() { @Override public void fire( - Change change, + ChangeData changeData, PatchSet patchSet, AccountState uploader, Timestamp when, @@ -66,7 +66,7 @@ } public void fire( - Change change, + ChangeData changeData, PatchSet patchSet, AccountState uploader, Timestamp when, @@ -77,8 +77,8 @@ try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), patchSet), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), patchSet), util.accountInfo(uploader), when, notify.handling());
diff --git a/java/com/google/gerrit/server/extensions/events/TopicEdited.java b/java/com/google/gerrit/server/extensions/events/TopicEdited.java index e4089b1..08b47f1 100644 --- a/java/com/google/gerrit/server/extensions/events/TopicEdited.java +++ b/java/com/google/gerrit/server/extensions/events/TopicEdited.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.common.AccountInfo; @@ -23,6 +22,7 @@ import com.google.gerrit.extensions.events.TopicEditedListener; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.sql.Timestamp; @@ -41,13 +41,14 @@ this.util = util; } - public void fire(Change change, AccountState account, String oldTopicName, Timestamp when) { + public void fire( + ChangeData changeData, AccountState account, String oldTopicName, Timestamp when) { if (listeners.isEmpty()) { return; } try { Event event = - new Event(util.changeInfo(change), util.accountInfo(account), oldTopicName, when); + new Event(util.changeInfo(changeData), util.accountInfo(account), oldTopicName, when); listeners.runEach(l -> l.onTopicEdited(event)); } catch (StorageException e) { logger.atSevere().withCause(e).log("Couldn't fire event");
diff --git a/java/com/google/gerrit/server/extensions/events/VoteDeleted.java b/java/com/google/gerrit/server/extensions/events/VoteDeleted.java index ef4e461..244e46c 100644 --- a/java/com/google/gerrit/server/extensions/events/VoteDeleted.java +++ b/java/com/google/gerrit/server/extensions/events/VoteDeleted.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -30,6 +29,7 @@ import com.google.gerrit.server.patch.PatchListObjectTooLargeException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -51,7 +51,7 @@ } public void fire( - Change change, + ChangeData changeData, PatchSet ps, AccountState reviewer, Map<String, Short> approvals, @@ -66,8 +66,8 @@ try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), ps), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), ps), util.accountInfo(reviewer), util.approvals(remover, approvals, when), util.approvals(remover, oldApprovals, when),
diff --git a/java/com/google/gerrit/server/extensions/events/WorkInProgressStateChanged.java b/java/com/google/gerrit/server/extensions/events/WorkInProgressStateChanged.java index 06b244b..bfc068d 100644 --- a/java/com/google/gerrit/server/extensions/events/WorkInProgressStateChanged.java +++ b/java/com/google/gerrit/server/extensions/events/WorkInProgressStateChanged.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.extensions.events; import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Change; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.NotifyHandling; @@ -28,6 +27,7 @@ import com.google.gerrit.server.patch.PatchListNotAvailableException; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginSetContext; +import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; @@ -41,7 +41,8 @@ public static final WorkInProgressStateChanged DISABLED = new WorkInProgressStateChanged() { @Override - public void fire(Change change, PatchSet patchSet, AccountState account, Timestamp when) {} + public void fire( + ChangeData changeData, PatchSet patchSet, AccountState account, Timestamp when) {} }; private final PluginSetContext<WorkInProgressStateChangedListener> listeners; @@ -59,15 +60,15 @@ this.util = null; } - public void fire(Change change, PatchSet patchSet, AccountState account, Timestamp when) { + public void fire(ChangeData changeData, PatchSet patchSet, AccountState account, Timestamp when) { if (listeners.isEmpty()) { return; } try { Event event = new Event( - util.changeInfo(change), - util.revisionInfo(change.getProject(), patchSet), + util.changeInfo(changeData), + util.revisionInfo(changeData.project(), patchSet), util.accountInfo(account), when); listeners.runEach(l -> l.onWorkInProgressStateChanged(event));
diff --git a/java/com/google/gerrit/server/extensions/webui/UiActions.java b/java/com/google/gerrit/server/extensions/webui/UiActions.java index 0bc3d5c..34c3c20 100644 --- a/java/com/google/gerrit/server/extensions/webui/UiActions.java +++ b/java/com/google/gerrit/server/extensions/webui/UiActions.java
@@ -72,7 +72,9 @@ new com.google.gerrit.metrics.Description("Latency for RestView#getDescription calls") .setCumulative() .setUnit(Units.MILLISECONDS), - Field.ofString("view", Metadata.Builder::restViewName).build()); + Field.ofString("view", Metadata.Builder::restViewName) + .description("view implementation class") + .build()); } public <R extends RestResource> Iterable<UiAction.Description> from( @@ -143,11 +145,12 @@ } String name = e.getExportName().substring(d + 1); - UiAction.Description dsc; + UiAction.Description dsc = null; try (Timer1.Context<String> ignored = uiActionLatency.start(name)) { dsc = ((UiAction<R>) view).getDescription(resource); + } catch (Exception ex) { + logger.atSevere().withCause(ex).log("Unable to render UIAction. Will omit from actions"); } - if (dsc == null) { return null; }
diff --git a/java/com/google/gerrit/server/fixes/testing/GitEditSubject.java b/java/com/google/gerrit/server/fixes/testing/GitEditSubject.java index 53b88b1..d90618c 100644 --- a/java/com/google/gerrit/server/fixes/testing/GitEditSubject.java +++ b/java/com/google/gerrit/server/fixes/testing/GitEditSubject.java
@@ -22,7 +22,6 @@ import com.google.gerrit.jgit.diff.ReplaceEdit; import com.google.gerrit.truth.ListSubject; import org.eclipse.jgit.diff.Edit; -import org.eclipse.jgit.diff.Edit.Type; public class GitEditSubject extends Subject { @@ -49,32 +48,32 @@ check("endB").that(edit.getEndB()).isEqualTo(endB); } - public void hasType(Type type) { + public void hasType(Edit.Type type) { isNotNull(); check("getType").that(edit.getType()).isEqualTo(type); } public void isInsert(int insertPos, int beginB, int insertedLength) { isNotNull(); - hasType(Type.INSERT); + hasType(Edit.Type.INSERT); hasRegions(insertPos, insertPos, beginB, beginB + insertedLength); } public void isDelete(int deletePos, int deletedLength, int posB) { isNotNull(); - hasType(Type.DELETE); + hasType(Edit.Type.DELETE); hasRegions(deletePos, deletePos + deletedLength, posB, posB); } public void isReplace(int originalPos, int originalLength, int newPos, int newLength) { isNotNull(); - hasType(Type.REPLACE); + hasType(Edit.Type.REPLACE); hasRegions(originalPos, originalPos + originalLength, newPos, newPos + newLength); } public void isEmpty() { isNotNull(); - hasType(Type.EMPTY); + hasType(Edit.Type.EMPTY); } public ListSubject<GitEditSubject, Edit> internalEdits() {
diff --git a/java/com/google/gerrit/server/git/ChangesByProjectCache.java b/java/com/google/gerrit/server/git/ChangesByProjectCache.java new file mode 100644 index 0000000..e476208 --- /dev/null +++ b/java/com/google/gerrit/server/git/ChangesByProjectCache.java
@@ -0,0 +1,63 @@ +// Copyright (C) 2023 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.git; + +import com.google.gerrit.entities.Project; +import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.query.change.ChangeData; +import com.google.inject.AbstractModule; +import java.io.IOException; +import java.util.Collection; +import org.eclipse.jgit.lib.Config; +import org.eclipse.jgit.lib.Repository; + +public interface ChangesByProjectCache { + public enum UseIndex { + TRUE, + FALSE; + } + + public static class Module extends AbstractModule { + private UseIndex useIndex; + private @GerritServerConfig Config config; + + public Module(UseIndex useIndex, @GerritServerConfig Config config) { + this.useIndex = useIndex; + this.config = config; + } + + @Override + protected void configure() { + boolean searchingCacheEnabled = + config.getLong("cache", SearchingChangeCacheImpl.ID_CACHE, "memoryLimit", 0) > 0; + if (searchingCacheEnabled && UseIndex.TRUE.equals(useIndex)) { + install(new SearchingChangeCacheImpl.SearchingChangeCacheImplModule()); + } else { + bind(UseIndex.class).toInstance(useIndex); + install(new ChangesByProjectCacheImpl.Module()); + } + } + } + + /** + * get changeDatas for the project + * + * @param project project to read. + * @param repository repository for the project to read. + * @return Collection of known changes; empty if no changes. + */ + Collection<ChangeData> getChangeDatas(Project.NameKey project, Repository repo) + throws IOException; +}
diff --git a/java/com/google/gerrit/server/git/ChangesByProjectCacheImpl.java b/java/com/google/gerrit/server/git/ChangesByProjectCacheImpl.java new file mode 100644 index 0000000..2d15a50 --- /dev/null +++ b/java/com/google/gerrit/server/git/ChangesByProjectCacheImpl.java
@@ -0,0 +1,356 @@ +// Copyright (C) 2023 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.git; + +import com.google.auto.value.AutoValue; +import com.google.common.cache.Cache; +import com.google.common.cache.Weigher; +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.common.Nullable; +import com.google.gerrit.entities.BranchNameKey; +import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.Project; +import com.google.gerrit.server.ReviewerSet; +import com.google.gerrit.server.cache.CacheModule; +import com.google.gerrit.server.git.ChangesByProjectCache.UseIndex; +import com.google.gerrit.server.index.change.ChangeField; +import com.google.gerrit.server.logging.Metadata; +import com.google.gerrit.server.logging.TraceContext; +import com.google.gerrit.server.logging.TraceContext.TraceTimer; +import com.google.gerrit.server.notedb.ChangeNotes; +import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.query.change.InternalChangeQuery; +import com.google.inject.Inject; +import com.google.inject.Provider; +import com.google.inject.Singleton; +import com.google.inject.name.Named; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.ExecutionException; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.lib.Repository; + +/** + * Lightweight cache of changes in each project. + * + * <p>This cache is intended to be used when filtering references and stores only the minimal fields + * required for a read permission check. + */ +@Singleton +public class ChangesByProjectCacheImpl implements ChangesByProjectCache { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + private static final String CACHE_NAME = "changes_by_project"; + + public static class Module extends CacheModule { + @Override + protected void configure() { + cache(CACHE_NAME, Project.NameKey.class, CachedProjectChanges.class) + .weigher(ChangesByProjetCacheWeigher.class); + bind(ChangesByProjectCache.class).to(ChangesByProjectCacheImpl.class); + } + } + + private final Cache<Project.NameKey, CachedProjectChanges> cache; + private final ChangeData.Factory cdFactory; + private final UseIndex useIndex; + private final Provider<InternalChangeQuery> queryProvider; + + @Inject + ChangesByProjectCacheImpl( + @Named(CACHE_NAME) Cache<Project.NameKey, CachedProjectChanges> cache, + ChangeData.Factory cdFactory, + UseIndex useIndex, + Provider<InternalChangeQuery> queryProvider) { + this.cache = cache; + this.cdFactory = cdFactory; + this.useIndex = useIndex; + this.queryProvider = queryProvider; + } + + /** {@inheritDoc} */ + @Override + public Collection<ChangeData> getChangeDatas(Project.NameKey project, Repository repo) + throws IOException { + CachedProjectChanges projectChanges = cache.getIfPresent(project); + if (projectChanges != null) { + return projectChanges.getUpdatedChangeDatas( + project, repo, cdFactory, ChangeNotes.Factory.scanChangeIds(repo), "Updating"); + } + if (UseIndex.TRUE.equals(useIndex)) { + return queryChangeDatasAndLoad(project); + } + return scanChangeDatasAndLoad(project, repo); + } + + private Collection<ChangeData> scanChangeDatasAndLoad(Project.NameKey project, Repository repo) + throws IOException { + CachedProjectChanges ours = new CachedProjectChanges(); + CachedProjectChanges projectChanges = ours; + try { + projectChanges = cache.get(project, () -> ours); + } catch (ExecutionException e) { + logger.atWarning().withCause(e).log("Cannot load %s for %s", CACHE_NAME, project.get()); + } + return projectChanges.getUpdatedChangeDatas( + project, + repo, + cdFactory, + ChangeNotes.Factory.scanChangeIds(repo), + ours == projectChanges ? "Scanning" : "Updating"); + } + + private Collection<ChangeData> queryChangeDatasAndLoad(Project.NameKey project) { + Collection<ChangeData> cds = queryChangeDatas(project); + cache.put(project, new CachedProjectChanges(cds)); + return cds; + } + + private Collection<ChangeData> queryChangeDatas(Project.NameKey project) { + try (TraceTimer timer = + TraceContext.newTimer( + "Querying changes of project", Metadata.builder().projectName(project.get()).build())) { + return queryProvider + .get() + .setRequestedFields(ChangeField.CHANGE, ChangeField.REVIEWER, ChangeField.REF_STATE) + .byProject(project); + } + } + + private static class CachedProjectChanges { + Map<String, Map<Change.Id, ObjectId>> metaObjectIdByNonPrivateChangeByBranch = + new ConcurrentHashMap<>(); // BranchNameKey "normalized" to a String to dedup project + Map<Change.Id, PrivateChange> privateChangeById = new ConcurrentHashMap<>(); + + public CachedProjectChanges() {} + + public CachedProjectChanges(Collection<ChangeData> cds) { + cds.stream().forEach(cd -> insert(cd)); + } + + public Collection<ChangeData> getUpdatedChangeDatas( + Project.NameKey project, + Repository repo, + ChangeData.Factory cdFactory, + Map<Change.Id, ObjectId> metaObjectIdByChange, + String operation) { + try (TraceTimer timer = + TraceContext.newTimer( + operation + " changes of project", + Metadata.builder().projectName(project.get()).build())) { + Map<Change.Id, ChangeData> cachedCdByChange = getChangeDataByChange(project, cdFactory); + List<ChangeData> cds = new ArrayList<>(); + for (Map.Entry<Change.Id, ObjectId> e : metaObjectIdByChange.entrySet()) { + Change.Id id = e.getKey(); + ChangeData cached = cachedCdByChange.get(id); + ChangeData cd = cached; + try { + if (cd == null || !cached.metaRevisionOrThrow().equals(e.getValue())) { + cd = cdFactory.create(project, id); + update(cached, cd); + } + } catch (Exception ex) { + // Do not let a bad change prevent other changes from being available. + logger.atFinest().withCause(ex).log("Can't load changeData for %s", id); + } + cds.add(cd); + } + return cds; + } + } + + public CachedProjectChanges update(ChangeData old, ChangeData updated) { + if (old != null) { + if (old.isPrivateOrThrow()) { + privateChangeById.remove(old.getId()); + } else { + Map<Change.Id, ObjectId> metaObjectIdByNonPrivateChange = + metaObjectIdByNonPrivateChangeByBranch.get(old.branchOrThrow().branch()); + if (metaObjectIdByNonPrivateChange != null) { + metaObjectIdByNonPrivateChange.remove(old.getId()); + } + } + } + return insert(updated); + } + + public CachedProjectChanges insert(ChangeData cd) { + if (cd.isPrivateOrThrow()) { + privateChangeById.put( + cd.getId(), + new AutoValue_ChangesByProjectCacheImpl_PrivateChange( + cd.change(), cd.reviewers(), cd.metaRevisionOrThrow())); + } else { + metaObjectIdByNonPrivateChangeByBranch + .computeIfAbsent(cd.branchOrThrow().branch(), b -> new ConcurrentHashMap<>()) + .put(cd.getId(), cd.metaRevisionOrThrow()); + } + return this; + } + + public Map<Change.Id, ChangeData> getChangeDataByChange( + Project.NameKey project, ChangeData.Factory cdFactory) { + Map<Change.Id, ChangeData> cdByChange = new HashMap<>(privateChangeById.size()); + for (PrivateChange pc : privateChangeById.values()) { + try { + ChangeData cd = cdFactory.create(pc.change()); + cd.setReviewers(pc.reviewers()); + cd.setMetaRevision(pc.metaRevision()); + cdByChange.put(cd.getId(), cd); + } catch (Exception ex) { + // Do not let a bad change prevent other changes from being available. + logger.atFinest().withCause(ex).log("Can't load changeData for %s", pc.change().getId()); + } + } + + for (Map.Entry<String, Map<Change.Id, ObjectId>> e : + metaObjectIdByNonPrivateChangeByBranch.entrySet()) { + BranchNameKey branch = BranchNameKey.create(project, e.getKey()); + for (Map.Entry<Change.Id, ObjectId> e2 : e.getValue().entrySet()) { + Change.Id id = e2.getKey(); + try { + cdByChange.put(id, cdFactory.createNonPrivate(branch, id, e2.getValue())); + } catch (Exception ex) { + // Do not let a bad change prevent other changes from being available. + logger.atFinest().withCause(ex).log("Can't load changeData for %s", id); + } + } + } + return cdByChange; + } + + public int weigh() { + int size = 0; + size += 24 * 2; // guess at basic ConcurrentHashMap overhead * 2 + for (Map.Entry<String, Map<Change.Id, ObjectId>> e : + metaObjectIdByNonPrivateChangeByBranch.entrySet()) { + size += JavaWeights.REFERENCE + e.getKey().length(); + size += + e.getValue().size() + * (JavaWeights.REFERENCE + + JavaWeights.OBJECT // Map.Entry + + JavaWeights.REFERENCE + + GerritWeights.CHANGE_NUM + + JavaWeights.REFERENCE + + GerritWeights.OBJECTID); + } + for (Map.Entry<Change.Id, PrivateChange> e : privateChangeById.entrySet()) { + size += JavaWeights.REFERENCE + GerritWeights.CHANGE_NUM; + size += JavaWeights.REFERENCE + e.getValue().weigh(); + } + return size; + } + } + + @AutoValue + abstract static class PrivateChange { + // Fields needed to serve permission checks on private Changes + abstract Change change(); + + @Nullable + abstract ReviewerSet reviewers(); + + abstract ObjectId metaRevision(); // Needed to confirm whether up-to-date + + public int weigh() { + int size = 0; + size += JavaWeights.OBJECT; // this + size += JavaWeights.REFERENCE + weigh(change()); + size += JavaWeights.REFERENCE + weigh(reviewers()); + size += JavaWeights.REFERENCE + GerritWeights.OBJECTID; // metaRevision + return size; + } + + private static int weigh(Change c) { + int size = 0; + size += JavaWeights.OBJECT; // change + size += JavaWeights.REFERENCE + GerritWeights.KEY_INT; // changeId + size += JavaWeights.REFERENCE + JavaWeights.OBJECT + 40; // changeKey; + size += JavaWeights.REFERENCE + GerritWeights.TIMESTAMP; // createdOn; + size += JavaWeights.REFERENCE + GerritWeights.TIMESTAMP; // lastUpdatedOn; + size += JavaWeights.REFERENCE + GerritWeights.ACCOUNT_ID; // owner; + size += + JavaWeights.REFERENCE + + c.getDest().project().get().length() + + c.getDest().branch().length(); + size += JavaWeights.CHAR; // status; + size += JavaWeights.INT; // currentPatchSetId; + size += JavaWeights.REFERENCE + c.getSubject().length(); + size += JavaWeights.REFERENCE + (c.getTopic() == null ? 0 : c.getTopic().length()); + size += + JavaWeights.REFERENCE + + (c.getOriginalSubject().equals(c.getSubject()) ? 0 : c.getSubject().length()); + size += + JavaWeights.REFERENCE + (c.getSubmissionId() == null ? 0 : c.getSubmissionId().length()); + size += JavaWeights.REFERENCE + GerritWeights.ACCOUNT_ID; // assignee; + size += JavaWeights.REFERENCE + JavaWeights.BOOLEAN; // isPrivate; + size += JavaWeights.REFERENCE + JavaWeights.BOOLEAN; // workInProgress; + size += JavaWeights.REFERENCE + JavaWeights.BOOLEAN; // reviewStarted; + size += JavaWeights.REFERENCE + GerritWeights.CHANGE_NUM; // revertOf; + size += JavaWeights.REFERENCE + GerritWeights.PACTCH_SET_ID; // cherryPickOf; + return size; + } + + private static int weigh(ReviewerSet rs) { + int size = 0; + size += JavaWeights.OBJECT; // ReviewerSet + size += JavaWeights.REFERENCE; // table + size += + rs.asTable().cellSet().size() + * (JavaWeights.OBJECT // cell (at least one object) + + JavaWeights.REFERENCE // ReviewerStateInternal + + (JavaWeights.REFERENCE + GerritWeights.ACCOUNT_ID) + + (JavaWeights.REFERENCE + GerritWeights.TIMESTAMP)); + size += JavaWeights.REFERENCE; // accounts + return size; + } + } + + private static class ChangesByProjetCacheWeigher + implements Weigher<Project.NameKey, CachedProjectChanges> { + @Override + public int weigh(Project.NameKey project, CachedProjectChanges changes) { + int size = 0; + size += project.get().length(); + size += changes.weigh(); + return size; + } + } + + private static class GerritWeights { + public static final int KEY_INT = JavaWeights.OBJECT + JavaWeights.INT; // IntKey + public static final int CHANGE_NUM = KEY_INT; + public static final int ACCOUNT_ID = KEY_INT; + public static final int PACTCH_SET_ID = + JavaWeights.OBJECT + + (JavaWeights.REFERENCE + GerritWeights.CHANGE_NUM) // PatchSet.Id.changeId + + JavaWeights.INT; // PatchSet.Id patch_num; + public static final int TIMESTAMP = JavaWeights.OBJECT + 8; // Timestamp + public static final int OBJECTID = JavaWeights.OBJECT + (5 * JavaWeights.INT); // (w1-w5) + } + + private static class JavaWeights { + public static final int BOOLEAN = 1; + public static final int CHAR = 1; + public static final int INT = 4; + public static final int OBJECT = 16; + public static final int REFERENCE = 8; + } +}
diff --git a/java/com/google/gerrit/server/git/CommitUtil.java b/java/com/google/gerrit/server/git/CommitUtil.java index 47cbd60..73378f6 100644 --- a/java/com/google/gerrit/server/git/CommitUtil.java +++ b/java/com/google/gerrit/server/git/CommitUtil.java
@@ -20,9 +20,7 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; -import com.google.gerrit.entities.Account.Id; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.api.changes.RevertInput; @@ -30,12 +28,12 @@ import com.google.gerrit.extensions.restapi.ResourceConflictException; import com.google.gerrit.extensions.restapi.ResourceNotFoundException; import com.google.gerrit.extensions.restapi.RestApiException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.CommonConverters; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.GerritPersonIdent; import com.google.gerrit.server.ReviewerSet; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.ChangeInserter; import com.google.gerrit.server.change.ChangeMessages; import com.google.gerrit.server.change.NotifyResolver; @@ -48,7 +46,7 @@ import com.google.gerrit.server.update.BatchUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.UpdateException; import com.google.gerrit.server.util.CommitMessageUtil; import com.google.inject.Inject; @@ -266,7 +264,7 @@ Change changeToRevert = notes.getChange(); Change.Id changeId = Change.id(seq.nextChangeId()); if (input.workInProgress) { - input.notify = NotifyHandling.OWNER; + input.notify = firstNonNull(input.notify, NotifyHandling.OWNER); } NotifyResolver.Result notify = notifyResolver.resolve(firstNonNull(input.notify, NotifyHandling.ALL), input.notifyDetails); @@ -279,7 +277,7 @@ ReviewerSet reviewerSet = approvalsUtil.getReviewers(notes); - Set<Id> reviewers = new HashSet<>(); + Set<Account.Id> reviewers = new HashSet<>(); reviewers.add(changeToRevert.getOwner()); reviewers.addAll(reviewerSet.byState(ReviewerStateInternal.REVIEWER)); reviewers.remove(user.getAccountId()); @@ -310,8 +308,9 @@ } @Override - public void postUpdate(Context ctx) throws Exception { - changeReverted.fire(change, ins.getChange(), ctx.getWhen()); + public void postUpdate(PostUpdateContext ctx) throws Exception { + changeReverted.fire( + ctx.getChangeData(change), ctx.getChangeData(ins.getChange()), ctx.getWhen()); try { RevertedSender emailSender = revertedSenderFactory.create(ctx.getProject(), change.getId()); emailSender.setFrom(ctx.getAccountId()); @@ -335,14 +334,10 @@ @Override public boolean updateChange(ChangeContext ctx) { - Change change = ctx.getChange(); - PatchSet.Id patchSetId = change.currentPatchSetId(); - ChangeMessage changeMessage = - ChangeMessagesUtil.newMessage( - ctx, - "Created a revert of this change as I" + computedChangeId.name(), - ChangeMessagesUtil.TAG_REVERT); - cmUtil.addChangeMessage(ctx.getUpdate(patchSetId), changeMessage); + cmUtil.setChangeMessage( + ctx, + "Created a revert of this change as I" + computedChangeId.name(), + ChangeMessagesUtil.TAG_REVERT); return true; } }
diff --git a/java/com/google/gerrit/server/git/DelegateRefDatabase.java b/java/com/google/gerrit/server/git/DelegateRefDatabase.java index decae05..bc5dd00 100644 --- a/java/com/google/gerrit/server/git/DelegateRefDatabase.java +++ b/java/com/google/gerrit/server/git/DelegateRefDatabase.java
@@ -15,10 +15,12 @@ package com.google.gerrit.server.git; import java.io.IOException; +import java.util.Collection; import java.util.List; import java.util.Map; import java.util.Set; import org.eclipse.jgit.annotations.NonNull; +import org.eclipse.jgit.lib.BatchRefUpdate; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Ref; import org.eclipse.jgit.lib.RefDatabase; @@ -34,7 +36,7 @@ private Repository delegate; - DelegateRefDatabase(Repository delegate) { + public DelegateRefDatabase(Repository delegate) { this.delegate = delegate; } @@ -49,11 +51,21 @@ } @Override + public boolean hasVersioning() { + return delegate.getRefDatabase().hasVersioning(); + } + + @Override public boolean isNameConflicting(String name) throws IOException { return delegate.getRefDatabase().isNameConflicting(name); } @Override + public Collection<String> getConflictingNames(String name) throws IOException { + return delegate.getRefDatabase().getConflictingNames(name); + } + + @Override public RefUpdate newUpdate(String name, boolean detach) throws IOException { return delegate.getRefDatabase().newUpdate(name, detach); } @@ -64,10 +76,35 @@ } @Override + public BatchRefUpdate newBatchUpdate() { + return delegate.getRefDatabase().newBatchUpdate(); + } + + @Override + public boolean performsAtomicTransactions() { + return delegate.getRefDatabase().performsAtomicTransactions(); + } + + @Override public Ref exactRef(String name) throws IOException { return delegate.getRefDatabase().exactRef(name); } + @Override + public Map<String, Ref> exactRef(String... refs) throws IOException { + return delegate.getRefDatabase().exactRef(refs); + } + + @Override + public Ref firstExactRef(String... refs) throws IOException { + return delegate.getRefDatabase().firstExactRef(refs); + } + + @Override + public List<Ref> getRefs() throws IOException { + return delegate.getRefDatabase().getRefs(); + } + @SuppressWarnings("deprecation") @Override public Map<String, Ref> getRefs(String prefix) throws IOException { @@ -75,12 +112,38 @@ } @Override + public List<Ref> getRefsByPrefix(String prefix) throws IOException { + return delegate.getRefDatabase().getRefsByPrefix(prefix); + } + + @Override + public List<Ref> getRefsByPrefixWithExclusions(String include, Set<String> excludes) + throws IOException { + return delegate.getRefDatabase().getRefsByPrefixWithExclusions(include, excludes); + } + + @Override + public List<Ref> getRefsByPrefix(String... prefixes) throws IOException { + return delegate.getRefDatabase().getRefsByPrefix(prefixes); + } + + @Override @NonNull public Set<Ref> getTipsWithSha1(ObjectId id) throws IOException { return delegate.getRefDatabase().getTipsWithSha1(id); } @Override + public boolean hasFastTipsWithSha1() throws IOException { + return delegate.getRefDatabase().hasFastTipsWithSha1(); + } + + @Override + public boolean hasRefs() throws IOException { + return delegate.getRefDatabase().hasRefs(); + } + + @Override public List<Ref> getAdditionalRefs() throws IOException { return delegate.getRefDatabase().getAdditionalRefs(); } @@ -90,7 +153,12 @@ return delegate.getRefDatabase().peel(ref); } - Repository getDelegate() { + @Override + public void refresh() { + delegate.getRefDatabase().refresh(); + } + + protected Repository getDelegate() { return delegate; } }
diff --git a/java/com/google/gerrit/server/git/DelegateRepository.java b/java/com/google/gerrit/server/git/DelegateRepository.java index 815dabc..9046d9d 100644 --- a/java/com/google/gerrit/server/git/DelegateRepository.java +++ b/java/com/google/gerrit/server/git/DelegateRepository.java
@@ -215,12 +215,12 @@ } @Override - public Set<ObjectId> getAdditionalHaves() { + public Set<ObjectId> getAdditionalHaves() throws IOException { return delegate.getAdditionalHaves(); } @Override - public Map<AnyObjectId, Set<Ref>> getAllRefsByPeeledObjectId() { + public Map<AnyObjectId, Set<Ref>> getAllRefsByPeeledObjectId() throws IOException { return delegate.getAllRefsByPeeledObjectId(); }
diff --git a/java/com/google/gerrit/server/git/GarbageCollection.java b/java/com/google/gerrit/server/git/GarbageCollection.java index c37572d..6ae4d62 100644 --- a/java/com/google/gerrit/server/git/GarbageCollection.java +++ b/java/com/google/gerrit/server/git/GarbageCollection.java
@@ -18,6 +18,7 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; import com.google.gerrit.common.data.GarbageCollectionResult; +import com.google.gerrit.common.data.GarbageCollectionResult.GcError; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.events.GarbageCollectorListener; import com.google.gerrit.server.config.GcConfig; @@ -78,9 +79,7 @@ Set<Project.NameKey> projectsToGc = gcQueue.addAll(projectNames); for (Project.NameKey projectName : Sets.difference(Sets.newHashSet(projectNames), projectsToGc)) { - result.addError( - new GarbageCollectionResult.Error( - GarbageCollectionResult.Error.Type.GC_ALREADY_SCHEDULED, projectName)); + result.addError(new GcError(GcError.Type.GC_ALREADY_SCHEDULED, projectName)); } for (Project.NameKey p : projectsToGc) { try (Repository repo = repoManager.openRepository(p)) { @@ -102,13 +101,10 @@ fire(p, statistics); } catch (RepositoryNotFoundException e) { logGcError(writer, p, e); - result.addError( - new GarbageCollectionResult.Error( - GarbageCollectionResult.Error.Type.REPOSITORY_NOT_FOUND, p)); + result.addError(new GcError(GcError.Type.REPOSITORY_NOT_FOUND, p)); } catch (Exception e) { logGcError(writer, p, e); - result.addError( - new GarbageCollectionResult.Error(GarbageCollectionResult.Error.Type.GC_FAILED, p)); + result.addError(new GcError(GcError.Type.GC_FAILED, p)); } finally { gcQueue.gcFinished(p); }
diff --git a/java/com/google/gerrit/server/git/GitRepositoryManager.java b/java/com/google/gerrit/server/git/GitRepositoryManager.java index e4d0696..8dba3e1 100644 --- a/java/com/google/gerrit/server/git/GitRepositoryManager.java +++ b/java/com/google/gerrit/server/git/GitRepositoryManager.java
@@ -30,6 +30,23 @@ */ @ImplementedBy(value = LocalDiskRepositoryManager.class) public interface GitRepositoryManager { + + /** Status of the repository. */ + enum Status { + /** Repository exists and is available on host. */ + ACTIVE, + /** Repository does not exist. */ + NON_EXISTENT, + /** + * Repository might exist but can not be opened. This can for example be the case when the + * repository is pending deletion / the caller does not have permissions / repository is broken. + */ + UNAVAILABLE; + } + + /** Get {@link Status} of the repository by name. */ + Status getRepositoryStatus(Project.NameKey name); + /** * Get (or open) a repository by name. * @@ -47,15 +64,16 @@ * @param name the repository name, relative to the base directory. * @return the cached Repository instance. Caller must call {@code close()} when done to decrement * the resource handle. + * @throws RepositoryExistsException repository exists. * @throws RepositoryCaseMismatchException the name collides with an existing repository name, but * only in case of a character within the name. * @throws RepositoryNotFoundException the name is invalid. * @throws IOException the repository cannot be created. */ Repository createRepository(Project.NameKey name) - throws RepositoryCaseMismatchException, RepositoryNotFoundException, IOException; + throws RepositoryNotFoundException, RepositoryExistsException, IOException; - /** @return set of all known projects, sorted by natural NameKey order. */ + /** Returns set of all known projects, sorted by natural NameKey order. */ SortedSet<Project.NameKey> list(); /**
diff --git a/java/com/google/gerrit/server/git/GitRepositoryManagerModule.java b/java/com/google/gerrit/server/git/GitRepositoryManagerModule.java index e4137b0..dfbe663 100644 --- a/java/com/google/gerrit/server/git/GitRepositoryManagerModule.java +++ b/java/com/google/gerrit/server/git/GitRepositoryManagerModule.java
@@ -17,6 +17,8 @@ import com.google.gerrit.lifecycle.LifecycleModule; import com.google.gerrit.server.ModuleImpl; import com.google.gerrit.server.config.RepositoryConfig; +import com.google.gerrit.server.git.LocalDiskRepositoryManager.LocalDiskRepositoryManagerModule; +import com.google.gerrit.server.git.MultiBaseLocalDiskRepositoryManager.MultiBaseLocalDiskRepositoryManagerModule; import com.google.inject.Inject; /** @@ -37,9 +39,9 @@ @Override protected void configure() { if (repoConfig.getAllBasePaths().isEmpty()) { - install(new LocalDiskRepositoryManager.Module()); + install(new LocalDiskRepositoryManagerModule()); } else { - install(new MultiBaseLocalDiskRepositoryManager.Module()); + install(new MultiBaseLocalDiskRepositoryManagerModule()); } } }
diff --git a/java/com/google/gerrit/server/git/HookUtil.java b/java/com/google/gerrit/server/git/HookUtil.java index fd29c8deb..cafa18e 100644 --- a/java/com/google/gerrit/server/git/HookUtil.java +++ b/java/com/google/gerrit/server/git/HookUtil.java
@@ -43,12 +43,12 @@ refs = rp.getRepository().getRefDatabase().getRefs().stream() .collect(toMap(Ref::getName, r -> r)); + rp.setAdvertisedRefs(refs, rp.getAdvertisedObjects()); } catch (ServiceMayNotContinueException e) { throw e; } catch (IOException e) { throw new ServiceMayNotContinueException(e); } - rp.setAdvertisedRefs(refs, rp.getAdvertisedObjects()); return refs; } @@ -70,12 +70,12 @@ refs = up.getRepository().getRefDatabase().getRefs().stream() .collect(toMap(Ref::getName, r -> r)); + up.setAdvertisedRefs(refs); } catch (ServiceMayNotContinueException e) { throw e; } catch (IOException e) { throw new ServiceMayNotContinueException(e); } - up.setAdvertisedRefs(refs); return refs; }
diff --git a/java/com/google/gerrit/server/git/LocalDiskRepositoryManager.java b/java/com/google/gerrit/server/git/LocalDiskRepositoryManager.java index 3054d76..6b5fd2e 100644 --- a/java/com/google/gerrit/server/git/LocalDiskRepositoryManager.java +++ b/java/com/google/gerrit/server/git/LocalDiskRepositoryManager.java
@@ -16,6 +16,7 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Project; +import com.google.gerrit.entities.Project.NameKey; import com.google.gerrit.entities.RefNames; import com.google.gerrit.extensions.events.LifecycleListener; import com.google.gerrit.lifecycle.LifecycleModule; @@ -54,7 +55,7 @@ public class LocalDiskRepositoryManager implements GitRepositoryManager { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - public static class Module extends LifecycleModule { + public static class LocalDiskRepositoryManagerModule extends LifecycleModule { @Override protected void configure() { listener().to(LocalDiskRepositoryManager.Lifecycle.class); @@ -131,6 +132,29 @@ } @Override + public Status getRepositoryStatus(NameKey name) { + if (isUnreasonableName(name)) { + return Status.NON_EXISTENT; + } + Path path = getBasePath(name); + File dir = FileKey.resolve(path.resolve(name.get()).toFile(), FS.DETECTED); + if (dir == null) { + return Status.NON_EXISTENT; + } + Repository repo; + try { + // Try to open with mustExist, so that it does not attempt to create a repository. + repo = RepositoryCache.open(FileKey.lenient(dir, FS.DETECTED), /*mustExist=*/ true); + } catch (RepositoryNotFoundException e) { + return Status.NON_EXISTENT; + } catch (IOException e) { + return Status.UNAVAILABLE; + } + // If object database does not exist, the repository is unusable + return repo.getObjectDatabase().exists() ? Status.ACTIVE : Status.UNAVAILABLE; + } + + @Override public Repository openRepository(Project.NameKey name) throws RepositoryNotFoundException { FileKey cachedLocation = fileKeyByProject.get(name); if (cachedLocation != null) { @@ -156,7 +180,7 @@ @Override public Repository createRepository(Project.NameKey name) - throws RepositoryNotFoundException, RepositoryCaseMismatchException, IOException { + throws RepositoryNotFoundException, RepositoryExistsException, IOException { if (isUnreasonableName(name)) { throw new RepositoryNotFoundException("Invalid name: " + name); } @@ -171,8 +195,7 @@ if (!onDiskName.equals(name)) { throw new RepositoryCaseMismatchException(name); } - - throw new IllegalStateException("Repository already exists: " + name); + throw new RepositoryExistsException(name); } // It doesn't exist under any of the standard permutations
diff --git a/java/com/google/gerrit/server/git/MergeTip.java b/java/com/google/gerrit/server/git/MergeTip.java index 204f453..4ffa1a8 100644 --- a/java/com/google/gerrit/server/git/MergeTip.java +++ b/java/com/google/gerrit/server/git/MergeTip.java
@@ -52,8 +52,8 @@ } /** - * @return the initial tip of the branch before the merge operation started; may be null, - * indicating a previously unborn branch. + * Returns the initial tip of the branch before the merge operation started; may be null, + * indicating a previously unborn branch. */ public CodeReviewCommit getInitialTip() { return initialTip; @@ -82,8 +82,8 @@ } /** - * @return The current tip of the current merge operation; may be null, indicating an unborn - * branch. + * Returns The current tip of the current merge operation; may be null, indicating an unborn + * branch. */ @Nullable public CodeReviewCommit getCurrentTip() {
diff --git a/java/com/google/gerrit/server/git/MergeUtil.java b/java/com/google/gerrit/server/git/MergeUtil.java index 16a1ae6..fac05d2 100644 --- a/java/com/google/gerrit/server/git/MergeUtil.java +++ b/java/com/google/gerrit/server/git/MergeUtil.java
@@ -47,9 +47,9 @@ import com.google.gerrit.extensions.restapi.MergeConflictException; import com.google.gerrit.extensions.restapi.MethodNotAllowedException; import com.google.gerrit.extensions.restapi.ResourceNotFoundException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.IdentifiedUser; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.config.UrlFormatter; import com.google.gerrit.server.git.CodeReviewCommit.CodeReviewRevWalk; @@ -223,9 +223,8 @@ int parentIndex, boolean ignoreIdenticalTree, boolean allowConflicts) - throws MissingObjectException, IncorrectObjectTypeException, IOException, - MergeIdenticalTreeException, MergeConflictException, MethodNotAllowedException, - InvalidMergeStrategyException { + throws IOException, MergeIdenticalTreeException, MergeConflictException, + MethodNotAllowedException, InvalidMergeStrategyException { ThreeWayMerger m = newThreeWayMerger(inserter, repoConfig); m.setBase(originalCommit.getParent(parentIndex)); @@ -247,7 +246,10 @@ } } else { if (!allowConflicts) { - throw new MergeConflictException("merge conflict"); + throw new MergeConflictException( + String.format( + "merge conflict while merging commits %s and %s", + mergeTip.toObjectId(), originalCommit.toObjectId())); } if (!useContentMerge) { @@ -510,9 +512,6 @@ * <li>Change-Id * </ul> * - * @param n - * @param notes - * @param psId * @return new message */ private String createDetailedCommitMessage(RevCommit n, ChangeNotes notes, PatchSet.Id psId) { @@ -600,11 +599,11 @@ } else if (isVerified(a.labelId())) { tag = "Tested-by"; } else { - final LabelType lt = project.getLabelTypes().byLabel(a.labelId()); - if (lt == null) { + final Optional<LabelType> lt = project.getLabelTypes().byLabel(a.labelId()); + if (!lt.isPresent()) { continue; } - tag = lt.getName(); + tag = lt.get().getName(); } if (!contains(footers, new FooterKey(tag), identbuf.toString())) { @@ -628,10 +627,6 @@ * Plugins implementing {@link ChangeMessageModifier} can modify the resulting commit message * arbitrarily. * - * @param n - * @param mergeTip - * @param notes - * @param id * @return new message */ public String createCommitMessageOnSubmit( @@ -650,7 +645,7 @@ private Iterable<PatchSetApproval> safeGetApprovals(ChangeNotes notes, PatchSet.Id psId) { try { - return approvalsUtil.byPatchSet(notes, psId, null, null); + return approvalsUtil.byPatchSet(notes, psId); } catch (StorageException e) { logger.atSevere().withCause(e).log("Can't read approval records for %s", psId); return Collections.emptyList(); @@ -684,6 +679,10 @@ return false; } + return canMerge(mergeTip, repo, toMerge); + } + + private boolean canMerge(CodeReviewCommit mergeTip, Repository repo, CodeReviewCommit toMerge) { try (ObjectInserter ins = new InMemoryInserter(repo)) { return newThreeWayMerger(ins, repo.getConfig()).merge(mergeTip, toMerge); } catch (LargeObjectException e) { @@ -705,6 +704,11 @@ return false; } + return canFastForward(mergeTip, rw, toMerge); + } + + private boolean canFastForward( + CodeReviewCommit mergeTip, CodeReviewRevWalk rw, CodeReviewCommit toMerge) { try { return mergeTip == null || rw.isMergedInto(mergeTip, toMerge) @@ -714,6 +718,19 @@ } } + public boolean canFastForwardOrMerge( + MergeSorter mergeSorter, + CodeReviewCommit mergeTip, + CodeReviewRevWalk rw, + Repository repo, + CodeReviewCommit toMerge) { + if (hasMissingDependencies(mergeSorter, toMerge)) { + return false; + } + + return canFastForward(mergeTip, rw, toMerge) || canMerge(mergeTip, repo, toMerge); + } + public boolean canCherryPick( MergeSorter mergeSorter, Repository repo, @@ -756,8 +773,7 @@ // by an equivalent merge with a different first parent. So // instead behave as though MERGE_IF_NECESSARY was configured. // - return canFastForward(mergeSorter, mergeTip, rw, toMerge) - || canMerge(mergeSorter, repo, mergeTip, toMerge); + return canFastForwardOrMerge(mergeSorter, mergeTip, rw, repo, toMerge); } public boolean hasMissingDependencies(MergeSorter mergeSorter, CodeReviewCommit toMerge) {
diff --git a/java/com/google/gerrit/server/git/MergedByPushOp.java b/java/com/google/gerrit/server/git/MergedByPushOp.java index 78cb013..426f8db 100644 --- a/java/com/google/gerrit/server/git/MergedByPushOp.java +++ b/java/com/google/gerrit/server/git/MergedByPushOp.java
@@ -18,7 +18,6 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.LabelId; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetInfo; @@ -33,7 +32,7 @@ import com.google.gerrit.server.patch.PatchSetInfoFactory; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.util.RequestScopePropagator; import com.google.inject.Inject; import com.google.inject.Provider; @@ -169,16 +168,13 @@ } } msgBuf.append("."); - ChangeMessage msg = - ChangeMessagesUtil.newMessage( - psId, ctx.getUser(), ctx.getWhen(), msgBuf.toString(), ChangeMessagesUtil.TAG_MERGED); - cmUtil.addChangeMessage(update, msg); + cmUtil.setChangeMessage(update, msgBuf.toString(), ChangeMessagesUtil.TAG_MERGED); update.putApproval(LabelId.legacySubmit().get(), (short) 1); return true; } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { if (!correctBranch) { return; } @@ -214,7 +210,8 @@ } })); - changeMerged.fire(change, patchSet, ctx.getAccount(), mergeResultRevId, ctx.getWhen()); + changeMerged.fire( + ctx.getChangeData(change), patchSet, ctx.getAccount(), mergeResultRevId, ctx.getWhen()); } private PatchSetInfo getPatchSetInfo(ChangeContext ctx) throws IOException {
diff --git a/java/com/google/gerrit/server/git/MultiBaseLocalDiskRepositoryManager.java b/java/com/google/gerrit/server/git/MultiBaseLocalDiskRepositoryManager.java index fd6506a..72e2df4 100644 --- a/java/com/google/gerrit/server/git/MultiBaseLocalDiskRepositoryManager.java +++ b/java/com/google/gerrit/server/git/MultiBaseLocalDiskRepositoryManager.java
@@ -35,7 +35,7 @@ @Singleton public class MultiBaseLocalDiskRepositoryManager extends LocalDiskRepositoryManager { - public static class Module extends LifecycleModule { + public static class MultiBaseLocalDiskRepositoryManagerModule extends LifecycleModule { @Override protected void configure() { bind(GitRepositoryManager.class).to(MultiBaseLocalDiskRepositoryManager.class);
diff --git a/java/com/google/gerrit/server/git/MultiProgressMonitor.java b/java/com/google/gerrit/server/git/MultiProgressMonitor.java index 15fbe3f..1acd98e 100644 --- a/java/com/google/gerrit/server/git/MultiProgressMonitor.java +++ b/java/com/google/gerrit/server/git/MultiProgressMonitor.java
@@ -14,14 +14,21 @@ package com.google.gerrit.server.git; +import static com.google.gerrit.server.DeadlineChecker.getTimeoutFormatter; +import static java.util.concurrent.TimeUnit.MILLISECONDS; import static java.util.concurrent.TimeUnit.NANOSECONDS; import com.google.common.base.Strings; import com.google.common.flogger.FluentLogger; import com.google.common.util.concurrent.UncheckedExecutionException; +import com.google.gerrit.server.CancellationMetrics; +import com.google.gerrit.server.cancellation.RequestStateProvider; +import com.google.inject.assistedinject.Assisted; +import com.google.inject.assistedinject.AssistedInject; import java.io.IOException; import java.io.OutputStream; import java.util.List; +import java.util.Optional; import java.util.concurrent.CancellationException; import java.util.concurrent.CopyOnWriteArrayList; import java.util.concurrent.ExecutionException; @@ -48,8 +55,26 @@ * <p>Callers should try to keep task and sub-task descriptions short, since the output should fit * on one terminal line. (Note that git clients do not accept terminal control characters, so true * multi-line progress messages would be impossible.) + * + * <p>Whether the client is disconnected or the deadline is exceeded can be checked by {@link + * #checkIfCancelled(RequestStateProvider.OnCancelled)}. This allows the worker thread to react to + * cancellations and abort its execution and finish gracefully. After a cancellation has been + * signaled the worker thread has 10 * {@link #maxIntervalNanos} to react to the cancellation and + * finish gracefully. If the worker thread doesn't finish gracefully in time after the cancellation + * has been signaled, the future executing the task is forcefully cancelled which means that the + * worker thread gets interrupted and an internal error is returned to the client. To react to + * cancellations it is recommended that the task opens a {@link + * com.google.gerrit.server.cancellation.RequestStateContext} in a try-with-resources block to + * register the {@link MultiProgressMonitor} as a {@link RequestStateProvider}. This way the worker + * thread gets aborted by a {@link com.google.gerrit.server.cancellation.RequestCancelledException} + * when the request is cancelled which allows the worker thread to handle the cancellation + * gracefully by catching this exception (e.g. to return a proper error message). {@link + * com.google.gerrit.server.cancellation.RequestCancelledException} is only thrown when the worker + * thread checks for cancellation via {@link + * com.google.gerrit.server.cancellation.RequestStateContext#abortIfCancelled()}. E.g. this is done + * whenever {@link com.google.gerrit.server.logging.TraceContext.TraceTimer} is opened/closed. */ -public class MultiProgressMonitor { +public class MultiProgressMonitor implements RequestStateProvider { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); /** Constant indicating the total work units cannot be predicted. */ @@ -58,6 +83,11 @@ private static final char[] SPINNER_STATES = new char[] {'-', '\\', '|', '/'}; private static final char NO_SPINNER = ' '; + public enum TaskKind { + INDEXING, + RECEIVE_COMMITS; + } + /** Handle for a sub-task. */ public class Task implements ProgressMonitor { private final String name; @@ -137,6 +167,11 @@ public String getTotalDisplay(int total) { return String.valueOf(total); } + + @Override + public void showDuration(boolean enabled) { + // not implemented + } } /** Handle for a sub-task whose total work can be updated while the task is in progress. */ @@ -185,13 +220,29 @@ } } + public interface Factory { + MultiProgressMonitor create(OutputStream out, TaskKind taskKind, String taskName); + + MultiProgressMonitor create( + OutputStream out, + TaskKind taskKind, + String taskName, + long maxIntervalTime, + TimeUnit maxIntervalUnit); + } + + private final CancellationMetrics cancellationMetrics; private final OutputStream out; + private final TaskKind taskKind; private final String taskName; private final List<Task> tasks = new CopyOnWriteArrayList<>(); private int spinnerIndex; private char spinnerState = NO_SPINNER; private boolean done; - private boolean write = true; + private boolean clientDisconnected; + private boolean deadlineExceeded; + private boolean forcefulTermination; + private Optional<Long> timeout = Optional.empty(); private final long maxIntervalNanos; @@ -201,8 +252,14 @@ * @param out stream for writing progress messages. * @param taskName name of the overall task. */ - public MultiProgressMonitor(OutputStream out, String taskName) { - this(out, taskName, 500, TimeUnit.MILLISECONDS); + @SuppressWarnings("UnusedMethod") + @AssistedInject + private MultiProgressMonitor( + CancellationMetrics cancellationMetrics, + @Assisted OutputStream out, + @Assisted TaskKind taskKind, + @Assisted String taskName) { + this(cancellationMetrics, out, taskKind, taskName, 500, MILLISECONDS); } /** @@ -213,9 +270,17 @@ * @param maxIntervalTime maximum interval between progress messages. * @param maxIntervalUnit time unit for progress interval. */ - public MultiProgressMonitor( - OutputStream out, String taskName, long maxIntervalTime, TimeUnit maxIntervalUnit) { + @AssistedInject + private MultiProgressMonitor( + CancellationMetrics cancellationMetrics, + @Assisted OutputStream out, + @Assisted TaskKind taskKind, + @Assisted String taskName, + @Assisted long maxIntervalTime, + @Assisted TimeUnit maxIntervalUnit) { + this.cancellationMetrics = cancellationMetrics; this.out = out; + this.taskKind = taskKind; this.taskName = taskName; maxIntervalNanos = NANOSECONDS.convert(maxIntervalTime, maxIntervalUnit); } @@ -223,11 +288,16 @@ /** * Wait for a task managed by a {@link Future}, with no timeout. * - * @see #waitFor(Future, long, TimeUnit) + * @see #waitFor(Future, long, TimeUnit, long, TimeUnit) */ public <T> T waitFor(Future<T> workerFuture) { try { - return waitFor(workerFuture, 0, null); + return waitFor( + workerFuture, + /* taskTimeoutTime= */ 0, + /* taskTimeoutUnit= */ null, + /* cancellationTimeoutTime= */ 0, + /* cancellationTimeoutUnit= */ null); } catch (TimeoutException e) { throw new IllegalStateException("timout exception without setting a timeout", e); } @@ -242,15 +312,30 @@ * * @see #waitForNonFinalTask(Future, long, TimeUnit) * @param workerFuture a future that returns when worker threads are finished. - * @param timeoutTime overall timeout for the task; the future is forcefully cancelled if the task - * exceeds the timeout. Non-positive values indicate no timeout. - * @param timeoutUnit unit for overall task timeout. + * @param taskTimeoutTime overall timeout for the task; the future gets a cancellation signal + * after this timeout is exceeded; non-positive values indicate no timeout. + * @param taskTimeoutUnit unit for overall task timeout. + * @param cancellationTimeoutTime timeout for the task to react to the cancellation signal; if the + * task doesn't terminate within this time it is forcefully cancelled; non-positive values + * indicate no timeout. + * @param cancellationTimeoutUnit unit for the cancellation timeout. * @throws TimeoutException if this thread or a worker thread was interrupted, the worker was * cancelled, or timed out waiting for a worker to call {@link #end()}. */ - public <T> T waitFor(Future<T> workerFuture, long timeoutTime, TimeUnit timeoutUnit) + public <T> T waitFor( + Future<T> workerFuture, + long taskTimeoutTime, + TimeUnit taskTimeoutUnit, + long cancellationTimeoutTime, + TimeUnit cancellationTimeoutUnit) throws TimeoutException { - T t = waitForNonFinalTask(workerFuture, timeoutTime, timeoutUnit); + T t = + waitForNonFinalTask( + workerFuture, + taskTimeoutTime, + taskTimeoutUnit, + cancellationTimeoutTime, + cancellationTimeoutUnit); synchronized (this) { if (!done) { // The worker may not have called end() explicitly, which is likely a @@ -270,7 +355,7 @@ */ public <T> T waitForNonFinalTask(Future<T> workerFuture) { try { - return waitForNonFinalTask(workerFuture, 0, null); + return waitForNonFinalTask(workerFuture, 0, null, 0, null); } catch (TimeoutException e) { throw new IllegalStateException("timout exception without setting a timeout", e); } @@ -281,18 +366,32 @@ * call {@link #end()}. It is intended to be used to track a non-final task. * * @param workerFuture a future that returns when worker threads are finished. - * @param timeoutTime overall timeout for the task; the future is forcefully cancelled if the task - * exceeds the timeout. Non-positive values indicate no timeout. - * @param timeoutUnit unit for overall task timeout. + * @param taskTimeoutTime overall timeout for the task; the future is forcefully cancelled if the + * task exceeds the timeout. Non-positive values indicate no timeout. + * @param taskTimeoutUnit unit for overall task timeout. + * @param cancellationTimeoutTime timeout for the task to react to the cancellation signal; if the + * task doesn't terminate within this time it is forcefully cancelled; non-positive values + * indicate no timeout. + * @param cancellationTimeoutUnit unit for the cancellation timeout. * @throws TimeoutException if this thread or a worker thread was interrupted, the worker was * cancelled, or timed out waiting for a worker to call {@link #end()}. */ - public <T> T waitForNonFinalTask(Future<T> workerFuture, long timeoutTime, TimeUnit timeoutUnit) + public <T> T waitForNonFinalTask( + Future<T> workerFuture, + long taskTimeoutTime, + TimeUnit taskTimeoutUnit, + long cancellationTimeoutTime, + TimeUnit cancellationTimeoutUnit) throws TimeoutException { long overallStart = System.nanoTime(); + long cancellationNanos = + cancellationTimeoutTime > 0 + ? NANOSECONDS.convert(cancellationTimeoutTime, cancellationTimeoutUnit) + : 0; long deadline; - if (timeoutTime > 0) { - deadline = overallStart + NANOSECONDS.convert(timeoutTime, timeoutUnit); + if (taskTimeoutTime > 0) { + timeout = Optional.of(NANOSECONDS.convert(taskTimeoutTime, taskTimeoutUnit)); + deadline = overallStart + timeout.get(); } else { deadline = 0; } @@ -312,14 +411,35 @@ long now = System.nanoTime(); if (deadline > 0 && now > deadline) { - workerFuture.cancel(true); - if (workerFuture.isCancelled()) { - logger.atWarning().log( - "MultiProgressMonitor worker killed after %sms: (timeout %sms, cancelled)", - TimeUnit.MILLISECONDS.convert(now - overallStart, NANOSECONDS), - TimeUnit.MILLISECONDS.convert(now - deadline, NANOSECONDS)); + if (!deadlineExceeded) { + logger.atFine().log( + "deadline exceeded after %sms, signaling cancellation (timeout=%sms, task=%s(%s))", + MILLISECONDS.convert(now - overallStart, NANOSECONDS), + MILLISECONDS.convert(now - deadline, NANOSECONDS), + taskKind, + taskName); } - break; + deadlineExceeded = true; + + // After setting deadlineExceeded = true give the cancellationNanos to react to the + // cancellation and return gracefully. + if (now > deadline + cancellationNanos) { + // The worker didn't react to the cancellation, cancel it forcefully by an interrupt. + workerFuture.cancel(true); + forcefulTermination = true; + if (workerFuture.isCancelled()) { + logger.atWarning().log( + "MultiProgressMonitor worker killed after %sms, cancelled (timeout=%sms, task=%s(%s))", + MILLISECONDS.convert(now - overallStart, NANOSECONDS), + MILLISECONDS.convert(now - deadline, NANOSECONDS), + taskKind, + taskName); + if (taskKind == TaskKind.RECEIVE_COMMITS) { + cancellationMetrics.countForcefulReceiveTimeout(); + } + } + break; + } } left -= now - start; @@ -329,15 +449,19 @@ } sendUpdate(); } + if (deadlineExceeded && !forcefulTermination && taskKind == TaskKind.RECEIVE_COMMITS) { + cancellationMetrics.countGracefulReceiveTimeout(); + } wakeUp(); } // The loop exits as soon as the worker calls end(), but we give it another - // maxInterval to finish up and return. + // 2 x maxIntervalNanos to finish up and return. try { - return workerFuture.get(maxIntervalNanos, NANOSECONDS); + return workerFuture.get(2 * maxIntervalNanos, NANOSECONDS); } catch (InterruptedException | CancellationException e) { - logger.atWarning().withCause(e).log("unable to finish processing"); + logger.atWarning().withCause(e).log( + "unable to finish processing (task=%s(%s))", taskKind, taskName); throw new UncheckedExecutionException(e); } catch (TimeoutException e) { workerFuture.cancel(true); @@ -451,15 +575,32 @@ } private void send(StringBuilder s) { - if (write) { + if (!clientDisconnected) { try { out.write(Constants.encode(s.toString())); out.flush(); } catch (IOException e) { logger.atWarning().withCause(e).log( - "Sending progress to client failed. Stop sending updates for task %s", taskName); - write = false; + "Sending progress to client failed. Stop sending updates for task %s(%s)", + taskKind, taskName); + clientDisconnected = true; } } } + + @Override + public void checkIfCancelled(OnCancelled onCancelled) { + if (clientDisconnected) { + onCancelled.onCancel(RequestStateProvider.Reason.CLIENT_CLOSED_REQUEST, /* message= */ null); + } else if (deadlineExceeded) { + onCancelled.onCancel( + RequestStateProvider.Reason.SERVER_DEADLINE_EXCEEDED, + timeout + .map( + taskKind == TaskKind.RECEIVE_COMMITS + ? getTimeoutFormatter("receive.timeout") + : getTimeoutFormatter("timeout")) + .orElse(null)); + } + } }
diff --git a/java/com/google/gerrit/server/git/PermissionAwareReadOnlyRefDatabase.java b/java/com/google/gerrit/server/git/PermissionAwareReadOnlyRefDatabase.java index 7950dc6..f66a089 100644 --- a/java/com/google/gerrit/server/git/PermissionAwareReadOnlyRefDatabase.java +++ b/java/com/google/gerrit/server/git/PermissionAwareReadOnlyRefDatabase.java
@@ -23,6 +23,7 @@ import com.google.gerrit.server.permissions.PermissionBackend.RefFilterOptions; import com.google.gerrit.server.permissions.PermissionBackendException; import java.io.IOException; +import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.HashMap; @@ -32,8 +33,10 @@ import java.util.Set; import java.util.function.Function; import java.util.stream.Collectors; +import java.util.stream.Stream; import org.eclipse.jgit.annotations.NonNull; import org.eclipse.jgit.annotations.Nullable; +import org.eclipse.jgit.lib.BatchRefUpdate; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Ref; import org.eclipse.jgit.lib.RefRename; @@ -60,6 +63,11 @@ } @Override + public Collection<String> getConflictingNames(String name) throws IOException { + throw new UnsupportedOperationException("PermissionAwareReadOnlyRefDatabase is read-only"); + } + + @Override public RefUpdate newUpdate(String name, boolean detach) { throw new UnsupportedOperationException("PermissionAwareReadOnlyRefDatabase is read-only"); } @@ -70,6 +78,11 @@ } @Override + public BatchRefUpdate newBatchUpdate() { + throw new UnsupportedOperationException("PermissionAwareReadOnlyRefDatabase is read-only"); + } + + @Override public Ref exactRef(String name) throws IOException { Ref ref = getDelegate().getRefDatabase().exactRef(name); if (ref == null) { @@ -130,6 +143,25 @@ } @Override + public List<Ref> getRefsByPrefixWithExclusions(String include, Set<String> excludes) + throws IOException { + Stream<Ref> refs = getRefs(include).values().stream(); + for (String exclude : excludes) { + refs = refs.filter(r -> !r.getName().startsWith(exclude)); + } + return Collections.unmodifiableList(refs.collect(Collectors.toList())); + } + + @Override + public List<Ref> getRefsByPrefix(String... prefixes) throws IOException { + List<Ref> result = new ArrayList<>(); + for (String prefix : prefixes) { + result.addAll(getRefsByPrefix(prefix)); + } + return Collections.unmodifiableList(result); + } + + @Override @NonNull public Map<String, Ref> exactRef(String... refs) throws IOException { Map<String, Ref> result = new HashMap<>(refs.length); @@ -155,6 +187,11 @@ } @Override + public List<Ref> getRefs() throws IOException { + return getRefsByPrefix(ALL); + } + + @Override @NonNull public Set<Ref> getTipsWithSha1(ObjectId id) throws IOException { Set<Ref> unfiltered = super.getTipsWithSha1(id); @@ -166,4 +203,9 @@ } return result; } + + @Override + public boolean hasRefs() throws IOException { + return !getRefs().isEmpty(); + } }
diff --git a/java/com/google/gerrit/server/git/RepoRefCache.java b/java/com/google/gerrit/server/git/RepoRefCache.java index 7a61e67..d2b3c32 100644 --- a/java/com/google/gerrit/server/git/RepoRefCache.java +++ b/java/com/google/gerrit/server/git/RepoRefCache.java
@@ -49,7 +49,7 @@ return id; } - /** @return an unmodifiable view of the refs that have been cached by this instance. */ + /** Returns an unmodifiable view of the refs that have been cached by this instance. */ public Map<String, Optional<ObjectId>> getCachedRefs() { return Collections.unmodifiableMap(ids); }
diff --git a/java/com/google/gerrit/server/git/RepositoryCaseMismatchException.java b/java/com/google/gerrit/server/git/RepositoryCaseMismatchException.java index 8535cd2..9e10c67 100644 --- a/java/com/google/gerrit/server/git/RepositoryCaseMismatchException.java +++ b/java/com/google/gerrit/server/git/RepositoryCaseMismatchException.java
@@ -15,7 +15,6 @@ package com.google.gerrit.server.git; import com.google.gerrit.entities.Project; -import org.eclipse.jgit.errors.RepositoryNotFoundException; /** * This exception is thrown if a project cannot be created because a project with the same name in a @@ -23,12 +22,12 @@ * (e.g. Windows), because in this case the name for the git repository in the file system is * already occupied by the existing project. */ -public class RepositoryCaseMismatchException extends RepositoryNotFoundException { +public class RepositoryCaseMismatchException extends RepositoryExistsException { private static final long serialVersionUID = 1L; /** @param projectName name of the project that cannot be created */ public RepositoryCaseMismatchException(Project.NameKey projectName) { - super("Name occupied in other case. Project " + projectName.get() + " cannot be created."); + super(projectName, "Name occupied in other case."); } }
diff --git a/java/com/google/gerrit/server/git/RepositoryExistsException.java b/java/com/google/gerrit/server/git/RepositoryExistsException.java new file mode 100644 index 0000000..563b078 --- /dev/null +++ b/java/com/google/gerrit/server/git/RepositoryExistsException.java
@@ -0,0 +1,37 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.git; + +import com.google.gerrit.entities.Project; +import java.io.IOException; + +/** Thrown when trying to create a repository that exist. */ +public class RepositoryExistsException extends IOException { + private static final long serialVersionUID = 1L; + + /** + * @param projectName name of the project that cannot be created + * @param reason reason why the project cannot be created + */ + public RepositoryExistsException(Project.NameKey projectName, String reason) { + super( + String.format("Repository %s exists and cannot be created. %s", projectName.get(), reason)); + } + + /** @param projectName name of the project that cannot be created */ + public RepositoryExistsException(Project.NameKey projectName) { + super(String.format("Repository %s exists and cannot be created.", projectName.get())); + } +}
diff --git a/java/com/google/gerrit/server/git/SearchingChangeCacheImpl.java b/java/com/google/gerrit/server/git/SearchingChangeCacheImpl.java index fed6541..b7731bf 100644 --- a/java/com/google/gerrit/server/git/SearchingChangeCacheImpl.java +++ b/java/com/google/gerrit/server/git/SearchingChangeCacheImpl.java
@@ -40,11 +40,12 @@ import com.google.inject.Singleton; import com.google.inject.TypeLiteral; import com.google.inject.name.Named; -import com.google.inject.util.Providers; import java.util.ArrayList; +import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.concurrent.ExecutionException; +import org.eclipse.jgit.lib.Repository; /** * Cache based on an index query of the most recent changes. The number of cached items depends on @@ -54,35 +55,22 @@ * fraction of all changes. These are the changes that were modified last. */ @Singleton -public class SearchingChangeCacheImpl implements GitReferenceUpdatedListener { +public class SearchingChangeCacheImpl + implements ChangesByProjectCache, GitReferenceUpdatedListener { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); static final String ID_CACHE = "changes"; - public static class Module extends CacheModule { - private final boolean slave; - - public Module() { - this(false); - } - - public Module(boolean slave) { - this.slave = slave; - } - + public static class SearchingChangeCacheImplModule extends CacheModule { @Override protected void configure() { - if (slave) { - bind(SearchingChangeCacheImpl.class).toProvider(Providers.of(null)); - } else { - cache(ID_CACHE, Project.NameKey.class, new TypeLiteral<List<CachedChange>>() {}) - .maximumWeight(0) - .loader(Loader.class); + cache(ID_CACHE, Project.NameKey.class, new TypeLiteral<List<CachedChange>>() {}) + .maximumWeight(0) + .loader(Loader.class); - bind(SearchingChangeCacheImpl.class); - DynamicSet.bind(binder(), GitReferenceUpdatedListener.class) - .to(SearchingChangeCacheImpl.class); - } + bind(ChangesByProjectCache.class).to(SearchingChangeCacheImpl.class); + DynamicSet.bind(binder(), GitReferenceUpdatedListener.class) + .to(SearchingChangeCacheImpl.class); } } @@ -116,9 +104,11 @@ * Additional stored fields are not loaded from the index. * * @param project project to read. - * @return list of known changes; empty if no changes. + * @param repo repository for the project to read. + * @return Collection of known changes; empty if no changes. */ - public List<ChangeData> getChangeData(Project.NameKey project) { + @Override + public Collection<ChangeData> getChangeDatas(Project.NameKey project, Repository unusedrepo) { try { List<CachedChange> cached = cache.get(project); List<ChangeData> cds = new ArrayList<>(cached.size());
diff --git a/java/com/google/gerrit/server/git/TagSet.java b/java/com/google/gerrit/server/git/TagSet.java index d6220a2..57fcf71 100644 --- a/java/com/google/gerrit/server/git/TagSet.java +++ b/java/com/google/gerrit/server/git/TagSet.java
@@ -43,6 +43,17 @@ import org.eclipse.jgit.revwalk.RevSort; import org.eclipse.jgit.revwalk.RevWalk; +/** + * Builds a set of tags, and tracks which tags are reachable from which non-tag, non-special refs. + * An instance is constructed from a snapshot of the ref database. TagSets can be incrementally + * updated to newer states of the RefDatabase using the refresh method. The updateFastForward method + * can do partial updates based on individual refs moving forward. + * + * <p>This set is used to determine which tags should be advertised when only a subset of refs is + * visible to a user. + * + * <p>TagSets can be serialized for use in a persisted TagCache + */ class TagSet { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); private static final ImmutableSet<String> SKIPPABLE_REF_PREFIXES = @@ -53,7 +64,14 @@ RefNames.REFS_STARRED_CHANGES); private final Project.NameKey projectName; + + /** + * refName => ref. CachedRef is a ref that has an integer identity, used for indexing into + * BitSets. + */ private final Map<String, CachedRef> refs; + + /** ObjectId-pointed-to-by-tag => Tag */ private final ObjectIdOwnerMap<Tag> tags; TagSet(Project.NameKey projectName) { @@ -86,13 +104,16 @@ return tags; } + /** Record a fast-forward update of the given ref. This is called from multiple threads. */ boolean updateFastForward(String refName, ObjectId oldValue, ObjectId newValue) { + // this looks fishy: refs is not a thread-safe data structure, but it is mutated in build() and + // rebuild(). TagSetHolder prohibits concurrent writes through the buildLock mutex, but it does + // not prohibit concurrent read/write. CachedRef ref = refs.get(refName); if (ref != null) { // compareAndSet works on reference equality, but this operation // wants to use object equality. Switch out oldValue with cur so the // compareAndSet will function correctly for this operation. - // ObjectId cur = ref.get(); if (cur.equals(oldValue)) { return ref.compareAndSet(cur, newValue); @@ -391,6 +412,9 @@ } static final class Tag extends ObjectIdOwnerMap.Entry { + + // a RefCache.flag => isVisible map. This reference is aliased to the + // bitset in TagCommit.refFlags. @VisibleForTesting final BitSet refFlags; Tag(AnyObjectId id, BitSet flags) { @@ -407,11 +431,12 @@ return MoreObjects.toStringHelper(this).addValue(name()).add("refFlags", refFlags).toString(); } } - + /** A ref along with its index into BitSet. */ @VisibleForTesting static final class CachedRef extends AtomicReference<ObjectId> { private static final long serialVersionUID = 1L; + /** unique identifier for this ref within the TagSet. */ final int flag; CachedRef(Ref ref, int flag) { @@ -444,7 +469,9 @@ } } + // TODO(hanwen): this would be better named as CommitWithReachability, as it also holds non-tags. private static final class TagCommit extends RevCommit { + /** CachedRef.flag => isVisible, indicating if this commit is reachable from the ref. */ final BitSet refFlags; TagCommit(AnyObjectId id) {
diff --git a/java/com/google/gerrit/server/git/TransferConfig.java b/java/com/google/gerrit/server/git/TransferConfig.java index 55b9448..728e4ed 100644 --- a/java/com/google/gerrit/server/git/TransferConfig.java +++ b/java/com/google/gerrit/server/git/TransferConfig.java
@@ -52,7 +52,7 @@ packConfig.fromConfig(cfg); } - /** @return configured timeout, in seconds. 0 if the timeout is infinite. */ + /** Returns configured timeout, in seconds. 0 if the timeout is infinite. */ public int getTimeout() { return timeout; }
diff --git a/java/com/google/gerrit/server/git/UploadPackMetricsHook.java b/java/com/google/gerrit/server/git/UploadPackMetricsHook.java index 4afff2b..0e981f2 100644 --- a/java/com/google/gerrit/server/git/UploadPackMetricsHook.java +++ b/java/com/google/gerrit/server/git/UploadPackMetricsHook.java
@@ -38,14 +38,21 @@ private final Counter1<Operation> requestCount; private final Timer1<Operation> counting; + private final Histogram1<Operation> bitmapIndexMissesCount; + private final Counter1<Operation> noBitmapIndex; private final Timer1<Operation> compressing; + private final Timer1<Operation> negotiating; + private final Timer1<Operation> searchingForReuse; + private final Timer1<Operation> searchingForSizes; private final Timer1<Operation> writing; private final Histogram1<Operation> packBytes; @Inject UploadPackMetricsHook(MetricMaker metricMaker) { Field<Operation> operationField = - Field.ofEnum(Operation.class, "operation", Metadata.Builder::gitOperation).build(); + Field.ofEnum(Operation.class, "operation", Metadata.Builder::gitOperation) + .description("The name of the operation (CLONE, FETCH).") + .build(); requestCount = metricMaker.newCounter( "git/upload-pack/request_count", @@ -62,6 +69,22 @@ .setUnit(Units.MILLISECONDS), operationField); + bitmapIndexMissesCount = + metricMaker.newHistogram( + "git/upload-pack/bitmap_index_misses_count", + new Description("Number of bitmap index misses per request") + .setCumulative() + .setUnit("misses"), + operationField); + + noBitmapIndex = + metricMaker.newCounter( + "git/upload-pack/no_bitmap_index", + new Description("Total number of requests executed without a bitmap index") + .setRate() + .setUnit("requests"), + operationField); + compressing = metricMaker.newTimer( "git/upload-pack/phase_compressing", @@ -70,6 +93,32 @@ .setUnit(Units.MILLISECONDS), operationField); + negotiating = + metricMaker.newTimer( + "git/upload-pack/phase_negotiating", + new Description("Time spent in the negotiation phase") + .setCumulative() + .setUnit(Units.MILLISECONDS), + operationField); + + searchingForReuse = + metricMaker.newTimer( + "git/upload-pack/phase_searching_for_reuse", + new Description( + "Time spent in the 'Finding sources...' while searching for reuse phase") + .setCumulative() + .setUnit(Units.MILLISECONDS), + operationField); + + searchingForSizes = + metricMaker.newTimer( + "git/upload-pack/phase_searching_for_sizes", + new Description( + "Time spent in the 'Finding sources...' while searching for sizes phase") + .setCumulative() + .setUnit(Units.MILLISECONDS), + operationField); + writing = metricMaker.newTimer( "git/upload-pack/phase_writing", @@ -96,7 +145,16 @@ requestCount.increment(op); counting.record(op, stats.getTimeCounting(), MILLISECONDS); + long bitmapIndexMisses = stats.getBitmapIndexMisses(); + if (bitmapIndexMisses < 0) { + noBitmapIndex.increment(op); + } else { + bitmapIndexMissesCount.record(op, bitmapIndexMisses); + } compressing.record(op, stats.getTimeCompressing(), MILLISECONDS); + negotiating.record(op, stats.getTimeNegotiating(), MILLISECONDS); + searchingForReuse.record(op, stats.getTimeSearchingForReuse(), MILLISECONDS); + searchingForSizes.record(op, stats.getTimeSearchingForSizes(), MILLISECONDS); writing.record(op, stats.getTimeWriting(), MILLISECONDS); packBytes.record(op, stats.getTotalBytes()); }
diff --git a/java/com/google/gerrit/server/git/WorkQueue.java b/java/com/google/gerrit/server/git/WorkQueue.java index 4b08040..8b59474 100644 --- a/java/com/google/gerrit/server/git/WorkQueue.java +++ b/java/com/google/gerrit/server/git/WorkQueue.java
@@ -76,7 +76,7 @@ } } - public static class Module extends LifecycleModule { + public static class WorkQueueModule extends LifecycleModule { @Override protected void configure() { bind(WorkQueue.class);
diff --git a/java/com/google/gerrit/server/git/meta/MetaDataUpdate.java b/java/com/google/gerrit/server/git/meta/MetaDataUpdate.java index e90f58b..27d5da9 100644 --- a/java/com/google/gerrit/server/git/meta/MetaDataUpdate.java +++ b/java/com/google/gerrit/server/git/meta/MetaDataUpdate.java
@@ -160,7 +160,7 @@ return create(name, null); } - /** @see User#create(Project.NameKey, IdentifiedUser, BatchRefUpdate) */ + /** See {@link User#create(Project.NameKey, IdentifiedUser, BatchRefUpdate)} */ public MetaDataUpdate create(Project.NameKey name, BatchRefUpdate batch) throws RepositoryNotFoundException, IOException { Repository repo = mgr.openRepository(name); @@ -234,7 +234,7 @@ this.closeRepository = closeRepository; } - /** @return batch in which to run the update, or {@code null} for no batch. */ + /** Returns batch in which to run the update, or {@code null} for no batch. */ BatchRefUpdate getBatch() { return batch; }
diff --git a/java/com/google/gerrit/server/git/meta/VersionedMetaData.java b/java/com/google/gerrit/server/git/meta/VersionedMetaData.java index ea594dd..61bd8a8 100644 --- a/java/com/google/gerrit/server/git/meta/VersionedMetaData.java +++ b/java/com/google/gerrit/server/git/meta/VersionedMetaData.java
@@ -35,6 +35,7 @@ import java.util.ArrayList; import java.util.List; import java.util.Objects; +import java.util.Optional; import org.eclipse.jgit.dircache.DirCache; import org.eclipse.jgit.dircache.DirCacheBuilder; import org.eclipse.jgit.dircache.DirCacheEditor; @@ -99,7 +100,7 @@ protected ObjectInserter inserter; protected DirCache newTree; - /** @return name of the reference storing this configuration. */ + /** Returns name of the reference storing this configuration. */ protected abstract String getRefName(); /** Set up the metadata, parsing any state from the loaded revision. */ @@ -109,13 +110,11 @@ * Save any changes to the metadata in a commit. * * @return true if the commit should proceed, false to abort. - * @throws IOException - * @throws ConfigInvalidException */ protected abstract boolean onSave(CommitBuilder commit) throws IOException, ConfigInvalidException; - /** @return revision of the metadata that was loaded. */ + /** Returns revision of the metadata that was loaded. */ @Nullable public ObjectId getRevision() { return ObjectIds.copyOrNull(revision); @@ -129,8 +128,6 @@ * * @param projectName the name of the project * @param db repository to access. - * @throws IOException - * @throws ConfigInvalidException */ public void load(Project.NameKey projectName, Repository db) throws IOException, ConfigInvalidException { @@ -151,8 +148,6 @@ * @param projectName the name of the project * @param db repository to access. * @param id revision to load. - * @throws IOException - * @throws ConfigInvalidException */ public void load(Project.NameKey projectName, Repository db, @Nullable ObjectId id) throws IOException, ConfigInvalidException { @@ -175,8 +170,6 @@ * @param projectName the name of the project * @param walk open walk to access to access. * @param id revision to load. - * @throws IOException - * @throws ConfigInvalidException */ public void load(Project.NameKey projectName, RevWalk walk, ObjectId id) throws IOException, ConfigInvalidException { @@ -515,12 +508,12 @@ } protected Config readConfig(String fileName) throws IOException, ConfigInvalidException { - return readConfig(fileName, null); + return readConfig(fileName, Optional.empty()); } - protected Config readConfig(String fileName, Config baseConfig) + protected Config readConfig(String fileName, Optional<? extends Config> baseConfig) throws IOException, ConfigInvalidException { - Config rc = new Config(baseConfig); + Config rc = new Config(baseConfig.isPresent() ? baseConfig.get() : null); String text = readUTF8(fileName); if (!text.isEmpty()) { try {
diff --git a/java/com/google/gerrit/server/git/receive/AsyncReceiveCommits.java b/java/com/google/gerrit/server/git/receive/AsyncReceiveCommits.java index 06cc228..aa4e88e 100644 --- a/java/com/google/gerrit/server/git/receive/AsyncReceiveCommits.java +++ b/java/com/google/gerrit/server/git/receive/AsyncReceiveCommits.java
@@ -42,6 +42,7 @@ import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.config.ReceiveCommitsExecutor; import com.google.gerrit.server.git.MultiProgressMonitor; +import com.google.gerrit.server.git.MultiProgressMonitor.TaskKind; import com.google.gerrit.server.git.PermissionAwareRepositoryManager; import com.google.gerrit.server.git.ProjectRunnable; import com.google.gerrit.server.git.TransferConfig; @@ -93,7 +94,9 @@ public class AsyncReceiveCommits { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - private static final String TIMEOUT_NAME = "ReceiveCommitsOverallTimeout"; + private static final String RECEIVE_OVERALL_TIMEOUT_NAME = "ReceiveCommitsOverallTimeout"; + private static final String RECEIVE_CANCELLATION_TIMEOUT_NAME = + "ReceiveCommitsCancellationTimeout"; public interface Factory { AsyncReceiveCommits create( @@ -103,7 +106,7 @@ @Nullable MessageSender messageSender); } - public static class Module extends PrivateModule { + public static class AsyncReceiveCommitsModule extends PrivateModule { @Override public void configure() { install(new FactoryModuleBuilder().build(LazyPostReceiveHookChain.Factory.class)); @@ -118,15 +121,29 @@ @Provides @Singleton - @Named(TIMEOUT_NAME) - long getTimeoutMillis(@GerritServerConfig Config cfg) { + @Named(RECEIVE_OVERALL_TIMEOUT_NAME) + long getReceiveTimeoutMillis(@GerritServerConfig Config cfg) { return ConfigUtil.getTimeUnit( cfg, "receive", null, "timeout", TimeUnit.MINUTES.toMillis(4), TimeUnit.MILLISECONDS); } + + @Provides + @Singleton + @Named(RECEIVE_CANCELLATION_TIMEOUT_NAME) + long getCancellationTimeoutMillis(@GerritServerConfig Config cfg) { + return ConfigUtil.getTimeUnit( + cfg, + "receive", + null, + "cancellationTimeout", + TimeUnit.SECONDS.toMillis(5), + TimeUnit.MILLISECONDS); + } } - private static MultiProgressMonitor newMultiProgressMonitor(MessageSender messageSender) { - return new MultiProgressMonitor( + private static MultiProgressMonitor newMultiProgressMonitor( + MultiProgressMonitor.Factory multiProgressMonitorFactory, MessageSender messageSender) { + return multiProgressMonitorFactory.create( new OutputStream() { @Override public void write(int b) { @@ -148,6 +165,7 @@ messageSender.flush(); } }, + TaskKind.RECEIVE_COMMITS, "Processing changes"); } @@ -205,6 +223,7 @@ } } + private final MultiProgressMonitor.Factory multiProgressMonitorFactory; private final Metrics metrics; private final ReceiveCommits receiveCommits; private final PermissionBackend.ForProject perm; @@ -213,7 +232,8 @@ private final RequestScopePropagator scopePropagator; private final ReceiveConfig receiveConfig; private final ContributorAgreementsChecker contributorAgreements; - private final long timeoutMillis; + private final long receiveTimeoutMillis; + private final long cancellationTimeoutMillis; private final ProjectState projectState; private final IdentifiedUser user; private final Repository repo; @@ -221,6 +241,7 @@ @Inject AsyncReceiveCommits( + MultiProgressMonitor.Factory multiProgressMonitorFactory, ReceiveCommits.Factory factory, PermissionBackend permissionBackend, Provider<InternalChangeQuery> queryProvider, @@ -234,17 +255,20 @@ QuotaBackend quotaBackend, UsersSelfAdvertiseRefsHook usersSelfAdvertiseRefsHook, AllUsersName allUsersName, - @Named(TIMEOUT_NAME) long timeoutMillis, + @Named(RECEIVE_OVERALL_TIMEOUT_NAME) long receiveTimeoutMillis, + @Named(RECEIVE_CANCELLATION_TIMEOUT_NAME) long cancellationTimeoutMillis, @Assisted ProjectState projectState, @Assisted IdentifiedUser user, @Assisted Repository repo, @Assisted @Nullable MessageSender messageSender) throws PermissionBackendException { + this.multiProgressMonitorFactory = multiProgressMonitorFactory; this.executor = executor; this.scopePropagator = scopePropagator; this.receiveConfig = receiveConfig; this.contributorAgreements = contributorAgreements; - this.timeoutMillis = timeoutMillis; + this.receiveTimeoutMillis = receiveTimeoutMillis; + this.cancellationTimeoutMillis = cancellationTimeoutMillis; this.projectState = projectState; this.user = user; this.repo = repo; @@ -332,10 +356,6 @@ try { result = preReceive(commands); } catch (TimeoutException e) { - metrics.timeouts.increment(); - logger.atWarning().withCause(e).log( - "Timeout in ReceiveCommits while processing changes for project %s", - projectState.getName()); receivePack.sendError("timeout while processing changes"); rejectCommandsNotAttempted(commands); return; @@ -362,7 +382,8 @@ return ReceiveCommitsResult.empty(); } String currentThreadName = Thread.currentThread().getName(); - MultiProgressMonitor monitor = newMultiProgressMonitor(receiveCommits.getMessageSender()); + MultiProgressMonitor monitor = + newMultiProgressMonitor(multiProgressMonitorFactory, receiveCommits.getMessageSender()); Callable<ReceiveCommitsResult> callable = () -> { String oldName = Thread.currentThread().getName(); @@ -380,12 +401,22 @@ ProjectRunnable.fromCallable( callable, receiveCommits.getProject().getNameKey(), "receive-commits", null, false); monitor.waitFor( - executor.submit(scopePropagator.wrap(runnable)), timeoutMillis, TimeUnit.MILLISECONDS); + executor.submit(scopePropagator.wrap(runnable)), + receiveTimeoutMillis, + TimeUnit.MILLISECONDS, + cancellationTimeoutMillis, + TimeUnit.MILLISECONDS); if (!runnable.isDone()) { // At this point we are either done or have thrown a TimeoutException and bailed out. throw new IllegalStateException("unable to get receive commits result"); } return runnable.get(); + } catch (TimeoutException e) { + metrics.timeouts.increment(); + logger.atWarning().withCause(e).log( + "Timeout in ReceiveCommits while processing changes for project %s", + projectState.getName()); + throw e; } catch (InterruptedException | ExecutionException e) { throw new UncheckedExecutionException(e); }
diff --git a/java/com/google/gerrit/server/git/receive/BUILD b/java/com/google/gerrit/server/git/receive/BUILD index b59d431..5c1cf52 100644 --- a/java/com/google/gerrit/server/git/receive/BUILD +++ b/java/com/google/gerrit/server/git/receive/BUILD
@@ -18,6 +18,7 @@ "//java/com/google/gerrit/index", "//java/com/google/gerrit/metrics", "//java/com/google/gerrit/server", + "//java/com/google/gerrit/server/cancellation", "//java/com/google/gerrit/server/logging", "//java/com/google/gerrit/server/restapi", "//java/com/google/gerrit/server/util/time",
diff --git a/java/com/google/gerrit/server/git/receive/HackPushNegotiateHook.java b/java/com/google/gerrit/server/git/receive/HackPushNegotiateHook.java index 72483af..12666f9 100644 --- a/java/com/google/gerrit/server/git/receive/HackPushNegotiateHook.java +++ b/java/com/google/gerrit/server/git/receive/HackPushNegotiateHook.java
@@ -80,13 +80,13 @@ r = rp.getRepository().getRefDatabase().getRefs().stream() .collect(toMap(Ref::getName, x -> x)); + rp.setAdvertisedRefs(r, history(r.values(), rp)); } catch (ServiceMayNotContinueException e) { throw e; } catch (IOException e) { throw new ServiceMayNotContinueException(e); } } - rp.setAdvertisedRefs(r, history(r.values(), rp)); } private Set<ObjectId> history(Collection<Ref> refs, ReceivePack rp) {
diff --git a/java/com/google/gerrit/server/git/receive/ReceiveCommits.java b/java/com/google/gerrit/server/git/receive/ReceiveCommits.java index e61c938..951eb55 100644 --- a/java/com/google/gerrit/server/git/receive/ReceiveCommits.java +++ b/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
@@ -46,6 +46,7 @@ import com.google.common.base.Joiner; import com.google.common.base.Splitter; import com.google.common.base.Strings; +import com.google.common.base.Throwables; import com.google.common.collect.BiMap; import com.google.common.collect.HashBiMap; import com.google.common.collect.ImmutableList; @@ -100,17 +101,28 @@ import com.google.gerrit.extensions.validators.CommentValidationContext; import com.google.gerrit.extensions.validators.CommentValidationFailure; import com.google.gerrit.extensions.validators.CommentValidator; -import com.google.gerrit.server.ApprovalsUtil; +import com.google.gerrit.metrics.Counter0; +import com.google.gerrit.metrics.Counter3; +import com.google.gerrit.metrics.Description; +import com.google.gerrit.metrics.Field; +import com.google.gerrit.metrics.MetricMaker; +import com.google.gerrit.server.CancellationMetrics; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.CommentsUtil; import com.google.gerrit.server.CreateGroupPermissionSyncer; +import com.google.gerrit.server.DeadlineChecker; import com.google.gerrit.server.IdentifiedUser; +import com.google.gerrit.server.InvalidDeadlineException; import com.google.gerrit.server.PatchSetUtil; import com.google.gerrit.server.PublishCommentUtil; import com.google.gerrit.server.PublishCommentsOp; import com.google.gerrit.server.RequestInfo; import com.google.gerrit.server.RequestListener; import com.google.gerrit.server.account.AccountResolver; +import com.google.gerrit.server.approval.ApprovalsUtil; +import com.google.gerrit.server.cancellation.RequestCancelledException; +import com.google.gerrit.server.cancellation.RequestStateContext; +import com.google.gerrit.server.change.AttentionSetUnchangedOp; import com.google.gerrit.server.change.ChangeInserter; import com.google.gerrit.server.change.NotifyResolver; import com.google.gerrit.server.change.SetHashtagsOp; @@ -172,7 +184,7 @@ import com.google.gerrit.server.update.BatchUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RepoContext; import com.google.gerrit.server.update.RepoOnlyOp; import com.google.gerrit.server.update.RetryHelper; @@ -187,6 +199,7 @@ import com.google.gerrit.util.cli.CmdLineParser; import com.google.inject.Inject; import com.google.inject.Provider; +import com.google.inject.Singleton; import com.google.inject.assistedinject.Assisted; import com.google.inject.util.Providers; import java.io.IOException; @@ -309,6 +322,37 @@ return RestApiException.wrap("Error inserting change/patchset", e); } + @Singleton + private static class Metrics { + private final Counter0 psRevisionMissing; + private final Counter3<String, String, String> pushCount; + + @Inject + Metrics(MetricMaker metricMaker) { + psRevisionMissing = + metricMaker.newCounter( + "receivecommits/ps_revision_missing", + new Description("errors due to patch set revision missing")); + pushCount = + metricMaker.newCounter( + "receivecommits/push_count", + new Description("number of pushes"), + Field.ofString("kind", (metadataBuilder, fieldValue) -> {}) + .description("The push kind (direct vs. magic).") + .build(), + Field.ofString( + "project", + (metadataBuilder, fieldValue) -> metadataBuilder.projectName(fieldValue)) + .description("The name of the project for which the push is done.") + .build(), + Field.ofString("type", (metadataBuilder, fieldValue) -> {}) + .description( + "The type of the update (CREATE, UPDATE, CREATE/UPDATE," + + " UPDATE_NONFASTFORWARD, DELETE).") + .build()); + } + } + // ReceiveCommits has a lot of fields, sorry. Here and in the constructor they are split up // somewhat, and kept sorted lexicographically within sections, except where later assignments // depend on previous ones. @@ -317,6 +361,7 @@ private final AccountResolver accountResolver; private final AllProjectsName allProjectsName; private final BatchUpdate.Factory batchUpdateFactory; + private final CancellationMetrics cancellationMetrics; private final ChangeEditUtil editUtil; private final ChangeIndexer indexer; private final ChangeInserter.Factory changeInserterFactory; @@ -329,10 +374,12 @@ private final Config config; private final CreateGroupPermissionSyncer createGroupPermissionSyncer; private final CreateRefControl createRefControl; + private final DeadlineChecker.Factory deadlineCheckerFactory; private final DynamicMap<ProjectConfigEntry> pluginConfigEntries; private final DynamicSet<PluginPushOption> pluginPushOptions; private final PluginSetContext<ReceivePackInitializer> initializers; private final MergedByPushOp.Factory mergedByPushOpFactory; + private final Metrics metrics; private final PatchSetInfoFactory patchSetInfoFactory; private final PatchSetUtil psUtil; private final DynamicSet<PerformanceLogger> performanceLoggers; @@ -401,6 +448,7 @@ AccountResolver accountResolver, AllProjectsName allProjectsName, BatchUpdate.Factory batchUpdateFactory, + CancellationMetrics cancellationMetrics, ProjectConfig.Factory projectConfigFactory, @GerritServerConfig Config config, ChangeEditUtil editUtil, @@ -413,11 +461,13 @@ BranchCommitValidator.Factory commitValidatorFactory, CreateGroupPermissionSyncer createGroupPermissionSyncer, CreateRefControl createRefControl, + DeadlineChecker.Factory deadlineCheckerFactory, DynamicMap<ProjectConfigEntry> pluginConfigEntries, DynamicSet<PluginPushOption> pluginPushOptions, PluginSetContext<ReceivePackInitializer> initializers, PluginSetContext<CommentValidator> commentValidators, MergedByPushOp.Factory mergedByPushOpFactory, + Metrics metrics, PatchSetInfoFactory patchSetInfoFactory, PatchSetUtil psUtil, DynamicSet<PerformanceLogger> performanceLoggers, @@ -454,6 +504,7 @@ this.accountResolver = accountResolver; this.allProjectsName = allProjectsName; this.batchUpdateFactory = batchUpdateFactory; + this.cancellationMetrics = cancellationMetrics; this.changeFormatter = changeFormatterProvider.get(); this.changeInserterFactory = changeInserterFactory; this.commentsUtil = commentsUtil; @@ -462,6 +513,7 @@ this.config = config; this.createRefControl = createRefControl; this.createGroupPermissionSyncer = createGroupPermissionSyncer; + this.deadlineCheckerFactory = deadlineCheckerFactory; this.editUtil = editUtil; this.hashtagsFactory = hashtagsFactory; this.setTopicFactory = setTopicFactory; @@ -472,6 +524,7 @@ this.notesFactory = notesFactory; this.optionParserFactory = optionParserFactory; this.ormProvider = ormProvider; + this.metrics = metrics; this.patchSetInfoFactory = patchSetInfoFactory; this.permissionBackend = permissionBackend; this.pluginConfigEntries = pluginConfigEntries; @@ -594,17 +647,20 @@ ReceiveCommitsResult processCommands( Collection<ReceiveCommand> commands, MultiProgressMonitor progress) throws StorageException { checkState(!used, "Tried to re-use a ReceiveCommits objects that is single-use only"); + long start = TimeUtil.nowNanos(); parsePushOptions(); + String clientProvidedDeadlineValue = + Iterables.getLast(pushOptions.get("deadline"), /* defaultValue= */ null); int commandCount = commands.size(); try (TraceContext traceContext = TraceContext.newTrace( tracePushOption.isPresent(), tracePushOption.orElse(null), (tagName, traceId) -> addMessage(tagName + ": " + traceId)); - TraceTimer traceTimer = - newTimer("processCommands", Metadata.builder().resourceCount(commandCount)); PerformanceLogContext performanceLogContext = - new PerformanceLogContext(config, performanceLoggers)) { + new PerformanceLogContext(config, performanceLoggers); + TraceTimer traceTimer = + newTimer("processCommands", Metadata.builder().resourceCount(commandCount))) { RequestInfo requestInfo = RequestInfo.builder(RequestInfo.RequestType.GIT_RECEIVE, user, traceContext) .project(project.getNameKey()) @@ -619,8 +675,33 @@ Task commandProgress = progress.beginSubTask("refs", UNKNOWN); commands = commands.stream().map(c -> wrapReceiveCommand(c, commandProgress)).collect(toList()); - processCommandsUnsafe(commands, progress); - rejectRemaining(commands, INTERNAL_SERVER_ERROR); + + try (RequestStateContext requestStateContext = + RequestStateContext.open() + .addRequestStateProvider(progress) + .addRequestStateProvider( + deadlineCheckerFactory.create(start, requestInfo, clientProvidedDeadlineValue))) { + processCommandsUnsafe(commands, progress); + rejectRemaining(commands, INTERNAL_SERVER_ERROR); + } catch (InvalidDeadlineException e) { + rejectRemaining(commands, e.getMessage()); + } catch (RuntimeException e) { + Optional<RequestCancelledException> requestCancelledException = + RequestCancelledException.getFromCausalChain(e); + if (!requestCancelledException.isPresent()) { + Throwables.throwIfUnchecked(e); + } + cancellationMetrics.countCancelledRequest( + requestInfo, requestCancelledException.get().getCancellationReason()); + StringBuilder msg = + new StringBuilder(requestCancelledException.get().formatCancellationReason()); + if (requestCancelledException.get().getCancellationMessage().isPresent()) { + msg.append( + String.format( + " (%s)", requestCancelledException.get().getCancellationMessage().get())); + } + rejectRemaining(commands, msg.toString()); + } // This sends error messages before the 'done' string of the progress monitor is sent. // Currently, the test framework relies on this ordering to understand if pushes completed @@ -628,17 +709,19 @@ sendErrorMessages(); commandProgress.end(); - progress.end(); loggingTags = traceContext.getTags(); logger.atFine().log("Processing commands done."); } + progress.end(); return result.build(); } // Process as many commands as possible, but may leave some commands in state NOT_ATTEMPTED. private void processCommandsUnsafe( Collection<ReceiveCommand> commands, MultiProgressMonitor progress) { - logger.atFine().log("Calling user: %s", user.getLoggableName()); + logger.atFine().log("Calling user: %s, commands: %d", user.getLoggableName(), commands.size()); + + // If the list of groups is large, the log entry may get dropped, so separate out. logger.atFine().log("Groups: %s", lazy(() -> user.getEffectiveGroups().getKnownGroups())); if (!projectState.getProject().getState().permitsWrite()) { @@ -648,8 +731,6 @@ return; } - logger.atFine().log("Parsing %d commands", commands.size()); - List<ReceiveCommand> magicCommands = new ArrayList<>(); List<ReceiveCommand> regularCommands = new ArrayList<>(); @@ -666,6 +747,13 @@ return; } + if (!magicCommands.isEmpty()) { + metrics.pushCount.increment("magic", project.getName(), getUpdateType(magicCommands)); + } + if (!regularCommands.isEmpty()) { + metrics.pushCount.increment("direct", project.getName(), getUpdateType(regularCommands)); + } + try { if (!regularCommands.isEmpty()) { handleRegularCommands(regularCommands, progress); @@ -716,6 +804,15 @@ lazy(() -> commands.stream().map(ReceiveCommits::commandToString).collect(joining(",")))); } + private String getUpdateType(List<ReceiveCommand> commands) { + return commands.stream() + .map(ReceiveCommand::getType) + .map(ReceiveCommand.Type::name) + .distinct() + .sorted() + .collect(joining("/")); + } + private void sendErrorMessages() { if (!errors.isEmpty()) { logger.atFine().log("Handling error conditions: %s", errors.keySet()); @@ -921,91 +1018,30 @@ Strings.nullToEmpty(magicBranchCmd.getMessage())); return; } - - try (BatchUpdate bu = - batchUpdateFactory.create( - project.getNameKey(), user.materializedCopy(), TimeUtil.nowTs()); - ObjectInserter ins = repo.newObjectInserter(); - ObjectReader reader = ins.newReader(); - RevWalk rw = new RevWalk(reader)) { - bu.setRepository(repo, rw, ins); - bu.setRefLogMessage("push"); - if (magicBranch != null) { - bu.setNotify(magicBranch.getNotifyForNewChange()); + try { + if (!newChanges.isEmpty()) { + // TODO: Retry lock failures on new change insertions. The retry will + // likely have to move to a higher layer to be able to achieve that + // due to state that needs to be reset with each retry attempt. + insertChangesAndPatchSets(magicBranchCmd, newChanges, replaceProgress); + } else { + retryHelper + .changeUpdate( + "insertPatchSets", + updateFactory -> { + insertChangesAndPatchSets(magicBranchCmd, newChanges, replaceProgress); + return null; + }) + .defaultTimeoutMultiplier(5) + .call(); } - - logger.atFine().log("Adding %d replace requests", newChanges.size()); - for (ReplaceRequest replace : replaceByChange.values()) { - replace.addOps(bu, replaceProgress); - if (magicBranch != null) { - bu.setNotifyHandling(replace.ontoChange, magicBranch.getNotifyHandling(replace.notes)); - if (magicBranch.shouldPublishComments()) { - bu.addOp( - replace.notes.getChangeId(), - publishCommentsOp.create(replace.psId, project.getNameKey())); - Optional<ChangeNotes> changeNotes = getChangeNotes(replace.notes.getChangeId()); - if (!changeNotes.isPresent()) { - // If not present, no need to update attention set here since this is a new change. - continue; - } - List<HumanComment> drafts = - commentsUtil.draftByChangeAuthor(changeNotes.get(), user.getAccountId()); - if (drafts.isEmpty()) { - // If no comments, attention set shouldn't update since the user didn't reply. - continue; - } - replyAttentionSetUpdates.processAutomaticAttentionSetRulesOnReply( - bu, changeNotes.get(), isReadyForReview(changeNotes.get()), user, drafts); - } - } - } - - logger.atFine().log("Adding %d create requests", newChanges.size()); - for (CreateRequest create : newChanges) { - create.addOps(bu); - } - - logger.atFine().log("Adding %d group update requests", newChanges.size()); - updateGroups.forEach(r -> r.addOps(bu)); - - logger.atFine().log("Executing batch"); - try { - bu.execute(); - } catch (UpdateException e) { - throw asRestApiException(e); - } - - replaceByChange.values().stream() - .forEach( - req -> - result.addChange(ReceiveCommitsResult.ChangeStatus.REPLACED, req.ontoChange)); - newChanges.stream() - .forEach( - req -> result.addChange(ReceiveCommitsResult.ChangeStatus.CREATED, req.changeId)); - - if (magicBranchCmd != null) { - magicBranchCmd.setResult(OK); - } - for (ReplaceRequest replace : replaceByChange.values()) { - String rejectMessage = replace.getRejectMessage(); - if (rejectMessage == null) { - if (replace.inputCommand.getResult() == NOT_ATTEMPTED) { - // Not necessarily the magic branch, so need to set OK on the original value. - replace.inputCommand.setResult(OK); - } - } else { - logger.atFine().log("Rejecting due to message from ReplaceOp"); - reject(replace.inputCommand, rejectMessage); - } - } - } catch (ResourceConflictException e) { addError(e.getMessage()); reject(magicBranchCmd, "conflict"); } catch (BadRequestException | UnprocessableEntityException | AuthException e) { logger.atFine().withCause(e).log("Rejecting due to client error"); reject(magicBranchCmd, e.getMessage()); - } catch (RestApiException | IOException e) { + } catch (RestApiException | IOException | UpdateException e) { throw new StorageException("Can't insert change/patch set for " + project.getName(), e); } @@ -1028,6 +1064,87 @@ } } + private void insertChangesAndPatchSets( + ReceiveCommand magicBranchCmd, List<CreateRequest> newChanges, Task replaceProgress) + throws RestApiException, IOException { + try (BatchUpdate bu = + batchUpdateFactory.create( + project.getNameKey(), user.materializedCopy(), TimeUtil.nowTs()); + ObjectInserter ins = repo.newObjectInserter(); + ObjectReader reader = ins.newReader(); + RevWalk rw = new RevWalk(reader)) { + bu.setRepository(repo, rw, ins); + bu.setRefLogMessage("push"); + if (magicBranch != null) { + bu.setNotify(magicBranch.getNotifyForNewChange()); + } + + logger.atFine().log("Adding %d replace requests", newChanges.size()); + for (ReplaceRequest replace : replaceByChange.values()) { + replace.addOps(bu, replaceProgress); + if (magicBranch != null) { + bu.setNotifyHandling(replace.ontoChange, magicBranch.getNotifyHandling(replace.notes)); + if (magicBranch.shouldPublishComments()) { + bu.addOp( + replace.notes.getChangeId(), + publishCommentsOp.create(replace.psId, project.getNameKey())); + Optional<ChangeNotes> changeNotes = getChangeNotes(replace.notes.getChangeId()); + if (!changeNotes.isPresent()) { + // If not present, no need to update attention set here since this is a new change. + continue; + } + List<HumanComment> drafts = + commentsUtil.draftByChangeAuthor(changeNotes.get(), user.getAccountId()); + if (drafts.isEmpty()) { + // If no comments, attention set shouldn't update since the user didn't reply. + continue; + } + replyAttentionSetUpdates.processAutomaticAttentionSetRulesOnReply( + bu, changeNotes.get(), isReadyForReview(changeNotes.get()), user, drafts); + } + } + } + + logger.atFine().log("Adding %d create requests", newChanges.size()); + for (CreateRequest create : newChanges) { + create.addOps(bu); + } + + logger.atFine().log("Adding %d group update requests", newChanges.size()); + updateGroups.forEach(r -> r.addOps(bu)); + + logger.atFine().log("Executing batch"); + try { + bu.execute(); + } catch (UpdateException e) { + throw asRestApiException(e); + } + + replaceByChange.values().stream() + .forEach( + req -> result.addChange(ReceiveCommitsResult.ChangeStatus.REPLACED, req.ontoChange)); + newChanges.stream() + .forEach( + req -> result.addChange(ReceiveCommitsResult.ChangeStatus.CREATED, req.changeId)); + + if (magicBranchCmd != null) { + magicBranchCmd.setResult(OK); + } + for (ReplaceRequest replace : replaceByChange.values()) { + String rejectMessage = replace.getRejectMessage(); + if (rejectMessage == null) { + if (replace.inputCommand.getResult() == NOT_ATTEMPTED) { + // Not necessarily the magic branch, so need to set OK on the original value. + replace.inputCommand.setResult(OK); + } + } else { + logger.atFine().log("Rejecting due to message from ReplaceOp"); + reject(replace.inputCommand, rejectMessage); + } + } + } + } + private boolean isReadyForReview(ChangeNotes changeNotes) { return (!changeNotes.getChange().isWorkInProgress() && !magicBranch.workInProgress) || magicBranch.ready; @@ -1519,6 +1636,12 @@ @Option(name = "--trace", metaVar = "NAME", usage = "enable tracing") String trace; + @Option( + name = "--deadline", + metaVar = "NAME", + usage = "deadline after which the push should be aborted") + String deadline; + @Option(name = "--base", metaVar = "BASE", usage = "merge base of changes") List<ObjectId> base; @@ -1531,6 +1654,14 @@ @Option(name = "--remove-private", usage = "remove privacy flag from updated change") boolean removePrivate; + /** + * The skip-validation option is defined to allow parsing it using the {@link #cmdLineParser}. + * However we do not allow this option for pushes to magic branches. This option is used to fail + * with a proper error message. + */ + @Option(name = "--skip-validation", usage = "skips commit validation") + boolean skipValidation; + @Option( name = "--wip", aliases = {"-work-in-progress"}, @@ -1651,9 +1782,16 @@ } @UsedAt(UsedAt.Project.GOOGLE) + @SuppressWarnings("unused") // unused in upstream, but used at Google @Option(name = "--create-cod-token", usage = "create a token for consistency-on-demand") private boolean createCodToken; + @Option( + name = "--ignore-automatic-attention-set-rules", + aliases = {"-ias", "-ignore-attention-set"}, + usage = "do not change the attention set on this push") + boolean ignoreAttentionSet; + MagicBranchInput( IdentifiedUser user, ProjectState projectState, ReceiveCommand cmd, LabelTypes labelTypes) { this.user = user; @@ -1675,7 +1813,7 @@ * account IDs computed from the commit message itself. * * @param additionalRecipients recipients parsed from the commit. - * @return set of reviewer strings to pass to {@code ReviewerAdder}. + * @return set of reviewer strings to pass to {@code ReviewerModifier}. */ ImmutableSet<String> getCombinedReviewers(MailRecipients additionalRecipients) { return getCombinedReviewers(reviewer, additionalRecipients.getReviewers()); @@ -1689,7 +1827,7 @@ * account IDs computed from the commit message itself. * * @param additionalRecipients recipients parsed from the commit. - * @return set of CC strings to pass to {@code ReviewerAdder}. + * @return set of CC strings to pass to {@code ReviewerModifier}. */ ImmutableSet<String> getCombinedCcs(MailRecipients additionalRecipients) { return getCombinedReviewers(cc, additionalRecipients.getCcOnly()); @@ -1814,6 +1952,14 @@ ref = null; // never happens } + if (magicBranch.skipValidation) { + reject( + cmd, + String.format( + "\"--%s\" option is only supported for direct push", PUSH_OPTION_SKIP_VALIDATION)); + return; + } + if (magicBranch.topic != null && magicBranch.topic.length() > ChangeUtil.TOPIC_MAX_LENGTH) { reject( cmd, String.format("topic length exceeds the limit (%d)", ChangeUtil.TOPIC_MAX_LENGTH)); @@ -2636,6 +2782,9 @@ if (!Strings.isNullOrEmpty(magicBranch.topic)) { bu.addOp(changeId, setTopicFactory.create(magicBranch.topic)); } + if (magicBranch.ignoreAttentionSet) { + bu.addOp(changeId, new AttentionSetUnchangedOp()); + } bu.addOp( changeId, new BatchUpdateOp() { @@ -2790,8 +2939,6 @@ * </ul> * * @return whether the new commit is valid - * @throws IOException - * @throws PermissionBackendException */ boolean validateNewPatchSet() throws IOException, PermissionBackendException { try (TraceTimer traceTimer = newTimer("validateNewPatchSet")) { @@ -2836,6 +2983,7 @@ Change change = notes.getChange(); priorPatchSet = change.currentPatchSetId(); if (!revisions.containsValue(priorPatchSet)) { + metrics.psRevisionMissing.increment(); logger.atWarning().log( "Change %d is missing revision for patch set %s" + " (it has revisions for these patch sets: %s)", @@ -3143,7 +3291,7 @@ } @Override - public void postUpdate(Context ctx) { + public void postUpdate(PostUpdateContext ctx) { String refName = cmd.getRefName(); if (cmd.getType() == ReceiveCommand.Type.UPDATE) { // aka fast-forward logger.atFine().log("Updating tag cache on fast-forward of %s", cmd.getRefName());
diff --git a/java/com/google/gerrit/server/git/receive/ReceiveCommitsAdvertiseRefsHook.java b/java/com/google/gerrit/server/git/receive/ReceiveCommitsAdvertiseRefsHook.java index 6c1f097..e545c70 100644 --- a/java/com/google/gerrit/server/git/receive/ReceiveCommitsAdvertiseRefsHook.java +++ b/java/com/google/gerrit/server/git/receive/ReceiveCommitsAdvertiseRefsHook.java
@@ -27,10 +27,9 @@ import com.google.gerrit.server.git.HookUtil; import com.google.gerrit.server.index.change.ChangeField; import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.query.change.ChangePredicates; import com.google.gerrit.server.query.change.ChangeStatusPredicate; import com.google.gerrit.server.query.change.InternalChangeQuery; -import com.google.gerrit.server.query.change.OwnerPredicate; -import com.google.gerrit.server.query.change.ProjectPredicate; import com.google.gerrit.server.util.MagicBranch; import com.google.inject.Provider; import java.io.IOException; @@ -92,7 +91,11 @@ .filter(ReceiveCommitsAdvertiseRefsHook::skip) .collect(toImmutableList()) .forEach(r -> advertisedRefs.remove(r)); - rp.setAdvertisedRefs(advertisedRefs, advertiseOpenChanges(rp.getRepository())); + try { + rp.setAdvertisedRefs(advertisedRefs, advertiseOpenChanges(rp.getRepository())); + } catch (IOException e) { + throw new ServiceMayNotContinueException(e); + } } private Set<ObjectId> advertiseOpenChanges(Repository repo) @@ -116,9 +119,9 @@ .setLimit(limit) .query( Predicate.and( - new ProjectPredicate(projectName.get()), + ChangePredicates.project(projectName), ChangeStatusPredicate.open(), - new OwnerPredicate(user)))) { + ChangePredicates.owner(user)))) { PatchSet ps = cd.currentPatchSet(); if (ps != null) { // Ensure we actually observed a patch set ref pointing to this
diff --git a/java/com/google/gerrit/server/git/receive/ReplaceOp.java b/java/com/google/gerrit/server/git/receive/ReplaceOp.java index ce62d7a..a9ef70e 100644 --- a/java/com/google/gerrit/server/git/receive/ReplaceOp.java +++ b/java/com/google/gerrit/server/git/receive/ReplaceOp.java
@@ -16,7 +16,7 @@ import static com.google.common.collect.ImmutableList.toImmutableList; import static com.google.common.collect.ImmutableSet.toImmutableSet; -import static com.google.gerrit.server.change.ReviewerAdder.newAddReviewerInputFromCommitIdentity; +import static com.google.gerrit.server.change.ReviewerModifier.newReviewerInputFromCommitIdentity; import static com.google.gerrit.server.mail.MailUtil.getRecipientsFromFooters; import static com.google.gerrit.server.mail.MailUtil.getRecipientsFromReviewers; import static com.google.gerrit.server.notedb.ReviewerStateInternal.REVIEWER; @@ -30,32 +30,31 @@ import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.BranchNameKey; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.LabelType; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.PatchSetInfo; import com.google.gerrit.entities.SubmissionId; -import com.google.gerrit.extensions.api.changes.AddReviewerInput; import com.google.gerrit.extensions.api.changes.NotifyHandling; +import com.google.gerrit.extensions.api.changes.ReviewerInput; import com.google.gerrit.extensions.client.ChangeKind; import com.google.gerrit.extensions.client.ReviewerState; import com.google.gerrit.extensions.registration.DynamicItem; import com.google.gerrit.extensions.restapi.BadRequestException; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.extensions.restapi.UnprocessableEntityException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.PatchSetUtil; import com.google.gerrit.server.account.AccountResolver; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.AddReviewersOp; import com.google.gerrit.server.change.ChangeKindCache; import com.google.gerrit.server.change.NotifyResolver; -import com.google.gerrit.server.change.ReviewerAdder; -import com.google.gerrit.server.change.ReviewerAdder.InternalAddReviewerInput; -import com.google.gerrit.server.change.ReviewerAdder.ReviewerAddition; -import com.google.gerrit.server.change.ReviewerAdder.ReviewerAdditionList; +import com.google.gerrit.server.change.ReviewerModifier; +import com.google.gerrit.server.change.ReviewerModifier.InternalReviewerInput; +import com.google.gerrit.server.change.ReviewerModifier.ReviewerModification; +import com.google.gerrit.server.change.ReviewerModifier.ReviewerModificationList; import com.google.gerrit.server.config.SendEmailExecutor; import com.google.gerrit.server.config.UrlFormatter; import com.google.gerrit.server.extensions.events.CommentAdded; @@ -74,6 +73,7 @@ import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RepoContext; import com.google.gerrit.server.util.RequestScopePropagator; import com.google.gerrit.server.validators.ValidationException; @@ -130,7 +130,7 @@ private final PatchSetUtil psUtil; private final ReplacePatchSetSender.Factory replacePatchSetFactory; private final ProjectCache projectCache; - private final ReviewerAdder reviewerAdder; + private final ReviewerModifier reviewerModifier; private final Change change; private final MessageIdGenerator messageIdGenerator; private final DynamicItem<UrlFormatter> urlFormatter; @@ -154,11 +154,11 @@ private ChangeNotes notes; private PatchSet newPatchSet; private ChangeKind changeKind; - private ChangeMessage msg; + private String mailMessage; private String rejectMessage; private MergedByPushOp mergedByPushOp; private RequestScopePropagator requestScopePropagator; - private ReviewerAdditionList reviewerAdditions; + private ReviewerModificationList reviewerAdditions; private MailRecipients oldRecipients; @Inject @@ -175,7 +175,7 @@ ReplacePatchSetSender.Factory replacePatchSetFactory, ProjectCache projectCache, @SendEmailExecutor ExecutorService sendEmailExecutor, - ReviewerAdder reviewerAdder, + ReviewerModifier reviewerModifier, Change change, MessageIdGenerator messageIdGenerator, DynamicItem<UrlFormatter> urlFormatter, @@ -203,7 +203,7 @@ this.replacePatchSetFactory = replacePatchSetFactory; this.projectCache = projectCache; this.sendEmailExecutor = sendEmailExecutor; - this.reviewerAdder = reviewerAdder; + this.reviewerModifier = reviewerModifier; this.change = change; this.messageIdGenerator = messageIdGenerator; this.urlFormatter = urlFormatter; @@ -305,6 +305,9 @@ change.setWorkInProgress(true); update.setWorkInProgress(true); } + if (magicBranch.ignoreAttentionSet) { + update.ignoreFurtherAttentionSetUpdates(); + } } newPatchSet = @@ -323,12 +326,13 @@ update, projectState.getLabelTypes(), newPatchSet, ctx.getUser(), approvals); reviewerAdditions = - reviewerAdder.prepare( + reviewerModifier.prepare( ctx.getNotes(), ctx.getUser(), getReviewerInputs(magicBranch, fromFooters, ctx.getChange(), info), true); - Optional<ReviewerAddition> reviewerError = reviewerAdditions.getFailures().stream().findFirst(); + Optional<ReviewerModification> reviewerError = + reviewerAdditions.getFailures().stream().findFirst(); if (reviewerError.isPresent()) { throw new UnprocessableEntityException(reviewerError.get().result.error); } @@ -341,9 +345,11 @@ update.putReviewer(ctx.getAccountId(), REVIEWER); } - msg = createChangeMessage(ctx, reviewMessage); - cmUtil.addChangeMessage(update, msg); + // Approvals that are being set in the new patch-set during this operation are not available yet + // outside of the scope of this method. Only copied approvals are set here. + approvalsUtil.byPatchSet(ctx.getNotes(), newPatchSet).forEach(a -> update.putCopiedApproval(a)); + mailMessage = insertChangeMessage(update, ctx, reviewMessage); if (mergedByPushOp == null) { resetChange(ctx); } else { @@ -353,24 +359,24 @@ return true; } - private ImmutableList<AddReviewerInput> getReviewerInputs( + private ImmutableList<ReviewerInput> getReviewerInputs( @Nullable MagicBranchInput magicBranch, MailRecipients fromFooters, Change change, PatchSetInfo psInfo) { // Disable individual emails when adding reviewers, as all reviewers will receive the single // bulk new change email. - Stream<AddReviewerInput> inputs = + Stream<ReviewerInput> inputs = Streams.concat( Streams.stream( - newAddReviewerInputFromCommitIdentity( + newReviewerInputFromCommitIdentity( change, psInfo.getCommitId(), psInfo.getAuthor().getAccount(), NotifyHandling.NONE, newPatchSet.uploader())), Streams.stream( - newAddReviewerInputFromCommitIdentity( + newReviewerInputFromCommitIdentity( change, psInfo.getCommitId(), psInfo.getCommitter().getAccount(), @@ -381,28 +387,27 @@ Streams.concat( inputs, magicBranch.getCombinedReviewers(fromFooters).stream() - .map(r -> newAddReviewerInput(r, ReviewerState.REVIEWER)), + .map(r -> newReviewerInput(r, ReviewerState.REVIEWER)), magicBranch.getCombinedCcs(fromFooters).stream() - .map(r -> newAddReviewerInput(r, ReviewerState.CC))); + .map(r -> newReviewerInput(r, ReviewerState.CC))); } return inputs.collect(toImmutableList()); } - private static InternalAddReviewerInput newAddReviewerInput( - String reviewer, ReviewerState state) { + private static InternalReviewerInput newReviewerInput(String reviewer, ReviewerState state) { // Disable individual emails when adding reviewers, as all reviewers will receive the single // bulk new patch set email. - InternalAddReviewerInput input = - ReviewerAdder.newAddReviewerInput(reviewer, state, NotifyHandling.NONE); + InternalReviewerInput input = + ReviewerModifier.newReviewerInput(reviewer, state, NotifyHandling.NONE); // Ignore failures for reasons like the reviewer being inactive or being unable to see the // change. See discussion in ChangeInserter. - input.otherFailureBehavior = ReviewerAdder.FailureBehavior.IGNORE; + input.otherFailureBehavior = ReviewerModifier.FailureBehavior.IGNORE; return input; } - private ChangeMessage createChangeMessage(ChangeContext ctx, String reviewMessage) + private String insertChangeMessage(ChangeUpdate update, ChangeContext ctx, String reviewMessage) throws IOException { String approvalMessage = ApprovalsUtil.renderMessageWithApprovals( @@ -421,12 +426,8 @@ if (magicBranch != null && magicBranch.workInProgress) { workInProgress = true; } - return ChangeMessagesUtil.newMessage( - patchSetId, - ctx.getUser(), - ctx.getWhen(), - message.toString(), - ChangeMessagesUtil.uploadedPatchSetTag(workInProgress)); + return cmUtil.setChangeMessage( + update, message.toString(), ChangeMessagesUtil.uploadedPatchSetTag(workInProgress)); } private String changeKindMessage(ChangeKind changeKind) { @@ -467,10 +468,10 @@ continue; } - LabelType lt = projectState.getLabelTypes().byLabel(a.labelId()); - if (lt != null) { - current.put(lt.getName(), a); - } + projectState + .getLabelTypes() + .byLabel(a.labelId()) + .ifPresent(l -> current.put(l.getName(), a)); } } return current; @@ -493,7 +494,7 @@ } @Override - public void postUpdate(Context ctx) throws Exception { + public void postUpdate(PostUpdateContext ctx) throws Exception { reviewerAdditions.postUpdate(ctx); if (changeKind != ChangeKind.TRIVIAL_REBASE) { // TODO(dborowitz): Merge email templates so we only have to send one. @@ -506,7 +507,8 @@ } } NotifyResolver.Result notify = ctx.getNotify(notes.getChangeId()); - revisionCreated.fire(notes.getChange(), newPatchSet, ctx.getAccount(), ctx.getWhen(), notify); + revisionCreated.fire( + ctx.getChangeData(notes), newPatchSet, ctx.getAccount(), ctx.getWhen(), notify); try { fireApprovalsEvent(ctx); } catch (Exception e) { @@ -531,7 +533,7 @@ replacePatchSetFactory.create(projectState.getNameKey(), notes.getChangeId()); emailSender.setFrom(ctx.getAccount().account().id()); emailSender.setPatchSet(newPatchSet, info); - emailSender.setChangeMessage(msg.getMessage(), ctx.getWhen()); + emailSender.setChangeMessage(mailMessage, ctx.getWhen()); emailSender.setNotify(ctx.getNotify(notes.getChangeId())); emailSender.addReviewers( Streams.concat( @@ -560,7 +562,7 @@ } } - private void fireApprovalsEvent(Context ctx) { + private void fireApprovalsEvent(PostUpdateContext ctx) { if (approvals.isEmpty()) { return; } @@ -588,7 +590,7 @@ } } commentAdded.fire( - notes.getChange(), + ctx.getChangeData(notes), newPatchSet, ctx.getAccount(), null,
diff --git a/java/com/google/gerrit/server/git/validators/CommitValidators.java b/java/com/google/gerrit/server/git/validators/CommitValidators.java index 870667b..596efb5 100644 --- a/java/com/google/gerrit/server/git/validators/CommitValidators.java +++ b/java/com/google/gerrit/server/git/validators/CommitValidators.java
@@ -45,7 +45,6 @@ import com.google.gerrit.server.events.CommitReceivedEvent; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.git.ValidationError; -import com.google.gerrit.server.git.validators.ValidationMessage.Type; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.TraceContext; import com.google.gerrit.server.logging.TraceContext.TraceTimer; @@ -326,7 +325,7 @@ + "Hint: run\n" + " git commit --amend\n" + "and move 'Change-Id: Ixxx..' to the bottom on a separate line\n", - Type.ERROR)); + ValidationMessage.Type.ERROR)); throw new CommitValidationException(CHANGE_ID_ABOVE_FOOTER_MSG, messages); } if (projectState.is(BooleanProjectConfig.REQUIRE_CHANGE_ID)) { @@ -366,7 +365,7 @@ + "and then amend the commit:\n" + " git commit --amend --no-edit\n" + "Finally, push your changes again\n", - Type.ERROR); + ValidationMessage.Type.ERROR); } private String getCommitMessageHookInstallationHint() { @@ -881,7 +880,7 @@ throw new CommitValidationException( "invalid account configuration", errorMessages.stream() - .map(m -> new CommitValidationMessage(m, Type.ERROR)) + .map(m -> new CommitValidationMessage(m, ValidationMessage.Type.ERROR)) .collect(toList())); } } catch (IOException e) { @@ -964,7 +963,7 @@ .append(urlFormatter.getSettingsUrl("EmailAddresses").get()) .append("\n\n"); } - return new CommitValidationMessage(sb.toString(), Type.ERROR); + return new CommitValidationMessage(sb.toString(), ValidationMessage.Type.ERROR); } /** @@ -985,6 +984,6 @@ } private static void addError(String error, List<CommitValidationMessage> messages) { - messages.add(new CommitValidationMessage(error, Type.ERROR)); + messages.add(new CommitValidationMessage(error, ValidationMessage.Type.ERROR)); } }
diff --git a/java/com/google/gerrit/server/git/validators/MergeValidators.java b/java/com/google/gerrit/server/git/validators/MergeValidators.java index cbaa121..325de5b 100644 --- a/java/com/google/gerrit/server/git/validators/MergeValidators.java +++ b/java/com/google/gerrit/server/git/validators/MergeValidators.java
@@ -36,6 +36,7 @@ import com.google.gerrit.server.config.ProjectConfigEntry; import com.google.gerrit.server.git.CodeReviewCommit; import com.google.gerrit.server.git.CodeReviewCommit.CodeReviewRevWalk; +import com.google.gerrit.server.group.db.GroupConfig; import com.google.gerrit.server.permissions.GlobalPermission; import com.google.gerrit.server.permissions.PermissionBackend; import com.google.gerrit.server.permissions.PermissionBackendException; @@ -51,6 +52,7 @@ import java.util.Objects; import org.eclipse.jgit.errors.ConfigInvalidException; import org.eclipse.jgit.lib.Config; +import org.eclipse.jgit.lib.Ref; import org.eclipse.jgit.lib.Repository; /** @@ -104,7 +106,8 @@ new PluginMergeValidationListener(mergeValidationListeners), projectConfigValidatorFactory.create(), accountValidatorFactory.create(), - groupValidatorFactory.create()); + groupValidatorFactory.create(), + new DestBranchRefValidator()); for (MergeValidationListener validator : validators) { validator.onPreMerge(repo, revWalk, commit, destProject, destBranch, patchSetId, caller); @@ -198,7 +201,7 @@ throw new MergeValidationException(SET_BY_ADMIN, e); } catch (PermissionBackendException e) { logger.atWarning().withCause(e).log("Cannot check ADMINISTRATE_SERVER"); - throw new MergeValidationException("validation unavailable"); + throw new MergeValidationException("validation unavailable", e); } } else { try { @@ -210,7 +213,7 @@ throw new MergeValidationException(SET_BY_OWNER, e); } catch (PermissionBackendException e) { logger.atWarning().withCause(e).log("Cannot check WRITE_CONFIG"); - throw new MergeValidationException("validation unavailable"); + throw new MergeValidationException("validation unavailable", e); } } if (allUsersName.equals(destProject.getNameKey()) @@ -317,7 +320,7 @@ } } catch (StorageException e) { logger.atSevere().withCause(e).log("Cannot validate account update"); - throw new MergeValidationException("account validation unavailable"); + throw new MergeValidationException("account validation unavailable", e); } try { @@ -329,7 +332,7 @@ } } catch (IOException e) { logger.atSevere().withCause(e).log("Cannot validate account update"); - throw new MergeValidationException("account validation unavailable"); + throw new MergeValidationException("account validation unavailable", e); } } } @@ -341,10 +344,12 @@ } private final AllUsersName allUsersName; + private final ChangeData.Factory changeDataFactory; @Inject - public GroupMergeValidator(AllUsersName allUsersName) { + public GroupMergeValidator(AllUsersName allUsersName, ChangeData.Factory changeDataFactory) { this.allUsersName = allUsersName; + this.changeDataFactory = changeDataFactory; } @Override @@ -363,7 +368,60 @@ return; } - throw new MergeValidationException("group update not allowed"); + // Update to group files is not supported because there are no validations + // on the changes being done to these files, without which the group data + // might get corrupted. Thus don't allow merges into All-Users group refs + // which updates group files (i.e., group.config, members and subgroups). + // But it is still useful to allow users to update files apart from group + // files. For example, users can maintain task config in group refs which + // allows users to collaborate and review changes on group specific task configs. + ChangeData cd = + changeDataFactory.create(destProject.getProject().getNameKey(), patchSetId.changeId()); + try { + if (cd.currentFilePaths().contains(GroupConfig.GROUP_CONFIG_FILE) + || cd.currentFilePaths().contains(GroupConfig.MEMBERS_FILE) + || cd.currentFilePaths().contains(GroupConfig.SUBGROUPS_FILE)) { + throw new MergeValidationException( + String.format( + "update to group files (%s, %s, %s) not allowed", + GroupConfig.GROUP_CONFIG_FILE, + GroupConfig.MEMBERS_FILE, + GroupConfig.SUBGROUPS_FILE)); + } + } catch (StorageException e) { + logger.atSevere().withCause(e).log("Cannot validate group update"); + throw new MergeValidationException("group validation unavailable", e); + } + } + } + + /** + * Validator to ensure that destBranch is not a symbolic reference (an attempt to merge into a + * symbolic ref branch leads to LOCK_FAILURE exception). + */ + private static class DestBranchRefValidator implements MergeValidationListener { + @Override + public void onPreMerge( + Repository repo, + CodeReviewRevWalk revWalk, + CodeReviewCommit commit, + ProjectState destProject, + BranchNameKey destBranch, + PatchSet.Id patchSetId, + IdentifiedUser caller) + throws MergeValidationException { + try { + Ref ref = repo.exactRef(destBranch.branch()); + // Usually the target branch exists, but there is an exception for some branches (see + // {@link com.google.gerrit.server.git.receive.ReceiveCommits} for details). + // Such non-existing branches should be ignored. + if (ref != null && ref.isSymbolic()) { + throw new MergeValidationException("the target branch is a symbolic ref"); + } + } catch (IOException e) { + logger.atSevere().withCause(e).log("Cannot validate destination branch"); + throw new MergeValidationException("symref validation unavailable", e); + } } } }
diff --git a/java/com/google/gerrit/server/git/validators/OnSubmitValidationListener.java b/java/com/google/gerrit/server/git/validators/OnSubmitValidationListener.java index 432dda3..98f2aa2 100644 --- a/java/com/google/gerrit/server/git/validators/OnSubmitValidationListener.java +++ b/java/com/google/gerrit/server/git/validators/OnSubmitValidationListener.java
@@ -76,8 +76,8 @@ } /** - * @return a map from ref to commands covering all ref operations to be performed on this - * repository as part of the ongoing submit operation. + * Returns a map from ref to commands covering all ref operations to be performed on this + * repository as part of the ongoing submit operation. */ public ImmutableMap<String, ReceiveCommand> getCommands() { return commands;
diff --git a/java/com/google/gerrit/server/git/validators/ValidationMessage.java b/java/com/google/gerrit/server/git/validators/ValidationMessage.java index b5d7eb1..c743bbc 100644 --- a/java/com/google/gerrit/server/git/validators/ValidationMessage.java +++ b/java/com/google/gerrit/server/git/validators/ValidationMessage.java
@@ -68,7 +68,8 @@ } /** - * Returns {@true} if this message is an error. Used to decide if the operation should be aborted. + * Returns {@code true} if this message is an error. Used to decide if the operation should be + * aborted. */ public boolean isError() { return type == Type.FATAL || type == Type.ERROR;
diff --git a/java/com/google/gerrit/server/group/PeriodicGroupIndexer.java b/java/com/google/gerrit/server/group/PeriodicGroupIndexer.java index cae213f..72e15ee 100644 --- a/java/com/google/gerrit/server/group/PeriodicGroupIndexer.java +++ b/java/com/google/gerrit/server/group/PeriodicGroupIndexer.java
@@ -59,7 +59,7 @@ public class PeriodicGroupIndexer implements Runnable { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - public static class Module extends LifecycleModule { + public static class PeriodicGroupIndexerModule extends LifecycleModule { @Override protected void configure() { listener().to(Lifecycle.class); @@ -145,7 +145,7 @@ } groupUuids = newGroupUuids; logger.atInfo().log("Run group indexer, %s groups reindexed", reindexCounter); - } catch (Throwable t) { + } catch (Exception t) { logger.atSevere().withCause(t).log("Failed to reindex groups"); } }
diff --git a/java/com/google/gerrit/server/group/db/GroupConfig.java b/java/com/google/gerrit/server/group/db/GroupConfig.java index b2d1849b..a00d529 100644 --- a/java/com/google/gerrit/server/group/db/GroupConfig.java +++ b/java/com/google/gerrit/server/group/db/GroupConfig.java
@@ -19,7 +19,6 @@ import static java.util.Objects.requireNonNull; import static java.util.stream.Collectors.joining; -import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Splitter; import com.google.common.base.Strings; import com.google.common.collect.ImmutableSet; @@ -89,25 +88,24 @@ * doesn't have any members or subgroups. */ public class GroupConfig extends VersionedMetaData { - @VisibleForTesting public static final String GROUP_CONFIG_FILE = "group.config"; - @VisibleForTesting static final String MEMBERS_FILE = "members"; - @VisibleForTesting static final String SUBGROUPS_FILE = "subgroups"; + public static final String GROUP_CONFIG_FILE = "group.config"; + public static final String MEMBERS_FILE = "members"; + public static final String SUBGROUPS_FILE = "subgroups"; private static final Pattern LINE_SEPARATOR_PATTERN = Pattern.compile("\\R"); /** - * Creates a {@code GroupConfig} for a new group from the {@code InternalGroupCreation} blueprint. - * Further, optional properties can be specified by setting an {@code InternalGroupUpdate} via - * {@link #setGroupUpdate(InternalGroupUpdate, AuditLogFormatter)} on the returned {@code - * GroupConfig}. + * Creates a {@link GroupConfig} for a new group from the {@link InternalGroupCreation} blueprint. + * Further, optional properties can be specified by setting a {@link GroupDelta} via {@link + * #setGroupDelta(GroupDelta, AuditLogFormatter)} on the returned {@link GroupConfig}. * - * <p><strong>Note:</strong> The returned {@code GroupConfig} has to be committed via {@link + * <p><strong>Note:</strong> The returned {@link GroupConfig} has to be committed via {@link * #commit(MetaDataUpdate)} in order to create the group for real. * * @param projectName the name of the project which holds the NoteDb commits for groups * @param repository the repository which holds the NoteDb commits for groups - * @param groupCreation an {@code InternalGroupCreation} specifying all properties which are + * @param groupCreation an {@link InternalGroupCreation} specifying all properties which are * required for a new group - * @return a {@code GroupConfig} for a group creation + * @return a {@link GroupConfig} for a group creation * @throws IOException if the repository can't be accessed for some reason * @throws ConfigInvalidException if a group with the same UUID already exists but can't be read * due to an invalid format @@ -123,7 +121,7 @@ } /** - * Creates a {@code GroupConfig} for an existing group. + * Creates a {@link GroupConfig} for an existing group. * * <p>The group is automatically loaded within this method and can be accessed via {@link * #getLoadedGroup()}. @@ -131,14 +129,14 @@ * <p>It's safe to call this method for non-existing groups. In that case, {@link * #getLoadedGroup()} won't return any group. Thus, the existence of a group can be easily tested. * - * <p>The group represented by the returned {@code GroupConfig} can be updated by setting an - * {@code InternalGroupUpdate} via {@link #setGroupUpdate(InternalGroupUpdate, AuditLogFormatter)} - * and committing the {@code GroupConfig} via {@link #commit(MetaDataUpdate)}. + * <p>The group represented by the returned {@link GroupConfig} can be updated by setting an + * {@link GroupDelta} via {@link #setGroupDelta(GroupDelta, AuditLogFormatter)} and committing the + * {@link GroupConfig} via {@link #commit(MetaDataUpdate)}. * * @param projectName the name of the project which holds the NoteDb commits for groups * @param repository the repository which holds the NoteDb commits for groups * @param groupUuid the UUID of the group - * @return a {@code GroupConfig} for the group with the specified UUID + * @return a {@link GroupConfig} for the group with the specified UUID * @throws IOException if the repository can't be accessed for some reason * @throws ConfigInvalidException if the group exists but can't be read due to an invalid format */ @@ -169,7 +167,7 @@ } /** - * Creates a {@code GroupConfig} for an existing group at a specific revision of the repository. + * Creates a {@link GroupConfig} for an existing group at a specific revision of the repository. * * <p>This method behaves nearly the same as {@link #loadForGroup(Project.NameKey, Repository, * AccountGroup.UUID)}. The only difference is that {@link #loadForGroup(Project.NameKey, @@ -180,7 +178,7 @@ * @param repository the repository which holds the NoteDb commits for groups * @param groupUuid the UUID of the group * @param commitId the revision of the repository at which the group should be loaded - * @return a {@code GroupConfig} for the group with the specified UUID + * @return a {@link GroupConfig} for the group with the specified UUID * @throws IOException if the repository can't be accessed for some reason * @throws ConfigInvalidException if the group exists but can't be read due to an invalid format */ @@ -200,7 +198,7 @@ private Optional<InternalGroup> loadedGroup = Optional.empty(); private Optional<InternalGroupCreation> groupCreation = Optional.empty(); - private Optional<InternalGroupUpdate> groupUpdate = Optional.empty(); + private Optional<GroupDelta> groupDelta = Optional.empty(); private AuditLogFormatter auditLogFormatter = AuditLogFormatter.createPartiallyWorkingFallBack(); private boolean isLoaded = false; private boolean allowSaveEmptyName; @@ -213,16 +211,16 @@ /** * Returns the group loaded from NoteDb. * - * <p>If not any NoteDb commits exist for the group represented by this {@code GroupConfig}, no + * <p>If not any NoteDb commits exist for the group represented by this {@link GroupConfig}, no * group is returned. * - * <p>After {@link #commit(MetaDataUpdate)} was called on this {@code GroupConfig}, this method + * <p>After {@link #commit(MetaDataUpdate)} was called on this {@link GroupConfig}, this method * returns a group which is in line with the latest NoteDb commit for this group. So, after - * creating a {@code GroupConfig} for a new group and committing it, this method can be used to + * creating a {@link GroupConfig} for a new group and committing it, this method can be used to * retrieve a representation of the created group. The same holds for the representation of an * updated group. * - * @return the loaded group, or an empty {@code Optional} if the group doesn't exist + * @return the loaded group, or an empty {@link Optional} if the group doesn't exist */ public Optional<InternalGroup> getLoadedGroup() { checkLoaded(); @@ -232,20 +230,19 @@ /** * Specifies how the current group should be updated. * - * <p>If the group is newly created, the {@code InternalGroupUpdate} can be used to specify - * optional properties. + * <p>If the group is newly created, the {@link GroupDelta} can be used to specify optional + * properties. * * <p><strong>Note:</strong> This method doesn't perform the update. It only contains the * instructions for the update. To apply the update for real and write the result back to NoteDb, - * call {@link #commit(MetaDataUpdate)} on this {@code GroupConfig}. + * call {@link #commit(MetaDataUpdate)} on this {@link GroupConfig}. * - * @param groupUpdate an {@code InternalGroupUpdate} outlining the modifications which should be - * applied - * @param auditLogFormatter an {@code AuditLogFormatter} for formatting the commit message in a + * @param groupDelta a {@link GroupDelta} with the modifications to be applied + * @param auditLogFormatter an {@link AuditLogFormatter} for formatting the commit message in a * parsable way */ - public void setGroupUpdate(InternalGroupUpdate groupUpdate, AuditLogFormatter auditLogFormatter) { - this.groupUpdate = Optional.of(groupUpdate); + public void setGroupDelta(GroupDelta groupDelta, AuditLogFormatter auditLogFormatter) { + this.groupDelta = Optional.of(groupDelta); this.auditLogFormatter = auditLogFormatter; } @@ -304,7 +301,7 @@ @Override protected boolean onSave(CommitBuilder commit) throws IOException, ConfigInvalidException { checkLoaded(); - if (!groupCreation.isPresent() && !groupUpdate.isPresent()) { + if (!groupCreation.isPresent() && !groupDelta.isPresent()) { // Group was neither created nor changed. -> A new commit isn't necessary. return false; } @@ -318,7 +315,7 @@ // for new groups, we explicitly need to truncate the timestamp here. Timestamp commitTimestamp = TimeUtil.truncateToSecond( - groupUpdate.flatMap(InternalGroupUpdate::getUpdatedOn).orElseGet(TimeUtil::nowTs)); + groupDelta.flatMap(GroupDelta::getUpdatedOn).orElseGet(TimeUtil::nowTs)); commit.setAuthor(new PersonIdent(commit.getAuthor(), commitTimestamp)); commit.setCommitter(new PersonIdent(commit.getCommitter(), commitTimestamp)); @@ -329,7 +326,7 @@ loadedGroup = Optional.of(updatedGroup); groupCreation = Optional.empty(); - groupUpdate = Optional.empty(); + groupDelta = Optional.empty(); return true; } @@ -339,8 +336,8 @@ } private Optional<String> getNewName() { - if (groupUpdate.isPresent()) { - return groupUpdate.get().getName().map(n -> Strings.nullToEmpty(n.get())); + if (groupDelta.isPresent()) { + return groupDelta.get().getName().map(n -> Strings.nullToEmpty(n.get())); } if (groupCreation.isPresent()) { return Optional.of(Strings.nullToEmpty(groupCreation.get().getNameKey().get())); @@ -377,11 +374,10 @@ internalGroupCreation -> Arrays.stream(GroupConfigEntry.values()) .forEach(configEntry -> configEntry.initNewConfig(config, internalGroupCreation))); - groupUpdate.ifPresent( - internalGroupUpdate -> + groupDelta.ifPresent( + delta -> Arrays.stream(GroupConfigEntry.values()) - .forEach( - configEntry -> configEntry.updateConfigValue(config, internalGroupUpdate))); + .forEach(configEntry -> configEntry.updateConfigValue(config, delta))); saveConfig(GROUP_CONFIG_FILE, config); return config; } @@ -389,8 +385,8 @@ private Optional<ImmutableSet<Account.Id>> updateMembers(ImmutableSet<Account.Id> originalMembers) throws IOException { Optional<ImmutableSet<Account.Id>> updatedMembers = - groupUpdate - .map(InternalGroupUpdate::getMemberModification) + groupDelta + .map(GroupDelta::getMemberModification) .map(memberModification -> memberModification.apply(originalMembers)) .map(ImmutableSet::copyOf) .filter(members -> !originalMembers.equals(members)); @@ -403,8 +399,8 @@ private Optional<ImmutableSet<AccountGroup.UUID>> updateSubgroups( ImmutableSet<AccountGroup.UUID> originalSubgroups) throws IOException { Optional<ImmutableSet<AccountGroup.UUID>> updatedSubgroups = - groupUpdate - .map(InternalGroupUpdate::getSubgroupModification) + groupDelta + .map(GroupDelta::getSubgroupModification) .map(subgroupModification -> subgroupModification.apply(originalSubgroups)) .map(ImmutableSet::copyOf) .filter(subgroups -> !originalSubgroups.equals(subgroups));
diff --git a/java/com/google/gerrit/server/group/db/GroupConfigEntry.java b/java/com/google/gerrit/server/group/db/GroupConfigEntry.java index be56344..687e3fb 100644 --- a/java/com/google/gerrit/server/group/db/GroupConfigEntry.java +++ b/java/com/google/gerrit/server/group/db/GroupConfigEntry.java
@@ -26,8 +26,8 @@ * <p>Each property knows how to read and write its value from/to a JGit {@link Config} file. * * <p><strong>Warning:</strong> This class is a low-level API for properties of groups in NoteDb. It - * may only be used by {@link GroupConfig}. Other classes should use {@link InternalGroupUpdate} to - * modify the properties of a group. + * may only be used by {@link GroupConfig}. Other classes should use {@link GroupDelta} to modify + * the properties of a group. */ enum GroupConfigEntry { /** @@ -59,7 +59,7 @@ } @Override - void updateConfigValue(Config config, InternalGroupUpdate groupUpdate) { + void updateConfigValue(Config config, GroupDelta groupDelta) { // Updating the ID is not supported. } }, @@ -87,8 +87,8 @@ } @Override - void updateConfigValue(Config config, InternalGroupUpdate groupUpdate) { - groupUpdate + void updateConfigValue(Config config, GroupDelta groupDelta) { + groupDelta .getName() .ifPresent(name -> config.setString(SECTION_NAME, null, super.keyName, name.get())); } @@ -112,8 +112,8 @@ } @Override - void updateConfigValue(Config config, InternalGroupUpdate groupUpdate) { - groupUpdate + void updateConfigValue(Config config, GroupDelta groupDelta) { + groupDelta .getDescription() .ifPresent( description -> @@ -144,8 +144,8 @@ } @Override - void updateConfigValue(Config config, InternalGroupUpdate groupUpdate) { - groupUpdate + void updateConfigValue(Config config, GroupDelta groupDelta) { + groupDelta .getOwnerGroupUUID() .ifPresent( ownerGroupUuid -> @@ -171,8 +171,8 @@ } @Override - void updateConfigValue(Config config, InternalGroupUpdate groupUpdate) { - groupUpdate + void updateConfigValue(Config config, GroupDelta groupDelta) { + groupDelta .getVisibleToAll() .ifPresent( visibleToAll -> config.setBoolean(SECTION_NAME, null, super.keyName, visibleToAll)); @@ -217,13 +217,13 @@ /** * Updates the corresponding property of this {@code GroupConfigEntry} in the given {@code Config} - * if the {@code InternalGroupUpdate} mentions a modification. + * if the {@link GroupDelta} mentions a modification. * - * <p>This call is a no-op if the {@code InternalGroupUpdate} doesn't contain a modification for - * the property. + * <p>This call is a no-op if the {@link GroupDelta} doesn't contain a modification for the + * property. * * @param config a {@code Config} for which the property should be updated - * @param groupUpdate an {@code InternalGroupUpdate} detailing the modifications on a group + * @param groupDelta a {@link GroupDelta} detailing the modifications on a group */ - abstract void updateConfigValue(Config config, InternalGroupUpdate groupUpdate); + abstract void updateConfigValue(Config config, GroupDelta groupDelta); }
diff --git a/java/com/google/gerrit/server/group/db/InternalGroupUpdate.java b/java/com/google/gerrit/server/group/db/GroupDelta.java similarity index 70% rename from java/com/google/gerrit/server/group/db/InternalGroupUpdate.java rename to java/com/google/gerrit/server/group/db/GroupDelta.java index 5c7408c..69cb936 100644 --- a/java/com/google/gerrit/server/group/db/InternalGroupUpdate.java +++ b/java/com/google/gerrit/server/group/db/GroupDelta.java
@@ -23,14 +23,13 @@ import java.util.Set; /** - * Definition of an update to a group. + * Data holder for updates to be applied to a group. * - * <p>An {@code InternalGroupUpdate} only specifies the modifications which should be applied to a - * group. Each of the modifications and hence each call on {@link InternalGroupUpdate.Builder} is - * optional. + * <p>A {@link GroupDelta} specifies the modifications to be applied to a group. Only fields set via + * {@link GroupDelta.Builder} will be updated. */ @AutoValue -public abstract class InternalGroupUpdate { +public abstract class GroupDelta { /** Representation of a member modification as defined by {@link #apply(ImmutableSet)}. */ @FunctionalInterface @@ -99,10 +98,10 @@ * Defines the {@code Timestamp} to be used for the NoteDb commits of the update. If not * specified, the current {@code Timestamp} when creating the commit will be used. * - * <p>If this {@code InternalGroupUpdate} is passed next to an {@link InternalGroupCreation} - * during a group creation, this {@code Timestamp} is used for the NoteDb commits of the new - * group. Hence, the {@link com.google.gerrit.entities.InternalGroup#getCreatedOn() - * InternalGroup#getCreatedOn()} field will match this {@code Timestamp}. + * <p>If this {@link GroupDelta} is passed next to an {@link InternalGroupCreation} during a group + * creation, this {@code Timestamp} is used for the NoteDb commits of the new group. Hence, the + * {@link com.google.gerrit.entities.InternalGroup#getCreatedOn() InternalGroup#getCreatedOn()} + * field will match this {@code Timestamp}. * * <p><strong>Note: </strong>{@code Timestamp}s of NoteDb commits for groups are used for events * in the audit log. For this reason, specifying this field will have an effect on the resulting @@ -113,56 +112,85 @@ public abstract Builder toBuilder(); public static Builder builder() { - return new AutoValue_InternalGroupUpdate.Builder() + return new AutoValue_GroupDelta.Builder() .setMemberModification(in -> in) .setSubgroupModification(in -> in); } - /** A builder for an {@link InternalGroupUpdate}. */ + /** A builder for a {@link GroupDelta}. */ @AutoValue.Builder public abstract static class Builder { - /** @see #getName() */ + /** + * Defines the new name of the group + * + * <p>See {@link #getName}. + */ public abstract Builder setName(AccountGroup.NameKey name); - /** @see #getDescription() */ + /** + * Defines the new description of the group + * + * <p>See {@link #getDescription()}} + */ public abstract Builder setDescription(String description); - /** @see #getOwnerGroupUUID() */ + /** + * Defines the new owner of the group + * + * <p>See {@link #getOwnerGroupUUID()} + */ public abstract Builder setOwnerGroupUUID(AccountGroup.UUID ownerGroupUUID); - /** @see #getVisibleToAll() */ + /** + * Defines the new state of the 'visibleToAll' flag of the group + * + * <p>See {@link #getVisibleToAll()} + */ public abstract Builder setVisibleToAll(boolean visibleToAll); - /** @see #getMemberModification() */ + /** + * Set {@link MemberModification} for the prospective {@link GroupDelta} + * + * <p>See {@link #getMemberModification()} + */ public abstract Builder setMemberModification(MemberModification memberModification); /** * Returns the currently defined {@link MemberModification} for the prospective {@link - * InternalGroupUpdate}. + * GroupDelta}. * * <p>This modification can be tweaked further and passed to {@link - * #setMemberModification(InternalGroupUpdate.MemberModification)} in order to combine multiple - * member additions, deletions, or other modifications into one update. + * #setMemberModification(GroupDelta.MemberModification)} in order to combine multiple member + * additions, deletions, or other modifications into one update. */ public abstract MemberModification getMemberModification(); - /** @see #getSubgroupModification() */ + /** + * Set {@link SubgroupModification} for the prospective {@link GroupDelta} + * + * <p>See {@link #getSubgroupModification()} + */ public abstract Builder setSubgroupModification(SubgroupModification subgroupModification); /** * Returns the currently defined {@link SubgroupModification} for the prospective {@link - * InternalGroupUpdate}. + * GroupDelta}. * * <p>This modification can be tweaked further and passed to {@link - * #setSubgroupModification(InternalGroupUpdate.SubgroupModification)} in order to combine - * multiple subgroup additions, deletions, or other modifications into one update. + * #setSubgroupModification(GroupDelta.SubgroupModification)} in order to combine multiple + * subgroup additions, deletions, or other modifications into one update. */ public abstract SubgroupModification getSubgroupModification(); - /** @see #getUpdatedOn() */ + /** + * Defines the {@code Timestamp} to be used for the NoteDb commits of the update. If not + * specified, the current {@code Timestamp} when creating the commit will be used. + * + * <p>See {@link #getUpdatedOn()} + */ public abstract Builder setUpdatedOn(Timestamp timestamp); - public abstract InternalGroupUpdate build(); + public abstract GroupDelta build(); } }
diff --git a/java/com/google/gerrit/server/group/db/GroupNameNotes.java b/java/com/google/gerrit/server/group/db/GroupNameNotes.java index cdba81f..7c4fb16f9 100644 --- a/java/com/google/gerrit/server/group/db/GroupNameNotes.java +++ b/java/com/google/gerrit/server/group/db/GroupNameNotes.java
@@ -35,6 +35,9 @@ import com.google.gerrit.exceptions.DuplicateKeyException; import com.google.gerrit.git.ObjectIds; import com.google.gerrit.server.git.meta.VersionedMetaData; +import com.google.gerrit.server.logging.Metadata; +import com.google.gerrit.server.logging.TraceContext; +import com.google.gerrit.server.logging.TraceContext.TraceTimer; import java.io.IOException; import java.util.Collection; import java.util.Map; @@ -210,7 +213,11 @@ if (ref == null) { return ImmutableList.of(); } - try (RevWalk revWalk = new RevWalk(repository); + try (TraceTimer ignored = + TraceContext.newTimer( + "Loading all groups", + Metadata.builder().noteDbRefName(RefNames.REFS_GROUPNAMES).build()); + RevWalk revWalk = new RevWalk(repository); ObjectReader reader = revWalk.getObjectReader()) { RevCommit notesCommit = revWalk.parseCommit(ref.getObjectId()); NoteMap noteMap = NoteMap.read(reader, notesCommit);
diff --git a/java/com/google/gerrit/server/group/db/GroupsNoteDbConsistencyChecker.java b/java/com/google/gerrit/server/group/db/GroupsNoteDbConsistencyChecker.java index 01ee811..24bcaf0 100644 --- a/java/com/google/gerrit/server/group/db/GroupsNoteDbConsistencyChecker.java +++ b/java/com/google/gerrit/server/group/db/GroupsNoteDbConsistencyChecker.java
@@ -22,6 +22,7 @@ import com.google.common.collect.HashBiMap; import com.google.common.collect.ImmutableList; import com.google.common.flogger.FluentLogger; +import com.google.errorprone.annotations.FormatMethod; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.AccountGroup; import com.google.gerrit.entities.GroupReference; @@ -138,8 +139,7 @@ Optional<Ref> maybeRef = refs.stream().filter(r -> r.getName().equals(RefNames.REFS_GROUPNAMES)).findFirst(); if (!maybeRef.isPresent()) { - String msg = String.format("ref %s does not exist", RefNames.REFS_GROUPNAMES); - result.problems.add(error(msg)); + result.problems.add(error("ref %s does not exist", RefNames.REFS_GROUPNAMES)); return; } Ref ref = maybeRef.get(); @@ -280,6 +280,7 @@ } } + @FormatMethod public static void logConsistencyProblemAsWarning(String fmt, Object... args) { logConsistencyProblem(warning(fmt, args)); }
diff --git a/java/com/google/gerrit/server/group/db/GroupsUpdate.java b/java/com/google/gerrit/server/group/db/GroupsUpdate.java index 02d55eb..9aa5cfd 100644 --- a/java/com/google/gerrit/server/group/db/GroupsUpdate.java +++ b/java/com/google/gerrit/server/group/db/GroupsUpdate.java
@@ -67,19 +67,19 @@ * <p>All calls which write group related details to the database are gathered here. Other classes * should always use this class instead of accessing the database directly. There are a few * exceptions though: schema classes, wrapper classes, and classes executed during init. The latter - * ones should use {@code GroupsOnInit} instead. + * ones should use {@link com.google.gerrit.pgm.init.GroupsOnInit} instead. * * <p>If not explicitly stated, all methods of this class refer to <em>internal</em> groups. */ public class GroupsUpdate { public interface Factory { /** - * Creates a {@code GroupsUpdate} which uses the identity of the specified user to mark database + * Creates a {@link GroupsUpdate} which uses the identity of the specified user to mark database * modifications executed by it. For NoteDb, this identity is used as author and committer for * all related commits. * * <p><strong>Note</strong>: Please use this method with care and consider using the {@link - * com.google.gerrit.server.UserInitiated} annotation on the provider of a {@code GroupsUpdate} + * com.google.gerrit.server.UserInitiated} annotation on the provider of a {@link GroupsUpdate} * instead. * * @param currentUser the user to which modifications should be attributed @@ -87,12 +87,12 @@ GroupsUpdate create(IdentifiedUser currentUser); /** - * Creates a {@code GroupsUpdate} which uses the server identity to mark database modifications + * Creates a {@link GroupsUpdate} which uses the server identity to mark database modifications * executed by it. For NoteDb, this identity is used as author and committer for all related * commits. * * <p><strong>Note</strong>: Please use this method with care and consider using the {@link - * com.google.gerrit.server.ServerInitiated} annotation on the provider of a {@code + * com.google.gerrit.server.ServerInitiated} annotation on the provider of a {@link * GroupsUpdate} instead. */ GroupsUpdate createWithServerIdent(); @@ -115,6 +115,7 @@ private final RetryHelper retryHelper; @AssistedInject + @SuppressWarnings("BindingAnnotationWithoutInject") GroupsUpdate( GitRepositoryManager repoManager, AllUsersName allUsersName, @@ -149,6 +150,7 @@ } @AssistedInject + @SuppressWarnings("BindingAnnotationWithoutInject") GroupsUpdate( GitRepositoryManager repoManager, AllUsersName allUsersName, @@ -183,6 +185,7 @@ Optional.of(currentUser)); } + @SuppressWarnings("BindingAnnotationWithoutInject") private GroupsUpdate( GitRepositoryManager repoManager, AllUsersName allUsersName, @@ -251,25 +254,24 @@ /** * Creates the specified group for the specified members (accounts). * - * @param groupCreation an {@code InternalGroupCreation} which specifies all mandatory properties + * @param groupCreation an {@link InternalGroupCreation} which specifies all mandatory properties * of the group - * @param groupUpdate an {@code InternalGroupUpdate} which specifies optional properties of the - * group. If this {@code InternalGroupUpdate} updates a property which was already specified - * by the {@code InternalGroupCreation}, the value of this {@code InternalGroupUpdate} wins. + * @param groupDelta a {@link GroupDelta} which specifies optional properties of the group. If + * this {@link GroupDelta} updates a property which was already specified by the {@link + * InternalGroupCreation}, the value of this {@link GroupDelta} wins. * @throws DuplicateKeyException if a group with the chosen name already exists * @throws IOException if indexing fails, or an error occurs while reading/writing from/to NoteDb - * @return the created {@code InternalGroup} + * @return the created {@link InternalGroup} */ - public InternalGroup createGroup( - InternalGroupCreation groupCreation, InternalGroupUpdate groupUpdate) + public InternalGroup createGroup(InternalGroupCreation groupCreation, GroupDelta groupDelta) throws DuplicateKeyException, IOException, ConfigInvalidException { - try (TraceTimer timer = + try (TraceTimer ignored = TraceContext.newTimer( "Creating group", Metadata.builder() - .groupName(groupUpdate.getName().orElseGet(groupCreation::getNameKey).get()) + .groupName(groupDelta.getName().orElseGet(groupCreation::getNameKey).get()) .build())) { - InternalGroup createdGroup = createGroupInNoteDbWithRetry(groupCreation, groupUpdate); + InternalGroup createdGroup = createGroupInNoteDbWithRetry(groupCreation, groupDelta); evictCachesOnGroupCreation(createdGroup); dispatchAuditEventsOnGroupCreation(createdGroup); return createdGroup; @@ -280,24 +282,23 @@ * Updates the specified group. * * @param groupUuid the UUID of the group to update - * @param groupUpdate an {@code InternalGroupUpdate} which indicates the desired updates on the - * group + * @param groupDelta a {@link GroupDelta} which indicates the desired updates on the group * @throws DuplicateKeyException if the new name of the group is used by another group * @throws IOException if indexing fails, or an error occurs while reading/writing from/to NoteDb * @throws NoSuchGroupException if the specified group doesn't exist */ - public void updateGroup(AccountGroup.UUID groupUuid, InternalGroupUpdate groupUpdate) + public void updateGroup(AccountGroup.UUID groupUuid, GroupDelta groupDelta) throws DuplicateKeyException, IOException, NoSuchGroupException, ConfigInvalidException { - try (TraceTimer timer = + try (TraceTimer ignored = TraceContext.newTimer( "Updating group", Metadata.builder().groupUuid(groupUuid.get()).build())) { - Optional<Timestamp> updatedOn = groupUpdate.getUpdatedOn(); + Optional<Timestamp> updatedOn = groupDelta.getUpdatedOn(); if (!updatedOn.isPresent()) { updatedOn = Optional.of(TimeUtil.nowTs()); - groupUpdate = groupUpdate.toBuilder().setUpdatedOn(updatedOn.get()).build(); + groupDelta = groupDelta.toBuilder().setUpdatedOn(updatedOn.get()).build(); } - UpdateResult result = updateGroupInNoteDbWithRetry(groupUuid, groupUpdate); + UpdateResult result = updateGroupInNoteDbWithRetry(groupUuid, groupDelta); updateNameInProjectConfigsIfNecessary(result); evictCachesOnGroupUpdate(result); dispatchAuditEventsOnGroupUpdate(result, updatedOn.get()); @@ -305,11 +306,11 @@ } private InternalGroup createGroupInNoteDbWithRetry( - InternalGroupCreation groupCreation, InternalGroupUpdate groupUpdate) + InternalGroupCreation groupCreation, GroupDelta groupDelta) throws IOException, ConfigInvalidException, DuplicateKeyException { try { return retryHelper - .groupUpdate("createGroup", () -> createGroupInNoteDb(groupCreation, groupUpdate)) + .groupUpdate("createGroup", () -> createGroupInNoteDb(groupCreation, groupDelta)) .call(); } catch (Exception e) { Throwables.throwIfUnchecked(e); @@ -322,17 +323,17 @@ @VisibleForTesting public InternalGroup createGroupInNoteDb( - InternalGroupCreation groupCreation, InternalGroupUpdate groupUpdate) + InternalGroupCreation groupCreation, GroupDelta groupDelta) throws IOException, ConfigInvalidException, DuplicateKeyException { try (Repository allUsersRepo = repoManager.openRepository(allUsersName)) { - AccountGroup.NameKey groupName = groupUpdate.getName().orElseGet(groupCreation::getNameKey); + AccountGroup.NameKey groupName = groupDelta.getName().orElseGet(groupCreation::getNameKey); GroupNameNotes groupNameNotes = GroupNameNotes.forNewGroup( allUsersName, allUsersRepo, groupCreation.getGroupUUID(), groupName); GroupConfig groupConfig = GroupConfig.createForNewGroup(allUsersName, allUsersRepo, groupCreation); - groupConfig.setGroupUpdate(groupUpdate, auditLogFormatter); + groupConfig.setGroupDelta(groupDelta, auditLogFormatter); commit(allUsersRepo, groupConfig, groupNameNotes); @@ -344,11 +345,11 @@ } private UpdateResult updateGroupInNoteDbWithRetry( - AccountGroup.UUID groupUuid, InternalGroupUpdate groupUpdate) + AccountGroup.UUID groupUuid, GroupDelta groupDelta) throws IOException, ConfigInvalidException, DuplicateKeyException, NoSuchGroupException { try { return retryHelper - .groupUpdate("updateGroup", () -> updateGroupInNoteDb(groupUuid, groupUpdate)) + .groupUpdate("updateGroup", () -> updateGroupInNoteDb(groupUuid, groupDelta)) .call(); } catch (Exception e) { Throwables.throwIfUnchecked(e); @@ -361,21 +362,20 @@ } @VisibleForTesting - public UpdateResult updateGroupInNoteDb( - AccountGroup.UUID groupUuid, InternalGroupUpdate groupUpdate) + public UpdateResult updateGroupInNoteDb(AccountGroup.UUID groupUuid, GroupDelta groupDelta) throws IOException, ConfigInvalidException, DuplicateKeyException, NoSuchGroupException { try (Repository allUsersRepo = repoManager.openRepository(allUsersName)) { GroupConfig groupConfig = GroupConfig.loadForGroup(allUsersName, allUsersRepo, groupUuid); - groupConfig.setGroupUpdate(groupUpdate, auditLogFormatter); + groupConfig.setGroupDelta(groupDelta, auditLogFormatter); if (!groupConfig.getLoadedGroup().isPresent()) { throw new NoSuchGroupException(groupUuid); } InternalGroup originalGroup = groupConfig.getLoadedGroup().get(); GroupNameNotes groupNameNotes = null; - if (groupUpdate.getName().isPresent()) { + if (groupDelta.getName().isPresent()) { AccountGroup.NameKey oldName = originalGroup.getNameKey(); - AccountGroup.NameKey newName = groupUpdate.getName().get(); + AccountGroup.NameKey newName = groupDelta.getName().get(); groupNameNotes = GroupNameNotes.forRename(allUsersName, allUsersRepo, groupUuid, oldName, newName); }
diff --git a/java/com/google/gerrit/server/group/db/InternalGroupCreation.java b/java/com/google/gerrit/server/group/db/InternalGroupCreation.java index 8988547..291c354 100644 --- a/java/com/google/gerrit/server/group/db/InternalGroupCreation.java +++ b/java/com/google/gerrit/server/group/db/InternalGroupCreation.java
@@ -20,19 +20,19 @@ /** * Definition of all properties necessary for a group creation. * - * <p>An instance of {@code InternalGroupCreation} is a blueprint for a group which should be + * <p>An instance of {@link InternalGroupCreation} is a blueprint for a group which should be * created. */ @AutoValue public abstract class InternalGroupCreation { - /** Defines the numeric ID the group should have. */ + /** Defines the numeric ID the group should have */ public abstract AccountGroup.Id getId(); - /** Defines the name the group should have. */ + /** Defines the name the group should have */ public abstract AccountGroup.NameKey getNameKey(); - /** Defines the UUID the group should have. */ + /** Defines the UUID the group should have */ public abstract AccountGroup.UUID getGroupUUID(); public static Builder builder() { @@ -41,13 +41,13 @@ @AutoValue.Builder public abstract static class Builder { - /** @see #getId() */ + /** Defines the name the group should have */ public abstract InternalGroupCreation.Builder setId(AccountGroup.Id id); - /** @see #getNameKey() */ + /** Defines the name the group should have */ public abstract InternalGroupCreation.Builder setNameKey(AccountGroup.NameKey name); - /** @see #getGroupUUID() */ + /** Defines the UUID the group should have */ public abstract InternalGroupCreation.Builder setGroupUUID(AccountGroup.UUID groupUuid); public abstract InternalGroupCreation build();
diff --git a/java/com/google/gerrit/server/group/testing/TestGroupBackend.java b/java/com/google/gerrit/server/group/testing/TestGroupBackend.java index 12d8c93..2d9c798 100644 --- a/java/com/google/gerrit/server/group/testing/TestGroupBackend.java +++ b/java/com/google/gerrit/server/group/testing/TestGroupBackend.java
@@ -102,6 +102,11 @@ memberships.put(user, membership); } + /** Remove the memberships of the given user. No-op if the user does not have any memberships. */ + public void removeMembershipsOf(Account.Id user) { + memberships.remove(user); + } + @Override public boolean handles(AccountGroup.UUID uuid) { if (uuid != null) {
diff --git a/java/com/google/gerrit/server/index/AbstractIndexModule.java b/java/com/google/gerrit/server/index/AbstractIndexModule.java index 352971f..81c517f 100644 --- a/java/com/google/gerrit/server/index/AbstractIndexModule.java +++ b/java/com/google/gerrit/server/index/AbstractIndexModule.java
@@ -33,6 +33,7 @@ * index implementations, such as {@link com.google.gerrit.lucene.LuceneIndexModule}. */ public abstract class AbstractIndexModule extends AbstractModule { + public static final String INDEX_MODULE = "index-module"; private final int threads; private final Map<String, Integer> singleVersions;
diff --git a/java/com/google/gerrit/server/index/IndexModule.java b/java/com/google/gerrit/server/index/IndexModule.java index 8b04c8d..85f423b 100644 --- a/java/com/google/gerrit/server/index/IndexModule.java +++ b/java/com/google/gerrit/server/index/IndexModule.java
@@ -33,6 +33,7 @@ import com.google.gerrit.index.project.ProjectSchemaDefinitions; import com.google.gerrit.lifecycle.LifecycleModule; import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.git.MultiProgressMonitor; import com.google.gerrit.server.git.WorkQueue; import com.google.gerrit.server.index.account.AccountIndexCollection; import com.google.gerrit.server.index.account.AccountIndexDefinition; @@ -51,6 +52,7 @@ import com.google.gerrit.server.index.group.GroupIndexer; import com.google.gerrit.server.index.group.GroupIndexerImpl; import com.google.gerrit.server.index.group.GroupSchemaDefinitions; +import com.google.gerrit.server.index.options.BuildBloomFilter; import com.google.gerrit.server.index.options.IsFirstInsertForEntry; import com.google.gerrit.server.index.project.ProjectIndexDefinition; import com.google.gerrit.server.index.project.ProjectIndexerImpl; @@ -112,6 +114,7 @@ @Override protected void configure() { + factory(MultiProgressMonitor.Factory.class); bind(AccountIndexRewriter.class); bind(AccountIndexCollection.class); @@ -148,6 +151,9 @@ OptionalBinder.newOptionalBinder(binder(), IsFirstInsertForEntry.class) .setDefault() .toInstance(IsFirstInsertForEntry.NO); + OptionalBinder.newOptionalBinder(binder(), BuildBloomFilter.class) + .setDefault() + .toInstance(BuildBloomFilter.TRUE); } @Provides
diff --git a/java/com/google/gerrit/server/index/OnlineUpgrader.java b/java/com/google/gerrit/server/index/OnlineUpgrader.java index bfcf55f..a7e3dbc 100644 --- a/java/com/google/gerrit/server/index/OnlineUpgrader.java +++ b/java/com/google/gerrit/server/index/OnlineUpgrader.java
@@ -20,7 +20,7 @@ /** Listener to handle upgrading index schema versions at startup. */ public class OnlineUpgrader implements LifecycleListener { - public static class Module extends LifecycleModule { + public static class OnlineUpgraderModule extends LifecycleModule { @Override protected void configure() { listener().to(OnlineUpgrader.class);
diff --git a/java/com/google/gerrit/server/index/VersionManager.java b/java/com/google/gerrit/server/index/VersionManager.java index 56ce604..cdb69c6 100644 --- a/java/com/google/gerrit/server/index/VersionManager.java +++ b/java/com/google/gerrit/server/index/VersionManager.java
@@ -107,7 +107,6 @@ * @param name index name * @param force start re-index * @return true if started, otherwise false. - * @throws ReindexerAlreadyRunningException */ public synchronized boolean startReindexer(String name, boolean force) throws ReindexerAlreadyRunningException { @@ -125,7 +124,6 @@ * * @param name index name * @return true if index was activated, otherwise false. - * @throws ReindexerAlreadyRunningException */ public synchronized boolean activateLatestIndex(String name) throws ReindexerAlreadyRunningException {
diff --git a/java/com/google/gerrit/server/index/account/AllAccountsIndexer.java b/java/com/google/gerrit/server/index/account/AllAccountsIndexer.java index ec27db0..1f48e35 100644 --- a/java/com/google/gerrit/server/index/account/AllAccountsIndexer.java +++ b/java/com/google/gerrit/server/index/account/AllAccountsIndexer.java
@@ -96,7 +96,7 @@ try { Optional<AccountState> a = accountCache.get(id); if (a.isPresent()) { - if (isFirstInsertForEntry.equals(isFirstInsertForEntry.YES)) { + if (isFirstInsertForEntry.equals(IsFirstInsertForEntry.YES)) { index.insert(a.get()); } else { index.replace(a.get());
diff --git a/java/com/google/gerrit/server/index/change/AllChangesIndexer.java b/java/com/google/gerrit/server/index/change/AllChangesIndexer.java index f176c38..7a1cd6e 100644 --- a/java/com/google/gerrit/server/index/change/AllChangesIndexer.java +++ b/java/com/google/gerrit/server/index/change/AllChangesIndexer.java
@@ -21,6 +21,7 @@ import com.google.auto.value.AutoValue; import com.google.common.base.Stopwatch; +import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSortedSet; import com.google.common.flogger.FluentLogger; import com.google.common.util.concurrent.ListenableFuture; @@ -32,12 +33,12 @@ import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.git.MultiProgressMonitor; import com.google.gerrit.server.git.MultiProgressMonitor.Task; +import com.google.gerrit.server.git.MultiProgressMonitor.TaskKind; import com.google.gerrit.server.git.MultiProgressMonitor.VolatileTask; import com.google.gerrit.server.index.IndexExecutor; import com.google.gerrit.server.index.OnlineReindexMode; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.notedb.ChangeNotes.Factory.ChangeNotesResult; -import com.google.gerrit.server.notedb.ChangeNotes.Factory.ScanResult; import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; @@ -48,6 +49,7 @@ import java.util.concurrent.RejectedExecutionException; import java.util.concurrent.atomic.AtomicBoolean; import java.util.concurrent.atomic.AtomicInteger; +import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.ProgressMonitor; import org.eclipse.jgit.lib.Repository; @@ -63,6 +65,8 @@ private Task failedTask; private static final int PROJECT_SLICE_MAX_REFS = 1000; + private final MultiProgressMonitor.Factory multiProgressMonitorFactory; + private static class ProjectsCollectionFailure extends Exception { private static final long serialVersionUID = 1L; @@ -80,12 +84,14 @@ @Inject AllChangesIndexer( + MultiProgressMonitor.Factory multiProgressMonitorFactory, ChangeData.Factory changeDataFactory, GitRepositoryManager repoManager, @IndexExecutor(BATCH) ListeningExecutorService executor, ChangeIndexer.Factory indexerFactory, ChangeNotes.Factory notesFactory, ProjectCache projectCache) { + this.multiProgressMonitorFactory = multiProgressMonitorFactory; this.changeDataFactory = changeDataFactory; this.repoManager = repoManager; this.executor = executor; @@ -102,10 +108,14 @@ public abstract int slices(); - public abstract ScanResult scanResult(); + public abstract ImmutableMap<Change.Id, ObjectId> metaIdByChange(); - private static ProjectSlice create(Project.NameKey name, int slice, int slices, ScanResult sr) { - return new AutoValue_AllChangesIndexer_ProjectSlice(name, slice, slices, sr); + private static ProjectSlice create( + Project.NameKey name, + int slice, + int slices, + ImmutableMap<Change.Id, ObjectId> metaIdByChange) { + return new AutoValue_AllChangesIndexer_ProjectSlice(name, slice, slices, metaIdByChange); } } @@ -128,7 +138,7 @@ Stopwatch sw = Stopwatch.createStarted(); AtomicBoolean ok = new AtomicBoolean(true); - mpm = new MultiProgressMonitor(progressOut, "Reindexing changes"); + mpm = multiProgressMonitorFactory.create(progressOut, TaskKind.INDEXING, "Reindexing changes"); doneTask = mpm.beginVolatileSubTask("changes"); failedTask = mpm.beginSubTask("failed", MultiProgressMonitor.UNKNOWN); List<ListenableFuture<?>> futures; @@ -186,10 +196,10 @@ Project.NameKey project, int slice, int slices, - ScanResult scanResult, + ImmutableMap<Change.Id, ObjectId> metaIdByChange, Task done, Task failed) { - return new ProjectIndexer(indexer, project, slice, slices, scanResult, done, failed); + return new ProjectIndexer(indexer, project, slice, slices, metaIdByChange, done, failed); } private class ProjectIndexer implements Callable<Void> { @@ -197,7 +207,7 @@ private final Project.NameKey project; private final int slice; private final int slices; - private final ScanResult scanResult; + private final ImmutableMap<Change.Id, ObjectId> metaIdByChange; private final ProgressMonitor done; private final ProgressMonitor failed; @@ -206,14 +216,14 @@ Project.NameKey project, int slice, int slices, - ScanResult scanResult, + ImmutableMap<Change.Id, ObjectId> metaIdByChange, ProgressMonitor done, ProgressMonitor failed) { this.indexer = indexer; this.project = project; this.slice = slice; this.slices = slices; - this.scanResult = scanResult; + this.metaIdByChange = metaIdByChange; this.done = done; this.failed = failed; } @@ -227,7 +237,7 @@ // but the goal is to invalidate that cache as infrequently as we possibly can. And besides, // we don't have concrete proof that improving packfile locality would help. notesFactory - .scan(scanResult, project, id -> (id.get() % slices) == slice) + .scan(metaIdByChange, project, id -> (id.get() % slices) == slice) .forEach(r -> index(r)); OnlineReindexMode.end(); return null; @@ -266,7 +276,10 @@ @Override public String toString() { - return "Index all changes of project " + project.get(); + if (slices == 1) { + return "Index all changes of project " + project.get(); + } + return "Index changes slice " + slice + "/" + slices + " of project " + project.get(); } } @@ -329,8 +342,9 @@ @Override public Void call() throws IOException { try (Repository repo = repoManager.openRepository(name)) { - ScanResult sr = ChangeNotes.Factory.scanChangeIds(repo); - int size = sr.all().size(); + ImmutableMap<Change.Id, ObjectId> metaIdByChange = + ChangeNotes.Factory.scanChangeIds(repo); + int size = metaIdByChange.size(); if (size > 0) { changeCount.addAndGet(size); int slices = 1 + size / PROJECT_SLICE_MAX_REFS; @@ -343,7 +357,7 @@ projTask.updateTotal(slices); for (int slice = 0; slice < slices; slice++) { - ProjectSlice projectSlice = ProjectSlice.create(name, slice, slices, sr); + ProjectSlice projectSlice = ProjectSlice.create(name, slice, slices, metaIdByChange); ListenableFuture<?> future = executor.submit( reindexProject( @@ -351,7 +365,7 @@ name, slice, slices, - projectSlice.scanResult(), + projectSlice.metaIdByChange(), doneTask, failedTask)); String description = "project " + name + " (" + slice + "/" + slices + ")";
diff --git a/java/com/google/gerrit/server/index/change/ChangeField.java b/java/com/google/gerrit/server/index/change/ChangeField.java index ce748d1..4a2419b 100644 --- a/java/com/google/gerrit/server/index/change/ChangeField.java +++ b/java/com/google/gerrit/server/index/change/ChangeField.java
@@ -16,6 +16,7 @@ import static com.google.common.base.MoreObjects.firstNonNull; import static com.google.common.collect.ImmutableList.toImmutableList; +import static com.google.common.collect.ImmutableListMultimap.toImmutableListMultimap; import static com.google.common.collect.ImmutableSet.toImmutableSet; import static com.google.gerrit.index.FieldDef.exact; import static com.google.gerrit.index.FieldDef.fullText; @@ -42,11 +43,13 @@ import com.google.common.flogger.FluentLogger; import com.google.common.io.Files; import com.google.common.primitives.Longs; +import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Address; import com.google.gerrit.entities.AttentionSetUpdate; import com.google.gerrit.entities.Change; import com.google.gerrit.entities.ChangeMessage; +import com.google.gerrit.entities.LabelType; import com.google.gerrit.entities.LegacySubmitRequirement; import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.Project; @@ -57,6 +60,7 @@ import com.google.gerrit.entities.converter.PatchSetProtoConverter; import com.google.gerrit.entities.converter.ProtoConverter; import com.google.gerrit.index.FieldDef; +import com.google.gerrit.index.RefState; import com.google.gerrit.index.SchemaUtil; import com.google.gerrit.json.OutputFormat; import com.google.gerrit.proto.Protos; @@ -66,11 +70,14 @@ import com.google.gerrit.server.config.AllUsersName; import com.google.gerrit.server.index.change.StalenessChecker.RefStatePattern; import com.google.gerrit.server.notedb.ReviewerStateInternal; +import com.google.gerrit.server.notedb.SubmitRequirementProtoConverter; import com.google.gerrit.server.project.SubmitRuleOptions; import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.query.change.ChangeQueryBuilder; import com.google.gerrit.server.query.change.ChangeStatusPredicate; +import com.google.gerrit.server.query.change.MagicLabelValue; import com.google.gson.Gson; +import com.google.protobuf.MessageLite; import java.sql.Timestamp; import java.time.Instant; import java.util.ArrayList; @@ -84,6 +91,7 @@ import java.util.Set; import java.util.function.Function; import java.util.stream.Stream; +import java.util.stream.StreamSupport; import org.eclipse.jgit.lib.PersonIdent; /** @@ -103,6 +111,7 @@ private static final Gson GSON = OutputFormat.JSON_COMPACT.newGson(); + // TODO: Rename LEGACY_ID to NUMERIC_ID /** Legacy change ID. */ public static final FieldDef<ChangeData, Integer> LEGACY_ID = integer("legacy_id").stored().build(cd -> cd.getId().get()); @@ -153,7 +162,7 @@ public static final FieldDef<ChangeData, Timestamp> MERGED_ON = timestamp(ChangeQueryBuilder.FIELD_MERGED_ON) .stored() - .build(cd -> cd.getMergedOn().orElse(null)); + .build(cd -> cd.getMergedOn().orElse(null), (cd, field) -> cd.setMergedOn(field)); /** List of full file paths modified in the current patch set. */ public static final FieldDef<ChangeData, Iterable<String>> PATH = @@ -179,11 +188,21 @@ exact(ChangeQueryBuilder.FIELD_HASHTAG) .buildRepeatable(cd -> cd.hashtags().stream().map(String::toLowerCase).collect(toSet())); + /** Hashtags as fulltext field for in-string search. */ + public static final FieldDef<ChangeData, Iterable<String>> FUZZY_HASHTAG = + fullText("hashtag2") + .buildRepeatable(cd -> cd.hashtags().stream().map(String::toLowerCase).collect(toSet())); + /** Hashtags with original case. */ public static final FieldDef<ChangeData, Iterable<byte[]>> HASHTAG_CASE_AWARE = storedOnly("_hashtag") .buildRepeatable( - cd -> cd.hashtags().stream().map(t -> t.getBytes(UTF_8)).collect(toSet())); + cd -> cd.hashtags().stream().map(t -> t.getBytes(UTF_8)).collect(toSet()), + (cd, field) -> + cd.setHashtags( + StreamSupport.stream(field.spliterator(), false) + .map(f -> new String(f, UTF_8)) + .collect(toImmutableSet()))); /** Components of each file path modified in the current patch set. */ public static final FieldDef<ChangeData, Iterable<String>> FILE_PART = @@ -248,7 +267,7 @@ StringBuilder directory = new StringBuilder(); r.add(directory.toString()); String nextPart = null; - for (String part : s.split(path)) { + for (String part : s.split(path.toLowerCase(Locale.US))) { if (nextPart != null) { r.add(nextPart); @@ -275,6 +294,10 @@ public static final FieldDef<ChangeData, Integer> OWNER = integer(ChangeQueryBuilder.FIELD_OWNER).build(changeGetter(c -> c.getOwner().get())); + /** Uploader of the latest patch set. */ + public static final FieldDef<ChangeData, Integer> UPLOADER = + integer(ChangeQueryBuilder.FIELD_UPLOADER).build(cd -> cd.currentPatchSet().uploader().get()); + /** References the source change number that this change was cherry-picked from. */ public static final FieldDef<ChangeData, Integer> CHERRY_PICK_OF_CHANGE = integer(ChangeQueryBuilder.FIELD_CHERRY_PICK_OF_CHANGE) @@ -323,6 +346,11 @@ integer(ChangeQueryBuilder.FIELD_ATTENTION_SET_USERS) .buildRepeatable(ChangeField::getAttentionSetUserIds); + /** Number of changes that contain attention set. */ + public static final FieldDef<ChangeData, Integer> ATTENTION_SET_USERS_COUNT = + intRange(ChangeQueryBuilder.FIELD_ATTENTION_SET_USERS_COUNT) + .build(cd -> additionsOnly(cd.attentionSet()).size()); + /** * The full attention set data including timestamp, reason and possible future fields. * @@ -330,7 +358,14 @@ */ public static final FieldDef<ChangeData, Iterable<byte[]>> ATTENTION_SET_FULL = storedOnly(ChangeQueryBuilder.FIELD_ATTENTION_SET_FULL) - .buildRepeatable(ChangeField::storedAttentionSet); + .buildRepeatable( + ChangeField::storedAttentionSet, + (cd, value) -> + parseAttentionSet( + StreamSupport.stream(value.spliterator(), false) + .map(v -> new String(v, UTF_8)) + .collect(toImmutableSet()), + cd)); /** The user assigned to the change. */ public static final FieldDef<ChangeData, Integer> ASSIGNEE = @@ -339,25 +374,38 @@ /** Reviewer(s) associated with the change. */ public static final FieldDef<ChangeData, Iterable<String>> REVIEWER = - exact("reviewer2").stored().buildRepeatable(cd -> getReviewerFieldValues(cd.reviewers())); + exact("reviewer2") + .stored() + .buildRepeatable( + cd -> getReviewerFieldValues(cd.reviewers()), + (cd, field) -> cd.setReviewers(parseReviewerFieldValues(cd.getId(), field))); /** Reviewer(s) associated with the change that do not have a gerrit account. */ public static final FieldDef<ChangeData, Iterable<String>> REVIEWER_BY_EMAIL = exact("reviewer_by_email") .stored() - .buildRepeatable(cd -> getReviewerByEmailFieldValues(cd.reviewersByEmail())); + .buildRepeatable( + cd -> getReviewerByEmailFieldValues(cd.reviewersByEmail()), + (cd, field) -> + cd.setReviewersByEmail(parseReviewerByEmailFieldValues(cd.getId(), field))); /** Reviewer(s) modified during change's current WIP phase. */ public static final FieldDef<ChangeData, Iterable<String>> PENDING_REVIEWER = exact(ChangeQueryBuilder.FIELD_PENDING_REVIEWER) .stored() - .buildRepeatable(cd -> getReviewerFieldValues(cd.pendingReviewers())); + .buildRepeatable( + cd -> getReviewerFieldValues(cd.pendingReviewers()), + (cd, field) -> cd.setPendingReviewers(parseReviewerFieldValues(cd.getId(), field))); /** Reviewer(s) by email modified during change's current WIP phase. */ public static final FieldDef<ChangeData, Iterable<String>> PENDING_REVIEWER_BY_EMAIL = exact(ChangeQueryBuilder.FIELD_PENDING_REVIEWER_BY_EMAIL) .stored() - .buildRepeatable(cd -> getReviewerByEmailFieldValues(cd.pendingReviewersByEmail())); + .buildRepeatable( + cd -> getReviewerByEmailFieldValues(cd.pendingReviewersByEmail()), + (cd, field) -> + cd.setPendingReviewersByEmail( + parseReviewerByEmailFieldValues(cd.getId(), field))); /** References a change that this change reverts. */ public static final FieldDef<ChangeData, Integer> REVERT_OF = @@ -559,24 +607,52 @@ /** List of labels on the current patch set including change owner votes. */ public static final FieldDef<ChangeData, Iterable<String>> LABEL = - exact("label2").buildRepeatable(cd -> getLabels(cd, true)); + exact("label2").buildRepeatable(cd -> getLabels(cd)); - private static Iterable<String> getLabels(ChangeData cd, boolean owners) { + private static Iterable<String> getLabels(ChangeData cd) { Set<String> allApprovals = new HashSet<>(); Set<String> distinctApprovals = new HashSet<>(); for (PatchSetApproval a : cd.currentApprovals()) { if (a.value() != 0 && !a.isLegacySubmit()) { allApprovals.add(formatLabel(a.label(), a.value(), a.accountId())); - if (owners && cd.change().getOwner().equals(a.accountId())) { + Optional<LabelType> labelType = cd.getLabelTypes().byLabel(a.labelId()); + allApprovals.addAll(getMaxMinAnyLabels(a.label(), a.value(), labelType, a.accountId())); + if (cd.change().getOwner().equals(a.accountId())) { allApprovals.add(formatLabel(a.label(), a.value(), ChangeQueryBuilder.OWNER_ACCOUNT_ID)); + allApprovals.addAll( + getMaxMinAnyLabels( + a.label(), a.value(), labelType, ChangeQueryBuilder.OWNER_ACCOUNT_ID)); + } + if (!cd.currentPatchSet().uploader().equals(a.accountId())) { + allApprovals.add( + formatLabel(a.label(), a.value(), ChangeQueryBuilder.NON_UPLOADER_ACCOUNT_ID)); + allApprovals.addAll( + getMaxMinAnyLabels( + a.label(), a.value(), labelType, ChangeQueryBuilder.NON_UPLOADER_ACCOUNT_ID)); } distinctApprovals.add(formatLabel(a.label(), a.value())); + distinctApprovals.addAll(getMaxMinAnyLabels(a.label(), a.value(), labelType, null)); } } allApprovals.addAll(distinctApprovals); return allApprovals; } + private static List<String> getMaxMinAnyLabels( + String label, short labelVal, Optional<LabelType> labelType, @Nullable Account.Id accountId) { + List<String> labels = new ArrayList<>(); + if (labelType.isPresent()) { + if (labelVal == labelType.get().getMaxPositive()) { + labels.add(formatLabel(label, MagicLabelValue.MAX.name(), accountId)); + } + if (labelVal == labelType.get().getMaxNegative()) { + labels.add(formatLabel(label, MagicLabelValue.MIN.name(), accountId)); + } + } + labels.add(formatLabel(label, MagicLabelValue.ANY.name(), accountId)); + return labels; + } + public static Set<String> getAuthorParts(ChangeData cd) { return SchemaUtil.getPersonParts(cd.getAuthor()); } @@ -637,13 +713,18 @@ /** Serialized change object, used for pre-populating results. */ public static final FieldDef<ChangeData, byte[]> CHANGE = storedOnly("_change") - .build(changeGetter(change -> toProto(ChangeProtoConverter.INSTANCE, change))); + .build( + changeGetter(change -> toProto(ChangeProtoConverter.INSTANCE, change)), + (cd, field) -> cd.setChange(parseProtoFrom(field, ChangeProtoConverter.INSTANCE))); /** Serialized approvals for the current patch set, used for pre-populating results. */ public static final FieldDef<ChangeData, Iterable<byte[]>> APPROVAL = storedOnly("_approval") .buildRepeatable( - cd -> toProtos(PatchSetApprovalProtoConverter.INSTANCE, cd.currentApprovals())); + cd -> toProtos(PatchSetApprovalProtoConverter.INSTANCE, cd.currentApprovals()), + (cd, field) -> + cd.setCurrentApprovals( + decodeProtos(field, PatchSetApprovalProtoConverter.INSTANCE))); public static String formatLabel(String label, int value) { return formatLabel(label, value, null); @@ -656,9 +737,22 @@ + (accountId != null ? "," + formatAccount(accountId) : ""); } + public static String formatLabel(String label, String value) { + return formatLabel(label, value, null); + } + + public static String formatLabel(String label, String value, @Nullable Account.Id accountId) { + return label.toLowerCase() + + "=" + + value + + (accountId != null ? "," + formatAccount(accountId) : ""); + } + private static String formatAccount(Account.Id accountId) { if (ChangeQueryBuilder.OWNER_ACCOUNT_ID.equals(accountId)) { return ChangeQueryBuilder.ARG_ID_OWNER; + } else if (ChangeQueryBuilder.NON_UPLOADER_ACCOUNT_ID.equals(accountId)) { + return ChangeQueryBuilder.ARG_ID_NON_UPLOADER; } return Integer.toString(accountId.get()); } @@ -674,17 +768,24 @@ cd -> Stream.concat( cd.publishedComments().stream().map(c -> c.message), + // Some endpoint allow passing user message in input, and we still want to + // search by that. Index on message template with placeholders for user + // data, so we don't + // persist user identifiable information data in index. cd.messages().stream().map(ChangeMessage::getMessage)) .collect(toSet())); /** Number of unresolved comment threads of the change, including robot comments. */ public static final FieldDef<ChangeData, Integer> UNRESOLVED_COMMENT_COUNT = intRange(ChangeQueryBuilder.FIELD_UNRESOLVED_COMMENT_COUNT) - .build(ChangeData::unresolvedCommentCount); + .build( + ChangeData::unresolvedCommentCount, + (cd, field) -> cd.setUnresolvedCommentCount(field)); /** Total number of published inline comments of the change, including robot comments. */ public static final FieldDef<ChangeData, Integer> TOTAL_COMMENT_COUNT = - intRange("total_comments").build(ChangeData::totalCommentCount); + intRange("total_comments") + .build(ChangeData::totalCommentCount, (cd, field) -> cd.setTotalCommentCount(field)); /** Whether the change is mergeable. */ public static final FieldDef<ChangeData, String> MERGEABLE = @@ -697,7 +798,8 @@ return null; } return m ? "1" : "0"; - }); + }, + (cd, field) -> cd.setMergeable(field == null ? false : field.equals("1"))); /** Whether the change is a merge commit. */ public static final FieldDef<ChangeData, String> MERGE = @@ -712,15 +814,33 @@ return m ? "1" : "0"; }); + /** Whether the change is a cherry pick of another change. */ + public static final FieldDef<ChangeData, String> CHERRY_PICK = + exact(ChangeQueryBuilder.FIELD_CHERRYPICK) + .stored() + .build(cd -> cd.change().getCherryPickOf() != null ? "1" : "0"); + /** The number of inserted lines in this change. */ public static final FieldDef<ChangeData, Integer> ADDED = intRange(ChangeQueryBuilder.FIELD_ADDED) - .build(cd -> cd.changedLines().isPresent() ? cd.changedLines().get().insertions : null); + .build( + cd -> cd.changedLines().isPresent() ? cd.changedLines().get().insertions : null, + (cd, field) -> { + if (field != null) { + cd.setLinesInserted(field); + } + }); /** The number of deleted lines in this change. */ public static final FieldDef<ChangeData, Integer> DELETED = intRange(ChangeQueryBuilder.FIELD_DELETED) - .build(cd -> cd.changedLines().isPresent() ? cd.changedLines().get().deletions : null); + .build( + cd -> cd.changedLines().isPresent() ? cd.changedLines().get().deletions : null, + (cd, field) -> { + if (field != null) { + cd.setLinesDeleted(field); + } + }); /** The total number of modified lines in this change. */ public static final FieldDef<ChangeData, Integer> DELTA = @@ -761,8 +881,12 @@ Iterables.transform( cd.stars().entries(), e -> - StarredChangesUtil.StarField.create(e.getKey(), e.getValue()) - .toString())); + StarredChangesUtil.StarField.create(e.getKey(), e.getValue()).toString()), + (cd, field) -> + cd.setStars( + StreamSupport.stream(field.spliterator(), false) + .map(f -> StarredChangesUtil.StarField.parse(f)) + .collect(toImmutableListMultimap(e -> e.accountId(), e -> e.label())))); /** Users that have starred the change with any label. */ public static final FieldDef<ChangeData, Iterable<Integer>> STARBY = @@ -778,7 +902,9 @@ /** Serialized patch set object, used for pre-populating results. */ public static final FieldDef<ChangeData, Iterable<byte[]>> PATCH_SET = storedOnly("_patch_set") - .buildRepeatable(cd -> toProtos(PatchSetProtoConverter.INSTANCE, cd.patchSets())); + .buildRepeatable( + cd -> toProtos(PatchSetProtoConverter.INSTANCE, cd.patchSets()), + (cd, field) -> cd.setPatchSets(decodeProtos(field, PatchSetProtoConverter.INSTANCE))); /** Users who have edits on this change. */ public static final FieldDef<ChangeData, Iterable<Integer>> EDITBY = @@ -812,7 +938,12 @@ return ImmutableSet.of(NOT_REVIEWED); } return reviewedBy.stream().map(Account.Id::get).collect(toList()); - }); + }, + (cd, field) -> + cd.setReviewedBy( + StreamSupport.stream(field.spliterator(), false) + .map(Account::id) + .collect(toImmutableSet()))); public static final SubmitRuleOptions SUBMIT_RULE_OPTIONS_LENIENT = SubmitRuleOptions.builder().recomputeOnClosedChanges(true).build(); @@ -820,6 +951,19 @@ public static final SubmitRuleOptions SUBMIT_RULE_OPTIONS_STRICT = SubmitRuleOptions.builder().build(); + /** All submit rules results in the form of "$ruleName,$status". */ + public static final FieldDef<ChangeData, Iterable<String>> SUBMIT_RULE_RESULT = + exact("submit_rule_result") + .buildRepeatable( + cd -> { + List<String> result = new ArrayList<>(); + List<SubmitRecord> submitRecords = cd.submitRecords(SUBMIT_RULE_OPTIONS_STRICT); + for (SubmitRecord record : submitRecords) { + result.add(record.ruleName + "=" + record.status.name()); + } + return result; + }); + /** * JSON type for storing SubmitRecords. * @@ -839,12 +983,14 @@ @Deprecated Map<String, String> data; } + String ruleName; SubmitRecord.Status status; List<StoredLabel> labels; List<StoredRequirement> requirements; String errorMessage; public StoredSubmitRecord(SubmitRecord rec) { + this.ruleName = rec.ruleName; this.status = rec.status; this.errorMessage = rec.errorMessage; if (rec.labels != null) { @@ -876,6 +1022,7 @@ public SubmitRecord toSubmitRecord() { SubmitRecord rec = new SubmitRecord(); + rec.ruleName = ruleName; rec.status = status; rec.errorMessage = errorMessage; if (labels != null) { @@ -908,11 +1055,27 @@ public static final FieldDef<ChangeData, Iterable<byte[]>> STORED_SUBMIT_RECORD_STRICT = storedOnly("full_submit_record_strict") - .buildRepeatable(cd -> storedSubmitRecords(cd, SUBMIT_RULE_OPTIONS_STRICT)); + .buildRepeatable( + cd -> storedSubmitRecords(cd, SUBMIT_RULE_OPTIONS_STRICT), + (cd, field) -> + parseSubmitRecords( + StreamSupport.stream(field.spliterator(), false) + .map(f -> new String(f, UTF_8)) + .collect(toSet()), + SUBMIT_RULE_OPTIONS_STRICT, + cd)); public static final FieldDef<ChangeData, Iterable<byte[]>> STORED_SUBMIT_RECORD_LENIENT = storedOnly("full_submit_record_lenient") - .buildRepeatable(cd -> storedSubmitRecords(cd, SUBMIT_RULE_OPTIONS_LENIENT)); + .buildRepeatable( + cd -> storedSubmitRecords(cd, SUBMIT_RULE_OPTIONS_LENIENT), + (cd, field) -> + parseSubmitRecords( + StreamSupport.stream(field.spliterator(), false) + .map(f -> new String(f, UTF_8)) + .collect(toSet()), + SUBMIT_RULE_OPTIONS_LENIENT, + cd)); public static void parseSubmitRecords( Collection<String> values, SubmitRuleOptions opts, ChangeData out) { @@ -964,6 +1127,27 @@ return result; } + /** Serialized submit requirements, used for pre-populating results. */ + public static final FieldDef<ChangeData, Iterable<byte[]>> STORED_SUBMIT_REQUIREMENTS = + storedOnly("full_submit_requirements") + .buildRepeatable( + cd -> + toProtos( + SubmitRequirementProtoConverter.INSTANCE, cd.submitRequirements().values()), + (cd, field) -> parseSubmitRequirements(field, cd)); + + private static void parseSubmitRequirements(Iterable<byte[]> values, ChangeData out) { + out.setSubmitRequirements( + StreamSupport.stream(values.spliterator(), false) + .map( + f -> + SubmitRequirementProtoConverter.INSTANCE.fromProto( + Protos.parseUnchecked( + SubmitRequirementProtoConverter.INSTANCE.getParser(), f))) + .collect( + ImmutableMap.toImmutableMap(sr -> sr.submitRequirement(), Function.identity()))); + } + /** * All values of all refs that were used in the course of indexing this document. * @@ -978,7 +1162,8 @@ .entries() .forEach(e -> result.add(e.getValue().toByteArray(e.getKey()))); return result; - }); + }, + (cd, field) -> cd.setRefStates(RefState.parseStates(field))); /** * All ref wildcard patterns that were used in the course of indexing this document. @@ -1004,7 +1189,8 @@ RefStatePattern.create(RefNames.refsDraftCommentsPrefix(id) + "*") .toByteArray(allUsers(cd))); return result; - }); + }, + (cd, field) -> cd.setRefStatePatterns(field)); private static String getTopic(ChangeData cd) { Change c = cd.change(); @@ -1022,6 +1208,18 @@ return Protos.toByteArray(converter.toProto(object)); } + private static <T> List<T> decodeProtos(Iterable<byte[]> raw, ProtoConverter<?, T> converter) { + return StreamSupport.stream(raw.spliterator(), false) + .map(bytes -> parseProtoFrom(bytes, converter)) + .collect(toImmutableList()); + } + + private static <P extends MessageLite, T> T parseProtoFrom( + byte[] bytes, ProtoConverter<P, T> converter) { + P message = Protos.parseUnchecked(converter.getParser(), bytes, 0, bytes.length); + return converter.fromProto(message); + } + private static <T> FieldDef.Getter<ChangeData, T> changeGetter(Function<Change, T> func) { return in -> in.change() != null ? func.apply(in.change()) : null; }
diff --git a/java/com/google/gerrit/server/index/change/ChangeIndex.java b/java/com/google/gerrit/server/index/change/ChangeIndex.java index 49d0d4e..05c5c77 100644 --- a/java/com/google/gerrit/server/index/change/ChangeIndex.java +++ b/java/com/google/gerrit/server/index/change/ChangeIndex.java
@@ -19,8 +19,7 @@ import com.google.gerrit.index.IndexDefinition; import com.google.gerrit.index.query.Predicate; import com.google.gerrit.server.query.change.ChangeData; -import com.google.gerrit.server.query.change.LegacyChangeIdPredicate; -import com.google.gerrit.server.query.change.LegacyChangeIdStrPredicate; +import com.google.gerrit.server.query.change.ChangePredicates; /** * Index for Gerrit changes. This class is mainly used for typing the generic parent class that @@ -32,7 +31,7 @@ @Override default Predicate<ChangeData> keyPredicate(Change.Id id) { return getSchema().useLegacyNumericFields() - ? new LegacyChangeIdPredicate(id) - : new LegacyChangeIdStrPredicate(id); + ? ChangePredicates.id(id) + : ChangePredicates.idStr(id); } }
diff --git a/java/com/google/gerrit/server/index/change/ChangeIndexer.java b/java/com/google/gerrit/server/index/change/ChangeIndexer.java index a088af0..8f68904 100644 --- a/java/com/google/gerrit/server/index/change/ChangeIndexer.java +++ b/java/com/google/gerrit/server/index/change/ChangeIndexer.java
@@ -47,6 +47,7 @@ import java.util.Collection; import java.util.Collections; import java.util.List; +import java.util.Map; import java.util.Set; import java.util.concurrent.Callable; import java.util.concurrent.ConcurrentHashMap; @@ -81,8 +82,7 @@ private final boolean autoReindexIfStale; private final IsFirstInsertForEntry isFirstInsertForEntry; - private final Set<IndexTask> queuedIndexTasks = - Collections.newSetFromMap(new ConcurrentHashMap<>()); + private final Map<Change.Id, IndexTask> queuedIndexTasks = new ConcurrentHashMap<>(); private final Set<ReindexIfStaleTask> queuedReindexIfStaleTasks = Collections.newSetFromMap(new ConcurrentHashMap<>()); @@ -143,16 +143,44 @@ /** * Start indexing a change. * - * @param id change to index. + * @param changeId change to index. * @return future for the indexing task. */ - public ListenableFuture<?> indexAsync(Project.NameKey project, Change.Id id) { - IndexTask task = new IndexTask(project, id); - if (queuedIndexTasks.add(task)) { - fireChangeScheduledForIndexingEvent(project.get(), id.get()); - return submit(task); - } - return Futures.immediateFuture(null); + public ListenableFuture<ChangeData> indexAsync(Project.NameKey project, Change.Id changeId) { + // If the change was already scheduled for indexing, we do not need to schedule it again. Change + // updates that happened after the change was scheduled for indexing will automatically be taken + // into account when the index task is executed (as it reads the current change state). + // To skip duplicate index requests, queuedIndexTasks keeps track of the scheduled index tasks. + // Here we check if the change has already been scheduled for indexing, and only if not we + // create a new index task for the change. + // By using computeIfAbsent we ensure that the lookup and the insertion of a new task happens + // atomically. Some attempted update operations on this map by other threads may be blocked + // while the computation is in progress (but not all as ConcurrentHashMap doesn't lock the + // entire table on write, but only segments of the table). + IndexTask task = + queuedIndexTasks.computeIfAbsent( + changeId, + id -> { + fireChangeScheduledForIndexingEvent(project.get(), id.get()); + return new IndexTask(project, id); + }); + // Submitting the task to the executor must not happen from within the computeIfAbsent callback, + // as this could result in the task being executed before the computeIfAbsent method has + // finished (e.g. if a direct executor is used, but also if starting the task asynchronously is + // faster than finishing the computeIfAbsent method). This could lead to failures and unexpected + // behavior: + // * The first thing that IndexTask does is to remove itself from queuedIndexTasks. + // This is done so that index requests which are received while an index task for the same + // change is in progress, are not dropped but added to the queue. This is important since + // the change state that is written to the index is read at the beginning of the index task + // and change updates that happen after this read will not be considered when updating the + // index. + // * Trying to remove the IndexTask from queuedIndexTasks at the beginning of the task doesn't + // work if the computeIfAbsent method hasn't finished yet. Either the queuedIndexTasks doesn't + // contain the new entry yet and the removal has no effect as it is done before the entry is + // added to the map, or the removal fails with {@link IllegalStateException} as recursive + // updates from within the computeIfAbsent callback are not allowed. + return task.submitIfNeeded(); } /** @@ -161,8 +189,9 @@ * @param ids changes to index. * @return future for completing indexing of all changes. */ - public ListenableFuture<?> indexAsync(Project.NameKey project, Collection<Change.Id> ids) { - List<ListenableFuture<?>> futures = new ArrayList<>(ids.size()); + public ListenableFuture<List<ChangeData>> indexAsync( + Project.NameKey project, Collection<Change.Id> ids) { + List<ListenableFuture<ChangeData>> futures = new ArrayList<>(ids.size()); for (Change.Id id : ids) { futures.add(indexAsync(project, id)); } @@ -214,7 +243,7 @@ .patchSetId(cd.currentPatchSet().number()) .indexVersion(i.getSchema().getVersion()) .build())) { - if (isFirstInsertForEntry.equals(isFirstInsertForEntry.YES)) { + if (isFirstInsertForEntry.equals(IsFirstInsertForEntry.YES)) { i.insert(cd); } else { i.replace(cd); @@ -269,9 +298,9 @@ * Start deleting a change. * * @param id change to delete. - * @return future for the deleting task. + * @return future for the deleting task, the result of the future is always {@code null} */ - public ListenableFuture<?> deleteAsync(Change.Id id) { + public ListenableFuture<ChangeData> deleteAsync(Change.Id id) { fireChangeScheduledForDeletionFromIndexEvent(id.get()); return submit(new DeleteTask(id)); } @@ -369,17 +398,46 @@ } } - private class IndexTask extends AbstractIndexTask<Void> { + private class IndexTask extends AbstractIndexTask<ChangeData> { + ListenableFuture<ChangeData> future; + private IndexTask(Project.NameKey project, Change.Id id) { super(project, id); } + /** + * Submits this task to be executed, if it wasn't submitted yet. + * + * <p>Submits this task to the executor if it hasn't been submitted yet. The future is cached so + * that it can be returned if this method is called again. + * + * <p>This method must be synchronized so that concurrent calls do not submit this task to the + * executor multiple times. + * + * @return future from which the result of the index task (the {@link ChangeData} instance) can + * be retrieved. + */ + private synchronized ListenableFuture<ChangeData> submitIfNeeded() { + if (future == null) { + future = submit(this); + } + return future; + } + @Override - public Void callImpl() throws Exception { + public ChangeData callImpl() throws Exception { + // Remove this task from queuedIndexTasks. This is done right at the beginning of this task so + // that index requests which are received for the same change while this index task is in + // progress, are not dropped but added to the queue. This is important since change updates + // that happen after reading the change notes below will not be considered when updating the + // index. remove(); + try { ChangeNotes changeNotes = notesFactory.createChecked(project, id); - doIndex(changeDataFactory.create(changeNotes)); + ChangeData changeData = changeDataFactory.create(changeNotes); + doIndex(changeData); + return changeData; } catch (NoSuchChangeException e) { doDelete(id); } @@ -407,12 +465,12 @@ @Override protected void remove() { - queuedIndexTasks.remove(this); + queuedIndexTasks.remove(id); } } // Not AbstractIndexTask as it doesn't need a request context. - private class DeleteTask implements Callable<Void> { + private class DeleteTask implements Callable<ChangeData> { private final Change.Id id; private DeleteTask(Change.Id id) { @@ -420,7 +478,7 @@ } @Override - public Void call() { + public ChangeData call() { logger.atFine().log("Delete change %d from index.", id.get()); // Don't bother setting a RequestContext to provide the DB. // Implementations should not need to access the DB in order to delete a
diff --git a/java/com/google/gerrit/server/index/change/ChangeSchemaDefinitions.java b/java/com/google/gerrit/server/index/change/ChangeSchemaDefinitions.java index 969b071..9339d62 100644 --- a/java/com/google/gerrit/server/index/change/ChangeSchemaDefinitions.java +++ b/java/com/google/gerrit/server/index/change/ChangeSchemaDefinitions.java
@@ -135,9 +135,57 @@ new Schema.Builder<ChangeData>().add(V59).add(ChangeField.MERGE).build(); /** Added new field {@link ChangeField#MERGED_ON} */ + @Deprecated static final Schema<ChangeData> V61 = new Schema.Builder<ChangeData>().add(V60).add(ChangeField.MERGED_ON).build(); + /** Added new field {@link ChangeField#FUZZY_HASHTAG} */ + @Deprecated + static final Schema<ChangeData> V62 = + new Schema.Builder<ChangeData>().add(V61).add(ChangeField.FUZZY_HASHTAG).build(); + + /** + * The computation of the {@link ChangeField#DIRECTORY} field is changed, hence reindexing is + * required. + */ + @Deprecated static final Schema<ChangeData> V63 = schema(V62, false); + + /** Added support for MIN/MAX/ANY for {@link ChangeField#LABEL} */ + @Deprecated static final Schema<ChangeData> V64 = schema(V63, false); + + /** Added new field for submit requirements. */ + @Deprecated + static final Schema<ChangeData> V65 = + new Schema.Builder<ChangeData>().add(V64).add(ChangeField.STORED_SUBMIT_REQUIREMENTS).build(); + + /** + * The computation of {@link ChangeField#LABEL} has changed: We added the non_uploader arg to the + * label field. + */ + @Deprecated static final Schema<ChangeData> V66 = schema(V65, false); + + /** Updated submit records: store the rule name that created the submit record. */ + @Deprecated static final Schema<ChangeData> V67 = schema(V66, false); + + /** Added new field {@link ChangeField#SUBMIT_RULE_RESULT}. */ + @Deprecated + static final Schema<ChangeData> V68 = + new Schema.Builder<ChangeData>().add(V67).add(ChangeField.SUBMIT_RULE_RESULT).build(); + + /** Added new field {@link ChangeField#CHERRY_PICK}. */ + @Deprecated + static final Schema<ChangeData> V69 = + new Schema.Builder<ChangeData>().add(V68).add(ChangeField.CHERRY_PICK).build(); + + /** Added new field {@link ChangeField#ATTENTION_SET_USERS_COUNT}. */ + @Deprecated + static final Schema<ChangeData> V70 = + new Schema.Builder<ChangeData>().add(V69).add(ChangeField.ATTENTION_SET_USERS_COUNT).build(); + + /** Added new field {@link ChangeField#UPLOADER}. */ + static final Schema<ChangeData> V71 = + new Schema.Builder<ChangeData>().add(V70).add(ChangeField.UPLOADER).build(); + /** * Name of the change index to be used when contacting index backends or loading configurations. */
diff --git a/java/com/google/gerrit/server/index/change/ReindexAfterRefUpdate.java b/java/com/google/gerrit/server/index/change/ReindexAfterRefUpdate.java index e39873e..49f6ff9 100644 --- a/java/com/google/gerrit/server/index/change/ReindexAfterRefUpdate.java +++ b/java/com/google/gerrit/server/index/change/ReindexAfterRefUpdate.java
@@ -87,11 +87,14 @@ @Override public void onGitReferenceUpdated(Event event) { - if (allUsersName.get().equals(event.getProjectName())) { + if (allUsersName.get().equals(event.getProjectName()) + && !RefNames.REFS_CONFIG.equals(event.getRefName())) { Account.Id accountId = Account.Id.fromRef(event.getRefName()); if (accountId != null && !event.getRefName().startsWith(RefNames.REFS_STARRED_CHANGES)) { indexer.get().index(accountId); } + // The update is in All-Users and not on refs/meta/config. So it's not a change. Return early. + return; } if (!enabled
diff --git a/java/com/google/gerrit/server/index/group/AllGroupsIndexer.java b/java/com/google/gerrit/server/index/group/AllGroupsIndexer.java index 075a4ce..3773d435 100644 --- a/java/com/google/gerrit/server/index/group/AllGroupsIndexer.java +++ b/java/com/google/gerrit/server/index/group/AllGroupsIndexer.java
@@ -103,7 +103,7 @@ groupCache.evict(uuid); InternalGroup internalGroup = reindexedGroups.get(uuid); if (internalGroup != null) { - if (isFirstInsertForEntry.equals(isFirstInsertForEntry.YES)) { + if (isFirstInsertForEntry.equals(IsFirstInsertForEntry.YES)) { index.insert(internalGroup); } else { index.replace(internalGroup);
diff --git a/java/com/google/gerrit/server/index/group/IndexedGroupQuery.java b/java/com/google/gerrit/server/index/group/IndexedGroupQuery.java index 8b0f1f8..1602e4d2 100644 --- a/java/com/google/gerrit/server/index/group/IndexedGroupQuery.java +++ b/java/com/google/gerrit/server/index/group/IndexedGroupQuery.java
@@ -14,6 +14,8 @@ package com.google.gerrit.server.index.group; +import static com.google.common.base.Preconditions.checkState; + import com.google.gerrit.entities.AccountGroup; import com.google.gerrit.entities.InternalGroup; import com.google.gerrit.index.Index; @@ -21,6 +23,7 @@ import com.google.gerrit.index.QueryOptions; import com.google.gerrit.index.query.DataSource; import com.google.gerrit.index.query.IndexedQuery; +import com.google.gerrit.index.query.Matchable; import com.google.gerrit.index.query.Predicate; import com.google.gerrit.index.query.QueryParseException; import java.util.HashSet; @@ -31,7 +34,7 @@ * com.google.gerrit.index.IndexRewriter}. See {@link IndexedQuery}. */ public class IndexedGroupQuery extends IndexedQuery<AccountGroup.UUID, InternalGroup> - implements DataSource<InternalGroup> { + implements DataSource<InternalGroup>, Matchable<InternalGroup> { public static QueryOptions createOptions( IndexConfig config, int start, int pageSize, int limit, Set<String> fields) { @@ -50,4 +53,20 @@ throws QueryParseException { super(index, pred, opts.convertForBackend()); } + + @Override + public boolean match(InternalGroup object) { + Predicate<InternalGroup> pred = getChild(0); + checkState( + pred.isMatchable(), + "match invoked, but child predicate %s doesn't implement %s", + pred, + Matchable.class.getName()); + return pred.asMatchable().match(object); + } + + @Override + public int getCost() { + return 1; + } }
diff --git a/java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java b/java/com/google/gerrit/server/index/options/BuildBloomFilter.java similarity index 69% rename from java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java rename to java/com/google/gerrit/server/index/options/BuildBloomFilter.java index 6451b0f..021f0fe 100644 --- a/java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java +++ b/java/com/google/gerrit/server/index/options/BuildBloomFilter.java
@@ -1,4 +1,4 @@ -// Copyright (C) 2018 The Android Open Source Project +// Copyright (C) 2023 The Android Open Source Project // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,11 +12,10 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.elasticsearch.bulk; +package com.google.gerrit.server.index.options; -public class DeleteRequest extends ActionRequest { - - public DeleteRequest(String id, String index) { - super("delete", id, index); - } +/** This enum can be used to decide if bloom filters for H2 disk caches should be built. */ +public enum BuildBloomFilter { + TRUE, + FALSE }
diff --git a/java/com/google/gerrit/server/index/project/AllProjectsIndexer.java b/java/com/google/gerrit/server/index/project/AllProjectsIndexer.java index 86c7e94..1c977d1 100644 --- a/java/com/google/gerrit/server/index/project/AllProjectsIndexer.java +++ b/java/com/google/gerrit/server/index/project/AllProjectsIndexer.java
@@ -86,7 +86,7 @@ projectCache.evict(name); ProjectData projectData = projectCache.get(name).orElseThrow(illegalState(name)).toProjectData(); - if (isFirstInsertForEntry.equals(isFirstInsertForEntry.YES)) { + if (isFirstInsertForEntry.equals(IsFirstInsertForEntry.YES)) { index.insert(projectData); } else { index.replace(projectData);
diff --git a/java/com/google/gerrit/server/ioutil/HostPlatform.java b/java/com/google/gerrit/server/ioutil/HostPlatform.java index 39e9c07..e27d17c 100644 --- a/java/com/google/gerrit/server/ioutil/HostPlatform.java +++ b/java/com/google/gerrit/server/ioutil/HostPlatform.java
@@ -21,7 +21,7 @@ private static final boolean win32 = compute("windows"); private static final boolean mac = compute("mac"); - /** @return true if this JVM is running on a Windows platform. */ + /** Returns true if this JVM is running on a Windows platform. */ public static boolean isWin32() { return win32; }
diff --git a/java/com/google/gerrit/server/ioutil/LimitedByteArrayOutputStream.java b/java/com/google/gerrit/server/ioutil/LimitedByteArrayOutputStream.java index 015887b..a58d9ae 100644 --- a/java/com/google/gerrit/server/ioutil/LimitedByteArrayOutputStream.java +++ b/java/com/google/gerrit/server/ioutil/LimitedByteArrayOutputStream.java
@@ -57,7 +57,7 @@ buffer.write(b, off, len); } - /** @return a newly allocated byte array with contents of the buffer. */ + /** Returns a newly allocated byte array with contents of the buffer. */ public byte[] toByteArray() { return buffer.toByteArray(); }
diff --git a/java/com/google/gerrit/server/logging/BUILD b/java/com/google/gerrit/server/logging/BUILD index c60af0d..ee0168c 100644 --- a/java/com/google/gerrit/server/logging/BUILD +++ b/java/com/google/gerrit/server/logging/BUILD
@@ -9,6 +9,7 @@ deps = [ "//java/com/google/gerrit/common:annotations", "//java/com/google/gerrit/extensions:api", + "//java/com/google/gerrit/server/cancellation", "//java/com/google/gerrit/server/util/time", "//lib:gson", "//lib:guava",
diff --git a/java/com/google/gerrit/server/logging/CallerFinder.java b/java/com/google/gerrit/server/logging/CallerFinder.java index bd7e608..4cb4b7f 100644 --- a/java/com/google/gerrit/server/logging/CallerFinder.java +++ b/java/com/google/gerrit/server/logging/CallerFinder.java
@@ -41,7 +41,7 @@ * * <p>E.g. the stacktrace could look like this: * - * <pre> + * <pre>{@code * GroupQueryProcessor(QueryProcessor<T>).query(List<String>, List<Predicate<T>>) line: 216 * GroupQueryProcessor(QueryProcessor<T>).query(List<Predicate<T>>) line: 188 * GroupQueryProcessor(QueryProcessor<T>).query(Predicate<T>) line: 171 @@ -52,7 +52,7 @@ * GroupCacheImpl$ByNameLoader.load(Object) line: 1 * LocalCache$LoadingValueReference<K,V>.loadFuture(K, CacheLoader<? super K,V>) line: 3527 * ... - * </pre> + * }</pre> * * <p>The first interesting caller is {@code GroupCacheImpl$ByNameLoader.load(String) line: 166}. To * find this caller from the stacktrace we could specify {@link
diff --git a/java/com/google/gerrit/server/logging/LoggingContext.java b/java/com/google/gerrit/server/logging/LoggingContext.java index 35594e9..eac96a6 100644 --- a/java/com/google/gerrit/server/logging/LoggingContext.java +++ b/java/com/google/gerrit/server/logging/LoggingContext.java
@@ -19,7 +19,7 @@ import com.google.common.base.MoreObjects; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSetMultimap; -import com.google.common.flogger.backend.Tags; +import com.google.common.flogger.context.Tags; import com.google.inject.Provider; import java.util.List; import java.util.concurrent.Callable;
diff --git a/java/com/google/gerrit/server/logging/LoggingContextAwareRunnable.java b/java/com/google/gerrit/server/logging/LoggingContextAwareRunnable.java index 3c4c563..1bba018 100644 --- a/java/com/google/gerrit/server/logging/LoggingContextAwareRunnable.java +++ b/java/com/google/gerrit/server/logging/LoggingContextAwareRunnable.java
@@ -28,24 +28,24 @@ * * <p>Example: * - * <pre> - * try (TraceContext traceContext = TraceContext.newTrace(true, ...)) { - * executor - * .submit(new LoggingContextAwareRunnable( - * () -> { - * // Tracing is enabled since the runnable is created within the TraceContext. - * // Tracing is even enabled if the executor runs the runnable only after the - * // TraceContext was closed. + * <pre>{@code + * try (TraceContext traceContext = TraceContext.newTrace(true, ...)) { + * executor + * .submit(new LoggingContextAwareRunnable( + * () -> { + * // Tracing is enabled since the runnable is created within the TraceContext. + * // Tracing is even enabled if the executor runs the runnable only after the + * // TraceContext was closed. * - * // The tag "foo=bar" is not set, since it was added to the logging context only - * // after this runnable was created. + * // The tag "foo=bar" is not set, since it was added to the logging context only + * // after this runnable was created. * - * // do stuff - * })) - * .get(); - * traceContext.addTag("foo", "bar"); - * } - * </pre> + * // do stuff + * })) + * .get(); + * traceContext.addTag("foo", "bar"); + * } + * }</pre> * * @see LoggingContextAwareCallable */
diff --git a/java/com/google/gerrit/server/logging/Metadata.java b/java/com/google/gerrit/server/logging/Metadata.java index 71ee01f..89b5b46 100644 --- a/java/com/google/gerrit/server/logging/Metadata.java +++ b/java/com/google/gerrit/server/logging/Metadata.java
@@ -55,6 +55,12 @@ /** The name of the implementation class. */ public abstract Optional<String> className(); + /** + * The reason of a request cancellation (CLIENT_CLOSED_REQUEST, CLIENT_PROVIDED_DEADLINE_EXCEEDED, + * SERVER_DEADLINE_EXCEEDED). + */ + public abstract Optional<String> cancellationReason(); + /** The numeric ID of a change. */ public abstract Optional<Integer> changeId(); @@ -66,9 +72,15 @@ /** The cause of an error. */ public abstract Optional<String> cause(); + /** Side where the comment is written: <= 0 for parent, 1 for revision. */ + public abstract Optional<Integer> commentSide(); + /** The SHA1 of a commit. */ public abstract Optional<String> commit(); + /** Diff algorithm used in diff computation. */ + public abstract Optional<String> diffAlgorithm(); + /** The type of an event. */ public abstract Optional<String> eventType(); @@ -144,6 +156,9 @@ /** The type of a Git push to Gerrit (CREATE_REPLACE, NORMAL, AUTOCLOSE). */ public abstract Optional<String> pushType(); + /** The type of a Git push to Gerrit (GIT_RECEIVE, GIT_UPLOAD, REST, SSH). */ + public abstract Optional<String> requestType(); + /** The number of resources that is processed. */ public abstract Optional<Integer> resourceCount(); @@ -167,17 +182,18 @@ * <pre> * Metadata{accountId=Optional.empty, actionType=Optional.empty, authDomainName=Optional.empty, * branchName=Optional.empty, cacheKey=Optional.empty, cacheName=Optional.empty, - * className=Optional.empty, changeId=Optional[9212550], changeIdType=Optional.empty, - * cause=Optional.empty, eventType=Optional.empty, exportValue=Optional.empty, - * filePath=Optional.empty, garbageCollectorName=Optional.empty, gitOperation=Optional.empty, - * groupId=Optional.empty, groupName=Optional.empty, groupUuid=Optional.empty, - * httpStatus=Optional.empty, indexName=Optional.empty, indexVersion=Optional[0], - * methodName=Optional.empty, multiple=Optional.empty, operationName=Optional.empty, - * partial=Optional.empty, noteDbFilePath=Optional.empty, noteDbRefName=Optional.empty, + * className=Optional.empty, cancellationReason=Optional.empty changeId=Optional[9212550], + * changeIdType=Optional.empty, cause=Optional.empty, diffAlgorithm=Optional.empty, + * eventType=Optional.empty, exportValue=Optional.empty, filePath=Optional.empty, + * garbageCollectorName=Optional.empty, gitOperation=Optional.empty, groupId=Optional.empty, + * groupName=Optional.empty, groupUuid=Optional.empty, httpStatus=Optional.empty, + * indexName=Optional.empty, indexVersion=Optional[0], methodName=Optional.empty, + * multiple=Optional.empty, operationName=Optional.empty, partial=Optional.empty, + * noteDbFilePath=Optional.empty, noteDbRefName=Optional.empty, * noteDbSequenceType=Optional.empty, patchSetId=Optional.empty, pluginMetadata=[], * pluginName=Optional.empty, projectName=Optional.empty, pushType=Optional.empty, - * resourceCount=Optional.empty, restViewName=Optional.empty, revision=Optional.empty, - * username=Optional.empty} + * requestType=Optional.empty, resourceCount=Optional.empty, restViewName=Optional.empty, + * revision=Optional.empty, username=Optional.empty} * </pre> * * <p>That's hard to read in logs. This is why this method @@ -282,14 +298,20 @@ public abstract Builder className(@Nullable String className); + public abstract Builder cancellationReason(@Nullable String cancellationReason); + public abstract Builder changeId(int changeId); public abstract Builder changeIdType(@Nullable String changeIdType); public abstract Builder cause(@Nullable String cause); + public abstract Builder commentSide(int side); + public abstract Builder commit(@Nullable String commit); + public abstract Builder diffAlgorithm(@Nullable String diffAlgorithm); + public abstract Builder eventType(@Nullable String eventType); public abstract Builder exportValue(@Nullable String exportValue); @@ -345,6 +367,8 @@ public abstract Builder pushType(@Nullable String pushType); + public abstract Builder requestType(@Nullable String requestType); + public abstract Builder resourceCount(int resourceCount); public abstract Builder restViewName(@Nullable String restViewName);
diff --git a/java/com/google/gerrit/server/logging/MutableTags.java b/java/com/google/gerrit/server/logging/MutableTags.java index 83009a6..3f48b59 100644 --- a/java/com/google/gerrit/server/logging/MutableTags.java +++ b/java/com/google/gerrit/server/logging/MutableTags.java
@@ -20,7 +20,7 @@ import com.google.common.collect.ImmutableSetMultimap; import com.google.common.collect.MultimapBuilder; import com.google.common.collect.SetMultimap; -import com.google.common.flogger.backend.Tags; +import com.google.common.flogger.context.Tags; public class MutableTags { private final SetMultimap<String, String> tagMap =
diff --git a/java/com/google/gerrit/server/logging/PerformanceLogContext.java b/java/com/google/gerrit/server/logging/PerformanceLogContext.java index b6dafdc..90e716f 100644 --- a/java/com/google/gerrit/server/logging/PerformanceLogContext.java +++ b/java/com/google/gerrit/server/logging/PerformanceLogContext.java
@@ -56,7 +56,7 @@ // Do not create performance log entries if performance logging is disabled or if no // PerformanceLogger is registered. boolean enablePerformanceLogging = - gerritConfig.getBoolean("tracing", "performanceLogging", true); + gerritConfig.getBoolean("tracing", "performanceLogging", false); LoggingContext.getInstance() .performanceLogging( enablePerformanceLogging && !Iterables.isEmpty(performanceLoggers.entries())); @@ -92,7 +92,7 @@ p -> { try (TraceContext traceContext = newPluginTrace(p)) { performanceLogRecords.forEach(r -> r.writeTo(p.get())); - } catch (Throwable e) { + } catch (RuntimeException e) { logger.atWarning().withCause(e).log( "Failure in %s of plugin %s", p.get().getClass(), p.getPluginName()); }
diff --git a/java/com/google/gerrit/server/logging/TraceContext.java b/java/com/google/gerrit/server/logging/TraceContext.java index 2fc19b5..487e0af 100644 --- a/java/com/google/gerrit/server/logging/TraceContext.java +++ b/java/com/google/gerrit/server/logging/TraceContext.java
@@ -24,6 +24,7 @@ import com.google.common.collect.Table; import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; +import com.google.gerrit.server.cancellation.RequestStateContext; import java.util.Optional; import java.util.concurrent.TimeUnit; import java.util.function.Consumer; @@ -208,6 +209,7 @@ } private TraceTimer(Runnable startLogFn, Consumer<Long> doneLogFn) { + RequestStateContext.abortIfCancelled(); startLogFn.run(); this.doneLogFn = doneLogFn; this.stopwatch = Stopwatch.createStarted(); @@ -217,6 +219,7 @@ public void close() { stopwatch.stop(); doneLogFn.accept(stopwatch.elapsed(TimeUnit.MILLISECONDS)); + RequestStateContext.abortIfCancelled(); } } @@ -265,15 +268,23 @@ return this; } - public boolean isTracing() { + public static boolean isTracing() { return LoggingContext.getInstance().isLoggingForced(); } - public Optional<String> getTraceId() { + public static Optional<String> getTraceId() { return LoggingContext.getInstance().getTagsAsMap().get(RequestId.Type.TRACE_ID.name()).stream() .findFirst(); } + public static Optional<String> getPluginTag() { + return getTag(PLUGIN_TAG); + } + + public static Optional<String> getTag(String tagName) { + return LoggingContext.getInstance().getTagsAsMap().get(tagName).stream().findFirst(); + } + public TraceContext enableAclLogging() { if (stopAclLoggingOnClose) { return this; @@ -283,11 +294,7 @@ return this; } - public boolean isAclLoggingEnabled() { - return LoggingContext.getInstance().isAclLogging(); - } - - public ImmutableList<String> getAclLogRecords() { + public static ImmutableList<String> getAclLogRecords() { return LoggingContext.getInstance().getAclLogRecords(); }
diff --git a/java/com/google/gerrit/server/mail/EmailModule.java b/java/com/google/gerrit/server/mail/EmailModule.java index ff166b1..c659b5f 100644 --- a/java/com/google/gerrit/server/mail/EmailModule.java +++ b/java/com/google/gerrit/server/mail/EmailModule.java
@@ -17,7 +17,6 @@ import com.google.gerrit.extensions.config.FactoryModule; import com.google.gerrit.server.mail.send.AbandonedSender; import com.google.gerrit.server.mail.send.AddKeySender; -import com.google.gerrit.server.mail.send.AddReviewerSender; import com.google.gerrit.server.mail.send.AddToAttentionSetSender; import com.google.gerrit.server.mail.send.CommentSender; import com.google.gerrit.server.mail.send.CreateChangeSender; @@ -26,6 +25,7 @@ import com.google.gerrit.server.mail.send.DeleteVoteSender; import com.google.gerrit.server.mail.send.HttpPasswordUpdateSender; import com.google.gerrit.server.mail.send.MergedSender; +import com.google.gerrit.server.mail.send.ModifyReviewerSender; import com.google.gerrit.server.mail.send.RegisterNewEmailSender; import com.google.gerrit.server.mail.send.RemoveFromAttentionSetSender; import com.google.gerrit.server.mail.send.ReplacePatchSetSender; @@ -38,7 +38,7 @@ protected void configure() { factory(AbandonedSender.Factory.class); factory(AddKeySender.Factory.class); - factory(AddReviewerSender.Factory.class); + factory(ModifyReviewerSender.Factory.class); factory(CommentSender.Factory.class); factory(CreateChangeSender.Factory.class); factory(DeleteKeySender.Factory.class);
diff --git a/java/com/google/gerrit/server/mail/EmailTokenVerifier.java b/java/com/google/gerrit/server/mail/EmailTokenVerifier.java index 2ff5fc3..ead4c06 100644 --- a/java/com/google/gerrit/server/mail/EmailTokenVerifier.java +++ b/java/com/google/gerrit/server/mail/EmailTokenVerifier.java
@@ -56,10 +56,13 @@ class ParsedToken { private final Account.Id accountId; private final String emailAddress; + private final AuthRequest.Factory authRequestFactory; - public ParsedToken(Account.Id accountId, String emailAddress) { + public ParsedToken( + Account.Id accountId, String emailAddress, AuthRequest.Factory authRequestFactory) { this.accountId = accountId; this.emailAddress = emailAddress; + this.authRequestFactory = authRequestFactory; } public Account.Id getAccountId() { @@ -71,7 +74,7 @@ } public AuthRequest toAuthRequest() { - return AuthRequest.forEmail(getEmailAddress()); + return authRequestFactory.createForEmail(getEmailAddress()); } @Override
diff --git a/java/com/google/gerrit/server/mail/SignedTokenEmailTokenVerifier.java b/java/com/google/gerrit/server/mail/SignedTokenEmailTokenVerifier.java index 77be665..36e801b 100644 --- a/java/com/google/gerrit/server/mail/SignedTokenEmailTokenVerifier.java +++ b/java/com/google/gerrit/server/mail/SignedTokenEmailTokenVerifier.java
@@ -19,6 +19,7 @@ import com.google.common.io.BaseEncoding; import com.google.gerrit.entities.Account; +import com.google.gerrit.server.account.AuthRequest; import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.server.mail.send.RegisterNewEmailSender; import com.google.inject.AbstractModule; @@ -31,8 +32,9 @@ @Singleton public class SignedTokenEmailTokenVerifier implements EmailTokenVerifier { private final SignedToken emailRegistrationToken; + private final AuthRequest.Factory authRequestFactory; - public static class Module extends AbstractModule { + public static class SignedTokenEmailTokenVerifierModule extends AbstractModule { @Override protected void configure() { bind(EmailTokenVerifier.class).to(SignedTokenEmailTokenVerifier.class); @@ -40,8 +42,9 @@ } @Inject - SignedTokenEmailTokenVerifier(AuthConfig config) { + SignedTokenEmailTokenVerifier(AuthConfig config, AuthRequest.Factory authRequestFactory) { emailRegistrationToken = config.getEmailRegistrationToken(); + this.authRequestFactory = authRequestFactory; } @Override @@ -77,7 +80,7 @@ } Account.Id id = Account.Id.tryParse(matcher.group(1)).orElseThrow(InvalidTokenException::new); String newEmail = matcher.group(2); - return new ParsedToken(id, newEmail); + return new ParsedToken(id, newEmail, authRequestFactory); } private void checkEmailRegistrationToken() {
diff --git a/java/com/google/gerrit/server/mail/receive/MailProcessor.java b/java/com/google/gerrit/server/mail/receive/MailProcessor.java index df38118..0710784 100644 --- a/java/com/google/gerrit/server/mail/receive/MailProcessor.java +++ b/java/com/google/gerrit/server/mail/receive/MailProcessor.java
@@ -14,6 +14,7 @@ package com.google.gerrit.server.mail.receive; +import static com.google.gerrit.entities.Patch.PATCHSET_LEVEL; import static java.util.stream.Collectors.toList; import com.google.common.base.Strings; @@ -23,7 +24,6 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.HumanComment; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; @@ -44,7 +44,6 @@ import com.google.gerrit.mail.MailMessage; import com.google.gerrit.mail.MailMetadata; import com.google.gerrit.mail.TextParser; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.CommentsUtil; import com.google.gerrit.server.PatchSetUtil; @@ -52,11 +51,13 @@ import com.google.gerrit.server.account.AccountCache; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.account.Emails; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.EmailReviewComments; import com.google.gerrit.server.config.UrlFormatter; import com.google.gerrit.server.extensions.events.CommentAdded; import com.google.gerrit.server.mail.MailFilter; import com.google.gerrit.server.mail.send.InboundEmailRejectionSender; +import com.google.gerrit.server.mail.send.InboundEmailRejectionSender.InboundEmailError; import com.google.gerrit.server.mail.send.MessageIdGenerator; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.plugincontext.PluginSetContext; @@ -65,7 +66,7 @@ import com.google.gerrit.server.update.BatchUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.RetryHelper; import com.google.gerrit.server.update.UpdateException; import com.google.gerrit.server.util.ManualRequestContext; @@ -92,7 +93,7 @@ private static final ImmutableMap<MailComment.CommentType, CommentForValidation.CommentType> MAIL_COMMENT_TYPE_TO_VALIDATION_TYPE = ImmutableMap.of( - MailComment.CommentType.CHANGE_MESSAGE, + MailComment.CommentType.PATCHSET_LEVEL, CommentForValidation.CommentType.CHANGE_MESSAGE, MailComment.CommentType.FILE_COMMENT, CommentForValidation.CommentType.FILE_COMMENT, MailComment.CommentType.INLINE_COMMENT, @@ -184,7 +185,7 @@ logger.atSevere().log( "Message %s is missing required metadata, have %s. Will delete message.", message.id(), metadata); - sendRejectionEmail(message, InboundEmailRejectionSender.Error.PARSING_ERROR); + sendRejectionEmail(message, InboundEmailError.PARSING_ERROR); return; } @@ -198,7 +199,7 @@ // We don't want to send an email if no accounts are linked to it. if (accountIds.size() > 1) { - sendRejectionEmail(message, InboundEmailRejectionSender.Error.UNKNOWN_ACCOUNT); + sendRejectionEmail(message, InboundEmailError.UNKNOWN_ACCOUNT); } return; } @@ -210,14 +211,14 @@ } if (!accountState.get().account().isActive()) { logger.atWarning().log("Mail: Account %s is inactive. Will delete message.", accountId); - sendRejectionEmail(message, InboundEmailRejectionSender.Error.INACTIVE_ACCOUNT); + sendRejectionEmail(message, InboundEmailError.INACTIVE_ACCOUNT); return; } persistComments(buf, message, metadata, accountId); } - private void sendRejectionEmail(MailMessage message, InboundEmailRejectionSender.Error reason) { + private void sendRejectionEmail(MailMessage message, InboundEmailError reason) { try { InboundEmailRejectionSender emailSender = emailRejectionSender.create(message.from(), message.id(), reason); @@ -233,7 +234,14 @@ throws UpdateException, RestApiException { try (ManualRequestContext ctx = oneOffRequestContext.openAs(sender)) { List<ChangeData> changeDataList = - queryProvider.get().byLegacyChangeId(Change.id(metadata.changeNumber)); + queryProvider + .get() + .enforceVisibility(true) + .byLegacyChangeId(Change.id(metadata.changeNumber)); + if (changeDataList.isEmpty()) { + sendRejectionEmail(message, InboundEmailError.CHANGE_NOT_FOUND); + return; + } if (changeDataList.size() != 1) { logger.atSevere().log( "Message %s references unique change %s," @@ -241,7 +249,7 @@ + " Will delete message.", message.id(), metadata.changeNumber, changeDataList.size()); - sendRejectionEmail(message, InboundEmailRejectionSender.Error.INTERNAL_EXCEPTION); + sendRejectionEmail(message, InboundEmailError.INTERNAL_EXCEPTION); return; } ChangeData cd = Iterables.getOnlyElement(changeDataList); @@ -277,7 +285,7 @@ if (parsedComments.isEmpty()) { logger.atWarning().log( "Could not parse any comments from %s. Will delete message.", message.id()); - sendRejectionEmail(message, InboundEmailRejectionSender.Error.PARSING_ERROR); + sendRejectionEmail(message, InboundEmailError.PARSING_ERROR); return; } @@ -298,7 +306,7 @@ PublishCommentUtil.findInvalidComments( commentValidationCtx, commentValidators, parsedCommentsForValidation); if (!commentValidationFailures.isEmpty()) { - sendRejectionEmail(message, InboundEmailRejectionSender.Error.COMMENT_REJECTED); + sendRejectionEmail(message, InboundEmailError.COMMENT_REJECTED); return; } @@ -313,7 +321,7 @@ private final PatchSet.Id psId; private final List<MailComment> parsedComments; private final String tag; - private ChangeMessage changeMessage; + private String mailMessage; private List<HumanComment> comments; private PatchSet patchSet; private ChangeNotes notes; @@ -332,14 +340,10 @@ throw new StorageException("patch set not found: " + psId); } - changeMessage = generateChangeMessage(ctx); - changeMessagesUtil.addChangeMessage(ctx.getUpdate(psId), changeMessage); - + mailMessage = + changeMessagesUtil.setChangeMessage(ctx.getUpdate(psId), generateChangeMessage(), tag); comments = new ArrayList<>(); for (MailComment c : parsedComments) { - if (c.getType() == MailComment.CommentType.CHANGE_MESSAGE) { - continue; - } comments.add( persistentCommentFromMailComment(ctx, c, targetPatchSetForComment(ctx, c, patchSet))); } @@ -352,9 +356,9 @@ } @Override - public void postUpdate(Context ctx) throws Exception { + public void postUpdate(PostUpdateContext ctx) throws Exception { String patchSetComment = null; - if (parsedComments.get(0).getType() == MailComment.CommentType.CHANGE_MESSAGE) { + if (parsedComments.get(0).getType() == MailComment.CommentType.PATCHSET_LEVEL) { patchSetComment = parsedComments.get(0).getMessage(); } // Send email notifications @@ -364,7 +368,8 @@ notes, patchSet, ctx.getUser().asIdentifiedUser(), - changeMessage, + mailMessage, + ctx.getWhen(), comments, patchSetComment, ImmutableList.of(), @@ -379,27 +384,19 @@ // Fire Gerrit event. Note that approvals can't be granted via email, so old and new approvals // are always the same here. commentAdded.fire( - notes.getChange(), + ctx.getChangeData(notes), patchSet, ctx.getAccount(), - changeMessage.getMessage(), + mailMessage, approvals, approvals, ctx.getWhen()); } - private ChangeMessage generateChangeMessage(ChangeContext ctx) { + private String generateChangeMessage() { String changeMsg = "Patch Set " + psId.get() + ":"; - if (parsedComments.get(0).getType() == MailComment.CommentType.CHANGE_MESSAGE) { - // Add a blank line after Patch Set to follow the default format - if (parsedComments.size() > 1) { - changeMsg += "\n\n" + numComments(parsedComments.size() - 1); - } - changeMsg += "\n\n" + parsedComments.get(0).getMessage(); - } else { - changeMsg += "\n\n" + numComments(parsedComments.size()); - } - return ChangeMessagesUtil.newMessage(ctx, changeMsg, tag); + changeMsg += "\n\n" + numComments(parsedComments.size()); + return changeMsg; } private PatchSet targetPatchSetForComment( @@ -418,7 +415,11 @@ // The patch set that this comment is based on is different if this // comment was sent in reply to a comment on a previous patch set. Side side; - if (mailComment.getInReplyTo() != null) { + if (mailComment.getType() == MailComment.CommentType.PATCHSET_LEVEL) { + fileName = PATCHSET_LEVEL; + // Patchset comments do not have side. + side = Side.REVISION; + } else if (mailComment.getInReplyTo() != null) { fileName = mailComment.getInReplyTo().key.filename; side = Side.fromShort(mailComment.getInReplyTo().side); } else {
diff --git a/java/com/google/gerrit/server/mail/receive/MailReceiver.java b/java/com/google/gerrit/server/mail/receive/MailReceiver.java index dc99b46..23e1cc3 100644 --- a/java/com/google/gerrit/server/mail/receive/MailReceiver.java +++ b/java/com/google/gerrit/server/mail/receive/MailReceiver.java
@@ -43,11 +43,11 @@ private WorkQueue workQueue; private Timer timer; - public static class Module extends LifecycleModule { + public static class MailReceiverModule extends LifecycleModule { private final EmailSettings mailSettings; @Inject - Module(EmailSettings mailSettings) { + MailReceiverModule(EmailSettings mailSettings) { this.mailSettings = mailSettings; } @@ -110,8 +110,6 @@ * requestDeletion will enqueue an email for deletion and delete it the next time we connect to * the email server. This does not guarantee deletion as the Gerrit instance might fail before we * connect to the email server. - * - * @param messageId */ public void requestDeletion(String messageId) { pendingDeletion.add(messageId);
diff --git a/java/com/google/gerrit/server/mail/send/ChangeEmail.java b/java/com/google/gerrit/server/mail/send/ChangeEmail.java index 81ce101..5c0132c 100644 --- a/java/com/google/gerrit/server/mail/send/ChangeEmail.java +++ b/java/com/google/gerrit/server/mail/send/ChangeEmail.java
@@ -41,11 +41,10 @@ import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.mail.send.ProjectWatch.Watchers; import com.google.gerrit.server.notedb.ReviewerStateInternal; -import com.google.gerrit.server.patch.PatchList; -import com.google.gerrit.server.patch.PatchListEntry; -import com.google.gerrit.server.patch.PatchListNotAvailableException; -import com.google.gerrit.server.patch.PatchListObjectTooLargeException; +import com.google.gerrit.server.patch.DiffNotAvailableException; +import com.google.gerrit.server.patch.FilePathAdapter; import com.google.gerrit.server.patch.PatchSetInfoNotAvailableException; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import com.google.gerrit.server.permissions.ChangePermission; import com.google.gerrit.server.permissions.GlobalPermission; import com.google.gerrit.server.permissions.PermissionBackendException; @@ -66,6 +65,7 @@ import org.apache.james.mime4j.dom.field.FieldName; import org.eclipse.jgit.diff.DiffFormatter; import org.eclipse.jgit.internal.JGitText; +import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.util.RawParseUtils; import org.eclipse.jgit.util.TemporaryBuffer; @@ -269,17 +269,23 @@ if (patchSet != null) { detail.append("---\n"); - PatchList patchList = getPatchList(); - for (PatchListEntry p : patchList.getPatches()) { - if (Patch.isMagic(p.getNewName())) { + Map<String, FileDiffOutput> modifiedFiles = listModifiedFiles(); + for (FileDiffOutput fileDiff : modifiedFiles.values()) { + if (fileDiff.newPath().isPresent() && Patch.isMagic(fileDiff.newPath().get())) { continue; } detail - .append(p.getChangeType().getCode()) + .append(fileDiff.changeType().getCode()) .append(" ") - .append(p.getNewName()) + .append( + FilePathAdapter.getNewPath( + fileDiff.oldPath(), fileDiff.newPath(), fileDiff.changeType())) .append("\n"); } + Integer insertions = + modifiedFiles.values().stream().map(FileDiffOutput::insertions).reduce(0, Integer::sum); + Integer deletions = + modifiedFiles.values().stream().map(FileDiffOutput::deletions).reduce(0, Integer::sum); detail.append( MessageFormat.format( "" // @@ -287,9 +293,9 @@ + "{1,choice,0#0 insertions|1#1 insertion|1<{1} insertions}(+), " // + "{2,choice,0#0 deletions|1#1 deletion|1<{2} deletions}(-)" // + "\n", - patchList.getPatches().size() - 1, // - patchList.getInsertions(), // - patchList.getDeletions())); + modifiedFiles.size() - 1, // + insertions, // + deletions)); detail.append("\n"); } return detail.toString(); @@ -300,7 +306,8 @@ } /** Get the patch list corresponding to patch set patchSetId of this change. */ - protected PatchList getPatchList(int patchSetId) throws PatchListNotAvailableException { + protected Map<String, FileDiffOutput> listModifiedFiles(int patchSetId) + throws DiffNotAvailableException { PatchSet ps; if (patchSetId == patchSet.number()) { ps = patchSet; @@ -308,18 +315,20 @@ try { ps = args.patchSetUtil.get(changeData.notes(), PatchSet.id(change.getId(), patchSetId)); } catch (StorageException e) { - throw new PatchListNotAvailableException("Failed to get patchSet", e); + throw new DiffNotAvailableException("Failed to get patchSet", e); } } - return args.patchListCache.get(change, ps); + return args.diffOperations.listModifiedFilesAgainstParent( + change.getProject(), ps.commitId(), /* parentNum= */ 0); } /** Get the patch list corresponding to this patch set. */ - protected PatchList getPatchList() throws PatchListNotAvailableException { + protected Map<String, FileDiffOutput> listModifiedFiles() throws DiffNotAvailableException { if (patchSet != null) { - return args.patchListCache.get(change, patchSet); + return args.diffOperations.listModifiedFilesAgainstParent( + change.getProject(), patchSet.commitId(), /* parentNum= */ 0); } - throw new PatchListNotAvailableException("no patchSet specified"); + throw new DiffNotAvailableException("no patchSet specified"); } /** Get the project entity the change is in; null if its been deleted. */ @@ -476,7 +485,7 @@ soyContext.put("coverLetter", getCoverLetter()); soyContext.put("fromName", getNameFor(fromId)); soyContext.put("fromEmail", getNameEmailFor(fromId)); - soyContext.put("diffLines", getDiffTemplateData()); + soyContext.put("diffLines", getDiffTemplateData(getUnifiedDiff())); soyContextEmailData.put("unifiedDiff", getUnifiedDiff()); soyContextEmailData.put("changeDetail", getChangeDetail()); @@ -576,18 +585,15 @@ /** Show patch set as unified difference. */ public String getUnifiedDiff() { - PatchList patchList; + Map<String, FileDiffOutput> modifiedFiles; try { - patchList = getPatchList(); - if (patchList.getOldId() == null) { + modifiedFiles = listModifiedFiles(); + if (modifiedFiles.isEmpty()) { // Octopus merges are not well supported for diff output by Gerrit. // Currently these always have a null oldId in the PatchList. return "[Octopus merge; cannot be formatted as a diff.]\n"; } - } catch (PatchListObjectTooLargeException e) { - logger.atWarning().log("Cannot format patch %s", e.getMessage()); - return ""; - } catch (PatchListNotAvailableException e) { + } catch (DiffNotAvailableException e) { logger.atSevere().withCause(e).log("Cannot format patch"); return ""; } @@ -597,9 +603,11 @@ try (DiffFormatter fmt = new DiffFormatter(buf)) { try (Repository git = args.server.openRepository(change.getProject())) { try { + ObjectId oldId = modifiedFiles.values().iterator().next().oldCommitId(); + ObjectId newId = modifiedFiles.values().iterator().next().newCommitId(); fmt.setRepository(git); fmt.setDetectRenames(true); - fmt.format(patchList.getOldId(), patchList.getNewId()); + fmt.format(oldId, newId); return RawParseUtils.decode(buf.toByteArray()); } catch (IOException e) { if (JGitText.get().inMemoryBufferLimitExceeded.equals(e.getMessage())) { @@ -619,11 +627,14 @@ * Generate a list of maps representing each line of the unified diff. The line maps will have a * 'type' key which maps to one of 'common', 'add' or 'remove' and a 'text' key which maps to the * line's content. + * + * @param sourceDiff the unified diff that we're converting to the map. + * @return map of 'type' to a line's content. */ - private ImmutableList<ImmutableMap<String, String>> getDiffTemplateData() { + protected ImmutableList<ImmutableMap<String, String>> getDiffTemplateData(String sourceDiff) { ImmutableList.Builder<ImmutableMap<String, String>> result = ImmutableList.builder(); Splitter lineSplitter = Splitter.on(System.getProperty("line.separator")); - for (String diffLine : lineSplitter.split(getUnifiedDiff())) { + for (String diffLine : lineSplitter.split(sourceDiff)) { ImmutableMap.Builder<String, String> lineData = ImmutableMap.builder(); lineData.put("text", diffLine);
diff --git a/java/com/google/gerrit/server/mail/send/CommentSender.java b/java/com/google/gerrit/server/mail/send/CommentSender.java index ac6c2f3..67b8b88 100644 --- a/java/com/google/gerrit/server/mail/send/CommentSender.java +++ b/java/com/google/gerrit/server/mail/send/CommentSender.java
@@ -14,6 +14,7 @@ package com.google.gerrit.server.mail.send; +import static com.google.gerrit.entities.Patch.PATCHSET_LEVEL; import static java.util.stream.Collectors.toList; import com.google.common.base.Strings; @@ -36,10 +37,9 @@ import com.google.gerrit.server.CommentsUtil; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.mail.receive.Protocol; +import com.google.gerrit.server.patch.DiffNotAvailableException; import com.google.gerrit.server.patch.PatchFile; -import com.google.gerrit.server.patch.PatchList; -import com.google.gerrit.server.patch.PatchListNotAvailableException; -import com.google.gerrit.server.patch.PatchListObjectTooLargeException; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import com.google.gerrit.server.util.LabelVote; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; @@ -55,7 +55,9 @@ import java.util.Map; import java.util.Optional; import org.apache.james.mime4j.dom.field.FieldName; +import org.eclipse.jgit.errors.MissingObjectException; import org.eclipse.jgit.lib.Config; +import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Repository; /** Send comments, after the author of them hit used Publish Comments in the UI. */ @@ -72,23 +74,23 @@ public PatchFile fileData; public List<Comment> comments = new ArrayList<>(); - /** @return a web link to a comment for a change. */ + /** Returns a web link to a comment for a change. */ public String getCommentLink(String uuid) { return args.urlFormatter.get().getInlineCommentView(change, uuid).orElse(null); } - /** @return a web link to the comment tab view of a change. */ + /** Returns a web link to the comment tab view of a change. */ public String getCommentsTabLink() { return args.urlFormatter.get().getCommentsTabView(change).orElse(null); } - /** @return a web link to the findings tab view of a change. */ + /** Returns a web link to the findings tab view of a change. */ public String getFindingsTabLink() { return args.urlFormatter.get().getFindingsTabView(change).orElse(null); } /** - * @return A title for the group, i.e. "Commit Message", "Merge List", or "File [[filename]]". + * Returns a title for the group, i.e. "Commit Message", "Merge List", or "File [[filename]]". */ public String getTitle() { if (Patch.COMMIT_MSG.equals(filename)) { @@ -181,8 +183,8 @@ } /** - * @return a list of FileCommentGroup objects representing the inline comments grouped by the - * file. + * Returns a list of FileCommentGroup objects representing the inline comments grouped by the + * file. */ private List<CommentSender.FileCommentGroup> getGroupedInlineComments(Repository repo) { List<CommentSender.FileCommentGroup> groups = new ArrayList<>(); @@ -198,30 +200,31 @@ currentGroup = new FileCommentGroup(); currentGroup.filename = c.key.filename; currentGroup.patchSetId = c.key.patchSetId; - // Get the patch list: - PatchList patchList = null; + // Get the modified files: + Map<String, FileDiffOutput> modifiedFiles = null; try { - patchList = getPatchList(c.key.patchSetId); - } catch (PatchListObjectTooLargeException e) { - logger.atWarning().log("Failed to get patch list: %s", e.getMessage()); - } catch (PatchListNotAvailableException e) { - logger.atSevere().withCause(e).log("Failed to get patch list"); + modifiedFiles = listModifiedFiles(c.key.patchSetId); + } catch (DiffNotAvailableException e) { + logger.atSevere().withCause(e).log("Failed to get modified files"); } groups.add(currentGroup); - if (patchList != null) { + if (modifiedFiles != null && !modifiedFiles.isEmpty()) { try { - currentGroup.fileData = new PatchFile(repo, patchList, c.key.filename); + currentGroup.fileData = + loadPatchFile(repo, modifiedFiles, c.key.filename, patchSet.commitId()); } catch (IOException e) { logger.atWarning().withCause(e).log( "Cannot load %s from %s in %s", - c.key.filename, patchList.getNewId().name(), projectState.getName()); + c.key.filename, + modifiedFiles.values().iterator().next().newCommitId().name(), + projectState.getName()); currentGroup.fileData = null; } } } - if (currentGroup.fileData != null) { + if (currentGroup.filename.equals(PATCHSET_LEVEL) || currentGroup.fileData != null) { currentGroup.comments.add(c); } } @@ -230,6 +233,28 @@ return groups; } + private PatchFile loadPatchFile( + Repository repo, + Map<String, FileDiffOutput> modifiedFiles, + String fileName, + ObjectId commitId) + throws IOException { + try { + return new PatchFile(repo, modifiedFiles, fileName); + } catch (MissingObjectException e) { + // check if the file has not been modified then is an unchanged file + if (!isModifiedFile(modifiedFiles, fileName)) { + return new PatchFile(repo, fileName, commitId); + } + throw e; + } + } + + private boolean isModifiedFile(Map<String, FileDiffOutput> modifiedFiles, String fileName) { + return modifiedFiles.values().stream() + .anyMatch(f -> f.newPath().map(v -> v.equals(fileName)).orElse(false)); + } + /** Get the set of accounts whose comments have been replied to in this email. */ private HashSet<Account.Id> getReplyAccounts() { HashSet<Account.Id> replyAccounts = new HashSet<>(); @@ -268,7 +293,7 @@ } /** - * @return the lines of file content in fileData that are encompassed by range on the given side. + * Returns the lines of file content in fileData that are encompassed by range on the given side. */ private List<String> getLinesByRange(Comment.Range range, PatchFile fileData, short side) { List<String> lines = new ArrayList<>(); @@ -331,9 +356,9 @@ } /** - * @return a shortened version of the given comment's message. Will be shortened to 100 characters - * or the first line, or following the last period within the first 100 characters, whichever - * is shorter. If the message is shortened, an ellipsis is appended. + * Returns a shortened version of the given comment's message. Will be shortened to 100 characters + * or the first line, or following the last period within the first 100 characters, whichever is + * shorter. If the message is shortened, an ellipsis is appended. */ protected static String getShortenedCommentMessage(String message) { int threshold = 100; @@ -369,8 +394,8 @@ } /** - * @return grouped inline comment data mapped to data structures that are suitable for passing - * into Soy. + * Returns grouped inline comment data mapped to data structures that are suitable for passing + * into Soy. */ private List<Map<String, Object>> getCommentGroupsTemplateData(Repository repo) { List<Map<String, Object>> commentGroups = new ArrayList<>(); @@ -383,7 +408,9 @@ List<Map<String, Object>> commentsList = new ArrayList<>(); for (Comment comment : group.comments) { Map<String, Object> commentData = new HashMap<>(); - commentData.put("lines", getLinesOfComment(comment, group.fileData)); + if (group.fileData != null) { + commentData.put("lines", getLinesOfComment(comment, group.fileData)); + } commentData.put("message", comment.message.trim()); List<CommentFormatter.Block> blocks = CommentFormatter.parse(comment.message); commentData.put("messageBlocks", commentBlocksToSoyData(blocks));
diff --git a/java/com/google/gerrit/server/mail/send/EmailArguments.java b/java/com/google/gerrit/server/mail/send/EmailArguments.java index 808d6a4..96effc1 100644 --- a/java/com/google/gerrit/server/mail/send/EmailArguments.java +++ b/java/com/google/gerrit/server/mail/send/EmailArguments.java
@@ -18,13 +18,14 @@ import com.google.gerrit.extensions.registration.DynamicItem; import com.google.gerrit.extensions.registration.DynamicSet; import com.google.gerrit.server.AnonymousUser; -import com.google.gerrit.server.ApprovalsUtil; +import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.GerritPersonIdentProvider; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.IdentifiedUser.GenericFactory; import com.google.gerrit.server.PatchSetUtil; import com.google.gerrit.server.account.AccountCache; import com.google.gerrit.server.account.GroupBackend; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.config.AllProjectsName; import com.google.gerrit.server.config.AnonymousCowardName; import com.google.gerrit.server.config.GerritInstanceName; @@ -34,7 +35,7 @@ import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.mail.EmailSettings; import com.google.gerrit.server.notedb.ChangeNotes; -import com.google.gerrit.server.patch.PatchListCache; +import com.google.gerrit.server.patch.DiffOperations; import com.google.gerrit.server.patch.PatchSetInfoFactory; import com.google.gerrit.server.permissions.PermissionBackend; import com.google.gerrit.server.project.ProjectCache; @@ -42,6 +43,7 @@ import com.google.gerrit.server.query.change.ChangeData; import com.google.gerrit.server.query.change.ChangeQueryBuilder; import com.google.gerrit.server.ssh.SshAdvertisedAddresses; +import com.google.gerrit.server.update.RetryHelper; import com.google.gerrit.server.validators.OutgoingEmailValidationListener; import com.google.inject.Inject; import com.google.inject.Provider; @@ -70,7 +72,7 @@ final PermissionBackend permissionBackend; final GroupBackend groupBackend; final AccountCache accountCache; - final PatchListCache patchListCache; + final DiffOperations diffOperations; final PatchSetUtil patchSetUtil; final ApprovalsUtil approvalsUtil; final Provider<FromAddressGenerator> fromAddressGenerator; @@ -85,7 +87,6 @@ final AllProjectsName allProjectsName; final List<String> sshAddresses; final SitePaths site; - final Provider<ChangeQueryBuilder> queryBuilder; final ChangeData.Factory changeDataFactory; final Provider<SoySauce> soySauce; @@ -95,6 +96,8 @@ final OutgoingEmailValidator validator; final boolean addInstanceNameInSubject; final Provider<String> instanceNameProvider; + final Provider<CurrentUser> currentUserProvider; + final RetryHelper retryHelper; @Inject EmailArguments( @@ -103,7 +106,7 @@ PermissionBackend permissionBackend, GroupBackend groupBackend, AccountCache accountCache, - PatchListCache patchListCache, + DiffOperations diffOperations, PatchSetUtil patchSetUtil, ApprovalsUtil approvalsUtil, Provider<FromAddressGenerator> fromAddressGenerator, @@ -126,13 +129,15 @@ Provider<InternalAccountQuery> accountQueryProvider, OutgoingEmailValidator validator, @GerritInstanceName Provider<String> instanceNameProvider, - @GerritServerConfig Config cfg) { + @GerritServerConfig Config cfg, + Provider<CurrentUser> currentUserProvider, + RetryHelper retryHelper) { this.server = server; this.projectCache = projectCache; this.permissionBackend = permissionBackend; this.groupBackend = groupBackend; this.accountCache = accountCache; - this.patchListCache = patchListCache; + this.diffOperations = diffOperations; this.patchSetUtil = patchSetUtil; this.approvalsUtil = approvalsUtil; this.fromAddressGenerator = fromAddressGenerator; @@ -155,7 +160,8 @@ this.accountQueryProvider = accountQueryProvider; this.validator = validator; this.instanceNameProvider = instanceNameProvider; - this.addInstanceNameInSubject = cfg.getBoolean("sendemail", "addInstanceNameInSubject", false); + this.currentUserProvider = currentUserProvider; + this.retryHelper = retryHelper; } }
diff --git a/java/com/google/gerrit/server/mail/send/InboundEmailRejectionSender.java b/java/com/google/gerrit/server/mail/send/InboundEmailRejectionSender.java index 709bf61..2e0eeb3 100644 --- a/java/com/google/gerrit/server/mail/send/InboundEmailRejectionSender.java +++ b/java/com/google/gerrit/server/mail/send/InboundEmailRejectionSender.java
@@ -28,20 +28,21 @@ public class InboundEmailRejectionSender extends OutgoingEmail { /** Used by the templating system to determine what error message should be sent */ - public enum Error { + public enum InboundEmailError { PARSING_ERROR, INACTIVE_ACCOUNT, UNKNOWN_ACCOUNT, INTERNAL_EXCEPTION, - COMMENT_REJECTED + COMMENT_REJECTED, + CHANGE_NOT_FOUND } public interface Factory { - InboundEmailRejectionSender create(Address to, String threadId, Error reason); + InboundEmailRejectionSender create(Address to, String threadId, InboundEmailError reason); } private final Address to; - private final Error reason; + private final InboundEmailError reason; private final String threadId; @Inject @@ -49,7 +50,7 @@ EmailArguments args, @Assisted Address to, @Assisted String threadId, - @Assisted Error reason) { + @Assisted InboundEmailError reason) { super(args, "error"); this.to = requireNonNull(to); this.threadId = requireNonNull(threadId);
diff --git a/java/com/google/gerrit/server/mail/send/MergedSender.java b/java/com/google/gerrit/server/mail/send/MergedSender.java index ea76ab8..cec857d 100644 --- a/java/com/google/gerrit/server/mail/send/MergedSender.java +++ b/java/com/google/gerrit/server/mail/send/MergedSender.java
@@ -78,16 +78,15 @@ try { Table<Account.Id, String, PatchSetApproval> pos = HashBasedTable.create(); Table<Account.Id, String, PatchSetApproval> neg = HashBasedTable.create(); - for (PatchSetApproval ca : - args.approvalsUtil.byPatchSet(changeData.notes(), patchSet.id(), null, null)) { - LabelType lt = labelTypes.byLabel(ca.labelId()); - if (lt == null) { + for (PatchSetApproval ca : args.approvalsUtil.byPatchSet(changeData.notes(), patchSet.id())) { + Optional<LabelType> lt = labelTypes.byLabel(ca.labelId()); + if (!lt.isPresent()) { continue; } if (ca.value() > 0) { - pos.put(ca.accountId(), lt.getName(), ca); + pos.put(ca.accountId(), lt.get().getName(), ca); } else if (ca.value() < 0) { - neg.put(ca.accountId(), lt.getName(), ca); + neg.put(ca.accountId(), lt.get().getName(), ca); } } @@ -142,6 +141,8 @@ soyContextEmailData.put("approvals", getApprovals()); if (stickyApprovalDiff.isPresent()) { soyContextEmailData.put("stickyApprovalDiff", stickyApprovalDiff.get()); + soyContextEmailData.put( + "stickyApprovalDiffHtml", getDiffTemplateData(stickyApprovalDiff.get())); } } }
diff --git a/java/com/google/gerrit/server/mail/send/MessageIdGenerator.java b/java/com/google/gerrit/server/mail/send/MessageIdGenerator.java index aa683f6..b32c43a 100644 --- a/java/com/google/gerrit/server/mail/send/MessageIdGenerator.java +++ b/java/com/google/gerrit/server/mail/send/MessageIdGenerator.java
@@ -58,8 +58,6 @@ /** * Create a {@link MessageId} as a result of a change update. * - * @param repoView - * @param patchsetId * @return MessageId that depends on the patchset. */ public MessageId fromChangeUpdate(RepoView repoView, PatchSet.Id patchsetId) { @@ -89,8 +87,9 @@ } /** - * @param accountId Create a {@link MessageId} as a result of an account update. - * @return MessageId that depends on the account id. + * Create a {@link MessageId} as a result of an account update + * + * @return {@link MessageId} that depends on the account id. */ public MessageId fromAccountUpdate(Account.Id accountId) { String userRef = RefNames.refsUsers(accountId); @@ -113,8 +112,6 @@ * Create a {@link MessageId} from a reason, Account.Id, and timestamp. * * @param reason for performing this account update - * @param accountId - * @param timestamp * @return MessageId that depends on the reason, accountId, and timestamp. */ public MessageId fromReasonAccountIdAndTimestamp(
diff --git a/java/com/google/gerrit/server/mail/send/AddReviewerSender.java b/java/com/google/gerrit/server/mail/send/ModifyReviewerSender.java similarity index 85% rename from java/com/google/gerrit/server/mail/send/AddReviewerSender.java rename to java/com/google/gerrit/server/mail/send/ModifyReviewerSender.java index 96d9483..b187f9c 100644 --- a/java/com/google/gerrit/server/mail/send/AddReviewerSender.java +++ b/java/com/google/gerrit/server/mail/send/ModifyReviewerSender.java
@@ -21,13 +21,13 @@ import com.google.inject.assistedinject.Assisted; /** Asks a user to review a change. */ -public class AddReviewerSender extends NewChangeSender { +public class ModifyReviewerSender extends NewChangeSender { public interface Factory { - AddReviewerSender create(Project.NameKey project, Change.Id changeId); + ModifyReviewerSender create(Project.NameKey project, Change.Id changeId); } @Inject - public AddReviewerSender( + public ModifyReviewerSender( EmailArguments args, @Assisted Project.NameKey project, @Assisted Change.Id changeId) { super(args, newChangeData(args, project, changeId)); } @@ -37,5 +37,6 @@ super.init(); ccExistingReviewers(); + removeUsersThatIgnoredTheChange(); } }
diff --git a/java/com/google/gerrit/server/mail/send/NewChangeSender.java b/java/com/google/gerrit/server/mail/send/NewChangeSender.java index ee9a328..001de52 100644 --- a/java/com/google/gerrit/server/mail/send/NewChangeSender.java +++ b/java/com/google/gerrit/server/mail/send/NewChangeSender.java
@@ -31,6 +31,8 @@ private final Set<Address> reviewersByEmail = new HashSet<>(); private final Set<Account.Id> extraCC = new HashSet<>(); private final Set<Address> extraCCByEmail = new HashSet<>(); + private final Set<Account.Id> removedReviewers = new HashSet<>(); + private final Set<Address> removedByEmailReviewers = new HashSet<>(); protected NewChangeSender(EmailArguments args, ChangeData changeData) { super(args, "newchange", changeData); @@ -52,10 +54,17 @@ extraCCByEmail.addAll(cc); } + public void addRemovedReviewers(Collection<Account.Id> removed) { + removedReviewers.addAll(removed); + } + + public void addRemovedByEmailReviewers(Collection<Address> removed) { + removedByEmailReviewers.addAll(removed); + } + @Override protected void init() throws EmailException { super.init(); - String threadId = getChangeMessageThreadId(); setHeader("References", threadId); @@ -71,6 +80,8 @@ case OWNER_REVIEWERS: reviewers.stream().forEach(r -> add(RecipientType.TO, r, true)); addByEmail(RecipientType.TO, reviewersByEmail, true); + removedReviewers.stream().forEach(r -> add(RecipientType.TO, r, true)); + addByEmail(RecipientType.TO, removedByEmailReviewers, true); break; } @@ -96,10 +107,25 @@ return names; } + public List<String> getRemovedReviewerNames() { + if (removedReviewers.isEmpty() && removedByEmailReviewers.isEmpty()) { + return null; + } + List<String> names = new ArrayList<>(); + for (Account.Id id : removedReviewers) { + names.add(getNameFor(id)); + } + for (Address address : removedByEmailReviewers) { + names.add(address.name()); + } + return names; + } + @Override protected void setupSoyContext() { super.setupSoyContext(); soyContext.put("ownerName", getNameFor(change.getOwner())); soyContextEmailData.put("reviewerNames", getReviewerNames()); + soyContextEmailData.put("removedReviewerNames", getRemovedReviewerNames()); } }
diff --git a/java/com/google/gerrit/server/mail/send/OutgoingEmail.java b/java/com/google/gerrit/server/mail/send/OutgoingEmail.java index 746a07a..286f0c7 100644 --- a/java/com/google/gerrit/server/mail/send/OutgoingEmail.java +++ b/java/com/google/gerrit/server/mail/send/OutgoingEmail.java
@@ -18,6 +18,7 @@ import static com.google.gerrit.extensions.client.GeneralPreferencesInfo.EmailStrategy.DISABLED; import static java.util.Objects.requireNonNull; +import com.google.common.base.Throwables; import com.google.common.collect.Sets; import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; @@ -25,14 +26,17 @@ import com.google.gerrit.entities.Address; import com.google.gerrit.entities.EmailHeader; import com.google.gerrit.entities.EmailHeader.AddressList; +import com.google.gerrit.entities.EmailHeader.StringEmailHeader; import com.google.gerrit.exceptions.EmailException; import com.google.gerrit.extensions.api.changes.RecipientType; import com.google.gerrit.extensions.client.GeneralPreferencesInfo; import com.google.gerrit.extensions.client.GeneralPreferencesInfo.EmailFormat; import com.google.gerrit.mail.MailHeader; +import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.change.NotifyResolver; import com.google.gerrit.server.permissions.PermissionBackendException; +import com.google.gerrit.server.update.RetryableAction.ActionType; import com.google.gerrit.server.validators.OutgoingEmailValidationListener; import com.google.gerrit.server.validators.ValidationException; import com.google.template.soy.jbcsrc.api.SoySauce; @@ -92,12 +96,27 @@ this.messageId = messageId; } - /** - * Format and enqueue the message for delivery. - * - * @throws EmailException - */ + /** Format and enqueue the message for delivery. */ public void send() throws EmailException { + try { + args.retryHelper + .action( + ActionType.SEND_EMAIL, + "sendEmail", + () -> { + sendImpl(); + return null; + }) + .retryWithTrace(Exception.class::isInstance) + .call(); + } catch (Exception e) { + Throwables.throwIfUnchecked(e); + Throwables.throwIfInstanceOf(e, EmailException.class); + throw new EmailException("sending email failed", e); + } + } + + private void sendImpl() throws EmailException { if (!args.emailSender.isEnabled()) { // Server has explicitly disabled email sending. // @@ -127,18 +146,40 @@ Optional<AccountState> fromUser = args.accountCache.get(fromId); if (fromUser.isPresent()) { GeneralPreferencesInfo senderPrefs = fromUser.get().generalPreferences(); + CurrentUser user = args.currentUserProvider.get(); + boolean isImpersonating = user.isIdentifiedUser() && user.isImpersonating(); + if (isImpersonating && user.getAccountId() != fromId) { + // This should not be possible, if this is the case it means the RequestContext is not + // set up correctly. + throw new EmailException( + String.format( + "User %s is sending email from %s, while acting on behalf of %s", + user.asIdentifiedUser().getRealUser().getAccountId(), + fromId, + user.getAccountId())); + } if (senderPrefs != null && senderPrefs.getEmailStrategy() == CC_ON_OWN_COMMENTS) { - // If we are impersonating a user, make sure they receive a CC of - // this message so they can always review and audit what we sent - // on their behalf to others. + // Include the sender in email if they enabled email notifications on their own + // comments. // logger.atFine().log( "CC email sender %s because the email strategy of this user is %s", fromUser.get().account().id(), CC_ON_OWN_COMMENTS); add(RecipientType.CC, fromId); + } else if (isImpersonating) { + // If we are impersonating a user, make sure they receive a CC of + // this message regardless of email strategy, unless email notifications are explicitly + // disabled for this user. This way they can always review and audit what we sent + // on their behalf to others. + logger.atFine().log( + "CC email sender %s because the email is sent on behalf of and email notifications" + + " are enabled for this user.", + fromUser.get().account().id()); + add(RecipientType.CC, fromId); + } else if (!notify.accounts().containsValue(fromId) && rcptTo.remove(fromId)) { // If they don't want a copy, but we queued one up anyway, - // drop them from the recipient lists. + // drop them from the recipient lists, but only if the user is not being impersonated. // logger.atFine().log( "Not CCing email sender %s because the email strategy of this user is not %s but" @@ -261,7 +302,7 @@ if (messageId != null) { String message = "<" + messageId.id() + suffix + "@" + getGerritHost() + ">"; message = message.replaceAll("\\s", ""); - va.headers.put(FieldName.MESSAGE_ID, new EmailHeader.String(message)); + va.headers.put(FieldName.MESSAGE_ID, new StringEmailHeader(message)); } } @@ -343,7 +384,7 @@ /** Set a header in the outgoing message. */ protected void setHeader(String name, String value) { - headers.put(name, new EmailHeader.String(value)); + headers.put(name, new StringEmailHeader(value)); } /** Remove a header from the outgoing message. */ @@ -504,9 +545,9 @@ } /** + * Returns whether this email is visible to the given account + * * @param to account. - * @throws PermissionBackendException - * @return whether this email is visible to the given account. */ protected boolean isVisibleTo(Account.Id to) throws PermissionBackendException { return true;
diff --git a/java/com/google/gerrit/server/mail/send/SmtpEmailSender.java b/java/com/google/gerrit/server/mail/send/SmtpEmailSender.java index 1ad94be..2c65789 100644 --- a/java/com/google/gerrit/server/mail/send/SmtpEmailSender.java +++ b/java/com/google/gerrit/server/mail/send/SmtpEmailSender.java
@@ -23,6 +23,7 @@ import com.google.gerrit.common.Version; import com.google.gerrit.entities.Address; import com.google.gerrit.entities.EmailHeader; +import com.google.gerrit.entities.EmailHeader.StringEmailHeader; import com.google.gerrit.exceptions.EmailException; import com.google.gerrit.server.config.ConfigUtil; import com.google.gerrit.server.config.GerritServerConfig; @@ -59,7 +60,7 @@ private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - public static class Module extends AbstractModule { + public static class SmtpEmailSenderModule extends AbstractModule { @Override protected void configure() { bind(EmailSender.class).to(SmtpEmailSender.class); @@ -381,12 +382,12 @@ try (QuotedPrintableOutputStream qp = new QuotedPrintableOutputStream(s, false)) { qp.write(input.getBytes(UTF_8)); } - return s.toString(); + return s.toString(UTF_8); } private static void setMissingHeader(Map<String, EmailHeader> hdrs, String name, String value) { if (!hdrs.containsKey(name) || hdrs.get(name).isEmpty()) { - hdrs.put(name, new EmailHeader.String(value)); + hdrs.put(name, new StringEmailHeader(value)); } }
diff --git a/java/com/google/gerrit/server/notedb/AbstractChangeNotes.java b/java/com/google/gerrit/server/notedb/AbstractChangeNotes.java index 74ecd68..158972f 100644 --- a/java/com/google/gerrit/server/notedb/AbstractChangeNotes.java +++ b/java/com/google/gerrit/server/notedb/AbstractChangeNotes.java
@@ -132,7 +132,7 @@ return changeId; } - /** @return revision of the metadata that was loaded. */ + /** Returns revision of the metadata that was loaded. */ public ObjectId getRevision() { return revision; } @@ -215,12 +215,12 @@ protected abstract void loadDefaults(); /** - * @return the NameKey for the project where the notes should be stored, which is not necessarily - * the same as the change's project. + * Returns the NameKey for the project where the notes should be stored, which is not necessarily + * the same as the change's project. */ public abstract Project.NameKey getProjectName(); - /** @return name of the reference storing this configuration. */ + /** Returns name of the reference storing this configuration. */ protected abstract String getRefName(); /** Set up the metadata, parsing any state from the loaded revision. */
diff --git a/java/com/google/gerrit/server/notedb/AbstractChangeUpdate.java b/java/com/google/gerrit/server/notedb/AbstractChangeUpdate.java index 8e6606e..6677490 100644 --- a/java/com/google/gerrit/server/notedb/AbstractChangeUpdate.java +++ b/java/com/google/gerrit/server/notedb/AbstractChangeUpdate.java
@@ -122,12 +122,11 @@ } /** - * @return notes for the state of this change prior to this update. If this update is part of a - * series managed by a {@link NoteDbUpdateManager}, then this reflects the state prior to the - * first update in the series. A null return value can only happen when the change is being - * rebuilt from NoteDb. A change that is in the process of being created will result in a - * non-null return value from this method, but a null return value from {@link - * ChangeNotes#getRevision()}. + * Returns notes for the state of this change prior to this update. If this update is part of a + * series managed by a {@link NoteDbUpdateManager}, then this reflects the state prior to the + * first update in the series. A null return value can only happen when the change is being + * rebuilt from NoteDb. A change that is in the process of being created will result in a non-null + * return value from this method, but a null return value from {@link ChangeNotes#getRevision()}. */ @Nullable public ChangeNotes getNotes() { @@ -173,8 +172,8 @@ } /** - * @return the NameKey for the project where the update will be stored, which is not necessarily - * the same as the change's project. + * Returns the NameKey for the project where the update will be stored, which is not necessarily + * the same as the change's project. */ protected abstract Project.NameKey getProjectName();
diff --git a/java/com/google/gerrit/server/notedb/ChangeDraftUpdate.java b/java/com/google/gerrit/server/notedb/ChangeDraftUpdate.java index 57f6353..95298d2 100644 --- a/java/com/google/gerrit/server/notedb/ChangeDraftUpdate.java +++ b/java/com/google/gerrit/server/notedb/ChangeDraftUpdate.java
@@ -92,6 +92,7 @@ private List<HumanComment> put = new ArrayList<>(); private Map<Key, DeleteReason> delete = new HashMap<>(); + @SuppressWarnings("UnusedMethod") @AssistedInject private ChangeDraftUpdate( @GerritPersonIdent PersonIdent serverIdent,
diff --git a/java/com/google/gerrit/server/notedb/ChangeNoteJson.java b/java/com/google/gerrit/server/notedb/ChangeNoteJson.java index 483b2e9..4c41a12 100644 --- a/java/com/google/gerrit/server/notedb/ChangeNoteJson.java +++ b/java/com/google/gerrit/server/notedb/ChangeNoteJson.java
@@ -14,9 +14,17 @@ package com.google.gerrit.server.notedb; +import com.google.common.collect.ImmutableList; +import com.google.gerrit.entities.EntitiesAdapterFactory; +import com.google.gerrit.json.EnumTypeAdapterFactory; import com.google.gson.Gson; import com.google.gson.GsonBuilder; +import com.google.gson.TypeAdapter; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; import com.google.inject.Singleton; +import com.google.inject.TypeLiteral; +import java.io.IOException; import java.sql.Timestamp; @Singleton @@ -26,6 +34,11 @@ static Gson newGson() { return new GsonBuilder() .registerTypeAdapter(Timestamp.class, new CommentTimestampAdapter().nullSafe()) + .registerTypeAdapterFactory(new EnumTypeAdapterFactory()) + .registerTypeAdapterFactory(EntitiesAdapterFactory.create()) + .registerTypeAdapter( + new TypeLiteral<ImmutableList<String>>() {}.getType(), + new ImmutableListAdapter().nullSafe()) .setPrettyPrinting() .create(); } @@ -33,4 +46,27 @@ public Gson getGson() { return gson; } + + static class ImmutableListAdapter extends TypeAdapter<ImmutableList<String>> { + + @Override + public void write(JsonWriter out, ImmutableList<String> value) throws IOException { + out.beginArray(); + for (String v : value) { + out.value(v); + } + out.endArray(); + } + + @Override + public ImmutableList<String> read(JsonReader in) throws IOException { + ImmutableList.Builder<String> builder = ImmutableList.builder(); + in.beginArray(); + while (in.hasNext()) { + builder.add(in.nextString()); + } + in.endArray(); + return builder.build(); + } + } }
diff --git a/java/com/google/gerrit/server/notedb/ChangeNoteUtil.java b/java/com/google/gerrit/server/notedb/ChangeNoteUtil.java index 15f187a..28ab711 100644 --- a/java/com/google/gerrit/server/notedb/ChangeNoteUtil.java +++ b/java/com/google/gerrit/server/notedb/ChangeNoteUtil.java
@@ -40,6 +40,7 @@ static final FooterKey FOOTER_GROUPS = new FooterKey("Groups"); static final FooterKey FOOTER_HASHTAGS = new FooterKey("Hashtags"); static final FooterKey FOOTER_LABEL = new FooterKey("Label"); + static final FooterKey FOOTER_COPIED_LABEL = new FooterKey("Copied-Label"); static final FooterKey FOOTER_PATCH_SET = new FooterKey("Patch-set"); static final FooterKey FOOTER_PATCH_SET_DESCRIPTION = new FooterKey("Patch-set-description"); static final FooterKey FOOTER_PRIVATE = new FooterKey("Private"); @@ -54,6 +55,8 @@ static final FooterKey FOOTER_REVERT_OF = new FooterKey("Revert-of"); static final FooterKey FOOTER_CHERRY_PICK_OF = new FooterKey("Cherry-pick-of"); + static final String GERRIT_USER_TEMPLATE = "Gerrit User %d"; + private static final Gson gson = OutputFormat.JSON_COMPACT.newGson(); private final ChangeNoteJson changeNoteJson; @@ -83,6 +86,11 @@ .append('>'); } + public static String formatAccountIdentString(Account.Id account, String accountIdAsEmail) { + return String.format( + "%s <%s>", ChangeNoteUtil.getAccountIdAsUsername(account), accountIdAsEmail); + } + /** * Returns a {@link PersonIdent} that contains the account ID, but not the user's name or email * address. @@ -97,10 +105,10 @@ /** Returns the string {@code "Gerrit User " + accountId}, to pseudonymize user names. */ public static String getAccountIdAsUsername(Account.Id accountId) { - return "Gerrit User " + accountId.toString(); + return String.format(GERRIT_USER_TEMPLATE, accountId.get()); } - private String getAccountIdAsEmailAddress(Account.Id accountId) { + public String getAccountIdAsEmailAddress(Account.Id accountId) { return accountId.get() + "@" + serverId; } @@ -145,7 +153,14 @@ } if (ptr <= changeMessageStart) { - return Optional.empty(); + // Return with subject, ChangeMessage is empty + return Optional.of( + CommitMessageRange.builder() + .subjectStart(subjectStart) + .subjectEnd(subjectEnd) + .changeMessageStart(changeMessageStart) + .changeMessageEnd(changeMessageStart) + .build()); } CommitMessageRange range = @@ -170,6 +185,10 @@ public abstract int changeMessageEnd(); + public boolean hasChangeMessage() { + return changeMessageStart() < changeMessageEnd(); + } + public static Builder builder() { return new AutoValue_ChangeNoteUtil_CommitMessageRange.Builder(); } @@ -190,7 +209,7 @@ } /** Helper class for JSON serialization. Timestamp is taken from the commit. */ - private static class AttentionStatusInNoteDb { + public static class AttentionStatusInNoteDb { final String personIdent; final AttentionSetUpdate.Operation operation;
diff --git a/java/com/google/gerrit/server/notedb/ChangeNotes.java b/java/com/google/gerrit/server/notedb/ChangeNotes.java index 6500d92..0b1bf7f 100644 --- a/java/com/google/gerrit/server/notedb/ChangeNotes.java +++ b/java/com/google/gerrit/server/notedb/ChangeNotes.java
@@ -16,16 +16,17 @@ import static com.google.common.base.Preconditions.checkArgument; import static com.google.common.base.Preconditions.checkState; +import static com.google.common.collect.ImmutableListMultimap.toImmutableListMultimap; import static com.google.common.collect.ImmutableSet.toImmutableSet; import static com.google.gerrit.entities.RefNames.changeMetaRef; import static java.util.Comparator.comparing; -import static java.util.Objects.requireNonNull; import com.google.auto.value.AutoValue; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableListMultimap; +import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.common.collect.ImmutableSortedMap; import com.google.common.collect.ImmutableSortedSet; @@ -34,9 +35,8 @@ import com.google.common.collect.MultimapBuilder; import com.google.common.collect.Multimaps; import com.google.common.collect.Ordering; -import com.google.common.collect.Sets; -import com.google.common.collect.Sets.SetView; import com.google.common.flogger.FluentLogger; +import com.google.errorprone.annotations.FormatMethod; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.AttentionSetUpdate; @@ -51,6 +51,7 @@ import com.google.gerrit.entities.RefNames; import com.google.gerrit.entities.RobotComment; import com.google.gerrit.entities.SubmitRecord; +import com.google.gerrit.entities.SubmitRequirementResult; import com.google.gerrit.server.AssigneeStatusUpdate; import com.google.gerrit.server.ReviewerByEmailSet; import com.google.gerrit.server.ReviewerSet; @@ -69,6 +70,7 @@ import java.util.Collection; import java.util.Collections; import java.util.List; +import java.util.Map; import java.util.Objects; import java.util.Optional; import java.util.function.Predicate; @@ -92,6 +94,7 @@ public static final Ordering<ChangeMessage> MESSAGE_BY_TIME = Ordering.from(comparing(ChangeMessage::getWrittenOn)); + @FormatMethod public static ConfigInvalidException parseException( Change.Id changeId, String fmt, Object... args) { return new ConfigInvalidException("Change " + changeId + ": " + String.format(fmt, args)); @@ -112,27 +115,18 @@ this.projectCache = projectCache; } - @AutoValue - public abstract static class ScanResult { - abstract ImmutableSet<Change.Id> fromPatchSetRefs(); - - abstract ImmutableSet<Change.Id> fromMetaRefs(); - - public SetView<Change.Id> all() { - return Sets.union(fromPatchSetRefs(), fromMetaRefs()); - } - } - - public static ScanResult scanChangeIds(Repository repo) throws IOException { - ImmutableSet.Builder<Change.Id> fromPs = ImmutableSet.builder(); - ImmutableSet.Builder<Change.Id> fromMeta = ImmutableSet.builder(); + public static ImmutableMap<Change.Id, ObjectId> scanChangeIds(Repository repo) + throws IOException { + ImmutableMap.Builder<Change.Id, ObjectId> metaIdByChange = ImmutableMap.builder(); for (Ref r : repo.getRefDatabase().getRefsByPrefix(RefNames.REFS_CHANGES)) { - Change.Id id = Change.Id.fromRef(r.getName()); - if (id != null) { - (r.getName().endsWith(RefNames.META_SUFFIX) ? fromMeta : fromPs).add(id); + if (r.getName().endsWith(RefNames.META_SUFFIX)) { + Change.Id id = Change.Id.fromRef(r.getName()); + if (id != null) { + metaIdByChange.put(id, r.getObjectId()); + } } } - return new AutoValue_ChangeNotes_Factory_ScanResult(fromPs.build(), fromMeta.build()); + return metaIdByChange.build(); } public ChangeNotes createChecked(Change c) { @@ -168,6 +162,12 @@ return new ChangeNotes(args, newChange(project, changeId), true, null).load(); } + public ChangeNotes create( + Project.NameKey project, Change.Id changeId, @Nullable ObjectId metaRevId) { + checkArgument(project != null, "project is required"); + return new ChangeNotes(args, newChange(project, changeId), true, null, metaRevId).load(); + } + public ChangeNotes create(Repository repository, Project.NameKey project, Change.Id changeId) { checkArgument(project != null, "project is required"); return new ChangeNotes(args, newChange(project, changeId), true, null).load(repository); @@ -198,7 +198,7 @@ * com.google.gerrit.entities.Project.NameKey} and the numeric change ID are not available. */ public ChangeNotes createCheckedUsingIndexLookup(Change.Id changeId) { - InternalChangeQuery query = queryProvider.get().noFields(); + InternalChangeQuery query = queryProvider.get().setLimit(2).noFields(); List<ChangeData> changes = query.byLegacyChangeId(changeId); if (changes.isEmpty()) { throw new NoSuchChangeException(changeId); @@ -298,27 +298,25 @@ } public Stream<ChangeNotesResult> scan( - ScanResult sr, Project.NameKey project, Predicate<Change.Id> changeIdPredicate) { - Stream<Change.Id> idStream = sr.all().stream(); + ImmutableMap<Change.Id, ObjectId> metaIdByChange, + Project.NameKey project, + Predicate<Change.Id> changeIdPredicate) { + Stream<Map.Entry<Change.Id, ObjectId>> metaByIdStream = metaIdByChange.entrySet().stream(); if (changeIdPredicate != null) { - idStream = idStream.filter(changeIdPredicate); + metaByIdStream = metaByIdStream.filter(e -> changeIdPredicate.test(e.getKey())); } - return idStream.map(id -> scanOneChange(project, sr, id)).filter(Objects::nonNull); + return metaByIdStream.map(e -> scanOneChange(project, e)).filter(Objects::nonNull); } @Nullable - private ChangeNotesResult scanOneChange(Project.NameKey project, ScanResult sr, Change.Id id) { - if (!sr.fromMetaRefs().contains(id)) { - // Stray patch set refs can happen due to normal error conditions, e.g. failed - // push processing, so aren't worth even a warning. - return null; - } - + private ChangeNotesResult scanOneChange( + Project.NameKey project, Map.Entry<Change.Id, ObjectId> metaIdByChangeId) { + Change.Id id = metaIdByChangeId.getKey(); // TODO(dborowitz): See discussion in BatchUpdate#newChangeContext. try { Change change = ChangeNotes.Factory.newChange(project, id); logger.atFine().log("adding change %s found in project %s", id, project); - return toResult(change); + return toResult(change, metaIdByChangeId.getValue()); } catch (InvalidServerIdException ise) { logger.atWarning().withCause(ise).log( "skipping change %d in project %s because of an invalid server id", id.get(), project); @@ -327,8 +325,8 @@ } @Nullable - private ChangeNotesResult toResult(Change rawChangeFromNoteDb) { - ChangeNotes n = new ChangeNotes(args, rawChangeFromNoteDb, true, null); + private ChangeNotesResult toResult(Change rawChangeFromNoteDb, ObjectId metaId) { + ChangeNotes n = new ChangeNotes(args, rawChangeFromNoteDb, true, null, metaId); try { n.load(); } catch (Exception e) { @@ -389,6 +387,7 @@ // ChangeNotesCache from handlers. private ImmutableSortedMap<PatchSet.Id, PatchSet> patchSets; private ImmutableListMultimap<PatchSet.Id, PatchSetApproval> approvals; + private ImmutableListMultimap<PatchSet.Id, PatchSetApproval> approvalsWithCopied; private ImmutableSet<Comment.Key> commentKeys; public ChangeNotes( @@ -426,28 +425,49 @@ return patchSets; } + /** + * Gets the approvals, not including the copied approvals. To get copied approvals as well, use + * {@link #getApprovalsWithCopied}, or use {@code ApprovalInference}. + */ public ImmutableListMultimap<PatchSet.Id, PatchSetApproval> getApprovals() { if (approvals == null) { - approvals = ImmutableListMultimap.copyOf(state.approvals()); + approvals = + state.approvals().stream() + .filter(e -> !e.getValue().copied()) + .collect(toImmutableListMultimap(e -> e.getKey(), e -> e.getValue())); } return approvals; } + /** + * This method is currently used only in tests. TODO(paiking): Use this method to fetch approvals + * (including copied approvals) instead of computing copied approvals on demand. This will be used + * by {@code ApprovalCache}. + * + * @return all approvals, including copied approvals. + */ + public ImmutableListMultimap<PatchSet.Id, PatchSetApproval> getApprovalsWithCopied() { + if (approvalsWithCopied == null) { + approvalsWithCopied = ImmutableListMultimap.copyOf(state.approvals()); + } + return approvalsWithCopied; + } + public ReviewerSet getReviewers() { return state.reviewers(); } - /** @return reviewers that do not currently have a Gerrit account and were added by email. */ + /** Returns reviewers that do not currently have a Gerrit account and were added by email. */ public ReviewerByEmailSet getReviewersByEmail() { return state.reviewersByEmail(); } - /** @return reviewers that were modified during this change's current WIP phase. */ + /** Returns reviewers that were modified during this change's current WIP phase. */ public ReviewerSet getPendingReviewers() { return state.pendingReviewers(); } - /** @return reviewers by email that were modified during this change's current WIP phase. */ + /** Returns reviewers by email that were modified during this change's current WIP phase. */ public ReviewerByEmailSet getPendingReviewersByEmail() { return state.pendingReviewersByEmail(); } @@ -467,8 +487,18 @@ } /** - * @return an ImmutableSet of Account.Ids of all users that have been assigned to this change. The - * order of the set is the order in which they were assigned. + * Returns the evaluated submit requirements for the change. We only intend to store submit + * requirements in NoteDb for closed changes, hence the result will be an empty list for active + * changes, or a list of submit requirements results otherwise. For closed changes, the results + * represent the state of evaluating submit requirements for this change when it was merged. + */ + public ImmutableList<SubmitRequirementResult> getSubmitRequirementsResult() { + return state.submitRequirementsResult(); + } + + /** + * Returns an ImmutableSet of Account.Ids of all users that have been assigned to this change. The + * order of the set is the order in which they were assigned. */ public ImmutableSet<Account.Id> getPastAssignees() { return Lists.reverse(state.assigneeUpdates()).stream() @@ -479,37 +509,37 @@ } /** - * @return an ImmutableList of AssigneeStatusUpdate of all the updates to the assignee field to - * this change. The order of the list is from most recent updates to least recent. + * Returns an ImmutableList of AssigneeStatusUpdate of all the updates to the assignee field to + * this change. The order of the list is from most recent updates to least recent. */ public ImmutableList<AssigneeStatusUpdate> getAssigneeUpdates() { return state.assigneeUpdates(); } - /** @return a ImmutableSet of all hashtags for this change sorted in alphabetical order. */ + /** Returns an ImmutableSet of all hashtags for this change sorted in alphabetical order. */ public ImmutableSet<String> getHashtags() { return ImmutableSortedSet.copyOf(state.hashtags()); } - /** @return a list of all users who have ever been a reviewer on this change. */ + /** Returns a list of all users who have ever been a reviewer on this change. */ public ImmutableList<Account.Id> getAllPastReviewers() { return state.allPastReviewers(); } /** - * @return submit records stored during the most recent submit; only for changes that were - * actually submitted. + * Returns submit records stored during the most recent submit; only for changes that were + * actually submitted. */ public ImmutableList<SubmitRecord> getSubmitRecords() { return state.submitRecords(); } - /** @return all change messages, in chronological order, oldest first. */ + /** Returns all change messages, in chronological order, oldest first. */ public ImmutableList<ChangeMessage> getChangeMessages() { return state.changeMessages(); } - /** @return inline comments on each revision. */ + /** Returns inline comments on each revision. */ public ImmutableListMultimap<ObjectId, HumanComment> getHumanComments() { return state.publishedComments(); } @@ -529,7 +559,7 @@ return state.updateCount(); } - /** @return {@link Optional} value of time when the change was merged. */ + /** Returns {@link Optional} value of time when the change was merged. */ public Optional<Timestamp> getMergedOn() { return Optional.ofNullable(state.mergedOn()); } @@ -607,8 +637,20 @@ public PatchSet getCurrentPatchSet() { PatchSet.Id psId = change.currentPatchSetId(); - return requireNonNull( - getPatchSets().get(psId), () -> String.format("missing current patch set %s", psId.get())); + if (psId == null || getPatchSets().get(psId) == null) { + // In some cases, the current patch-set doesn't exist yet as it's being created during the + // operation (e.g rebase). + PatchSet currentPatchset = + getPatchSets().values().stream() + .max((p1, p2) -> p1.id().get() - p2.id().get()) + .orElseThrow( + () -> + new IllegalStateException( + String.format( + "change %s can't load any patchset", getChangeId().toString()))); + return currentPatchset; + } + return getPatchSets().get(psId); } @Override
diff --git a/java/com/google/gerrit/server/notedb/ChangeNotesParser.java b/java/com/google/gerrit/server/notedb/ChangeNotesParser.java index 2eb69e6f..0fc6324 100644 --- a/java/com/google/gerrit/server/notedb/ChangeNotesParser.java +++ b/java/com/google/gerrit/server/notedb/ChangeNotesParser.java
@@ -21,6 +21,7 @@ import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_CHANGE_ID; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_CHERRY_PICK_OF; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_COMMIT; +import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_COPIED_LABEL; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_CURRENT; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_GROUPS; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_HASHTAGS; @@ -55,6 +56,7 @@ import com.google.common.collect.Tables; import com.google.common.flogger.FluentLogger; import com.google.common.primitives.Ints; +import com.google.errorprone.annotations.FormatMethod; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Address; @@ -68,6 +70,7 @@ import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.RefNames; import com.google.gerrit.entities.SubmitRecord; +import com.google.gerrit.entities.SubmitRequirementResult; import com.google.gerrit.metrics.Timer0; import com.google.gerrit.server.AssigneeStatusUpdate; import com.google.gerrit.server.ReviewerByEmailSet; @@ -104,6 +107,8 @@ class ChangeNotesParser { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + private static final String LABEL_VOTE_UUID_SEPARATOR = ", "; + // Private final members initialized in the constructor. private final ChangeNoteJson changeNoteJson; private final NoteDbMetrics metrics; @@ -125,6 +130,7 @@ private final List<AssigneeStatusUpdate> assigneeUpdates; private final List<SubmitRecord> submitRecords; private final ListMultimap<ObjectId, HumanComment> humanComments; + private final List<SubmitRequirementResult> submitRequirementResults; private final Map<PatchSet.Id, PatchSet.Builder> patchSets; private final Set<PatchSet.Id> deletedPatchSets; private final Map<PatchSet.Id, PatchSetState> patchSetStates; @@ -187,6 +193,7 @@ submitRecords = Lists.newArrayListWithExpectedSize(1); allChangeMessages = new ArrayList<>(); humanComments = MultimapBuilder.hashKeys().arrayListValues().build(); + submitRequirementResults = new ArrayList<>(); patchSets = new HashMap<>(); deletedPatchSets = new HashSet<>(); patchSetStates = new HashMap<>(); @@ -259,6 +266,7 @@ submitRecords, buildAllMessages(), humanComments, + submitRequirementResults, firstNonNull(isPrivate, false), firstNonNull(workInProgress, false), firstNonNull(hasReviewStarted, true), @@ -409,6 +417,9 @@ for (String line : commit.getFooterLineValues(FOOTER_LABEL)) { parseApproval(psId, accountId, realAccountId, commitTimestamp, line); } + for (String line : commit.getFooterLineValues(FOOTER_COPIED_LABEL)) { + parseCopiedApproval(psId, commitTimestamp, line); + } for (ReviewerStateInternal state : ReviewerStateInternal.values()) { for (String line : commit.getFooterLineValues(state.getFooterKey())) { @@ -735,10 +746,14 @@ } ChangeMessage changeMessage = - new ChangeMessage(ChangeMessage.key(psId.changeId(), commit.name()), accountId, ts, psId); - changeMessage.setMessage(changeMsgString.get()); - changeMessage.setTag(tag); - changeMessage.setRealAuthor(realAccountId); + ChangeMessage.create( + ChangeMessage.key(psId.changeId(), commit.name()), + accountId, + ts, + psId, + changeMsgString.get(), + realAccountId, + tag); return allChangeMessages.add(changeMessage); } @@ -749,11 +764,13 @@ Optional<ChangeNoteUtil.CommitMessageRange> range = parseCommitMessageRange(commit); return range.map( commitMessageRange -> - RawParseUtils.decode( - enc, - raw, - commitMessageRange.changeMessageStart(), - commitMessageRange.changeMessageEnd() + 1)); + commitMessageRange.hasChangeMessage() + ? RawParseUtils.decode( + enc, + raw, + commitMessageRange.changeMessageStart(), + commitMessageRange.changeMessageEnd() + 1) + : null); } private void parseNotes() throws IOException, ConfigInvalidException { @@ -768,6 +785,9 @@ for (HumanComment c : e.getValue().getEntities()) { humanComments.put(e.getKey(), c); } + for (SubmitRequirementResult sr : e.getValue().getSubmitRequirementsResult()) { + submitRequirementResults.add(sr); + } } for (PatchSet.Builder b : patchSets.values()) { @@ -783,6 +803,109 @@ } } + // Return the UUID start index or -1 if no UUID is present + private int parseCopiedApprovalUuidStart(String line, int tagStart) { + int separatorIndex = line.indexOf(LABEL_VOTE_UUID_SEPARATOR); + + // The first part of the condition checks whether the footer has the following format: + // Copied-Label: <LABEL>=VOTE <Gerrit Account>,<Gerrit Real Account> :"<TAG>" + // Weird tag that contains uuid delimiter. The uuid is actually not present. + if ((tagStart != -1 && separatorIndex > tagStart) + || + + // The second part of the condition allows us to distinguish the following two lines: + // Label2=+1, 577fb248e474018276351785930358ec0450e9f7 Gerrit User 1 <1@gerrit> + // Label2=+1 User Name (company_name, department) <2@gerrit> + (line.indexOf(' ') < separatorIndex)) { + return -1; + } + return separatorIndex; + } + + // Splitting on "," breaks for identities containing commas. The below re-implements splitting on + // "(?<=>),", but it's 3-5x faster, as performance matters here. + private String[] parseIdentities(String line) { + String[] idents = line.split(","); + List<String> identitiesList = new ArrayList<>(); + for (int i = 0; i < idents.length; i++) { + if (i == 0 || idents[i - 1].endsWith(">")) { + identitiesList.add(idents[i]); + } else { + int lastIndex = identitiesList.size() - 1; + identitiesList.set(lastIndex, identitiesList.get(lastIndex) + "," + idents[i]); + } + } + return identitiesList.toArray(new String[0]); + } + + // Footer example: Copied-Label: <LABEL>=VOTE <Gerrit Account>,<Gerrit Real Account> :"<TAG>" + // ":<"TAG>"" is optional. <Gerrit Real Account> is also optional, if it was not set. + // The label, vote, and the Gerrit account are mandatory (unlike FOOTER_LABEL where Gerrit + // Account is also optional since by default it's the committer). + private void parseCopiedApproval(PatchSet.Id psId, Timestamp ts, String line) + throws ConfigInvalidException { + // Copied approvals can't be explicitly removed. They are removed the same way as non-copied + // approvals. + checkFooter(!line.startsWith("-"), FOOTER_COPIED_LABEL, line); + + Account.Id accountId, realAccountId = null; + String labelVoteStr; + String tag = null; + int tagStart = line.indexOf(":\""); + // UUID introduced in https://gerrit-review.googlesource.com/c/gerrit/+/324937 + // Only parsed for backward compatibility + int uuidStart = parseCopiedApprovalUuidStart(line, tagStart); + int identitiesStart = + line.indexOf(' ', uuidStart != -1 ? uuidStart + LABEL_VOTE_UUID_SEPARATOR.length() : 0); + // The first account is the accountId, and second (if applicable) is the realAccountId. + try { + labelVoteStr = line.substring(0, uuidStart != -1 ? uuidStart : identitiesStart); + } catch (StringIndexOutOfBoundsException ex) { + throw new ConfigInvalidException(ex.getMessage(), ex); + } + String[] identities = + parseIdentities( + line.substring(identitiesStart + 1, tagStart == -1 ? line.length() : tagStart)); + + PersonIdent ident = RawParseUtils.parsePersonIdent(identities[0]); + checkFooter(ident != null, FOOTER_COPIED_LABEL, line); + accountId = parseIdent(ident); + + if (identities.length > 1) { + PersonIdent realIdent = RawParseUtils.parsePersonIdent(identities[1]); + checkFooter(realIdent != null, FOOTER_COPIED_LABEL, line); + realAccountId = parseIdent(realIdent); + } + + LabelVote l; + try { + l = LabelVote.parseWithEquals(labelVoteStr); + } catch (IllegalArgumentException e) { + ConfigInvalidException pe = parseException("invalid %s: %s", FOOTER_COPIED_LABEL, line); + pe.initCause(e); + throw pe; + } + + if (tagStart != -1) { + // tagStart+2 skips ":\"" to parse the actual tag. Tags are in brackets. + // line.length()-1 skips the last ". + tag = line.substring(tagStart + 2, line.length() - 1); + } + + PatchSetApproval.Builder psa = + PatchSetApproval.builder() + .key(PatchSetApproval.key(psId, accountId, LabelId.create(l.label()))) + .value(l.value()) + .granted(ts) + .tag(Optional.ofNullable(tag)) + .copied(true); + if (realAccountId != null) { + psa.realAccountId(realAccountId); + } + approvals.putIfAbsent(psa.key(), psa); + bufferedApprovals.add(psa); + } + private void parseApproval( PatchSet.Id psId, Account.Id accountId, Account.Id realAccountId, Timestamp ts, String line) throws ConfigInvalidException { @@ -810,25 +933,52 @@ // update operation was executed by this user on behalf of the effective // user. Account.Id effectiveAccountId; - String labelVoteStr; - int s = line.indexOf(' '); - if (s > 0) { + // UUID introduced in https://gerrit-review.googlesource.com/c/gerrit/+/324937 + // Only parsed for backward compatibility + int voteUuidSeparatorIndex = line.indexOf(LABEL_VOTE_UUID_SEPARATOR); + // We need some additional logic to differentiate between labels that have a UUID and those that + // have a user with a comma. This allows us to separate the following cases (note that the + // leading `Label: ` has been elided at this point): + // Label: <LABEL>=VOTE, <UUID> <Gerrit Account> + // Label: <LABEL>=VOTE <Gerrit, Account> + int reviewerStartOffset = 0; + int scoreStart = line.indexOf('=') + 1; + StringBuilder labelNameScore = new StringBuilder(line.substring(0, scoreStart)); + for (int i = scoreStart; i < line.length(); i++) { + char currentChar = line.charAt(i); + // If we hit ',' before ' ' we have a UUID + if (currentChar == ',') { + labelNameScore.append(line, scoreStart, i); + reviewerStartOffset = voteUuidSeparatorIndex + LABEL_VOTE_UUID_SEPARATOR.length(); + break; + } + // Otherwise we don't + if (currentChar == ' ') { + labelNameScore.append(line, scoreStart, i); + break; + } + // If we hit neither we're defensive assign the whole line + if (i == line.length() - 1) { + labelNameScore = new StringBuilder(line); + break; + } + } + int reviewerStart = line.indexOf(' ', reviewerStartOffset); + if (reviewerStart > 0) { // Account in the label line (2) becomes the effective ID of the // approval. If there is a real user (3) different from the commit user // (2), we actually don't store that anywhere in this case; it's more // important to record that the real user (3) actually initiated submit. - labelVoteStr = line.substring(0, s); - PersonIdent ident = RawParseUtils.parsePersonIdent(line.substring(s + 1)); + PersonIdent ident = RawParseUtils.parsePersonIdent(line.substring(reviewerStart + 1)); checkFooter(ident != null, FOOTER_LABEL, line); effectiveAccountId = parseIdent(ident); } else { - labelVoteStr = line; effectiveAccountId = committerId; } LabelVote l; try { - l = LabelVote.parseWithEquals(labelVoteStr); + l = LabelVote.parseWithEquals(labelNameScore.toString()); } catch (IllegalArgumentException e) { ConfigInvalidException pe = parseException("invalid %s: %s", FOOTER_LABEL, line); pe.initCause(e); @@ -904,8 +1054,9 @@ } } else { checkFooter(rec != null, FOOTER_SUBMITTED_WITH, line); - if (line.startsWith("Rule-Name")) { - // This is just added for forward compatibility. Ignore this field. + if (line.startsWith("Rule-Name: ")) { + String ruleName = line.split(": ")[1]; + rec.ruleName = ruleName; continue; } SubmitRecord.Label label = new SubmitRecord.Label(); @@ -1158,6 +1309,7 @@ } if (!missing.isEmpty()) { throw parseException( + "%s", "Missing footers: " + missing.stream().map(FooterKey::getName).collect(joining(", "))); } } @@ -1191,6 +1343,7 @@ return pending != null && pending.commitId().isPresent(); } + @FormatMethod private ConfigInvalidException parseException(String fmt, Object... args) { return ChangeNotes.parseException(id, fmt, args); }
diff --git a/java/com/google/gerrit/server/notedb/ChangeNotesState.java b/java/com/google/gerrit/server/notedb/ChangeNotesState.java index 33bc039..4d6b9cf 100644 --- a/java/com/google/gerrit/server/notedb/ChangeNotesState.java +++ b/java/com/google/gerrit/server/notedb/ChangeNotesState.java
@@ -44,6 +44,7 @@ import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.Project; import com.google.gerrit.entities.SubmitRecord; +import com.google.gerrit.entities.SubmitRequirementResult; import com.google.gerrit.entities.converter.ChangeMessageProtoConverter; import com.google.gerrit.entities.converter.PatchSetApprovalProtoConverter; import com.google.gerrit.entities.converter.PatchSetProtoConverter; @@ -128,6 +129,7 @@ List<SubmitRecord> submitRecords, List<ChangeMessage> changeMessages, ListMultimap<ObjectId, HumanComment> publishedComments, + List<SubmitRequirementResult> submitRequirementResults, boolean isPrivate, boolean workInProgress, boolean reviewStarted, @@ -181,6 +183,7 @@ .submitRecords(submitRecords) .changeMessages(changeMessages) .publishedComments(publishedComments) + .submitRequirementsResult(submitRequirementResults) .updateCount(updateCount) .mergedOn(mergedOn) .build(); @@ -326,6 +329,8 @@ abstract ImmutableListMultimap<ObjectId, HumanComment> publishedComments(); + abstract ImmutableList<SubmitRequirementResult> submitRequirementsResult(); + abstract int updateCount(); @Nullable @@ -404,6 +409,7 @@ .submitRecords(ImmutableList.of()) .changeMessages(ImmutableList.of()) .publishedComments(ImmutableListMultimap.of()) + .submitRequirementsResult(ImmutableList.of()) .updateCount(0); } @@ -445,6 +451,9 @@ abstract Builder publishedComments(ListMultimap<ObjectId, HumanComment> publishedComments); + abstract Builder submitRequirementsResult( + List<SubmitRequirementResult> submitRequirementsResult); + abstract Builder updateCount(int updateCount); abstract Builder mergedOn(Timestamp mergedOn); @@ -519,6 +528,12 @@ .changeMessages() .forEach(m -> b.addChangeMessage(ChangeMessageProtoConverter.INSTANCE.toProto(m))); object.publishedComments().values().forEach(c -> b.addPublishedComment(GSON.toJson(c))); + object + .submitRequirementsResult() + .forEach( + sr -> + b.addSubmitRequirementResult( + SubmitRequirementProtoConverter.INSTANCE.toProto(sr))); b.setUpdateCount(object.updateCount()); if (object.mergedOn() != null) { b.setMergedOnMillis(object.mergedOn().getTime()); @@ -658,6 +673,10 @@ proto.getPublishedCommentList().stream() .map(r -> GSON.fromJson(r, HumanComment.class)) .collect(toImmutableListMultimap(HumanComment::getCommitId, c -> c))) + .submitRequirementsResult( + proto.getSubmitRequirementResultList().stream() + .map(sr -> SubmitRequirementProtoConverter.INSTANCE.fromProto(sr)) + .collect(toImmutableList())) .updateCount(proto.getUpdateCount()) .mergedOn(proto.getHasMergedOn() ? new Timestamp(proto.getMergedOnMillis()) : null); return b.build();
diff --git a/java/com/google/gerrit/server/notedb/ChangeRevisionNote.java b/java/com/google/gerrit/server/notedb/ChangeRevisionNote.java index bf2cf07..44475db 100644 --- a/java/com/google/gerrit/server/notedb/ChangeRevisionNote.java +++ b/java/com/google/gerrit/server/notedb/ChangeRevisionNote.java
@@ -16,7 +16,9 @@ import static java.nio.charset.StandardCharsets.UTF_8; +import com.google.common.collect.ImmutableList; import com.google.gerrit.entities.HumanComment; +import com.google.gerrit.entities.SubmitRequirementResult; import java.io.ByteArrayInputStream; import java.io.IOException; import java.io.InputStream; @@ -34,6 +36,8 @@ private final HumanComment.Status status; private String pushCert; + private ImmutableList<SubmitRequirementResult> submitRequirementsResult; + ChangeRevisionNote( ChangeNoteJson noteJson, ObjectReader reader, ObjectId noteId, HumanComment.Status status) { super(reader, noteId); @@ -41,6 +45,11 @@ this.status = status; } + public ImmutableList<SubmitRequirementResult> getSubmitRequirementsResult() { + checkParsed(); + return submitRequirementsResult; + } + public String getPushCert() { checkParsed(); return pushCert; @@ -52,20 +61,24 @@ MutableInteger p = new MutableInteger(); p.value = offset; - HumanCommentsRevisionNoteData data = parseJson(noteJson, raw, p.value); + ChangeRevisionNoteData data = parseJson(noteJson, raw, p.value); if (status == HumanComment.Status.PUBLISHED) { pushCert = data.pushCert; } else { pushCert = null; } + this.submitRequirementsResult = + data.submitRequirementResults == null + ? ImmutableList.of() + : ImmutableList.copyOf(data.submitRequirementResults); return data.comments; } - private HumanCommentsRevisionNoteData parseJson(ChangeNoteJson noteUtil, byte[] raw, int offset) + private ChangeRevisionNoteData parseJson(ChangeNoteJson noteUtil, byte[] raw, int offset) throws IOException { try (InputStream is = new ByteArrayInputStream(raw, offset, raw.length - offset); Reader r = new InputStreamReader(is, UTF_8)) { - return noteUtil.getGson().fromJson(r, HumanCommentsRevisionNoteData.class); + return noteUtil.getGson().fromJson(r, ChangeRevisionNoteData.class); } } }
diff --git a/java/com/google/gerrit/server/notedb/HumanCommentsRevisionNoteData.java b/java/com/google/gerrit/server/notedb/ChangeRevisionNoteData.java similarity index 78% rename from java/com/google/gerrit/server/notedb/HumanCommentsRevisionNoteData.java rename to java/com/google/gerrit/server/notedb/ChangeRevisionNoteData.java index e570412..8e33023 100644 --- a/java/com/google/gerrit/server/notedb/HumanCommentsRevisionNoteData.java +++ b/java/com/google/gerrit/server/notedb/ChangeRevisionNoteData.java
@@ -15,14 +15,17 @@ package com.google.gerrit.server.notedb; import com.google.gerrit.entities.HumanComment; +import com.google.gerrit.entities.SubmitRequirementResult; import java.util.List; /** * Holds the raw data of a RevisionNote. * - * <p>It is intended for deserialization from JSON only. It is used for human comments only. + * <p>It is intended for deserialization from JSON only. It is used for human comments. Submit + * requirements are also stored but only for closed changes. */ -class HumanCommentsRevisionNoteData { +class ChangeRevisionNoteData { String pushCert; List<HumanComment> comments; + List<SubmitRequirementResult> submitRequirementResults; }
diff --git a/java/com/google/gerrit/server/notedb/ChangeUpdate.java b/java/com/google/gerrit/server/notedb/ChangeUpdate.java index 708212d..ddc59f0 100644 --- a/java/com/google/gerrit/server/notedb/ChangeUpdate.java +++ b/java/com/google/gerrit/server/notedb/ChangeUpdate.java
@@ -24,6 +24,7 @@ import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_CHANGE_ID; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_CHERRY_PICK_OF; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_COMMIT; +import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_COPIED_LABEL; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_CURRENT; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_GROUPS; import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_HASHTAGS; @@ -52,18 +53,22 @@ import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Table; +import com.google.common.collect.Table.Cell; import com.google.common.collect.TreeBasedTable; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Address; import com.google.gerrit.entities.AttentionSetUpdate; +import com.google.gerrit.entities.AttentionSetUpdate.Operation; import com.google.gerrit.entities.Change; import com.google.gerrit.entities.Comment; import com.google.gerrit.entities.HumanComment; import com.google.gerrit.entities.LabelId; +import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.Project; import com.google.gerrit.entities.RobotComment; import com.google.gerrit.entities.SubmissionId; import com.google.gerrit.entities.SubmitRecord; +import com.google.gerrit.entities.SubmitRequirementResult; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.client.ReviewerState; import com.google.gerrit.server.CurrentUser; @@ -77,6 +82,7 @@ import com.google.inject.assistedinject.AssistedInject; import java.io.IOException; import java.util.ArrayList; +import java.util.Collection; import java.util.Comparator; import java.util.Date; import java.util.HashMap; @@ -114,7 +120,6 @@ public interface Factory { ChangeUpdate create(ChangeNotes notes, CurrentUser user, Date when); - @VisibleForTesting ChangeUpdate create( ChangeNotes notes, CurrentUser user, Date when, Comparator<String> labelNameComparator); } @@ -126,9 +131,11 @@ private final ServiceUserClassifier serviceUserClassifier; private final Table<String, Account.Id, Optional<Short>> approvals; + private final List<PatchSetApproval> copiedApprovals = new ArrayList<>(); private final Map<Account.Id, ReviewerStateInternal> reviewers = new LinkedHashMap<>(); private final Map<Address, ReviewerStateInternal> reviewersByEmail = new LinkedHashMap<>(); private final List<HumanComment> comments = new ArrayList<>(); + private final List<SubmitRequirementResult> submitRequirementResults = new ArrayList<>(); private String commitSubject; private String subject; @@ -163,6 +170,7 @@ private DeleteCommentRewriter deleteCommentRewriter; private DeleteChangeMessageRewriter deleteChangeMessageRewriter; + @SuppressWarnings("UnusedMethod") @AssistedInject private ChangeUpdate( @GerritPersonIdent PersonIdent serverIdent, @@ -270,6 +278,19 @@ approvals.put(label, reviewer, Optional.empty()); } + /** + * We expect the {@code copied} flag of {@code copiedPatchSetApproval} to be set, since this + * method is only meant for copied approvals. + */ + public void putCopiedApproval(PatchSetApproval copiedPatchSetApproval) { + checkArgument(copiedPatchSetApproval.copied(), "Approval that should be copied is not copied."); + copiedApprovals.add(copiedPatchSetApproval); + } + + public boolean hasCopiedApprovals() { + return !copiedApprovals.isEmpty(); + } + public void merge(SubmissionId submissionId, Iterable<SubmitRecord> submitRecords) { this.status = Change.Status.MERGED; this.submissionId = submissionId.toString(); @@ -302,6 +323,10 @@ this.psDescription = psDescription; } + public void putSubmitRequirementResults(Collection<SubmitRequirementResult> rs) { + submitRequirementResults.addAll(rs); + } + public void putComment(HumanComment.Status status, HumanComment c) { verifyComment(c); createDraftUpdateIfNull(); @@ -485,10 +510,10 @@ this.cherryPickOf = Optional.empty(); } - /** @return the tree id for the updated tree */ + /** Returns the tree id for the updated tree */ private ObjectId storeRevisionNotes(RevWalk rw, ObjectInserter inserter, ObjectId curr) throws ConfigInvalidException, IOException { - if (comments.isEmpty() && pushCert == null) { + if (submitRequirementResults.isEmpty() && comments.isEmpty() && pushCert == null) { return null; } RevisionNoteMap<ChangeRevisionNote> rnm = getRevisionNoteMap(rw, curr); @@ -498,6 +523,9 @@ c.tag = tag; cache.get(c.getCommitId()).putComment(c); } + for (SubmitRequirementResult sr : submitRequirementResults) { + cache.get(sr.patchSetCommitId()).putSubmitRequirementResult(sr); + } if (pushCert != null) { checkState(commit != null); cache.get(ObjectId.fromString(commit)).setPushCertificate(pushCert); @@ -695,18 +723,10 @@ } for (Table.Cell<String, Account.Id, Optional<Short>> c : approvals.cellSet()) { - addFooter(msg, FOOTER_LABEL); - // Label names/values are safe to append without sanitizing. - if (!c.getValue().isPresent()) { - msg.append('-').append(c.getRowKey()); - } else { - msg.append(LabelVote.create(c.getRowKey(), c.getValue().get()).formatWithEquals()); - } - Account.Id id = c.getColumnKey(); - if (!id.equals(getAccountId())) { - noteUtil.appendAccountIdIdentString(msg.append(' '), id); - } - msg.append('\n'); + addLabelFooter(msg, c); + } + for (PatchSetApproval patchSetApproval : copiedApprovals) { + addCopiedLabelFooter(msg, patchSetApproval); } if (submissionId != null) { @@ -720,7 +740,10 @@ msg.append(' ').append(sanitizeFooter(rec.errorMessage)); } msg.append('\n'); - + if (rec.ruleName != null) { + addFooter(msg, FOOTER_SUBMITTED_WITH).append("Rule-Name: ").append(rec.ruleName); + msg.append('\n'); + } if (rec.labels != null) { for (SubmitRecord.Label label : rec.labels) { // Label names/values are safe to append without sanitizing. @@ -735,7 +758,6 @@ msg.append('\n'); } } - // TODO(maximeg) We might want to list plugins that validated this submission. } } @@ -770,9 +792,7 @@ } } - if (plannedAttentionSetUpdates != null) { - updateAttentionSet(msg); - } + updateAttentionSet(msg); CommitBuilder cb = new CommitBuilder(); cb.setMessage(msg.toString()); @@ -787,6 +807,47 @@ return cb; } + private void addLabelFooter(StringBuilder msg, Cell<String, Account.Id, Optional<Short>> c) { + addFooter(msg, FOOTER_LABEL); + // Label names/values are safe to append without sanitizing. + if (!c.getValue().isPresent()) { + msg.append('-').append(c.getRowKey()); + } else { + msg.append(LabelVote.create(c.getRowKey(), c.getValue().get()).formatWithEquals()); + } + Account.Id id = c.getColumnKey(); + if (!id.equals(getAccountId())) { + noteUtil.appendAccountIdIdentString(msg.append(' '), id); + } + msg.append('\n'); + } + + private void addCopiedLabelFooter(StringBuilder msg, PatchSetApproval patchSetApproval) { + if (patchSetApproval.value() == 0) { + // Can only happen if we removed a vote. There is no need to persist removed votes. + return; + } + addFooter(msg, FOOTER_COPIED_LABEL); + // Label names/values are safe to append without sanitizing. + msg.append( + LabelVote.create(patchSetApproval.label(), patchSetApproval.value()).formatWithEquals()); + Account.Id id = patchSetApproval.accountId(); + noteUtil.appendAccountIdIdentString(msg.append(' '), id); + + // In the non-copied labels, we don't need to pass the real account id since it's already + // in FOOTER_REAL_USER. Here, we want to retain the original real account id. + if (patchSetApproval.realAccountId() != null) { + noteUtil.appendAccountIdIdentString(msg.append(","), patchSetApproval.realAccountId()); + } + + // In the non-copied labels, we don't need to pass the tag since it's already in + // FOOTER_TAG, but in this chase we want to retain the original tag, and not the current tag. + if (patchSetApproval.tag().isPresent()) { + msg.append(":\"" + sanitizeFooter(patchSetApproval.tag().get()) + "\""); + } + msg.append('\n'); + } + private void clearAttentionSet(String reason) { if (getNotes().getAttentionSet() == null) { return; @@ -854,7 +915,7 @@ */ private void updateAttentionSet(StringBuilder msg) { if (plannedAttentionSetUpdates == null) { - return; + plannedAttentionSetUpdates = new HashMap<>(); } Set<Account.Id> currentUsersInAttentionSet = AttentionSetUtil.additionsOnly(getNotes().getAttentionSet()).stream() @@ -876,6 +937,8 @@ .map(r -> r.getKey()) .collect(ImmutableSet.toImmutableSet())); + removeInactiveUsersFromAttentionSet(currentReviewers); + for (AttentionSetUpdate attentionSetUpdate : plannedAttentionSetUpdates.values()) { if (attentionSetUpdate.operation() == AttentionSetUpdate.Operation.ADD && currentUsersInAttentionSet.contains(attentionSetUpdate.account())) { @@ -913,6 +976,38 @@ } } + private void removeInactiveUsersFromAttentionSet(Set<Account.Id> currentReviewers) { + Set<Account.Id> inActiveUsersInTheAttentionSet = + // get the current attention set. + getNotes().getAttentionSet().stream() + .filter(a -> a.operation().equals(Operation.ADD)) + .map(a -> a.account()) + // remove users that are currently being removed from the attention set. + .filter( + a -> + plannedAttentionSetUpdates.getOrDefault(a, /*defaultValue= */ null) == null + || plannedAttentionSetUpdates.get(a).operation().equals(Operation.REMOVE)) + // remove users that are still active on the change. + .filter(a -> !isActiveOnChange(currentReviewers, a)) + .collect(ImmutableSet.toImmutableSet()); + + // We override the flag, as we never want such users in the attention set. + ignoreFurtherAttentionSetUpdates = false; + + addToPlannedAttentionSetUpdates( + inActiveUsersInTheAttentionSet.stream() + .map( + a -> + AttentionSetUpdate.createForWrite( + a, + Operation.REMOVE, + /* reason= */ "Only change owner, uploader, reviewers, and cc can " + + "be in the attention set")) + .collect(ImmutableSet.toImmutableSet())); + + ignoreFurtherAttentionSetUpdates = true; + } + /** * Returns whether {@code accountId} is active on a change based on the {@code currentReviewers}. * Activity is defined as being a part of the reviewers, an uploader, or an owner of a change. @@ -948,6 +1043,7 @@ public boolean isEmpty() { return commitSubject == null && approvals.isEmpty() + && copiedApprovals.isEmpty() && changeMessage == null && comments.isEmpty() && reviewers.isEmpty()
diff --git a/java/com/google/gerrit/server/notedb/CommitRewriter.java b/java/com/google/gerrit/server/notedb/CommitRewriter.java new file mode 100644 index 0000000..7f440bd --- /dev/null +++ b/java/com/google/gerrit/server/notedb/CommitRewriter.java
@@ -0,0 +1,1362 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +package com.google.gerrit.server.notedb; + +import static com.google.common.base.MoreObjects.firstNonNull; +import static com.google.common.base.Preconditions.checkState; +import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_ASSIGNEE; +import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_ATTENTION; +import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_LABEL; +import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_REAL_USER; +import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_SUBMITTED_WITH; +import static com.google.gerrit.server.notedb.ChangeNoteUtil.FOOTER_TAG; +import static com.google.gerrit.server.util.AccountTemplateUtil.ACCOUNT_TEMPLATE_PATTERN; +import static com.google.gerrit.server.util.AccountTemplateUtil.ACCOUNT_TEMPLATE_REGEX; +import static java.nio.charset.StandardCharsets.UTF_8; + +import com.google.auto.value.AutoValue; +import com.google.common.base.Strings; +import com.google.common.collect.ImmutableMap; +import com.google.common.collect.ImmutableSet; +import com.google.common.collect.Iterables; +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.common.Nullable; +import com.google.gerrit.common.UsedAt; +import com.google.gerrit.entities.Account; +import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.HumanComment; +import com.google.gerrit.entities.PatchSetApproval; +import com.google.gerrit.entities.Project; +import com.google.gerrit.entities.RefNames; +import com.google.gerrit.entities.SubmitRecord; +import com.google.gerrit.git.RefUpdateUtil; +import com.google.gerrit.json.OutputFormat; +import com.google.gerrit.server.ChangeMessagesUtil; +import com.google.gerrit.server.account.AccountCache; +import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.notedb.ChangeNoteUtil.AttentionStatusInNoteDb; +import com.google.gerrit.server.notedb.ChangeNoteUtil.CommitMessageRange; +import com.google.gerrit.server.util.AccountTemplateUtil; +import com.google.gson.Gson; +import com.google.inject.Inject; +import com.google.inject.Singleton; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.Serializable; +import java.nio.charset.Charset; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; +import org.apache.commons.lang.StringUtils; +import org.eclipse.jgit.diff.DiffAlgorithm; +import org.eclipse.jgit.diff.DiffFormatter; +import org.eclipse.jgit.diff.EditList; +import org.eclipse.jgit.diff.HistogramDiff; +import org.eclipse.jgit.diff.RawText; +import org.eclipse.jgit.diff.RawTextComparator; +import org.eclipse.jgit.errors.ConfigInvalidException; +import org.eclipse.jgit.internal.storage.file.FileRepository; +import org.eclipse.jgit.internal.storage.file.PackInserter; +import org.eclipse.jgit.lib.BatchRefUpdate; +import org.eclipse.jgit.lib.CommitBuilder; +import org.eclipse.jgit.lib.Constants; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.lib.ObjectInserter; +import org.eclipse.jgit.lib.PersonIdent; +import org.eclipse.jgit.lib.Ref; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.revwalk.FooterLine; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevSort; +import org.eclipse.jgit.revwalk.RevWalk; +import org.eclipse.jgit.transport.ReceiveCommand; +import org.eclipse.jgit.util.RawParseUtils; + +/** + * Rewrites ('backfills') commit history of change in NoteDb to not contain user data. Only fixes + * known cases, rewriting commits case by case. + * + * <p>The cases where we used to put user data in NoteDb can be found by + * https://gerrit-review.googlesource.com/q/hashtag:user-data-cleanup + * + * <p>As opposed to {@link NoteDbRewriter} implementations, which target a specific change and are + * used by REST endpoints, this rewriter is used as standalone tool, that bulk backfills changes by + * project. + */ +@UsedAt(UsedAt.Project.GOOGLE) +@Singleton +public class CommitRewriter { + /** Options to run {@link #backfillProject}. */ + public static class RunOptions implements Serializable { + /** Whether to rewrite the commit history or only find refs that need to be fixed. */ + public boolean dryRun = true; + /** + * Whether to verify that resulting commits contain user data for the accounts that are linked + * to a change, see {@link #verifyCommit}, {@link #collectAccounts}. + */ + public boolean verifyCommits = true; + /** Whether to compute and output the diff of the commit history for the backfilled refs. */ + public boolean outputDiff = true; + + /** Max number of refs to update in a single {@link BatchRefUpdate}. */ + public int maxRefsInBatch = 10000; + /** + * Max number of refs to fix by a single {@link RefsUpdate#backfillProject} run. Since second + * run on the same set of refs is a no-op, running with this option in a loop will eventually + * fix all refs. Number of executed {@link BatchRefUpdate} depends on {@link #maxRefsInBatch} + * option. + */ + public int maxRefsToUpdate = 50000; + } + + /** Result of the backfill run for a project. */ + public static class BackfillResult { + + /** If the run for the project was successful. */ + public boolean ok; + + /** + * Refs that were fixed by the run/ would be fixed if in --dry-run, together with their commit + * history diff. Diff is empty if --output-diff is false. + */ + public Map<String, List<CommitDiff>> fixedRefDiff = new HashMap<>(); + + /** + * Refs that still contain user data after the backfill run. Only filled if --verify-commits, + * see {@link #verifyCommit} + */ + public List<String> refsStillInvalidAfterFix = new ArrayList<>(); + + /** Refs, failed to backfill by the run. */ + public List<String> refsFailedToFix = new ArrayList<>(); + } + + /** Diff result of a single commit rewrite */ + @AutoValue + public abstract static class CommitDiff { + public static CommitDiff create(ObjectId oldSha1, String commitDiff) { + return new AutoValue_CommitRewriter_CommitDiff(oldSha1, commitDiff); + } + + /** SHA1 of the overwritten commit */ + public abstract ObjectId oldSha1(); + + /** Diff applied to the commit with {@link #oldSha1} */ + public abstract String diff(); + } + + public static final String DEFAULT_ACCOUNT_REPLACEMENT = "Gerrit Account"; + + private static final Pattern NON_REPLACE_ACCOUNT_PATTERN = + Pattern.compile(DEFAULT_ACCOUNT_REPLACEMENT + "|" + ACCOUNT_TEMPLATE_REGEX); + + private static final Pattern OK_ACCOUNT_NAME_PATTERN = + Pattern.compile("(?i:someone|someone else|anonymous)|" + ACCOUNT_TEMPLATE_REGEX); + + /** Patterns to match change messages that need to be fixed. */ + private static final Pattern ASSIGNEE_DELETED_PATTERN = Pattern.compile("Assignee deleted: (.*)"); + + private static final Pattern ASSIGNEE_ADDED_PATTERN = Pattern.compile("Assignee added: (.*)"); + private static final Pattern ASSIGNEE_CHANGED_PATTERN = + Pattern.compile("Assignee changed from: (.*) to: (.*)"); + + private static final Pattern REMOVED_REVIEWER_PATTERN = + Pattern.compile( + "Removed (cc|reviewer) (.*)(\\.| with the following votes:\n.*)", Pattern.DOTALL); + + private static final Pattern REMOVED_VOTE_PATTERN = Pattern.compile("Removed (.*) by (.*)"); + + private static final String REMOVED_VOTES_CHANGE_MESSAGE_START = "Removed the following votes:"; + private static final Pattern REMOVED_VOTES_CHANGE_MESSAGE_PATTERN = + Pattern.compile("\\* (.*) by (.*)"); + + private static final Pattern REMOVED_CHANGE_MESSAGE_PATTERN = + Pattern.compile("Change message removed by: (.*)(\nReason: .*)?"); + + private static final Pattern SUBMITTED_PATTERN = + Pattern.compile("Change has been successfully (.*) by (.*)"); + + private static final Pattern ON_CODE_OWNER_ADD_REVIEWER_PATTERN = + Pattern.compile("(.*) who was added as reviewer owns the following files"); + + private static final String CODE_OWNER_ADD_REVIEWER_TAG = + ChangeMessagesUtil.AUTOGENERATED_BY_GERRIT_TAG_PREFIX + "code-owners:addReviewer"; + + private static final String ON_CODE_OWNER_APPROVAL_REGEX = "code-owner approved by (.*):"; + private static final String ON_CODE_OWNER_OVERRIDE_REGEX = + "code-owners submit requirement .* overridden by (.*)"; + + private static final Pattern ON_CODE_OWNER_REVIEW_PATTERN = + Pattern.compile(ON_CODE_OWNER_APPROVAL_REGEX + "|" + ON_CODE_OWNER_OVERRIDE_REGEX); + private static final Pattern ON_CODE_OWNER_POST_REVIEW_PATTERN = + Pattern.compile("Patch Set [0-9]+:[\\s\\S]*By (voting|removing)[\\s\\S]*"); + + private static final Pattern REPLY_BY_REASON_PATTERN = + Pattern.compile("(.*) replied on the change"); + private static final Pattern ADDED_BY_REASON_PATTERN = + Pattern.compile("Added by (.*) using the hovercard menu"); + private static final Pattern REMOVED_BY_REASON_PATTERN = + Pattern.compile("Removed by (.*) using the hovercard menu"); + private static final Pattern REMOVED_BY_ICON_CLICK_REASON_PATTERN = + Pattern.compile("Removed by (.*) by clicking the attention icon"); + + /** Matches {@link Account#getNameEmail} */ + private static final Pattern NAME_EMAIL_PATTERN = Pattern.compile("(.*) (\\<.*\\>|\\(.*\\))"); + + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + private final ChangeNotes.Factory changeNotesFactory; + private final AccountCache accountCache; + private final DiffAlgorithm diffAlgorithm = new HistogramDiff(); + private static final Gson gson = OutputFormat.JSON_COMPACT.newGson(); + + @Inject + CommitRewriter(ChangeNotes.Factory changeNotesFactory, AccountCache accountCache) { + this.changeNotesFactory = changeNotesFactory; + this.accountCache = accountCache; + } + + /** + * Rewrites commit history of {@link RefNames#changeMetaRef}s in single {@code repo}. Only + * rewrites branch if necessary, i.e. if there were any commits that contained user data. + * + * <p>See {@link RunOptions} for the execution and output options. + * + * @param project project to backfill + * @param repo repo to backfill + * @param options {@link RunOptions} to control how the run is executed. + * @return BackfillResult + */ + public BackfillResult backfillProject( + Project.NameKey project, Repository repo, RunOptions options) { + + checkState( + options.maxRefsInBatch > 0 && options.maxRefsToUpdate > 0, + "Expected maxRefsInBatch>0 && <= maxRefsToUpdate>0"); + checkState( + options.maxRefsInBatch <= options.maxRefsToUpdate, + "Expected maxRefsInBatch(%s) <= maxRefsToUpdate(%s)", + options.maxRefsInBatch, + options.maxRefsToUpdate); + BackfillResult result = new BackfillResult(); + result.ok = true; + int refsInUpdate = 0; + RefsUpdate refsUpdate = null; + try { + for (Ref ref : repo.getRefDatabase().getRefsByPrefix(RefNames.REFS_CHANGES)) { + if (result.fixedRefDiff.size() >= options.maxRefsToUpdate) { + return result; + } + Change.Id changeId = Change.Id.fromRef(ref.getName()); + if (changeId == null || !ref.getName().equals(RefNames.changeMetaRef(changeId))) { + continue; + } + try { + ImmutableSet<AccountState> accountsInChange = ImmutableSet.of(); + if (options.verifyCommits) { + try { + ChangeNotes changeNotes = changeNotesFactory.create(project, changeId); + accountsInChange = collectAccounts(changeNotes); + } catch (Exception e) { + logger.atWarning().withCause(e).log("Failed to run verification on ref %s", ref); + } + } + if (refsUpdate == null) { + refsUpdate = RefsUpdate.create(repo); + } + ChangeFixProgress changeFixProgress = + backfillChange(refsUpdate, ref, accountsInChange, options); + if (changeFixProgress.anyFixesApplied) { + refsInUpdate++; + refsUpdate + .batchRefUpdate() + .addCommand( + new ReceiveCommand( + ref.getObjectId(), changeFixProgress.newTipId, ref.getName())); + result.fixedRefDiff.put(ref.getName(), changeFixProgress.commitDiffs); + } + if (refsInUpdate >= options.maxRefsInBatch + || result.fixedRefDiff.size() >= options.maxRefsToUpdate) { + processUpdate(options, refsUpdate); + refsUpdate = null; + refsInUpdate = 0; + } + if (!changeFixProgress.isValidAfterFix) { + result.refsStillInvalidAfterFix.add(ref.getName()); + } + } catch (Exception e) { + logger.atWarning().withCause(e).log("Failed to fix ref %s", ref); + result.refsFailedToFix.add(ref.getName()); + } + } + processUpdate(options, refsUpdate); + } catch (IOException e) { + logger.atWarning().log("Failed to fix project %s. Reason: %s", project.get(), e.getMessage()); + result.ok = false; + } finally { + if (refsUpdate != null) { + refsUpdate.close(); + } + } + + return result; + } + + /** Executes a single {@link RefsUpdate#batchRefUpdate}. */ + private void processUpdate(RunOptions options, @Nullable RefsUpdate refsUpdate) + throws IOException { + if (refsUpdate == null) { + return; + } + if (!refsUpdate.batchRefUpdate().getCommands().isEmpty()) { + if (!options.dryRun) { + refsUpdate.inserter().flush(); + RefUpdateUtil.executeChecked(refsUpdate.batchRefUpdate(), refsUpdate.revWalk()); + } + } + refsUpdate.close(); + } + + /** + * Retrieves accounts, that are associated with a change (e.g. reviewers, commenters, etc.). These + * accounts are used to verify that commits do not contain user data. See {@link #verifyCommit} + * + * @param changeNotes {@link ChangeNotes} of the change to retrieve associated accounts from. + * @return {@link AccountState} of accounts, that are associated with the change. + */ + private ImmutableSet<AccountState> collectAccounts(ChangeNotes changeNotes) { + Set<Account.Id> accounts = new HashSet<>(); + accounts.add(changeNotes.getChange().getOwner()); + for (PatchSetApproval patchSetApproval : changeNotes.getApprovals().values()) { + if (patchSetApproval.accountId() != null) { + accounts.add(patchSetApproval.accountId()); + } + if (patchSetApproval.realAccountId() != null) { + accounts.add(patchSetApproval.realAccountId()); + } + } + accounts.addAll(changeNotes.getAllPastReviewers()); + accounts.addAll(changeNotes.getPastAssignees()); + changeNotes + .getAttentionSetUpdates() + .forEach(attentionSetUpdate -> accounts.add(attentionSetUpdate.account())); + for (SubmitRecord submitRecord : changeNotes.getSubmitRecords()) { + if (submitRecord.labels != null) { + accounts.addAll( + submitRecord.labels.stream() + .map(label -> label.appliedBy) + .filter(Objects::nonNull) + .collect(Collectors.toSet())); + } + } + for (HumanComment comment : changeNotes.getHumanComments().values()) { + if (comment.author != null) { + accounts.add(comment.author.getId()); + } + if (comment.getRealAuthor() != null) { + accounts.add(comment.getRealAuthor().getId()); + } + } + return ImmutableSet.copyOf(accountCache.get(accounts).values()); + } + + /** Verifies that the commit does not contain user data of accounts in {@code accounts}. */ + private boolean verifyCommit( + String commitMessage, PersonIdent author, Collection<AccountState> accounts) { + for (AccountState accountState : accounts) { + Account account = accountState.account(); + if (commitMessage.contains(account.getName())) { + return false; + } + if (account.fullName() != null && commitMessage.contains(account.fullName())) { + return false; + } + if (account.displayName() != null && commitMessage.contains(account.displayName())) { + return false; + } + if (account.preferredEmail() != null && commitMessage.contains(account.preferredEmail())) { + return false; + } + if (accountState.userName().isPresent() + && commitMessage.contains(accountState.userName().get())) { + return false; + } + Stream<String> allEmails = + accountState.externalIds().stream().map(ExternalId::email).filter(Objects::nonNull); + if (allEmails.anyMatch(email -> commitMessage.contains(email))) { + return false; + } + if (author.toString().contains(account.getName())) { + return false; + } + } + return true; + } + + /** + * Walks the ref history from oldest update to the most recent update, fixing the commits that + * contain user data case by case. Commit history is rewritten from the first commit, that needs + * to be updated, for all subsequent updates. The new ref tip is returned in {@link + * ChangeFixProgress#newTipId}. + */ + public ChangeFixProgress backfillChange( + RefsUpdate refsUpdate, + Ref ref, + ImmutableSet<AccountState> accountsInChange, + RunOptions options) + throws IOException, ConfigInvalidException { + + ObjectId oldTip = ref.getObjectId(); + // Walk from the first commit of the branch. + refsUpdate.revWalk().reset(); + refsUpdate.revWalk().markStart(refsUpdate.revWalk().parseCommit(oldTip)); + refsUpdate.revWalk().sort(RevSort.TOPO); + + refsUpdate.revWalk().sort(RevSort.REVERSE); + + RevCommit originalCommit; + + boolean rewriteStarted = false; + ChangeFixProgress changeFixProgress = new ChangeFixProgress(ref.getName()); + while ((originalCommit = refsUpdate.revWalk().next()) != null) { + + changeFixProgress.updateAuthorId = + parseIdent(changeFixProgress, originalCommit.getAuthorIdent()); + PersonIdent fixedAuthorIdent; + if (changeFixProgress.updateAuthorId.isPresent()) { + fixedAuthorIdent = + getFixedIdent(originalCommit.getAuthorIdent(), changeFixProgress.updateAuthorId.get()); + } else { + // Field to parse id from ident. Update by gerrit server or an old/broken change. + // Leave as it is. + fixedAuthorIdent = originalCommit.getAuthorIdent(); + } + Optional<String> fixedCommitMessage = fixedCommitMessage(originalCommit, changeFixProgress); + String commitMessage = + fixedCommitMessage.isPresent() + ? fixedCommitMessage.get() + : originalCommit.getFullMessage(); + if (options.verifyCommits) { + boolean isCommitValid = verifyCommit(commitMessage, fixedAuthorIdent, accountsInChange); + changeFixProgress.isValidAfterFix &= isCommitValid; + if (!isCommitValid) { + StringBuilder detailedVerificationStatus = + new StringBuilder( + String.format( + "Commit %s of ref %s failed verification after fix", + originalCommit.getId(), ref)); + detailedVerificationStatus.append("\nCommit body:\n"); + detailedVerificationStatus.append(commitMessage); + if (fixedCommitMessage.isPresent()) { + detailedVerificationStatus.append("\n was fixed.\n"); + } + detailedVerificationStatus.append("Commit author:\n"); + detailedVerificationStatus.append(fixedAuthorIdent.toString()); + logger.atWarning().log("%s", detailedVerificationStatus); + } + } + boolean needsFix = + !fixedAuthorIdent.equals(originalCommit.getAuthorIdent()) + || fixedCommitMessage.isPresent(); + + if (!rewriteStarted && !needsFix) { + changeFixProgress.newTipId = originalCommit; + continue; + } + rewriteStarted = true; + changeFixProgress.anyFixesApplied = true; + CommitBuilder cb = new CommitBuilder(); + if (changeFixProgress.newTipId != null) { + cb.setParentId(changeFixProgress.newTipId); + } + cb.setTreeId(originalCommit.getTree()); + cb.setMessage(commitMessage); + cb.setAuthor(fixedAuthorIdent); + cb.setCommitter(originalCommit.getCommitterIdent()); + cb.setEncoding(originalCommit.getEncoding()); + byte[] newCommitContent = cb.build(); + checkCommitModification(originalCommit, newCommitContent); + changeFixProgress.newTipId = + refsUpdate.inserter().insert(Constants.OBJ_COMMIT, newCommitContent); + // Only compute diff if the content of the commit was actually changed. + if (options.outputDiff && needsFix) { + String diff = computeDiff(originalCommit.getRawBuffer(), newCommitContent); + checkState( + !Strings.isNullOrEmpty(diff), + "Expected diff for commit %s of ref %s", + originalCommit.getId(), + ref.getName()); + changeFixProgress.commitDiffs.add(CommitDiff.create(originalCommit.getId(), diff)); + } else if (needsFix) { + // Always output old commits SHA1 + changeFixProgress.commitDiffs.add(CommitDiff.create(originalCommit.getId(), "")); + } + } + return changeFixProgress; + } + + /** + * In NoteDb, all the meta information is stored in footer lines. If we accidentally drop some of + * the footer lines, the original meta information will be lost, and the change might become + * unparsable. + * + * <p>While we can not verify the entire commit content, we at least make sure that the resulting + * commit has the same author, committer and footer lines are in the same order and contain same + * footer keys as the original commit. + * + * <p>Commit message and footer values might have been rewritten. + */ + private void checkCommitModification(RevCommit originalCommit, byte[] newCommitContent) + throws IOException { + RevCommit newCommit = RevCommit.parse(newCommitContent); + PersonIdent newAuthorIdent = newCommit.getAuthorIdent(); + PersonIdent originalAuthorIdent = originalCommit.getAuthorIdent(); + // The new commit must have same author and committer ident as the original commit. + if (!verifyPersonIdent(newAuthorIdent, originalAuthorIdent)) { + throw new IllegalStateException( + String.format( + "New author %s does not match original author %s", + newAuthorIdent.toExternalString(), originalAuthorIdent.toExternalString())); + } + PersonIdent newCommitterIdent = newCommit.getCommitterIdent(); + PersonIdent originalCommitterIdent = originalCommit.getCommitterIdent(); + if (!verifyPersonIdent(newCommitterIdent, originalCommitterIdent)) { + throw new IllegalStateException( + String.format( + "New committer %s does not match original committer %s", + newCommitterIdent.toExternalString(), originalCommitterIdent.toExternalString())); + } + + List<FooterLine> newFooterLines = newCommit.getFooterLines(); + List<FooterLine> originalFooterLines = originalCommit.getFooterLines(); + // Number and order of footer lines must remain the same, the value may have changed. + if (newFooterLines.size() != originalFooterLines.size()) { + String diff = computeDiff(originalCommit.getRawBuffer(), newCommitContent); + throw new IllegalStateException( + String.format( + "Expected footer lines in new commit to match original footer lines. Diff %s", diff)); + } + for (int i = 0; i < newFooterLines.size(); i++) { + FooterLine newFooterLine = newFooterLines.get(i); + FooterLine originalFooterLine = originalFooterLines.get(i); + if (!newFooterLine.getKey().equals(originalFooterLine.getKey())) { + String diff = computeDiff(originalCommit.getRawBuffer(), newCommitContent); + throw new IllegalStateException( + String.format( + "Expected footer lines in new commit to match original footer lines. Diff %s", + diff)); + } + } + } + + private boolean verifyPersonIdent(PersonIdent newIdent, PersonIdent originalIdent) { + return newIdent.getTimeZoneOffset() == originalIdent.getTimeZoneOffset() + && newIdent.getWhen().getTime() == originalIdent.getWhen().getTime() + && newIdent.getEmailAddress().equals(originalIdent.getEmailAddress()); + } + + private Optional<String> fixAssigneeChangeMessage( + ChangeFixProgress changeFixProgress, + Optional<Account.Id> oldAssignee, + Optional<Account.Id> newAssignee, + String originalChangeMessage) { + if (Strings.isNullOrEmpty(originalChangeMessage)) { + return Optional.empty(); + } + + Matcher assigneeDeletedMatcher = ASSIGNEE_DELETED_PATTERN.matcher(originalChangeMessage); + if (assigneeDeletedMatcher.matches()) { + if (!NON_REPLACE_ACCOUNT_PATTERN.matcher(assigneeDeletedMatcher.group(1)).matches()) { + Optional<String> assigneeReplacement = + getPossibleAccountReplacement( + changeFixProgress, + oldAssignee, + getAccountInfoFromNameEmail(assigneeDeletedMatcher.group(1))); + + return Optional.of( + assigneeReplacement.isPresent() + ? "Assignee deleted: " + assigneeReplacement.get() + : "Assignee was deleted."); + } + return Optional.empty(); + } + + Matcher assigneeAddedMatcher = ASSIGNEE_ADDED_PATTERN.matcher(originalChangeMessage); + if (assigneeAddedMatcher.matches()) { + if (!NON_REPLACE_ACCOUNT_PATTERN.matcher(assigneeAddedMatcher.group(1)).matches()) { + Optional<String> assigneeReplacement = + getPossibleAccountReplacement( + changeFixProgress, + newAssignee, + getAccountInfoFromNameEmail(assigneeAddedMatcher.group(1))); + return Optional.of( + assigneeReplacement.isPresent() + ? "Assignee added: " + assigneeReplacement.get() + : "Assignee was added."); + } + return Optional.empty(); + } + + Matcher assigneeChangedMatcher = ASSIGNEE_CHANGED_PATTERN.matcher(originalChangeMessage); + if (assigneeChangedMatcher.matches()) { + if (!NON_REPLACE_ACCOUNT_PATTERN.matcher(assigneeChangedMatcher.group(1)).matches()) { + Optional<String> oldAssigneeReplacement = + getPossibleAccountReplacement( + changeFixProgress, + oldAssignee, + getAccountInfoFromNameEmail(assigneeChangedMatcher.group(1))); + Optional<String> newAssigneeReplacement = + getPossibleAccountReplacement( + changeFixProgress, + newAssignee, + getAccountInfoFromNameEmail(assigneeChangedMatcher.group(2))); + return Optional.of( + oldAssigneeReplacement.isPresent() && newAssigneeReplacement.isPresent() + ? String.format( + "Assignee changed from: %s to: %s", + oldAssigneeReplacement.get(), newAssigneeReplacement.get()) + : "Assignee was changed."); + } + return Optional.empty(); + } + return Optional.empty(); + } + + private Optional<String> fixReviewerChangeMessage(String originalChangeMessage) { + if (Strings.isNullOrEmpty(originalChangeMessage)) { + return Optional.empty(); + } + Matcher matcher = REMOVED_REVIEWER_PATTERN.matcher(originalChangeMessage); + + if (matcher.matches() && !ACCOUNT_TEMPLATE_PATTERN.matcher(matcher.group(2)).matches()) { + // Since we do not use change messages for reviewer updates on UI, it does not matter what we + // rewrite it to. + return Optional.of(originalChangeMessage.substring(0, matcher.end(1))); + } + return Optional.empty(); + } + + private Optional<String> fixRemoveVoteChangeMessage( + ChangeFixProgress changeFixProgress, + Optional<Account.Id> reviewer, + String originalChangeMessage) { + if (Strings.isNullOrEmpty(originalChangeMessage)) { + return Optional.empty(); + } + + Matcher matcher = REMOVED_VOTE_PATTERN.matcher(originalChangeMessage); + if (matcher.matches() && !NON_REPLACE_ACCOUNT_PATTERN.matcher(matcher.group(2)).matches()) { + Optional<String> reviewerReplacement = + getPossibleAccountReplacement( + changeFixProgress, reviewer, getAccountInfoFromNameEmail(matcher.group(2))); + StringBuilder replacement = new StringBuilder(); + replacement.append("Removed ").append(matcher.group(1)); + if (reviewerReplacement.isPresent()) { + replacement.append(" by ").append(reviewerReplacement.get()); + } + return Optional.of(replacement.toString()); + } + return Optional.empty(); + } + + private Optional<String> fixRemoveVotesChangeMessage( + ChangeFixProgress changeFixProgress, String originalChangeMessage) { + if (Strings.isNullOrEmpty(originalChangeMessage) + || !originalChangeMessage.startsWith(REMOVED_VOTES_CHANGE_MESSAGE_START)) { + return Optional.empty(); + } + String[] lines = originalChangeMessage.split("\\r?\\n"); + StringBuilder fixedLines = new StringBuilder(); + boolean anyFixed = false; + for (int i = 1; i < lines.length; i++) { + if (lines[i].isEmpty()) { + continue; + } + Matcher matcher = REMOVED_VOTES_CHANGE_MESSAGE_PATTERN.matcher(lines[i]); + String replacementLine = lines[i]; + if (matcher.matches() && !NON_REPLACE_ACCOUNT_PATTERN.matcher(matcher.group(2)).matches()) { + anyFixed = true; + Optional<String> reviewerReplacement = + getPossibleAccountReplacement( + changeFixProgress, Optional.empty(), getAccountInfoFromNameEmail(matcher.group(2))); + replacementLine = "* " + matcher.group(1); + if (reviewerReplacement.isPresent()) { + replacementLine += " by " + reviewerReplacement.get(); + } + replacementLine += "\n"; + } + fixedLines.append(replacementLine); + } + if (!anyFixed) { + return Optional.empty(); + } + return Optional.of(REMOVED_VOTES_CHANGE_MESSAGE_START + "\n" + fixedLines); + } + + private Optional<String> fixDeleteChangeMessageCommitMessage(String originalChangeMessage) { + if (Strings.isNullOrEmpty(originalChangeMessage)) { + return Optional.empty(); + } + + Matcher matcher = REMOVED_CHANGE_MESSAGE_PATTERN.matcher(originalChangeMessage); + if (matcher.matches() && !ACCOUNT_TEMPLATE_PATTERN.matcher(matcher.group(1)).matches()) { + String fixedMessage = "Change message removed"; + if (matcher.group(2) != null) { + fixedMessage += matcher.group(2); + } + return Optional.of(fixedMessage); + } + return Optional.empty(); + } + + private Optional<String> fixSubmitChangeMessage(String originalChangeMessage) { + if (Strings.isNullOrEmpty(originalChangeMessage)) { + return Optional.empty(); + } + + Matcher matcher = SUBMITTED_PATTERN.matcher(originalChangeMessage); + if (matcher.matches()) { + // See https://gerrit-review.googlesource.com/c/gerrit/+/272654 + return Optional.of(originalChangeMessage.substring(0, matcher.end(1))); + } + return Optional.empty(); + } + + /** + * Rewrites a code owners change message. + * + * <p>See https://gerrit-review.googlesource.com/c/plugins/code-owners/+/305409 + */ + private Optional<String> fixCodeOwnersOnAddReviewerChangeMessage( + ChangeFixProgress changeFixProgress, String originalMessage) { + if (Strings.isNullOrEmpty(originalMessage)) { + return Optional.empty(); + } + + Matcher onAddReviewerMatcher = ON_CODE_OWNER_ADD_REVIEWER_PATTERN.matcher(originalMessage); + if (!onAddReviewerMatcher.find() + || NON_REPLACE_ACCOUNT_PATTERN + .matcher(normalizeOnCodeOwnerAddReviewerMatch(onAddReviewerMatcher.group(1))) + .matches()) { + return Optional.empty(); + } + + // Pre fix, try to replace with something meaningful. + // Retrieve reviewer accounts from cache and try to match by their name. + onAddReviewerMatcher.reset(); + StringBuffer sb = new StringBuffer(); + while (onAddReviewerMatcher.find()) { + String reviewerName = normalizeOnCodeOwnerAddReviewerMatch(onAddReviewerMatcher.group(1)); + Optional<String> replacementName = + getPossibleAccountReplacement( + changeFixProgress, Optional.empty(), ParsedAccountInfo.create(reviewerName)); + onAddReviewerMatcher.appendReplacement( + sb, + replacementName.isPresent() + ? replacementName.get() + ", who was added as reviewer owns the following files" + : "Added reviewer owns the following files"); + } + onAddReviewerMatcher.appendTail(sb); + sb.append("\n"); + return Optional.of(sb.toString()); + } + + /** + * See {@link #ON_CODE_OWNER_ADD_REVIEWER_PATTERN}. + * + * <p>Some of the messages have format '{@link AccountTemplateUtil#ACCOUNT_TEMPLATE}, who...', + * while others '{@link AccountTemplateUtil#ACCOUNT_TEMPLATE} who...'. + * + * <p>Cut the trailing ',' from the match, so that valid patterns are not replaced. + */ + private static String normalizeOnCodeOwnerAddReviewerMatch(String reviewerMatch) { + String reviewerName = reviewerMatch; + if (reviewerName.charAt(reviewerName.length() - 1) == ',') { + reviewerName = reviewerName.substring(0, reviewerName.length() - 1); + } + return reviewerName; + } + + private Optional<String> fixCodeOwnersOnReviewChangeMessage( + Optional<Account.Id> reviewer, String originalMessage) { + if (Strings.isNullOrEmpty(originalMessage)) { + return Optional.empty(); + } + Matcher onCodeOwnerPostReviewMatcher = + ON_CODE_OWNER_POST_REVIEW_PATTERN.matcher(originalMessage); + if (!onCodeOwnerPostReviewMatcher.matches()) { + return Optional.empty(); + } + Matcher onCodeOwnerReviewMatcher = ON_CODE_OWNER_REVIEW_PATTERN.matcher(originalMessage); + while (onCodeOwnerReviewMatcher.find()) { + String accountName = + firstNonNull(onCodeOwnerReviewMatcher.group(1), onCodeOwnerReviewMatcher.group(2)); + if (!ACCOUNT_TEMPLATE_PATTERN.matcher(accountName).matches()) { + return Optional.of( + originalMessage.replace( + "by " + accountName, + "by " + + reviewer + .map(AccountTemplateUtil::getAccountTemplate) + .orElse(DEFAULT_ACCOUNT_REPLACEMENT)) + + "\n"); + } + } + + return Optional.empty(); + } + + private Optional<String> fixAttentionSetReason(String originalReason) { + if (Strings.isNullOrEmpty(originalReason)) { + return Optional.empty(); + } + // Only the latest attention set updates are displayed on UI. As long as reason is + // human-readable, it does not matter what we rewrite it to. + + Matcher replyByReasonMatcher = REPLY_BY_REASON_PATTERN.matcher(originalReason); + if (replyByReasonMatcher.matches() + && !OK_ACCOUNT_NAME_PATTERN.matcher(replyByReasonMatcher.group(1)).matches()) { + return Optional.of("Someone replied on the change"); + } + + Matcher addedByReasonMatcher = ADDED_BY_REASON_PATTERN.matcher(originalReason); + if (addedByReasonMatcher.matches() + && !OK_ACCOUNT_NAME_PATTERN.matcher(addedByReasonMatcher.group(1)).matches()) { + return Optional.of("Added by someone using the hovercard menu"); + } + + Matcher removedByReasonMatcher = REMOVED_BY_REASON_PATTERN.matcher(originalReason); + if (removedByReasonMatcher.matches() + && !OK_ACCOUNT_NAME_PATTERN.matcher(removedByReasonMatcher.group(1)).matches()) { + + return Optional.of("Removed by someone using the hovercard menu"); + } + + Matcher removedByIconClickReasonMatcher = + REMOVED_BY_ICON_CLICK_REASON_PATTERN.matcher(originalReason); + if (removedByIconClickReasonMatcher.matches() + && !OK_ACCOUNT_NAME_PATTERN.matcher(removedByIconClickReasonMatcher.group(1)).matches()) { + + return Optional.of("Removed by someone by clicking the attention icon"); + } + return Optional.empty(); + } + + /** + * Fixes commit body case by case, so it does not contain user data. Returns fixed commit message, + * or {@link Optional#empty} if no fixes were applied. + */ + private Optional<String> fixedCommitMessage(RevCommit revCommit, ChangeFixProgress fixProgress) + throws ConfigInvalidException { + byte[] raw = revCommit.getRawBuffer(); + Charset enc = RawParseUtils.parseEncoding(raw); + Optional<CommitMessageRange> commitMessageRange = + ChangeNoteUtil.parseCommitMessageRange(revCommit); + if (!commitMessageRange.isPresent()) { + throw new ConfigInvalidException("Failed to parse commit message " + revCommit.getName()); + } + String changeSubject = + RawParseUtils.decode( + enc, + raw, + commitMessageRange.get().subjectStart(), + commitMessageRange.get().subjectEnd()); + Optional<String> fixedChangeMessage = Optional.empty(); + String originalChangeMessage = null; + if (commitMessageRange.isPresent() && commitMessageRange.get().hasChangeMessage()) { + originalChangeMessage = + RawParseUtils.decode( + enc, + raw, + commitMessageRange.get().changeMessageStart(), + commitMessageRange.get().changeMessageEnd() + 1) + .trim(); + } + List<FooterLine> footerLines = revCommit.getFooterLines(); + StringBuilder footerLinesBuilder = new StringBuilder(); + boolean anyFootersFixed = false; + for (FooterLine fl : footerLines) { + String footerKey = fl.getKey(); + String footerValue = fl.getValue(); + if (footerKey.equalsIgnoreCase(FOOTER_TAG.getName())) { + fixProgress.tag = footerValue; + } else if (footerKey.equalsIgnoreCase(FOOTER_ASSIGNEE.getName())) { + Account.Id oldAssignee = fixProgress.assigneeId; + FixIdentResult fixedAssignee = null; + if (footerValue.equals("")) { + fixProgress.assigneeId = null; + } else { + fixedAssignee = getFixedIdentString(fixProgress, footerValue); + fixProgress.assigneeId = fixedAssignee.accountId; + } + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = + fixAssigneeChangeMessage( + fixProgress, + Optional.ofNullable(oldAssignee), + Optional.ofNullable(fixProgress.assigneeId), + originalChangeMessage); + } + if (fixedAssignee != null && fixedAssignee.fixedIdentString.isPresent()) { + addFooter(footerLinesBuilder, footerKey, fixedAssignee.fixedIdentString.get()); + anyFootersFixed = true; + continue; + } + } else if (Arrays.stream(ReviewerStateInternal.values()) + .anyMatch(state -> footerKey.equalsIgnoreCase(state.getFooterKey().getName()))) { + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = fixReviewerChangeMessage(originalChangeMessage); + } + FixIdentResult fixedReviewer = getFixedIdentString(fixProgress, footerValue); + if (fixedReviewer.fixedIdentString.isPresent()) { + addFooter(footerLinesBuilder, footerKey, fixedReviewer.fixedIdentString.get()); + anyFootersFixed = true; + continue; + } + } else if (footerKey.equalsIgnoreCase(FOOTER_REAL_USER.getName())) { + FixIdentResult fixedRealUser = getFixedIdentString(fixProgress, footerValue); + if (fixedRealUser.fixedIdentString.isPresent()) { + addFooter(footerLinesBuilder, footerKey, fixedRealUser.fixedIdentString.get()); + anyFootersFixed = true; + continue; + } + } else if (footerKey.equalsIgnoreCase(FOOTER_LABEL.getName())) { + int voterIdentStart = footerValue.indexOf(' '); + FixIdentResult fixedVoter = null; + if (voterIdentStart > 0) { + String originalIdentString = footerValue.substring(voterIdentStart + 1); + fixedVoter = getFixedIdentString(fixProgress, originalIdentString); + } + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = + fixRemoveVoteChangeMessage( + fixProgress, + fixedVoter == null + ? fixProgress.updateAuthorId + : Optional.of(fixedVoter.accountId), + originalChangeMessage); + } + if (fixedVoter != null && fixedVoter.fixedIdentString.isPresent()) { + String fixedLabelVote = + footerValue.substring(0, voterIdentStart) + " " + fixedVoter.fixedIdentString.get(); + addFooter(footerLinesBuilder, footerKey, fixedLabelVote); + anyFootersFixed = true; + continue; + } + } else if (footerKey.equalsIgnoreCase(FOOTER_SUBMITTED_WITH.getName())) { + // Record format: + // Submitted-with: OK + // Submitted-with: OK: Code-Review: User Name <accountId@serverId> + int voterIdentStart = StringUtils.ordinalIndexOf(footerValue, ": ", 2); + if (voterIdentStart >= 0) { + String originalIdentString = footerValue.substring(voterIdentStart + 2); + FixIdentResult fixedVoter = getFixedIdentString(fixProgress, originalIdentString); + if (fixedVoter.fixedIdentString.isPresent()) { + String fixedLabelVote = + footerValue.substring(0, voterIdentStart) + + ": " + + fixedVoter.fixedIdentString.get(); + addFooter(footerLinesBuilder, footerKey, fixedLabelVote); + anyFootersFixed = true; + continue; + } + } + + } else if (footerKey.equalsIgnoreCase(FOOTER_ATTENTION.getName())) { + AttentionStatusInNoteDb originalAttentionSetUpdate = + gson.fromJson(footerValue, AttentionStatusInNoteDb.class); + FixIdentResult fixedAttentionAccount = + getFixedIdentString(fixProgress, originalAttentionSetUpdate.personIdent); + Optional<String> fixedReason = fixAttentionSetReason(originalAttentionSetUpdate.reason); + if (fixedAttentionAccount.fixedIdentString.isPresent() || fixedReason.isPresent()) { + AttentionStatusInNoteDb fixedAttentionSetUpdate = + new AttentionStatusInNoteDb( + fixedAttentionAccount.fixedIdentString.isPresent() + ? fixedAttentionAccount.fixedIdentString.get() + : originalAttentionSetUpdate.personIdent, + originalAttentionSetUpdate.operation, + fixedReason.isPresent() ? fixedReason.get() : originalAttentionSetUpdate.reason); + addFooter(footerLinesBuilder, footerKey, gson.toJson(fixedAttentionSetUpdate)); + anyFootersFixed = true; + continue; + } + } + addFooter(footerLinesBuilder, footerKey, footerValue); + } + // Some of the old commits are missing corresponding footers but still have change messages that + // need the fix. For such cases, try to guess or replace with the default string (see + // getPossibleAccountReplacement) + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = fixReviewerChangeMessage(originalChangeMessage); + } + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = fixRemoveVotesChangeMessage(fixProgress, originalChangeMessage); + } + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = + fixRemoveVoteChangeMessage(fixProgress, Optional.empty(), originalChangeMessage); + } + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = + fixAssigneeChangeMessage( + fixProgress, Optional.empty(), Optional.empty(), originalChangeMessage); + } + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = fixSubmitChangeMessage(originalChangeMessage); + } + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = fixDeleteChangeMessageCommitMessage(originalChangeMessage); + } + if (!fixedChangeMessage.isPresent()) { + fixedChangeMessage = + fixCodeOwnersOnReviewChangeMessage(fixProgress.updateAuthorId, originalChangeMessage); + } + if (!fixedChangeMessage.isPresent() + && Objects.equals(fixProgress.tag, CODE_OWNER_ADD_REVIEWER_TAG)) { + fixedChangeMessage = + fixCodeOwnersOnAddReviewerChangeMessage(fixProgress, originalChangeMessage); + } + if (!anyFootersFixed && !fixedChangeMessage.isPresent()) { + return Optional.empty(); + } + StringBuilder fixedCommitBuilder = new StringBuilder(); + fixedCommitBuilder.append(changeSubject); + fixedCommitBuilder.append("\n\n"); + if (commitMessageRange.get().hasChangeMessage()) { + fixedCommitBuilder.append(fixedChangeMessage.orElse(originalChangeMessage)); + fixedCommitBuilder.append("\n\n"); + } + fixedCommitBuilder.append(footerLinesBuilder); + return Optional.of(fixedCommitBuilder.toString()); + } + + private static StringBuilder addFooter(StringBuilder sb, String footer, String value) { + if (value == null) { + return sb; + } + sb.append(footer).append(":"); + sb.append(" ").append(value); + sb.append('\n'); + return sb; + } + + private Optional<Account.Id> parseIdent(ChangeFixProgress changeFixProgress, PersonIdent ident) { + Optional<Account.Id> account = NoteDbUtil.parseIdent(ident); + if (account.isPresent()) { + changeFixProgress.parsedAccounts.putIfAbsent(account.get(), Optional.empty()); + } else { + logger.atWarning().log( + "Fixing ref %s, failed to parse id %s", changeFixProgress.changeMetaRef, ident); + } + return account; + } + + /** + * Fixes {@code originalIdent} so it does not contain user data, see {@link + * ChangeNoteUtil#getAccountIdAsUsername}. + */ + private PersonIdent getFixedIdent(PersonIdent originalIdent, Account.Id identAccount) { + return new PersonIdent( + ChangeNoteUtil.getAccountIdAsUsername(identAccount), + originalIdent.getEmailAddress(), + originalIdent.getWhen(), + originalIdent.getTimeZone()); + } + + /** + * Parses {@code originalIdentString} and applies the fix, so it does not contain user data, see + * {@link ChangeNoteUtil#appendAccountIdIdentString}. + * + * @param changeFixProgress see {@link ChangeFixProgress} + * @param originalIdentString ident to apply the fix to. + * @return {@link FixIdentResult}, with {@link FixIdentResult#accountId} parsed from {@code + * originalIdentString} and {@link FixIdentResult#fixedIdentString} if the fix was applied. + * @throws ConfigInvalidException if could not parse {@link FixIdentResult#accountId} from {@code + * originalIdentString} + */ + private FixIdentResult getFixedIdentString( + ChangeFixProgress changeFixProgress, String originalIdentString) + throws ConfigInvalidException { + FixIdentResult fixIdentResult = new FixIdentResult(); + PersonIdent originalIdent = RawParseUtils.parsePersonIdent(originalIdentString); + // Ident as String is saved in NoteDB footers, if this fails to parse, something is + // wrong with the change and we better not touch it. + fixIdentResult.accountId = + parseIdent(changeFixProgress, originalIdent) + .orElseThrow( + () -> new ConfigInvalidException("field to parse id: " + originalIdentString)); + String fixedIdentString = + ChangeNoteUtil.formatAccountIdentString( + fixIdentResult.accountId, originalIdent.getEmailAddress()); + fixIdentResult.fixedIdentString = + fixedIdentString.equals(originalIdentString) + ? Optional.empty() + : Optional.of(fixedIdentString); + return fixIdentResult; + } + + /** Extracts {@link ParsedAccountInfo} from {@link Account#getNameEmail} */ + private ParsedAccountInfo getAccountInfoFromNameEmail(String nameEmail) { + Matcher nameEmailMatcher = NAME_EMAIL_PATTERN.matcher(nameEmail); + if (!nameEmailMatcher.matches()) { + return ParsedAccountInfo.create(nameEmail); + } + + return ParsedAccountInfo.create( + nameEmailMatcher.group(1), + nameEmailMatcher.group(2).substring(1, nameEmailMatcher.group(2).length() - 1)); + } + + /** + * Returns replacement for {@code accountName}. + * + * <p>If {@code account} is known, replace with {@link AccountTemplateUtil#getAccountTemplate}. + * Otherwise, try to guess the correct replacement account for {@code accountName} among {@link + * ChangeFixProgress#parsedAccounts} that appeared in the change. If this fails {@link + * Optional#empty} is returned. + * + * @param changeFixProgress see {@link ChangeFixProgress} + * @param account account that should be used for replacement, if known + * @param accountInfo {@link ParsedAccountInfo} to replace. + * @return replacement for {@code accountName} or {@link Optional#empty}, if the replacement could + * not be determined. + */ + private Optional<String> getPossibleAccountReplacement( + ChangeFixProgress changeFixProgress, + Optional<Account.Id> account, + ParsedAccountInfo accountInfo) { + if (account.isPresent()) { + return Optional.of(AccountTemplateUtil.getAccountTemplate(account.get())); + } + // Retrieve reviewer accounts from cache and try to match by their name. + Map<Account.Id, AccountState> missingAccountStateReviewers = + accountCache.get( + changeFixProgress.parsedAccounts.entrySet().stream() + .filter(entry -> !entry.getValue().isPresent()) + .map(Map.Entry::getKey) + .collect(ImmutableSet.toImmutableSet())); + changeFixProgress.parsedAccounts.putAll( + missingAccountStateReviewers.entrySet().stream() + .collect( + ImmutableMap.toImmutableMap( + Map.Entry::getKey, e -> Optional.ofNullable(e.getValue())))); + Map<Account.Id, AccountState> possibleReplacements = ImmutableMap.of(); + if (accountInfo.email().isPresent()) { + possibleReplacements = + changeFixProgress.parsedAccounts.entrySet().stream() + .filter( + e -> + e.getValue().isPresent() + && Objects.equals( + e.getValue().get().account().preferredEmail(), + accountInfo.email().get())) + .collect(ImmutableMap.toImmutableMap(Map.Entry::getKey, e -> e.getValue().get())); + // Filter further so we match both email & name + if (possibleReplacements.size() > 1) { + logger.atWarning().log( + "Fixing ref %s, multiple accounts found with the same email address, while replacing %s", + changeFixProgress.changeMetaRef, accountInfo); + possibleReplacements = + possibleReplacements.entrySet().stream() + .filter(e -> Objects.equals(e.getValue().account().getName(), accountInfo.name())) + .collect(ImmutableMap.toImmutableMap(Map.Entry::getKey, Map.Entry::getValue)); + } + } + if (possibleReplacements.isEmpty()) { + possibleReplacements = + changeFixProgress.parsedAccounts.entrySet().stream() + .filter( + e -> + e.getValue().isPresent() + && Objects.equals( + e.getValue().get().account().getName(), accountInfo.name())) + .collect(ImmutableMap.toImmutableMap(Map.Entry::getKey, e -> e.getValue().get())); + } + Optional<String> replacementName = Optional.empty(); + if (possibleReplacements.isEmpty()) { + logger.atWarning().log( + "Fixing ref %s, could not find reviewer account matching name %s", + changeFixProgress.changeMetaRef, accountInfo); + } else if (possibleReplacements.size() > 1) { + logger.atWarning().log( + "Fixing ref %s found multiple reviewer account matching name %s", + changeFixProgress.changeMetaRef, accountInfo); + } else { + replacementName = + Optional.of( + AccountTemplateUtil.getAccountTemplate( + Iterables.getOnlyElement(possibleReplacements.keySet()))); + } + return replacementName; + } + + /** + * Cuts tree and parent lines from raw unparsed commit body, so they are not included in diff + * comparison. + * + * @param b raw unparsed commit body, see {@link RevCommit#getRawBuffer()}. + * <p>For parsing, see {@link RawParseUtils#author}, {@link RawParseUtils#commitMessage}, etc. + * @return raw unparsed commit body, without tree and parent lines. + */ + public static byte[] cutTreeAndParents(byte[] b) { + final int sz = b.length; + int ptr = 46; // skip the "tree ..." line. + while (ptr < sz && b[ptr] == 'p') { + ptr += 48; + } // skip this parent. + return Arrays.copyOfRange(b, ptr, b.length + 1); + } + + private String computeDiff(byte[] oldCommit, byte[] newCommit) throws IOException { + RawText oldBody = new RawText(cutTreeAndParents(oldCommit)); + RawText newBody = new RawText(cutTreeAndParents(newCommit)); + ByteArrayOutputStream out = new ByteArrayOutputStream(); + EditList diff = diffAlgorithm.diff(RawTextComparator.DEFAULT, oldBody, newBody); + try (DiffFormatter fmt = new DiffFormatter(out)) { + // Do not show any unchanged lines, since it is not interesting + fmt.setContext(0); + fmt.format(diff, oldBody, newBody); + fmt.flush(); + return out.toString(UTF_8); + } + } + + private static ObjectInserter newPackInserter(Repository repo) { + if (!(repo instanceof FileRepository)) { + return repo.newObjectInserter(); + } + PackInserter ins = ((FileRepository) repo).getObjectDatabase().newPackInserter(); + ins.checkExisting(false); + return ins; + } + + /** + * Parsed and fixed {@link PersonIdent} string, formatted as {@link + * ChangeNoteUtil#appendAccountIdIdentString} + */ + private static class FixIdentResult { + + /** {@link com.google.gerrit.entities.Account.Id} parsed from PersonIdent string. */ + Account.Id accountId; + /** + * Fixed ident string, that does not contain user data, or {@link Optional#empty} if fix was not + * required. + */ + Optional<String> fixedIdentString; + } + + /** + * Holds the state of change rewrite progress. Rewrite goes from the oldest commit to the most + * recent update. + */ + private static class ChangeFixProgress { + + /** {@link RefNames#changeMetaRef} of the change that is being fixed. */ + final String changeMetaRef; + + /** Tag at current commit update. */ + String tag = null; + + /** Assignee at current commit update. */ + Account.Id assigneeId = null; + + /** Author of the current commit update. */ + Optional<Account.Id> updateAuthorId = null; + + /** + * Accounts parsed so far together with their {@link Account#getName} extracted from {@link + * #accountCache} if needed by rewrite. Maps to empty string if was not requested from cache + * yet. + */ + Map<Account.Id, Optional<AccountState>> parsedAccounts = new HashMap<>(); + + /** Id of the current commit in rewriter walk. */ + ObjectId newTipId = null; + /** If any commits were rewritten by the rewriter. */ + boolean anyFixesApplied = false; + + /** + * Whether all commits seen by the rewriter with the fixes applied passed the verification, see + * {@link #verifyCommit}. + */ + boolean isValidAfterFix = true; + + List<CommitDiff> commitDiffs = new ArrayList<>(); + + public ChangeFixProgress(String changeMetaRef) { + this.changeMetaRef = changeMetaRef; + } + } + + /** + * Account info parsed from {@link Account#getNameEmail}. See {@link + * #getAccountInfoFromNameEmail}. + */ + @AutoValue + abstract static class ParsedAccountInfo { + + static ParsedAccountInfo create(String fullName, String email) { + return new AutoValue_CommitRewriter_ParsedAccountInfo(fullName, Optional.ofNullable(email)); + } + + static ParsedAccountInfo create(String fullName) { + return new AutoValue_CommitRewriter_ParsedAccountInfo(fullName, Optional.empty()); + } + + abstract String name(); + + abstract Optional<String> email(); + } + + /** + * Objects, needed to fix Refs in a single {@link BatchRefUpdate}. Number of changes in a batch + * are limited by {@link RunOptions#maxRefsInBatch}. + */ + @AutoValue + abstract static class RefsUpdate implements AutoCloseable { + static RefsUpdate create(Repository repo) { + RevWalk revWalk = new RevWalk(repo); + ObjectInserter inserter = newPackInserter(repo); + BatchRefUpdate bru = repo.getRefDatabase().newBatchUpdate(); + bru.setForceRefLog(true); + bru.setRefLogMessage(CommitRewriter.class.getName(), false); + bru.setAllowNonFastForwards(true); + return new AutoValue_CommitRewriter_RefsUpdate(bru, revWalk, inserter); + } + + @Override + public void close() { + inserter().close(); + revWalk().close(); + } + + abstract BatchRefUpdate batchRefUpdate(); + + abstract RevWalk revWalk(); + + abstract ObjectInserter inserter(); + } +}
diff --git a/java/com/google/gerrit/server/notedb/DeleteChangeMessageRewriter.java b/java/com/google/gerrit/server/notedb/DeleteChangeMessageRewriter.java index b555fdb..6d6d53d 100644 --- a/java/com/google/gerrit/server/notedb/DeleteChangeMessageRewriter.java +++ b/java/com/google/gerrit/server/notedb/DeleteChangeMessageRewriter.java
@@ -88,7 +88,8 @@ byte[] raw = commit.getRawBuffer(); Optional<ChangeNoteUtil.CommitMessageRange> range = parseCommitMessageRange(commit); - checkState(range.isPresent(), "failed to parse commit message"); + checkState( + range.isPresent() && range.get().hasChangeMessage(), "failed to parse commit message"); // Only replace the commit message body, which is the user-provided message. The subject and // footers are NoteDb metadata. @@ -109,7 +110,6 @@ * @param commitMessage the full commit message of the new commit. * @param inserter the {@code ObjectInserter} for the rewrite process. * @return the {@code objectId} of the new commit. - * @throws IOException */ private ObjectId rewriteOneCommit( RevCommit originalCommit,
diff --git a/java/com/google/gerrit/server/notedb/DeleteCommentRewriter.java b/java/com/google/gerrit/server/notedb/DeleteCommentRewriter.java index d0b6247..e8c0fda 100644 --- a/java/com/google/gerrit/server/notedb/DeleteCommentRewriter.java +++ b/java/com/google/gerrit/server/notedb/DeleteCommentRewriter.java
@@ -191,8 +191,6 @@ * @param putInComments the comments put in by this commit. * @param deletedComments the comments deleted by this commit. * @return the {@code objectId} of the new commit. - * @throws IOException - * @throws ConfigInvalidException */ private ObjectId rewriteCommit( RevCommit originalCommit,
diff --git a/java/com/google/gerrit/server/notedb/NoteDbUpdateManager.java b/java/com/google/gerrit/server/notedb/NoteDbUpdateManager.java index 65758f9..e817fe6 100644 --- a/java/com/google/gerrit/server/notedb/NoteDbUpdateManager.java +++ b/java/com/google/gerrit/server/notedb/NoteDbUpdateManager.java
@@ -31,6 +31,8 @@ import com.google.gerrit.git.RefUpdateUtil; import com.google.gerrit.metrics.Timer0; import com.google.gerrit.server.GerritPersonIdent; +import com.google.gerrit.server.cancellation.RequestStateContext; +import com.google.gerrit.server.cancellation.RequestStateContext.NonCancellableOperationContext; import com.google.gerrit.server.config.AllUsersName; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.git.GitRepositoryManager; @@ -304,6 +306,12 @@ } } + public BatchRefUpdate prepare() throws IOException { + checkNotExecuted(); + stage(); + return prepare(changeRepo, false, pushCert); + } + @Nullable public BatchRefUpdate execute() throws IOException { return execute(false); @@ -316,7 +324,9 @@ executed = true; return null; } - try (Timer0.Context timer = metrics.updateLatency.start()) { + try (Timer0.Context timer = metrics.updateLatency.start(); + NonCancellableOperationContext nonCancellableOperationContext = + RequestStateContext.startNonCancellableOperation()) { stage(); // ChangeUpdates must execute before ChangeDraftUpdates. // @@ -349,7 +359,7 @@ } } - private BatchRefUpdate execute(OpenRepo or, boolean dryrun, @Nullable PushCertificate pushCert) + private BatchRefUpdate prepare(OpenRepo or, boolean dryrun, @Nullable PushCertificate pushCert) throws IOException { if (or == null || or.cmds.isEmpty()) { return null; @@ -378,7 +388,13 @@ bru = listener.beforeUpdateRefs(bru); } - if (!dryrun) { + return bru; + } + + private BatchRefUpdate execute(OpenRepo or, boolean dryrun, @Nullable PushCertificate pushCert) + throws IOException { + BatchRefUpdate bru = prepare(or, dryrun, pushCert); + if (bru != null && !dryrun) { RefUpdateUtil.executeChecked(bru, or.rw); } return bru;
diff --git a/java/com/google/gerrit/server/notedb/RevisionNoteBuilder.java b/java/com/google/gerrit/server/notedb/RevisionNoteBuilder.java index 3c1d359..7998476 100644 --- a/java/com/google/gerrit/server/notedb/RevisionNoteBuilder.java +++ b/java/com/google/gerrit/server/notedb/RevisionNoteBuilder.java
@@ -22,16 +22,20 @@ import com.google.common.collect.Maps; import com.google.common.collect.MultimapBuilder; import com.google.gerrit.entities.Comment; +import com.google.gerrit.entities.SubmitRequirementResult; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.OutputStream; import java.io.OutputStreamWriter; +import java.util.ArrayList; import java.util.Collections; +import java.util.Comparator; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Set; +import java.util.stream.Collectors; import org.eclipse.jgit.lib.AnyObjectId; import org.eclipse.jgit.lib.ObjectId; @@ -60,11 +64,16 @@ } } + /** Submit requirements are sorted w.r.t. their names before storing in NoteDb. */ + private final Comparator<SubmitRequirementResult> SUBMIT_REQUIREMENT_RESULT_COMPARATOR = + Comparator.comparing(sr -> sr.submitRequirement().name()); + final byte[] baseRaw; private final List<? extends Comment> baseComments; final Map<Comment.Key, Comment> put; private final Set<Comment.Key> delete; + private List<SubmitRequirementResult> submitRequirementResults; private String pushCert; private RevisionNoteBuilder(RevisionNote<? extends Comment> base) { @@ -81,6 +90,7 @@ put = new HashMap<>(); pushCert = null; } + submitRequirementResults = new ArrayList<>(); delete = new HashSet<>(); } @@ -99,6 +109,10 @@ put.put(comment.key, comment); } + void putSubmitRequirementResult(SubmitRequirementResult result) { + submitRequirementResults.add(result); + } + void deleteComment(Comment.Key key) { checkArgument(!put.containsKey(key), "cannot both delete and put %s", key); delete.add(key); @@ -126,13 +140,19 @@ private void buildNoteJson(ChangeNoteJson noteUtil, OutputStream out) throws IOException { ListMultimap<Integer, Comment> comments = buildCommentMap(); - if (comments.isEmpty() && pushCert == null) { + if (submitRequirementResults.isEmpty() && comments.isEmpty() && pushCert == null) { return; } RevisionNoteData data = new RevisionNoteData(); data.comments = COMMENT_ORDER.sortedCopy(comments.values()); data.pushCert = pushCert; + if (!submitRequirementResults.isEmpty()) { + data.submitRequirementResults = + submitRequirementResults.stream() + .sorted(SUBMIT_REQUIREMENT_RESULT_COMPARATOR) + .collect(Collectors.toList()); + } try (OutputStreamWriter osw = new OutputStreamWriter(out, UTF_8)) { noteUtil.getGson().toJson(data, osw);
diff --git a/java/com/google/gerrit/server/notedb/RevisionNoteData.java b/java/com/google/gerrit/server/notedb/RevisionNoteData.java index da15b34..c8770f1 100644 --- a/java/com/google/gerrit/server/notedb/RevisionNoteData.java +++ b/java/com/google/gerrit/server/notedb/RevisionNoteData.java
@@ -15,15 +15,17 @@ package com.google.gerrit.server.notedb; import com.google.gerrit.entities.Comment; +import com.google.gerrit.entities.SubmitRequirementResult; import java.util.List; /** * Holds the raw data of a RevisionNote. * * <p>It is intended for serialization to JSON only. It is used for human comments and robot - * comments. + * comments, as well as for storing submit requirements. */ class RevisionNoteData { String pushCert; List<Comment> comments; + List<SubmitRequirementResult> submitRequirementResults; }
diff --git a/java/com/google/gerrit/server/notedb/RobotCommentUpdate.java b/java/com/google/gerrit/server/notedb/RobotCommentUpdate.java index 895f378..d13e74d 100644 --- a/java/com/google/gerrit/server/notedb/RobotCommentUpdate.java +++ b/java/com/google/gerrit/server/notedb/RobotCommentUpdate.java
@@ -69,6 +69,7 @@ private List<RobotComment> put = new ArrayList<>(); + @SuppressWarnings("UnusedMethod") @AssistedInject private RobotCommentUpdate( @GerritPersonIdent PersonIdent serverIdent, @@ -81,6 +82,7 @@ super(noteUtil, serverIdent, notes, null, accountId, realAccountId, authorIdent, when); } + @SuppressWarnings("UnusedMethod") @AssistedInject private RobotCommentUpdate( @GerritPersonIdent PersonIdent serverIdent,
diff --git a/java/com/google/gerrit/server/notedb/Sequences.java b/java/com/google/gerrit/server/notedb/Sequences.java index e44d031..b42253e 100644 --- a/java/com/google/gerrit/server/notedb/Sequences.java +++ b/java/com/google/gerrit/server/notedb/Sequences.java
@@ -114,8 +114,11 @@ .setCumulative() .setUnit(Units.MILLISECONDS), Field.ofEnum(SequenceType.class, "sequence", Metadata.Builder::noteDbSequenceType) + .description("The sequence from which IDs were retrieved.") .build(), - Field.ofBoolean("multiple", Metadata.Builder::multiple).build()); + Field.ofBoolean("multiple", Metadata.Builder::multiple) + .description("Whether more than one ID was retrieved.") + .build()); } public int nextAccountId() {
diff --git a/java/com/google/gerrit/server/notedb/StoreSubmitRequirementsOp.java b/java/com/google/gerrit/server/notedb/StoreSubmitRequirementsOp.java new file mode 100644 index 0000000..d128633 --- /dev/null +++ b/java/com/google/gerrit/server/notedb/StoreSubmitRequirementsOp.java
@@ -0,0 +1,71 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.notedb; + +import com.google.gerrit.server.experiments.ExperimentFeatures; +import com.google.gerrit.server.experiments.ExperimentFeaturesConstants; +import com.google.gerrit.server.project.SubmitRequirementsEvaluator; +import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.update.BatchUpdateOp; +import com.google.gerrit.server.update.ChangeContext; +import com.google.inject.Inject; + +/** A {@link BatchUpdateOp} that stores the evaluated submit requirements of a change in NoteDb. */ +public class StoreSubmitRequirementsOp implements BatchUpdateOp { + private final ChangeData.Factory changeDataFactory; + private final SubmitRequirementsEvaluator evaluator; + private final boolean storeRequirementsInNoteDb; + + public interface Factory { + StoreSubmitRequirementsOp create(); + } + + @Inject + public StoreSubmitRequirementsOp( + ChangeData.Factory changeDataFactory, + ExperimentFeatures experimentFeatures, + SubmitRequirementsEvaluator evaluator) { + this.changeDataFactory = changeDataFactory; + this.evaluator = evaluator; + this.storeRequirementsInNoteDb = + experimentFeatures.isFeatureEnabled( + ExperimentFeaturesConstants + .GERRIT_BACKEND_REQUEST_FEATURE_STORE_SUBMIT_REQUIREMENTS_ON_MERGE); + } + + @Override + public boolean updateChange(ChangeContext ctx) throws Exception { + if (!storeRequirementsInNoteDb) { + // Temporarily stop storing submit requirements in NoteDb when the change is merged. + return false; + } + // Create ChangeData using the project/change IDs instead of ctx.getChange(). We do that because + // for changes requiring a rebase before submission (e.g. if submit type = RebaseAlways), the + // RebaseOp inserts a new patchset that is visible here (via Change#getCurrentPatchset). If we + // then try to get ChangeData#currentPatchset it will return null, since it loads patchsets from + // NoteDb but tries to find the patchset with the ID of the one just inserted by the rebase op. + // Note that this implementation means that, in this case, submit requirement results will be + // stored in change notes of the pre last patchset commit. This is fine since submit requirement + // results should evaluate to the exact same results for both commits. Additionally, the + // pre-last commit is the one for which we displayed the submit requirement results of the last + // patchset to the user before it was merged. + ChangeData changeData = changeDataFactory.create(ctx.getProject(), ctx.getChange().getId()); + ChangeUpdate update = ctx.getUpdate(ctx.getChange().currentPatchSetId()); + // We do not want to store submit requirements in NoteDb for legacy submit records + update.putSubmitRequirementResults( + evaluator.evaluateAllRequirements(changeData, /* includeLegacy= */ false).values()); + return !changeData.submitRequirements().isEmpty(); + } +}
diff --git a/java/com/google/gerrit/server/notedb/SubmitRequirementProtoConverter.java b/java/com/google/gerrit/server/notedb/SubmitRequirementProtoConverter.java new file mode 100644 index 0000000..3caa4d4 --- /dev/null +++ b/java/com/google/gerrit/server/notedb/SubmitRequirementProtoConverter.java
@@ -0,0 +1,96 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.notedb; + +import com.google.errorprone.annotations.Immutable; +import com.google.gerrit.entities.SubmitRequirementResult; +import com.google.gerrit.entities.converter.ProtoConverter; +import com.google.gerrit.server.cache.proto.Cache.SubmitRequirementResultProto; +import com.google.gerrit.server.cache.serialize.ObjectIdConverter; +import com.google.gerrit.server.cache.serialize.entities.SubmitRequirementExpressionResultSerializer; +import com.google.gerrit.server.cache.serialize.entities.SubmitRequirementSerializer; +import com.google.protobuf.Descriptors.FieldDescriptor; +import com.google.protobuf.Parser; +import java.util.Optional; + +@Immutable +public enum SubmitRequirementProtoConverter + implements ProtoConverter<SubmitRequirementResultProto, SubmitRequirementResult> { + INSTANCE; + + private static final FieldDescriptor SR_APPLICABILITY_EXPR_RESULT_FIELD = + SubmitRequirementResultProto.getDescriptor().findFieldByNumber(2); + private static final FieldDescriptor SR_OVERRIDE_EXPR_RESULT_FIELD = + SubmitRequirementResultProto.getDescriptor().findFieldByNumber(4); + private static final FieldDescriptor SR_LEGACY_FIELD = + SubmitRequirementResultProto.getDescriptor().findFieldByNumber(6); + + @Override + public SubmitRequirementResultProto toProto(SubmitRequirementResult r) { + SubmitRequirementResultProto.Builder builder = SubmitRequirementResultProto.newBuilder(); + builder + .setSubmitRequirement(SubmitRequirementSerializer.serialize(r.submitRequirement())) + .setCommit(ObjectIdConverter.create().toByteString(r.patchSetCommitId())); + if (r.legacy().isPresent()) { + builder.setLegacy(r.legacy().get()); + } + if (r.applicabilityExpressionResult().isPresent()) { + builder.setApplicabilityExpressionResult( + SubmitRequirementExpressionResultSerializer.serialize( + r.applicabilityExpressionResult().get())); + } + builder.setSubmittabilityExpressionResult( + SubmitRequirementExpressionResultSerializer.serialize(r.submittabilityExpressionResult())); + if (r.overrideExpressionResult().isPresent()) { + builder.setOverrideExpressionResult( + SubmitRequirementExpressionResultSerializer.serialize( + r.overrideExpressionResult().get())); + } + return builder.build(); + } + + @Override + public SubmitRequirementResult fromProto(SubmitRequirementResultProto proto) { + SubmitRequirementResult.Builder builder = + SubmitRequirementResult.builder() + .patchSetCommitId(ObjectIdConverter.create().fromByteString(proto.getCommit())) + .submitRequirement( + SubmitRequirementSerializer.deserialize(proto.getSubmitRequirement())); + if (proto.hasField(SR_LEGACY_FIELD)) { + builder.legacy(Optional.of(proto.getLegacy())); + } + if (proto.hasField(SR_APPLICABILITY_EXPR_RESULT_FIELD)) { + builder.applicabilityExpressionResult( + Optional.of( + SubmitRequirementExpressionResultSerializer.deserialize( + proto.getApplicabilityExpressionResult()))); + } + builder.submittabilityExpressionResult( + SubmitRequirementExpressionResultSerializer.deserialize( + proto.getSubmittabilityExpressionResult())); + if (proto.hasField(SR_OVERRIDE_EXPR_RESULT_FIELD)) { + builder.overrideExpressionResult( + Optional.of( + SubmitRequirementExpressionResultSerializer.deserialize( + proto.getOverrideExpressionResult()))); + } + return builder.build(); + } + + @Override + public Parser<SubmitRequirementResultProto> getParser() { + return SubmitRequirementResultProto.parser(); + } +}
diff --git a/java/com/google/gerrit/server/patch/AutoMerger.java b/java/com/google/gerrit/server/patch/AutoMerger.java index 3f17a2e..9a84398 100644 --- a/java/com/google/gerrit/server/patch/AutoMerger.java +++ b/java/com/google/gerrit/server/patch/AutoMerger.java
@@ -31,6 +31,8 @@ import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.update.RepoView; import com.google.inject.Inject; +import com.google.inject.Provider; +import com.google.inject.Singleton; import java.io.IOException; import java.util.Optional; import org.eclipse.jgit.dircache.DirCache; @@ -70,6 +72,7 @@ * <p>The second point means that these commits are referenced from NoteDb. The consequence of this * is that these refs should never be deleted. */ +@Singleton public class AutoMerger { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); @@ -88,7 +91,7 @@ private final Counter1<OperationType> counter; private final Timer1<OperationType> latency; - private final PersonIdent gerritIdent; + private final Provider<PersonIdent> gerritIdentProvider; private final boolean save; private final ThreeWayMergeStrategy configuredMergeStrategy; @@ -96,21 +99,25 @@ AutoMerger( MetricMaker metricMaker, @GerritServerConfig Config cfg, - @GerritPersonIdent PersonIdent gerritIdent) { + @GerritPersonIdent Provider<PersonIdent> gerritIdentProvider) { + Field<OperationType> operationTypeField = + Field.ofEnum(OperationType.class, "type", Metadata.Builder::operationName) + .description("The type of the operation (CACHE_LOAD, IN_MEMORY_WRITE, ON_DISK_WRITE).") + .build(); this.counter = metricMaker.newCounter( "git/auto-merge/num_operations", new Description("AutoMerge computations").setRate().setUnit("auto merge computations"), - Field.ofEnum(OperationType.class, "type", Metadata.Builder::operationName).build()); + operationTypeField); this.latency = metricMaker.newTimer( "git/auto-merge/latency", new Description("AutoMerge computation latency") .setCumulative() .setUnit("milliseconds"), - Field.ofEnum(OperationType.class, "type", Metadata.Builder::operationName).build()); + operationTypeField); this.save = cacheAutomerge(cfg); - this.gerritIdent = gerritIdent; + this.gerritIdentProvider = gerritIdentProvider; this.configuredMergeStrategy = MergeUtil.getMergeStrategy(cfg); } @@ -139,7 +146,7 @@ } counter.increment(OperationType.IN_MEMORY_WRITE); logger.atInfo().log("Computing in-memory AutoMerge for " + merge.name()); - try (Timer1.Context ignored = latency.start(OperationType.IN_MEMORY_WRITE)) { + try (Timer1.Context<OperationType> ignored = latency.start(OperationType.IN_MEMORY_WRITE)) { return rw.parseCommit(createAutoMergeCommit(repo.getConfig(), rw, ins, merge, mergeStrategy)); } } @@ -162,17 +169,47 @@ return Optional.empty(); } + if (repoView.getRef(RefNames.refsCacheAutomerge(maybeMergeCommit.name())).isPresent()) { + logger.atFine().log("AutoMerge alredy exists"); + return Optional.empty(); + } + + return Optional.of( + new ReceiveCommand( + ObjectId.zeroId(), + createAutoMergeCommit(repoView, rw, ins, maybeMergeCommit), + RefNames.refsCacheAutomerge(maybeMergeCommit.name()))); + } + + /** + * Creates an auto merge commit for the provided merge commit. + * + * <p>Callers are expected to ensure that the provided commit indeed has 2 parents. + * + * @return An auto-merge commit. Headers of the returned RevCommit are parsed. + */ + ObjectId createAutoMergeCommit( + RepoView repoView, RevWalk rw, ObjectInserter ins, RevCommit mergeCommit) throws IOException { ObjectId autoMerge; - try (Timer1.Context ignored = latency.start(OperationType.ON_DISK_WRITE)) { + try (Timer1.Context<OperationType> ignored = latency.start(OperationType.ON_DISK_WRITE)) { autoMerge = createAutoMergeCommit( - repoView.getConfig(), rw, ins, maybeMergeCommit, configuredMergeStrategy); + repoView.getConfig(), rw, ins, mergeCommit, configuredMergeStrategy); } counter.increment(OperationType.ON_DISK_WRITE); logger.atFine().log("Added %s AutoMerge ref update for commit", autoMerge.name()); - return Optional.of( - new ReceiveCommand( - ObjectId.zeroId(), autoMerge, RefNames.refsCacheAutomerge(maybeMergeCommit.name()))); + return autoMerge; + } + + Optional<RevCommit> lookupCommit(Repository repo, RevWalk rw, String refName) throws IOException { + Ref ref = repo.getRefDatabase().exactRef(refName); + if (ref != null && ref.getObjectId() != null) { + RevObject obj = rw.parseAny(ref.getObjectId()); + if (obj instanceof RevCommit) { + return Optional.of((RevCommit) obj); + } + } + return Optional.empty(); } /** @@ -219,7 +256,9 @@ // the input commit, using the server name and timezone. PersonIdent ident = new PersonIdent( - gerritIdent, merge.getCommitterIdent().getWhen(), gerritIdent.getTimeZone()); + gerritIdentProvider.get(), + merge.getCommitterIdent().getWhen(), + gerritIdentProvider.get().getTimeZone()); CommitBuilder cb = new CommitBuilder(); cb.setAuthor(ident); cb.setCommitter(ident); @@ -241,18 +280,6 @@ return rw.parseCommit(ins.insert(cb)); } - private Optional<RevCommit> lookupCommit(Repository repo, RevWalk rw, String refName) - throws IOException { - Ref ref = repo.getRefDatabase().exactRef(refName); - if (ref != null && ref.getObjectId() != null) { - RevObject obj = rw.parseAny(ref.getObjectId()); - if (obj instanceof RevCommit) { - return Optional.of((RevCommit) obj); - } - } - return Optional.empty(); - } - private static class NonFlushingWrapper extends ObjectInserter.Filter { private final ObjectInserter ins;
diff --git a/java/com/google/gerrit/server/patch/BaseCommitUtil.java b/java/com/google/gerrit/server/patch/BaseCommitUtil.java index 7c06a62..dcd3e85 100644 --- a/java/com/google/gerrit/server/patch/BaseCommitUtil.java +++ b/java/com/google/gerrit/server/patch/BaseCommitUtil.java
@@ -16,40 +16,47 @@ import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Project; +import com.google.gerrit.entities.RefNames; +import com.google.gerrit.git.LockFailureException; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.git.InMemoryInserter; -import com.google.gerrit.server.git.MergeUtil; +import com.google.gerrit.server.update.RepoView; import com.google.inject.Inject; +import com.google.inject.Singleton; import java.io.IOException; +import java.util.Optional; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.Constants; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.ObjectInserter; import org.eclipse.jgit.lib.ObjectReader; +import org.eclipse.jgit.lib.RefUpdate; import org.eclipse.jgit.lib.Repository; -import org.eclipse.jgit.merge.ThreeWayMergeStrategy; import org.eclipse.jgit.revwalk.RevCommit; import org.eclipse.jgit.revwalk.RevObject; import org.eclipse.jgit.revwalk.RevWalk; /** A utility class for computing the base commit / parent for a specific patchset commit. */ +@Singleton class BaseCommitUtil { private final AutoMerger autoMerger; - private final ThreeWayMergeStrategy mergeStrategy; private final GitRepositoryManager repoManager; + /** If true, auto-merge results are stored in the repository. */ + private final boolean saveAutomerge; + @Inject BaseCommitUtil(AutoMerger am, @GerritServerConfig Config cfg, GitRepositoryManager repoManager) { this.autoMerger = am; - this.mergeStrategy = MergeUtil.getMergeStrategy(cfg); + this.saveAutomerge = AutoMerger.cacheAutomerge(cfg); this.repoManager = repoManager; } RevObject getBaseCommit(Project.NameKey project, ObjectId newCommit, @Nullable Integer parentNum) throws IOException { try (Repository repo = repoManager.openRepository(project); - InMemoryInserter ins = new InMemoryInserter(repo); + ObjectInserter ins = newInserter(repo); ObjectReader reader = ins.newReader(); RevWalk rw = new RevWalk(reader)) { return getParentCommit(repo, ins, rw, parentNum, newCommit); @@ -88,7 +95,7 @@ */ RevObject getParentCommit( Repository repo, - InMemoryInserter ins, + ObjectInserter ins, RevWalk rw, @Nullable Integer parentNum, ObjectId commitId) @@ -107,12 +114,70 @@ } // Only support auto-merge for 2 parents, not octopus merges if (current.getParentCount() == 2) { - return autoMerger.lookupFromGitOrMergeInMemory(repo, rw, ins, current, mergeStrategy); + if (!saveAutomerge) { + throw new IOException( + "diff against auto-merge commits is only supported if 'change.cacheAutomerge' config is set to true."); + } + // TODO(ghareeb): Avoid persisting auto-merge commits. + return getAutoMergeFromGitOrCreate(repo, ins, rw, current); } return null; } } + /** + * Gets the auto-merge commit from git if it already exists. If not, the auto-merge is created, + * persisted in git and the cache-automerge ref is updated for the merge commit. + * + * @return the auto-merge {@link RevCommit} + */ + private RevCommit getAutoMergeFromGitOrCreate( + Repository repo, ObjectInserter ins, RevWalk rw, RevCommit mergeCommit) throws IOException { + String refName = RefNames.refsCacheAutomerge(mergeCommit.name()); + Optional<RevCommit> autoMergeCommit = autoMerger.lookupCommit(repo, rw, refName); + if (autoMergeCommit.isPresent()) { + return autoMergeCommit.get(); + } + ObjectId autoMergeId = + autoMerger.createAutoMergeCommit(new RepoView(repo, rw, ins), rw, ins, mergeCommit); + ins.flush(); + return updateRef(repo, rw, refName, autoMergeId, mergeCommit); + } + + private static RevCommit updateRef( + Repository repo, RevWalk rw, String refName, ObjectId autoMergeId, RevCommit merge) + throws IOException { + RefUpdate ru = repo.updateRef(refName); + ru.setNewObjectId(autoMergeId); + ru.disableRefLog(); + switch (ru.forceUpdate()) { + case FAST_FORWARD: + case FORCED: + case NEW: + case NO_CHANGE: + return rw.parseCommit(autoMergeId); + case LOCK_FAILURE: + throw new LockFailureException( + String.format("Failed to create auto-merge of %s", merge.name()), ru); + case IO_FAILURE: + case NOT_ATTEMPTED: + case REJECTED: + case REJECTED_CURRENT_BRANCH: + case REJECTED_MISSING_OBJECT: + case REJECTED_OTHER_REASON: + case RENAMED: + default: + throw new IOException( + String.format( + "Failed to create auto-merge of %s: Cannot write %s (%s)", + merge.name(), refName, ru.getResult())); + } + } + + private ObjectInserter newInserter(Repository repo) { + return saveAutomerge ? repo.newObjectInserter() : new InMemoryInserter(repo); + } + private static ObjectId emptyTree(ObjectInserter ins) throws IOException { ObjectId id = ins.insert(Constants.OBJ_TREE, new byte[] {}); ins.flush();
diff --git a/java/com/google/gerrit/server/patch/ComparisonType.java b/java/com/google/gerrit/server/patch/ComparisonType.java index eca2658..e450779 100644 --- a/java/com/google/gerrit/server/patch/ComparisonType.java +++ b/java/com/google/gerrit/server/patch/ComparisonType.java
@@ -30,7 +30,7 @@ /** * 1-based parent. Available if the old commit is the parent of the new commit and old commit is - * not the auto-merge. + * not the auto-merge. If set to 0, then comparison is for a root commit. */ abstract Optional<Integer> parentNum(); @@ -48,6 +48,10 @@ return new AutoValue_ComparisonType(Optional.empty(), true); } + public static ComparisonType againstRoot() { + return new AutoValue_ComparisonType(Optional.of(0), false); + } + private static ComparisonType create(Optional<Integer> parent, boolean automerge) { return new AutoValue_ComparisonType(parent, automerge); }
diff --git a/java/com/google/gerrit/server/patch/DiffExecutor.java b/java/com/google/gerrit/server/patch/DiffExecutor.java index 63d5c50..c9b87ff 100644 --- a/java/com/google/gerrit/server/patch/DiffExecutor.java +++ b/java/com/google/gerrit/server/patch/DiffExecutor.java
@@ -16,14 +16,11 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; -import com.google.gerrit.server.patch.filediff.PatchListLoader; import com.google.inject.BindingAnnotation; import java.lang.annotation.Retention; import java.util.concurrent.ExecutorService; -/** - * Marker on {@link ExecutorService} used by {@link IntraLineLoader} and {@link PatchListLoader}. - */ +/** Marker on {@link ExecutorService} used by {@link IntraLineLoader}. */ @Retention(RUNTIME) @BindingAnnotation public @interface DiffExecutor {}
diff --git a/java/com/google/gerrit/server/patch/DiffOperations.java b/java/com/google/gerrit/server/patch/DiffOperations.java index 93aefff..d2da736 100644 --- a/java/com/google/gerrit/server/patch/DiffOperations.java +++ b/java/com/google/gerrit/server/patch/DiffOperations.java
@@ -16,6 +16,7 @@ import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Patch; +import com.google.gerrit.entities.Patch.ChangeType; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.client.DiffPreferencesInfo; import com.google.gerrit.server.patch.filediff.FileDiffOutput; @@ -45,16 +46,17 @@ * * @param project a project name representing a git repository. * @param newCommit 20 bytes SHA-1 of the new commit used in the diff. - * @param parentNum integer specifying which parent to use as base. If null, the only parent will - * be used or the auto-merge if {@code newCommit} is a merge commit. - * @return the list of modified files between the two commits. + * @param parentNum 1-based integer specifying which parent to use as base. If zero, the only + * parent will be used or the auto-merge if {@code newCommit} is a merge commit. + * @return map of file paths to the file diffs. The map key is the new file path for all {@link + * ChangeType} file diffs except {@link ChangeType#DELETED} entries where the map key contains + * the old file path. The map entries are not sorted by key. * @throws DiffNotAvailableException if auto-merge is requested for a commit having more than two * parents, if the {@code newCommit} could not be parsed for extracting the base commit, or if * an internal error occurred in Git while evaluating the diff. */ Map<String, FileDiffOutput> listModifiedFilesAgainstParent( - Project.NameKey project, ObjectId newCommit, @Nullable Integer parentNum) - throws DiffNotAvailableException; + Project.NameKey project, ObjectId newCommit, int parentNum) throws DiffNotAvailableException; /** * Returns the list of added, deleted or modified files between two commits (patchsets). The @@ -63,7 +65,9 @@ * @param project a project name representing a git repository. * @param oldCommit 20 bytes SHA-1 of the old commit used in the diff. * @param newCommit 20 bytes SHA-1 of the new commit used in the diff. - * @return the list of modified files between the two commits. + * @return map of file paths to the file diffs. The map key is the new file path for all {@link + * ChangeType} file diffs except {@link ChangeType#DELETED} entries where the map key contains + * the old file path. The map entries are not sorted by key. * @throws DiffNotAvailableException if an internal error occurred in Git while evaluating the * diff. */ @@ -80,8 +84,8 @@ * * @param project a project name representing a git repository. * @param newCommit 20 bytes SHA-1 of the new commit used in the diff. - * @param parentNum integer specifying which parent to use as base. If null, the only parent will - * be used or the auto-merge if {@code newCommit} is a merge commit. + * @param parentNum 1-based integer specifying which parent to use as base. If zero, the only + * parent will be used or the auto-merge if {@code newCommit} is a merge commit. * @param fileName the file name for which the diff should be evaluated. * @param whitespace preference controlling whitespace effect in diff computation. * @return the diff for the single file between the two commits. @@ -91,7 +95,7 @@ FileDiffOutput getModifiedFileAgainstParent( Project.NameKey project, ObjectId newCommit, - @Nullable Integer parentNum, + int parentNum, String fileName, @Nullable DiffPreferencesInfo.Whitespace whitespace) throws DiffNotAvailableException;
diff --git a/java/com/google/gerrit/server/patch/DiffOperationsImpl.java b/java/com/google/gerrit/server/patch/DiffOperationsImpl.java index 6217239..3423b32 100644 --- a/java/com/google/gerrit/server/patch/DiffOperationsImpl.java +++ b/java/com/google/gerrit/server/patch/DiffOperationsImpl.java
@@ -18,6 +18,7 @@ import static com.google.gerrit.entities.Patch.MERGE_LIST; import com.google.auto.value.AutoValue; +import com.google.common.collect.ImmutableCollection; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; import com.google.common.flogger.FluentLogger; @@ -28,8 +29,6 @@ import com.google.gerrit.extensions.client.DiffPreferencesInfo; import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; import com.google.gerrit.server.cache.CacheModule; -import com.google.gerrit.server.config.ConfigUtil; -import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.patch.diff.ModifiedFilesCache; import com.google.gerrit.server.patch.diff.ModifiedFilesCacheImpl; import com.google.gerrit.server.patch.diff.ModifiedFilesCacheKey; @@ -43,34 +42,29 @@ import com.google.gerrit.server.patch.gitfilediff.GitFileDiffCacheImpl.DiffAlgorithm; import com.google.inject.Inject; import com.google.inject.Module; +import com.google.inject.Singleton; import java.io.IOException; import java.util.ArrayList; import java.util.List; import java.util.Map; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.ObjectId; /** * Provides different file diff operations. Uses the underlying Git/Gerrit caches to speed up the * diff computation. */ +@Singleton public class DiffOperationsImpl implements DiffOperations { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); private static final int RENAME_SCORE = 60; - private static final DiffAlgorithm DEFAULT_DIFF_ALGORITHM = DiffAlgorithm.HISTOGRAM; + private static final DiffAlgorithm DEFAULT_DIFF_ALGORITHM = + DiffAlgorithm.HISTOGRAM_WITH_FALLBACK_MYERS; private static final Whitespace DEFAULT_WHITESPACE = Whitespace.IGNORE_NONE; private final ModifiedFilesCache modifiedFilesCache; private final FileDiffCache fileDiffCache; private final BaseCommitUtil baseCommitUtil; - private final long timeoutMillis; - private final ExecutorService diffExecutor; public static Module module() { return new CacheModule() { @@ -89,30 +83,18 @@ public DiffOperationsImpl( ModifiedFilesCache modifiedFilesCache, FileDiffCache fileDiffCache, - BaseCommitUtil baseCommit, - @DiffExecutor ExecutorService executor, - @GerritServerConfig Config cfg) { + BaseCommitUtil baseCommit) { this.modifiedFilesCache = modifiedFilesCache; this.fileDiffCache = fileDiffCache; this.baseCommitUtil = baseCommit; - this.diffExecutor = executor; - this.timeoutMillis = - ConfigUtil.getTimeUnit( - cfg, - "cache", - "diff", - "timeout", - TimeUnit.MILLISECONDS.convert(5, TimeUnit.SECONDS), - TimeUnit.MILLISECONDS); } @Override public Map<String, FileDiffOutput> listModifiedFilesAgainstParent( - Project.NameKey project, ObjectId newCommit, @Nullable Integer parent) - throws DiffNotAvailableException { + Project.NameKey project, ObjectId newCommit, int parent) throws DiffNotAvailableException { try { DiffParameters diffParams = computeDiffParameters(project, newCommit, parent); - return listModifiedFilesWithTimeout(diffParams); + return getModifiedFiles(diffParams); } catch (IOException e) { throw new DiffNotAvailableException( "Failed to evaluate the parent/base commit for commit " + newCommit, e); @@ -130,22 +112,29 @@ .baseCommit(oldCommit) .comparisonType(ComparisonType.againstOtherPatchSet()) .build(); - return listModifiedFilesWithTimeout(params); + return getModifiedFiles(params); } @Override public FileDiffOutput getModifiedFileAgainstParent( Project.NameKey project, ObjectId newCommit, - @Nullable Integer parent, + int parent, String fileName, @Nullable DiffPreferencesInfo.Whitespace whitespace) throws DiffNotAvailableException { try { DiffParameters diffParams = computeDiffParameters(project, newCommit, parent); FileDiffCacheKey key = - createFileDiffCacheKey(project, diffParams.baseCommit(), newCommit, fileName, whitespace); - return getModifiedFileWithTimeout(key, diffParams); + createFileDiffCacheKey( + project, + diffParams.baseCommit(), + newCommit, + fileName, + DEFAULT_DIFF_ALGORITHM, + /* useTimeout= */ true, + whitespace); + return getModifiedFileForKey(key); } catch (IOException e) { throw new DiffNotAvailableException( "Failed to evaluate the parent/base commit for commit " + newCommit, e); @@ -160,60 +149,16 @@ String fileName, @Nullable DiffPreferencesInfo.Whitespace whitespace) throws DiffNotAvailableException { - DiffParameters params = // used for logging only - DiffParameters.builder() - .project(project) - .baseCommit(oldCommit) - .newCommit(newCommit) - .comparisonType(ComparisonType.againstOtherPatchSet()) - .build(); FileDiffCacheKey key = - createFileDiffCacheKey(project, oldCommit, newCommit, fileName, whitespace); - return getModifiedFileWithTimeout(key, params); - } - - private Map<String, FileDiffOutput> listModifiedFilesWithTimeout(DiffParameters params) - throws DiffNotAvailableException { - Future<DiffResult> task = - diffExecutor.submit( - () -> { - ImmutableMap<String, FileDiffOutput> modifiedFiles = getModifiedFiles(params); - return DiffResult.create(null, modifiedFiles); - }); - DiffResult diffResult = execDiffWithTimeout(task, params); - return diffResult.modifiedFiles(); - } - - private FileDiffOutput getModifiedFileWithTimeout(FileDiffCacheKey key, DiffParameters params) - throws DiffNotAvailableException { - Future<DiffResult> task = - diffExecutor.submit( - () -> { - Map<String, FileDiffOutput> diffList = getModifiedFilesForKeys(ImmutableList.of(key)); - FileDiffOutput fileDiffOutput = - diffList.containsKey(key.newFilePath()) - ? diffList.get(key.newFilePath()) - : FileDiffOutput.empty(key.newFilePath(), key.oldCommit(), key.newCommit()); - return DiffResult.create(fileDiffOutput, null); - }); - DiffResult result = execDiffWithTimeout(task, params); - return result.fileDiff(); - } - - /** Executes a diff task by employing a timeout. */ - private DiffResult execDiffWithTimeout(Future<DiffResult> task, DiffParameters params) - throws DiffNotAvailableException { - try { - return task.get(timeoutMillis, TimeUnit.MILLISECONDS); - } catch (InterruptedException | TimeoutException e) { - throw new DiffNotAvailableException( - String.format( - "Timeout reached while computing diff for project %s, old commit %s, new commit %s", - params.project(), params.baseCommit().name(), params.newCommit().name()), - e); - } catch (ExecutionException e) { - throw new DiffNotAvailableException(e); - } + createFileDiffCacheKey( + project, + oldCommit, + newCommit, + fileName, + DEFAULT_DIFF_ALGORITHM, + /* useTimeout= */ true, + whitespace); + return getModifiedFileForKey(key); } private ImmutableMap<String, FileDiffOutput> getModifiedFiles(DiffParameters diffParams) @@ -230,12 +175,24 @@ List<FileDiffCacheKey> fileCacheKeys = new ArrayList<>(); fileCacheKeys.add( createFileDiffCacheKey( - project, oldCommit, newCommit, COMMIT_MSG, /* whitespace= */ null)); + project, + oldCommit, + newCommit, + COMMIT_MSG, + DEFAULT_DIFF_ALGORITHM, + /* useTimeout= */ true, + /* whitespace= */ null)); if (cmp.isAgainstAutoMerge() || isMergeAgainstParent(cmp, project, newCommit)) { fileCacheKeys.add( createFileDiffCacheKey( - project, oldCommit, newCommit, MERGE_LIST, /*whitespace = */ null)); + project, + oldCommit, + newCommit, + MERGE_LIST, + DEFAULT_DIFF_ALGORITHM, + /* useTimeout= */ true, + /*whitespace = */ null)); } if (diffParams.skipFiles() == null) { @@ -249,6 +206,8 @@ entity.newPath().isPresent() ? entity.newPath().get() : entity.oldPath().get(), + DEFAULT_DIFF_ALGORITHM, + /* useTimeout= */ true, /* whitespace= */ null)) .forEach(fileCacheKeys::add); } @@ -258,22 +217,71 @@ } } + private FileDiffOutput getModifiedFileForKey(FileDiffCacheKey key) + throws DiffNotAvailableException { + Map<String, FileDiffOutput> diffList = getModifiedFilesForKeys(ImmutableList.of(key)); + return diffList.containsKey(key.newFilePath()) + ? diffList.get(key.newFilePath()) + : FileDiffOutput.empty(key.newFilePath(), key.oldCommit(), key.newCommit()); + } + + /** + * Lookup the file diffs for the input {@code keys}. For results where the cache reports negative + * results, e.g. due to timeouts in the cache loader, this method requests the diff again using + * the fallback algorithm {@link DiffAlgorithm#HISTOGRAM_NO_FALLBACK}. + */ private ImmutableMap<String, FileDiffOutput> getModifiedFilesForKeys(List<FileDiffCacheKey> keys) throws DiffNotAvailableException { - ImmutableMap.Builder<String, FileDiffOutput> files = ImmutableMap.builder(); ImmutableMap<FileDiffCacheKey, FileDiffOutput> fileDiffs = fileDiffCache.getAll(keys); + List<FileDiffCacheKey> fallbackKeys = new ArrayList<>(); - for (FileDiffOutput fileDiffOutput : fileDiffs.values()) { + ImmutableList.Builder<FileDiffOutput> result = ImmutableList.builder(); + + // Use the fallback diff algorithm for negative results + for (FileDiffCacheKey key : fileDiffs.keySet()) { + FileDiffOutput diff = fileDiffs.get(key); + if (diff.isNegative()) { + FileDiffCacheKey fallbackKey = + createFileDiffCacheKey( + key.project(), + key.oldCommit(), + key.newCommit(), + key.newFilePath(), + // Use the fallback diff algorithm + DiffAlgorithm.HISTOGRAM_NO_FALLBACK, + // We don't enforce timeouts with the fallback algorithm. Timeouts were introduced + // because of a bug in JGit that happens only when the histogram algorithm uses + // Myers as fallback. See https://bugs.chromium.org/p/gerrit/issues/detail?id=487 + /* useTimeout= */ false, + key.whitespace()); + fallbackKeys.add(fallbackKey); + } else { + result.add(diff); + } + } + result.addAll(fileDiffCache.getAll(fallbackKeys).values()); + return mapByFilePath(result.build()); + } + + /** + * Map a collection of {@link FileDiffOutput} based on their file paths. The result map keys + * represent the old file path for deleted files, or the new path otherwise. + */ + private ImmutableMap<String, FileDiffOutput> mapByFilePath( + ImmutableCollection<FileDiffOutput> fileDiffOutputs) { + ImmutableMap.Builder<String, FileDiffOutput> diffs = ImmutableMap.builder(); + + for (FileDiffOutput fileDiffOutput : fileDiffOutputs) { if (fileDiffOutput.isEmpty() || allDueToRebase(fileDiffOutput)) { continue; } if (fileDiffOutput.changeType() == ChangeType.DELETED) { - files.put(fileDiffOutput.oldPath().get(), fileDiffOutput); + diffs.put(fileDiffOutput.oldPath().get(), fileDiffOutput); } else { - files.put(fileDiffOutput.newPath().get(), fileDiffOutput); + diffs.put(fileDiffOutput.newPath().get(), fileDiffOutput); } } - return files.build(); + return diffs.build(); } private static boolean allDueToRebase(FileDiffOutput fileDiffOutput) { @@ -302,6 +310,8 @@ ObjectId aCommit, ObjectId bCommit, String newPath, + DiffAlgorithm diffAlgorithm, + boolean useTimeout, @Nullable Whitespace whitespace) { whitespace = whitespace == null ? DEFAULT_WHITESPACE : whitespace; return FileDiffCacheKey.builder() @@ -310,37 +320,22 @@ .newCommit(bCommit) .newFilePath(newPath) .renameScore(RENAME_SCORE) - .diffAlgorithm(DEFAULT_DIFF_ALGORITHM) + .diffAlgorithm(diffAlgorithm) .whitespace(whitespace) + .useTimeout(useTimeout) .build(); } - /** - * All interface methods create their results using this class. This is used so that the timeout - * method {@link #execDiffWithTimeout(Future, DiffParameters)} could be reused by all interface - * methods. - */ - @AutoValue - abstract static class DiffResult { - static DiffResult create( - @Nullable FileDiffOutput fileDiff, - @Nullable ImmutableMap<String, FileDiffOutput> modifiedFiles) { - return new AutoValue_DiffOperationsImpl_DiffResult(fileDiff, modifiedFiles); - } - - @Nullable - abstract FileDiffOutput fileDiff(); - - @Nullable - abstract ImmutableMap<String, FileDiffOutput> modifiedFiles(); - } - @AutoValue abstract static class DiffParameters { abstract Project.NameKey project(); abstract ObjectId newCommit(); + /** + * Base commit represents the old commit of the diff. For diffs against the root commit, this + * should be set to {@link ObjectId#zeroId()}. + */ abstract ObjectId baseCommit(); abstract ComparisonType comparisonType(); @@ -380,12 +375,17 @@ Project.NameKey project, ObjectId newCommit, Integer parent) throws IOException { DiffParameters.Builder result = DiffParameters.builder().project(project).newCommit(newCommit).parent(parent); - if (parent != null) { + if (parent > 0) { result.baseCommit(baseCommitUtil.getBaseCommit(project, newCommit, parent)); result.comparisonType(ComparisonType.againstParent(parent)); return result.build(); } int numParents = baseCommitUtil.getNumParents(project, newCommit); + if (numParents == 0) { + result.baseCommit(ObjectId.zeroId()); + result.comparisonType(ComparisonType.againstRoot()); + return result.build(); + } if (numParents == 1) { result.baseCommit(baseCommitUtil.getBaseCommit(project, newCommit, parent)); result.comparisonType(ComparisonType.againstParent(1)); @@ -394,11 +394,9 @@ if (numParents > 2) { logger.atFine().log( "Diff against auto-merge for merge commits " - + "with more than two parents is not supported. Commit " - + newCommit - + " has " - + numParents - + " parents. Falling back to the diff against the first parent."); + + "with more than two parents is not supported. Commit %s has %d parents." + + " Falling back to the diff against the first parent.", + newCommit, numParents); result.baseCommit(baseCommitUtil.getBaseCommit(project, newCommit, 1).getId()); result.comparisonType(ComparisonType.againstParent(1)); result.skipFiles(true);
diff --git a/java/com/google/gerrit/server/patch/DiffSummaryLoader.java b/java/com/google/gerrit/server/patch/DiffSummaryLoader.java index b61e0c7..fcce672 100644 --- a/java/com/google/gerrit/server/patch/DiffSummaryLoader.java +++ b/java/com/google/gerrit/server/patch/DiffSummaryLoader.java
@@ -16,58 +16,73 @@ import com.google.gerrit.entities.Patch; import com.google.gerrit.entities.Project; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; import java.util.ArrayList; import java.util.List; +import java.util.Map; import java.util.concurrent.Callable; +import org.eclipse.jgit.lib.ObjectId; public class DiffSummaryLoader implements Callable<DiffSummary> { public interface Factory { DiffSummaryLoader create(DiffSummaryKey key, Project.NameKey project); } - private final PatchListCache patchListCache; + private final DiffOperations diffOperations; private final DiffSummaryKey key; private final Project.NameKey project; @Inject - DiffSummaryLoader(PatchListCache plc, @Assisted DiffSummaryKey k, @Assisted Project.NameKey p) { - patchListCache = plc; + DiffSummaryLoader( + DiffOperations diffOps, @Assisted DiffSummaryKey k, @Assisted Project.NameKey p) { + diffOperations = diffOps; key = k; project = p; } @Override public DiffSummary call() throws Exception { - PatchList patchList = patchListCache.get(key.toPatchListKey(), project); - return toDiffSummary(patchList); + ObjectId oldId = key.toPatchListKey().getOldId(); + ObjectId newId = key.toPatchListKey().getNewId(); + Map<String, FileDiffOutput> diffList = + oldId == null + ? diffOperations.listModifiedFilesAgainstParent(project, newId, /* parentNum= */ 0) + : diffOperations.listModifiedFiles(project, oldId, newId); + return toDiffSummary(diffList); } - private DiffSummary toDiffSummary(PatchList patchList) { - List<String> r = new ArrayList<>(patchList.getPatches().size()); - for (PatchListEntry e : patchList.getPatches()) { - if (Patch.isMagic(e.getNewName())) { + private DiffSummary toDiffSummary(Map<String, FileDiffOutput> fileDiffs) { + List<String> r = new ArrayList<>(fileDiffs.size()); + int linesInserted = 0; + int linesDeleted = 0; + for (String path : fileDiffs.keySet()) { + if (Patch.isMagic(path)) { continue; } - switch (e.getChangeType()) { + FileDiffOutput fileDiff = fileDiffs.get(path); + linesInserted += fileDiff.insertions(); + linesDeleted += fileDiff.deletions(); + switch (fileDiff.changeType()) { case ADDED: case MODIFIED: case DELETED: case COPIED: case REWRITE: - r.add(e.getNewName()); + r.add( + FilePathAdapter.getNewPath( + fileDiff.oldPath(), fileDiff.newPath(), fileDiff.changeType())); break; case RENAMED: - r.add(e.getOldName()); - r.add(e.getNewName()); + r.add(FilePathAdapter.getOldPath(fileDiff.oldPath(), fileDiff.changeType())); + r.add( + FilePathAdapter.getNewPath( + fileDiff.oldPath(), fileDiff.newPath(), fileDiff.changeType())); break; } } - return new DiffSummary( - r.stream().sorted().toArray(String[]::new), - patchList.getInsertions(), - patchList.getDeletions()); + return new DiffSummary(r.stream().sorted().toArray(String[]::new), linesInserted, linesDeleted); } }
diff --git a/java/com/google/gerrit/server/patch/FilePathAdapter.java b/java/com/google/gerrit/server/patch/FilePathAdapter.java index ccd1466..2c98f1a 100644 --- a/java/com/google/gerrit/server/patch/FilePathAdapter.java +++ b/java/com/google/gerrit/server/patch/FilePathAdapter.java
@@ -35,11 +35,12 @@ case DELETED: case ADDED: case MODIFIED: - case REWRITE: return null; case COPIED: case RENAMED: return oldName.get(); + case REWRITE: + return oldName.isPresent() ? oldName.get() : null; default: throw new IllegalArgumentException("Unsupported type " + changeType); }
diff --git a/java/com/google/gerrit/server/patch/IntraLineLoader.java b/java/com/google/gerrit/server/patch/IntraLineLoader.java index 34ac3d8..d6afa88 100644 --- a/java/com/google/gerrit/server/patch/IntraLineLoader.java +++ b/java/com/google/gerrit/server/patch/IntraLineLoader.java
@@ -25,7 +25,9 @@ import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; import java.util.ArrayList; +import java.util.Arrays; import java.util.List; +import java.util.Optional; import java.util.concurrent.Callable; import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutorService; @@ -33,6 +35,7 @@ import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeoutException; import java.util.regex.Pattern; +import java.util.stream.Collectors; import org.eclipse.jgit.diff.Edit; import org.eclipse.jgit.diff.MyersDiff; import org.eclipse.jgit.lib.Config; @@ -250,13 +253,102 @@ wordEdits.set(j, new Edit(ab, ae, bb, be)); } - edits.set(i, new ReplaceEdit(e, wordEdits)); + // Validate that the intra-line edits applied to the "a" text produces the "b" text. If this + // check fails, fallback to a single replace edit that covers the whole area. + if (isValidTransformation(a, b, wordEdits)) { + edits.set(i, new ReplaceEdit(e, wordEdits)); + } else { + edits.set(i, new ReplaceEdit(e, Arrays.asList(new Edit(0, a.size(), 0, b.size())))); + } } } return new IntraLineDiff(edits); } + /** + * Validate that the application of the list of {@code edits} to the {@code lText} text produces + * the {@code rText} text. + * + * @return true if {@code lText} + {@code edits} results in the {@code rText} text, and false + * otherwise. + */ + private static boolean isValidTransformation(CharText lText, CharText rText, List<Edit> edits) { + // Apply replace and delete edits to the left text + Optional<String> left = + applyEditsToString( + toStringBuilder(lText), + toStringBuilder(rText).toString(), + edits.stream() + .filter(e -> e.getType() == Edit.Type.REPLACE || e.getType() == Edit.Type.DELETE) + .collect(Collectors.toList())); + // Remove insert edits from the right text + Optional<String> right = + applyEditsToString( + toStringBuilder(rText), + null, + edits.stream() + .filter(e -> e.getType() == Edit.Type.INSERT) + .collect(Collectors.toList())); + + return left.isPresent() && right.isPresent() && left.get().contentEquals(right.get()); + } + + /** + * Apply edits to the {@code target} string. Replace edits are applied to target and replaced with + * a substring from {@code from}. Delete edits are applied to target. Insert edits are removed + * from target. + * + * @return Optional containing the transformed string, or empty if the transformation fails (due + * to index out of bounds). + */ + private static Optional<String> applyEditsToString( + StringBuilder target, String from, List<Edit> edits) { + // Process edits right to left to avoid re-computation of indices when characters are removed. + try { + for (int i = edits.size() - 1; i >= 0; i--) { + Edit edit = edits.get(i); + if (edit.getType() == Edit.Type.REPLACE) { + boundaryCheck(target, edit.getBeginA(), edit.getEndA() - 1); + boundaryCheck(from, edit.getBeginB(), edit.getEndB() - 1); + target.replace( + edit.getBeginA(), edit.getEndA(), from.substring(edit.getBeginB(), edit.getEndB())); + } else if (edit.getType() == Edit.Type.DELETE) { + boundaryCheck(target, edit.getBeginA(), edit.getEndA() - 1); + target.delete(edit.getBeginA(), edit.getEndA()); + } else if (edit.getType() == Edit.Type.INSERT) { + boundaryCheck(target, edit.getBeginB(), edit.getEndB() - 1); + target.delete(edit.getBeginB(), edit.getEndB()); + } + } + return Optional.of(target.toString()); + } catch (StringIndexOutOfBoundsException unused) { + return Optional.empty(); + } + } + + private static void boundaryCheck(StringBuilder s, int i1, int i2) { + if (i1 >= 0 && i2 >= 0 && i1 < s.length() && i2 < s.length()) { + return; + } + throw new StringIndexOutOfBoundsException(); + } + + private static void boundaryCheck(String s, int i1, int i2) { + if (i1 >= 0 && i2 >= 0 && i1 < s.length() && i2 < s.length()) { + return; + } + throw new StringIndexOutOfBoundsException(); + } + + private static StringBuilder toStringBuilder(CharText text) { + StringBuilder result = new StringBuilder(); + for (int i = 0; i < text.size(); i++) { + result.append(text.charAt(i)); + } + return result; + } + private static void combineLineEdits( List<Edit> edits, ImmutableSet<Edit> editsDueToRebase, Text a, Text b) { for (int j = 0; j < edits.size() - 1; ) {
diff --git a/java/com/google/gerrit/server/patch/PatchFile.java b/java/com/google/gerrit/server/patch/PatchFile.java index ca5223d..4e16a43 100644 --- a/java/com/google/gerrit/server/patch/PatchFile.java +++ b/java/com/google/gerrit/server/patch/PatchFile.java
@@ -18,7 +18,9 @@ import com.google.gerrit.entities.Patch; import com.google.gerrit.exceptions.NoSuchEntityException; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import java.io.IOException; +import java.util.Map; import org.eclipse.jgit.errors.CorruptObjectException; import org.eclipse.jgit.errors.IncorrectObjectTypeException; import org.eclipse.jgit.errors.MissingObjectException; @@ -35,7 +37,7 @@ /** State supporting processing of a single {@link Patch} instance. */ public class PatchFile { private final Repository repo; - private final PatchListEntry entry; + private final FileDiffOutput diff; private final RevTree aTree; private final RevTree bTree; @@ -51,21 +53,30 @@ private Text a; private Text b; - public PatchFile(Repository repo, PatchList patchList, String fileName) - throws MissingObjectException, IncorrectObjectTypeException, IOException { + public PatchFile(Repository repo, Map<String, FileDiffOutput> modifiedFiles, String fileName) + throws IOException { this.repo = repo; - this.entry = patchList.get(fileName); + this.diff = + modifiedFiles.values().stream() + .filter(f -> f.newPath().isPresent() && f.newPath().get().equals(fileName)) + .findFirst() + .orElse(FileDiffOutput.empty(fileName, ObjectId.zeroId(), ObjectId.zeroId())); + if (Patch.PATCHSET_LEVEL.equals(fileName)) { + aTree = null; + bTree = null; + return; + } try (ObjectReader reader = repo.newObjectReader(); RevWalk rw = new RevWalk(reader)) { - final RevCommit bCommit = rw.parseCommit(patchList.getNewId()); + final RevCommit bCommit = rw.parseCommit(diff.newCommitId()); if (Patch.COMMIT_MSG.equals(fileName)) { - if (patchList.getComparisonType().isAgainstParentOrAutoMerge()) { + if (diff.comparisonType().isAgainstParentOrAutoMerge()) { a = Text.EMPTY; } else { // For the initial commit, we have an empty tree on Side A - RevObject object = rw.parseAny(patchList.getOldId()); + RevObject object = rw.parseAny(diff.oldCommitId()); a = object instanceof RevCommit ? Text.forCommit(reader, object) : Text.EMPTY; } b = Text.forCommit(reader, bCommit); @@ -74,18 +85,18 @@ bTree = null; } else if (Patch.MERGE_LIST.equals(fileName)) { // For the initial commit, we have an empty tree on Side A - RevObject object = rw.parseAny(patchList.getOldId()); + RevObject object = rw.parseAny(diff.oldCommitId()); a = object instanceof RevCommit - ? Text.forMergeList(patchList.getComparisonType(), reader, object) + ? Text.forMergeList(diff.comparisonType(), reader, object) : Text.EMPTY; - b = Text.forMergeList(patchList.getComparisonType(), reader, bCommit); + b = Text.forMergeList(diff.comparisonType(), reader, bCommit); aTree = null; bTree = null; } else { - if (patchList.getOldId() != null) { - aTree = rw.parseTree(patchList.getOldId()); + if (diff.oldCommitId() != null) { + aTree = rw.parseTree(diff.oldCommitId()); } else { final RevCommit p = bCommit.getParent(0); rw.parseHeaders(p); @@ -96,12 +107,23 @@ } } + public PatchFile(Repository repo, String fileName, ObjectId patchSetCommitId) throws IOException { + this.repo = repo; + this.diff = FileDiffOutput.empty(fileName, patchSetCommitId, patchSetCommitId); + try (ObjectReader reader = repo.newObjectReader(); + RevWalk rw = new RevWalk(reader)) { + final RevCommit bCommit = rw.parseCommit(diff.newCommitId()); + this.aTree = bCommit.getTree(); + this.bTree = bCommit.getTree(); + } + } + private String getOldName() { - String name = entry.getOldName(); + String name = FilePathAdapter.getOldPath(diff.oldPath(), diff.changeType()); if (name != null) { return name; } - return entry.getNewName(); + return FilePathAdapter.getNewPath(diff.oldPath(), diff.newPath(), diff.changeType()); } /** @@ -111,7 +133,6 @@ * @param line the line number to extract (1 based; 1 is the first line). * @return the string version of the file line. * @throws IOException the patch or complete file content cannot be read. - * @throws NoSuchEntityException */ public String getLine(int file, int line) throws IOException, NoSuchEntityException { switch (file) { @@ -123,7 +144,10 @@ case 1: if (b == null) { - b = load(bTree, entry.getNewName()); + b = + load( + bTree, + FilePathAdapter.getNewPath(diff.oldPath(), diff.newPath(), diff.changeType())); } return b.getString(line - 1); @@ -135,7 +159,7 @@ private Text load(ObjectId tree, String path) throws MissingObjectException, IncorrectObjectTypeException, CorruptObjectException, IOException { - if (path == null) { + if (path == null || Patch.PATCHSET_LEVEL.equals(path)) { return Text.EMPTY; } final TreeWalk tw = TreeWalk.forPath(repo, path, tree);
diff --git a/java/com/google/gerrit/server/patch/PatchList.java b/java/com/google/gerrit/server/patch/PatchList.java index cb95553..b983fb8 100644 --- a/java/com/google/gerrit/server/patch/PatchList.java +++ b/java/com/google/gerrit/server/patch/PatchList.java
@@ -140,17 +140,17 @@ return Collections.unmodifiableList(Arrays.asList(patches)); } - /** @return the comparison type */ + /** Returns the comparison type */ public ComparisonType getComparisonType() { return comparisonType; } - /** @return total number of new lines added. */ + /** Returns total number of new lines added. */ public int getInsertions() { return insertions; } - /** @return total number of lines removed. */ + /** Returns total number of lines removed. */ public int getDeletions() { return deletions; }
diff --git a/java/com/google/gerrit/server/patch/PatchListCache.java b/java/com/google/gerrit/server/patch/PatchListCache.java index e60302a..b8651e0 100644 --- a/java/com/google/gerrit/server/patch/PatchListCache.java +++ b/java/com/google/gerrit/server/patch/PatchListCache.java
@@ -14,47 +14,13 @@ package com.google.gerrit.server.patch; -import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; -import org.eclipse.jgit.lib.ObjectId; -/** Provides a cached list of {@link PatchListEntry}. */ +/** + * Provides a cached list of intra-line and summary diffs. Use {@link DiffOperations} to compute + * detailed file diffs. + */ public interface PatchListCache { - /** - * Returns the patch list - list of modified files - between two commits. - * - * @param key identifies the old / new commits. - * @param project name key identifying a specific git project (repository). - * @return patch list containing the modified files between two commits. - * @deprecated use {@link DiffOperations} instead. - */ - @Deprecated - PatchList get(PatchListKey key, Project.NameKey project) throws PatchListNotAvailableException; - - /** - * Returns the patch list - list of modified files - between two commits. - * - * @param change entity containing all change data. - * @param patchSet single revision of a {@link Change}. - * @return patch list containing the modified files between two commits. - * @deprecated use {@link DiffOperations} instead. - */ - @Deprecated - PatchList get(Change change, PatchSet patchSet) throws PatchListNotAvailableException; - - /** - * Returns the patch list - list of modified files - between two commits. - * - * @param change entity containing all change data. - * @param patchSet single revision of a {@link Change}. - * @param parentNum 1-based parent number when new commit used in comparison is a merge commit. - * @return patch list containing the modified files between two commits. - * @deprecated use {@link DiffOperations} instead. - */ - @Deprecated - ObjectId getOldId(Change change, PatchSet patchSet, Integer parentNum) - throws PatchListNotAvailableException; IntraLineDiff getIntraLineDiff(IntraLineDiffKey key, IntraLineDiffArgs args);
diff --git a/java/com/google/gerrit/server/patch/PatchListCacheImpl.java b/java/com/google/gerrit/server/patch/PatchListCacheImpl.java index a3e9a54..eab0c22 100644 --- a/java/com/google/gerrit/server/patch/PatchListCacheImpl.java +++ b/java/com/google/gerrit/server/patch/PatchListCacheImpl.java
@@ -15,17 +15,12 @@ package com.google.gerrit.server.patch; -import com.google.common.annotations.VisibleForTesting; import com.google.common.cache.Cache; +import com.google.common.flogger.FluentLogger; import com.google.common.util.concurrent.UncheckedExecutionException; -import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; -import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; -import com.google.gerrit.server.cache.CacheBackend; import com.google.gerrit.server.cache.CacheModule; import com.google.gerrit.server.config.GerritServerConfig; -import com.google.gerrit.server.patch.filediff.PatchListLoader; import com.google.inject.Inject; import com.google.inject.Module; import com.google.inject.Singleton; @@ -33,12 +28,12 @@ import java.util.concurrent.ExecutionException; import org.eclipse.jgit.errors.LargeObjectException; import org.eclipse.jgit.lib.Config; -import org.eclipse.jgit.lib.ObjectId; /** Provides a cached list of {@link PatchListEntry}. */ @Singleton public class PatchListCacheImpl implements PatchListCache { - public static final String FILE_NAME = "diff"; + public static final FluentLogger logger = FluentLogger.forEnclosingClass(); + static final String INTRA_NAME = "diff_intraline"; static final String DIFF_SUMMARY = "diff_summary"; @@ -46,13 +41,6 @@ return new CacheModule() { @Override protected void configure() { - factory(PatchListLoader.Factory.class); - // TODO(davido): Switch off using legacy cache backend, after fixing PatchListLoader - // to be recursion free. - persist(FILE_NAME, PatchListKey.class, PatchList.class, CacheBackend.GUAVA) - .maximumWeight(10 << 20) - .weigher(PatchListWeigher.class); - factory(IntraLineLoader.Factory.class); persist(INTRA_NAME, IntraLineDiffKey.class, IntraLineDiff.class) .maximumWeight(10 << 20) @@ -70,27 +58,21 @@ }; } - private final Cache<PatchListKey, PatchList> fileCache; private final Cache<IntraLineDiffKey, IntraLineDiff> intraCache; private final Cache<DiffSummaryKey, DiffSummary> diffSummaryCache; - private final PatchListLoader.Factory fileLoaderFactory; private final IntraLineLoader.Factory intraLoaderFactory; private final DiffSummaryLoader.Factory diffSummaryLoaderFactory; private final boolean computeIntraline; @Inject PatchListCacheImpl( - @Named(FILE_NAME) Cache<PatchListKey, PatchList> fileCache, @Named(INTRA_NAME) Cache<IntraLineDiffKey, IntraLineDiff> intraCache, @Named(DIFF_SUMMARY) Cache<DiffSummaryKey, DiffSummary> diffSummaryCache, - PatchListLoader.Factory fileLoaderFactory, IntraLineLoader.Factory intraLoaderFactory, DiffSummaryLoader.Factory diffSummaryLoaderFactory, @GerritServerConfig Config cfg) { - this.fileCache = fileCache; this.intraCache = intraCache; this.diffSummaryCache = diffSummaryCache; - this.fileLoaderFactory = fileLoaderFactory; this.intraLoaderFactory = intraLoaderFactory; this.diffSummaryLoaderFactory = diffSummaryLoaderFactory; @@ -100,52 +82,6 @@ } @Override - public PatchList get(PatchListKey key, Project.NameKey project) - throws PatchListNotAvailableException { - try { - PatchList pl = fileCache.get(key, fileLoaderFactory.create(key, project)); - if (pl instanceof LargeObjectTombstone) { - throw new PatchListObjectTooLargeException( - "Error computing " + key + ". Previous attempt failed with LargeObjectException"); - } - return pl; - } catch (ExecutionException e) { - PatchListLoader.logger.atWarning().withCause(e).log("Error computing %s", key); - throw new PatchListNotAvailableException(e); - } catch (UncheckedExecutionException e) { - if (e.getCause() instanceof LargeObjectException) { - // Cache negative result so we don't need to redo expensive computations that would yield - // the same result. - fileCache.put(key, new LargeObjectTombstone()); - PatchListLoader.logger.atWarning().withCause(e).log("Error computing %s", key); - throw new PatchListNotAvailableException(e); - } - throw e; - } - } - - @Override - public PatchList get(Change change, PatchSet patchSet) throws PatchListNotAvailableException { - return get(change, patchSet, null); - } - - @Override - public ObjectId getOldId(Change change, PatchSet patchSet, Integer parentNum) - throws PatchListNotAvailableException { - return get(change, patchSet, parentNum).getOldId(); - } - - private PatchList get(Change change, PatchSet patchSet, Integer parentNum) - throws PatchListNotAvailableException { - Project.NameKey project = change.getProject(); - ObjectId b = patchSet.commitId(); - if (parentNum != null) { - return get(PatchListKey.againstParentNum(parentNum, b, Whitespace.IGNORE_NONE), project); - } - return get(PatchListKey.againstDefaultBase(b, Whitespace.IGNORE_NONE), project); - } - - @Override public IntraLineDiff getIntraLineDiff(IntraLineDiffKey key, IntraLineDiffArgs args) { if (computeIntraline) { try { @@ -164,28 +100,14 @@ try { return diffSummaryCache.get(key, diffSummaryLoaderFactory.create(key, project)); } catch (ExecutionException e) { - PatchListLoader.logger.atWarning().withCause(e).log("Error computing %s", key); + logger.atWarning().withCause(e).log("Error computing %s", key); throw new PatchListNotAvailableException(e); } catch (UncheckedExecutionException e) { if (e.getCause() instanceof LargeObjectException) { - PatchListLoader.logger.atWarning().withCause(e).log("Error computing %s", key); + logger.atWarning().withCause(e).log("Error computing %s", key); throw new PatchListNotAvailableException(e); } throw e; } } - - /** Used to cache negative results in {@code fileCache}. */ - @VisibleForTesting - public static class LargeObjectTombstone extends PatchList { - private static final long serialVersionUID = 1L; - - @VisibleForTesting - public LargeObjectTombstone() { - // Initialize super class with valid values. We don't care about the inner state, but need to - // pass valid values that don't break (de)serialization. - super( - null, ObjectId.zeroId(), false, ComparisonType.againstAutoMerge(), new PatchListEntry[0]); - } - } }
diff --git a/java/com/google/gerrit/server/patch/PatchListWeigher.java b/java/com/google/gerrit/server/patch/PatchListWeigher.java deleted file mode 100644 index 942d0e0..0000000 --- a/java/com/google/gerrit/server/patch/PatchListWeigher.java +++ /dev/null
@@ -1,37 +0,0 @@ -// Copyright (C) 2012 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.patch; - -import com.google.common.cache.Weigher; - -/** Approximates memory usage for PatchList in bytes of memory used. */ -public class PatchListWeigher implements Weigher<PatchListKey, PatchList> { - @Override - public int weigh(PatchListKey key, PatchList value) { - int size = - 16 - + 4 * 8 - + 2 * 36 - + 8 // Size of PatchListKey, 64 bit JVM - + 16 - + 3 * 8 - + 3 * 4 - + 20; // Size of PatchList, 64 bit JVM - for (PatchListEntry e : value.getPatches()) { - size += e.weigh(); - } - return size; - } -}
diff --git a/java/com/google/gerrit/server/patch/PatchScriptBuilder.java b/java/com/google/gerrit/server/patch/PatchScriptBuilder.java index 5998bba..33300e3 100644 --- a/java/com/google/gerrit/server/patch/PatchScriptBuilder.java +++ b/java/com/google/gerrit/server/patch/PatchScriptBuilder.java
@@ -71,28 +71,8 @@ intralineDiffCalculator = calculator; } - /** Convert into {@link PatchScript} using the old diff cache output. */ - PatchScript toPatchScriptOld(Repository git, PatchList list, PatchListEntry content) - throws IOException { - - PatchFileChange change = - new PatchFileChange( - content.getEdits(), - content.getEditsDueToRebase(), - content.getHeaderLines(), - content.getOldName(), - content.getNewName(), - content.getChangeType(), - content.getPatchType()); - SidesResolver sidesResolver = new SidesResolver(git, list.getComparisonType()); - ResolvedSides sides = - resolveSides( - git, sidesResolver, oldName(change), newName(change), list.getOldId(), list.getNewId()); - return build(sides.a, sides.b, change); - } - /** Convert into {@link PatchScript} using the new diff cache output. */ - PatchScript toPatchScriptNew(Repository git, FileDiffOutput content) throws IOException { + PatchScript toPatchScript(Repository git, FileDiffOutput content) throws IOException { PatchFileChange change = new PatchFileChange( content.edits().stream().map(TaggedEdit::jgitEdit).collect(toImmutableList()), @@ -235,10 +215,10 @@ return null; case DELETED: case MODIFIED: - case REWRITE: return entry.getNewName(); case COPIED: case RENAMED: + case REWRITE: default: return entry.getOldName(); }
diff --git a/java/com/google/gerrit/server/patch/PatchScriptFactory.java b/java/com/google/gerrit/server/patch/PatchScriptFactory.java index 885459a..02f125a 100644 --- a/java/com/google/gerrit/server/patch/PatchScriptFactory.java +++ b/java/com/google/gerrit/server/patch/PatchScriptFactory.java
@@ -26,20 +26,13 @@ import com.google.gerrit.entities.Project; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.client.DiffPreferencesInfo; -import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; import com.google.gerrit.extensions.restapi.AuthException; -import com.google.gerrit.metrics.Counter1; -import com.google.gerrit.metrics.Description; -import com.google.gerrit.metrics.Field; -import com.google.gerrit.metrics.MetricMaker; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.PatchSetUtil; -import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.edit.ChangeEdit; import com.google.gerrit.server.edit.ChangeEditUtil; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.git.LargeObjectException; -import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.patch.PatchScriptBuilder.IntraLineDiffCalculatorResult; import com.google.gerrit.server.patch.filediff.FileDiffOutput; @@ -50,23 +43,15 @@ import com.google.gerrit.server.project.NoSuchChangeException; import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.project.ProjectState; -import com.google.inject.Inject; import com.google.inject.Provider; -import com.google.inject.Singleton; import com.google.inject.assistedinject.Assisted; import com.google.inject.assistedinject.AssistedInject; import java.io.IOException; -import java.util.Objects; import java.util.Optional; import java.util.Set; import java.util.concurrent.Callable; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import org.apache.commons.lang.exception.ExceptionUtils; import org.eclipse.jgit.diff.Edit; import org.eclipse.jgit.errors.RepositoryNotFoundException; -import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Repository; @@ -93,33 +78,10 @@ CurrentUser currentUser); } - /** These metrics are temporary for launching the new redesigned diff cache. */ - @Singleton - static class Metrics { - final Counter1<String> diffs; - static final String MATCH = "match"; - static final String MISMATCH = "mismatch"; - static final String ERROR = "error"; - - @Inject - Metrics(MetricMaker metricMaker) { - diffs = - metricMaker.newCounter( - "diff/get_diff/dark_launch", - new Description( - "Total number of matching, non-matching, or error in diffs in the old and new diff cache implementations.") - .setRate() - .setUnit("count"), - Field.ofString("type", Metadata.Builder::eventType).build()); - } - } - private final GitRepositoryManager repoManager; private final PatchSetUtil psUtil; private final Provider<PatchScriptBuilder> builderFactory; private final PatchListCache patchListCache; - private final Metrics metrics; - private final ExecutorService executor; private final String fileName; @Nullable private final PatchSet.Id psa; @@ -137,8 +99,6 @@ private ChangeNotes notes; - private final boolean runNewDiffCache; - @AssistedInject PatchScriptFactory( GitRepositoryManager grm, @@ -149,9 +109,6 @@ PermissionBackend permissionBackend, ProjectCache projectCache, DiffOperations diffOperations, - Metrics metrics, - @DiffExecutor ExecutorService executor, - @GerritServerConfig Config cfg, @Assisted ChangeNotes notes, @Assisted String fileName, @Assisted("patchSetA") @Nullable PatchSet.Id patchSetA, @@ -167,18 +124,13 @@ this.permissionBackend = permissionBackend; this.projectCache = projectCache; this.diffOperations = diffOperations; - this.metrics = metrics; - this.executor = executor; this.fileName = fileName; this.psa = patchSetA; - this.parentNum = -1; + this.parentNum = 0; this.psb = patchSetB; this.diffPrefs = diffPrefs; this.currentUser = currentUser; - - this.runNewDiffCache = cfg.getBoolean("cache", "diff_cache", "runNewDiffCache_GetDiff", false); - changeId = patchSetB.changeId(); } @@ -192,9 +144,6 @@ PermissionBackend permissionBackend, ProjectCache projectCache, DiffOperations diffOperations, - Metrics metrics, - @DiffExecutor ExecutorService executor, - @GerritServerConfig Config cfg, @Assisted ChangeNotes notes, @Assisted String fileName, @Assisted int parentNum, @@ -210,8 +159,6 @@ this.permissionBackend = permissionBackend; this.projectCache = projectCache; this.diffOperations = diffOperations; - this.metrics = metrics; - this.executor = executor; this.fileName = fileName; this.psa = null; @@ -219,11 +166,8 @@ this.psb = patchSetB; this.diffPrefs = diffPrefs; this.currentUser = currentUser; - - this.runNewDiffCache = cfg.getBoolean("cache", "diff_cache", "runNewDiffCache_GetDiff", false); - changeId = patchSetB.changeId(); - checkArgument(parentNum >= 0, "parentNum must be >= 0"); + checkArgument(parentNum > 0, "parentNum must be > 0"); } @Override @@ -259,17 +203,7 @@ } bId = edit.get().getEditCommit(); } - if (runNewDiffCache) { - PatchScript patchScript = getPatchScriptWithNewDiffCache(git, aId, bId); - // TODO(ghareeb): remove the async run. This is temporarily used to keep sanity checking - // the results while rolling out the new diff cache. - runOldDiffCacheAsyncAndExportMetrics(git, aId, bId, patchScript); - return patchScript; - } else { - return getPatchScriptWithOldDiffCache(git, aId, bId); - } - } catch (PatchListNotAvailableException e) { - throw new NoSuchChangeException(changeId, e); + return getPatchScript(git, aId, bId); } catch (DiffNotAvailableException e) { throw new StorageException(e); } catch (IOException e) { @@ -287,116 +221,22 @@ } } - private void runOldDiffCacheAsyncAndExportMetrics( - Repository git, ObjectId aId, ObjectId bId, PatchScript expected) { - @SuppressWarnings("unused") - Future<?> possiblyIgnoredError = - executor.submit( - () -> { - try { - PatchScript patchScript = getPatchScriptWithOldDiffCache(git, aId, bId); - if (areEqualPatchscripts(patchScript, expected)) { - metrics.diffs.increment(Metrics.MATCH); - } else { - metrics.diffs.increment(Metrics.MISMATCH); - logger.atWarning().atMostEvery(10, TimeUnit.SECONDS).log( - "Mismatching diff for change %s, old commit ID: %s, new commit ID: %s, file name: %s.", - changeId.toString(), aId, bId, fileName); - } - } catch (PatchListNotAvailableException | IOException e) { - metrics.diffs.increment(Metrics.ERROR); - logger.atSevere().atMostEvery(10, TimeUnit.SECONDS).log( - String.format( - "Error computing new diff for change %s, old commit ID: %s, new commit ID: %s.\n", - changeId.toString(), aId, bId) - + ExceptionUtils.getStackTrace(e)); - } - }); - } - - private PatchScript getPatchScriptWithOldDiffCache(Repository git, ObjectId aId, ObjectId bId) - throws IOException, PatchListNotAvailableException { - PatchScriptBuilder patchScriptBuilder = newBuilder(); - PatchList list = listFor(keyFor(aId, bId, diffPrefs.ignoreWhitespace)); - PatchListEntry content = list.get(fileName); - return patchScriptBuilder.toPatchScriptOld(git, list, content); - } - - private PatchScript getPatchScriptWithNewDiffCache(Repository git, ObjectId aId, ObjectId bId) + private PatchScript getPatchScript(Repository git, ObjectId aId, ObjectId bId) throws IOException, DiffNotAvailableException { FileDiffOutput fileDiffOutput = aId == null ? diffOperations.getModifiedFileAgainstParent( - notes.getProjectName(), - bId, - parentNum == -1 ? null : parentNum + 1, - fileName, - diffPrefs.ignoreWhitespace) + notes.getProjectName(), bId, parentNum, fileName, diffPrefs.ignoreWhitespace) : diffOperations.getModifiedFile( notes.getProjectName(), aId, bId, fileName, diffPrefs.ignoreWhitespace); - return newBuilder().toPatchScriptNew(git, fileDiffOutput); - } - - /** - * The comparison is not exhaustive but is using the most important fields. Comparing all fields - * will require some work in {@link PatchScript} to, e.g., convert it to autovalue. This - * comparison method shall give a strong signal that both patchscripts are almost identical. - */ - private static boolean areEqualPatchscripts(PatchScript ps1, PatchScript ps2) { - boolean equal = true; - if (!ps1.getChangeType().equals(ps2.getChangeType())) { - equal = false; - logger.atWarning().log( - "Mismatching change type: old = %s, new = %s.", ps1.getChangeType(), ps2.getChangeType()); - } - if (!ps1.getPatchHeader().equals(ps2.getPatchHeader())) { - equal = false; - logger.atWarning().log( - "Mismatching patch header: old = %s, new = %s.", - ps1.getPatchHeader(), ps2.getPatchHeader()); - } - if (!Objects.equals(ps1.getOldName(), ps2.getOldName())) { - equal = false; - logger.atWarning().log( - "Mismatching old name: old = %s, new = %s.", ps1.getOldName(), ps2.getOldName()); - } - if (!Objects.equals(ps1.getNewName(), ps2.getNewName())) { - equal = false; - logger.atWarning().log( - "Mismatching new name: old = %s, new = %s.", ps1.getNewName(), ps2.getNewName()); - } - if (!ps1.getEdits().containsAll(ps2.getEdits())) { - equal = false; - logger.atWarning().log( - "Mismatching edits: old = %s, new = %s.", ps1.getEdits(), ps2.getEdits()); - } - if (!ps2.getEdits().containsAll(ps1.getEdits())) { - equal = false; - logger.atWarning().log( - "Mismatching edits: old = %s, new = %s.", ps1.getEdits(), ps2.getEdits()); - } - if (!ps1.getEditsDueToRebase().equals(ps2.getEditsDueToRebase())) { - equal = false; - logger.atWarning().log( - "Mismatching edits due to rebase: old = %s, new = %s.", - ps1.getEditsDueToRebase(), ps2.getEditsDueToRebase()); - } - if (!ps1.getA().equals(ps2.getA())) { - equal = false; - logger.atWarning().log("Mismatching sparse file content in old commit."); - } - if (!ps1.getB().equals(ps2.getB())) { - equal = false; - logger.atWarning().log("Mismatching sparse file content in new commit."); - } - return equal; + return newBuilder().toPatchScript(git, fileDiffOutput); } private Optional<ObjectId> getAId() { if (psa == null) { return Optional.empty(); } - checkState(parentNum < 0, "expected no parentNum when psa is present"); + checkState(parentNum == 0, "expected no parentNum when psa is present"); checkArgument(psa.get() != 0, "edit not supported for left side"); return Optional.of(getCommitId(psa)); } @@ -409,17 +249,6 @@ return Optional.of(getCommitId(psb)); } - private PatchListKey keyFor(ObjectId aId, ObjectId bId, Whitespace whitespace) { - if (parentNum < 0) { - return PatchListKey.againstCommit(aId, bId, whitespace); - } - return PatchListKey.againstParentNum(parentNum + 1, bId, whitespace); - } - - private PatchList listFor(PatchListKey key) throws PatchListNotAvailableException { - return patchListCache.get(key, notes.getProjectName()); - } - private PatchScriptBuilder newBuilder() { final PatchScriptBuilder b = builderFactory.get(); b.setDiffPrefs(diffPrefs);
diff --git a/java/com/google/gerrit/server/patch/SubmitWithStickyApprovalDiff.java b/java/com/google/gerrit/server/patch/SubmitWithStickyApprovalDiff.java index 18d532b..572d73d 100644 --- a/java/com/google/gerrit/server/patch/SubmitWithStickyApprovalDiff.java +++ b/java/com/google/gerrit/server/patch/SubmitWithStickyApprovalDiff.java
@@ -16,8 +16,10 @@ import static com.google.gerrit.server.project.ProjectCache.illegalState; +import com.google.gerrit.common.Nullable; import com.google.gerrit.common.data.PatchScript; import com.google.gerrit.entities.LabelId; +import com.google.gerrit.entities.LabelType; import com.google.gerrit.entities.Patch; import com.google.gerrit.entities.Patch.ChangeType; import com.google.gerrit.entities.PatchSet; @@ -27,23 +29,32 @@ import com.google.gerrit.extensions.client.DiffPreferencesInfo; import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; import com.google.gerrit.extensions.restapi.AuthException; -import com.google.gerrit.prettify.common.SparseFileContent; -import com.google.gerrit.prettify.common.SparseFileContent.Accessor; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.config.GerritServerConfig; +import com.google.gerrit.server.diff.DiffInfoCreator; +import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.git.LargeObjectException; import com.google.gerrit.server.git.validators.CommentCumulativeSizeValidator; import com.google.gerrit.server.notedb.ChangeNotes; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.project.InvalidChangeOperationException; import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.project.ProjectState; import com.google.inject.Inject; import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; import java.util.List; +import java.util.Map; +import java.util.Optional; import java.util.stream.Collectors; -import org.eclipse.jgit.diff.Edit; +import org.eclipse.jgit.diff.DiffFormatter; +import org.eclipse.jgit.internal.JGitText; import org.eclipse.jgit.lib.Config; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.util.RawParseUtils; +import org.eclipse.jgit.util.TemporaryBuffer; /** * This class is used on submit to compute the diff between the latest approved patch-set, and the @@ -58,20 +69,25 @@ * <p>We exclude the magic files from the returned diff to make it shorter and more concise. */ public class SubmitWithStickyApprovalDiff { + private static final int HEAP_EST_SIZE = 32 * 1024; + + private final DiffOperations diffOperations; private final ProjectCache projectCache; private final PatchScriptFactory.Factory patchScriptFactoryFactory; - private final PatchListCache patchListCache; + private final GitRepositoryManager repositoryManager; private final int maxCumulativeSize; @Inject SubmitWithStickyApprovalDiff( + DiffOperations diffOperations, ProjectCache projectCache, PatchScriptFactory.Factory patchScriptFactoryFactory, - PatchListCache patchListCache, + GitRepositoryManager repositoryManager, @GerritServerConfig Config serverConfig) { + this.diffOperations = diffOperations; this.projectCache = projectCache; this.patchScriptFactoryFactory = patchScriptFactoryFactory; - this.patchListCache = patchListCache; + this.repositoryManager = repositoryManager; maxCumulativeSize = serverConfig.getInt( "change", @@ -82,16 +98,7 @@ public String apply(ChangeNotes notes, CurrentUser currentUser) throws AuthException, IOException, PermissionBackendException, InvalidChangeOperationException { - // In some submit strategies, the current patch-set doesn't exist yet as it's being created - // during the submit. Hence, we assign the current patch-set to be the last existing patch-set. - PatchSet currentPatchset = - notes.getPatchSets().values().stream() - .max((p1, p2) -> p1.id().get() - p2.id().get()) - .orElseThrow( - () -> - new IllegalStateException( - String.format( - "change %s can't load any patchset", notes.getChangeId().toString()))); + PatchSet currentPatchset = notes.getCurrentPatchSet(); PatchSet.Id latestApprovedPatchsetId = getLatestApprovedPatchsetId(notes); if (latestApprovedPatchsetId.get() == currentPatchset.id().get()) { @@ -102,40 +109,58 @@ new StringBuilder( String.format( "\n\n%d is the latest approved patch-set.\n", latestApprovedPatchsetId.get())); - PatchList patchList = - getPatchList( + Map<String, FileDiffOutput> modifiedFiles = + listModifiedFiles( notes.getProjectName(), currentPatchset, notes.getPatchSets().get(latestApprovedPatchsetId)); // To make the message a bit more concise, we skip the magic files. - List<PatchListEntry> patchListEntryList = - patchList.getPatches().stream() - .filter(p -> !Patch.isMagic(p.getNewName())) + List<FileDiffOutput> modifiedFilesList = + modifiedFiles.values().stream() + .filter(p -> !Patch.isMagic(p.newPath().orElse(""))) .collect(Collectors.toList()); - if (patchListEntryList.isEmpty()) { + if (modifiedFilesList.isEmpty()) { diff.append( "No files were changed between the latest approved patch-set and the submitted one.\n"); return diff.toString(); } diff.append("The change was submitted with unreviewed changes in the following files:\n\n"); - - for (PatchListEntry patchListEntry : patchListEntryList) { - diff.append( - getDiffForFile( - notes, currentPatchset.id(), latestApprovedPatchsetId, patchListEntry, currentUser)); - } - if (diff.length() > maxCumulativeSize) { - // The diff length is not counted as part of the limit (for technical reasons, since we'd - // have to call CommentCumulativeSizeValidator), but it's best not to post an extra large - // change message here. - return String.format( - "\n\n%d is the latest approved patch-set.\nThe change was submitted " - + "with many unreviewed changes (the diff is too large to show). Please review the " - + "diff.", - latestApprovedPatchsetId.get()); + TemporaryBuffer.Heap buffer = + new TemporaryBuffer.Heap(Math.min(HEAP_EST_SIZE, maxCumulativeSize), maxCumulativeSize); + try (Repository repository = repositoryManager.openRepository(notes.getProjectName()); + DiffFormatter formatter = new DiffFormatter(buffer)) { + formatter.setRepository(repository); + formatter.setDetectRenames(true); + boolean isDiffTooLarge = false; + List<String> formatterResult = null; + try { + formatter.format( + modifiedFilesList.get(0).oldCommitId(), modifiedFilesList.get(0).newCommitId()); + // This returns the diff for all the files. + formatterResult = + Arrays.stream(RawParseUtils.decode(buffer.toByteArray()).split("\n")) + .collect(Collectors.toList()); + } catch (IOException e) { + if (JGitText.get().inMemoryBufferLimitExceeded.equals(e.getMessage())) { + isDiffTooLarge = true; + } else { + throw e; + } + } + for (FileDiffOutput fileDiff : modifiedFilesList) { + diff.append( + getDiffForFile( + notes, + currentPatchset.id(), + latestApprovedPatchsetId, + fileDiff, + currentUser, + formatterResult, + isDiffTooLarge)); + } } return diff.toString(); } @@ -144,28 +169,35 @@ ChangeNotes notes, PatchSet.Id currentPatchsetId, PatchSet.Id latestApprovedPatchsetId, - PatchListEntry patchListEntry, - CurrentUser currentUser) + FileDiffOutput fileDiffOutput, + CurrentUser currentUser, + @Nullable List<String> formatterResult, + boolean isDiffTooLarge) throws AuthException, InvalidChangeOperationException, IOException, PermissionBackendException { StringBuilder diff = new StringBuilder( String.format( - "The name of the file: %s\nInsertions: %d, Deletions: %d.\n\n", - patchListEntry.getNewName(), - patchListEntry.getInsertions(), - patchListEntry.getDeletions())); + "```\nThe name of the file: %s\nInsertions: %d, Deletions: %d.\n\n", + fileDiffOutput.newPath().isPresent() + ? fileDiffOutput.newPath().get() + : fileDiffOutput.oldPath().get(), + fileDiffOutput.insertions(), + fileDiffOutput.deletions())); DiffPreferencesInfo diffPreferencesInfo = createDefaultDiffPreferencesInfo(); PatchScriptFactory patchScriptFactory = patchScriptFactoryFactory.create( notes, - patchListEntry.getNewName(), + fileDiffOutput.newPath().isPresent() + ? fileDiffOutput.newPath().get() + : fileDiffOutput.oldPath().get(), latestApprovedPatchsetId, currentPatchsetId, diffPreferencesInfo, currentUser); PatchScript patchScript = null; try { + // TODO(paiking): we can get rid of this call to optimize by checking the diff for renames. patchScript = patchScriptFactory.call(); } catch (LargeObjectException exception) { diff.append("The file content is too large for showing the full diff. \n\n"); @@ -175,59 +207,62 @@ diff.append( String.format( "The file %s was renamed to %s\n", - patchListEntry.getOldName(), patchListEntry.getNewName())); + fileDiffOutput.oldPath().get(), fileDiffOutput.newPath().get())); } - SparseFileContent.Accessor fileA = patchScript.getA().createAccessor(); - SparseFileContent.Accessor fileB = patchScript.getB().createAccessor(); - boolean editsExist = false; - if (patchScript.getEdits().stream().anyMatch(e -> e.getType() != Edit.Type.EMPTY)) { - diff.append("```\n"); - editsExist = true; + if (isDiffTooLarge) { + diff.append("The diff is too large to show. Please review the diff."); + diff.append("\n```\n"); + return diff.toString(); } - for (Edit edit : patchScript.getEdits()) { - diff.append(getDiffForEdit(fileA, fileB, edit)); - } - if (editsExist) { - diff.append("```\n"); - } + // This filters only the file we need. + // TODO(paiking): we can make this more efficient by mapping the files to their respective + // diffs prior to this method, such that we need to go over the diff only once. + diff.append(getDiffForFile(patchScript, formatterResult)); + // This line (and the ``` above) are useful for formatting in the web UI. + diff.append("\n```\n"); return diff.toString(); } - private String getDiffForEdit(Accessor fileA, Accessor fileB, Edit edit) { - StringBuilder diff = new StringBuilder(); - Edit.Type type = edit.getType(); - switch (type) { - case INSERT: - diff.append(String.format("@@ +%d:%d @@\n", edit.getBeginB(), edit.getEndB())); - diff.append(getModifiedLines(fileB, edit.getBeginB(), edit.getEndB(), '+')); - diff.append("\n"); - break; - case DELETE: - diff.append(String.format("@@ -%d:%d @@\n", edit.getBeginA(), edit.getEndA())); - diff.append(getModifiedLines(fileA, edit.getBeginA(), edit.getEndA(), '-')); - diff.append("\n"); - break; - case REPLACE: - diff.append( - String.format( - "@@ -%d:%d, +%d:%d @@\n", - edit.getBeginA(), edit.getEndA(), edit.getBeginB(), edit.getEndB())); - diff.append(getModifiedLines(fileA, edit.getBeginA(), edit.getEndA(), '-')); - diff.append(getModifiedLines(fileB, edit.getBeginB(), edit.getEndB(), '+')); - diff.append("\n"); - break; - case EMPTY: - // do nothing since there is no change here. + /** + * Show patch set as unified difference for a specific file. We on purpose are not using {@link + * DiffInfoCreator} since we'd like to get the original git/JGit style diff. + */ + public String getDiffForFile(PatchScript patchScript, List<String> formatterResult) { + // only return information about the current file, and not about files that are not + // relevant. DiffFormatter returns other potential files because of rebases, which we can + // ignore. + List<String> modifiedFormatterResult = new ArrayList<>(); + int indexOfFormatterResult = 0; + while (formatterResult.size() > indexOfFormatterResult + && !formatterResult + .get(indexOfFormatterResult) + .equals( + String.format( + "diff --git a/%s b/%s", + patchScript.getOldName() != null + ? patchScript.getOldName() + : patchScript.getNewName(), + patchScript.getNewName()))) { + indexOfFormatterResult++; } - return diff.toString(); - } - - private String getModifiedLines(Accessor file, int begin, int end, char modificationType) { - StringBuilder diff = new StringBuilder(); - for (int i = begin; i < end; i++) { - diff.append(String.format("%c %s\n", modificationType, file.get(i))); + // remove non user friendly information. + while (formatterResult.size() > indexOfFormatterResult + && !formatterResult.get(indexOfFormatterResult).startsWith("@@")) { + indexOfFormatterResult++; } - return diff.toString(); + for (; indexOfFormatterResult < formatterResult.size(); indexOfFormatterResult++) { + if (formatterResult.get(indexOfFormatterResult).startsWith("diff --git")) { + break; + } + modifiedFormatterResult.add(formatterResult.get(indexOfFormatterResult)); + } + if (modifiedFormatterResult.size() == 0) { + // This happens for diffs that are just renames, but we already account for renames. + return ""; + } + return modifiedFormatterResult.stream() + .filter(s -> !s.equals("\\ No newline at end of file")) + .collect(Collectors.joining("\n")); } private DiffPreferencesInfo createDefaultDiffPreferencesInfo() { @@ -245,10 +280,9 @@ if (!patchSetApproval.label().equals(LabelId.CODE_REVIEW)) { continue; } - if (!projectState - .getLabelTypes(notes) - .byLabel(patchSetApproval.labelId()) - .isMaxPositive(patchSetApproval)) { + Optional<LabelType> lt = + projectState.getLabelTypes(notes).byLabel(patchSetApproval.labelId()); + if (!lt.isPresent() || !lt.get().isMaxPositive(patchSetApproval)) { continue; } if (patchSetApproval.patchSetId().get() > maxPatchSetId.get()) { @@ -259,16 +293,14 @@ } /** - * Gets the {@link PatchList} between the two latest patch-sets. Can be used to compute difference - * in files between those two patch-sets . + * Gets the list of modified files between the two latest patch-sets. Can be used to compute + * difference in files between those two patch-sets. */ - private PatchList getPatchList(Project.NameKey project, PatchSet ps, PatchSet priorPatchSet) { - PatchListKey key = - PatchListKey.againstCommit( - priorPatchSet.commitId(), ps.commitId(), DiffPreferencesInfo.Whitespace.IGNORE_NONE); + private Map<String, FileDiffOutput> listModifiedFiles( + Project.NameKey project, PatchSet ps, PatchSet priorPatchSet) { try { - return patchListCache.get(key, project); - } catch (PatchListNotAvailableException ex) { + return diffOperations.listModifiedFiles(project, priorPatchSet.commitId(), ps.commitId()); + } catch (DiffNotAvailableException ex) { throw new StorageException( "failed to compute difference in files, so won't post diff messsage on submit although " + "the latest approved patch-set was not the same as the submitted patch-set.",
diff --git a/java/com/google/gerrit/server/patch/diff/ModifiedFilesCache.java b/java/com/google/gerrit/server/patch/diff/ModifiedFilesCache.java index bcae238..76d1710 100644 --- a/java/com/google/gerrit/server/patch/diff/ModifiedFilesCache.java +++ b/java/com/google/gerrit/server/patch/diff/ModifiedFilesCache.java
@@ -28,16 +28,17 @@ * files. * * <p>If the {@link ModifiedFilesCacheKey#aCommit()} is equal to {@link - * org.eclipse.jgit.lib.Constants#EMPTY_TREE_ID}, the diff will be evaluated against the empty tree, - * and the result will be exactly the same as the caller can get from {@link + * org.eclipse.jgit.lib.ObjectId#zeroId()}, the diff will be evaluated against the empty tree, and + * the result will be exactly the same as the caller can get from {@link * GitModifiedFilesCache#get(GitModifiedFilesCacheKey)} */ public interface ModifiedFilesCache { /** + * Returns the list of {@link ModifiedFile}s between the 2 git commits identified by the key + * * @param key used to identify two git commits and contains other attributes to control the diff * calculation. - * @return the list of {@link ModifiedFile}s between the 2 git commits identified by the key. * @throws DiffNotAvailableException the supplied commits IDs of the key do no exist, are not IDs * of a commit, or an exception occurred while reading a pack file. */
diff --git a/java/com/google/gerrit/server/patch/diff/ModifiedFilesCacheImpl.java b/java/com/google/gerrit/server/patch/diff/ModifiedFilesCacheImpl.java index 6023c0e..b4d8c04 100644 --- a/java/com/google/gerrit/server/patch/diff/ModifiedFilesCacheImpl.java +++ b/java/com/google/gerrit/server/patch/diff/ModifiedFilesCacheImpl.java
@@ -15,15 +15,17 @@ package com.google.gerrit.server.patch.diff; import static com.google.common.collect.ImmutableList.toImmutableList; -import static org.eclipse.jgit.lib.Constants.EMPTY_TREE_ID; import com.google.common.cache.CacheLoader; import com.google.common.cache.LoadingCache; +import com.google.common.collect.ArrayListMultimap; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; +import com.google.common.collect.ListMultimap; import com.google.common.collect.Sets; import com.google.common.collect.Streams; import com.google.common.flogger.FluentLogger; +import com.google.gerrit.entities.Patch.ChangeType; import com.google.gerrit.server.cache.CacheModule; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.patch.DiffNotAvailableException; @@ -34,9 +36,11 @@ import com.google.gerrit.server.patch.gitdiff.ModifiedFile; import com.google.inject.Inject; import com.google.inject.Module; +import com.google.inject.Singleton; import com.google.inject.TypeLiteral; import com.google.inject.name.Named; import java.io.IOException; +import java.util.ArrayList; import java.util.List; import java.util.Set; import java.util.stream.Stream; @@ -51,11 +55,11 @@ * <p>The loader of this cache wraps a {@link GitModifiedFilesCache} to retrieve the git modified * files. * - * <p>If the {@link ModifiedFilesCacheKey#aCommit()} is equal to {@link - * org.eclipse.jgit.lib.Constants#EMPTY_TREE_ID}, the diff will be evaluated against the empty tree, - * and the result will be exactly the same as the caller can get from {@link - * GitModifiedFilesCache#get(GitModifiedFilesCacheKey)} + * <p>If the {@link ModifiedFilesCacheKey#aCommit()} is equal to {@link ObjectId#zeroId()}, the diff + * will be evaluated against the empty tree, and the result will be exactly the same as the caller + * can get from {@link GitModifiedFilesCache#get(GitModifiedFilesCacheKey)} */ +@Singleton public class ModifiedFilesCacheImpl implements ModifiedFilesCache { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); @@ -82,7 +86,7 @@ .valueSerializer(GitModifiedFilesCacheImpl.ValueSerializer.INSTANCE) .maximumWeight(10 << 20) .weigher(ModifiedFilesWeigher.class) - .version(1) + .version(4) .loader(ModifiedFilesLoader.class); } }; @@ -128,7 +132,7 @@ private ImmutableList<ModifiedFile> loadModifiedFiles(ModifiedFilesCacheKey key, RevWalk rw) throws IOException, DiffNotAvailableException { ObjectId aTree = - key.aCommit().equals(EMPTY_TREE_ID) + key.aCommit().equals(ObjectId.zeroId()) ? key.aCommit() : DiffUtil.getTreeId(rw, key.aCommit()); ObjectId bTree = DiffUtil.getTreeId(rw, key.bCommit()); @@ -139,8 +143,8 @@ .bTree(bTree) .renameScore(key.renameScore()) .build(); - List<ModifiedFile> modifiedFiles = gitCache.get(gitKey); - if (key.aCommit().equals(EMPTY_TREE_ID)) { + List<ModifiedFile> modifiedFiles = mergeRewrittenEntries(gitCache.get(gitKey)); + if (key.aCommit().equals(ObjectId.zeroId())) { return ImmutableList.copyOf(modifiedFiles); } RevCommit revCommitA = DiffUtil.getRevCommit(rw, key.aCommit()); @@ -202,5 +206,37 @@ // value as the set of file paths shouldn't contain it. return touchedFilePaths.contains(oldFilePath) || touchedFilePaths.contains(newFilePath); } + + /** + * Return the {@code modifiedFiles} input list while merging rewritten entries. + * + * <p>Background: In some cases, JGit returns two diff entries (ADDED/DELETED, RENAMED/DELETED, + * etc...) for the same file path. This happens e.g. when a file's mode is changed between + * patchsets, for example converting a symlink file to a regular file. We identify this case and + * return a single modified file with changeType = {@link ChangeType#REWRITE}. + */ + private static List<ModifiedFile> mergeRewrittenEntries(List<ModifiedFile> modifiedFiles) { + List<ModifiedFile> result = new ArrayList<>(); + ListMultimap<String, ModifiedFile> byPath = ArrayListMultimap.create(); + modifiedFiles.stream() + .forEach( + f -> { + if (f.changeType() == ChangeType.DELETED) { + byPath.get(f.oldPath().get()).add(f); + } else { + byPath.get(f.newPath().get()).add(f); + } + }); + for (String path : byPath.keySet()) { + List<ModifiedFile> entries = byPath.get(path); + if (entries.size() == 1) { + result.add(entries.get(0)); + } else { + // More than one. Return a single REWRITE entry. + result.add(entries.get(0).toBuilder().changeType(ChangeType.REWRITE).build()); + } + } + return result; + } } }
diff --git a/java/com/google/gerrit/server/patch/diff/ModifiedFilesCacheKey.java b/java/com/google/gerrit/server/patch/diff/ModifiedFilesCacheKey.java index 2ac3f5e..4a406c8 100644 --- a/java/com/google/gerrit/server/patch/diff/ModifiedFilesCacheKey.java +++ b/java/com/google/gerrit/server/patch/diff/ModifiedFilesCacheKey.java
@@ -32,10 +32,10 @@ /** A specific git project / repository. */ public abstract Project.NameKey project(); - /** @return the old commit ID used in the git tree diff */ + /** Returns the old commit ID used in the git tree diff */ public abstract ObjectId aCommit(); - /** @return the new commit ID used in the git tree diff */ + /** Returns the new commit ID used in the git tree diff */ public abstract ObjectId bCommit(); /**
diff --git a/java/com/google/gerrit/server/patch/filediff/AllDiffsEvaluator.java b/java/com/google/gerrit/server/patch/filediff/AllDiffsEvaluator.java index 12decc3..0923252 100644 --- a/java/com/google/gerrit/server/patch/filediff/AllDiffsEvaluator.java +++ b/java/com/google/gerrit/server/patch/filediff/AllDiffsEvaluator.java
@@ -14,8 +14,6 @@ package com.google.gerrit.server.patch.filediff; -import static org.eclipse.jgit.lib.Constants.EMPTY_TREE_ID; - import com.google.common.collect.ImmutableMap; import com.google.common.flogger.FluentLogger; import com.google.gerrit.server.patch.DiffNotAvailableException; @@ -203,7 +201,7 @@ FileDiffCacheKey key, ObjectId aCommit, ObjectId bCommit, String pathNew, RevWalk rw) throws IOException { ObjectId oldTreeId = - aCommit.equals(EMPTY_TREE_ID) ? EMPTY_TREE_ID : DiffUtil.getTreeId(rw, aCommit); + aCommit.equals(ObjectId.zeroId()) ? ObjectId.zeroId() : DiffUtil.getTreeId(rw, aCommit); ObjectId newTreeId = DiffUtil.getTreeId(rw, bCommit); return GitFileDiffCacheKey.builder() .project(key.project()) @@ -213,6 +211,7 @@ .renameScore(key.renameScore()) .diffAlgorithm(key.diffAlgorithm()) .whitespace(key.whitespace()) + .useTimeout(key.useTimeout()) .build(); } }
diff --git a/java/com/google/gerrit/server/patch/filediff/FileDiffCacheImpl.java b/java/com/google/gerrit/server/patch/filediff/FileDiffCacheImpl.java index 395312f..92c3b39 100644 --- a/java/com/google/gerrit/server/patch/filediff/FileDiffCacheImpl.java +++ b/java/com/google/gerrit/server/patch/filediff/FileDiffCacheImpl.java
@@ -16,7 +16,6 @@ import static com.google.common.collect.ImmutableList.toImmutableList; import static java.nio.charset.StandardCharsets.UTF_8; -import static org.eclipse.jgit.lib.Constants.EMPTY_TREE_ID; import com.google.common.cache.CacheLoader; import com.google.common.cache.LoadingCache; @@ -26,11 +25,15 @@ import com.google.common.collect.Multimap; import com.google.common.collect.Streams; import com.google.common.flogger.FluentLogger; +import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.Patch; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; import com.google.gerrit.server.cache.CacheModule; import com.google.gerrit.server.git.GitRepositoryManager; +import com.google.gerrit.server.logging.Metadata; +import com.google.gerrit.server.logging.TraceContext; +import com.google.gerrit.server.logging.TraceContext.TraceTimer; import com.google.gerrit.server.patch.AutoMerger; import com.google.gerrit.server.patch.ComparisonType; import com.google.gerrit.server.patch.DiffNotAvailableException; @@ -43,6 +46,7 @@ import com.google.gerrit.server.patch.gitfilediff.GitFileDiffCacheImpl.DiffAlgorithmFactory; import com.google.inject.Inject; import com.google.inject.Module; +import com.google.inject.Singleton; import com.google.inject.name.Named; import java.io.IOException; import java.util.ArrayList; @@ -71,10 +75,10 @@ * Cache for the single file diff between two commits for a single file path. This cache adds extra * Gerrit logic such as identifying edits due to rebase. * - * <p>If the {@link FileDiffCacheKey#oldCommit()} is equal to {@link - * org.eclipse.jgit.lib.Constants#EMPTY_TREE_ID}, the git diff will be evaluated against the empty - * tree. + * <p>If the {@link FileDiffCacheKey#oldCommit()} is equal to {@link ObjectId#zeroId()}, the git + * diff will be evaluated against the empty tree. */ +@Singleton public class FileDiffCacheImpl implements FileDiffCache { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); @@ -93,7 +97,7 @@ persist(DIFF, FileDiffCacheKey.class, FileDiffOutput.class) .maximumWeight(10 << 20) .weigher(FileDiffWeigher.class) - .version(4) + .version(8) .keySerializer(FileDiffCacheKey.Serializer.INSTANCE) .valueSerializer(FileDiffOutput.Serializer.INSTANCE) .loader(FileDiffLoader.class); @@ -151,44 +155,56 @@ @Override public FileDiffOutput load(FileDiffCacheKey key) throws IOException, DiffNotAvailableException { - return loadAll(ImmutableList.of(key)).get(key); + try (TraceTimer timer = + TraceContext.newTimer( + "Loading a single key from file diff cache", + Metadata.builder().filePath(key.newFilePath()).build())) { + return loadAll(ImmutableList.of(key)).get(key); + } } @Override public Map<FileDiffCacheKey, FileDiffOutput> loadAll(Iterable<? extends FileDiffCacheKey> keys) throws DiffNotAvailableException { - ImmutableMap.Builder<FileDiffCacheKey, FileDiffOutput> result = ImmutableMap.builder(); + try (TraceTimer timer = TraceContext.newTimer("Loading multiple keys from file diff cache")) { + ImmutableMap.Builder<FileDiffCacheKey, FileDiffOutput> result = ImmutableMap.builder(); - Map<Project.NameKey, List<FileDiffCacheKey>> keysByProject = - Streams.stream(keys).distinct().collect(Collectors.groupingBy(FileDiffCacheKey::project)); + Map<Project.NameKey, List<FileDiffCacheKey>> keysByProject = + Streams.stream(keys) + .distinct() + .collect(Collectors.groupingBy(FileDiffCacheKey::project)); - for (Project.NameKey project : keysByProject.keySet()) { - List<FileDiffCacheKey> fileKeys = new ArrayList<>(); + for (Project.NameKey project : keysByProject.keySet()) { + List<FileDiffCacheKey> fileKeys = new ArrayList<>(); - try (Repository repo = repoManager.openRepository(project); - ObjectReader reader = repo.newObjectReader(); - RevWalk rw = new RevWalk(reader)) { + try (Repository repo = repoManager.openRepository(project); + ObjectReader reader = repo.newObjectReader(); + RevWalk rw = new RevWalk(reader)) { - for (FileDiffCacheKey key : keysByProject.get(project)) { - if (key.newFilePath().equals(Patch.COMMIT_MSG)) { - result.put(key, createMagicPathEntry(key, reader, rw, MagicPath.COMMIT)); - } else if (key.newFilePath().equals(Patch.MERGE_LIST)) { - result.put(key, createMagicPathEntry(key, reader, rw, MagicPath.MERGE_LIST)); - } else { - fileKeys.add(key); + for (FileDiffCacheKey key : keysByProject.get(project)) { + if (key.newFilePath().equals(Patch.COMMIT_MSG)) { + result.put(key, createMagicPathEntry(key, reader, rw, MagicPath.COMMIT)); + } else if (key.newFilePath().equals(Patch.MERGE_LIST)) { + result.put(key, createMagicPathEntry(key, reader, rw, MagicPath.MERGE_LIST)); + } else { + fileKeys.add(key); + } } + result.putAll(createFileEntries(reader, fileKeys, rw)); + } catch (IOException e) { + logger.atWarning().log("Failed to open the repository %s: %s", project, e.getMessage()); } - result.putAll(createFileEntries(reader, fileKeys, rw)); - } catch (IOException e) { - logger.atWarning().log("Failed to open the repository %s: %s", project, e.getMessage()); } + return result.build(); } - return result.build(); } private ComparisonType getComparisonType( RevWalk rw, ObjectReader reader, ObjectId oldCommitId, ObjectId newCommitId) throws IOException { + if (oldCommitId.equals(ObjectId.zeroId())) { + return ComparisonType.againstRoot(); + } RevCommit oldCommit = DiffUtil.getRevCommit(rw, oldCommitId); RevCommit newCommit = DiffUtil.getRevCommit(rw, newCommitId); for (int i = 0; i < newCommit.getParentCount(); i++) { @@ -211,7 +227,7 @@ } /** - * Creates a {@link FileDiffOutput} entry for the "Commit message" and "Merge list" file paths. + * Creates a {@link FileDiffOutput} entry for the "Commit message" or "Merge list" magic paths. */ private FileDiffOutput createMagicPathEntry( FileDiffCacheKey key, ObjectReader reader, RevWalk rw, MagicPath magicPath) { @@ -219,7 +235,10 @@ RawTextComparator cmp = comparatorFor(key.whitespace()); ComparisonType comparisonType = getComparisonType(rw, reader, key.oldCommit(), key.newCommit()); - RevCommit aCommit = DiffUtil.getRevCommit(rw, key.oldCommit()); + RevCommit aCommit = + key.oldCommit().equals(ObjectId.zeroId()) + ? null + : DiffUtil.getRevCommit(rw, key.oldCommit()); RevCommit bCommit = DiffUtil.getRevCommit(rw, key.newCommit()); return magicPath == MagicPath.COMMIT ? createCommitEntry(reader, aCommit, bCommit, comparisonType, cmp, key.diffAlgorithm()) @@ -248,16 +267,19 @@ } } + /** + * Creates a commit entry. {@code oldCommit} is null if the comparison is against a root commit. + */ private FileDiffOutput createCommitEntry( ObjectReader reader, - RevCommit oldCommit, + @Nullable RevCommit oldCommit, RevCommit newCommit, ComparisonType comparisonType, RawTextComparator rawTextComparator, GitFileDiffCacheImpl.DiffAlgorithm diffAlgorithm) throws IOException { Text aText = - comparisonType.isAgainstParentOrAutoMerge() + oldCommit == null || comparisonType.isAgainstParentOrAutoMerge() ? Text.EMPTY : Text.forCommit(reader, oldCommit); Text bText = Text.forCommit(reader, newCommit); @@ -272,16 +294,20 @@ diffAlgorithm); } + /** + * Creates a merge list entry. {@code oldCommit} is null if the comparison is against a root + * commit. + */ private FileDiffOutput createMergeListEntry( ObjectReader reader, - RevCommit oldCommit, + @Nullable RevCommit oldCommit, RevCommit newCommit, ComparisonType comparisonType, RawTextComparator rawTextComparator, GitFileDiffCacheImpl.DiffAlgorithm diffAlgorithm) throws IOException { Text aText = - comparisonType.isAgainstParentOrAutoMerge() + oldCommit == null || comparisonType.isAgainstParentOrAutoMerge() ? Text.EMPTY : Text.forMergeList(comparisonType, reader, oldCommit); Text bText = Text.forMergeList(comparisonType, reader, newCommit); @@ -297,7 +323,7 @@ } private static FileDiffOutput createMagicFileDiffOutput( - ObjectId oldCommit, + @Nullable ObjectId oldCommit, ObjectId newCommit, ComparisonType comparisonType, RawTextComparator rawTextComparator, @@ -317,7 +343,7 @@ FileHeader fileHeader = new FileHeader(rawHdr, edits, PatchType.UNIFIED); Patch.ChangeType changeType = FileHeaderUtil.getChangeType(fileHeader); return FileDiffOutput.builder() - .oldCommitId(oldCommit) + .oldCommitId(oldCommit == null ? ObjectId.zeroId() : oldCommit) .newCommitId(newCommit) .comparisonType(comparisonType) .oldPath(FileHeaderUtil.getOldPath(fileHeader)) @@ -364,6 +390,19 @@ for (AugmentedFileDiffCacheKey augmentedKey : allFileDiffs.keySet()) { AllFileGitDiffs allDiffs = allFileDiffs.get(augmentedKey); + GitFileDiff mainGitDiff = allDiffs.mainDiff().gitDiff(); + + if (mainGitDiff.isNegative()) { + // If the result of the git diff computation was negative, i.e. due to timeout, cache a + // negative result. + result.put( + augmentedKey.key(), + FileDiffOutput.createNegative( + mainGitDiff.newPath().orElse(""), + augmentedKey.key().oldCommit(), + augmentedKey.key().newCommit())); + continue; + } FileEdits rebaseFileEdits = FileEdits.empty(); if (!augmentedKey.ignoreRebase()) { @@ -371,12 +410,13 @@ } List<Edit> rebaseEdits = rebaseFileEdits.edits(); - RevTree aTree = rw.parseTree(allDiffs.mainDiff().gitKey().oldTree()); + ObjectId oldTreeId = allDiffs.mainDiff().gitKey().oldTree(); + + RevTree aTree = oldTreeId.equals(ObjectId.zeroId()) ? null : rw.parseTree(oldTreeId); RevTree bTree = rw.parseTree(allDiffs.mainDiff().gitKey().newTree()); - GitFileDiff mainGitDiff = allDiffs.mainDiff().gitDiff(); Long oldSize = - mainGitDiff.oldMode().isPresent() && mainGitDiff.oldPath().isPresent() + aTree != null && mainGitDiff.oldMode().isPresent() && mainGitDiff.oldPath().isPresent() ? new FileSizeEvaluator(reader, aTree) .compute( mainGitDiff.oldId(), @@ -425,7 +465,7 @@ private List<AugmentedFileDiffCacheKey> wrapKeys(List<FileDiffCacheKey> keys, RevWalk rw) { List<AugmentedFileDiffCacheKey> result = new ArrayList<>(); for (FileDiffCacheKey key : keys) { - if (key.oldCommit().equals(EMPTY_TREE_ID)) { + if (key.oldCommit().equals(ObjectId.zeroId())) { result.add(AugmentedFileDiffCacheKey.builder().key(key).ignoreRebase(true).build()); continue; }
diff --git a/java/com/google/gerrit/server/patch/filediff/FileDiffCacheKey.java b/java/com/google/gerrit/server/patch/filediff/FileDiffCacheKey.java index a478fcf..5880b65 100644 --- a/java/com/google/gerrit/server/patch/filediff/FileDiffCacheKey.java +++ b/java/com/google/gerrit/server/patch/filediff/FileDiffCacheKey.java
@@ -35,7 +35,10 @@ /** A specific git project / repository. */ public abstract Project.NameKey project(); - /** The 20 bytes SHA-1 commit ID of the old commit used in the diff. */ + /** + * The 20 bytes SHA-1 commit ID of the old commit used in the diff. If set to {@link + * ObjectId#zeroId()}, an empty tree is used for the diff. + */ public abstract ObjectId oldCommit(); /** The 20 bytes SHA-1 commit ID of the new commit used in the diff. */ @@ -55,6 +58,9 @@ public abstract DiffPreferencesInfo.Whitespace whitespace(); + /** Employ a timeout on the git computation while formatting the file header. */ + public abstract boolean useTimeout(); + /** Number of bytes that this entity occupies. */ public int weight() { return stringSize(project().get()) @@ -62,13 +68,16 @@ + stringSize(newFilePath()) + 4 // renameScore + 4 // diffAlgorithm - + 4; // whitespace + + 4 // whitespace + + 1; // useTimeout } public static FileDiffCacheKey.Builder builder() { return new AutoValue_FileDiffCacheKey.Builder(); } + public abstract Builder toBuilder(); + @AutoValue.Builder public abstract static class Builder { @@ -91,6 +100,8 @@ public abstract FileDiffCacheKey.Builder whitespace(Whitespace value); + public abstract FileDiffCacheKey.Builder useTimeout(boolean value); + public abstract FileDiffCacheKey build(); } @@ -109,6 +120,7 @@ .setRenameScore(key.renameScore()) .setDiffAlgorithm(key.diffAlgorithm().name()) .setWhitespace(key.whitespace().name()) + .setUseTimeout(key.useTimeout()) .build()); } @@ -124,6 +136,7 @@ .renameScore(proto.getRenameScore()) .diffAlgorithm(DiffAlgorithm.valueOf(proto.getDiffAlgorithm())) .whitespace(Whitespace.valueOf(proto.getWhitespace())) + .useTimeout(proto.getUseTimeout()) .build(); } }
diff --git a/java/com/google/gerrit/server/patch/filediff/FileDiffOutput.java b/java/com/google/gerrit/server/patch/filediff/FileDiffOutput.java index e7f47ef..242c1a4 100644 --- a/java/com/google/gerrit/server/patch/filediff/FileDiffOutput.java +++ b/java/com/google/gerrit/server/patch/filediff/FileDiffOutput.java
@@ -37,7 +37,10 @@ public abstract class FileDiffOutput implements Serializable { private static final long serialVersionUID = 1L; - /** The 20 bytes SHA-1 object ID of the old git commit used in the diff. */ + /** + * The 20 bytes SHA-1 object ID of the old git commit used in the diff, or {@link + * ObjectId#zeroId()} if {@link #newCommitId()} was a root commit. + */ public abstract ObjectId oldCommitId(); /** The 20 bytes SHA-1 object ID of the new git commit used in the diff. */ @@ -79,6 +82,14 @@ /** Difference in file size between the old and new commits. */ public abstract long sizeDelta(); + /** + * Returns {@code true} if the diff computation was not able to compute a diff, i.e. for diffs + * taking a very long time to compute. We cache negative result in this case. + */ + public abstract Optional<Boolean> negative(); + + public abstract Builder toBuilder(); + /** A boolean indicating if all underlying edits of the file diff are due to rebase. */ public boolean allEditsDueToRebase() { return !edits().isEmpty() && edits().stream().allMatch(TaggedEdit::dueToRebase); @@ -122,11 +133,31 @@ .build(); } + /** + * Create a negative file diff. We use this to cache negative diffs for entries that result in + * timeouts. + */ + public static FileDiffOutput createNegative( + String filePath, ObjectId oldCommitId, ObjectId newCommitId) { + return empty(filePath, oldCommitId, newCommitId) + .toBuilder() + .negative(Optional.of(true)) + .build(); + } + /** Returns true if this entity represents an unchanged file between two commits. */ public boolean isEmpty() { return headerLines().isEmpty() && edits().isEmpty(); } + /** + * Returns {@code true} if the diff computation was not able to compute a diff. We cache negative + * result in this case. + */ + public boolean isNegative() { + return negative().isPresent() && negative().get(); + } + public static Builder builder() { return new AutoValue_FileDiffOutput.Builder(); } @@ -151,6 +182,9 @@ for (String s : headerLines()) { s += stringSize(s); } + if (negative().isPresent()) { + result += 1; + } return result; } @@ -179,6 +213,8 @@ public abstract Builder sizeDelta(long value); + public abstract Builder negative(Optional<Boolean> value); + public abstract FileDiffOutput build(); } @@ -194,6 +230,9 @@ private static final FieldDescriptor PATCH_TYPE_DESCRIPTOR = FileDiffOutputProto.getDescriptor().findFieldByNumber(4); + private static final FieldDescriptor NEGATIVE_DESCRIPTOR = + FileDiffOutputProto.getDescriptor().findFieldByNumber(12); + @Override public byte[] serialize(FileDiffOutput fileDiff) { ObjectIdConverter idConverter = ObjectIdConverter.create(); @@ -234,6 +273,10 @@ builder.setPatchType(fileDiff.patchType().get().name()); } + if (fileDiff.negative().isPresent()) { + builder.setNegative(fileDiff.negative().get()); + } + return Protos.toByteArray(builder.build()); } @@ -272,6 +315,9 @@ if (proto.hasField(PATCH_TYPE_DESCRIPTOR)) { builder.patchType(Optional.of(Patch.PatchType.valueOf(proto.getPatchType()))); } + if (proto.hasField(NEGATIVE_DESCRIPTOR)) { + builder.negative(Optional.of(proto.getNegative())); + } return builder.build(); } }
diff --git a/java/com/google/gerrit/server/patch/filediff/PatchListLoader.java b/java/com/google/gerrit/server/patch/filediff/PatchListLoader.java deleted file mode 100644 index 017e276..0000000 --- a/java/com/google/gerrit/server/patch/filediff/PatchListLoader.java +++ /dev/null
@@ -1,680 +0,0 @@ -// Copyright (C) 2020 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// -// -// - -package com.google.gerrit.server.patch.filediff; - -import static com.google.common.base.Preconditions.checkArgument; -import static com.google.common.collect.ImmutableList.toImmutableList; -import static java.nio.charset.StandardCharsets.UTF_8; -import static java.util.stream.Collectors.toSet; -import static org.eclipse.jgit.lib.Constants.OBJ_BLOB; - -import com.google.auto.value.AutoValue; -import com.google.common.base.Throwables; -import com.google.common.collect.ImmutableList; -import com.google.common.collect.ImmutableMultimap; -import com.google.common.collect.ImmutableSet; -import com.google.common.collect.Iterables; -import com.google.common.collect.Multimap; -import com.google.common.flogger.FluentLogger; -import com.google.gerrit.entities.Patch; -import com.google.gerrit.entities.Project; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; -import com.google.gerrit.server.config.ConfigUtil; -import com.google.gerrit.server.config.GerritServerConfig; -import com.google.gerrit.server.git.GitRepositoryManager; -import com.google.gerrit.server.git.InMemoryInserter; -import com.google.gerrit.server.git.MergeUtil; -import com.google.gerrit.server.patch.AutoMerger; -import com.google.gerrit.server.patch.ComparisonType; -import com.google.gerrit.server.patch.DiffExecutor; -import com.google.gerrit.server.patch.PatchList; -import com.google.gerrit.server.patch.PatchListCache; -import com.google.gerrit.server.patch.PatchListCacheImpl; -import com.google.gerrit.server.patch.PatchListEntry; -import com.google.gerrit.server.patch.PatchListKey; -import com.google.gerrit.server.patch.PatchListNotAvailableException; -import com.google.gerrit.server.patch.Text; -import com.google.gerrit.server.patch.filediff.EditTransformer.ContextAwareEdit; -import com.google.inject.Inject; -import com.google.inject.assistedinject.Assisted; -import java.io.IOException; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashSet; -import java.util.List; -import java.util.Optional; -import java.util.Set; -import java.util.concurrent.Callable; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Future; -import java.util.concurrent.TimeUnit; -import java.util.concurrent.TimeoutException; -import org.eclipse.jgit.diff.DiffEntry; -import org.eclipse.jgit.diff.DiffEntry.ChangeType; -import org.eclipse.jgit.diff.DiffFormatter; -import org.eclipse.jgit.diff.Edit; -import org.eclipse.jgit.diff.EditList; -import org.eclipse.jgit.diff.HistogramDiff; -import org.eclipse.jgit.diff.RawText; -import org.eclipse.jgit.diff.RawTextComparator; -import org.eclipse.jgit.lib.AbbreviatedObjectId; -import org.eclipse.jgit.lib.Config; -import org.eclipse.jgit.lib.Constants; -import org.eclipse.jgit.lib.FileMode; -import org.eclipse.jgit.lib.ObjectId; -import org.eclipse.jgit.lib.ObjectInserter; -import org.eclipse.jgit.lib.ObjectReader; -import org.eclipse.jgit.lib.Repository; -import org.eclipse.jgit.merge.ThreeWayMergeStrategy; -import org.eclipse.jgit.patch.FileHeader; -import org.eclipse.jgit.patch.FileHeader.PatchType; -import org.eclipse.jgit.revwalk.RevCommit; -import org.eclipse.jgit.revwalk.RevObject; -import org.eclipse.jgit.revwalk.RevTree; -import org.eclipse.jgit.revwalk.RevWalk; -import org.eclipse.jgit.treewalk.TreeWalk; -import org.eclipse.jgit.util.io.DisabledOutputStream; - -public class PatchListLoader implements Callable<PatchList> { - public static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - public interface Factory { - PatchListLoader create(PatchListKey key, Project.NameKey project); - } - - private final GitRepositoryManager repoManager; - private final PatchListCache patchListCache; - private final ThreeWayMergeStrategy mergeStrategy; - private final ExecutorService diffExecutor; - private final AutoMerger autoMerger; - private final PatchListKey key; - private final Project.NameKey project; - private final long timeoutMillis; - - @Inject - PatchListLoader( - GitRepositoryManager mgr, - PatchListCache plc, - @GerritServerConfig Config cfg, - @DiffExecutor ExecutorService de, - AutoMerger am, - @Assisted PatchListKey k, - @Assisted Project.NameKey p) { - repoManager = mgr; - patchListCache = plc; - mergeStrategy = MergeUtil.getMergeStrategy(cfg); - diffExecutor = de; - autoMerger = am; - key = k; - project = p; - timeoutMillis = - ConfigUtil.getTimeUnit( - cfg, - "cache", - PatchListCacheImpl.FILE_NAME, - "timeout", - TimeUnit.MILLISECONDS.convert(5, TimeUnit.SECONDS), - TimeUnit.MILLISECONDS); - } - - @Override - public PatchList call() throws IOException, PatchListNotAvailableException { - try (Repository repo = repoManager.openRepository(project); - InMemoryInserter ins = new InMemoryInserter(repo); - ObjectReader reader = ins.newReader(); - RevWalk rw = new RevWalk(reader)) { - return readPatchList(repo, rw, ins); - } - } - - private static RawTextComparator comparatorFor(Whitespace ws) { - switch (ws) { - case IGNORE_ALL: - return RawTextComparator.WS_IGNORE_ALL; - - case IGNORE_TRAILING: - return RawTextComparator.WS_IGNORE_TRAILING; - - case IGNORE_LEADING_AND_TRAILING: - return RawTextComparator.WS_IGNORE_CHANGE; - - case IGNORE_NONE: - default: - return RawTextComparator.DEFAULT; - } - } - - private PatchList readPatchList(Repository repo, RevWalk rw, InMemoryInserter ins) - throws IOException, PatchListNotAvailableException { - ObjectReader reader = rw.getObjectReader(); - checkArgument(reader.getCreatedFromInserter() == ins); - RawTextComparator cmp = comparatorFor(key.getWhitespace()); - try (DiffFormatter df = new DiffFormatter(DisabledOutputStream.INSTANCE)) { - RevCommit b = rw.parseCommit(key.getNewId()); - RevObject a = aFor(key, repo, rw, ins, b); - - if (a == null) { - // TODO(sop) Remove this case. - // This is an octopus merge commit which should be compared against the - // auto-merge. However since we don't support computing the auto-merge - // for octopus merge commits, we fall back to diffing against the first - // parent, even though this wasn't what was requested. - // - ComparisonType comparisonType = ComparisonType.againstParent(1); - PatchListEntry[] entries = new PatchListEntry[2]; - entries[0] = newCommitMessage(cmp, reader, null, b); - entries[1] = newMergeList(cmp, reader, null, b, comparisonType); - return new PatchList(a, b, true, comparisonType, entries); - } - - ComparisonType comparisonType = getComparisonType(a, b); - - RevCommit aCommit = a instanceof RevCommit ? (RevCommit) a : null; - RevTree aTree = rw.parseTree(a); - RevTree bTree = b.getTree(); - - df.setReader(reader, repo.getConfig()); - df.setDiffComparator(cmp); - df.setDetectRenames(true); - List<DiffEntry> diffEntries = df.scan(aTree, bTree); - - EditsDueToRebaseResult editsDueToRebaseResult = - determineEditsDueToRebase(aCommit, b, diffEntries, df, rw); - diffEntries = editsDueToRebaseResult.getRelevantOriginalDiffEntries(); - Multimap<String, ContextAwareEdit> editsDueToRebasePerFilePath = - editsDueToRebaseResult.getEditsDueToRebasePerFilePath(); - - List<PatchListEntry> entries = new ArrayList<>(); - entries.add( - newCommitMessage( - cmp, reader, comparisonType.isAgainstParentOrAutoMerge() ? null : aCommit, b)); - boolean isMerge = b.getParentCount() > 1; - if (isMerge) { - entries.add( - newMergeList( - cmp, - reader, - comparisonType.isAgainstParentOrAutoMerge() ? null : aCommit, - b, - comparisonType)); - } - for (DiffEntry diffEntry : diffEntries) { - Set<ContextAwareEdit> editsDueToRebase = - getEditsDueToRebase(editsDueToRebasePerFilePath, diffEntry); - Optional<PatchListEntry> patchListEntry = - getPatchListEntry(reader, df, diffEntry, aTree, bTree, editsDueToRebase); - patchListEntry.ifPresent(entries::add); - } - return new PatchList( - a, b, isMerge, comparisonType, entries.toArray(new PatchListEntry[entries.size()])); - } - } - - /** - * Identifies the edits which are present between {@code commitA} and {@code commitB} due to other - * commits in between those two. Edits which cannot be clearly attributed to those other commits - * (because they overlap with modifications introduced by {@code commitA} or {@code commitB}) are - * omitted from the result. The edits are expressed as differences between {@code treeA} of {@code - * commitA} and {@code treeB} of {@code commitB}. - * - * <p><b>Note:</b> If one of the commits is a merge commit, an empty {@code Multimap} will be - * returned. - * - * <p><b>Warning:</b> This method assumes that commitA and commitB are either a parent and child - * commit or represent two patch sets which belong to the same change. No checks are made to - * confirm this assumption! Passing arbitrary commits to this method may lead to strange results - * or take very long. - * - * <p>This logic could be expanded to arbitrary commits if the following adjustments were applied: - * - * <ul> - * <li>If {@code commitA} is an ancestor of {@code commitB} (or the other way around), {@code - * commitA} (or {@code commitB}) is used instead of its parent in this method. - * <li>Special handling for merge commits is added. If only one of them is a merge commit, the - * whole computation has to be done between the single parent and all parents of the merge - * commit. If both of them are merge commits, all combinations of parents have to be - * considered. Alternatively, we could decide to not support this feature for merge commits - * (or just for specific types of merge commits). - * </ul> - * - * @param commitA the commit defining {@code treeA} - * @param commitB the commit defining {@code treeB} - * @param diffEntries the list of {@code DiffEntries} for the diff between {@code commitA} and - * {@code commitB} - * @param df the {@code DiffFormatter} - * @param rw the current {@code RevWalk} - * @return an aggregated result of the computation - * @throws PatchListNotAvailableException if the edits can't be identified - * @throws IOException if an error occurred while accessing the repository - */ - private EditsDueToRebaseResult determineEditsDueToRebase( - RevCommit commitA, - RevCommit commitB, - List<DiffEntry> diffEntries, - DiffFormatter df, - RevWalk rw) - throws PatchListNotAvailableException, IOException { - if (commitA == null - || isRootOrMergeCommit(commitA) - || isRootOrMergeCommit(commitB) - || areParentChild(commitA, commitB) - || haveCommonParent(commitA, commitB)) { - return EditsDueToRebaseResult.create(diffEntries, ImmutableMultimap.of()); - } - - PatchListKey oldKey = PatchListKey.againstDefaultBase(key.getOldId(), key.getWhitespace()); - PatchList oldPatchList = patchListCache.get(oldKey, project); - PatchListKey newKey = PatchListKey.againstDefaultBase(key.getNewId(), key.getWhitespace()); - PatchList newPatchList = patchListCache.get(newKey, project); - - List<PatchListEntry> oldPatches = oldPatchList.getPatches(); - List<PatchListEntry> newPatches = newPatchList.getPatches(); - // TODO(aliceks): Have separate but more limited lists for parents and patch sets (but don't - // mess up renames/copies). - Set<String> touchedFilePaths = new HashSet<>(); - for (PatchListEntry patchListEntry : oldPatches) { - touchedFilePaths.addAll(getTouchedFilePaths(patchListEntry)); - } - for (PatchListEntry patchListEntry : newPatches) { - touchedFilePaths.addAll(getTouchedFilePaths(patchListEntry)); - } - - List<DiffEntry> relevantDiffEntries = - diffEntries.stream() - .filter(diffEntry -> isTouched(touchedFilePaths, diffEntry)) - .collect(toImmutableList()); - - RevCommit parentCommitA = commitA.getParent(0); - rw.parseBody(parentCommitA); - RevCommit parentCommitB = commitB.getParent(0); - rw.parseBody(parentCommitB); - List<DiffEntry> parentDiffEntries = df.scan(parentCommitA, parentCommitB); - // TODO(aliceks): Find a way to not construct a PatchListEntry as it contains many unnecessary - // details and we don't fill all of them properly. - List<PatchListEntry> parentPatchListEntries = - getRelevantPatchListEntries( - parentDiffEntries, parentCommitA, parentCommitB, touchedFilePaths, df); - - EditTransformer editTransformer = new EditTransformer(toFileEditsList(parentPatchListEntries)); - editTransformer.transformReferencesOfSideA(toFileEditsList(oldPatches)); - editTransformer.transformReferencesOfSideB(toFileEditsList(newPatches)); - return EditsDueToRebaseResult.create( - relevantDiffEntries, editTransformer.getEditsPerFilePath()); - } - - private ImmutableList<FileEdits> toFileEditsList(List<PatchListEntry> entries) { - return entries.stream().map(PatchListLoader::toFileEdits).collect(toImmutableList()); - } - - private static FileEdits toFileEdits(PatchListEntry patchListEntry) { - Optional<String> oldName = Optional.empty(); - Optional<String> newName = Optional.empty(); - switch (patchListEntry.getChangeType()) { - case DELETED: - oldName = Optional.of(patchListEntry.getNewName()); - break; - case ADDED: - case MODIFIED: - case REWRITE: - newName = Optional.of(patchListEntry.getNewName()); - break; - - case COPIED: - case RENAMED: - oldName = Optional.of(patchListEntry.getOldName()); - newName = Optional.of(patchListEntry.getNewName()); - break; - } - return FileEdits.createFromJgitEdits(patchListEntry.getEdits(), oldName, newName); - } - - private static boolean isRootOrMergeCommit(RevCommit commit) { - return commit.getParentCount() != 1; - } - - private static boolean areParentChild(RevCommit commitA, RevCommit commitB) { - return ObjectId.isEqual(commitA.getParent(0), commitB) - || ObjectId.isEqual(commitB.getParent(0), commitA); - } - - private static boolean haveCommonParent(RevCommit commitA, RevCommit commitB) { - return ObjectId.isEqual(commitA.getParent(0), commitB.getParent(0)); - } - - private static Set<String> getTouchedFilePaths(PatchListEntry patchListEntry) { - String oldFilePath = patchListEntry.getOldName(); - String newFilePath = patchListEntry.getNewName(); - - return oldFilePath == null - ? ImmutableSet.of(newFilePath) - : ImmutableSet.of(oldFilePath, newFilePath); - } - - private static boolean isTouched(Set<String> touchedFilePaths, DiffEntry diffEntry) { - String oldFilePath = diffEntry.getOldPath(); - String newFilePath = diffEntry.getNewPath(); - // One of the above file paths could be /dev/null but we need not explicitly check for this - // value as the set of file paths shouldn't contain it. - return touchedFilePaths.contains(oldFilePath) || touchedFilePaths.contains(newFilePath); - } - - private List<PatchListEntry> getRelevantPatchListEntries( - List<DiffEntry> parentDiffEntries, - RevCommit parentCommitA, - RevCommit parentCommitB, - Set<String> touchedFilePaths, - DiffFormatter diffFormatter) - throws IOException { - List<PatchListEntry> parentPatchListEntries = new ArrayList<>(parentDiffEntries.size()); - for (DiffEntry parentDiffEntry : parentDiffEntries) { - if (!isTouched(touchedFilePaths, parentDiffEntry)) { - continue; - } - FileHeader fileHeader = toFileHeader(parentCommitB, diffFormatter, parentDiffEntry); - // The code which uses this PatchListEntry doesn't care about the last three parameters. As - // they are expensive to compute, we use arbitrary values for them. - PatchListEntry patchListEntry = - newEntry(parentCommitA.getTree(), fileHeader, ImmutableSet.of(), 0, 0); - parentPatchListEntries.add(patchListEntry); - } - return parentPatchListEntries; - } - - private static Set<ContextAwareEdit> getEditsDueToRebase( - Multimap<String, ContextAwareEdit> editsDueToRebasePerFilePath, DiffEntry diffEntry) { - if (editsDueToRebasePerFilePath.isEmpty()) { - return ImmutableSet.of(); - } - - String filePath = diffEntry.getNewPath(); - if (diffEntry.getChangeType() == ChangeType.DELETE) { - filePath = diffEntry.getOldPath(); - } - return ImmutableSet.copyOf(editsDueToRebasePerFilePath.get(filePath)); - } - - private Optional<PatchListEntry> getPatchListEntry( - ObjectReader objectReader, - DiffFormatter diffFormatter, - DiffEntry diffEntry, - RevTree treeA, - RevTree treeB, - Set<ContextAwareEdit> editsDueToRebase) - throws IOException { - FileHeader fileHeader = toFileHeader(key.getNewId(), diffFormatter, diffEntry); - long oldSize = - getFileSize( - objectReader, - diffEntry.getOldId(), - diffEntry.getOldMode(), - diffEntry.getOldPath(), - treeA); - long newSize = - getFileSize( - objectReader, - diffEntry.getNewId(), - diffEntry.getNewMode(), - diffEntry.getNewPath(), - treeB); - Set<Edit> contentEditsDueToRebase = getContentEdits(editsDueToRebase); - PatchListEntry patchListEntry = - newEntry(treeA, fileHeader, contentEditsDueToRebase, newSize, newSize - oldSize); - // All edits in a file are due to rebase -> exclude the file from the diff. - if (EditTransformer.toEdits(toFileEdits(patchListEntry)).allMatch(editsDueToRebase::contains)) { - return Optional.empty(); - } - return Optional.of(patchListEntry); - } - - private static Set<Edit> getContentEdits(Set<ContextAwareEdit> editsDueToRebase) { - return editsDueToRebase.stream() - .map(ContextAwareEdit::toEdit) - .filter(Optional::isPresent) - .map(Optional::get) - .collect(toSet()); - } - - private ComparisonType getComparisonType(RevObject a, RevCommit b) { - for (int i = 0; i < b.getParentCount(); i++) { - if (b.getParent(i).equals(a)) { - return ComparisonType.againstParent(i + 1); - } - } - - if (key.getOldId() == null && b.getParentCount() > 0) { - return ComparisonType.againstAutoMerge(); - } - - return ComparisonType.againstOtherPatchSet(); - } - - private static long getFileSize( - ObjectReader reader, AbbreviatedObjectId abbreviatedId, FileMode mode, String path, RevTree t) - throws IOException { - if (!isBlob(mode)) { - return 0; - } - ObjectId fileId = - toObjectId(reader, abbreviatedId).orElseGet(() -> lookupObjectId(reader, path, t)); - if (ObjectId.zeroId().equals(fileId)) { - return 0; - } - return reader.getObjectSize(fileId, OBJ_BLOB); - } - - private static boolean isBlob(FileMode mode) { - int t = mode.getBits() & FileMode.TYPE_MASK; - return t == FileMode.TYPE_FILE || t == FileMode.TYPE_SYMLINK; - } - - private static Optional<ObjectId> toObjectId( - ObjectReader reader, AbbreviatedObjectId abbreviatedId) throws IOException { - if (abbreviatedId == null) { - // In theory, DiffEntry#getOldId or DiffEntry#getNewId can be null for pure renames or pure - // mode changes (e.g. DiffEntry#modify doesn't set the IDs). However, the method we call - // for diffs (DiffFormatter#scan) seems to always produce DiffEntries with set IDs, even for - // pure renames. - return Optional.empty(); - } - if (abbreviatedId.isComplete()) { - // With the current JGit version and the method we call for diffs (DiffFormatter#scan), this - // is the only code path taken right now. - return Optional.ofNullable(abbreviatedId.toObjectId()); - } - Collection<ObjectId> objectIds = reader.resolve(abbreviatedId); - // It seems very unlikely that an ObjectId which was just abbreviated by the diff computation - // now can't be resolved to exactly one ObjectId. The API allows this possibility, though. - return objectIds.size() == 1 - ? Optional.of(Iterables.getOnlyElement(objectIds)) - : Optional.empty(); - } - - private static ObjectId lookupObjectId(ObjectReader reader, String path, RevTree tree) { - // This variant is very expensive. - try (TreeWalk treeWalk = TreeWalk.forPath(reader, path, tree)) { - return treeWalk != null ? treeWalk.getObjectId(0) : ObjectId.zeroId(); - } catch (IOException e) { - throw new StorageException(e); - } - } - - private FileHeader toFileHeader( - ObjectId commitB, DiffFormatter diffFormatter, DiffEntry diffEntry) throws IOException { - - Future<FileHeader> result = - diffExecutor.submit( - () -> { - synchronized (diffEntry) { - return diffFormatter.toFileHeader(diffEntry); - } - }); - - try { - return result.get(timeoutMillis, TimeUnit.MILLISECONDS); - } catch (InterruptedException | TimeoutException e) { - logger.atWarning().log( - "%s ms timeout reached for Diff loader in project %s" - + " on commit %s on path %s comparing %s..%s", - timeoutMillis, - project, - commitB.name(), - diffEntry.getNewPath(), - diffEntry.getOldId().name(), - diffEntry.getNewId().name()); - result.cancel(true); - synchronized (diffEntry) { - return toFileHeaderWithoutMyersDiff(diffFormatter, diffEntry); - } - } catch (ExecutionException e) { - // If there was an error computing the result, carry it - // up to the caller so the cache knows this key is invalid. - Throwables.throwIfInstanceOf(e.getCause(), IOException.class); - throw new IOException(e.getMessage(), e.getCause()); - } - } - - private FileHeader toFileHeaderWithoutMyersDiff(DiffFormatter diffFormatter, DiffEntry diffEntry) - throws IOException { - HistogramDiff histogramDiff = new HistogramDiff(); - histogramDiff.setFallbackAlgorithm(null); - diffFormatter.setDiffAlgorithm(histogramDiff); - return diffFormatter.toFileHeader(diffEntry); - } - - private PatchListEntry newCommitMessage( - RawTextComparator cmp, ObjectReader reader, RevCommit aCommit, RevCommit bCommit) - throws IOException { - Text aText = aCommit != null ? Text.forCommit(reader, aCommit) : Text.EMPTY; - Text bText = Text.forCommit(reader, bCommit); - return createPatchListEntry(cmp, aCommit, aText, bText, Patch.COMMIT_MSG); - } - - private PatchListEntry newMergeList( - RawTextComparator cmp, - ObjectReader reader, - RevCommit aCommit, - RevCommit bCommit, - ComparisonType comparisonType) - throws IOException { - Text aText = aCommit != null ? Text.forMergeList(comparisonType, reader, aCommit) : Text.EMPTY; - Text bText = Text.forMergeList(comparisonType, reader, bCommit); - return createPatchListEntry(cmp, aCommit, aText, bText, Patch.MERGE_LIST); - } - - private static PatchListEntry createPatchListEntry( - RawTextComparator cmp, RevCommit aCommit, Text aText, Text bText, String fileName) { - byte[] rawHdr = getRawHeader(aCommit != null, fileName); - byte[] aContent = aText.getContent(); - byte[] bContent = bText.getContent(); - long size = bContent.length; - long sizeDelta = size - aContent.length; - RawText aRawText = new RawText(aContent); - RawText bRawText = new RawText(bContent); - EditList edits = new HistogramDiff().diff(cmp, aRawText, bRawText); - FileHeader fh = new FileHeader(rawHdr, edits, PatchType.UNIFIED); - return new PatchListEntry(fh, edits, ImmutableSet.of(), size, sizeDelta); - } - - private static byte[] getRawHeader(boolean hasA, String fileName) { - StringBuilder hdr = new StringBuilder(); - hdr.append("diff --git"); - if (hasA) { - hdr.append(" a/").append(fileName); - } else { - hdr.append(" ").append(FileHeader.DEV_NULL); - } - hdr.append(" b/").append(fileName); - hdr.append("\n"); - - if (hasA) { - hdr.append("--- a/").append(fileName).append("\n"); - } else { - hdr.append("--- ").append(FileHeader.DEV_NULL).append("\n"); - } - hdr.append("+++ b/").append(fileName).append("\n"); - return hdr.toString().getBytes(UTF_8); - } - - private static PatchListEntry newEntry( - RevTree aTree, FileHeader fileHeader, Set<Edit> editsDueToRebase, long size, long sizeDelta) { - if (aTree == null // want combined diff - || fileHeader.getPatchType() != PatchType.UNIFIED - || fileHeader.getHunks().isEmpty()) { - return new PatchListEntry(fileHeader, ImmutableList.of(), ImmutableSet.of(), size, sizeDelta); - } - - List<Edit> edits = fileHeader.toEditList(); - if (edits.isEmpty()) { - return new PatchListEntry(fileHeader, ImmutableList.of(), ImmutableSet.of(), size, sizeDelta); - } - return new PatchListEntry(fileHeader, edits, editsDueToRebase, size, sizeDelta); - } - - private RevObject aFor( - PatchListKey key, Repository repo, RevWalk rw, InMemoryInserter ins, RevCommit b) - throws IOException { - if (key.getOldId() != null) { - return rw.parseAny(key.getOldId()); - } - - switch (b.getParentCount()) { - case 0: - return rw.parseAny(emptyTree(ins)); - case 1: - { - RevCommit r = b.getParent(0); - rw.parseBody(r); - return r; - } - default: - if (key.getParentNum() != null) { - RevCommit r = b.getParent(key.getParentNum() - 1); - rw.parseBody(r); - return r; - } - // Only support auto-merge for 2 parents, not octopus merges - if (b.getParentCount() == 2) { - return autoMerger.lookupFromGitOrMergeInMemory(repo, rw, ins, b, mergeStrategy); - } - return null; - } - } - - private static ObjectId emptyTree(ObjectInserter ins) throws IOException { - ObjectId id = ins.insert(Constants.OBJ_TREE, new byte[] {}); - ins.flush(); - return id; - } - - @AutoValue - abstract static class EditsDueToRebaseResult { - public static EditsDueToRebaseResult create( - List<DiffEntry> relevantDiffEntries, - Multimap<String, ContextAwareEdit> editsDueToRebasePerFilePath) { - return new AutoValue_PatchListLoader_EditsDueToRebaseResult( - relevantDiffEntries, editsDueToRebasePerFilePath); - } - - public abstract List<DiffEntry> getRelevantOriginalDiffEntries(); - - /** Returns the edits per file path they modify in {@code treeB}. */ - public abstract Multimap<String, ContextAwareEdit> getEditsDueToRebasePerFilePath(); - } -}
diff --git a/java/com/google/gerrit/server/patch/gitdiff/GitModifiedFilesCacheImpl.java b/java/com/google/gerrit/server/patch/gitdiff/GitModifiedFilesCacheImpl.java index b3b82bb..9d5dc2d 100644 --- a/java/com/google/gerrit/server/patch/gitdiff/GitModifiedFilesCacheImpl.java +++ b/java/com/google/gerrit/server/patch/gitdiff/GitModifiedFilesCacheImpl.java
@@ -29,6 +29,7 @@ import com.google.gerrit.server.patch.DiffNotAvailableException; import com.google.inject.Inject; import com.google.inject.Module; +import com.google.inject.Singleton; import com.google.inject.TypeLiteral; import com.google.inject.name.Named; import java.io.IOException; @@ -38,11 +39,13 @@ import org.eclipse.jgit.diff.DiffEntry; import org.eclipse.jgit.diff.DiffEntry.ChangeType; import org.eclipse.jgit.diff.DiffFormatter; +import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.ObjectReader; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.util.io.DisabledOutputStream; /** Implementation of the {@link GitModifiedFilesCache} */ +@Singleton public class GitModifiedFilesCacheImpl implements GitModifiedFilesCache { private static final String GIT_MODIFIED_FILES = "git_modified_files"; private static final ImmutableMap<ChangeType, Patch.ChangeType> changeTypeMap = @@ -79,7 +82,7 @@ .weigher(GitModifiedFilesWeigher.class) // The cache is using the default disk limit as per section cache.<name>.diskLimit // in the cache documentation link. - .version(1) + .version(2) .loader(GitModifiedFilesCacheImpl.Loader.class); } }; @@ -128,9 +131,11 @@ df.setDetectRenames(true); df.getRenameDetector().setRenameScore(key.renameScore()); } + // Skip detecting content renames for binary files. + df.getRenameDetector().setSkipContentRenamesForBinaryFiles(true); // The scan method only returns the file paths that are different. Callers may choose to // format these paths themselves. - return df.scan(key.aTree(), key.bTree()); + return df.scan(key.aTree().equals(ObjectId.zeroId()) ? null : key.aTree(), key.bTree()); } }
diff --git a/java/com/google/gerrit/server/patch/gitdiff/GitModifiedFilesCacheKey.java b/java/com/google/gerrit/server/patch/gitdiff/GitModifiedFilesCacheKey.java index fb8fce1..16b0e65 100644 --- a/java/com/google/gerrit/server/patch/gitdiff/GitModifiedFilesCacheKey.java +++ b/java/com/google/gerrit/server/patch/gitdiff/GitModifiedFilesCacheKey.java
@@ -37,7 +37,8 @@ /** * The git SHA-1 {@link ObjectId} of the first git tree object for which the diff should be - * computed. + * computed. If equals to {@link ObjectId#zeroId()}, a null tree is used for the diff scan, and + * {@link #bTree()} is treated as an added tree. */ public abstract ObjectId aTree();
diff --git a/java/com/google/gerrit/server/patch/gitdiff/ModifiedFile.java b/java/com/google/gerrit/server/patch/gitdiff/ModifiedFile.java index 9512094..f4e7ca3 100644 --- a/java/com/google/gerrit/server/patch/gitdiff/ModifiedFile.java +++ b/java/com/google/gerrit/server/patch/gitdiff/ModifiedFile.java
@@ -51,6 +51,8 @@ return new AutoValue_ModifiedFile.Builder(); } + public abstract Builder toBuilder(); + /** Computes this object's weight, which is its size in bytes. */ public int weight() { int weight = 1; // the changeType field
diff --git a/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiff.java b/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiff.java index e1af81d..2f23c8c 100644 --- a/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiff.java +++ b/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiff.java
@@ -29,13 +29,12 @@ import com.google.gerrit.server.cache.serialize.ObjectIdConverter; import com.google.gerrit.server.patch.filediff.Edit; import com.google.protobuf.Descriptors.FieldDescriptor; -import java.io.IOException; import java.util.Map; import java.util.Optional; import org.eclipse.jgit.diff.DiffEntry; -import org.eclipse.jgit.diff.DiffFormatter; import org.eclipse.jgit.lib.AbbreviatedObjectId; import org.eclipse.jgit.lib.FileMode; +import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.patch.FileHeader; /** @@ -65,8 +64,7 @@ * Creates a {@link GitFileDiff} using the {@code diffEntry} and the {@code diffFormatter} * parameters. */ - static GitFileDiff create(DiffEntry diffEntry, DiffFormatter diffFormatter) throws IOException { - FileHeader fileHeader = diffFormatter.toFileHeader(diffEntry); + static GitFileDiff create(DiffEntry diffEntry, FileHeader fileHeader) { ImmutableList<Edit> edits = fileHeader.toEditList().stream().map(Edit::fromJGitEdit).collect(toImmutableList()); @@ -102,6 +100,15 @@ .build(); } + /** + * Create a negative result to be cached, i.e. if the diff computation did not finish in a + * reasonable amount of time. + */ + static GitFileDiff createNegative( + AbbreviatedObjectId oldId, AbbreviatedObjectId newId, String newFilePath) { + return empty(oldId, newId, newFilePath).toBuilder().negative(Optional.of(true)).build(); + } + /** An {@link ImmutableList} of the modified regions in the file. */ public abstract ImmutableList<Edit> edits(); @@ -114,7 +121,10 @@ /** The file name at the new git tree identified by {@link #newId()} */ public abstract Optional<String> newPath(); - /** The 20 bytes SHA-1 object ID of the old git tree of the diff. */ + /** + * The 20 bytes SHA-1 object ID of the old git tree of the diff, or {@link ObjectId#zeroId()} if + * {@link #newId()} was a root git tree (i.e. has no parents). + */ public abstract AbbreviatedObjectId oldId(); /** The 20 bytes SHA-1 object ID of the new git tree of the diff. */ @@ -133,6 +143,12 @@ public abstract Optional<PatchType> patchType(); /** + * Returns {@code true} if the diff computation was not able to compute a diff. We cache negative + * result in this case. + */ + public abstract Optional<Boolean> negative(); + + /** * Returns true if the object was created using the {@link #empty(AbbreviatedObjectId, * AbbreviatedObjectId, String)} method. */ @@ -140,6 +156,14 @@ return edits().isEmpty(); } + /** + * Returns {@code true} if the diff computation was not able to compute a diff. We cache negative + * result in this case. + */ + public boolean isNegative() { + return negative().isPresent() && negative().get(); + } + /** Returns the size of the object in bytes. */ public int weight() { int result = 20 * 2; // oldId and newId @@ -161,13 +185,22 @@ if (newMode().isPresent()) { result += 4; } + if (negative().isPresent()) { + result += 1; + } return result; } + public String getDefaultPath() { + return oldPath().isPresent() ? oldPath().get() : newPath().get(); + } + public static Builder builder() { return new AutoValue_GitFileDiff.Builder(); } + public abstract Builder toBuilder(); + @AutoValue.Builder public abstract static class Builder { @@ -191,6 +224,8 @@ public abstract Builder patchType(Optional<PatchType> value); + public abstract Builder negative(Optional<Boolean> value); + public abstract GitFileDiff build(); } @@ -212,6 +247,9 @@ private static final FieldDescriptor PATCH_TYPE_DESCRIPTOR = GitFileDiffProto.getDescriptor().findFieldByNumber(10); + private static final FieldDescriptor NEGATIVE_DESCRIPTOR = + GitFileDiffProto.getDescriptor().findFieldByNumber(11); + @Override public byte[] serialize(GitFileDiff gitFileDiff) { ObjectIdConverter idConverter = ObjectIdConverter.create(); @@ -246,6 +284,9 @@ if (gitFileDiff.patchType().isPresent()) { builder.setPatchType(gitFileDiff.patchType().get().name()); } + if (gitFileDiff.negative().isPresent()) { + builder.setNegative(gitFileDiff.negative().get()); + } return Protos.toByteArray(builder.build()); } @@ -279,6 +320,9 @@ if (proto.hasField(PATCH_TYPE_DESCRIPTOR)) { builder.patchType(Optional.of(Patch.PatchType.valueOf(proto.getPatchType()))); } + if (proto.hasField(NEGATIVE_DESCRIPTOR)) { + builder.negative(Optional.of(proto.getNegative())); + } return builder.build(); } }
diff --git a/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiffCacheImpl.java b/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiffCacheImpl.java index 97cf37d32..44af22e 100644 --- a/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiffCacheImpl.java +++ b/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiffCacheImpl.java
@@ -17,27 +17,49 @@ import static java.util.function.Function.identity; import com.google.auto.value.AutoValue; +import com.google.common.base.Throwables; import com.google.common.cache.CacheLoader; import com.google.common.cache.LoadingCache; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.common.collect.Iterables; +import com.google.common.collect.ListMultimap; +import com.google.common.collect.MultimapBuilder; +import com.google.common.collect.Multimaps; import com.google.common.collect.Streams; +import com.google.gerrit.entities.Patch; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; +import com.google.gerrit.metrics.Counter0; +import com.google.gerrit.metrics.Description; +import com.google.gerrit.metrics.MetricMaker; import com.google.gerrit.server.cache.CacheModule; +import com.google.gerrit.server.config.ConfigUtil; +import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.git.GitRepositoryManager; +import com.google.gerrit.server.logging.Metadata; +import com.google.gerrit.server.logging.TraceContext; +import com.google.gerrit.server.logging.TraceContext.TraceTimer; +import com.google.gerrit.server.patch.DiffExecutor; import com.google.gerrit.server.patch.DiffNotAvailableException; +import com.google.gerrit.server.util.git.CloseablePool; import com.google.inject.Inject; import com.google.inject.Module; +import com.google.inject.Singleton; import com.google.inject.name.Named; import java.io.IOException; +import java.util.ArrayList; import java.util.Collection; +import java.util.Comparator; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.ExecutionException; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; import java.util.function.Function; import java.util.stream.Collectors; import org.eclipse.jgit.diff.DiffEntry; @@ -46,12 +68,14 @@ import org.eclipse.jgit.diff.HistogramDiff; import org.eclipse.jgit.diff.RawTextComparator; import org.eclipse.jgit.lib.AbbreviatedObjectId; +import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.ObjectId; -import org.eclipse.jgit.lib.ObjectReader; import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.patch.FileHeader; import org.eclipse.jgit.util.io.DisabledOutputStream; /** Implementation of the {@link GitFileDiffCache} */ +@Singleton public class GitFileDiffCacheImpl implements GitFileDiffCache { private static final String GIT_DIFF = "git_file_diff"; @@ -65,22 +89,39 @@ .weigher(GitFileDiffWeigher.class) .keySerializer(GitFileDiffCacheKey.Serializer.INSTANCE) .valueSerializer(GitFileDiff.Serializer.INSTANCE) + .version(3) .loader(GitFileDiffCacheImpl.Loader.class); } }; } + @Singleton + static class Metrics { + final Counter0 timeouts; + + @Inject + Metrics(MetricMaker metricMaker) { + timeouts = + metricMaker.newCounter( + "caches/diff/timeouts", + new Description( + "Total number of git file diff computations that resulted in timeouts.") + .setRate() + .setUnit("count")); + } + } + /** Enum for the supported diff algorithms for the file diff computation. */ public enum DiffAlgorithm { - HISTOGRAM, - HISTOGRAM_WITHOUT_MYERS_FALLBACK + HISTOGRAM_WITH_FALLBACK_MYERS, + HISTOGRAM_NO_FALLBACK } /** Creates a new JGit diff algorithm instance using the Gerrit's {@link DiffAlgorithm} enum. */ public static class DiffAlgorithmFactory { public static org.eclipse.jgit.diff.DiffAlgorithm create(DiffAlgorithm diffAlgorithm) { HistogramDiff result = new HistogramDiff(); - if (diffAlgorithm.equals(DiffAlgorithm.HISTOGRAM_WITHOUT_MYERS_FALLBACK)) { + if (diffAlgorithm.equals(DiffAlgorithm.HISTOGRAM_NO_FALLBACK)) { result.setFallbackAlgorithm(null); } return result; @@ -126,43 +167,72 @@ : entry.getNewPath(); private final GitRepositoryManager repoManager; + private final ExecutorService diffExecutor; + private final long timeoutMillis; + private final Metrics metrics; @Inject - public Loader(GitRepositoryManager repoManager) { + public Loader( + @GerritServerConfig Config cfg, + GitRepositoryManager repoManager, + @DiffExecutor ExecutorService de, + Metrics metrics) { this.repoManager = repoManager; + this.diffExecutor = de; + this.timeoutMillis = + ConfigUtil.getTimeUnit( + cfg, + "cache", + GIT_DIFF, + "timeout", + TimeUnit.MILLISECONDS.convert(5, TimeUnit.SECONDS), + TimeUnit.MILLISECONDS); + this.metrics = metrics; } @Override - public GitFileDiff load(GitFileDiffCacheKey key) throws IOException { - return loadAll(ImmutableList.of(key)).get(key); + public GitFileDiff load(GitFileDiffCacheKey key) throws IOException, DiffNotAvailableException { + try (TraceTimer timer = + TraceContext.newTimer( + "Loading a single key from git file diff cache", + Metadata.builder() + .diffAlgorithm(key.diffAlgorithm().name()) + .filePath(key.newFilePath()) + .build())) { + return loadAll(ImmutableList.of(key)).get(key); + } } @Override public Map<GitFileDiffCacheKey, GitFileDiff> loadAll( - Iterable<? extends GitFileDiffCacheKey> keys) throws IOException { - ImmutableMap.Builder<GitFileDiffCacheKey, GitFileDiff> result = - ImmutableMap.builderWithExpectedSize(Iterables.size(keys)); + Iterable<? extends GitFileDiffCacheKey> keys) + throws IOException, DiffNotAvailableException { + try (TraceTimer timer = + TraceContext.newTimer("Loading multiple keys from git file diff cache")) { + ImmutableMap.Builder<GitFileDiffCacheKey, GitFileDiff> result = + ImmutableMap.builderWithExpectedSize(Iterables.size(keys)); - Map<Project.NameKey, List<GitFileDiffCacheKey>> byProject = - Streams.stream(keys) - .distinct() - .collect(Collectors.groupingBy(GitFileDiffCacheKey::project)); + Map<Project.NameKey, List<GitFileDiffCacheKey>> byProject = + Streams.stream(keys) + .distinct() + .collect(Collectors.groupingBy(GitFileDiffCacheKey::project)); - for (Map.Entry<Project.NameKey, List<GitFileDiffCacheKey>> entry : byProject.entrySet()) { - try (Repository repo = repoManager.openRepository(entry.getKey()); - ObjectReader reader = repo.newObjectReader()) { + for (Map.Entry<Project.NameKey, List<GitFileDiffCacheKey>> entry : byProject.entrySet()) { + try (Repository repo = repoManager.openRepository(entry.getKey())) { - // Grouping keys by diff options because each group of keys will be processed with a - // separate call to JGit using the DiffFormatter object. - Map<DiffOptions, List<GitFileDiffCacheKey>> optionsGroups = - entry.getValue().stream().collect(Collectors.groupingBy(DiffOptions::fromKey)); + // Grouping keys by diff options because each group of keys will be processed with a + // separate call to JGit using the DiffFormatter object. + Map<DiffOptions, List<GitFileDiffCacheKey>> optionsGroups = + entry.getValue().stream().collect(Collectors.groupingBy(DiffOptions::fromKey)); - for (Map.Entry<DiffOptions, List<GitFileDiffCacheKey>> group : optionsGroups.entrySet()) { - result.putAll(loadAllImpl(repo, reader, group.getKey(), group.getValue())); + for (Map.Entry<DiffOptions, List<GitFileDiffCacheKey>> group : + optionsGroups.entrySet()) { + result.putAll(loadAllImpl(repo, group.getKey(), group.getValue())); + } } } + return result.build(); } - return result.build(); } /** @@ -172,46 +242,69 @@ * @return The git file diffs for all input keys. */ private Map<GitFileDiffCacheKey, GitFileDiff> loadAllImpl( - Repository repo, ObjectReader reader, DiffOptions options, List<GitFileDiffCacheKey> keys) - throws IOException { + Repository repo, DiffOptions options, List<GitFileDiffCacheKey> keys) + throws IOException, DiffNotAvailableException { ImmutableMap.Builder<GitFileDiffCacheKey, GitFileDiff> result = ImmutableMap.builderWithExpectedSize(keys.size()); Map<GitFileDiffCacheKey, String> filePaths = keys.stream().collect(Collectors.toMap(identity(), GitFileDiffCacheKey::newFilePath)); - DiffFormatter formatter = createDiffFormatter(options, repo, reader); - Map<String, DiffEntry> diffEntries = loadDiffEntries(formatter, options, filePaths.values()); - for (GitFileDiffCacheKey key : filePaths.keySet()) { - String newFilePath = filePaths.get(key); - if (diffEntries.containsKey(newFilePath)) { - result.put(key, GitFileDiff.create(diffEntries.get(newFilePath), formatter)); - continue; + try (CloseablePool<DiffFormatter> diffPool = + new CloseablePool<>(() -> createDiffFormatter(options, repo))) { + ListMultimap<String, DiffEntry> diffEntries; + try (CloseablePool<DiffFormatter>.Handle formatter = diffPool.get()) { + diffEntries = loadDiffEntries(formatter.get(), options, filePaths.values()); } - result.put( - key, - GitFileDiff.empty( - AbbreviatedObjectId.fromObjectId(key.oldTree()), - AbbreviatedObjectId.fromObjectId(key.newTree()), - newFilePath)); + for (GitFileDiffCacheKey key : filePaths.keySet()) { + String newFilePath = filePaths.get(key); + if (!diffEntries.containsKey(newFilePath)) { + result.put( + key, + GitFileDiff.empty( + AbbreviatedObjectId.fromObjectId(key.oldTree()), + AbbreviatedObjectId.fromObjectId(key.newTree()), + newFilePath)); + continue; + } + List<DiffEntry> entries = diffEntries.get(newFilePath); + if (entries.size() == 1) { + result.put(key, createGitFileDiff(entries.get(0), key, diffPool)); + } else { + // Handle when JGit returns two {Added, Deleted} entries for the same file. This + // happens, for example, when a file's mode is changed between patchsets (e.g. + // converting a symlink to a regular file). We combine both diff entries into a single + // entry with {changeType = Rewrite}. + List<GitFileDiff> gitDiffs = new ArrayList<>(); + for (DiffEntry entry : diffEntries.get(newFilePath)) { + gitDiffs.add(createGitFileDiff(entry, key, diffPool)); + } + result.put(key, createRewriteEntry(gitDiffs)); + } + } + return result.build(); } - return result.build(); } - private static Map<String, DiffEntry> loadDiffEntries( + private static ListMultimap<String, DiffEntry> loadDiffEntries( DiffFormatter diffFormatter, DiffOptions diffOptions, Collection<String> filePaths) throws IOException { Set<String> filePathsSet = ImmutableSet.copyOf(filePaths); List<DiffEntry> diffEntries = - diffFormatter.scan(diffOptions.oldTree(), diffOptions.newTree()); + diffFormatter.scan( + diffOptions.oldTree().equals(ObjectId.zeroId()) ? null : diffOptions.oldTree(), + diffOptions.newTree()); return diffEntries.stream() .filter(d -> filePathsSet.contains(pathExtractor.apply(d))) - .collect(Collectors.toMap(d -> pathExtractor.apply(d), identity())); + .collect( + Multimaps.toMultimap( + d -> pathExtractor.apply(d), + identity(), + MultimapBuilder.treeKeys().arrayListValues()::build)); } - private static DiffFormatter createDiffFormatter( - DiffOptions diffOptions, Repository repo, ObjectReader reader) { + private static DiffFormatter createDiffFormatter(DiffOptions diffOptions, Repository repo) { try (DiffFormatter diffFormatter = new DiffFormatter(DisabledOutputStream.INSTANCE)) { - diffFormatter.setReader(reader, repo.getConfig()); + diffFormatter.setRepository(repo); RawTextComparator cmp = comparatorFor(diffOptions.whitespace()); diffFormatter.setDiffComparator(cmp); if (diffOptions.renameScore() != -1) { @@ -219,6 +312,7 @@ diffFormatter.getRenameDetector().setRenameScore(diffOptions.renameScore()); } diffFormatter.setDiffAlgorithm(DiffAlgorithmFactory.create(diffOptions.diffAlgorithm())); + diffFormatter.getRenameDetector().setSkipContentRenamesForBinaryFiles(true); return diffFormatter; } } @@ -239,6 +333,83 @@ return RawTextComparator.DEFAULT; } } + + /** + * Create a {@link GitFileDiff}. The result depends on the value of the {@code useTimeout} field + * of the {@code key} parameter. + * + * <ul> + * <li>If {@code useTimeout} is true, the computation is performed with timeout enforcement + * (identified by {@link #timeoutMillis}). If the timeout is exceeded, this method returns + * a negative result using {@link GitFileDiff#createNegative(AbbreviatedObjectId, + * AbbreviatedObjectId, String)}. + * <li>If {@code useTimeouts} is false, the computation is performed synchronously without + * timeout enforcement. + */ + private GitFileDiff createGitFileDiff( + DiffEntry diffEntry, GitFileDiffCacheKey key, CloseablePool<DiffFormatter> diffPool) + throws IOException { + if (!key.useTimeout()) { + try (CloseablePool<DiffFormatter>.Handle formatter = diffPool.get()) { + FileHeader fileHeader = formatter.get().toFileHeader(diffEntry); + return GitFileDiff.create(diffEntry, fileHeader); + } + } + // This submits the DiffFormatter to a different thread. The CloseablePool and our usage of it + // ensures that any DiffFormatter instance and the ObjectReader it references internally is + // only used by a single thread concurrently. However, ObjectReaders have a reference to + // Repository which might not be thread safe (FileRepository is, DfsRepository might not). + // This could lead to a race condition. + Future<GitFileDiff> fileDiffFuture = + diffExecutor.submit( + () -> { + try (CloseablePool<DiffFormatter>.Handle formatter = diffPool.get()) { + return GitFileDiff.create(diffEntry, formatter.get().toFileHeader(diffEntry)); + } + }); + try { + // We employ the timeout because of a bug in Myers diff in JGit. See + // bugs.chromium.org/p/gerrit/issues/detail?id=487 for more details. The bug may happen + // if the algorithm used in diffs is HISTOGRAM_WITH_FALLBACK_MYERS. + return fileDiffFuture.get(timeoutMillis, TimeUnit.MILLISECONDS); + } catch (InterruptedException | TimeoutException e) { + // If timeout happens, create a negative result + metrics.timeouts.increment(); + return GitFileDiff.createNegative( + AbbreviatedObjectId.fromObjectId(key.oldTree()), + AbbreviatedObjectId.fromObjectId(key.newTree()), + key.newFilePath()); + } catch (ExecutionException e) { + // If there was an error computing the result, carry it + // up to the caller so the cache knows this key is invalid. + Throwables.throwIfInstanceOf(e.getCause(), IOException.class); + throw new IOException(e.getMessage(), e.getCause()); + } + } + } + + /** + * Create a single {@link GitFileDiff} with {@link com.google.gerrit.entities.Patch.ChangeType} + * equals {@link com.google.gerrit.entities.Patch.ChangeType#REWRITE}, assuming the input list + * contains two entries. + * + * @param gitDiffs input list of exactly two {@link GitFileDiff} for same file path. + * @return a single {@link GitFileDiff} with change type equals {@link + * com.google.gerrit.entities.Patch.ChangeType#REWRITE}. + * @throws DiffNotAvailableException if input list contains git diffs with change types other than + * {ADDED, DELETED}. This is a JGit error. + */ + private static GitFileDiff createRewriteEntry(List<GitFileDiff> gitDiffs) + throws DiffNotAvailableException { + if (gitDiffs.size() != 2) { + throw new DiffNotAvailableException( + String.format( + "JGit error: found %d dff entries for same file path %s", + gitDiffs.size(), gitDiffs.get(0).getDefaultPath())); + } + // Convert the first entry (prioritized according to change type enum order) to REWRITE + gitDiffs.sort(Comparator.comparingInt(o -> o.changeType().ordinal())); + return gitDiffs.get(0).toBuilder().changeType(Patch.ChangeType.REWRITE).build(); } /** An entity representing the options affecting the diff computation. */
diff --git a/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiffCacheKey.java b/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiffCacheKey.java index f104388..2d80614 100644 --- a/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiffCacheKey.java +++ b/java/com/google/gerrit/server/patch/gitfilediff/GitFileDiffCacheKey.java
@@ -34,7 +34,11 @@ /** A specific git project / repository. */ public abstract Project.NameKey project(); - /** The old 20 bytes SHA-1 git tree ID used in the git tree diff */ + /** + * The old 20 bytes SHA-1 git tree ID used in the git tree diff. If equals to {@link + * ObjectId#zeroId()}, a null tree is used for the diff scan, and {@link #newTree()} ()} is + * treated as an added tree. + */ public abstract ObjectId oldTree(); /** The new 20 bytes SHA-1 git tree ID used in the git tree diff */ @@ -53,13 +57,17 @@ public abstract DiffPreferencesInfo.Whitespace whitespace(); + /** Employ a timeout on the git computation while formatting the file header. */ + public abstract boolean useTimeout(); + public int weight() { return stringSize(project().get()) + 20 * 2 // oldTree and newTree + stringSize(newFilePath()) + 4 // renameScore + 4 // diffAlgorithm - + 4; // whitespace + + 4 // whitespace + + 1; // useTimeout } public static Builder builder() { @@ -88,6 +96,8 @@ public abstract Builder whitespace(Whitespace value); + public abstract Builder useTimeout(boolean value); + public abstract GitFileDiffCacheKey build(); } @@ -106,6 +116,7 @@ .setRenameScore(key.renameScore()) .setDiffAlgorithm(key.diffAlgorithm().name()) .setWhitepsace(key.whitespace().name()) + .setUseTimeout(key.useTimeout()) .build()); } @@ -121,6 +132,7 @@ .renameScore(proto.getRenameScore()) .diffAlgorithm(DiffAlgorithm.valueOf(proto.getDiffAlgorithm())) .whitespace(Whitespace.valueOf(proto.getWhitepsace())) + .useTimeout(proto.getUseTimeout()) .build(); } }
diff --git a/java/com/google/gerrit/server/permissions/ChangeControl.java b/java/com/google/gerrit/server/permissions/ChangeControl.java index 37c773a..b5f5283 100644 --- a/java/com/google/gerrit/server/permissions/ChangeControl.java +++ b/java/com/google/gerrit/server/permissions/ChangeControl.java
@@ -62,7 +62,7 @@ /** Can this user see this change? */ boolean isVisible() { - if (getChange().isPrivate() && !isPrivateVisible(changeData)) { + if (changeData.isPrivateOrThrow() && !isPrivateVisible(changeData)) { return false; } // Does the user have READ permission on the destination? @@ -150,7 +150,7 @@ Permission.EDIT_TOPIC_NAME) // user can edit topic on a specific ref || getProjectControl().isAdmin(); } - return refControl.canForceEditTopicName(); + return refControl.canForceEditTopicName(isOwner()); } /** Can this user toggle WorkInProgress state? */
diff --git a/java/com/google/gerrit/server/permissions/DefaultPermissionBackend.java b/java/com/google/gerrit/server/permissions/DefaultPermissionBackend.java index 66299a8..bf4d05a 100644 --- a/java/com/google/gerrit/server/permissions/DefaultPermissionBackend.java +++ b/java/com/google/gerrit/server/permissions/DefaultPermissionBackend.java
@@ -35,8 +35,8 @@ import com.google.gerrit.server.PeerDaemonUser; import com.google.gerrit.server.account.CapabilityCollection; import com.google.gerrit.server.cache.PerThreadCache; +import com.google.gerrit.server.cache.PerThreadProjectCache; import com.google.gerrit.server.project.ProjectCache; -import com.google.gerrit.server.project.ProjectState; import com.google.inject.Inject; import com.google.inject.Provider; import com.google.inject.Singleton; @@ -124,11 +124,12 @@ @Override public ForProject project(Project.NameKey project) { try { - ProjectState state = projectCache.get(project).orElseThrow(illegalState(project)); ProjectControl control = - PerThreadCache.getOrCompute( - PerThreadCache.Key.create(ProjectControl.class, project, user.getCacheKey()), - () -> projectControlFactory.create(user, state)); + PerThreadProjectCache.getOrCompute( + PerThreadCache.Key.create(Project.NameKey.class, project, user.getCacheKey()), + () -> + projectControlFactory.create( + user, projectCache.get(project).orElseThrow(illegalState(project)))); return control.asForProject(); } catch (Exception e) { Throwable cause = e.getCause() != null ? e.getCause() : e;
diff --git a/java/com/google/gerrit/server/permissions/DefaultPermissionMappings.java b/java/com/google/gerrit/server/permissions/DefaultPermissionMappings.java index dcaf485..9d69d9b 100644 --- a/java/com/google/gerrit/server/permissions/DefaultPermissionMappings.java +++ b/java/com/google/gerrit/server/permissions/DefaultPermissionMappings.java
@@ -55,12 +55,12 @@ .put(GlobalPermission.RUN_AS, GlobalCapability.RUN_AS) .put(GlobalPermission.RUN_GC, GlobalCapability.RUN_GC) .put(GlobalPermission.STREAM_EVENTS, GlobalCapability.STREAM_EVENTS) + .put(GlobalPermission.VIEW_ACCESS, GlobalCapability.VIEW_ACCESS) .put(GlobalPermission.VIEW_ALL_ACCOUNTS, GlobalCapability.VIEW_ALL_ACCOUNTS) .put(GlobalPermission.VIEW_CACHES, GlobalCapability.VIEW_CACHES) .put(GlobalPermission.VIEW_CONNECTIONS, GlobalCapability.VIEW_CONNECTIONS) .put(GlobalPermission.VIEW_PLUGINS, GlobalCapability.VIEW_PLUGINS) .put(GlobalPermission.VIEW_QUEUE, GlobalCapability.VIEW_QUEUE) - .put(GlobalPermission.VIEW_ACCESS, GlobalCapability.VIEW_ACCESS) .build(); static {
diff --git a/java/com/google/gerrit/server/permissions/DefaultRefFilter.java b/java/com/google/gerrit/server/permissions/DefaultRefFilter.java index 1b528d7..e8a9996 100644 --- a/java/com/google/gerrit/server/permissions/DefaultRefFilter.java +++ b/java/com/google/gerrit/server/permissions/DefaultRefFilter.java
@@ -42,6 +42,7 @@ import com.google.gerrit.server.permissions.PermissionBackend.RefFilterOptions; import com.google.gerrit.server.project.ProjectState; import com.google.inject.Inject; +import com.google.inject.Singleton; import com.google.inject.assistedinject.Assisted; import java.io.IOException; import java.util.ArrayList; @@ -60,6 +61,27 @@ DefaultRefFilter create(ProjectControl projectControl); } + @Singleton + private static class Metrics { + final Counter0 fullFilterCount; + final Counter0 skipFilterCount; + + @Inject + Metrics(MetricMaker metricMaker) { + fullFilterCount = + metricMaker.newCounter( + "permissions/ref_filter/full_filter_count", + new Description("Rate of full ref filter operations").setRate()); + skipFilterCount = + metricMaker.newCounter( + "permissions/ref_filter/skip_filter_count", + new Description( + "Rate of ref filter operations where we skip full evaluation" + + " because the user can read all refs") + .setRate()); + } + } + private final TagCache tagCache; private final ChangeNotes.Factory changeNotesFactory; private final PermissionBackend permissionBackend; @@ -68,8 +90,7 @@ private final CurrentUser user; private final ProjectState projectState; private final PermissionBackend.ForProject permissionBackendForProject; - private final Counter0 fullFilterCount; - private final Counter0 skipFilterCount; + private final Metrics metrics; private final boolean skipFullRefEvaluationIfAllRefsAreVisible; private final VisibleChangesCache.Factory visibleChangesCacheFactory; @@ -82,7 +103,7 @@ PermissionBackend permissionBackend, RefVisibilityControl refVisibilityControl, @GerritServerConfig Config config, - MetricMaker metricMaker, + Metrics metrics, VisibleChangesCache.Factory visibleChangesCacheFactory, @Assisted ProjectControl projectControl) { this.tagCache = tagCache; @@ -98,17 +119,7 @@ this.projectState = projectControl.getProjectState(); this.permissionBackendForProject = permissionBackend.user(user).project(projectState.getNameKey()); - this.fullFilterCount = - metricMaker.newCounter( - "permissions/ref_filter/full_filter_count", - new Description("Rate of full ref filter operations").setRate()); - this.skipFilterCount = - metricMaker.newCounter( - "permissions/ref_filter/skip_filter_count", - new Description( - "Rate of ref filter operations where we skip full evaluation" - + " because the user can read all refs") - .setRate()); + this.metrics = metrics; } /** Filters given refs and tags by visibility. */ @@ -195,12 +206,12 @@ logger.atFinest().log("User has READ on refs/* = %s", hasReadOnRefsStar); if (skipFullRefEvaluationIfAllRefsAreVisible && !projectState.isAllUsers()) { if (projectState.statePermitsRead() && hasReadOnRefsStar) { - skipFilterCount.increment(); + metrics.skipFilterCount.increment(); logger.atFinest().log( "Fast path, all refs are visible because user has READ on refs/*: %s", refs); return new AutoValue_DefaultRefFilter_Result(refs, ImmutableList.of()); } else if (projectControl.allRefsAreVisible(ImmutableSet.of(RefNames.REFS_CONFIG))) { - skipFilterCount.increment(); + metrics.skipFilterCount.increment(); refs = fastHideRefsMetaConfig(refs); logger.atFinest().log( "Fast path, all refs except %s are visible: %s", RefNames.REFS_CONFIG, refs); @@ -208,7 +219,7 @@ } } logger.atFinest().log("Doing full ref filtering"); - fullFilterCount.increment(); + metrics.fullFilterCount.increment(); boolean hasAccessDatabase = permissionBackend
diff --git a/java/com/google/gerrit/server/permissions/GlobalPermission.java b/java/com/google/gerrit/server/permissions/GlobalPermission.java index d4f22e6..c0b44e5 100644 --- a/java/com/google/gerrit/server/permissions/GlobalPermission.java +++ b/java/com/google/gerrit/server/permissions/GlobalPermission.java
@@ -53,12 +53,12 @@ RUN_AS, RUN_GC, STREAM_EVENTS, + VIEW_ACCESS, VIEW_ALL_ACCOUNTS, VIEW_CACHES, VIEW_CONNECTIONS, VIEW_PLUGINS, - VIEW_QUEUE, - VIEW_ACCESS; + VIEW_QUEUE; private static final FluentLogger logger = FluentLogger.forEnclosingClass();
diff --git a/java/com/google/gerrit/server/permissions/LabelPermission.java b/java/com/google/gerrit/server/permissions/LabelPermission.java index 268570c..c266caa 100644 --- a/java/com/google/gerrit/server/permissions/LabelPermission.java +++ b/java/com/google/gerrit/server/permissions/LabelPermission.java
@@ -71,12 +71,12 @@ this.name = LabelType.checkName(name); } - /** @return {@code SELF} or {@code ON_BEHALF_OF} (or labelAs). */ + /** Returns {@code SELF} or {@code ON_BEHALF_OF} (or labelAs). */ public ForUser forUser() { return forUser; } - /** @return name of the label, e.g. {@code "Code-Review"}. */ + /** Returns name of the label, e.g. {@code "Code-Review"}. */ public String label() { return name; } @@ -199,17 +199,17 @@ this.label = requireNonNull(label, "LabelVote"); } - /** @return {@code SELF} or {@code ON_BEHALF_OF} (or labelAs). */ + /** Returns {@code SELF} or {@code ON_BEHALF_OF} (or labelAs). */ public ForUser forUser() { return forUser; } - /** @return name of the label, e.g. {@code "Code-Review"}. */ + /** Returns name of the label, e.g. {@code "Code-Review"}. */ public String label() { return label.label(); } - /** @return specific value of the label, e.g. 1 or 2. */ + /** Returns specific value of the label, e.g. 1 or 2. */ public short value() { return label.value(); }
diff --git a/java/com/google/gerrit/server/permissions/PermissionBackend.java b/java/com/google/gerrit/server/permissions/PermissionBackend.java index 27c6793..d40b138 100644 --- a/java/com/google/gerrit/server/permissions/PermissionBackend.java +++ b/java/com/google/gerrit/server/permissions/PermissionBackend.java
@@ -269,7 +269,7 @@ /** Returns an instance scoped for the change, and its destination ref and project. */ public ForChange change(ChangeData cd) { try { - return ref(cd.change().getDest().branch()).change(cd); + return ref(cd.branchOrThrow().branch()).change(cd); } catch (StorageException e) { return FailedPermissionBackend.change("unavailable", e); }
diff --git a/java/com/google/gerrit/server/permissions/PermissionCollection.java b/java/com/google/gerrit/server/permissions/PermissionCollection.java index ddba52b..4b8db1c 100644 --- a/java/com/google/gerrit/server/permissions/PermissionCollection.java +++ b/java/com/google/gerrit/server/permissions/PermissionCollection.java
@@ -277,8 +277,8 @@ } /** - * @return true if a "${username}" pattern might need to be expanded to build this collection, - * making the results user specific. + * Returns true if a "${username}" pattern might need to be expanded to build this collection, + * making the results user specific. */ public boolean isUserSpecific() { return perUser;
diff --git a/java/com/google/gerrit/server/permissions/ProjectControl.java b/java/com/google/gerrit/server/permissions/ProjectControl.java index a92fde0..8100457 100644 --- a/java/com/google/gerrit/server/permissions/ProjectControl.java +++ b/java/com/google/gerrit/server/permissions/ProjectControl.java
@@ -114,7 +114,7 @@ } ChangeControl controlFor(ChangeData cd) { - return new ChangeControl(controlForRef(cd.change().getDest()), cd); + return new ChangeControl(controlForRef(cd.branchOrThrow()), cd); } RefControl controlForRef(BranchNameKey ref) { @@ -154,8 +154,8 @@ } /** - * @return {@code Capable.OK} if the user can upload to at least one reference. Does not check - * Contributor Agreements. + * Returns {@code Capable.OK} if the user can upload to at least one reference. Does not check + * Contributor Agreements. */ boolean canPushToAtLeastOneRef() { return canPerformOnAnyRef(Permission.PUSH) @@ -366,7 +366,7 @@ @Override public ForChange change(ChangeData cd) { try { - checkProject(cd.change()); + checkProject(cd); return super.change(cd); } catch (StorageException e) { return FailedPermissionBackend.change("unavailable", e); @@ -379,13 +379,21 @@ return super.change(notes); } + private void checkProject(ChangeData cd) { + checkProject(cd.project()); + } + private void checkProject(Change change) { + checkProject(change.getProject()); + } + + private void checkProject(Project.NameKey changeProject) { Project.NameKey project = getProject().getNameKey(); checkArgument( - project.equals(change.getProject()), + project.equals(changeProject), "expected change in project %s, not %s", project, - change.getProject()); + changeProject); } @Override
diff --git a/java/com/google/gerrit/server/permissions/RefControl.java b/java/com/google/gerrit/server/permissions/RefControl.java index dd00dca..484fa39 100644 --- a/java/com/google/gerrit/server/permissions/RefControl.java +++ b/java/com/google/gerrit/server/permissions/RefControl.java
@@ -135,19 +135,19 @@ return hasReadPermissionOnRef; } - /** @return true if this user can add a new patch set to this ref */ + /** Returns true if this user can add a new patch set to this ref */ boolean canAddPatchSet() { return projectControl .controlForRef(MagicBranch.NEW_CHANGE + refName) .canPerform(Permission.ADD_PATCH_SET); } - /** @return true if this user can rebase changes on this ref */ + /** Returns true if this user can rebase changes on this ref */ boolean canRebase() { return canPerform(Permission.REBASE); } - /** @return true if this user can submit patch sets to this ref */ + /** Returns true if this user can submit patch sets to this ref */ boolean canSubmit(boolean isChangeOwner) { if (RefNames.REFS_CONFIG.equals(refName)) { // Always allow project owners to submit configuration changes. @@ -160,12 +160,12 @@ return canPerform(Permission.SUBMIT, isChangeOwner, false); } - /** @return true if this user can force edit topic names. */ - boolean canForceEditTopicName() { - return canPerform(Permission.EDIT_TOPIC_NAME, false, true); + /** Returns true if this user can force edit topic names. */ + boolean canForceEditTopicName(boolean isChangeOwner) { + return canPerform(Permission.EDIT_TOPIC_NAME, isChangeOwner, true); } - /** @return true if this user can delete changes. */ + /** Returns true if this user can delete changes. */ boolean canDeleteChanges(boolean isChangeOwner) { return canPerform(Permission.DELETE_CHANGES) || (isChangeOwner && canPerform(Permission.DELETE_OWN_CHANGES, isChangeOwner, false)); @@ -201,12 +201,12 @@ return canPerform(Permission.REVERT); } - /** @return true if this user can submit merge patch sets to this ref */ + /** Returns true if this user can submit merge patch sets to this ref */ private boolean canUploadMerges() { return projectControl.controlForRef("refs/for/" + refName).canPerform(Permission.PUSH_MERGE); } - /** @return true if the user can update the reference as a fast-forward. */ + /** Returns true if the user can update the reference as a fast-forward. */ private boolean canUpdate() { if (RefNames.REFS_CONFIG.equals(refName) && !projectControl.isOwner()) { // Pushing requires being at least project owner, in addition to push. @@ -225,7 +225,7 @@ return canPerform(Permission.PUSH); } - /** @return true if the user can rewind (force push) the reference. */ + /** Returns true if the user can rewind (force push) the reference. */ private boolean canForceUpdate() { if (canPushWithForce()) { return true; @@ -281,7 +281,7 @@ } } - /** @return true if this user can forge the author line in a commit. */ + /** Returns true if this user can forge the author line in a commit. */ private boolean canForgeAuthor() { if (canForgeAuthor == null) { canForgeAuthor = canPerform(Permission.FORGE_AUTHOR); @@ -289,7 +289,7 @@ return canForgeAuthor; } - /** @return true if this user can forge the committer line in a commit. */ + /** Returns true if this user can forge the committer line in a commit. */ private boolean canForgeCommitter() { if (canForgeCommitter == null) { canForgeCommitter = canPerform(Permission.FORGE_COMMITTER); @@ -297,7 +297,7 @@ return canForgeCommitter; } - /** @return true if this user can forge the server on the committer line. */ + /** Returns true if this user can forge the server on the committer line. */ private boolean canForgeGerritServerIdentity() { return canPerform(Permission.FORGE_SERVER); } @@ -364,7 +364,9 @@ } return new PermissionRange( - permissionName, Math.max(voteMin, blockAllowMin), Math.min(voteMax, blockAllowMax)); + permissionName, + /* min= */ Math.max(voteMin, blockAllowMin), + /* max= */ Math.min(voteMax, blockAllowMax)); } private boolean isBlocked(String permissionName, boolean isChangeOwner, boolean withForce) { @@ -523,7 +525,10 @@ + "who also have 'Push' rights on " + RefNames.REFS_CONFIG); } else { - pde.setAdvice("To push into this reference you need 'Push' rights."); + pde.setAdvice( + "Push to refs/for/" + + RefNames.shortName(refName) + + " to create a review, or get 'Push' rights to update the branch."); } break; case DELETE: @@ -557,7 +562,8 @@ break; case FORGE_COMMITTER: pde.setAdvice( - "You need 'Forge Committer' rights to push commits with another user as committer."); + "You need 'Forge Committer' rights to push commits with another user as" + + " committer."); break; case FORGE_SERVER: pde.setAdvice(
diff --git a/java/com/google/gerrit/server/permissions/SectionSortCache.java b/java/com/google/gerrit/server/permissions/SectionSortCache.java index d800782..e64f8b6 100644 --- a/java/com/google/gerrit/server/permissions/SectionSortCache.java +++ b/java/com/google/gerrit/server/permissions/SectionSortCache.java
@@ -17,6 +17,7 @@ import static com.google.common.collect.ImmutableList.toImmutableList; import com.google.auto.value.AutoValue; +import com.google.auto.value.extension.memoized.Memoized; import com.google.common.cache.Cache; import com.google.common.collect.ImmutableList; import com.google.common.flogger.FluentLogger; @@ -126,22 +127,22 @@ public abstract List<String> patterns(); - public abstract int cachedHashCode(); - static EntryKey create(String refName, List<AccessSection> sections) { - int hc = refName.hashCode(); List<String> patterns = new ArrayList<>(sections.size()); for (AccessSection s : sections) { - String n = s.getName(); - patterns.add(n); - hc = hc * 31 + n.hashCode(); + patterns.add(s.getName()); } - return new AutoValue_SectionSortCache_EntryKey(refName, ImmutableList.copyOf(patterns), hc); + return new AutoValue_SectionSortCache_EntryKey(refName, ImmutableList.copyOf(patterns)); } + @Memoized @Override - public final int hashCode() { - return cachedHashCode(); + public int hashCode() { + int hc = ref().hashCode(); + for (String n : patterns()) { + hc = hc * 31 + n.hashCode(); + } + return hc; } }
diff --git a/java/com/google/gerrit/server/permissions/VisibleChangesCache.java b/java/com/google/gerrit/server/permissions/VisibleChangesCache.java index 2e47576..6bb3204 100644 --- a/java/com/google/gerrit/server/permissions/VisibleChangesCache.java +++ b/java/com/google/gerrit/server/permissions/VisibleChangesCache.java
@@ -14,19 +14,12 @@ package com.google.gerrit.server.permissions; -import static com.google.common.collect.ImmutableList.toImmutableList; - -import com.google.common.collect.ImmutableList; import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.BranchNameKey; import com.google.gerrit.entities.Change; import com.google.gerrit.entities.Project; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.extensions.restapi.AuthException; -import com.google.gerrit.server.git.SearchingChangeCacheImpl; -import com.google.gerrit.server.notedb.ChangeNotes; -import com.google.gerrit.server.notedb.ChangeNotes.Factory.ChangeNotesResult; +import com.google.gerrit.server.git.ChangesByProjectCache; import com.google.gerrit.server.project.ProjectState; import com.google.gerrit.server.query.change.ChangeData; import com.google.inject.Inject; @@ -36,10 +29,7 @@ import java.util.Map; import org.eclipse.jgit.lib.Repository; -/** - * Gets all of the visible by current user changes in the repository that are available in the - * change index and cache. - */ +/** Gets all the changes in a repository visible by the current user. */ class VisibleChangesCache { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); @@ -47,26 +37,23 @@ VisibleChangesCache create(ProjectControl projectControl, Repository repository); } - @Nullable private final SearchingChangeCacheImpl changeCache; private final ProjectState projectState; - private final ChangeNotes.Factory changeNotesFactory; private final PermissionBackend.ForProject permissionBackendForProject; + private final ChangesByProjectCache changesByProjectCache; private final Repository repository; private Map<Change.Id, BranchNameKey> visibleChanges; @Inject VisibleChangesCache( - @Nullable SearchingChangeCacheImpl changeCache, PermissionBackend permissionBackend, - ChangeNotes.Factory changeNotesFactory, + ChangesByProjectCache changesByProjectCache, @Assisted ProjectControl projectControl, @Assisted Repository repository) { - this.changeCache = changeCache; this.projectState = projectControl.getProjectState(); this.permissionBackendForProject = permissionBackend.user(projectControl.getUser()).project(projectState.getNameKey()); - this.changeNotesFactory = changeNotesFactory; + this.changesByProjectCache = changesByProjectCache; this.repository = repository; } @@ -75,21 +62,16 @@ * by looking at the cached visible changes. */ public boolean isVisible(Change.Id changeId) throws PermissionBackendException { - cachedVisibleChanges(); - return visibleChanges.containsKey(changeId); + return cachedVisibleChanges().containsKey(changeId); } /** * Returns the visible changes in the repository {@code repo}. If not cached, computes the visible * changes and caches them. */ - public Map<Change.Id, BranchNameKey> cachedVisibleChanges() throws PermissionBackendException { + public Map<Change.Id, BranchNameKey> cachedVisibleChanges() { if (visibleChanges == null) { - if (changeCache == null) { - visibleChangesByScan(); - } else { - visibleChangesBySearch(); - } + loadVisibleChanges(); logger.atFinest().log("Visible changes: %s", visibleChanges.keySet()); } return visibleChanges; @@ -105,65 +87,21 @@ return cachedVisibleChanges().get(changeId); } - private void visibleChangesBySearch() throws PermissionBackendException { + private void loadVisibleChanges() { visibleChanges = new HashMap<>(); + if (!projectState.statePermitsRead()) { + return; + } Project.NameKey project = projectState.getNameKey(); try { - for (ChangeData cd : changeCache.getChangeData(project)) { - if (!projectState.statePermitsRead()) { - continue; - } - try { - permissionBackendForProject.change(cd).check(ChangePermission.READ); - visibleChanges.put(cd.getId(), cd.change().getDest()); - } catch (AuthException e) { - // Do nothing. + for (ChangeData cd : changesByProjectCache.getChangeDatas(project, repository)) { + if (permissionBackendForProject.change(cd).testOrFalse(ChangePermission.READ)) { + visibleChanges.put(cd.getId(), cd.branchOrThrow()); } } - } catch (StorageException e) { + } catch (IOException e) { logger.atSevere().withCause(e).log( "Cannot load changes for project %s, assuming no changes are visible", project); } } - - private void visibleChangesByScan() throws PermissionBackendException { - visibleChanges = new HashMap<>(); - Project.NameKey p = projectState.getNameKey(); - ImmutableList<ChangeNotesResult> changes; - try { - changes = changeNotesFactory.scan(repository, p).collect(toImmutableList()); - } catch (IOException e) { - logger.atSevere().withCause(e).log( - "Cannot load changes for project %s, assuming no changes are visible", p); - return; - } - - for (ChangeNotesResult notesResult : changes) { - ChangeNotes notes = toNotes(notesResult); - if (notes != null) { - visibleChanges.put(notes.getChangeId(), notes.getChange().getDest()); - } - } - } - - @Nullable - private ChangeNotes toNotes(ChangeNotesResult r) throws PermissionBackendException { - if (r.error().isPresent()) { - logger.atWarning().withCause(r.error().get()).log( - "Failed to load change %s in %s", r.id(), projectState.getName()); - return null; - } - - if (!projectState.statePermitsRead()) { - return null; - } - - try { - permissionBackendForProject.change(r.notes()).check(ChangePermission.READ); - return r.notes(); - } catch (AuthException e) { - // Skip. - } - return null; - } }
diff --git a/java/com/google/gerrit/server/plugincontext/PluginContext.java b/java/com/google/gerrit/server/plugincontext/PluginContext.java index 90d56c8..a5fad56 100644 --- a/java/com/google/gerrit/server/plugincontext/PluginContext.java +++ b/java/com/google/gerrit/server/plugincontext/PluginContext.java
@@ -30,6 +30,7 @@ import com.google.gerrit.metrics.Field; import com.google.gerrit.metrics.MetricMaker; import com.google.gerrit.metrics.Timer3; +import com.google.gerrit.server.cancellation.RequestCancelledException; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.TraceContext; import com.google.inject.Inject; @@ -53,7 +54,7 @@ * <p>A plugin context can be manually opened by invoking the newTrace methods. This should only be * needed if an extension throws multiple exceptions that need to be handled: * - * <pre> + * <pre>{@code * public interface Foo { * void doFoo() throws Exception1, Exception2, Exception3; * } @@ -65,7 +66,7 @@ * fooExtension.get().doFoo(); * } * } - * </pre> + * }</pre> * * <p>This class hosts static methods with generic functionality to invoke plugin extensions with a * trace context that are commonly used by {@link PluginItemContext}, {@link PluginSetContext} and @@ -120,11 +121,17 @@ @Inject PluginMetrics(MetricMaker metricMaker) { Field<String> pluginNameField = - Field.ofString("plugin_name", Metadata.Builder::pluginName).build(); + Field.ofString("plugin_name", Metadata.Builder::pluginName) + .description("The name of the plugin.") + .build(); Field<String> classNameField = - Field.ofString("class_name", Metadata.Builder::className).build(); + Field.ofString("class_name", Metadata.Builder::className) + .description("The class of the plugin that was invoked.") + .build(); Field<String> exportValueField = - Field.ofString("export_value", Metadata.Builder::exportValue).build(); + Field.ofString("export_value", Metadata.Builder::exportValue) + .description("The export name under which the invoked class is registered.") + .build(); this.latency = metricMaker.newTimer( @@ -185,7 +192,8 @@ } /** - * Runs a plugin extension. All exceptions from the plugin extension are caught and logged. + * Runs a plugin extension. All exceptions from the plugin extension are caught and logged (except + * {@link RequestCancelledException}. * * <p>The consumer gets the extension implementation provided that should be invoked. * @@ -204,7 +212,8 @@ try (TraceContext traceContext = newTrace(extension); Timer3.Context<String, String, String> ctx = pluginMetrics.startLatency(extension)) { extensionImplConsumer.run(extensionImpl); - } catch (Throwable e) { + } catch (Exception e) { + Throwables.throwIfInstanceOf(e, RequestCancelledException.class); pluginMetrics.incrementErrorCount(extension); logger.atWarning().withCause(e).log( "Failure in %s of plugin %s", extensionImpl.getClass(), extension.getPluginName()); @@ -212,7 +221,8 @@ } /** - * Runs a plugin extension. All exceptions from the plugin extension are caught and logged. + * Runs a plugin extension. All exceptions from the plugin extension are caught and logged (except + * {@link RequestCancelledException}. * * <p>The consumer get the {@link Extension} provided that should be invoked. The extension * provides access to the plugin name and the export name. @@ -233,7 +243,8 @@ try (TraceContext traceContext = newTrace(extension); Timer3.Context<String, String, String> ctx = pluginMetrics.startLatency(extension)) { extensionConsumer.run(extension); - } catch (Throwable e) { + } catch (Exception e) { + Throwables.throwIfInstanceOf(e, RequestCancelledException.class); pluginMetrics.incrementErrorCount(extension); logger.atWarning().withCause(e).log( "Failure in %s of plugin %s", extensionImpl.getClass(), extension.getPluginName()); @@ -267,7 +278,7 @@ try (TraceContext traceContext = newTrace(extension); Timer3.Context<String, String, String> ctx = pluginMetrics.startLatency(extension)) { extensionImplConsumer.run(extensionImpl); - } catch (Throwable e) { + } catch (Exception e) { Throwables.throwIfInstanceOf(e, exceptionClass); Throwables.throwIfUnchecked(e); pluginMetrics.incrementErrorCount(extension); @@ -304,7 +315,7 @@ try (TraceContext traceContext = newTrace(extension); Timer3.Context<String, String, String> ctx = pluginMetrics.startLatency(extension)) { extensionConsumer.run(extension); - } catch (Throwable e) { + } catch (Exception e) { Throwables.throwIfInstanceOf(e, exceptionClass); Throwables.throwIfUnchecked(e); pluginMetrics.incrementErrorCount(extension);
diff --git a/java/com/google/gerrit/server/plugincontext/PluginItemContext.java b/java/com/google/gerrit/server/plugincontext/PluginItemContext.java index 421b3ad..e88a6fe 100644 --- a/java/com/google/gerrit/server/plugincontext/PluginItemContext.java +++ b/java/com/google/gerrit/server/plugincontext/PluginItemContext.java
@@ -40,46 +40,46 @@ * * <p>Example if all exceptions should be caught and logged: * - * <pre> + * <pre>{@code * fooPluginItemContext.run(foo -> foo.doFoo()); - * </pre> + * }</pre> * * <p>Example if all exceptions, but one, should be caught and logged: * - * <pre> + * <pre>{@code * try { * fooPluginItemContext.run(foo -> foo.doFoo(), MyException.class); * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if return values should be handled: * - * <pre> + * <pre>{@code * Object result = fooPluginItemContext.call(foo -> foo.getFoo()); - * </pre> + * }</pre> * * <p>Example if return values and a single exception should be handled: * - * <pre> + * <pre>{@code * Object result; * try { * result = fooPluginItemContext.call(foo -> foo.getFoo(), MyException.class); * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if several exceptions should be handled: * - * <pre> + * <pre>{@code * try (TraceContext traceContext = PluginContext.newTrace(fooDynamicItem.getEntry())) { * fooDynamicItem.get().doFoo(); * } catch (MyException1 | MyException2 | MyException3 e) { * // handle the exception * } - * </pre> + * }</pre> */ public class PluginItemContext<T> { @Nullable private final DynamicItem<T> dynamicItem;
diff --git a/java/com/google/gerrit/server/plugincontext/PluginMapContext.java b/java/com/google/gerrit/server/plugincontext/PluginMapContext.java index b02ad27..fb50cd5 100644 --- a/java/com/google/gerrit/server/plugincontext/PluginMapContext.java +++ b/java/com/google/gerrit/server/plugincontext/PluginMapContext.java
@@ -33,15 +33,15 @@ * * <p>Example if all exceptions should be caught and logged: * - * <pre> + * <pre>{@code * Map<String, Object> results = new HashMap<>(); * fooPluginMapContext.runEach( * extension -> results.put(extension.getExportName(), extension.get().getFoo()); - * </pre> + * }</pre> * * <p>Example if all exceptions, but one, should be caught and logged: * - * <pre> + * <pre>{@code * Map<String, Object> results = new HashMap<>(); * try { * fooPluginMapContext.runEach( @@ -50,22 +50,22 @@ * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if return values should be handled: * - * <pre> + * <pre>{@code * Map<String, Object> results = new HashMap<>(); * for (PluginMapEntryContext<Foo> c : fooPluginMapContext) { * if (c.call(extension -> extension.get().handles(x))) { * c.run(extension -> results.put(extension.getExportName(), extension.get().getFoo()); * } * } - * </pre> + * }</pre> * * <p>Example if return values and a single exception should be handled: * - * <pre> + * <pre>{@code * Map<String, Object> results = new HashMap<>(); * try { * for (PluginMapEntryContext<Foo> c : fooPluginMapContext) { @@ -77,11 +77,11 @@ * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if several exceptions should be handled: * - * <pre> + * <pre>{@code * for (Extension<Foo> fooExtension : fooDynamicMap) { * try (TraceContext traceContext = PluginContext.newTrace(fooExtension)) { * fooExtension.get().doFoo(); @@ -89,7 +89,7 @@ * // handle the exception * } * } - * </pre> + * }</pre> */ public class PluginMapContext<T> implements Iterable<PluginMapEntryContext<T>> { private final DynamicMap<T> dynamicMap;
diff --git a/java/com/google/gerrit/server/plugincontext/PluginMapEntryContext.java b/java/com/google/gerrit/server/plugincontext/PluginMapEntryContext.java index 68589cf..27181cb 100644 --- a/java/com/google/gerrit/server/plugincontext/PluginMapEntryContext.java +++ b/java/com/google/gerrit/server/plugincontext/PluginMapEntryContext.java
@@ -35,15 +35,15 @@ * * <p>The call* methods execute the extension and deliver a result back to the caller. * - * <pre> + * <pre>{@code * Map<String, Object> results = new HashMap<>(); * fooPluginMapEntryContext.run( * extension -> results.put(extension.getExportName(), extension.get().getFoo()); - * </pre> + * }</pre> * * <p>Example if all exceptions, but one, should be caught and logged: * - * <pre> + * <pre>{@code * Map<String, Object> results = new HashMap<>(); * try { * fooPluginMapEntryContext.run( @@ -52,28 +52,28 @@ * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if return values should be handled: * - * <pre> + * <pre>{@code * Object result = fooPluginMapEntryContext.call(extension -> extension.get().getFoo()); - * </pre> + * }</pre> * * <p>Example if return values and a single exception should be handled: * - * <pre> + * <pre>{@code * Object result; * try { * result = fooPluginMapEntryContext.call(extension -> extension.get().getFoo(), MyException.class); * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if several exceptions should be handled: * - * <pre> + * <pre>{@code * for (Extension<Foo> fooExtension : fooDynamicMap) { * try (TraceContext traceContext = PluginContext.newTrace(fooExtension)) { * fooExtension.get().doFoo(); @@ -81,7 +81,7 @@ * // handle the exception * } * } - * </pre> + * }</pre> */ public class PluginMapEntryContext<T> { private final Extension<T> extension;
diff --git a/java/com/google/gerrit/server/plugincontext/PluginSetContext.java b/java/com/google/gerrit/server/plugincontext/PluginSetContext.java index b64cfeb..43c9552 100644 --- a/java/com/google/gerrit/server/plugincontext/PluginSetContext.java +++ b/java/com/google/gerrit/server/plugincontext/PluginSetContext.java
@@ -34,33 +34,33 @@ * * <p>Example if all exceptions should be caught and logged: * - * <pre> + * <pre>{@code * fooPluginSetContext.runEach(foo -> foo.doFoo()); - * </pre> + * }</pre> * * <p>Example if all exceptions, but one, should be caught and logged: * - * <pre> + * <pre>{@code * try { * fooPluginSetContext.runEach(foo -> foo.doFoo(), MyException.class); * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if return values should be handled: * - * <pre> + * <pre>{@code * for (PluginSetEntryContext<Foo> c : fooPluginSetContext) { * if (c.call(foo -> foo.handles(x))) { * c.run(foo -> foo.doFoo()); * } * } - * </pre> + * }</pre> * * <p>Example if return values and a single exception should be handled: * - * <pre> + * <pre>{@code * try { * for (PluginSetEntryContext<Foo> c : fooPluginSetContext) { * if (c.call(foo -> foo.handles(x), MyException.class)) { @@ -70,11 +70,11 @@ * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if several exceptions should be handled: * - * <pre> + * <pre>{@code * for (Extension<Foo> fooExtension : fooDynamicSet.entries()) { * try (TraceContext traceContext = PluginContext.newTrace(fooExtension)) { * fooExtension.get().doFoo(); @@ -82,7 +82,7 @@ * // handle the exception * } * } - * </pre> + * }</pre> */ public class PluginSetContext<T> implements Iterable<PluginSetEntryContext<T>> { private final DynamicSet<T> dynamicSet;
diff --git a/java/com/google/gerrit/server/plugincontext/PluginSetEntryContext.java b/java/com/google/gerrit/server/plugincontext/PluginSetEntryContext.java index 2268c07..be97b52 100644 --- a/java/com/google/gerrit/server/plugincontext/PluginSetEntryContext.java +++ b/java/com/google/gerrit/server/plugincontext/PluginSetEntryContext.java
@@ -37,40 +37,40 @@ * * <p>Example if all exceptions should be caught and logged: * - * <pre> + * <pre>{@code * fooPluginSetEntryContext.run(foo -> foo.doFoo()); - * </pre> + * }</pre> * * <p>Example if all exceptions, but one, should be caught and logged: * - * <pre> + * <pre>{@code * try { * fooPluginSetEntryContext.run(foo -> foo.doFoo(), MyException.class); * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if return values should be handled: * - * <pre> + * <pre>{@code * Object result = fooPluginSetEntryContext.call(foo -> foo.getFoo()); - * </pre> + * }</pre> * * <p>Example if return values and a single exception should be handled: * - * <pre> + * <pre>{@code * Object result; * try { * result = fooPluginSetEntryContext.call(foo -> foo.getFoo(), MyException.class); * } catch (MyException e) { * // handle the exception * } - * </pre> + * }</pre> * * <p>Example if several exceptions should be handled: * - * <pre> + * <pre>{@code * for (Extension<Foo> fooExtension : fooDynamicSet.entries()) { * try (TraceContext traceContext = PluginContext.newTrace(fooExtension)) { * fooExtension.get().doFoo(); @@ -78,7 +78,7 @@ * // handle the exception * } * } - * </pre> + * }</pre> */ public class PluginSetEntryContext<T> { private final Extension<T> extension;
diff --git a/java/com/google/gerrit/server/plugins/PluginLoader.java b/java/com/google/gerrit/server/plugins/PluginLoader.java index 0a06081..8d17d85 100644 --- a/java/com/google/gerrit/server/plugins/PluginLoader.java +++ b/java/com/google/gerrit/server/plugins/PluginLoader.java
@@ -253,7 +253,7 @@ FileSnapshot snapshot = FileSnapshot.save(off.toFile()); Plugin offPlugin = loadPlugin(name, off, snapshot); disabled.put(name, offPlugin); - } catch (Throwable e) { + } catch (Exception e) { // This shouldn't happen, as the plugin was loaded earlier. logger.atWarning().withCause(e.getCause()).log( "Cannot load disabled plugin %s", active.getName()); @@ -510,7 +510,7 @@ if (!newPlugin.isDisabled()) { try { newPlugin.start(env); - } catch (Throwable e) { + } catch (Exception e) { newPlugin.stop(env); throw e; } @@ -528,7 +528,7 @@ } broken.remove(name); return newPlugin; - } catch (Throwable err) { + } catch (Exception err) { broken.put(name, snapshot); throw new PluginInstallException(err); }
diff --git a/java/com/google/gerrit/server/project/CreateRefControl.java b/java/com/google/gerrit/server/project/CreateRefControl.java index 54ab628..ab134b5 100644 --- a/java/com/google/gerrit/server/project/CreateRefControl.java +++ b/java/com/google/gerrit/server/project/CreateRefControl.java
@@ -69,8 +69,9 @@ * * @param user the user performing the operation * @param repo repository on which user want to create - * @param branch the branch the new {@link RevObject} should be created on + * @param destBranch the branch the new {@link RevObject} should be created on * @param object the object the user will start the reference with + * @param sourceBranches the source ref from which the new ref is created from * @throws AuthException if creation is denied; the message explains the denial. * @throws PermissionBackendException on failure of permission checks. * @throws ResourceConflictException if the project state does not permit the operation @@ -78,25 +79,46 @@ public void checkCreateRef( Provider<? extends CurrentUser> user, Repository repo, - BranchNameKey branch, + BranchNameKey destBranch, RevObject object, - boolean forPush) + boolean forPush, + BranchNameKey... sourceBranches) throws AuthException, PermissionBackendException, NoSuchProjectException, IOException, ResourceConflictException { ProjectState ps = - projectCache.get(branch.project()).orElseThrow(noSuchProject(branch.project())); + projectCache.get(destBranch.project()).orElseThrow(noSuchProject(destBranch.project())); ps.checkStatePermitsWrite(); - PermissionBackend.ForRef perm = permissionBackend.user(user.get()).ref(branch); + PermissionBackend.ForRef perm = permissionBackend.user(user.get()).ref(destBranch); if (object instanceof RevCommit) { perm.check(RefPermission.CREATE); - checkCreateCommit(user, repo, (RevCommit) object, ps.getNameKey(), perm, forPush); + if (sourceBranches.length == 0) { + checkCreateCommit(user, repo, (RevCommit) object, ps.getNameKey(), perm, forPush); + } else { + for (BranchNameKey src : sourceBranches) { + PermissionBackend.ForRef forRef = permissionBackend.user(user.get()).ref(src); + if (forRef.testOrFalse(RefPermission.READ)) { + return; + } + } + AuthException e = + new AuthException( + String.format( + "must have %s on existing ref to create new ref from it", + RefPermission.READ.describeForException())); + e.setAdvice( + String.format( + "use an existing ref visible to you, or get %s permission on the ref", + RefPermission.READ.describeForException())); + throw e; + } } else if (object instanceof RevTag) { RevTag tag = (RevTag) object; try (RevWalk rw = new RevWalk(repo)) { rw.parseBody(tag); } catch (IOException e) { - logger.atSevere().withCause(e).log("RevWalk(%s) parsing %s:", branch.project(), tag.name()); + logger.atSevere().withCause(e).log( + "RevWalk(%s) parsing %s:", destBranch.project(), tag.name()); throw e; } @@ -112,12 +134,12 @@ if (target instanceof RevCommit) { checkCreateCommit(user, repo, (RevCommit) target, ps.getNameKey(), perm, forPush); } else { - checkCreateRef(user, repo, branch, target, forPush); + checkCreateRef(user, repo, destBranch, target, forPush); } // If the tag has a PGP signature, allow a lower level of permission // than if it doesn't have a PGP signature. - PermissionBackend.ForRef forRef = permissionBackend.user(user.get()).ref(branch); + PermissionBackend.ForRef forRef = permissionBackend.user(user.get()).ref(destBranch); if (tag.getRawGpgSignature() != null) { forRef.check(RefPermission.CREATE_SIGNED_TAG); } else {
diff --git a/java/com/google/gerrit/server/project/DefaultProjectNameLockManager.java b/java/com/google/gerrit/server/project/DefaultProjectNameLockManager.java index ab347e5..762e244 100644 --- a/java/com/google/gerrit/server/project/DefaultProjectNameLockManager.java +++ b/java/com/google/gerrit/server/project/DefaultProjectNameLockManager.java
@@ -25,7 +25,7 @@ @Singleton public class DefaultProjectNameLockManager implements ProjectNameLockManager { - public static class Module extends AbstractModule { + public static class DefaultProjectNameLockManagerModule extends AbstractModule { @Override protected void configure() { DynamicItem.bind(binder(), ProjectNameLockManager.class)
diff --git a/java/com/google/gerrit/server/project/LabelDefinitionJson.java b/java/com/google/gerrit/server/project/LabelDefinitionJson.java index 730162f..63c9d22 100644 --- a/java/com/google/gerrit/server/project/LabelDefinitionJson.java +++ b/java/com/google/gerrit/server/project/LabelDefinitionJson.java
@@ -32,6 +32,7 @@ label.defaultValue = labelType.getDefaultValue(); label.branches = labelType.getRefPatterns() != null ? labelType.getRefPatterns() : null; label.canOverride = toBoolean(labelType.isCanOverride()); + label.copyCondition = labelType.getCopyCondition().orElse(null); label.copyAnyScore = toBoolean(labelType.isCopyAnyScore()); label.copyMinScore = toBoolean(labelType.isCopyMinScore()); label.copyMaxScore = toBoolean(labelType.isCopyMaxScore());
diff --git a/java/com/google/gerrit/server/project/NullProjectCache.java b/java/com/google/gerrit/server/project/NullProjectCache.java new file mode 100644 index 0000000..57976d3 --- /dev/null +++ b/java/com/google/gerrit/server/project/NullProjectCache.java
@@ -0,0 +1,93 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.project; + +import com.google.common.collect.ImmutableSortedSet; +import com.google.gerrit.entities.AccountGroup.UUID; +import com.google.gerrit.entities.Project; +import com.google.gerrit.entities.Project.NameKey; +import com.google.gerrit.exceptions.StorageException; +import java.io.IOException; +import java.util.Optional; +import java.util.Set; + +/** An implementation of {@link ProjectCache} with no operations implemented. */ +public class NullProjectCache implements ProjectCache { + + @Override + public ProjectState getAllProjects() { + throw new UnsupportedOperationException(); + } + + @Override + public ProjectState getAllUsers() { + throw new UnsupportedOperationException(); + } + + @Override + public Optional<ProjectState> get(NameKey projectName) throws StorageException { + throw new UnsupportedOperationException(); + } + + @Override + public void evict(NameKey p) { + throw new UnsupportedOperationException(); + } + + @Override + public void remove(Project p) { + throw new UnsupportedOperationException(); + } + + @Override + public void remove(NameKey name) { + throw new UnsupportedOperationException(); + } + + @Override + public ImmutableSortedSet<NameKey> all() { + throw new UnsupportedOperationException(); + } + + @Override + public void refreshProjectList() { + throw new UnsupportedOperationException(); + } + + @Override + public Set<UUID> guessRelevantGroupUUIDs() { + throw new UnsupportedOperationException(); + } + + @Override + public ImmutableSortedSet<NameKey> byName(String prefix) { + throw new UnsupportedOperationException(); + } + + @Override + public void onCreateProject(NameKey newProjectName) throws IOException { + throw new UnsupportedOperationException(); + } + + @Override + public void evictAndReindex(Project p) { + throw new UnsupportedOperationException(); + } + + @Override + public void evictAndReindex(NameKey p) { + throw new UnsupportedOperationException(); + } +}
diff --git a/java/com/google/gerrit/server/project/ProjectCache.java b/java/com/google/gerrit/server/project/ProjectCache.java index 0ae84fc..e0569b9 100644 --- a/java/com/google/gerrit/server/project/ProjectCache.java +++ b/java/com/google/gerrit/server/project/ProjectCache.java
@@ -42,10 +42,10 @@ return () -> new NoSuchProjectException(nameKey); } - /** @return the parent state for all projects on this server. */ + /** Returns the parent state for all projects on this server. */ ProjectState getAllProjects(); - /** @return the project state of the project storing meta data for all users. */ + /** Returns the project state of the project storing meta data for all users. */ ProjectState getAllUsers(); /** @@ -91,15 +91,15 @@ */ void remove(Project.NameKey name); - /** @return sorted iteration of projects. */ + /** Returns sorted iteration of projects. */ ImmutableSortedSet<Project.NameKey> all(); /** Refreshes project list cache */ void refreshProjectList(); /** - * @return estimated set of relevant groups extracted from hot project access rules. If the cache - * is cold or too small for the entire project set of the server, this set may be incomplete. + * Returns estimated set of relevant groups extracted from hot project access rules. If the cache + * is cold or too small for the entire project set of the server, this set may be incomplete. */ Set<AccountGroup.UUID> guessRelevantGroupUUIDs();
diff --git a/java/com/google/gerrit/server/project/ProjectCacheImpl.java b/java/com/google/gerrit/server/project/ProjectCacheImpl.java index f1f7d93..0f6810f 100644 --- a/java/com/google/gerrit/server/project/ProjectCacheImpl.java +++ b/java/com/google/gerrit/server/project/ProjectCacheImpl.java
@@ -51,9 +51,9 @@ import com.google.gerrit.server.cache.serialize.ObjectIdConverter; import com.google.gerrit.server.cache.serialize.ProtobufSerializer; import com.google.gerrit.server.cache.serialize.entities.CachedProjectConfigSerializer; +import com.google.gerrit.server.config.AllProjectsConfigProvider; import com.google.gerrit.server.config.AllProjectsName; import com.google.gerrit.server.config.AllUsersName; -import com.google.gerrit.server.config.SitePaths; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.TraceContext; @@ -78,10 +78,15 @@ import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Ref; import org.eclipse.jgit.lib.Repository; -import org.eclipse.jgit.storage.file.FileBasedConfig; -import org.eclipse.jgit.util.FS; +import org.eclipse.jgit.lib.StoredConfig; -/** Cache of project information, including access rights. */ +/** + * Cache of project information, including access rights. + * + * <p>The data of a project is the project's project.config in refs/meta/config parsed out as an + * immutable value. It's keyed purely by the refs/meta/config SHA-1. We also cache the same value + * keyed by name. The latter mapping can become outdated, so data must be evicted explicitly. + */ @Singleton public class ProjectCacheImpl implements ProjectCache { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); @@ -315,27 +320,22 @@ /** * Returns a {@code MurMur128} hash of the contents of {@code etc/All-Projects-project.config}. */ - public static byte[] allProjectsFileProjectConfigHash( - AllProjectsName allProjectsName, SitePaths sitePaths) { + public static byte[] allProjectsFileProjectConfigHash(Optional<StoredConfig> allProjectsConfig) { // Hash the contents of All-Projects-project.config // This is a way for administrators to orchestrate project.config changes across many Gerrit // instances. // When this file changes, we need to make sure we disregard persistently cached project // state. - FileBasedConfig fileBasedConfig = - new FileBasedConfig( - sitePaths - .etc_dir - .resolve(allProjectsName.get()) - .resolve(ProjectConfig.PROJECT_CONFIG) - .toFile(), - FS.DETECTED); + if (!allProjectsConfig.isPresent()) { + // If the project.config file is not present, this is equal to an empty config file: + return Hashing.murmur3_128().hashString("", UTF_8).asBytes(); + } try { - fileBasedConfig.load(); + allProjectsConfig.get().load(); } catch (IOException | ConfigInvalidException e) { throw new IllegalStateException(e); } - return Hashing.murmur3_128().hashString(fileBasedConfig.toText(), UTF_8).asBytes(); + return Hashing.murmur3_128().hashString(allProjectsConfig.get().toText(), UTF_8).asBytes(); } @Singleton @@ -345,7 +345,7 @@ private final ListeningExecutorService cacheRefreshExecutor; private final Counter2<String, Boolean> refreshCounter; private final AllProjectsName allProjectsName; - private final SitePaths sitePaths; + private final AllProjectsConfigProvider allProjectsConfigProvider; @Inject InMemoryLoader( @@ -355,18 +355,25 @@ @CacheRefreshExecutor ListeningExecutorService cacheRefreshExecutor, MetricMaker metricMaker, AllProjectsName allProjectsName, - SitePaths sitePaths) { + AllProjectsConfigProvider allProjectsConfigProvider) { this.persistedCache = persistedCache; this.repoManager = repoManager; this.cacheRefreshExecutor = cacheRefreshExecutor; refreshCounter = metricMaker.newCounter( "caches/refresh_count", - new Description("count").setRate(), - Field.ofString("cache", Metadata.Builder::className).build(), - Field.ofBoolean("outdated", Metadata.Builder::outdated).build()); + new Description( + "The number of refreshes per cache with an indicator if a reload was" + + " necessary.") + .setRate(), + Field.ofString("cache", Metadata.Builder::className) + .description("The name of the cache.") + .build(), + Field.ofBoolean("outdated", Metadata.Builder::outdated) + .description("Whether the cache entry was outdated on reload.") + .build()); this.allProjectsName = allProjectsName; - this.sitePaths = sitePaths; + this.allProjectsConfigProvider = allProjectsConfigProvider; } @Override @@ -380,7 +387,8 @@ Cache.ProjectCacheKeyProto.newBuilder().setProject(key.get()); Ref configRef = git.exactRef(RefNames.REFS_CONFIG); if (key.get().equals(allProjectsName.get())) { - byte[] fileHash = allProjectsFileProjectConfigHash(allProjectsName, sitePaths); + Optional<StoredConfig> allProjectsConfig = allProjectsConfigProvider.get(allProjectsName); + byte[] fileHash = allProjectsFileProjectConfigHash(allProjectsConfig); keyProto.setGlobalConfigRevision(ByteString.copyFrom(fileHash)); } if (configRef != null) {
diff --git a/java/com/google/gerrit/server/project/ProjectCacheWarmer.java b/java/com/google/gerrit/server/project/ProjectCacheWarmer.java index 332aba7..8794f66 100644 --- a/java/com/google/gerrit/server/project/ProjectCacheWarmer.java +++ b/java/com/google/gerrit/server/project/ProjectCacheWarmer.java
@@ -22,6 +22,7 @@ import com.google.gerrit.server.logging.LoggingContextAwareExecutorService; import com.google.inject.Inject; import com.google.inject.Singleton; +import java.util.Optional; import java.util.concurrent.ExecutorService; import java.util.concurrent.ScheduledThreadPoolExecutor; import java.util.concurrent.TimeUnit; @@ -54,15 +55,15 @@ () -> { for (Project.NameKey name : cache.all()) { pool.execute( - () -> - cache - .get(name) - .orElseThrow( - () -> - new IllegalStateException( - "race while traversing projects. got " - + name - + " when loading all projects, but can't load it now"))); + () -> { + Optional<ProjectState> project = cache.get(name); + if (!project.isPresent()) { + throw new IllegalStateException( + "race while traversing projects. got " + + name + + " when loading all projects, but can't load it now"); + } + }); } pool.shutdown(); try {
diff --git a/java/com/google/gerrit/server/project/ProjectConfig.java b/java/com/google/gerrit/server/project/ProjectConfig.java index 37c16a9..c101ddf 100644 --- a/java/com/google/gerrit/server/project/ProjectConfig.java +++ b/java/com/google/gerrit/server/project/ProjectConfig.java
@@ -57,15 +57,17 @@ import com.google.gerrit.entities.Project; import com.google.gerrit.entities.RefNames; import com.google.gerrit.entities.StoredCommentLinkInfo; +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementExpression; import com.google.gerrit.entities.SubscribeSection; import com.google.gerrit.exceptions.InvalidNameException; import com.google.gerrit.extensions.client.InheritableBoolean; import com.google.gerrit.extensions.client.ProjectState; import com.google.gerrit.server.account.GroupBackend; +import com.google.gerrit.server.config.AllProjectsConfigProvider; import com.google.gerrit.server.config.AllProjectsName; import com.google.gerrit.server.config.ConfigUtil; import com.google.gerrit.server.config.PluginConfig; -import com.google.gerrit.server.config.SitePaths; import com.google.gerrit.server.git.ValidationError; import com.google.gerrit.server.git.meta.MetaDataUpdate; import com.google.gerrit.server.git.meta.VersionedMetaData; @@ -96,8 +98,6 @@ import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.lib.StoredConfig; import org.eclipse.jgit.revwalk.RevWalk; -import org.eclipse.jgit.storage.file.FileBasedConfig; -import org.eclipse.jgit.util.FS; public class ProjectConfig extends VersionedMetaData implements ValidationError.Sink { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); @@ -110,6 +110,7 @@ public static final String KEY_ALLOW_POST_SUBMIT = "allowPostSubmit"; public static final String KEY_IGNORE_SELF_APPROVAL = "ignoreSelfApproval"; public static final String KEY_COPY_ANY_SCORE = "copyAnyScore"; + public static final String KEY_COPY_CONDITION = "copyCondition"; public static final String KEY_COPY_MAX_SCORE = "copyMaxScore"; public static final String KEY_COPY_ALL_SCORES_IF_LIST_OF_FILES_DID_NOT_CHANGE = "copyAllScoresIfListOfFilesDidNotChange"; @@ -123,6 +124,13 @@ public static final String KEY_CAN_OVERRIDE = "canOverride"; public static final String KEY_BRANCH = "branch"; + public static final String SUBMIT_REQUIREMENT = "submit-requirement"; + public static final String KEY_SR_DESCRIPTION = "description"; + public static final String KEY_SR_APPLICABILITY_EXPRESSION = "applicableIf"; + public static final String KEY_SR_SUBMITTABILITY_EXPRESSION = "submittableIf"; + public static final String KEY_SR_OVERRIDE_EXPRESSION = "overrideIf"; + public static final String KEY_SR_OVERRIDE_IN_CHILD_PROJECTS = "canOverrideInChildProjects"; + public static final String KEY_MATCH = "match"; private static final String KEY_HTML = "html"; public static final String KEY_LINK = "link"; @@ -192,29 +200,22 @@ // ProjectCache, so this would retain lots more memory. @Singleton public static class Factory { - @Nullable - public static StoredConfig getBaseConfig( - SitePaths sitePaths, AllProjectsName allProjects, Project.NameKey projectName) { - return projectName.equals(allProjects) - // Delay loading till onLoad method. - ? new FileBasedConfig( - sitePaths.etc_dir.resolve(allProjects.get()).resolve(PROJECT_CONFIG).toFile(), - FS.DETECTED) - : null; - } - - private final SitePaths sitePaths; - private final AllProjectsName allProjects; + private final AllProjectsName allProjectsName; + private final AllProjectsConfigProvider allProjectsConfigProvider; @Inject - Factory(SitePaths sitePaths, AllProjectsName allProjects) { - this.sitePaths = sitePaths; - this.allProjects = allProjects; + Factory(AllProjectsName allProjectsName, AllProjectsConfigProvider allProjectsConfigProvider) { + this.allProjectsName = allProjectsName; + this.allProjectsConfigProvider = allProjectsConfigProvider; } public ProjectConfig create(Project.NameKey projectName) { return new ProjectConfig( - projectName, getBaseConfig(sitePaths, allProjects, projectName), allProjects); + projectName, + projectName.equals(allProjectsName) + ? allProjectsConfigProvider.get(allProjectsName) + : Optional.empty(), + allProjectsName); } public ProjectConfig read(MetaDataUpdate update) throws IOException, ConfigInvalidException { @@ -239,7 +240,7 @@ } } - private final StoredConfig baseConfig; + private final Optional<StoredConfig> baseConfig; private final AllProjectsName allProjectsName; private Project project; @@ -250,6 +251,7 @@ private Map<String, ContributorAgreement> contributorAgreements; private Map<String, NotifyConfig> notifySections; private Map<String, LabelType> labelSections; + private Map<String, SubmitRequirement> submitRequirementSections; private ConfiguredMimeTypes mimeTypes; private Map<Project.NameKey, SubscribeSection> subscribeSections; private Map<String, StoredCommentLinkInfo> commentLinkSections; @@ -282,6 +284,7 @@ subscribeSections.values().forEach(s -> builder.addSubscribeSection(s)); commentLinkSections.values().forEach(c -> builder.addCommentLinkSection(c)); labelSections.values().forEach(l -> builder.addLabelSection(l)); + submitRequirementSections.values().forEach(sr -> builder.addSubmitRequirementSection(sr)); pluginConfigs .entrySet() .forEach(c -> builder.addPluginConfig(c.getKey(), c.getValue().toText())); @@ -367,7 +370,7 @@ private ProjectConfig( Project.NameKey projectName, - @Nullable StoredConfig baseConfig, + Optional<StoredConfig> baseConfig, AllProjectsName allProjectsName) { this.projectName = projectName; this.baseConfig = baseConfig; @@ -539,6 +542,14 @@ return labelSections; } + public Map<String, SubmitRequirement> getSubmitRequirementSections() { + return submitRequirementSections; + } + + public void upsertSubmitRequirement(SubmitRequirement requirement) { + submitRequirementSections.put(requirement.name(), requirement); + } + /** Adds or replaces the given {@link LabelType} in this config. */ public void upsertLabelType(LabelType labelType) { labelSections.put(labelType.getName(), labelType); @@ -575,32 +586,32 @@ groupList.renameGroup(uuid, newName); } - /** @return the group reference, if the group is used by at least one rule. */ + /** Returns the group reference, if the group is used by at least one rule. */ public GroupReference getGroup(AccountGroup.UUID uuid) { return groupList.byUUID(uuid); } /** - * @return the group reference corresponding to the specified group name if the group is used by - * at least one rule or plugin value. + * Returns the group reference corresponding to the specified group name if the group is used by + * at least one rule or plugin value. */ public GroupReference getGroup(String groupName) { return groupList.byName(groupName); } /** - * @return the project's rules.pl ObjectId, if present in the branch. Null if it doesn't exist. + * Returns the project's rules.pl ObjectId, if present in the branch. Null if it doesn't exist. */ public ObjectId getRulesId() { return rulesId; } - /** @return the maxObjectSizeLimit configured on this project, or zero if not configured. */ + /** Returns the maxObjectSizeLimit configured on this project, or zero if not configured. */ public long getMaxObjectSizeLimit() { return maxObjectSizeLimit; } - /** @return the checkReceivedObjects for this project, default is true. */ + /** Returns the checkReceivedObjects for this project, default is true. */ public boolean getCheckReceivedObjects() { return checkReceivedObjects; } @@ -642,8 +653,8 @@ @Override protected void onLoad() throws IOException, ConfigInvalidException { - if (baseConfig != null) { - baseConfig.load(); + if (baseConfig.isPresent()) { + baseConfig.get().load(); } readGroupList(); @@ -658,7 +669,7 @@ if (rc.getStringList(ACCESS, null, KEY_INHERIT_FROM).length > 1) { // The config must not contain more than one parent to inherit from // as there is no guarantee which of the parents would be used then. - error(ValidationError.create(PROJECT_CONFIG, "Cannot inherit from multiple projects")); + error("Cannot inherit from multiple projects"); } p.setParent(rc.getString(ACCESS, null, KEY_INHERIT_FROM)); @@ -688,6 +699,7 @@ loadBranchOrderSection(rc); loadNotifySections(rc); loadLabelSections(rc); + loadSubmitRequirementSections(rc); loadCommentLinkSections(rc); loadSubscribeSections(rc); mimeTypes = ConfiguredMimeTypes.create(projectName.get(), rc); @@ -710,10 +722,8 @@ String lower = name.toLowerCase(); if (lowerNames.containsKey(lower)) { error( - ValidationError.create( - PROJECT_CONFIG, - String.format( - "Extension Panels \"%s\" conflicts with \"%s\"", name, lowerNames.get(lower)))); + String.format( + "Extension Panels \"%s\" conflicts with \"%s\"", name, lowerNames.get(lower))); } lowerNames.put(lower, name); extensionPanelSections.put( @@ -739,26 +749,14 @@ ca.setAutoVerify(null); } else if (rules.size() > 1) { error( - ValidationError.create( - PROJECT_CONFIG, - "Invalid rule in " - + CONTRIBUTOR_AGREEMENT - + "." - + name - + "." - + KEY_AUTO_VERIFY - + ": at most one group may be set")); + String.format( + "Invalid rule in %s.%s.%s: at most one group may be set", + CONTRIBUTOR_AGREEMENT, name, KEY_AUTO_VERIFY)); } else if (rules.get(0).getAction() != Action.ALLOW) { error( - ValidationError.create( - PROJECT_CONFIG, - "Invalid rule in " - + CONTRIBUTOR_AGREEMENT - + "." - + name - + "." - + KEY_AUTO_VERIFY - + ": the group must be allowed")); + String.format( + "Invalid rule in %s.%s.%s: the group must be allowed", + CONTRIBUTOR_AGREEMENT, name, KEY_AUTO_VERIFY)); } else { ca.setAutoVerify(rules.get(0).getGroup()); } @@ -806,21 +804,16 @@ if (ref.getUUID() != null) { n.addGroup(ref); } else { - error( - ValidationError.create( - PROJECT_CONFIG, - "group \"" + ref.getName() + "\" not in " + GroupList.FILE_NAME)); + error(String.format("group \"%s\" not in %s", ref.getName(), GroupList.FILE_NAME)); } } else if (dst.startsWith("user ")) { - error(ValidationError.create(PROJECT_CONFIG, dst + " not supported")); + error(String.format("%s not supported", dst)); } else { try { n.addAddress(Address.parse(dst)); } catch (IllegalArgumentException err) { error( - ValidationError.create( - PROJECT_CONFIG, - "notify section \"" + sectionName + "\" has invalid email \"" + dst + "\"")); + String.format("notify section \"%s\" has invalid email \"%s\"", sectionName, dst)); } } } @@ -881,7 +874,7 @@ try { RefPattern.validateRegExp(refPattern); } catch (InvalidNameException e) { - error(ValidationError.create(PROJECT_CONFIG, "Invalid ref name: " + e.getMessage())); + error(String.format("Invalid ref name: %s", e.getMessage())); return false; } return true; @@ -909,9 +902,7 @@ // to fail fast if any of the patterns are invalid. patterns.add(Pattern.compile(patternString).pattern()); } catch (PatternSyntaxException e) { - error( - ValidationError.create( - PROJECT_CONFIG, "Invalid regular expression: " + e.getMessage())); + error(String.format("Invalid regular expression: %s", e.getMessage())); continue; } } @@ -938,15 +929,11 @@ rule = PermissionRule.fromString(ruleString, useRange); } catch (IllegalArgumentException notRule) { error( - ValidationError.create( - PROJECT_CONFIG, - "Invalid rule in " - + section - + (subsection != null ? "." + subsection : "") - + "." - + varName - + ": " - + notRule.getMessage())); + String.format( + "Invalid rule in %s.%s: %s", + section + (subsection != null ? "." + subsection : ""), + varName, + notRule.getMessage())); continue; } @@ -957,9 +944,7 @@ // all rules in the same file share the same GroupReference. // ref = groupList.resolve(rule.getGroup()); - error( - ValidationError.create( - PROJECT_CONFIG, "group \"" + ref.getName() + "\" not in " + GroupList.FILE_NAME)); + error(String.format("group \"%s\" not in %s", ref.getName(), GroupList.FILE_NAME)); } perm.add(rule.toBuilder().setGroup(ref)); @@ -977,16 +962,56 @@ return LabelValue.create(Shorts.checkedCast(PermissionRule.parseInt(parts.get(0))), valueText); } + private void loadSubmitRequirementSections(Config rc) { + Map<String, String> lowerNames = new HashMap<>(); + submitRequirementSections = new LinkedHashMap<>(); + for (String name : rc.getSubsections(SUBMIT_REQUIREMENT)) { + String lower = name.toLowerCase(); + if (lowerNames.containsKey(lower)) { + error( + String.format( + "Submit requirement '%s' conflicts with '%s'.", name, lowerNames.get(lower))); + continue; + } + lowerNames.put(lower, name); + String description = rc.getString(SUBMIT_REQUIREMENT, name, KEY_SR_DESCRIPTION); + String appExpr = rc.getString(SUBMIT_REQUIREMENT, name, KEY_SR_APPLICABILITY_EXPRESSION); + String blockExpr = rc.getString(SUBMIT_REQUIREMENT, name, KEY_SR_SUBMITTABILITY_EXPRESSION); + String overrideExpr = rc.getString(SUBMIT_REQUIREMENT, name, KEY_SR_OVERRIDE_EXPRESSION); + boolean canInherit = + rc.getBoolean(SUBMIT_REQUIREMENT, name, KEY_SR_OVERRIDE_IN_CHILD_PROJECTS, false); + + if (blockExpr == null) { + error( + String.format( + "Submit requirement '%s' does not define a submittability expression.", name)); + continue; + } + + // TODO(SR): add expressions validation. Expressions are stored as strings so we need to + // validate their syntax. + + SubmitRequirement submitRequirement = + SubmitRequirement.builder() + .setName(name) + .setDescription(Optional.ofNullable(description)) + .setApplicabilityExpression(SubmitRequirementExpression.of(appExpr)) + .setSubmittabilityExpression(SubmitRequirementExpression.create(blockExpr)) + .setOverrideExpression(SubmitRequirementExpression.of(overrideExpr)) + .setAllowOverrideInChildProjects(canInherit) + .build(); + + submitRequirementSections.put(name, submitRequirement); + } + } + private void loadLabelSections(Config rc) { Map<String, String> lowerNames = Maps.newHashMapWithExpectedSize(2); labelSections = new LinkedHashMap<>(); for (String name : rc.getSubsections(LABEL)) { String lower = name.toLowerCase(); if (lowerNames.containsKey(lower)) { - error( - ValidationError.create( - PROJECT_CONFIG, - String.format("Label \"%s\" conflicts with \"%s\"", name, lowerNames.get(lower)))); + error(String.format("Label \"%s\" conflicts with \"%s\"", name, lowerNames.get(lower))); } lowerNames.put(lower, name); @@ -998,18 +1023,13 @@ if (allValues.add(labelValue.getValue())) { values.add(labelValue); } else { - error( - ValidationError.create( - PROJECT_CONFIG, - String.format("Duplicate %s \"%s\" for label \"%s\"", KEY_VALUE, value, name))); + error(String.format("Duplicate %s \"%s\" for label \"%s\"", KEY_VALUE, value, name)); } } catch (IllegalArgumentException notValue) { error( - ValidationError.create( - PROJECT_CONFIG, - String.format( - "Invalid %s \"%s\" for label \"%s\": %s", - KEY_VALUE, value, name, notValue.getMessage()))); + String.format( + "Invalid %s \"%s\" for label \"%s\": %s", + KEY_VALUE, value, name, notValue.getMessage())); } } @@ -1017,7 +1037,7 @@ try { label = LabelType.builder(name, values); } catch (IllegalArgumentException badName) { - error(ValidationError.create(PROJECT_CONFIG, String.format("Invalid label \"%s\"", name))); + error(String.format("Invalid label \"%s\"", name)); continue; } @@ -1028,24 +1048,19 @@ : Optional.of(LabelFunction.MAX_WITH_BLOCK); if (!function.isPresent()) { error( - ValidationError.create( - PROJECT_CONFIG, - String.format( - "Invalid %s for label \"%s\". Valid names are: %s", - KEY_FUNCTION, name, Joiner.on(", ").join(LabelFunction.ALL.keySet())))); + String.format( + "Invalid %s for label \"%s\". Valid names are: %s", + KEY_FUNCTION, name, Joiner.on(", ").join(LabelFunction.ALL.keySet()))); } label.setFunction(function.orElse(null)); + label.setCopyCondition(rc.getString(LABEL, name, KEY_COPY_CONDITION)); if (!values.isEmpty()) { short dv = (short) rc.getInt(LABEL, name, KEY_DEFAULT_VALUE, 0); if (isInRange(dv, values)) { label.setDefaultValue(dv); } else { - error( - ValidationError.create( - PROJECT_CONFIG, - String.format( - "Invalid %s \"%s\" for label \"%s\"", KEY_DEFAULT_VALUE, dv, name))); + error(String.format("Invalid %s \"%s\" for label \"%s\"", KEY_DEFAULT_VALUE, dv, name)); } } label.setAllowPostSubmit( @@ -1094,18 +1109,13 @@ short copyValue = Shorts.checkedCast(PermissionRule.parseInt(value)); if (!copyValues.add(copyValue)) { error( - ValidationError.create( - PROJECT_CONFIG, - String.format( - "Duplicate %s \"%s\" for label \"%s\"", KEY_COPY_VALUE, value, name))); + String.format("Duplicate %s \"%s\" for label \"%s\"", KEY_COPY_VALUE, value, name)); } } catch (IllegalArgumentException notValue) { error( - ValidationError.create( - PROJECT_CONFIG, - String.format( - "Invalid %s \"%s\" for label \"%s\": %s", - KEY_COPY_VALUE, value, name, notValue.getMessage()))); + String.format( + "Invalid %s \"%s\" for label \"%s\": %s", + KEY_COPY_VALUE, value, name, notValue.getMessage())); } } label.setCopyValues(copyValues); @@ -1140,18 +1150,14 @@ commentLinkSections.put(name, buildCommentLink(rc, name, false)); } catch (PatternSyntaxException e) { error( - ValidationError.create( - PROJECT_CONFIG, - String.format( - "Invalid pattern \"%s\" in commentlink.%s.match: %s", - rc.getString(COMMENTLINK, name, KEY_MATCH), name, e.getMessage()))); + String.format( + "Invalid pattern \"%s\" in commentlink.%s.match: %s", + rc.getString(COMMENTLINK, name, KEY_MATCH), name, e.getMessage())); } catch (IllegalArgumentException e) { error( - ValidationError.create( - PROJECT_CONFIG, - String.format( - "Error in pattern \"%s\" in commentlink.%s.match: %s", - rc.getString(COMMENTLINK, name, KEY_MATCH), name, e.getMessage()))); + String.format( + "Error in pattern \"%s\" in commentlink.%s.match: %s", + rc.getString(COMMENTLINK, name, KEY_MATCH), name, e.getMessage())); } } } @@ -1193,9 +1199,7 @@ if (groupName != null) { GroupReference ref = groupList.byName(groupName); if (ref == null) { - error( - ValidationError.create( - PROJECT_CONFIG, "group \"" + groupName + "\" not in " + GroupList.FILE_NAME)); + error(String.format("group \"%s\" not in %s", groupName, GroupList.FILE_NAME)); } rc.setString(PLUGIN, plugin, name, value); } @@ -1291,6 +1295,7 @@ savePluginSections(rc, keepGroups); groupList.retainUUIDs(keepGroups); saveLabelSections(rc); + saveSubmitRequirementSections(rc); saveCommentLinkSections(rc); saveSubscribeSections(rc); saveBranchOrderSection(rc); @@ -1623,6 +1628,11 @@ values.add(value.format().trim()); } rc.setStringList(LABEL, name, KEY_VALUE, values); + if (label.getCopyCondition().isPresent()) { + rc.setString(LABEL, name, KEY_COPY_CONDITION, label.getCopyCondition().get()); + } else { + rc.unset(LABEL, name, KEY_COPY_CONDITION); + } List<String> refPatterns = label.getRefPatterns(); if (refPatterns != null && !refPatterns.isEmpty()) { @@ -1637,6 +1647,45 @@ } } + private void saveSubmitRequirementSections(Config rc) { + unsetSection(rc, SUBMIT_REQUIREMENT); + + if (submitRequirementSections != null) { + for (Map.Entry<String, SubmitRequirement> entry : submitRequirementSections.entrySet()) { + String name = entry.getKey(); + SubmitRequirement sr = entry.getValue(); + + if (sr.description().isPresent()) { + rc.setString(SUBMIT_REQUIREMENT, name, KEY_SR_DESCRIPTION, sr.description().get()); + } + if (sr.applicabilityExpression().isPresent()) { + rc.setString( + SUBMIT_REQUIREMENT, + name, + KEY_SR_APPLICABILITY_EXPRESSION, + sr.applicabilityExpression().get().expressionString()); + } + rc.setString( + SUBMIT_REQUIREMENT, + name, + KEY_SR_SUBMITTABILITY_EXPRESSION, + sr.submittabilityExpression().expressionString()); + if (sr.overrideExpression().isPresent()) { + rc.setString( + SUBMIT_REQUIREMENT, + name, + KEY_SR_OVERRIDE_EXPRESSION, + sr.overrideExpression().get().expressionString()); + } + rc.setBoolean( + SUBMIT_REQUIREMENT, + name, + KEY_SR_OVERRIDE_IN_CHILD_PROJECTS, + sr.allowOverrideInChildProjects()); + } + } + } + private static void setBooleanConfigKey( Config rc, String section, String name, String key, boolean value, boolean defaultValue) { if (value == defaultValue) { @@ -1700,11 +1749,15 @@ try { return rc.getEnum(section, subsection, name, defaultValue); } catch (IllegalArgumentException err) { - error(ValidationError.create(PROJECT_CONFIG, err.getMessage())); + error(err.getMessage()); return defaultValue; } } + private void error(String errorMessage) { + error(ValidationError.create(PROJECT_CONFIG, errorMessage)); + } + @Override public void error(ValidationError error) { if (validationErrors == null) {
diff --git a/java/com/google/gerrit/server/project/ProjectCreator.java b/java/com/google/gerrit/server/project/ProjectCreator.java index c382f04..4e778a4 100644 --- a/java/com/google/gerrit/server/project/ProjectCreator.java +++ b/java/com/google/gerrit/server/project/ProjectCreator.java
@@ -39,7 +39,8 @@ import com.google.gerrit.server.extensions.events.AbstractNoNotifyEvent; import com.google.gerrit.server.extensions.events.GitReferenceUpdated; import com.google.gerrit.server.git.GitRepositoryManager; -import com.google.gerrit.server.git.RepositoryCaseMismatchException; +import com.google.gerrit.server.git.GitRepositoryManager.Status; +import com.google.gerrit.server.git.RepositoryExistsException; import com.google.gerrit.server.git.meta.MetaDataUpdate; import com.google.gerrit.server.plugincontext.PluginSetContext; import com.google.inject.Inject; @@ -107,12 +108,9 @@ final Project.NameKey nameKey = args.getProject(); try { final String head = args.permissionsOnly ? RefNames.REFS_CONFIG : args.branch.get(0); - try (Repository repo = repoManager.openRepository(nameKey)) { - if (repo.getObjectDatabase().exists()) { - throw new ResourceConflictException("project \"" + nameKey + "\" exists"); - } - } catch (RepositoryNotFoundException e) { - // It does not exist, safe to ignore. + Status status = repoManager.getRepositoryStatus(nameKey); + if (!status.equals(Status.NON_EXISTENT)) { + throw new RepositoryExistsException(nameKey, "Repository status: " + status); } try (Repository repo = repoManager.createRepository(nameKey)) { RefUpdate u = repo.updateRef(Constants.HEAD); @@ -129,13 +127,11 @@ return projectCache.get(nameKey).orElseThrow(illegalState(nameKey)); } - } catch (RepositoryCaseMismatchException e) { + } catch (RepositoryExistsException e) { throw new ResourceConflictException( "Cannot create " + nameKey.get() - + " because the name is already occupied by another project." - + " The other project has the same name, only spelled in a" - + " different case.", + + " because the name is already occupied by another project.", e); } catch (RepositoryNotFoundException badName) { throw new BadRequestException("invalid project name: " + nameKey, badName);
diff --git a/java/com/google/gerrit/server/project/ProjectState.java b/java/com/google/gerrit/server/project/ProjectState.java index 8fcfd49..b350f3c 100644 --- a/java/com/google/gerrit/server/project/ProjectState.java +++ b/java/com/google/gerrit/server/project/ProjectState.java
@@ -15,13 +15,12 @@ package com.google.gerrit.server.project; import static com.google.common.base.Preconditions.checkState; -import static com.google.common.collect.ImmutableList.toImmutableList; import static com.google.gerrit.entities.PermissionRule.Action.ALLOW; -import static java.util.Comparator.comparing; import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.FluentIterable; import com.google.common.collect.ImmutableList; +import com.google.common.collect.ImmutableMap; import com.google.common.collect.Lists; import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.AccessSection; @@ -37,6 +36,7 @@ import com.google.gerrit.entities.PermissionRule; import com.google.gerrit.entities.Project; import com.google.gerrit.entities.StoredCommentLinkInfo; +import com.google.gerrit.entities.SubmitRequirement; import com.google.gerrit.entities.SubscribeSection; import com.google.gerrit.extensions.api.projects.CommentLinkInfo; import com.google.gerrit.extensions.client.SubmitType; @@ -63,8 +63,8 @@ import org.eclipse.jgit.lib.Config; /** - * Cached information on a project. Must not contain any data derived from parents other than it's - * immediate parent's {@link com.google.gerrit.entities.Project.NameKey}. + * State of a project, aggregated from the project and its parents. This is obtained from the {@link + * ProjectCache}. It should not be persisted across requests */ public class ProjectState { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); @@ -136,8 +136,8 @@ } /** - * @return cached computation of all global capabilities. This should only be invoked on the state - * from {@link ProjectCache#getAllProjects()}. Null on any other project. + * Returns cached computation of all global capabilities. This should only be invoked on the state + * from {@link ProjectCache#getAllProjects()}. Null on any other project. */ public CapabilityCollection getCapabilityCollection() { return capabilities; @@ -269,12 +269,8 @@ if (localAccessSections != null) { return localAccessSections; } - ImmutableList<AccessSection> fromConfig = - cachedConfig.getAccessSections().values().stream() - .sorted(comparing(AccessSection::getName)) - .collect(toImmutableList()); - List<SectionMatcher> sm = new ArrayList<>(fromConfig.size()); - for (AccessSection section : fromConfig) { + List<SectionMatcher> sm = new ArrayList<>(cachedConfig.getAccessSections().values().size()); + for (AccessSection section : cachedConfig.getAccessSections().values()) { SectionMatcher matcher = SectionMatcher.wrap(getNameKey(), section); if (matcher != null) { sm.add(matcher); @@ -301,9 +297,9 @@ } /** - * @return all {@link AccountGroup}'s to which the owner privilege for 'refs/*' is assigned for - * this project (the local owners), if there are no local owners the local owners of the - * nearest parent project that has local owners are returned + * Returns all {@link AccountGroup}'s to which the owner privilege for 'refs/*' is assigned for + * this project (the local owners), if there are no local owners the local owners of the nearest + * parent project that has local owners are returned */ public Set<AccountGroup.UUID> getOwners() { for (ProjectState p : tree()) { @@ -315,10 +311,10 @@ } /** - * @return all {@link AccountGroup}'s that are allowed to administrate the complete project. This - * includes all groups to which the owner privilege for 'refs/*' is assigned for this project - * (the local owners) and all groups to which the owner privilege for 'refs/*' is assigned for - * one of the parent projects (the inherited owners). + * Returns all {@link AccountGroup}'s that are allowed to administrate the complete project. This + * includes all groups to which the owner privilege for 'refs/*' is assigned for this project (the + * local owners) and all groups to which the owner privilege for 'refs/*' is assigned for one of + * the parent projects (the inherited owners). */ public Set<AccountGroup.UUID> getAllOwners() { Set<AccountGroup.UUID> result = new HashSet<>(); @@ -331,16 +327,16 @@ } /** - * @return an iterable that walks through this project and then the parents of this project. - * Starts from this project and progresses up the hierarchy to All-Projects. + * Returns an iterable that walks through this project and then the parents of this project. + * Starts from this project and progresses up the hierarchy to All-Projects. */ public Iterable<ProjectState> tree() { return () -> new ProjectHierarchyIterator(projectCache, allProjectsName, ProjectState.this); } /** - * @return an iterable that walks in-order from All-Projects through the project hierarchy to this - * project. + * Returns an iterable that walks in-order from All-Projects through the project hierarchy to this + * project. */ public Iterable<ProjectState> treeInOrder() { List<ProjectState> projects = Lists.newArrayList(tree()); @@ -349,8 +345,8 @@ } /** - * @return an iterable that walks through the parents of this project. Starts from the immediate - * parent of this project and progresses up the hierarchy to All-Projects. + * Returns an iterable that walks through the parents of this project. Starts from the immediate + * parent of this project and progresses up the hierarchy to All-Projects. */ public FluentIterable<ProjectState> parents() { return FluentIterable.from(tree()).skip(1); @@ -379,6 +375,21 @@ return false; } + /** Get all submit requirements for a project, including those from parent projects. */ + public Map<String, SubmitRequirement> getSubmitRequirements() { + Map<String, SubmitRequirement> requirements = new LinkedHashMap<>(); + for (ProjectState s : treeInOrder()) { + for (SubmitRequirement requirement : s.getConfig().getSubmitRequirementSections().values()) { + String lowerName = requirement.name().toLowerCase(); + SubmitRequirement old = requirements.get(lowerName); + if (old == null || old.allowOverrideInChildProjects()) { + requirements.put(lowerName, requirement); + } + } + } + return ImmutableMap.copyOf(requirements); + } + /** All available label types. */ public LabelTypes getLabelTypes() { Map<String, LabelType> types = new LinkedHashMap<>(); @@ -464,19 +475,19 @@ * {@code PluginConfig#withInheritance(ProjectState.Factory)} */ public PluginConfig getPluginConfig(String pluginName) { - if (getConfig().getPluginConfigs().containsKey(pluginName)) { - Config config = new Config(); + Config config = new Config(); + String cachedPluginConfig = getConfig().getPluginConfigs().get(pluginName); + if (cachedPluginConfig != null) { try { - config.fromText(getConfig().getPluginConfigs().get(pluginName)); + config.fromText(cachedPluginConfig); } catch (ConfigInvalidException e) { // This is OK to propagate as IllegalStateException because it's a programmer error. // The config was converted to a String using Config#toText. So #fromText must not // throw a ConfigInvalidException throw new IllegalStateException("invalid plugin config for " + pluginName, e); } - return PluginConfig.create(pluginName, config, getConfig()); } - return PluginConfig.create(pluginName, new Config(), getConfig()); + return PluginConfig.create(pluginName, config, getConfig()); } public Optional<BranchOrderSection> getBranchOrderSection() {
diff --git a/java/com/google/gerrit/server/project/ProjectsConsistencyChecker.java b/java/com/google/gerrit/server/project/ProjectsConsistencyChecker.java index 812d98d..fca1b36 100644 --- a/java/com/google/gerrit/server/project/ProjectsConsistencyChecker.java +++ b/java/com/google/gerrit/server/project/ProjectsConsistencyChecker.java
@@ -48,10 +48,7 @@ import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.index.change.ChangeField; import com.google.gerrit.server.query.change.ChangeData; -import com.google.gerrit.server.query.change.ChangeIdPredicate; -import com.google.gerrit.server.query.change.CommitPredicate; -import com.google.gerrit.server.query.change.ProjectPredicate; -import com.google.gerrit.server.query.change.RefPredicate; +import com.google.gerrit.server.query.change.ChangePredicates; import com.google.gerrit.server.update.RetryHelper; import com.google.inject.Inject; import com.google.inject.Singleton; @@ -151,7 +148,7 @@ // Base predicate which is fixed for every change query. Predicate<ChangeData> basePredicate = - and(new ProjectPredicate(projectName.get()), new RefPredicate(branch), open()); + and(ChangePredicates.project(projectName), ChangePredicates.ref(branch), open()); int maxLeafPredicates = indexConfig.maxTerms() - basePredicate.getLeafCount(); @@ -231,11 +228,11 @@ } // Find changes that have a matching Change-Id. - predicates.add(new ChangeIdPredicate(changeId)); + predicates.add(ChangePredicates.idPrefix(changeId)); }); // Find changes that have a matching commit. - predicates.add(new CommitPredicate(commit.name())); + predicates.add(ChangePredicates.commitPrefix(commit.name())); } if (!predicates.isEmpty()) {
diff --git a/java/com/google/gerrit/server/project/Reachable.java b/java/com/google/gerrit/server/project/Reachable.java index 331b7da..342c2bc 100644 --- a/java/com/google/gerrit/server/project/Reachable.java +++ b/java/com/google/gerrit/server/project/Reachable.java
@@ -14,10 +14,10 @@ package com.google.gerrit.server.project; +import com.google.common.collect.ImmutableList; import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Project; import com.google.gerrit.server.CurrentUser; -import com.google.gerrit.server.change.IncludedInResolver; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.TraceContext; import com.google.gerrit.server.logging.TraceContext.TraceTimer; @@ -27,11 +27,15 @@ import com.google.inject.Inject; import com.google.inject.Singleton; import java.io.IOException; +import java.util.ArrayList; import java.util.Collection; import java.util.List; import java.util.Optional; +import org.eclipse.jgit.errors.IncorrectObjectTypeException; +import org.eclipse.jgit.errors.MissingObjectException; import org.eclipse.jgit.lib.Ref; import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.revwalk.ReachabilityChecker; import org.eclipse.jgit.revwalk.RevCommit; import org.eclipse.jgit.revwalk.RevWalk; @@ -51,9 +55,9 @@ } /** - * @return true if a commit is reachable from a given set of refs. This method enforces - * permissions on the given set of refs and performs a reachability check. Tags are not - * filtered separately and will only be returned if reachable by a provided ref. + * Returns true if a commit is reachable from a given set of refs. This method enforces + * permissions on the given set of refs and performs a reachability check. Tags are not filtered + * separately and will only be returned if reachable by a provided ref. */ public boolean fromRefs( Project.NameKey project, Repository repo, RevCommit commit, List<Ref> refs) { @@ -73,14 +77,33 @@ .orElse(permissionBackend.currentUser()) .project(project) .filter(refs, repo, RefFilterOptions.defaults()); + Collection<RevCommit> visible = new ArrayList<>(); + for (Ref r : filtered) { + try { + visible.add(rw.parseCommit(r.getObjectId())); + } catch (IncorrectObjectTypeException notCommit) { + // Its OK for a tag reference to point to a blob or a tree, this + // is common in the Linux kernel or git.git repository. + continue; + } catch (MissingObjectException notHere) { + // Log the problem with this branch, but keep processing. + logger.atWarning().log( + "Reference %s in %s points to dangling object %s", + r.getName(), repo.getDirectory(), r.getObjectId()); + continue; + } + } // The filtering above already produces a voluminous trace. To separate the permission check // from the reachability check, do the trace here: try (TraceTimer timer = TraceContext.newTimer( - "IncludedInResolver.includedInAny", + "ReachabilityChecker.areAllReachable", Metadata.builder().projectName(project.get()).resourceCount(refs.size()).build())) { - return IncludedInResolver.includedInAny(repo, rw, commit, filtered); + ReachabilityChecker checker = rw.getObjectReader().createReachabilityChecker(rw); + Optional<RevCommit> unreachable = + checker.areAllReachable(ImmutableList.of(rw.parseCommit(commit)), visible.stream()); + return !unreachable.isPresent(); } } catch (IOException | PermissionBackendException e) { logger.atSevere().withCause(e).log(
diff --git a/java/com/google/gerrit/server/project/RefPatternMatcher.java b/java/com/google/gerrit/server/project/RefPatternMatcher.java index b9076b3..be840b5 100644 --- a/java/com/google/gerrit/server/project/RefPatternMatcher.java +++ b/java/com/google/gerrit/server/project/RefPatternMatcher.java
@@ -22,6 +22,7 @@ import com.google.common.collect.ImmutableSet; import com.google.common.collect.Streams; import com.google.gerrit.common.data.ParameterizedString; +import com.google.gerrit.entities.AccessSection; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.RefNames; import com.google.gerrit.server.CurrentUser; @@ -32,6 +33,13 @@ import java.util.stream.Stream; public abstract class RefPatternMatcher { + public static RefPatternMatcher getMatcher(AccessSection section) { + if (section.getNamePattern().isPresent()) { + return new Regexp(section.getNamePattern().get()); + } + return getMatcher(section.getName()); + } + public static RefPatternMatcher getMatcher(String pattern) { if (containsParameters(pattern)) { return new ExpandParameters(pattern); @@ -79,6 +87,10 @@ pattern = Pattern.compile(re); } + Regexp(Pattern re) { + pattern = re; + } + @Override public boolean match(String ref, CurrentUser user) { return pattern.matcher(ref).matches() || (isRE(ref) && pattern.pattern().equals(ref));
diff --git a/java/com/google/gerrit/server/project/RefResource.java b/java/com/google/gerrit/server/project/RefResource.java index ac2735d..fcf6048 100644 --- a/java/com/google/gerrit/server/project/RefResource.java +++ b/java/com/google/gerrit/server/project/RefResource.java
@@ -22,9 +22,9 @@ super(projectState, user); } - /** @return the ref's name */ + /** Returns the ref's name */ public abstract String getRef(); - /** @return the ref's revision */ + /** Returns the ref's revision */ public abstract String getRevision(); }
diff --git a/java/com/google/gerrit/server/project/RefValidationHelper.java b/java/com/google/gerrit/server/project/RefValidationHelper.java index 1912660..a6020a3 100644 --- a/java/com/google/gerrit/server/project/RefValidationHelper.java +++ b/java/com/google/gerrit/server/project/RefValidationHelper.java
@@ -22,19 +22,20 @@ import com.google.inject.Inject; import com.google.inject.assistedinject.Assisted; import org.eclipse.jgit.lib.RefUpdate; -import org.eclipse.jgit.transport.ReceiveCommand.Type; +import org.eclipse.jgit.transport.ReceiveCommand; public class RefValidationHelper { public interface Factory { - RefValidationHelper create(Type operationType); + RefValidationHelper create(ReceiveCommand.Type operationType); } private final RefOperationValidators.Factory refValidatorsFactory; - private final Type operationType; + private final ReceiveCommand.Type operationType; @Inject RefValidationHelper( - RefOperationValidators.Factory refValidatorsFactory, @Assisted Type operationType) { + RefOperationValidators.Factory refValidatorsFactory, + @Assisted ReceiveCommand.Type operationType) { this.refValidatorsFactory = refValidatorsFactory; this.operationType = operationType; }
diff --git a/java/com/google/gerrit/server/project/RemoveReviewerControl.java b/java/com/google/gerrit/server/project/RemoveReviewerControl.java index 652c49f..0336e8e 100644 --- a/java/com/google/gerrit/server/project/RemoveReviewerControl.java +++ b/java/com/google/gerrit/server/project/RemoveReviewerControl.java
@@ -62,7 +62,7 @@ checkRemoveReviewer(notes, currentUser, reviewer, 0); } - /** @return true if the user is allowed to remove this reviewer. */ + /** Returns true if the user is allowed to remove this reviewer. */ public boolean testRemoveReviewer( ChangeData cd, CurrentUser currentUser, Account.Id reviewer, int value) throws PermissionBackendException {
diff --git a/java/com/google/gerrit/server/project/SectionMatcher.java b/java/com/google/gerrit/server/project/SectionMatcher.java index 763957e..3d7175f 100644 --- a/java/com/google/gerrit/server/project/SectionMatcher.java +++ b/java/com/google/gerrit/server/project/SectionMatcher.java
@@ -28,7 +28,7 @@ static SectionMatcher wrap(Project.NameKey project, AccessSection section) { String ref = section.getName(); if (AccessSection.isValidRefSectionName(ref)) { - return new SectionMatcher(project, section, getMatcher(ref)); + return new SectionMatcher(project, section, getMatcher(section)); } return null; }
diff --git a/java/com/google/gerrit/server/project/SubmitRequirementsAdapter.java b/java/com/google/gerrit/server/project/SubmitRequirementsAdapter.java new file mode 100644 index 0000000..539edc1 --- /dev/null +++ b/java/com/google/gerrit/server/project/SubmitRequirementsAdapter.java
@@ -0,0 +1,220 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.project; + +import com.google.common.collect.ImmutableList; +import com.google.common.collect.MoreCollectors; +import com.google.common.flogger.FluentLogger; +import com.google.gerrit.entities.LabelType; +import com.google.gerrit.entities.SubmitRecord; +import com.google.gerrit.entities.SubmitRecord.Label; +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementExpression; +import com.google.gerrit.entities.SubmitRequirementExpressionResult; +import com.google.gerrit.entities.SubmitRequirementExpressionResult.Status; +import com.google.gerrit.entities.SubmitRequirementResult; +import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.query.change.ChangeQueryBuilder; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.function.Function; +import java.util.stream.Collectors; +import org.eclipse.jgit.lib.ObjectId; + +/** + * Convert {@link com.google.gerrit.entities.SubmitRecord} entities to {@link + * com.google.gerrit.entities.SubmitRequirementResult}s. + */ +public class SubmitRequirementsAdapter { + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + + private SubmitRequirementsAdapter() {} + + /** + * Retrieve legacy submit records (created by label functions and other {@link + * com.google.gerrit.server.rules.SubmitRule}s) and convert them to submit requirement results. + */ + public static Map<SubmitRequirement, SubmitRequirementResult> getLegacyRequirements( + SubmitRuleEvaluator.Factory evaluator, ChangeData cd) { + // We use SubmitRuleOptions.defaults() which does not recompute submit rules for closed changes. + // This doesn't have an effect since we never call this class (i.e. to evaluate submit + // requirements) for closed changes. + List<SubmitRecord> records = evaluator.create(SubmitRuleOptions.defaults()).evaluate(cd); + List<LabelType> labelTypes = cd.getLabelTypes().getLabelTypes(); + ObjectId commitId = cd.currentPatchSet().commitId(); + return records.stream() + .map(r -> createResult(r, labelTypes, commitId)) + .flatMap(List::stream) + .collect(Collectors.toMap(sr -> sr.submitRequirement(), Function.identity())); + } + + static List<SubmitRequirementResult> createResult( + SubmitRecord record, List<LabelType> labelTypes, ObjectId psCommitId) { + List<SubmitRequirementResult> results; + if (record.ruleName != null && record.ruleName.equals("gerrit~DefaultSubmitRule")) { + results = createFromDefaultSubmitRecord(record.labels, labelTypes, psCommitId); + } else { + results = createFromCustomSubmitRecord(record, psCommitId); + } + logger.atFine().log("Converted submit record %s to submit requirements %s", record, results); + return results; + } + + private static List<SubmitRequirementResult> createFromDefaultSubmitRecord( + List<Label> labels, List<LabelType> labelTypes, ObjectId psCommitId) { + ImmutableList.Builder<SubmitRequirementResult> result = ImmutableList.builder(); + for (Label label : labels) { + LabelType labelType = getLabelType(labelTypes, label.label); + if (!isBlocking(labelType)) { + continue; + } + ImmutableList<String> atoms = toExpressionAtomList(labelType); + SubmitRequirement.Builder req = + SubmitRequirement.builder() + .setName(label.label) + .setSubmittabilityExpression(toExpression(atoms)) + .setAllowOverrideInChildProjects(labelType.isCanOverride()); + result.add( + SubmitRequirementResult.builder() + .legacy(Optional.of(true)) + .submitRequirement(req.build()) + .submittabilityExpressionResult( + createExpressionResult(toExpression(atoms), mapStatus(label), atoms)) + .patchSetCommitId(psCommitId) + .build()); + } + return result.build(); + } + + private static List<SubmitRequirementResult> createFromCustomSubmitRecord( + SubmitRecord record, ObjectId psCommitId) { + String ruleName = record.ruleName != null ? record.ruleName : "Custom-Rule"; + if (record.labels == null || record.labels.isEmpty()) { + SubmitRequirement sr = + SubmitRequirement.builder() + .setName(ruleName) + .setSubmittabilityExpression( + SubmitRequirementExpression.create(String.format("rule:%s", ruleName))) + .setAllowOverrideInChildProjects(false) + .build(); + return ImmutableList.of( + SubmitRequirementResult.builder() + .legacy(Optional.of(true)) + .submitRequirement(sr) + .submittabilityExpressionResult( + createExpressionResult( + sr.submittabilityExpression(), mapStatus(record), ImmutableList.of(ruleName))) + .patchSetCommitId(psCommitId) + .build()); + } + ImmutableList.Builder<SubmitRequirementResult> result = ImmutableList.builder(); + for (Label label : record.labels) { + String expressionString = String.format("label:%s=%s", label.label, ruleName); + SubmitRequirement sr = + SubmitRequirement.builder() + .setName(label.label) + .setSubmittabilityExpression(SubmitRequirementExpression.create(expressionString)) + .setAllowOverrideInChildProjects(false) + .build(); + result.add( + SubmitRequirementResult.builder() + .legacy(Optional.of(true)) + .submitRequirement(sr) + .submittabilityExpressionResult( + createExpressionResult( + sr.submittabilityExpression(), + mapStatus(label), + ImmutableList.of(expressionString))) + .patchSetCommitId(psCommitId) + .build()); + } + return result.build(); + } + + private static boolean isBlocking(LabelType labelType) { + return labelType.getFunction().isBlock() || labelType.getFunction().isRequired(); + } + + private static SubmitRequirementExpression toExpression(List<String> atoms) { + return SubmitRequirementExpression.create(String.join(" ", atoms)); + } + + private static ImmutableList<String> toExpressionAtomList(LabelType lt) { + String ignoreSelfApproval = + lt.isIgnoreSelfApproval() ? ",user=" + ChangeQueryBuilder.ARG_ID_NON_UPLOADER : ""; + switch (lt.getFunction()) { + case MAX_WITH_BLOCK: + return ImmutableList.of( + String.format("label:%s=MAX", lt.getName()) + ignoreSelfApproval, + String.format("-label:%s=MIN", lt.getName())); + case ANY_WITH_BLOCK: + return ImmutableList.of(String.format(String.format("-label:%s=MIN", lt.getName()))); + case MAX_NO_BLOCK: + return ImmutableList.of( + String.format(String.format("label:%s=MAX", lt.getName())) + ignoreSelfApproval); + case NO_BLOCK: + case NO_OP: + case PATCH_SET_LOCK: + default: + return ImmutableList.of(); + } + } + + private static Status mapStatus(Label label) { + SubmitRequirementExpressionResult.Status status = Status.PASS; + switch (label.status) { + case OK: + case MAY: + status = Status.PASS; + break; + case REJECT: + case NEED: + case IMPOSSIBLE: + status = Status.FAIL; + break; + } + return status; + } + + private static Status mapStatus(SubmitRecord submitRecord) { + switch (submitRecord.status) { + case OK: + case CLOSED: + case FORCED: + return Status.PASS; + case NOT_READY: + return Status.FAIL; + case RULE_ERROR: + default: + return Status.ERROR; + } + } + + private static SubmitRequirementExpressionResult createExpressionResult( + SubmitRequirementExpression expression, Status status, ImmutableList<String> atoms) { + return SubmitRequirementExpressionResult.create( + expression, + status, + status == Status.PASS ? atoms : ImmutableList.of(), + status == Status.FAIL ? atoms : ImmutableList.of()); + } + + private static LabelType getLabelType(List<LabelType> labelTypes, String labelName) { + return labelTypes.stream() + .filter(lt -> lt.getName().equals(labelName)) + .collect(MoreCollectors.onlyElement()); + } +}
diff --git a/java/com/google/gerrit/server/project/SubmitRequirementsEvaluator.java b/java/com/google/gerrit/server/project/SubmitRequirementsEvaluator.java new file mode 100644 index 0000000..402bb51 --- /dev/null +++ b/java/com/google/gerrit/server/project/SubmitRequirementsEvaluator.java
@@ -0,0 +1,52 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.project; + +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementExpression; +import com.google.gerrit.entities.SubmitRequirementExpressionResult; +import com.google.gerrit.entities.SubmitRequirementResult; +import com.google.gerrit.index.query.QueryParseException; +import com.google.gerrit.server.query.change.ChangeData; +import java.util.Map; + +public interface SubmitRequirementsEvaluator { + /** + * Evaluate and return all submit requirement results for a change. Submit requirements are read + * from the project config of the project containing the change as well as parent projects. + * + * @param cd change data corresponding to a specific gerrit change + * @param includeLegacy if set to true, evaluate legacy {@link + * com.google.gerrit.entities.SubmitRecord}s and convert them to submit requirements. + */ + Map<SubmitRequirement, SubmitRequirementResult> evaluateAllRequirements( + ChangeData cd, boolean includeLegacy); + + /** Evaluate a single {@link SubmitRequirement} using change data. */ + SubmitRequirementResult evaluateRequirement(SubmitRequirement sr, ChangeData cd); + + /** Evaluate a {@link SubmitRequirementExpression} using change data. */ + SubmitRequirementExpressionResult evaluateExpression( + SubmitRequirementExpression expression, ChangeData changeData); + + /** + * Validate a {@link SubmitRequirementExpression}. Callers who wish to validate submit + * requirements upon creation or update should use this method. + * + * @param expression entity containing the expression string. + * @throws QueryParseException the expression string contains invalid syntax and can't be parsed. + */ + void validateExpression(SubmitRequirementExpression expression) throws QueryParseException; +}
diff --git a/java/com/google/gerrit/server/project/SubmitRequirementsEvaluatorImpl.java b/java/com/google/gerrit/server/project/SubmitRequirementsEvaluatorImpl.java new file mode 100644 index 0000000..cc2c805 --- /dev/null +++ b/java/com/google/gerrit/server/project/SubmitRequirementsEvaluatorImpl.java
@@ -0,0 +1,148 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.project; + +import static com.google.gerrit.server.project.ProjectCache.illegalState; + +import com.google.common.collect.ImmutableMap; +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementExpression; +import com.google.gerrit.entities.SubmitRequirementExpressionResult; +import com.google.gerrit.entities.SubmitRequirementExpressionResult.PredicateResult; +import com.google.gerrit.entities.SubmitRequirementResult; +import com.google.gerrit.index.query.Predicate; +import com.google.gerrit.index.query.QueryParseException; +import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.query.change.SubmitRequirementChangeQueryBuilder; +import com.google.inject.AbstractModule; +import com.google.inject.Inject; +import com.google.inject.Module; +import com.google.inject.Provider; +import com.google.inject.Scopes; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; + +/** Evaluates submit requirements for different change data. */ +public class SubmitRequirementsEvaluatorImpl implements SubmitRequirementsEvaluator { + + private final Provider<SubmitRequirementChangeQueryBuilder> queryBuilder; + private final ProjectCache projectCache; + private final SubmitRuleEvaluator.Factory legacyEvaluator; + + public static Module module() { + return new AbstractModule() { + @Override + protected void configure() { + bind(SubmitRequirementsEvaluator.class) + .to(SubmitRequirementsEvaluatorImpl.class) + .in(Scopes.SINGLETON); + } + }; + } + + @Inject + private SubmitRequirementsEvaluatorImpl( + Provider<SubmitRequirementChangeQueryBuilder> queryBuilder, + ProjectCache projectCache, + SubmitRuleEvaluator.Factory legacyEvaluator) { + this.queryBuilder = queryBuilder; + this.projectCache = projectCache; + this.legacyEvaluator = legacyEvaluator; + } + + @Override + public void validateExpression(SubmitRequirementExpression expression) + throws QueryParseException { + queryBuilder.get().parse(expression.expressionString()); + } + + @Override + public Map<SubmitRequirement, SubmitRequirementResult> evaluateAllRequirements( + ChangeData cd, boolean includeLegacy) { + Map<SubmitRequirement, SubmitRequirementResult> projectConfigRequirements = getRequirements(cd); + Map<SubmitRequirement, SubmitRequirementResult> result = projectConfigRequirements; + if (includeLegacy) { + Map<SubmitRequirement, SubmitRequirementResult> legacyReqs = + SubmitRequirementsAdapter.getLegacyRequirements(legacyEvaluator, cd); + result = + SubmitRequirementsUtil.mergeLegacyAndNonLegacyRequirements( + projectConfigRequirements, legacyReqs); + } + return ImmutableMap.copyOf(result); + } + + @Override + public SubmitRequirementResult evaluateRequirement(SubmitRequirement sr, ChangeData cd) { + SubmitRequirementExpressionResult blockingResult = + evaluateExpression(sr.submittabilityExpression(), cd); + + Optional<SubmitRequirementExpressionResult> applicabilityResult = + sr.applicabilityExpression().isPresent() + ? Optional.of(evaluateExpression(sr.applicabilityExpression().get(), cd)) + : Optional.empty(); + + Optional<SubmitRequirementExpressionResult> overrideResult = + sr.overrideExpression().isPresent() + ? Optional.of(evaluateExpression(sr.overrideExpression().get(), cd)) + : Optional.empty(); + + return SubmitRequirementResult.builder() + .legacy(Optional.of(false)) + .submitRequirement(sr) + .patchSetCommitId(cd.currentPatchSet().commitId()) + .submittabilityExpressionResult(blockingResult) + .applicabilityExpressionResult(applicabilityResult) + .overrideExpressionResult(overrideResult) + .build(); + } + + @Override + public SubmitRequirementExpressionResult evaluateExpression( + SubmitRequirementExpression expression, ChangeData changeData) { + try { + Predicate<ChangeData> predicate = queryBuilder.get().parse(expression.expressionString()); + PredicateResult predicateResult = evaluatePredicateTree(predicate, changeData); + return SubmitRequirementExpressionResult.create(expression, predicateResult); + } catch (QueryParseException e) { + return SubmitRequirementExpressionResult.error(expression, e.getMessage()); + } + } + + /** Evaluate and return submit requirements stored in this project's config and its parents. */ + private Map<SubmitRequirement, SubmitRequirementResult> getRequirements(ChangeData cd) { + ProjectState state = projectCache.get(cd.project()).orElseThrow(illegalState(cd.project())); + Map<String, SubmitRequirement> requirements = state.getSubmitRequirements(); + Map<SubmitRequirement, SubmitRequirementResult> result = new HashMap<>(); + for (SubmitRequirement requirement : requirements.values()) { + result.put(requirement, evaluateRequirement(requirement, cd)); + } + return result; + } + + /** Evaluate the predicate recursively using change data. */ + private PredicateResult evaluatePredicateTree( + Predicate<ChangeData> predicate, ChangeData changeData) { + PredicateResult.Builder predicateResult = + PredicateResult.builder() + .predicateString(predicate.isLeaf() ? predicate.getPredicateString() : "") + .status(predicate.asMatchable().match(changeData)); + predicate + .getChildren() + .forEach( + c -> predicateResult.addChildPredicateResult(evaluatePredicateTree(c, changeData))); + return predicateResult.build(); + } +}
diff --git a/java/com/google/gerrit/server/project/SubmitRequirementsUtil.java b/java/com/google/gerrit/server/project/SubmitRequirementsUtil.java new file mode 100644 index 0000000..102d3f2 --- /dev/null +++ b/java/com/google/gerrit/server/project/SubmitRequirementsUtil.java
@@ -0,0 +1,71 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.project; + +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementResult; +import java.util.HashMap; +import java.util.Map; +import java.util.stream.Collectors; + +/** + * A utility class for different operations related to {@link + * com.google.gerrit.entities.SubmitRequirement}s. + */ +public class SubmitRequirementsUtil { + + private SubmitRequirementsUtil() {} + + /** + * Merge legacy and non-legacy submit requirement results. If both input maps have submit + * requirements with the same name and fulfillment status (according to {@link + * SubmitRequirementResult#fulfilled()}), we eliminate the entry from the {@code + * legacyRequirements} input map and only include the one from the {@code + * projectConfigRequirements} in the result. + * + * @param projectConfigRequirements map of {@link SubmitRequirement} to {@link + * SubmitRequirementResult} containing results for submit requirements stored in the + * project.config. + * @param legacyRequirements map of {@link SubmitRequirement} to {@link SubmitRequirementResult} + * containing the results of converting legacy submit records to submit requirements. + * @return a map that is the result of merging both input maps, while eliminating requirements + * with the same name and status. + */ + public static Map<SubmitRequirement, SubmitRequirementResult> mergeLegacyAndNonLegacyRequirements( + Map<SubmitRequirement, SubmitRequirementResult> projectConfigRequirements, + Map<SubmitRequirement, SubmitRequirementResult> legacyRequirements) { + Map<SubmitRequirement, SubmitRequirementResult> result = new HashMap<>(); + result.putAll(projectConfigRequirements); + Map<String, SubmitRequirementResult> requirementsByName = + projectConfigRequirements.entrySet().stream() + .collect(Collectors.toMap(sr -> sr.getKey().name().toLowerCase(), sr -> sr.getValue())); + for (Map.Entry<SubmitRequirement, SubmitRequirementResult> legacy : + legacyRequirements.entrySet()) { + String name = legacy.getKey().name().toLowerCase(); + SubmitRequirementResult projectConfigResult = requirementsByName.get(name); + SubmitRequirementResult legacyResult = legacy.getValue(); + if (projectConfigResult != null && matchByStatus(projectConfigResult, legacyResult)) { + continue; + } + result.put(legacy.getKey(), legacy.getValue()); + } + return result; + } + + /** Returns true if both input results are equal in allowing/disallowing change submission. */ + private static boolean matchByStatus(SubmitRequirementResult r1, SubmitRequirementResult r2) { + return r1.fulfilled() == r2.fulfilled(); + } +}
diff --git a/java/com/google/gerrit/server/project/SubmitRuleEvaluator.java b/java/com/google/gerrit/server/project/SubmitRuleEvaluator.java index a7659d4..84d91a4 100644 --- a/java/com/google/gerrit/server/project/SubmitRuleEvaluator.java +++ b/java/com/google/gerrit/server/project/SubmitRuleEvaluator.java
@@ -15,23 +15,29 @@ package com.google.gerrit.server.project; import static com.google.common.collect.ImmutableList.toImmutableList; -import static com.google.gerrit.server.project.ProjectCache.noSuchProject; import com.google.common.collect.Streams; +import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.Project; import com.google.gerrit.entities.SubmitRecord; import com.google.gerrit.entities.SubmitTypeRecord; import com.google.gerrit.exceptions.StorageException; +import com.google.gerrit.extensions.api.changes.ChangeApi; import com.google.gerrit.metrics.Description; import com.google.gerrit.metrics.Description.Units; import com.google.gerrit.metrics.MetricMaker; import com.google.gerrit.metrics.Timer0; +import com.google.gerrit.server.change.ChangeJson; import com.google.gerrit.server.index.OnlineReindexMode; +import com.google.gerrit.server.logging.CallerFinder; import com.google.gerrit.server.plugincontext.PluginSetContext; import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.rules.DefaultSubmitRule; import com.google.gerrit.server.rules.PrologRule; import com.google.gerrit.server.rules.SubmitRule; import com.google.inject.Inject; +import com.google.inject.Singleton; import com.google.inject.assistedinject.Assisted; import java.util.List; import java.util.Optional; @@ -41,42 +47,63 @@ * the results through rules found in the parent projects, all the way up to All-Projects. */ public class SubmitRuleEvaluator { - private final ProjectCache projectCache; - private final PrologRule prologRule; - private final PluginSetContext<SubmitRule> submitRules; - private final Timer0 submitRuleEvaluationLatency; - private final Timer0 submitTypeEvaluationLatency; - private final SubmitRuleOptions opts; + private static final FluentLogger logger = FluentLogger.forEnclosingClass(); public interface Factory { /** Returns a new {@link SubmitRuleEvaluator} with the specified options */ SubmitRuleEvaluator create(SubmitRuleOptions options); } + @Singleton + private static class Metrics { + final Timer0 submitRuleEvaluationLatency; + final Timer0 submitTypeEvaluationLatency; + + @Inject + Metrics(MetricMaker metricMaker) { + submitRuleEvaluationLatency = + metricMaker.newTimer( + "change/submit_rule_evaluation", + new Description("Latency for evaluating submit rules on a change.") + .setCumulative() + .setUnit(Units.MILLISECONDS)); + submitTypeEvaluationLatency = + metricMaker.newTimer( + "change/submit_type_evaluation", + new Description("Latency for evaluating the submit type on a change.") + .setCumulative() + .setUnit(Units.MILLISECONDS)); + } + } + + private final ProjectCache projectCache; + private final PrologRule prologRule; + private final PluginSetContext<SubmitRule> submitRules; + private final Metrics metrics; + private final SubmitRuleOptions opts; + private final CallerFinder callerFinder; + @Inject private SubmitRuleEvaluator( ProjectCache projectCache, PrologRule prologRule, PluginSetContext<SubmitRule> submitRules, - MetricMaker metricMaker, + Metrics metrics, @Assisted SubmitRuleOptions options) { this.projectCache = projectCache; this.prologRule = prologRule; this.submitRules = submitRules; - this.submitRuleEvaluationLatency = - metricMaker.newTimer( - "change/submit_rule_evaluation", - new Description("Latency for evaluating submit rules on a change.") - .setCumulative() - .setUnit(Units.MILLISECONDS)); - this.submitTypeEvaluationLatency = - metricMaker.newTimer( - "change/submit_type_evaluation", - new Description("Latency for evaluating the submit type on a change.") - .setCumulative() - .setUnit(Units.MILLISECONDS)); + this.metrics = metrics; this.opts = options; + + this.callerFinder = + CallerFinder.builder() + .addTarget(ChangeApi.class) + .addTarget(ChangeJson.class) + .addTarget(ChangeData.class) + .addTarget(SubmitRequirementsEvaluatorImpl.class) + .build(); } /** @@ -87,15 +114,24 @@ * @param cd ChangeData to evaluate */ public List<SubmitRecord> evaluate(ChangeData cd) { - try (Timer0.Context ignored = submitRuleEvaluationLatency.start()) { + logger.atFine().log( + "Evaluate submit rules for change %d (caller: %s)", + cd.change().getId().get(), callerFinder.findCallerLazy()); + try (Timer0.Context ignored = metrics.submitRuleEvaluationLatency.start()) { Change change; + ProjectState projectState; try { change = cd.change(); if (change == null) { throw new StorageException("Change not found"); } - projectCache.get(cd.project()).orElseThrow(noSuchProject(cd.project())); + Project.NameKey name = cd.project(); + Optional<ProjectState> projectStateOptional = projectCache.get(name); + if (!projectStateOptional.isPresent()) { + throw new NoSuchProjectException(name); + } + projectState = projectStateOptional.get(); } catch (NoSuchProjectException e) { throw new IllegalStateException("Unable to find project while evaluating submit rule", e); } @@ -117,7 +153,23 @@ // We evaluate all the plugin-defined evaluators, // and then we collect the results in one list. return Streams.stream(submitRules) - .map(c -> c.call(s -> s.evaluate(cd))) + // Skip evaluating the default submit rule if the project has prolog rules. + // Note that in this case, the prolog submit rule will handle labels for us + .filter( + projectState.hasPrologRules() + ? rule -> !(rule.get() instanceof DefaultSubmitRule) + : rule -> true) + .map( + c -> + c.call( + s -> { + Optional<SubmitRecord> evaluate = s.evaluate(cd); + if (evaluate.isPresent()) { + evaluate.get().ruleName = + c.getPluginName() + "~" + s.getClass().getSimpleName(); + } + return evaluate; + })) .filter(Optional::isPresent) .map(Optional::get) .collect(toImmutableList()); @@ -128,12 +180,15 @@ * Evaluate the submit type rules to get the submit type. * * @return record from the evaluated rules. - * @param cd */ public SubmitTypeRecord getSubmitType(ChangeData cd) { - try (Timer0.Context ignored = submitTypeEvaluationLatency.start()) { + try (Timer0.Context ignored = metrics.submitTypeEvaluationLatency.start()) { try { - projectCache.get(cd.project()).orElseThrow(noSuchProject(cd.project())); + Project.NameKey name = cd.project(); + Optional<ProjectState> project = projectCache.get(name); + if (!project.isPresent()) { + throw new NoSuchProjectException(name); + } } catch (NoSuchProjectException e) { throw new IllegalStateException("Unable to find project while evaluating submit rule", e); }
diff --git a/java/com/google/gerrit/server/query/account/AccountPredicates.java b/java/com/google/gerrit/server/query/account/AccountPredicates.java index e4da946..8f94089 100644 --- a/java/com/google/gerrit/server/query/account/AccountPredicates.java +++ b/java/com/google/gerrit/server/query/account/AccountPredicates.java
@@ -21,7 +21,6 @@ import com.google.gerrit.index.FieldDef; import com.google.gerrit.index.Schema; import com.google.gerrit.index.query.IndexPredicate; -import com.google.gerrit.index.query.Matchable; import com.google.gerrit.index.query.Predicate; import com.google.gerrit.index.query.QueryBuilder; import com.google.gerrit.server.account.AccountState; @@ -132,8 +131,7 @@ } /** Predicate that is mapped to a field in the account index. */ - static class AccountPredicate extends IndexPredicate<AccountState> - implements Matchable<AccountState> { + static class AccountPredicate extends IndexPredicate<AccountState> { AccountPredicate(FieldDef<AccountState, ?> def, String value) { super(def, value); } @@ -141,16 +139,6 @@ AccountPredicate(FieldDef<AccountState, ?> def, String name, String value) { super(def, name, value); } - - @Override - public boolean match(AccountState object) { - return true; - } - - @Override - public int getCost() { - return 1; - } } private AccountPredicates() {}
diff --git a/java/com/google/gerrit/server/query/account/AccountQueryProcessor.java b/java/com/google/gerrit/server/query/account/AccountQueryProcessor.java index 9893d1a..d812eef 100644 --- a/java/com/google/gerrit/server/query/account/AccountQueryProcessor.java +++ b/java/com/google/gerrit/server/query/account/AccountQueryProcessor.java
@@ -17,6 +17,7 @@ import static com.google.common.base.Preconditions.checkState; import static com.google.gerrit.server.query.account.AccountQueryBuilder.FIELD_LIMIT; +import com.google.common.collect.ImmutableList; import com.google.gerrit.index.IndexConfig; import com.google.gerrit.index.query.AndSource; import com.google.gerrit.index.query.IndexPredicate; @@ -33,6 +34,7 @@ import com.google.gerrit.server.notedb.Sequences; import com.google.inject.Inject; import com.google.inject.Provider; +import com.google.inject.Singleton; /** * Query processor for the account index. @@ -45,6 +47,14 @@ private final Sequences sequences; private final IndexConfig indexConfig; + @Singleton + protected static class AccountQueryMetrics extends QueryProcessor.Metrics { + @Inject + protected AccountQueryMetrics(MetricMaker metricMaker) { + super(metricMaker); + } + } + static { // It is assumed that basic rewrites do not touch visibleto predicates. checkState( @@ -56,14 +66,14 @@ protected AccountQueryProcessor( Provider<CurrentUser> userProvider, AccountLimits.Factory limitsFactory, - MetricMaker metricMaker, + AccountQueryMetrics accountQueryMetrics, IndexConfig indexConfig, AccountIndexCollection indexes, AccountIndexRewriter rewriter, AccountControl.Factory accountControlFactory, Sequences sequences) { super( - metricMaker, + accountQueryMetrics, AccountSchemaDefinitions.INSTANCE, indexConfig, indexes, @@ -78,7 +88,9 @@ @Override protected Predicate<AccountState> enforceVisibility(Predicate<AccountState> pred) { return new AndSource<>( - pred, new AccountIsVisibleToPredicate(accountControlFactory.get()), start, indexConfig); + ImmutableList.of(pred, new AccountIsVisibleToPredicate(accountControlFactory.get())), + start, + indexConfig); } @Override
diff --git a/java/com/google/gerrit/server/query/account/InternalAccountQuery.java b/java/com/google/gerrit/server/query/account/InternalAccountQuery.java index 091edca..1d67009 100644 --- a/java/com/google/gerrit/server/query/account/InternalAccountQuery.java +++ b/java/com/google/gerrit/server/query/account/InternalAccountQuery.java
@@ -31,6 +31,7 @@ import com.google.gerrit.index.query.InternalQuery; import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.index.account.AccountField; import com.google.gerrit.server.index.account.AccountIndexCollection; import com.google.inject.Inject; @@ -46,20 +47,24 @@ public class InternalAccountQuery extends InternalQuery<AccountState, InternalAccountQuery> { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + private final ExternalIdKeyFactory externalIdKeyFactory; + @Inject InternalAccountQuery( AccountQueryProcessor queryProcessor, AccountIndexCollection indexes, - IndexConfig indexConfig) { + IndexConfig indexConfig, + ExternalIdKeyFactory externalIdKeyFactory) { super(queryProcessor, indexes, indexConfig); + this.externalIdKeyFactory = externalIdKeyFactory; } - public List<AccountState> byDefault(String query) { - return query(AccountPredicates.defaultPredicate(schema(), true, query)); + public List<AccountState> byDefault(String query, boolean canSeeSecondaryEmails) { + return query(AccountPredicates.defaultPredicate(schema(), canSeeSecondaryEmails, query)); } public List<AccountState> byExternalId(String scheme, String id) { - return byExternalId(ExternalId.Key.create(scheme, id)); + return byExternalId(externalIdKeyFactory.create(scheme, id)); } public List<AccountState> byExternalId(ExternalId.Key externalId) {
diff --git a/java/com/google/gerrit/server/query/approval/ApprovalContext.java b/java/com/google/gerrit/server/query/approval/ApprovalContext.java new file mode 100644 index 0000000..4dedbb5 --- /dev/null +++ b/java/com/google/gerrit/server/query/approval/ApprovalContext.java
@@ -0,0 +1,59 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.approval; + +import static com.google.common.base.Preconditions.checkState; + +import com.google.auto.value.AutoValue; +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.entities.PatchSetApproval; +import com.google.gerrit.extensions.client.ChangeKind; +import com.google.gerrit.server.notedb.ChangeNotes; + +/** Entity representing all required information to match predicates for copying approvals. */ +@AutoValue +public abstract class ApprovalContext { + /** Approval on the source patch set to be copied. */ + public abstract PatchSetApproval patchSetApproval(); + + /** + * Target change and patch set for the approval. This must be used instead of getting the PatchSet + * from {@link #changeNotes()} because it is possible we are now creating the patch-set, so it + * doesn't exist in changeNotes yet. + */ + public abstract PatchSet target(); + + /** {@link ChangeNotes} of the change in question. */ + public abstract ChangeNotes changeNotes(); + + /** {@link ChangeKind} of the delta between the origin and target patch set. */ + public abstract ChangeKind changeKind(); + + public static ApprovalContext create( + ChangeNotes changeNotes, PatchSetApproval psa, PatchSet patchSet, ChangeKind changeKind) { + checkState( + psa.patchSetId().changeId().equals(patchSet.id().changeId()), + "approval and target must be the same change. got: %s, %s", + psa.patchSetId(), + patchSet.id()); + // TODO(ekempin): Use checkState to verify that psa.patchSetId().get() + 1 == id.get() so that + // it's ensured that approvals are only copied to the next consecutive patch set. To add back + // this verification https://gerrit-review.googlesource.com/c/gerrit/+/312633 can be reverted. + // As explained in the commit message of this change doing this check is only possible if there + // are no changes with gaps in patch set numbers. Since it's planned to fix-up old changes with + // gaps in patch set numbers, this todo is a reminder to add back the check once this is done. + return new AutoValue_ApprovalContext(psa, patchSet, changeNotes, changeKind); + } +}
diff --git a/java/com/google/gerrit/server/api/groups/Module.java b/java/com/google/gerrit/server/query/approval/ApprovalModule.java similarity index 68% copy from java/com/google/gerrit/server/api/groups/Module.java copy to java/com/google/gerrit/server/query/approval/ApprovalModule.java index 7d7af4e..ff4d5ad 100644 --- a/java/com/google/gerrit/server/api/groups/Module.java +++ b/java/com/google/gerrit/server/query/approval/ApprovalModule.java
@@ -1,4 +1,4 @@ -// Copyright (C) 2015 The Android Open Source Project +// Copyright (C) 2021 The Android Open Source Project // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,16 +12,16 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.server.api.groups; +package com.google.gerrit.server.query.approval; -import com.google.gerrit.extensions.api.groups.Groups; import com.google.gerrit.extensions.config.FactoryModule; -public class Module extends FactoryModule { +/** Module to bind logic related to approval copying. */ +public class ApprovalModule extends FactoryModule { + @Override protected void configure() { - bind(Groups.class).to(GroupsImpl.class); - - factory(GroupApiImpl.Factory.class); + factory(MagicValuePredicate.Factory.class); + factory(UserInPredicate.Factory.class); } }
diff --git a/java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java b/java/com/google/gerrit/server/query/approval/ApprovalPredicate.java similarity index 60% copy from java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java copy to java/com/google/gerrit/server/query/approval/ApprovalPredicate.java index 6451b0f..a6f8153 100644 --- a/java/com/google/gerrit/elasticsearch/bulk/DeleteRequest.java +++ b/java/com/google/gerrit/server/query/approval/ApprovalPredicate.java
@@ -1,4 +1,4 @@ -// Copyright (C) 2018 The Android Open Source Project +// Copyright (C) 2021 The Android Open Source Project // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -12,11 +12,15 @@ // See the License for the specific language governing permissions and // limitations under the License. -package com.google.gerrit.elasticsearch.bulk; +package com.google.gerrit.server.query.approval; -public class DeleteRequest extends ActionRequest { +import com.google.gerrit.index.query.Matchable; +import com.google.gerrit.index.query.Predicate; - public DeleteRequest(String id, String index) { - super("delete", id, index); +public abstract class ApprovalPredicate extends Predicate<ApprovalContext> + implements Matchable<ApprovalContext> { + @Override + public int getCost() { + return 1; } }
diff --git a/java/com/google/gerrit/server/query/approval/ApprovalQueryBuilder.java b/java/com/google/gerrit/server/query/approval/ApprovalQueryBuilder.java new file mode 100644 index 0000000..819f319 --- /dev/null +++ b/java/com/google/gerrit/server/query/approval/ApprovalQueryBuilder.java
@@ -0,0 +1,104 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.approval; + +import com.google.gerrit.entities.AccountGroup; +import com.google.gerrit.entities.GroupDescription; +import com.google.gerrit.extensions.client.ChangeKind; +import com.google.gerrit.index.query.Predicate; +import com.google.gerrit.index.query.QueryBuilder; +import com.google.gerrit.index.query.QueryParseException; +import com.google.gerrit.server.account.GroupControl; +import com.google.gerrit.server.group.GroupResolver; +import com.google.inject.Inject; +import java.util.Arrays; + +public class ApprovalQueryBuilder extends QueryBuilder<ApprovalContext, ApprovalQueryBuilder> { + private static final QueryBuilder.Definition<ApprovalContext, ApprovalQueryBuilder> mydef = + new QueryBuilder.Definition<>(ApprovalQueryBuilder.class); + + private final MagicValuePredicate.Factory magicValuePredicate; + private final UserInPredicate.Factory userInPredicate; + private final GroupResolver groupResolver; + private final GroupControl.Factory groupControl; + private final ListOfFilesUnchangedPredicate listOfFilesUnchangedPredicate; + + @Inject + protected ApprovalQueryBuilder( + MagicValuePredicate.Factory magicValuePredicate, + UserInPredicate.Factory userInPredicate, + GroupResolver groupResolver, + GroupControl.Factory groupControl, + ListOfFilesUnchangedPredicate listOfFilesUnchangedPredicate) { + super(mydef, null); + this.magicValuePredicate = magicValuePredicate; + this.userInPredicate = userInPredicate; + this.groupResolver = groupResolver; + this.groupControl = groupControl; + this.listOfFilesUnchangedPredicate = listOfFilesUnchangedPredicate; + } + + @Operator + public Predicate<ApprovalContext> changekind(String term) throws QueryParseException { + return new ChangeKindPredicate(toEnumValue(ChangeKind.class, term)); + } + + @Operator + public Predicate<ApprovalContext> is(String term) throws QueryParseException { + return magicValuePredicate.create(toEnumValue(MagicValuePredicate.MagicValue.class, term)); + } + + @Operator + public Predicate<ApprovalContext> approverin(String group) throws QueryParseException { + return userInPredicate.create(UserInPredicate.Field.APPROVER, parseGroupOrThrow(group)); + } + + @Operator + public Predicate<ApprovalContext> uploaderin(String group) throws QueryParseException { + return userInPredicate.create(UserInPredicate.Field.UPLOADER, parseGroupOrThrow(group)); + } + + @Operator + public Predicate<ApprovalContext> has(String value) throws QueryParseException { + if (value.equals("unchanged-files")) { + return listOfFilesUnchangedPredicate; + } + throw error( + String.format( + "'%s' is not a supported argument for has. only 'unchanged-files' is supported", + value)); + } + + private static <T extends Enum<T>> T toEnumValue(Class<T> clazz, String term) + throws QueryParseException { + try { + return Enum.valueOf(clazz, term.toUpperCase().replace('-', '_')); + } catch (IllegalArgumentException e) { + throw new QueryParseException( + String.format( + "%s is not a valid term. valid options: %s", + term, Arrays.asList(clazz.getEnumConstants())), + e); + } + } + + private AccountGroup.UUID parseGroupOrThrow(String maybeUUID) throws QueryParseException { + GroupDescription.Basic g = groupResolver.parseId(maybeUUID); + if (g == null || !groupControl.controlFor(g).isVisible()) { + throw error("Group " + maybeUUID + " not found"); + } + return g.getGroupUUID(); + } +}
diff --git a/java/com/google/gerrit/server/query/approval/ChangeKindPredicate.java b/java/com/google/gerrit/server/query/approval/ChangeKindPredicate.java new file mode 100644 index 0000000..78711fd --- /dev/null +++ b/java/com/google/gerrit/server/query/approval/ChangeKindPredicate.java
@@ -0,0 +1,56 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.approval; + +import com.google.gerrit.extensions.client.ChangeKind; +import com.google.gerrit.index.query.Predicate; +import java.util.Collection; +import java.util.Objects; + +/** + * Predicate that matches patch set approvals we want to copy if the diff between the old and new + * patch set is of a certain kind. + */ +public class ChangeKindPredicate extends ApprovalPredicate { + private final ChangeKind changeKind; + + ChangeKindPredicate(ChangeKind changeKind) { + this.changeKind = changeKind; + } + + @Override + public boolean match(ApprovalContext ctx) { + return ctx.changeKind().equals(changeKind); + } + + @Override + public Predicate<ApprovalContext> copy( + Collection<? extends Predicate<ApprovalContext>> children) { + return new ChangeKindPredicate(changeKind); + } + + @Override + public int hashCode() { + return Objects.hash(changeKind); + } + + @Override + public boolean equals(Object other) { + if (!(other instanceof ChangeKindPredicate)) { + return false; + } + return ((ChangeKindPredicate) other).changeKind.equals(changeKind); + } +}
diff --git a/java/com/google/gerrit/server/query/approval/ListOfFilesUnchangedPredicate.java b/java/com/google/gerrit/server/query/approval/ListOfFilesUnchangedPredicate.java new file mode 100644 index 0000000..de7dd0a --- /dev/null +++ b/java/com/google/gerrit/server/query/approval/ListOfFilesUnchangedPredicate.java
@@ -0,0 +1,143 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.approval; + +import com.google.gerrit.entities.Patch; +import com.google.gerrit.entities.Patch.ChangeType; +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.entities.Project; +import com.google.gerrit.exceptions.StorageException; +import com.google.gerrit.index.query.Predicate; +import com.google.gerrit.server.git.GitRepositoryManager; +import com.google.gerrit.server.patch.DiffNotAvailableException; +import com.google.gerrit.server.patch.DiffOperations; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; +import com.google.inject.Inject; +import com.google.inject.Singleton; +import java.io.IOException; +import java.util.Collection; +import java.util.HashSet; +import java.util.Map; +import java.util.Objects; +import java.util.Set; +import org.eclipse.jgit.lib.ObjectId; +import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.revwalk.RevWalk; + +/** Predicate that matches when the new patch-set includes the same files as the old patch-set. */ +@Singleton +public class ListOfFilesUnchangedPredicate extends ApprovalPredicate { + private final DiffOperations diffOperations; + private final GitRepositoryManager repositoryManager; + + @Inject + public ListOfFilesUnchangedPredicate( + DiffOperations diffOperations, GitRepositoryManager repositoryManager) { + this.diffOperations = diffOperations; + this.repositoryManager = repositoryManager; + } + + @Override + public boolean match(ApprovalContext ctx) { + PatchSet targetPatchSet = ctx.target(); + PatchSet sourcePatchSet = + ctx.changeNotes().getPatchSets().get(ctx.patchSetApproval().patchSetId()); + + Integer parentNum = + isInitialCommit(ctx.changeNotes().getProjectName(), targetPatchSet.commitId()) ? 0 : 1; + try { + Map<String, FileDiffOutput> baseVsCurrent = + diffOperations.listModifiedFilesAgainstParent( + ctx.changeNotes().getProjectName(), targetPatchSet.commitId(), parentNum); + Map<String, FileDiffOutput> baseVsPrior = + diffOperations.listModifiedFilesAgainstParent( + ctx.changeNotes().getProjectName(), sourcePatchSet.commitId(), parentNum); + Map<String, FileDiffOutput> priorVsCurrent = + diffOperations.listModifiedFiles( + ctx.changeNotes().getProjectName(), + sourcePatchSet.commitId(), + targetPatchSet.commitId()); + return match(baseVsCurrent, baseVsPrior, priorVsCurrent); + } catch (DiffNotAvailableException ex) { + throw new StorageException( + "failed to compute difference in files, so won't copy" + + " votes on labels even if list of files is the same and " + + "copyAllIfListOfFilesDidNotChange", + ex); + } + } + + /** + * returns {@code true} if the files that were modified are the same in both inputs, and the + * {@link ChangeType} matches for each modified file. + */ + public boolean match( + Map<String, FileDiffOutput> baseVsCurrent, + Map<String, FileDiffOutput> baseVsPrior, + Map<String, FileDiffOutput> priorVsCurrent) { + Set<String> allFiles = new HashSet<>(); + allFiles.addAll(baseVsCurrent.keySet()); + allFiles.addAll(baseVsPrior.keySet()); + for (String file : allFiles) { + if (Patch.isMagic(file)) { + continue; + } + FileDiffOutput fileDiffOutput1 = baseVsCurrent.get(file); + FileDiffOutput fileDiffOutput2 = baseVsPrior.get(file); + if (!priorVsCurrent.containsKey(file)) { + // If the file is not modified between prior and current patchsets, then scan safely skip + // it. The file might has been modified due to rebase. + continue; + } + if (fileDiffOutput1 == null || fileDiffOutput2 == null) { + return false; + } + if (!fileDiffOutput2.changeType().equals(fileDiffOutput1.changeType())) { + return false; + } + } + return true; + } + + public boolean isInitialCommit(Project.NameKey project, ObjectId objectId) { + try (Repository repo = repositoryManager.openRepository(project); + RevWalk revWalk = new RevWalk(repo)) { + return revWalk.parseCommit(objectId).getParentCount() == 0; + } catch (IOException ex) { + throw new StorageException(ex); + } + } + + @Override + public Predicate<ApprovalContext> copy( + Collection<? extends Predicate<ApprovalContext>> children) { + return new ListOfFilesUnchangedPredicate(diffOperations, repositoryManager); + } + + @Override + public int hashCode() { + return Objects.hash(diffOperations, repositoryManager); + } + + @Override + public boolean equals(Object other) { + if (!(other instanceof ListOfFilesUnchangedPredicate)) { + return false; + } + ListOfFilesUnchangedPredicate o = (ListOfFilesUnchangedPredicate) other; + return Objects.equals(o.diffOperations, diffOperations) + && Objects.equals(o.repositoryManager, repositoryManager); + } +}
diff --git a/java/com/google/gerrit/server/query/approval/MagicValuePredicate.java b/java/com/google/gerrit/server/query/approval/MagicValuePredicate.java new file mode 100644 index 0000000..326620d --- /dev/null +++ b/java/com/google/gerrit/server/query/approval/MagicValuePredicate.java
@@ -0,0 +1,101 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.approval; + +import com.google.gerrit.entities.LabelId; +import com.google.gerrit.entities.LabelType; +import com.google.gerrit.entities.Project; +import com.google.gerrit.index.query.Predicate; +import com.google.gerrit.server.project.ProjectCache; +import com.google.inject.Inject; +import com.google.inject.assistedinject.Assisted; +import java.util.Collection; +import java.util.Objects; +import java.util.Optional; + +/** Predicate that matches patch set approvals we want to copy based on the value. */ +public class MagicValuePredicate extends ApprovalPredicate { + enum MagicValue { + MIN, + MAX, + ANY + } + + public interface Factory { + MagicValuePredicate create(MagicValue value); + } + + private final MagicValue value; + private final ProjectCache projectCache; + + @Inject + MagicValuePredicate(ProjectCache projectCache, @Assisted MagicValue value) { + this.projectCache = projectCache; + this.value = value; + } + + @Override + public boolean match(ApprovalContext ctx) { + Optional<LabelType> lt = + getLabelType(ctx.changeNotes().getProjectName(), ctx.patchSetApproval().labelId()); + short pValue; + switch (value) { + case ANY: + return true; + case MIN: + if (!lt.isPresent()) { + return false; + } + pValue = lt.get().getMaxNegative(); + break; + case MAX: + if (!lt.isPresent()) { + return false; + } + pValue = lt.get().getMaxPositive(); + break; + default: + throw new IllegalArgumentException("unrecognized label value: " + value); + } + return pValue == ctx.patchSetApproval().value(); + } + + private Optional<LabelType> getLabelType(Project.NameKey project, LabelId labelId) { + return projectCache + .get(project) + .orElseThrow(() -> new IllegalStateException(project + " absent")) + .getLabelTypes() + .byLabel(labelId); + } + + @Override + public Predicate<ApprovalContext> copy( + Collection<? extends Predicate<ApprovalContext>> children) { + return new MagicValuePredicate(projectCache, value); + } + + @Override + public int hashCode() { + return Objects.hash(value); + } + + @Override + public boolean equals(Object other) { + if (!(other instanceof MagicValuePredicate)) { + return false; + } + return ((MagicValuePredicate) other).value.equals(value); + } +}
diff --git a/java/com/google/gerrit/server/query/approval/UserInPredicate.java b/java/com/google/gerrit/server/query/approval/UserInPredicate.java new file mode 100644 index 0000000..ac6720d --- /dev/null +++ b/java/com/google/gerrit/server/query/approval/UserInPredicate.java
@@ -0,0 +1,71 @@ +package com.google.gerrit.server.query.approval; + +import com.google.gerrit.entities.Account; +import com.google.gerrit.entities.AccountGroup; +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.index.query.Predicate; +import com.google.gerrit.server.IdentifiedUser; +import com.google.inject.Inject; +import com.google.inject.assistedinject.Assisted; +import java.util.Collection; +import java.util.Objects; + +/** Predicate that matches group memberships of users such as uploader or approver. */ +public class UserInPredicate extends ApprovalPredicate { + interface Factory { + UserInPredicate create(Field field, AccountGroup.UUID group); + } + + enum Field { + UPLOADER, + APPROVER + } + + private final IdentifiedUser.GenericFactory identifiedUserFactory; + private final Field field; + private final AccountGroup.UUID group; + + @Inject + UserInPredicate( + IdentifiedUser.GenericFactory identifiedUserFactory, + @Assisted Field field, + @Assisted AccountGroup.UUID group) { + this.identifiedUserFactory = identifiedUserFactory; + this.field = field; + this.group = group; + } + + @Override + public boolean match(ApprovalContext ctx) { + Account.Id accountId; + if (field == Field.UPLOADER) { + PatchSet patchSet = ctx.target(); + accountId = patchSet.uploader(); + } else if (field == Field.APPROVER) { + accountId = ctx.patchSetApproval().accountId(); + } else { + throw new IllegalStateException("unknown field in group membership check: " + field); + } + return identifiedUserFactory.create(accountId).getEffectiveGroups().contains(group); + } + + @Override + public Predicate<ApprovalContext> copy( + Collection<? extends Predicate<ApprovalContext>> children) { + return new UserInPredicate(identifiedUserFactory, field, group); + } + + @Override + public int hashCode() { + return Objects.hash(field, group); + } + + @Override + public boolean equals(Object other) { + if (!(other instanceof UserInPredicate)) { + return false; + } + UserInPredicate o = (UserInPredicate) other; + return Objects.equals(o.field, field) && Objects.equals(o.group, group); + } +}
diff --git a/java/com/google/gerrit/server/query/change/AndChangeSource.java b/java/com/google/gerrit/server/query/change/AndChangeSource.java index 98cada3..e4f768e 100644 --- a/java/com/google/gerrit/server/query/change/AndChangeSource.java +++ b/java/com/google/gerrit/server/query/change/AndChangeSource.java
@@ -16,7 +16,6 @@ import com.google.gerrit.index.IndexConfig; import com.google.gerrit.index.query.AndSource; -import com.google.gerrit.index.query.IsVisibleToPredicate; import com.google.gerrit.index.query.Predicate; import java.util.Collection; import java.util.List; @@ -28,11 +27,8 @@ } public AndChangeSource( - Predicate<ChangeData> that, - IsVisibleToPredicate<ChangeData> isVisibleToPredicate, - int start, - IndexConfig indexConfig) { - super(that, isVisibleToPredicate, start, indexConfig); + Collection<Predicate<ChangeData>> that, int start, IndexConfig indexConfig) { + super(that, start, indexConfig); } @Override
diff --git a/java/com/google/gerrit/server/query/change/AssigneePredicate.java b/java/com/google/gerrit/server/query/change/AssigneePredicate.java deleted file mode 100644 index 35a91c9..0000000 --- a/java/com/google/gerrit/server/query/change/AssigneePredicate.java +++ /dev/null
@@ -1,41 +0,0 @@ -// Copyright (C) 2016 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.server.index.change.ChangeField; - -public class AssigneePredicate extends ChangeIndexPredicate { - protected final Account.Id id; - - public AssigneePredicate(Account.Id id) { - super(ChangeField.ASSIGNEE, id.toString()); - this.id = id; - } - - @Override - public boolean match(ChangeData object) { - if (id.get() == ChangeField.NO_ASSIGNEE) { - Account.Id assignee = object.change().getAssignee(); - return assignee == null; - } - return id.equals(object.change().getAssignee()); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/AttentionSetPredicate.java b/java/com/google/gerrit/server/query/change/AttentionSetPredicate.java deleted file mode 100644 index 2b18767..0000000 --- a/java/com/google/gerrit/server/query/change/AttentionSetPredicate.java +++ /dev/null
@@ -1,41 +0,0 @@ -// Copyright (C) 2020 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.util.AttentionSetUtil.additionsOnly; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.server.index.change.ChangeField; - -/** Simple predicate for searching by attention set. */ -public class AttentionSetPredicate extends ChangeIndexPredicate { - protected final Account.Id id; - - AttentionSetPredicate(Account.Id id) { - super(ChangeField.ATTENTION_SET_USERS, id.toString()); - this.id = id; - } - - @Override - public boolean match(ChangeData changeData) { - return additionsOnly(changeData.attentionSet()).stream() - .anyMatch(update -> update.account().equals(id)); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/AuthorPredicate.java b/java/com/google/gerrit/server/query/change/AuthorPredicate.java deleted file mode 100644 index 79914a3..0000000 --- a/java/com/google/gerrit/server/query/change/AuthorPredicate.java +++ /dev/null
@@ -1,36 +0,0 @@ -// Copyright (C) 2015 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.AUTHOR; -import static com.google.gerrit.server.query.change.ChangeQueryBuilder.FIELD_AUTHOR; - -import com.google.gerrit.server.index.change.ChangeField; - -public class AuthorPredicate extends ChangeIndexPredicate { - public AuthorPredicate(String value) { - super(AUTHOR, FIELD_AUTHOR, value.toLowerCase()); - } - - @Override - public boolean match(ChangeData object) { - return ChangeField.getAuthorParts(object).contains(getValue().toLowerCase()); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/BooleanPredicate.java b/java/com/google/gerrit/server/query/change/BooleanPredicate.java index 68f83e8..6ca3acc 100644 --- a/java/com/google/gerrit/server/query/change/BooleanPredicate.java +++ b/java/com/google/gerrit/server/query/change/BooleanPredicate.java
@@ -25,9 +25,4 @@ public boolean match(ChangeData object) { return getValue().equals(getField().get(object)); } - - @Override - public int getCost() { - return 1; - } }
diff --git a/java/com/google/gerrit/server/query/change/ChangeData.java b/java/com/google/gerrit/server/query/change/ChangeData.java index f7167cd..7d7b17b 100644 --- a/java/com/google/gerrit/server/query/change/ChangeData.java +++ b/java/com/google/gerrit/server/query/change/ChangeData.java
@@ -22,6 +22,7 @@ import com.google.auto.value.AutoValue; import com.google.common.annotations.VisibleForTesting; import com.google.common.base.MoreObjects; +import com.google.common.collect.HashBasedTable; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableListMultimap; import com.google.common.collect.ImmutableMap; @@ -33,12 +34,13 @@ import com.google.common.collect.Lists; import com.google.common.collect.Maps; import com.google.common.collect.SetMultimap; +import com.google.common.collect.Table; import com.google.common.flogger.FluentLogger; import com.google.common.primitives.Ints; import com.google.gerrit.common.Nullable; -import com.google.gerrit.common.UsedAt; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.AttentionSetUpdate; +import com.google.gerrit.entities.BranchNameKey; import com.google.gerrit.entities.Change; import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.Comment; @@ -51,12 +53,13 @@ import com.google.gerrit.entities.RefNames; import com.google.gerrit.entities.RobotComment; import com.google.gerrit.entities.SubmitRecord; +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementResult; import com.google.gerrit.entities.SubmitTypeRecord; import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.restapi.BadRequestException; import com.google.gerrit.extensions.restapi.ResourceConflictException; import com.google.gerrit.index.RefState; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.CommentsUtil; import com.google.gerrit.server.CurrentUser; @@ -66,12 +69,15 @@ import com.google.gerrit.server.ReviewerStatusUpdate; import com.google.gerrit.server.StarredChangesUtil; import com.google.gerrit.server.StarredChangesUtil.StarRef; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.CommentThread; import com.google.gerrit.server.change.CommentThreads; import com.google.gerrit.server.change.MergeabilityCache; import com.google.gerrit.server.change.PureRevert; import com.google.gerrit.server.config.AllUsersName; import com.google.gerrit.server.config.TrackingFooters; +import com.google.gerrit.server.experiments.ExperimentFeatures; +import com.google.gerrit.server.experiments.ExperimentFeaturesConstants; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.git.MergeUtil; import com.google.gerrit.server.notedb.ChangeNotes; @@ -84,6 +90,9 @@ import com.google.gerrit.server.project.NoSuchChangeException; import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.project.ProjectState; +import com.google.gerrit.server.project.SubmitRequirementsAdapter; +import com.google.gerrit.server.project.SubmitRequirementsEvaluator; +import com.google.gerrit.server.project.SubmitRequirementsUtil; import com.google.gerrit.server.project.SubmitRuleEvaluator; import com.google.gerrit.server.project.SubmitRuleOptions; import com.google.gerrit.server.util.time.TimeUtil; @@ -101,6 +110,7 @@ import java.util.Optional; import java.util.Set; import java.util.function.Function; +import java.util.stream.Collectors; import java.util.stream.Stream; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.PersonIdent; @@ -231,6 +241,19 @@ return assistedFactory.create(project, id, null, null); } + public ChangeData create(Project.NameKey project, Change.Id id, ObjectId metaRevision) { + ChangeData cd = assistedFactory.create(project, id, null, null); + cd.setMetaRevision(metaRevision); + return cd; + } + + public ChangeData createNonPrivate(BranchNameKey branch, Change.Id id, ObjectId metaRevision) { + ChangeData cd = create(branch.project(), id, metaRevision); + cd.branch = branch.branch(); + cd.isPrivate = false; + return cd; + } + public ChangeData create(Change change) { return assistedFactory.create(change.getProject(), change.getId(), change, null); } @@ -263,7 +286,7 @@ ChangeData cd = new ChangeData( null, null, null, null, null, null, null, null, null, null, null, null, null, null, - null, project, id, null, null); + null, null, null, project, id, null, null); cd.currentPatchSet = PatchSet.builder() .id(PatchSet.id(id, currentPatchSetId)) @@ -281,6 +304,7 @@ private final ChangeMessagesUtil cmUtil; private final ChangeNotes.Factory notesFactory; private final CommentsUtil commentsUtil; + private final ExperimentFeatures experimentFeatures; private final GitRepositoryManager repoManager; private final MergeUtil.Factory mergeUtilFactory; private final MergeabilityCache mergeabilityCache; @@ -289,6 +313,7 @@ private final ProjectCache projectCache; private final TrackingFooters trackingFooters; private final PureRevert pureRevert; + private final SubmitRequirementsEvaluator submitRequirementsEvaluator; private final SubmitRuleEvaluator.Factory submitRuleEvaluatorFactory; // Required assisted injected fields. @@ -300,6 +325,8 @@ private final Map<SubmitRuleOptions, List<SubmitRecord>> submitRecords = Maps.newLinkedHashMapWithExpectedSize(1); + private Map<SubmitRequirement, SubmitRequirementResult> submitRequirements; + private StorageConstraint storageConstraint = StorageConstraint.NOTEDB_ONLY; private Change change; private ChangeNotes notes; @@ -308,6 +335,8 @@ private PatchSet currentPatchSet; private Collection<PatchSet> patchSets; private ListMultimap<PatchSet.Id, PatchSetApproval> allApprovals; + + private ListMultimap<PatchSet.Id, PatchSetApproval> allApprovalsWithCopied; private List<PatchSetApproval> currentApprovals; private List<String> currentFiles; private Optional<DiffSummary> diffSummary; @@ -317,12 +346,24 @@ private List<ChangeMessage> messages; private Optional<ChangedLines> changedLines; private SubmitTypeRecord submitTypeRecord; + private String branch; + private Boolean isPrivate; private Boolean mergeable; - private Boolean merge; + private ObjectId metaRevision; private Set<String> hashtags; - private Map<Account.Id, Ref> editsByUser; + /** + * Map from {@link com.google.gerrit.entities.Account.Id} to the tip of the edit ref for this + * change and a given user. + */ + private Table<Account.Id, PatchSet.Id, ObjectId> editsByUser; + private Set<Account.Id> reviewedBy; - private Map<Account.Id, Ref> draftsByUser; + /** + * Map from {@link com.google.gerrit.entities.Account.Id} to the tip of the draft comments ref for + * this change and the user. + */ + private Map<Account.Id, ObjectId> draftsByUser; + private ImmutableListMultimap<Account.Id, String> stars; private StarsOf starsOf; private ImmutableMap<Account.Id, StarRef> starRefs; @@ -334,7 +375,7 @@ private PersonIdent author; private PersonIdent committer; private ImmutableSet<AttentionSetUpdate> attentionSet; - private int parentCount; + private Integer parentCount; private Integer unresolvedCommentCount; private Integer totalCommentCount; private LabelTypes labelTypes; @@ -350,6 +391,7 @@ ChangeMessagesUtil cmUtil, ChangeNotes.Factory notesFactory, CommentsUtil commentsUtil, + ExperimentFeatures experimentFeatures, GitRepositoryManager repoManager, MergeUtil.Factory mergeUtilFactory, MergeabilityCache mergeabilityCache, @@ -358,6 +400,7 @@ ProjectCache projectCache, TrackingFooters trackingFooters, PureRevert pureRevert, + SubmitRequirementsEvaluator submitRequirementsEvaluator, SubmitRuleEvaluator.Factory submitRuleEvaluatorFactory, @Assisted Project.NameKey project, @Assisted Change.Id id, @@ -368,6 +411,7 @@ this.cmUtil = cmUtil; this.notesFactory = notesFactory; this.commentsUtil = commentsUtil; + this.experimentFeatures = experimentFeatures; this.repoManager = repoManager; this.mergeUtilFactory = mergeUtilFactory; this.mergeabilityCache = mergeabilityCache; @@ -377,6 +421,7 @@ this.starredChangesUtil = starredChangesUtil; this.trackingFooters = trackingFooters; this.pureRevert = pureRevert; + this.submitRequirementsEvaluator = submitRequirementsEvaluator; this.submitRuleEvaluatorFactory = submitRuleEvaluatorFactory; this.project = project; @@ -472,6 +517,26 @@ changedLines = Optional.of(new ChangedLines(insertions, deletions)); } + public void setLinesInserted(int insertions) { + changedLines = + Optional.of( + new ChangedLines( + insertions, + changedLines != null && changedLines.isPresent() + ? changedLines.get().deletions + : -1)); + } + + public void setLinesDeleted(int deletions) { + changedLines = + Optional.of( + new ChangedLines( + changedLines != null && changedLines.isPresent() + ? changedLines.get().insertions + : -1, + deletions)); + } + public void setNoChangedLines() { changedLines = Optional.empty(); } @@ -484,6 +549,55 @@ return project; } + public BranchNameKey branchOrThrow() { + if (change == null) { + if (branch != null) { + return BranchNameKey.create(project, branch); + } + throwIfNotLazyLoad("branch"); + change(); + } + return change.getDest(); + } + + public boolean isPrivateOrThrow() { + if (change == null) { + if (isPrivate != null) { + return isPrivate; + } + throwIfNotLazyLoad("isPrivate"); + change(); + } + return change.isPrivate(); + } + + public ChangeData setMetaRevision(ObjectId metaRevision) { + this.metaRevision = metaRevision; + return this; + } + + public ObjectId metaRevisionOrThrow() { + if (notes == null) { + if (metaRevision != null) { + return metaRevision; + } + if (refStates != null) { + Set<RefState> refs = refStates.get(project); + if (refs != null) { + String metaRef = RefNames.changeMetaRef(getId()); + for (RefState r : refs) { + if (r.ref().equals(metaRef)) { + return r.id(); + } + } + } + } + throwIfNotLazyLoad("metaRevision"); + notes(); + } + return notes.getRevision(); + } + boolean fastIsVisibleTo(CurrentUser user) { return visibleTo == user; } @@ -494,7 +608,7 @@ public Change change() { if (change == null && lazyload()) { - reloadChange(); + loadChange(); } return change; } @@ -504,12 +618,18 @@ } public Change reloadChange() { + metaRevision = null; + return loadChange(); + } + + private Change loadChange() { try { - notes = notesFactory.createChecked(project, legacyId); + notes = notesFactory.createChecked(project, legacyId, metaRevision); } catch (NoSuchChangeException e) { throw new StorageException("Unable to load change " + legacyId, e); } change = notes.getChange(); + metaRevision = null; setPatchSets(null); return change; } @@ -527,7 +647,8 @@ if (!lazyload()) { throw new StorageException("ChangeNotes not available, lazyLoad = false"); } - notes = notesFactory.create(project(), legacyId); + notes = notesFactory.create(project(), legacyId, metaRevision); + change = notes.getChange(); } return notes; } @@ -559,8 +680,7 @@ } else { try { currentApprovals = - ImmutableList.copyOf( - approvalsUtil.byPatchSet(notes(), c.currentPatchSetId(), null, null)); + ImmutableList.copyOf(approvalsUtil.byPatchSet(notes(), c.currentPatchSetId())); } catch (StorageException e) { if (e.getCause() instanceof NoSuchChangeException) { currentApprovals = Collections.emptyList(); @@ -631,7 +751,6 @@ author = c.getAuthorIdent(); committer = c.getCommitterIdent(); parentCount = c.getParentCount(); - merge = parentCount > 1; } catch (IOException e) { throw new StorageException( String.format( @@ -691,7 +810,7 @@ this.attentionSet = attentionSet; } - /** @return patches for the change, in patch set ID order. */ + /** Returns patches for the change, in patch set ID order. */ public Collection<PatchSet> patchSets() { if (patchSets == null) { patchSets = psUtil.byChange(notes()); @@ -704,7 +823,7 @@ this.patchSets = patchSets; } - /** @return patch with the given ID, or null if it does not exist. */ + /** Returns patch with the given ID, or null if it does not exist. */ public PatchSet patchSet(PatchSet.Id psId) { if (currentPatchSet != null && currentPatchSet.id().equals(psId)) { return currentPatchSet; @@ -718,8 +837,8 @@ } /** - * @return all patch set approvals for the change, keyed by ID, ordered by timestamp within each - * patch set. + * Returns all patch set approvals for the change, keyed by ID, ordered by timestamp within each + * patch set. */ public ListMultimap<PatchSet.Id, PatchSetApproval> approvals() { if (allApprovals == null) { @@ -731,6 +850,16 @@ return allApprovals; } + public ListMultimap<PatchSet.Id, PatchSetApproval> conditionallyLoadApprovalsWithCopied() { + if (allApprovalsWithCopied == null) { + if (!lazyload()) { + return ImmutableListMultimap.of(); + } + allApprovalsWithCopied = approvalsUtil.byChangeWithCopied(notes()); + } + return allApprovalsWithCopied; + } + /* @return legacy submit ('SUBM') approval label */ // TODO(mariasavtchouk): Deprecate legacy submit label, // see com.google.gerrit.entities.LabelId.LEGACY_SUBMIT_NAME @@ -740,11 +869,7 @@ public ReviewerSet reviewers() { if (reviewers == null) { - if (!lazyload()) { - // We are not allowed to load values from NoteDb. Reviewers were not populated with values - // from the index. However, we need these values for permission checks. - throw new IllegalStateException("reviewers not populated"); - } + throwIfNotLazyLoad("reviewers"); reviewers = approvalsUtil.getReviewers(notes()); } return reviewers; @@ -895,6 +1020,57 @@ return messages; } + /** + * Get all evaluated submit requirements for this change, including those from parent projects. + * For closed changes, submit requirements are read from the change notes. For active changes, + * submit requirements are evaluated online. + * + * <p>For changes loaded from the index, the value will be set from index field {@link + * com.google.gerrit.server.index.change.ChangeField#STORED_SUBMIT_REQUIREMENTS}. + */ + public Map<SubmitRequirement, SubmitRequirementResult> submitRequirements() { + if (!experimentFeatures.isFeatureEnabled( + ExperimentFeaturesConstants.GERRIT_BACKEND_REQUEST_FEATURE_ENABLE_SUBMIT_REQUIREMENTS)) { + return Collections.emptyMap(); + } + if (submitRequirements == null) { + if (!lazyload()) { + return Collections.emptyMap(); + } + Change c = change(); + if (c == null || !c.isClosed()) { + // Open changes: Evaluate submit requirements online. + submitRequirements = + submitRequirementsEvaluator.evaluateAllRequirements(this, /* includeLegacy= */ true); + return submitRequirements; + } + // Closed changes: Load submit requirement results from NoteDb. + Map<SubmitRequirement, SubmitRequirementResult> projectConfigRequirements = + notes().getSubmitRequirementsResult().stream() + .filter(r -> !r.isLegacy()) + .collect(Collectors.toMap(r -> r.submitRequirement(), Function.identity())); + Map<SubmitRequirement, SubmitRequirementResult> legacyRequirements = + SubmitRequirementsAdapter.getLegacyRequirements(submitRuleEvaluatorFactory, this); + submitRequirements = + SubmitRequirementsUtil.mergeLegacyAndNonLegacyRequirements( + projectConfigRequirements, legacyRequirements); + } + return submitRequirements; + } + + public void setSubmitRequirements( + Map<SubmitRequirement, SubmitRequirementResult> submitRequirements) { + if (!experimentFeatures.isFeatureEnabled( + ExperimentFeaturesConstants + .GERRIT_BACKEND_REQUEST_FEATURE_ENABLE_SUBMIT_REQUIREMENTS_BACKFILLING_ON_DASHBOARD)) { + // Only set back values from the index if the experiment is not active. While the experiment + // is active, we want + // to compute SRs from scratch to ensure fresh results. + // TODO(ghareeb, hiesel): Remove this. + this.submitRequirements = submitRequirements; + } + } + public List<SubmitRecord> submitRecords(SubmitRuleOptions options) { // If the change is not submitted yet, 'strict' and 'lenient' both have the same result. If the // change is submitted, SubmitRecord requested with 'strict' will contain just a single entry @@ -987,36 +1163,39 @@ @Nullable public Boolean isMerge() { - if (merge == null) { + if (parentCount == null) { if (!loadCommitData()) { return null; } } - return merge; + return parentCount > 1; } public Set<Account.Id> editsByUser() { - return editRefs().keySet(); + return editRefs().rowKeySet(); } - public Map<Account.Id, Ref> editRefs() { + public Table<Account.Id, PatchSet.Id, ObjectId> editRefs() { if (editsByUser == null) { if (!lazyload()) { - return Collections.emptyMap(); + return HashBasedTable.create(); } Change c = change(); if (c == null) { - return Collections.emptyMap(); + return HashBasedTable.create(); } - editsByUser = new HashMap<>(); + editsByUser = HashBasedTable.create(); Change.Id id = requireNonNull(change.getId()); try (Repository repo = repoManager.openRepository(project())) { for (Ref ref : repo.getRefDatabase().getRefsByPrefix(RefNames.REFS_USERS)) { - String name = ref.getName().substring(RefNames.REFS_USERS.length()); - if (id.equals(Change.Id.fromEditRefPart(name))) { - Account.Id accountId = Account.Id.fromRefPart(name); + if (!RefNames.isRefsEdit(ref.getName())) { + continue; + } + PatchSet.Id ps = PatchSet.Id.fromEditRef(ref.getName()); + if (id.equals(ps.changeId())) { + Account.Id accountId = Account.Id.fromRef(ref.getName()); if (accountId != null) { - editsByUser.put(accountId, ref); + editsByUser.put(accountId, ps, ref.getObjectId()); } } } @@ -1031,48 +1210,7 @@ return draftRefs().keySet(); } - public Map<Account.Id, Ref> draftRefs() { - if (draftsByUser == null) { - if (!lazyload()) { - return Collections.emptyMap(); - } - Change c = change(); - if (c == null) { - return Collections.emptyMap(); - } - - draftsByUser = new HashMap<>(); - for (Ref ref : commentsUtil.getDraftRefs(notes().getChangeId())) { - Account.Id account = Account.Id.fromRefSuffix(ref.getName()); - if (account != null - // Double-check that any drafts exist for this user after - // filtering out zombies. If some but not all drafts in the ref - // were zombies, the returned Ref still includes those zombies; - // this is suboptimal, but is ok for the purposes of - // draftsByUser(), and easier than trying to rebuild the change at - // this point. - && !notes().getDraftComments(account, ref).isEmpty()) { - draftsByUser.put(account, ref); - } - } - } - return draftsByUser; - } - public boolean isReviewedBy(Account.Id accountId) { - Collection<String> stars = stars(accountId); - - PatchSet ps = currentPatchSet(); - if (ps != null) { - if (stars.contains(StarredChangesUtil.REVIEWED_LABEL + "/" + ps.number())) { - return true; - } - - if (stars.contains(StarredChangesUtil.UNREVIEWED_LABEL + "/" + ps.number())) { - return false; - } - } - return reviewedBy().contains(accountId); } @@ -1170,8 +1308,8 @@ } /** - * @return {@code null} if {@code revertOf} is {@code null}; true if the change is a pure revert; - * false otherwise. + * Returns {@code null} if {@code revertOf} is {@code null}; true if the change is a pure revert; + * false otherwise. */ @Nullable public Boolean isPureRevert() { @@ -1213,7 +1351,14 @@ } ImmutableSetMultimap.Builder<NameKey, RefState> result = ImmutableSetMultimap.builder(); - editRefs().values().forEach(r -> result.put(project, RefState.of(r))); + for (Table.Cell<Account.Id, PatchSet.Id, ObjectId> edit : editRefs().cellSet()) { + result.put( + project, + RefState.create( + RefNames.refsEdit( + edit.getRowKey(), edit.getColumnKey().changeId(), edit.getColumnKey()), + edit.getValue())); + } starRefs().values().forEach(r -> result.put(allUsersName, RefState.of(r.ref()))); // TODO: instantiating the notes is too much. We don't want to parse NoteDb, we just want the @@ -1222,7 +1367,14 @@ notes().getRobotComments(); // Force loading robot comments. RobotCommentNotes robotNotes = notes().getRobotCommentNotes(); result.put(project, RefState.create(robotNotes.getRefName(), robotNotes.getMetaId())); - draftRefs().values().forEach(r -> result.put(allUsersName, RefState.of(r))); + draftRefs() + .entrySet() + .forEach( + r -> + result.put( + allUsersName, + RefState.create( + RefNames.refsDraftComments(getId(), r.getKey()), r.getValue()))); refStates = result.build(); } @@ -1230,14 +1382,35 @@ return refStates; } - @UsedAt(UsedAt.Project.GOOGLE) - public void setRefStates(Iterable<byte[]> refStates) { - // TODO(hanwen): remove Google use, and drop this method. - setRefStates(RefState.parseStates(refStates)); - } - public void setRefStates(ImmutableSetMultimap<Project.NameKey, RefState> refStates) { this.refStates = refStates; + if (draftsByUser == null) { + // Recover draft refs as well. Draft comments are represented as refs in the repository. + // ChangeData exposes #draftsByUser which just provides a Set of Account.Ids of users who + // have drafts comments on this change. Recovering this list from RefStates makes it + // available even on ChangeData instances retrieved from the index. + draftsByUser = new HashMap<>(); + if (refStates.containsKey(allUsersName)) { + refStates.get(allUsersName).stream() + .filter(r -> RefNames.isRefsDraftsComments(r.ref())) + .forEach(r -> draftsByUser.put(Account.Id.fromRef(r.ref()), r.id())); + } + } + if (editsByUser == null) { + // Recover edit refs as well. Edits are represented as refs in the repository. + // ChangeData exposes #editsByUser which just provides a Set of Account.Ids of users who + // have edits on this change. Recovering this list from RefStates makes it available even + // on ChangeData instances retrieved from the index. + editsByUser = HashBasedTable.create(); + if (refStates.containsKey(project())) { + refStates.get(project()).stream() + .filter(r -> RefNames.isRefsEdit(r.ref())) + .forEach( + r -> + editsByUser.put( + Account.Id.fromRef(r.ref()), PatchSet.Id.fromEditRef(r.ref()), r.id())); + } + } } public ImmutableList<byte[]> getRefStatePatterns() { @@ -1248,6 +1421,14 @@ this.refStatePatterns = ImmutableList.copyOf(refStatePatterns); } + private void throwIfNotLazyLoad(String field) { + if (!lazyload()) { + // We are not allowed to load values from NoteDb. 'field' was not populated, however, + // we need this value for permission checks. + throw new IllegalStateException("'" + field + "' field not populated"); + } + } + @AutoValue abstract static class ReviewedByEvent { private static ReviewedByEvent create(ChangeMessage msg) { @@ -1269,4 +1450,32 @@ public abstract ImmutableSortedSet<String> stars(); } + + private Map<Account.Id, ObjectId> draftRefs() { + if (draftsByUser == null) { + if (!lazyload()) { + return Collections.emptyMap(); + } + Change c = change(); + if (c == null) { + return Collections.emptyMap(); + } + + draftsByUser = new HashMap<>(); + for (Ref ref : commentsUtil.getDraftRefs(notes().getChangeId())) { + Account.Id account = Account.Id.fromRefSuffix(ref.getName()); + if (account != null + // Double-check that any drafts exist for this user after + // filtering out zombies. If some but not all drafts in the ref + // were zombies, the returned Ref still includes those zombies; + // this is suboptimal, but is ok for the purposes of + // draftsByUser(), and easier than trying to rebuild the change at + // this point. + && !notes().getDraftComments(account, ref).isEmpty()) { + draftsByUser.put(account, ref.getObjectId()); + } + } + } + return draftsByUser; + } }
diff --git a/java/com/google/gerrit/server/query/change/ChangeDataSource.java b/java/com/google/gerrit/server/query/change/ChangeDataSource.java index 34579a9..26ce46c 100644 --- a/java/com/google/gerrit/server/query/change/ChangeDataSource.java +++ b/java/com/google/gerrit/server/query/change/ChangeDataSource.java
@@ -17,6 +17,6 @@ import com.google.gerrit.index.query.DataSource; public interface ChangeDataSource extends DataSource<ChangeData> { - /** @return true if all returned ChangeData.hasChange() will be true. */ + /** Returns true if all returned ChangeData.hasChange() will be true. */ boolean hasChange(); }
diff --git a/java/com/google/gerrit/server/query/change/ChangeIdPredicate.java b/java/com/google/gerrit/server/query/change/ChangeIdPredicate.java deleted file mode 100644 index f837ef4..0000000 --- a/java/com/google/gerrit/server/query/change/ChangeIdPredicate.java +++ /dev/null
@@ -1,50 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Change; -import com.google.gerrit.index.query.HasCardinality; -import com.google.gerrit.server.index.change.ChangeField; - -/** Predicate over Change-Id strings (aka Change.Key). */ -public class ChangeIdPredicate extends ChangeIndexPredicate implements HasCardinality { - public ChangeIdPredicate(String id) { - super(ChangeField.ID, ChangeQueryBuilder.FIELD_CHANGE, id); - } - - @Override - public boolean match(ChangeData cd) { - Change change = cd.change(); - if (change == null) { - return false; - } - - String key = change.getKey().get(); - if (key.equals(getValue()) || key.startsWith(getValue())) { - return true; - } - return false; - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 5; - } -}
diff --git a/java/com/google/gerrit/server/query/change/ChangeIndexCardinalPredicate.java b/java/com/google/gerrit/server/query/change/ChangeIndexCardinalPredicate.java new file mode 100644 index 0000000..6540d80 --- /dev/null +++ b/java/com/google/gerrit/server/query/change/ChangeIndexCardinalPredicate.java
@@ -0,0 +1,39 @@ +// Copyright (C) 2022 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import com.google.gerrit.index.FieldDef; +import com.google.gerrit.index.query.HasCardinality; + +public class ChangeIndexCardinalPredicate extends ChangeIndexPredicate implements HasCardinality { + protected final int cardinality; + + protected ChangeIndexCardinalPredicate( + FieldDef<ChangeData, ?> def, String value, int cardinality) { + super(def, value); + this.cardinality = cardinality; + } + + protected ChangeIndexCardinalPredicate( + FieldDef<ChangeData, ?> def, String name, String value, int cardinality) { + super(def, name, value); + this.cardinality = cardinality; + } + + @Override + public int getCardinality() { + return cardinality; + } +}
diff --git a/java/com/google/gerrit/server/query/change/ChangeIndexPredicate.java b/java/com/google/gerrit/server/query/change/ChangeIndexPredicate.java index a176a58..ccd4109 100644 --- a/java/com/google/gerrit/server/query/change/ChangeIndexPredicate.java +++ b/java/com/google/gerrit/server/query/change/ChangeIndexPredicate.java
@@ -16,12 +16,10 @@ import com.google.gerrit.index.FieldDef; import com.google.gerrit.index.query.IndexPredicate; -import com.google.gerrit.index.query.Matchable; import com.google.gerrit.index.query.Predicate; /** Predicate that is mapped to a field in the change index. */ -public abstract class ChangeIndexPredicate extends IndexPredicate<ChangeData> - implements Matchable<ChangeData> { +public class ChangeIndexPredicate extends IndexPredicate<ChangeData> { /** * Returns an index predicate that matches no changes in the index. *
diff --git a/java/com/google/gerrit/server/query/change/ChangeIsVisibleToPredicate.java b/java/com/google/gerrit/server/query/change/ChangeIsVisibleToPredicate.java index bb10de5..24042ad 100644 --- a/java/com/google/gerrit/server/query/change/ChangeIsVisibleToPredicate.java +++ b/java/com/google/gerrit/server/query/change/ChangeIsVisibleToPredicate.java
@@ -17,13 +17,11 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Change; import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.index.query.IsVisibleToPredicate; import com.google.gerrit.server.AnonymousUser; import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.InternalUser; import com.google.gerrit.server.index.IndexUtils; -import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.permissions.ChangePermission; import com.google.gerrit.server.permissions.PermissionBackend; import com.google.gerrit.server.permissions.PermissionBackendException; @@ -42,20 +40,17 @@ ChangeIsVisibleToPredicate forUser(CurrentUser user); } - protected final ChangeNotes.Factory notesFactory; protected final CurrentUser user; protected final ProjectCache projectCache; private final PermissionBackend.WithUser withUser; @Inject public ChangeIsVisibleToPredicate( - ChangeNotes.Factory notesFactory, PermissionBackend permissionBackend, ProjectCache projectCache, Provider<AnonymousUser> anonymousUserProvider, @Assisted CurrentUser user) { super(ChangeQueryBuilder.FIELD_VISIBLETO, IndexUtils.describe(user)); - this.notesFactory = notesFactory; this.user = user; this.projectCache = projectCache; withUser = @@ -88,7 +83,10 @@ } try { - withUser.change(cd).check(ChangePermission.READ); + if (!withUser.change(cd).test(ChangePermission.READ)) { + logger.atFine().log("Filter out non-visisble change: %s", cd); + return false; + } } catch (PermissionBackendException e) { Throwable cause = e.getCause(); if (cause instanceof RepositoryNotFoundException) { @@ -98,9 +96,6 @@ return false; } throw new StorageException("unable to check permissions on change " + cd.getId(), e); - } catch (AuthException e) { - logger.atFine().log("Filter out non-visisble change: %s", cd); - return false; } cd.cacheVisibleTo(user);
diff --git a/java/com/google/gerrit/server/query/change/ChangePredicates.java b/java/com/google/gerrit/server/query/change/ChangePredicates.java new file mode 100644 index 0000000..7abe4b7 --- /dev/null +++ b/java/com/google/gerrit/server/query/change/ChangePredicates.java
@@ -0,0 +1,314 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import com.google.common.base.CharMatcher; +import com.google.gerrit.entities.Account; +import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.entities.Project; +import com.google.gerrit.git.ObjectIds; +import com.google.gerrit.index.query.Predicate; +import com.google.gerrit.server.change.HashtagsUtil; +import com.google.gerrit.server.index.change.ChangeField; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.Locale; + +/** Predicates that match against {@link ChangeData}. */ +public class ChangePredicates { + private ChangePredicates() {} + + /** + * Returns a predicate that matches changes where the provided {@link + * com.google.gerrit.entities.Account.Id} is in the attention set. + */ + public static Predicate<ChangeData> attentionSet(Account.Id id) { + return new ChangeIndexPredicate(ChangeField.ATTENTION_SET_USERS, id.toString()); + } + + /** + * Returns a predicate that matches changes that are assigned to the provided {@link + * com.google.gerrit.entities.Account.Id}. + */ + public static Predicate<ChangeData> assignee(Account.Id id) { + return new ChangeIndexPredicate(ChangeField.ASSIGNEE, id.toString()); + } + + /** + * Returns a predicate that matches changes that are a revert of the provided {@link + * com.google.gerrit.entities.Change.Id}. + */ + public static Predicate<ChangeData> revertOf(Change.Id revertOf) { + return new ChangeIndexCardinalPredicate(ChangeField.REVERT_OF, revertOf.toString(), 1); + } + + /** + * Returns a predicate that matches changes that have a comment authored by the provided {@link + * com.google.gerrit.entities.Account.Id}. + */ + public static Predicate<ChangeData> commentBy(Account.Id id) { + return new ChangeIndexPredicate(ChangeField.COMMENTBY, id.toString()); + } + + /** + * Returns a predicate that matches changes where the provided {@link + * com.google.gerrit.entities.Account.Id} has a pending change edit. + */ + public static Predicate<ChangeData> editBy(Account.Id id) { + return new ChangeIndexPredicate(ChangeField.EDITBY, id.toString()); + } + + /** + * Returns a predicate that matches changes where the provided {@link + * com.google.gerrit.entities.Account.Id} has a pending draft comment. + */ + public static Predicate<ChangeData> draftBy(Account.Id id) { + return new ChangeIndexCardinalPredicate(ChangeField.DRAFTBY, id.toString(), 20); + } + + /** + * Returns a predicate that matches changes that were reviewed by any of the provided {@link + * com.google.gerrit.entities.Account.Id}. + */ + public static Predicate<ChangeData> reviewedBy(Collection<Account.Id> ids) { + List<Predicate<ChangeData>> predicates = new ArrayList<>(ids.size()); + for (Account.Id id : ids) { + predicates.add(new ChangeIndexPredicate(ChangeField.REVIEWEDBY, id.toString())); + } + return Predicate.or(predicates); + } + + /** Returns a predicate that matches changes that were not yet reviewed. */ + public static Predicate<ChangeData> unreviewed() { + return Predicate.not( + new ChangeIndexPredicate(ChangeField.REVIEWEDBY, ChangeField.NOT_REVIEWED.toString())); + } + + /** + * Returns a predicate that matches the change with the provided {@link + * com.google.gerrit.entities.Change.Id}. + */ + public static Predicate<ChangeData> id(Change.Id id) { + return new ChangeIndexCardinalPredicate( + ChangeField.LEGACY_ID, ChangeQueryBuilder.FIELD_CHANGE, id.toString(), 1); + } + + /** + * Returns a predicate that matches the change with the provided {@link + * com.google.gerrit.entities.Change.Id}. + */ + public static Predicate<ChangeData> idStr(Change.Id id) { + return new ChangeIndexCardinalPredicate( + ChangeField.LEGACY_ID_STR, ChangeQueryBuilder.FIELD_CHANGE, id.toString(), 1); + } + + /** + * Returns a predicate that matches changes owned by the provided {@link + * com.google.gerrit.entities.Account.Id}. + */ + public static Predicate<ChangeData> owner(Account.Id id) { + return new ChangeIndexCardinalPredicate(ChangeField.OWNER, id.toString(), 5000); + } + + /** + * Returns a predicate that matches changes where the latest patch set was uploaded by the + * provided {@link com.google.gerrit.entities.Account.Id}. + */ + public static Predicate<ChangeData> uploader(Account.Id id) { + return new ChangeIndexPredicate(ChangeField.UPLOADER, id.toString()); + } + + /** + * Returns a predicate that matches changes that are a cherry pick of the provided {@link + * com.google.gerrit.entities.Change.Id}. + */ + public static Predicate<ChangeData> cherryPickOf(Change.Id id) { + return new ChangeIndexPredicate(ChangeField.CHERRY_PICK_OF_CHANGE, id.toString()); + } + + /** + * Returns a predicate that matches changes that are a cherry pick of the provided {@link + * com.google.gerrit.entities.PatchSet.Id}. + */ + public static Predicate<ChangeData> cherryPickOf(PatchSet.Id psId) { + return Predicate.and( + cherryPickOf(psId.changeId()), + new ChangeIndexPredicate(ChangeField.CHERRY_PICK_OF_PATCHSET, String.valueOf(psId.get()))); + } + + /** + * Returns a predicate that matches changes in the provided {@link + * com.google.gerrit.entities.Project.NameKey}. + */ + public static Predicate<ChangeData> project(Project.NameKey id) { + return new ChangeIndexCardinalPredicate(ChangeField.PROJECT, id.get(), 1_000_000); + } + + /** Returns a predicate that matches changes targeted at the provided {@code refName}. */ + public static Predicate<ChangeData> ref(String refName) { + return new ChangeIndexCardinalPredicate(ChangeField.REF, refName, 10_000); + } + + /** Returns a predicate that matches changes in the provided {@code topic}. */ + public static Predicate<ChangeData> exactTopic(String topic) { + return new ChangeIndexPredicate(ChangeField.EXACT_TOPIC, topic); + } + + /** Returns a predicate that matches changes in the provided {@code topic}. */ + public static Predicate<ChangeData> fuzzyTopic(String topic) { + return new ChangeIndexPredicate(ChangeField.FUZZY_TOPIC, topic); + } + + /** Returns a predicate that matches changes submitted in the provided {@code changeSet}. */ + public static Predicate<ChangeData> submissionId(String changeSet) { + return new ChangeIndexPredicate(ChangeField.SUBMISSIONID, changeSet); + } + + /** Returns a predicate that matches changes that modified the provided {@code path}. */ + public static Predicate<ChangeData> path(String path) { + return new ChangeIndexPredicate(ChangeField.PATH, path); + } + + /** Returns a predicate that matches changes tagged with the provided {@code hashtag}. */ + public static Predicate<ChangeData> hashtag(String hashtag) { + // Use toLowerCase without locale to match behavior in ChangeField. + return new ChangeIndexPredicate( + ChangeField.HASHTAG, HashtagsUtil.cleanupHashtag(hashtag).toLowerCase()); + } + + /** Returns a predicate that matches changes tagged with the provided {@code hashtag}. */ + public static Predicate<ChangeData> fuzzyHashtag(String hashtag) { + // Use toLowerCase without locale to match behavior in ChangeField. + return new ChangeIndexPredicate( + ChangeField.FUZZY_HASHTAG, HashtagsUtil.cleanupHashtag(hashtag).toLowerCase()); + } + + /** Returns a predicate that matches changes that modified the provided {@code file}. */ + public static Predicate<ChangeData> file(ChangeQueryBuilder.Arguments args, String file) { + Predicate<ChangeData> eqPath = path(file); + if (!args.getSchema().hasField(ChangeField.FILE_PART)) { + return eqPath; + } + return Predicate.or(eqPath, new ChangeIndexPredicate(ChangeField.FILE_PART, file)); + } + + /** + * Returns a predicate that matches changes with the provided {@code footer} in their commit + * message. + */ + public static Predicate<ChangeData> footer(String footer) { + int indexEquals = footer.indexOf('='); + int indexColon = footer.indexOf(':'); + + // footer key cannot contain '=' + if (indexEquals > 0 && (indexEquals < indexColon || indexColon < 0)) { + footer = footer.substring(0, indexEquals) + ": " + footer.substring(indexEquals + 1); + } + return new ChangeIndexPredicate(ChangeField.FOOTER, footer.toLowerCase(Locale.US)); + } + + /** + * Returns a predicate that matches changes that modified files in the provided {@code directory}. + */ + public static Predicate<ChangeData> directory(String directory) { + return new ChangeIndexPredicate( + ChangeField.DIRECTORY, CharMatcher.is('/').trimFrom(directory).toLowerCase(Locale.US)); + } + + /** Returns a predicate that matches changes with the provided {@code trackingId}. */ + public static Predicate<ChangeData> trackingId(String trackingId) { + return new ChangeIndexCardinalPredicate(ChangeField.TR, trackingId, 5); + } + + /** Returns a predicate that matches changes authored by the provided {@code exactAuthor}. */ + public static Predicate<ChangeData> exactAuthor(String exactAuthor) { + return new ChangeIndexPredicate(ChangeField.EXACT_AUTHOR, exactAuthor.toLowerCase(Locale.US)); + } + + /** Returns a predicate that matches changes authored by the provided {@code author}. */ + public static Predicate<ChangeData> author(String author) { + return new ChangeIndexPredicate(ChangeField.AUTHOR, author); + } + + /** + * Returns a predicate that matches changes where the patch set was committed by {@code + * exactCommitter}. + */ + public static Predicate<ChangeData> exactCommitter(String exactCommitter) { + return new ChangeIndexPredicate( + ChangeField.EXACT_COMMITTER, exactCommitter.toLowerCase(Locale.US)); + } + + /** + * Returns a predicate that matches changes where the patch set was committed by {@code + * committer}. + */ + public static Predicate<ChangeData> committer(String comitter) { + return new ChangeIndexPredicate(ChangeField.COMMITTER, comitter.toLowerCase(Locale.US)); + } + + /** Returns a predicate that matches changes whose ID starts with the provided {@code id}. */ + public static Predicate<ChangeData> idPrefix(String id) { + return new ChangeIndexCardinalPredicate(ChangeField.ID, id, 5); + } + + /** + * Returns a predicate that matches changes in a project that has the provided {@code prefix} in + * its name. + */ + public static Predicate<ChangeData> projectPrefix(String prefix) { + return new ChangeIndexPredicate(ChangeField.PROJECTS, prefix); + } + + /** + * Returns a predicate that matches changes where a patch set has the provided {@code commitId} + * either as prefix or as full {@link org.eclipse.jgit.lib.ObjectId}. + */ + public static Predicate<ChangeData> commitPrefix(String commitId) { + if (commitId.length() == ObjectIds.STR_LEN) { + return new ChangeIndexCardinalPredicate(ChangeField.EXACT_COMMIT, commitId, 5); + } + return new ChangeIndexCardinalPredicate(ChangeField.COMMIT, commitId, 5); + } + + /** + * Returns a predicate that matches changes where the provided {@code message} appears in the + * commit message. Uses full-text search semantics. + */ + public static Predicate<ChangeData> message(String message) { + return new ChangeIndexPredicate(ChangeField.COMMIT_MESSAGE, message); + } + + /** + * Returns a predicate that matches changes where the provided {@code comment} appears in any + * comment on any patch set of the change. Uses full-text search semantics. + */ + public static Predicate<ChangeData> comment(String comment) { + return new ChangeIndexPredicate(ChangeField.COMMENT, comment); + } + + /** + * Returns a predicate that matches with changes having a specific submit rule evaluating to a + * certain result. Value should be in the form of "$ruleName=$status" with $ruleName equals to + * '$plugin_name~$rule_name' and $rule_name equals to the name of the class that implements the + * {@link com.google.gerrit.server.rules.SubmitRule}. For gerrit core rules, $ruleName should be + * in the form of 'gerrit~$rule_name'. + */ + public static Predicate<ChangeData> submitRuleStatus(String value) { + return new ChangeIndexPredicate(ChangeField.SUBMIT_RULE_RESULT, value); + } +}
diff --git a/java/com/google/gerrit/server/query/change/ChangeQueryBuilder.java b/java/com/google/gerrit/server/query/change/ChangeQueryBuilder.java index b02b52d..fad3bac 100644 --- a/java/com/google/gerrit/server/query/change/ChangeQueryBuilder.java +++ b/java/com/google/gerrit/server/query/change/ChangeQueryBuilder.java
@@ -26,6 +26,7 @@ import com.google.common.base.Splitter; import com.google.common.collect.Iterables; import com.google.common.collect.Lists; +import com.google.common.collect.Sets; import com.google.common.flogger.FluentLogger; import com.google.common.primitives.Ints; import com.google.gerrit.entities.Account; @@ -33,9 +34,9 @@ import com.google.gerrit.entities.Address; import com.google.gerrit.entities.BranchNameKey; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.GroupDescription; import com.google.gerrit.entities.GroupReference; import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.entities.Project; import com.google.gerrit.entities.RefNames; import com.google.gerrit.entities.SubmitRecord; import com.google.gerrit.exceptions.NotSignedInException; @@ -77,8 +78,10 @@ import com.google.gerrit.server.notedb.ReviewerStateInternal; import com.google.gerrit.server.patch.PatchListCache; import com.google.gerrit.server.permissions.PermissionBackend; +import com.google.gerrit.server.plugincontext.PluginSetContext; import com.google.gerrit.server.project.ChildProjects; import com.google.gerrit.server.project.ProjectCache; +import com.google.gerrit.server.rules.SubmitRule; import com.google.gerrit.server.submit.SubmitDryRun; import com.google.inject.Inject; import com.google.inject.Provider; @@ -86,6 +89,7 @@ import com.google.inject.util.Providers; import java.io.IOException; import java.util.ArrayList; +import java.util.Arrays; import java.util.Collection; import java.util.Collections; import java.util.HashSet; @@ -100,6 +104,8 @@ import org.eclipse.jgit.errors.RepositoryNotFoundException; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.Repository; +import org.eclipse.jgit.revwalk.RevCommit; +import org.eclipse.jgit.revwalk.RevWalk; /** Parses a query string meant to be applied to change objects. */ public class ChangeQueryBuilder extends QueryBuilder<ChangeData, ChangeQueryBuilder> { @@ -138,6 +144,7 @@ public static final String FIELD_ADDED = "added"; public static final String FIELD_AGE = "age"; public static final String FIELD_ATTENTION_SET_USERS = "attentionusers"; + public static final String FIELD_ATTENTION_SET_USERS_COUNT = "attentionuserscount"; public static final String FIELD_ATTENTION_SET_FULL = "attentionfull"; public static final String FIELD_ASSIGNEE = "assignee"; public static final String FIELD_AUTHOR = "author"; @@ -175,7 +182,6 @@ public static final String FIELD_OWNERIN = "ownerin"; public static final String FIELD_PARENTOF = "parentof"; public static final String FIELD_PARENTPROJECT = "parentproject"; - public static final String FIELD_PATH = "path"; public static final String FIELD_PENDING_REVIEWER = "pendingreviewer"; public static final String FIELD_PENDING_REVIEWER_BY_EMAIL = "pendingreviewerbyemail"; public static final String FIELD_PRIVATE = "private"; @@ -183,21 +189,21 @@ public static final String FIELD_PROJECTS = "projects"; public static final String FIELD_REF = "ref"; public static final String FIELD_REVIEWEDBY = "reviewedby"; - public static final String FIELD_REVIEWER = "reviewer"; public static final String FIELD_REVIEWERIN = "reviewerin"; public static final String FIELD_STAR = "star"; public static final String FIELD_STARBY = "starby"; - public static final String FIELD_STARREDBY = "starredby"; public static final String FIELD_STARTED = "started"; public static final String FIELD_STATUS = "status"; public static final String FIELD_SUBMISSIONID = "submissionid"; public static final String FIELD_TR = "tr"; public static final String FIELD_UNRESOLVED_COMMENT_COUNT = "unresolved"; + public static final String FIELD_UPLOADER = "uploader"; + public static final String FIELD_UPLOADERIN = "uploaderin"; public static final String FIELD_VISIBLETO = "visibleto"; public static final String FIELD_WATCHEDBY = "watchedby"; public static final String FIELD_WIP = "wip"; public static final String FIELD_REVERTOF = "revertof"; - public static final String FIELD_CHERRY_PICK_OF = "cherrypickof"; + public static final String FIELD_CHERRYPICK = "cherrypick"; public static final String FIELD_CHERRY_PICK_OF_CHANGE = "cherrypickofchange"; public static final String FIELD_CHERRY_PICK_OF_PATCHSET = "cherrypickofpatchset"; @@ -205,7 +211,9 @@ public static final String ARG_ID_USER = "user"; public static final String ARG_ID_GROUP = "group"; public static final String ARG_ID_OWNER = "owner"; + public static final String ARG_ID_NON_UPLOADER = "non_uploader"; public static final Account.Id OWNER_ACCOUNT_ID = Account.id(0); + public static final Account.Id NON_UPLOADER_ACCOUNT_ID = Account.id(-1); public static final String OPERATOR_MERGED_BEFORE = "mergedbefore"; public static final String OPERATOR_MERGED_AFTER = "mergedafter"; @@ -246,7 +254,9 @@ final ChangeIsVisibleToPredicate.Factory changeIsVisbleToPredicateFactory; final OperatorAliasConfig operatorAliasConfig; final boolean indexMergeable; + final boolean conflictsPredicateEnabled; final HasOperandAliasConfig hasOperandAliasConfig; + final PluginSetContext<SubmitRule> submitRules; private final Provider<CurrentUser> self; @@ -281,7 +291,8 @@ OperatorAliasConfig operatorAliasConfig, @GerritServerConfig Config gerritConfig, HasOperandAliasConfig hasOperandAliasConfig, - ChangeIsVisibleToPredicate.Factory changeIsVisbleToPredicateFactory) { + ChangeIsVisibleToPredicate.Factory changeIsVisbleToPredicateFactory, + PluginSetContext<SubmitRule> submitRules) { this( queryProvider, rewriter, @@ -310,8 +321,10 @@ groupMembers, operatorAliasConfig, MergeabilityComputationBehavior.fromConfig(gerritConfig).includeInIndex(), + gerritConfig.getBoolean("change", null, "conflictsPredicateEnabled", true), hasOperandAliasConfig, - changeIsVisbleToPredicateFactory); + changeIsVisbleToPredicateFactory, + submitRules); } private Arguments( @@ -342,8 +355,10 @@ GroupMembers groupMembers, OperatorAliasConfig operatorAliasConfig, boolean indexMergeable, + boolean conflictsPredicateEnabled, HasOperandAliasConfig hasOperandAliasConfig, - ChangeIsVisibleToPredicate.Factory changeIsVisbleToPredicateFactory) { + ChangeIsVisibleToPredicate.Factory changeIsVisbleToPredicateFactory, + PluginSetContext<SubmitRule> submitRules) { this.queryProvider = queryProvider; this.rewriter = rewriter; this.opFactories = opFactories; @@ -372,7 +387,9 @@ this.changeIsVisbleToPredicateFactory = changeIsVisbleToPredicateFactory; this.operatorAliasConfig = operatorAliasConfig; this.indexMergeable = indexMergeable; + this.conflictsPredicateEnabled = conflictsPredicateEnabled; this.hasOperandAliasConfig = hasOperandAliasConfig; + this.submitRules = submitRules; } Arguments asUser(CurrentUser otherUser) { @@ -404,8 +421,10 @@ groupMembers, operatorAliasConfig, indexMergeable, + conflictsPredicateEnabled, hasOperandAliasConfig, - changeIsVisbleToPredicateFactory); + changeIsVisbleToPredicateFactory, + submitRules); } Arguments asUser(Account.Id otherId) { @@ -451,22 +470,22 @@ @Inject ChangeQueryBuilder(Arguments args) { this(mydef, args); - setupAliases(); } @VisibleForTesting protected ChangeQueryBuilder(Definition<ChangeData, ChangeQueryBuilder> def, Arguments args) { super(def, args.opFactories); this.args = args; + setupAliases(); } private void setupAliases() { - setOperatorAliases(args.operatorAliasConfig.getChangeQueryOperatorAliases()); - hasOperandAliases = args.hasOperandAliasConfig.getChangeQueryHasOperandAliases(); - } - - public Arguments getArgs() { - return args; + if (args.operatorAliasConfig != null) { + setOperatorAliases(args.operatorAliasConfig.getChangeQueryOperatorAliases()); + } + if (args.hasOperandAliasConfig != null) { + hasOperandAliases = args.hasOperandAliasConfig.getChangeQueryHasOperandAliases(); + } } public ChangeQueryBuilder asUser(CurrentUser user) { @@ -527,17 +546,17 @@ return Predicate.and( project(triplet.get().project().get()), branch(triplet.get().branch().branch()), - new ChangeIdPredicate(parseChangeId(triplet.get().id().get()))); + ChangePredicates.idPrefix(parseChangeId(triplet.get().id().get()))); } if (PAT_LEGACY_ID.matcher(query).matches()) { Integer id = Ints.tryParse(query); if (id != null) { return args.getSchema().useLegacyNumericFields() - ? new LegacyChangeIdPredicate(Change.id(id)) - : new LegacyChangeIdStrPredicate(Change.id(id)); + ? ChangePredicates.id(Change.id(id)) + : ChangePredicates.idStr(Change.id(id)); } } else if (PAT_CHANGE_ID.matcher(query).matches()) { - return new ChangeIdPredicate(parseChangeId(query)); + return ChangePredicates.idPrefix(parseChangeId(query)); } throw new QueryParseException("Invalid change format"); @@ -545,13 +564,13 @@ @Operator public Predicate<ChangeData> comment(String value) { - return new CommentPredicate(args.index, value); + return ChangePredicates.comment(value); } @Operator public Predicate<ChangeData> status(String statusName) { if ("reviewed".equalsIgnoreCase(statusName)) { - return IsReviewedPredicate.create(); + return ChangePredicates.unreviewed(); } return ChangeStatusPredicate.parse(statusName); } @@ -561,22 +580,55 @@ } @Operator + public Predicate<ChangeData> rule(String value) throws QueryParseException { + String ruleNameArg = value; + String statusArg = null; + String[] queryArgs = value.split("="); + if (queryArgs.length > 2) { + throw new QueryParseException( + "Invalid query arguments. Correct format is 'rule:<rule_name>=<status>' " + + "with <rule_name> in the form of <plugin>~<rule>. For Gerrit core rules, " + + "rule name should be specified either as gerrit~<rule> or <rule>."); + } + if (queryArgs.length == 2) { + ruleNameArg = queryArgs[0]; + statusArg = queryArgs[1]; + } + + // If ruleName is not prefixed by the plugin name, add the "gerrit~" prefix to it. + if (!ruleNameArg.contains("~")) { + ruleNameArg = "gerrit~" + ruleNameArg; + } + + return statusArg == null + ? Predicate.or( + Arrays.asList( + ChangePredicates.submitRuleStatus(ruleNameArg + "=" + SubmitRecord.Status.OK), + ChangePredicates.submitRuleStatus(ruleNameArg + "=" + SubmitRecord.Status.FORCED))) + : ChangePredicates.submitRuleStatus(ruleNameArg + "=" + statusArg); + } + + @Operator public Predicate<ChangeData> has(String value) throws QueryParseException { value = hasOperandAliases.getOrDefault(value, value); if ("star".equalsIgnoreCase(value)) { - return starredby(self()); - } - - if ("stars".equalsIgnoreCase(value)) { - return new HasStarsPredicate(self()); + return starredBySelf(); } if ("draft".equalsIgnoreCase(value)) { - return draftby(self()); + return draftBySelf(); } if ("edit".equalsIgnoreCase(value)) { - return new EditByPredicate(self()); + return ChangePredicates.editBy(self()); + } + + if ("attention".equalsIgnoreCase(value)) { + if (!args.index.getSchema().hasField(ChangeField.ATTENTION_SET_USERS)) { + throw new QueryParseException( + "'has:attention' operator is not supported by change index version"); + } + return new IsAttentionPredicate(); } if ("unresolved".equalsIgnoreCase(value)) { @@ -598,11 +650,11 @@ @Operator public Predicate<ChangeData> is(String value) throws QueryParseException { if ("starred".equalsIgnoreCase(value)) { - return starredby(self()); + return starredBySelf(); } if ("watched".equalsIgnoreCase(value)) { - return new IsWatchedByPredicate(args, false); + return new IsWatchedByPredicate(args); } if ("visible".equalsIgnoreCase(value)) { @@ -610,11 +662,19 @@ } if ("reviewed".equalsIgnoreCase(value)) { - return IsReviewedPredicate.create(); + return ChangePredicates.unreviewed(); } if ("owner".equalsIgnoreCase(value)) { - return new OwnerPredicate(self()); + return ChangePredicates.owner(self()); + } + + if ("uploader".equalsIgnoreCase(value)) { + if (!args.getSchema().hasField(ChangeField.UPLOADER)) { + throw new QueryParseException( + "'is:uploader' operator is not supported by change index version"); + } + return ChangePredicates.uploader(self()); } if ("reviewer".equalsIgnoreCase(value)) { @@ -652,12 +712,20 @@ "'is:private' operator is not supported by change index version"); } + if ("attention".equalsIgnoreCase(value)) { + if (!args.index.getSchema().hasField(ChangeField.ATTENTION_SET_USERS)) { + throw new QueryParseException( + "'is:attention' operator is not supported by change index version"); + } + return new IsAttentionPredicate(); + } + if ("assigned".equalsIgnoreCase(value)) { - return Predicate.not(new AssigneePredicate(Account.id(ChangeField.NO_ASSIGNEE))); + return Predicate.not(ChangePredicates.assignee(Account.id(ChangeField.NO_ASSIGNEE))); } if ("unassigned".equalsIgnoreCase(value)) { - return new AssigneePredicate(Account.id(ChangeField.NO_ASSIGNEE)); + return ChangePredicates.assignee(Account.id(ChangeField.NO_ASSIGNEE)); } if ("submittable".equalsIgnoreCase(value)) { @@ -673,7 +741,7 @@ } if ("ignored".equalsIgnoreCase(value)) { - return star("ignore"); + return ignoredBySelf(); } if ("started".equalsIgnoreCase(value)) { @@ -691,6 +759,14 @@ throw new QueryParseException("'is:wip' operator is not supported by change index version"); } + if ("cherrypick".equalsIgnoreCase(value)) { + if (args.getSchema().hasField(ChangeField.CHERRY_PICK)) { + return new BooleanPredicate(ChangeField.CHERRY_PICK); + } + throw new QueryParseException( + "'is:cherrypick' operator is not supported by change index version"); + } + // for plugins the value will be operandName_pluginName List<String> names = Lists.newArrayList(Splitter.on('_').split(value)); if (names.size() == 2) { @@ -704,11 +780,14 @@ @Operator public Predicate<ChangeData> commit(String id) { - return new CommitPredicate(id); + return ChangePredicates.commitPrefix(id); } @Operator public Predicate<ChangeData> conflicts(String value) throws QueryParseException { + if (!args.conflictsPredicateEnabled) { + throw new QueryParseException("'conflicts:' operator is not supported by server"); + } List<Change> changes = parseChange(value); List<Predicate<ChangeData>> or = new ArrayList<>(changes.size()); for (Change c : changes) { @@ -727,12 +806,12 @@ if (name.startsWith("^")) { return new RegexProjectPredicate(name); } - return new ProjectPredicate(name); + return ChangePredicates.project(Project.nameKey(name)); } @Operator public Predicate<ChangeData> projects(String name) { - return new ProjectPrefixPredicate(name); + return ChangePredicates.projectPrefix(name); } @Operator @@ -740,11 +819,28 @@ List<ChangeData> changes = parseChangeData(value); List<Predicate<ChangeData>> or = new ArrayList<>(changes.size()); for (ChangeData c : changes) { - or.add(new ParentOfPredicate(value, c, args.repoManager)); + for (RevCommit revCommit : getParents(c)) { + or.add(ChangePredicates.commitPrefix(revCommit.getId().getName())); + } } return Predicate.or(or); } + private Set<RevCommit> getParents(ChangeData change) { + PatchSet ps = change.currentPatchSet(); + try (Repository repo = args.repoManager.openRepository(change.project()); + RevWalk walk = new RevWalk(repo)) { + RevCommit c = walk.parseCommit(ps.commitId()); + return Sets.newHashSet(c.getParents()); + } catch (IOException e) { + throw new StorageException( + String.format( + "Loading commit %s for ps %d of change %d failed.", + ps.commitId(), ps.id().get(), ps.id().changeId().get()), + e); + } + } + @Operator public Predicate<ChangeData> parentproject(String name) { return new ParentProjectPredicate(args.projectCache, args.childProjects, name); @@ -790,12 +886,28 @@ @Operator public Predicate<ChangeData> hashtag(String hashtag) { - return new HashtagPredicate(hashtag); + return ChangePredicates.hashtag(hashtag); + } + + @Operator + public Predicate<ChangeData> inhashtag(String hashtag) throws QueryParseException { + if (hashtag.startsWith("^")) { + return new RegexHashtagPredicate(hashtag); + } + if (hashtag.isEmpty()) { + return ChangePredicates.hashtag(hashtag); + } + + if (!args.index.getSchema().hasField(ChangeField.FUZZY_HASHTAG)) { + throw new QueryParseException( + "'inhashtag' operator is not supported by change index version"); + } + return ChangePredicates.fuzzyHashtag(hashtag); } @Operator public Predicate<ChangeData> topic(String name) { - return new ExactTopicPredicate(name); + return ChangePredicates.exactTopic(name); } @Operator @@ -804,9 +916,9 @@ return new RegexTopicPredicate(name); } if (name.isEmpty()) { - return new ExactTopicPredicate(name); + return ChangePredicates.exactTopic(name); } - return new FuzzyTopicPredicate(name, args.index); + return ChangePredicates.fuzzyTopic(name); } @Operator @@ -814,7 +926,7 @@ if (ref.startsWith("^")) { return new RegexRefPredicate(ref); } - return new RefPredicate(ref); + return ChangePredicates.ref(ref); } @Operator @@ -827,7 +939,7 @@ if (file.startsWith("^")) { return new RegexPathPredicate(file); } - return EqualsFilePredicate.create(args, file); + return ChangePredicates.file(args, file); } @Operator @@ -835,7 +947,7 @@ if (path.startsWith("^")) { return new RegexPathPredicate(path); } - return new EqualsPathPredicate(FIELD_PATH, path); + return ChangePredicates.path(path); } @Operator @@ -868,7 +980,7 @@ @Operator public Predicate<ChangeData> footer(String footer) throws QueryParseException { if (args.getSchema().hasField(ChangeField.FOOTER)) { - return new FooterPredicate(footer); + return ChangePredicates.footer(footer); } throw new QueryParseException("'footer' operator is not supported by change index version"); } @@ -884,7 +996,7 @@ if (directory.startsWith("^")) { return new RegexDirectoryPredicate(directory); } - return new DirectoryPredicate(directory); + return ChangePredicates.directory(directory); } throw new QueryParseException("'directory' operator is not supported by change index version"); } @@ -915,6 +1027,8 @@ if (pair.getKey().equalsIgnoreCase(ARG_ID_USER)) { if (pair.getValue().equals(ARG_ID_OWNER)) { accounts = Collections.singleton(OWNER_ACCOUNT_ID); + } else if (pair.getValue().equals(ARG_ID_NON_UPLOADER)) { + accounts = Collections.singleton(NON_UPLOADER_ACCOUNT_ID); } else { accounts = parseAccount(pair.getValue()); } @@ -932,6 +1046,8 @@ try { if (value.equals(ARG_ID_OWNER)) { accounts = Collections.singleton(OWNER_ACCOUNT_ID); + } else if (value.equals(ARG_ID_NON_UPLOADER)) { + accounts = Collections.singleton(NON_UPLOADER_ACCOUNT_ID); } else { accounts = parseAccount(value); } @@ -956,7 +1072,7 @@ int eq = name.indexOf('='); if (args.getSchema().hasField(ChangeField.SUBMIT_RECORD) && eq > 0) { String statusName = name.substring(eq + 1).toUpperCase(); - if (!isInt(statusName)) { + if (!isInt(statusName) && !MagicLabelValue.tryParse(statusName).isPresent()) { SubmitRecord.Label.Status status = Enums.getIfPresent(SubmitRecord.Label.Status.class, statusName).orNull(); if (status == null) { @@ -981,70 +1097,30 @@ @Operator public Predicate<ChangeData> message(String text) { - return new MessagePredicate(args.index, text); + return ChangePredicates.message(text); } @Operator public Predicate<ChangeData> star(String label) throws QueryParseException { - return new StarPredicate(self(), label); - } - - @Operator - public Predicate<ChangeData> starredby(String who) - throws QueryParseException, IOException, ConfigInvalidException { - return starredby(parseAccount(who)); - } - - private Predicate<ChangeData> starredby(Set<Account.Id> who) { - List<Predicate<ChangeData>> p = Lists.newArrayListWithCapacity(who.size()); - for (Account.Id id : who) { - p.add(starredby(id)); + if ("ignore".equalsIgnoreCase(label)) { + return ignoredBySelf(); } - return Predicate.or(p); - } - - private Predicate<ChangeData> starredby(Account.Id who) { - return new StarPredicate(who, StarredChangesUtil.DEFAULT_LABEL); - } - - @Operator - public Predicate<ChangeData> watchedby(String who) - throws QueryParseException, IOException, ConfigInvalidException { - Set<Account.Id> m = parseAccount(who); - List<IsWatchedByPredicate> p = Lists.newArrayListWithCapacity(m.size()); - - Account.Id callerId; - try { - CurrentUser caller = args.self.get(); - callerId = caller.isIdentifiedUser() ? caller.getAccountId() : null; - } catch (ProvisionException e) { - callerId = null; + if ("star".equalsIgnoreCase(label)) { + return starredBySelf(); } - - for (Account.Id id : m) { - // Each child IsWatchedByPredicate includes a visibility filter for the - // corresponding user, to ensure that predicate subtree only returns - // changes visible to that user. The exception is if one of the users is - // the caller of this method, in which case visibility is already being - // checked at the top level. - p.add(new IsWatchedByPredicate(args.asUser(id), !id.equals(callerId))); - } - return Predicate.or(p); + throw new IllegalArgumentException(); } - @Operator - public Predicate<ChangeData> draftby(String who) - throws QueryParseException, IOException, ConfigInvalidException { - Set<Account.Id> m = parseAccount(who); - List<Predicate<ChangeData>> p = Lists.newArrayListWithCapacity(m.size()); - for (Account.Id id : m) { - p.add(draftby(id)); - } - return Predicate.or(p); + private Predicate<ChangeData> ignoredBySelf() throws QueryParseException { + return new StarPredicate(self(), StarredChangesUtil.IGNORE_LABEL); } - private Predicate<ChangeData> draftby(Account.Id who) { - return new HasDraftByPredicate(who); + private Predicate<ChangeData> starredBySelf() throws QueryParseException { + return new StarPredicate(self(), StarredChangesUtil.DEFAULT_LABEL); + } + + private Predicate<ChangeData> draftBySelf() throws QueryParseException { + return ChangePredicates.draftBy(self()); } @Operator @@ -1103,9 +1179,9 @@ } private Predicate<ChangeData> owner(Set<Account.Id> who) { - List<OwnerPredicate> p = Lists.newArrayListWithCapacity(who.size()); + List<Predicate<ChangeData>> p = Lists.newArrayListWithCapacity(who.size()); for (Account.Id id : who) { - p.add(new OwnerPredicate(id)); + p.add(ChangePredicates.owner(id)); } return Predicate.or(p); } @@ -1120,6 +1196,23 @@ } @Operator + public Predicate<ChangeData> uploader(String who) + throws QueryParseException, IOException, ConfigInvalidException { + if (!args.getSchema().hasField(ChangeField.UPLOADER)) { + throw new QueryParseException("'uploader' operator is not supported by change index version"); + } + return uploader(parseAccount(who, (AccountState s) -> true)); + } + + private Predicate<ChangeData> uploader(Set<Account.Id> who) { + List<Predicate<ChangeData>> p = Lists.newArrayListWithCapacity(who.size()); + for (Account.Id id : who) { + p.add(ChangePredicates.uploader(id)); + } + return Predicate.or(p); + } + + @Operator public Predicate<ChangeData> attention(String who) throws QueryParseException, IOException, ConfigInvalidException { if (!args.index.getSchema().hasField(ChangeField.ATTENTION_SET_USERS)) { @@ -1130,7 +1223,7 @@ } private Predicate<ChangeData> attention(Set<Account.Id> who) { - return Predicate.or(who.stream().map(AttentionSetPredicate::new).collect(toImmutableSet())); + return Predicate.or(who.stream().map(ChangePredicates::attentionSet).collect(toImmutableSet())); } @Operator @@ -1140,30 +1233,45 @@ } private Predicate<ChangeData> assignee(Set<Account.Id> who) { - List<AssigneePredicate> p = Lists.newArrayListWithCapacity(who.size()); + List<Predicate<ChangeData>> p = Lists.newArrayListWithCapacity(who.size()); for (Account.Id id : who) { - p.add(new AssigneePredicate(id)); + p.add(ChangePredicates.assignee(id)); } return Predicate.or(p); } @Operator public Predicate<ChangeData> ownerin(String group) throws QueryParseException, IOException { - GroupReference g = GroupBackends.findBestSuggestion(args.groupBackend, group); - if (g == null) { - throw error("Group " + group + " not found"); - } - + GroupReference g = parseGroup(group); AccountGroup.UUID groupId = g.getUUID(); - GroupDescription.Basic groupDescription = args.groupBackend.get(groupId); - if (!(groupDescription instanceof GroupDescription.Internal)) { + if (args.groupBackend.isOrContainsExternalGroup(groupId)) { return new OwnerinPredicate(args.userFactory, groupId); } Set<Account.Id> accounts = getMembers(groupId); - List<OwnerPredicate> p = Lists.newArrayListWithCapacity(accounts.size()); + List<Predicate<ChangeData>> p = Lists.newArrayListWithCapacity(accounts.size()); for (Account.Id id : accounts) { - p.add(new OwnerPredicate(id)); + p.add(ChangePredicates.owner(id)); + } + return Predicate.or(p); + } + + @Operator + public Predicate<ChangeData> uploaderin(String group) throws QueryParseException, IOException { + if (!args.getSchema().hasField(ChangeField.UPLOADER)) { + throw new QueryParseException("'uploader' operator is not supported by change index version"); + } + + GroupReference g = parseGroup(group); + AccountGroup.UUID groupId = g.getUUID(); + if (args.groupBackend.isOrContainsExternalGroup(groupId)) { + return new UploaderinPredicate(args.userFactory, groupId); + } + + Set<Account.Id> accounts = getMembers(groupId); + List<Predicate<ChangeData>> p = Lists.newArrayListWithCapacity(accounts.size()); + for (Account.Id id : accounts) { + p.add(ChangePredicates.uploader(id)); } return Predicate.or(p); } @@ -1206,16 +1314,13 @@ @Operator public Predicate<ChangeData> reviewerin(String group) throws QueryParseException { - GroupReference g = GroupBackends.findBestSuggestion(args.groupBackend, group); - if (g == null) { - throw error("Group " + group + " not found"); - } + GroupReference g = parseGroup(group); return new ReviewerinPredicate(args.userFactory, g.getUUID()); } @Operator public Predicate<ChangeData> tr(String trackingId) { - return new TrackingIdPredicate(trackingId); + return ChangePredicates.trackingId(trackingId); } @Operator @@ -1259,9 +1364,9 @@ } private Predicate<ChangeData> commentby(Set<Account.Id> who) { - List<CommentByPredicate> p = Lists.newArrayListWithCapacity(who.size()); + List<Predicate<ChangeData>> p = Lists.newArrayListWithCapacity(who.size()); for (Account.Id id : who) { - p.add(new CommentByPredicate(id)); + p.add(ChangePredicates.commentBy(id)); } return Predicate.or(p); } @@ -1321,7 +1426,7 @@ @Operator public Predicate<ChangeData> reviewedby(String who) throws QueryParseException, IOException, ConfigInvalidException { - return IsReviewedPredicate.create(parseAccount(who)); + return ChangePredicates.reviewedBy(parseAccount(who)); } @Operator @@ -1373,18 +1478,18 @@ public Predicate<ChangeData> author(String who) throws QueryParseException { if (args.getSchema().hasField(ChangeField.EXACT_AUTHOR)) { return getAuthorOrCommitterPredicate( - who.trim(), ExactAuthorPredicate::new, AuthorPredicate::new); + who.trim(), ChangePredicates::exactAuthor, ChangePredicates::author); } - return getAuthorOrCommitterFullTextPredicate(who.trim(), AuthorPredicate::new); + return getAuthorOrCommitterFullTextPredicate(who.trim(), ChangePredicates::author); } @Operator public Predicate<ChangeData> committer(String who) throws QueryParseException { if (args.getSchema().hasField(ChangeField.EXACT_COMMITTER)) { return getAuthorOrCommitterPredicate( - who.trim(), ExactCommitterPredicate::new, CommitterPredicate::new); + who.trim(), ChangePredicates::exactCommitter, ChangePredicates::committer); } - return getAuthorOrCommitterFullTextPredicate(who.trim(), CommitterPredicate::new); + return getAuthorOrCommitterFullTextPredicate(who.trim(), ChangePredicates::committer); } @Operator @@ -1404,8 +1509,11 @@ @Operator public Predicate<ChangeData> revertof(String value) throws QueryParseException { + if (value == null || Ints.tryParse(value) == null) { + throw new QueryParseException("'revertof' must be an integer"); + } if (args.getSchema().hasField(ChangeField.REVERT_OF)) { - return new RevertOfPredicate(value); + return ChangePredicates.revertOf(Change.id(Ints.tryParse(value))); } throw new QueryParseException("'revertof' operator is not supported by change index version"); } @@ -1413,7 +1521,7 @@ @Operator public Predicate<ChangeData> submissionId(String value) throws QueryParseException { if (args.getSchema().hasField(ChangeField.SUBMISSIONID)) { - return new SubmissionIdPredicate(value); + return ChangePredicates.submissionId(value); } throw new QueryParseException( "'submissionid' operator is not supported by change index version"); @@ -1424,13 +1532,11 @@ if (args.getSchema().hasField(ChangeField.CHERRY_PICK_OF_CHANGE) && args.getSchema().hasField(ChangeField.CHERRY_PICK_OF_PATCHSET)) { if (Ints.tryParse(value) != null) { - return new CherryPickOfChangePredicate(value); + return ChangePredicates.cherryPickOf(Change.id(Ints.tryParse(value))); } try { PatchSet.Id patchSetId = PatchSet.Id.parse(value); - return Predicate.and( - new CherryPickOfChangePredicate(patchSetId.changeId().toString()), - new CherryPickOfPatchSetPredicate(patchSetId.getId())); + return ChangePredicates.cherryPickOf(patchSetId); } catch (IllegalArgumentException e) { throw new QueryParseException( "'"
diff --git a/java/com/google/gerrit/server/query/change/ChangeQueryProcessor.java b/java/com/google/gerrit/server/query/change/ChangeQueryProcessor.java index 0f0535a..3097224 100644 --- a/java/com/google/gerrit/server/query/change/ChangeQueryProcessor.java +++ b/java/com/google/gerrit/server/query/change/ChangeQueryProcessor.java
@@ -17,6 +17,7 @@ import static com.google.common.base.Preconditions.checkState; import static com.google.gerrit.server.query.change.ChangeQueryBuilder.FIELD_LIMIT; +import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableListMultimap; import com.google.gerrit.entities.Change; import com.google.gerrit.extensions.common.PluginDefinedInfo; @@ -42,6 +43,7 @@ import com.google.gerrit.server.notedb.Sequences; import com.google.inject.Inject; import com.google.inject.Provider; +import com.google.inject.Singleton; import java.util.ArrayList; import java.util.Collection; import java.util.HashMap; @@ -65,6 +67,14 @@ private final Sequences sequences; private final IndexConfig indexConfig; + @Singleton + protected static class ChangeQueryMetrics extends QueryProcessor.Metrics { + @Inject + protected ChangeQueryMetrics(MetricMaker metricMaker) { + super(metricMaker); + } + } + static { // It is assumed that basic rewrites do not touch visibleto predicates. checkState( @@ -76,7 +86,7 @@ ChangeQueryProcessor( Provider<CurrentUser> userProvider, AccountLimits.Factory limitsFactory, - MetricMaker metricMaker, + ChangeQueryMetrics changeQueryMetrics, IndexConfig indexConfig, ChangeIndexCollection indexes, ChangeIndexRewriter rewriter, @@ -84,7 +94,7 @@ ChangeIsVisibleToPredicate.Factory changeIsVisibleToPredicateFactory, DynamicSet<ChangePluginDefinedInfoFactory> changePluginDefinedInfoFactories) { super( - metricMaker, + changeQueryMetrics, ChangeSchemaDefinitions.INSTANCE, indexConfig, indexes, @@ -143,7 +153,9 @@ @Override protected Predicate<ChangeData> enforceVisibility(Predicate<ChangeData> pred) { return new AndChangeSource( - pred, changeIsVisibleToPredicateFactory.forUser(userProvider.get()), start, indexConfig); + ImmutableList.of(pred, changeIsVisibleToPredicateFactory.forUser(userProvider.get())), + start, + indexConfig); } @Override
diff --git a/java/com/google/gerrit/server/query/change/ChangeStatusPredicate.java b/java/com/google/gerrit/server/query/change/ChangeStatusPredicate.java index 47445f6..4a56cdf 100644 --- a/java/com/google/gerrit/server/query/change/ChangeStatusPredicate.java +++ b/java/com/google/gerrit/server/query/change/ChangeStatusPredicate.java
@@ -125,11 +125,6 @@ } @Override - public int getCost() { - return 0; - } - - @Override public int hashCode() { return Objects.hashCode(status); }
diff --git a/java/com/google/gerrit/server/query/change/CherryPickOfChangePredicate.java b/java/com/google/gerrit/server/query/change/CherryPickOfChangePredicate.java deleted file mode 100644 index d452017..0000000 --- a/java/com/google/gerrit/server/query/change/CherryPickOfChangePredicate.java +++ /dev/null
@@ -1,36 +0,0 @@ -// Copyright (C) 2019 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.server.index.change.ChangeField; - -public class CherryPickOfChangePredicate extends ChangeIndexPredicate { - public CherryPickOfChangePredicate(String cherryPickOfChange) { - super(ChangeField.CHERRY_PICK_OF_CHANGE, cherryPickOfChange); - } - - @Override - public boolean match(ChangeData cd) { - if (cd.change().getCherryPickOf() == null) { - return false; - } - return Integer.toString(cd.change().getCherryPickOf().changeId().get()).equals(value); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/CherryPickOfPatchSetPredicate.java b/java/com/google/gerrit/server/query/change/CherryPickOfPatchSetPredicate.java deleted file mode 100644 index 888f45d..0000000 --- a/java/com/google/gerrit/server/query/change/CherryPickOfPatchSetPredicate.java +++ /dev/null
@@ -1,36 +0,0 @@ -// Copyright (C) 2019 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.server.index.change.ChangeField; - -public class CherryPickOfPatchSetPredicate extends ChangeIndexPredicate { - public CherryPickOfPatchSetPredicate(String cherryPickOfPatchSet) { - super(ChangeField.CHERRY_PICK_OF_PATCHSET, cherryPickOfPatchSet); - } - - @Override - public boolean match(ChangeData cd) { - if (cd.change().getCherryPickOf() == null) { - return false; - } - return cd.change().getCherryPickOf().getId().equals(value); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/CommentByPredicate.java b/java/com/google/gerrit/server/query/change/CommentByPredicate.java deleted file mode 100644 index b8cf100..0000000 --- a/java/com/google/gerrit/server/query/change/CommentByPredicate.java +++ /dev/null
@@ -1,54 +0,0 @@ -// Copyright (C) 2015 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.entities.ChangeMessage; -import com.google.gerrit.entities.HumanComment; -import com.google.gerrit.server.index.change.ChangeField; -import java.util.Objects; - -public class CommentByPredicate extends ChangeIndexPredicate { - protected final Account.Id id; - - public CommentByPredicate(Account.Id id) { - super(ChangeField.COMMENTBY, id.toString()); - this.id = id; - } - - Account.Id getAccountId() { - return id; - } - - @Override - public boolean match(ChangeData cd) { - for (ChangeMessage m : cd.messages()) { - if (Objects.equals(m.getAuthor(), id)) { - return true; - } - } - for (HumanComment c : cd.publishedComments()) { - if (Objects.equals(c.author.getId(), id)) { - return true; - } - } - return false; - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/CommentPredicate.java b/java/com/google/gerrit/server/query/change/CommentPredicate.java deleted file mode 100644 index 4b14f08..0000000 --- a/java/com/google/gerrit/server/query/change/CommentPredicate.java +++ /dev/null
@@ -1,59 +0,0 @@ -// Copyright (C) 2013 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Change; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.server.index.change.ChangeField; -import com.google.gerrit.server.index.change.ChangeIndex; -import com.google.gerrit.server.index.change.IndexedChangeQuery; - -public class CommentPredicate extends ChangeIndexPredicate { - protected final ChangeIndex index; - - public CommentPredicate(ChangeIndex index, String value) { - super(ChangeField.COMMENT, value); - this.index = index; - } - - @Override - public boolean match(ChangeData object) { - try { - Change.Id id = object.getId(); - Predicate<ChangeData> p = - Predicate.and( - index.getSchema().useLegacyNumericFields() - ? new LegacyChangeIdPredicate(id) - : new LegacyChangeIdStrPredicate(id), - this); - for (ChangeData cData : index.getSource(p, IndexedChangeQuery.oneResult()).read()) { - if (cData.getId().equals(id)) { - return true; - } - } - } catch (QueryParseException e) { - throw new StorageException(e); - } - - return false; - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/CommitPredicate.java b/java/com/google/gerrit/server/query/change/CommitPredicate.java deleted file mode 100644 index 970c222..0000000 --- a/java/com/google/gerrit/server/query/change/CommitPredicate.java +++ /dev/null
@@ -1,65 +0,0 @@ -// Copyright (C) 2015 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.git.ObjectIds.matchesAbbreviation; -import static com.google.gerrit.server.index.change.ChangeField.COMMIT; -import static com.google.gerrit.server.index.change.ChangeField.EXACT_COMMIT; - -import com.google.gerrit.entities.PatchSet; -import com.google.gerrit.git.ObjectIds; -import com.google.gerrit.index.FieldDef; -import com.google.gerrit.index.query.HasCardinality; - -public class CommitPredicate extends ChangeIndexPredicate implements HasCardinality { - static FieldDef<ChangeData, ?> commitField(String id) { - if (id.length() == ObjectIds.STR_LEN) { - return EXACT_COMMIT; - } - return COMMIT; - } - - public CommitPredicate(String id) { - super(commitField(id), id); - } - - @Override - public boolean match(ChangeData object) { - String id = getValue().toLowerCase(); - for (PatchSet p : object.patchSets()) { - if (equals(p, id)) { - return true; - } - } - return false; - } - - protected boolean equals(PatchSet p, String id) { - if (getField() == EXACT_COMMIT) { - return p.commitId().name().equals(id); - } - return matchesAbbreviation(p.commitId(), id); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 5; - } -}
diff --git a/java/com/google/gerrit/server/query/change/CommitterPredicate.java b/java/com/google/gerrit/server/query/change/CommitterPredicate.java deleted file mode 100644 index 1dcf97f..0000000 --- a/java/com/google/gerrit/server/query/change/CommitterPredicate.java +++ /dev/null
@@ -1,36 +0,0 @@ -// Copyright (C) 2015 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.COMMITTER; -import static com.google.gerrit.server.query.change.ChangeQueryBuilder.FIELD_COMMITTER; - -import com.google.gerrit.server.index.change.ChangeField; - -public class CommitterPredicate extends ChangeIndexPredicate { - public CommitterPredicate(String value) { - super(COMMITTER, FIELD_COMMITTER, value.toLowerCase()); - } - - @Override - public boolean match(ChangeData object) { - return ChangeField.getCommitterParts(object).contains(getValue().toLowerCase()); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/ConflictsPredicate.java b/java/com/google/gerrit/server/query/change/ConflictsPredicate.java index f4af4ca..f95dbb0 100644 --- a/java/com/google/gerrit/server/query/change/ConflictsPredicate.java +++ b/java/com/google/gerrit/server/query/change/ConflictsPredicate.java
@@ -83,17 +83,17 @@ List<Predicate<ChangeData>> filePredicates = new ArrayList<>(files.size()); for (String file : files) { - filePredicates.add(new EqualsPathPredicate(ChangeQueryBuilder.FIELD_PATH, file)); + filePredicates.add(ChangePredicates.path(file)); } List<Predicate<ChangeData>> and = new ArrayList<>(5); - and.add(new ProjectPredicate(c.getProject().get())); - and.add(new RefPredicate(c.getDest().branch())); + and.add(ChangePredicates.project(c.getProject())); + and.add(ChangePredicates.ref(c.getDest().branch())); and.add( Predicate.not( args.getSchema().useLegacyNumericFields() - ? new LegacyChangeIdPredicate(c.getId()) - : new LegacyChangeIdStrPredicate(c.getId()))); + ? ChangePredicates.id(c.getId()) + : ChangePredicates.idStr(c.getId()))); and.add(Predicate.or(filePredicates)); ChangeDataCache changeDataCache = new ChangeDataCache(cd, args.projectCache);
diff --git a/java/com/google/gerrit/server/query/change/DirectoryPredicate.java b/java/com/google/gerrit/server/query/change/DirectoryPredicate.java deleted file mode 100644 index 3ab3e26..0000000 --- a/java/com/google/gerrit/server/query/change/DirectoryPredicate.java +++ /dev/null
@@ -1,39 +0,0 @@ -// Copyright (C) 2019 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.common.base.CharMatcher; -import com.google.gerrit.server.index.change.ChangeField; -import java.util.Locale; - -public class DirectoryPredicate extends ChangeIndexPredicate { - private static String clean(String directory) { - return CharMatcher.is('/').trimFrom(directory).toLowerCase(Locale.US); - } - - DirectoryPredicate(String value) { - super(ChangeField.DIRECTORY, clean(value)); - } - - @Override - public boolean match(ChangeData cd) { - return ChangeField.getDirectories(cd).contains(value); - } - - @Override - public int getCost() { - return 0; - } -}
diff --git a/java/com/google/gerrit/server/query/change/EditByPredicate.java b/java/com/google/gerrit/server/query/change/EditByPredicate.java deleted file mode 100644 index 0fd66f8..0000000 --- a/java/com/google/gerrit/server/query/change/EditByPredicate.java +++ /dev/null
@@ -1,37 +0,0 @@ -// Copyright (C) 2015 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.server.index.change.ChangeField; - -public class EditByPredicate extends ChangeIndexPredicate { - protected final Account.Id id; - - public EditByPredicate(Account.Id id) { - super(ChangeField.EDITBY, id.toString()); - this.id = id; - } - - @Override - public boolean match(ChangeData cd) { - return cd.editsByUser().contains(id); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/EqualsFilePredicate.java b/java/com/google/gerrit/server/query/change/EqualsFilePredicate.java deleted file mode 100644 index 9c033b6..0000000 --- a/java/com/google/gerrit/server/query/change/EqualsFilePredicate.java +++ /dev/null
@@ -1,43 +0,0 @@ -// Copyright (C) 2013 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.server.index.change.ChangeField; -import com.google.gerrit.server.query.change.ChangeQueryBuilder.Arguments; - -public class EqualsFilePredicate extends ChangeIndexPredicate { - public static Predicate<ChangeData> create(Arguments args, String value) { - Predicate<ChangeData> eqPath = new EqualsPathPredicate(ChangeQueryBuilder.FIELD_FILE, value); - if (!args.getSchema().hasField(ChangeField.FILE_PART)) { - return eqPath; - } - return Predicate.or(eqPath, new EqualsFilePredicate(value)); - } - - private EqualsFilePredicate(String value) { - super(ChangeField.FILE_PART, ChangeQueryBuilder.FIELD_FILE, value); - } - - @Override - public boolean match(ChangeData object) { - return ChangeField.getFileParts(object).contains(value); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/EqualsLabelPredicate.java b/java/com/google/gerrit/server/query/change/EqualsLabelPredicate.java deleted file mode 100644 index 7f910f1..0000000 --- a/java/com/google/gerrit/server/query/change/EqualsLabelPredicate.java +++ /dev/null
@@ -1,146 +0,0 @@ -// Copyright (C) 2013 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.entities.AccountGroup; -import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.LabelType; -import com.google.gerrit.entities.LabelTypes; -import com.google.gerrit.entities.PatchSetApproval; -import com.google.gerrit.extensions.restapi.AuthException; -import com.google.gerrit.server.IdentifiedUser; -import com.google.gerrit.server.index.change.ChangeField; -import com.google.gerrit.server.permissions.ChangePermission; -import com.google.gerrit.server.permissions.PermissionBackend; -import com.google.gerrit.server.permissions.PermissionBackendException; -import com.google.gerrit.server.project.ProjectCache; -import com.google.gerrit.server.project.ProjectState; -import java.util.Optional; - -public class EqualsLabelPredicate extends ChangeIndexPostFilterPredicate { - protected final ProjectCache projectCache; - protected final PermissionBackend permissionBackend; - protected final IdentifiedUser.GenericFactory userFactory; - protected final String label; - protected final int expVal; - protected final Account.Id account; - protected final AccountGroup.UUID group; - - public EqualsLabelPredicate( - LabelPredicate.Args args, String label, int expVal, Account.Id account) { - super(ChangeField.LABEL, ChangeField.formatLabel(label, expVal, account)); - this.permissionBackend = args.permissionBackend; - this.projectCache = args.projectCache; - this.userFactory = args.userFactory; - this.group = args.group; - this.label = label; - this.expVal = expVal; - this.account = account; - } - - @Override - public boolean match(ChangeData object) { - Change c = object.change(); - if (c == null) { - // The change has disappeared. - // - return false; - } - - Optional<ProjectState> project = projectCache.get(c.getDest().project()); - if (!project.isPresent()) { - // The project has disappeared. - // - return false; - } - - LabelType labelType = type(project.get().getLabelTypes(), label); - if (labelType == null) { - return false; // Label is not defined by this project. - } - - boolean hasVote = false; - object.setStorageConstraint(ChangeData.StorageConstraint.INDEX_PRIMARY_NOTEDB_SECONDARY); - for (PatchSetApproval p : object.currentApprovals()) { - if (labelType.matches(p)) { - hasVote = true; - if (match(object, p.value(), p.accountId())) { - return true; - } - } - } - - if (!hasVote && expVal == 0) { - return true; - } - - return false; - } - - protected static LabelType type(LabelTypes types, String toFind) { - if (types.byLabel(toFind) != null) { - return types.byLabel(toFind); - } - - for (LabelType lt : types.getLabelTypes()) { - if (toFind.equalsIgnoreCase(lt.getName())) { - return lt; - } - } - return null; - } - - protected boolean match(ChangeData cd, short value, Account.Id approver) { - if (value != expVal) { - return false; - } - - if (account != null - && !account.equals(approver) - && !account.equals(ChangeQueryBuilder.OWNER_ACCOUNT_ID)) { - return false; - } - - if (account != null - && account.equals(ChangeQueryBuilder.OWNER_ACCOUNT_ID) - && !cd.change().getOwner().equals(approver)) { - return false; - } - - IdentifiedUser reviewer = userFactory.create(approver); - if (group != null && !reviewer.getEffectiveGroups().contains(group)) { - return false; - } - - // Check the user has 'READ' permission. - try { - PermissionBackend.ForChange perm = permissionBackend.absentUser(approver).change(cd); - if (!projectCache.get(cd.project()).map(ProjectState::statePermitsRead).orElse(false)) { - return false; - } - - perm.check(ChangePermission.READ); - return true; - } catch (PermissionBackendException | AuthException e) { - return false; - } - } - - @Override - public int getCost() { - return 1 + (group == null ? 0 : 1); - } -}
diff --git a/java/com/google/gerrit/server/query/change/EqualsLabelPredicates.java b/java/com/google/gerrit/server/query/change/EqualsLabelPredicates.java new file mode 100644 index 0000000..7f3978d --- /dev/null +++ b/java/com/google/gerrit/server/query/change/EqualsLabelPredicates.java
@@ -0,0 +1,199 @@ +// Copyright (C) 2013 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import com.google.gerrit.entities.Account; +import com.google.gerrit.entities.AccountGroup; +import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.LabelType; +import com.google.gerrit.entities.LabelTypes; +import com.google.gerrit.entities.PatchSetApproval; +import com.google.gerrit.extensions.restapi.AuthException; +import com.google.gerrit.index.query.PostFilterPredicate; +import com.google.gerrit.server.IdentifiedUser; +import com.google.gerrit.server.index.change.ChangeField; +import com.google.gerrit.server.permissions.ChangePermission; +import com.google.gerrit.server.permissions.PermissionBackend; +import com.google.gerrit.server.permissions.PermissionBackendException; +import com.google.gerrit.server.project.ProjectCache; +import com.google.gerrit.server.project.ProjectState; +import java.util.Optional; + +public class EqualsLabelPredicates { + public static class PostFilterEqualsLabelPredicate extends PostFilterPredicate<ChangeData> { + private final Matcher matcher; + + public PostFilterEqualsLabelPredicate(LabelPredicate.Args args, String label, int expVal) { + super(ChangeQueryBuilder.FIELD_LABEL, ChangeField.formatLabel(label, expVal)); + matcher = new Matcher(args, label, expVal); + } + + @Override + public boolean match(ChangeData object) { + return matcher.match(object); + } + + @Override + public int getCost() { + return 2; + } + } + + public static class IndexEqualsLabelPredicate extends ChangeIndexPostFilterPredicate { + private final Matcher matcher; + + public IndexEqualsLabelPredicate(LabelPredicate.Args args, String label, int expVal) { + this(args, label, expVal, null); + } + + public IndexEqualsLabelPredicate( + LabelPredicate.Args args, String label, int expVal, Account.Id account) { + super(ChangeField.LABEL, ChangeField.formatLabel(label, expVal, account)); + this.matcher = new Matcher(args, label, expVal, account); + } + + @Override + public boolean match(ChangeData object) { + return matcher.match(object); + } + + @Override + public int getCost() { + return 1 + (matcher.group == null ? 0 : 1); + } + } + + private static class Matcher { + protected final ProjectCache projectCache; + protected final PermissionBackend permissionBackend; + protected final IdentifiedUser.GenericFactory userFactory; + protected final String label; + protected final int expVal; + protected final Account.Id account; + protected final AccountGroup.UUID group; + + public Matcher(LabelPredicate.Args args, String label, int expVal) { + this(args, label, expVal, null); + } + + public Matcher(LabelPredicate.Args args, String label, int expVal, Account.Id account) { + this.permissionBackend = args.permissionBackend; + this.projectCache = args.projectCache; + this.userFactory = args.userFactory; + this.group = args.group; + this.label = label; + this.expVal = expVal; + this.account = account; + } + + public boolean match(ChangeData cd) { + Change c = cd.change(); + if (c == null) { + // The change has disappeared. + return false; + } + + Optional<ProjectState> project = projectCache.get(c.getDest().project()); + if (!project.isPresent()) { + // The project has disappeared. + return false; + } + + LabelType labelType = type(project.get().getLabelTypes(), label); + if (labelType == null) { + return false; // Label is not defined by this project. + } + + boolean hasVote = false; + cd.setStorageConstraint(ChangeData.StorageConstraint.INDEX_PRIMARY_NOTEDB_SECONDARY); + for (PatchSetApproval psa : cd.currentApprovals()) { + if (labelType.matches(psa)) { + hasVote = true; + if (match(cd, psa)) { + return true; + } + } + } + + if (!hasVote && expVal == 0) { + return true; + } + + return false; + } + + private boolean match(ChangeData cd, PatchSetApproval psa) { + if (psa.value() != expVal) { + return false; + } + Account.Id approver = psa.accountId(); + + if (account != null) { + // case when account in query is numeric + if (!account.equals(approver) && !isMagicUser()) { + return false; + } + + // case when account in query = owner + if (account.equals(ChangeQueryBuilder.OWNER_ACCOUNT_ID) + && !cd.change().getOwner().equals(approver)) { + return false; + } + + // case when account in query = non_uploader + if (account.equals(ChangeQueryBuilder.NON_UPLOADER_ACCOUNT_ID) + && cd.currentPatchSet().uploader().equals(approver)) { + return false; + } + } + + IdentifiedUser reviewer = userFactory.create(approver); + if (group != null && !reviewer.getEffectiveGroups().contains(group)) { + return false; + } + + // Check the user has 'READ' permission. + try { + PermissionBackend.ForChange perm = permissionBackend.absentUser(approver).change(cd); + if (!projectCache.get(cd.project()).map(ProjectState::statePermitsRead).orElse(false)) { + return false; + } + + perm.check(ChangePermission.READ); + return true; + } catch (PermissionBackendException | AuthException e) { + return false; + } + } + + private boolean isMagicUser() { + return account.equals(ChangeQueryBuilder.OWNER_ACCOUNT_ID) + || account.equals(ChangeQueryBuilder.NON_UPLOADER_ACCOUNT_ID); + } + } + + public static LabelType type(LabelTypes types, String toFind) { + if (types.byLabel(toFind).isPresent()) { + return types.byLabel(toFind).get(); + } + + for (LabelType lt : types.getLabelTypes()) { + if (toFind.equalsIgnoreCase(lt.getName())) { + return lt; + } + } + return null; + } +}
diff --git a/java/com/google/gerrit/server/query/change/EqualsPathPredicate.java b/java/com/google/gerrit/server/query/change/EqualsPathPredicate.java deleted file mode 100644 index 76936fa..0000000 --- a/java/com/google/gerrit/server/query/change/EqualsPathPredicate.java +++ /dev/null
@@ -1,34 +0,0 @@ -// Copyright (C) 2013 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.server.index.change.ChangeField; -import java.util.Collections; - -public class EqualsPathPredicate extends ChangeIndexPredicate { - public EqualsPathPredicate(String fieldName, String value) { - super(ChangeField.PATH, fieldName, value); - } - - @Override - public boolean match(ChangeData object) { - return Collections.binarySearch(object.currentFilePaths(), value) >= 0; - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/ExactAuthorPredicate.java b/java/com/google/gerrit/server/query/change/ExactAuthorPredicate.java deleted file mode 100644 index c1b6928..0000000 --- a/java/com/google/gerrit/server/query/change/ExactAuthorPredicate.java +++ /dev/null
@@ -1,37 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.EXACT_AUTHOR; -import static com.google.gerrit.server.query.change.ChangeQueryBuilder.FIELD_EXACTAUTHOR; - -import com.google.gerrit.server.index.change.ChangeField; -import java.util.Locale; - -public class ExactAuthorPredicate extends ChangeIndexPredicate { - public ExactAuthorPredicate(String value) { - super(EXACT_AUTHOR, FIELD_EXACTAUTHOR, value.toLowerCase(Locale.US)); - } - - @Override - public boolean match(ChangeData object) { - return ChangeField.getAuthorNameAndEmail(object).contains(getValue()); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/ExactCommitterPredicate.java b/java/com/google/gerrit/server/query/change/ExactCommitterPredicate.java deleted file mode 100644 index dac63af..0000000 --- a/java/com/google/gerrit/server/query/change/ExactCommitterPredicate.java +++ /dev/null
@@ -1,37 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.EXACT_COMMITTER; -import static com.google.gerrit.server.query.change.ChangeQueryBuilder.FIELD_EXACTCOMMITTER; - -import com.google.gerrit.server.index.change.ChangeField; -import java.util.Locale; - -public class ExactCommitterPredicate extends ChangeIndexPredicate { - public ExactCommitterPredicate(String value) { - super(EXACT_COMMITTER, FIELD_EXACTCOMMITTER, value.toLowerCase(Locale.US)); - } - - @Override - public boolean match(ChangeData object) { - return ChangeField.getCommitterNameAndEmail(object).contains(getValue()); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/ExactTopicPredicate.java b/java/com/google/gerrit/server/query/change/ExactTopicPredicate.java deleted file mode 100644 index 6683c91..0000000 --- a/java/com/google/gerrit/server/query/change/ExactTopicPredicate.java +++ /dev/null
@@ -1,39 +0,0 @@ -// Copyright (C) 2015 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.EXACT_TOPIC; - -import com.google.gerrit.entities.Change; - -public class ExactTopicPredicate extends ChangeIndexPredicate { - public ExactTopicPredicate(String topic) { - super(EXACT_TOPIC, topic); - } - - @Override - public boolean match(ChangeData object) { - Change change = object.change(); - if (change == null) { - return false; - } - return getValue().equals(change.getTopic()); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/FileExtensionListPredicate.java b/java/com/google/gerrit/server/query/change/FileExtensionListPredicate.java index bddd2ec..c16bc83 100644 --- a/java/com/google/gerrit/server/query/change/FileExtensionListPredicate.java +++ b/java/com/google/gerrit/server/query/change/FileExtensionListPredicate.java
@@ -36,9 +36,4 @@ public boolean match(ChangeData cd) { return ChangeField.getAllExtensionsAsList(cd).equals(value); } - - @Override - public int getCost() { - return 0; - } }
diff --git a/java/com/google/gerrit/server/query/change/FileExtensionPredicate.java b/java/com/google/gerrit/server/query/change/FileExtensionPredicate.java index ee573a7..39715cf 100644 --- a/java/com/google/gerrit/server/query/change/FileExtensionPredicate.java +++ b/java/com/google/gerrit/server/query/change/FileExtensionPredicate.java
@@ -33,9 +33,4 @@ public boolean match(ChangeData object) { return ChangeField.getExtensions(object).contains(value); } - - @Override - public int getCost() { - return 0; - } }
diff --git a/java/com/google/gerrit/server/query/change/FooterPredicate.java b/java/com/google/gerrit/server/query/change/FooterPredicate.java deleted file mode 100644 index 4d7588c..0000000 --- a/java/com/google/gerrit/server/query/change/FooterPredicate.java +++ /dev/null
@@ -1,45 +0,0 @@ -// Copyright (C) 2019 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.server.index.change.ChangeField; -import java.util.Locale; - -public class FooterPredicate extends ChangeIndexPredicate { - private static String clean(String value) { - int indexEquals = value.indexOf('='); - int indexColon = value.indexOf(':'); - - // footer key cannot contain '=' - if (indexEquals > 0 && (indexEquals < indexColon || indexColon < 0)) { - value = value.substring(0, indexEquals) + ": " + value.substring(indexEquals + 1); - } - return value.toLowerCase(Locale.US); - } - - FooterPredicate(String value) { - super(ChangeField.FOOTER, clean(value)); - } - - @Override - public boolean match(ChangeData cd) { - return ChangeField.getFooters(cd).contains(value); - } - - @Override - public int getCost() { - return 0; - } -}
diff --git a/java/com/google/gerrit/server/query/change/FuzzyTopicPredicate.java b/java/com/google/gerrit/server/query/change/FuzzyTopicPredicate.java deleted file mode 100644 index d558b0f..0000000 --- a/java/com/google/gerrit/server/query/change/FuzzyTopicPredicate.java +++ /dev/null
@@ -1,62 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.FUZZY_TOPIC; - -import com.google.common.collect.Iterables; -import com.google.gerrit.entities.Change; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.server.index.change.ChangeIndex; -import com.google.gerrit.server.index.change.IndexedChangeQuery; - -public class FuzzyTopicPredicate extends ChangeIndexPredicate { - protected final ChangeIndex index; - - public FuzzyTopicPredicate(String topic, ChangeIndex index) { - super(FUZZY_TOPIC, topic); - this.index = index; - } - - @Override - public boolean match(ChangeData cd) { - Change change = cd.change(); - if (change == null) { - return false; - } - String t = change.getTopic(); - if (t == null) { - return false; - } - try { - Predicate<ChangeData> thisId = - index.getSchema().useLegacyNumericFields() - ? new LegacyChangeIdPredicate(cd.getId()) - : new LegacyChangeIdStrPredicate(cd.getId()); - Iterable<ChangeData> results = - index.getSource(and(thisId, this), IndexedChangeQuery.oneResult()).read(); - return !Iterables.isEmpty(results); - } catch (QueryParseException e) { - throw new StorageException(e); - } - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/GroupPredicate.java b/java/com/google/gerrit/server/query/change/GroupPredicate.java index 99f37d6..f470cf9 100644 --- a/java/com/google/gerrit/server/query/change/GroupPredicate.java +++ b/java/com/google/gerrit/server/query/change/GroupPredicate.java
@@ -33,9 +33,4 @@ } return false; } - - @Override - public int getCost() { - return 1; - } }
diff --git a/java/com/google/gerrit/server/query/change/HasDraftByPredicate.java b/java/com/google/gerrit/server/query/change/HasDraftByPredicate.java deleted file mode 100644 index f2bc45d..0000000 --- a/java/com/google/gerrit/server/query/change/HasDraftByPredicate.java +++ /dev/null
@@ -1,43 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.index.query.HasCardinality; -import com.google.gerrit.server.index.change.ChangeField; - -public class HasDraftByPredicate extends ChangeIndexPredicate implements HasCardinality { - protected final Account.Id accountId; - - public HasDraftByPredicate(Account.Id accountId) { - super(ChangeField.DRAFTBY, accountId.toString()); - this.accountId = accountId; - } - - @Override - public boolean match(ChangeData cd) { - return cd.draftsByUser().contains(accountId); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 20; - } -}
diff --git a/java/com/google/gerrit/server/query/change/HasStarsPredicate.java b/java/com/google/gerrit/server/query/change/HasStarsPredicate.java deleted file mode 100644 index 2fbd1e8..0000000 --- a/java/com/google/gerrit/server/query/change/HasStarsPredicate.java +++ /dev/null
@@ -1,42 +0,0 @@ -// Copyright (C) 2016 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.server.index.change.ChangeField; - -public class HasStarsPredicate extends ChangeIndexPredicate { - protected final Account.Id accountId; - - public HasStarsPredicate(Account.Id accountId) { - super(ChangeField.STARBY, accountId.toString()); - this.accountId = accountId; - } - - @Override - public boolean match(ChangeData cd) { - return cd.stars().containsKey(accountId); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public String toString() { - return ChangeQueryBuilder.FIELD_STARBY + ":" + accountId; - } -}
diff --git a/java/com/google/gerrit/server/query/change/HashtagPredicate.java b/java/com/google/gerrit/server/query/change/HashtagPredicate.java deleted file mode 100644 index 1fe4af4..0000000 --- a/java/com/google/gerrit/server/query/change/HashtagPredicate.java +++ /dev/null
@@ -1,41 +0,0 @@ -// Copyright (C) 2014 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.server.change.HashtagsUtil; -import com.google.gerrit.server.index.change.ChangeField; - -public class HashtagPredicate extends ChangeIndexPredicate { - public HashtagPredicate(String hashtag) { - // Use toLowerCase without locale to match behavior in ChangeField. - // TODO(dborowitz): Change both. - super(ChangeField.HASHTAG, HashtagsUtil.cleanupHashtag(hashtag).toLowerCase()); - } - - @Override - public boolean match(ChangeData object) { - for (String hashtag : object.notes().load().getHashtags()) { - if (hashtag.equalsIgnoreCase(getValue())) { - return true; - } - } - return false; - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/InternalChangeQuery.java b/java/com/google/gerrit/server/query/change/InternalChangeQuery.java index 1012f4a..c8e9f66 100644 --- a/java/com/google/gerrit/server/query/change/InternalChangeQuery.java +++ b/java/com/google/gerrit/server/query/change/InternalChangeQuery.java
@@ -61,15 +61,15 @@ } private static Predicate<ChangeData> ref(BranchNameKey branch) { - return new RefPredicate(branch.branch()); + return ChangePredicates.ref(branch.branch()); } private static Predicate<ChangeData> change(Change.Key key) { - return new ChangeIdPredicate(key.get()); + return ChangePredicates.idPrefix(key.get()); } private static Predicate<ChangeData> project(Project.NameKey project) { - return new ProjectPredicate(project.get()); + return ChangePredicates.project(project); } private static Predicate<ChangeData> status(Change.Status status) { @@ -77,7 +77,7 @@ } private static Predicate<ChangeData> commit(String id) { - return new CommitPredicate(id); + return ChangePredicates.commitPrefix(id); } private final ChangeData.Factory changeDataFactory; @@ -99,8 +99,8 @@ predicateFactory = (id) -> schema().useLegacyNumericFields() - ? new LegacyChangeIdPredicate(id) - : new LegacyChangeIdStrPredicate(id); + ? ChangePredicates.id(id) + : ChangePredicates.idStr(id); } public List<ChangeData> byKey(Change.Key key) { @@ -108,7 +108,7 @@ } public List<ChangeData> byKeyPrefix(String prefix) { - return query(new ChangeIdPredicate(prefix)); + return query(ChangePredicates.idPrefix(prefix)); } public List<ChangeData> byLegacyChangeId(Change.Id id) { @@ -166,7 +166,7 @@ Iterable<ChangeData> byCommitsOnBranchNotMerged( Repository repo, BranchNameKey branch, Collection<String> hashes, int indexLimit) throws IOException { - if (hashes.size() > indexLimit) { + if (hashes.size() > indexLimit || !indexes.getSearchIndex().isEnabled()) { return byCommitsOnBranchNotMergedFromDatabase(repo, branch, hashes); } return byCommitsOnBranchNotMergedFromIndex(branch, hashes); @@ -226,7 +226,7 @@ } public List<ChangeData> byTopicOpen(String topic) { - return query(and(new ExactTopicPredicate(topic), open())); + return query(and(ChangePredicates.exactTopic(topic), open())); } public List<ChangeData> byCommit(ObjectId id) { @@ -270,14 +270,17 @@ private static Predicate<ChangeData> byBranchCommitPred( String project, String branch, String hash) { - return and(new ProjectPredicate(project), new RefPredicate(branch), commit(hash)); + return and( + ChangePredicates.project(Project.nameKey(project)), + ChangePredicates.ref(branch), + commit(hash)); } public List<ChangeData> bySubmissionId(String cs) { if (Strings.isNullOrEmpty(cs)) { return Collections.emptyList(); } - return query(new SubmissionIdPredicate(cs)); + return query(ChangePredicates.submissionId(cs)); } private static Predicate<ChangeData> byProjectGroupsPredicate(
diff --git a/java/com/google/gerrit/server/query/change/IsAttentionPredicate.java b/java/com/google/gerrit/server/query/change/IsAttentionPredicate.java new file mode 100644 index 0000000..d20d64a --- /dev/null +++ b/java/com/google/gerrit/server/query/change/IsAttentionPredicate.java
@@ -0,0 +1,33 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import com.google.gerrit.index.query.QueryParseException; +import com.google.gerrit.server.index.change.ChangeField; + +public class IsAttentionPredicate extends IntegerRangeChangePredicate { + public IsAttentionPredicate() throws QueryParseException { + this(">0"); + } + + public IsAttentionPredicate(String value) throws QueryParseException { + super(ChangeField.ATTENTION_SET_USERS_COUNT, value); + } + + @Override + protected Integer getValueInt(ChangeData changeData) { + return ChangeField.ATTENTION_SET_USERS_COUNT.get(changeData); + } +}
diff --git a/java/com/google/gerrit/server/query/change/IsReviewedPredicate.java b/java/com/google/gerrit/server/query/change/IsReviewedPredicate.java deleted file mode 100644 index 4b32b06..0000000 --- a/java/com/google/gerrit/server/query/change/IsReviewedPredicate.java +++ /dev/null
@@ -1,59 +0,0 @@ -// Copyright (C) 2015 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.REVIEWEDBY; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.server.index.change.ChangeField; -import java.util.ArrayList; -import java.util.Collection; -import java.util.List; -import java.util.Set; - -public class IsReviewedPredicate extends ChangeIndexPredicate { - protected static final Account.Id NOT_REVIEWED = Account.id(ChangeField.NOT_REVIEWED); - - public static Predicate<ChangeData> create() { - return Predicate.not(new IsReviewedPredicate(NOT_REVIEWED)); - } - - public static Predicate<ChangeData> create(Collection<Account.Id> ids) { - List<Predicate<ChangeData>> predicates = new ArrayList<>(ids.size()); - for (Account.Id id : ids) { - predicates.add(new IsReviewedPredicate(id)); - } - return Predicate.or(predicates); - } - - protected final Account.Id id; - - private IsReviewedPredicate(Account.Id id) { - super(REVIEWEDBY, Integer.toString(id.get())); - this.id = id; - } - - @Override - public boolean match(ChangeData cd) { - Set<Account.Id> reviewedBy = cd.reviewedBy(); - return !reviewedBy.isEmpty() ? reviewedBy.contains(id) : id.equals(NOT_REVIEWED); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/IsWatchedByPredicate.java b/java/com/google/gerrit/server/query/change/IsWatchedByPredicate.java index 3a43fd3..054a69e 100644 --- a/java/com/google/gerrit/server/query/change/IsWatchedByPredicate.java +++ b/java/com/google/gerrit/server/query/change/IsWatchedByPredicate.java
@@ -36,14 +36,13 @@ protected final CurrentUser user; - public IsWatchedByPredicate(ChangeQueryBuilder.Arguments args, boolean checkIsVisible) - throws QueryParseException { - super(filters(args, checkIsVisible)); + public IsWatchedByPredicate(ChangeQueryBuilder.Arguments args) throws QueryParseException { + super(filters(args)); this.user = args.getUser(); } - protected static List<Predicate<ChangeData>> filters( - ChangeQueryBuilder.Arguments args, boolean checkIsVisible) throws QueryParseException { + protected static List<Predicate<ChangeData>> filters(ChangeQueryBuilder.Arguments args) + throws QueryParseException { List<Predicate<ChangeData>> r = new ArrayList<>(); ChangeQueryBuilder builder = new ChangeQueryBuilder(args); for (ProjectWatchKey w : getWatches(args)) { @@ -82,11 +81,8 @@ } if (r.isEmpty()) { return ImmutableList.of(ChangeIndexPredicate.none()); - } else if (checkIsVisible) { - return ImmutableList.of(or(r), builder.isVisible()); - } else { - return ImmutableList.of(or(r)); } + return ImmutableList.of(or(r)); } protected static Collection<ProjectWatchKey> getWatches(ChangeQueryBuilder.Arguments args)
diff --git a/java/com/google/gerrit/server/query/change/LabelPredicate.java b/java/com/google/gerrit/server/query/change/LabelPredicate.java index 38d1dbe..15356f9 100644 --- a/java/com/google/gerrit/server/query/change/LabelPredicate.java +++ b/java/com/google/gerrit/server/query/change/LabelPredicate.java
@@ -14,6 +14,7 @@ package com.google.gerrit.server.query.change; +import com.google.common.collect.ImmutableList; import com.google.common.collect.Lists; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.AccountGroup; @@ -22,6 +23,7 @@ import com.google.gerrit.index.query.RangeUtil; import com.google.gerrit.index.query.RangeUtil.Range; import com.google.gerrit.server.IdentifiedUser; +import com.google.gerrit.server.account.GroupBackend; import com.google.gerrit.server.permissions.PermissionBackend; import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.util.LabelVote; @@ -39,6 +41,7 @@ protected final String value; protected final Set<Account.Id> accounts; protected final AccountGroup.UUID group; + protected final GroupBackend groupBackend; protected Args( ProjectCache projectCache, @@ -46,25 +49,27 @@ IdentifiedUser.GenericFactory userFactory, String value, Set<Account.Id> accounts, - AccountGroup.UUID group) { + AccountGroup.UUID group, + GroupBackend groupBackend) { this.projectCache = projectCache; this.permissionBackend = permissionBackend; this.userFactory = userFactory; this.value = value; this.accounts = accounts; this.group = group; + this.groupBackend = groupBackend; } } protected static class Parsed { protected final String label; protected final String test; - protected final int expVal; + protected final int numericValue; - protected Parsed(String label, String test, int expVal) { + protected Parsed(String label, String test, int numericValue) { this.label = label; this.test = test; - this.expVal = expVal; + this.numericValue = numericValue; } } @@ -77,12 +82,27 @@ AccountGroup.UUID group) { super( predicates( - new Args(a.projectCache, a.permissionBackend, a.userFactory, value, accounts, group))); + new Args( + a.projectCache, + a.permissionBackend, + a.userFactory, + value, + accounts, + group, + a.groupBackend))); this.value = value; } protected static List<Predicate<ChangeData>> predicates(Args args) { String v = args.value; + + try { + MagicLabelVote mlv = MagicLabelVote.parseWithEquals(v); + return ImmutableList.of(magicLabelPredicate(args, mlv)); + } catch (IllegalArgumentException e) { + // Try next format. + } + Parsed parsed = null; try { @@ -108,7 +128,7 @@ } else { range = RangeUtil.getRange( - parsed.label, parsed.test, parsed.expVal, -MAX_LABEL_VALUE, MAX_LABEL_VALUE); + parsed.label, parsed.test, parsed.numericValue, -MAX_LABEL_VALUE, MAX_LABEL_VALUE); } String prefix = range.prefix; int min = range.min; @@ -138,12 +158,35 @@ } protected static Predicate<ChangeData> equalsLabelPredicate(Args args, String label, int expVal) { + if (args.groupBackend.isOrContainsExternalGroup(args.group)) { + // We can only get members of internal groups and negating an index search that doesn't + // include the external group information leads to incorrect query results. Use a + // PostFilterPredicate in this case instead. + return new EqualsLabelPredicates.PostFilterEqualsLabelPredicate(args, label, expVal); + } if (args.accounts == null || args.accounts.isEmpty()) { - return new EqualsLabelPredicate(args, label, expVal, null); + return new EqualsLabelPredicates.IndexEqualsLabelPredicate(args, label, expVal); } List<Predicate<ChangeData>> r = new ArrayList<>(); for (Account.Id a : args.accounts) { - r.add(new EqualsLabelPredicate(args, label, expVal, a)); + r.add(new EqualsLabelPredicates.IndexEqualsLabelPredicate(args, label, expVal, a)); + } + return or(r); + } + + protected static Predicate<ChangeData> magicLabelPredicate(Args args, MagicLabelVote mlv) { + if (args.groupBackend.isOrContainsExternalGroup(args.group)) { + // We can only get members of internal groups and negating an index search that doesn't + // include the external group information leads to incorrect query results. Use a + // PostFilterPredicate in this case instead. + return new MagicLabelPredicates.PostFilterMagicLabelPredicate(args, mlv); + } + if (args.accounts == null || args.accounts.isEmpty()) { + return new MagicLabelPredicates.IndexMagicLabelPredicate(args, mlv); + } + List<Predicate<ChangeData>> r = new ArrayList<>(); + for (Account.Id a : args.accounts) { + r.add(new MagicLabelPredicates.IndexMagicLabelPredicate(args, mlv, a)); } return or(r); }
diff --git a/java/com/google/gerrit/server/query/change/LegacyChangeIdPredicate.java b/java/com/google/gerrit/server/query/change/LegacyChangeIdPredicate.java deleted file mode 100644 index 5dd780b..0000000 --- a/java/com/google/gerrit/server/query/change/LegacyChangeIdPredicate.java +++ /dev/null
@@ -1,45 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.LEGACY_ID; - -import com.google.gerrit.entities.Change; -import com.google.gerrit.index.query.HasCardinality; - -/** Predicate over change number (aka legacy ID or Change.Id). */ -public class LegacyChangeIdPredicate extends ChangeIndexPredicate implements HasCardinality { - protected final Change.Id id; - - public LegacyChangeIdPredicate(Change.Id id) { - super(LEGACY_ID, ChangeQueryBuilder.FIELD_CHANGE, id.toString()); - this.id = id; - } - - @Override - public boolean match(ChangeData object) { - return id.equals(object.getId()); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/LegacyChangeIdStrPredicate.java b/java/com/google/gerrit/server/query/change/LegacyChangeIdStrPredicate.java deleted file mode 100644 index be0aae3..0000000 --- a/java/com/google/gerrit/server/query/change/LegacyChangeIdStrPredicate.java +++ /dev/null
@@ -1,45 +0,0 @@ -// Copyright (C) 2019 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import static com.google.gerrit.server.index.change.ChangeField.LEGACY_ID_STR; - -import com.google.gerrit.entities.Change; -import com.google.gerrit.index.query.HasCardinality; - -/** Predicate over change number (aka legacy ID or Change.Id). */ -public class LegacyChangeIdStrPredicate extends ChangeIndexPredicate implements HasCardinality { - protected final Change.Id id; - - public LegacyChangeIdStrPredicate(Change.Id id) { - super(LEGACY_ID_STR, ChangeQueryBuilder.FIELD_CHANGE, id.toString()); - this.id = id; - } - - @Override - public boolean match(ChangeData object) { - return id.equals(object.getId()); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/MagicLabelPredicates.java b/java/com/google/gerrit/server/query/change/MagicLabelPredicates.java new file mode 100644 index 0000000..017abec --- /dev/null +++ b/java/com/google/gerrit/server/query/change/MagicLabelPredicates.java
@@ -0,0 +1,152 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import static com.google.gerrit.server.query.change.EqualsLabelPredicates.type; + +import com.google.gerrit.entities.Account; +import com.google.gerrit.entities.Change; +import com.google.gerrit.entities.LabelType; +import com.google.gerrit.entities.LabelValue; +import com.google.gerrit.index.query.PostFilterPredicate; +import com.google.gerrit.index.query.Predicate; +import com.google.gerrit.server.index.change.ChangeField; +import com.google.gerrit.server.project.ProjectState; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; + +public class MagicLabelPredicates { + public static class PostFilterMagicLabelPredicate extends PostFilterPredicate<ChangeData> { + private static class PostFilterMatcher extends Matcher { + public PostFilterMatcher(LabelPredicate.Args args, MagicLabelVote magicLabelVote) { + super(args, magicLabelVote); + } + + @Override + protected Predicate<ChangeData> numericPredicate(String label, short value) { + return new EqualsLabelPredicates.PostFilterEqualsLabelPredicate(args, label, value); + } + } + + private final PostFilterMatcher matcher; + + public PostFilterMagicLabelPredicate(LabelPredicate.Args args, MagicLabelVote magicLabelVote) { + super(ChangeQueryBuilder.FIELD_LABEL, magicLabelVote.formatLabel()); + this.matcher = new PostFilterMatcher(args, magicLabelVote); + } + + @Override + public boolean match(ChangeData changeData) { + return matcher.match(changeData); + } + + @Override + public int getCost() { + return 2; + } + } + + public static class IndexMagicLabelPredicate extends ChangeIndexPredicate { + private static class IndexMatcher extends Matcher { + public IndexMatcher( + LabelPredicate.Args args, MagicLabelVote magicLabelVote, Account.Id account) { + super(args, magicLabelVote, account); + } + + @Override + protected Predicate<ChangeData> numericPredicate(String label, short value) { + return new EqualsLabelPredicates.IndexEqualsLabelPredicate(args, label, value, account); + } + } + + private final Matcher matcher; + + public IndexMagicLabelPredicate(LabelPredicate.Args args, MagicLabelVote magicLabelVote) { + this(args, magicLabelVote, null); + } + + public IndexMagicLabelPredicate( + LabelPredicate.Args args, MagicLabelVote magicLabelVote, Account.Id account) { + super(ChangeField.LABEL, magicLabelVote.formatLabel()); + this.matcher = new IndexMatcher(args, magicLabelVote, account); + } + + @Override + public boolean match(ChangeData changeData) { + return matcher.match(changeData); + } + } + + private abstract static class Matcher { + protected final LabelPredicate.Args args; + protected final MagicLabelVote magicLabelVote; + protected final Account.Id account; + + public Matcher(LabelPredicate.Args args, MagicLabelVote magicLabelVote) { + this(args, magicLabelVote, null); + } + + public Matcher(LabelPredicate.Args args, MagicLabelVote magicLabelVote, Account.Id account) { + this.account = account; + this.args = args; + this.magicLabelVote = magicLabelVote; + } + + public boolean match(ChangeData cd) { + Change change = cd.change(); + if (change == null) { + return false; // The change has disappeared. + } + + Optional<ProjectState> project = args.projectCache.get(change.getDest().project()); + if (!project.isPresent()) { + return false; // The project has disappeared. + } + + LabelType labelType = type(project.get().getLabelTypes(), magicLabelVote.label()); + if (labelType == null) { + return false; // Label is not defined by this project. + } + + switch (magicLabelVote.value()) { + case ANY: + return matchAny(cd, labelType); + case MIN: + return matchNumeric(cd, magicLabelVote.label(), labelType.getMin().getValue()); + case MAX: + return matchNumeric(cd, magicLabelVote.label(), labelType.getMax().getValue()); + } + + throw new IllegalStateException("Unsupported magic label value: " + magicLabelVote.value()); + } + + private boolean matchAny(ChangeData changeData, LabelType labelType) { + List<Predicate<ChangeData>> predicates = new ArrayList<>(); + for (LabelValue labelValue : labelType.getValues()) { + if (labelValue.getValue() != 0) { + predicates.add(numericPredicate(labelType.getName(), labelValue.getValue())); + } + } + return Predicate.or(predicates).asMatchable().match(changeData); + } + + private boolean matchNumeric(ChangeData changeData, String label, short value) { + return numericPredicate(label, value).asMatchable().match(changeData); + } + + protected abstract Predicate<ChangeData> numericPredicate(String label, short value); + } +}
diff --git a/java/com/google/gerrit/server/query/change/MagicLabelValue.java b/java/com/google/gerrit/server/query/change/MagicLabelValue.java new file mode 100644 index 0000000..c4bcbe3 --- /dev/null +++ b/java/com/google/gerrit/server/query/change/MagicLabelValue.java
@@ -0,0 +1,31 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import java.util.Optional; + +public enum MagicLabelValue { + ANY, + MIN, + MAX; + + public static Optional<MagicLabelValue> tryParse(String value) { + try { + return Optional.of(MagicLabelValue.valueOf(value)); + } catch (IllegalArgumentException e) { + return Optional.empty(); + } + } +}
diff --git a/java/com/google/gerrit/server/query/change/MagicLabelVote.java b/java/com/google/gerrit/server/query/change/MagicLabelVote.java new file mode 100644 index 0000000..c29ac72 --- /dev/null +++ b/java/com/google/gerrit/server/query/change/MagicLabelVote.java
@@ -0,0 +1,47 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import static com.google.common.base.Preconditions.checkArgument; + +import com.google.auto.value.AutoValue; +import com.google.common.base.Strings; +import com.google.gerrit.entities.LabelType; +import java.util.Locale; + +/** An entity representing a special label vote that's not numeric, e.g. MAX, MIN, etc... */ +@AutoValue +public abstract class MagicLabelVote { + public static MagicLabelVote parseWithEquals(String text) { + checkArgument(!Strings.isNullOrEmpty(text), "Empty label vote"); + int e = text.lastIndexOf('='); + checkArgument(e >= 0, "Label vote missing '=': %s", text); + String label = text.substring(0, e); + String voteValue = text.substring(e + 1); + return create(label, MagicLabelValue.valueOf(voteValue)); + } + + public static MagicLabelVote create(String label, MagicLabelValue value) { + return new AutoValue_MagicLabelVote(LabelType.checkNameInternal(label), value); + } + + public abstract String label(); + + public abstract MagicLabelValue value(); + + public String formatLabel() { + return label().toLowerCase(Locale.US) + "=" + value().name(); + } +}
diff --git a/java/com/google/gerrit/server/query/change/MessagePredicate.java b/java/com/google/gerrit/server/query/change/MessagePredicate.java deleted file mode 100644 index 44cbd8e..0000000 --- a/java/com/google/gerrit/server/query/change/MessagePredicate.java +++ /dev/null
@@ -1,58 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.query.Predicate; -import com.google.gerrit.index.query.QueryParseException; -import com.google.gerrit.server.index.change.ChangeField; -import com.google.gerrit.server.index.change.ChangeIndex; -import com.google.gerrit.server.index.change.IndexedChangeQuery; - -/** Predicate to match changes that contains specified text in commit messages body. */ -public class MessagePredicate extends ChangeIndexPredicate { - protected final ChangeIndex index; - - public MessagePredicate(ChangeIndex index, String value) { - super(ChangeField.COMMIT_MESSAGE, value); - this.index = index; - } - - @Override - public boolean match(ChangeData object) { - try { - Predicate<ChangeData> p = - Predicate.and( - index.getSchema().useLegacyNumericFields() - ? new LegacyChangeIdPredicate(object.getId()) - : new LegacyChangeIdStrPredicate(object.getId()), - this); - for (ChangeData cData : index.getSource(p, IndexedChangeQuery.oneResult()).read()) { - if (cData.getId().equals(object.getId())) { - return true; - } - } - } catch (QueryParseException e) { - throw new StorageException(e); - } - - return false; - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/OutputStreamQuery.java b/java/com/google/gerrit/server/query/change/OutputStreamQuery.java index cf53a1b..d21f5b6 100644 --- a/java/com/google/gerrit/server/query/change/OutputStreamQuery.java +++ b/java/com/google/gerrit/server/query/change/OutputStreamQuery.java
@@ -29,7 +29,7 @@ import com.google.gerrit.index.query.QueryParseException; import com.google.gerrit.index.query.QueryResult; import com.google.gerrit.server.DynamicOptions; -import com.google.gerrit.server.cache.PerThreadCache; +import com.google.gerrit.server.account.AccountAttributeLoader; import com.google.gerrit.server.config.TrackingFooters; import com.google.gerrit.server.data.ChangeAttribute; import com.google.gerrit.server.data.PatchSetAttribute; @@ -88,6 +88,7 @@ private final EventFactory eventFactory; private final TrackingFooters trackingFooters; private final SubmitRuleEvaluator.Factory submitRuleEvaluatorFactory; + private final AccountAttributeLoader.Factory accountAttributeLoaderFactory; private OutputFormat outputFormat = OutputFormat.TEXT; private boolean includePatchSets; @@ -112,13 +113,15 @@ ChangeQueryProcessor queryProcessor, EventFactory eventFactory, TrackingFooters trackingFooters, - SubmitRuleEvaluator.Factory submitRuleEvaluatorFactory) { + SubmitRuleEvaluator.Factory submitRuleEvaluatorFactory, + AccountAttributeLoader.Factory accountAttributeLoaderFactory) { this.repoManager = repoManager; this.queryBuilder = queryBuilder; this.queryProcessor = queryProcessor; this.eventFactory = eventFactory; this.trackingFooters = trackingFooters; this.submitRuleEvaluatorFactory = submitRuleEvaluatorFactory; + this.accountAttributeLoaderFactory = accountAttributeLoaderFactory; } void setLimit(int n) { @@ -207,7 +210,7 @@ return; } - try (PerThreadCache ignored = PerThreadCache.create()) { + try { final QueryStatsAttribute stats = new QueryStatsAttribute(); stats.runTimeMilliseconds = TimeUtil.nowMs(); @@ -216,9 +219,13 @@ QueryResult<ChangeData> results = queryProcessor.query(queryBuilder.parse(queryString)); pluginInfosByChange = queryProcessor.createPluginDefinedInfos(results.entities()); try { + AccountAttributeLoader accountLoader = accountAttributeLoaderFactory.create(); + List<ChangeAttribute> changeAttributes = new ArrayList<>(); for (ChangeData d : results.entities()) { - show(buildChangeAttribute(d, repos, revWalks)); + changeAttributes.add(buildChangeAttribute(d, repos, revWalks, accountLoader)); } + accountLoader.fill(); + changeAttributes.forEach(c -> show(c)); } finally { closeAll(revWalks.values(), repos.values()); } @@ -249,10 +256,13 @@ } private ChangeAttribute buildChangeAttribute( - ChangeData d, Map<Project.NameKey, Repository> repos, Map<Project.NameKey, RevWalk> revWalks) + ChangeData d, + Map<Project.NameKey, Repository> repos, + Map<Project.NameKey, RevWalk> revWalks, + AccountAttributeLoader accountLoader) throws IOException { LabelTypes labelTypes = d.getLabelTypes(); - ChangeAttribute c = eventFactory.asChangeAttribute(d.change()); + ChangeAttribute c = eventFactory.asChangeAttribute(d.change(), accountLoader); c.hashtags = Lists.newArrayList(d.hashtags()); eventFactory.extend(c, d.change()); @@ -261,13 +271,14 @@ } if (includeAllReviewers) { - eventFactory.addAllReviewers(c, d.notes()); + eventFactory.addAllReviewers(c, d.notes(), accountLoader); } if (includeSubmitRecords) { SubmitRuleOptions options = SubmitRuleOptions.builder().recomputeOnClosedChanges(true).build(); - eventFactory.addSubmitRecords(c, submitRuleEvaluatorFactory.create(options).evaluate(d)); + eventFactory.addSubmitRecords( + c, submitRuleEvaluatorFactory.create(options).evaluate(d), accountLoader); } if (includeCommitMessage) { @@ -292,29 +303,31 @@ rw, c, d.patchSets(), - includeApprovals ? d.approvals().asMap() : null, + includeApprovals ? d.conditionallyLoadApprovalsWithCopied().asMap() : null, includeFiles, d.change(), - labelTypes); + labelTypes, + accountLoader); } if (includeCurrentPatchSet) { PatchSet current = d.currentPatchSet(); if (current != null) { c.currentPatchSet = eventFactory.asPatchSetAttribute(rw, d.change(), current); - eventFactory.addApprovals(c.currentPatchSet, d.currentApprovals(), labelTypes); + eventFactory.addApprovals( + c.currentPatchSet, d.currentApprovals(), labelTypes, accountLoader); if (includeFiles) { eventFactory.addPatchSetFileNames(c.currentPatchSet, d.change(), d.currentPatchSet()); } if (includeComments) { - eventFactory.addPatchSetComments(c.currentPatchSet, d.publishedComments()); + eventFactory.addPatchSetComments(c.currentPatchSet, d.publishedComments(), accountLoader); } } } if (includeComments) { - eventFactory.addComments(c, d.messages()); + eventFactory.addComments(c, d.messages(), accountLoader); if (includePatchSets) { eventFactory.addPatchSets( rw, @@ -323,9 +336,10 @@ includeApprovals ? d.approvals().asMap() : null, includeFiles, d.change(), - labelTypes); + labelTypes, + accountLoader); for (PatchSetAttribute attribute : c.patchSets) { - eventFactory.addPatchSetComments(attribute, d.publishedComments()); + eventFactory.addPatchSetComments(attribute, d.publishedComments(), accountLoader); } } }
diff --git a/java/com/google/gerrit/server/query/change/OwnerPredicate.java b/java/com/google/gerrit/server/query/change/OwnerPredicate.java deleted file mode 100644 index 175a273..0000000 --- a/java/com/google/gerrit/server/query/change/OwnerPredicate.java +++ /dev/null
@@ -1,49 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Account; -import com.google.gerrit.entities.Change; -import com.google.gerrit.index.query.HasCardinality; -import com.google.gerrit.server.index.change.ChangeField; - -public class OwnerPredicate extends ChangeIndexPredicate implements HasCardinality { - protected final Account.Id id; - - public OwnerPredicate(Account.Id id) { - super(ChangeField.OWNER, id.toString()); - this.id = id; - } - - protected Account.Id getAccountId() { - return id; - } - - @Override - public boolean match(ChangeData object) { - Change change = object.change(); - return change != null && id.equals(change.getOwner()); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 5000; - } -}
diff --git a/java/com/google/gerrit/server/query/change/ParentOfPredicate.java b/java/com/google/gerrit/server/query/change/ParentOfPredicate.java deleted file mode 100644 index e48d586..0000000 --- a/java/com/google/gerrit/server/query/change/ParentOfPredicate.java +++ /dev/null
@@ -1,62 +0,0 @@ -// Copyright (C) 2021 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.common.collect.Sets; -import com.google.gerrit.entities.PatchSet; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.index.query.Matchable; -import com.google.gerrit.index.query.OperatorPredicate; -import com.google.gerrit.server.git.GitRepositoryManager; -import java.io.IOException; -import java.util.Set; -import org.eclipse.jgit.lib.Repository; -import org.eclipse.jgit.revwalk.RevCommit; -import org.eclipse.jgit.revwalk.RevWalk; - -public class ParentOfPredicate extends OperatorPredicate<ChangeData> - implements Matchable<ChangeData> { - protected final Set<RevCommit> parents; - - public ParentOfPredicate(String value, ChangeData change, GitRepositoryManager repoManager) { - super(ChangeQueryBuilder.FIELD_PARENTOF, value); - this.parents = getParents(change, repoManager); - } - - @Override - public boolean match(ChangeData changeData) { - return changeData.patchSets().stream().anyMatch(ps -> parents.contains(ps.commitId())); - } - - @Override - public int getCost() { - return 1; - } - - protected Set<RevCommit> getParents(ChangeData change, GitRepositoryManager repoManager) { - PatchSet ps = change.currentPatchSet(); - try (Repository repo = repoManager.openRepository(change.project()); - RevWalk walk = new RevWalk(repo)) { - RevCommit c = walk.parseCommit(ps.commitId()); - return Sets.newHashSet(c.getParents()); - } catch (IOException e) { - throw new StorageException( - String.format( - "Loading commit %s for ps %d of change %d failed.", - ps.commitId(), ps.id().get(), ps.id().changeId().get()), - e); - } - } -}
diff --git a/java/com/google/gerrit/server/query/change/ParentProjectPredicate.java b/java/com/google/gerrit/server/query/change/ParentProjectPredicate.java index 2c82075..4a54c03 100644 --- a/java/com/google/gerrit/server/query/change/ParentProjectPredicate.java +++ b/java/com/google/gerrit/server/query/change/ParentProjectPredicate.java
@@ -47,10 +47,10 @@ } List<Predicate<ChangeData>> r = new ArrayList<>(); - r.add(new ProjectPredicate(projectState.get().getName())); + r.add(ChangePredicates.project(projectState.get().getNameKey())); try { for (ProjectInfo p : childProjects.list(projectState.get().getNameKey())) { - r.add(new ProjectPredicate(p.name)); + r.add(ChangePredicates.project(Project.nameKey(p.name))); } } catch (PermissionBackendException e) { logger.atWarning().withCause(e).log("cannot check permissions to expand child projects");
diff --git a/java/com/google/gerrit/server/query/change/PredicateArgs.java b/java/com/google/gerrit/server/query/change/PredicateArgs.java index ad7917e..aa6bfbc 100644 --- a/java/com/google/gerrit/server/query/change/PredicateArgs.java +++ b/java/com/google/gerrit/server/query/change/PredicateArgs.java
@@ -40,9 +40,8 @@ * name]}. * * @param args arguments to be parsed - * @throws QueryParseException */ - PredicateArgs(String args) throws QueryParseException { + public PredicateArgs(String args) throws QueryParseException { positional = new ArrayList<>(); keyValue = new HashMap<>();
diff --git a/java/com/google/gerrit/server/query/change/ProjectPredicate.java b/java/com/google/gerrit/server/query/change/ProjectPredicate.java deleted file mode 100644 index 99286fa..0000000 --- a/java/com/google/gerrit/server/query/change/ProjectPredicate.java +++ /dev/null
@@ -1,51 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.Project; -import com.google.gerrit.index.query.HasCardinality; -import com.google.gerrit.server.index.change.ChangeField; - -public class ProjectPredicate extends ChangeIndexPredicate implements HasCardinality { - public ProjectPredicate(String id) { - super(ChangeField.PROJECT, id); - } - - protected Project.NameKey getValueKey() { - return Project.nameKey(getValue()); - } - - @Override - public boolean match(ChangeData object) { - Change change = object.change(); - if (change == null) { - return false; - } - - Project.NameKey p = change.getDest().project(); - return p.equals(getValueKey()); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 1_000_000; - } -}
diff --git a/java/com/google/gerrit/server/query/change/ProjectPrefixPredicate.java b/java/com/google/gerrit/server/query/change/ProjectPrefixPredicate.java deleted file mode 100644 index c23a175..0000000 --- a/java/com/google/gerrit/server/query/change/ProjectPrefixPredicate.java +++ /dev/null
@@ -1,35 +0,0 @@ -// Copyright (C) 2014 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Change; -import com.google.gerrit.server.index.change.ChangeField; - -public class ProjectPrefixPredicate extends ChangeIndexPredicate { - public ProjectPrefixPredicate(String prefix) { - super(ChangeField.PROJECTS, prefix); - } - - @Override - public boolean match(ChangeData object) { - Change c = object.change(); - return c != null && c.getDest().project().get().startsWith(getValue()); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/RefPredicate.java b/java/com/google/gerrit/server/query/change/RefPredicate.java deleted file mode 100644 index 715b527..0000000 --- a/java/com/google/gerrit/server/query/change/RefPredicate.java +++ /dev/null
@@ -1,44 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Change; -import com.google.gerrit.index.query.HasCardinality; -import com.google.gerrit.server.index.change.ChangeField; - -public class RefPredicate extends ChangeIndexPredicate implements HasCardinality { - public RefPredicate(String ref) { - super(ChangeField.REF, ref); - } - - @Override - public boolean match(ChangeData object) { - Change change = object.change(); - if (change == null) { - return false; - } - return getValue().equals(change.getDest().branch()); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 10_000; - } -}
diff --git a/java/com/google/gerrit/server/query/change/RegexHashtagPredicate.java b/java/com/google/gerrit/server/query/change/RegexHashtagPredicate.java new file mode 100644 index 0000000..24efa6a --- /dev/null +++ b/java/com/google/gerrit/server/query/change/RegexHashtagPredicate.java
@@ -0,0 +1,51 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import static com.google.gerrit.server.index.change.ChangeField.HASHTAG; + +import dk.brics.automaton.RegExp; +import dk.brics.automaton.RunAutomaton; + +public class RegexHashtagPredicate extends ChangeRegexPredicate { + protected final RunAutomaton pattern; + + public RegexHashtagPredicate(String re) { + super(HASHTAG, re); + + if (re.startsWith("^")) { + re = re.substring(1); + } + + if (re.endsWith("$") && !re.endsWith("\\$")) { + re = re.substring(0, re.length() - 1); + } + + this.pattern = new RunAutomaton(new RegExp(re).toAutomaton()); + } + + @Override + public boolean match(ChangeData cd) { + if (cd.hashtags().isEmpty()) { + return false; + } + return cd.hashtags().stream().anyMatch(ht -> pattern.run(ht)); + } + + @Override + public int getCost() { + return 1; + } +}
diff --git a/java/com/google/gerrit/server/query/change/RevertOfPredicate.java b/java/com/google/gerrit/server/query/change/RevertOfPredicate.java deleted file mode 100644 index 5fbaac9..0000000 --- a/java/com/google/gerrit/server/query/change/RevertOfPredicate.java +++ /dev/null
@@ -1,42 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.index.query.HasCardinality; -import com.google.gerrit.server.index.change.ChangeField; - -public class RevertOfPredicate extends ChangeIndexPredicate implements HasCardinality { - public RevertOfPredicate(String revertOf) { - super(ChangeField.REVERT_OF, revertOf); - } - - @Override - public boolean match(ChangeData cd) { - if (cd.change().getRevertOf() == null) { - return false; - } - return cd.change().getRevertOf().toString().equals(value); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/ReviewerByEmailPredicate.java b/java/com/google/gerrit/server/query/change/ReviewerByEmailPredicate.java index 62fe9e8..3a51972 100644 --- a/java/com/google/gerrit/server/query/change/ReviewerByEmailPredicate.java +++ b/java/com/google/gerrit/server/query/change/ReviewerByEmailPredicate.java
@@ -45,9 +45,4 @@ public boolean match(ChangeData cd) { return cd.reviewersByEmail().asTable().get(state, adr) != null; } - - @Override - public int getCost() { - return 1; - } }
diff --git a/java/com/google/gerrit/server/query/change/ReviewerPredicate.java b/java/com/google/gerrit/server/query/change/ReviewerPredicate.java index 237b986..57f5213 100644 --- a/java/com/google/gerrit/server/query/change/ReviewerPredicate.java +++ b/java/com/google/gerrit/server/query/change/ReviewerPredicate.java
@@ -55,11 +55,6 @@ } @Override - public int getCost() { - return 1; - } - - @Override public int getCardinality() { return 5000; }
diff --git a/java/com/google/gerrit/server/query/change/StarPredicate.java b/java/com/google/gerrit/server/query/change/StarPredicate.java index ce13da9..548ab29 100644 --- a/java/com/google/gerrit/server/query/change/StarPredicate.java +++ b/java/com/google/gerrit/server/query/change/StarPredicate.java
@@ -35,11 +35,6 @@ } @Override - public int getCost() { - return 1; - } - - @Override public int getCardinality() { return 10; }
diff --git a/java/com/google/gerrit/server/query/change/SubmissionIdPredicate.java b/java/com/google/gerrit/server/query/change/SubmissionIdPredicate.java deleted file mode 100644 index 093447e..0000000 --- a/java/com/google/gerrit/server/query/change/SubmissionIdPredicate.java +++ /dev/null
@@ -1,41 +0,0 @@ -// Copyright (C) 2015 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.entities.Change; -import com.google.gerrit.server.index.change.ChangeField; - -public class SubmissionIdPredicate extends ChangeIndexPredicate { - public SubmissionIdPredicate(String changeSet) { - super(ChangeField.SUBMISSIONID, changeSet); - } - - @Override - public boolean match(ChangeData object) { - Change change = object.change(); - if (change == null) { - return false; - } - if (change.getSubmissionId() == null) { - return false; - } - return getValue().equals(change.getSubmissionId()); - } - - @Override - public int getCost() { - return 1; - } -}
diff --git a/java/com/google/gerrit/server/query/change/SubmitRecordPredicate.java b/java/com/google/gerrit/server/query/change/SubmitRecordPredicate.java index 4ca684a..ecddbb6 100644 --- a/java/com/google/gerrit/server/query/change/SubmitRecordPredicate.java +++ b/java/com/google/gerrit/server/query/change/SubmitRecordPredicate.java
@@ -43,9 +43,4 @@ public boolean match(ChangeData in) { return ChangeField.formatSubmitRecordValues(in).contains(getValue()); } - - @Override - public int getCost() { - return 1; - } }
diff --git a/java/com/google/gerrit/server/query/change/SubmitRequirementChangeQueryBuilder.java b/java/com/google/gerrit/server/query/change/SubmitRequirementChangeQueryBuilder.java new file mode 100644 index 0000000..e63714f --- /dev/null +++ b/java/com/google/gerrit/server/query/change/SubmitRequirementChangeQueryBuilder.java
@@ -0,0 +1,35 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import com.google.gerrit.index.query.QueryBuilder; +import com.google.inject.Inject; + +/** + * A query builder for submit requirement expressions that includes all {@link ChangeQueryBuilder} + * operators, in addition to extra operators contributed by this class. + * + * <p>Operators defined in this class cannot be used in change queries. + */ +public class SubmitRequirementChangeQueryBuilder extends ChangeQueryBuilder { + + private static final QueryBuilder.Definition<ChangeData, ChangeQueryBuilder> def = + new QueryBuilder.Definition<>(SubmitRequirementChangeQueryBuilder.class); + + @Inject + SubmitRequirementChangeQueryBuilder(Arguments args) { + super(def, args); + } +}
diff --git a/java/com/google/gerrit/server/query/change/SubmitRequirementPredicate.java b/java/com/google/gerrit/server/query/change/SubmitRequirementPredicate.java new file mode 100644 index 0000000..184ede3 --- /dev/null +++ b/java/com/google/gerrit/server/query/change/SubmitRequirementPredicate.java
@@ -0,0 +1,35 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import com.google.gerrit.index.query.Matchable; +import com.google.gerrit.index.query.OperatorPredicate; + +/** + * Predicate that can be used in submit requirement expressions. Subclasses extended by this + * predicate cannot be used in search queries. + */ +public abstract class SubmitRequirementPredicate extends OperatorPredicate<ChangeData> + implements Matchable<ChangeData> { + + public SubmitRequirementPredicate(String name, String value) { + super(name, value); + } + + @Override + public boolean supportedForQueries() { + return false; + } +}
diff --git a/java/com/google/gerrit/server/query/change/SubmittablePredicate.java b/java/com/google/gerrit/server/query/change/SubmittablePredicate.java index 2018fbc..060a92e 100644 --- a/java/com/google/gerrit/server/query/change/SubmittablePredicate.java +++ b/java/com/google/gerrit/server/query/change/SubmittablePredicate.java
@@ -30,9 +30,4 @@ return cd.submitRecords(ChangeField.SUBMIT_RULE_OPTIONS_STRICT).stream() .anyMatch(r -> r.status == status); } - - @Override - public int getCost() { - return 1; - } }
diff --git a/java/com/google/gerrit/server/query/change/TrackingIdPredicate.java b/java/com/google/gerrit/server/query/change/TrackingIdPredicate.java deleted file mode 100644 index 0d1bd67..0000000 --- a/java/com/google/gerrit/server/query/change/TrackingIdPredicate.java +++ /dev/null
@@ -1,39 +0,0 @@ -// Copyright (C) 2010 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.query.change; - -import com.google.gerrit.index.query.HasCardinality; -import com.google.gerrit.server.index.change.ChangeField; - -public class TrackingIdPredicate extends ChangeIndexPredicate implements HasCardinality { - public TrackingIdPredicate(String trackingId) { - super(ChangeField.TR, trackingId); - } - - @Override - public boolean match(ChangeData cd) { - return cd.trackingFooters().containsValue(getValue()); - } - - @Override - public int getCost() { - return 1; - } - - @Override - public int getCardinality() { - return 5; - } -}
diff --git a/java/com/google/gerrit/server/query/change/UploaderinPredicate.java b/java/com/google/gerrit/server/query/change/UploaderinPredicate.java new file mode 100644 index 0000000..f44c0b5 --- /dev/null +++ b/java/com/google/gerrit/server/query/change/UploaderinPredicate.java
@@ -0,0 +1,50 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.query.change; + +import com.google.gerrit.entities.AccountGroup; +import com.google.gerrit.entities.PatchSet; +import com.google.gerrit.index.query.PostFilterPredicate; +import com.google.gerrit.server.IdentifiedUser; + +/** + * Predicate that matches changes where the latest patch set was uploaded by a user in the provided + * group. + */ +public class UploaderinPredicate extends PostFilterPredicate<ChangeData> { + protected final IdentifiedUser.GenericFactory userFactory; + protected final AccountGroup.UUID uuid; + + public UploaderinPredicate(IdentifiedUser.GenericFactory userFactory, AccountGroup.UUID uuid) { + super(ChangeQueryBuilder.FIELD_UPLOADERIN, uuid.get()); + this.userFactory = userFactory; + this.uuid = uuid; + } + + @Override + public boolean match(ChangeData cd) { + PatchSet latestPatchSet = cd.currentPatchSet(); + if (latestPatchSet == null) { + return false; + } + IdentifiedUser uploader = userFactory.create(latestPatchSet.uploader()); + return uploader.getEffectiveGroups().contains(uuid); + } + + @Override + public int getCost() { + return 2; + } +}
diff --git a/java/com/google/gerrit/server/query/group/GroupPredicates.java b/java/com/google/gerrit/server/query/group/GroupPredicates.java index 992f60d..8a2dc8d 100644 --- a/java/com/google/gerrit/server/query/group/GroupPredicates.java +++ b/java/com/google/gerrit/server/query/group/GroupPredicates.java
@@ -44,7 +44,7 @@ } public static Predicate<InternalGroup> name(String name) { - return new GroupPredicate(GroupField.NAME, GroupQueryBuilder.FIELD_NAME, name); + return new GroupPredicate(GroupField.NAME, name); } public static Predicate<InternalGroup> owner(AccountGroup.UUID ownerUuid) {
diff --git a/java/com/google/gerrit/server/query/group/GroupQueryProcessor.java b/java/com/google/gerrit/server/query/group/GroupQueryProcessor.java index c6683fa..74c8d39 100644 --- a/java/com/google/gerrit/server/query/group/GroupQueryProcessor.java +++ b/java/com/google/gerrit/server/query/group/GroupQueryProcessor.java
@@ -17,6 +17,7 @@ import static com.google.common.base.Preconditions.checkState; import static com.google.gerrit.server.query.group.GroupQueryBuilder.FIELD_LIMIT; +import com.google.common.collect.ImmutableList; import com.google.gerrit.entities.InternalGroup; import com.google.gerrit.index.IndexConfig; import com.google.gerrit.index.query.AndSource; @@ -33,6 +34,7 @@ import com.google.gerrit.server.notedb.Sequences; import com.google.inject.Inject; import com.google.inject.Provider; +import com.google.inject.Singleton; /** * Query processor for the group index. @@ -46,6 +48,14 @@ private final Sequences sequences; private final IndexConfig indexConfig; + @Singleton + protected static class GroupQueryMetrics extends QueryProcessor.Metrics { + @Inject + protected GroupQueryMetrics(MetricMaker metricMaker) { + super(metricMaker); + } + } + static { // It is assumed that basic rewrites do not touch visibleto predicates. checkState( @@ -57,14 +67,14 @@ protected GroupQueryProcessor( Provider<CurrentUser> userProvider, AccountLimits.Factory limitsFactory, - MetricMaker metricMaker, + GroupQueryMetrics groupQueryMetrics, IndexConfig indexConfig, GroupIndexCollection indexes, GroupIndexRewriter rewriter, GroupControl.GenericFactory groupControlFactory, Sequences sequences) { super( - metricMaker, + groupQueryMetrics, GroupSchemaDefinitions.INSTANCE, indexConfig, indexes, @@ -80,8 +90,8 @@ @Override protected Predicate<InternalGroup> enforceVisibility(Predicate<InternalGroup> pred) { return new AndSource<>( - pred, - new GroupIsVisibleToPredicate(groupControlFactory, userProvider.get()), + ImmutableList.of( + pred, new GroupIsVisibleToPredicate(groupControlFactory, userProvider.get())), start, indexConfig); }
diff --git a/java/com/google/gerrit/server/query/project/ProjectQueryProcessor.java b/java/com/google/gerrit/server/query/project/ProjectQueryProcessor.java index 6dafa92..ddc7ccc 100644 --- a/java/com/google/gerrit/server/query/project/ProjectQueryProcessor.java +++ b/java/com/google/gerrit/server/query/project/ProjectQueryProcessor.java
@@ -17,6 +17,7 @@ import static com.google.common.base.Preconditions.checkState; import static com.google.gerrit.server.query.project.ProjectQueryBuilder.FIELD_LIMIT; +import com.google.common.collect.ImmutableList; import com.google.gerrit.index.IndexConfig; import com.google.gerrit.index.project.ProjectData; import com.google.gerrit.index.project.ProjectIndexCollection; @@ -33,6 +34,7 @@ import com.google.gerrit.server.project.ProjectCache; import com.google.inject.Inject; import com.google.inject.Provider; +import com.google.inject.Singleton; /** * Query processor for the project index. @@ -48,6 +50,14 @@ private final ProjectCache projectCache; private final IndexConfig indexConfig; + @Singleton + protected static class ProjectQueryMetrics extends QueryProcessor.Metrics { + @Inject + protected ProjectQueryMetrics(MetricMaker metricMaker) { + super(metricMaker); + } + } + static { // It is assumed that basic rewrites do not touch visibleto predicates. checkState( @@ -59,14 +69,14 @@ protected ProjectQueryProcessor( Provider<CurrentUser> userProvider, AccountLimits.Factory limitsFactory, - MetricMaker metricMaker, + ProjectQueryMetrics projectQueryMetrics, IndexConfig indexConfig, ProjectIndexCollection indexes, ProjectIndexRewriter rewriter, PermissionBackend permissionBackend, ProjectCache projectCache) { super( - metricMaker, + projectQueryMetrics, ProjectSchemaDefinitions.INSTANCE, indexConfig, indexes, @@ -82,8 +92,8 @@ @Override protected Predicate<ProjectData> enforceVisibility(Predicate<ProjectData> pred) { return new AndSource<>( - pred, - new ProjectIsVisibleToPredicate(permissionBackend, userProvider.get()), + ImmutableList.of( + pred, new ProjectIsVisibleToPredicate(permissionBackend, userProvider.get())), start, indexConfig); }
diff --git a/java/com/google/gerrit/server/restapi/BUILD b/java/com/google/gerrit/server/restapi/BUILD index 708e860..63817d2 100644 --- a/java/com/google/gerrit/server/restapi/BUILD +++ b/java/com/google/gerrit/server/restapi/BUILD
@@ -35,6 +35,7 @@ "//lib/auto:auto-value-annotations", "//lib/commons:compress", "//lib/commons:lang", + "//lib/errorprone:annotations", "//lib/flogger:api", "//lib/guice", "//lib/guice:guice-assistedinject",
diff --git a/java/com/google/gerrit/server/restapi/RestApiModule.java b/java/com/google/gerrit/server/restapi/RestApiModule.java index 909c1f4..dffcf44 100644 --- a/java/com/google/gerrit/server/restapi/RestApiModule.java +++ b/java/com/google/gerrit/server/restapi/RestApiModule.java
@@ -15,20 +15,26 @@ package com.google.gerrit.server.restapi; import com.google.gerrit.server.plugins.PluginRestApiModule; +import com.google.gerrit.server.restapi.access.AccessRestApiModule; +import com.google.gerrit.server.restapi.account.AccountRestApiModule; +import com.google.gerrit.server.restapi.change.ChangeRestApiModule; +import com.google.gerrit.server.restapi.config.ConfigRestApiModule; import com.google.gerrit.server.restapi.config.RestCacheAdminModule; +import com.google.gerrit.server.restapi.group.GroupRestApiModule; +import com.google.gerrit.server.restapi.project.ProjectRestApiModule; import com.google.inject.AbstractModule; public class RestApiModule extends AbstractModule { @Override protected void configure() { - install(new com.google.gerrit.server.restapi.access.Module()); - install(new com.google.gerrit.server.restapi.account.Module()); - install(new com.google.gerrit.server.restapi.change.Module()); - install(new com.google.gerrit.server.restapi.config.Module()); + install(new AccessRestApiModule()); + install(new AccountRestApiModule()); + install(new ChangeRestApiModule()); + install(new ConfigRestApiModule()); install(new RestCacheAdminModule()); - install(new com.google.gerrit.server.restapi.group.Module()); + install(new GroupRestApiModule()); install(new PluginRestApiModule()); - install(new com.google.gerrit.server.restapi.project.Module()); - install(new com.google.gerrit.server.restapi.project.Module.BatchModule()); + install(new ProjectRestApiModule()); + install(new ProjectRestApiModule.BatchModule()); } }
diff --git a/java/com/google/gerrit/server/restapi/access/Module.java b/java/com/google/gerrit/server/restapi/access/AccessRestApiModule.java similarity index 94% rename from java/com/google/gerrit/server/restapi/access/Module.java rename to java/com/google/gerrit/server/restapi/access/AccessRestApiModule.java index 3a4955d..71bb696 100644 --- a/java/com/google/gerrit/server/restapi/access/Module.java +++ b/java/com/google/gerrit/server/restapi/access/AccessRestApiModule.java
@@ -20,7 +20,7 @@ import com.google.gerrit.extensions.restapi.RestApiModule; /** Guice module that binds all REST endpoints for {@code /access/}. */ -public class Module extends RestApiModule { +public class AccessRestApiModule extends RestApiModule { @Override protected void configure() { bind(AccessCollection.class);
diff --git a/java/com/google/gerrit/server/restapi/access/ListAccess.java b/java/com/google/gerrit/server/restapi/access/ListAccess.java index 1e1bade..c3b4ff2 100644 --- a/java/com/google/gerrit/server/restapi/access/ListAccess.java +++ b/java/com/google/gerrit/server/restapi/access/ListAccess.java
@@ -14,11 +14,18 @@ package com.google.gerrit.server.restapi.access; +import com.google.common.base.Strings; import com.google.gerrit.entities.Project; import com.google.gerrit.extensions.api.access.ProjectAccessInfo; +import com.google.gerrit.extensions.restapi.AuthException; +import com.google.gerrit.extensions.restapi.IdString; +import com.google.gerrit.extensions.restapi.ResourceNotFoundException; import com.google.gerrit.extensions.restapi.Response; import com.google.gerrit.extensions.restapi.RestReadView; import com.google.gerrit.extensions.restapi.TopLevelResource; +import com.google.gerrit.server.permissions.PermissionBackend; +import com.google.gerrit.server.permissions.ProjectPermission; +import com.google.gerrit.server.project.ProjectCache; import com.google.gerrit.server.restapi.project.GetAccess; import com.google.inject.Inject; import java.util.ArrayList; @@ -41,10 +48,15 @@ usage = "projects for which the access rights should be returned") private List<String> projects = new ArrayList<>(); + private final PermissionBackend permissionBackend; + private final ProjectCache projectCache; private final GetAccess getAccess; @Inject - public ListAccess(GetAccess getAccess) { + public ListAccess( + PermissionBackend permissionBackend, ProjectCache projectCache, GetAccess getAccess) { + this.permissionBackend = permissionBackend; + this.projectCache = projectCache; this.getAccess = getAccess; } @@ -53,7 +65,23 @@ throws Exception { Map<String, ProjectAccessInfo> access = new TreeMap<>(); for (String p : projects) { - access.put(p, getAccess.apply(Project.nameKey(p))); + if (Strings.nullToEmpty(p).isEmpty()) { + continue; + } + + Project.NameKey projectName = Project.nameKey(IdString.fromUrl(p).get().trim()); + + if (!projectCache.get(projectName).isPresent()) { + throw new ResourceNotFoundException(projectName.get()); + } + + try { + permissionBackend.currentUser().project(projectName).check(ProjectPermission.ACCESS); + } catch (AuthException e) { + throw new ResourceNotFoundException(projectName.get(), e); + } + + access.put(projectName.get(), getAccess.apply(projectName)); } return Response.ok(access); }
diff --git a/java/com/google/gerrit/server/restapi/account/Module.java b/java/com/google/gerrit/server/restapi/account/AccountRestApiModule.java similarity index 96% rename from java/com/google/gerrit/server/restapi/account/Module.java rename to java/com/google/gerrit/server/restapi/account/AccountRestApiModule.java index 7570465..2a8f55f 100644 --- a/java/com/google/gerrit/server/restapi/account/Module.java +++ b/java/com/google/gerrit/server/restapi/account/AccountRestApiModule.java
@@ -30,7 +30,7 @@ import com.google.gerrit.server.account.externalids.ExternalIdNotes; import com.google.inject.Provides; -public class Module extends RestApiModule { +public class AccountRestApiModule extends RestApiModule { @Override protected void configure() { bind(AccountsCollection.class); @@ -99,10 +99,6 @@ delete(STARRED_CHANGE_KIND).to(StarredChanges.Delete.class); bind(StarredChanges.Create.class); - child(ACCOUNT_KIND, "stars.changes").to(Stars.class); - get(STAR_KIND).to(Stars.Get.class); - post(STAR_KIND).to(Stars.Post.class); - get(ACCOUNT_KIND, "external.ids").to(GetExternalIds.class); post(ACCOUNT_KIND, "external.ids:delete").to(DeleteExternalIds.class);
diff --git a/java/com/google/gerrit/server/restapi/account/CreateAccount.java b/java/com/google/gerrit/server/restapi/account/CreateAccount.java index b65f4ee..b4946c4 100644 --- a/java/com/google/gerrit/server/restapi/account/CreateAccount.java +++ b/java/com/google/gerrit/server/restapi/account/CreateAccount.java
@@ -44,10 +44,11 @@ import com.google.gerrit.server.account.VersionedAuthorizedKeys; import com.google.gerrit.server.account.externalids.DuplicateExternalIdKeyException; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; import com.google.gerrit.server.config.AuthConfig; import com.google.gerrit.server.group.GroupResolver; +import com.google.gerrit.server.group.db.GroupDelta; import com.google.gerrit.server.group.db.GroupsUpdate; -import com.google.gerrit.server.group.db.InternalGroupUpdate; import com.google.gerrit.server.mail.send.OutgoingEmailValidator; import com.google.gerrit.server.notedb.Sequences; import com.google.gerrit.server.permissions.PermissionBackendException; @@ -85,6 +86,7 @@ private final Provider<GroupsUpdate> groupsUpdate; private final OutgoingEmailValidator validator; private final AuthConfig authConfig; + private final ExternalIdFactory externalIdFactory; @Inject CreateAccount( @@ -97,7 +99,8 @@ PluginSetContext<AccountExternalIdCreator> externalIdCreators, @UserInitiated Provider<GroupsUpdate> groupsUpdate, OutgoingEmailValidator validator, - AuthConfig authConfig) { + AuthConfig authConfig, + ExternalIdFactory externalIdFactory) { this.seq = seq; this.groupResolver = groupResolver; this.authorizedKeys = authorizedKeys; @@ -108,6 +111,7 @@ this.groupsUpdate = groupsUpdate; this.validator = validator; this.authConfig = authConfig; + this.externalIdFactory = externalIdFactory; } @Override @@ -142,10 +146,10 @@ if (!validator.isValid(input.email)) { throw new BadRequestException("invalid email address"); } - extIds.add(ExternalId.createEmail(accountId, input.email)); + extIds.add(externalIdFactory.createEmail(accountId, input.email)); } - extIds.add(ExternalId.createUsername(username, accountId, input.httpPassword)); + extIds.add(externalIdFactory.createUsername(username, accountId, input.httpPassword)); externalIdCreators.runEach(c -> extIds.addAll(c.create(accountId, username, input.email))); try { @@ -209,10 +213,10 @@ private void addGroupMember(AccountGroup.UUID groupUuid, Account.Id accountId) throws IOException, NoSuchGroupException, ConfigInvalidException { - InternalGroupUpdate groupUpdate = - InternalGroupUpdate.builder() + GroupDelta groupDelta = + GroupDelta.builder() .setMemberModification(memberIds -> Sets.union(memberIds, ImmutableSet.of(accountId))) .build(); - groupsUpdate.get().updateGroup(groupUuid, groupUpdate); + groupsUpdate.get().updateGroup(groupUuid, groupDelta); } }
diff --git a/java/com/google/gerrit/server/restapi/account/CreateEmail.java b/java/com/google/gerrit/server/restapi/account/CreateEmail.java index 6ee4539..70fbb26 100644 --- a/java/com/google/gerrit/server/restapi/account/CreateEmail.java +++ b/java/com/google/gerrit/server/restapi/account/CreateEmail.java
@@ -83,6 +83,7 @@ private final OutgoingEmailValidator validator; private final MessageIdGenerator messageIdGenerator; private final boolean isDevMode; + private final AuthRequest.Factory authRequestFactory; @Inject CreateEmail( @@ -94,7 +95,8 @@ RegisterNewEmailSender.Factory registerNewEmailFactory, PutPreferred putPreferred, OutgoingEmailValidator validator, - MessageIdGenerator messageIdGenerator) { + MessageIdGenerator messageIdGenerator, + AuthRequest.Factory authRequestFactory) { this.self = self; this.realm = realm; this.permissionBackend = permissionBackend; @@ -104,6 +106,7 @@ this.validator = validator; this.isDevMode = authConfig.getAuthType() == DEVELOPMENT_BECOME_ANY_ACCOUNT; this.messageIdGenerator = messageIdGenerator; + this.authRequestFactory = authRequestFactory; } @Override @@ -151,7 +154,7 @@ logger.atWarning().log("skipping email validation in developer mode"); } try { - accountManager.link(user.getAccountId(), AuthRequest.forEmail(email)); + accountManager.link(user.getAccountId(), authRequestFactory.createForEmail(email)); } catch (AccountException e) { throw new ResourceConflictException(e.getMessage()); }
diff --git a/java/com/google/gerrit/server/restapi/account/DeleteDraftComments.java b/java/com/google/gerrit/server/restapi/account/DeleteDraftComments.java index ec82e1a..1485a6e5 100644 --- a/java/com/google/gerrit/server/restapi/account/DeleteDraftComments.java +++ b/java/com/google/gerrit/server/restapi/account/DeleteDraftComments.java
@@ -41,13 +41,12 @@ import com.google.gerrit.server.change.ChangeJson; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.query.change.ChangeData; +import com.google.gerrit.server.query.change.ChangePredicates; import com.google.gerrit.server.query.change.ChangeQueryBuilder; -import com.google.gerrit.server.query.change.HasDraftByPredicate; import com.google.gerrit.server.query.change.InternalChangeQuery; import com.google.gerrit.server.restapi.change.CommentJson; import com.google.gerrit.server.restapi.change.CommentJson.HumanCommentFormatter; import com.google.gerrit.server.update.BatchUpdate; -import com.google.gerrit.server.update.BatchUpdate.Factory; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; import com.google.gerrit.server.update.UpdateException; @@ -80,7 +79,7 @@ @Inject DeleteDraftComments( Provider<CurrentUser> userProvider, - Factory batchUpdateFactory, + BatchUpdate.Factory batchUpdateFactory, Provider<ChangeQueryBuilder> queryBuilderProvider, Provider<InternalChangeQuery> queryProvider, ChangeData.Factory changeDataFactory, @@ -147,7 +146,7 @@ private Predicate<ChangeData> predicate(Account.Id accountId, DeleteDraftCommentsInput input) throws BadRequestException { - Predicate<ChangeData> hasDraft = new HasDraftByPredicate(accountId); + Predicate<ChangeData> hasDraft = ChangePredicates.draftBy(accountId); if (CharMatcher.whitespace().trimFrom(Strings.nullToEmpty(input.query)).isEmpty()) { return hasDraft; }
diff --git a/java/com/google/gerrit/server/restapi/account/DeleteExternalIds.java b/java/com/google/gerrit/server/restapi/account/DeleteExternalIds.java index 445a5d6..e099a70 100644 --- a/java/com/google/gerrit/server/restapi/account/DeleteExternalIds.java +++ b/java/com/google/gerrit/server/restapi/account/DeleteExternalIds.java
@@ -18,6 +18,8 @@ import static java.util.stream.Collectors.toMap; import static java.util.stream.Collectors.toSet; +import com.google.common.collect.ImmutableSet; +import com.google.gerrit.extensions.restapi.AuthException; import com.google.gerrit.extensions.restapi.BadRequestException; import com.google.gerrit.extensions.restapi.ResourceConflictException; import com.google.gerrit.extensions.restapi.Response; @@ -29,6 +31,7 @@ import com.google.gerrit.server.account.AccountManager; import com.google.gerrit.server.account.AccountResource; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.permissions.GlobalPermission; import com.google.gerrit.server.permissions.PermissionBackend; @@ -56,17 +59,20 @@ private final AccountManager accountManager; private final ExternalIds externalIds; private final Provider<CurrentUser> self; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject DeleteExternalIds( PermissionBackend permissionBackend, AccountManager accountManager, ExternalIds externalIds, - Provider<CurrentUser> self) { + Provider<CurrentUser> self, + ExternalIdKeyFactory externalIdKeyFactory) { this.permissionBackend = permissionBackend; this.accountManager = accountManager; this.externalIds = externalIds; this.self = self; + this.externalIdKeyFactory = externalIdKeyFactory; } @Override @@ -87,15 +93,24 @@ List<ExternalId> toDelete = new ArrayList<>(); Optional<ExternalId.Key> last = resource.getUser().getLastLoginExternalIdKey(); for (String externalIdStr : extIds) { - ExternalId id = externalIdMap.get(ExternalId.Key.parse(externalIdStr)); + ExternalId id = externalIdMap.get(externalIdKeyFactory.parse(externalIdStr)); if (id == null) { throw new UnprocessableEntityException( String.format("External id %s does not exist", externalIdStr)); } - if ((!id.isScheme(SCHEME_USERNAME)) - && (!last.isPresent() || (!last.get().equals(id.key())))) { + if (!last.isPresent() || !last.get().equals(id.key())) { + if (id.isScheme(SCHEME_USERNAME)) { + if (self.get().hasSameAccountId(resource.getUser())) { + throw new AuthException("User cannot delete its own externalId in 'username:' scheme"); + } + permissionBackend + .currentUser() + .checkAny( + ImmutableSet.of( + GlobalPermission.ADMINISTRATE_SERVER, GlobalPermission.MAINTAIN_SERVER)); + } toDelete.add(id); } else { throw new ResourceConflictException(
diff --git a/java/com/google/gerrit/server/restapi/account/PutHttpPassword.java b/java/com/google/gerrit/server/restapi/account/PutHttpPassword.java index 2427def..9361e27 100644 --- a/java/com/google/gerrit/server/restapi/account/PutHttpPassword.java +++ b/java/com/google/gerrit/server/restapi/account/PutHttpPassword.java
@@ -34,6 +34,8 @@ import com.google.gerrit.server.account.AccountResource; import com.google.gerrit.server.account.AccountsUpdate; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.mail.send.HttpPasswordUpdateSender; import com.google.gerrit.server.permissions.GlobalPermission; @@ -77,6 +79,8 @@ private final ExternalIds externalIds; private final Provider<AccountsUpdate> accountsUpdateProvider; private final HttpPasswordUpdateSender.Factory httpPasswordUpdateSenderFactory; + private final ExternalIdFactory externalIdFactory; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject PutHttpPassword( @@ -84,12 +88,16 @@ PermissionBackend permissionBackend, ExternalIds externalIds, @UserInitiated Provider<AccountsUpdate> accountsUpdateProvider, - HttpPasswordUpdateSender.Factory httpPasswordUpdateSenderFactory) { + HttpPasswordUpdateSender.Factory httpPasswordUpdateSenderFactory, + ExternalIdFactory externalIdFactory, + ExternalIdKeyFactory externalIdKeyFactory) { this.self = self; this.permissionBackend = permissionBackend; this.externalIds = externalIds; this.accountsUpdateProvider = accountsUpdateProvider; this.httpPasswordUpdateSenderFactory = httpPasswordUpdateSenderFactory; + this.externalIdFactory = externalIdFactory; + this.externalIdKeyFactory = externalIdKeyFactory; } @Override @@ -125,7 +133,7 @@ String userName = user.getUserName().orElseThrow(() -> new ResourceConflictException("username must be set")); Optional<ExternalId> optionalExtId = - externalIds.get(ExternalId.Key.create(SCHEME_USERNAME, userName)); + externalIds.get(externalIdKeyFactory.create(SCHEME_USERNAME, userName)); ExternalId extId = optionalExtId.orElseThrow(ResourceNotFoundException::new); accountsUpdateProvider .get() @@ -134,7 +142,7 @@ extId.accountId(), u -> u.updateExternalId( - ExternalId.createWithPassword( + externalIdFactory.createWithPassword( extId.key(), extId.accountId(), extId.email(), newPassword))); try {
diff --git a/java/com/google/gerrit/server/restapi/account/PutPreferred.java b/java/com/google/gerrit/server/restapi/account/PutPreferred.java index 32b5ff2..9a11891 100644 --- a/java/com/google/gerrit/server/restapi/account/PutPreferred.java +++ b/java/com/google/gerrit/server/restapi/account/PutPreferred.java
@@ -28,8 +28,10 @@ import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.ServerInitiated; import com.google.gerrit.server.account.AccountResource; +import com.google.gerrit.server.account.AccountState; import com.google.gerrit.server.account.AccountsUpdate; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.permissions.GlobalPermission; import com.google.gerrit.server.permissions.PermissionBackend; @@ -62,17 +64,20 @@ private final PermissionBackend permissionBackend; private final Provider<AccountsUpdate> accountsUpdateProvider; private final ExternalIds externalIds; + private final ExternalIdFactory externalIdFactory; @Inject PutPreferred( Provider<CurrentUser> self, PermissionBackend permissionBackend, @ServerInitiated Provider<AccountsUpdate> accountsUpdateProvider, - ExternalIds externalIds) { + ExternalIds externalIds, + ExternalIdFactory externalIdFactory) { this.self = self; this.permissionBackend = permissionBackend; this.accountsUpdateProvider = accountsUpdateProvider; this.externalIds = externalIds; + this.externalIdFactory = externalIdFactory; } @Override @@ -88,69 +93,75 @@ throws RestApiException, IOException, ConfigInvalidException { AtomicReference<Optional<RestApiException>> exception = new AtomicReference<>(Optional.empty()); AtomicBoolean alreadyPreferred = new AtomicBoolean(false); - accountsUpdateProvider - .get() - .update( - "Set Preferred Email via API", - user.getAccountId(), - (a, u) -> { - if (preferredEmail.equals(a.account().preferredEmail())) { - alreadyPreferred.set(true); - } else { - // check if the user has a matching email - String matchingEmail = null; - for (String email : - a.externalIds().stream() - .map(ExternalId::email) - .filter(Objects::nonNull) - .collect(toSet())) { - if (email.equals(preferredEmail)) { - // we have an email that matches exactly, prefer this one - matchingEmail = email; - break; - } else if (matchingEmail == null && email.equalsIgnoreCase(preferredEmail)) { - // we found an email that matches but has a different case - matchingEmail = email; - } - } - - if (matchingEmail == null) { - // user doesn't have an external ID for this email - if (user.hasEmailAddress(preferredEmail)) { - // but Realm says the user is allowed to use this email - Set<ExternalId> existingExtIdsWithThisEmail = - externalIds.byEmail(preferredEmail); - if (!existingExtIdsWithThisEmail.isEmpty()) { - // but the email is already assigned to another account - logger.atWarning().log( - "Cannot set preferred email %s for account %s because it is owned" - + " by the following account(s): %s", - preferredEmail, - user.getAccountId(), - existingExtIdsWithThisEmail.stream() - .map(ExternalId::accountId) - .collect(toList())); - exception.set( - Optional.of( - new ResourceConflictException("email in use by another account"))); - return; + Optional<AccountState> updatedAccount = + accountsUpdateProvider + .get() + .update( + "Set Preferred Email via API", + user.getAccountId(), + (a, u) -> { + if (preferredEmail.equals(a.account().preferredEmail())) { + alreadyPreferred.set(true); + } else { + // check if the user has a matching email + String matchingEmail = null; + for (String email : + a.externalIds().stream() + .map(ExternalId::email) + .filter(Objects::nonNull) + .collect(toSet())) { + if (email.equals(preferredEmail)) { + // we have an email that matches exactly, prefer this one + matchingEmail = email; + break; + } else if (matchingEmail == null && email.equalsIgnoreCase(preferredEmail)) { + // we found an email that matches but has a different case + matchingEmail = email; + } } - // claim the email now - u.addExternalId(ExternalId.createEmail(a.account().id(), preferredEmail)); - matchingEmail = preferredEmail; - } else { - // Realm says that the email doesn't belong to the user. This can only happen as - // a race condition because EmailsCollection would have thrown - // ResourceNotFoundException already before invoking this REST endpoint. - exception.set(Optional.of(new ResourceNotFoundException(preferredEmail))); - return; + if (matchingEmail == null) { + // user doesn't have an external ID for this email + if (user.hasEmailAddress(preferredEmail)) { + // but Realm says the user is allowed to use this email + Set<ExternalId> existingExtIdsWithThisEmail = + externalIds.byEmail(preferredEmail); + if (!existingExtIdsWithThisEmail.isEmpty()) { + // but the email is already assigned to another account + logger.atWarning().log( + "Cannot set preferred email %s for account %s because it is owned" + + " by the following account(s): %s", + preferredEmail, + user.getAccountId(), + existingExtIdsWithThisEmail.stream() + .map(ExternalId::accountId) + .collect(toList())); + exception.set( + Optional.of( + new ResourceConflictException( + "email in use by another account"))); + return; + } + + // claim the email now + u.addExternalId( + externalIdFactory.createEmail(a.account().id(), preferredEmail)); + matchingEmail = preferredEmail; + } else { + // Realm says that the email doesn't belong to the user. This can only + // happen as + // a race condition because EmailsCollection would have thrown + // ResourceNotFoundException already before invoking this REST endpoint. + exception.set(Optional.of(new ResourceNotFoundException(preferredEmail))); + return; + } + } + u.setPreferredEmail(matchingEmail); } - } - u.setPreferredEmail(matchingEmail); - } - }) - .orElseThrow(() -> new ResourceNotFoundException("account not found")); + }); + if (!updatedAccount.isPresent()) { + throw new ResourceNotFoundException("account not found"); + } if (exception.get().isPresent()) { throw exception.get().get(); }
diff --git a/java/com/google/gerrit/server/restapi/account/PutUsername.java b/java/com/google/gerrit/server/restapi/account/PutUsername.java index 05bf1fd..f295389 100644 --- a/java/com/google/gerrit/server/restapi/account/PutUsername.java +++ b/java/com/google/gerrit/server/restapi/account/PutUsername.java
@@ -34,6 +34,8 @@ import com.google.gerrit.server.account.AccountsUpdate; import com.google.gerrit.server.account.Realm; import com.google.gerrit.server.account.externalids.ExternalId; +import com.google.gerrit.server.account.externalids.ExternalIdFactory; +import com.google.gerrit.server.account.externalids.ExternalIdKeyFactory; import com.google.gerrit.server.account.externalids.ExternalIds; import com.google.gerrit.server.permissions.GlobalPermission; import com.google.gerrit.server.permissions.PermissionBackend; @@ -65,6 +67,8 @@ private final Provider<AccountsUpdate> accountsUpdateProvider; private final SshKeyCache sshKeyCache; private final Realm realm; + private final ExternalIdFactory externalIdFactory; + private final ExternalIdKeyFactory externalIdKeyFactory; @Inject PutUsername( @@ -73,13 +77,17 @@ ExternalIds externalIds, @ServerInitiated Provider<AccountsUpdate> accountsUpdateProvider, SshKeyCache sshKeyCache, - Realm realm) { + Realm realm, + ExternalIdFactory externalIdFactory, + ExternalIdKeyFactory externalIdKeyFactory) { this.self = self; this.permissionBackend = permissionBackend; this.externalIds = externalIds; this.accountsUpdateProvider = accountsUpdateProvider; this.sshKeyCache = sshKeyCache; this.realm = realm; + this.externalIdFactory = externalIdFactory; + this.externalIdKeyFactory = externalIdKeyFactory; } @Override @@ -107,14 +115,14 @@ throw new UnprocessableEntityException("invalid username"); } - ExternalId.Key key = ExternalId.Key.create(SCHEME_USERNAME, input.username); + ExternalId.Key key = externalIdKeyFactory.create(SCHEME_USERNAME, input.username); try { accountsUpdateProvider .get() .update( "Set Username via API", accountId, - u -> u.addExternalId(ExternalId.create(key, accountId, null, null))); + u -> u.addExternalId(externalIdFactory.create(key, accountId, null, null))); } catch (DuplicateKeyException dupeErr) { // If we are using this identity, don't report the exception. Optional<ExternalId> other = externalIds.get(key);
diff --git a/java/com/google/gerrit/server/restapi/account/QueryAccounts.java b/java/com/google/gerrit/server/restapi/account/QueryAccounts.java index 0d12fd4..e6b4eee 100644 --- a/java/com/google/gerrit/server/restapi/account/QueryAccounts.java +++ b/java/com/google/gerrit/server/restapi/account/QueryAccounts.java
@@ -107,8 +107,8 @@ } @Option(name = "-O", usage = "Output option flags, in hex") - void setOptionFlagsHex(String hex) { - options.addAll(ListOption.fromBits(ListAccountsOption.class, Integer.parseInt(hex, 16))); + void setOptionFlagsHex(String hex) throws BadRequestException { + options.addAll(ListOption.fromHexString(ListAccountsOption.class, hex)); } @Option(
diff --git a/java/com/google/gerrit/server/restapi/account/StarredChanges.java b/java/com/google/gerrit/server/restapi/account/StarredChanges.java index e67fe9e..39c1fef 100644 --- a/java/com/google/gerrit/server/restapi/account/StarredChanges.java +++ b/java/com/google/gerrit/server/restapi/account/StarredChanges.java
@@ -90,7 +90,7 @@ return (RestReadView<AccountResource>) self -> { QueryChanges query = changes.list(); - query.addQuery("starredby:" + self.getUser().getAccountId().get()); + query.addQuery("has:star"); return query.apply(TopLevelResource.INSTANCE); }; }
diff --git a/java/com/google/gerrit/server/restapi/account/Stars.java b/java/com/google/gerrit/server/restapi/account/Stars.java deleted file mode 100644 index cc362f2..0000000 --- a/java/com/google/gerrit/server/restapi/account/Stars.java +++ /dev/null
@@ -1,183 +0,0 @@ -// Copyright (C) 2016 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.restapi.account; - -import com.google.gerrit.extensions.api.changes.StarsInput; -import com.google.gerrit.extensions.common.ChangeInfo; -import com.google.gerrit.extensions.registration.DynamicMap; -import com.google.gerrit.extensions.restapi.AuthException; -import com.google.gerrit.extensions.restapi.BadRequestException; -import com.google.gerrit.extensions.restapi.ChildCollection; -import com.google.gerrit.extensions.restapi.IdString; -import com.google.gerrit.extensions.restapi.Response; -import com.google.gerrit.extensions.restapi.RestApiException; -import com.google.gerrit.extensions.restapi.RestModifyView; -import com.google.gerrit.extensions.restapi.RestReadView; -import com.google.gerrit.extensions.restapi.RestView; -import com.google.gerrit.extensions.restapi.TopLevelResource; -import com.google.gerrit.server.CurrentUser; -import com.google.gerrit.server.IdentifiedUser; -import com.google.gerrit.server.StarredChangesUtil; -import com.google.gerrit.server.StarredChangesUtil.IllegalLabelException; -import com.google.gerrit.server.account.AccountResource; -import com.google.gerrit.server.account.AccountResource.Star; -import com.google.gerrit.server.change.ChangeResource; -import com.google.gerrit.server.permissions.PermissionBackendException; -import com.google.gerrit.server.restapi.change.ChangesCollection; -import com.google.gerrit.server.restapi.change.QueryChanges; -import com.google.inject.Inject; -import com.google.inject.Provider; -import com.google.inject.Singleton; -import java.io.IOException; -import java.util.Collection; -import java.util.List; -import java.util.Set; -import java.util.SortedSet; - -/** - * Implements adding label stars to changes. - * - * <p>This handles {@code POST} and {@code GET} for {@code - * /accounts/<account-identifier>/stars.changes/<change ID>}. - */ -@Singleton -public class Stars implements ChildCollection<AccountResource, AccountResource.Star> { - - private final ChangesCollection changes; - private final ListStarredChanges listStarredChanges; - private final StarredChangesUtil starredChangesUtil; - private final DynamicMap<RestView<AccountResource.Star>> views; - - @Inject - Stars( - ChangesCollection changes, - ListStarredChanges listStarredChanges, - StarredChangesUtil starredChangesUtil, - DynamicMap<RestView<AccountResource.Star>> views) { - this.changes = changes; - this.listStarredChanges = listStarredChanges; - this.starredChangesUtil = starredChangesUtil; - this.views = views; - } - - @Override - public Star parse(AccountResource parent, IdString id) - throws RestApiException, PermissionBackendException, IOException { - IdentifiedUser user = parent.getUser(); - // This enforces visibility of the change. - ChangeResource change = changes.parse(TopLevelResource.INSTANCE, id); - Set<String> labels = starredChangesUtil.getLabels(user.getAccountId(), change.getId()); - return new AccountResource.Star(user, change, labels); - } - - @Override - public DynamicMap<RestView<Star>> views() { - return views; - } - - @Override - public ListStarredChanges list() { - return listStarredChanges; - } - - @Singleton - public static class ListStarredChanges implements RestReadView<AccountResource> { - - private final Provider<CurrentUser> self; - private final ChangesCollection changes; - - @Inject - ListStarredChanges(Provider<CurrentUser> self, ChangesCollection changes) { - this.self = self; - this.changes = changes; - } - - @Override - @SuppressWarnings("unchecked") - public Response<List<ChangeInfo>> apply(AccountResource rsrc) - throws RestApiException, PermissionBackendException { - if (!self.get().hasSameAccountId(rsrc.getUser())) { - throw new AuthException("not allowed to list stars of another account"); - } - - // The type of the value in the response that is returned by QueryChanges depends on the - // number of queries that is provided as input. If a single query is provided as input the - // value type is {@code List<ChangeInfo>}, if multiple queries are provided as input the value - // type is {@code List<List<ChangeInfo>>) (one {@code List<ChangeInfo>} as result to each - // query). Since in this case we provide exactly one query ("has:stars") as input we know that - // the value always has the type {@code List<ChangeInfo>} and hence we can safely cast the - // value to this type. - QueryChanges query = changes.list(); - query.addQuery("has:stars"); - Response<?> response = query.apply(TopLevelResource.INSTANCE); - List<ChangeInfo> value = (List<ChangeInfo>) response.value(); - return Response.ok(value); - } - } - - @Singleton - public static class Get implements RestReadView<AccountResource.Star> { - - private final Provider<CurrentUser> self; - private final StarredChangesUtil starredChangesUtil; - - @Inject - Get(Provider<CurrentUser> self, StarredChangesUtil starredChangesUtil) { - this.self = self; - this.starredChangesUtil = starredChangesUtil; - } - - @Override - public Response<SortedSet<String>> apply(AccountResource.Star rsrc) throws AuthException { - if (!self.get().hasSameAccountId(rsrc.getUser())) { - throw new AuthException("not allowed to get stars of another account"); - } - return Response.ok( - starredChangesUtil.getLabels(self.get().getAccountId(), rsrc.getChange().getId())); - } - } - - @Singleton - public static class Post implements RestModifyView<AccountResource.Star, StarsInput> { - - private final Provider<CurrentUser> self; - private final StarredChangesUtil starredChangesUtil; - - @Inject - Post(Provider<CurrentUser> self, StarredChangesUtil starredChangesUtil) { - this.self = self; - this.starredChangesUtil = starredChangesUtil; - } - - @Override - public Response<Collection<String>> apply(AccountResource.Star rsrc, StarsInput in) - throws AuthException, BadRequestException { - if (!self.get().hasSameAccountId(rsrc.getUser())) { - throw new AuthException("not allowed to update stars of another account"); - } - try { - return Response.ok( - starredChangesUtil.star( - self.get().getAccountId(), - rsrc.getChange().getProject(), - rsrc.getChange().getId(), - in.add, - in.remove)); - } catch (IllegalLabelException e) { - throw new BadRequestException(e.getMessage()); - } - } - } -}
diff --git a/java/com/google/gerrit/server/restapi/change/Abandon.java b/java/com/google/gerrit/server/restapi/change/Abandon.java index b207390..2cfc3f5 100644 --- a/java/com/google/gerrit/server/restapi/change/Abandon.java +++ b/java/com/google/gerrit/server/restapi/change/Abandon.java
@@ -14,9 +14,7 @@ package com.google.gerrit.server.restapi.change; -import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Change; -import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.AbandonInput; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.common.ChangeInfo; @@ -45,8 +43,6 @@ @Singleton public class Abandon implements RestModifyView<ChangeResource, AbandonInput>, UiAction<ChangeResource> { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - private final BatchUpdate.Factory updateFactory; private final ChangeJson.Factory json; private final AbandonOp.Factory abandonOpFactory; @@ -129,7 +125,7 @@ } @Override - public UiAction.Description getDescription(ChangeResource rsrc) { + public UiAction.Description getDescription(ChangeResource rsrc) throws IOException { UiAction.Description description = new UiAction.Description() .setLabel("Abandon") @@ -140,17 +136,9 @@ if (!change.isNew()) { return description; } - - try { - if (patchSetUtil.isPatchSetLocked(rsrc.getNotes())) { - return description; - } - } catch (StorageException e) { - logger.atSevere().withCause(e).log( - "Failed to check if the current patch set of change %s is locked", change.getId()); + if (patchSetUtil.isPatchSetLocked(rsrc.getNotes())) { return description; } - return description.setVisible(rsrc.permissions().testOrFalse(ChangePermission.ABANDON)); } }
diff --git a/java/com/google/gerrit/server/restapi/change/Module.java b/java/com/google/gerrit/server/restapi/change/ChangeRestApiModule.java similarity index 98% rename from java/com/google/gerrit/server/restapi/change/Module.java rename to java/com/google/gerrit/server/restapi/change/ChangeRestApiModule.java index f87c9a1..02b4c13 100644 --- a/java/com/google/gerrit/server/restapi/change/Module.java +++ b/java/com/google/gerrit/server/restapi/change/ChangeRestApiModule.java
@@ -53,7 +53,7 @@ import com.google.gerrit.server.restapi.change.Reviewed.PutReviewed; import com.google.gerrit.server.util.AttentionSetEmail; -public class Module extends RestApiModule { +public class ChangeRestApiModule extends RestApiModule { @Override protected void configure() { bind(ChangesCollection.class); @@ -120,11 +120,10 @@ delete(CHANGE_KIND, "private").to(DeletePrivate.class); put(CHANGE_KIND, "ignore").to(Ignore.class); put(CHANGE_KIND, "unignore").to(Unignore.class); - put(CHANGE_KIND, "reviewed").to(MarkAsReviewed.class); - put(CHANGE_KIND, "unreviewed").to(MarkAsUnreviewed.class); post(CHANGE_KIND, "wip").to(SetWorkInProgress.class); post(CHANGE_KIND, "ready").to(SetReadyForReview.class); put(CHANGE_KIND, "message").to(PutMessage.class); + post(CHANGE_KIND, "check.submit_requirement").to(CheckSubmitRequirement.class); get(CHANGE_KIND, "suggest_reviewers").to(SuggestChangeReviewers.class); child(CHANGE_KIND, "reviewers").to(Reviewers.class);
diff --git a/java/com/google/gerrit/server/restapi/change/CheckSubmitRequirement.java b/java/com/google/gerrit/server/restapi/change/CheckSubmitRequirement.java new file mode 100644 index 0000000..55b234c --- /dev/null +++ b/java/com/google/gerrit/server/restapi/change/CheckSubmitRequirement.java
@@ -0,0 +1,79 @@ +// Copyright (C) 2021 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package com.google.gerrit.server.restapi.change; + +import com.google.gerrit.entities.SubmitRequirement; +import com.google.gerrit.entities.SubmitRequirementExpression; +import com.google.gerrit.entities.SubmitRequirementResult; +import com.google.gerrit.extensions.common.SubmitRequirementInput; +import com.google.gerrit.extensions.common.SubmitRequirementResultInfo; +import com.google.gerrit.extensions.restapi.BadRequestException; +import com.google.gerrit.extensions.restapi.Response; +import com.google.gerrit.extensions.restapi.RestModifyView; +import com.google.gerrit.server.change.ChangeResource; +import com.google.gerrit.server.change.SubmitRequirementsJson; +import com.google.gerrit.server.project.SubmitRequirementsEvaluator; +import com.google.inject.Inject; +import java.util.Optional; + +/** + * A rest view to evaluate (test) a {@link com.google.gerrit.entities.SubmitRequirement} on a given + * change. + * + * <p>TODO(ghareeb): Can this class be made singleton? + */ +public class CheckSubmitRequirement + implements RestModifyView<ChangeResource, SubmitRequirementInput> { + private final SubmitRequirementsEvaluator evaluator; + + @Inject + public CheckSubmitRequirement(SubmitRequirementsEvaluator evaluator) { + this.evaluator = evaluator; + } + + @Override + public Response<SubmitRequirementResultInfo> apply( + ChangeResource resource, SubmitRequirementInput input) throws BadRequestException { + SubmitRequirement requirement = createSubmitRequirement(input); + SubmitRequirementResult res = + evaluator.evaluateRequirement(requirement, resource.getChangeData()); + return Response.ok(SubmitRequirementsJson.toInfo(requirement, res)); + } + + private SubmitRequirement createSubmitRequirement(SubmitRequirementInput input) + throws BadRequestException { + validateSubmitRequirementInput(input); + return SubmitRequirement.builder() + .setName(input.name) + .setDescription(Optional.ofNullable(input.description)) + .setApplicabilityExpression(SubmitRequirementExpression.of(input.applicabilityExpression)) + .setSubmittabilityExpression( + SubmitRequirementExpression.create(input.submittabilityExpression)) + .setOverrideExpression(SubmitRequirementExpression.of(input.overrideExpression)) + .setAllowOverrideInChildProjects( + input.allowOverrideInChildProjects == null ? true : input.allowOverrideInChildProjects) + .build(); + } + + private void validateSubmitRequirementInput(SubmitRequirementInput input) + throws BadRequestException { + if (input.name == null) { + throw new BadRequestException("Field 'name' is missing from input."); + } + if (input.submittabilityExpression == null) { + throw new BadRequestException("Field 'submittability_expression' is missing from input."); + } + } +}
diff --git a/java/com/google/gerrit/server/restapi/change/CherryPickChange.java b/java/com/google/gerrit/server/restapi/change/CherryPickChange.java index 3d3ef69..c8771ee 100644 --- a/java/com/google/gerrit/server/restapi/change/CherryPickChange.java +++ b/java/com/google/gerrit/server/restapi/change/CherryPickChange.java
@@ -33,11 +33,11 @@ import com.google.gerrit.extensions.restapi.ResourceConflictException; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.extensions.restapi.UnprocessableEntityException; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.GerritPersonIdent; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.ReviewerSet; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.ChangeInserter; import com.google.gerrit.server.change.NotifyResolver; import com.google.gerrit.server.change.PatchSetInserter; @@ -328,6 +328,7 @@ input.parent - 1, input.allowEmpty, input.allowConflicts); + oi.flush(); } catch (MergeIdenticalTreeException | MergeConflictException e) { throw new IntegrationConflictException("Cherry pick failed: " + e.getMessage(), e); } @@ -448,6 +449,9 @@ if (workInProgress != null) { inserter.setWorkInProgress(workInProgress); } + if (shouldSetToReady(cherryPickCommit, destNotes, workInProgress)) { + inserter.setWorkInProgress(false); + } bu.addOp(destChange.getId(), inserter); PatchSet.Id sourcePatchSetId = sourceChange == null ? null : sourceChange.currentPatchSetId(); // If sourceChange is not provided, reset cherryPickOf to avoid stale value. @@ -461,6 +465,20 @@ return destChange.getId(); } + /** + * We should set the change to be "ready for review" if: 1. workInProgress is not already set on + * this request. 2. The patch-set doesn't have any git conflict markers. 3. The change used to be + * work in progress (because of a previous patch-set). + */ + private boolean shouldSetToReady( + CodeReviewCommit cherryPickCommit, + ChangeNotes destChangeNotes, + @Nullable Boolean workInProgress) { + return workInProgress == null + && cherryPickCommit.getFilesWithGitConflicts().isEmpty() + && destChangeNotes.getChange().isWorkInProgress(); + } + private Change.Id createNewChange( BatchUpdate bu, CodeReviewCommit cherryPickCommit,
diff --git a/java/com/google/gerrit/server/restapi/change/CommentJson.java b/java/com/google/gerrit/server/restapi/change/CommentJson.java index edc8fcf..81b6fb3 100644 --- a/java/com/google/gerrit/server/restapi/change/CommentJson.java +++ b/java/com/google/gerrit/server/restapi/change/CommentJson.java
@@ -190,7 +190,7 @@ return CommentContextKey.builder() .project(project) .changeId(changeId) - .id(r.id) + .id(Url.decode(r.id)) // We reverse the encoding done while filling comment info .path(r.path) .patchset(r.patchSet) .contextPadding(contextPadding)
diff --git a/java/com/google/gerrit/server/restapi/change/CommentPorter.java b/java/com/google/gerrit/server/restapi/change/CommentPorter.java index 34af285..1a4eb18 100644 --- a/java/com/google/gerrit/server/restapi/change/CommentPorter.java +++ b/java/com/google/gerrit/server/restapi/change/CommentPorter.java
@@ -29,28 +29,30 @@ import com.google.gerrit.entities.Patch; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.Project; -import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; import com.google.gerrit.metrics.Counter0; import com.google.gerrit.metrics.Description; import com.google.gerrit.metrics.MetricMaker; import com.google.gerrit.server.CommentsUtil; +import com.google.gerrit.server.logging.Metadata; +import com.google.gerrit.server.logging.TraceContext; +import com.google.gerrit.server.logging.TraceContext.TraceTimer; import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.patch.DiffMappings; +import com.google.gerrit.server.patch.DiffNotAvailableException; +import com.google.gerrit.server.patch.DiffOperations; import com.google.gerrit.server.patch.GitPositionTransformer; import com.google.gerrit.server.patch.GitPositionTransformer.BestPositionOnConflict; import com.google.gerrit.server.patch.GitPositionTransformer.FileMapping; import com.google.gerrit.server.patch.GitPositionTransformer.Mapping; import com.google.gerrit.server.patch.GitPositionTransformer.Position; import com.google.gerrit.server.patch.GitPositionTransformer.PositionedEntity; -import com.google.gerrit.server.patch.PatchList; -import com.google.gerrit.server.patch.PatchListCache; -import com.google.gerrit.server.patch.PatchListKey; -import com.google.gerrit.server.patch.PatchListNotAvailableException; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; +import com.google.gerrit.server.patch.filediff.FileEdits; +import com.google.gerrit.server.patch.filediff.TaggedEdit; import com.google.inject.Inject; import com.google.inject.Singleton; import java.util.List; import java.util.Map; -import java.util.Map.Entry; import java.util.Optional; import java.util.function.Function; import java.util.stream.Stream; @@ -99,15 +101,15 @@ } } + private final DiffOperations diffOperations; private final GitPositionTransformer positionTransformer = new GitPositionTransformer(BestPositionOnConflict.INSTANCE); - private final PatchListCache patchListCache; private final CommentsUtil commentsUtil; private final Metrics metrics; @Inject - public CommentPorter(PatchListCache patchListCache, CommentsUtil commentsUtil, Metrics metrics) { - this.patchListCache = patchListCache; + public CommentPorter(DiffOperations diffOperations, CommentsUtil commentsUtil, Metrics metrics) { + this.diffOperations = diffOperations; this.commentsUtil = commentsUtil; this.metrics = metrics; } @@ -142,10 +144,13 @@ PatchSet targetPatchset, List<HumanComment> comments, List<HumanCommentFilter> filters) { - - ImmutableList<HumanCommentFilter> allFilters = addDefaultFilters(filters, targetPatchset); - ImmutableList<HumanComment> relevantComments = filter(comments, allFilters); - return port(changeNotes, targetPatchset, relevantComments); + try (TraceTimer ignored = + TraceContext.newTimer( + "Porting comments", Metadata.builder().patchSetId(targetPatchset.number()).build())) { + ImmutableList<HumanCommentFilter> allFilters = addDefaultFilters(filters, targetPatchset); + ImmutableList<HumanComment> relevantComments = filter(comments, allFilters); + return port(changeNotes, targetPatchset, relevantComments); + } } private ImmutableList<HumanCommentFilter> addDefaultFilters( @@ -203,20 +208,29 @@ PatchSet originalPatchset, PatchSet targetPatchset, ImmutableList<HumanComment> comments) { - Map<Short, List<HumanComment>> commentsPerSide = - comments.stream().collect(groupingBy(comment -> comment.side)); - ImmutableList.Builder<HumanComment> portedComments = ImmutableList.builder(); - for (Entry<Short, List<HumanComment>> sideAndComments : commentsPerSide.entrySet()) { - portedComments.addAll( - portSamePatchsetAndSide( - project, - change, - originalPatchset, - targetPatchset, - sideAndComments.getValue(), - sideAndComments.getKey())); + try (TraceTimer ignored = + TraceContext.newTimer( + "Porting comments same patchset", + Metadata.builder() + .projectName(project.get()) + .changeId(change.getChangeId()) + .patchSetId(originalPatchset.number()) + .build())) { + Map<Short, List<HumanComment>> commentsPerSide = + comments.stream().collect(groupingBy(comment -> comment.side)); + ImmutableList.Builder<HumanComment> portedComments = ImmutableList.builder(); + for (Map.Entry<Short, List<HumanComment>> sideAndComments : commentsPerSide.entrySet()) { + portedComments.addAll( + portSamePatchsetAndSide( + project, + change, + originalPatchset, + targetPatchset, + sideAndComments.getValue(), + sideAndComments.getKey())); + } + return portedComments.build(); } - return portedComments.build(); } private ImmutableList<HumanComment> portSamePatchsetAndSide( @@ -226,30 +240,40 @@ PatchSet targetPatchset, List<HumanComment> comments, short side) { - ImmutableSet<Mapping> mappings; - try { - mappings = loadMappings(project, change, originalPatchset, targetPatchset, side); - } catch (Exception e) { - logger.atWarning().withCause(e).log( - "Could not determine some necessary diff mappings for porting comments on change %s from" - + " patchset %s to patchset %s. Mapping %d affected comments to the fallback" - + " destination.", - change.getChangeId(), - originalPatchset.id().getId(), - targetPatchset.id().getId(), - comments.size()); - mappings = getFallbackMappings(comments); - } + try (TraceTimer ignored = + TraceContext.newTimer( + "Porting comments same patchset and side", + Metadata.builder() + .projectName(project.get()) + .changeId(change.getChangeId()) + .patchSetId(originalPatchset.number()) + .commentSide(side) + .build())) { + ImmutableSet<Mapping> mappings; + try { + mappings = loadMappings(project, change, originalPatchset, targetPatchset, side); + } catch (Exception e) { + logger.atWarning().withCause(e).log( + "Could not determine some necessary diff mappings for porting comments on change %s from" + + " patchset %s to patchset %s. Mapping %d affected comments to the fallback" + + " destination.", + change.getChangeId(), + originalPatchset.id().getId(), + targetPatchset.id().getId(), + comments.size()); + mappings = getFallbackMappings(comments); + } - ImmutableList<PositionedEntity<HumanComment>> positionedComments = - comments.stream().map(this::toPositionedEntity).collect(toImmutableList()); - ImmutableMap<PositionedEntity<HumanComment>, HumanComment> origToPortedMap = - positionTransformer.transform(positionedComments, mappings).stream() - .collect( - ImmutableMap.toImmutableMap( - Function.identity(), PositionedEntity::getEntityAtUpdatedPosition)); - collectMetrics(origToPortedMap); - return ImmutableList.copyOf(origToPortedMap.values()); + ImmutableList<PositionedEntity<HumanComment>> positionedComments = + comments.stream().map(this::toPositionedEntity).collect(toImmutableList()); + ImmutableMap<PositionedEntity<HumanComment>, HumanComment> origToPortedMap = + positionTransformer.transform(positionedComments, mappings).stream() + .collect( + ImmutableMap.toImmutableMap( + Function.identity(), PositionedEntity::getEntityAtUpdatedPosition)); + collectMetrics(origToPortedMap); + return ImmutableList.copyOf(origToPortedMap.values()); + } } private ImmutableSet<Mapping> loadMappings( @@ -258,10 +282,19 @@ PatchSet originalPatchset, PatchSet targetPatchset, short side) - throws PatchListNotAvailableException { - ObjectId originalCommit = determineCommitId(change, originalPatchset, side); - ObjectId targetCommit = determineCommitId(change, targetPatchset, side); - return loadCommitMappings(project, originalCommit, targetCommit); + throws DiffNotAvailableException { + try (TraceTimer ignored = + TraceContext.newTimer( + "Loading commit mappings", + Metadata.builder() + .projectName(project.get()) + .changeId(change.getChangeId()) + .patchSetId(originalPatchset.number()) + .build())) { + ObjectId originalCommit = determineCommitId(change, originalPatchset, side); + ObjectId targetCommit = determineCommitId(change, targetPatchset, side); + return loadCommitMappings(project, originalCommit, targetCommit); + } } private ObjectId determineCommitId(Change change, PatchSet patchset, short side) { @@ -277,12 +310,24 @@ private ImmutableSet<Mapping> loadCommitMappings( Project.NameKey project, ObjectId originalCommit, ObjectId targetCommit) - throws PatchListNotAvailableException { - PatchList patchList = - patchListCache.get( - PatchListKey.againstCommit(originalCommit, targetCommit, Whitespace.IGNORE_NONE), - project); - return patchList.getPatches().stream().map(DiffMappings::toMapping).collect(toImmutableSet()); + throws DiffNotAvailableException { + try (TraceTimer ignored = + TraceContext.newTimer( + "Computing diffs", Metadata.builder().commit(originalCommit.name()).build())) { + Map<String, FileDiffOutput> modifiedFiles = + diffOperations.listModifiedFiles(project, originalCommit, targetCommit); + return modifiedFiles.values().stream() + .map(CommentPorter::getFileEdits) + .map(DiffMappings::toMapping) + .collect(toImmutableSet()); + } + } + + private static FileEdits getFileEdits(FileDiffOutput fileDiffOutput) { + return FileEdits.create( + fileDiffOutput.edits().stream().map(TaggedEdit::edit).collect(toImmutableList()), + fileDiffOutput.oldPath(), + fileDiffOutput.newPath()); } private ImmutableSet<Mapping> getFallbackMappings(List<HumanComment> comments) {
diff --git a/java/com/google/gerrit/server/restapi/change/CreateChange.java b/java/com/google/gerrit/server/restapi/change/CreateChange.java index c392bd1..fa47bef 100644 --- a/java/com/google/gerrit/server/restapi/change/CreateChange.java +++ b/java/com/google/gerrit/server/restapi/change/CreateChange.java
@@ -19,6 +19,7 @@ import com.google.common.base.Joiner; import com.google.common.base.Strings; +import com.google.common.collect.ImmutableListMultimap; import com.google.common.collect.Iterables; import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; @@ -377,6 +378,8 @@ // create an empty commit c = newCommit(oi, rw, author, committer, mergeTip, commitMessage); } + // Flush inserter so that commit becomes visible to validators + oi.flush(); Change.Id changeId = Change.id(seq.nextChangeId()); ChangeInserter ins = changeInserterFactory.create(changeId, c, input.branch); @@ -385,6 +388,17 @@ ins.setPrivate(input.isPrivate); ins.setWorkInProgress(input.workInProgress || !c.getFilesWithGitConflicts().isEmpty()); ins.setGroups(groups); + + if (input.validationOptions != null) { + ImmutableListMultimap.Builder<String, String> validationOptions = + ImmutableListMultimap.builder(); + input + .validationOptions + .entrySet() + .forEach(e -> validationOptions.put(e.getKey(), e.getValue())); + ins.setValidationOptions(validationOptions.build()); + } + try (BatchUpdate bu = updateFactory.create(projectState.getNameKey(), me, now)) { bu.setRepository(git, rw, oi); bu.setNotify(
diff --git a/java/com/google/gerrit/server/restapi/change/CreateMergePatchSet.java b/java/com/google/gerrit/server/restapi/change/CreateMergePatchSet.java index af4bf69..e943e47 100644 --- a/java/com/google/gerrit/server/restapi/change/CreateMergePatchSet.java +++ b/java/com/google/gerrit/server/restapi/change/CreateMergePatchSet.java
@@ -194,6 +194,7 @@ sourceCommit, author, ObjectId.fromString(change.getKey().get().substring(1))); + oi.flush(); PatchSet.Id nextPsId = ChangeUtil.nextPatchSetId(ps.id()); PatchSetInserter psInserter =
diff --git a/java/com/google/gerrit/server/restapi/change/DeleteAssignee.java b/java/com/google/gerrit/server/restapi/change/DeleteAssignee.java index 842ed2a..d867e00 100644 --- a/java/com/google/gerrit/server/restapi/change/DeleteAssignee.java +++ b/java/com/google/gerrit/server/restapi/change/DeleteAssignee.java
@@ -16,7 +16,6 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.extensions.common.AccountInfo; import com.google.gerrit.extensions.common.Input; import com.google.gerrit.extensions.restapi.Response; @@ -34,8 +33,9 @@ import com.google.gerrit.server.update.BatchUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.UpdateException; +import com.google.gerrit.server.util.AccountTemplateUtil; import com.google.gerrit.server.util.time.TimeUtil; import com.google.inject.Inject; import com.google.inject.Singleton; @@ -94,7 +94,7 @@ IdentifiedUser deletedAssigneeUser = userFactory.create(currentAssigneeId); deletedAssignee = deletedAssigneeUser.state(); update.removeAssignee(); - addMessage(ctx, update, deletedAssigneeUser); + addMessage(ctx, deletedAssigneeUser); return true; } @@ -102,19 +102,18 @@ return deletedAssignee != null ? deletedAssignee.account().id() : null; } - private void addMessage( - ChangeContext ctx, ChangeUpdate update, IdentifiedUser deletedAssignee) { - ChangeMessage cmsg = - ChangeMessagesUtil.newMessage( - ctx, - "Assignee deleted: " + deletedAssignee.getNameEmail(), - ChangeMessagesUtil.TAG_DELETE_ASSIGNEE); - cmUtil.addChangeMessage(update, cmsg); + private void addMessage(ChangeContext ctx, IdentifiedUser deletedAssignee) { + cmUtil.setChangeMessage( + ctx, + "Assignee deleted: " + + AccountTemplateUtil.getAccountTemplate(deletedAssignee.getAccountId()), + ChangeMessagesUtil.TAG_DELETE_ASSIGNEE); } @Override - public void postUpdate(Context ctx) { - assigneeChanged.fire(change, ctx.getAccount(), deletedAssignee, ctx.getWhen()); + public void postUpdate(PostUpdateContext ctx) { + assigneeChanged.fire( + ctx.getChangeData(change), ctx.getAccount(), deletedAssignee, ctx.getWhen()); } } }
diff --git a/java/com/google/gerrit/server/restapi/change/DeleteChangeMessage.java b/java/com/google/gerrit/server/restapi/change/DeleteChangeMessage.java index 5b44957..0e868e7 100644 --- a/java/com/google/gerrit/server/restapi/change/DeleteChangeMessage.java +++ b/java/com/google/gerrit/server/restapi/change/DeleteChangeMessage.java
@@ -14,12 +14,11 @@ package com.google.gerrit.server.restapi.change; -import static com.google.gerrit.server.ChangeMessagesUtil.createChangeMessageInfo; import static java.util.Objects.requireNonNull; -import com.google.common.annotations.VisibleForTesting; import com.google.common.base.Strings; import com.google.gerrit.common.Nullable; +import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Change; import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.PatchSet; @@ -42,6 +41,7 @@ import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; import com.google.gerrit.server.update.UpdateException; +import com.google.gerrit.server.util.AccountTemplateUtil; import com.google.gerrit.server.util.time.TimeUtil; import com.google.inject.Inject; import com.google.inject.Provider; @@ -85,7 +85,7 @@ permissionBackend.user(user).check(GlobalPermission.ADMINISTRATE_SERVER); String newChangeMessage = - createNewChangeMessage(user.asIdentifiedUser().getName(), input.reason); + createNewChangeMessage(user.asIdentifiedUser().getAccountId(), input.reason); DeleteChangeMessageOp deleteChangeMessageOp = new DeleteChangeMessageOp(resource.getChangeMessageId(), newChangeMessage); try (BatchUpdate batchUpdate = @@ -107,26 +107,29 @@ changeMessagesUtil.byChange(notesFactory.createChecked(project, cId)); ChangeMessage updatedChangeMessage = messages.get(targetIdx); AccountLoader accountLoader = accountLoaderFactory.create(true); - ChangeMessageInfo info = createChangeMessageInfo(updatedChangeMessage, accountLoader); + ChangeMessageInfo info = + changeMessagesUtil.createChangeMessageInfoWithReplacedTemplates( + updatedChangeMessage, accountLoader); accountLoader.fill(); return info; } - @VisibleForTesting - public static String createNewChangeMessage(String deletedBy, @Nullable String deletedReason) { - requireNonNull(deletedBy, "user name must not be null"); + public static String createNewChangeMessage( + Account.Id deletedBy, @Nullable String deletedReason) { + requireNonNull(deletedBy, "user must not be null"); if (Strings.isNullOrEmpty(deletedReason)) { return createNewChangeMessage(deletedBy); } - return String.format("Change message removed by: %s\nReason: %s", deletedBy, deletedReason); + return String.format( + "Change message removed by: %s\nReason: %s", + AccountTemplateUtil.getAccountTemplate(deletedBy), deletedReason); } - @VisibleForTesting - public static String createNewChangeMessage(String deletedBy) { - requireNonNull(deletedBy, "user name must not be null"); + public static String createNewChangeMessage(Account.Id deletedBy) { + requireNonNull(deletedBy, "user must not be null"); - return "Change message removed by: " + deletedBy; + return "Change message removed by: " + AccountTemplateUtil.getAccountTemplate(deletedBy); } private class DeleteChangeMessageOp implements BatchUpdateOp {
diff --git a/java/com/google/gerrit/server/restapi/change/DeleteReviewer.java b/java/com/google/gerrit/server/restapi/change/DeleteReviewer.java index 3e4a483..db8e9de 100644 --- a/java/com/google/gerrit/server/restapi/change/DeleteReviewer.java +++ b/java/com/google/gerrit/server/restapi/change/DeleteReviewer.java
@@ -64,7 +64,7 @@ if (rsrc.isByEmail()) { op = deleteReviewerByEmailOpFactory.create(rsrc.getReviewerByEmail()); } else { - op = deleteReviewerOpFactory.create(rsrc.getReviewerUser().state(), input); + op = deleteReviewerOpFactory.create(rsrc.getReviewerUser().getAccount(), input); } bu.addOp(rsrc.getChange().getId(), op); bu.execute();
diff --git a/java/com/google/gerrit/server/restapi/change/DeleteVote.java b/java/com/google/gerrit/server/restapi/change/DeleteVote.java index 4b813df..7ee38d4 100644 --- a/java/com/google/gerrit/server/restapi/change/DeleteVote.java +++ b/java/com/google/gerrit/server/restapi/change/DeleteVote.java
@@ -21,7 +21,6 @@ import com.google.common.flogger.FluentLogger; import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.LabelTypes; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetApproval; @@ -34,11 +33,13 @@ import com.google.gerrit.extensions.restapi.Response; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.extensions.restapi.RestModifyView; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; +import com.google.gerrit.server.CurrentUser; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.PatchSetUtil; import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.approval.ApprovalsUtil; +import com.google.gerrit.server.change.AddToAttentionSetOp; import com.google.gerrit.server.change.NotifyResolver; import com.google.gerrit.server.change.ReviewerResource; import com.google.gerrit.server.change.VoteResource; @@ -53,11 +54,13 @@ import com.google.gerrit.server.update.BatchUpdate; import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.UpdateException; +import com.google.gerrit.server.util.AccountTemplateUtil; import com.google.gerrit.server.util.LabelVote; import com.google.gerrit.server.util.time.TimeUtil; import com.google.inject.Inject; +import com.google.inject.Provider; import com.google.inject.Singleton; import java.io.IOException; import java.util.HashMap; @@ -72,13 +75,14 @@ private final ApprovalsUtil approvalsUtil; private final PatchSetUtil psUtil; private final ChangeMessagesUtil cmUtil; - private final IdentifiedUser.GenericFactory userFactory; private final VoteDeleted voteDeleted; private final DeleteVoteSender.Factory deleteVoteSenderFactory; private final NotifyResolver notifyResolver; private final RemoveReviewerControl removeReviewerControl; private final ProjectCache projectCache; private final MessageIdGenerator messageIdGenerator; + private final AddToAttentionSetOp.Factory attentionSetOpfactory; + private final Provider<CurrentUser> currentUserProvider; @Inject DeleteVote( @@ -86,24 +90,26 @@ ApprovalsUtil approvalsUtil, PatchSetUtil psUtil, ChangeMessagesUtil cmUtil, - IdentifiedUser.GenericFactory userFactory, VoteDeleted voteDeleted, DeleteVoteSender.Factory deleteVoteSenderFactory, NotifyResolver notifyResolver, RemoveReviewerControl removeReviewerControl, ProjectCache projectCache, - MessageIdGenerator messageIdGenerator) { + MessageIdGenerator messageIdGenerator, + AddToAttentionSetOp.Factory attentionSetOpFactory, + Provider<CurrentUser> currentUserProvider) { this.updateFactory = updateFactory; this.approvalsUtil = approvalsUtil; this.psUtil = psUtil; this.cmUtil = cmUtil; - this.userFactory = userFactory; this.voteDeleted = voteDeleted; this.deleteVoteSenderFactory = deleteVoteSenderFactory; this.notifyResolver = notifyResolver; this.removeReviewerControl = removeReviewerControl; this.projectCache = projectCache; this.messageIdGenerator = messageIdGenerator; + this.attentionSetOpfactory = attentionSetOpFactory; + this.currentUserProvider = currentUserProvider; } @Override @@ -140,6 +146,14 @@ r.getReviewerUser().state(), rsrc.getLabel(), input)); + if (!r.getReviewerUser().getAccountId().equals(currentUserProvider.get().getAccountId())) { + bu.addOp( + change.getId(), + attentionSetOpfactory.create( + r.getReviewerUser().getAccountId(), + /* reason= */ "Their vote was deleted", + /* notify= */ false)); + } bu.execute(); } @@ -152,7 +166,7 @@ private final String label; private final DeleteVoteInput input; - private ChangeMessage changeMessage; + private String mailMessage; private Change change; private PatchSet ps; private Map<String, Short> newApprovals = new HashMap<>(); @@ -181,7 +195,7 @@ for (PatchSetApproval a : approvalsUtil.byPatchSetUser( ctx.getNotes(), psId, accountId, ctx.getRevWalk(), ctx.getRepoView().getConfig())) { - if (labelTypes.byLabel(a.labelId()) == null) { + if (!labelTypes.byLabel(a.labelId()).isPresent()) { continue; // Ignore undefined labels. } else if (!a.label().equals(label)) { // Populate map for non-matching labels, needed by VoteDeleted. @@ -211,17 +225,15 @@ StringBuilder msg = new StringBuilder(); msg.append("Removed "); LabelVote.appendTo(msg, label, requireNonNull(oldApprovals.get(label))); - msg.append(" by ").append(userFactory.create(accountId).getNameEmail()).append("\n"); - changeMessage = - ChangeMessagesUtil.newMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_DELETE_VOTE); - cmUtil.addChangeMessage(ctx.getUpdate(psId), changeMessage); - + msg.append(" by ").append(AccountTemplateUtil.getAccountTemplate(accountId)).append("\n"); + mailMessage = + cmUtil.setChangeMessage(ctx, msg.toString(), ChangeMessagesUtil.TAG_DELETE_VOTE); return true; } @Override - public void postUpdate(Context ctx) { - if (changeMessage == null) { + public void postUpdate(PostUpdateContext ctx) { + if (mailMessage == null) { return; } @@ -232,7 +244,7 @@ ReplyToChangeSender emailSender = deleteVoteSenderFactory.create(ctx.getProject(), change.getId()); emailSender.setFrom(user.getAccountId()); - emailSender.setChangeMessage(changeMessage.getMessage(), ctx.getWhen()); + emailSender.setChangeMessage(mailMessage, ctx.getWhen()); emailSender.setNotify(notify); emailSender.setMessageId( messageIdGenerator.fromChangeUpdate(ctx.getRepoView(), change.currentPatchSetId())); @@ -243,13 +255,13 @@ } voteDeleted.fire( - change, + ctx.getChangeData(change), ps, accountState, newApprovals, oldApprovals, input.notify, - changeMessage.getMessage(), + mailMessage, user.state(), ctx.getWhen()); }
diff --git a/java/com/google/gerrit/server/restapi/change/Files.java b/java/com/google/gerrit/server/restapi/change/Files.java index f82284e..320e57d 100644 --- a/java/com/google/gerrit/server/restapi/change/Files.java +++ b/java/com/google/gerrit/server/restapi/change/Files.java
@@ -14,6 +14,7 @@ package com.google.gerrit.server.restapi.change; +import com.google.common.collect.Iterables; import com.google.common.collect.Lists; import com.google.common.flogger.FluentLogger; import com.google.common.hash.Hasher; @@ -43,11 +44,11 @@ import com.google.gerrit.server.change.FileResource; import com.google.gerrit.server.change.RevisionResource; import com.google.gerrit.server.git.GitRepositoryManager; -import com.google.gerrit.server.patch.PatchList; -import com.google.gerrit.server.patch.PatchListCache; +import com.google.gerrit.server.patch.DiffNotAvailableException; +import com.google.gerrit.server.patch.DiffOperations; import com.google.gerrit.server.patch.PatchListKey; import com.google.gerrit.server.patch.PatchListNotAvailableException; -import com.google.gerrit.server.patch.PatchListObjectTooLargeException; +import com.google.gerrit.server.patch.filediff.FileDiffOutput; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.plugincontext.PluginItemContext; import com.google.inject.Inject; @@ -63,6 +64,7 @@ import java.util.Set; import java.util.concurrent.TimeUnit; import org.eclipse.jgit.errors.RepositoryNotFoundException; +import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.ObjectReader; import org.eclipse.jgit.lib.Repository; import org.eclipse.jgit.revwalk.RevCommit; @@ -112,30 +114,30 @@ @Option(name = "-q") String query; + private final DiffOperations diffOperations; private final Provider<CurrentUser> self; private final FileInfoJson fileInfoJson; private final Revisions revisions; private final GitRepositoryManager gitManager; - private final PatchListCache patchListCache; private final PatchSetUtil psUtil; private final PluginItemContext<AccountPatchReviewStore> accountPatchReviewStore; private final GerritApi gApi; @Inject ListFiles( + DiffOperations diffOperations, Provider<CurrentUser> self, FileInfoJson fileInfoJson, Revisions revisions, GitRepositoryManager gitManager, - PatchListCache patchListCache, PatchSetUtil psUtil, PluginItemContext<AccountPatchReviewStore> accountPatchReviewStore, GerritApi gApi) { + this.diffOperations = diffOperations; this.self = self; this.fileInfoJson = fileInfoJson; this.revisions = revisions; this.gitManager = gitManager; - this.patchListCache = patchListCache; this.psUtil = psUtil; this.accountPatchReviewStore = accountPatchReviewStore; this.gApi = gApi; @@ -181,7 +183,7 @@ r = Response.ok( fileInfoJson.getFileInfoMap( - resource.getChange(), resource.getPatchSet().commitId(), parentNum - 1)); + resource.getChange(), resource.getPatchSet().commitId(), parentNum)); } else { r = Response.ok(fileInfoJson.getFileInfoMap(resource.getChange(), resource.getPatchSet())); } @@ -252,9 +254,7 @@ try { return copy(res.files(), res.patchSetId(), resource, userId); - } catch (PatchListObjectTooLargeException e) { - logger.atWarning().log("Cannot copy patch review flags: %s", e.getMessage()); - } catch (IOException | PatchListNotAvailableException e) { + } catch (IOException | DiffNotAvailableException e) { logger.atWarning().withCause(e).log("Cannot copy patch review flags"); } } @@ -264,7 +264,7 @@ private List<String> copy( Set<String> paths, PatchSet.Id old, RevisionResource resource, Account.Id userId) - throws IOException, PatchListNotAvailableException { + throws IOException, DiffNotAvailableException { Project.NameKey project = resource.getChange().getProject(); try (Repository git = gitManager.openRepository(project); ObjectReader reader = git.newObjectReader(); @@ -273,31 +273,35 @@ Change change = resource.getChange(); PatchSet patchSet = psUtil.get(resource.getNotes(), old); if (patchSet == null) { - throw new PatchListNotAvailableException( + throw new DiffNotAvailableException( String.format( "patch set %s of change %s not found", old.get(), change.getId().get())); } - PatchList oldList = patchListCache.get(change, patchSet); + Map<String, FileDiffOutput> oldList = + diffOperations.listModifiedFilesAgainstParent( + project, patchSet.commitId(), /* parentNum= */ 0); - PatchList curList = patchListCache.get(change, resource.getPatchSet()); + Map<String, FileDiffOutput> curList = + diffOperations.listModifiedFilesAgainstParent( + project, resource.getPatchSet().commitId(), /* parentNum= */ 0); int sz = paths.size(); List<String> pathList = Lists.newArrayListWithCapacity(sz); tw.setFilter(PathFilterGroup.createFromStrings(paths)); tw.setRecursive(true); - int o = tw.addTree(rw.parseCommit(oldList.getNewId()).getTree()); - int c = tw.addTree(rw.parseCommit(curList.getNewId()).getTree()); + int o = tw.addTree(rw.parseCommit(getNewId(oldList)).getTree()); + int c = tw.addTree(rw.parseCommit(getNewId(curList)).getTree()); int op = -1; - if (oldList.getOldId() != null) { - op = tw.addTree(rw.parseTree(oldList.getOldId())); + if (getOldId(oldList) != null) { + op = tw.addTree(rw.parseTree(getOldId(oldList))); } int cp = -1; - if (curList.getOldId() != null) { - cp = tw.addTree(rw.parseTree(curList.getOldId())); + if (getOldId(curList) != null) { + cp = tw.addTree(rw.parseTree(getOldId(curList))); } while (tw.next()) { @@ -354,5 +358,18 @@ h.putLong(PatchListKey.serialVersionUID); return h.hash().toString(); } + + @Nullable + private ObjectId getOldId(Map<String, FileDiffOutput> fileDiffList) { + return fileDiffList.isEmpty() + ? null + : Iterables.getFirst(fileDiffList.values(), null).oldCommitId(); + } + + private ObjectId getNewId(Map<String, FileDiffOutput> fileDiffList) { + return fileDiffList.isEmpty() + ? null + : Iterables.getFirst(fileDiffList.values(), null).newCommitId(); + } } }
diff --git a/java/com/google/gerrit/server/restapi/change/GetAttentionSet.java b/java/com/google/gerrit/server/restapi/change/GetAttentionSet.java index 6822d91..9a4eefd 100644 --- a/java/com/google/gerrit/server/restapi/change/GetAttentionSet.java +++ b/java/com/google/gerrit/server/restapi/change/GetAttentionSet.java
@@ -24,9 +24,9 @@ import com.google.gerrit.server.account.AccountLoader; import com.google.gerrit.server.change.ChangeResource; import com.google.gerrit.server.permissions.PermissionBackendException; +import com.google.gerrit.server.util.AttentionSetUtil; import com.google.inject.Inject; import com.google.inject.Singleton; -import java.sql.Timestamp; import java.util.Set; /** Reads the list of users currently in the attention set. */ @@ -47,10 +47,7 @@ ImmutableSet<AttentionSetInfo> response = // This filtering should match ChangeJson. additionsOnly(changeResource.getNotes().getAttentionSet()).stream() - .map( - a -> - new AttentionSetInfo( - accountLoader.get(a.account()), Timestamp.from(a.timestamp()), a.reason())) + .map(a -> AttentionSetUtil.createAttentionSetInfo(a, accountLoader)) .collect(toImmutableSet()); accountLoader.fill(); return Response.ok(response);
diff --git a/java/com/google/gerrit/server/restapi/change/GetChange.java b/java/com/google/gerrit/server/restapi/change/GetChange.java index 340b9a0..a81171a 100644 --- a/java/com/google/gerrit/server/restapi/change/GetChange.java +++ b/java/com/google/gerrit/server/restapi/change/GetChange.java
@@ -76,8 +76,9 @@ } @Option(name = "-O", usage = "Output option flags, in hex") - void setOptionFlagsHex(String hex) { - options.addAll(ListOption.fromBits(ListChangesOption.class, Integer.parseInt(hex, 16))); + void setOptionFlagsHex(String hex) throws BadRequestException { + EnumSet<ListChangesOption> optionSet = ListOption.fromHexString(ListChangesOption.class, hex); + options.addAll(optionSet); } @Inject
diff --git a/java/com/google/gerrit/server/restapi/change/GetDetail.java b/java/com/google/gerrit/server/restapi/change/GetDetail.java index 4139560..b365e57 100644 --- a/java/com/google/gerrit/server/restapi/change/GetDetail.java +++ b/java/com/google/gerrit/server/restapi/change/GetDetail.java
@@ -16,6 +16,7 @@ import com.google.gerrit.extensions.client.ListChangesOption; import com.google.gerrit.extensions.common.ChangeInfo; +import com.google.gerrit.extensions.restapi.BadRequestException; import com.google.gerrit.extensions.restapi.Response; import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.extensions.restapi.RestReadView; @@ -34,7 +35,7 @@ } @Option(name = "-O", usage = "Output option flags, in hex") - void setOptionFlagsHex(String hex) { + void setOptionFlagsHex(String hex) throws BadRequestException { delegate.setOptionFlagsHex(hex); }
diff --git a/java/com/google/gerrit/server/restapi/change/GetDiff.java b/java/com/google/gerrit/server/restapi/change/GetDiff.java index 19256bb..9424198 100644 --- a/java/com/google/gerrit/server/restapi/change/GetDiff.java +++ b/java/com/google/gerrit/server/restapi/change/GetDiff.java
@@ -74,6 +74,7 @@ @Option(name = "--base", metaVar = "REVISION") String base; + /** 1-based index of the parent's position in the commit object. */ @Option(name = "--parent", metaVar = "parent-number") int parentNum; @@ -143,7 +144,7 @@ } else if (parentNum > 0) { psf = patchScriptFactoryFactory.create( - notes, fileName, parentNum - 1, pId, prefs, currentUser.get()); + notes, fileName, parentNum, pId, prefs, currentUser.get()); } else { psf = patchScriptFactoryFactory.create(notes, fileName, null, pId, prefs, currentUser.get()); } @@ -230,21 +231,29 @@ } @Override + public ImmutableList<WebLinkInfo> getEditWebLinks() { + return webLinks.getEditLinks(projectName.get(), revB, sideB.fileName()); + } + + @Override public ImmutableList<WebLinkInfo> getFileWebLinks(DiffSide.Type type) { - String rev; - String hash; - DiffSide side; - if (type == DiffSide.Type.SIDE_A) { - rev = revA; - hash = hashA; - side = sideA; - } else { - rev = revB; - hash = hashB; - side = sideB; - } + String rev = getSideRev(type); + String hash = getSideHash(type); + DiffSide side = getDiffSide(type); return webLinks.getFileLinks(projectName.get(), rev, hash, side.fileName()); } + + private String getSideRev(DiffSide.Type sideType) { + return DiffSide.Type.SIDE_A == sideType ? revA : revB; + } + + private String getSideHash(DiffSide.Type sideType) { + return DiffSide.Type.SIDE_A == sideType ? hashA : hashB; + } + + private DiffSide getDiffSide(DiffSide.Type sideType) { + return DiffSide.Type.SIDE_A == sideType ? sideA : sideB; + } } public GetDiff setBase(String base) {
diff --git a/java/com/google/gerrit/server/restapi/change/GetFixPreview.java b/java/com/google/gerrit/server/restapi/change/GetFixPreview.java index 6089778..95e26a2 100644 --- a/java/com/google/gerrit/server/restapi/change/GetFixPreview.java +++ b/java/com/google/gerrit/server/restapi/change/GetFixPreview.java
@@ -35,7 +35,6 @@ import com.google.gerrit.server.change.FixResource; import com.google.gerrit.server.diff.DiffInfoCreator; import com.google.gerrit.server.diff.DiffSide; -import com.google.gerrit.server.diff.DiffSide.Type; import com.google.gerrit.server.diff.DiffWebLinksProvider; import com.google.gerrit.server.git.GitRepositoryManager; import com.google.gerrit.server.git.LargeObjectException; @@ -121,7 +120,7 @@ DiffSide.create( ps.getFileInfoA(), MoreObjects.firstNonNull(ps.getOldName(), ps.getNewName()), - Type.SIDE_A); + DiffSide.Type.SIDE_A); DiffSide sideB = DiffSide.create(ps.getFileInfoB(), ps.getNewName(), DiffSide.Type.SIDE_B); DiffInfoCreator diffInfoCreator = @@ -137,7 +136,12 @@ } @Override - public ImmutableList<WebLinkInfo> getFileWebLinks(Type fileInfoType) { + public ImmutableList<WebLinkInfo> getEditWebLinks() { + return ImmutableList.of(); + } + + @Override + public ImmutableList<WebLinkInfo> getFileWebLinks(DiffSide.Type fileInfoType) { return ImmutableList.of(); } }
diff --git a/java/com/google/gerrit/server/restapi/change/GetMetaDiff.java b/java/com/google/gerrit/server/restapi/change/GetMetaDiff.java index 1e71d4c..81d97e2 100644 --- a/java/com/google/gerrit/server/restapi/change/GetMetaDiff.java +++ b/java/com/google/gerrit/server/restapi/change/GetMetaDiff.java
@@ -63,8 +63,8 @@ } @Option(name = "-O", usage = "Output option flags, in hex") - void setOptionFlagsHex(String hex) { - options.addAll(ListOption.fromBits(ListChangesOption.class, Integer.parseInt(hex, 16))); + void setOptionFlagsHex(String hex) throws BadRequestException { + options.addAll(ListOption.fromHexString(ListChangesOption.class, hex)); } @Option(name = "--old", usage = "old NoteDb meta SHA-1")
diff --git a/java/com/google/gerrit/server/restapi/change/GetRelated.java b/java/com/google/gerrit/server/restapi/change/GetRelated.java index ba1a1dc..0eef468 100644 --- a/java/com/google/gerrit/server/restapi/change/GetRelated.java +++ b/java/com/google/gerrit/server/restapi/change/GetRelated.java
@@ -14,10 +14,6 @@ package com.google.gerrit.server.restapi.change; -import static com.google.common.base.Preconditions.checkArgument; -import static java.util.stream.Collectors.toSet; - -import com.google.common.annotations.VisibleForTesting; import com.google.common.collect.Lists; import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; @@ -29,56 +25,39 @@ import com.google.gerrit.extensions.common.CommitInfo; import com.google.gerrit.extensions.restapi.Response; import com.google.gerrit.extensions.restapi.RestReadView; -import com.google.gerrit.index.IndexConfig; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.CommonConverters; -import com.google.gerrit.server.PatchSetUtil; +import com.google.gerrit.server.change.GetRelatedChangesUtil; +import com.google.gerrit.server.change.RelatedChangesSorter; import com.google.gerrit.server.change.RevisionResource; -import com.google.gerrit.server.notedb.ChangeNotes; import com.google.gerrit.server.permissions.PermissionBackendException; import com.google.gerrit.server.project.NoSuchProjectException; import com.google.gerrit.server.query.change.ChangeData; -import com.google.gerrit.server.query.change.InternalChangeQuery; import com.google.inject.Inject; -import com.google.inject.Provider; import com.google.inject.Singleton; import java.io.IOException; import java.util.ArrayList; import java.util.Collections; import java.util.List; import java.util.Locale; -import java.util.Set; -import org.eclipse.jgit.errors.RepositoryNotFoundException; import org.eclipse.jgit.revwalk.RevCommit; @Singleton public class GetRelated implements RestReadView<RevisionResource> { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - private final Provider<InternalChangeQuery> queryProvider; - private final PatchSetUtil psUtil; - private final RelatedChangesSorter sorter; - private final IndexConfig indexConfig; private final ChangeData.Factory changeDataFactory; + private final GetRelatedChangesUtil getRelatedChangesUtil; @Inject - GetRelated( - Provider<InternalChangeQuery> queryProvider, - PatchSetUtil psUtil, - RelatedChangesSorter sorter, - IndexConfig indexConfig, - ChangeData.Factory changeDataFactory) { - this.queryProvider = queryProvider; - this.psUtil = psUtil; - this.sorter = sorter; - this.indexConfig = indexConfig; + GetRelated(ChangeData.Factory changeDataFactory, GetRelatedChangesUtil getRelatedChangesUtil) { this.changeDataFactory = changeDataFactory; + this.getRelatedChangesUtil = getRelatedChangesUtil; } @Override public Response<RelatedChangesInfo> apply(RevisionResource rsrc) - throws RepositoryNotFoundException, IOException, NoSuchProjectException, - PermissionBackendException { + throws IOException, NoSuchProjectException, PermissionBackendException { RelatedChangesInfo relatedChangesInfo = new RelatedChangesInfo(); relatedChangesInfo.changes = getRelated(rsrc); return Response.ok(relatedChangesInfo); @@ -86,30 +65,15 @@ public List<RelatedChangeAndCommitInfo> getRelated(RevisionResource rsrc) throws IOException, PermissionBackendException { - Set<String> groups = getAllGroups(rsrc.getNotes(), psUtil); - logger.atFine().log("groups = %s", groups); - if (groups.isEmpty()) { - return Collections.emptyList(); - } - - List<ChangeData> cds = - InternalChangeQuery.byProjectGroups( - queryProvider, indexConfig, rsrc.getChange().getProject(), groups); - if (cds.isEmpty()) { - return Collections.emptyList(); - } - if (cds.size() == 1 && cds.get(0).getId().equals(rsrc.getChange().getId())) { - return Collections.emptyList(); - } - List<RelatedChangeAndCommitInfo> result = new ArrayList<>(cds.size()); - boolean isEdit = rsrc.getEdit().isPresent(); PatchSet basePs = isEdit ? rsrc.getEdit().get().getBasePatchSet() : rsrc.getPatchSet(); logger.atFine().log("isEdit = %s, basePs = %s", isEdit, basePs); - cds = reloadChangeIfStale(cds, rsrc.getChange(), basePs); + List<RelatedChangesSorter.PatchSetData> sortedResult = + getRelatedChangesUtil.getRelated(changeDataFactory.create(rsrc.getNotes()), basePs); - for (RelatedChangesSorter.PatchSetData d : sorter.sort(cds, basePs)) { + List<RelatedChangeAndCommitInfo> result = new ArrayList<>(sortedResult.size()); + for (RelatedChangesSorter.PatchSetData d : sortedResult) { PatchSet ps = d.patchSet(); RevCommit commit; if (isEdit && ps.id().equals(basePs.id())) { @@ -134,37 +98,6 @@ return result; } - @VisibleForTesting - public static Set<String> getAllGroups(ChangeNotes notes, PatchSetUtil psUtil) { - return psUtil.byChange(notes).stream().flatMap(ps -> ps.groups().stream()).collect(toSet()); - } - - private List<ChangeData> reloadChangeIfStale( - List<ChangeData> changeDatasFromIndex, Change wantedChange, PatchSet wantedPs) { - checkArgument( - wantedChange.getId().equals(wantedPs.id().changeId()), - "change of wantedPs (%s) doesn't match wantedChange (%s)", - wantedPs.id().changeId(), - wantedChange.getId()); - - List<ChangeData> changeDatas = new ArrayList<>(changeDatasFromIndex.size() + 1); - changeDatas.addAll(changeDatasFromIndex); - - // Reload the change in case the patch set is absent. - changeDatas.stream() - .filter( - cd -> cd.getId().equals(wantedPs.id().changeId()) && cd.patchSet(wantedPs.id()) == null) - .forEach(ChangeData::reloadChange); - - if (changeDatas.stream().noneMatch(cd -> cd.getId().equals(wantedPs.id().changeId()))) { - // The change of the wanted patch set is missing in the result from the index. - // Load it from NoteDb and add it to the result. - changeDatas.add(changeDataFactory.create(wantedChange)); - } - - return changeDatas; - } - static RelatedChangeAndCommitInfo newChangeAndCommit( Project.NameKey project, @Nullable Change change, @Nullable PatchSet ps, RevCommit c) { RelatedChangeAndCommitInfo info = new RelatedChangeAndCommitInfo();
diff --git a/java/com/google/gerrit/server/restapi/change/ListChangeDrafts.java b/java/com/google/gerrit/server/restapi/change/ListChangeDrafts.java index 65f90ae..89ee399 100644 --- a/java/com/google/gerrit/server/restapi/change/ListChangeDrafts.java +++ b/java/com/google/gerrit/server/restapi/change/ListChangeDrafts.java
@@ -27,12 +27,10 @@ import com.google.gerrit.server.restapi.change.CommentJson.HumanCommentFormatter; import com.google.inject.Inject; import com.google.inject.Provider; -import com.google.inject.Singleton; import java.util.List; import java.util.Map; import org.kohsuke.args4j.Option; -@Singleton public class ListChangeDrafts implements RestReadView<ChangeResource> { private final ChangeData.Factory changeDataFactory; private final Provider<CommentJson> commentJson;
diff --git a/java/com/google/gerrit/server/restapi/change/ListChangeMessages.java b/java/com/google/gerrit/server/restapi/change/ListChangeMessages.java index 099d0a6..c881621 100644 --- a/java/com/google/gerrit/server/restapi/change/ListChangeMessages.java +++ b/java/com/google/gerrit/server/restapi/change/ListChangeMessages.java
@@ -14,8 +14,6 @@ package com.google.gerrit.server.restapi.change; -import static com.google.gerrit.server.ChangeMessagesUtil.createChangeMessageInfo; - import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.extensions.common.ChangeMessageInfo; import com.google.gerrit.extensions.restapi.Response; @@ -48,7 +46,10 @@ List<ChangeMessage> messages = changeMessagesUtil.byChange(resource.getNotes()); List<ChangeMessageInfo> messageInfos = messages.stream() - .map(m -> createChangeMessageInfo(m, accountLoader)) + .map( + m -> + changeMessagesUtil.createChangeMessageInfoWithReplacedTemplates( + m, accountLoader)) .collect(Collectors.toList()); accountLoader.fill(); return Response.ok(messageInfos);
diff --git a/java/com/google/gerrit/server/restapi/change/ListReviewers.java b/java/com/google/gerrit/server/restapi/change/ListReviewers.java index 3d07d43..12dbf4e 100644 --- a/java/com/google/gerrit/server/restapi/change/ListReviewers.java +++ b/java/com/google/gerrit/server/restapi/change/ListReviewers.java
@@ -19,7 +19,7 @@ import com.google.gerrit.extensions.api.changes.ReviewerInfo; import com.google.gerrit.extensions.restapi.Response; import com.google.gerrit.extensions.restapi.RestReadView; -import com.google.gerrit.server.ApprovalsUtil; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.ChangeResource; import com.google.gerrit.server.change.ReviewerJson; import com.google.gerrit.server.change.ReviewerResource;
diff --git a/java/com/google/gerrit/server/restapi/change/ListRevisionReviewers.java b/java/com/google/gerrit/server/restapi/change/ListRevisionReviewers.java index b44f637..2df2d29 100644 --- a/java/com/google/gerrit/server/restapi/change/ListRevisionReviewers.java +++ b/java/com/google/gerrit/server/restapi/change/ListRevisionReviewers.java
@@ -20,7 +20,7 @@ import com.google.gerrit.extensions.restapi.MethodNotAllowedException; import com.google.gerrit.extensions.restapi.Response; import com.google.gerrit.extensions.restapi.RestReadView; -import com.google.gerrit.server.ApprovalsUtil; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.ReviewerJson; import com.google.gerrit.server.change.ReviewerResource; import com.google.gerrit.server.change.RevisionResource;
diff --git a/java/com/google/gerrit/server/restapi/change/MarkAsReviewed.java b/java/com/google/gerrit/server/restapi/change/MarkAsReviewed.java deleted file mode 100644 index fa4555b..0000000 --- a/java/com/google/gerrit/server/restapi/change/MarkAsReviewed.java +++ /dev/null
@@ -1,70 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.restapi.change; - -import com.google.common.flogger.FluentLogger; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.extensions.common.Input; -import com.google.gerrit.extensions.restapi.Response; -import com.google.gerrit.extensions.restapi.RestApiException; -import com.google.gerrit.extensions.restapi.RestModifyView; -import com.google.gerrit.extensions.webui.UiAction; -import com.google.gerrit.server.StarredChangesUtil; -import com.google.gerrit.server.StarredChangesUtil.IllegalLabelException; -import com.google.gerrit.server.change.ChangeResource; -import com.google.gerrit.server.query.change.ChangeData; -import com.google.inject.Inject; -import com.google.inject.Singleton; - -@Singleton -public class MarkAsReviewed - implements RestModifyView<ChangeResource, Input>, UiAction<ChangeResource> { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - private final ChangeData.Factory changeDataFactory; - private final StarredChangesUtil stars; - - @Inject - MarkAsReviewed(ChangeData.Factory changeDataFactory, StarredChangesUtil stars) { - this.changeDataFactory = changeDataFactory; - this.stars = stars; - } - - @Override - public Description getDescription(ChangeResource rsrc) { - return new UiAction.Description() - .setLabel("Mark Reviewed") - .setTitle("Mark the change as reviewed to unhighlight it in the dashboard") - .setVisible(!isReviewed(rsrc)); - } - - @Override - public Response<String> apply(ChangeResource rsrc, Input input) - throws RestApiException, IllegalLabelException { - stars.markAsReviewed(rsrc); - return Response.ok(); - } - - private boolean isReviewed(ChangeResource rsrc) { - try { - return changeDataFactory - .create(rsrc.getNotes()) - .isReviewedBy(rsrc.getUser().asIdentifiedUser().getAccountId()); - } catch (StorageException e) { - logger.atSevere().withCause(e).log("failed to check if change is reviewed"); - } - return false; - } -}
diff --git a/java/com/google/gerrit/server/restapi/change/MarkAsUnreviewed.java b/java/com/google/gerrit/server/restapi/change/MarkAsUnreviewed.java deleted file mode 100644 index 601fc4a..0000000 --- a/java/com/google/gerrit/server/restapi/change/MarkAsUnreviewed.java +++ /dev/null
@@ -1,68 +0,0 @@ -// Copyright (C) 2017 The Android Open Source Project -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -package com.google.gerrit.server.restapi.change; - -import com.google.common.flogger.FluentLogger; -import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.extensions.common.Input; -import com.google.gerrit.extensions.restapi.Response; -import com.google.gerrit.extensions.restapi.RestModifyView; -import com.google.gerrit.extensions.webui.UiAction; -import com.google.gerrit.server.StarredChangesUtil; -import com.google.gerrit.server.StarredChangesUtil.IllegalLabelException; -import com.google.gerrit.server.change.ChangeResource; -import com.google.gerrit.server.query.change.ChangeData; -import com.google.inject.Inject; -import com.google.inject.Singleton; - -@Singleton -public class MarkAsUnreviewed - implements RestModifyView<ChangeResource, Input>, UiAction<ChangeResource> { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - - private final ChangeData.Factory changeDataFactory; - private final StarredChangesUtil stars; - - @Inject - MarkAsUnreviewed(ChangeData.Factory changeDataFactory, StarredChangesUtil stars) { - this.changeDataFactory = changeDataFactory; - this.stars = stars; - } - - @Override - public Description getDescription(ChangeResource rsrc) { - return new UiAction.Description() - .setLabel("Mark Unreviewed") - .setTitle("Mark the change as unreviewed to highlight it in the dashboard") - .setVisible(isReviewed(rsrc)); - } - - @Override - public Response<String> apply(ChangeResource rsrc, Input input) throws IllegalLabelException { - stars.markAsUnreviewed(rsrc); - return Response.ok(); - } - - private boolean isReviewed(ChangeResource rsrc) { - try { - return changeDataFactory - .create(rsrc.getNotes()) - .isReviewedBy(rsrc.getUser().asIdentifiedUser().getAccountId()); - } catch (StorageException e) { - logger.atSevere().withCause(e).log("failed to check if change is reviewed"); - } - return false; - } -}
diff --git a/java/com/google/gerrit/server/restapi/change/Move.java b/java/com/google/gerrit/server/restapi/change/Move.java index fc7e9f4..5281f1f 100644 --- a/java/com/google/gerrit/server/restapi/change/Move.java +++ b/java/com/google/gerrit/server/restapi/change/Move.java
@@ -21,17 +21,14 @@ import static com.google.gerrit.server.query.change.ChangeData.asChanges; import com.google.common.base.Strings; -import com.google.common.flogger.FluentLogger; import com.google.gerrit.common.Nullable; import com.google.gerrit.entities.BranchNameKey; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.LabelType; import com.google.gerrit.entities.PatchSet; import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.Project; import com.google.gerrit.entities.RefNames; -import com.google.gerrit.exceptions.StorageException; import com.google.gerrit.extensions.api.changes.MoveInput; import com.google.gerrit.extensions.common.ChangeInfo; import com.google.gerrit.extensions.restapi.AuthException; @@ -42,11 +39,11 @@ import com.google.gerrit.extensions.restapi.RestApiException; import com.google.gerrit.extensions.restapi.RestModifyView; import com.google.gerrit.extensions.webui.UiAction; -import com.google.gerrit.server.ApprovalsUtil; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.IdentifiedUser; import com.google.gerrit.server.PatchSetUtil; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.ChangeJson; import com.google.gerrit.server.change.ChangeResource; import com.google.gerrit.server.config.GerritServerConfig; @@ -67,6 +64,7 @@ import com.google.inject.Provider; import com.google.inject.Singleton; import java.io.IOException; +import java.util.Optional; import org.eclipse.jgit.lib.Config; import org.eclipse.jgit.lib.ObjectId; import org.eclipse.jgit.lib.Repository; @@ -75,8 +73,6 @@ @Singleton public class Move implements RestModifyView<ChangeResource, MoveInput>, UiAction<ChangeResource> { - private static final FluentLogger logger = FluentLogger.forEnclosingClass(); - private final PermissionBackend permissionBackend; private final BatchUpdate.Factory updateFactory; private final ChangeJson.Factory json; @@ -249,9 +245,7 @@ msgBuf.append("\n\n"); msgBuf.append(input.message); } - ChangeMessage cmsg = - ChangeMessagesUtil.newMessage(ctx, msgBuf.toString(), ChangeMessagesUtil.TAG_MOVE); - cmUtil.addChangeMessage(update, cmsg); + cmUtil.setChangeMessage(ctx, msgBuf.toString(), ChangeMessagesUtil.TAG_MOVE); return true; } @@ -269,11 +263,13 @@ approvalsUtil.byPatchSet( ctx.getNotes(), psId, ctx.getRevWalk(), ctx.getRepoView().getConfig())) { ProjectState projectState = projectCache.get(project).orElseThrow(illegalState(project)); - LabelType type = projectState.getLabelTypes(ctx.getNotes()).byLabel(psa.labelId()); + Optional<LabelType> type = + projectState.getLabelTypes(ctx.getNotes()).byLabel(psa.labelId()); // Only keep veto votes, defined as votes where: // 1- the label function allows minimum values to block submission. // 2- the vote holds the minimum value. - if (type == null || (type.isMaxNegative(psa) && type.getFunction().isBlock())) { + if (!type.isPresent() + || (type.get().isMaxNegative(psa) && type.get().getFunction().isBlock())) { continue; } @@ -284,41 +280,29 @@ } @Override - public UiAction.Description getDescription(ChangeResource rsrc) { + public UiAction.Description getDescription(ChangeResource rsrc) throws IOException { UiAction.Description description = new UiAction.Description() .setLabel("Move Change") .setTitle("Move change to a different branch") .setVisible(false); + if (!moveEnabled) { + return description; + } Change change = rsrc.getChange(); if (!change.isNew()) { return description; } - - try { - if (!projectCache - .get(rsrc.getProject()) - .orElseThrow(illegalState(rsrc.getProject())) - .statePermitsWrite()) { - return description; - } - } catch (StorageException e) { - logger.atSevere().withCause(e).log( - "Failed to check if project state permits write: %s", rsrc.getProject()); + if (!projectCache + .get(rsrc.getProject()) + .orElseThrow(illegalState(rsrc.getProject())) + .statePermitsWrite()) { return description; } - - try { - if (psUtil.isPatchSetLocked(rsrc.getNotes())) { - return description; - } - } catch (StorageException e) { - logger.atSevere().withCause(e).log( - "Failed to check if the current patch set of change %s is locked", change.getId()); + if (psUtil.isPatchSetLocked(rsrc.getNotes())) { return description; } - return description.setVisible( and( permissionBackend.user(rsrc.getUser()).ref(change.getDest()).testCond(CREATE_CHANGE),
diff --git a/java/com/google/gerrit/server/restapi/change/PostReview.java b/java/com/google/gerrit/server/restapi/change/PostReview.java index 58321e9..5c252f4 100644 --- a/java/com/google/gerrit/server/restapi/change/PostReview.java +++ b/java/com/google/gerrit/server/restapi/change/PostReview.java
@@ -16,12 +16,12 @@ import static com.google.common.base.MoreObjects.firstNonNull; import static com.google.common.collect.ImmutableList.toImmutableList; +import static com.google.common.collect.ImmutableSet.toImmutableSet; import static com.google.gerrit.entities.Patch.PATCHSET_LEVEL; import static com.google.gerrit.server.notedb.ReviewerStateInternal.REVIEWER; import static com.google.gerrit.server.permissions.LabelPermission.ForUser.ON_BEHALF_OF; import static com.google.gerrit.server.project.ProjectCache.illegalState; import static java.nio.charset.StandardCharsets.UTF_8; -import static java.util.Objects.requireNonNull; import static java.util.stream.Collectors.groupingBy; import static java.util.stream.Collectors.joining; import static java.util.stream.Collectors.toList; @@ -43,7 +43,6 @@ import com.google.gerrit.entities.Account; import com.google.gerrit.entities.Address; import com.google.gerrit.entities.Change; -import com.google.gerrit.entities.ChangeMessage; import com.google.gerrit.entities.Comment; import com.google.gerrit.entities.FixReplacement; import com.google.gerrit.entities.FixSuggestion; @@ -55,14 +54,14 @@ import com.google.gerrit.entities.PatchSetApproval; import com.google.gerrit.entities.RobotComment; import com.google.gerrit.exceptions.StorageException; -import com.google.gerrit.extensions.api.changes.AddReviewerInput; -import com.google.gerrit.extensions.api.changes.AddReviewerResult; import com.google.gerrit.extensions.api.changes.NotifyHandling; import com.google.gerrit.extensions.api.changes.ReviewInput; import com.google.gerrit.extensions.api.changes.ReviewInput.CommentInput; import com.google.gerrit.extensions.api.changes.ReviewInput.DraftHandling; import com.google.gerrit.extensions.api.changes.ReviewInput.RobotCommentInput; import com.google.gerrit.extensions.api.changes.ReviewResult; +import com.google.gerrit.extensions.api.changes.ReviewerInput; +import com.google.gerrit.extensions.api.changes.ReviewerResult; import com.google.gerrit.extensions.client.Comment.Range; import com.google.gerrit.extensions.client.DiffPreferencesInfo.Whitespace; import com.google.gerrit.extensions.client.ReviewerState; @@ -81,7 +80,10 @@ import com.google.gerrit.extensions.validators.CommentValidationContext; import com.google.gerrit.extensions.validators.CommentValidationFailure; import com.google.gerrit.extensions.validators.CommentValidator; -import com.google.gerrit.server.ApprovalsUtil; +import com.google.gerrit.metrics.Counter1; +import com.google.gerrit.metrics.Description; +import com.google.gerrit.metrics.Field; +import com.google.gerrit.metrics.MetricMaker; import com.google.gerrit.server.ChangeMessagesUtil; import com.google.gerrit.server.ChangeUtil; import com.google.gerrit.server.CommentsUtil; @@ -90,18 +92,22 @@ import com.google.gerrit.server.PatchSetUtil; import com.google.gerrit.server.PublishCommentUtil; import com.google.gerrit.server.ReviewerSet; +import com.google.gerrit.server.account.AccountCache; import com.google.gerrit.server.account.AccountResolver; -import com.google.gerrit.server.change.AddReviewersEmail; -import com.google.gerrit.server.change.AddReviewersOp.Result; +import com.google.gerrit.server.account.AccountState; +import com.google.gerrit.server.approval.ApprovalsUtil; import com.google.gerrit.server.change.ChangeResource; import com.google.gerrit.server.change.EmailReviewComments; +import com.google.gerrit.server.change.ModifyReviewersEmail; import com.google.gerrit.server.change.NotifyResolver; -import com.google.gerrit.server.change.ReviewerAdder; -import com.google.gerrit.server.change.ReviewerAdder.ReviewerAddition; +import com.google.gerrit.server.change.ReviewerModifier; +import com.google.gerrit.server.change.ReviewerModifier.ReviewerModification; +import com.google.gerrit.server.change.ReviewerOp.Result; import com.google.gerrit.server.change.RevisionResource; import com.google.gerrit.server.change.WorkInProgressOp; import com.google.gerrit.server.config.GerritServerConfig; import com.google.gerrit.server.extensions.events.CommentAdded; +import com.google.gerrit.server.extensions.events.ReviewerAdded; import com.google.gerrit.server.logging.Metadata; import com.google.gerrit.server.logging.TraceContext; import com.google.gerrit.server.notedb.ChangeNotes; @@ -123,7 +129,7 @@ import com.google.gerrit.server.update.BatchUpdateOp; import com.google.gerrit.server.update.ChangeContext; import com.google.gerrit.server.update.CommentsRejectedException; -import com.google.gerrit.server.update.Context; +import com.google.gerrit.server.update.PostUpdateContext; import com.google.gerrit.server.update.UpdateException; import com.google.gerrit.server.util.LabelVote; import com.google.gerrit.server.util.time.TimeUtil; @@ -152,6 +158,29 @@ public class PostReview implements RestModifyView<RevisionResource, ReviewInput> { private static final FluentLogger logger = FluentLogger.forEnclosingClass(); + @Singleton + private static class Metrics { + final Counter1<String> draftHandling; + + @Inject + Metrics(MetricMaker metricMaker) { + draftHandling = + metricMaker.newCounter( + "change/post_review/draft_handling", + new Description( + "Total number of draft handling option " + + "(KEEP, PUBLISH, PUBLISH_ALL_REVISIONS) " + + "selected by users while posting a review.") + .setRate() + .setUnit("count"), + Field.ofString("type", Metadata.Builder::eventType) + .description( + "The type of the draft handling option" + + " (KEEP, PUBLISH, PUBLISH_ALL_REVISIONS).") + .build()); + } + } + private static final String ERROR_ADDING_REVIEWER = "error adding reviewer"; public static final String ERROR_WIP_READY_MUTUALLY_EXCLUSIVE = "work_in_progress and ready are mutually exclusive"; @@ -161,6 +190,7 @@ private final BatchUpdate.Factory updateFactory; private final ChangeResource.Factory changeResourceFactory; private final ChangeData.Factory changeDataFactory; + private final AccountCache accountCache; private final ApprovalsUtil approvalsUtil; private final ChangeMessagesUtil cmUtil; private final CommentsUtil commentsUtil; @@ -170,8 +200,9 @@ priv
