Merge "Internally handle refs updated in a BatchRefUpdate by a single event" into stable-3.6
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/Documentation/cmd-index.txt b/Documentation/cmd-index.txt
index ce3a024..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.
diff --git a/Documentation/config-gerrit.txt b/Documentation/config-gerrit.txt
index 2b20cab..611a8e0 100644
--- a/Documentation/config-gerrit.txt
+++ b/Documentation/config-gerrit.txt
@@ -1188,7 +1188,7 @@
cache `"prolog_rules"`::
+
Caches parsed `rules.pl` contents for each project. This cache uses the same
-size as the `projects` cache, and cannot be configured independently.
+size as the `projects` cache when `cache.prolog_rules.memoryLimit` is not set.
cache `"pure_revert"`::
+
@@ -1309,6 +1309,21 @@
+
Default is the number of CPUs.
+[[cache.project_list.interval]]cache.project_list.interval::
++
+The link:#schedule-configuration-interval[interval] for running
+the project_list cache warmer.
+
+By default, if `cache.project_list.maxAge` is set, `interval` will be set to
+half its value. If `cache.project_list.maxAge` is not set or `interval` is set
+to `-1`, it is disabled.
+
+[[cache.project_list.startTime]]cache.project_list.startTime::
++
+The link:#schedule-configuration-startTime[start time] for running
+the project_list cache warmer.
+
+Default is 00:00 if the project_list cache warmer is enabled.
[[capability]]
=== Section capability
@@ -3201,6 +3216,25 @@
+
Defaults to true.
+[[index.paginationType]]index.paginationType::
++
+The pagination type to use when index queries are repeated to
+obtain the next set of results. Supported values are:
++
+* `OFFSET`
++
+Index queries are repeated with a non-zero offset to obtain the
+next set of results.
++
+* `SEARCH_AFTER`
++
+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.
++
+Defaults to `OFFSET`.
+
[[index.maxLimit]]index.maxLimit::
+
Maximum limit to allow for search queries. Requesting results above this
@@ -3219,6 +3253,44 @@
+
Defaults to no limit.
+[[index.pageSizeMultiplier]]index.pageSizeMultiplier::
++
+When index queries are repeated to obtain more results, this multiplier
+will be used to determine the limit for the next query. Using a page
+multiplier allows queries to start off small and thus provide good
+latency for queries which may end up only having very few results, and
+then scaling up to have better throughput to handle queries with larger
+result sets without incurring the overhead of making as many queries as
+would be required with a smaller limit. This strategy of using a multiplier
+attempts to create a balance between latency and throughput by dynamically
+adjusting the query size to the number of results being returned by each
+query in the pagination.
++
+The larger the multiplier, the better the throughput on large queries, and
+it also improves latency on large queries by scaling up quickly. However, a
+larger multiplier can hurt latencies a bit by making the "last" query in a
+series longer than needed. The impact of this depends on how much the backend
+latency goes up when specifying a large limit and few results are returned.
+Setting link:#index.maxPageSize[index.maxPageSize] that isn't too large, can
+likely help reduce the impacts of this.
++
+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.
++
+Defaults to 1 which effectively turns this feature off.
+
+[[index.maxPageSize]]index.maxPageSize::
++
+Maximum size to allow when index queries are repeated to obtain more results. Note
+that, link:#index.maxLimit[index.maxLimit] will be used to limit page size if it
+is configured to a value lower than maxPageSize.
++
+For example, if the limit of previous query was 500, pageSizeMultiplier is
+configured to 5 and maxPageSize to 2000, the next query will have a limit of
+2000 (instead of 2500).
++
+Defaults to no limit.
+
[[index.maxTerms]]index.maxTerms::
+
Maximum number of leaf terms to allow in a query. Too-large queries may
@@ -3932,6 +4004,46 @@
+
Defaults to true.
+[[metrics]]
+=== Section metrics
+
+[[metrics.reservoir]]metrics.reservoir::
++
+The type of data reservoir used by the metrics system to calculate the percentile
+values for timers and histograms.
+It can be set to one of the following values:
++
+* ExponentiallyDecaying: An exponentially-decaying random reservoir based on
+ Cormode et al's forward-decaying priority reservoir sampling method to produce
+ a statistically representative sampling reservoir, exponentially biased towards
+ newer entries.
+* SlidingTimeWindowArray: A sliding window that stores only the measurements made
+ in the last window using chunks of 512 samples.
+* SlidingTimeWindow: A sliding window that stores only the measurements made in
+ the last window using a skip list.
+* SlidingWindow: A sliding window that stores only the last measurements.
+* Uniform: A random sampling reservoir that uses Vitter's Algorithm R to produce
+ a statistically representative sample.
++
+Defaults to ExponentiallyDecaying.
+
+[[metrics.ExponentiallyDecaying.alpha]]metrics.ExponentiallyDecaying.alpha::
++
+The exponential decay factor; the higher this is, the more biased the reservoir
+will be towards newer values.
+
+[[metrics.reservoirType.size]]metrics.<reservoirType>.size::
++
+The number of samples to keep in the reservoir. Applies to all reservoir types
+except the sliding time-based ones.
++
+Defaults to 1028.
+
+[[metrics.reservoirType.window]]metrics.<reservoirType>.window::
++
+The window of time for keeping data in the reservoir. It only applies to sliding
+time-based reservoir types.
+
[[mimetype]]
=== Section mimetype
@@ -5068,22 +5180,27 @@
+
Supported ciphers:
+
-* `aes128-ctr`
-* `aes192-ctr`
-* `aes256-ctr`
* `aes128-cbc`
+* `aes128-ctr`
+* `aes128-gcm@openssh.com`
* `aes192-cbc`
+* `aes192-ctr`
* `aes256-cbc`
-* `blowfish-cbc`
-* `3des-cbc`
+* `aes256-ctr`
+* `aes256-gcm@openssh.com`
* `arcfour128`
* `arcfour256`
+* `blowfish-cbc`
+* `chacha20-poly1305@openssh.com`
+* `3des-cbc`
* `none`
+
-By default, all supported ciphers except `none` are available.
-+
If your setup allows for it, it's recommended to disable all ciphers except
the AES-CTR modes.
++
+See also link:https://github.com/apache/mina-sshd/tree/master#ciphers[ciphers,role=external,window=_blank].
++
+By default, all supported ciphers except `none` are available.
[[sshd.mac]]sshd.mac::
+
@@ -5101,6 +5218,11 @@
* `hmac-sha1-96`
* `hmac-sha2-256`
* `hmac-sha2-512`
+* `hmac-sha1-etm@openssh.com`
+* `hmac-sha2-256-etm@openssh.com`
+* `hmac-sha2-512-etm@openssh.com`
++
+See also link:https://github.com/apache/mina-sshd/tree/master#macs[macs,role=external,window=_blank].
+
By default, all supported MACs are available.
@@ -5129,6 +5251,9 @@
* `ecdh-sha2-nistp521`
* `ecdh-sha2-nistp384`
* `ecdh-sha2-nistp256`
+* `curve25519-sha256`
+* `curve25519-sha256@libssh.org`
+* `curve448-sha512`
* `diffie-hellman-group-exchange-sha256`
* `diffie-hellman-group18-sha512`
* `diffie-hellman-group17-sha512`
@@ -5139,12 +5264,14 @@
See link:#sshd.enableDeprecatedKexAlgorithms[sshd.enableDeprecatedKexAlgorithms]
for deprecated key algorithms and how to enable them.
-By default, all supported key exchange algorithms are available.
-
It is strongly recommended to disable at least `diffie-hellman-group1-sha1`
as it's known to be vulnerable (logjam attack). Additionally, if your setup
allows for it, it is recommended to disable the remaining two `sha1` key
exchange algorithms.
+
+See also link:https://github.com/apache/mina-sshd/tree/master#key-exchange[key exchange,role=external,window=_blank].
+
+By default, all supported key exchange algorithms are available.
--
[[sshd.kerberosKeytab]]sshd.kerberosKeytab::
@@ -5256,13 +5383,13 @@
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, true.
+By default, false.
[[tracing.exportPerformanceMetrics]]tracing.exportPerformanceMetrics::
+
diff --git a/Documentation/dev-plugins.txt b/Documentation/dev-plugins.txt
index ca5480a..ca72f8b 100644
--- a/Documentation/dev-plugins.txt
+++ b/Documentation/dev-plugins.txt
@@ -208,6 +208,28 @@
The canonical web URL may be injected into any .jar plugin regardless of
whether or not the plugin provides an HTTP servlet.
+[[plugin_resources]]
+=== Plugin resources
+
+Plugins are able to access their own resources without having to go through
+the implementation details on how they are packaged or deployed to Gerrit.
+
+The following example shows a MyClass in a plugin that is able to access the
+last modified time of the "myresource" loaded.
+
+[source,java]
+----
+public class MyClass {
+
+ @Inject
+ public MyClass(Plugin plugin) {
+ long myresourceTime = plugin.getContentScanner().getEntry("myresource").getTime();
+ }
+
+ [...]
+}
+----
+
[[reload_method]]
=== Reload Method
diff --git a/Documentation/dev-release-deploy-config.txt b/Documentation/dev-release-deploy-config.txt
index a4ccccf..db08da5 100644
--- a/Documentation/dev-release-deploy-config.txt
+++ b/Documentation/dev-release-deploy-config.txt
@@ -44,15 +44,13 @@
+
Generate and publish a PGP key as described in
link:http://central.sonatype.org/pages/working-with-pgp-signatures.html[
-Working with PGP Signatures,role=external,window=_blank]. In addition to the keyserver mentioned
-there it is recommended to also publish the key to the
-link:https://keyserver.ubuntu.com/[Ubuntu key server].
+Working with PGP Signatures,role=external,window=_blank].
+
Please be aware that after publishing your public key it may take a
while until it is visible to the Sonatype server.
+
Add an entry for the public key in the
-link:https://gerrit.googlesource.com/homepage/+/md-pages/releases/public-keys.md[key list,role=external,window=_blank]
+link:https://gerrit.googlesource.com/homepage/+/master/pages/site/releases/public-keys.md[key list,role=external,window=_blank]
on the homepage.
+
The PGP passphrase can be put in `~/.m2/settings.xml`:
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt
index 6f0f937..413923f 100644
--- a/Documentation/rest-api-projects.txt
+++ b/Documentation/rest-api-projects.txt
@@ -3978,7 +3978,7 @@
|`value` ||
The effective boolean value.
|`configured_value` ||
-The configured value, can be `TRUE`, `FALSE` or `INHERITED`.
+The configured value, can be `TRUE`, `FALSE` or `INHERIT`.
|`inherited_value` |optional|
The boolean value inherited from the parent. +
Not set if there is no parent.
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-search.txt b/Documentation/user-search.txt
index bae083b..55fb0c7 100644
--- a/Documentation/user-search.txt
+++ b/Documentation/user-search.txt
@@ -341,7 +341,9 @@
By default full text matching is used, but regular expressions can be
enabled by starting with `^`.
The link:http://www.brics.dk/automaton/[dk.brics.automaton library,role=external,window=_blank]
-is used for the evaluation of such patterns.
+is used for the evaluation of such patterns. Note, that searching with
+regular expressions is limited to the first 32766 bytes of the
+commit message due to limitations in Lucene.
[[comment]]
comment:'TEXT'::
@@ -555,7 +557,7 @@
not find any abandoned but mergeable changes.
+
This operator only works if Gerrit indexes 'mergeable'. See
-link:config-gerrit.html#index.change.indexMergeable[indexMergeable]
+link:config-gerrit.html#change.mergeabilityComputationBehavior[change.mergeabilityComputationBehavior]
for details.
[[ignored]]
diff --git a/WORKSPACE b/WORKSPACE
index 51068e0..fe6b94e 100644
--- a/WORKSPACE
+++ b/WORKSPACE
@@ -34,6 +34,15 @@
load("//tools:deps.bzl", "CAFFEINE_VERS", "java_dependencies")
http_archive(
+ name = "platforms",
+ sha256 = "379113459b0feaf6bfbb584a91874c065078aa673222846ac765f86661c27407",
+ urls = [
+ "https://mirror.bazel.build/github.com/bazelbuild/platforms/releases/download/0.0.5/platforms-0.0.5.tar.gz",
+ "https://github.com/bazelbuild/platforms/releases/download/0.0.5/platforms-0.0.5.tar.gz",
+ ],
+)
+
+http_archive(
name = "rbe_jdk11",
sha256 = "5939e2a4e56d1fc53b6c44c6db97ee068c9f4bd18e86c762f6ab8b4fff5e294b",
strip_prefix = "rbe_autoconfig-3.0.0",
diff --git a/antlr3/BUILD b/antlr3/BUILD
index 549946a..23641e3 100644
--- a/antlr3/BUILD
+++ b/antlr3/BUILD
@@ -22,6 +22,7 @@
srcs = [":query"],
visibility = [
"//java/com/google/gerrit/index:__subpackages__",
+ "//java/com/google/gerrit/server:__subpackages__",
"//javatests/com/google/gerrit:__subpackages__",
"//javatests/com/google/gerrit/index:__pkg__",
"//plugins:__pkg__",
diff --git a/antlr3/com/google/gerrit/index/query/Query.g b/antlr3/com/google/gerrit/index/query/Query.g
index c8587df..0994d9b 100644
--- a/antlr3/com/google/gerrit/index/query/Query.g
+++ b/antlr3/com/google/gerrit/index/query/Query.g
@@ -152,8 +152,10 @@
: ( ' ' | '\r' | '\t' | '\n' ) { $channel=HIDDEN; }
;
+fragment LOWERCASE_AND_UNDERSCORE: ('a'..'z' | '_')+ ;
+
FIELD_NAME
- : ('a'..'z' | '_')+
+ : LOWERCASE_AND_UNDERSCORE ( '-' LOWERCASE_AND_UNDERSCORE )*
;
EXACT_PHRASE
diff --git a/java/com/google/gerrit/acceptance/AbstractDaemonTest.java b/java/com/google/gerrit/acceptance/AbstractDaemonTest.java
index 2083050..903b709 100644
--- a/java/com/google/gerrit/acceptance/AbstractDaemonTest.java
+++ b/java/com/google/gerrit/acceptance/AbstractDaemonTest.java
@@ -100,8 +100,6 @@
import com.google.gerrit.extensions.restapi.BinaryResult;
import com.google.gerrit.extensions.restapi.IdString;
import com.google.gerrit.extensions.restapi.RestApiException;
-import com.google.gerrit.index.project.ProjectIndex;
-import com.google.gerrit.index.project.ProjectIndexCollection;
import com.google.gerrit.json.OutputFormat;
import com.google.gerrit.server.GerritPersonIdent;
import com.google.gerrit.server.IdentifiedUser;
@@ -128,11 +126,7 @@
import com.google.gerrit.server.git.GitRepositoryManager;
import com.google.gerrit.server.git.meta.MetaDataUpdate;
import com.google.gerrit.server.group.SystemGroupBackend;
-import com.google.gerrit.server.index.account.AccountIndex;
-import com.google.gerrit.server.index.account.AccountIndexCollection;
import com.google.gerrit.server.index.account.AccountIndexer;
-import com.google.gerrit.server.index.change.ChangeIndex;
-import com.google.gerrit.server.index.change.ChangeIndexCollection;
import com.google.gerrit.server.index.change.ChangeIndexer;
import com.google.gerrit.server.notedb.AbstractChangeNotes;
import com.google.gerrit.server.notedb.ChangeNoteUtil;
@@ -315,14 +309,11 @@
protected BlockStrategy noSleepBlockStrategy = t -> {}; // Don't sleep in tests.
@Inject private AbstractChangeNotes.Args changeNotesArgs;
- @Inject private AccountIndexCollection accountIndexes;
@Inject private AccountIndexer accountIndexer;
- @Inject private ChangeIndexCollection changeIndexes;
@Inject private EventRecorder.Factory eventRecorderFactory;
@Inject private InProcessProtocol inProcessProtocol;
@Inject private PluginGuiceEnvironment pluginGuiceEnvironment;
@Inject private PluginUser.Factory pluginUserFactory;
- @Inject private ProjectIndexCollection projectIndexes;
@Inject private RequestScopeOperations requestScopeOperations;
@Inject private SitePaths sitePaths;
@Inject private ProjectOperations projectOperations;
@@ -1072,87 +1063,6 @@
};
}
- protected void disableChangeIndexWrites() {
- for (ChangeIndex i : changeIndexes.getWriteIndexes()) {
- if (!(i instanceof ReadOnlyChangeIndex)) {
- changeIndexes.addWriteIndex(new ReadOnlyChangeIndex(i));
- }
- }
- }
-
- protected void enableChangeIndexWrites() {
- for (ChangeIndex i : changeIndexes.getWriteIndexes()) {
- if (i instanceof ReadOnlyChangeIndex) {
- changeIndexes.addWriteIndex(((ReadOnlyChangeIndex) i).unwrap());
- }
- }
- }
-
- protected AutoCloseable disableChangeIndex() {
- disableChangeIndexWrites();
- ChangeIndex maybeDisabledSearchIndex = changeIndexes.getSearchIndex();
- if (!(maybeDisabledSearchIndex instanceof DisabledChangeIndex)) {
- changeIndexes.setSearchIndex(new DisabledChangeIndex(maybeDisabledSearchIndex), false);
- }
-
- return () -> {
- enableChangeIndexWrites();
- ChangeIndex maybeEnabledSearchIndex = changeIndexes.getSearchIndex();
- if (maybeEnabledSearchIndex instanceof DisabledChangeIndex) {
- changeIndexes.setSearchIndex(
- ((DisabledChangeIndex) maybeEnabledSearchIndex).unwrap(), false);
- }
- };
- }
-
- protected AutoCloseable disableAccountIndex() {
- AccountIndex maybeDisabledSearchIndex = accountIndexes.getSearchIndex();
- if (!(maybeDisabledSearchIndex instanceof DisabledAccountIndex)) {
- accountIndexes.setSearchIndex(new DisabledAccountIndex(maybeDisabledSearchIndex), false);
- }
-
- return () -> {
- AccountIndex maybeEnabledSearchIndex = accountIndexes.getSearchIndex();
- if (maybeEnabledSearchIndex instanceof DisabledAccountIndex) {
- accountIndexes.setSearchIndex(
- ((DisabledAccountIndex) maybeEnabledSearchIndex).unwrap(), false);
- }
- };
- }
-
- protected AutoCloseable disableProjectIndex() {
- disableProjectIndexWrites();
- ProjectIndex maybeDisabledSearchIndex = projectIndexes.getSearchIndex();
- if (!(maybeDisabledSearchIndex instanceof DisabledProjectIndex)) {
- projectIndexes.setSearchIndex(new DisabledProjectIndex(maybeDisabledSearchIndex), false);
- }
-
- return () -> {
- enableProjectIndexWrites();
- ProjectIndex maybeEnabledSearchIndex = projectIndexes.getSearchIndex();
- if (maybeEnabledSearchIndex instanceof DisabledProjectIndex) {
- projectIndexes.setSearchIndex(
- ((DisabledProjectIndex) maybeEnabledSearchIndex).unwrap(), false);
- }
- };
- }
-
- protected void disableProjectIndexWrites() {
- for (ProjectIndex i : projectIndexes.getWriteIndexes()) {
- if (!(i instanceof DisabledProjectIndex)) {
- projectIndexes.addWriteIndex(new DisabledProjectIndex(i));
- }
- }
- }
-
- protected void enableProjectIndexWrites() {
- for (ProjectIndex i : projectIndexes.getWriteIndexes()) {
- if (i instanceof DisabledProjectIndex) {
- projectIndexes.addWriteIndex(((DisabledProjectIndex) i).unwrap());
- }
- }
- }
-
protected static Gson newGson() {
return OutputFormat.JSON_COMPACT.newGson();
}
diff --git a/java/com/google/gerrit/acceptance/InMemoryTestingDatabaseModule.java b/java/com/google/gerrit/acceptance/InMemoryTestingDatabaseModule.java
index 373246a..9a652e3 100644
--- a/java/com/google/gerrit/acceptance/InMemoryTestingDatabaseModule.java
+++ b/java/com/google/gerrit/acceptance/InMemoryTestingDatabaseModule.java
@@ -21,11 +21,13 @@
import com.google.gerrit.extensions.events.LifecycleListener;
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;
import com.google.gerrit.server.config.TrackingFooters;
@@ -36,6 +38,7 @@
import com.google.gerrit.testing.InMemoryRepositoryManager;
import com.google.inject.Inject;
import com.google.inject.ProvisionException;
+import com.google.inject.Scopes;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
@@ -69,6 +72,7 @@
bind(InMemoryRepositoryManager.class).in(SINGLETON);
}
+ bind(MetricsReservoirConfig.class).to(MetricsReservoirConfigImpl.class).in(Scopes.SINGLETON);
bind(MetricMaker.class).to(TestMetricMaker.class);
listener().to(CreateSchema.class);
diff --git a/java/com/google/gerrit/acceptance/ReadOnlyChangeIndex.java b/java/com/google/gerrit/acceptance/ReadOnlyChangeIndex.java
deleted file mode 100644
index f7a0669..0000000
--- a/java/com/google/gerrit/acceptance/ReadOnlyChangeIndex.java
+++ /dev/null
@@ -1,77 +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.acceptance;
-
-import com.google.gerrit.entities.Change;
-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.index.change.ChangeIndex;
-import com.google.gerrit.server.query.change.ChangeData;
-
-class ReadOnlyChangeIndex implements ChangeIndex {
- private final ChangeIndex index;
-
- ReadOnlyChangeIndex(ChangeIndex index) {
- this.index = index;
- }
-
- ChangeIndex unwrap() {
- return index;
- }
-
- @Override
- public Schema<ChangeData> getSchema() {
- return index.getSchema();
- }
-
- @Override
- public void close() {
- index.close();
- }
-
- @Override
- public void insert(ChangeData obj) {
- // do nothing
- }
-
- @Override
- public void replace(ChangeData obj) {
- // do nothing
- }
-
- @Override
- public void delete(Change.Id key) {
- // do nothing
- }
-
- @Override
- public void deleteAll() {
- // do nothing
- }
-
- @Override
- public DataSource<ChangeData> getSource(Predicate<ChangeData> p, QueryOptions opts)
- throws QueryParseException {
- return index.getSource(p, opts);
- }
-
- @Override
- public void markReady(boolean ready) {
- // do nothing
- }
-}
diff --git a/java/com/google/gerrit/acceptance/testsuite/change/IndexOperations.java b/java/com/google/gerrit/acceptance/testsuite/change/IndexOperations.java
new file mode 100644
index 0000000..cba9b15
--- /dev/null
+++ b/java/com/google/gerrit/acceptance/testsuite/change/IndexOperations.java
@@ -0,0 +1,162 @@
+// 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.acceptance.testsuite.change;
+
+import com.google.gerrit.acceptance.DisabledAccountIndex;
+import com.google.gerrit.acceptance.DisabledChangeIndex;
+import com.google.gerrit.acceptance.DisabledProjectIndex;
+import com.google.gerrit.index.project.ProjectIndex;
+import com.google.gerrit.index.project.ProjectIndexCollection;
+import com.google.gerrit.server.index.account.AccountIndex;
+import com.google.gerrit.server.index.account.AccountIndexCollection;
+import com.google.gerrit.server.index.change.ChangeIndex;
+import com.google.gerrit.server.index.change.ChangeIndexCollection;
+import com.google.inject.Inject;
+
+/** Helpers to enable and disable reads/writes to secondary indices during testing. */
+public interface IndexOperations {
+ /**
+ * Disables reads from the secondary index that this instance is scoped to. Reads fail with {@code
+ * UnsupportedOperationException}.
+ */
+ AutoCloseable disableReads();
+
+ /**
+ * Disables writes to the secondary index that this instance is scoped to. Writes fail with {@code
+ * UnsupportedOperationException}.
+ */
+ AutoCloseable disableWrites();
+
+ /** Disables reads from and writes to the secondary index that this instance is scoped to. */
+ default AutoCloseable disableReadsAndWrites() {
+ AutoCloseable reads = disableReads();
+ AutoCloseable writes = disableWrites();
+ return () -> {
+ reads.close();
+ writes.close();
+ };
+ }
+
+ class Change implements IndexOperations {
+ @Inject private ChangeIndexCollection indices;
+
+ @Override
+ public AutoCloseable disableReads() {
+ ChangeIndex maybeDisabledSearchIndex = indices.getSearchIndex();
+ if (!(maybeDisabledSearchIndex instanceof DisabledChangeIndex)) {
+ indices.setSearchIndex(
+ new DisabledChangeIndex(maybeDisabledSearchIndex), /* closeOld */ false);
+ }
+
+ return () -> {
+ ChangeIndex maybeEnabledSearchIndex = indices.getSearchIndex();
+ if (maybeEnabledSearchIndex instanceof DisabledChangeIndex) {
+ indices.setSearchIndex(
+ ((DisabledChangeIndex) maybeEnabledSearchIndex).unwrap(), /* closeOld */ false);
+ }
+ };
+ }
+
+ @Override
+ public AutoCloseable disableWrites() {
+ for (ChangeIndex i : indices.getWriteIndexes()) {
+ if (!(i instanceof DisabledChangeIndex)) {
+ indices.addWriteIndex(new DisabledChangeIndex(i));
+ }
+ }
+ return () -> {
+ for (ChangeIndex i : indices.getWriteIndexes()) {
+ if (i instanceof DisabledChangeIndex) {
+ indices.addWriteIndex(((DisabledChangeIndex) i).unwrap());
+ }
+ }
+ };
+ }
+ }
+
+ class Account implements IndexOperations {
+ @Inject private AccountIndexCollection indices;
+
+ @Override
+ public AutoCloseable disableReads() {
+ AccountIndex maybeDisabledSearchIndex = indices.getSearchIndex();
+ if (!(maybeDisabledSearchIndex instanceof DisabledAccountIndex)) {
+ indices.setSearchIndex(
+ new DisabledAccountIndex(maybeDisabledSearchIndex), /* closeOld */ false);
+ }
+
+ return () -> {
+ AccountIndex maybeEnabledSearchIndex = indices.getSearchIndex();
+ if (maybeEnabledSearchIndex instanceof DisabledAccountIndex) {
+ indices.setSearchIndex(
+ ((DisabledAccountIndex) maybeEnabledSearchIndex).unwrap(), /* closeOld */ false);
+ }
+ };
+ }
+
+ @Override
+ public AutoCloseable disableWrites() {
+ for (AccountIndex i : indices.getWriteIndexes()) {
+ if (!(i instanceof DisabledAccountIndex)) {
+ indices.addWriteIndex(new DisabledAccountIndex(i));
+ }
+ }
+ return () -> {
+ for (AccountIndex i : indices.getWriteIndexes()) {
+ if (i instanceof DisabledAccountIndex) {
+ indices.addWriteIndex(((DisabledAccountIndex) i).unwrap());
+ }
+ }
+ };
+ }
+ }
+
+ class Project implements IndexOperations {
+ @Inject private ProjectIndexCollection indices;
+
+ @Override
+ public AutoCloseable disableReads() {
+ ProjectIndex maybeDisabledSearchIndex = indices.getSearchIndex();
+ if (!(maybeDisabledSearchIndex instanceof DisabledProjectIndex)) {
+ indices.setSearchIndex(
+ new DisabledProjectIndex(maybeDisabledSearchIndex), /* closeOld */ false);
+ }
+
+ return () -> {
+ ProjectIndex maybeEnabledSearchIndex = indices.getSearchIndex();
+ if (maybeEnabledSearchIndex instanceof DisabledProjectIndex) {
+ indices.setSearchIndex(
+ ((DisabledProjectIndex) maybeEnabledSearchIndex).unwrap(), /* closeOld */ false);
+ }
+ };
+ }
+
+ @Override
+ public AutoCloseable disableWrites() {
+ for (ProjectIndex i : indices.getWriteIndexes()) {
+ if (!(i instanceof DisabledProjectIndex)) {
+ indices.addWriteIndex(new DisabledProjectIndex(i));
+ }
+ }
+ return () -> {
+ for (ProjectIndex i : indices.getWriteIndexes()) {
+ if (i instanceof DisabledProjectIndex) {
+ indices.addWriteIndex(((DisabledProjectIndex) i).unwrap());
+ }
+ }
+ };
+ }
+ }
+}
diff --git a/java/com/google/gerrit/asciidoctor/DocIndexer.java b/java/com/google/gerrit/asciidoctor/DocIndexer.java
index 513bdd7..6cbe2a9 100644
--- a/java/com/google/gerrit/asciidoctor/DocIndexer.java
+++ b/java/com/google/gerrit/asciidoctor/DocIndexer.java
@@ -107,11 +107,19 @@
String title;
try (BufferedReader titleReader = Files.newBufferedReader(file.toPath(), UTF_8)) {
- title = titleReader.readLine();
- if (title != null && title.startsWith("[[")) {
+ while ((title = titleReader.readLine()) != null) {
// Generally the first line of the txt is the title. In a few cases the
- // first line is a "[[tag]]" and the second line is the title.
- title = titleReader.readLine();
+ // first lines are "[[tag]]" and or ":attribute:" and the next line
+ // after those is the title.
+ if (title.startsWith("[[")) {
+ continue;
+ }
+ // Skip attributes such as :linkattrs:
+ if (title.startsWith(":") && title.endsWith(":")) {
+ continue;
+ }
+ // We found the title
+ break;
}
}
Matcher matcher = SECTION_HEADER.matcher(title);
diff --git a/java/com/google/gerrit/entities/StoredCommentLinkInfo.java b/java/com/google/gerrit/entities/StoredCommentLinkInfo.java
index f298782..dc5abbc 100644
--- a/java/com/google/gerrit/entities/StoredCommentLinkInfo.java
+++ b/java/com/google/gerrit/entities/StoredCommentLinkInfo.java
@@ -58,7 +58,7 @@
* on it's own.
*/
public static StoredCommentLinkInfo disabled(String name) {
- return builder(name).setOverrideOnly(true).build();
+ return builder(name).setOverrideOnly(true).setEnabled(false).build();
}
/** Creates and returns a new {@link StoredCommentLinkInfo.Builder} instance. */
diff --git a/java/com/google/gerrit/extensions/common/SubmitRecordInfo.java b/java/com/google/gerrit/extensions/common/SubmitRecordInfo.java
index 09c9841..acf9a8c 100644
--- a/java/com/google/gerrit/extensions/common/SubmitRecordInfo.java
+++ b/java/com/google/gerrit/extensions/common/SubmitRecordInfo.java
@@ -15,6 +15,7 @@
package com.google.gerrit.extensions.common;
import java.util.List;
+import java.util.Objects;
/** API response containing a {@link com.google.gerrit.entities.SubmitRecord} entity. */
public class SubmitRecordInfo {
@@ -38,6 +39,25 @@
public String label;
public Status status;
public AccountInfo appliedBy;
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (!(o instanceof Label)) {
+ return false;
+ }
+ Label that = (Label) o;
+ return Objects.equals(label, that.label)
+ && status == that.status
+ && Objects.equals(appliedBy, that.appliedBy);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(label, status, appliedBy);
+ }
}
public String ruleName;
@@ -45,4 +65,25 @@
public List<Label> labels;
public List<LegacySubmitRequirementInfo> requirements;
public String errorMessage;
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (!(o instanceof SubmitRecordInfo)) {
+ return false;
+ }
+ SubmitRecordInfo that = (SubmitRecordInfo) o;
+ return Objects.equals(ruleName, that.ruleName)
+ && status == that.status
+ && Objects.equals(labels, that.labels)
+ && Objects.equals(requirements, that.requirements)
+ && Objects.equals(errorMessage, that.errorMessage);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(ruleName, status, labels, requirements, errorMessage);
+ }
}
diff --git a/java/com/google/gerrit/extensions/common/SubmitRequirementExpressionInfo.java b/java/com/google/gerrit/extensions/common/SubmitRequirementExpressionInfo.java
index e9549c9..b4731f2 100644
--- a/java/com/google/gerrit/extensions/common/SubmitRequirementExpressionInfo.java
+++ b/java/com/google/gerrit/extensions/common/SubmitRequirementExpressionInfo.java
@@ -15,6 +15,7 @@
package com.google.gerrit.extensions.common;
import java.util.List;
+import java.util.Objects;
/** Result of evaluating a single submit requirement expression. */
public class SubmitRequirementExpressionInfo {
@@ -42,4 +43,25 @@
* during its evaluation.
*/
public String errorMessage;
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (!(o instanceof SubmitRequirementExpressionInfo)) {
+ return false;
+ }
+ SubmitRequirementExpressionInfo that = (SubmitRequirementExpressionInfo) o;
+ return fulfilled == that.fulfilled
+ && Objects.equals(expression, that.expression)
+ && Objects.equals(passingAtoms, that.passingAtoms)
+ && Objects.equals(failingAtoms, that.failingAtoms)
+ && Objects.equals(errorMessage, that.errorMessage);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(expression, fulfilled, passingAtoms, failingAtoms, errorMessage);
+ }
}
diff --git a/java/com/google/gerrit/extensions/common/SubmitRequirementResultInfo.java b/java/com/google/gerrit/extensions/common/SubmitRequirementResultInfo.java
index 4778038..cf0d53c 100644
--- a/java/com/google/gerrit/extensions/common/SubmitRequirementResultInfo.java
+++ b/java/com/google/gerrit/extensions/common/SubmitRequirementResultInfo.java
@@ -15,6 +15,7 @@
package com.google.gerrit.extensions.common;
import com.google.gerrit.common.Nullable;
+import java.util.Objects;
/** Result of evaluating a submit requirement on a change. */
public class SubmitRequirementResultInfo {
@@ -72,4 +73,34 @@
/** Result of evaluating the override expression. */
@Nullable public SubmitRequirementExpressionInfo overrideExpressionResult;
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (!(o instanceof SubmitRequirementResultInfo)) {
+ return false;
+ }
+ SubmitRequirementResultInfo that = (SubmitRequirementResultInfo) o;
+ return isLegacy == that.isLegacy
+ && Objects.equals(name, that.name)
+ && Objects.equals(description, that.description)
+ && status == that.status
+ && Objects.equals(applicabilityExpressionResult, that.applicabilityExpressionResult)
+ && Objects.equals(submittabilityExpressionResult, that.submittabilityExpressionResult)
+ && Objects.equals(overrideExpressionResult, that.overrideExpressionResult);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(
+ name,
+ description,
+ status,
+ isLegacy,
+ applicabilityExpressionResult,
+ submittabilityExpressionResult,
+ overrideExpressionResult);
+ }
}
diff --git a/java/com/google/gerrit/server/util/GuiceRequestScopePropagator.java b/java/com/google/gerrit/httpd/GuiceRequestScopePropagator.java
similarity index 80%
rename from java/com/google/gerrit/server/util/GuiceRequestScopePropagator.java
rename to java/com/google/gerrit/httpd/GuiceRequestScopePropagator.java
index 99dd8bf..7c8094a 100644
--- a/java/com/google/gerrit/server/util/GuiceRequestScopePropagator.java
+++ b/java/com/google/gerrit/httpd/GuiceRequestScopePropagator.java
@@ -12,11 +12,13 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.google.gerrit.server.util;
+package com.google.gerrit.httpd;
import com.google.gerrit.common.Nullable;
import com.google.gerrit.server.RemotePeer;
import com.google.gerrit.server.config.CanonicalWebUrl;
+import com.google.gerrit.server.util.RequestScopePropagator;
+import com.google.gerrit.server.util.ThreadLocalRequestContext;
import com.google.inject.Inject;
import com.google.inject.Key;
import com.google.inject.Provider;
@@ -29,21 +31,25 @@
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Callable;
+import javax.servlet.http.HttpServletRequest;
/** Propagator for Guice's built-in servlet scope. */
public class GuiceRequestScopePropagator extends RequestScopePropagator {
private final String url;
private final SocketAddress peer;
+ private final Provider<HttpServletRequest> request;
@Inject
GuiceRequestScopePropagator(
@CanonicalWebUrl @Nullable Provider<String> urlProvider,
@RemotePeer Provider<SocketAddress> remotePeerProvider,
- ThreadLocalRequestContext local) {
+ ThreadLocalRequestContext local,
+ Provider<HttpServletRequest> request) {
super(ServletScopes.REQUEST, local);
this.url = urlProvider != null ? urlProvider.get() : null;
this.peer = remotePeerProvider.get();
+ this.request = request;
}
/** @see RequestScopePropagator#wrap(Callable) */
@@ -64,6 +70,11 @@
seedMap.put(Key.get(typeOfProvider(SocketAddress.class), RemotePeer.class), Providers.of(peer));
seedMap.put(Key.get(SocketAddress.class, RemotePeer.class), peer);
+ Key<?> webSessionAttrKey = Key.get(WebSession.class);
+ Object webSessionAttrValue = request.get().getAttribute(webSessionAttrKey.toString());
+ seedMap.put(webSessionAttrKey, webSessionAttrValue);
+ seedMap.put(Key.get(typeOfProvider(WebSession.class)), Providers.of(webSessionAttrValue));
+
return ServletScopes.continueRequest(callable, seedMap);
}
diff --git a/java/com/google/gerrit/httpd/WebModule.java b/java/com/google/gerrit/httpd/WebModule.java
index da485cc..79dde85 100644
--- a/java/com/google/gerrit/httpd/WebModule.java
+++ b/java/com/google/gerrit/httpd/WebModule.java
@@ -29,7 +29,6 @@
import com.google.gerrit.server.config.GerritRequestModule;
import com.google.gerrit.server.config.GitwebCgiConfig;
import com.google.gerrit.server.git.receive.AsyncReceiveCommits.AsyncReceiveCommitsModule;
-import com.google.gerrit.server.util.GuiceRequestScopePropagator;
import com.google.gerrit.server.util.RequestScopePropagator;
import com.google.inject.Inject;
import com.google.inject.ProvisionException;
diff --git a/java/com/google/gerrit/httpd/plugins/HttpPluginServlet.java b/java/com/google/gerrit/httpd/plugins/HttpPluginServlet.java
index dddc298..a03aa36 100644
--- a/java/com/google/gerrit/httpd/plugins/HttpPluginServlet.java
+++ b/java/com/google/gerrit/httpd/plugins/HttpPluginServlet.java
@@ -489,7 +489,7 @@
}
if (toc != null) {
- appendPageAsSection(scanner, toc, "Documentaion", md);
+ appendPageAsSection(scanner, toc, "Documentation", md);
} else {
appendEntriesSection(scanner, docs, "Documentation", md, prefix, 0);
appendEntriesSection(scanner, servlets, "Servlets", md, prefix, "servlet-".length());
diff --git a/java/com/google/gerrit/httpd/restapi/RestApiServlet.java b/java/com/google/gerrit/httpd/restapi/RestApiServlet.java
index b7dd2f4..543e794 100644
--- a/java/com/google/gerrit/httpd/restapi/RestApiServlet.java
+++ b/java/com/google/gerrit/httpd/restapi/RestApiServlet.java
@@ -363,7 +363,7 @@
try (PerThreadCache ignored = PerThreadCache.create()) {
List<IdString> path = splitPath(req);
- RequestInfo requestInfo = createRequestInfo(traceContext, requestUri, path);
+ RequestInfo requestInfo = createRequestInfo(traceContext, requestUri(req), path);
globals.requestListeners.runEach(l -> l.onRequest(requestInfo));
// It's important that the PerformanceLogContext is closed before the response is sent to
diff --git a/java/com/google/gerrit/index/IndexConfig.java b/java/com/google/gerrit/index/IndexConfig.java
index 8676fb2..c21f32e 100644
--- a/java/com/google/gerrit/index/IndexConfig.java
+++ b/java/com/google/gerrit/index/IndexConfig.java
@@ -30,6 +30,7 @@
@AutoValue
public abstract class IndexConfig {
private static final int DEFAULT_MAX_TERMS = 1024;
+ private static final int DEFAULT_PAGE_SIZE_MULTIPLIER = 1;
public static IndexConfig createDefault() {
return builder().build();
@@ -40,7 +41,10 @@
setIfPresent(cfg, "maxLimit", b::maxLimit);
setIfPresent(cfg, "maxPages", b::maxPages);
setIfPresent(cfg, "maxTerms", b::maxTerms);
+ setIfPresent(cfg, "pageSizeMultiplier", b::pageSizeMultiplier);
+ setIfPresent(cfg, "maxPageSize", b::maxPageSize);
setTypeOrDefault(cfg, b::type);
+ setPaginationTypeOrDefault(cfg, b::paginationType);
return b;
}
@@ -56,13 +60,21 @@
setter.accept(new IndexType(type).toString());
}
+ private static void setPaginationTypeOrDefault(Config cfg, Consumer<PaginationType> setter) {
+ setter.accept(
+ cfg != null ? cfg.getEnum("index", null, "paginationType", PaginationType.OFFSET) : null);
+ }
+
public static Builder builder() {
return new AutoValue_IndexConfig.Builder()
.maxLimit(Integer.MAX_VALUE)
.maxPages(Integer.MAX_VALUE)
.maxTerms(DEFAULT_MAX_TERMS)
+ .pageSizeMultiplier(DEFAULT_PAGE_SIZE_MULTIPLIER)
+ .maxPageSize(Integer.MAX_VALUE)
.type(IndexType.getDefault())
- .separateChangeSubIndexes(false);
+ .separateChangeSubIndexes(false)
+ .paginationType(PaginationType.OFFSET);
}
@AutoValue.Builder
@@ -85,6 +97,12 @@
public abstract Builder separateChangeSubIndexes(boolean separate);
+ public abstract Builder paginationType(PaginationType type);
+
+ public abstract Builder pageSizeMultiplier(int pageSizeMultiplier);
+
+ public abstract Builder maxPageSize(int maxPageSize);
+
abstract IndexConfig autoBuild();
public IndexConfig build() {
@@ -92,6 +110,8 @@
checkLimit(cfg.maxLimit(), "maxLimit");
checkLimit(cfg.maxPages(), "maxPages");
checkLimit(cfg.maxTerms(), "maxTerms");
+ checkLimit(cfg.pageSizeMultiplier(), "pageSizeMultiplier");
+ checkLimit(cfg.maxPageSize(), "maxPageSize");
return cfg;
}
}
@@ -124,4 +144,21 @@
* Returns whether different subsets of changes may be stored in different physical sub-indexes.
*/
public abstract boolean separateChangeSubIndexes();
+
+ /**
+ * Returns pagination type to use when index queries are repeated to obtain the next set of
+ * results.
+ */
+ public abstract PaginationType paginationType();
+
+ /**
+ * Returns multiplier to be used to determine the limit when queries are repeated to obtain the
+ * next set of results.
+ */
+ public abstract int pageSizeMultiplier();
+
+ /**
+ * 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/PaginationType.java b/java/com/google/gerrit/index/PaginationType.java
new file mode 100644
index 0000000..e7e34fd
--- /dev/null
+++ b/java/com/google/gerrit/index/PaginationType.java
@@ -0,0 +1,29 @@
+// 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.index;
+
+public enum PaginationType {
+ /** Index queries are restarted at a non-zero offset to obtain the next set of results */
+ OFFSET,
+
+ /**
+ * Index queries are restarted using a search-after object. Supported index backends can provide
+ * their custom implementations for search-after.
+ *
+ * <p>For example, Lucene implementation uses the last doc from the previous search as
+ * search-after object and uses the IndexSearcher.searchAfter API to get the next set of results.
+ */
+ SEARCH_AFTER
+}
diff --git a/java/com/google/gerrit/index/QueryOptions.java b/java/com/google/gerrit/index/QueryOptions.java
index 0401dab..91c8d1a 100644
--- a/java/com/google/gerrit/index/QueryOptions.java
+++ b/java/com/google/gerrit/index/QueryOptions.java
@@ -19,15 +19,52 @@
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableSet;
import com.google.common.primitives.Ints;
+import com.google.gerrit.common.Nullable;
import java.util.Set;
import java.util.function.Function;
@AutoValue
public abstract class QueryOptions {
public static QueryOptions create(IndexConfig config, int start, int limit, Set<String> fields) {
+ return create(config, start, null, limit, config.pageSizeMultiplier(), limit, fields);
+ }
+
+ public static QueryOptions create(
+ IndexConfig config, int start, int pageSize, int limit, Set<String> fields) {
+ return create(config, start, null, pageSize, config.pageSizeMultiplier(), limit, fields);
+ }
+
+ public static QueryOptions create(
+ IndexConfig config,
+ int start,
+ int pageSize,
+ int pageSizeMultiplier,
+ int limit,
+ Set<String> fields) {
+ return create(config, start, null, pageSize, pageSizeMultiplier, limit, fields);
+ }
+
+ public static QueryOptions create(
+ IndexConfig config,
+ int start,
+ Object searchAfter,
+ int pageSize,
+ int pageSizeMultiplier,
+ int limit,
+ Set<String> fields) {
checkArgument(start >= 0, "start must be nonnegative: %s", start);
checkArgument(limit > 0, "limit must be positive: %s", limit);
- return new AutoValue_QueryOptions(config, start, limit, ImmutableSet.copyOf(fields));
+ if (searchAfter != null) {
+ checkArgument(start == 0, "start must be 0 when searchAfter is specified: %s", start);
+ }
+ return new AutoValue_QueryOptions(
+ config,
+ start,
+ searchAfter,
+ pageSize,
+ pageSizeMultiplier,
+ limit,
+ ImmutableSet.copyOf(fields));
}
public QueryOptions convertForBackend() {
@@ -36,26 +73,56 @@
int backendLimit = config().maxLimit();
int limit = Ints.saturatedCast((long) limit() + start());
limit = Math.min(limit, backendLimit);
- return create(config(), 0, limit, fields());
+ int pageSize = Math.min(Ints.saturatedCast((long) pageSize() + start()), backendLimit);
+ return create(config(), 0, null, pageSize, pageSizeMultiplier(), limit, fields());
}
public abstract IndexConfig config();
public abstract int start();
+ @Nullable
+ public abstract Object searchAfter();
+
+ public abstract int pageSize();
+
+ public abstract int pageSizeMultiplier();
+
public abstract int limit();
public abstract ImmutableSet<String> fields();
+ public QueryOptions withPageSize(int pageSize) {
+ return create(
+ config(), start(), searchAfter(), pageSize, pageSizeMultiplier(), limit(), fields());
+ }
+
public QueryOptions withLimit(int newLimit) {
- return create(config(), start(), newLimit, fields());
+ return create(
+ config(), start(), searchAfter(), pageSize(), pageSizeMultiplier(), newLimit, fields());
}
public QueryOptions withStart(int newStart) {
- return create(config(), newStart, limit(), fields());
+ return create(
+ config(), newStart, searchAfter(), pageSize(), pageSizeMultiplier(), limit(), fields());
+ }
+
+ public QueryOptions withSearchAfter(Object newSearchAfter) {
+ // Index search-after APIs don't use 'start', so set it to 0 to be safe. ElasticSearch for
+ // example, expects it to be 0 when using search-after APIs.
+ return create(
+ config(), start(), newSearchAfter, pageSize(), pageSizeMultiplier(), limit(), fields())
+ .withStart(0);
}
public QueryOptions filterFields(Function<QueryOptions, Set<String>> filter) {
- return create(config(), start(), limit(), filter.apply(this));
+ return create(
+ config(),
+ start(),
+ searchAfter(),
+ pageSize(),
+ pageSizeMultiplier(),
+ limit(),
+ filter.apply(this));
}
}
diff --git a/java/com/google/gerrit/index/query/AndPredicate.java b/java/com/google/gerrit/index/query/AndPredicate.java
index fd8ca96..23ae312 100644
--- a/java/com/google/gerrit/index/query/AndPredicate.java
+++ b/java/com/google/gerrit/index/query/AndPredicate.java
@@ -15,15 +15,19 @@
package com.google.gerrit.index.query;
import static com.google.common.base.Preconditions.checkState;
+import static com.google.common.collect.ImmutableList.toImmutableList;
+import com.google.common.collect.ImmutableList;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
+import java.util.Comparator;
import java.util.List;
/** Requires all predicates to be true. */
-public class AndPredicate<T> extends Predicate<T> implements Matchable<T> {
+public class AndPredicate<T> extends Predicate<T>
+ implements Matchable<T>, Comparator<Predicate<T>> {
private final List<Predicate<T>> children;
private final int cost;
@@ -35,7 +39,7 @@
protected AndPredicate(Collection<? extends Predicate<T>> that) {
List<Predicate<T>> t = new ArrayList<>(that.size());
int c = 0;
- for (Predicate<T> p : that) {
+ for (Predicate<T> p : sort(that)) {
if (getClass() == p.getClass()) {
for (Predicate<T> gp : p.getChildren()) {
t.add(gp);
@@ -116,6 +120,28 @@
&& getChildren().equals(((Predicate<?>) other).getChildren());
}
+ private ImmutableList<Predicate<T>> sort(Collection<? extends Predicate<T>> that) {
+ return that.stream().sorted(this).collect(toImmutableList());
+ }
+
+ @Override
+ public int compare(Predicate<T> a, Predicate<T> b) {
+ int ai = a instanceof DataSource ? 0 : 1;
+ int bi = b instanceof DataSource ? 0 : 1;
+ int cmp = ai - bi;
+
+ if (cmp == 0) {
+ cmp = a.estimateCost() - b.estimateCost();
+ }
+
+ if (cmp == 0 && a instanceof DataSource && b instanceof DataSource) {
+ DataSource<?> as = (DataSource<?>) a;
+ DataSource<?> bs = (DataSource<?>) b;
+ cmp = as.getCardinality() - bs.getCardinality();
+ }
+ return cmp;
+ }
+
@Override
public String toString() {
final StringBuilder r = new StringBuilder();
diff --git a/java/com/google/gerrit/index/query/AndSource.java b/java/com/google/gerrit/index/query/AndSource.java
index 538e11b..2a04051 100644
--- a/java/com/google/gerrit/index/query/AndSource.java
+++ b/java/com/google/gerrit/index/query/AndSource.java
@@ -15,56 +15,58 @@
package com.google.gerrit.index.query;
import static com.google.common.base.Preconditions.checkArgument;
-import static com.google.common.collect.ImmutableList.toImmutableList;
-import com.google.common.collect.FluentIterable;
import com.google.common.collect.ImmutableList;
-import com.google.common.collect.Iterables;
-import com.google.gerrit.exceptions.StorageException;
-import java.util.ArrayList;
+import com.google.gerrit.index.IndexConfig;
import java.util.Collection;
-import java.util.Comparator;
import java.util.List;
-public class AndSource<T> extends AndPredicate<T>
- implements DataSource<T>, Comparator<Predicate<T>> {
+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) {
- this(that, null, 0);
+ public AndSource(Collection<? extends Predicate<T>> that, IndexConfig indexConfig) {
+ this(that, null, 0, indexConfig);
}
- public AndSource(Predicate<T> that, IsVisibleToPredicate<T> isVisibleToPredicate) {
- this(that, isVisibleToPredicate, 0);
+ 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) {
- this(ImmutableList.of(that), isVisibleToPredicate, start);
+ 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) {
+ int start,
+ IndexConfig indexConfig) {
super(that);
checkArgument(start >= 0, "negative start: %s", start);
this.isVisibleToPredicate = isVisibleToPredicate;
this.start = start;
+ this.indexConfig = indexConfig;
int c = Integer.MAX_VALUE;
DataSource<T> s = null;
int minCost = Integer.MAX_VALUE;
- for (Predicate<T> p : sort(getChildren())) {
+ for (Predicate<T> p : getChildren()) {
if (p instanceof DataSource) {
c = Math.min(c, ((DataSource<?>) p).getCardinality());
int cost = p.estimateCost();
if (cost < minCost) {
- s = toDataSource(p);
+ s = toPaginatingSource(p);
minCost = cost;
}
}
@@ -75,64 +77,12 @@
@Override
public ResultSet<T> read() {
- if (source == null) {
- throw new StorageException("No DataSource: " + this);
- }
-
- // ResultSets are lazy. Calling #read here first and then dealing with ResultSets only when
- // requested allows the index to run asynchronous queries.
- ResultSet<T> resultSet = source.read();
- return new LazyResultSet<>(
- () -> {
- List<T> r = new ArrayList<>();
- T last = null;
- int nextStart = 0;
- boolean skipped = false;
- for (T data : buffer(resultSet)) {
- if (!isMatchable() || match(data)) {
- r.add(data);
- } else {
- skipped = true;
- }
- last = data;
- nextStart++;
- }
-
- if (skipped && last != null && source instanceof Paginated) {
- // If our source is a paginated source and we skipped at
- // least one of its results, we may not have filled the full
- // limit the caller wants. Restart the source and continue.
- //
- @SuppressWarnings("unchecked")
- Paginated<T> p = (Paginated<T>) source;
- while (skipped && r.size() < p.getOptions().limit() + start) {
- skipped = false;
- ResultSet<T> next = p.restart(nextStart);
-
- for (T data : buffer(next)) {
- if (match(data)) {
- r.add(data);
- } else {
- skipped = true;
- }
- nextStart++;
- }
- }
- }
-
- if (start >= r.size()) {
- return ImmutableList.of();
- } else if (start > 0) {
- return ImmutableList.copyOf(r.subList(start, r.size()));
- }
- return ImmutableList.copyOf(r);
- });
+ return source.read();
}
@Override
public ResultSet<FieldBundle> readRaw() {
- // TOOD(hiesel): Implement
- throw new UnsupportedOperationException("not implemented");
+ return source.readRaw();
}
@Override
@@ -153,11 +103,6 @@
return true;
}
- private Iterable<T> buffer(ResultSet<T> scanner) {
- return FluentIterable.from(Iterables.partition(scanner, 50))
- .transformAndConcat(this::transformBuffer);
- }
-
protected List<T> transformBuffer(List<T> buffer) {
return buffer;
}
@@ -167,30 +112,18 @@
return cardinality;
}
- private ImmutableList<Predicate<T>> sort(Collection<? extends Predicate<T>> that) {
- return that.stream().sorted(this).collect(toImmutableList());
- }
-
- @Override
- public int compare(Predicate<T> a, Predicate<T> b) {
- int ai = a instanceof DataSource ? 0 : 1;
- int bi = b instanceof DataSource ? 0 : 1;
- int cmp = ai - bi;
-
- if (cmp == 0) {
- cmp = a.estimateCost() - b.estimateCost();
- }
-
- if (cmp == 0 && a instanceof DataSource && b instanceof DataSource) {
- DataSource<?> as = (DataSource<?>) a;
- DataSource<?> bs = (DataSource<?>) b;
- cmp = as.getCardinality() - bs.getCardinality();
- }
- return cmp;
- }
-
@SuppressWarnings("unchecked")
- private DataSource<T> toDataSource(Predicate<T> pred) {
- return (DataSource<T>) pred;
+ private PaginatingSource<T> toPaginatingSource(Predicate<T> pred) {
+ return new PaginatingSource<T>((DataSource<T>) pred, start, indexConfig) {
+ @Override
+ protected boolean match(T object) {
+ return AndSource.this.match(object);
+ }
+
+ @Override
+ protected boolean isMatchable() {
+ return AndSource.this.isMatchable();
+ }
+ };
}
}
diff --git a/java/com/google/gerrit/index/query/IndexedQuery.java b/java/com/google/gerrit/index/query/IndexedQuery.java
index ffd442b..ee25ef9 100644
--- a/java/com/google/gerrit/index/query/IndexedQuery.java
+++ b/java/com/google/gerrit/index/query/IndexedQuery.java
@@ -87,19 +87,15 @@
}
@Override
- public ResultSet<T> restart(int start) {
- opts = opts.withStart(start);
- try {
- source = index.getSource(pred, opts);
- } catch (QueryParseException e) {
- // Don't need to show this exception to the user; the only thing that
- // changed about pred was its start, and any other QPEs that might happen
- // should have already thrown from the constructor.
- throw new StorageException(e);
- }
- // Don't convert start to a limit, since the caller of this method (see
- // AndSource) has calculated the actual number to skip.
- return read();
+ public ResultSet<T> restart(int start, int pageSize) {
+ opts = opts.withStart(start).withPageSize(pageSize);
+ return search();
+ }
+
+ @Override
+ public ResultSet<T> restart(Object searchAfter, int pageSize) {
+ opts = opts.withSearchAfter(searchAfter).withPageSize(pageSize);
+ return search();
}
@Override
@@ -127,4 +123,18 @@
public String toString() {
return MoreObjects.toStringHelper("index").add("p", pred).add("opts", opts).toString();
}
+
+ private ResultSet<T> search() {
+ try {
+ source = index.getSource(pred, opts);
+ } catch (QueryParseException e) {
+ // Don't need to show this exception to the user; the only thing that
+ // changed about pred was its start, and any other QPEs that might happen
+ // should have already thrown from the constructor.
+ throw new StorageException(e);
+ }
+ // Don't convert start to a limit, since the caller of this method (see
+ // AndSource) has calculated the actual number to skip.
+ return read();
+ }
}
diff --git a/java/com/google/gerrit/index/query/LazyResultSet.java b/java/com/google/gerrit/index/query/LazyResultSet.java
index f3fab5f..a7d71f0 100644
--- a/java/com/google/gerrit/index/query/LazyResultSet.java
+++ b/java/com/google/gerrit/index/query/LazyResultSet.java
@@ -53,4 +53,9 @@
@Override
public void close() {}
+
+ @Override
+ public Object searchAfter() {
+ return null;
+ }
}
diff --git a/java/com/google/gerrit/index/query/ListResultSet.java b/java/com/google/gerrit/index/query/ListResultSet.java
index 9d7eadf..f09fda0 100644
--- a/java/com/google/gerrit/index/query/ListResultSet.java
+++ b/java/com/google/gerrit/index/query/ListResultSet.java
@@ -54,4 +54,9 @@
public void close() {
results = null;
}
+
+ @Override
+ public Object searchAfter() {
+ return null;
+ }
}
diff --git a/java/com/google/gerrit/index/query/Paginated.java b/java/com/google/gerrit/index/query/Paginated.java
index e61dd53..5521990 100644
--- a/java/com/google/gerrit/index/query/Paginated.java
+++ b/java/com/google/gerrit/index/query/Paginated.java
@@ -19,5 +19,7 @@
public interface Paginated<T> {
QueryOptions getOptions();
- ResultSet<T> restart(int start);
+ ResultSet<T> restart(int start, int pageSize);
+
+ ResultSet<T> restart(Object searchAfter, int pageSize);
}
diff --git a/java/com/google/gerrit/index/query/PaginatingSource.java b/java/com/google/gerrit/index/query/PaginatingSource.java
new file mode 100644
index 0000000..fd3a218
--- /dev/null
+++ b/java/com/google/gerrit/index/query/PaginatingSource.java
@@ -0,0 +1,148 @@
+// 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.index.query;
+
+import static com.google.common.base.Preconditions.checkArgument;
+
+import com.google.common.collect.FluentIterable;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Iterables;
+import com.google.common.collect.Ordering;
+import com.google.gerrit.exceptions.StorageException;
+import com.google.gerrit.index.IndexConfig;
+import com.google.gerrit.index.PaginationType;
+import com.google.gerrit.index.QueryOptions;
+import java.util.ArrayList;
+import java.util.List;
+
+public class PaginatingSource<T> implements DataSource<T> {
+ protected final DataSource<T> source;
+ private final int start;
+ private final int cardinality;
+ private final IndexConfig indexConfig;
+
+ public PaginatingSource(DataSource<T> source, int start, IndexConfig indexConfig) {
+ checkArgument(start >= 0, "negative start: %s", start);
+ this.source = source;
+ this.start = start;
+ this.cardinality = source.getCardinality();
+ this.indexConfig = indexConfig;
+ }
+
+ @Override
+ public ResultSet<T> read() {
+ if (source == null) {
+ throw new StorageException("No DataSource: " + this);
+ }
+
+ // ResultSets are lazy. Calling #read here first and then dealing with ResultSets only when
+ // requested allows the index to run asynchronous queries.
+ ResultSet<T> resultSet = source.read();
+ return new LazyResultSet<>(
+ () -> {
+ List<T> r = new ArrayList<>();
+ T last = null;
+ int pageResultSize = 0;
+ for (T data : buffer(resultSet)) {
+ if (!isMatchable() || match(data)) {
+ r.add(data);
+ }
+ last = data;
+ pageResultSize++;
+ }
+
+ if (last != null && source instanceof Paginated) {
+ // Restart source and continue if we have not filled the
+ // full limit the caller wants.
+ //
+ @SuppressWarnings("unchecked")
+ Paginated<T> p = (Paginated<T>) source;
+ QueryOptions opts = p.getOptions();
+ final int limit = opts.limit();
+ int pageSize = opts.pageSize();
+ int pageSizeMultiplier = opts.pageSizeMultiplier();
+ Object searchAfter = resultSet.searchAfter();
+ int nextStart = pageResultSize;
+ while (pageResultSize == pageSize && r.size() <= limit) { // get 1 more than the limit
+ pageSize = getNextPageSize(pageSize, pageSizeMultiplier);
+ ResultSet<T> next =
+ indexConfig.paginationType().equals(PaginationType.SEARCH_AFTER)
+ ? p.restart(searchAfter, pageSize)
+ : p.restart(nextStart, pageSize);
+ pageResultSize = 0;
+ for (T data : buffer(next)) {
+ if (match(data)) {
+ r.add(data);
+ }
+ pageResultSize++;
+ }
+ nextStart += pageResultSize;
+ searchAfter = next.searchAfter();
+ }
+ }
+
+ if (start >= r.size()) {
+ return ImmutableList.of();
+ } else if (start > 0) {
+ return ImmutableList.copyOf(r.subList(start, r.size()));
+ }
+ return ImmutableList.copyOf(r);
+ });
+ }
+
+ @Override
+ public ResultSet<FieldBundle> readRaw() {
+ // TOOD(hiesel): Implement
+ throw new UnsupportedOperationException("not implemented");
+ }
+
+ private Iterable<T> buffer(ResultSet<T> scanner) {
+ return FluentIterable.from(Iterables.partition(scanner, 50))
+ .transformAndConcat(this::transformBuffer);
+ }
+
+ protected boolean match(T object) {
+ return true;
+ }
+
+ protected boolean isMatchable() {
+ return true;
+ }
+
+ protected List<T> transformBuffer(List<T> buffer) {
+ return buffer;
+ }
+
+ @Override
+ public int getCardinality() {
+ return cardinality;
+ }
+
+ private int getNextPageSize(int pageSize, int pageSizeMultiplier) {
+ List<Integer> possiblePageSizes = new ArrayList<>(3);
+ try {
+ possiblePageSizes.add(Math.multiplyExact(pageSize, pageSizeMultiplier));
+ } catch (ArithmeticException e) {
+ possiblePageSizes.add(Integer.MAX_VALUE);
+ }
+ if (indexConfig.maxPageSize() > 0) {
+ possiblePageSizes.add(indexConfig.maxPageSize());
+ }
+ if (indexConfig.maxLimit() > 0) {
+ possiblePageSizes.add(indexConfig.maxLimit());
+ }
+ return Ordering.natural().min(possiblePageSizes);
+ }
+}
diff --git a/java/com/google/gerrit/index/query/QueryProcessor.java b/java/com/google/gerrit/index/query/QueryProcessor.java
index 0d5e7b3..21d4c2e 100644
--- a/java/com/google/gerrit/index/query/QueryProcessor.java
+++ b/java/com/google/gerrit/index/query/QueryProcessor.java
@@ -79,7 +79,7 @@
private final IndexCollection<?, T, ? extends Index<?, T>> indexes;
private final IndexRewriter<T> rewriter;
private final String limitField;
- private final IntSupplier permittedLimit;
+ private final IntSupplier userQueryLimit;
private final CallerFinder callerFinder;
// This class is not generally thread-safe, but programmer error may result in it being shared
@@ -100,14 +100,14 @@
IndexCollection<?, T, ? extends Index<?, T>> indexes,
IndexRewriter<T> rewriter,
String limitField,
- IntSupplier permittedLimit) {
+ IntSupplier userQueryLimit) {
this.metrics = new Metrics(metricMaker);
this.schemaDef = schemaDef;
this.indexConfig = indexConfig;
this.indexes = indexes;
this.rewriter = rewriter;
this.limitField = limitField;
- this.permittedLimit = permittedLimit;
+ this.userQueryLimit = userQueryLimit;
this.used = new AtomicBoolean(false);
this.callerFinder =
CallerFinder.builder()
@@ -230,9 +230,10 @@
checkSupportedForQueries(q);
int limit = getEffectiveLimit(q);
limits.add(limit);
+ int initialPageSize = getInitialPageSize(limit);
- if (limit == getBackendSupportedLimit()) {
- limit--;
+ if (initialPageSize == getBackendSupportedLimit()) {
+ initialPageSize--;
}
int page = (start / limit) + 1;
@@ -241,10 +242,31 @@
"Cannot go beyond page " + indexConfig.maxPages() + " of results");
}
- // Always bump limit by 1, even if this results in exceeding the permitted
- // max for this user. The only way to see if there are more entities is to
- // ask for one more result from the query.
- QueryOptions opts = createOptions(indexConfig, start, limit + 1, getRequestedFields());
+ // Always bump initial page size by 1, even if this results in exceeding the
+ // permitted max for this user. The only way to see if there are more entities
+ // is to ask for one more result from the query.
+ try {
+ initialPageSize = Math.addExact(initialPageSize, 1);
+ } catch (ArithmeticException e) {
+ initialPageSize = Integer.MAX_VALUE;
+ }
+
+ // If pageSizeMultiplier is set to 1 (default), update it to 10 for no-limit queries as
+ // it helps improve performance and also prevents no-limit queries from severely degrading
+ // when pagination type is OFFSET.
+ int pageSizeMultiplier = indexConfig.pageSizeMultiplier();
+ if (isNoLimit && pageSizeMultiplier == 1) {
+ pageSizeMultiplier = 10;
+ }
+
+ QueryOptions opts =
+ createOptions(
+ indexConfig,
+ start,
+ initialPageSize,
+ pageSizeMultiplier,
+ limit,
+ getRequestedFields());
logger.atFine().log("Query options: %s", opts);
Predicate<T> pred = rewriter.rewrite(q, opts);
if (enforceVisibility) {
@@ -259,6 +281,9 @@
@SuppressWarnings("unchecked")
DataSource<T> s = (DataSource<T>) pred;
+ if (initialPageSize < limit && !(pred instanceof AndSource)) {
+ s = new PaginatingSource<T>(s, start, indexConfig);
+ }
sources.add(s);
}
@@ -318,8 +343,14 @@
}
protected QueryOptions createOptions(
- IndexConfig indexConfig, int start, int limit, Set<String> requestedFields) {
- return QueryOptions.create(indexConfig, start, limit, requestedFields);
+ IndexConfig indexConfig,
+ int start,
+ int pageSize,
+ int pageSizeMultiplier,
+ int limit,
+ Set<String> requestedFields) {
+ return QueryOptions.create(
+ indexConfig, start, pageSize, pageSizeMultiplier, limit, requestedFields);
}
/**
@@ -357,14 +388,14 @@
}
private int getPermittedLimit() {
- return enforceVisibility ? permittedLimit.getAsInt() : Integer.MAX_VALUE;
+ return enforceVisibility ? userQueryLimit.getAsInt() : Integer.MAX_VALUE;
}
private int getBackendSupportedLimit() {
return indexConfig.maxLimit();
}
- private int getEffectiveLimit(Predicate<T> p) {
+ public int getEffectiveLimit(Predicate<T> p) {
if (isNoLimit == true) {
return Integer.MAX_VALUE;
}
@@ -383,6 +414,7 @@
int result = Ordering.natural().min(possibleLimits);
// Should have short-circuited from #query or thrown some other exception before getting here.
checkState(result > 0, "effective limit should be positive");
+
return result;
}
@@ -393,5 +425,17 @@
.findFirst();
}
+ protected IntSupplier getUserQueryLimit() {
+ return userQueryLimit;
+ }
+
+ protected int getInitialPageSize(int queryLimit) {
+ return queryLimit;
+ }
+
protected abstract String formatForLogging(T t);
+
+ protected abstract int getIndexSize();
+
+ protected abstract int getBatchSize();
}
diff --git a/java/com/google/gerrit/index/query/ResultSet.java b/java/com/google/gerrit/index/query/ResultSet.java
index 65fcd45..b4bd19e 100644
--- a/java/com/google/gerrit/index/query/ResultSet.java
+++ b/java/com/google/gerrit/index/query/ResultSet.java
@@ -49,4 +49,6 @@
* the iterator has finished.
*/
void close();
+
+ Object searchAfter();
}
diff --git a/java/com/google/gerrit/index/testing/AbstractFakeIndex.java b/java/com/google/gerrit/index/testing/AbstractFakeIndex.java
index 36e9e52..4241828 100644
--- a/java/com/google/gerrit/index/testing/AbstractFakeIndex.java
+++ b/java/com/google/gerrit/index/testing/AbstractFakeIndex.java
@@ -19,6 +19,7 @@
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;
@@ -52,6 +53,9 @@
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;
/**
@@ -69,12 +73,14 @@
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
@@ -108,18 +114,33 @@
}
}
+ public int getQueryCount() {
+ return queryCount;
+ }
+
@Override
public DataSource<V> getSource(Predicate<V> p, QueryOptions opts) {
List<V> results;
synchronized (indexedDocuments) {
- results =
+ Stream<V> valueStream =
indexedDocuments.values().stream()
.map(doc -> valueFor(doc))
.filter(doc -> p.asMatchable().match(doc))
- .sorted(sortingComparator())
- .skip(opts.start())
- .limit(opts.limit())
- .collect(toImmutableList());
+ .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.pageSize(), valueList.size());
+ results = valueList.subList(fromIndex, toIndex);
+ } else {
+ results = valueStream.skip(opts.start()).limit(opts.pageSize()).collect(toImmutableList());
+ }
+ queryCount++;
}
return new DataSource<>() {
@Override
@@ -129,12 +150,19 @@
@Override
public ResultSet<V> read() {
- return new ListResultSet<>(results);
+ 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()) {
@@ -148,8 +176,16 @@
}
}
fieldBundles.add(new FieldBundle(fields.build()));
+ searchAfter = keyFor(result);
}
- return new ListResultSet<>(fieldBundles.build());
+ ImmutableList<FieldBundle> resultSet = fieldBundles.build();
+ K finalSearchAfter = searchAfter;
+ return new ListResultSet<>(resultSet) {
+ @Override
+ public Object searchAfter() {
+ return finalSearchAfter;
+ }
+ };
}
};
}
diff --git a/java/com/google/gerrit/json/OptionalTypeAdapter.java b/java/com/google/gerrit/json/OptionalTypeAdapter.java
new file mode 100644
index 0000000..9bfa72d
--- /dev/null
+++ b/java/com/google/gerrit/json/OptionalTypeAdapter.java
@@ -0,0 +1,69 @@
+// 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.json;
+
+import com.google.gson.JsonDeserializationContext;
+import com.google.gson.JsonDeserializer;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonNull;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParseException;
+import com.google.gson.JsonSerializationContext;
+import com.google.gson.JsonSerializer;
+import com.google.inject.TypeLiteral;
+import java.lang.reflect.ParameterizedType;
+import java.lang.reflect.Type;
+import java.util.Optional;
+
+public class OptionalTypeAdapter
+ implements JsonSerializer<Optional<?>>, JsonDeserializer<Optional<?>> {
+
+ private static final String VALUE = "value";
+
+ @Override
+ public JsonElement serialize(Optional<?> src, Type typeOfSrc, JsonSerializationContext context) {
+ Optional<?> optional = src == null ? Optional.empty() : src;
+ JsonObject json = new JsonObject();
+ json.add(VALUE, optional.map(context::serialize).orElse(JsonNull.INSTANCE));
+ return json;
+ }
+
+ @Override
+ public Optional<?> deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)
+ throws JsonParseException {
+ if (!json.getAsJsonObject().has(VALUE)) {
+ return Optional.empty();
+ }
+
+ JsonElement value = json.getAsJsonObject().get(VALUE);
+ if (value == null || value.isJsonNull()) {
+ return Optional.empty();
+ }
+
+ // handle the situation when one uses Optional without type parameter which is an equivalent of
+ // <?> type
+ ParameterizedType parameterizedType =
+ (ParameterizedType) new TypeLiteral<Optional<?>>() {}.getType();
+ if (typeOfT instanceof ParameterizedType) {
+ parameterizedType = (ParameterizedType) typeOfT;
+ if (parameterizedType.getActualTypeArguments().length != 1) {
+ throw new JsonParseException("Expected one parameter type in Optional.");
+ }
+ }
+
+ Type optionalOf = parameterizedType.getActualTypeArguments()[0];
+ return Optional.of(context.deserialize(value, optionalOf));
+ }
+}
diff --git a/java/com/google/gerrit/launcher/GerritLauncher.java b/java/com/google/gerrit/launcher/GerritLauncher.java
index ceec55c..a190ebf 100644
--- a/java/com/google/gerrit/launcher/GerritLauncher.java
+++ b/java/com/google/gerrit/launcher/GerritLauncher.java
@@ -301,7 +301,7 @@
move(jars, "javax.inject-1.jar", extapi);
move(jars, "aopalliance-1.0.jar", extapi);
move(jars, "guice-servlet-", extapi);
- move(jars, "tomcat-servlet-api-", extapi);
+ move(jars, "servlet-api-", extapi);
ClassLoader parent = ClassLoader.getSystemClassLoader();
if (!extapi.isEmpty()) {
diff --git a/java/com/google/gerrit/lucene/AbstractLuceneIndex.java b/java/com/google/gerrit/lucene/AbstractLuceneIndex.java
index 988d6fb..586887b 100644
--- a/java/com/google/gerrit/lucene/AbstractLuceneIndex.java
+++ b/java/com/google/gerrit/lucene/AbstractLuceneIndex.java
@@ -536,20 +536,31 @@
private <T> ResultSet<T> readImpl(Function<Document, T> mapper) {
IndexSearcher searcher = null;
+ ScoreDoc scoreDoc = null;
try {
searcher = acquire();
- int realLimit = opts.start() + opts.limit();
- TopFieldDocs docs = searcher.search(query, realLimit, sort);
+ int realLimit = opts.start() + opts.pageSize();
+ TopFieldDocs docs =
+ opts.searchAfter() != null
+ ? searcher.searchAfter(
+ (ScoreDoc) opts.searchAfter(), query, realLimit, sort, false, false)
+ : searcher.search(query, realLimit, sort);
ImmutableList.Builder<T> b = ImmutableList.builderWithExpectedSize(docs.scoreDocs.length);
for (int i = opts.start(); i < docs.scoreDocs.length; i++) {
- ScoreDoc sd = docs.scoreDocs[i];
- Document doc = searcher.doc(sd.doc, opts.fields());
+ scoreDoc = docs.scoreDocs[i];
+ Document doc = searcher.doc(scoreDoc.doc, opts.fields());
T mapperResult = mapper.apply(doc);
if (mapperResult != null) {
b.add(mapperResult);
}
}
- return new ListResultSet<>(b.build());
+ ScoreDoc searchAfter = scoreDoc;
+ return new ListResultSet<T>(b.build()) {
+ @Override
+ public Object searchAfter() {
+ return searchAfter;
+ }
+ };
} catch (IOException e) {
throw new StorageException(e);
} finally {
diff --git a/java/com/google/gerrit/lucene/LuceneChangeIndex.java b/java/com/google/gerrit/lucene/LuceneChangeIndex.java
index 9ea9d2e..d40dfb4 100644
--- a/java/com/google/gerrit/lucene/LuceneChangeIndex.java
+++ b/java/com/google/gerrit/lucene/LuceneChangeIndex.java
@@ -40,6 +40,7 @@
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.Schema;
import com.google.gerrit.index.query.FieldBundle;
@@ -64,8 +65,11 @@
import java.io.IOException;
import java.nio.file.Path;
import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
+import java.util.Map;
import java.util.Set;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
@@ -319,6 +323,7 @@
private final QueryOptions opts;
private final Sort sort;
private final Function<Document, FieldBundle> rawDocumentMapper;
+ private final boolean isSearchAfterPagination;
private QuerySource(
List<ChangeSubIndex> indexes,
@@ -333,6 +338,8 @@
this.opts = opts;
this.sort = sort;
this.rawDocumentMapper = rawDocumentMapper;
+ this.isSearchAfterPagination =
+ opts.config().paginationType().equals(PaginationType.SEARCH_AFTER);
}
@Override
@@ -360,9 +367,9 @@
final Set<String> fields = IndexUtils.changeFields(opts, schema.useLegacyNumericFields());
return new ChangeDataResults(
executor.submit(
- new Callable<List<Document>>() {
+ new Callable<Results>() {
@Override
- public List<Document> call() throws IOException {
+ public Results call() throws IOException {
return doRead(fields);
}
@@ -377,8 +384,12 @@
@Override
public ResultSet<FieldBundle> readRaw() {
List<Document> documents;
+ Map<ChangeSubIndex, ScoreDoc> searchAfterBySubIndex;
+
try {
- documents = doRead(IndexUtils.changeFields(opts, schema.useLegacyNumericFields()));
+ Results r = doRead(IndexUtils.changeFields(opts, schema.useLegacyNumericFields()));
+ documents = r.docs;
+ searchAfterBySubIndex = r.searchAfterBySubIndex;
} catch (IOException e) {
throw new StorageException(e);
}
@@ -399,29 +410,57 @@
public void close() {
// Do nothing.
}
+
+ @Override
+ public Object searchAfter() {
+ return searchAfterBySubIndex;
+ }
};
}
- private List<Document> doRead(Set<String> fields) throws IOException {
+ private Results doRead(Set<String> fields) throws IOException {
IndexSearcher[] searchers = new IndexSearcher[indexes.size()];
+ Map<ChangeSubIndex, ScoreDoc> searchAfterBySubIndex = new HashMap<>();
try {
- int realLimit = opts.start() + opts.limit();
- if (Integer.MAX_VALUE - opts.limit() < opts.start()) {
- realLimit = Integer.MAX_VALUE;
+ int realPageSize = opts.start() + opts.pageSize();
+ if (Integer.MAX_VALUE - opts.pageSize() < opts.start()) {
+ realPageSize = Integer.MAX_VALUE;
}
- TopFieldDocs[] hits = new TopFieldDocs[indexes.size()];
+ List<TopFieldDocs> hits = new ArrayList<>();
+ int searchAfterHitsCount = 0;
for (int i = 0; i < indexes.size(); i++) {
- searchers[i] = indexes.get(i).acquire();
- hits[i] = searchers[i].search(query, realLimit, sort);
+ ChangeSubIndex subIndex = indexes.get(i);
+ searchers[i] = subIndex.acquire();
+ if (isSearchAfterPagination) {
+ ScoreDoc searchAfter = getSearchAfter(subIndex);
+ int maxRemainingHits = realPageSize - searchAfterHitsCount;
+ if (maxRemainingHits > 0) {
+ TopFieldDocs subIndexHits =
+ searchers[i].searchAfter(
+ searchAfter,
+ query,
+ maxRemainingHits,
+ sort,
+ /* doDocScores= */ false,
+ /* doMaxScore= */ false);
+ searchAfterHitsCount += subIndexHits.scoreDocs.length;
+ hits.add(subIndexHits);
+ searchAfterBySubIndex.put(
+ subIndex, Iterables.getLast(Arrays.asList(subIndexHits.scoreDocs), searchAfter));
+ }
+ } else {
+ hits.add(searchers[i].search(query, realPageSize, sort));
+ }
}
- TopDocs docs = TopDocs.merge(sort, realLimit, hits);
+ TopDocs docs =
+ TopDocs.merge(sort, realPageSize, hits.stream().toArray(TopFieldDocs[]::new));
List<Document> result = new ArrayList<>(docs.scoreDocs.length);
for (int i = opts.start(); i < docs.scoreDocs.length; i++) {
ScoreDoc sd = docs.scoreDocs[i];
result.add(searchers[sd.shardIndex].doc(sd.doc, fields));
}
- return result;
+ return new Results(result, searchAfterBySubIndex);
} finally {
for (int i = 0; i < indexes.size(); i++) {
if (searchers[i] != null) {
@@ -434,13 +473,41 @@
}
}
}
+
+ /**
+ * Returns null for the first page or when pagination type is not {@link
+ * PaginationType#SEARCH_AFTER search-after}, otherwise returns the last doc from previous
+ * search on the given change sub-index.
+ *
+ * @param subIndex change sub-index
+ * @return the score doc that can be used to page result sets
+ */
+ private ScoreDoc getSearchAfter(ChangeSubIndex subIndex) {
+ if (isSearchAfterPagination
+ && opts.searchAfter() != null
+ && opts.searchAfter() instanceof Map) {
+ return ((Map<ChangeSubIndex, ScoreDoc>) opts.searchAfter()).get(subIndex);
+ }
+ return null;
+ }
+ }
+
+ private static class Results {
+ List<Document> docs;
+ Map<ChangeSubIndex, ScoreDoc> searchAfterBySubIndex;
+
+ public Results(List<Document> docs, Map<ChangeSubIndex, ScoreDoc> searchAfterBySubIndex) {
+ this.docs = docs;
+ this.searchAfterBySubIndex = searchAfterBySubIndex;
+ }
}
private class ChangeDataResults implements ResultSet<ChangeData> {
- private final Future<List<Document>> future;
+ private final Future<Results> future;
private final Set<String> fields;
+ private Map<ChangeSubIndex, ScoreDoc> searchAfterBySubIndex;
- ChangeDataResults(Future<List<Document>> future, Set<String> fields) {
+ ChangeDataResults(Future<Results> future, Set<String> fields) {
this.future = future;
this.fields = fields;
}
@@ -453,7 +520,9 @@
@Override
public ImmutableList<ChangeData> toList() {
try {
- List<Document> docs = future.get();
+ Results r = future.get();
+ List<Document> docs = r.docs;
+ searchAfterBySubIndex = r.searchAfterBySubIndex;
ImmutableList.Builder<ChangeData> result =
ImmutableList.builderWithExpectedSize(docs.size());
for (Document doc : docs) {
@@ -473,6 +542,11 @@
public void close() {
future.cancel(false /* do not interrupt Lucene */);
}
+
+ @Override
+ public Object searchAfter() {
+ return searchAfterBySubIndex;
+ }
}
private static ListMultimap<String, IndexableField> fields(Document doc, Set<String> fields) {
diff --git a/java/com/google/gerrit/metrics/MetricMaker.java b/java/com/google/gerrit/metrics/MetricMaker.java
index 42ec8a0..618d421 100644
--- a/java/com/google/gerrit/metrics/MetricMaker.java
+++ b/java/com/google/gerrit/metrics/MetricMaker.java
@@ -78,14 +78,15 @@
* @param name unique name of the metric.
* @param value only value of the metric.
* @param desc description of the metric.
+ * @return registration handle
*/
- public <V> void newConstantMetric(String name, V value, Description desc) {
+ public <V> RegistrationHandle newConstantMetric(String name, V value, Description desc) {
desc.setConstant();
@SuppressWarnings("unchecked")
Class<V> type = (Class<V>) value.getClass();
CallbackMetric0<V> metric = newCallbackMetric(name, type, desc);
- newTrigger(metric, () -> metric.set(value));
+ return newTrigger(metric, () -> metric.set(value));
}
/**
@@ -107,11 +108,12 @@
* @param valueClass type of value recorded by the metric.
* @param desc description of the metric.
* @param trigger function to compute the value of the metric.
+ * @return registration handle
*/
- public <V> void newCallbackMetric(
+ public <V> RegistrationHandle newCallbackMetric(
String name, Class<V> valueClass, Description desc, Supplier<V> trigger) {
CallbackMetric0<V> metric = newCallbackMetric(name, valueClass, desc);
- newTrigger(metric, () -> metric.set(trigger.get()));
+ return newTrigger(metric, () -> metric.set(trigger.get()));
}
/**
diff --git a/java/com/google/gerrit/metrics/MetricsReservoirConfig.java b/java/com/google/gerrit/metrics/MetricsReservoirConfig.java
new file mode 100644
index 0000000..ca4cb09
--- /dev/null
+++ b/java/com/google/gerrit/metrics/MetricsReservoirConfig.java
@@ -0,0 +1,33 @@
+// 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.metrics;
+
+import java.time.Duration;
+
+/** Configuration of the Metrics' reservoir type and size. */
+public interface MetricsReservoirConfig {
+
+ /** Returns the reservoir type. */
+ ReservoirType reservoirType();
+
+ /** Returns the reservoir window duration. */
+ Duration reservoirWindow();
+
+ /** Returns the number of samples that the reservoir can contain */
+ int reservoirSize();
+
+ /** Returns the alpha parameter of the ExponentiallyDecaying reservoir */
+ double reservoirAlpha();
+}
diff --git a/java/com/google/gerrit/metrics/ReservoirType.java b/java/com/google/gerrit/metrics/ReservoirType.java
new file mode 100644
index 0000000..fe89752
--- /dev/null
+++ b/java/com/google/gerrit/metrics/ReservoirType.java
@@ -0,0 +1,24 @@
+// 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.metrics;
+
+/** Type of reservoir for collecting metrics into. */
+public enum ReservoirType {
+ ExponentiallyDecaying,
+ SlidingTimeWindowArray,
+ SlidingTimeWindow,
+ SlidingWindow,
+ Uniform;
+}
diff --git a/java/com/google/gerrit/metrics/dropwizard/DropWizardMetricMaker.java b/java/com/google/gerrit/metrics/dropwizard/DropWizardMetricMaker.java
index fcba0ee..32be18d 100644
--- a/java/com/google/gerrit/metrics/dropwizard/DropWizardMetricMaker.java
+++ b/java/com/google/gerrit/metrics/dropwizard/DropWizardMetricMaker.java
@@ -18,8 +18,10 @@
import static com.google.gerrit.metrics.dropwizard.MetricResource.METRIC_KIND;
import static com.google.gerrit.server.config.ConfigResource.CONFIG_KIND;
+import com.codahale.metrics.Histogram;
import com.codahale.metrics.Metric;
import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.Timer;
import com.google.common.collect.FluentIterable;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
@@ -41,6 +43,7 @@
import com.google.gerrit.metrics.Histogram2;
import com.google.gerrit.metrics.Histogram3;
import com.google.gerrit.metrics.MetricMaker;
+import com.google.gerrit.metrics.MetricsReservoirConfig;
import com.google.gerrit.metrics.Timer0;
import com.google.gerrit.metrics.Timer1;
import com.google.gerrit.metrics.Timer2;
@@ -48,10 +51,12 @@
import com.google.gerrit.metrics.proc.JGitMetricModule;
import com.google.gerrit.metrics.proc.ProcMetricModule;
import com.google.gerrit.server.cache.CacheMetrics;
+import com.google.gerrit.server.config.MetricsReservoirConfigImpl;
import com.google.inject.Inject;
import com.google.inject.Scopes;
import com.google.inject.Singleton;
import java.util.Map;
+import java.util.Optional;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.TimeUnit;
@@ -65,8 +70,25 @@
@Singleton
public class DropWizardMetricMaker extends MetricMaker {
public static class ApiModule extends RestApiModule {
+ private final Optional<MetricsReservoirConfig> metricsReservoirConfig;
+
+ public ApiModule(MetricsReservoirConfig metricsReservoirConfig) {
+ this.metricsReservoirConfig = Optional.of(metricsReservoirConfig);
+ }
+
+ public ApiModule() {
+ this.metricsReservoirConfig = Optional.empty();
+ }
+
@Override
protected void configure() {
+ if (metricsReservoirConfig.isPresent()) {
+ bind(MetricsReservoirConfig.class).toInstance(metricsReservoirConfig.get());
+ } else {
+ bind(MetricsReservoirConfig.class)
+ .to(MetricsReservoirConfigImpl.class)
+ .in(Scopes.SINGLETON);
+ }
bind(MetricRegistry.class).in(Scopes.SINGLETON);
bind(DropWizardMetricMaker.class).in(Scopes.SINGLETON);
bind(MetricMaker.class).to(DropWizardMetricMaker.class);
@@ -89,12 +111,14 @@
private final MetricRegistry registry;
private final Map<String, BucketedMetric> bucketed;
private final Map<String, ImmutableMap<String, String>> descriptions;
+ private final MetricsReservoirConfig reservoirConfig;
@Inject
- DropWizardMetricMaker(MetricRegistry registry) {
+ DropWizardMetricMaker(MetricRegistry registry, MetricsReservoirConfig reservoirConfig) {
this.registry = registry;
this.bucketed = new ConcurrentHashMap<>();
this.descriptions = new ConcurrentHashMap<>();
+ this.reservoirConfig = reservoirConfig;
}
Iterable<String> getMetricNames() {
@@ -222,7 +246,9 @@
}
TimerImpl newTimerImpl(String name) {
- return new TimerImpl(name, registry.timer(name));
+ return new TimerImpl(
+ name,
+ registry.timer(name, () -> new Timer(DropWizardReservoirProvider.get(reservoirConfig))));
}
@Override
@@ -271,7 +297,10 @@
}
HistogramImpl newHistogramImpl(String name) {
- return new HistogramImpl(name, registry.histogram(name));
+ return new HistogramImpl(
+ name,
+ registry.histogram(
+ name, () -> new Histogram(DropWizardReservoirProvider.get(reservoirConfig))));
}
@Override
diff --git a/java/com/google/gerrit/metrics/dropwizard/DropWizardReservoirProvider.java b/java/com/google/gerrit/metrics/dropwizard/DropWizardReservoirProvider.java
new file mode 100644
index 0000000..3089068
--- /dev/null
+++ b/java/com/google/gerrit/metrics/dropwizard/DropWizardReservoirProvider.java
@@ -0,0 +1,52 @@
+// 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.metrics.dropwizard;
+
+import com.codahale.metrics.ExponentiallyDecayingReservoir;
+import com.codahale.metrics.Reservoir;
+import com.codahale.metrics.SlidingTimeWindowArrayReservoir;
+import com.codahale.metrics.SlidingTimeWindowReservoir;
+import com.codahale.metrics.SlidingWindowReservoir;
+import com.codahale.metrics.UniformReservoir;
+import com.google.gerrit.metrics.MetricsReservoirConfig;
+import com.google.gerrit.metrics.ReservoirType;
+import java.util.concurrent.TimeUnit;
+
+class DropWizardReservoirProvider {
+
+ private DropWizardReservoirProvider() {}
+
+ static Reservoir get(MetricsReservoirConfig config) {
+ ReservoirType reservoirType = config.reservoirType();
+ switch (reservoirType) {
+ case ExponentiallyDecaying:
+ return new ExponentiallyDecayingReservoir(config.reservoirSize(), config.reservoirAlpha());
+ case SlidingTimeWindowArray:
+ return new SlidingTimeWindowArrayReservoir(
+ config.reservoirWindow().toMillis(), TimeUnit.MILLISECONDS);
+ case SlidingTimeWindow:
+ return new SlidingTimeWindowReservoir(
+ config.reservoirWindow().toMillis(), TimeUnit.MILLISECONDS);
+ case SlidingWindow:
+ return new SlidingWindowReservoir(config.reservoirSize());
+ case Uniform:
+ return new UniformReservoir(config.reservoirSize());
+
+ default:
+ throw new IllegalArgumentException(
+ "Unsupported metrics reservoir type " + reservoirType.name());
+ }
+ }
+}
diff --git a/java/com/google/gerrit/pgm/util/BatchProgramModule.java b/java/com/google/gerrit/pgm/util/BatchProgramModule.java
index 41ed991..9c0a4be 100644
--- a/java/com/google/gerrit/pgm/util/BatchProgramModule.java
+++ b/java/com/google/gerrit/pgm/util/BatchProgramModule.java
@@ -56,6 +56,7 @@
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;
import com.google.gerrit.server.config.GitReceivePackGroups;
import com.google.gerrit.server.config.GitUploadPackGroups;
import com.google.gerrit.server.config.SysExecutorModule;
@@ -95,6 +96,7 @@
import com.google.gerrit.server.rules.SubmitRule;
import com.google.gerrit.server.update.BatchUpdate;
import com.google.inject.Injector;
+import com.google.inject.Key;
import com.google.inject.Module;
import com.google.inject.TypeLiteral;
import com.google.inject.util.Providers;
@@ -102,6 +104,7 @@
import java.util.Collections;
import java.util.List;
import java.util.Set;
+import org.eclipse.jgit.lib.Config;
/** Module for programs that perform batch operations on a site. */
public class BatchProgramModule extends FactoryModule {
@@ -204,7 +207,7 @@
// Submit rules
DynamicSet.setOf(binder(), SubmitRule.class);
factory(SubmitRuleEvaluator.Factory.class);
- modules.add(new PrologModule());
+ modules.add(new PrologModule(getConfig()));
modules.add(new DefaultSubmitRuleModule());
modules.add(new IgnoreSelfApprovalRuleModule());
@@ -226,4 +229,8 @@
.stream()
.forEach(this::install);
}
+
+ protected Config getConfig() {
+ return parentInjector.getInstance(Key.get(Config.class, GerritServerConfig.class));
+ }
}
diff --git a/java/com/google/gerrit/server/LibModuleLoader.java b/java/com/google/gerrit/server/LibModuleLoader.java
index cf53c80..5c0f8e4 100644
--- a/java/com/google/gerrit/server/LibModuleLoader.java
+++ b/java/com/google/gerrit/server/LibModuleLoader.java
@@ -18,6 +18,7 @@
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;
@@ -55,9 +56,14 @@
try {
Method m =
- clazz.getMethod("singleVersionWithExplicitVersions", Map.class, int.class, boolean.class);
+ clazz.getMethod(
+ "singleVersionWithExplicitVersions",
+ Map.class,
+ int.class,
+ boolean.class,
+ AutoFlush.class);
- Module module = (Module) m.invoke(null, versions, threads, replica);
+ Module module = (Module) m.invoke(null, versions, threads, replica, AutoFlush.DISABLED);
logger.atInfo().log("Installed module %s", className);
return module;
} catch (Exception e) {
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/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/InternalAccountDirectory.java b/java/com/google/gerrit/server/account/InternalAccountDirectory.java
index 130fa44..f7b0b60 100644
--- a/java/com/google/gerrit/server/account/InternalAccountDirectory.java
+++ b/java/com/google/gerrit/server/account/InternalAccountDirectory.java
@@ -32,6 +32,7 @@
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;
@@ -52,6 +53,9 @@
@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 InternalAccountDirectoryModule extends AbstractModule {
@Override
@@ -129,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)) {
diff --git a/java/com/google/gerrit/server/cache/mem/DefaultMemoryCacheFactory.java b/java/com/google/gerrit/server/cache/mem/DefaultMemoryCacheFactory.java
index f672d11..3b104dd 100644
--- a/java/com/google/gerrit/server/cache/mem/DefaultMemoryCacheFactory.java
+++ b/java/com/google/gerrit/server/cache/mem/DefaultMemoryCacheFactory.java
@@ -93,7 +93,7 @@
Duration refreshAfterWrite = def.refreshAfterWrite();
if (has(def.configKey(), "refreshAfterWrite")) {
- builder.expireAfterAccess(
+ builder.refreshAfterWrite(
ConfigUtil.getTimeUnit(
cfg,
"cache",
diff --git a/java/com/google/gerrit/server/config/GerritGlobalModule.java b/java/com/google/gerrit/server/config/GerritGlobalModule.java
index 0f892b3..6449155 100644
--- a/java/com/google/gerrit/server/config/GerritGlobalModule.java
+++ b/java/com/google/gerrit/server/config/GerritGlobalModule.java
@@ -281,7 +281,7 @@
install(new GroupDbModule());
install(new GroupModule());
install(new NoteDbModule());
- install(new PrologModule());
+ install(new PrologModule(cfg));
install(new DefaultSubmitRuleModule());
install(new IgnoreSelfApprovalRuleModule());
install(new ReceiveCommitsModule());
diff --git a/java/com/google/gerrit/server/config/MetricsReservoirConfigImpl.java b/java/com/google/gerrit/server/config/MetricsReservoirConfigImpl.java
new file mode 100644
index 0000000..ac3c53a
--- /dev/null
+++ b/java/com/google/gerrit/server/config/MetricsReservoirConfigImpl.java
@@ -0,0 +1,96 @@
+// 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.config;
+
+import com.google.gerrit.metrics.MetricsReservoirConfig;
+import com.google.gerrit.metrics.ReservoirType;
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
+import java.time.Duration;
+import java.util.Optional;
+import java.util.concurrent.TimeUnit;
+import org.eclipse.jgit.lib.Config;
+
+/** Define metrics reservoir settings based on gerrit.config */
+@Singleton
+public class MetricsReservoirConfigImpl implements MetricsReservoirConfig {
+ private static final double RESERVOIR_ALPHA_DEFAULT = 0.015;
+ private static final int METRICS_RESERVOIR_SIZE_DEFAULT = 1028;
+ private static final long METRICS_RESERVOIR_WINDOW_MSEC_DEFAULT = 60000L;
+ private static final String METRICS_SECTION = "metrics";
+ private static final String METRICS_RESERVOIR = "reservoir";
+
+ private final ReservoirType reservoirType;
+
+ private final Duration reservoirWindow;
+ private final int reservoirSize;
+ private final double reservoirAlpha;
+
+ @Inject
+ MetricsReservoirConfigImpl(@GerritServerConfig Config gerritConfig) {
+ this.reservoirType =
+ gerritConfig.getEnum(
+ METRICS_SECTION, null, METRICS_RESERVOIR, ReservoirType.ExponentiallyDecaying);
+
+ reservoirWindow =
+ Duration.ofMillis(
+ ConfigUtil.getTimeUnit(
+ gerritConfig,
+ METRICS_SECTION,
+ reservoirType.name(),
+ "window",
+ METRICS_RESERVOIR_WINDOW_MSEC_DEFAULT,
+ TimeUnit.MILLISECONDS));
+ reservoirSize =
+ gerritConfig.getInt(
+ METRICS_SECTION, reservoirType.name(), "size", METRICS_RESERVOIR_SIZE_DEFAULT);
+ reservoirAlpha =
+ Optional.ofNullable(gerritConfig.getString(METRICS_SECTION, reservoirType.name(), "alpha"))
+ .map(Double::parseDouble)
+ .orElse(RESERVOIR_ALPHA_DEFAULT);
+ }
+
+ /* (non-Javadoc)
+ * @see com.google.gerrit.server.config.MetricsConfig#reservoirType()
+ */
+ @Override
+ public ReservoirType reservoirType() {
+ return reservoirType;
+ }
+
+ /* (non-Javadoc)
+ * @see com.google.gerrit.server.config.MetricsConfig#reservoirWindow()
+ */
+ @Override
+ public Duration reservoirWindow() {
+ return reservoirWindow;
+ }
+
+ /* (non-Javadoc)
+ * @see com.google.gerrit.server.config.MetricsConfig#reservoirSize()
+ */
+ @Override
+ public int reservoirSize() {
+ return reservoirSize;
+ }
+
+ /* (non-Javadoc)
+ * @see com.google.gerrit.server.config.MetricsConfig#reservoirAlpha()
+ */
+ @Override
+ public double reservoirAlpha() {
+ return reservoirAlpha;
+ }
+}
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/events/EventFactory.java b/java/com/google/gerrit/server/events/EventFactory.java
index 2b402a6..95f6d96 100644
--- a/java/com/google/gerrit/server/events/EventFactory.java
+++ b/java/com/google/gerrit/server/events/EventFactory.java
@@ -36,6 +36,7 @@
import com.google.gerrit.extensions.registration.DynamicItem;
import com.google.gerrit.index.IndexConfig;
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;
@@ -121,7 +122,7 @@
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();
@@ -129,15 +130,9 @@
a.id = change.getKey().get();
a.number = change.getId().get();
a.subject = change.getSubject();
- try {
- a.commitMessage = changeDataFactory.create(change).commitMessage();
- } catch (Exception e) {
- logger.atSevere().withCause(e).log(
- "Error while getting full commit message for change %d", a.number);
- }
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().getEpochSecond();
a.wip = change.isWorkInProgress() ? true : null;
@@ -151,12 +146,9 @@
/** Create a {@link ChangeAttribute} instance from the specified change. */
public ChangeAttribute asChangeAttribute(Change change, ChangeNotes notes) {
- ChangeAttribute a = asChangeAttribute(change);
- Set<String> hashtags = notes.load().getHashtags();
- if (!hashtags.isEmpty()) {
- a.hashtags = new ArrayList<>(hashtags.size());
- a.hashtags.addAll(hashtags);
- }
+ ChangeAttribute a = asChangeAttribute(change, (AccountAttributeLoader) null);
+ addHashTags(a, notes);
+ addCommitMessage(a, notes);
return a;
}
/**
@@ -180,25 +172,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);
@@ -209,7 +203,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) {
@@ -217,7 +212,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,13 +347,23 @@
a.commitMessage = commitMessage;
}
+ private void addCommitMessage(ChangeAttribute changeAttribute, ChangeNotes notes) {
+ try {
+ addCommitMessage(changeAttribute, changeDataFactory.create(notes).commitMessage());
+ } catch (Exception e) {
+ logger.atSevere().withCause(e).log(
+ "Error while getting full commit message for change %d", changeAttribute.number);
+ }
+ }
+
public void addPatchSets(
RevWalk revWalk,
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(
@@ -368,13 +373,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) {
@@ -385,13 +391,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));
}
}
}
@@ -421,22 +429,30 @@
}
}
- 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().getEpochSecond();
PatchSet.Id pId = patchSet.id();
try {
@@ -453,7 +469,7 @@
p.author.name = author.getName();
p.author.username = "";
} else {
- p.author = asAccountAttribute(author.getAccount());
+ p.author = asAccountAttribute(author.getAccount(), accountLoader);
}
Map<String, FileDiffOutput> modifiedFiles =
@@ -476,20 +492,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()) {
@@ -498,6 +518,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) {
@@ -529,11 +553,12 @@
* @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().getEpochSecond();
a.oldValue = null;
@@ -542,20 +567,22 @@
return a;
}
- public MessageAttribute asMessageAttribute(ChangeMessage message) {
+ public MessageAttribute asMessageAttribute(
+ ChangeMessage message, AccountAttributeLoader accountLoader) {
MessageAttribute a = new MessageAttribute();
a.timestamp = message.getWrittenOn().getEpochSecond();
a.reviewer =
message.getAuthor() != null
- ? asAccountAttribute(message.getAuthor())
+ ? asAccountAttribute(message.getAuthor(), accountLoader)
: asAccountAttribute(myIdent.get());
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;
@@ -569,4 +596,12 @@
}
return null;
}
+
+ private void addHashTags(ChangeAttribute changeAttribute, ChangeNotes notes) {
+ Set<String> hashtags = notes.load().getHashtags();
+ if (!hashtags.isEmpty()) {
+ changeAttribute.hashtags = new ArrayList<>(hashtags.size());
+ changeAttribute.hashtags.addAll(hashtags);
+ }
+ }
}
diff --git a/java/com/google/gerrit/server/events/EventTypes.java b/java/com/google/gerrit/server/events/EventTypes.java
index 5498ec8..229ef86 100644
--- a/java/com/google/gerrit/server/events/EventTypes.java
+++ b/java/com/google/gerrit/server/events/EventTypes.java
@@ -14,6 +14,7 @@
package com.google.gerrit.server.events;
+import com.google.common.collect.ImmutableMap;
import java.util.HashMap;
import java.util.Map;
@@ -61,4 +62,15 @@
public static Class<?> getClass(String type) {
return typesByString.get(type);
}
+
+ /**
+ * Get a copy of all currently registered events.
+ *
+ * <p>The key is the one given to the evenType parameter of the {@link #register} method.
+ *
+ * @return ImmutableMap of event types, Event classes.
+ */
+ public static Map<String, Class<?>> getRegisteredEvents() {
+ return ImmutableMap.copyOf(typesByString);
+ }
}
diff --git a/java/com/google/gerrit/server/experiments/ExperimentFeaturesConstants.java b/java/com/google/gerrit/server/experiments/ExperimentFeaturesConstants.java
index 86a9f69..ffeb44b 100644
--- a/java/com/google/gerrit/server/experiments/ExperimentFeaturesConstants.java
+++ b/java/com/google/gerrit/server/experiments/ExperimentFeaturesConstants.java
@@ -22,6 +22,8 @@
/** Features that are known experiments and can be referenced in the code. */
public static String UI_FEATURE_PATCHSET_COMMENTS = "UiFeature__patchset_comments";
+ public static String UI_FEATURE_SUBMIT_REQUIREMENTS_UI = "UiFeature__submit_requirements_ui";
+
public static String GERRIT_BACKEND_REQUEST_FEATURE_REMOVE_REVISION_ETAG =
"GerritBackendRequestFeature__remove_revision_etag";
@@ -34,5 +36,5 @@
/** Features, enabled by default in the current release. */
public static final ImmutableSet<String> DEFAULT_ENABLED_FEATURES =
- ImmutableSet.of(UI_FEATURE_PATCHSET_COMMENTS);
+ ImmutableSet.of(UI_FEATURE_PATCHSET_COMMENTS, UI_FEATURE_SUBMIT_REQUIREMENTS_UI);
}
diff --git a/java/com/google/gerrit/server/git/DelegateRepository.java b/java/com/google/gerrit/server/git/DelegateRepository.java
index d839bce..9046d9d 100644
--- a/java/com/google/gerrit/server/git/DelegateRepository.java
+++ b/java/com/google/gerrit/server/git/DelegateRepository.java
@@ -65,7 +65,8 @@
this.delegate = delegate;
}
- Repository delegate() {
+ /** Returns the wrapped {@link Repository} instance. */
+ public Repository delegate() {
return delegate;
}
diff --git a/java/com/google/gerrit/server/git/RefCache.java b/java/com/google/gerrit/server/git/RefCache.java
index 5a5cae9..2dee427 100644
--- a/java/com/google/gerrit/server/git/RefCache.java
+++ b/java/com/google/gerrit/server/git/RefCache.java
@@ -37,4 +37,7 @@
* present with a value of {@link ObjectId#zeroId()}.
*/
Optional<ObjectId> get(String refName) throws IOException;
+
+ /** Closes this cache, releasing the references to any underlying resources. */
+ void close();
}
diff --git a/java/com/google/gerrit/server/git/RepoRefCache.java b/java/com/google/gerrit/server/git/RepoRefCache.java
index c69f9a6..d2b3c32 100644
--- a/java/com/google/gerrit/server/git/RepoRefCache.java
+++ b/java/com/google/gerrit/server/git/RepoRefCache.java
@@ -28,8 +28,11 @@
public class RepoRefCache implements RefCache {
private final RefDatabase refdb;
private final Map<String, Optional<ObjectId>> ids;
+ private final Repository repo;
public RepoRefCache(Repository repo) {
+ repo.incrementOpen();
+ this.repo = repo;
this.refdb = repo.getRefDatabase();
this.ids = new HashMap<>();
}
@@ -50,4 +53,9 @@
public Map<String, Optional<ObjectId>> getCachedRefs() {
return Collections.unmodifiableMap(ids);
}
+
+ @Override
+ public void close() {
+ repo.close();
+ }
}
diff --git a/java/com/google/gerrit/server/git/SearchingChangeCacheImpl.java b/java/com/google/gerrit/server/git/SearchingChangeCacheImpl.java
index ff5bcc2..e2f9abd 100644
--- a/java/com/google/gerrit/server/git/SearchingChangeCacheImpl.java
+++ b/java/com/google/gerrit/server/git/SearchingChangeCacheImpl.java
@@ -45,6 +45,7 @@
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ExecutionException;
+import java.util.stream.Stream;
/**
* Cache based on an index query of the most recent changes. The number of cached items depends on
@@ -116,22 +117,23 @@
* Additional stored fields are not loaded from the index.
*
* @param project project to read.
- * @return list of known changes; empty if no changes.
+ * @return stream of known changes; empty if no changes.
*/
- public List<ChangeData> getChangeData(Project.NameKey project) {
+ public Stream<ChangeData> getChangeData(Project.NameKey project) {
+ List<CachedChange> cached;
try {
- List<CachedChange> cached = cache.get(project);
- List<ChangeData> cds = new ArrayList<>(cached.size());
- for (CachedChange cc : cached) {
- ChangeData cd = changeDataFactory.create(cc.change());
- cd.setReviewers(cc.reviewers());
- cds.add(cd);
- }
- return Collections.unmodifiableList(cds);
+ cached = cache.get(project);
} catch (ExecutionException e) {
logger.atWarning().withCause(e).log("Cannot fetch changes for %s", project);
- return Collections.emptyList();
+ return Stream.empty();
}
+ return cached.stream()
+ .map(
+ cc -> {
+ ChangeData cd = changeDataFactory.create(cc.change());
+ cd.setReviewers(cc.reviewers());
+ return cd;
+ });
}
@Override
diff --git a/java/com/google/gerrit/server/git/receive/AsyncReceiveCommits.java b/java/com/google/gerrit/server/git/receive/AsyncReceiveCommits.java
index 718eec2..dd5af2c 100644
--- a/java/com/google/gerrit/server/git/receive/AsyncReceiveCommits.java
+++ b/java/com/google/gerrit/server/git/receive/AsyncReceiveCommits.java
@@ -36,6 +36,7 @@
import com.google.gerrit.metrics.Timer1;
import com.google.gerrit.server.IdentifiedUser;
import com.google.gerrit.server.PublishCommentsOp;
+import com.google.gerrit.server.cache.PerThreadCache;
import com.google.gerrit.server.config.AllUsersName;
import com.google.gerrit.server.config.ConfigUtil;
import com.google.gerrit.server.config.GerritServerConfig;
@@ -385,7 +386,7 @@
() -> {
String oldName = Thread.currentThread().getName();
Thread.currentThread().setName(oldName + "-for-" + currentThreadName);
- try {
+ try (PerThreadCache threadLocalCache = PerThreadCache.create()) {
return receiveCommits.processCommands(commands, monitor);
} finally {
Thread.currentThread().setName(oldName);
diff --git a/java/com/google/gerrit/server/git/receive/ReceiveCommits.java b/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
index 889dfd6..f212384 100644
--- a/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
+++ b/java/com/google/gerrit/server/git/receive/ReceiveCommits.java
@@ -1457,7 +1457,7 @@
// Must pass explicit user instead of injecting a provider into CreateRefControl, since
// Provider<CurrentUser> within ReceiveCommits will always return anonymous.
createRefControl.checkCreateRef(
- Providers.of(user), receivePack.getRepository(), branch, obj);
+ Providers.of(user), receivePack.getRepository(), branch, obj, /* forPush= */ true);
} catch (AuthException denied) {
rejectProhibited(cmd, denied);
return;
@@ -3486,7 +3486,7 @@
rw.markStart(newTip);
rw.markUninteresting(rw.parseCommit(cmd.getOldId()));
- Map<Change.Key, ChangeNotes> byKey = null;
+ Map<Change.Key, ChangeData> changeDataByKey = null;
List<ReplaceRequest> replaceAndClose = new ArrayList<>();
int existingPatchSets = 0;
@@ -3522,8 +3522,8 @@
for (String changeId :
ChangeUtil.getChangeIdsFromFooter(c, urlFormatter.get())) {
- if (byKey == null) {
- byKey =
+ if (changeDataByKey == null) {
+ changeDataByKey =
retryHelper
.changeIndexQuery(
"queryOpenChangesByKeyByBranch",
@@ -3531,14 +3531,15 @@
.call();
}
- ChangeNotes onto = byKey.get(Change.key(changeId.trim()));
+ ChangeData onto = changeDataByKey.get(Change.key(changeId.trim()));
if (onto != null) {
newPatchSets++;
// Hold onto this until we're done with the walk, as the call to
// req.validate below calls isMergedInto which resets the walk.
+ ChangeNotes ontoNotes = onto.notes();
ReplaceRequest req =
- new ReplaceRequest(onto.getChangeId(), c, cmd, false);
- req.notes = onto;
+ new ReplaceRequest(ontoNotes.getChangeId(), c, cmd, false);
+ req.notes = ontoNotes;
replaceAndClose.add(req);
continue COMMIT;
}
@@ -3611,14 +3612,17 @@
}
}
- private Map<Change.Key, ChangeNotes> openChangesByKeyByBranch(
+ private Map<Change.Key, ChangeData> openChangesByKeyByBranch(
InternalChangeQuery internalChangeQuery, BranchNameKey branch) {
try (TraceTimer traceTimer =
newTimer("openChangesByKeyByBranch", Metadata.builder().branchName(branch.branch()))) {
- Map<Change.Key, ChangeNotes> r = new HashMap<>();
+ Map<Change.Key, ChangeData> r = new HashMap<>();
for (ChangeData cd : internalChangeQuery.byBranchOpen(branch)) {
try {
- r.put(cd.change().getKey(), cd.notes());
+ // ChangeData is not materialised into a ChangeNotes for avoiding
+ // to load a potentially large number of changes meta-data into memory
+ // which would cause unnecessary disk I/O, CPU and heap utilisation.
+ r.put(cd.change().getKey(), cd);
} catch (NoSuchChangeException e) {
// Ignore deleted change
}
diff --git a/java/com/google/gerrit/server/git/validators/AccountValidator.java b/java/com/google/gerrit/server/git/validators/AccountValidator.java
index 873f421..b38f405 100644
--- a/java/com/google/gerrit/server/git/validators/AccountValidator.java
+++ b/java/com/google/gerrit/server/git/validators/AccountValidator.java
@@ -91,7 +91,7 @@
return ImmutableList.of(String.format("account '%s' does not exist", accountId.get()));
}
- if (accountId.equals(self.get().getAccountId()) && !newAccount.get().isActive()) {
+ if (!newAccount.get().isActive() && accountId.equals(self.get().getAccountId())) {
messages.add("cannot deactivate own account");
}
diff --git a/java/com/google/gerrit/server/group/testing/TestGroupBackend.java b/java/com/google/gerrit/server/group/testing/TestGroupBackend.java
index 601ac59..12d8c93 100644
--- a/java/com/google/gerrit/server/group/testing/TestGroupBackend.java
+++ b/java/com/google/gerrit/server/group/testing/TestGroupBackend.java
@@ -118,6 +118,13 @@
@Override
public Collection<GroupReference> suggest(String name, ProjectState project) {
+ AccountGroup.UUID uuid = AccountGroup.uuid(name);
+ if (handles(uuid)) {
+ GroupDescription.Basic g = get(uuid);
+ if (g != null) {
+ return ImmutableList.of(GroupReference.forGroup(g));
+ }
+ }
return ImmutableList.of();
}
diff --git a/java/com/google/gerrit/server/index/change/ChangeField.java b/java/com/google/gerrit/server/index/change/ChangeField.java
index c06347e..ee272b7 100644
--- a/java/com/google/gerrit/server/index/change/ChangeField.java
+++ b/java/com/google/gerrit/server/index/change/ChangeField.java
@@ -83,6 +83,7 @@
import java.sql.Timestamp;
import java.time.Instant;
import java.util.ArrayList;
+import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
@@ -114,6 +115,12 @@
private static final Gson GSON = OutputFormat.JSON_COMPACT.newGson();
+ /**
+ * To avoid the non-google dependency on org.apache.lucene.index.IndexWriter.MAX_TERM_LENGTH it is
+ * redefined here.
+ */
+ public static final int MAX_TERM_LENGTH = (1 << 15) - 2;
+
// TODO: Rename LEGACY_ID to NUMERIC_ID
/** Legacy change ID. */
public static final FieldDef<ChangeData, Integer> LEGACY_ID =
@@ -873,7 +880,8 @@
/** Commit message of the current patch set. */
public static final FieldDef<ChangeData, String> COMMIT_MESSAGE_EXACT =
- exact(ChangeQueryBuilder.FIELD_MESSAGE_EXACT).build(ChangeData::commitMessage);
+ exact(ChangeQueryBuilder.FIELD_MESSAGE_EXACT)
+ .build(cd -> truncateStringValueToMaxTermLength(cd.commitMessage()));
/** Summary or inline comment. */
public static final FieldDef<ChangeData, Iterable<String>> COMMENT =
@@ -1394,4 +1402,46 @@
private static AllUsersName allUsers(ChangeData cd) {
return cd.getAllUsersNameForIndexing();
}
+
+ private static String truncateStringValueToMaxTermLength(String str) {
+ return truncateStringValue(str, MAX_TERM_LENGTH);
+ }
+
+ @VisibleForTesting
+ static String truncateStringValue(String str, int maxBytes) {
+ if (maxBytes < 0) {
+ throw new IllegalArgumentException("maxBytes < 0 not allowed");
+ }
+
+ if (maxBytes == 0) {
+ return "";
+ }
+
+ if (str.length() > maxBytes) {
+ if (Character.isHighSurrogate(str.charAt(maxBytes - 1))) {
+ str = str.substring(0, maxBytes - 1);
+ } else {
+ str = str.substring(0, maxBytes);
+ }
+ }
+ byte[] strBytes = str.getBytes(UTF_8);
+ if (strBytes.length > maxBytes) {
+ while (maxBytes > 0 && (strBytes[maxBytes] & 0xC0) == 0x80) {
+ maxBytes -= 1;
+ }
+ if (maxBytes > 0) {
+ if (strBytes.length >= maxBytes && (strBytes[maxBytes - 1] & 0xE0) == 0xC0) {
+ maxBytes -= 1;
+ }
+ if (strBytes.length >= maxBytes && (strBytes[maxBytes - 1] & 0xF0) == 0xE0) {
+ maxBytes -= 1;
+ }
+ if (strBytes.length >= maxBytes && (strBytes[maxBytes - 1] & 0xF8) == 0xF0) {
+ maxBytes -= 1;
+ }
+ }
+ return new String(Arrays.copyOfRange(strBytes, 0, maxBytes), UTF_8);
+ }
+ return str;
+ }
}
diff --git a/java/com/google/gerrit/server/index/change/ChangeIndexRewriter.java b/java/com/google/gerrit/server/index/change/ChangeIndexRewriter.java
index d57f800..16e442c 100644
--- a/java/com/google/gerrit/server/index/change/ChangeIndexRewriter.java
+++ b/java/com/google/gerrit/server/index/change/ChangeIndexRewriter.java
@@ -283,7 +283,7 @@
private Predicate<ChangeData> copy(Predicate<ChangeData> in, List<Predicate<ChangeData>> all) {
if (in instanceof AndPredicate) {
- return new AndChangeSource(all);
+ return new AndChangeSource(all, config);
} else if (in instanceof OrPredicate) {
return new OrSource(all);
}
diff --git a/java/com/google/gerrit/server/index/change/IndexedChangeQuery.java b/java/com/google/gerrit/server/index/change/IndexedChangeQuery.java
index b804c4c..339d7bb 100644
--- a/java/com/google/gerrit/server/index/change/IndexedChangeQuery.java
+++ b/java/com/google/gerrit/server/index/change/IndexedChangeQuery.java
@@ -34,6 +34,7 @@
import com.google.gerrit.index.query.ResultSet;
import com.google.gerrit.server.query.change.ChangeData;
import com.google.gerrit.server.query.change.ChangeDataSource;
+import com.google.gerrit.server.query.change.ChangeIndexPostFilterPredicate;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
@@ -51,24 +52,40 @@
public class IndexedChangeQuery extends IndexedQuery<Change.Id, ChangeData>
implements ChangeDataSource, Matchable<ChangeData> {
public static QueryOptions oneResult() {
- return createOptions(IndexConfig.createDefault(), 0, 1, ImmutableSet.of());
+ IndexConfig config = IndexConfig.createDefault();
+ return createOptions(config, 0, 1, config.pageSizeMultiplier(), 1, ImmutableSet.of());
}
public static QueryOptions createOptions(
IndexConfig config, int start, int limit, Set<String> fields) {
+ return createOptions(config, start, limit, config.pageSizeMultiplier(), limit, fields);
+ }
+
+ public static QueryOptions createOptions(
+ IndexConfig config,
+ int start,
+ int pageSize,
+ int pageSizeMultiplier,
+ int limit,
+ Set<String> fields) {
// Always include project since it is needed to load the change from NoteDb.
if (!fields.contains(CHANGE.getName()) && !fields.contains(PROJECT.getName())) {
fields = new HashSet<>(fields);
fields.add(PROJECT.getName());
}
- return QueryOptions.create(config, start, limit, fields);
+ return QueryOptions.create(config, start, pageSize, pageSizeMultiplier, limit, fields);
}
@VisibleForTesting
static QueryOptions convertOptions(QueryOptions opts) {
opts = opts.convertForBackend();
return IndexedChangeQuery.createOptions(
- opts.config(), opts.start(), opts.limit(), opts.fields());
+ opts.config(),
+ opts.start(),
+ opts.pageSize(),
+ opts.pageSizeMultiplier(),
+ opts.limit(),
+ opts.fields());
}
private final Map<ChangeData, DataSource<ChangeData>> fromSource;
@@ -109,16 +126,38 @@
public void close() {
rs.close();
}
+
+ @Override
+ public Object searchAfter() {
+ return rs.searchAfter();
+ }
};
}
+ public boolean postIndexMatch(Predicate<ChangeData> pred, ChangeData cd) {
+ if (pred instanceof ChangeIndexPostFilterPredicate) {
+ checkState(
+ pred.isMatchable(),
+ "match invoked, but child predicate %s doesn't implement %s",
+ pred,
+ Matchable.class.getName());
+ return pred.asMatchable().match(cd);
+ }
+ for (int i = 0; i < pred.getChildCount(); i++) {
+ if (!postIndexMatch(pred.getChild(i), cd)) {
+ return false;
+ }
+ }
+ return true;
+ }
+
@Override
public boolean match(ChangeData cd) {
- if (source != null && fromSource.get(cd) == source) {
+ Predicate<ChangeData> pred = getChild(0);
+ if (source != null && fromSource.get(cd) == source && postIndexMatch(pred, cd)) {
return true;
}
- Predicate<ChangeData> pred = getChild(0);
checkState(
pred.isMatchable(),
"match invoked, but child predicate %s doesn't implement %s",
diff --git a/java/com/google/gerrit/server/index/group/IndexedGroupQuery.java b/java/com/google/gerrit/server/index/group/IndexedGroupQuery.java
index 90070b6..8b0f1f8 100644
--- a/java/com/google/gerrit/server/index/group/IndexedGroupQuery.java
+++ b/java/com/google/gerrit/server/index/group/IndexedGroupQuery.java
@@ -34,13 +34,13 @@
implements DataSource<InternalGroup> {
public static QueryOptions createOptions(
- IndexConfig config, int start, int limit, Set<String> fields) {
+ IndexConfig config, int start, int pageSize, int limit, Set<String> fields) {
// Always include GroupField.UUID since it is needed to load the group from NoteDb.
if (!fields.contains(GroupField.UUID.getName())) {
fields = new HashSet<>(fields);
fields.add(GroupField.UUID.getName());
}
- return QueryOptions.create(config, start, limit, fields);
+ return QueryOptions.create(config, start, pageSize, limit, fields);
}
public IndexedGroupQuery(
diff --git a/java/com/google/gerrit/server/index/group/StalenessChecker.java b/java/com/google/gerrit/server/index/group/StalenessChecker.java
index 4ce3f5b..4e992cb 100644
--- a/java/com/google/gerrit/server/index/group/StalenessChecker.java
+++ b/java/com/google/gerrit/server/index/group/StalenessChecker.java
@@ -66,7 +66,7 @@
}
Optional<FieldBundle> result =
- i.getRaw(uuid, IndexedGroupQuery.createOptions(indexConfig, 0, 1, FIELDS));
+ i.getRaw(uuid, IndexedGroupQuery.createOptions(indexConfig, 0, 1, 1, FIELDS));
if (!result.isPresent()) {
// The document is missing in the index.
try (Repository repo = repoManager.openRepository(allUsers)) {
diff --git a/java/com/google/gerrit/server/logging/LoggingContext.java b/java/com/google/gerrit/server/logging/LoggingContext.java
index 3907da5..eac96a6 100644
--- a/java/com/google/gerrit/server/logging/LoggingContext.java
+++ b/java/com/google/gerrit/server/logging/LoggingContext.java
@@ -90,8 +90,9 @@
return tags.get() == null
&& forceLogging.get() == null
&& performanceLogging.get() == null
+ && (performanceLogRecords.get() == null || performanceLogRecords.get().isEmtpy())
&& aclLogging.get() == null
- && aclLogRecords.get() == null;
+ && (aclLogRecords.get() == null || aclLogRecords.get().isEmpty());
}
public void clear() {
diff --git a/java/com/google/gerrit/server/logging/MutableAclLogRecords.java b/java/com/google/gerrit/server/logging/MutableAclLogRecords.java
index baa9b1f..a692d2b 100644
--- a/java/com/google/gerrit/server/logging/MutableAclLogRecords.java
+++ b/java/com/google/gerrit/server/logging/MutableAclLogRecords.java
@@ -45,6 +45,10 @@
return ImmutableList.copyOf(aclLogRecords);
}
+ public boolean isEmpty() {
+ return aclLogRecords.isEmpty();
+ }
+
@Override
public String toString() {
return MoreObjects.toStringHelper(this).add("aclLogRecords", aclLogRecords).toString();
diff --git a/java/com/google/gerrit/server/logging/MutablePerformanceLogRecords.java b/java/com/google/gerrit/server/logging/MutablePerformanceLogRecords.java
index 4ee70d7..2965719 100644
--- a/java/com/google/gerrit/server/logging/MutablePerformanceLogRecords.java
+++ b/java/com/google/gerrit/server/logging/MutablePerformanceLogRecords.java
@@ -46,6 +46,10 @@
return ImmutableList.copyOf(performanceLogRecords);
}
+ public boolean isEmtpy() {
+ return performanceLogRecords.isEmpty();
+ }
+
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
diff --git a/java/com/google/gerrit/server/logging/PerformanceLogContext.java b/java/com/google/gerrit/server/logging/PerformanceLogContext.java
index 65e033b15..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()));
diff --git a/java/com/google/gerrit/server/mail/send/MailSoySauceLoader.java b/java/com/google/gerrit/server/mail/send/MailSoySauceLoader.java
index ad1703d..8ee8fc2 100644
--- a/java/com/google/gerrit/server/mail/send/MailSoySauceLoader.java
+++ b/java/com/google/gerrit/server/mail/send/MailSoySauceLoader.java
@@ -14,8 +14,9 @@
package com.google.gerrit.server.mail.send;
+import static com.google.common.base.Preconditions.checkArgument;
+
import com.google.common.io.CharStreams;
-import com.google.common.io.Resources;
import com.google.gerrit.server.config.SitePaths;
import com.google.gerrit.server.plugincontext.PluginSetContext;
import com.google.inject.Inject;
@@ -26,6 +27,7 @@
import com.google.template.soy.shared.SoyAstCache;
import java.io.IOException;
import java.io.Reader;
+import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
@@ -137,6 +139,8 @@
}
// Otherwise load the template as a resource.
- builder.add(Resources.getResource(logicalPath), logicalPath);
+ URL resource = this.getClass().getClassLoader().getResource(logicalPath);
+ checkArgument(resource != null, "resource %s not found.", logicalPath);
+ builder.add(resource, logicalPath);
}
}
diff --git a/java/com/google/gerrit/server/notedb/ChangeNoteJson.java b/java/com/google/gerrit/server/notedb/ChangeNoteJson.java
index 37a38fe..0f1d362c 100644
--- a/java/com/google/gerrit/server/notedb/ChangeNoteJson.java
+++ b/java/com/google/gerrit/server/notedb/ChangeNoteJson.java
@@ -18,6 +18,7 @@
import com.google.gerrit.entities.EntitiesAdapterFactory;
import com.google.gerrit.json.EnumTypeAdapterFactory;
import com.google.gerrit.json.OptionalSubmitRequirementExpressionResultAdapterFactory;
+import com.google.gerrit.json.OptionalTypeAdapter;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
@@ -52,6 +53,7 @@
static Gson newGson() {
return new GsonBuilder()
+ .registerTypeAdapter(Optional.class, new OptionalTypeAdapter())
.registerTypeAdapter(Timestamp.class, new CommentTimestampAdapter().nullSafe())
.registerTypeAdapterFactory(new EnumTypeAdapterFactory())
.registerTypeAdapterFactory(EntitiesAdapterFactory.create())
diff --git a/java/com/google/gerrit/server/notedb/RepoSequence.java b/java/com/google/gerrit/server/notedb/RepoSequence.java
index 47e12ff..d743921 100644
--- a/java/com/google/gerrit/server/notedb/RepoSequence.java
+++ b/java/com/google/gerrit/server/notedb/RepoSequence.java
@@ -340,4 +340,16 @@
counterLock.unlock();
}
}
+
+ /**
+ * Retrieves the last returned sequence number.
+ *
+ * <p>Explicitly calls {@link #next()} if this instance didn't return sequence number until now.
+ */
+ public int last() {
+ if (counter == 0) {
+ next();
+ }
+ return counter - 1;
+ }
}
diff --git a/java/com/google/gerrit/server/notedb/Sequences.java b/java/com/google/gerrit/server/notedb/Sequences.java
index 7ae98778..b42253e 100644
--- a/java/com/google/gerrit/server/notedb/Sequences.java
+++ b/java/com/google/gerrit/server/notedb/Sequences.java
@@ -55,6 +55,9 @@
private final RepoSequence changeSeq;
private final RepoSequence groupSeq;
private final Timer2<SequenceType, Boolean> nextIdLatency;
+ private final int accountBatchSize;
+ private final int changeBatchSize;
+ private final int groupBatchSize = 1;
@Inject
public Sequences(
@@ -65,7 +68,7 @@
AllUsersName allUsers,
MetricMaker metrics) {
- int accountBatchSize =
+ accountBatchSize =
cfg.getInt(
SECTION_NOTEDB,
NAME_ACCOUNTS,
@@ -80,7 +83,7 @@
() -> FIRST_ACCOUNT_ID,
accountBatchSize);
- int changeBatchSize =
+ changeBatchSize =
cfg.getInt(
SECTION_NOTEDB,
NAME_CHANGES,
@@ -95,7 +98,6 @@
() -> FIRST_CHANGE_ID,
changeBatchSize);
- int groupBatchSize = 1;
groupSeq =
new RepoSequence(
repoManager,
@@ -147,6 +149,18 @@
}
}
+ public int changeBatchSize() {
+ return changeBatchSize;
+ }
+
+ public int groupBatchSize() {
+ return groupBatchSize;
+ }
+
+ public int accountBatchSize() {
+ return accountBatchSize;
+ }
+
public int currentChangeId() {
return changeSeq.current();
}
@@ -159,6 +173,18 @@
return groupSeq.current();
}
+ public int lastChangeId() {
+ return changeSeq.last();
+ }
+
+ public int lastGroupId() {
+ return groupSeq.last();
+ }
+
+ public int lastAccountId() {
+ return accountSeq.last();
+ }
+
public void setChangeIdValue(int value) {
changeSeq.storeNew(value);
}
diff --git a/java/com/google/gerrit/server/permissions/DefaultPermissionBackendModule.java b/java/com/google/gerrit/server/permissions/DefaultPermissionBackendModule.java
index d2e85be..3f84dff 100644
--- a/java/com/google/gerrit/server/permissions/DefaultPermissionBackendModule.java
+++ b/java/com/google/gerrit/server/permissions/DefaultPermissionBackendModule.java
@@ -31,7 +31,6 @@
// TODO(hiesel) Hide ProjectControl, RefControl, ChangeControl related bindings.
factory(ProjectControl.Factory.class);
factory(DefaultRefFilter.Factory.class);
- factory(VisibleChangesCache.Factory.class);
}
}
}
diff --git a/java/com/google/gerrit/server/permissions/DefaultRefFilter.java b/java/com/google/gerrit/server/permissions/DefaultRefFilter.java
index 4f10528..eebaa8f 100644
--- a/java/com/google/gerrit/server/permissions/DefaultRefFilter.java
+++ b/java/com/google/gerrit/server/permissions/DefaultRefFilter.java
@@ -15,18 +15,22 @@
package com.google.gerrit.server.permissions;
import static com.google.common.base.Preconditions.checkState;
+import static com.google.common.collect.ImmutableSet.toImmutableSet;
import static com.google.common.flogger.LazyArgs.lazy;
import static com.google.gerrit.entities.RefNames.REFS_CONFIG;
import static java.util.stream.Collectors.toCollection;
import com.google.auto.value.AutoValue;
+import com.google.common.base.Supplier;
+import com.google.common.base.Suppliers;
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.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.RefNames;
-import com.google.gerrit.exceptions.StorageException;
import com.google.gerrit.metrics.Counter0;
import com.google.gerrit.metrics.Description;
import com.google.gerrit.metrics.MetricMaker;
@@ -40,12 +44,14 @@
import com.google.gerrit.server.notedb.ChangeNotes;
import com.google.gerrit.server.permissions.PermissionBackend.RefFilterOptions;
import com.google.gerrit.server.project.ProjectState;
+import com.google.gerrit.server.query.change.ChangeData;
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.List;
+import java.util.Objects;
import java.util.stream.Collectors;
import org.eclipse.jgit.lib.Config;
import org.eclipse.jgit.lib.Constants;
@@ -60,38 +66,39 @@
}
private final TagCache tagCache;
- private final ChangeNotes.Factory changeNotesFactory;
private final PermissionBackend permissionBackend;
private final RefVisibilityControl refVisibilityControl;
private final ProjectControl projectControl;
private final CurrentUser user;
private final ProjectState projectState;
private final PermissionBackend.ForProject permissionBackendForProject;
+ private final @Nullable SearchingChangeCacheImpl searchingChangeDataProvider;
+ private final ChangeData.Factory changeDataFactory;
+ private final ChangeNotes.Factory changeNotesFactory;
private final Counter0 fullFilterCount;
private final Counter0 skipFilterCount;
private final boolean skipFullRefEvaluationIfAllRefsAreVisible;
- private final VisibleChangesCache.Factory visibleChangesCacheFactory;
-
- private VisibleChangesCache visibleChangesCache;
@Inject
DefaultRefFilter(
TagCache tagCache,
- ChangeNotes.Factory changeNotesFactory,
PermissionBackend permissionBackend,
RefVisibilityControl refVisibilityControl,
@GerritServerConfig Config config,
MetricMaker metricMaker,
- VisibleChangesCache.Factory visibleChangesCacheFactory,
+ @Nullable SearchingChangeCacheImpl searchingChangeDataProvider,
+ ChangeData.Factory changeDataFactory,
+ ChangeNotes.Factory changeNotesFactory,
@Assisted ProjectControl projectControl) {
this.tagCache = tagCache;
- this.changeNotesFactory = changeNotesFactory;
this.permissionBackend = permissionBackend;
this.refVisibilityControl = refVisibilityControl;
+ this.searchingChangeDataProvider = searchingChangeDataProvider;
+ this.changeDataFactory = changeDataFactory;
+ this.changeNotesFactory = changeNotesFactory;
this.skipFullRefEvaluationIfAllRefsAreVisible =
config.getBoolean("auth", "skipFullRefEvaluationIfAllRefsAreVisible", true);
this.projectControl = projectControl;
- this.visibleChangesCacheFactory = visibleChangesCacheFactory;
this.user = projectControl.getUser();
this.projectState = projectControl.getProjectState();
@@ -113,7 +120,6 @@
/** Filters given refs and tags by visibility. */
ImmutableList<Ref> filter(Collection<Ref> refs, Repository repo, RefFilterOptions opts)
throws PermissionBackendException {
- visibleChangesCache = visibleChangesCacheFactory.create(projectControl, repo);
logger.atFinest().log(
"Filter refs for repository %s by visibility (options = %s, refs = %s)",
projectState.getNameKey(), opts, refs);
@@ -126,33 +132,26 @@
"Project state %s permits read = %s",
projectState.getProject().getState(), projectState.statePermitsRead());
- // See if we can get away with a single, cheap ref evaluation.
- if (refs.size() == 1) {
- String refName = Iterables.getOnlyElement(refs).getName();
- if (opts.filterMeta() && isMetadata(refName)) {
- logger.atFinest().log("Filter out metadata ref %s", refName);
- return ImmutableList.of();
- }
- if (RefNames.isRefsChanges(refName)) {
- boolean isChangeRefVisisble = canSeeSingleChangeRef(repo, refName);
- if (isChangeRefVisisble) {
- logger.atFinest().log("Change ref %s is visible", refName);
- return ImmutableList.copyOf(refs);
- }
- logger.atFinest().log("Filter out non-visible change ref %s", refName);
- return ImmutableList.of();
- }
- }
-
// Perform an initial ref filtering with all the refs the caller asked for. If we find tags that
// we have to investigate separately (deferred tags) then perform a reachability check starting
// from all visible branches (refs/heads/*).
- Result initialRefFilter = filterRefs(new ArrayList<>(refs), opts);
+ Supplier<ImmutableMap<Change.Id, ChangeData>> visibleChanges =
+ Suppliers.memoize(
+ () ->
+ GitVisibleChangeFilter.getVisibleChanges(
+ searchingChangeDataProvider,
+ changeNotesFactory,
+ changeDataFactory,
+ projectState.getNameKey(),
+ permissionBackendForProject,
+ repo,
+ changes(refs)));
+ Result initialRefFilter = filterRefs(new ArrayList<>(refs), opts, visibleChanges);
ImmutableList.Builder<Ref> visibleRefs = ImmutableList.builder();
visibleRefs.addAll(initialRefFilter.visibleRefs());
if (!initialRefFilter.deferredTags().isEmpty()) {
try (TraceTimer traceTimer = TraceContext.newTimer("Check visibility of deferred tags")) {
- Result allVisibleBranches = filterRefs(getTaggableRefs(repo), opts);
+ Result allVisibleBranches = filterRefs(getTaggableRefs(repo), opts, visibleChanges);
checkState(
allVisibleBranches.deferredTags().isEmpty(),
"unexpected tags found when filtering refs/heads/* "
@@ -187,15 +186,22 @@
* separately for later rev-walk-based visibility computation. Tags where visibility is trivial to
* compute will be returned as part of {@link Result#visibleRefs()}.
*/
- Result filterRefs(List<Ref> refs, RefFilterOptions opts) throws PermissionBackendException {
+ Result filterRefs(
+ List<Ref> refs,
+ RefFilterOptions opts,
+ Supplier<ImmutableMap<Change.Id, ChangeData>> visibleChanges)
+ throws PermissionBackendException {
logger.atFinest().log("Filter refs (refs = %s)", refs);
+ if (!projectState.statePermitsRead()) {
+ return new AutoValue_DefaultRefFilter_Result(ImmutableList.of(), ImmutableList.of());
+ }
// TODO(hiesel): Remove when optimization is done.
boolean hasReadOnRefsStar =
checkProjectPermission(permissionBackendForProject, ProjectPermission.READ);
logger.atFinest().log("User has READ on refs/* = %s", hasReadOnRefsStar);
if (skipFullRefEvaluationIfAllRefsAreVisible && !projectState.isAllUsers()) {
- if (projectState.statePermitsRead() && hasReadOnRefsStar) {
+ if (hasReadOnRefsStar) {
skipFilterCount.increment();
logger.atFinest().log(
"Fast path, all refs are visible because user has READ on refs/*: %s", refs);
@@ -254,9 +260,9 @@
// most recent changes).
if (hasAccessDatabase) {
resultRefs.add(ref);
- } else if (!visibleChangesCache.isVisible(changeId)) {
+ } else if (!visibleChanges.get().containsKey(changeId)) {
logger.atFinest().log("Filter out invisible change ref %s", refName);
- } else if (RefNames.isRefsEdit(refName) && !visibleEdit(refName)) {
+ } else if (RefNames.isRefsEdit(refName) && !visibleEdit(refName, visibleChanges.get())) {
logger.atFinest().log("Filter out invisible change edit ref %s", refName);
} else {
// Change is visible
@@ -294,6 +300,19 @@
}
}
+ /**
+ * Returns the number of changes contained in {@code refs}. A change has one meta ref and many
+ * patch set refs. We count over the meta refs to make sure we get the number of unique changes in
+ * the provided refs.
+ */
+ private static ImmutableSet<Change.Id> changes(Collection<Ref> refs) {
+ return refs.stream()
+ .map(Ref::getName)
+ .map(Change.Id::fromRef)
+ .filter(Objects::nonNull)
+ .collect(toImmutableSet());
+ }
+
private List<Ref> fastHideRefsMetaConfig(List<Ref> refs) throws PermissionBackendException {
if (!canReadRef(REFS_CONFIG)) {
return refs.stream()
@@ -303,7 +322,8 @@
return refs;
}
- private boolean visibleEdit(String name) throws PermissionBackendException {
+ private boolean visibleEdit(String name, ImmutableMap<Change.Id, ChangeData> visibleChanges)
+ throws PermissionBackendException {
Change.Id id = Change.Id.fromEditRefPart(name);
if (id == null) {
logger.atWarning().log("Couldn't extract change ID from edit ref %s", name);
@@ -312,17 +332,16 @@
if (user.isIdentifiedUser()
&& name.startsWith(RefNames.refsEditPrefix(user.asIdentifiedUser().getAccountId()))
- && visibleChangesCache.isVisible(id)) {
+ && visibleChanges.containsKey(id)) {
logger.atFinest().log("Own change edit ref is visible: %s", name);
return true;
}
- if (visibleChangesCache.isVisible(id)) {
+ if (visibleChanges.containsKey(id)) {
// Default to READ_PRIVATE_CHANGES as there is no special permission for reading edits.
+ BranchNameKey dest = visibleChanges.get(id).change().getDest();
boolean canRead =
- permissionBackendForProject
- .ref(visibleChangesCache.getBranchNameKey(id).branch())
- .test(RefPermission.READ_PRIVATE_CHANGES);
+ permissionBackendForProject.ref(dest.branch()).test(RefPermission.READ_PRIVATE_CHANGES);
logger.atFinest().log(
"Foreign change edit ref is " + (canRead ? "visible" : "invisible") + ": %s", name);
return canRead;
@@ -343,8 +362,7 @@
}
private boolean canReadRef(String ref) throws PermissionBackendException {
- return permissionBackendForProject.ref(ref).test(RefPermission.READ)
- && projectState.statePermitsRead();
+ return permissionBackendForProject.ref(ref).test(RefPermission.READ);
}
private boolean checkProjectPermission(
@@ -353,37 +371,6 @@
return forProject.test(perm);
}
- /**
- * Returns true if the user can see the provided change ref. Uses NoteDb for evaluation, hence
- * does not suffer from the limitations documented in {@link SearchingChangeCacheImpl}.
- *
- * <p>This code lets users fetch changes that are not among the fraction of most recently modified
- * changes that {@link SearchingChangeCacheImpl} returns. This works only when Git Protocol v2
- * with refs-in-wants is used as that enables Gerrit to skip traditional advertisement of all
- * visible refs.
- */
- private boolean canSeeSingleChangeRef(Repository repo, String refName)
- throws PermissionBackendException {
- // We are treating just a single change ref. We are therefore not going through regular ref
- // filtering, but use NoteDb directly. This makes it so that we can always serve this ref
- // even if the change is not part of the set of most recent changes that
- // SearchingChangeCacheImpl returns.
- Change.Id cId = Change.Id.fromRef(refName);
- if (cId == null) {
- // The ref is not a valid change ref. Treat it as non-visible since it's not representing a
- // change.
- logger.atWarning().log("invalid change ref %s is not visible", refName);
- return false;
- }
- ChangeNotes notes;
- try {
- notes = changeNotesFactory.create(repo, projectState.getNameKey(), cId);
- } catch (StorageException e) {
- throw new PermissionBackendException("can't construct change notes", e);
- }
- return permissionBackendForProject.change(notes).test(ChangePermission.READ);
- }
-
@AutoValue
abstract static class Result {
/** Subset of the refs passed into the computation that is visible to the user. */
diff --git a/java/com/google/gerrit/server/permissions/GitVisibleChangeFilter.java b/java/com/google/gerrit/server/permissions/GitVisibleChangeFilter.java
new file mode 100644
index 0000000..506d292
--- /dev/null
+++ b/java/com/google/gerrit/server/permissions/GitVisibleChangeFilter.java
@@ -0,0 +1,145 @@
+// 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.permissions;
+
+import static com.google.common.collect.ImmutableMap.toImmutableMap;
+
+import com.google.common.collect.ImmutableMap;
+import com.google.common.collect.ImmutableSet;
+import com.google.common.flogger.FluentLogger;
+import com.google.gerrit.common.Nullable;
+import com.google.gerrit.entities.Change;
+import com.google.gerrit.entities.Project;
+import com.google.gerrit.exceptions.StorageException;
+import com.google.gerrit.server.git.SearchingChangeCacheImpl;
+import com.google.gerrit.server.notedb.ChangeNotes;
+import com.google.gerrit.server.query.change.ChangeData;
+import java.io.IOException;
+import java.util.Objects;
+import java.util.Set;
+import java.util.function.Function;
+import java.util.stream.Stream;
+import org.eclipse.jgit.lib.Repository;
+
+/**
+ * This class can tell efficiently if changes are visible to a user. It is intended to be used when
+ * serving Git traffic on the Git wire protocol and in similar use cases when we need to know
+ * efficiently if a (potentially large number) of changes are visible to a user.
+ *
+ * <p>The efficiency of this class comes from heuristic optimization:
+ *
+ * <ul>
+ * <li>For a low number of expected checks, we check visibility one-by-one.
+ * <li>For a high number of expected checks and settings where the change index is available, we
+ * load the N most recent changes from the index and filter them by visibility. This is fast,
+ * but comes with the caveat that older changes are pretended to be invisible.
+ * <li>For a high number of expected checks and settings where the change index is unavailable, we
+ * scan the repo and determine visibility one-by-one. This is *very* expensive.
+ * </ul>
+ *
+ * <p>Changes that fail to load are pretended to be invisible. This is important on the Git paths as
+ * we don't want to advertise change refs where we were unable to check the visibility (e.g. due to
+ * data corruption on that change). At the same time, the overall operation should succeed as
+ * otherwise a single broken change would break Git operations for an entire repo.
+ */
+public class GitVisibleChangeFilter {
+ private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+
+ private static final int CHANGE_LIMIT_FOR_DIRECT_FILTERING = 5;
+
+ private GitVisibleChangeFilter() {}
+
+ /** Returns a map of all visible changes. Might pretend old changes are invisible. */
+ static ImmutableMap<Change.Id, ChangeData> getVisibleChanges(
+ @Nullable SearchingChangeCacheImpl searchingChangeCache,
+ ChangeNotes.Factory changeNotesFactory,
+ ChangeData.Factory changeDataFactory,
+ Project.NameKey projectName,
+ PermissionBackend.ForProject forProject,
+ Repository repository,
+ ImmutableSet<Change.Id> changes) {
+ Stream<ChangeData> changeDatas;
+ if (changes.size() < CHANGE_LIMIT_FOR_DIRECT_FILTERING) {
+ changeDatas = loadChangeDatasOneByOne(changes, changeDataFactory, projectName);
+ } else if (searchingChangeCache != null) {
+ changeDatas = searchingChangeCache.getChangeData(projectName);
+ } else {
+ changeDatas =
+ scanRepoForChangeDatas(changeNotesFactory, changeDataFactory, repository, projectName);
+ }
+
+ return changeDatas
+ .filter(cd -> changes.contains(cd.getId()))
+ .filter(
+ cd -> {
+ try {
+ return forProject.change(cd).test(ChangePermission.READ);
+ } catch (PermissionBackendException e) {
+ throw new StorageException(e);
+ }
+ })
+ .collect(toImmutableMap(ChangeData::getId, Function.identity()));
+ }
+
+ /** Get a stream of changes by loading them individually. */
+ private static Stream<ChangeData> loadChangeDatasOneByOne(
+ Set<Change.Id> ids, ChangeData.Factory changeDataFactory, Project.NameKey projectName) {
+ return ids.stream()
+ .map(
+ id -> {
+ try {
+ ChangeData cd = changeDataFactory.create(projectName, id);
+ cd.notes(); // Make sure notes are available. This will trigger loading notes and
+ // throw an exception in case the change is corrupt and can't be loaded. It will
+ // then be omitted from the result.
+ return cd;
+ } catch (Exception e) {
+ // We drop changes that we can't load. The repositories contain 'dead' change refs
+ // and we want to overall operation to continue.
+ logger.atFinest().withCause(e).log("Can't load Change notes for %s", id);
+ return null;
+ }
+ })
+ .filter(Objects::nonNull);
+ }
+
+ /** Get a stream of all changes by scanning the repo. This is extremely slow. */
+ private static Stream<ChangeData> scanRepoForChangeDatas(
+ ChangeNotes.Factory changeNotesFactory,
+ ChangeData.Factory changeDataFactory,
+ Repository repository,
+ Project.NameKey projectName) {
+ Stream<ChangeData> cds;
+ try {
+ cds =
+ changeNotesFactory
+ .scan(repository, projectName)
+ .map(
+ notesResult -> {
+ if (!notesResult.error().isPresent()) {
+ return changeDataFactory.create(notesResult.notes());
+ } else {
+ logger.atWarning().withCause(notesResult.error().get()).log(
+ "Unable to load ChangeNotes for %s", notesResult.id());
+ return null;
+ }
+ })
+ .filter(Objects::nonNull);
+ } catch (IOException e) {
+ throw new StorageException(e);
+ }
+ return cds;
+ }
+}
diff --git a/java/com/google/gerrit/server/permissions/ProjectControl.java b/java/com/google/gerrit/server/permissions/ProjectControl.java
index 664d867..e4fa1c4 100644
--- a/java/com/google/gerrit/server/permissions/ProjectControl.java
+++ b/java/com/google/gerrit/server/permissions/ProjectControl.java
@@ -346,7 +346,6 @@
}
private class ForProjectImpl extends ForProject {
- private DefaultRefFilter refFilter;
private String resourcePath;
@Override
@@ -415,10 +414,7 @@
@Override
public Collection<Ref> filter(Collection<Ref> refs, Repository repo, RefFilterOptions opts)
throws PermissionBackendException {
- if (refFilter == null) {
- refFilter = refFilterFactory.create(ProjectControl.this);
- }
- return refFilter.filter(refs, repo, opts);
+ return refFilterFactory.create(ProjectControl.this).filter(refs, repo, opts);
}
private boolean can(CoreOrPluginProjectPermission perm) throws PermissionBackendException {
diff --git a/java/com/google/gerrit/server/permissions/VisibleChangesCache.java b/java/com/google/gerrit/server/permissions/VisibleChangesCache.java
deleted file mode 100644
index 552f4f6..0000000
--- a/java/com/google/gerrit/server/permissions/VisibleChangesCache.java
+++ /dev/null
@@ -1,162 +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.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.server.git.SearchingChangeCacheImpl;
-import com.google.gerrit.server.notedb.ChangeNotes;
-import com.google.gerrit.server.notedb.ChangeNotes.Factory.ChangeNotesResult;
-import com.google.gerrit.server.project.ProjectState;
-import com.google.gerrit.server.query.change.ChangeData;
-import com.google.inject.Inject;
-import com.google.inject.assistedinject.Assisted;
-import java.io.IOException;
-import java.util.HashMap;
-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.
- */
-class VisibleChangesCache {
- private static final FluentLogger logger = FluentLogger.forEnclosingClass();
-
- interface Factory {
- 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 Repository repository;
- private Map<Change.Id, BranchNameKey> visibleChanges;
-
- @Inject
- VisibleChangesCache(
- @Nullable SearchingChangeCacheImpl changeCache,
- PermissionBackend permissionBackend,
- ChangeNotes.Factory changeNotesFactory,
- @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.repository = repository;
- }
-
- /**
- * Returns {@code true} if the {@code changeId} in repository {@code repo} is visible to the user,
- * by looking at the cached visible changes.
- */
- public boolean isVisible(Change.Id changeId) throws PermissionBackendException {
- cachedVisibleChanges();
- return visibleChanges.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 {
- if (visibleChanges == null) {
- if (changeCache == null) {
- visibleChangesByScan();
- } else {
- visibleChangesBySearch();
- }
- logger.atFinest().log("Visible changes: %s", visibleChanges.keySet());
- }
- return visibleChanges;
- }
-
- /**
- * Returns the {@code BranchNameKey} for {@code changeId}. If not cached, computes *all* visible
- * changes and caches them before returning this specific change. If not visible or not found,
- * returns {@code null}.
- */
- @Nullable
- public BranchNameKey getBranchNameKey(Change.Id changeId) throws PermissionBackendException {
- return cachedVisibleChanges().get(changeId);
- }
-
- private void visibleChangesBySearch() throws PermissionBackendException {
- visibleChanges = new HashMap<>();
- Project.NameKey project = projectState.getNameKey();
- try {
- for (ChangeData cd : changeCache.getChangeData(project)) {
- if (!projectState.statePermitsRead()) {
- continue;
- }
- if (permissionBackendForProject.change(cd).test(ChangePermission.READ)) {
- visibleChanges.put(cd.getId(), cd.change().getDest());
- }
- }
- } catch (StorageException 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;
- }
-
- if (permissionBackendForProject.change(r.notes()).test(ChangePermission.READ)) {
- return r.notes();
- }
- return null;
- }
-}
diff --git a/java/com/google/gerrit/server/plugins/ServerPluginInfoModule.java b/java/com/google/gerrit/server/plugins/ServerPluginInfoModule.java
index 639b278..60dff84 100644
--- a/java/com/google/gerrit/server/plugins/ServerPluginInfoModule.java
+++ b/java/com/google/gerrit/server/plugins/ServerPluginInfoModule.java
@@ -49,6 +49,7 @@
bind(String.class)
.annotatedWith(PluginCanonicalWebUrl.class)
.toInstance(plugin.getPluginCanonicalWebUrl());
+ bind(Plugin.class).toInstance(plugin);
install(
new LifecycleModule() {
diff --git a/java/com/google/gerrit/server/project/CreateRefControl.java b/java/com/google/gerrit/server/project/CreateRefControl.java
index 0d015d4..ab134b5 100644
--- a/java/com/google/gerrit/server/project/CreateRefControl.java
+++ b/java/com/google/gerrit/server/project/CreateRefControl.java
@@ -25,10 +25,13 @@
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.permissions.RefPermission;
+import com.google.gerrit.server.query.change.ChangeData;
+import com.google.gerrit.server.update.RetryHelper;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
import java.io.IOException;
+import java.util.List;
import java.util.Optional;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.PersonIdent;
@@ -41,18 +44,24 @@
/** Manages access control for creating Git references (aka branches, tags). */
@Singleton
public class CreateRefControl {
+
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
private final PermissionBackend permissionBackend;
private final ProjectCache projectCache;
private final Reachable reachable;
+ private final RetryHelper retryHelper;
@Inject
CreateRefControl(
- PermissionBackend permissionBackend, ProjectCache projectCache, Reachable reachable) {
+ PermissionBackend permissionBackend,
+ ProjectCache projectCache,
+ Reachable reachable,
+ RetryHelper retryHelper) {
this.permissionBackend = permissionBackend;
this.projectCache = projectCache;
this.reachable = reachable;
+ this.retryHelper = retryHelper;
}
/**
@@ -60,30 +69,56 @@
*
* @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
*/
public void checkCreateRef(
- Provider<? extends CurrentUser> user, Repository repo, BranchNameKey branch, RevObject object)
+ Provider<? extends CurrentUser> user,
+ Repository repo,
+ BranchNameKey destBranch,
+ RevObject object,
+ 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);
+ 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;
}
@@ -97,14 +132,14 @@
RevObject target = tag.getObject();
if (target instanceof RevCommit) {
- checkCreateCommit(user, repo, (RevCommit) target, ps.getNameKey(), perm);
+ checkCreateCommit(user, repo, (RevCommit) target, ps.getNameKey(), perm, forPush);
} else {
- checkCreateRef(user, repo, branch, target);
+ 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 {
@@ -122,12 +157,33 @@
Repository repo,
RevCommit commit,
Project.NameKey project,
- PermissionBackend.ForRef forRef)
+ PermissionBackend.ForRef forRef,
+ boolean forPush)
throws AuthException, PermissionBackendException, IOException {
- // If the user has update (push) permission, they can create the ref regardless
- // of whether they are pushing any new objects along with the create.
- if (forRef.test(RefPermission.UPDATE)) {
- return;
+ try {
+ // If the user has UPDATE (push) permission, they can set the ref to an arbitrary commit:
+ //
+ // * if they don't have access, we don't advertise the data, and a conforming git client
+ // would send the object along with the push as outcome of the negotation.
+ // * a malicious client could try to send the update without sending the object. This
+ // is prevented by JGit's ConnectivityChecker (see receive.checkReferencedObjectsAreReachable
+ // to switch off this costly check).
+ //
+ // Thus, when using the git command-line client, we don't need to do extra checks for users
+ // with push access.
+ //
+ // When using the REST API, there is no negotiation, and the target commit must already be on
+ // the server, so we must check that the user can see that commit.
+ if (forPush) {
+ // We can only shortcut for UPDATE permission. Pushing a tag (CREATE_TAG, CREATE_SIGNED_TAG)
+ // can also introduce new objects. While there may not be a confidentiality problem
+ // (the caller supplies the data as documented above), the permission is for creating
+ // tags to existing commits.
+ forRef.check(RefPermission.UPDATE);
+ return;
+ }
+ } catch (AuthException denied) {
+ // Fall through to check reachability.
}
if (reachable.fromRefs(
project,
@@ -142,6 +198,18 @@
return;
}
+ // Previous check only catches normal branches. Try PatchSet refs too. If we can create refs,
+ // we're not a replica, so we can always use the change index.
+ List<ChangeData> changes =
+ retryHelper
+ .changeIndexQuery(
+ "queryChangesByProjectCommitWithLimit1",
+ q -> q.enforceVisibility(true).setLimit(1).byProjectCommit(project, commit))
+ .call();
+ if (!changes.isEmpty()) {
+ return;
+ }
+
AuthException e =
new AuthException(
String.format(
diff --git a/java/com/google/gerrit/server/project/PeriodicProjectListCacheWarmer.java b/java/com/google/gerrit/server/project/PeriodicProjectListCacheWarmer.java
new file mode 100644
index 0000000..caffb45
--- /dev/null
+++ b/java/com/google/gerrit/server/project/PeriodicProjectListCacheWarmer.java
@@ -0,0 +1,100 @@
+// 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.project;
+
+import static java.util.concurrent.TimeUnit.MILLISECONDS;
+
+import com.google.common.flogger.FluentLogger;
+import com.google.gerrit.extensions.events.LifecycleListener;
+import com.google.gerrit.server.config.GerritServerConfig;
+import com.google.gerrit.server.config.ScheduleConfig;
+import com.google.gerrit.server.git.WorkQueue;
+import com.google.inject.Inject;
+import java.time.Duration;
+import org.eclipse.jgit.lib.Config;
+
+public class PeriodicProjectListCacheWarmer implements Runnable {
+ private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+
+ public static class LifeCycle implements LifecycleListener {
+ protected final Config config;
+ protected final WorkQueue queue;
+ protected final PeriodicProjectListCacheWarmer runner;
+
+ @Inject
+ LifeCycle(
+ @GerritServerConfig Config config, WorkQueue queue, PeriodicProjectListCacheWarmer runner) {
+ this.config = config;
+ this.queue = queue;
+ this.runner = runner;
+ }
+
+ @Override
+ public void start() {
+ long interval = -1L;
+ String intervalString = config.getString("cache", ProjectCacheImpl.CACHE_LIST, "interval");
+ if (!"-1".equals(intervalString)) {
+ long maxAge =
+ config.getTimeUnit("cache", ProjectCacheImpl.CACHE_LIST, "maxAge", -1L, MILLISECONDS);
+ interval =
+ config.getTimeUnit(
+ "cache",
+ ProjectCacheImpl.CACHE_LIST,
+ "interval",
+ getHalfDuration(maxAge),
+ MILLISECONDS);
+ }
+
+ if (interval == -1L) {
+ logger.atWarning().log("project_list cache warmer is disabled");
+ return;
+ }
+
+ String startTime = config.getString("cache", ProjectCacheImpl.CACHE_LIST, "startTime");
+ if (startTime == null) {
+ startTime = "00:00";
+ }
+
+ runner.run();
+ queue.scheduleAtFixedRate(runner, ScheduleConfig.Schedule.createOrFail(interval, startTime));
+ }
+
+ @Override
+ public void stop() {
+ // handled by WorkQueue.stop() already
+ }
+
+ private long getHalfDuration(long duration) {
+ if (duration < 0) {
+ return duration;
+ }
+ return Duration.ofMillis(duration).dividedBy(2L).toMillis();
+ }
+ }
+
+ protected final ProjectCache cache;
+
+ @Inject
+ PeriodicProjectListCacheWarmer(ProjectCache cache) {
+ this.cache = cache;
+ }
+
+ @Override
+ public void run() {
+ logger.atFine().log("Loading project_list cache");
+ cache.all();
+ logger.atFine().log("Finished loading project_list cache");
+ }
+}
diff --git a/java/com/google/gerrit/server/project/ProjectCacheImpl.java b/java/com/google/gerrit/server/project/ProjectCacheImpl.java
index 3aa3783..52a524f 100644
--- a/java/com/google/gerrit/server/project/ProjectCacheImpl.java
+++ b/java/com/google/gerrit/server/project/ProjectCacheImpl.java
@@ -95,7 +95,7 @@
public static final String PERSISTED_CACHE_NAME = "persisted_projects";
- private static final String CACHE_LIST = "project_list";
+ public static final String CACHE_LIST = "project_list";
public static Module module() {
return new CacheModule() {
@@ -147,6 +147,13 @@
listener().to(ProjectCacheWarmer.class);
}
});
+ install(
+ new LifecycleModule() {
+ @Override
+ protected void configure() {
+ listener().to(PeriodicProjectListCacheWarmer.LifeCycle.class);
+ }
+ });
}
};
}
diff --git a/java/com/google/gerrit/server/query/account/AccountQueryProcessor.java b/java/com/google/gerrit/server/query/account/AccountQueryProcessor.java
index 2e29bbd..9893d1a 100644
--- a/java/com/google/gerrit/server/query/account/AccountQueryProcessor.java
+++ b/java/com/google/gerrit/server/query/account/AccountQueryProcessor.java
@@ -30,6 +30,7 @@
import com.google.gerrit.server.index.account.AccountIndexCollection;
import com.google.gerrit.server.index.account.AccountIndexRewriter;
import com.google.gerrit.server.index.account.AccountSchemaDefinitions;
+import com.google.gerrit.server.notedb.Sequences;
import com.google.inject.Inject;
import com.google.inject.Provider;
@@ -41,6 +42,8 @@
*/
public class AccountQueryProcessor extends QueryProcessor<AccountState> {
private final AccountControl.Factory accountControlFactory;
+ private final Sequences sequences;
+ private final IndexConfig indexConfig;
static {
// It is assumed that basic rewrites do not touch visibleto predicates.
@@ -57,7 +60,8 @@
IndexConfig indexConfig,
AccountIndexCollection indexes,
AccountIndexRewriter rewriter,
- AccountControl.Factory accountControlFactory) {
+ AccountControl.Factory accountControlFactory,
+ Sequences sequences) {
super(
metricMaker,
AccountSchemaDefinitions.INSTANCE,
@@ -67,16 +71,28 @@
FIELD_LIMIT,
() -> limitsFactory.create(userProvider.get()).getQueryLimit());
this.accountControlFactory = accountControlFactory;
+ this.sequences = sequences;
+ this.indexConfig = indexConfig;
}
@Override
protected Predicate<AccountState> enforceVisibility(Predicate<AccountState> pred) {
return new AndSource<>(
- pred, new AccountIsVisibleToPredicate(accountControlFactory.get()), start);
+ pred, new AccountIsVisibleToPredicate(accountControlFactory.get()), start, indexConfig);
}
@Override
protected String formatForLogging(AccountState accountState) {
return accountState.account().id().toString();
}
+
+ @Override
+ protected int getIndexSize() {
+ return sequences.lastAccountId();
+ }
+
+ @Override
+ protected int getBatchSize() {
+ return sequences.accountBatchSize();
+ }
}
diff --git a/java/com/google/gerrit/server/query/change/AndChangeSource.java b/java/com/google/gerrit/server/query/change/AndChangeSource.java
index 749204f..98cada3 100644
--- a/java/com/google/gerrit/server/query/change/AndChangeSource.java
+++ b/java/com/google/gerrit/server/query/change/AndChangeSource.java
@@ -14,6 +14,7 @@
package com.google.gerrit.server.query.change;
+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;
@@ -22,15 +23,16 @@
public class AndChangeSource extends AndSource<ChangeData> implements ChangeDataSource {
- public AndChangeSource(Collection<Predicate<ChangeData>> that) {
- super(that);
+ public AndChangeSource(Collection<Predicate<ChangeData>> that, IndexConfig indexConfig) {
+ super(that, indexConfig);
}
public AndChangeSource(
Predicate<ChangeData> that,
IsVisibleToPredicate<ChangeData> isVisibleToPredicate,
- int start) {
- super(that, isVisibleToPredicate, start);
+ int start,
+ IndexConfig indexConfig) {
+ super(that, isVisibleToPredicate, start, indexConfig);
}
@Override
diff --git a/java/com/google/gerrit/server/query/change/ChangeIndexPostFilterPredicate.java b/java/com/google/gerrit/server/query/change/ChangeIndexPostFilterPredicate.java
new file mode 100644
index 0000000..d86d366
--- /dev/null
+++ b/java/com/google/gerrit/server/query/change/ChangeIndexPostFilterPredicate.java
@@ -0,0 +1,31 @@
+// 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;
+
+/**
+ * Predicate that is mapped to a field in the change index, with additional filtering done in the
+ * {@code match} method.
+ */
+public abstract class ChangeIndexPostFilterPredicate extends ChangeIndexPredicate {
+ protected ChangeIndexPostFilterPredicate(FieldDef<ChangeData, ?> def, String value) {
+ super(def, value);
+ }
+
+ protected ChangeIndexPostFilterPredicate(FieldDef<ChangeData, ?> def, String name, String value) {
+ super(def, name, value);
+ }
+}
diff --git a/java/com/google/gerrit/server/query/change/ChangeIsVisibleToPredicate.java b/java/com/google/gerrit/server/query/change/ChangeIsVisibleToPredicate.java
index ac72d15..24042ad 100644
--- a/java/com/google/gerrit/server/query/change/ChangeIsVisibleToPredicate.java
+++ b/java/com/google/gerrit/server/query/change/ChangeIsVisibleToPredicate.java
@@ -41,9 +41,8 @@
}
protected final CurrentUser user;
- protected final PermissionBackend permissionBackend;
protected final ProjectCache projectCache;
- private final Provider<AnonymousUser> anonymousUserProvider;
+ private final PermissionBackend.WithUser withUser;
@Inject
public ChangeIsVisibleToPredicate(
@@ -53,9 +52,14 @@
@Assisted CurrentUser user) {
super(ChangeQueryBuilder.FIELD_VISIBLETO, IndexUtils.describe(user));
this.user = user;
- this.permissionBackend = permissionBackend;
this.projectCache = projectCache;
- this.anonymousUserProvider = anonymousUserProvider;
+ withUser =
+ user.isIdentifiedUser()
+ ? permissionBackend.absentUser(user.getAccountId())
+ : permissionBackend.user(
+ Optional.of(user)
+ .filter(u -> u instanceof GroupBackedUser || u instanceof InternalUser)
+ .orElseGet(anonymousUserProvider::get));
}
@Override
@@ -74,18 +78,10 @@
return false;
}
if (!projectState.get().statePermitsRead()) {
- logger.atFine().log("Filter out change %s of non-reabable project %s", cd, cd.project());
+ logger.atFine().log("Filter out change %s of non-readable project %s", cd, cd.project());
return false;
}
- PermissionBackend.WithUser withUser =
- user.isIdentifiedUser()
- ? permissionBackend.absentUser(user.getAccountId())
- : permissionBackend.user(
- Optional.of(user)
- .filter(u -> u instanceof GroupBackedUser || u instanceof InternalUser)
- .orElseGet(anonymousUserProvider::get));
-
try {
if (!withUser.change(cd).test(ChangePermission.READ)) {
logger.atFine().log("Filter out non-visisble change: %s", cd);
diff --git a/java/com/google/gerrit/server/query/change/ChangeQueryProcessor.java b/java/com/google/gerrit/server/query/change/ChangeQueryProcessor.java
index ed1f2f1..0f0535a 100644
--- a/java/com/google/gerrit/server/query/change/ChangeQueryProcessor.java
+++ b/java/com/google/gerrit/server/query/change/ChangeQueryProcessor.java
@@ -39,6 +39,7 @@
import com.google.gerrit.server.index.change.ChangeIndexRewriter;
import com.google.gerrit.server.index.change.ChangeSchemaDefinitions;
import com.google.gerrit.server.index.change.IndexedChangeQuery;
+import com.google.gerrit.server.notedb.Sequences;
import com.google.inject.Inject;
import com.google.inject.Provider;
import java.util.ArrayList;
@@ -61,6 +62,8 @@
private final Map<String, DynamicBean> dynamicBeans = new HashMap<>();
private final List<Extension<ChangePluginDefinedInfoFactory>>
changePluginDefinedInfoFactoriesByPlugin = new ArrayList<>();
+ private final Sequences sequences;
+ private final IndexConfig indexConfig;
static {
// It is assumed that basic rewrites do not touch visibleto predicates.
@@ -77,6 +80,7 @@
IndexConfig indexConfig,
ChangeIndexCollection indexes,
ChangeIndexRewriter rewriter,
+ Sequences sequences,
ChangeIsVisibleToPredicate.Factory changeIsVisibleToPredicateFactory,
DynamicSet<ChangePluginDefinedInfoFactory> changePluginDefinedInfoFactories) {
super(
@@ -89,6 +93,8 @@
() -> limitsFactory.create(userProvider.get()).getQueryLimit());
this.userProvider = userProvider;
this.changeIsVisibleToPredicateFactory = changeIsVisibleToPredicateFactory;
+ this.sequences = sequences;
+ this.indexConfig = indexConfig;
changePluginDefinedInfoFactories
.entries()
@@ -103,8 +109,14 @@
@Override
protected QueryOptions createOptions(
- IndexConfig indexConfig, int start, int limit, Set<String> requestedFields) {
- return IndexedChangeQuery.createOptions(indexConfig, start, limit, requestedFields);
+ IndexConfig indexConfig,
+ int start,
+ int pageSize,
+ int pageSizeMultiplier,
+ int limit,
+ Set<String> requestedFields) {
+ return IndexedChangeQuery.createOptions(
+ indexConfig, start, pageSize, pageSizeMultiplier, limit, requestedFields);
}
@Override
@@ -131,11 +143,26 @@
@Override
protected Predicate<ChangeData> enforceVisibility(Predicate<ChangeData> pred) {
return new AndChangeSource(
- pred, changeIsVisibleToPredicateFactory.forUser(userProvider.get()), start);
+ pred, changeIsVisibleToPredicateFactory.forUser(userProvider.get()), start, indexConfig);
}
@Override
protected String formatForLogging(ChangeData changeData) {
return changeData.getId().toString();
}
+
+ @Override
+ protected int getIndexSize() {
+ return sequences.lastChangeId();
+ }
+
+ @Override
+ protected int getBatchSize() {
+ return sequences.changeBatchSize();
+ }
+
+ @Override
+ protected int getInitialPageSize(int limit) {
+ return Math.min(getUserQueryLimit().getAsInt(), limit);
+ }
}
diff --git a/java/com/google/gerrit/server/query/change/EqualsLabelPredicate.java b/java/com/google/gerrit/server/query/change/EqualsLabelPredicate.java
index a65d0a0..6aacfc9 100644
--- a/java/com/google/gerrit/server/query/change/EqualsLabelPredicate.java
+++ b/java/com/google/gerrit/server/query/change/EqualsLabelPredicate.java
@@ -32,7 +32,7 @@
import com.google.gerrit.server.query.change.ChangeData.StorageConstraint;
import java.util.Optional;
-public class EqualsLabelPredicate extends ChangeIndexPredicate {
+public class EqualsLabelPredicate extends ChangeIndexPostFilterPredicate {
protected final ProjectCache projectCache;
protected final PermissionBackend permissionBackend;
protected final IdentifiedUser.GenericFactory userFactory;
diff --git a/java/com/google/gerrit/server/query/change/OutputStreamQuery.java b/java/com/google/gerrit/server/query/change/OutputStreamQuery.java
index 1b6dc62..716cf10 100644
--- a/java/com/google/gerrit/server/query/change/OutputStreamQuery.java
+++ b/java/com/google/gerrit/server/query/change/OutputStreamQuery.java
@@ -18,6 +18,7 @@
import static java.nio.charset.StandardCharsets.UTF_8;
import com.google.common.collect.ImmutableListMultimap;
+import com.google.common.collect.Lists;
import com.google.common.flogger.FluentLogger;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.LabelTypes;
@@ -28,6 +29,8 @@
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.account.AccountAttributeLoader;
+import com.google.gerrit.server.cache.PerThreadCache;
import com.google.gerrit.server.config.TrackingFooters;
import com.google.gerrit.server.data.ChangeAttribute;
import com.google.gerrit.server.data.PatchSetAttribute;
@@ -86,6 +89,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;
@@ -110,13 +114,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) {
@@ -205,7 +211,7 @@
return;
}
- try {
+ try (PerThreadCache ignored = PerThreadCache.create()) {
final QueryStatsAttribute stats = new QueryStatsAttribute();
stats.runTimeMilliseconds = TimeUtil.nowMs();
@@ -214,9 +220,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());
}
@@ -247,10 +257,14 @@
}
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(), d.notes());
+ ChangeAttribute c = eventFactory.asChangeAttribute(d.change(), accountLoader);
+ c.hashtags = Lists.newArrayList(d.hashtags());
eventFactory.extend(c, d.change());
if (!trackingFooters.isEmpty()) {
@@ -258,13 +272,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,26 +307,28 @@
includeApprovals ? d.approvals().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,
@@ -320,9 +337,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/group/GroupQueryProcessor.java b/java/com/google/gerrit/server/query/group/GroupQueryProcessor.java
index 9e56807..c6683fa 100644
--- a/java/com/google/gerrit/server/query/group/GroupQueryProcessor.java
+++ b/java/com/google/gerrit/server/query/group/GroupQueryProcessor.java
@@ -30,6 +30,7 @@
import com.google.gerrit.server.index.group.GroupIndexCollection;
import com.google.gerrit.server.index.group.GroupIndexRewriter;
import com.google.gerrit.server.index.group.GroupSchemaDefinitions;
+import com.google.gerrit.server.notedb.Sequences;
import com.google.inject.Inject;
import com.google.inject.Provider;
@@ -42,6 +43,8 @@
public class GroupQueryProcessor extends QueryProcessor<InternalGroup> {
private final Provider<CurrentUser> userProvider;
private final GroupControl.GenericFactory groupControlFactory;
+ private final Sequences sequences;
+ private final IndexConfig indexConfig;
static {
// It is assumed that basic rewrites do not touch visibleto predicates.
@@ -58,7 +61,8 @@
IndexConfig indexConfig,
GroupIndexCollection indexes,
GroupIndexRewriter rewriter,
- GroupControl.GenericFactory groupControlFactory) {
+ GroupControl.GenericFactory groupControlFactory,
+ Sequences sequences) {
super(
metricMaker,
GroupSchemaDefinitions.INSTANCE,
@@ -69,16 +73,31 @@
() -> limitsFactory.create(userProvider.get()).getQueryLimit());
this.userProvider = userProvider;
this.groupControlFactory = groupControlFactory;
+ this.sequences = sequences;
+ this.indexConfig = indexConfig;
}
@Override
protected Predicate<InternalGroup> enforceVisibility(Predicate<InternalGroup> pred) {
return new AndSource<>(
- pred, new GroupIsVisibleToPredicate(groupControlFactory, userProvider.get()), start);
+ pred,
+ new GroupIsVisibleToPredicate(groupControlFactory, userProvider.get()),
+ start,
+ indexConfig);
}
@Override
protected String formatForLogging(InternalGroup internalGroup) {
return internalGroup.getGroupUUID().get();
}
+
+ @Override
+ protected int getIndexSize() {
+ return sequences.lastGroupId();
+ }
+
+ @Override
+ protected int getBatchSize() {
+ return sequences.groupBatchSize();
+ }
}
diff --git a/java/com/google/gerrit/server/query/project/ProjectQueryProcessor.java b/java/com/google/gerrit/server/query/project/ProjectQueryProcessor.java
index 8e6d8a1..6dafa92 100644
--- a/java/com/google/gerrit/server/query/project/ProjectQueryProcessor.java
+++ b/java/com/google/gerrit/server/query/project/ProjectQueryProcessor.java
@@ -30,6 +30,7 @@
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.account.AccountLimits;
import com.google.gerrit.server.permissions.PermissionBackend;
+import com.google.gerrit.server.project.ProjectCache;
import com.google.inject.Inject;
import com.google.inject.Provider;
@@ -44,6 +45,8 @@
public class ProjectQueryProcessor extends QueryProcessor<ProjectData> {
private final PermissionBackend permissionBackend;
private final Provider<CurrentUser> userProvider;
+ private final ProjectCache projectCache;
+ private final IndexConfig indexConfig;
static {
// It is assumed that basic rewrites do not touch visibleto predicates.
@@ -60,7 +63,8 @@
IndexConfig indexConfig,
ProjectIndexCollection indexes,
ProjectIndexRewriter rewriter,
- PermissionBackend permissionBackend) {
+ PermissionBackend permissionBackend,
+ ProjectCache projectCache) {
super(
metricMaker,
ProjectSchemaDefinitions.INSTANCE,
@@ -71,16 +75,31 @@
() -> limitsFactory.create(userProvider.get()).getQueryLimit());
this.permissionBackend = permissionBackend;
this.userProvider = userProvider;
+ this.projectCache = projectCache;
+ this.indexConfig = indexConfig;
}
@Override
protected Predicate<ProjectData> enforceVisibility(Predicate<ProjectData> pred) {
return new AndSource<>(
- pred, new ProjectIsVisibleToPredicate(permissionBackend, userProvider.get()), start);
+ pred,
+ new ProjectIsVisibleToPredicate(permissionBackend, userProvider.get()),
+ start,
+ indexConfig);
}
@Override
protected String formatForLogging(ProjectData projectData) {
return projectData.getProject().getName();
}
+
+ @Override
+ protected int getIndexSize() {
+ return projectCache.all().size();
+ }
+
+ @Override
+ protected int getBatchSize() {
+ return 1;
+ }
}
diff --git a/java/com/google/gerrit/server/restapi/BUILD b/java/com/google/gerrit/server/restapi/BUILD
index 2864391..2566b72 100644
--- a/java/com/google/gerrit/server/restapi/BUILD
+++ b/java/com/google/gerrit/server/restapi/BUILD
@@ -8,6 +8,7 @@
name = "restapi",
srcs = glob(["**/*.java"]),
deps = [
+ "//antlr3:query_parser",
"//java/com/google/gerrit/common:annotations",
"//java/com/google/gerrit/common:server",
"//java/com/google/gerrit/entities",
@@ -29,6 +30,7 @@
"//lib:guava",
"//lib:jgit",
"//lib:servlet-api",
+ "//lib/antlr:java-runtime",
"//lib/auto:auto-value",
"//lib/auto:auto-value-annotations",
"//lib/commons:compress",
diff --git a/java/com/google/gerrit/server/restapi/account/PostWatchedProjects.java b/java/com/google/gerrit/server/restapi/account/PostWatchedProjects.java
index 5979b2a..2131070 100644
--- a/java/com/google/gerrit/server/restapi/account/PostWatchedProjects.java
+++ b/java/com/google/gerrit/server/restapi/account/PostWatchedProjects.java
@@ -14,12 +14,15 @@
package com.google.gerrit.server.restapi.account;
+import com.google.common.base.Strings;
import com.google.gerrit.entities.NotifyConfig.NotifyType;
import com.google.gerrit.extensions.client.ProjectWatchInfo;
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.RestModifyView;
+import com.google.gerrit.index.query.QueryParseException;
+import com.google.gerrit.index.query.QueryParser;
import com.google.gerrit.server.IdentifiedUser;
import com.google.gerrit.server.UserInitiated;
import com.google.gerrit.server.account.AccountResource;
@@ -95,6 +98,17 @@
throw new BadRequestException("project name must be specified");
}
+ if (!Strings.isNullOrEmpty(info.filter)) {
+ try {
+ QueryParser.parse(info.filter);
+ } catch (QueryParseException e) {
+ throw new BadRequestException(
+ String.format(
+ "invalid filter expression for project %s: %s", info.project, e.getMessage()),
+ e);
+ }
+ }
+
ProjectWatchKey key =
ProjectWatchKey.create(projectsCollection.parse(info.project).getNameKey(), info.filter);
if (m.containsKey(key)) {
diff --git a/java/com/google/gerrit/server/restapi/project/CreateBranch.java b/java/com/google/gerrit/server/restapi/project/CreateBranch.java
index c9da5b8..018ed86 100644
--- a/java/com/google/gerrit/server/restapi/project/CreateBranch.java
+++ b/java/com/google/gerrit/server/restapi/project/CreateBranch.java
@@ -50,6 +50,7 @@
import java.util.Map;
import org.eclipse.jgit.lib.Constants;
import org.eclipse.jgit.lib.ObjectId;
+import org.eclipse.jgit.lib.Ref;
import org.eclipse.jgit.lib.RefUpdate;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.revwalk.RevObject;
@@ -132,7 +133,21 @@
object = rw.parseCommit(object);
}
- createRefControl.checkCreateRef(identifiedUser, repo, name, object);
+ Ref sourceRef = repo.exactRef(input.revision);
+ if (sourceRef == null) {
+ createRefControl.checkCreateRef(identifiedUser, repo, name, object, /* forPush= */ false);
+ } else {
+ if (sourceRef.isSymbolic()) {
+ sourceRef = sourceRef.getTarget();
+ }
+ createRefControl.checkCreateRef(
+ identifiedUser,
+ repo,
+ name,
+ object,
+ /* forPush= */ false,
+ BranchNameKey.create(rsrc.getNameKey(), sourceRef.getName()));
+ }
RefUpdate u = repo.updateRef(ref);
u.setExpectedOldObjectId(ObjectId.zeroId());
diff --git a/java/com/google/gerrit/server/rules/PrologModule.java b/java/com/google/gerrit/server/rules/PrologModule.java
index 5cf4220..ebb5ec0 100644
--- a/java/com/google/gerrit/server/rules/PrologModule.java
+++ b/java/com/google/gerrit/server/rules/PrologModule.java
@@ -18,12 +18,19 @@
import com.google.gerrit.extensions.config.FactoryModule;
import com.google.gerrit.extensions.registration.DynamicSet;
import com.google.gerrit.server.rules.RulesCache.RulesCacheModule;
+import org.eclipse.jgit.lib.Config;
public class PrologModule extends FactoryModule {
+ protected final Config config;
+
+ public PrologModule(Config config) {
+ this.config = config;
+ }
+
@Override
protected void configure() {
install(new EnvironmentModule());
- install(new RulesCacheModule());
+ install(new RulesCacheModule(config));
bind(PrologEnvironment.Args.class);
factory(PrologRuleEvaluator.Factory.class);
diff --git a/java/com/google/gerrit/server/rules/RulesCache.java b/java/com/google/gerrit/server/rules/RulesCache.java
index 706804a..773c75e 100644
--- a/java/com/google/gerrit/server/rules/RulesCache.java
+++ b/java/com/google/gerrit/server/rules/RulesCache.java
@@ -17,6 +17,7 @@
import static com.googlecode.prolog_cafe.lang.PrologMachineCopy.save;
import com.google.common.base.Joiner;
+import com.google.common.base.Strings;
import com.google.common.cache.Cache;
import com.google.common.collect.ImmutableList;
import com.google.gerrit.entities.Project;
@@ -73,11 +74,25 @@
@Singleton
public class RulesCache {
public static class RulesCacheModule extends CacheModule {
+ protected final Config config;
+
+ public RulesCacheModule(Config config) {
+ this.config = config;
+ }
+
@Override
protected void configure() {
- cache(RulesCache.CACHE_NAME, ObjectId.class, PrologMachineCopy.class)
- // This cache is auxiliary to the project cache, so size it the same.
- .configKey(ProjectCacheImpl.CACHE_NAME);
+ if (has(ProjectCacheImpl.CACHE_NAME, "memoryLimit")) {
+ // As this cache is auxiliary to the project cache, so size it the same when available
+ cache(RulesCache.CACHE_NAME, ObjectId.class, PrologMachineCopy.class)
+ .maximumWeight(config.getLong("cache", ProjectCacheImpl.CACHE_NAME, "memoryLimit", 0));
+ } else {
+ cache(RulesCache.CACHE_NAME, ObjectId.class, PrologMachineCopy.class);
+ }
+ }
+
+ private boolean has(String name, String var) {
+ return !Strings.isNullOrEmpty(config.getString("cache", name, var));
}
}
diff --git a/java/com/google/gerrit/server/update/ChainedReceiveCommands.java b/java/com/google/gerrit/server/update/ChainedReceiveCommands.java
index 99c72f2..5ff8d33 100644
--- a/java/com/google/gerrit/server/update/ChainedReceiveCommands.java
+++ b/java/com/google/gerrit/server/update/ChainedReceiveCommands.java
@@ -39,13 +39,19 @@
public class ChainedReceiveCommands implements RefCache {
private final Map<String, ReceiveCommand> commands = new LinkedHashMap<>();
private final RepoRefCache refCache;
+ private final boolean closeRefCache;
public ChainedReceiveCommands(Repository repo) {
- this(new RepoRefCache(repo));
+ this(new RepoRefCache(repo), true);
}
public ChainedReceiveCommands(RepoRefCache refCache) {
+ this(refCache, false);
+ }
+
+ private ChainedReceiveCommands(RepoRefCache refCache, boolean closeRefCache) {
this.refCache = requireNonNull(refCache);
+ this.closeRefCache = closeRefCache;
}
public RepoRefCache getRepoRefCache() {
@@ -122,4 +128,11 @@
public Map<String, ReceiveCommand> getCommands() {
return Collections.unmodifiableMap(commands);
}
+
+ @Override
+ public void close() {
+ if (closeRefCache) {
+ refCache.close();
+ }
+ }
}
diff --git a/java/com/google/gerrit/sshd/CommandModule.java b/java/com/google/gerrit/sshd/CommandModule.java
index ac07056..4242c71 100644
--- a/java/com/google/gerrit/sshd/CommandModule.java
+++ b/java/com/google/gerrit/sshd/CommandModule.java
@@ -15,6 +15,7 @@
package com.google.gerrit.sshd;
import com.google.gerrit.lifecycle.LifecycleModule;
+import com.google.gerrit.server.account.AccountAttributeLoader;
import com.google.inject.binder.LinkedBindingBuilder;
import org.apache.sshd.server.command.Command;
@@ -29,6 +30,7 @@
* @return a binding that must be bound to a non-singleton provider for a {@link Command} object.
*/
protected LinkedBindingBuilder<Command> command(String name) {
+ factory(AccountAttributeLoader.Factory.class);
return bind(Commands.key(name));
}
diff --git a/java/com/google/gerrit/sshd/SshLogJsonLayout.java b/java/com/google/gerrit/sshd/SshLogJsonLayout.java
index 0edad6f..321cf56 100644
--- a/java/com/google/gerrit/sshd/SshLogJsonLayout.java
+++ b/java/com/google/gerrit/sshd/SshLogJsonLayout.java
@@ -84,7 +84,7 @@
String metricString = getMdcString(event, P_MESSAGE);
if (metricString != null && !metricString.isEmpty()) {
- List<String> ssh_metrics = SPLITTER.splitToList(" ");
+ List<String> ssh_metrics = SPLITTER.splitToList(metricString);
this.timeNegotiating = ssh_metrics.get(0);
this.timeSearchReuse = ssh_metrics.get(1);
this.timeSearchSizes = ssh_metrics.get(2);
diff --git a/java/com/google/gerrit/sshd/SshScope.java b/java/com/google/gerrit/sshd/SshScope.java
index 0fe8b78..f19c395 100644
--- a/java/com/google/gerrit/sshd/SshScope.java
+++ b/java/com/google/gerrit/sshd/SshScope.java
@@ -53,6 +53,8 @@
private volatile long startedMemory;
private volatile long finishedMemory;
+ private IdentifiedUser identifiedUser;
+
private Context(SshSession s, String c, long at) {
session = s;
commandLine = c;
@@ -125,8 +127,10 @@
public CurrentUser getUser() {
CurrentUser user = session.getUser();
if (user != null && user.isIdentifiedUser()) {
- IdentifiedUser identifiedUser = userFactory.create(user.getAccountId());
- identifiedUser.setAccessPath(user.getAccessPath());
+ if (identifiedUser == null) {
+ identifiedUser = userFactory.create(user.getAccountId());
+ identifiedUser.setAccessPath(user.getAccessPath());
+ }
return identifiedUser;
}
return user;
diff --git a/java/com/google/gerrit/sshd/commands/PatchSetParser.java b/java/com/google/gerrit/sshd/commands/PatchSetParser.java
index 4ebf15e..65d48dd 100644
--- a/java/com/google/gerrit/sshd/commands/PatchSetParser.java
+++ b/java/com/google/gerrit/sshd/commands/PatchSetParser.java
@@ -18,6 +18,7 @@
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.PatchSet;
import com.google.gerrit.entities.Project;
+import com.google.gerrit.entities.RefNames;
import com.google.gerrit.git.ObjectIds;
import com.google.gerrit.server.PatchSetUtil;
import com.google.gerrit.server.change.ChangeFinder;
@@ -59,6 +60,7 @@
if (token.matches("^([0-9a-fA-F]{4," + ObjectIds.STR_LEN + "})$")) {
InternalChangeQuery query = queryProvider.get();
List<ChangeData> cds;
+ branch = branch != null ? RefNames.fullName(branch) : null;
if (projectState != null) {
Project.NameKey p = projectState.getNameKey();
if (branch != null) {
diff --git a/java/com/google/gerrit/testing/BUILD b/java/com/google/gerrit/testing/BUILD
index 798a2d4..861fa00 100644
--- a/java/com/google/gerrit/testing/BUILD
+++ b/java/com/google/gerrit/testing/BUILD
@@ -34,6 +34,7 @@
"//java/com/google/gerrit/server/audit",
"//java/com/google/gerrit/server/cache/h2",
"//java/com/google/gerrit/server/cache/mem",
+ "//java/com/google/gerrit/server/group/testing",
"//java/com/google/gerrit/server/logging",
"//java/com/google/gerrit/server/restapi",
"//java/com/google/gerrit/server/schema",
@@ -48,6 +49,7 @@
"//lib/flogger:api",
"//lib/guice",
"//lib/guice:guice-servlet",
+ "//lib/log:impl-log4j",
"//lib/truth",
],
)
diff --git a/java/com/google/gerrit/testing/InMemoryModule.java b/java/com/google/gerrit/testing/InMemoryModule.java
index b9daa13..b00cadb 100644
--- a/java/com/google/gerrit/testing/InMemoryModule.java
+++ b/java/com/google/gerrit/testing/InMemoryModule.java
@@ -25,6 +25,7 @@
import com.google.gerrit.auth.AuthModule;
import com.google.gerrit.extensions.client.AuthType;
import com.google.gerrit.extensions.config.FactoryModule;
+import com.google.gerrit.extensions.registration.DynamicSet;
import com.google.gerrit.extensions.systemstatus.ServerInformation;
import com.google.gerrit.gpg.GpgModule;
import com.google.gerrit.httpd.auth.restapi.OAuthRestModule;
@@ -37,7 +38,9 @@
import com.google.gerrit.server.FanOutExecutor;
import com.google.gerrit.server.GerritPersonIdent;
import com.google.gerrit.server.GerritPersonIdentProvider;
+import com.google.gerrit.server.LibModuleType;
import com.google.gerrit.server.PluginUser;
+import com.google.gerrit.server.account.GroupBackend;
import com.google.gerrit.server.api.GerritApiModule;
import com.google.gerrit.server.api.PluginApiModule;
import com.google.gerrit.server.audit.AuditModule;
@@ -76,6 +79,7 @@
import com.google.gerrit.server.git.PerThreadRequestScope;
import com.google.gerrit.server.git.SearchingChangeCacheImpl.SearchingChangeCacheImplModule;
import com.google.gerrit.server.git.WorkQueue;
+import com.google.gerrit.server.group.testing.TestGroupBackend;
import com.google.gerrit.server.index.account.AccountSchemaDefinitions;
import com.google.gerrit.server.index.account.AllAccountsIndexer;
import com.google.gerrit.server.index.change.AllChangesIndexer;
@@ -243,13 +247,19 @@
bind(AllChangesIndexer.class).toProvider(Providers.of(null));
bind(AllGroupsIndexer.class).toProvider(Providers.of(null));
- String indexTypeCfg = cfg.getString("index", null, "type");
- IndexType indexType = new IndexType(indexTypeCfg != null ? indexTypeCfg : "fake");
- // For custom index types, callers must provide their own module.
- if (indexType.isLucene()) {
- install(luceneIndexModule());
- } else if (indexType.isFake()) {
- install(fakeIndexModule());
+ // Index lib module has a higher priority than index type configuration.
+ String indexModule =
+ cfg.getString("index", null, "install" + LibModuleType.INDEX_MODULE_TYPE.getConfigKey());
+ if (indexModule != null) {
+ install(indexModule(indexModule));
+ } else {
+ String indexTypeCfg = cfg.getString("index", null, "type");
+ IndexType indexType = new IndexType(indexTypeCfg != null ? indexTypeCfg : "fake");
+ if (indexType.isLucene()) {
+ install(luceneIndexModule());
+ } else if (indexType.isFake()) {
+ install(fakeIndexModule());
+ }
}
bind(ServerInformationImpl.class);
bind(ServerInformation.class).to(ServerInformationImpl.class);
@@ -260,6 +270,8 @@
install(new ConfigExperimentFeaturesModule());
bind(ProjectOperations.class).to(ProjectOperationsImpl.class);
+ bind(TestGroupBackend.class).in(SINGLETON);
+ DynamicSet.bind(binder(), GroupBackend.class).to(TestGroupBackend.class);
}
/** Copy of SchemaModule with a slightly different server ID provider. */
diff --git a/javatests/com/google/gerrit/acceptance/api/change/ChangeIT.java b/javatests/com/google/gerrit/acceptance/api/change/ChangeIT.java
index db7d302..c5f0d23 100644
--- a/javatests/com/google/gerrit/acceptance/api/change/ChangeIT.java
+++ b/javatests/com/google/gerrit/acceptance/api/change/ChangeIT.java
@@ -85,6 +85,7 @@
import com.google.gerrit.acceptance.VerifyNoPiiInChangeNotes;
import com.google.gerrit.acceptance.config.GerritConfig;
import com.google.gerrit.acceptance.testsuite.account.AccountOperations;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
import com.google.gerrit.acceptance.testsuite.group.GroupOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperations;
@@ -232,6 +233,7 @@
@Inject private ProjectOperations projectOperations;
@Inject private RequestScopeOperations requestScopeOperations;
@Inject private ExtensionRegistry extensionRegistry;
+ @Inject private IndexOperations.Change changeIndexOperations;
@Inject
@Named("diff_intraline")
@@ -3155,11 +3157,8 @@
public void submitStaleChange() throws Exception {
PushOneCommit.Result r = createChange();
- disableChangeIndexWrites();
- try {
+ try (AutoCloseable ignored = changeIndexOperations.disableWrites()) {
r = amendChange(r.getChangeId());
- } finally {
- enableChangeIndexWrites();
}
gApi.changes().id(r.getChangeId()).current().review(ReviewInput.approve());
@@ -4700,7 +4699,7 @@
PushOneCommit.Result change = createChange();
int number = gApi.changes().id(change.getChangeId()).get()._number;
- try (AutoCloseable ignored = disableChangeIndex()) {
+ try (AutoCloseable ignored = changeIndexOperations.disableReadsAndWrites()) {
assertThat(gApi.changes().id(project.get(), number).get(options).changeId)
.isEqualTo(change.getChangeId());
}
diff --git a/javatests/com/google/gerrit/acceptance/api/change/ChangeReviewIT.java b/javatests/com/google/gerrit/acceptance/api/change/ChangeReviewIT.java
new file mode 100644
index 0000000..2b04e56
--- /dev/null
+++ b/javatests/com/google/gerrit/acceptance/api/change/ChangeReviewIT.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.acceptance.api.change;
+
+import com.google.gerrit.acceptance.AbstractDaemonTest;
+import com.google.gerrit.acceptance.PushOneCommit;
+import com.google.gerrit.acceptance.UseSsh;
+import org.junit.Test;
+
+@UseSsh
+public class ChangeReviewIT extends AbstractDaemonTest {
+
+ @Test
+ public void testGerritReviewCommandWithShortNameBranch() throws Exception {
+ PushOneCommit.Result r = createChange();
+ adminSshSession.exec(
+ "gerrit review --project "
+ + r.getChange().change().getProject().get()
+ + " --branch "
+ + r.getChange().change().getDest().shortName()
+ + " --code-review 1 "
+ + r.getCommit().getName());
+ adminSshSession.assertSuccess();
+ }
+
+ @Test
+ public void testGerritReviewCommandWithoutProject() throws Exception {
+ PushOneCommit.Result r = createChange();
+ adminSshSession.exec(
+ "gerrit review"
+ + " --branch "
+ + r.getChange().change().getDest().shortName()
+ + " --code-review 1 "
+ + r.getCommit().getName());
+ adminSshSession.assertSuccess();
+ }
+}
diff --git a/javatests/com/google/gerrit/acceptance/api/change/SubmitRequirementIT.java b/javatests/com/google/gerrit/acceptance/api/change/SubmitRequirementIT.java
index 61e55ff..865dd6c 100644
--- a/javatests/com/google/gerrit/acceptance/api/change/SubmitRequirementIT.java
+++ b/javatests/com/google/gerrit/acceptance/api/change/SubmitRequirementIT.java
@@ -34,6 +34,7 @@
import com.google.gerrit.acceptance.PushOneCommit;
import com.google.gerrit.acceptance.UseTimezone;
import com.google.gerrit.acceptance.VerifyNoPiiInChangeNotes;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate;
import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperations;
@@ -95,6 +96,7 @@
@Inject private ProjectOperations projectOperations;
@Inject private RequestScopeOperations requestScopeOperations;
@Inject private ExtensionRegistry extensionRegistry;
+ @Inject private IndexOperations.Change changeIndexOperations;
@Test
public void submitRecords() throws Exception {
@@ -1049,8 +1051,7 @@
// disable change index writes so that the change in the index gets stale when the new submit
// requirement is added
- disableChangeIndexWrites();
- try {
+ try (AutoCloseable ignored = changeIndexOperations.disableWrites()) {
// Override submit requirement in project (allow uploaders to self approve).
configSubmitRequirement(
project,
@@ -1073,8 +1074,6 @@
assertThat(actions).containsKey("submit");
ActionInfo submitAction = actions.get("submit");
assertThat(submitAction.enabled).isTrue();
- } finally {
- enableChangeIndexWrites();
}
}
diff --git a/javatests/com/google/gerrit/acceptance/api/project/ProjectIndexerIT.java b/javatests/com/google/gerrit/acceptance/api/project/ProjectIndexerIT.java
index e45d95c..a625a70 100644
--- a/javatests/com/google/gerrit/acceptance/api/project/ProjectIndexerIT.java
+++ b/javatests/com/google/gerrit/acceptance/api/project/ProjectIndexerIT.java
@@ -21,6 +21,7 @@
import com.google.common.collect.ImmutableSet;
import com.google.gerrit.acceptance.AbstractDaemonTest;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.entities.Project;
import com.google.gerrit.exceptions.StorageException;
@@ -50,6 +51,7 @@
@Inject private IndexConfig indexConfig;
@Inject private StalenessChecker stalenessChecker;
@Inject private ProjectOperations projectOperations;
+ @Inject private IndexOperations.Project projectIndexOperations;
private static final ImmutableSet<String> FIELDS =
ImmutableSet.of(ProjectField.NAME.getName(), ProjectField.REF_STATE.getName());
@@ -124,7 +126,7 @@
assertThrows(
StorageException.class,
() -> {
- try (AutoCloseable ignored = disableProjectIndex()) {
+ try (AutoCloseable ignored = projectIndexOperations.disableReadsAndWrites()) {
try (ProjectConfigUpdate u = updateProject(project)) {
update.accept(u.getConfig());
u.save();
diff --git a/javatests/com/google/gerrit/acceptance/git/PushPermissionsIT.java b/javatests/com/google/gerrit/acceptance/git/PushPermissionsIT.java
index e76e2f6..f94aa12 100644
--- a/javatests/com/google/gerrit/acceptance/git/PushPermissionsIT.java
+++ b/javatests/com/google/gerrit/acceptance/git/PushPermissionsIT.java
@@ -47,6 +47,7 @@
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.transport.PushResult;
import org.eclipse.jgit.transport.RefSpec;
+import org.eclipse.jgit.transport.RemoteRefUpdate;
import org.eclipse.jgit.transport.RemoteRefUpdate.Status;
import org.eclipse.jgit.transport.TrackingRefUpdate;
import org.junit.Before;
@@ -94,6 +95,32 @@
}
@Test
+ public void pushNewCommitsRequiresPushPermission() throws Exception {
+ testRepo.branch("HEAD").commit().create();
+ projectOperations
+ .project(project)
+ .forUpdate()
+ .add(allow(Permission.CREATE).ref("refs/*").group(REGISTERED_USERS))
+ .update();
+
+ PushResult r = push("HEAD:refs/heads/newbranch");
+
+ String msg = "update for creating new commit object not permitted";
+ RemoteRefUpdate rru = r.getRemoteUpdate("refs/heads/newbranch");
+ assertThat(rru.getStatus()).isNotEqualTo(Status.OK);
+ assertThat(rru.getMessage()).contains(msg);
+
+ projectOperations
+ .project(project)
+ .forUpdate()
+ .add(allow(Permission.PUSH).ref("refs/*").group(REGISTERED_USERS))
+ .update();
+ RemoteRefUpdate success =
+ push("HEAD:refs/heads/newbranch").getRemoteUpdate("refs/heads/newbranch");
+ assertThat(success.getStatus()).isEqualTo(Status.OK);
+ }
+
+ @Test
public void fastForwardUpdateDenied() throws Exception {
testRepo.branch("HEAD").commit().create();
PushResult r = push("HEAD:refs/heads/master");
diff --git a/javatests/com/google/gerrit/acceptance/git/RefAdvertisementIT.java b/javatests/com/google/gerrit/acceptance/git/RefAdvertisementIT.java
index 0905587..f58f81c 100644
--- a/javatests/com/google/gerrit/acceptance/git/RefAdvertisementIT.java
+++ b/javatests/com/google/gerrit/acceptance/git/RefAdvertisementIT.java
@@ -32,6 +32,7 @@
import com.google.gerrit.acceptance.PushOneCommit;
import com.google.gerrit.acceptance.TestAccount;
import com.google.gerrit.acceptance.config.GerritConfig;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperations;
import com.google.gerrit.common.Nullable;
@@ -82,6 +83,7 @@
@Inject private PermissionBackend permissionBackend;
@Inject private ProjectOperations projectOperations;
@Inject private RequestScopeOperations requestScopeOperations;
+ @Inject private IndexOperations.Change changeIndexOperations;
private AccountGroup.UUID admins;
private AccountGroup.UUID nonInteractiveUsers;
@@ -1395,7 +1397,7 @@
public void fetchSingleChangeWithoutIndexAccess() throws Exception {
PushOneCommit.Result change = createChange();
String patchSetRef = change.getPatchSetId().toRefName();
- try (AutoCloseable ignored = disableChangeIndex();
+ try (AutoCloseable ignored = changeIndexOperations.disableReadsAndWrites();
Repository repo = repoManager.openRepository(project)) {
ImmutableList<Ref> singleRef = ImmutableList.of(repo.exactRef(patchSetRef));
ImmutableList<Ref> filteredRefs =
diff --git a/javatests/com/google/gerrit/acceptance/git/SubmoduleSubscriptionsIT.java b/javatests/com/google/gerrit/acceptance/git/SubmoduleSubscriptionsIT.java
index 1c8ca93..d2aab5b 100644
--- a/javatests/com/google/gerrit/acceptance/git/SubmoduleSubscriptionsIT.java
+++ b/javatests/com/google/gerrit/acceptance/git/SubmoduleSubscriptionsIT.java
@@ -22,6 +22,7 @@
import com.google.gerrit.acceptance.PushOneCommit;
import com.google.gerrit.acceptance.UseClockStep;
import com.google.gerrit.acceptance.config.GerritConfig;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.entities.Project;
import com.google.gerrit.entities.RefNames;
@@ -53,6 +54,8 @@
}
@Inject private ProjectOperations projectOperations;
+ @Inject private IndexOperations.Change changeIndexOperations;
+ @Inject private IndexOperations.Account accountIndexOperations;
@Inject private SubmitRuleEvaluator.Factory evaluatorFactory;
@Test
@@ -747,12 +750,10 @@
}
private String getStatus(ChangeData cd) throws Exception {
-
- try (AutoCloseable changeIndex = disableChangeIndex()) {
- try (AutoCloseable accountIndex = disableAccountIndex()) {
- SubmitRuleEvaluator ruleEvaluator = evaluatorFactory.create(SubmitRuleOptions.defaults());
- return ruleEvaluator.evaluate(cd).iterator().next().status.toString();
- }
+ try (AutoCloseable ignored = changeIndexOperations.disableReadsAndWrites();
+ AutoCloseable accountIndex = accountIndexOperations.disableReadsAndWrites()) {
+ SubmitRuleEvaluator ruleEvaluator = evaluatorFactory.create(SubmitRuleOptions.defaults());
+ return ruleEvaluator.evaluate(cd).iterator().next().status.toString();
}
}
diff --git a/javatests/com/google/gerrit/acceptance/rest/TraceIT.java b/javatests/com/google/gerrit/acceptance/rest/TraceIT.java
index 7e40b2b..64e3762 100644
--- a/javatests/com/google/gerrit/acceptance/rest/TraceIT.java
+++ b/javatests/com/google/gerrit/acceptance/rest/TraceIT.java
@@ -374,6 +374,7 @@
}
@Test
+ @GerritConfig(name = "tracing.performanceLogging", value = "true")
public void performanceLoggingForRestCall() throws Exception {
PerformanceLogger testPerformanceLogger = mock(PerformanceLogger.class);
try (Registration registration =
@@ -385,6 +386,7 @@
}
@Test
+ @GerritConfig(name = "tracing.performanceLogging", value = "true")
public void performanceLoggingForPush() throws Exception {
PerformanceLogger testPerformanceLogger = mock(PerformanceLogger.class);
try (Registration registration =
@@ -397,8 +399,7 @@
}
@Test
- @GerritConfig(name = "tracing.performanceLogging", value = "false")
- public void noPerformanceLoggingIfDisabled() throws Exception {
+ public void noPerformanceLoggingByDefault() throws Exception {
PerformanceLogger testPerformanceLogger = mock(PerformanceLogger.class);
try (Registration registration =
extensionRegistry.newRegistration().add(testPerformanceLogger)) {
diff --git a/javatests/com/google/gerrit/acceptance/rest/change/GetMetaDiffIT.java b/javatests/com/google/gerrit/acceptance/rest/change/GetMetaDiffIT.java
index 29dd227..26e37f4 100644
--- a/javatests/com/google/gerrit/acceptance/rest/change/GetMetaDiffIT.java
+++ b/javatests/com/google/gerrit/acceptance/rest/change/GetMetaDiffIT.java
@@ -60,6 +60,21 @@
}
@Test
+ public void metaDiffSubmitReq() throws Exception {
+ PushOneCommit.Result ch = createChange();
+ ChangeApi chApi = gApi.changes().id(ch.getChangeId());
+ ChangeInfo oldInfo = chApi.get();
+ chApi.setHashtags(new HashtagsInput(ImmutableSet.of(HASHTAG)));
+ ChangeInfo newInfo = chApi.get();
+
+ ChangeInfoDifference difference =
+ chApi.metaDiff(oldInfo.metaRevId, newInfo.metaRevId, ListChangesOption.SUBMIT_REQUIREMENTS);
+
+ assertThat(difference.added().submitRequirements).isNull();
+ assertThat(difference.removed().submitRequirements).isNull();
+ }
+
+ @Test
public void metaDiffReturnsSuccessful() throws Exception {
PushOneCommit.Result ch = createChange();
ChangeInfo info = gApi.changes().id(ch.getChangeId()).get();
diff --git a/javatests/com/google/gerrit/acceptance/rest/project/CreateBranchIT.java b/javatests/com/google/gerrit/acceptance/rest/project/CreateBranchIT.java
index 7c51a42..df899ce 100644
--- a/javatests/com/google/gerrit/acceptance/rest/project/CreateBranchIT.java
+++ b/javatests/com/google/gerrit/acceptance/rest/project/CreateBranchIT.java
@@ -31,7 +31,10 @@
import com.google.gerrit.acceptance.AbstractDaemonTest;
import com.google.gerrit.acceptance.ExtensionRegistry;
import com.google.gerrit.acceptance.ExtensionRegistry.Registration;
+import com.google.gerrit.acceptance.PushOneCommit;
import com.google.gerrit.acceptance.RestResponse;
+import com.google.gerrit.acceptance.TestAccount;
+import com.google.gerrit.acceptance.testsuite.group.GroupOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperations;
import com.google.gerrit.entities.Account;
@@ -67,6 +70,7 @@
public class CreateBranchIT extends AbstractDaemonTest {
@Inject private ProjectOperations projectOperations;
@Inject private RequestScopeOperations requestScopeOperations;
+ @Inject private GroupOperations groupOperations;
@Inject private ExtensionRegistry extensionRegistry;
private BranchNameKey testBranch;
@@ -497,6 +501,50 @@
}
}
+ @Test
+ public void createBranchRevisionVisibility() throws Exception {
+ AccountGroup.UUID privilegedGroupUuid =
+ groupOperations.newGroup().name(name("privilegedGroup")).create();
+ TestAccount privilegedUser =
+ accountCreator.create(
+ "privilegedUser", "privilegedUser@example.com", "privilegedUser", null);
+ groupOperations.group(privilegedGroupUuid).forUpdate().addMember(privilegedUser.id()).update();
+ projectOperations
+ .project(project)
+ .forUpdate()
+ .add(block(Permission.READ).ref("refs/heads/secret/*").group(REGISTERED_USERS))
+ .add(allow(Permission.READ).ref("refs/heads/secret/*").group(privilegedGroupUuid))
+ .add(allow(Permission.READ).ref("refs/heads/*").group(REGISTERED_USERS))
+ .add(allow(Permission.CREATE).ref("refs/heads/*").group(REGISTERED_USERS))
+ .add(allow(Permission.PUSH).ref("refs/heads/*").group(REGISTERED_USERS))
+ .update();
+ PushOneCommit push =
+ pushFactory.create(admin.newIdent(), testRepo, "Configure", "file.txt", "contents");
+ PushOneCommit.Result result = push.to("refs/heads/secret/main");
+ result.assertOkStatus();
+ RevCommit secretCommit = result.getCommit();
+ requestScopeOperations.setApiUser(privilegedUser.id());
+ BranchInfo info = gApi.projects().name(project.get()).branch("refs/heads/secret/main").get();
+ assertThat(info.revision).isEqualTo(secretCommit.name());
+ TestAccount unprivileged =
+ accountCreator.create("unprivileged", "unprivileged@example.com", "unprivileged", null);
+ requestScopeOperations.setApiUser(unprivileged.id());
+ assertThrows(
+ ResourceNotFoundException.class,
+ () -> gApi.projects().name(project.get()).branch("refs/heads/secret/main").get());
+ BranchInput branchInput = new BranchInput();
+ branchInput.ref = "public";
+ branchInput.revision = secretCommit.name();
+ assertThrows(
+ AuthException.class,
+ () -> gApi.projects().name(project.get()).branch(branchInput.ref).create(branchInput));
+
+ branchInput.revision = "refs/heads/secret/main";
+ assertThrows(
+ AuthException.class,
+ () -> gApi.projects().name(project.get()).branch(branchInput.ref).create(branchInput));
+ }
+
private void blockCreateReference() throws Exception {
projectOperations
.project(project)
diff --git a/javatests/com/google/gerrit/acceptance/server/change/GetRelatedIT.java b/javatests/com/google/gerrit/acceptance/server/change/GetRelatedIT.java
index fd3ac7f..8bf7443 100644
--- a/javatests/com/google/gerrit/acceptance/server/change/GetRelatedIT.java
+++ b/javatests/com/google/gerrit/acceptance/server/change/GetRelatedIT.java
@@ -31,6 +31,7 @@
import com.google.gerrit.acceptance.UseTimezone;
import com.google.gerrit.acceptance.config.GerritConfig;
import com.google.gerrit.acceptance.testsuite.account.AccountOperations;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
import com.google.gerrit.acceptance.testsuite.group.GroupOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.acceptance.testsuite.request.RequestScopeOperations;
@@ -82,6 +83,7 @@
@Inject private GroupOperations groupOperations;
@Inject private ProjectOperations projectOperations;
@Inject private RequestScopeOperations requestScopeOperations;
+ @Inject private IndexOperations.Change changeIndexOperations;
@Inject private IndexConfig indexConfig;
@Inject private ChangesCollection changes;
@@ -545,11 +547,8 @@
RevCommit c2_2 = testRepo.amend(c2_1).add("b.txt", "2").create();
testRepo.reset(c2_2);
- disableChangeIndexWrites();
- try {
+ try (AutoCloseable ignored = changeIndexOperations.disableWrites()) {
pushHead(testRepo, "refs/for/master", false);
- } finally {
- enableChangeIndexWrites();
}
PatchSet.Id psId1_1 = getPatchSetId(c1_1);
diff --git a/javatests/com/google/gerrit/acceptance/server/experiments/ExperimentFeaturesIT.java b/javatests/com/google/gerrit/acceptance/server/experiments/ExperimentFeaturesIT.java
index 09e6dfe..b2a0ded 100644
--- a/javatests/com/google/gerrit/acceptance/server/experiments/ExperimentFeaturesIT.java
+++ b/javatests/com/google/gerrit/acceptance/server/experiments/ExperimentFeaturesIT.java
@@ -65,7 +65,7 @@
values = {"enabledFeature"})
@GerritConfig(
name = "experiments.disabled",
- values = {"UiFeature__patchset_comments"})
+ values = {"UiFeature__patchset_comments", "UiFeature__submit_requirements_ui"})
public void configOverride_defaultFeatureDisabled() {
assertThat(experimentFeatures.isFeatureEnabled("enabledFeature")).isTrue();
assertThat(
diff --git a/javatests/com/google/gerrit/acceptance/server/rules/RulesIT.java b/javatests/com/google/gerrit/acceptance/server/rules/RulesIT.java
index 3ba7829..4f93dd6 100644
--- a/javatests/com/google/gerrit/acceptance/server/rules/RulesIT.java
+++ b/javatests/com/google/gerrit/acceptance/server/rules/RulesIT.java
@@ -21,6 +21,7 @@
import com.google.gerrit.acceptance.AbstractDaemonTest;
import com.google.gerrit.acceptance.NoHttpd;
import com.google.gerrit.acceptance.PushOneCommit;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
import com.google.gerrit.entities.RefNames;
import com.google.gerrit.entities.SubmitRecord;
@@ -43,6 +44,8 @@
public class RulesIT extends AbstractDaemonTest {
@Inject private ProjectOperations projectOperations;
@Inject private SubmitRuleEvaluator.Factory evaluatorFactory;
+ @Inject private IndexOperations.Change changeIndexOperations;
+ @Inject private IndexOperations.Account accountIndexOperations;
@Test
public void testUnresolvedCommentsCountPredicate() throws Exception {
@@ -240,8 +243,8 @@
ChangeData cd = result.getChange();
Collection<SubmitRecord> records;
- try (AutoCloseable ignored1 = disableChangeIndex();
- AutoCloseable ignored2 = disableAccountIndex()) {
+ try (AutoCloseable ignored1 = changeIndexOperations.disableReadsAndWrites();
+ AutoCloseable ignored2 = accountIndexOperations.disableReadsAndWrites()) {
SubmitRuleEvaluator ruleEvaluator = evaluatorFactory.create(SubmitRuleOptions.defaults());
records = ruleEvaluator.evaluate(cd);
}
diff --git a/javatests/com/google/gerrit/acceptance/ssh/AbstractIndexTests.java b/javatests/com/google/gerrit/acceptance/ssh/AbstractIndexTests.java
index 18c4952..2a06900 100644
--- a/javatests/com/google/gerrit/acceptance/ssh/AbstractIndexTests.java
+++ b/javatests/com/google/gerrit/acceptance/ssh/AbstractIndexTests.java
@@ -26,6 +26,7 @@
import com.google.gerrit.acceptance.PushOneCommit;
import com.google.gerrit.acceptance.UseSsh;
import com.google.gerrit.acceptance.config.GerritConfig;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
import com.google.gerrit.extensions.common.ChangeInfo;
import com.google.gerrit.server.query.change.ChangeData;
import com.google.inject.Inject;
@@ -36,6 +37,7 @@
@UseSsh
public abstract class AbstractIndexTests extends AbstractDaemonTest {
@Inject private ExtensionRegistry extensionRegistry;
+ @Inject private IndexOperations.Change changeIndexOperations;
@Test
@GerritConfig(name = "index.autoReindexIfStale", value = "false")
@@ -49,11 +51,10 @@
String changeLegacyId = change.getChange().getId().toString();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
- disableChangeIndexWrites();
- amendChange(changeId, "second test", "test2.txt", "test2");
-
- assertChangeQuery(change.getChange(), false);
- enableChangeIndexWrites();
+ try (AutoCloseable ignored = changeIndexOperations.disableWrites()) {
+ amendChange(changeId, "second test", "test2.txt", "test2");
+ assertChangeQuery(change.getChange(), false);
+ }
changeIndexedCounter.clear();
String cmd = Joiner.on(" ").join("gerrit", "index", "changes", changeLegacyId);
@@ -77,11 +78,10 @@
String changeId = change.getChangeId();
ChangeInfo changeInfo = gApi.changes().id(changeId).get();
- disableChangeIndexWrites();
- amendChange(changeId, "second test", "test2.txt", "test2");
-
- assertChangeQuery(change.getChange(), false);
- enableChangeIndexWrites();
+ try (AutoCloseable ignored = changeIndexOperations.disableWrites()) {
+ amendChange(changeId, "second test", "test2.txt", "test2");
+ assertChangeQuery(change.getChange(), false);
+ }
changeIndexedCounter.clear();
String cmd = Joiner.on(" ").join("gerrit", "index", "changes-in-project", project.get());
diff --git a/javatests/com/google/gerrit/acceptance/ssh/SshTraceIT.java b/javatests/com/google/gerrit/acceptance/ssh/SshTraceIT.java
index ce5cff7..84c3936 100644
--- a/javatests/com/google/gerrit/acceptance/ssh/SshTraceIT.java
+++ b/javatests/com/google/gerrit/acceptance/ssh/SshTraceIT.java
@@ -23,6 +23,7 @@
import com.google.gerrit.acceptance.ExtensionRegistry;
import com.google.gerrit.acceptance.ExtensionRegistry.Registration;
import com.google.gerrit.acceptance.UseSsh;
+import com.google.gerrit.acceptance.config.GerritConfig;
import com.google.gerrit.server.logging.LoggingContext;
import com.google.gerrit.server.logging.Metadata;
import com.google.gerrit.server.logging.PerformanceLogger;
@@ -92,6 +93,7 @@
}
@Test
+ @GerritConfig(name = "tracing.performanceLogging", value = "true")
public void performanceLoggingForSshCall() throws Exception {
TestPerformanceLogger testPerformanceLogger = new TestPerformanceLogger();
try (Registration registration =
diff --git a/javatests/com/google/gerrit/httpd/raw/IndexServletTest.java b/javatests/com/google/gerrit/httpd/raw/IndexServletTest.java
index 634231f..f65e823 100644
--- a/javatests/com/google/gerrit/httpd/raw/IndexServletTest.java
+++ b/javatests/com/google/gerrit/httpd/raw/IndexServletTest.java
@@ -105,7 +105,7 @@
assertThat(output)
.contains(
"window.ENABLED_EXPERIMENTS = JSON.parse('\\x5b\\x22"
- + String.join("\\x22,", expectedEnabled)
+ + String.join("\\x22,\\x22", expectedEnabled)
+ "\\x22\\x5d');</script>");
}
}
diff --git a/javatests/com/google/gerrit/index/query/AndSourceTest.java b/javatests/com/google/gerrit/index/query/AndSourceTest.java
new file mode 100644
index 0000000..3ae48fb
--- /dev/null
+++ b/javatests/com/google/gerrit/index/query/AndSourceTest.java
@@ -0,0 +1,33 @@
+// 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.index.query;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import com.google.common.collect.Lists;
+import org.junit.Test;
+
+public class AndSourceTest extends PredicateTest {
+ @Test
+ public void ensureLowerCostPredicateRunsFirst() {
+ TestMatchablePredicate p1 = new TestMatchablePredicate("predicate1", "foo", 10);
+ TestMatchablePredicate p2 = new TestMatchablePredicate("predicate2", "foo", 1);
+ AndSource<String> andSource = new AndSource<>(Lists.newArrayList(p1, p2), null);
+ andSource.match("bar");
+ assertFalse(p1.ranMatch);
+ assertTrue(p2.ranMatch);
+ }
+}
diff --git a/javatests/com/google/gerrit/index/query/LazyDataSourceTest.java b/javatests/com/google/gerrit/index/query/LazyDataSourceTest.java
index 7064f64..4105a1d 100644
--- a/javatests/com/google/gerrit/index/query/LazyDataSourceTest.java
+++ b/javatests/com/google/gerrit/index/query/LazyDataSourceTest.java
@@ -17,6 +17,7 @@
import static com.google.gerrit.testing.GerritJUnit.assertThrows;
import com.google.common.collect.ImmutableList;
+import com.google.gerrit.index.IndexConfig;
import com.google.gerrit.server.query.change.ChangeData;
import com.google.gerrit.server.query.change.ChangeDataSource;
import com.google.gerrit.server.query.change.OrSource;
@@ -88,11 +89,17 @@
public void close() {
// No-op
}
+
+ @Override
+ public Object searchAfter() {
+ return null;
+ }
}
@Test
public void andSourceIsLazy() {
- AndSource<ChangeData> and = new AndSource<>(ImmutableList.of(new LazyPredicate()));
+ AndSource<ChangeData> and =
+ new AndSource<>(ImmutableList.of(new LazyPredicate()), IndexConfig.createDefault());
ResultSet<ChangeData> resultSet = and.read();
assertThrows(AssertionError.class, () -> resultSet.toList());
}
diff --git a/javatests/com/google/gerrit/index/query/PredicateTest.java b/javatests/com/google/gerrit/index/query/PredicateTest.java
index 171ca27..8cb8d17 100644
--- a/javatests/com/google/gerrit/index/query/PredicateTest.java
+++ b/javatests/com/google/gerrit/index/query/PredicateTest.java
@@ -18,7 +18,30 @@
@Ignore
public abstract class PredicateTest {
- protected static final class TestPredicate extends OperatorPredicate<String> {
+ @SuppressWarnings("ProtectedMembersInFinalClass")
+ protected static final class TestMatchablePredicate extends TestPredicate
+ implements Matchable<String> {
+ protected int cost;
+ protected boolean ranMatch = false;
+
+ protected TestMatchablePredicate(String name, String value, int cost) {
+ super(name, value);
+ this.cost = cost;
+ }
+
+ @Override
+ public boolean match(String object) {
+ ranMatch = true;
+ return false;
+ }
+
+ @Override
+ public int getCost() {
+ return cost;
+ }
+ }
+
+ protected static class TestPredicate extends OperatorPredicate<String> {
private TestPredicate(String name, String value) {
super(name, value);
}
diff --git a/javatests/com/google/gerrit/index/query/QueryParserTest.java b/javatests/com/google/gerrit/index/query/QueryParserTest.java
index f478803..2ff56a8 100644
--- a/javatests/com/google/gerrit/index/query/QueryParserTest.java
+++ b/javatests/com/google/gerrit/index/query/QueryParserTest.java
@@ -19,6 +19,7 @@
import static com.google.gerrit.index.query.QueryParser.DEFAULT_FIELD;
import static com.google.gerrit.index.query.QueryParser.EXACT_PHRASE;
import static com.google.gerrit.index.query.QueryParser.FIELD_NAME;
+import static com.google.gerrit.index.query.QueryParser.NOT;
import static com.google.gerrit.index.query.QueryParser.SINGLE_WORD;
import static com.google.gerrit.index.query.QueryParser.parse;
import static com.google.gerrit.index.query.testing.TreeSubject.assertThat;
@@ -242,6 +243,119 @@
assertThat(r).child(0).hasText("A backslash \\ in phrase");
}
+ @Test
+ public void fieldNameWithNot() throws Exception {
+ Tree r = parse("-foo:bar");
+ assertThat(r).hasType(NOT);
+ assertThat(r).hasText("NOT");
+ assertThat(r).hasChildCount(1);
+ assertThat(r).child(0).hasType(FIELD_NAME);
+ assertThat(r).child(0).hasText("foo");
+ assertThat(r).child(0).hasChildCount(1);
+ assertThat(r).child(0).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).child(0).hasText("bar");
+ assertThat(r).child(0).child(0).hasNoChildren();
+ }
+
+ @Test
+ public void fieldNameWithDigit() throws Exception {
+ Tree r = parse("foo9:bar");
+ assertThat(r).hasType(DEFAULT_FIELD);
+ assertThat(r).hasChildCount(3);
+ assertThat(r).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).hasText("foo9");
+ assertThat(r).child(0).hasNoChildren();
+ assertThat(r).child(1).hasType(COLON);
+ assertThat(r).child(1).hasText(":");
+ assertThat(r).child(1).hasNoChildren();
+ assertThat(r).child(2).hasType(SINGLE_WORD);
+ assertThat(r).child(2).hasText("bar");
+ assertThat(r).child(2).hasNoChildren();
+ }
+
+ @Test
+ public void fieldNameWithUnderscore() throws Exception {
+ Tree r = parse("foo_bar:baz");
+ assertThat(r).hasType(FIELD_NAME);
+ assertThat(r).hasText("foo_bar");
+ assertThat(r).hasChildCount(1);
+ assertThat(r).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).hasText("baz");
+ assertThat(r).child(0).hasNoChildren();
+ }
+
+ @Test
+ public void fieldNameWithHyphen() throws Exception {
+ Tree r = parse("foo-bar:baz");
+ assertThat(r).hasType(FIELD_NAME);
+ assertThat(r).hasText("foo-bar");
+ assertThat(r).hasChildCount(1);
+ assertThat(r).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).hasText("baz");
+ assertThat(r).child(0).hasNoChildren();
+ }
+
+ @Test
+ public void fieldNameEndingWithHyphen() throws Exception {
+ Tree r = parse("foo-:bar");
+ assertThat(r).hasType(DEFAULT_FIELD);
+ assertThat(r).hasChildCount(3);
+ assertThat(r).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).hasText("foo-");
+ assertThat(r).child(0).hasNoChildren();
+ assertThat(r).child(1).hasType(COLON);
+ assertThat(r).child(1).hasText(":");
+ assertThat(r).child(1).hasNoChildren();
+ assertThat(r).child(2).hasType(SINGLE_WORD);
+ assertThat(r).child(2).hasText("bar");
+ assertThat(r).child(2).hasNoChildren();
+ }
+
+ @Test
+ public void fieldNameWithNotAndHyphen() throws Exception {
+ Tree r = parse("-foo-bar:baz");
+ assertThat(r).hasType(NOT);
+ assertThat(r).hasText("NOT");
+ assertThat(r).hasChildCount(1);
+ assertThat(r).child(0).hasType(FIELD_NAME);
+ assertThat(r).child(0).hasText("foo-bar");
+ assertThat(r).child(0).hasChildCount(1);
+ assertThat(r).child(0).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).child(0).hasText("baz");
+ assertThat(r).child(0).child(0).hasNoChildren();
+ }
+
+ @Test
+ public void fieldNameWithNotAndEndingWithHyphen() throws Exception {
+ Tree r = parse("-foo-bar-:baz");
+ assertThat(r).hasType(NOT);
+ assertThat(r).hasChildCount(1);
+ assertThat(r).child(0).hasType(DEFAULT_FIELD);
+ assertThat(r).child(0).hasChildCount(3);
+ assertThat(r).child(0).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).child(0).hasText("foo-bar-");
+ assertThat(r).child(0).child(0).hasNoChildren();
+ assertThat(r).child(0).child(1).hasType(COLON);
+ assertThat(r).child(0).child(1).hasText(":");
+ assertThat(r).child(0).child(1).hasNoChildren();
+ assertThat(r).child(0).child(2).hasType(SINGLE_WORD);
+ assertThat(r).child(0).child(2).hasText("baz");
+ assertThat(r).child(0).child(2).hasNoChildren();
+ }
+
+ @Test
+ public void fieldNameWithMiscellaneousCharacters() throws Exception {
+ Tree r = parse("-foo-bar_-baz_:qux");
+ assertThat(r).hasType(NOT);
+ assertThat(r).hasChildCount(1);
+ assertThat(r).child(0).hasType(FIELD_NAME);
+ assertThat(r).child(0).hasText("foo-bar_-baz_");
+ assertThat(r).child(0).hasChildCount(1);
+ assertThat(r).child(0).child(0).hasType(SINGLE_WORD);
+ assertThat(r).child(0).child(0).hasText("qux");
+ assertThat(r).child(0).child(0).hasNoChildren();
+ }
+
private static void assertParseFails(String query) {
assertThrows(QueryParseException.class, () -> parse(query));
}
diff --git a/javatests/com/google/gerrit/integration/git/BUILD b/javatests/com/google/gerrit/integration/git/BUILD
index 28755af..86b3f36 100644
--- a/javatests/com/google/gerrit/integration/git/BUILD
+++ b/javatests/com/google/gerrit/integration/git/BUILD
@@ -1,13 +1,32 @@
load("//javatests/com/google/gerrit/acceptance:tests.bzl", "acceptance_tests")
+# TODO(davido): This was only needed as own rule, to provide a dedicated
+# tag to skip Git version v2 protocol tests. That was particularly
+# needed for RBE, because this test assumes that git client version is
+# at least 2.17.1. Once Bazel docker image for Ubuntu 20.04 is available
+# and we removed our own RBE docker image, we can merge this rule with
+# the other rules in this package.
acceptance_tests(
srcs = ["GitProtocolV2IT.java"],
group = "protocol-v2",
labels = ["git-protocol-v2"],
)
+# This rule can be also merged with the other tests in this package.
acceptance_tests(
srcs = ["UploadArchiveIT.java"],
group = "upload-archive",
labels = ["git-upload-archive"],
)
+
+acceptance_tests(
+ srcs = glob(
+ ["*.java"],
+ exclude = [
+ "GitProtocolV2IT.java",
+ "UploadArchiveIT.java",
+ ],
+ ),
+ group = "git_tests",
+ labels = ["git"],
+)
diff --git a/javatests/com/google/gerrit/integration/git/GitProtocolV2IT.java b/javatests/com/google/gerrit/integration/git/GitProtocolV2IT.java
index acf9a50..d40f2a1 100644
--- a/javatests/com/google/gerrit/integration/git/GitProtocolV2IT.java
+++ b/javatests/com/google/gerrit/integration/git/GitProtocolV2IT.java
@@ -16,7 +16,9 @@
import static com.google.common.truth.Truth.assertThat;
import static com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.allow;
+import static com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.allowCapability;
import static com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.deny;
+import static com.google.gerrit.testing.GerritJUnit.assertThrows;
import static java.nio.charset.StandardCharsets.UTF_8;
import com.google.common.collect.ImmutableList;
@@ -27,7 +29,11 @@
import com.google.gerrit.acceptance.StandaloneSiteTest;
import com.google.gerrit.acceptance.TestAccount;
import com.google.gerrit.acceptance.UseSsh;
+import com.google.gerrit.acceptance.testsuite.change.IndexOperations;
+import com.google.gerrit.acceptance.testsuite.group.GroupOperations;
import com.google.gerrit.acceptance.testsuite.project.ProjectOperations;
+import com.google.gerrit.common.data.GlobalCapability;
+import com.google.gerrit.entities.AccountGroup;
import com.google.gerrit.entities.Change;
import com.google.gerrit.entities.PatchSet;
import com.google.gerrit.entities.Permission;
@@ -40,7 +46,10 @@
import com.google.gerrit.server.group.SystemGroupBackend;
import com.google.inject.Inject;
import java.io.File;
+import java.io.IOException;
import java.net.InetSocketAddress;
+import java.util.ArrayList;
+import java.util.List;
import org.eclipse.jgit.lib.Config;
import org.junit.BeforeClass;
import org.junit.Test;
@@ -62,9 +71,11 @@
@Inject private GerritApi gApi;
@Inject private AccountCreator accountCreator;
@Inject private ProjectOperations projectOperations;
+ @Inject private GroupOperations groupOperations;
@Inject private @TestSshServerAddress InetSocketAddress sshAddress;
@Inject private @GerritServerConfig Config config;
@Inject private AllProjectsName allProjectsName;
+ @Inject private IndexOperations.Change changeIndexOperations;
@BeforeClass
public static void assertGitClientVersion() throws Exception {
@@ -86,15 +97,20 @@
Project.NameKey project = Project.nameKey("foo");
gApi.projects().create(project.get());
- // Set up project permission
+ // Clear all permissions for anonymous users. Allow registered users to fetch/push.
+ AccountGroup.UUID admins = groupOperations.newGroup().addMember(admin.id()).create();
projectOperations
- .project(project)
+ .project(allProjectsName)
.forUpdate()
- .add(deny(Permission.READ).ref("refs/heads/*").group(SystemGroupBackend.ANONYMOUS_USERS))
+ .removeAllAccessSections()
.add(
allow(Permission.READ)
.ref("refs/heads/master")
.group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allow(Permission.READ).ref("refs/*").group(admins))
+ .add(allow(Permission.CREATE).ref("refs/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allow(Permission.PUSH).ref("refs/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allowCapability(GlobalCapability.ADMINISTRATE_SERVER).group(admins))
.update();
// Retrieve HTTP url
@@ -211,15 +227,17 @@
Project.NameKey allRefsVisibleProject = Project.nameKey("all-refs-visible");
gApi.projects().create(allRefsVisibleProject.get());
- // Set up project permission to allow reading all refs
+ // Allow registered users to fetch/push. Allow anonymous users to read refs/heads/* which also
+ // allows reading changes.
projectOperations
- .project(allRefsVisibleProject)
+ .project(allProjectsName)
.forUpdate()
+ .removeAllAccessSections()
.add(allow(Permission.READ).ref("refs/heads/*").group(SystemGroupBackend.ANONYMOUS_USERS))
.add(
- allow(Permission.READ)
- .ref("refs/changes/*")
- .group(SystemGroupBackend.ANONYMOUS_USERS))
+ allow(Permission.READ).ref("refs/heads/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allow(Permission.CREATE).ref("refs/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allow(Permission.PUSH).ref("refs/*").group(SystemGroupBackend.REGISTERED_USERS))
.update();
// Create new change and retrieve refs for the created patch set
@@ -265,6 +283,140 @@
Project.NameKey privateProject = Project.nameKey("private-project");
gApi.projects().create(privateProject.get());
+ // Clear all permissions for anonymous users. Allow registered users to fetch/push.
+ projectOperations
+ .project(allProjectsName)
+ .forUpdate()
+ .removeAllAccessSections()
+ .add(
+ allow(Permission.READ).ref("refs/heads/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allow(Permission.CREATE).ref("refs/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allow(Permission.PUSH).ref("refs/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .update();
+
+ // Create new change and retrieve refs for the created patch set
+ ChangeInput visibleChangeIn =
+ new ChangeInput(privateProject.get(), "master", "Test private change");
+ visibleChangeIn.newBranch = true;
+ int visibleChangeNumber = gApi.changes().create(visibleChangeIn).info()._number;
+ Change.Id changeId = Change.id(visibleChangeNumber);
+ String visibleChangeNumberRef = RefNames.patchSetRef(PatchSet.id(changeId, 1));
+
+ // Create new change and retrieve refs for the created patch set. We'll use this to make sure
+ // refs-in-wants only sends us changes we asked for.
+ ChangeInput changeWeDidNotAskForIn =
+ new ChangeInput(privateProject.get(), "stable", "Test private change 2");
+ changeWeDidNotAskForIn.newBranch = true;
+ int changeWeDidNotAskForNumber = gApi.changes().create(changeWeDidNotAskForIn).info()._number;
+ Change.Id changeWeDidNotAskFor = Change.id(changeWeDidNotAskForNumber);
+ String changeWeDidNotAskForRef = RefNames.patchSetRef(PatchSet.id(changeWeDidNotAskFor, 1));
+
+ // Fetch a single ref using git wire protocol v2 over HTTP with authentication
+ execute(GIT_INIT);
+
+ String outFetchRef =
+ execute(
+ ImmutableList.<String>builder()
+ .add(GIT_FETCH)
+ .add(urlWithCredentials + "/" + privateProject.get())
+ .add(visibleChangeNumberRef)
+ .build(),
+ ImmutableMap.of("GIT_TRACE_PACKET", "1"));
+
+ assertThat(outFetchRef).contains("git< version 2");
+ assertThat(outFetchRef).contains(visibleChangeNumberRef);
+ // refs-in-wants should not advertise changes we did not ask for
+ assertThat(outFetchRef).doesNotContain(changeWeDidNotAskForRef);
+ }
+ }
+
+ @Test
+ public void testGitWireProtocolV2FetchIndividualRef_doesNotNeedChangeIndex() throws Exception {
+ try (ServerContext ctx = startServer()) {
+ ctx.getInjector().injectMembers(this);
+
+ // Setup admin password
+ gApi.accounts().id(admin.username()).setHttpPassword(ADMIN_PASSWORD);
+
+ // Get authenticated Git/HTTP URL
+ String urlWithCredentials =
+ config
+ .getString("gerrit", null, "canonicalweburl")
+ .replace("http://", "http://" + admin.username() + ":" + ADMIN_PASSWORD + "@");
+
+ // Create project
+ Project.NameKey privateProject = Project.nameKey("private-project");
+ gApi.projects().create(privateProject.get());
+
+ // Disallow general read permissions for anonymous users
+ projectOperations
+ .project(allProjectsName)
+ .forUpdate()
+ .add(deny(Permission.READ).ref("refs/*").group(SystemGroupBackend.ANONYMOUS_USERS))
+ .add(
+ allow(Permission.READ)
+ .ref("refs/heads/master")
+ .group(SystemGroupBackend.REGISTERED_USERS))
+ .update();
+
+ // Create new change and retrieve refs for the created patch set
+ ChangeInput visibleChangeIn =
+ new ChangeInput(privateProject.get(), "master", "Test private change");
+ visibleChangeIn.newBranch = true;
+ int visibleChangeNumber = gApi.changes().create(visibleChangeIn).info()._number;
+ Change.Id changeId = Change.id(visibleChangeNumber);
+ String visibleChangeNumberRef = RefNames.patchSetRef(PatchSet.id(changeId, 1));
+
+ // Create new change and retrieve refs for the created patch set. We'll use this to make sure
+ // refs-in-wants only sends us changes we asked for.
+ ChangeInput changeWeDidNotAskForIn =
+ new ChangeInput(privateProject.get(), "stable", "Test private change 2");
+ changeWeDidNotAskForIn.newBranch = true;
+ int changeWeDidNotAskForNumber = gApi.changes().create(changeWeDidNotAskForIn).info()._number;
+ Change.Id changeWeDidNotAskFor = Change.id(changeWeDidNotAskForNumber);
+ String changeWeDidNotAskForRef = RefNames.patchSetRef(PatchSet.id(changeWeDidNotAskFor, 1));
+
+ // Fetch a single ref using git wire protocol v2 over HTTP with authentication
+ execute(GIT_INIT);
+
+ String outFetchRef;
+ try (AutoCloseable ignored = changeIndexOperations.disableReadsAndWrites()) {
+ outFetchRef =
+ execute(
+ ImmutableList.<String>builder()
+ .add(GIT_FETCH)
+ .add(urlWithCredentials + "/" + privateProject.get())
+ .add(visibleChangeNumberRef)
+ .build(),
+ ImmutableMap.of("GIT_TRACE_PACKET", "1"));
+ }
+
+ assertThat(outFetchRef).contains("git< version 2");
+ assertThat(outFetchRef).contains(visibleChangeNumberRef);
+ // refs-in-wants should not advertise changes we did not ask for
+ assertThat(outFetchRef).doesNotContain(changeWeDidNotAskForRef);
+ }
+ }
+
+ @Test
+ public void testGitWireProtocolV2FetchIndividualRef_doesNotNeedNoteDbWhenAskedForManyChanges()
+ throws Exception {
+ try (ServerContext ctx = startServer()) {
+ ctx.getInjector().injectMembers(this);
+
+ // Setup admin password
+ gApi.accounts().id(admin.username()).setHttpPassword(ADMIN_PASSWORD);
+
+ // Get authenticated Git/HTTP URL
+ String urlWithCredentials =
+ config
+ .getString("gerrit", null, "canonicalweburl")
+ .replace("http://", "http://" + admin.username() + ":" + ADMIN_PASSWORD + "@");
+
+ // Create project
+ Project.NameKey privateProject = Project.nameKey("private-project");
+ gApi.projects().create(privateProject.get());
+
// Disallow general read permissions for anonymous users
projectOperations
.project(allProjectsName)
@@ -286,28 +438,125 @@
.group(SystemGroupBackend.REGISTERED_USERS))
.update();
- // Create new change and retrieve refs for the created patch set
- ChangeInput visibleChangeIn =
- new ChangeInput(privateProject.get(), "master", "Test private change");
- visibleChangeIn.newBranch = true;
- int visibleChangeNumber = gApi.changes().create(visibleChangeIn).info()._number;
- Change.Id changeId = Change.id(visibleChangeNumber);
- String visibleChangeNumberRef = RefNames.patchSetRef(PatchSet.id(changeId, 1));
+ List<String> changeRefs = new ArrayList<>();
+ for (int i = 0; i < 10; i++) {
+ // Create new change and retrieve refs for the created patch set
+ ChangeInput visibleChangeIn =
+ new ChangeInput(privateProject.get(), "master", "Test private change");
+ visibleChangeIn.newBranch = true;
+ int visibleChangeNumber = gApi.changes().create(visibleChangeIn).info()._number;
+ Change.Id changeId = Change.id(visibleChangeNumber);
+ changeRefs.add(RefNames.patchSetRef(PatchSet.id(changeId, 1)));
+ }
// Fetch a single ref using git wire protocol v2 over HTTP with authentication
execute(GIT_INIT);
+ try (AutoCloseable ignored = changeIndexOperations.disableReadsAndWrites()) {
+ // Since we ask for many changes at once, the server will use the change index to speed up
+ // filtering. Having that disabled fails.
+ assertThrows(
+ IOException.class,
+ () ->
+ execute(
+ ImmutableList.<String>builder()
+ .add(GIT_FETCH)
+ .add(urlWithCredentials + "/" + privateProject.get())
+ .addAll(changeRefs)
+ .build(),
+ ImmutableMap.of("GIT_TRACE_PACKET", "1")));
+ }
+
+ // The same call succeeds if the change index is enabled.
String outFetchRef =
execute(
ImmutableList.<String>builder()
.add(GIT_FETCH)
.add(urlWithCredentials + "/" + privateProject.get())
- .add(visibleChangeNumberRef)
+ .addAll(changeRefs)
.build(),
ImmutableMap.of("GIT_TRACE_PACKET", "1"));
+ assertThat(outFetchRef).contains("git< version 2");
+ assertThat(outFetchRef).contains(changeRefs.get(0));
+ }
+ }
+
+ @Test
+ public void testGitWireProtocolV2FetchIndividualRef_anonymousCantSeeInvisibleChange()
+ throws Exception {
+ try (ServerContext ctx = startServer()) {
+ ctx.getInjector().injectMembers(this);
+
+ // Setup admin password
+ gApi.accounts().id(admin.username()).setHttpPassword(ADMIN_PASSWORD);
+
+ String url = config.getString("gerrit", null, "canonicalweburl");
+
+ // Create project
+ Project.NameKey privateProject = Project.nameKey("private-project");
+ gApi.projects().create(privateProject.get());
+
+ // Disallow general read permissions for anonymous users except on master
+ projectOperations
+ .project(allProjectsName)
+ .forUpdate()
+ .removeAllAccessSections()
+ .add(
+ allow(Permission.READ)
+ .ref("refs/heads/master")
+ .group(SystemGroupBackend.ANONYMOUS_USERS))
+ .add(
+ allow(Permission.READ).ref("refs/heads/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allow(Permission.CREATE).ref("refs/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .add(allow(Permission.PUSH).ref("refs/*").group(SystemGroupBackend.REGISTERED_USERS))
+ .update();
+
+ // Create new change and retrieve refs for the created patch set
+ ChangeInput visibleChangeIn = new ChangeInput(privateProject.get(), "master", "Visible");
+ visibleChangeIn.newBranch = true;
+ int visibleChangeNumber = gApi.changes().create(visibleChangeIn).info()._number;
+ Change.Id changeId = Change.id(visibleChangeNumber);
+ String visibleChangeNumberRef = RefNames.patchSetRef(PatchSet.id(changeId, 1));
+
+ // Create new change and retrieve refs for the created patch set. We'll use this to make sure
+ // refs-in-wants only sends us changes we asked for.
+ ChangeInput invisibleChangeIn = new ChangeInput(privateProject.get(), "stable", "Invisible");
+ invisibleChangeIn.newBranch = true;
+ int invisibleChangeNumber = gApi.changes().create(invisibleChangeIn).info()._number;
+ Change.Id invisibleChange = Change.id(invisibleChangeNumber);
+ String invisibleChangeRef = RefNames.patchSetRef(PatchSet.id(invisibleChange, 1));
+
+ // Fetch a single ref using git wire protocol v2 over HTTP with authentication
+ execute(GIT_INIT);
+
+ String outFetchRef;
+ try (AutoCloseable ignored = changeIndexOperations.disableReadsAndWrites()) {
+ outFetchRef =
+ execute(
+ ImmutableList.<String>builder()
+ .add(GIT_FETCH)
+ .add(url + "/" + privateProject.get())
+ .add(visibleChangeNumberRef)
+ .build(),
+ ImmutableMap.of("GIT_TRACE_PACKET", "1"));
+ }
assertThat(outFetchRef).contains("git< version 2");
assertThat(outFetchRef).contains(visibleChangeNumberRef);
+
+ try (AutoCloseable ignored = changeIndexOperations.disableReadsAndWrites()) {
+ // Fetching invisible ref fails
+ assertThrows(
+ IOException.class,
+ () ->
+ execute(
+ ImmutableList.<String>builder()
+ .add(GIT_FETCH)
+ .add(url + "/" + privateProject.get())
+ .add(invisibleChangeRef)
+ .build(),
+ ImmutableMap.of("GIT_TRACE_PACKET", "1")));
+ }
}
}
diff --git a/javatests/com/google/gerrit/integration/git/PushToRefsUsersIT.java b/javatests/com/google/gerrit/integration/git/PushToRefsUsersIT.java
new file mode 100644
index 0000000..c42f00d
--- /dev/null
+++ b/javatests/com/google/gerrit/integration/git/PushToRefsUsersIT.java
@@ -0,0 +1,111 @@
+// 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.integration.git;
+
+import static com.google.common.truth.Truth.assertThat;
+import static java.nio.charset.StandardCharsets.UTF_8;
+
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+import com.google.gerrit.acceptance.StandaloneSiteTest;
+import com.google.gerrit.extensions.api.GerritApi;
+import com.google.gerrit.server.config.AllUsersName;
+import com.google.gerrit.server.config.GerritServerConfig;
+import com.google.inject.Inject;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
+import org.eclipse.jgit.lib.Config;
+import org.junit.Test;
+
+// TODO(davido): In addition to push over HTTP also add a test for push over SSH
+public class PushToRefsUsersIT extends StandaloneSiteTest {
+ private static final String ADMIN_PASSWORD = "secret";
+ private final String[] GIT_CLONE = new String[] {"git", "clone"};
+ private final String[] GIT_FETCH_USERS_SELF =
+ new String[] {"git", "fetch", "origin", "refs/users/self"};
+ private final String[] GIT_CO_FETCH_HEAD = new String[] {"git", "checkout", "FETCH_HEAD"};
+ private final String[] GIT_CONFIG_USER_EMAIL =
+ new String[] {"git", "config", "user.email", "admin@example.com"};
+ private final String[] GIT_CONFIG_USER_NAME =
+ new String[] {"git", "config", "user.name", "Administrator"};
+ private final String[] GIT_COMMIT = new String[] {"git", "commit", "-am", "OOO"};
+ private final String[] GIT_PUSH_USERS_SELF =
+ new String[] {"git", "push", "origin", "HEAD:refs/users/self"};
+
+ @Inject private GerritApi gApi;
+ @Inject private @GerritServerConfig Config config;
+ @Inject private AllUsersName allUsersName;
+
+ @Test
+ public void testPushToRefsUsersOverHttp() throws Exception {
+ try (ServerContext ctx = startServer()) {
+ ctx.getInjector().injectMembers(this);
+
+ // Setup admin password
+ gApi.accounts().id(admin.username()).setHttpPassword(ADMIN_PASSWORD);
+
+ // Get authenticated Git/HTTP URL
+ String urlWithCredentials =
+ config
+ .getString("gerrit", null, "canonicalweburl")
+ .replace("http://", "http://" + admin.username() + ":" + ADMIN_PASSWORD + "@");
+
+ // Clone All-Users repository
+ execute(
+ ImmutableList.<String>builder()
+ .add(GIT_CLONE)
+ .add(urlWithCredentials + "/a/" + allUsersName)
+ .add(sitePaths.data_dir.toFile().getAbsolutePath())
+ .build(),
+ sitePaths.site_path);
+
+ // Fetch refs/users/self for admin user
+ execute(GIT_FETCH_USERS_SELF);
+
+ // Checkout FETCH_HEAD
+ execute(GIT_CO_FETCH_HEAD);
+
+ // Set admin user status to OOO
+ Files.write(
+ sitePaths.data_dir.resolve("account.config"),
+ " status = OOO".getBytes(UTF_8),
+ StandardOpenOption.APPEND);
+
+ // Set user email
+ execute(GIT_CONFIG_USER_EMAIL);
+
+ // Set user name
+ execute(GIT_CONFIG_USER_NAME);
+
+ // Commit
+ execute(GIT_COMMIT);
+
+ // Push
+ assertThat(execute(GIT_PUSH_USERS_SELF)).contains("Processing changes: refs: 1, done");
+
+ // Verify user status
+ assertThat(gApi.accounts().id(admin.id().get()).detail().status).isEqualTo("OOO");
+ }
+ }
+
+ private String execute(String... cmds) throws Exception {
+ return execute(ImmutableList.<String>builder().add(cmds).build(), sitePaths.data_dir);
+ }
+
+ private String execute(ImmutableList<String> cmd, Path path) throws Exception {
+ return execute(cmd, path.toFile(), ImmutableMap.of());
+ }
+}
diff --git a/javatests/com/google/gerrit/metrics/dropwizard/BUILD b/javatests/com/google/gerrit/metrics/dropwizard/BUILD
index 98d12b2..e236f30 100644
--- a/javatests/com/google/gerrit/metrics/dropwizard/BUILD
+++ b/javatests/com/google/gerrit/metrics/dropwizard/BUILD
@@ -6,7 +6,10 @@
tags = ["metrics"],
visibility = ["//visibility:public"],
deps = [
+ "//java/com/google/gerrit/metrics",
"//java/com/google/gerrit/metrics/dropwizard",
+ "//lib/mockito",
"//lib/truth",
+ "@dropwizard-core//jar",
],
)
diff --git a/javatests/com/google/gerrit/metrics/dropwizard/DropWizardMetricMakerTest.java b/javatests/com/google/gerrit/metrics/dropwizard/DropWizardMetricMakerTest.java
index 9b21bf6..5777779 100644
--- a/javatests/com/google/gerrit/metrics/dropwizard/DropWizardMetricMakerTest.java
+++ b/javatests/com/google/gerrit/metrics/dropwizard/DropWizardMetricMakerTest.java
@@ -15,12 +15,33 @@
package com.google.gerrit.metrics.dropwizard;
import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import com.codahale.metrics.MetricRegistry;
+import com.google.gerrit.metrics.Description;
+import com.google.gerrit.metrics.MetricsReservoirConfig;
+import com.google.gerrit.metrics.ReservoirType;
+import org.junit.Before;
import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+@RunWith(MockitoJUnitRunner.class)
public class DropWizardMetricMakerTest {
- DropWizardMetricMaker metrics =
- new DropWizardMetricMaker(null /* MetricRegistry unused in tests */);
+
+ @Mock MetricsReservoirConfig reservoirConfigMock;
+
+ MetricRegistry registry;
+
+ DropWizardMetricMaker metrics;
+
+ @Before
+ public void setupMocks() {
+ registry = new MetricRegistry();
+ metrics = new DropWizardMetricMaker(registry, reservoirConfigMock);
+ }
@Test
public void shouldSanitizeUnwantedChars() throws Exception {
@@ -41,4 +62,15 @@
assertThat(metrics.sanitizeMetricName("metric//")).isEqualTo("metric");
assertThat(metrics.sanitizeMetricName("metric/submetric/")).isEqualTo("metric/submetric");
}
+
+ @Test
+ public void shouldRequestForReservoirForNewTimer() throws Exception {
+ when(reservoirConfigMock.reservoirType()).thenReturn(ReservoirType.ExponentiallyDecaying);
+
+ metrics.newTimer(
+ "foo",
+ new Description("foo description").setCumulative().setUnit(Description.Units.MILLISECONDS));
+
+ verify(reservoirConfigMock).reservoirType();
+ }
}
diff --git a/javatests/com/google/gerrit/metrics/dropwizard/DropWizardReservoirProviderTest.java b/javatests/com/google/gerrit/metrics/dropwizard/DropWizardReservoirProviderTest.java
new file mode 100644
index 0000000..6402b53
--- /dev/null
+++ b/javatests/com/google/gerrit/metrics/dropwizard/DropWizardReservoirProviderTest.java
@@ -0,0 +1,64 @@
+// 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.metrics.dropwizard;
+
+import static com.google.common.truth.Truth.assertThat;
+import static org.mockito.Mockito.when;
+
+import com.codahale.metrics.ExponentiallyDecayingReservoir;
+import com.codahale.metrics.SlidingTimeWindowArrayReservoir;
+import com.codahale.metrics.SlidingTimeWindowReservoir;
+import com.codahale.metrics.SlidingWindowReservoir;
+import com.codahale.metrics.UniformReservoir;
+import com.google.gerrit.metrics.MetricsReservoirConfig;
+import com.google.gerrit.metrics.ReservoirType;
+import java.time.Duration;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+@RunWith(MockitoJUnitRunner.class)
+public class DropWizardReservoirProviderTest {
+ private static final int SLIDING_WINDOW_INTERVAL = 1;
+ private static final int SLIDING_WINDOW_SIZE = 256;
+
+ @Mock private MetricsReservoirConfig configMock;
+
+ @Test
+ public void shouldInstantiateReservoirProviderBasedOnMetricsConfig() {
+ when(configMock.reservoirType()).thenReturn(ReservoirType.ExponentiallyDecaying);
+ assertThat(DropWizardReservoirProvider.get(configMock))
+ .isInstanceOf(ExponentiallyDecayingReservoir.class);
+
+ when(configMock.reservoirType()).thenReturn(ReservoirType.SlidingTimeWindow);
+ when(configMock.reservoirWindow()).thenReturn(Duration.ofMinutes(1));
+ assertThat(DropWizardReservoirProvider.get(configMock))
+ .isInstanceOf(SlidingTimeWindowReservoir.class);
+
+ when(configMock.reservoirType()).thenReturn(ReservoirType.SlidingTimeWindowArray);
+ when(configMock.reservoirWindow()).thenReturn(Duration.ofMinutes(SLIDING_WINDOW_INTERVAL));
+ assertThat(DropWizardReservoirProvider.get(configMock))
+ .isInstanceOf(SlidingTimeWindowArrayReservoir.class);
+
+ when(configMock.reservoirType()).thenReturn(ReservoirType.SlidingWindow);
+ when(configMock.reservoirSize()).thenReturn(SLIDING_WINDOW_SIZE);
+ assertThat(DropWizardReservoirProvider.get(configMock))
+ .isInstanceOf(SlidingWindowReservoir.class);
+
+ when(configMock.reservoirType()).thenReturn(ReservoirType.Uniform);
+ assertThat(DropWizardReservoirProvider.get(configMock)).isInstanceOf(UniformReservoir.class);
+ }
+}
diff --git a/javatests/com/google/gerrit/metrics/proc/ProcMetricModuleTest.java b/javatests/com/google/gerrit/metrics/proc/ProcMetricModuleTest.java
index 33919e7..ea89ae9 100644
--- a/javatests/com/google/gerrit/metrics/proc/ProcMetricModuleTest.java
+++ b/javatests/com/google/gerrit/metrics/proc/ProcMetricModuleTest.java
@@ -17,6 +17,7 @@
import static com.google.common.truth.Truth.assertThat;
import static com.google.common.truth.Truth.assertWithMessage;
import static com.google.gerrit.testing.GerritJUnit.assertThrows;
+import static org.mockito.Mockito.mock;
import com.codahale.metrics.Counter;
import com.codahale.metrics.Gauge;
@@ -31,7 +32,9 @@
import com.google.gerrit.metrics.Description.FieldOrdering;
import com.google.gerrit.metrics.Field;
import com.google.gerrit.metrics.MetricMaker;
+import com.google.gerrit.metrics.MetricsReservoirConfig;
import com.google.gerrit.metrics.dropwizard.DropWizardMetricMaker;
+import com.google.inject.AbstractModule;
import com.google.inject.Guice;
import com.google.inject.Inject;
import com.google.inject.Injector;
@@ -179,7 +182,14 @@
@Before
public void setup() {
- Injector injector = Guice.createInjector(new DropWizardMetricMaker.ApiModule());
+ Injector injector =
+ Guice.createInjector(
+ new AbstractModule() {
+ @Override
+ protected void configure() {
+ install(new DropWizardMetricMaker.ApiModule(mock(MetricsReservoirConfig.class)));
+ }
+ });
LifecycleManager mgr = new LifecycleManager();
mgr.add(injector);
diff --git a/javatests/com/google/gerrit/server/cache/BUILD b/javatests/com/google/gerrit/server/cache/BUILD
index b3b2f5a..c708e09 100644
--- a/javatests/com/google/gerrit/server/cache/BUILD
+++ b/javatests/com/google/gerrit/server/cache/BUILD
@@ -7,8 +7,11 @@
deps = [
"//java/com/google/gerrit/server",
"//java/com/google/gerrit/testing:gerrit-test-util",
+ "//javatests/com/google/gerrit/util/http/testutil",
"//lib:junit",
"//lib/truth",
+ "//lib/truth:truth-java8-extension",
+ "@servlet-api//jar",
],
)
diff --git a/javatests/com/google/gerrit/server/cache/PerThreadCacheTest.java b/javatests/com/google/gerrit/server/cache/PerThreadCacheTest.java
index 5d420d3..1bb9784 100644
--- a/javatests/com/google/gerrit/server/cache/PerThreadCacheTest.java
+++ b/javatests/com/google/gerrit/server/cache/PerThreadCacheTest.java
@@ -15,6 +15,7 @@
package com.google.gerrit.server.cache;
import static com.google.common.truth.Truth.assertThat;
+import static com.google.common.truth.Truth8.assertThat;
import static com.google.gerrit.testing.GerritJUnit.assertThrows;
import java.util.function.Supplier;
diff --git a/javatests/com/google/gerrit/server/events/EventTypesTest.java b/javatests/com/google/gerrit/server/events/EventTypesTest.java
index c822d6c..7e97f184 100644
--- a/javatests/com/google/gerrit/server/events/EventTypesTest.java
+++ b/javatests/com/google/gerrit/server/events/EventTypesTest.java
@@ -48,4 +48,16 @@
Class<?> clazz = EventTypes.getClass("does-not-exist-event");
assertThat(clazz).isNull();
}
+
+ @Test
+ public void getRegisteredEventsGetsANewlyRegisteredEvent() {
+ EventTypes.register(TestEvent.TYPE, TestEvent.class);
+ assertThat(EventTypes.getRegisteredEvents()).containsEntry(TestEvent.TYPE, TestEvent.class);
+ }
+
+ @Test
+ public void getRegisteredEventsGetsTypeGivenAtRegistration() {
+ EventTypes.register("alternate-type", TestEvent.class);
+ assertThat(EventTypes.getRegisteredEvents()).containsEntry("alternate-type", TestEvent.class);
+ }
}
diff --git a/javatests/com/google/gerrit/server/git/RepoRefCacheTest.java b/javatests/com/google/gerrit/server/git/RepoRefCacheTest.java
new file mode 100644
index 0000000..2bc6b92
--- /dev/null
+++ b/javatests/com/google/gerrit/server/git/RepoRefCacheTest.java
@@ -0,0 +1,274 @@
+// 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.git;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import java.io.IOException;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+import org.eclipse.jgit.attributes.AttributesNodeProvider;
+import org.eclipse.jgit.internal.storage.dfs.DfsRepositoryDescription;
+import org.eclipse.jgit.internal.storage.dfs.InMemoryRepository;
+import org.eclipse.jgit.junit.TestRepository;
+import org.eclipse.jgit.lib.BatchRefUpdate;
+import org.eclipse.jgit.lib.Constants;
+import org.eclipse.jgit.lib.ObjectDatabase;
+import org.eclipse.jgit.lib.Ref;
+import org.eclipse.jgit.lib.RefDatabase;
+import org.eclipse.jgit.lib.RefRename;
+import org.eclipse.jgit.lib.RefUpdate;
+import org.eclipse.jgit.lib.ReflogReader;
+import org.eclipse.jgit.lib.Repository;
+import org.eclipse.jgit.lib.StoredConfig;
+import org.eclipse.jgit.util.FS;
+import org.junit.Test;
+
+public class RepoRefCacheTest {
+ private static final String TEST_BRANCH = "main";
+
+ @Test
+ @SuppressWarnings("resource")
+ public void repositoryUseShouldBeTrackedByRepoRefCache() throws Exception {
+ RefCache cache;
+ TestRepositoryWithRefCounting repoWithRefCounting;
+
+ try (TestRepositoryWithRefCounting repo =
+ TestRepositoryWithRefCounting.createWithBranch(TEST_BRANCH)) {
+ assertThat(repo.refCounter()).isEqualTo(1);
+ repoWithRefCounting = repo;
+ cache = new RepoRefCache(repo);
+ }
+
+ assertThat(repoWithRefCounting.refCounter()).isEqualTo(1);
+ assertThat(cache.get(Constants.R_HEADS + TEST_BRANCH)).isNotNull();
+ }
+
+ private static class TestRepositoryWithRefCounting extends Repository {
+ private int refCounter;
+
+ static TestRepositoryWithRefCounting createWithBranch(String branchName) throws Exception {
+ InMemoryRepository.Builder builder =
+ new InMemoryRepository.Builder()
+ .setRepositoryDescription(new DfsRepositoryDescription(""))
+ .setFS(FS.detect().setUserHome(null));
+ TestRepositoryWithRefCounting testRepo = new TestRepositoryWithRefCounting(builder);
+ new TestRepository<>(testRepo).branch(branchName).commit().message("").create();
+ return testRepo;
+ }
+
+ private final Repository repo;
+
+ private TestRepositoryWithRefCounting(InMemoryRepository.Builder builder) throws IOException {
+ super(builder);
+
+ repo = builder.build();
+ refCounter = 1;
+ }
+
+ public int refCounter() {
+ return refCounter;
+ }
+
+ @Override
+ public void incrementOpen() {
+ repo.incrementOpen();
+ refCounter++;
+ }
+
+ @Override
+ public void close() {
+ repo.close();
+ refCounter--;
+ }
+
+ @Override
+ public void create(boolean bare) throws IOException {}
+
+ @Override
+ public ObjectDatabase getObjectDatabase() {
+ checkIsOpen();
+ return repo.getObjectDatabase();
+ }
+
+ @Override
+ public RefDatabase getRefDatabase() {
+ RefDatabase refDatabase = repo.getRefDatabase();
+ return new RefDatabase() {
+
+ @Override
+ public int hashCode() {
+ return refDatabase.hashCode();
+ }
+
+ @Override
+ public void create() throws IOException {
+ refDatabase.create();
+ }
+
+ @Override
+ public void close() {
+ checkIsOpen();
+ refDatabase.close();
+ }
+
+ @Override
+ public boolean isNameConflicting(String name) throws IOException {
+ checkIsOpen();
+ return refDatabase.isNameConflicting(name);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ return refDatabase.equals(obj);
+ }
+
+ @Override
+ public Collection<String> getConflictingNames(String name) throws IOException {
+ checkIsOpen();
+ return refDatabase.getConflictingNames(name);
+ }
+
+ @Override
+ public RefUpdate newUpdate(String name, boolean detach) throws IOException {
+ checkIsOpen();
+ return refDatabase.newUpdate(name, detach);
+ }
+
+ @Override
+ public RefRename newRename(String fromName, String toName) throws IOException {
+ checkIsOpen();
+ return refDatabase.newRename(fromName, toName);
+ }
+
+ @Override
+ public BatchRefUpdate newBatchUpdate() {
+ checkIsOpen();
+ return refDatabase.newBatchUpdate();
+ }
+
+ @Override
+ public boolean performsAtomicTransactions() {
+ checkIsOpen();
+ return refDatabase.performsAtomicTransactions();
+ }
+
+ @Override
+ public Ref exactRef(String name) throws IOException {
+ checkIsOpen();
+ return refDatabase.exactRef(name);
+ }
+
+ @Override
+ public String toString() {
+ return refDatabase.toString();
+ }
+
+ @Override
+ public Map<String, Ref> exactRef(String... refs) throws IOException {
+ checkIsOpen();
+ return refDatabase.exactRef(refs);
+ }
+
+ @Override
+ public Ref firstExactRef(String... refs) throws IOException {
+ checkIsOpen();
+ return refDatabase.firstExactRef(refs);
+ }
+
+ @Override
+ public List<Ref> getRefs() throws IOException {
+ checkIsOpen();
+ return refDatabase.getRefs();
+ }
+
+ @Override
+ public Map<String, Ref> getRefs(String prefix) throws IOException {
+ checkIsOpen();
+ return refDatabase.getRefs(prefix);
+ }
+
+ @Override
+ public List<Ref> getRefsByPrefix(String prefix) throws IOException {
+ checkIsOpen();
+ return refDatabase.getRefsByPrefix(prefix);
+ }
+
+ @Override
+ public boolean hasRefs() throws IOException {
+ checkIsOpen();
+ return refDatabase.hasRefs();
+ }
+
+ @Override
+ public List<Ref> getAdditionalRefs() throws IOException {
+ checkIsOpen();
+ return refDatabase.getAdditionalRefs();
+ }
+
+ @Override
+ public Ref peel(Ref ref) throws IOException {
+ checkIsOpen();
+ return refDatabase.peel(ref);
+ }
+
+ @Override
+ public void refresh() {
+ checkIsOpen();
+ refDatabase.refresh();
+ }
+ };
+ }
+
+ @Override
+ public StoredConfig getConfig() {
+ return repo.getConfig();
+ }
+
+ @Override
+ public AttributesNodeProvider createAttributesNodeProvider() {
+ checkIsOpen();
+ return repo.createAttributesNodeProvider();
+ }
+
+ @Override
+ public void scanForRepoChanges() throws IOException {
+ checkIsOpen();
+ }
+
+ @Override
+ public void notifyIndexChanged(boolean internal) {
+ checkIsOpen();
+ }
+
+ @Override
+ public ReflogReader getReflogReader(String refName) throws IOException {
+ checkIsOpen();
+ return repo.getReflogReader(refName);
+ }
+
+ private void checkIsOpen() {
+ if (refCounter <= 0) {
+ throw new IllegalStateException("Repository is not open (refCounter=" + refCounter + ")");
+ }
+ }
+
+ @Override
+ public String getIdentifier() {
+ return "foo";
+ }
+ }
+}
diff --git a/javatests/com/google/gerrit/server/git/delegate/DelegateRepositoryTest.java b/javatests/com/google/gerrit/server/git/delegate/DelegateRepositoryTest.java
new file mode 100644
index 0000000..74e0fac
--- /dev/null
+++ b/javatests/com/google/gerrit/server/git/delegate/DelegateRepositoryTest.java
@@ -0,0 +1,41 @@
+// 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.git.delegate;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.gerrit.entities.Project;
+import com.google.gerrit.server.git.DelegateRepository;
+import com.google.gerrit.testing.InMemoryRepositoryManager;
+import java.io.IOException;
+import org.eclipse.jgit.lib.Repository;
+import org.junit.Test;
+
+public class DelegateRepositoryTest {
+
+ @Test
+ public void shouldDelegateRepositoryFromAnyPackage() throws IOException {
+ Repository foo = new InMemoryRepositoryManager().createRepository(Project.nameKey("foo"));
+ try (TestDelegateRepository delegateRepository = new TestDelegateRepository(foo)) {
+ assertThat(delegateRepository.delegate()).isSameInstanceAs(foo);
+ }
+ }
+
+ static class TestDelegateRepository extends DelegateRepository {
+ protected TestDelegateRepository(Repository delegate) {
+ super(delegate);
+ }
+ }
+}
diff --git a/javatests/com/google/gerrit/server/index/change/ChangeFieldTest.java b/javatests/com/google/gerrit/server/index/change/ChangeFieldTest.java
index 3364540..0bdf5cd 100644
--- a/javatests/com/google/gerrit/server/index/change/ChangeFieldTest.java
+++ b/javatests/com/google/gerrit/server/index/change/ChangeFieldTest.java
@@ -168,6 +168,55 @@
assertThat(ChangeField.DELETED.setIfPossible(cd, new FakeStoredValue(null))).isTrue();
}
+ @Test
+ public void shortStringIsNotTruncated() {
+ assertThat(ChangeField.truncateStringValue("short string", 20)).isEqualTo("short string");
+ String two_byte_str = String.format("short string %s", new String(Character.toChars(956)));
+ assertThat(ChangeField.truncateStringValue(two_byte_str, 20)).isEqualTo(two_byte_str);
+ String three_byte_str = String.format("short string %s", new String(Character.toChars(43421)));
+ assertThat(ChangeField.truncateStringValue(three_byte_str, 20)).isEqualTo(three_byte_str);
+ String four_byte_str = String.format("short string %s", new String(Character.toChars(132878)));
+ assertThat(ChangeField.truncateStringValue(four_byte_str, 20)).isEqualTo(four_byte_str);
+ assertThat(ChangeField.truncateStringValue("", 6)).isEqualTo("");
+ assertThat(ChangeField.truncateStringValue("", 0)).isEqualTo("");
+ }
+
+ @Test
+ public void longStringIsTruncated() {
+ assertThat(ChangeField.truncateStringValue("longer string", 6)).isEqualTo("longer");
+ assertThat(ChangeField.truncateStringValue("longer string", 0)).isEqualTo("");
+
+ String two_byte_str =
+ String.format(
+ "multibytechars %1$s%1$s%1$s%1$s present", new String(Character.toChars(956)));
+ assertThat(ChangeField.truncateStringValue(two_byte_str, 16)).isEqualTo("multibytechars ");
+ assertThat(ChangeField.truncateStringValue(two_byte_str, 17))
+ .isEqualTo(String.format("multibytechars %1$s", new String(Character.toChars(956))));
+ assertThat(ChangeField.truncateStringValue(two_byte_str, 18))
+ .isEqualTo(String.format("multibytechars %1$s", new String(Character.toChars(956))));
+
+ String three_byte_str =
+ String.format(
+ "multibytechars %1$s%1$s%1$s%1$s present", new String(Character.toChars(43421)));
+ assertThat(ChangeField.truncateStringValue(three_byte_str, 16)).isEqualTo("multibytechars ");
+ assertThat(ChangeField.truncateStringValue(three_byte_str, 17)).isEqualTo("multibytechars ");
+ assertThat(ChangeField.truncateStringValue(three_byte_str, 18))
+ .isEqualTo(String.format("multibytechars %1$s", new String(Character.toChars(43421))));
+ assertThat(ChangeField.truncateStringValue(three_byte_str, 21))
+ .isEqualTo(String.format("multibytechars %1$s%1$s", new String(Character.toChars(43421))));
+
+ String four_byte_str =
+ String.format(
+ "multibytechars %1$s%1$s%1$s%1$s present", new String(Character.toChars(132878)));
+ assertThat(ChangeField.truncateStringValue(four_byte_str, 16)).isEqualTo("multibytechars ");
+ assertThat(ChangeField.truncateStringValue(four_byte_str, 17)).isEqualTo("multibytechars ");
+ assertThat(ChangeField.truncateStringValue(four_byte_str, 18)).isEqualTo("multibytechars ");
+ assertThat(ChangeField.truncateStringValue(four_byte_str, 19))
+ .isEqualTo(String.format("multibytechars %1$s", new String(Character.toChars(132878))));
+ assertThat(ChangeField.truncateStringValue(four_byte_str, 23))
+ .isEqualTo(String.format("multibytechars %1$s%1$s", new String(Character.toChars(132878))));
+ }
+
private static SubmitRecord record(SubmitRecord.Status status, SubmitRecord.Label... labels) {
SubmitRecord r = new SubmitRecord();
r.status = status;
diff --git a/javatests/com/google/gerrit/server/index/change/ChangeIndexRewriterTest.java b/javatests/com/google/gerrit/server/index/change/ChangeIndexRewriterTest.java
index 3a47ad8..3d0fd25 100644
--- a/javatests/com/google/gerrit/server/index/change/ChangeIndexRewriterTest.java
+++ b/javatests/com/google/gerrit/server/index/change/ChangeIndexRewriterTest.java
@@ -97,7 +97,7 @@
Predicate<ChangeData> in = parse("foo:a file:b");
Predicate<ChangeData> out = rewrite(in);
assertThat(AndChangeSource.class).isSameInstanceAs(out.getClass());
- assertThat(out.getChildren()).containsExactly(query(in.getChild(1)), in.getChild(0)).inOrder();
+ assertThat(out.getChildren()).containsExactly(query(parse("file:b")), parse("foo:a")).inOrder();
}
@Test
@@ -126,9 +126,9 @@
.inOrder();
// Same at the assertions above, that were added for readability
- assertThat(out.getChild(0)).isEqualTo(query(in.getChild(0)));
+ assertThat(out.getChild(0)).isEqualTo(query(parse("-status:abandoned")));
assertThat(indexedSubTree.getChildren())
- .containsExactly(query(in.getChild(1).getChild(1)), in.getChild(1).getChild(0))
+ .containsExactly(query(parse("file:b")), parse("foo:a"))
.inOrder();
}
@@ -137,7 +137,9 @@
Predicate<ChangeData> in = parse("-foo:a (file:b OR file:c)");
Predicate<ChangeData> out = rewrite(in);
assertThat(out.getClass()).isSameInstanceAs(AndChangeSource.class);
- assertThat(out.getChildren()).containsExactly(query(in.getChild(1)), in.getChild(0)).inOrder();
+ assertThat(out.getChildren())
+ .containsExactly(query(parse("file:b OR file:c")), parse("-foo:a"))
+ .inOrder();
}
@Test
@@ -146,7 +148,8 @@
Predicate<ChangeData> out = rewrite(in);
assertThat(out.getClass()).isSameInstanceAs(OrSource.class);
assertThat(out.getChildren())
- .containsExactly(query(or(in.getChild(0), in.getChild(2))), in.getChild(1), in.getChild(3))
+ .containsExactly(
+ query(or(parse("file:a"), parse("file:c"))), parse("foo:b"), parse("foo:d"))
.inOrder();
}
@@ -156,7 +159,7 @@
Predicate<ChangeData> out = rewrite(in);
assertThat(AndChangeSource.class).isSameInstanceAs(out.getClass());
assertThat(out.getChildren())
- .containsExactly(query(and(in.getChild(0), in.getChild(2))), in.getChild(1))
+ .containsExactly(query(and(parse("status:new"), parse("file:a"))), parse("bar:p"))
.inOrder();
}
@@ -166,7 +169,7 @@
Predicate<ChangeData> out = rewrite(in);
assertThat(out.getClass()).isEqualTo(AndChangeSource.class);
assertThat(out.getChildren())
- .containsExactly(query(and(in.getChild(0), in.getChild(2))), in.getChild(1))
+ .containsExactly(query(and(parse("status:new"), parse("file:a"))), parse("bar:p"))
.inOrder();
}
@@ -176,7 +179,7 @@
Predicate<ChangeData> out = rewrite(in);
assertThat(out.getClass()).isEqualTo(AndChangeSource.class);
assertThat(out.getChildren())
- .containsExactly(query(and(in.getChild(0), in.getChild(2))), in.getChild(1))
+ .containsExactly(query(and(parse("status:new OR file:a"), parse("file:b"))), parse("bar:p"))
.inOrder();
}
@@ -186,7 +189,7 @@
Predicate<ChangeData> out = rewrite(in, options(0, 5));
assertThat(out.getClass()).isEqualTo(AndChangeSource.class);
assertThat(out.getChildren())
- .containsExactly(query(in.getChild(1), 5), parse("limit:5"), parse("limit:5"))
+ .containsExactly(query(parse("file:a"), 5), parse("limit:5"), parse("limit:5"))
.inOrder();
}
@@ -257,7 +260,7 @@
@SafeVarargs
private static AndChangeSource andSource(Predicate<ChangeData>... preds) {
- return new AndChangeSource(Arrays.asList(preds));
+ return new AndChangeSource(Arrays.asList(preds), IndexConfig.createDefault());
}
private Predicate<ChangeData> rewrite(Predicate<ChangeData> in) throws QueryParseException {
diff --git a/javatests/com/google/gerrit/server/logging/LoggingContextAwareExecutorServiceTest.java b/javatests/com/google/gerrit/server/logging/LoggingContextAwareExecutorServiceTest.java
index 8d019f3..1f0da16 100644
--- a/javatests/com/google/gerrit/server/logging/LoggingContextAwareExecutorServiceTest.java
+++ b/javatests/com/google/gerrit/server/logging/LoggingContextAwareExecutorServiceTest.java
@@ -56,6 +56,9 @@
}
};
performanceLoggerRegistrationHandle = performanceLoggers.add("gerrit", testPerformanceLogger);
+
+ // Enable performance logging
+ config.setBoolean("tracing", null, "performanceLogging", true);
}
@After
diff --git a/javatests/com/google/gerrit/server/logging/PerformanceLogContextTest.java b/javatests/com/google/gerrit/server/logging/PerformanceLogContextTest.java
index e60d6b4..b1cd8fb 100644
--- a/javatests/com/google/gerrit/server/logging/PerformanceLogContextTest.java
+++ b/javatests/com/google/gerrit/server/logging/PerformanceLogContextTest.java
@@ -56,6 +56,9 @@
testPerformanceLogger = new TestPerformanceLogger();
performanceLoggerRegistrationHandle = performanceLoggers.add("gerrit", testPerformanceLogger);
+
+ // Enable performance logging
+ config.setBoolean("tracing", null, "performanceLogging", true);
}
@After
diff --git a/javatests/com/google/gerrit/server/notedb/ChangeNoteJsonTest.java b/javatests/com/google/gerrit/server/notedb/ChangeNoteJsonTest.java
new file mode 100644
index 0000000..24e28f3
--- /dev/null
+++ b/javatests/com/google/gerrit/server/notedb/ChangeNoteJsonTest.java
@@ -0,0 +1,127 @@
+// 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.notedb;
+
+import static com.google.common.truth.Truth.assertThat;
+import static com.google.common.truth.Truth8.assertThat;
+
+import com.google.gson.Gson;
+import com.google.inject.TypeLiteral;
+import java.util.Optional;
+import org.junit.Test;
+
+public class ChangeNoteJsonTest {
+ private final Gson gson = new ChangeNoteJson().getGson();
+
+ static class Child {
+ Optional<String> optionalValue;
+ }
+
+ static class Parent {
+ Optional<Child> optionalChild;
+ }
+
+ @Test
+ public void shouldSerializeAndDeserializeEmptyOptional() {
+ // given
+ Optional<?> empty = Optional.empty();
+
+ // when
+ String json = gson.toJson(empty);
+
+ // then
+ assertThat(json).isEqualTo("{}");
+
+ // and when
+ Optional<?> result = gson.fromJson(json, Optional.class);
+
+ // and then
+ assertThat(result).isEmpty();
+ }
+
+ @Test
+ public void shouldSerializeAndDeserializeNonEmptyOptional() {
+ // given
+ String value = "foo";
+ Optional<String> nonEmpty = Optional.of(value);
+
+ // when
+ String json = gson.toJson(nonEmpty);
+
+ // then
+ assertThat(json).isEqualTo("{\n \"value\": \"" + value + "\"\n}");
+
+ // and when
+ Optional<String> result = gson.fromJson(json, new TypeLiteral<Optional<String>>() {}.getType());
+
+ // and then
+ assertThat(result).isPresent();
+ assertThat(result.get()).isEqualTo(value);
+ }
+
+ @Test
+ public void shouldSerializeAndDeserializeNestedNonEmptyOptional() {
+ String value = "foo";
+ Child fooChild = new Child();
+ fooChild.optionalValue = Optional.of(value);
+ Parent parent = new Parent();
+ parent.optionalChild = Optional.of(fooChild);
+
+ String json = gson.toJson(parent);
+
+ assertThat(json)
+ .isEqualTo(
+ "{\n"
+ + " \"optionalChild\": {\n"
+ + " \"value\": {\n"
+ + " \"optionalValue\": {\n"
+ + " \"value\": \"foo\"\n"
+ + " }\n"
+ + " }\n"
+ + " }\n"
+ + "}");
+
+ Parent result = gson.fromJson(json, new TypeLiteral<Parent>() {}.getType());
+
+ assertThat(result.optionalChild).isPresent();
+ assertThat(result.optionalChild.get().optionalValue).isPresent();
+ assertThat(result.optionalChild.get().optionalValue.get()).isEqualTo(value);
+ }
+
+ @Test
+ public void shouldSerializeAndDeserializeNestedEmptyOptional() {
+ Child fooChild = new Child();
+ fooChild.optionalValue = Optional.empty();
+ Parent parent = new Parent();
+ parent.optionalChild = Optional.of(fooChild);
+
+ String json = gson.toJson(parent);
+
+ assertThat(json)
+ .isEqualTo(
+ "{\n"
+ + " \"optionalChild\": {\n"
+ + " \"value\": {\n"
+ + " \"optionalValue\": {}\n"
+ + " }\n"
+ + " }\n"
+ + "}");
+
+ Parent result = gson.fromJson(json, new TypeLiteral<Parent>() {}.getType());
+
+ assertThat(result.optionalChild).isPresent();
+ assertThat(result.optionalChild.get().optionalValue).isEmpty();
+ }
+}
diff --git a/javatests/com/google/gerrit/server/notedb/RepoSequenceTest.java b/javatests/com/google/gerrit/server/notedb/RepoSequenceTest.java
index a768eaf..0c9f731 100644
--- a/javatests/com/google/gerrit/server/notedb/RepoSequenceTest.java
+++ b/javatests/com/google/gerrit/server/notedb/RepoSequenceTest.java
@@ -91,27 +91,37 @@
assertThat(s.acquireCount).isEqualTo(0);
assertThat(s.next()).isEqualTo(1);
+ assertThat(s.last()).isEqualTo(1);
assertThat(s.acquireCount).isEqualTo(1);
assertThat(s.next()).isEqualTo(2);
+ assertThat(s.last()).isEqualTo(2);
assertThat(s.acquireCount).isEqualTo(1);
assertThat(s.next()).isEqualTo(3);
+ assertThat(s.last()).isEqualTo(3);
assertThat(s.acquireCount).isEqualTo(1);
assertThat(s.next()).isEqualTo(4);
+ assertThat(s.last()).isEqualTo(4);
assertThat(s.acquireCount).isEqualTo(2);
assertThat(s.next()).isEqualTo(5);
+ assertThat(s.last()).isEqualTo(5);
assertThat(s.acquireCount).isEqualTo(2);
assertThat(s.next()).isEqualTo(6);
+ assertThat(s.last()).isEqualTo(6);
assertThat(s.acquireCount).isEqualTo(2);
assertThat(s.next()).isEqualTo(7);
+ assertThat(s.last()).isEqualTo(7);
assertThat(s.acquireCount).isEqualTo(3);
assertThat(s.next()).isEqualTo(8);
+ assertThat(s.last()).isEqualTo(8);
assertThat(s.acquireCount).isEqualTo(3);
assertThat(s.next()).isEqualTo(9);
+ assertThat(s.last()).isEqualTo(9);
assertThat(s.acquireCount).isEqualTo(3);
assertThat(s.next()).isEqualTo(10);
+ assertThat(s.last()).isEqualTo(10);
assertThat(s.acquireCount).isEqualTo(4);
}
@@ -127,6 +137,8 @@
assertThat(s2.next()).isEqualTo(5);
assertThat(s1.next()).isEqualTo(3);
assertThat(s2.next()).isEqualTo(6);
+ assertThat(s1.last()).isEqualTo(3);
+ assertThat(s2.last()).isEqualTo(6);
// s2 acquires 7-9; s1 acquires 10-12.
assertThat(s2.next()).isEqualTo(7);
@@ -135,6 +147,8 @@
assertThat(s1.next()).isEqualTo(11);
assertThat(s2.next()).isEqualTo(9);
assertThat(s1.next()).isEqualTo(12);
+ assertThat(s1.last()).isEqualTo(12);
+ assertThat(s2.last()).isEqualTo(9);
}
@Test
@@ -284,48 +298,61 @@
}
@Test
- public void nextWithCountOneCaller() throws Exception {
+ public void nextWithCountAndLastByOneCaller() throws Exception {
RepoSequence s = newSequence("id", 1, 3);
assertThat(s.next(2)).containsExactly(1, 2).inOrder();
assertThat(s.acquireCount).isEqualTo(1);
+ assertThat(s.last()).isEqualTo(2);
assertThat(s.next(2)).containsExactly(3, 4).inOrder();
assertThat(s.acquireCount).isEqualTo(2);
+ assertThat(s.last()).isEqualTo(4);
assertThat(s.next(2)).containsExactly(5, 6).inOrder();
assertThat(s.acquireCount).isEqualTo(2);
+ assertThat(s.last()).isEqualTo(6);
assertThat(s.next(3)).containsExactly(7, 8, 9).inOrder();
assertThat(s.acquireCount).isEqualTo(3);
+ assertThat(s.last()).isEqualTo(9);
assertThat(s.next(3)).containsExactly(10, 11, 12).inOrder();
assertThat(s.acquireCount).isEqualTo(4);
+ assertThat(s.last()).isEqualTo(12);
assertThat(s.next(3)).containsExactly(13, 14, 15).inOrder();
assertThat(s.acquireCount).isEqualTo(5);
+ assertThat(s.last()).isEqualTo(15);
assertThat(s.next(7)).containsExactly(16, 17, 18, 19, 20, 21, 22).inOrder();
assertThat(s.acquireCount).isEqualTo(6);
+ assertThat(s.last()).isEqualTo(22);
assertThat(s.next(7)).containsExactly(23, 24, 25, 26, 27, 28, 29).inOrder();
assertThat(s.acquireCount).isEqualTo(7);
+ assertThat(s.last()).isEqualTo(29);
assertThat(s.next(7)).containsExactly(30, 31, 32, 33, 34, 35, 36).inOrder();
assertThat(s.acquireCount).isEqualTo(8);
+ assertThat(s.last()).isEqualTo(36);
}
@Test
- public void nextWithCountMultipleCallers() throws Exception {
+ public void nextWithCountAndLastByMultipleCallers() throws Exception {
RepoSequence s1 = newSequence("id", 1, 3);
RepoSequence s2 = newSequence("id", 1, 4);
assertThat(s1.next(2)).containsExactly(1, 2).inOrder();
+ assertThat(s1.last()).isEqualTo(2);
assertThat(s1.acquireCount).isEqualTo(1);
// s1 hasn't exhausted its last batch.
assertThat(s2.next(2)).containsExactly(4, 5).inOrder();
+ assertThat(s2.last()).isEqualTo(5);
assertThat(s2.acquireCount).isEqualTo(1);
// s1 acquires again to cover this request, plus a whole new batch.
assertThat(s1.next(3)).containsExactly(3, 8, 9);
+ assertThat(s1.last()).isEqualTo(9);
assertThat(s1.acquireCount).isEqualTo(2);
// s2 hasn't exhausted its last batch, do so now.
assertThat(s2.next(2)).containsExactly(6, 7);
+ assertThat(s2.last()).isEqualTo(7);
assertThat(s2.acquireCount).isEqualTo(1);
}
diff --git a/javatests/com/google/gerrit/server/project/ProjectConfigTest.java b/javatests/com/google/gerrit/server/project/ProjectConfigTest.java
index 2b7d7af..26f7d60 100644
--- a/javatests/com/google/gerrit/server/project/ProjectConfigTest.java
+++ b/javatests/com/google/gerrit/server/project/ProjectConfigTest.java
@@ -756,6 +756,7 @@
ProjectConfig cfg = read(rev);
assertThat(cfg.getCommentLinkSections())
.containsExactly(StoredCommentLinkInfo.enabled("bugzilla"));
+ assertThat(Iterables.getOnlyElement(cfg.getCommentLinkSections()).getEnabled()).isNull();
}
@Test
@@ -767,6 +768,7 @@
ProjectConfig cfg = read(rev);
assertThat(cfg.getCommentLinkSections())
.containsExactly(StoredCommentLinkInfo.disabled("bugzilla"));
+ assertThat(Iterables.getOnlyElement(cfg.getCommentLinkSections()).getEnabled()).isFalse();
}
@Test
diff --git a/javatests/com/google/gerrit/server/query/account/AbstractQueryAccountsTest.java b/javatests/com/google/gerrit/server/query/account/AbstractQueryAccountsTest.java
index 16f7199..e0a69a0 100644
--- a/javatests/com/google/gerrit/server/query/account/AbstractQueryAccountsTest.java
+++ b/javatests/com/google/gerrit/server/query/account/AbstractQueryAccountsTest.java
@@ -646,7 +646,10 @@
.getRaw(
Account.id(userInfo._accountId),
QueryOptions.create(
- IndexConfig.createDefault(), 0, 1, schema.getStoredFields().keySet()));
+ IndexConfig.fromConfig(config).build(),
+ 0,
+ 1,
+ schema.getStoredFields().keySet()));
assertThat(rawFields).isPresent();
if (schema.useLegacyNumericFields()) {
diff --git a/javatests/com/google/gerrit/server/query/change/AbstractQueryChangesTest.java b/javatests/com/google/gerrit/server/query/change/AbstractQueryChangesTest.java
index 55c7921..28d9ac7 100644
--- a/javatests/com/google/gerrit/server/query/change/AbstractQueryChangesTest.java
+++ b/javatests/com/google/gerrit/server/query/change/AbstractQueryChangesTest.java
@@ -109,6 +109,7 @@
import com.google.gerrit.server.account.Accounts;
import com.google.gerrit.server.account.AccountsUpdate;
import com.google.gerrit.server.account.AuthRequest;
+import com.google.gerrit.server.account.ListGroupMembership;
import com.google.gerrit.server.account.VersionedAccountQueries;
import com.google.gerrit.server.account.externalids.ExternalIdFactory;
import com.google.gerrit.server.change.ChangeInserter;
@@ -118,6 +119,7 @@
import com.google.gerrit.server.config.AllUsersName;
import com.google.gerrit.server.experiments.ExperimentFeaturesConstants;
import com.google.gerrit.server.git.meta.MetaDataUpdate;
+import com.google.gerrit.server.group.testing.TestGroupBackend;
import com.google.gerrit.server.index.change.ChangeField;
import com.google.gerrit.server.index.change.ChangeIndexCollection;
import com.google.gerrit.server.index.change.ChangeIndexer;
@@ -195,14 +197,15 @@
@Inject protected SchemaCreator schemaCreator;
@Inject protected Sequences seq;
@Inject protected ThreadLocalRequestContext requestContext;
+ @Inject protected TestGroupBackend testGroupBackend;
@Inject protected ProjectCache projectCache;
@Inject protected MetaDataUpdate.Server metaDataUpdateFactory;
@Inject protected IdentifiedUser.GenericFactory identifiedUserFactory;
@Inject protected AuthRequest.Factory authRequestFactory;
@Inject protected ExternalIdFactory externalIdFactory;
+ @Inject protected ProjectOperations projectOperations;
@Inject private ProjectConfig.Factory projectConfigFactory;
- @Inject private ProjectOperations projectOperations;
protected Injector injector;
protected LifecycleManager lifecycle;
@@ -728,7 +731,7 @@
assertThat(thrown).hasMessageThat().contains("invalid value");
}
- private Change createChange(TestRepository<Repo> repo, PersonIdent person) throws Exception {
+ protected Change createChange(TestRepository<Repo> repo, PersonIdent person) throws Exception {
RevCommit commit =
repo.parseBody(repo.commit().message("message").author(person).committer(person).create());
return insert(repo, newChangeForCommit(repo, commit), null);
@@ -1387,6 +1390,44 @@
}
@Test
+ public void byLabelExternalGroup() throws Exception {
+ Account.Id user1 = createAccount("user1");
+ Account.Id user2 = createAccount("user2");
+ TestRepository<InMemoryRepositoryManager.Repo> repo = createProject("repo");
+
+ // create group and add users
+ AccountGroup.UUID external_group1 = AccountGroup.uuid("testbackend:group1");
+ AccountGroup.UUID external_group2 = AccountGroup.uuid("testbackend:group2");
+ testGroupBackend.create(external_group1);
+ testGroupBackend.create(external_group2);
+ testGroupBackend.setMembershipsOf(
+ user1, new ListGroupMembership(ImmutableList.of(external_group1)));
+ testGroupBackend.setMembershipsOf(
+ user2, new ListGroupMembership(ImmutableList.of(external_group2)));
+
+ Change change1 = insert(repo, newChange(repo), user1);
+ Change change2 = insert(repo, newChange(repo), user1);
+
+ // post a review with user1 and other_user
+ requestContext.setContext(newRequestContext(user1));
+ gApi.changes()
+ .id(change1.getId().get())
+ .current()
+ .review(new ReviewInput().label("Code-Review", 1));
+ requestContext.setContext(newRequestContext(userId));
+ gApi.changes()
+ .id(change2.getId().get())
+ .current()
+ .review(new ReviewInput().label("Code-Review", 1));
+
+ assertQuery("label:Code-Review=+1," + external_group1.get(), change1);
+ assertQuery("label:Code-Review=+1,group=" + external_group1.get(), change1);
+ assertQuery("label:Code-Review=+1,user=user1", change1);
+ assertQuery("label:Code-Review=+1,user=user2");
+ assertQuery("label:Code-Review=+1,group=" + external_group2.get());
+ }
+
+ @Test
public void limit() throws Exception {
TestRepository<Repo> repo = createProject("repo");
Change last = null;
diff --git a/javatests/com/google/gerrit/server/query/change/BUILD b/javatests/com/google/gerrit/server/query/change/BUILD
index 3fde339..32a646e 100644
--- a/javatests/com/google/gerrit/server/query/change/BUILD
+++ b/javatests/com/google/gerrit/server/query/change/BUILD
@@ -21,6 +21,7 @@
"//java/com/google/gerrit/acceptance/config",
"//java/com/google/gerrit/acceptance/testsuite/project",
"//java/com/google/gerrit/common:annotations",
+ "//java/com/google/gerrit/common:server",
"//java/com/google/gerrit/entities",
"//java/com/google/gerrit/extensions:api",
"//java/com/google/gerrit/httpd",
@@ -28,6 +29,7 @@
"//java/com/google/gerrit/index:query_exception",
"//java/com/google/gerrit/lifecycle",
"//java/com/google/gerrit/server",
+ "//java/com/google/gerrit/server/group/testing",
"//java/com/google/gerrit/server/project/testing:project-test-util",
"//java/com/google/gerrit/server/schema",
"//java/com/google/gerrit/server/util/time",
diff --git a/javatests/com/google/gerrit/server/query/change/FakeQueryChangesLatestIndexVersionTest.java b/javatests/com/google/gerrit/server/query/change/FakeQueryChangesLatestIndexVersionTest.java
index 5496f56..4dde452 100644
--- a/javatests/com/google/gerrit/server/query/change/FakeQueryChangesLatestIndexVersionTest.java
+++ b/javatests/com/google/gerrit/server/query/change/FakeQueryChangesLatestIndexVersionTest.java
@@ -26,4 +26,11 @@
public static Config defaultConfig() {
return IndexConfig.createForFake();
}
+
+ @ConfigSuite.Config
+ public static Config searchAfterPaginationType() {
+ Config config = defaultConfig();
+ config.setString("index", null, "paginationType", "SEARCH_AFTER");
+ return config;
+ }
}
diff --git a/javatests/com/google/gerrit/server/query/change/FakeQueryChangesPreviousIndexVersionTest.java b/javatests/com/google/gerrit/server/query/change/FakeQueryChangesPreviousIndexVersionTest.java
index 1610eca..95896dc 100644
--- a/javatests/com/google/gerrit/server/query/change/FakeQueryChangesPreviousIndexVersionTest.java
+++ b/javatests/com/google/gerrit/server/query/change/FakeQueryChangesPreviousIndexVersionTest.java
@@ -36,4 +36,11 @@
IndexConfig.createForFake())
.values());
}
+
+ @ConfigSuite.Config
+ public static Config searchAfterPaginationType() {
+ Config config = againstPreviousIndexVersion();
+ config.setString("index", null, "paginationType", "SEARCH_AFTER");
+ return config;
+ }
}
diff --git a/javatests/com/google/gerrit/server/query/change/FakeQueryChangesTest.java b/javatests/com/google/gerrit/server/query/change/FakeQueryChangesTest.java
index 1e23420..3968a33 100644
--- a/javatests/com/google/gerrit/server/query/change/FakeQueryChangesTest.java
+++ b/javatests/com/google/gerrit/server/query/change/FakeQueryChangesTest.java
@@ -14,10 +14,27 @@
package com.google.gerrit.server.query.change;
+import static com.google.common.truth.Truth.assertThat;
+import static com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.allowCapability;
+import static com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.block;
+import static com.google.gerrit.common.data.GlobalCapability.QUERY_LIMIT;
+import static com.google.gerrit.server.group.SystemGroupBackend.REGISTERED_USERS;
+
+import com.google.gerrit.acceptance.UseClockStep;
+import com.google.gerrit.entities.Permission;
+import com.google.gerrit.entities.Project;
+import com.google.gerrit.index.testing.AbstractFakeIndex;
+import com.google.gerrit.server.config.AllProjectsName;
+import com.google.gerrit.server.index.change.ChangeIndexCollection;
import com.google.gerrit.testing.InMemoryModule;
+import com.google.gerrit.testing.InMemoryRepositoryManager;
+import com.google.gerrit.testing.InMemoryRepositoryManager.Repo;
import com.google.inject.Guice;
+import com.google.inject.Inject;
import com.google.inject.Injector;
+import org.eclipse.jgit.junit.TestRepository;
import org.eclipse.jgit.lib.Config;
+import org.junit.Test;
/**
* Test against {@link com.google.gerrit.index.testing.AbstractFakeIndex}. This test might seem
@@ -25,6 +42,9 @@
* results as production indices.
*/
public abstract class FakeQueryChangesTest extends AbstractQueryChangesTest {
+ @Inject private ChangeIndexCollection changeIndexCollection;
+ @Inject protected AllProjectsName allProjects;
+
@Override
protected Injector createInjector() {
Config fakeConfig = new Config(config);
@@ -32,4 +52,84 @@
fakeConfig.setString("index", null, "type", "fake");
return Guice.createInjector(new InMemoryModule(fakeConfig));
}
+
+ @Test
+ @UseClockStep
+ @SuppressWarnings("unchecked")
+ public void stopQueryIfNoMoreResults() throws Exception {
+ // create 2 visible changes
+ TestRepository<InMemoryRepositoryManager.Repo> testRepo = createProject("repo");
+ insert(testRepo, newChange(testRepo));
+ insert(testRepo, newChange(testRepo));
+
+ // create 2 invisible changes
+ TestRepository<Repo> hiddenProject = createProject("hiddenProject");
+ insert(hiddenProject, newChange(hiddenProject));
+ insert(hiddenProject, newChange(hiddenProject));
+ projectOperations
+ .project(Project.nameKey("hiddenProject"))
+ .forUpdate()
+ .add(block(Permission.READ).ref("refs/*").group(REGISTERED_USERS))
+ .update();
+
+ AbstractFakeIndex idx = (AbstractFakeIndex) changeIndexCollection.getSearchIndex();
+ newQuery("status:new").withLimit(5).get();
+ // Since the limit of the query (i.e. 5) is more than the total number of changes (i.e. 4),
+ // only 1 index search is expected.
+ assertThat(idx.getQueryCount()).isEqualTo(1);
+ }
+
+ @Test
+ @UseClockStep
+ @SuppressWarnings("unchecked")
+ public void noLimitQueryPaginates() throws Exception {
+ TestRepository<InMemoryRepositoryManager.Repo> testRepo = createProject("repo");
+ // create 4 changes
+ insert(testRepo, newChange(testRepo));
+ insert(testRepo, newChange(testRepo));
+ insert(testRepo, newChange(testRepo));
+ insert(testRepo, newChange(testRepo));
+
+ // Set queryLimit to 2
+ projectOperations
+ .project(allProjects)
+ .forUpdate()
+ .add(allowCapability(QUERY_LIMIT).group(REGISTERED_USERS).range(0, 2))
+ .update();
+
+ AbstractFakeIndex idx = (AbstractFakeIndex) changeIndexCollection.getSearchIndex();
+
+ // 2 index searches are expected. The first index search will run with size 3 (i.e.
+ // the configured query-limit+1), and then we will paginate to get the remaining
+ // changes with the second index search.
+ newQuery("status:new").withNoLimit().get();
+ assertThat(idx.getQueryCount()).isEqualTo(2);
+ }
+
+ @Test
+ @UseClockStep
+ @SuppressWarnings("unchecked")
+ public void internalQueriesPaginate() throws Exception {
+ // create 4 changes
+ TestRepository<InMemoryRepositoryManager.Repo> testRepo = createProject("repo");
+ insert(testRepo, newChange(testRepo));
+ insert(testRepo, newChange(testRepo));
+ insert(testRepo, newChange(testRepo));
+ insert(testRepo, newChange(testRepo));
+
+ // Set queryLimit to 2
+ projectOperations
+ .project(allProjects)
+ .forUpdate()
+ .add(allowCapability(QUERY_LIMIT).group(REGISTERED_USERS).range(0, 2))
+ .update();
+
+ AbstractFakeIndex idx = (AbstractFakeIndex) changeIndexCollection.getSearchIndex();
+
+ // 2 index searches are expected. The first index search will run with size 3 (i.e.
+ // the configured query-limit+1), and then we will paginate to get the remaining
+ // changes with the second index search.
+ queryProvider.get().query(queryBuilderProvider.get().parse("status:new"));
+ assertThat(idx.getQueryCount()).isEqualTo(2);
+ }
}
diff --git a/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesLatestIndexVersionTest.java b/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesLatestIndexVersionTest.java
index 52a9170..4587943 100644
--- a/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesLatestIndexVersionTest.java
+++ b/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesLatestIndexVersionTest.java
@@ -23,4 +23,11 @@
public static Config defaultConfig() {
return IndexConfig.createForLucene();
}
+
+ @ConfigSuite.Config
+ public static Config searchAfterPaginationType() {
+ Config config = defaultConfig();
+ config.setString("index", null, "paginationType", "SEARCH_AFTER");
+ return config;
+ }
}
diff --git a/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesPreviousIndexVersionTest.java b/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesPreviousIndexVersionTest.java
index 62483fa..1782697 100644
--- a/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesPreviousIndexVersionTest.java
+++ b/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesPreviousIndexVersionTest.java
@@ -33,4 +33,11 @@
IndexConfig.createForLucene())
.values());
}
+
+ @ConfigSuite.Config
+ public static Config searchAfterPaginationType() {
+ Config config = againstPreviousIndexVersion();
+ config.setString("index", null, "paginationType", "SEARCH_AFTER");
+ return config;
+ }
}
diff --git a/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesTest.java b/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesTest.java
index 6a83fb9..9717bfb 100644
--- a/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesTest.java
+++ b/javatests/com/google/gerrit/server/query/change/LuceneQueryChangesTest.java
@@ -15,13 +15,18 @@
package com.google.gerrit.server.query.change;
import static com.google.common.truth.Truth.assertThat;
+import static com.google.gerrit.acceptance.testsuite.project.TestProjectUpdate.allowCapability;
+import static com.google.gerrit.common.data.GlobalCapability.QUERY_LIMIT;
+import static com.google.gerrit.server.group.SystemGroupBackend.REGISTERED_USERS;
import static com.google.gerrit.testing.GerritJUnit.assertThrows;
import com.google.gerrit.entities.Change;
import com.google.gerrit.extensions.restapi.BadRequestException;
+import com.google.gerrit.server.config.AllProjectsName;
import com.google.gerrit.testing.InMemoryModule;
import com.google.gerrit.testing.InMemoryRepositoryManager.Repo;
import com.google.inject.Guice;
+import com.google.inject.Inject;
import com.google.inject.Injector;
import org.eclipse.jgit.junit.TestRepository;
import org.eclipse.jgit.lib.Config;
@@ -29,6 +34,8 @@
import org.junit.Test;
public abstract class LuceneQueryChangesTest extends AbstractQueryChangesTest {
+ @Inject protected AllProjectsName allProjects;
+
@Override
protected Injector createInjector() {
Config luceneConfig = new Config(config);
@@ -66,4 +73,29 @@
() -> assertQuery("owner: \"" + nameEmail + "\"\\", change1));
assertThat(thrown).hasMessageThat().contains("Cannot create full-text query with value: \\");
}
+
+ @Test
+ public void openAndClosedChanges() throws Exception {
+ TestRepository<Repo> repo = createProject("repo");
+
+ // create 3 closed changes
+ Change change1 = insert(repo, newChangeWithStatus(repo, Change.Status.MERGED));
+ Change change2 = insert(repo, newChangeWithStatus(repo, Change.Status.MERGED));
+ Change change3 = insert(repo, newChangeWithStatus(repo, Change.Status.MERGED));
+
+ // create 3 new changes
+ Change change4 = insert(repo, newChangeWithStatus(repo, Change.Status.NEW));
+ Change change5 = insert(repo, newChangeWithStatus(repo, Change.Status.NEW));
+ Change change6 = insert(repo, newChangeWithStatus(repo, Change.Status.NEW));
+
+ // Set queryLimit to 1
+ projectOperations
+ .project(allProjects)
+ .forUpdate()
+ .add(allowCapability(QUERY_LIMIT).group(REGISTERED_USERS).range(0, 1))
+ .update();
+
+ Change[] expected = new Change[] {change6, change5, change4, change3, change2, change1};
+ assertQuery(newQuery("project:repo").withNoLimit(), expected);
+ }
}
diff --git a/javatests/com/google/gerrit/server/query/group/AbstractQueryGroupsTest.java b/javatests/com/google/gerrit/server/query/group/AbstractQueryGroupsTest.java
index 568b5a0..6e4fec1 100644
--- a/javatests/com/google/gerrit/server/query/group/AbstractQueryGroupsTest.java
+++ b/javatests/com/google/gerrit/server/query/group/AbstractQueryGroupsTest.java
@@ -374,7 +374,7 @@
.getRaw(
uuid,
QueryOptions.create(
- IndexConfig.createDefault(),
+ IndexConfig.fromConfig(config).build(),
0,
10,
indexes.getSearchIndex().getSchema().getStoredFields().keySet()));
diff --git a/lib/log/BUILD b/lib/log/BUILD
index 6a85bd1..21c4d47 100644
--- a/lib/log/BUILD
+++ b/lib/log/BUILD
@@ -18,6 +18,14 @@
)
java_library(
+ name = "impl-log4j",
+ data = ["//lib:LICENSE-slf4j"],
+ visibility = ["//visibility:public"],
+ exports = ["@impl-log4j//jar"],
+ runtime_deps = [":log4j"],
+)
+
+java_library(
name = "jcl-over-slf4j",
data = ["//lib:LICENSE-slf4j"],
visibility = ["//visibility:public"],
diff --git a/modules/jgit b/modules/jgit
index d73b7cd..d013761 160000
--- a/modules/jgit
+++ b/modules/jgit
@@ -1 +1 @@
-Subproject commit d73b7cdeb4eaf32e3d41c105b974e620b33a168e
+Subproject commit d01376106af8800017ac3c08d7c7ac1fd5ccc9ee
diff --git a/plugins/BUILD b/plugins/BUILD
index 7862b1c..32efa3e 100644
--- a/plugins/BUILD
+++ b/plugins/BUILD
@@ -64,6 +64,7 @@
"//java/com/google/gerrit/server/logging",
"//java/com/google/gerrit/server/schema",
"//java/com/google/gerrit/server/util/time",
+ "//java/com/google/gerrit/proto",
"//java/com/google/gerrit/util/cli",
"//java/com/google/gerrit/util/http",
"//java/com/google/gerrit/util/logging",
diff --git a/plugins/gitiles b/plugins/gitiles
index 44b5333..24529d2 160000
--- a/plugins/gitiles
+++ b/plugins/gitiles
@@ -1 +1 @@
-Subproject commit 44b5333d08d02c15334f81906134a5613d3f0a3b
+Subproject commit 24529d232268ac51fd6850770f70dc0fcd732dd8
diff --git a/plugins/package.json b/plugins/package.json
index 94c8be9..6fdb0fc 100644
--- a/plugins/package.json
+++ b/plugins/package.json
@@ -6,7 +6,7 @@
"@gerritcodereview/typescript-api": "3.4.4",
"@polymer/decorators": "^3.0.0",
"@polymer/polymer": "^3.4.1",
- "lit": "^2.1.1"
+ "lit": "^2.2.3"
},
"license": "Apache-2.0",
"private": true
diff --git a/plugins/yarn.lock b/plugins/yarn.lock
index 5dccf83..4cb70a6 100644
--- a/plugins/yarn.lock
+++ b/plugins/yarn.lock
@@ -7,10 +7,10 @@
resolved "https://registry.yarnpkg.com/@gerritcodereview/typescript-api/-/typescript-api-3.4.4.tgz#9f09687038088dd7edd3b4e30d249502eb21bfbc"
integrity sha512-MAiQwntcQ59b92yYDsVIXj3oBbAB4C7HELkLFFbYs4ZjzC43XqqtR9VF0dh5OUC8wzFZttgUiOmGehk9edpPuw==
-"@lit/reactive-element@^1.1.0":
- version "1.2.0"
- resolved "https://registry.yarnpkg.com/@lit/reactive-element/-/reactive-element-1.2.0.tgz#c62444a0e3d3f8d3a6875ad56f867279aa89fa88"
- integrity sha512-7i/Fz8enAQ2AN5DyJ2i2AFERufjP6x1NjuHoNgDyJkjjHxEoo8kVyyHxu1A9YyeShlksjt5FvpvENBDuivQHLA==
+"@lit/reactive-element@^1.3.0":
+ version "1.3.2"
+ resolved "https://registry.yarnpkg.com/@lit/reactive-element/-/reactive-element-1.3.2.tgz#43e470537b6ec2c23510c07812616d5aa27a17cd"
+ integrity sha512-A2e18XzPMrIh35nhIdE4uoqRzoIpEU5vZYuQN4S3Ee1zkGdYC27DP12pewbw/RLgPHzaE4kx/YqxMzebOpm0dA==
"@polymer/decorators@^3.0.0":
version "3.0.0"
@@ -36,26 +36,26 @@
resolved "https://registry.yarnpkg.com/@webcomponents/shadycss/-/shadycss-1.11.0.tgz#73e289996c002d8be694cd3be0e83c46ad25e7e0"
integrity sha512-L5O/+UPum8erOleNjKq6k58GVl3fNsEQdSOyh0EUhNmi7tHUyRuCJy1uqJiWydWcLARE5IPsMoPYMZmUGrz1JA==
-lit-element@^3.1.0:
- version "3.1.1"
- resolved "https://registry.yarnpkg.com/lit-element/-/lit-element-3.1.1.tgz#562d5ccbc8ba0c01d8ba4a0ac3576263167d2ccb"
- integrity sha512-14ClnMAU8EXnzC+M2/KDd3SFmNUn1QUw1+GxWkEMwGV3iaH8ObunMlO5svzvaWlkSV0WlxJCi40NGnDVJ2XZKQ==
+lit-element@^3.2.0:
+ version "3.2.0"
+ resolved "https://registry.yarnpkg.com/lit-element/-/lit-element-3.2.0.tgz#9c981c55dfd9a8f124dc863edb62cc529d434db7"
+ integrity sha512-HbE7yt2SnUtg5DCrWt028oaU4D5F4k/1cntAFHTkzY8ZIa8N0Wmu92PxSxucsQSOXlODFrICkQ5x/tEshKi13g==
dependencies:
- "@lit/reactive-element" "^1.1.0"
- lit-html "^2.1.0"
+ "@lit/reactive-element" "^1.3.0"
+ lit-html "^2.2.0"
-lit-html@^2.1.0:
- version "2.1.1"
- resolved "https://registry.yarnpkg.com/lit-html/-/lit-html-2.1.1.tgz#f4da485798a0d967514d31730d387350fafb79f7"
- integrity sha512-E4BImK6lopAYanJpvcGaAG8kQFF1ccIulPu2BRNZI7acFB6i4ujjjsnaPVFT1j/4lD9r8GKih0Y8d7/LH8SeyQ==
+lit-html@^2.2.0:
+ version "2.2.6"
+ resolved "https://registry.yarnpkg.com/lit-html/-/lit-html-2.2.6.tgz#e70679605420a34c4f3cbd0c483b2fb1fff781df"
+ integrity sha512-xOKsPmq/RAKJ6dUeOxhmOYFjcjf0Q7aSdfBJgdJkOfCUnkmmJPxNrlZpRBeVe1Gg50oYWMlgm6ccAE/SpJgSdw==
dependencies:
"@types/trusted-types" "^2.0.2"
-lit@^2.1.1:
- version "2.1.1"
- resolved "https://registry.yarnpkg.com/lit/-/lit-2.1.1.tgz#65f43abca945988f696391f762c645ba51966b0b"
- integrity sha512-yqDqf36IhXwOxIQSFqCMgpfvDCRdxLCLZl7m/+tO5C9W/OBHUj17qZpiMBT35v97QMVKcKEi1KZ3hZRyTwBNsQ==
+lit@^2.2.3:
+ version "2.2.6"
+ resolved "https://registry.yarnpkg.com/lit/-/lit-2.2.6.tgz#4ef223e88517c000b0c01baf2e3535e61a75a5b5"
+ integrity sha512-K2vkeGABfSJSfkhqHy86ujchJs3NR9nW1bEEiV+bXDkbiQ60Tv5GUausYN2mXigZn8lC1qXuc46ArQRKYmumZw==
dependencies:
- "@lit/reactive-element" "^1.1.0"
- lit-element "^3.1.0"
- lit-html "^2.1.0"
+ "@lit/reactive-element" "^1.3.0"
+ lit-element "^3.2.0"
+ lit-html "^2.2.0"
diff --git a/polygerrit-ui/app/BUILD b/polygerrit-ui/app/BUILD
index e298c65..084befa 100644
--- a/polygerrit-ui/app/BUILD
+++ b/polygerrit-ui/app/BUILD
@@ -246,6 +246,7 @@
],
ignore = ".eslintignore",
plugins = [
+ "@npm//@typescript-eslint/eslint-plugin",
"@npm//eslint-config-google",
"@npm//eslint-plugin-html",
"@npm//eslint-plugin-import",
diff --git a/polygerrit-ui/app/api/BUILD_for_publishing_api_only b/polygerrit-ui/app/api/BUILD_for_publishing_api_only
index 9d3029b..67a26cd 100644
--- a/polygerrit-ui/app/api/BUILD_for_publishing_api_only
+++ b/polygerrit-ui/app/api/BUILD_for_publishing_api_only
@@ -38,6 +38,7 @@
# Use this rule for publishing the js plugin api as a package to the npm repo.
pkg_npm(
name = "js_plugin_api_npm_package",
+ package_name = "@gerritcodereview/typescript-api",
srcs = glob(
["**/*"],
exclude = [
diff --git a/polygerrit-ui/app/api/rest-api.ts b/polygerrit-ui/app/api/rest-api.ts
index 72712ff..685151b 100644
--- a/polygerrit-ui/app/api/rest-api.ts
+++ b/polygerrit-ui/app/api/rest-api.ts
@@ -130,7 +130,7 @@
export enum InheritedBooleanInfoConfiguredValue {
TRUE = 'TRUE',
FALSE = 'FALSE',
- INHERITED = 'INHERITED',
+ INHERIT = 'INHERIT',
}
/**
diff --git a/polygerrit-ui/app/elements/admin/gr-access-section/gr-access-section.ts b/polygerrit-ui/app/elements/admin/gr-access-section/gr-access-section.ts
index 8fa2e90..2c83ed3 100644
--- a/polygerrit-ui/app/elements/admin/gr-access-section/gr-access-section.ts
+++ b/polygerrit-ui/app/elements/admin/gr-access-section/gr-access-section.ts
@@ -403,9 +403,9 @@
permission: PermissionArrayItem<EditablePermissionInfo>
): string | undefined {
if (this.section?.id === GLOBAL_NAME) {
- return this.capabilities?.[permission.id].name;
+ return this.capabilities?.[permission.id]?.name;
} else if (AccessPermissions[permission.id]) {
- return AccessPermissions[permission.id].name;
+ return AccessPermissions[permission.id]?.name;
} else if (permission.value.label) {
let behalfOf = '';
if (permission.id.startsWith('labelAs-')) {
diff --git a/polygerrit-ui/app/elements/admin/gr-access-section/gr-access-section_test.ts b/polygerrit-ui/app/elements/admin/gr-access-section/gr-access-section_test.ts
index f4d81c4..1c4c437 100644
--- a/polygerrit-ui/app/elements/admin/gr-access-section/gr-access-section_test.ts
+++ b/polygerrit-ui/app/elements/admin/gr-access-section/gr-access-section_test.ts
@@ -224,6 +224,12 @@
element.capabilities![permission.id].name
);
+ permission = {
+ id: 'non-existent' as GitRef,
+ value: {rules: {}},
+ };
+ assert.isUndefined(element.computePermissionName(permission));
+
element.section.id = 'refs/for/*' as GitRef;
permission = {
id: 'abandon' as GitRef,
diff --git a/polygerrit-ui/app/elements/admin/gr-admin-group-list/gr-admin-group-list.ts b/polygerrit-ui/app/elements/admin/gr-admin-group-list/gr-admin-group-list.ts
index 9330f08..ba737a7 100644
--- a/polygerrit-ui/app/elements/admin/gr-admin-group-list/gr-admin-group-list.ts
+++ b/polygerrit-ui/app/elements/admin/gr-admin-group-list/gr-admin-group-list.ts
@@ -29,7 +29,7 @@
import {SHOWN_ITEMS_COUNT} from '../../../constants/constants';
import {tableStyles} from '../../../styles/gr-table-styles';
import {sharedStyles} from '../../../styles/shared-styles';
-import {LitElement, PropertyValues, html} from 'lit';
+import {LitElement, PropertyValues, css, html} from 'lit';
import {customElement, query, property, state} from 'lit/decorators';
import {assertIsDefined} from '../../../utils/common-util';
@@ -78,7 +78,15 @@
}
static override get styles() {
- return [tableStyles, sharedStyles];
+ return [
+ tableStyles,
+ sharedStyles,
+ css`
+ gr-list-view {
+ --generic-list-description-width: 70%;
+ }
+ `,
+ ];
}
override render() {
diff --git a/polygerrit-ui/app/elements/admin/gr-create-change-dialog/gr-create-change-dialog.ts b/polygerrit-ui/app/elements/admin/gr-create-change-dialog/gr-create-change-dialog.ts
index 119b905..8e797b7 100644
--- a/polygerrit-ui/app/elements/admin/gr-create-change-dialog/gr-create-change-dialog.ts
+++ b/polygerrit-ui/app/elements/admin/gr-create-change-dialog/gr-create-change-dialog.ts
@@ -65,7 +65,8 @@
// private but used in test
@state() topic?: string;
- @state() private baseChange?: ChangeId;
+ @property({type: String})
+ baseChange?: ChangeId;
@state() private baseCommit?: string;
@@ -272,7 +273,7 @@
return true;
case InheritedBooleanInfoConfiguredValue.FALSE:
return false;
- case InheritedBooleanInfoConfiguredValue.INHERITED:
+ case InheritedBooleanInfoConfiguredValue.INHERIT:
return !!config.inherited_value;
default:
return false;
diff --git a/polygerrit-ui/app/elements/admin/gr-create-repo-dialog/gr-create-repo-dialog.ts b/polygerrit-ui/app/elements/admin/gr-create-repo-dialog/gr-create-repo-dialog.ts
index 4c26f89..617ef99 100644
--- a/polygerrit-ui/app/elements/admin/gr-create-repo-dialog/gr-create-repo-dialog.ts
+++ b/polygerrit-ui/app/elements/admin/gr-create-repo-dialog/gr-create-repo-dialog.ts
@@ -36,10 +36,6 @@
import {fireEvent} from '../../../utils/event-util';
declare global {
- interface HTMLElementEventMap {
- 'text-changed': CustomEvent<string>;
- 'value-changed': CustomEvent;
- }
interface HTMLElementTagNameMap {
'gr-create-repo-dialog': GrCreateRepoDialog;
}
diff --git a/polygerrit-ui/app/elements/admin/gr-group-members/gr-group-members_test.ts b/polygerrit-ui/app/elements/admin/gr-group-members/gr-group-members_test.ts
index 46a69f4..762bd2d 100644
--- a/polygerrit-ui/app/elements/admin/gr-group-members/gr-group-members_test.ts
+++ b/polygerrit-ui/app/elements/admin/gr-group-members/gr-group-members_test.ts
@@ -25,6 +25,7 @@
queryAndAssert,
stubBaseUrl,
stubRestApi,
+ waitUntil,
} from '../../../test/test-utils';
import {
AccountId,
@@ -191,8 +192,7 @@
groupMemberSearchInput.text = memberName;
groupMemberSearchInput.value = '1234';
- await element.updateComplete;
- assert.isFalse(button.hasAttribute('disabled'));
+ await waitUntil(() => !button.hasAttribute('disabled'));
return element.handleSavingGroupMember().then(() => {
assert.isTrue(button.hasAttribute('disabled'));
@@ -218,7 +218,7 @@
const button = queryAndAssert<GrButton>(element, '#saveIncludedGroups');
- assert.isTrue(button.hasAttribute('disabled'));
+ await waitUntil(() => button.hasAttribute('disabled'));
const includedGroupSearchInput = queryAndAssert<GrAutocomplete>(
element,
@@ -226,8 +226,8 @@
);
includedGroupSearchInput.text = includedGroupName;
includedGroupSearchInput.value = 'testId';
- await element.updateComplete;
- assert.isFalse(button.hasAttribute('disabled'));
+
+ await waitUntil(() => !button.hasAttribute('disabled'));
return element.handleSavingIncludedGroups().then(() => {
assert.isTrue(button.hasAttribute('disabled'));
diff --git a/polygerrit-ui/app/elements/admin/gr-group/gr-group.ts b/polygerrit-ui/app/elements/admin/gr-group/gr-group.ts
index c4ef8e6..fc53ac6 100644
--- a/polygerrit-ui/app/elements/admin/gr-group/gr-group.ts
+++ b/polygerrit-ui/app/elements/admin/gr-group/gr-group.ts
@@ -56,10 +56,6 @@
}
declare global {
- interface HTMLElementEventMap {
- 'text-changed': CustomEvent<string>;
- 'value-changed': CustomEvent;
- }
interface HTMLElementTagNameMap {
'gr-group': GrGroup;
}
diff --git a/polygerrit-ui/app/elements/admin/gr-group/gr-group_test.ts b/polygerrit-ui/app/elements/admin/gr-group/gr-group_test.ts
index c2ef76a..a6258b0 100644
--- a/polygerrit-ui/app/elements/admin/gr-group/gr-group_test.ts
+++ b/polygerrit-ui/app/elements/admin/gr-group/gr-group_test.ts
@@ -23,6 +23,7 @@
mockPromise,
queryAndAssert,
stubRestApi,
+ waitUntil,
} from '../../../test/test-utils';
import {createGroupInfo} from '../../../test/test-data-generators.js';
import {GroupId, GroupInfo, GroupName} from '../../../types/common';
@@ -139,9 +140,8 @@
queryAndAssert<GrAutocomplete>(element, '#groupNameInput').text =
groupName2;
- await element.updateComplete;
+ await waitUntil(() => button.hasAttribute('disabled') === false);
- assert.isFalse(button.hasAttribute('disabled'));
assert.isTrue(
queryAndAssert<HTMLHeadingElement>(
element,
@@ -184,8 +184,7 @@
queryAndAssert<GrAutocomplete>(element, '#groupOwnerInput').text =
'testId2';
- await element.updateComplete;
- assert.isFalse(button.disabled);
+ await waitUntil(() => button.disabled === false);
assert.isTrue(
queryAndAssert<HTMLHeadingElement>(
element,
diff --git a/polygerrit-ui/app/elements/admin/gr-permission/gr-permission.ts b/polygerrit-ui/app/elements/admin/gr-permission/gr-permission.ts
index fba349d..ff3df99 100644
--- a/polygerrit-ui/app/elements/admin/gr-permission/gr-permission.ts
+++ b/polygerrit-ui/app/elements/admin/gr-permission/gr-permission.ts
@@ -147,10 +147,7 @@
override willUpdate(changedProperties: PropertyValues<GrPermission>): void {
if (changedProperties.has('editing')) {
- this.handleEditingChanged(
- this.editing,
- changedProperties.get('editing') as boolean
- );
+ this.handleEditingChanged(changedProperties.get('editing'));
}
if (
changedProperties.has('permission') ||
@@ -329,7 +326,7 @@
return permissionId === 'owner' || section === 'GLOBAL_CAPABILITIES';
}
- private handleEditingChanged(editing: boolean, editingOld: boolean) {
+ private handleEditingChanged(editingOld: boolean) {
// Ignore when editing gets set initially.
if (!editingOld) {
return;
@@ -339,7 +336,7 @@
}
// Restore original values if no longer editing.
- if (!editing) {
+ if (!this.editing) {
this.deleted = false;
delete this.permission.value.deleted;
this.groupFilter = '';
diff --git a/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor.ts b/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor.ts
index 55f7567..2033180 100644
--- a/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor.ts
+++ b/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor.ts
@@ -14,19 +14,19 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
+
import '@polymer/iron-input/iron-input';
import '@polymer/paper-toggle-button/paper-toggle-button';
-import '../../../styles/gr-form-styles';
-import '../../../styles/shared-styles';
import '../../shared/gr-button/gr-button';
-import {dom, EventApi} from '@polymer/polymer/lib/legacy/polymer.dom';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-plugin-config-array-editor_html';
-import {property, customElement} from '@polymer/decorators';
import {
PluginConfigOptionsChangedEventDetail,
ArrayPluginOption,
} from '../gr-repo-plugin-config/gr-repo-plugin-config-types';
+import {formStyles} from '../../../styles/gr-form-styles';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {LitElement, html, css} from 'lit';
+import {customElement, property, state} from 'lit/decorators';
+import {BindValueChangeEvent} from '../../../types/events';
declare global {
interface HTMLElementTagNameMap {
@@ -35,61 +35,153 @@
}
@customElement('gr-plugin-config-array-editor')
-export class GrPluginConfigArrayEditor extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrPluginConfigArrayEditor extends LitElement {
/**
* Fired when the plugin config option changes.
*
* @event plugin-config-option-changed
*/
- @property({type: String})
- _newValue = '';
+ // private but used in test
+ @state() newValue = '';
// This property is never null, since this component in only about operations
// on pluginOption.
@property({type: Object})
pluginOption!: ArrayPluginOption;
- @property({type: Boolean, reflectToAttribute: true})
+ @property({type: Boolean, reflect: true})
disabled = false;
- _handleAddTap(e: MouseEvent) {
- e.preventDefault();
- this._handleAdd();
+ static override get styles() {
+ return [
+ sharedStyles,
+ formStyles,
+ css`
+ .wrapper {
+ width: 30em;
+ }
+ .existingItems {
+ background: var(--table-header-background-color);
+ border: 1px solid var(--border-color);
+ border-radius: var(--border-radius);
+ }
+ gr-button {
+ float: right;
+ margin-left: var(--spacing-m);
+ width: 4.5em;
+ }
+ .row {
+ align-items: center;
+ display: flex;
+ justify-content: space-between;
+ padding: var(--spacing-m) 0;
+ width: 100%;
+ }
+ .existingItems .row {
+ padding: var(--spacing-m);
+ }
+ .existingItems .row:not(:first-of-type) {
+ border-top: 1px solid var(--border-color);
+ }
+ input {
+ flex-grow: 1;
+ }
+ .hide {
+ display: none;
+ }
+ .placeholder {
+ color: var(--deemphasized-text-color);
+ padding-top: var(--spacing-m);
+ }
+ `,
+ ];
}
- _handleInputKeydown(e: KeyboardEvent) {
+ override render() {
+ return html`
+ <div class="wrapper gr-form-styles">
+ ${this.renderPluginOptions()}
+ <div class="row ${this.disabled ? 'hide' : ''}">
+ <iron-input
+ .bindValue=${this.newValue}
+ @bind-value-changed=${this.handleBindValueChangedNewValue}
+ >
+ <input
+ id="input"
+ @keydown=${this.handleInputKeydown}
+ ?disabled=${this.disabled}
+ />
+ </iron-input>
+ <gr-button
+ id="addButton"
+ ?disabled=${!this.newValue.length}
+ link
+ @click=${this.handleAddTap}
+ >Add</gr-button
+ >
+ </div>
+ </div>
+ `;
+ }
+
+ private renderPluginOptions() {
+ if (!this.pluginOption?.info?.values?.length) {
+ return html`<div class="row placeholder">None configured.</div>`;
+ }
+
+ return html`
+ <div class="existingItems">
+ ${this.pluginOption.info.values.map(item =>
+ this.renderPluginOptionValue(item)
+ )}
+ </div>
+ `;
+ }
+
+ private renderPluginOptionValue(item: string) {
+ return html`
+ <div class="row">
+ <span>${item}</span>
+ <gr-button
+ link
+ ?disabled=${this.disabled}
+ @click=${() => this.handleDelete(item)}
+ >Delete</gr-button
+ >
+ </div>
+ `;
+ }
+
+ private handleAddTap(e: MouseEvent) {
+ e.preventDefault();
+ this.handleAdd();
+ }
+
+ private handleInputKeydown(e: KeyboardEvent) {
// Enter.
if (e.keyCode === 13) {
e.preventDefault();
- this._handleAdd();
+ this.handleAdd();
}
}
- _handleAdd() {
- if (!this._newValue.length) {
+ private handleAdd() {
+ if (!this.newValue.length) {
return;
}
- this._dispatchChanged(
- this.pluginOption.info.values.concat([this._newValue])
- );
- this._newValue = '';
+ this.dispatchChanged(this.pluginOption.info.values.concat([this.newValue]));
+ this.newValue = '';
}
- _handleDelete(e: MouseEvent) {
- const value = ((dom(e) as EventApi).localTarget as HTMLElement).dataset[
- 'item'
- ];
- this._dispatchChanged(
+ private handleDelete(value: string) {
+ this.dispatchChanged(
this.pluginOption.info.values.filter(str => str !== value)
);
}
- _dispatchChanged(values: string[]) {
+ // private but used in test
+ dispatchChanged(values: string[]) {
const {_key, info} = this.pluginOption;
const detail: PluginConfigOptionsChangedEventDetail = {
_key,
@@ -101,7 +193,7 @@
);
}
- _computeShowInputRow(disabled: boolean) {
- return disabled ? 'hide' : '';
+ private handleBindValueChangedNewValue(e: BindValueChangeEvent) {
+ this.newValue = e.detail.value;
}
}
diff --git a/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor_html.ts b/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor_html.ts
deleted file mode 100644
index 7709198..0000000
--- a/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor_html.ts
+++ /dev/null
@@ -1,100 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="shared-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <style include="gr-form-styles">
- .wrapper {
- width: 30em;
- }
- .existingItems {
- background: var(--table-header-background-color);
- border: 1px solid var(--border-color);
- border-radius: var(--border-radius);
- }
- gr-button {
- float: right;
- margin-left: var(--spacing-m);
- width: 4.5em;
- }
- .row {
- align-items: center;
- display: flex;
- justify-content: space-between;
- padding: var(--spacing-m) 0;
- width: 100%;
- }
- .existingItems .row {
- padding: var(--spacing-m);
- }
- .existingItems .row:not(:first-of-type) {
- border-top: 1px solid var(--border-color);
- }
- input {
- flex-grow: 1;
- }
- .hide {
- display: none;
- }
- .placeholder {
- color: var(--deemphasized-text-color);
- padding-top: var(--spacing-m);
- }
- </style>
- <div class="wrapper gr-form-styles">
- <template is="dom-if" if="[[pluginOption.info.values.length]]">
- <div class="existingItems">
- <template is="dom-repeat" items="[[pluginOption.info.values]]">
- <div class="row">
- <span>[[item]]</span>
- <gr-button
- link=""
- disabled$="[[disabled]]"
- data-item$="[[item]]"
- on-click="_handleDelete"
- >Delete</gr-button
- >
- </div>
- </template>
- </div>
- </template>
- <template is="dom-if" if="[[!pluginOption.info.values.length]]">
- <div class="row placeholder">None configured.</div>
- </template>
- <div class$="row [[_computeShowInputRow(disabled)]]">
- <iron-input on-keydown="_handleInputKeydown" bind-value="{{_newValue}}">
- <input
- is="iron-input"
- id="input"
- on-keydown="_handleInputKeydown"
- bind-value="{{_newValue}}"
- disabled$="[[disabled]]"
- />
- </iron-input>
- <gr-button
- id="addButton"
- disabled$="[[!_newValue.length]]"
- link=""
- on-click="_handleAddTap"
- >Add</gr-button
- >
- </div>
- </div>
-`;
diff --git a/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor_test.ts b/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor_test.ts
index 655eb6b..5de1f1e 100644
--- a/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor_test.ts
+++ b/polygerrit-ui/app/elements/admin/gr-plugin-config-array-editor/gr-plugin-config-array-editor_test.ts
@@ -42,80 +42,96 @@
};
});
- test('_computeShowInputRow', () => {
- assert.equal(element._computeShowInputRow(true), 'hide');
- assert.equal(element._computeShowInputRow(false), '');
- });
-
suite('adding', () => {
setup(() => {
- dispatchStub = sinon.stub(element, '_dispatchChanged');
+ dispatchStub = sinon.stub(element, 'dispatchChanged');
});
- test('with enter', () => {
- element._newValue = '';
- MockInteractions.pressAndReleaseKeyOn(element.$.input, 13); // Enter
- assert.isFalse(element.$.input.hasAttribute('disabled'));
- flush();
+ test('with enter', async () => {
+ element.newValue = '';
+ await element.updateComplete;
+ MockInteractions.pressAndReleaseKeyOn(
+ queryAndAssert<HTMLInputElement>(element, '#input'),
+ 13
+ ); // Enter
+ await element.updateComplete;
+ assert.isFalse(
+ queryAndAssert<HTMLInputElement>(element, '#input').hasAttribute(
+ 'disabled'
+ )
+ );
+ await element.updateComplete;
assert.isFalse(dispatchStub.called);
- element._newValue = 'test';
- MockInteractions.pressAndReleaseKeyOn(element.$.input, 13); // Enter
- assert.isFalse(element.$.input.hasAttribute('disabled'));
- flush();
+ element.newValue = 'test';
+ await element.updateComplete;
+
+ MockInteractions.pressAndReleaseKeyOn(
+ queryAndAssert<HTMLInputElement>(element, '#input'),
+ 13
+ ); // Enter
+ await element.updateComplete;
+ assert.isFalse(
+ queryAndAssert<HTMLInputElement>(element, '#input').hasAttribute(
+ 'disabled'
+ )
+ );
+ await element.updateComplete;
assert.isTrue(dispatchStub.called);
assert.equal(dispatchStub.lastCall.args[0], 'test');
- assert.equal(element._newValue, '');
+ assert.equal(element.newValue, '');
});
- test('with add btn', () => {
- element._newValue = '';
- MockInteractions.tap(element.$.addButton);
- flush();
+ test('with add btn', async () => {
+ element.newValue = '';
+ queryAndAssert<GrButton>(element, '#addButton').click();
+ await element.updateComplete;
assert.isFalse(dispatchStub.called);
- element._newValue = 'test';
- MockInteractions.tap(element.$.addButton);
- flush();
+
+ element.newValue = 'test';
+ await element.updateComplete;
+
+ queryAndAssert<GrButton>(element, '#addButton').click();
+ await element.updateComplete;
assert.isTrue(dispatchStub.called);
assert.equal(dispatchStub.lastCall.args[0], 'test');
- assert.equal(element._newValue, '');
+ assert.equal(element.newValue, '');
});
});
test('deleting', async () => {
- dispatchStub = sinon.stub(element, '_dispatchChanged');
+ dispatchStub = sinon.stub(element, 'dispatchChanged');
element.pluginOption = {
_key: '',
info: {type: ConfigParameterInfoType.ARRAY, values: ['test', 'test2']},
};
element.disabled = true;
- await flush();
+ await element.updateComplete;
const rows = queryAll(element, '.existingItems .row');
assert.equal(rows.length, 2);
const button = queryAndAssert<GrButton>(rows[0], 'gr-button');
MockInteractions.tap(button);
- await flush();
+ await element.updateComplete;
assert.isFalse(dispatchStub.called);
element.disabled = false;
- element.notifyPath('pluginOption.info.editable');
- await flush();
+ await element.updateComplete;
- MockInteractions.tap(button);
- await flush();
+ button.click();
+ await element.updateComplete;
assert.isTrue(dispatchStub.called);
assert.deepEqual(dispatchStub.lastCall.args[0], ['test2']);
});
- test('_dispatchChanged', () => {
+ test('dispatchChanged', () => {
const eventStub = sinon.stub(element, 'dispatchEvent');
- element._dispatchChanged(['new-test-value']);
+ element.dispatchChanged(['new-test-value']);
assert.isTrue(eventStub.called);
const {detail} = eventStub.lastCall.args[0] as CustomEvent;
diff --git a/polygerrit-ui/app/elements/admin/gr-repo-access/gr-repo-access.ts b/polygerrit-ui/app/elements/admin/gr-repo-access/gr-repo-access.ts
index 07a9188..ad15ab6 100644
--- a/polygerrit-ui/app/elements/admin/gr-repo-access/gr-repo-access.ts
+++ b/polygerrit-ui/app/elements/admin/gr-repo-access/gr-repo-access.ts
@@ -59,9 +59,6 @@
const MAX_AUTOCOMPLETE_RESULTS = 50;
declare global {
- interface HTMLElementEventMap {
- 'text-changed': CustomEvent<string>;
- }
interface HTMLElementTagNameMap {
'gr-repo-access': GrRepoAccess;
}
diff --git a/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view.ts b/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view.ts
index 85d53d7..9743987 100644
--- a/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view.ts
+++ b/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view.ts
@@ -35,7 +35,6 @@
import {fire, fireTitleChange} from '../../../utils/event-util';
import {getAppContext} from '../../../services/app-context';
import {GerritView} from '../../../services/router/router-model';
-import {RELOAD_DASHBOARD_INTERVAL_MS} from '../../../constants/constants';
import {sharedStyles} from '../../../styles/shared-styles';
import {LitElement, PropertyValues, html, css} from 'lit';
import {customElement, property, state, query} from 'lit/decorators';
@@ -103,8 +102,6 @@
private reporting = getAppContext().reportingService;
- private lastVisibleTimestampMs = 0;
-
constructor() {
super();
this.addEventListener('next-page', () => this.handleNextPage());
@@ -112,32 +109,12 @@
this.addEventListener('reload', () => this.reload());
}
- private readonly visibilityChangeListener = () => {
- if (document.visibilityState === 'visible') {
- if (
- Date.now() - this.lastVisibleTimestampMs >
- RELOAD_DASHBOARD_INTERVAL_MS
- )
- this.reload();
- } else {
- this.lastVisibleTimestampMs = Date.now();
- }
- };
-
override connectedCallback() {
super.connectedCallback();
this.loadPreferences();
- document.addEventListener(
- 'visibilitychange',
- this.visibilityChangeListener
- );
}
override disconnectedCallback() {
- document.removeEventListener(
- 'visibilitychange',
- this.visibilityChangeListener
- );
super.disconnectedCallback();
}
@@ -305,7 +282,9 @@
this.viewState.selectedChangeIndex = 0;
this.viewState.query = this.query;
this.viewState.offset = this.offset;
- fire(this, 'view-state-changed', {value: this.viewState});
+ fire(this, 'view-state-change-list-view-changed', {
+ value: this.viewState,
+ });
}
// NOTE: This method may be called before attachment. Fire title-change
@@ -430,13 +409,13 @@
private handleSelectedIndexChanged(e: ValueChangedEvent<number>) {
if (!this.viewState) return;
this.viewState.selectedChangeIndex = e.detail.value;
- fire(this, 'view-state-changed', {value: this.viewState});
+ fire(this, 'view-state-change-list-view-changed', {value: this.viewState});
}
}
declare global {
interface HTMLElementEventMap {
- 'view-state-changed': ValueChangedEvent<ChangeListViewState>;
+ 'view-state-change-list-view-changed': ValueChangedEvent<ChangeListViewState>;
}
interface HTMLElementTagNameMap {
'gr-change-list-view': GrChangeListView;
diff --git a/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view_test.ts b/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view_test.ts
index c37c635..0633f46 100644
--- a/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view_test.ts
+++ b/polygerrit-ui/app/elements/change-list/gr-change-list-view/gr-change-list-view_test.ts
@@ -20,7 +20,6 @@
import {GrChangeListView} from './gr-change-list-view';
import {page} from '../../../utils/page-wrapper-utils';
import {GerritNav} from '../../core/gr-navigation/gr-navigation';
-import 'lodash/lodash';
import {
mockPromise,
query,
@@ -140,7 +139,9 @@
});
test('prevArrow', async () => {
- element.changes = _.times(25, _.constant(createChange()));
+ element.changes = Array(25)
+ .fill(0)
+ .map(_ => createChange());
element.offset = 0;
element.loading = false;
await element.updateComplete;
@@ -152,32 +153,34 @@
});
test('nextArrow', async () => {
- element.changes = _.times(
- 25,
- _.constant({...createChange(), _more_changes: true})
- ) as ChangeInfo[];
+ element.changes = Array(25)
+ .fill(0)
+ .map(_ => ({...createChange(), _more_changes: true} as ChangeInfo));
element.loading = false;
await element.updateComplete;
assert.isOk(query(element, '#nextArrow'));
- element.changes = _.times(25, _.constant(createChange()));
+ element.changes = Array(25)
+ .fill(0)
+ .map(_ => createChange());
await element.updateComplete;
assert.isNotOk(query(element, '#nextArrow'));
});
test('handleNextPage', async () => {
const showStub = sinon.stub(page, 'show');
- element.changes = _.times(25, _.constant(createChange()));
+ element.changes = Array(25)
+ .fill(0)
+ .map(_ => createChange());
element.changesPerPage = 10;
element.loading = false;
await element.updateComplete;
element.handleNextPage();
assert.isFalse(showStub.called);
- element.changes = _.times(
- 25,
- _.constant({...createChange(), _more_changes: true})
- ) as ChangeInfo[];
+ element.changes = Array(25)
+ .fill(0)
+ .map(_ => ({...createChange(), _more_changes: true} as ChangeInfo));
element.loading = false;
await element.updateComplete;
element.handleNextPage();
@@ -187,7 +190,9 @@
test('handlePreviousPage', async () => {
const showStub = sinon.stub(page, 'show');
element.offset = 0;
- element.changes = _.times(25, _.constant(createChange()));
+ element.changes = Array(25)
+ .fill(0)
+ .map(_ => createChange());
element.changesPerPage = 10;
element.loading = false;
await element.updateComplete;
diff --git a/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions.ts b/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions.ts
index 5f6732e..10fd50e 100644
--- a/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions.ts
+++ b/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions.ts
@@ -29,7 +29,6 @@
import '../gr-confirm-submit-dialog/gr-confirm-submit-dialog';
import '../../../styles/shared-styles';
import {dom, EventApi} from '@polymer/polymer/lib/legacy/polymer.dom';
-import {htmlTemplate} from './gr-change-actions_html';
import {GerritNav} from '../../core/gr-navigation/gr-navigation';
import {getPluginLoader} from '../../shared/gr-js-api-interface/gr-plugin-loader';
import {getAppContext} from '../../../services/app-context';
@@ -47,7 +46,6 @@
NotifyType,
} from '../../../constants/constants';
import {EventType as PluginEventType, TargetElement} from '../../../api/plugin';
-import {customElement, observe, property} from '@polymer/decorators';
import {
AccountInfo,
ActionInfo,
@@ -63,11 +61,9 @@
LabelInfo,
NumericChangeId,
PatchSetNum,
- PropertyType,
RequestPayload,
RevertSubmissionInfo,
ReviewInput,
- ServerInfo,
} from '../../../types/common';
import {GrConfirmAbandonDialog} from '../gr-confirm-abandon-dialog/gr-confirm-abandon-dialog';
import {GrOverlay} from '../../shared/gr-overlay/gr-overlay';
@@ -86,13 +82,17 @@
ConfirmRebaseEventDetail,
GrConfirmRebaseDialog,
} from '../gr-confirm-rebase-dialog/gr-confirm-rebase-dialog';
-import {PolymerDeepPropertyChange} from '@polymer/polymer/interfaces';
import {GrButton} from '../../shared/gr-button/gr-button';
import {
GrChangeActionsElement,
UIActionInfo,
} from '../../shared/gr-js-api-interface/gr-change-actions-js-api';
-import {fireAlert, fireEvent, fireReload} from '../../../utils/event-util';
+import {
+ fire,
+ fireAlert,
+ fireEvent,
+ fireReload,
+} from '../../../utils/event-util';
import {
getApprovalInfo,
getVotingRange,
@@ -108,8 +108,13 @@
} from '../../../api/change-actions';
import {ErrorCallback} from '../../../api/rest';
import {GrDropdown} from '../../shared/gr-dropdown/gr-dropdown';
-import {resolve, DIPolymerElement} from '../../../models/dependency';
+import {resolve} from '../../../models/dependency';
import {changeModelToken} from '../../../models/change/change-model';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {LitElement, PropertyValues, css, html, nothing} from 'lit';
+import {customElement, property, query, state} from 'lit/decorators';
+import {ifDefined} from 'lit/directives/if-defined';
+import {assertIsDefined, queryAll} from '../../../utils/common-util';
const ERR_BRANCH_EMPTY = 'The destination branch can’t be empty.';
const ERR_COMMIT_EMPTY = 'The commit message can’t be empty.';
@@ -320,35 +325,11 @@
init?(): void;
}
-export interface GrChangeActions {
- $: {
- mainContent: Element;
- overlay: GrOverlay;
- confirmRebase: GrConfirmRebaseDialog;
- confirmCherrypick: GrConfirmCherrypickDialog;
- confirmCherrypickConflict: GrConfirmCherrypickConflictDialog;
- confirmMove: GrConfirmMoveDialog;
- confirmRevertDialog: GrConfirmRevertDialog;
- confirmAbandonDialog: GrConfirmAbandonDialog;
- confirmSubmitDialog: GrConfirmSubmitDialog;
- createFollowUpDialog: GrDialog;
- createFollowUpChange: GrCreateChangeDialog;
- confirmDeleteDialog: GrDialog;
- confirmDeleteEditDialog: GrDialog;
- moreActions: GrDropdown;
- secondaryActions: HTMLElement;
- };
-}
-
@customElement('gr-change-actions')
export class GrChangeActions
- extends DIPolymerElement
+ extends LitElement
implements GrChangeActionsElement
{
- static get template() {
- return htmlTemplate;
- }
-
/**
* Fired when the change should be reloaded.
*
@@ -373,6 +354,37 @@
* @event show-error
*/
+ @query('#mainContent') mainContent?: Element;
+
+ @query('#overlay') overlay?: GrOverlay;
+
+ @query('#confirmRebase') confirmRebase?: GrConfirmRebaseDialog;
+
+ @query('#confirmCherrypick') confirmCherrypick?: GrConfirmCherrypickDialog;
+
+ @query('#confirmCherrypickConflict')
+ confirmCherrypickConflict?: GrConfirmCherrypickConflictDialog;
+
+ @query('#confirmMove') confirmMove?: GrConfirmMoveDialog;
+
+ @query('#confirmRevertDialog') confirmRevertDialog?: GrConfirmRevertDialog;
+
+ @query('#confirmAbandonDialog') confirmAbandonDialog?: GrConfirmAbandonDialog;
+
+ @query('#confirmSubmitDialog') confirmSubmitDialog?: GrConfirmSubmitDialog;
+
+ @query('#createFollowUpDialog') createFollowUpDialog?: GrDialog;
+
+ @query('#createFollowUpChange') createFollowUpChange?: GrCreateChangeDialog;
+
+ @query('#confirmDeleteDialog') confirmDeleteDialog?: GrDialog;
+
+ @query('#confirmDeleteEditDialog') confirmDeleteEditDialog?: GrDialog;
+
+ @query('#moreActions') moreActions?: GrDropdown;
+
+ @query('#secondaryActions') secondaryActions?: HTMLElement;
+
// TODO(TS): Ensure that ActionType, ChangeActions and RevisionActions
// properties are replaced with enums everywhere and remove them from
// the GrChangeActions class
@@ -407,8 +419,8 @@
@property({type: Boolean})
_hasKnownChainState = false;
- @property({type: Boolean})
- _hideQuickApproveAction = false;
+ // private but used in test
+ @state() _hideQuickApproveAction = false;
@property({type: Object})
account?: AccountInfo;
@@ -422,7 +434,7 @@
@property({type: String})
commitNum?: CommitId;
- @property({type: Boolean, observer: '_computeChainState'})
+ @property({type: Boolean})
hasParent?: boolean;
@property({type: String})
@@ -431,58 +443,39 @@
@property({type: String})
commitMessage = '';
- @property({type: Object, notify: true})
+ @property({type: Object})
revisionActions: ActionNameToActionInfoMap = {};
- @property({type: Object, computed: '_getSubmitAction(revisionActions)'})
- _revisionSubmitAction?: ActionInfo | null;
+ @state() private revisionSubmitAction?: ActionInfo | null;
- @property({type: Object, computed: '_getRebaseAction(revisionActions)'})
- _revisionRebaseAction?: ActionInfo | null;
+ // used as a proprty type so cannot be private
+ @state() revisionRebaseAction?: ActionInfo | null;
@property({type: String})
privateByDefault?: InheritedBooleanInfo;
- @property({type: Boolean})
- _loading = true;
+ // private but used in test
+ @state() loading = true;
- @property({type: String})
- _actionLoadingMessage = '';
+ // private but used in test
+ @state() actionLoadingMessage = '';
- @property({
- type: Array,
- computed:
- '_computeAllActions(actions.*, revisionActions.*,' +
- 'primaryActionKeys.*, _additionalActions.*, change, ' +
- '_actionPriorityOverrides.*)',
- })
- _allActionValues: UIActionInfo[] = []; // _computeAllActions always returns an array
+ // _computeAllActions always returns an array
+ // private but used in test
+ @state() allActionValues: UIActionInfo[] = [];
- @property({
- type: Array,
- computed:
- '_computeTopLevelActions(_allActionValues.*, ' +
- '_hiddenActions.*, editMode, _overflowActions.*)',
- observer: '_filterPrimaryActions',
- })
- _topLevelActions?: UIActionInfo[];
+ // private but used in test
+ @state() topLevelActions?: UIActionInfo[];
- @property({type: Array})
- _topLevelPrimaryActions?: UIActionInfo[];
+ // private but used in test
+ @state() topLevelPrimaryActions?: UIActionInfo[];
- @property({type: Array})
- _topLevelSecondaryActions?: UIActionInfo[];
+ // private but used in test
+ @state() topLevelSecondaryActions?: UIActionInfo[];
- @property({
- type: Array,
- computed:
- '_computeMenuActions(_allActionValues.*, ' +
- '_hiddenActions.*, _overflowActions.*)',
- })
- _menuActions?: MenuAction[];
+ @state() private menuActions?: MenuAction[];
- @property({type: Array})
- _overflowActions: OverflowAction[] = [
+ @state() private overflowActions: OverflowAction[] = [
{
type: ActionType.CHANGE,
key: ChangeActions.WIP,
@@ -529,17 +522,15 @@
},
];
- @property({type: Array})
- _actionPriorityOverrides: ActionPriorityOverride[] = [];
+ @state() private actionPriorityOverrides: ActionPriorityOverride[] = [];
- @property({type: Array})
- _additionalActions: UIActionInfo[] = [];
+ @state() private additionalActions: UIActionInfo[] = [];
- @property({type: Array})
- _hiddenActions: string[] = [];
+ // private but used in test
+ @state() hiddenActions: string[] = [];
- @property({type: Array})
- _disabledMenuActions: string[] = [];
+ // private but used in test
+ @state() disabledMenuActions: string[] = [];
@property({type: Boolean})
editPatchsetLoaded = false;
@@ -550,9 +541,6 @@
@property({type: Boolean})
editBasedOnCurrentPatchSet = true;
- @property({type: Object})
- _config?: ServerInfo;
-
@property({type: Boolean})
loggedIn = false;
@@ -563,31 +551,323 @@
constructor() {
super();
this.addEventListener('fullscreen-overlay-opened', () =>
- this._handleHideBackgroundContent()
+ this.handleHideBackgroundContent()
);
this.addEventListener('fullscreen-overlay-closed', () =>
- this._handleShowBackgroundContent()
+ this.handleShowBackgroundContent()
);
}
- override ready() {
- super.ready();
+ override connectedCallback() {
+ super.connectedCallback();
this.jsAPI.addElement(TargetElement.CHANGE_ACTIONS, this);
- this.restApiService.getConfig().then(config => {
- this._config = config;
+ this.handleLoadingComplete();
+ }
+
+ static override get styles() {
+ return [
+ sharedStyles,
+ css`
+ :host {
+ display: flex;
+ font-family: var(--font-family);
+ }
+ #actionLoadingMessage,
+ #mainContent,
+ section {
+ display: flex;
+ }
+ #actionLoadingMessage,
+ gr-button,
+ gr-dropdown {
+ /* px because don't have the same font size */
+ margin-left: 8px;
+ }
+ gr-button {
+ display: block;
+ }
+ #actionLoadingMessage {
+ align-items: center;
+ color: var(--deemphasized-text-color);
+ }
+ #confirmSubmitDialog .changeSubject {
+ margin: var(--spacing-l);
+ text-align: center;
+ }
+ iron-icon {
+ color: inherit;
+ margin-right: var(--spacing-xs);
+ }
+ #moreActions iron-icon {
+ margin: 0;
+ }
+ #moreMessage,
+ .hidden {
+ display: none;
+ }
+ @media screen and (max-width: 50em) {
+ #mainContent {
+ flex-wrap: wrap;
+ }
+ gr-button {
+ --gr-button-padding: var(--spacing-m);
+ white-space: nowrap;
+ }
+ gr-button,
+ gr-dropdown {
+ margin: 0;
+ }
+ #actionLoadingMessage {
+ margin: var(--spacing-m);
+ text-align: center;
+ }
+ #moreMessage {
+ display: inline;
+ }
+ }
+ `,
+ ];
+ }
+
+ override render() {
+ if (!this.change) return nothing;
+ return html`
+ <div id="mainContent">
+ <span id="actionLoadingMessage" ?hidden=${!this.actionLoadingMessage}>
+ ${this.actionLoadingMessage}
+ </span>
+ <section
+ id="primaryActions"
+ ?hidden=${this.loading ||
+ !this.topLevelActions ||
+ !this.topLevelActions.length}
+ >
+ ${this.topLevelPrimaryActions?.map(action =>
+ this.renderTopPrimaryActions(action)
+ )}
+ </section>
+ <section
+ id="secondaryActions"
+ ?hidden=${this.loading ||
+ !this.topLevelActions ||
+ !this.topLevelActions.length}
+ >
+ ${this.topLevelSecondaryActions?.map(action =>
+ this.renderTopSecondaryActions(action)
+ )}
+ </section>
+ <gr-button ?hidden=${!this.loading}>Loading actions...</gr-button>
+ <gr-dropdown
+ id="moreActions"
+ link
+ .verticalOffset=${32}
+ .horizontalAlign=${'right'}
+ @tap-item=${this.handleOverflowItemTap}
+ ?hidden=${this.loading ||
+ !this.menuActions ||
+ !this.menuActions.length}
+ .disabledIds=${this.disabledMenuActions}
+ .items=${this.menuActions}
+ >
+ <iron-icon icon="gr-icons:more-vert" aria-labelledby="moreMessage">
+ </iron-icon>
+ <span id="moreMessage">More</span>
+ </gr-dropdown>
+ </div>
+ <gr-overlay id="overlay" with-backdrop="">
+ <gr-confirm-rebase-dialog
+ id="confirmRebase"
+ class="confirmDialog"
+ .changeNumber=${this.change?._number}
+ @confirm=${this.handleRebaseConfirm}
+ @cancel=${this.handleConfirmDialogCancel}
+ .branch=${this.change?.branch}
+ .hasParent=${this.hasParent}
+ .rebaseOnCurrent=${this.revisionRebaseAction
+ ? !!this.revisionRebaseAction.enabled
+ : null}
+ ></gr-confirm-rebase-dialog>
+ <gr-confirm-cherrypick-dialog
+ id="confirmCherrypick"
+ class="confirmDialog"
+ .changeStatus=${this.changeStatus}
+ .commitMessage=${this.commitMessage}
+ .commitNum=${this.commitNum}
+ @confirm=${this.handleCherrypickConfirm}
+ @cancel=${this.handleConfirmDialogCancel}
+ .project=${this.change?.project}
+ ></gr-confirm-cherrypick-dialog>
+ <gr-confirm-cherrypick-conflict-dialog
+ id="confirmCherrypickConflict"
+ class="confirmDialog"
+ @confirm=${this.handleCherrypickConflictConfirm}
+ @cancel=${this.handleConfirmDialogCancel}
+ ></gr-confirm-cherrypick-conflict-dialog>
+ <gr-confirm-move-dialog
+ id="confirmMove"
+ class="confirmDialog"
+ @confirm=${this.handleMoveConfirm}
+ @cancel=${this.handleConfirmDialogCancel}
+ .project=${this.change?.project}
+ ></gr-confirm-move-dialog>
+ <gr-confirm-revert-dialog
+ id="confirmRevertDialog"
+ class="confirmDialog"
+ @confirm=${this.handleRevertDialogConfirm}
+ @cancel=${this.handleConfirmDialogCancel}
+ ></gr-confirm-revert-dialog>
+ <gr-confirm-abandon-dialog
+ id="confirmAbandonDialog"
+ class="confirmDialog"
+ @confirm=${this.handleAbandonDialogConfirm}
+ @cancel=${this.handleConfirmDialogCancel}
+ ></gr-confirm-abandon-dialog>
+ <gr-confirm-submit-dialog
+ id="confirmSubmitDialog"
+ class="confirmDialog"
+ .action=${this.revisionSubmitAction}
+ @cancel=${this.handleConfirmDialogCancel}
+ @confirm=${this.handleSubmitConfirm}
+ ></gr-confirm-submit-dialog>
+ <gr-dialog
+ id="createFollowUpDialog"
+ class="confirmDialog"
+ confirm-label="Create"
+ @confirm=${this.handleCreateFollowUpChange}
+ @cancel=${this.handleCloseCreateFollowUpChange}
+ >
+ <div class="header" slot="header">Create Follow-Up Change</div>
+ <div class="main" slot="main">
+ <gr-create-change-dialog
+ id="createFollowUpChange"
+ .branch=${this.change?.branch}
+ .baseChange=${this.change?.id}
+ .repoName=${this.change?.project}
+ .privateByDefault=${this.privateByDefault}
+ ></gr-create-change-dialog>
+ </div>
+ </gr-dialog>
+ <gr-dialog
+ id="confirmDeleteDialog"
+ class="confirmDialog"
+ confirm-label="Delete"
+ confirm-on-enter=""
+ @cancel=${this.handleConfirmDialogCancel}
+ @confirm=${this.handleDeleteConfirm}
+ >
+ <div class="header" slot="header">Delete Change</div>
+ <div class="main" slot="main">
+ Do you really want to delete the change?
+ </div>
+ </gr-dialog>
+ <gr-dialog
+ id="confirmDeleteEditDialog"
+ class="confirmDialog"
+ confirm-label="Delete"
+ confirm-on-enter=""
+ @cancel=${this.handleConfirmDialogCancel}
+ @confirm=${this.handleDeleteEditConfirm}
+ >
+ <div class="header" slot="header">Delete Change Edit</div>
+ <div class="main" slot="main">
+ Do you really want to delete the edit?
+ </div>
+ </gr-dialog>
+ </gr-overlay>
+ `;
+ }
+
+ private renderTopPrimaryActions(action: UIActionInfo) {
+ return html`
+ <gr-tooltip-content
+ title=${ifDefined(action.title)}
+ .hasTooltip=${!!action.title}
+ ?position-below=${true}
+ >
+ <gr-button
+ link
+ class=${action.__key}
+ data-action-key=${action.__key}
+ data-label=${action.label}
+ ?disabled=${this.calculateDisabled(action)}
+ @click=${(e: MouseEvent) =>
+ this.handleActionTap(e, action.__key, action.__type)}
+ >
+ <iron-icon
+ class=${action.icon ? '' : 'hidden'}
+ .icon="gr-icons:${action.icon}"
+ ></iron-icon>
+ ${action.label}
+ </gr-button>
+ </gr-tooltip-content>
+ `;
+ }
+
+ private renderTopSecondaryActions(action: UIActionInfo) {
+ return html`
+ <gr-tooltip-content
+ title=${ifDefined(action.title)}
+ .hasTooltip=${!!action.title}
+ ?position-below=${true}
+ >
+ <gr-button
+ link
+ class=${action.__key}
+ data-action-key=${action.__key}
+ data-label=${action.label}
+ ?disabled=${this.calculateDisabled(action)}
+ @click=${(e: MouseEvent) =>
+ this.handleActionTap(e, action.__key, action.__type)}
+ >
+ <iron-icon
+ class=${action.icon ? '' : 'hidden'}
+ icon="gr-icons:${action.icon}"
+ ></iron-icon>
+ ${action.label}
+ </gr-button>
+ </gr-tooltip-content>
+ `;
+ }
+
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('hasParent')) {
+ this.computeChainState();
+ }
+
+ if (changedProperties.has('change')) {
+ this.reload();
+ this.actions = this.change?.actions ?? {};
+ }
+
+ this.editStatusChanged();
+
+ this.actionsChanged();
+ this.allActionValues = this.computeAllActions();
+ this.topLevelActions = this.allActionValues.filter(a => {
+ if (this.hiddenActions.includes(a.__key)) return false;
+ if (this.editMode) return EDIT_ACTIONS.has(a.__key);
+ return this.getActionOverflowIndex(a.__type, a.__key) === -1;
});
- this._handleLoadingComplete();
+ this.topLevelPrimaryActions = this.topLevelActions.filter(
+ action => action.__primary
+ );
+ this.topLevelSecondaryActions = this.topLevelActions.filter(
+ action => !action.__primary
+ );
+ this.menuActions = this.computeMenuActions();
+ this.revisionSubmitAction = this.getSubmitAction(this.revisionActions);
+ this.revisionRebaseAction = this.getRebaseAction(this.revisionActions);
}
- _getSubmitAction(revisionActions: ActionNameToActionInfoMap) {
- return this._getRevisionAction(revisionActions, 'submit');
+ private getSubmitAction(revisionActions: ActionNameToActionInfoMap) {
+ return this.getRevisionAction(revisionActions, 'submit');
}
- _getRebaseAction(revisionActions: ActionNameToActionInfoMap) {
- return this._getRevisionAction(revisionActions, 'rebase');
+ private getRebaseAction(revisionActions: ActionNameToActionInfoMap) {
+ return this.getRevisionAction(revisionActions, 'rebase');
}
- _getRevisionAction(
+ private getRevisionAction(
revisionActions: ActionNameToActionInfoMap,
actionName: string
) {
@@ -608,7 +888,7 @@
}
const change = this.change;
- this._loading = true;
+ this.loading = true;
return this.restApiService
.getChangeRevisionActions(this.changeNum, this.latestPatchNum)
.then(revisionActions => {
@@ -617,37 +897,33 @@
}
this.revisionActions = revisionActions;
- this._sendShowRevisionActions({
+ this.sendShowRevisionActions({
change,
revisionActions,
});
- this._handleLoadingComplete();
+ this.handleLoadingComplete();
})
.catch(err => {
fireAlert(this, ERR_REVISION_ACTIONS);
- this._loading = false;
+ this.loading = false;
throw err;
});
}
- _handleLoadingComplete() {
+ private handleLoadingComplete() {
getPluginLoader()
.awaitPluginsLoaded()
- .then(() => (this._loading = false));
+ .then(() => (this.loading = false));
}
- _sendShowRevisionActions(detail: {
+ // private but used in test
+ sendShowRevisionActions(detail: {
change: ChangeInfo;
revisionActions: ActionNameToActionInfoMap;
}) {
this.jsAPI.handleEvent(PluginEventType.SHOW_REVISION_ACTIONS, detail);
}
- @observe('change')
- _changeChanged() {
- this.reload();
- }
-
addActionButton(type: ActionType, label: string) {
if (type !== ActionType.CHANGE && type !== ActionType.REVISION) {
throw Error(`Invalid action type: ${type}`);
@@ -659,16 +935,18 @@
__key:
ADDITIONAL_ACTION_KEY_PREFIX + Math.random().toString(36).substr(2),
};
- this.push('_additionalActions', action);
+ this.additionalActions.push(action);
+ this.requestUpdate('additionalActions');
return action.__key;
}
removeActionButton(key: string) {
- const idx = this._indexOfActionButtonWithKey(key);
+ const idx = this.indexOfActionButtonWithKey(key);
if (idx === -1) {
return;
}
- this.splice('_additionalActions', idx, 1);
+ this.additionalActions.splice(idx, 1);
+ this.requestUpdate('additionalActions');
}
setActionButtonProp<T extends keyof UIActionInfo>(
@@ -676,26 +954,26 @@
prop: T,
value: UIActionInfo[T]
) {
- this.set(
- ['_additionalActions', this._indexOfActionButtonWithKey(key), prop],
- value
- );
+ this.additionalActions[this.indexOfActionButtonWithKey(key)][prop] = value;
+ this.requestUpdate('additionalActions');
}
setActionOverflow(type: ActionType, key: string, overflow: boolean) {
if (type !== ActionType.CHANGE && type !== ActionType.REVISION) {
throw Error(`Invalid action type given: ${type}`);
}
- const index = this._getActionOverflowIndex(type, key);
+ const index = this.getActionOverflowIndex(type, key);
const action: OverflowAction = {
type,
key,
overflow,
};
if (!overflow && index !== -1) {
- this.splice('_overflowActions', index, 1);
+ this.overflowActions.splice(index, 1);
+ this.requestUpdate('overflowActions');
} else if (overflow) {
- this.push('_overflowActions', action);
+ this.overflowActions.push(action);
+ this.requestUpdate('overflowActions');
}
}
@@ -707,7 +985,7 @@
if (type !== ActionType.CHANGE && type !== ActionType.REVISION) {
throw Error(`Invalid action type given: ${type}`);
}
- const index = this._actionPriorityOverrides.findIndex(
+ const index = this.actionPriorityOverrides.findIndex(
action => action.type === type && action.key === key
);
const action: ActionPriorityOverride = {
@@ -716,9 +994,11 @@
priority,
};
if (index !== -1) {
- this.set('_actionPriorityOverrides', index, action);
+ this.actionPriorityOverrides[index] = action;
+ this.requestUpdate('actionPriorityOverrides');
} else {
- this.push('_actionPriorityOverrides', action);
+ this.actionPriorityOverrides.push(action);
+ this.requestUpdate('actionPriorityOverrides');
}
}
@@ -731,11 +1011,13 @@
throw Error(`Invalid action type given: ${type}`);
}
- const idx = this._hiddenActions.indexOf(key);
+ const idx = this.hiddenActions.indexOf(key);
if (hidden && idx === -1) {
- this.push('_hiddenActions', key);
+ this.hiddenActions.push(key);
+ this.requestUpdate('hiddenActions');
} else if (!hidden && idx !== -1) {
- this.splice('_hiddenActions', idx, 1);
+ this.hiddenActions.splice(idx, 1);
+ this.requestUpdate('hiddenActions');
}
}
@@ -749,182 +1031,111 @@
}
}
- _indexOfActionButtonWithKey(key: string) {
- for (let i = 0; i < this._additionalActions.length; i++) {
- if (this._additionalActions[i].__key === key) {
+ private indexOfActionButtonWithKey(key: string) {
+ for (let i = 0; i < this.additionalActions.length; i++) {
+ if (this.additionalActions[i].__key === key) {
return i;
}
}
return -1;
}
- _shouldHideActions(
- actions?: PolymerDeepPropertyChange<UIActionInfo[], UIActionInfo[]>,
- loading?: boolean
- ) {
- return loading || !actions || !actions.base || !actions.base.length;
- }
-
- _keyCount(
- changeRecord?: PolymerDeepPropertyChange<
- ActionNameToActionInfoMap,
- ActionNameToActionInfoMap
- >
- ) {
- return Object.keys(changeRecord?.base || {}).length;
- }
-
- @observe('actions.*', 'revisionActions.*', '_additionalActions.*')
- _actionsChanged(
- actionsChangeRecord?: PolymerDeepPropertyChange<
- ActionNameToActionInfoMap,
- ActionNameToActionInfoMap
- >,
- revisionActionsChangeRecord?: PolymerDeepPropertyChange<
- ActionNameToActionInfoMap,
- ActionNameToActionInfoMap
- >,
- additionalActionsChangeRecord?: PolymerDeepPropertyChange<
- UIActionInfo[],
- UIActionInfo[]
- >
- ) {
- // Polymer 2: check for undefined
- if (
- actionsChangeRecord === undefined ||
- revisionActionsChangeRecord === undefined ||
- additionalActionsChangeRecord === undefined
- ) {
- return;
- }
-
- const additionalActions =
- (additionalActionsChangeRecord && additionalActionsChangeRecord.base) ||
- [];
+ private actionsChanged() {
this.hidden =
- this._keyCount(actionsChangeRecord) === 0 &&
- this._keyCount(revisionActionsChangeRecord) === 0 &&
- additionalActions.length === 0;
- this._actionLoadingMessage = '';
- this._actionLoadingMessage = '';
- this._disabledMenuActions = [];
+ Object.keys(this.actions).length === 0 &&
+ Object.keys(this.revisionActions).length === 0 &&
+ this.additionalActions.length === 0;
+ this.actionLoadingMessage = '';
+ this.disabledMenuActions = [];
- const revisionActions = revisionActionsChangeRecord.base || {};
- if (Object.keys(revisionActions).length !== 0) {
- if (!revisionActions.download) {
- this.set('revisionActions.download', DOWNLOAD_ACTION);
+ if (Object.keys(this.revisionActions).length !== 0) {
+ if (!this.revisionActions.download) {
+ this.revisionActions = {
+ ...this.revisionActions,
+ download: DOWNLOAD_ACTION,
+ };
+ fire(this, 'revision-actions-changed', {
+ value: this.revisionActions,
+ });
}
}
- const actions = actionsChangeRecord.base || {};
- if (!actions.includedIn && this.change?.status === ChangeStatus.MERGED) {
- this.set('actions.includedIn', INCLUDED_IN_ACTION);
- }
- }
-
- _deleteAndNotify(actionName: string) {
- if (this.actions && this.actions[actionName]) {
- delete this.actions[actionName];
- // We assign a fake value of 'false' to support Polymer 2
- // see https://github.com/Polymer/polymer/issues/2631
- this.notifyPath('actions.' + actionName, false);
- }
- }
-
- @observe(
- 'editMode',
- 'editPatchsetLoaded',
- 'editBasedOnCurrentPatchSet',
- 'disableEdit',
- 'loggedIn',
- 'actions.*',
- 'change.*'
- )
- _editStatusChanged(
- editMode: boolean,
- editPatchsetLoaded: boolean,
- editBasedOnCurrentPatchSet: boolean,
- disableEdit: boolean,
- loggedIn: boolean,
- actionsChangeRecord?: PolymerDeepPropertyChange<
- ActionNameToActionInfoMap,
- ActionNameToActionInfoMap
- >,
- changeChangeRecord?: PolymerDeepPropertyChange<ChangeInfo, ChangeInfo>
- ) {
- // Hide change edits if not logged in
if (
- actionsChangeRecord === undefined ||
- changeChangeRecord === undefined ||
- !loggedIn
+ !this.actions.includedIn &&
+ this.change?.status === ChangeStatus.MERGED
) {
+ this.actions = {...this.actions, includedIn: INCLUDED_IN_ACTION};
+ }
+ }
+
+ private editStatusChanged() {
+ // Hide change edits if not logged in
+ if (this.change === undefined || !this.loggedIn) {
return;
}
- if (disableEdit) {
- this._deleteAndNotify('publishEdit');
- this._deleteAndNotify('rebaseEdit');
- this._deleteAndNotify('deleteEdit');
- this._deleteAndNotify('stopEdit');
- this._deleteAndNotify('edit');
+ if (this.disableEdit) {
+ delete this.actions.rebaseEdit;
+ delete this.actions.publishEdit;
+ delete this.actions.deleteEdit;
+ delete this.actions.stopEdit;
+ delete this.actions.edit;
return;
}
- const actions = actionsChangeRecord.base;
- const change = changeChangeRecord.base;
- if (actions && editPatchsetLoaded) {
+ if (this.editPatchsetLoaded) {
// Only show actions that mutate an edit if an actual edit patch set
// is loaded.
- if (changeIsOpen(change)) {
- if (editBasedOnCurrentPatchSet) {
- if (!actions.publishEdit) {
- this.set('actions.publishEdit', PUBLISH_EDIT);
+ if (changeIsOpen(this.change)) {
+ if (this.editBasedOnCurrentPatchSet) {
+ if (!this.actions.publishEdit) {
+ this.actions = {...this.actions, publishEdit: PUBLISH_EDIT};
}
- this._deleteAndNotify('rebaseEdit');
+ delete this.actions.rebaseEdit;
} else {
- if (!actions.rebaseEdit) {
- this.set('actions.rebaseEdit', REBASE_EDIT);
+ if (!this.actions.rebaseEdit) {
+ this.actions = {...this.actions, rebaseEdit: REBASE_EDIT};
}
- this._deleteAndNotify('publishEdit');
+ delete this.actions.publishEdit;
}
}
- if (!actions.deleteEdit) {
- this.set('actions.deleteEdit', DELETE_EDIT);
+ if (!this.actions.deleteEdit) {
+ this.actions = {...this.actions, deleteEdit: DELETE_EDIT};
}
} else {
- this._deleteAndNotify('publishEdit');
- this._deleteAndNotify('rebaseEdit');
- this._deleteAndNotify('deleteEdit');
+ delete this.actions.rebaseEdit;
+ delete this.actions.publishEdit;
+ delete this.actions.deleteEdit;
}
- if (actions && changeIsOpen(change)) {
+ if (changeIsOpen(this.change)) {
// Only show edit button if there is no edit patchset loaded and the
// file list is not in edit mode.
- if (editPatchsetLoaded || editMode) {
- this._deleteAndNotify('edit');
+ if (this.editPatchsetLoaded || this.editMode) {
+ delete this.actions.edit;
} else {
- if (!actions.edit) {
- this.set('actions.edit', EDIT);
+ if (!this.actions.edit) {
+ this.actions = {...this.actions, edit: EDIT};
}
}
// Only show STOP_EDIT if edit mode is enabled, but no edit patch set
// is loaded.
- if (editMode && !editPatchsetLoaded) {
- if (!actions.stopEdit) {
- this.set('actions.stopEdit', STOP_EDIT);
+ if (this.editMode && !this.editPatchsetLoaded) {
+ if (!this.actions.stopEdit) {
+ this.actions = {...this.actions, stopEdit: STOP_EDIT};
fireAlert(this, 'Change is in edit mode');
}
} else {
- this._deleteAndNotify('stopEdit');
+ delete this.actions.stopEdit;
}
} else {
// Remove edit button.
- this._deleteAndNotify('edit');
+ delete this.actions.edit;
}
}
- _getValuesFor<T>(obj: {[key: string]: T}): T[] {
+ private getValuesFor<T>(obj: {[key: string]: T}): T[] {
return Object.keys(obj).map(key => obj[key]);
}
- _getLabelStatus(label: LabelInfo): LabelStatus {
+ private getLabelStatus(label: LabelInfo): LabelStatus {
if (isQuickLabelInfo(label)) {
if (label.approved) {
return LabelStatus.OK;
@@ -943,7 +1154,7 @@
* Get highest score for last missing permitted label for current change.
* Returns null if no labels permitted or more than one label missing.
*/
- _getTopMissingApproval() {
+ private getTopMissingApproval() {
if (!this.change || !this.change.labels || !this.change.permitted_labels) {
return null;
}
@@ -958,7 +1169,7 @@
if (this.change.permitted_labels[label].length === 0) {
continue;
}
- const status = this._getLabelStatus(labelInfo);
+ const status = this.getLabelStatus(labelInfo);
if (status === LabelStatus.NEED) {
if (result) {
// More than one label is missing, so check if Code Review can be
@@ -1014,20 +1225,20 @@
}
hideQuickApproveAction() {
- if (!this._topLevelSecondaryActions) {
- throw new Error('_topLevelSecondaryActions must be set');
+ if (!this.topLevelSecondaryActions) {
+ throw new Error('topLevelSecondaryActions must be set');
}
- this._topLevelSecondaryActions = this._topLevelSecondaryActions.filter(
+ this.topLevelSecondaryActions = this.topLevelSecondaryActions.filter(
sa => !isQuickApproveAction(sa)
);
this._hideQuickApproveAction = true;
}
- _getQuickApproveAction(): QuickApproveUIActionInfo | null {
+ private getQuickApproveAction(): QuickApproveUIActionInfo | null {
if (this._hideQuickApproveAction) {
return null;
}
- const approval = this._getTopMissingApproval();
+ const approval = this.getTopMissingApproval();
if (!approval) {
return null;
}
@@ -1049,32 +1260,23 @@
return action;
}
- _getActionValues(
- actionsChangeRecord: PolymerDeepPropertyChange<
- ActionNameToActionInfoMap,
- ActionNameToActionInfoMap
- >,
- primariesChangeRecord: PolymerDeepPropertyChange<
- PrimaryActionKey[],
- PrimaryActionKey[]
- >,
- additionalActionsChangeRecord: PolymerDeepPropertyChange<
- UIActionInfo[],
- UIActionInfo[]
- >,
+ private getActionValues(
+ actionsChange: ActionNameToActionInfoMap,
+ primariesChange: PrimaryActionKey[],
+ additionalActionsChange: UIActionInfo[],
type: ActionType
): UIActionInfo[] {
- if (!actionsChangeRecord || !primariesChangeRecord) {
+ if (!actionsChange || !primariesChange) {
return [];
}
- const actions = actionsChangeRecord.base || {};
- const primaryActionKeys = primariesChangeRecord.base || [];
+ const actions = actionsChange;
+ const primaryActionKeys = primariesChange;
const result: UIActionInfo[] = [];
const values: Array<ChangeActions | RevisionActions> =
type === ActionType.CHANGE
- ? this._getValuesFor(ChangeActions)
- : this._getValuesFor(RevisionActions);
+ ? this.getValuesFor(ChangeActions)
+ : this.getValuesFor(RevisionActions);
const pluginActions: UIActionInfo[] = [];
Object.keys(actions).forEach(a => {
@@ -1084,26 +1286,25 @@
action.__primary = primaryActionKeys.includes(a as PrimaryActionKey);
// Plugin actions always contain ~ in the key.
if (a.indexOf('~') !== -1) {
- this._populateActionUrl(action);
+ this.populateActionUrl(action);
pluginActions.push(action);
// Add server-side provided plugin actions to overflow menu.
- this._overflowActions.push({
+ this.overflowActions.push({
type,
key: a,
});
+ this.requestUpdate('overflowActions');
return;
} else if (!values.includes(a as PrimaryActionKey)) {
return;
}
- action.label = this._getActionLabel(action);
+ action.label = this.getActionLabel(action);
// Triggers a re-render by ensuring object inequality.
result.push({...action});
});
- let additionalActions =
- (additionalActionsChangeRecord && additionalActionsChangeRecord.base) ||
- [];
+ let additionalActions = additionalActionsChange;
additionalActions = additionalActions
.filter(a => a.__type === type)
.map(a => {
@@ -1114,7 +1315,7 @@
return result.concat(additionalActions).concat(pluginActions);
}
- _populateActionUrl(action: UIActionInfo) {
+ private populateActionUrl(action: UIActionInfo) {
const patchNum =
action.__type === ActionType.REVISION ? this.latestPatchNum : undefined;
if (!this.changeNum) {
@@ -1129,7 +1330,7 @@
* Given a change action, return a display label that uses the appropriate
* casing or includes explanatory details.
*/
- _getActionLabel(action: UIActionInfo) {
+ private getActionLabel(action: UIActionInfo) {
if (action.label === 'Delete') {
// This label is common within change and revision actions. Make it more
// explicit to the user.
@@ -1138,34 +1339,38 @@
return 'Mark as work in progress';
}
// Otherwise, just map the name to sentence case.
- return this._toSentenceCase(action.label);
+ return this.toSentenceCase(action.label);
}
/**
* Capitalize the first letter and lowecase all others.
+ *
+ * private but used in test
*/
- _toSentenceCase(s: string) {
+ toSentenceCase(s: string) {
if (!s.length) {
return '';
}
return s[0].toUpperCase() + s.slice(1).toLowerCase();
}
- _computeLoadingLabel(action: string) {
+ private computeLoadingLabel(action: string) {
return ActionLoadingLabels[action] || 'Working...';
}
- _canSubmitChange() {
+ // private but used in test
+ canSubmitChange() {
if (!this.change) {
return false;
}
return this.jsAPI.canSubmitChange(
this.change,
- this._getRevision(this.change, this.latestPatchNum)
+ this.getRevision(this.change, this.latestPatchNum)
);
}
- _getRevision(change: ChangeViewChangeInfo, patchNum?: PatchSetNum) {
+ // private but used in test
+ getRevision(change: ChangeViewChangeInfo, patchNum?: PatchSetNum) {
for (const rev of Object.values(change.revisions)) {
if (rev._number === patchNum) {
return rev;
@@ -1187,21 +1392,23 @@
this.reporting.error(new Error('changes is undefined'));
return;
}
- this.$.confirmRevertDialog.populate(change, this.commitMessage, changes);
- this._showActionDialog(this.$.confirmRevertDialog);
+ assertIsDefined(this.confirmRevertDialog, 'confirmRevertDialog');
+ this.confirmRevertDialog.populate(change, this.commitMessage, changes);
+ this.showActionDialog(this.confirmRevertDialog);
});
}
showSubmitDialog() {
- if (!this._canSubmitChange()) {
+ if (!this.canSubmitChange()) {
return;
}
- this._showActionDialog(this.$.confirmSubmitDialog);
+ assertIsDefined(this.confirmSubmitDialog, 'confirmSubmitDialog');
+ this.showActionDialog(this.confirmSubmitDialog);
}
- _handleActionTap(e: MouseEvent) {
+ private handleActionTap(e: MouseEvent, key: string, type: string) {
e.preventDefault();
- let el = (dom(e) as EventApi).localTarget as Element;
+ let el = e.target as Element;
while (el.tagName.toLowerCase() !== 'gr-button') {
if (!el.parentElement) {
return;
@@ -1209,10 +1416,6 @@
el = el.parentElement;
}
- const key = el.getAttribute('data-action-key');
- if (!key) {
- throw new Error("Button doesn't have data-action-key attribute");
- }
if (
key.startsWith(ADDITIONAL_ACTION_KEY_PREFIX) ||
key.indexOf('~') !== -1
@@ -1226,11 +1429,10 @@
);
return;
}
- const type = el.getAttribute('data-action-type') as ActionType;
- this._handleAction(type, key);
+ this.handleAction(type as ActionType, key);
}
- _handleOverflowItemTap(e: CustomEvent<MenuAction>) {
+ private handleOverflowItemTap(e: CustomEvent<MenuAction>) {
e.preventDefault();
const el = (dom(e) as EventApi).localTarget as Element;
const key = e.detail.action.__key;
@@ -1247,147 +1449,160 @@
);
return;
}
- this._handleAction(e.detail.action.__type, e.detail.action.__key);
+ this.handleAction(e.detail.action.__type, e.detail.action.__key);
}
- _handleAction(type: ActionType, key: string) {
+ // private but used in test
+ handleAction(type: ActionType, key: string) {
this.reporting.reportInteraction(`${type}-${key}`);
switch (type) {
case ActionType.REVISION:
- this._handleRevisionAction(key);
+ this.handleRevisionAction(key);
break;
case ActionType.CHANGE:
- this._handleChangeAction(key);
+ this.handleChangeAction(key);
break;
default:
- this._fireAction(
- this._prependSlash(key),
+ this.fireAction(
+ this.prependSlash(key),
assertUIActionInfo(this.actions[key]),
false
);
}
}
- _handleChangeAction(key: string) {
+ // private but used in test
+ handleChangeAction(key: string) {
switch (key) {
case ChangeActions.REVERT:
this.showRevertDialog();
break;
case ChangeActions.ABANDON:
- this._showActionDialog(this.$.confirmAbandonDialog);
+ assertIsDefined(this.confirmAbandonDialog, 'confirmAbandonDialog');
+ this.showActionDialog(this.confirmAbandonDialog);
break;
case QUICK_APPROVE_ACTION.key: {
- const action = this._allActionValues.find(isQuickApproveAction);
+ const action = this.allActionValues.find(isQuickApproveAction);
if (!action) {
return;
}
- this._fireAction(this._prependSlash(key), action, true, action.payload);
+ this.fireAction(this.prependSlash(key), action, true, action.payload);
break;
}
case ChangeActions.EDIT:
- this._handleEditTap();
+ this.handleEditTap();
break;
case ChangeActions.STOP_EDIT:
- this._handleStopEditTap();
+ this.handleStopEditTap();
break;
case ChangeActions.DELETE:
- this._handleDeleteTap();
+ this.handleDeleteTap();
break;
case ChangeActions.DELETE_EDIT:
- this._handleDeleteEditTap();
+ this.handleDeleteEditTap();
break;
case ChangeActions.FOLLOW_UP:
- this._handleFollowUpTap();
+ this.handleFollowUpTap();
break;
case ChangeActions.WIP:
- this._handleWipTap();
+ this.handleWipTap();
break;
case ChangeActions.MOVE:
- this._handleMoveTap();
+ this.handleMoveTap();
break;
case ChangeActions.PUBLISH_EDIT:
- this._handlePublishEditTap();
+ this.handlePublishEditTap();
break;
case ChangeActions.REBASE_EDIT:
- this._handleRebaseEditTap();
+ this.handleRebaseEditTap();
break;
case ChangeActions.INCLUDED_IN:
- this._handleIncludedInTap();
+ this.handleIncludedInTap();
break;
default:
- this._fireAction(
- this._prependSlash(key),
+ this.fireAction(
+ this.prependSlash(key),
assertUIActionInfo(this.actions[key]),
false
);
}
}
- _handleRevisionAction(key: string) {
+ private handleRevisionAction(key: string) {
switch (key) {
case RevisionActions.REBASE:
- this._showActionDialog(this.$.confirmRebase);
- this.$.confirmRebase.fetchRecentChanges();
+ assertIsDefined(this.confirmRebase, 'confirmRebase');
+ this.showActionDialog(this.confirmRebase);
+ this.confirmRebase.fetchRecentChanges();
break;
case RevisionActions.CHERRYPICK:
- this._handleCherrypickTap();
+ this.handleCherrypickTap();
break;
case RevisionActions.DOWNLOAD:
- this._handleDownloadTap();
+ this.handleDownloadTap();
break;
case RevisionActions.SUBMIT:
- if (!this._canSubmitChange()) {
+ if (!this.canSubmitChange()) {
return;
}
- this._showActionDialog(this.$.confirmSubmitDialog);
+ assertIsDefined(this.confirmSubmitDialog, 'confirmSubmitDialog');
+ this.showActionDialog(this.confirmSubmitDialog);
break;
default:
- this._fireAction(
- this._prependSlash(key),
+ this.fireAction(
+ this.prependSlash(key),
assertUIActionInfo(this.revisionActions[key]),
true
);
}
}
- _prependSlash(key: string) {
+ private prependSlash(key: string) {
return key === '/' ? key : `/${key}`;
}
/**
* _hasKnownChainState set to true true if hasParent is defined (can be
* either true or false). set to false otherwise.
+ *
+ * private but used in test
*/
- _computeChainState() {
+ computeChainState() {
this._hasKnownChainState = true;
}
- _calculateDisabled(action: UIActionInfo, hasKnownChainState: boolean) {
+ // private but used in test
+ calculateDisabled(action: UIActionInfo) {
if (action.__key === 'rebase') {
// Rebase button is only disabled when change has no parent(s).
- return hasKnownChainState === false;
+ return this._hasKnownChainState === false;
}
return !action.enabled;
}
- _handleConfirmDialogCancel() {
- this._hideAllDialogs();
+ private handleConfirmDialogCancel() {
+ this.hideAllDialogs();
}
- _hideAllDialogs() {
- const dialogEls = this.root!.querySelectorAll('.confirmDialog');
+ private hideAllDialogs() {
+ assertIsDefined(this.confirmSubmitDialog, 'confirmSubmitDialog');
+ const dialogEls = queryAll(this, '.confirmDialog');
for (const dialogEl of dialogEls) {
(dialogEl as HTMLElement).hidden = true;
}
- this.$.overlay.close();
+ assertIsDefined(this.overlay, 'overlay');
+ this.overlay.close();
}
- _handleRebaseConfirm(e: CustomEvent<ConfirmRebaseEventDetail>) {
- const el = this.$.confirmRebase;
+ // private but used in test
+ handleRebaseConfirm(e: CustomEvent<ConfirmRebaseEventDetail>) {
+ assertIsDefined(this.confirmRebase, 'confirmRebase');
+ assertIsDefined(this.overlay, 'overlay');
+ const el = this.confirmRebase;
const payload = {base: e.detail.base};
- this.$.overlay.close();
+ this.overlay.close();
el.hidden = true;
- this._fireAction(
+ this.fireAction(
'/rebase',
assertUIActionInfo(this.revisionActions.rebase),
true,
@@ -1395,16 +1610,20 @@
);
}
- _handleCherrypickConfirm() {
- this._handleCherryPickRestApi(false);
+ // private but used in test
+ handleCherrypickConfirm() {
+ this.handleCherryPickRestApi(false);
}
- _handleCherrypickConflictConfirm() {
- this._handleCherryPickRestApi(true);
+ // private but used in test
+ handleCherrypickConflictConfirm() {
+ this.handleCherryPickRestApi(true);
}
- _handleCherryPickRestApi(conflicts: boolean) {
- const el = this.$.confirmCherrypick;
+ private handleCherryPickRestApi(conflicts: boolean) {
+ assertIsDefined(this.confirmCherrypick, 'confirmCherrypick');
+ assertIsDefined(this.overlay, 'overlay');
+ const el = this.confirmCherrypick;
if (!el.branch) {
fireAlert(this, ERR_BRANCH_EMPTY);
return;
@@ -1413,9 +1632,9 @@
fireAlert(this, ERR_COMMIT_EMPTY);
return;
}
- this.$.overlay.close();
+ this.overlay.close();
el.hidden = true;
- this._fireAction(
+ this.fireAction(
'/cherrypick',
assertUIActionInfo(this.revisionActions.cherrypick),
true,
@@ -1428,29 +1647,34 @@
);
}
- _handleMoveConfirm() {
- const el = this.$.confirmMove;
+ // private but used in test
+ handleMoveConfirm() {
+ assertIsDefined(this.confirmMove, 'confirmMove');
+ assertIsDefined(this.overlay, 'overlay');
+ const el = this.confirmMove;
if (!el.branch) {
fireAlert(this, ERR_BRANCH_EMPTY);
return;
}
- this.$.overlay.close();
+ this.overlay.close();
el.hidden = true;
- this._fireAction('/move', assertUIActionInfo(this.actions.move), false, {
+ this.fireAction('/move', assertUIActionInfo(this.actions.move), false, {
destination_branch: el.branch,
message: el.message,
});
}
- _handleRevertDialogConfirm(e: CustomEvent<ConfirmRevertEventDetail>) {
+ private handleRevertDialogConfirm(e: CustomEvent<ConfirmRevertEventDetail>) {
+ assertIsDefined(this.confirmRevertDialog, 'confirmRevertDialog');
+ assertIsDefined(this.overlay, 'overlay');
const revertType = e.detail.revertType;
const message = e.detail.message;
- const el = this.$.confirmRevertDialog;
- this.$.overlay.close();
+ const el = this.confirmRevertDialog;
+ this.overlay.close();
el.hidden = true;
switch (revertType) {
case RevertType.REVERT_SINGLE_CHANGE:
- this._fireAction(
+ this.fireAction(
'/revert',
assertUIActionInfo(this.actions.revert),
false,
@@ -1460,7 +1684,7 @@
case RevertType.REVERT_SUBMISSION:
// TODO(dhruvsri): replace with this.actions.revert_submission once
// BE starts sending it again
- this._fireAction(
+ this.fireAction(
'/revert_submission',
{__key: 'revert_submission', method: HttpMethod.POST} as UIActionInfo,
false,
@@ -1472,11 +1696,14 @@
}
}
- _handleAbandonDialogConfirm() {
- const el = this.$.confirmAbandonDialog;
- this.$.overlay.close();
+ // private but used in test
+ handleAbandonDialogConfirm() {
+ assertIsDefined(this.confirmAbandonDialog, 'confirmAbandonDialog');
+ assertIsDefined(this.overlay, 'overlay');
+ const el = this.confirmAbandonDialog;
+ this.overlay.close();
el.hidden = true;
- this._fireAction(
+ this.fireAction(
'/abandon',
assertUIActionInfo(this.actions.abandon),
false,
@@ -1486,58 +1713,62 @@
);
}
- _handleCreateFollowUpChange() {
- this.$.createFollowUpChange.handleCreateChange();
- this._handleCloseCreateFollowUpChange();
+ private handleCreateFollowUpChange() {
+ assertIsDefined(this.createFollowUpChange, 'createFollowUpChange');
+ this.createFollowUpChange.handleCreateChange();
+ this.handleCloseCreateFollowUpChange();
}
- _handleCloseCreateFollowUpChange() {
- this.$.overlay.close();
+ private handleCloseCreateFollowUpChange() {
+ assertIsDefined(this.overlay, 'overlay');
+ this.overlay.close();
}
- _handleDeleteConfirm() {
- this._hideAllDialogs();
- this._fireAction(
+ private handleDeleteConfirm() {
+ this.hideAllDialogs();
+ this.fireAction(
'/',
assertUIActionInfo(this.actions[ChangeActions.DELETE]),
false
);
}
- _handleDeleteEditConfirm() {
- this._hideAllDialogs();
+ private handleDeleteEditConfirm() {
+ this.hideAllDialogs();
// We need to make sure that all cached version of a change
// edit are deleted.
this.storage.eraseEditableContentItemsForChangeEdit(this.changeNum);
- this._fireAction(
+ this.fireAction(
'/edit',
assertUIActionInfo(this.actions.deleteEdit),
false
);
}
- _handleSubmitConfirm() {
- if (!this._canSubmitChange()) {
+ // private but used in test
+ handleSubmitConfirm() {
+ if (!this.canSubmitChange()) {
return;
}
- this._hideAllDialogs();
- this._fireAction(
+ this.hideAllDialogs();
+ this.fireAction(
'/submit',
assertUIActionInfo(this.revisionActions.submit),
true
);
}
- _getActionOverflowIndex(type: string, key: string) {
- return this._overflowActions.findIndex(
+ private getActionOverflowIndex(type: string, key: string) {
+ return this.overflowActions.findIndex(
action => action.type === type && action.key === key
);
}
- _setLoadingOnButtonWithKey(type: string, key: string) {
- this._actionLoadingMessage = this._computeLoadingLabel(key);
+ // private but used in test
+ setLoadingOnButtonWithKey(type: string, key: string) {
+ this.actionLoadingMessage = this.computeLoadingLabel(key);
let buttonKey = key;
// TODO(dhruvsri): clean this up later
// If key is revert-submission, then button key should be 'revert'
@@ -1547,14 +1778,12 @@
}
// If the action appears in the overflow menu.
- if (this._getActionOverflowIndex(type, buttonKey) !== -1) {
- this.push(
- '_disabledMenuActions',
- buttonKey === '/' ? 'delete' : buttonKey
- );
+ if (this.getActionOverflowIndex(type, buttonKey) !== -1) {
+ this.disabledMenuActions.push(buttonKey === '/' ? 'delete' : buttonKey);
+ this.requestUpdate('disabledMenuActions');
return () => {
- this._actionLoadingMessage = '';
- this._disabledMenuActions = [];
+ this.actionLoadingMessage = '';
+ this.disabledMenuActions = [];
};
}
@@ -1568,38 +1797,41 @@
buttonEl.setAttribute('loading', 'true');
buttonEl.disabled = true;
return () => {
- this._actionLoadingMessage = '';
+ this.actionLoadingMessage = '';
buttonEl.removeAttribute('loading');
buttonEl.disabled = false;
};
}
- _fireAction(
+ // private but used in test
+ fireAction(
endpoint: string,
action: UIActionInfo,
revAction: boolean,
payload?: RequestPayload
) {
- const cleanupFn = this._setLoadingOnButtonWithKey(
+ const cleanupFn = this.setLoadingOnButtonWithKey(
action.__type,
action.__key
);
- this._send(
+ this.send(
action.method,
payload,
endpoint,
revAction,
cleanupFn,
action
- ).then(res => this._handleResponse(action, res));
+ ).then(res => this.handleResponse(action, res));
}
- _showActionDialog(dialog: ChangeActionDialog) {
- this._hideAllDialogs();
+ // private but used in test
+ showActionDialog(dialog: ChangeActionDialog) {
+ this.hideAllDialogs();
if (dialog.init) dialog.init();
dialog.hidden = false;
- this.$.overlay.open().then(() => {
+ assertIsDefined(this.overlay, 'overlay');
+ this.overlay.open().then(() => {
if (dialog.resetFocus) {
dialog.resetFocus();
}
@@ -1608,7 +1840,8 @@
// TODO(rmistry): Redo this after
// https://bugs.chromium.org/p/gerrit/issues/detail?id=4671 is resolved.
- _setReviewOnRevert(newChangeId: NumericChangeId) {
+ // private but used in test
+ setReviewOnRevert(newChangeId: NumericChangeId) {
const review = this.jsAPI.getReviewPostRevert(this.change);
if (!review) {
return Promise.resolve(undefined);
@@ -1616,7 +1849,8 @@
return this.restApiService.saveChangeReview(newChangeId, CURRENT, review);
}
- _handleResponse(action: UIActionInfo, response?: Response) {
+ // private but used in test
+ handleResponse(action: UIActionInfo, response?: Response) {
if (!response) {
return;
}
@@ -1624,8 +1858,8 @@
switch (action.__key) {
case ChangeActions.REVERT: {
const revertChangeInfo: ChangeInfo = obj as unknown as ChangeInfo;
- this._waitForChangeReachable(revertChangeInfo._number)
- .then(() => this._setReviewOnRevert(revertChangeInfo._number))
+ this.waitForChangeReachable(revertChangeInfo._number)
+ .then(() => this.setReviewOnRevert(revertChangeInfo._number))
.then(() => {
GerritNav.navigateToChange(revertChangeInfo);
});
@@ -1633,11 +1867,9 @@
}
case RevisionActions.CHERRYPICK: {
const cherrypickChangeInfo: ChangeInfo = obj as unknown as ChangeInfo;
- this._waitForChangeReachable(cherrypickChangeInfo._number).then(
- () => {
- GerritNav.navigateToChange(cherrypickChangeInfo);
- }
- );
+ this.waitForChangeReachable(cherrypickChangeInfo._number).then(() => {
+ GerritNav.navigateToChange(cherrypickChangeInfo);
+ });
break;
}
case ChangeActions.DELETE:
@@ -1661,7 +1893,7 @@
)
return;
/* If there is only 1 change then gerrit will automatically
- redirect to that change */
+ redirect to that change */
GerritNav.navigateToSearchQuery(
`topic: ${revertSubmistionInfo.revert_changes[0].topic}`
);
@@ -1674,7 +1906,8 @@
});
}
- _handleResponseError(
+ // private but used in test
+ handleResponseError(
action: UIActionInfo,
response: Response | undefined | null,
body?: RequestPayload
@@ -1696,7 +1929,11 @@
body &&
!(body as CherryPickInput).allow_conflicts
) {
- this._showActionDialog(this.$.confirmCherrypickConflict);
+ assertIsDefined(
+ this.confirmCherrypickConflict,
+ 'confirmCherrypickConflict'
+ );
+ this.showActionDialog(this.confirmCherrypickConflict);
return;
}
}
@@ -1714,7 +1951,8 @@
});
}
- _send(
+ // private but used in test
+ send(
method: HttpMethod | undefined,
payload: RequestPayload | undefined,
actionEndpoint: string,
@@ -1724,7 +1962,7 @@
): Promise<Response | undefined> {
const handleError: ErrorCallback = response => {
cleanupFn.call(this);
- this._handleResponseError(action, response, payload);
+ this.handleResponseError(action, response, payload);
};
const change = this.change;
const changeNum = this.changeNum;
@@ -1774,11 +2012,13 @@
});
}
- _handleCherrypickTap() {
+ // private but used in test
+ handleCherrypickTap() {
if (!this.change) {
throw new Error('The change property must be set');
}
- this.$.confirmCherrypick.branch = '' as BranchName;
+ assertIsDefined(this.confirmCherrypick, 'confirmCherrypick');
+ this.confirmCherrypick.branch = '' as BranchName;
const query = `topic: "${this.change.topic}"`;
const options = listChangesOptionsToHex(
ListChangesOption.MESSAGES,
@@ -1791,52 +2031,61 @@
this.reporting.error(new Error('getChanges returns undefined'));
return;
}
- this.$.confirmCherrypick.updateChanges(changes);
- this._showActionDialog(this.$.confirmCherrypick);
+ this.confirmCherrypick!.updateChanges(changes);
+ this.showActionDialog(this.confirmCherrypick!);
});
}
- _handleMoveTap() {
- this.$.confirmMove.branch = '' as BranchName;
- this.$.confirmMove.message = '';
- this._showActionDialog(this.$.confirmMove);
+ // private but used in test
+ handleMoveTap() {
+ assertIsDefined(this.confirmMove, 'confirmMove');
+ this.confirmMove.branch = '' as BranchName;
+ this.confirmMove.message = '';
+ this.showActionDialog(this.confirmMove);
}
- _handleDownloadTap() {
+ // private but used in test
+ handleDownloadTap() {
fireEvent(this, 'download-tap');
}
- _handleIncludedInTap() {
+ // private but used in test
+ handleIncludedInTap() {
fireEvent(this, 'included-tap');
}
- _handleDeleteTap() {
- this._showActionDialog(this.$.confirmDeleteDialog);
+ // private but used in test
+ handleDeleteTap() {
+ assertIsDefined(this.confirmDeleteDialog, 'confirmDeleteDialog');
+ this.showActionDialog(this.confirmDeleteDialog);
}
- _handleDeleteEditTap() {
- this._showActionDialog(this.$.confirmDeleteEditDialog);
+ // private but used in test
+ handleDeleteEditTap() {
+ assertIsDefined(this.confirmDeleteEditDialog, 'confirmDeleteEditDialog');
+ this.showActionDialog(this.confirmDeleteEditDialog);
}
- _handleFollowUpTap() {
- this._showActionDialog(this.$.createFollowUpDialog);
+ private handleFollowUpTap() {
+ assertIsDefined(this.createFollowUpDialog, 'createFollowUpDialog');
+ this.showActionDialog(this.createFollowUpDialog);
}
- _handleWipTap() {
+ private handleWipTap() {
if (!this.actions.wip) {
return;
}
- this._fireAction('/wip', assertUIActionInfo(this.actions.wip), false);
+ this.fireAction('/wip', assertUIActionInfo(this.actions.wip), false);
}
- _handlePublishEditTap() {
+ private handlePublishEditTap() {
if (!this.actions.publishEdit) return;
// We need to make sure that all cached version of a change
// edit are deleted.
this.storage.eraseEditableContentItemsForChangeEdit(this.changeNum);
- this._fireAction(
+ this.fireAction(
'/edit:publish',
assertUIActionInfo(this.actions.publishEdit),
false,
@@ -1844,93 +2093,71 @@
);
}
- _handleRebaseEditTap() {
+ private handleRebaseEditTap() {
if (!this.actions.rebaseEdit) {
return;
}
- this._fireAction(
+ this.fireAction(
'/edit:rebase',
assertUIActionInfo(this.actions.rebaseEdit),
false
);
}
- _handleHideBackgroundContent() {
- this.$.mainContent.classList.add('overlayOpen');
+ // private but used in test
+ handleHideBackgroundContent() {
+ assertIsDefined(this.mainContent, 'mainContent');
+ this.mainContent.classList.add('overlayOpen');
}
- _handleShowBackgroundContent() {
- this.$.mainContent.classList.remove('overlayOpen');
+ // private but used in test
+ handleShowBackgroundContent() {
+ assertIsDefined(this.mainContent, 'mainContent');
+ this.mainContent.classList.remove('overlayOpen');
}
/**
* Merge sources of change actions into a single ordered array of action
* values.
*/
- _computeAllActions(
- changeActionsRecord: PolymerDeepPropertyChange<
- ActionNameToActionInfoMap,
- ActionNameToActionInfoMap
- >,
- revisionActionsRecord: PolymerDeepPropertyChange<
- ActionNameToActionInfoMap,
- ActionNameToActionInfoMap
- >,
- primariesRecord: PolymerDeepPropertyChange<
- PrimaryActionKey[],
- PrimaryActionKey[]
- >,
- additionalActionsRecord: PolymerDeepPropertyChange<
- UIActionInfo[],
- UIActionInfo[]
- >,
- change?: ChangeInfo
- ): UIActionInfo[] {
+ private computeAllActions(): UIActionInfo[] {
// Polymer 2: check for undefined
- if (
- [
- changeActionsRecord,
- revisionActionsRecord,
- primariesRecord,
- additionalActionsRecord,
- change,
- ].includes(undefined)
- ) {
+ if (this.change === undefined) {
return [];
}
- const revisionActionValues = this._getActionValues(
- revisionActionsRecord,
- primariesRecord,
- additionalActionsRecord,
+ const revisionActionValues = this.getActionValues(
+ this.revisionActions,
+ this.primaryActionKeys,
+ this.additionalActions,
ActionType.REVISION
);
- const changeActionValues = this._getActionValues(
- changeActionsRecord,
- primariesRecord,
- additionalActionsRecord,
+ const changeActionValues = this.getActionValues(
+ this.actions,
+ this.primaryActionKeys,
+ this.additionalActions,
ActionType.CHANGE
);
- const quickApprove = this._getQuickApproveAction();
+ const quickApprove = this.getQuickApproveAction();
if (quickApprove) {
changeActionValues.unshift(quickApprove);
}
return revisionActionValues
.concat(changeActionValues)
- .sort((a, b) => this._actionComparator(a, b))
+ .sort((a, b) => this.actionComparator(a, b))
.map(action => {
if (ACTIONS_WITH_ICONS.has(action.__key)) {
action.icon = action.__key;
}
return action;
})
- .filter(action => !this._shouldSkipAction(action));
+ .filter(action => !this.shouldSkipAction(action));
}
- _getActionPriority(action: UIActionInfo) {
+ private getActionPriority(action: UIActionInfo) {
if (action.__type && action.__key) {
- const overrideAction = this._actionPriorityOverrides.find(
+ const overrideAction = this.actionPriorityOverrides.find(
i => i.type === action.__type && i.key === action.__key
);
@@ -1952,10 +2179,12 @@
/**
* Sort comparator to define the order of change actions.
+ *
+ * private but used in test
*/
- _actionComparator(actionA: UIActionInfo, actionB: UIActionInfo) {
+ actionComparator(actionA: UIActionInfo, actionB: UIActionInfo) {
const priorityDelta =
- this._getActionPriority(actionA) - this._getActionPriority(actionB);
+ this.getActionPriority(actionA) - this.getActionPriority(actionB);
// Sort by the button label if same priority.
if (priorityDelta === 0) {
return actionA.label > actionB.label ? 1 : -1;
@@ -1964,41 +2193,15 @@
}
}
- _shouldSkipAction(action: UIActionInfo) {
+ private shouldSkipAction(action: UIActionInfo) {
return SKIP_ACTION_KEYS.includes(action.__key);
}
- _computeTopLevelActions(
- actionRecord: PolymerDeepPropertyChange<UIActionInfo[], UIActionInfo[]>,
- hiddenActionsRecord: PolymerDeepPropertyChange<string[], string[]>,
- editMode: boolean
- ): UIActionInfo[] {
- const hiddenActions = hiddenActionsRecord.base || [];
- return actionRecord.base.filter(a => {
- if (hiddenActions.includes(a.__key)) return false;
- if (editMode) return EDIT_ACTIONS.has(a.__key);
- return this._getActionOverflowIndex(a.__type, a.__key) === -1;
- });
- }
-
- _filterPrimaryActions(_topLevelActions: UIActionInfo[]) {
- this._topLevelPrimaryActions = _topLevelActions.filter(
- action => action.__primary
- );
- this._topLevelSecondaryActions = _topLevelActions.filter(
- action => !action.__primary
- );
- }
-
- _computeMenuActions(
- actionRecord: PolymerDeepPropertyChange<UIActionInfo[], UIActionInfo[]>,
- hiddenActionsRecord: PolymerDeepPropertyChange<string[], string[]>
- ): MenuAction[] {
- const hiddenActions = hiddenActionsRecord.base || [];
- return actionRecord.base
+ private computeMenuActions(): MenuAction[] {
+ return this.allActionValues
.filter(a => {
- const overflow = this._getActionOverflowIndex(a.__type, a.__key) !== -1;
- return overflow && !hiddenActions.includes(a.__key);
+ const overflow = this.getActionOverflowIndex(a.__type, a.__key) !== -1;
+ return overflow && !this.hiddenActions.includes(a.__key);
})
.map(action => {
let key = action.__key;
@@ -2014,15 +2217,6 @@
});
}
- _computeRebaseOnCurrent(
- revisionRebaseAction: PropertyType<GrChangeActions, '_revisionRebaseAction'>
- ) {
- if (revisionRebaseAction) {
- return !!revisionRebaseAction.enabled;
- }
- return null;
- }
-
/**
* Occasionally, a change created by a change action is not yet known to the
* API for a brief time. Wait for the given change number to be recognized.
@@ -2030,8 +2224,9 @@
* Returns a promise that resolves with true if a request is recognized, or
* false if the change was never recognized after all attempts.
*
+ * private but used in test
*/
- _waitForChangeReachable(changeNum: NumericChangeId) {
+ waitForChangeReachable(changeNum: NumericChangeId) {
let attemptsRemaining = AWAIT_CHANGE_ATTEMPTS;
return new Promise(resolve => {
const check = () => {
@@ -2057,24 +2252,19 @@
});
}
- _handleEditTap() {
+ private handleEditTap() {
this.dispatchEvent(new CustomEvent('edit-tap', {bubbles: false}));
}
- _handleStopEditTap() {
+ private handleStopEditTap() {
this.dispatchEvent(new CustomEvent('stop-edit-tap', {bubbles: false}));
}
-
- _computeHasTooltip(title?: string) {
- return !!title;
- }
-
- _computeHasIcon(action: UIActionInfo) {
- return action.icon ? '' : 'hidden';
- }
}
declare global {
+ interface HTMLElementEventMap {
+ 'revision-actions-changed': CustomEvent<{value: ActionNameToActionInfoMap}>;
+ }
interface HTMLElementTagNameMap {
'gr-change-actions': GrChangeActions;
}
diff --git a/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions_html.ts b/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions_html.ts
deleted file mode 100644
index 17ca7cf..0000000
--- a/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions_html.ts
+++ /dev/null
@@ -1,264 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="shared-styles">
- :host {
- display: flex;
- font-family: var(--font-family);
- }
- #actionLoadingMessage,
- #mainContent,
- section {
- display: flex;
- }
- #actionLoadingMessage,
- gr-button,
- gr-dropdown {
- /* px because don't have the same font size */
- margin-left: 8px;
- }
- gr-button {
- display: block;
- }
- #actionLoadingMessage {
- align-items: center;
- color: var(--deemphasized-text-color);
- }
- #confirmSubmitDialog .changeSubject {
- margin: var(--spacing-l);
- text-align: center;
- }
- iron-icon {
- color: inherit;
- margin-right: var(--spacing-xs);
- }
- #moreActions iron-icon {
- margin: 0;
- }
- #moreMessage,
- .hidden {
- display: none;
- }
- @media screen and (max-width: 50em) {
- #mainContent {
- flex-wrap: wrap;
- }
- gr-button {
- --gr-button-padding: var(--spacing-m);
- white-space: nowrap;
- }
- gr-button,
- gr-dropdown {
- margin: 0;
- }
- #actionLoadingMessage {
- margin: var(--spacing-m);
- text-align: center;
- }
- #moreMessage {
- display: inline;
- }
- }
- </style>
- <div id="mainContent">
- <span id="actionLoadingMessage" hidden$="[[!_actionLoadingMessage]]">
- [[_actionLoadingMessage]]</span
- >
- <section
- id="primaryActions"
- hidden$="[[_shouldHideActions(_topLevelActions.*, _loading)]]"
- >
- <template is="dom-repeat" items="[[_topLevelPrimaryActions]]" as="action">
- <gr-tooltip-content
- title$="[[action.title]]"
- has-tooltip="[[_computeHasTooltip(action.title)]]"
- position-below="true"
- >
- <gr-button
- link=""
- data-action-key$="[[action.__key]]"
- class$="[[action.__key]]"
- data-action-type$="[[action.__type]]"
- data-label$="[[action.label]]"
- disabled$="[[_calculateDisabled(action, _hasKnownChainState)]]"
- on-click="_handleActionTap"
- >
- <iron-icon
- class$="[[_computeHasIcon(action)]]"
- icon$="gr-icons:[[action.icon]]"
- ></iron-icon>
- [[action.label]]
- </gr-button>
- </gr-tooltip-content>
- </template>
- </section>
- <section
- id="secondaryActions"
- hidden$="[[_shouldHideActions(_topLevelActions.*, _loading)]]"
- >
- <template
- is="dom-repeat"
- items="[[_topLevelSecondaryActions]]"
- as="action"
- >
- <gr-tooltip-content
- title$="[[action.title]]"
- has-tooltip="[[_computeHasTooltip(action.title)]]"
- position-below="true"
- >
- <gr-button
- link=""
- data-action-key$="[[action.__key]]"
- class$="[[action.__key]]"
- data-action-type$="[[action.__type]]"
- data-label$="[[action.label]]"
- disabled$="[[_calculateDisabled(action, _hasKnownChainState)]]"
- on-click="_handleActionTap"
- >
- <iron-icon
- class$="[[_computeHasIcon(action)]]"
- icon$="gr-icons:[[action.icon]]"
- ></iron-icon>
- [[action.label]]
- </gr-button>
- </gr-tooltip-content>
- </template>
- </section>
- <gr-button hidden$="[[!_loading]]" disabled=""
- >Loading actions...</gr-button
- >
- <gr-dropdown
- id="moreActions"
- link=""
- vertical-offset="32"
- horizontal-align="right"
- on-tap-item="_handleOverflowItemTap"
- hidden$="[[_shouldHideActions(_menuActions.*, _loading)]]"
- disabled-ids="[[_disabledMenuActions]]"
- items="[[_menuActions]]"
- >
- <iron-icon icon="gr-icons:more-vert" aria-labelledby="moreMessage">
- </iron-icon>
- <span id="moreMessage">More</span>
- </gr-dropdown>
- </div>
- <gr-overlay id="overlay" with-backdrop="">
- <gr-confirm-rebase-dialog
- id="confirmRebase"
- class="confirmDialog"
- change-number="[[change._number]]"
- on-confirm="_handleRebaseConfirm"
- on-cancel="_handleConfirmDialogCancel"
- branch="[[change.branch]]"
- has-parent="[[hasParent]]"
- rebase-on-current="[[_computeRebaseOnCurrent(_revisionRebaseAction)]]"
- hidden=""
- ></gr-confirm-rebase-dialog>
- <gr-confirm-cherrypick-dialog
- id="confirmCherrypick"
- class="confirmDialog"
- change-status="[[changeStatus]]"
- commit-message="[[commitMessage]]"
- commit-num="[[commitNum]]"
- on-confirm="_handleCherrypickConfirm"
- on-cancel="_handleConfirmDialogCancel"
- project="[[change.project]]"
- hidden=""
- ></gr-confirm-cherrypick-dialog>
- <gr-confirm-cherrypick-conflict-dialog
- id="confirmCherrypickConflict"
- class="confirmDialog"
- on-confirm="_handleCherrypickConflictConfirm"
- on-cancel="_handleConfirmDialogCancel"
- hidden=""
- ></gr-confirm-cherrypick-conflict-dialog>
- <gr-confirm-move-dialog
- id="confirmMove"
- class="confirmDialog"
- on-confirm="_handleMoveConfirm"
- on-cancel="_handleConfirmDialogCancel"
- project="[[change.project]]"
- hidden=""
- ></gr-confirm-move-dialog>
- <gr-confirm-revert-dialog
- id="confirmRevertDialog"
- class="confirmDialog"
- on-confirm="_handleRevertDialogConfirm"
- on-cancel="_handleConfirmDialogCancel"
- hidden=""
- ></gr-confirm-revert-dialog>
- <gr-confirm-abandon-dialog
- id="confirmAbandonDialog"
- class="confirmDialog"
- on-confirm="_handleAbandonDialogConfirm"
- on-cancel="_handleConfirmDialogCancel"
- hidden=""
- ></gr-confirm-abandon-dialog>
- <gr-confirm-submit-dialog
- id="confirmSubmitDialog"
- class="confirmDialog"
- action="[[_revisionSubmitAction]]"
- on-cancel="_handleConfirmDialogCancel"
- on-confirm="_handleSubmitConfirm"
- hidden=""
- ></gr-confirm-submit-dialog>
- <gr-dialog
- id="createFollowUpDialog"
- class="confirmDialog"
- confirm-label="Create"
- on-confirm="_handleCreateFollowUpChange"
- on-cancel="_handleCloseCreateFollowUpChange"
- >
- <div class="header" slot="header">Create Follow-Up Change</div>
- <div class="main" slot="main">
- <gr-create-change-dialog
- id="createFollowUpChange"
- branch="[[change.branch]]"
- base-change="[[change.id]]"
- repo-name="[[change.project]]"
- private-by-default="[[privateByDefault]]"
- ></gr-create-change-dialog>
- </div>
- </gr-dialog>
- <gr-dialog
- id="confirmDeleteDialog"
- class="confirmDialog"
- confirm-label="Delete"
- confirm-on-enter=""
- on-cancel="_handleConfirmDialogCancel"
- on-confirm="_handleDeleteConfirm"
- >
- <div class="header" slot="header">Delete Change</div>
- <div class="main" slot="main">
- Do you really want to delete the change?
- </div>
- </gr-dialog>
- <gr-dialog
- id="confirmDeleteEditDialog"
- class="confirmDialog"
- confirm-label="Delete"
- confirm-on-enter=""
- on-cancel="_handleConfirmDialogCancel"
- on-confirm="_handleDeleteEditConfirm"
- >
- <div class="header" slot="header">Delete Change Edit</div>
- <div class="main" slot="main">Do you really want to delete the edit?</div>
- </gr-dialog>
- </gr-overlay>
-`;
diff --git a/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions_test.ts b/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions_test.ts
index 50ab91c..3207279 100644
--- a/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-change-actions/gr-change-actions_test.ts
@@ -54,23 +54,28 @@
TopicName,
} from '../../../types/common';
import {ActionType} from '../../../api/change-actions';
-import {tap} from '@polymer/iron-test-helpers/mock-interactions';
import {SinonFakeTimers} from 'sinon';
import {IronAutogrowTextareaElement} from '@polymer/iron-autogrow-textarea';
import {GrButton} from '../../shared/gr-button/gr-button';
import {GrDialog} from '../../shared/gr-dialog/gr-dialog';
import {UIActionInfo} from '../../shared/gr-js-api-interface/gr-change-actions-js-api';
-import {PolymerDeepPropertyChange} from '@polymer/polymer/interfaces';
import {getAppContext} from '../../../services/app-context';
-
-const basicFixture = fixtureFromElement('gr-change-actions');
+import {fixture, html} from '@open-wc/testing-helpers';
+import {GrConfirmCherrypickDialog} from '../gr-confirm-cherrypick-dialog/gr-confirm-cherrypick-dialog';
+import {GrDropdown} from '../../shared/gr-dropdown/gr-dropdown';
+import {GrOverlay} from '../../shared/gr-overlay/gr-overlay';
+import {GrConfirmSubmitDialog} from '../gr-confirm-submit-dialog/gr-confirm-submit-dialog';
+import {GrConfirmRebaseDialog} from '../gr-confirm-rebase-dialog/gr-confirm-rebase-dialog';
+import {GrConfirmMoveDialog} from '../gr-confirm-move-dialog/gr-confirm-move-dialog';
+import {GrConfirmAbandonDialog} from '../gr-confirm-abandon-dialog/gr-confirm-abandon-dialog';
+import {GrConfirmRevertDialog} from '../gr-confirm-revert-dialog/gr-confirm-revert-dialog';
// TODO(dhruvsri): remove use of _populateRevertMessage as it's private
suite('gr-change-actions tests', () => {
let element: GrChangeActions;
suite('basic tests', () => {
- setup(() => {
+ setup(async () => {
stubRestApi('getChangeRevisionActions').returns(
Promise.resolve({
cherrypick: {
@@ -127,78 +132,62 @@
.stub(getPluginLoader(), 'awaitPluginsLoaded')
.returns(Promise.resolve());
- element = basicFixture.instantiate();
- element.change = createChangeViewChange();
- element.changeNum = 42 as NumericChangeId;
- element.latestPatchNum = 2 as PatchSetNum;
- element.actions = {
- '/': {
- method: HttpMethod.DELETE,
- label: 'Delete Change',
- title: 'Delete change X_X',
- enabled: true,
+ element = await fixture<GrChangeActions>(html`
+ <gr-change-actions></gr-change-actions>
+ `);
+ element.change = {
+ ...createChangeViewChange(),
+ actions: {
+ '/': {
+ method: HttpMethod.DELETE,
+ label: 'Delete Change',
+ title: 'Delete change X_X',
+ enabled: true,
+ },
},
};
+ element.changeNum = 42 as NumericChangeId;
+ element.latestPatchNum = 2 as PatchSetNum;
element.account = {
_account_id: 123 as AccountId,
};
stubRestApi('getRepoBranches').returns(Promise.resolve([]));
- return element.reload();
+ await element.updateComplete;
+ await element.reload();
});
test('show-revision-actions event should fire', async () => {
- const spy = sinon.spy(element, '_sendShowRevisionActions');
+ const spy = sinon.spy(element, 'sendShowRevisionActions');
element.reload();
- await flush();
+ await element.updateComplete;
assert.isTrue(spy.called);
});
test('primary and secondary actions split properly', () => {
// Submit should be the only primary action.
- assert.equal(element._topLevelPrimaryActions!.length, 1);
- assert.equal(element._topLevelPrimaryActions![0].label, 'Submit');
+ assert.equal(element.topLevelPrimaryActions!.length, 1);
+ assert.equal(element.topLevelPrimaryActions![0].label, 'Submit');
assert.equal(
- element._topLevelSecondaryActions!.length,
- element._topLevelActions!.length - 1
+ element.topLevelSecondaryActions!.length,
+ element.topLevelActions!.length - 1
);
});
test('revert submission action is skipped', () => {
assert.equal(
- element._allActionValues.filter(action => action.__key === 'submit')
+ element.allActionValues.filter(action => action.__key === 'submit')
.length,
1
);
assert.equal(
- element._allActionValues.filter(
+ element.allActionValues.filter(
action => action.__key === 'revert_submission'
).length,
0
);
});
- test('_shouldHideActions', () => {
- assert.isTrue(element._shouldHideActions(undefined, true));
- assert.isTrue(
- element._shouldHideActions(
- {base: [] as UIActionInfo[]} as PolymerDeepPropertyChange<
- UIActionInfo[],
- UIActionInfo[]
- >,
- false
- )
- );
- assert.isFalse(
- element._shouldHideActions(
- {
- base: [{__key: 'test'}] as UIActionInfo[],
- } as PolymerDeepPropertyChange<UIActionInfo[], UIActionInfo[]>,
- false
- )
- );
- });
-
test('plugin revision actions', async () => {
const stub = stubRestApi('getChangeActionURL').returns(
Promise.resolve('the-url')
@@ -207,7 +196,7 @@
'plugin~action': {},
};
assert.isOk(element.revisionActions['plugin~action']);
- await flush();
+ await element.updateComplete;
assert.isTrue(
stub.calledWith(
element.changeNum,
@@ -229,7 +218,7 @@
'plugin~action': {},
};
assert.isOk(element.actions['plugin~action']);
- await flush();
+ await element.updateComplete;
assert.isTrue(
stub.calledWith(element.changeNum, undefined, '/plugin~action')
);
@@ -266,7 +255,7 @@
});
test('hide revision action', async () => {
- await flush();
+ await element.updateComplete;
let buttonEl: Element | undefined = queryAndAssert(
element,
'[data-action-key="submit"]'
@@ -277,14 +266,8 @@
element.RevisionActions.SUBMIT,
true
);
- assert.lengthOf(element._hiddenActions, 1);
- element.setActionHidden(
- element.ActionType.REVISION,
- element.RevisionActions.SUBMIT,
- true
- );
- assert.lengthOf(element._hiddenActions, 1);
- await flush();
+ assert.lengthOf(element.hiddenActions, 1);
+ await element.updateComplete;
buttonEl = query(element, '[data-action-key="submit"]');
assert.isNotOk(buttonEl);
@@ -293,31 +276,35 @@
element.RevisionActions.SUBMIT,
false
);
- await flush();
+ await element.updateComplete;
buttonEl = queryAndAssert(element, '[data-action-key="submit"]');
assert.isFalse(buttonEl.hasAttribute('hidden'));
});
test('buttons exist', async () => {
- element._loading = false;
- await flush();
+ element.loading = false;
+ await element.updateComplete;
const buttonEls = queryAll(element, 'gr-button');
- const menuItems = element.$.moreActions.items;
+ const menuItems = queryAndAssert<GrDropdown>(
+ element,
+ '#moreActions'
+ ).items;
// Total button number is one greater than the number of total actions
// due to the existence of the overflow menu trigger.
assert.equal(
buttonEls.length + menuItems!.length,
- element._allActionValues.length + 1
+ element.allActionValues.length + 1
);
assert.isFalse(element.hidden);
});
test('delete buttons have explicit labels', async () => {
- await flush();
- const deleteItems = element.$.moreActions.items!.filter(item =>
- item.id!.startsWith('delete')
- );
+ await element.updateComplete;
+ const deleteItems = queryAndAssert<GrDropdown>(
+ element,
+ '#moreActions'
+ ).items!.filter(item => item.id!.startsWith('delete'));
assert.equal(deleteItems.length, 1);
assert.equal(deleteItems[0].name, 'Delete change');
});
@@ -335,10 +322,10 @@
rev2: revObj,
},
};
- assert.deepEqual(element._getRevision(change, 2 as PatchSetNum), revObj);
+ assert.deepEqual(element.getRevision(change, 2 as PatchSetNum), revObj);
});
- test('_actionComparator sort order', () => {
+ test('actionComparator sort order', () => {
const actions = [
{label: '123', __type: ActionType.CHANGE, __key: 'review'},
{label: 'abc-ro', __type: ActionType.REVISION, __key: 'random'},
@@ -354,16 +341,18 @@
const result = actions.slice();
result.reverse();
- result.sort(element._actionComparator.bind(element));
+ result.sort(element.actionComparator.bind(element));
assert.deepEqual(result, actions);
});
test('submit change', async () => {
- const showSpy = sinon.spy(element, '_showActionDialog');
+ const showSpy = sinon.spy(element, 'showActionDialog');
stubRestApi('getFromProjectLookup').returns(
Promise.resolve('test' as RepoName)
);
- sinon.stub(element.$.overlay, 'open').returns(Promise.resolve());
+ sinon
+ .stub(queryAndAssert<GrOverlay>(element, '#overlay'), 'open')
+ .returns(Promise.resolve());
element.change = {
...createChangeViewChange(),
revisions: {
@@ -373,25 +362,36 @@
};
element.latestPatchNum = 2 as PatchSetNum;
- const submitButton = queryAndAssert(
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="submit"]'
- );
- tap(submitButton);
+ ).click();
- await flush();
- assert.isTrue(showSpy.calledWith(element.$.confirmSubmitDialog));
+ await element.updateComplete;
+ assert.isTrue(
+ showSpy.calledWith(
+ queryAndAssert<GrConfirmSubmitDialog>(element, '#confirmSubmitDialog')
+ )
+ );
});
test('submit change, tap on icon', async () => {
const submitted = mockPromise();
sinon
- .stub(element.$.confirmSubmitDialog, 'resetFocus')
+ .stub(
+ queryAndAssert<GrConfirmSubmitDialog>(
+ element,
+ '#confirmSubmitDialog'
+ ),
+ 'resetFocus'
+ )
.callsFake(() => submitted.resolve());
stubRestApi('getFromProjectLookup').returns(
Promise.resolve('test' as RepoName)
);
- sinon.stub(element.$.overlay, 'open').returns(Promise.resolve());
+ sinon
+ .stub(queryAndAssert<GrOverlay>(element, '#overlay'), 'open')
+ .returns(Promise.resolve());
element.change = {
...createChangeViewChange(),
revisions: {
@@ -401,18 +401,17 @@
};
element.latestPatchNum = 2 as PatchSetNum;
- const submitIcon = queryAndAssert(
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="submit"] iron-icon'
- );
- tap(submitIcon);
+ ).click();
await submitted;
});
- test('_handleSubmitConfirm', () => {
- const fireStub = sinon.stub(element, '_fireAction');
- sinon.stub(element, '_canSubmitChange').returns(true);
- element._handleSubmitConfirm();
+ test('handleSubmitConfirm', () => {
+ const fireStub = sinon.stub(element, 'fireAction');
+ sinon.stub(element, 'canSubmitChange').returns(true);
+ element.handleSubmitConfirm();
assert.isTrue(fireStub.calledOnce);
assert.deepEqual(fireStub.lastCall.args, [
'/submit',
@@ -421,77 +420,66 @@
]);
});
- test('_handleSubmitConfirm when not able to submit', () => {
- const fireStub = sinon.stub(element, '_fireAction');
- sinon.stub(element, '_canSubmitChange').returns(false);
- element._handleSubmitConfirm();
+ test('handleSubmitConfirm when not able to submit', () => {
+ const fireStub = sinon.stub(element, 'fireAction');
+ sinon.stub(element, 'canSubmitChange').returns(false);
+ element.handleSubmitConfirm();
assert.isFalse(fireStub.called);
});
test('submit change with plugin hook', async () => {
- sinon.stub(element, '_canSubmitChange').callsFake(() => false);
- const fireActionStub = sinon.stub(element, '_fireAction');
- await flush();
- const submitButton = queryAndAssert(
+ sinon.stub(element, 'canSubmitChange').callsFake(() => false);
+ const fireActionStub = sinon.stub(element, 'fireAction');
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="submit"]'
- );
- tap(submitButton);
+ ).click();
assert.equal(fireActionStub.callCount, 0);
});
- test('chain state', () => {
+ test('chain state', async () => {
assert.equal(element._hasKnownChainState, false);
element.hasParent = true;
+ await element.updateComplete;
assert.equal(element._hasKnownChainState, true);
- element.hasParent = false;
});
- test('_calculateDisabled', () => {
- let hasKnownChainState = false;
+ test('calculateDisabled', () => {
const action = {
__key: 'rebase',
enabled: true,
__type: ActionType.CHANGE,
label: 'l',
};
- assert.equal(
- element._calculateDisabled(action, hasKnownChainState),
- true
- );
+ element._hasKnownChainState = false;
+ assert.equal(element.calculateDisabled(action), true);
action.__key = 'delete';
- assert.equal(
- element._calculateDisabled(action, hasKnownChainState),
- false
- );
+ assert.equal(element.calculateDisabled(action), false);
action.__key = 'rebase';
- hasKnownChainState = true;
- assert.equal(
- element._calculateDisabled(action, hasKnownChainState),
- false
- );
+ element._hasKnownChainState = true;
+ assert.equal(element.calculateDisabled(action), false);
action.enabled = false;
- assert.equal(
- element._calculateDisabled(action, hasKnownChainState),
- false
- );
+ assert.equal(element.calculateDisabled(action), false);
});
test('rebase change', async () => {
- const fireActionStub = sinon.stub(element, '_fireAction');
+ const fireActionStub = sinon.stub(element, 'fireAction');
const fetchChangesStub = sinon
- .stub(element.$.confirmRebase, 'fetchRecentChanges')
+ .stub(
+ queryAndAssert<GrConfirmRebaseDialog>(element, '#confirmRebase'),
+ 'fetchRecentChanges'
+ )
.returns(Promise.resolve([]));
element._hasKnownChainState = true;
- await flush();
- const rebaseButton = queryAndAssert(
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="rebase"]'
- );
- tap(rebaseButton);
+ ).click();
const rebaseAction = {
__key: 'rebase',
__type: 'revision',
@@ -502,7 +490,7 @@
title: 'Rebase onto tip of branch or parent change',
};
assert.isTrue(fetchChangesStub.called);
- element._handleRebaseConfirm(
+ element.handleRebaseConfirm(
new CustomEvent('', {detail: {base: '1234'}})
);
assert.deepEqual(fireActionStub.lastCall.args, [
@@ -515,87 +503,108 @@
test('rebase change fires reload event', async () => {
const eventStub = sinon.stub(element, 'dispatchEvent');
- element._handleResponse(
+ await element.handleResponse(
{__key: 'rebase', __type: ActionType.CHANGE, label: 'l'},
new Response()
);
- await flush();
assert.isTrue(eventStub.called);
assert.equal(eventStub.lastCall.args[0].type, 'reload');
});
test("rebase dialog gets recent changes each time it's opened", async () => {
const fetchChangesStub = sinon
- .stub(element.$.confirmRebase, 'fetchRecentChanges')
+ .stub(
+ queryAndAssert<GrConfirmRebaseDialog>(element, '#confirmRebase'),
+ 'fetchRecentChanges'
+ )
.returns(Promise.resolve([]));
element._hasKnownChainState = true;
- const rebaseButton = queryAndAssert(
+ await element.updateComplete;
+ const rebaseButton = queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="rebase"]'
);
- tap(rebaseButton);
+ rebaseButton.click();
+ await element.updateComplete;
assert.isTrue(fetchChangesStub.calledOnce);
- await flush();
- element.$.confirmRebase.dispatchEvent(
+ await element.updateComplete;
+ queryAndAssert<GrConfirmRebaseDialog>(
+ element,
+ '#confirmRebase'
+ ).dispatchEvent(
new CustomEvent('cancel', {
composed: true,
bubbles: true,
})
);
- tap(rebaseButton);
+ rebaseButton.click();
assert.isTrue(fetchChangesStub.calledTwice);
});
test('two dialogs are not shown at the same time', async () => {
element._hasKnownChainState = true;
- await flush();
- const rebaseButton = queryAndAssert(
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="rebase"]'
+ ).click();
+ await element.updateComplete;
+ assert.isFalse(
+ queryAndAssert<GrConfirmRebaseDialog>(element, '#confirmRebase').hidden
);
- tap(rebaseButton);
- await flush();
- assert.isFalse(element.$.confirmRebase.hidden);
stubRestApi('getChanges').returns(Promise.resolve([]));
- element._handleCherrypickTap();
- await flush();
- assert.isTrue(element.$.confirmRebase.hidden);
- assert.isFalse(element.$.confirmCherrypick.hidden);
+ element.handleCherrypickTap();
+ await element.updateComplete;
+ assert.isTrue(
+ queryAndAssert<GrConfirmRebaseDialog>(element, '#confirmRebase').hidden
+ );
+ assert.isFalse(
+ queryAndAssert<GrConfirmCherrypickDialog>(element, '#confirmCherrypick')
+ .hidden
+ );
});
test('fullscreen-overlay-opened hides content', () => {
- const spy = sinon.spy(element, '_handleHideBackgroundContent');
- element.$.overlay.dispatchEvent(
+ const spy = sinon.spy(element, 'handleHideBackgroundContent');
+ queryAndAssert<GrOverlay>(element, '#overlay').dispatchEvent(
new CustomEvent('fullscreen-overlay-opened', {
composed: true,
bubbles: true,
})
);
assert.isTrue(spy.called);
- assert.isTrue(element.$.mainContent.classList.contains('overlayOpen'));
+ assert.isTrue(
+ queryAndAssert<Element>(element, '#mainContent').classList.contains(
+ 'overlayOpen'
+ )
+ );
});
test('fullscreen-overlay-closed shows content', () => {
- const spy = sinon.spy(element, '_handleShowBackgroundContent');
- element.$.overlay.dispatchEvent(
+ const spy = sinon.spy(element, 'handleShowBackgroundContent');
+ queryAndAssert<GrOverlay>(element, '#overlay').dispatchEvent(
new CustomEvent('fullscreen-overlay-closed', {
composed: true,
bubbles: true,
})
);
assert.isTrue(spy.called);
- assert.isFalse(element.$.mainContent.classList.contains('overlayOpen'));
+ assert.isFalse(
+ queryAndAssert<Element>(element, '#mainContent').classList.contains(
+ 'overlayOpen'
+ )
+ );
});
- test('_setReviewOnRevert', () => {
+ test('setReviewOnRevert', () => {
const review = {labels: {Foo: 1, 'Bar-Baz': -2}};
const changeId = 1234 as NumericChangeId;
sinon.stub(element.jsAPI, 'getReviewPostRevert').returns(review);
const saveStub = stubRestApi('saveChangeReview').returns(
Promise.resolve(new Response())
);
- const setReviewOnRevert = element._setReviewOnRevert(changeId) as Promise<
+ const setReviewOnRevert = element.setReviewOnRevert(changeId) as Promise<
undefined | Response
>;
return setReviewOnRevert.then((_res: Response | undefined) => {
@@ -607,14 +616,14 @@
suite('change edits', () => {
test('disableEdit', async () => {
- element.set('editMode', false);
- element.set('editPatchsetLoaded', false);
+ element.editMode = false;
+ element.editBasedOnCurrentPatchSet = false;
element.change = {
...createChangeViewChange(),
status: ChangeStatus.NEW,
};
- element.set('disableEdit', true);
- await flush();
+ element.disableEdit = true;
+ await element.updateComplete;
assert.isNotOk(
query(element, 'gr-button[data-action-key="publishEdit"]')
@@ -630,28 +639,30 @@
});
test('shows confirm dialog for delete edit', async () => {
- element.set('loggedIn', true);
- element.set('editMode', true);
- element.set('editPatchsetLoaded', true);
+ element.loggedIn = true;
+ element.editMode = true;
+ element.editPatchsetLoaded = true;
+ await element.updateComplete;
- const fireActionStub = sinon.stub(element, '_fireAction');
- element._handleDeleteEditTap();
- assert.isFalse(element.$.confirmDeleteEditDialog.hidden);
- tap(
- queryAndAssert(
- queryAndAssert(element, '#confirmDeleteEditDialog'),
- 'gr-button[primary]'
- )
+ const fireActionStub = sinon.stub(element, 'fireAction');
+ element.handleDeleteEditTap();
+ assert.isFalse(
+ queryAndAssert<GrDialog>(element, '#confirmDeleteEditDialog').hidden
);
- await flush();
+ queryAndAssert<GrButton>(
+ queryAndAssert(element, '#confirmDeleteEditDialog'),
+ 'gr-button[primary]'
+ ).click();
+ await element.updateComplete;
assert.equal(fireActionStub.lastCall.args[0], '/edit');
});
test('all cached change edits get deleted on delete edit', async () => {
- element.set('loggedIn', true);
- element.set('editMode', true);
- element.set('editPatchsetLoaded', true);
+ element.loggedIn = true;
+ element.editMode = true;
+ element.editPatchsetLoaded = true;
+ await element.updateComplete;
const storage = getAppContext().storageService;
storage.setEditableContentItem(
@@ -679,31 +690,31 @@
const eraseEditableContentItemsForChangeEditSpy = spyStorage(
'eraseEditableContentItemsForChangeEdit'
);
- sinon.stub(element, '_fireAction');
- element._handleDeleteEditTap();
- assert.isFalse(element.$.confirmDeleteEditDialog.hidden);
- tap(
- queryAndAssert(
- queryAndAssert(element, '#confirmDeleteEditDialog'),
- 'gr-button[primary]'
- )
+ sinon.stub(element, 'fireAction');
+ element.handleDeleteEditTap();
+ assert.isFalse(
+ queryAndAssert<GrDialog>(element, '#confirmDeleteEditDialog').hidden
);
- await flush();
+ queryAndAssert<GrButton>(
+ queryAndAssert(element, '#confirmDeleteEditDialog'),
+ 'gr-button[primary]'
+ ).click();
+ await element.updateComplete;
assert.isTrue(eraseEditableContentItemsForChangeEditSpy.called);
assert.isNotOk(storage.getEditableContentItem('c42_psedit_index.php')!);
assert.isNotOk(storage.getEditableContentItem('c42_ps2_index.php')!);
});
test('edit patchset is loaded, needs rebase', async () => {
- element.set('loggedIn', true);
- element.set('editMode', true);
- element.set('editPatchsetLoaded', true);
+ element.loggedIn = true;
+ element.editMode = true;
+ element.editPatchsetLoaded = true;
element.change = {
...createChangeViewChange(),
status: ChangeStatus.NEW,
};
element.editBasedOnCurrentPatchSet = false;
- await flush();
+ await element.updateComplete;
assert.isNotOk(
query(element, 'gr-button[data-action-key="publishEdit"]')
@@ -715,15 +726,15 @@
});
test('edit patchset is loaded, does not need rebase', async () => {
- element.set('loggedIn', true);
- element.set('editMode', true);
- element.set('editPatchsetLoaded', true);
+ element.loggedIn = true;
+ element.editMode = true;
+ element.editPatchsetLoaded = true;
element.change = {
...createChangeViewChange(),
status: ChangeStatus.NEW,
};
element.editBasedOnCurrentPatchSet = true;
- await flush();
+ await element.updateComplete;
assert.isOk(query(element, 'gr-button[data-action-key="publishEdit"]'));
assert.isNotOk(
@@ -735,14 +746,14 @@
});
test('edit mode is loaded, no edit patchset', async () => {
- element.set('loggedIn', true);
- element.set('editMode', true);
- element.set('editPatchsetLoaded', false);
+ element.loggedIn = true;
+ element.editMode = true;
+ element.editPatchsetLoaded = false;
element.change = {
...createChangeViewChange(),
status: ChangeStatus.NEW,
};
- await flush();
+ await element.updateComplete;
assert.isNotOk(
query(element, 'gr-button[data-action-key="publishEdit"]')
@@ -758,14 +769,14 @@
});
test('normal patch set', async () => {
- element.set('loggedIn', true);
- element.set('editMode', false);
- element.set('editPatchsetLoaded', false);
+ element.loggedIn = true;
+ element.editMode = false;
+ element.editPatchsetLoaded = false;
element.change = {
...createChangeViewChange(),
status: ChangeStatus.NEW,
};
- await flush();
+ await element.updateComplete;
assert.isNotOk(
query(element, 'gr-button[data-action-key="publishEdit"]')
@@ -781,17 +792,17 @@
});
test('edit action', async () => {
- element.set('loggedIn', true);
+ element.loggedIn = true;
const editTapped = mockPromise();
element.addEventListener('edit-tap', () => {
editTapped.resolve();
});
- element.set('editMode', true);
+ element.editMode = true;
element.change = {
...createChangeViewChange(),
status: ChangeStatus.NEW,
};
- await flush();
+ await element.updateComplete;
assert.isNotOk(query(element, 'gr-button[data-action-key="edit"]'));
assert.isOk(query(element, 'gr-button[data-action-key="stopEdit"]'));
@@ -799,34 +810,33 @@
...createChangeViewChange(),
status: ChangeStatus.MERGED,
};
- await flush();
+ await element.updateComplete;
assert.isNotOk(query(element, 'gr-button[data-action-key="edit"]'));
element.change = {
...createChangeViewChange(),
status: ChangeStatus.NEW,
};
- element.set('editMode', false);
- await flush();
+ element.editMode = false;
+ await element.updateComplete;
- const editButton = queryAndAssert(
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="edit"]'
- );
- tap(editButton);
+ ).click();
await editTapped;
});
});
test('edit action not shown for logged out user', async () => {
- element.set('loggedIn', false);
- element.set('editMode', false);
- element.set('editPatchsetLoaded', false);
+ element.loggedIn = false;
+ element.editMode = false;
+ element.editPatchsetLoaded = false;
element.change = {
...createChangeViewChange(),
status: ChangeStatus.NEW,
};
- await flush();
+ await element.updateComplete;
assert.isNotOk(
query(element, 'gr-button[data-action-key="publishEdit"]')
@@ -841,12 +851,12 @@
let fireActionStub: sinon.SinonStub;
setup(() => {
- fireActionStub = sinon.stub(element, '_fireAction');
+ fireActionStub = sinon.stub(element, 'fireAction');
sinon.stub(window, 'alert');
});
test('works', async () => {
- element._handleCherrypickTap();
+ element.handleCherrypickTap();
const action = {
__key: 'cherrypick',
__type: 'revision',
@@ -857,24 +867,39 @@
title: 'Cherry pick change to a different branch',
};
- element._handleCherrypickConfirm();
+ element.handleCherrypickConfirm();
assert.equal(fireActionStub.callCount, 0);
- element.$.confirmCherrypick.branch = 'master' as BranchName;
- element._handleCherrypickConfirm();
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).branch = 'master' as BranchName;
+ element.handleCherrypickConfirm();
assert.equal(fireActionStub.callCount, 0); // Still needs a message.
// Add attributes that are used to determine the message.
- element.$.confirmCherrypick.commitMessage = 'foo message';
- element.$.confirmCherrypick.changeStatus = ChangeStatus.NEW;
- element.$.confirmCherrypick.commitNum = '123' as CommitId;
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).commitMessage = 'foo message';
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).changeStatus = ChangeStatus.NEW;
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).commitNum = '123' as CommitId;
await element.updateComplete;
- element._handleCherrypickConfirm();
+ element.handleCherrypickConfirm();
await element.updateComplete;
const autogrowEl = queryAndAssert<IronAutogrowTextareaElement>(
- element.$.confirmCherrypick,
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ),
'#messageInput'
);
assert.equal(autogrowEl.value, 'foo message');
@@ -893,7 +918,7 @@
});
test('cherry pick even with conflicts', async () => {
- element._handleCherrypickTap();
+ element.handleCherrypickTap();
const action = {
__key: 'cherrypick',
__type: 'revision',
@@ -904,15 +929,27 @@
title: 'Cherry pick change to a different branch',
};
- element.$.confirmCherrypick.branch = 'master' as BranchName;
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).branch = 'master' as BranchName;
// Add attributes that are used to determine the message.
- element.$.confirmCherrypick.commitMessage = 'foo message';
- element.$.confirmCherrypick.changeStatus = ChangeStatus.NEW;
- element.$.confirmCherrypick.commitNum = '123' as CommitId;
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).commitMessage = 'foo message';
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).changeStatus = ChangeStatus.NEW;
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).commitNum = '123' as CommitId;
await element.updateComplete;
- element._handleCherrypickConflictConfirm();
+ element.handleCherrypickConflictConfirm();
await element.updateComplete;
assert.deepEqual(fireActionStub.lastCall.args, [
@@ -930,10 +967,19 @@
test('branch name cleared when re-open cherrypick', () => {
const emptyBranchName = '';
- element.$.confirmCherrypick.branch = 'master' as BranchName;
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).branch = 'master' as BranchName;
- element._handleCherrypickTap();
- assert.equal(element.$.confirmCherrypick.branch, emptyBranchName);
+ element.handleCherrypickTap();
+ assert.equal(
+ queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ ).branch,
+ emptyBranchName
+ );
});
suite('cherry pick topics', () => {
@@ -957,20 +1003,28 @@
];
setup(async () => {
stubRestApi('getChanges').returns(Promise.resolve(changes));
- element._handleCherrypickTap();
- await flush();
- const radioButtons = queryAll(
- element.$.confirmCherrypick,
+ element.handleCherrypickTap();
+ await element.updateComplete;
+ const confirmCherrypick = queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ );
+ await element.updateComplete;
+ const radioButtons = queryAll<HTMLInputElement>(
+ confirmCherrypick,
"input[name='cherryPickOptions']"
);
assert.equal(radioButtons.length, 2);
- tap(radioButtons[1]);
- await flush();
+ radioButtons[1].click();
+ await element.updateComplete;
});
test('cherry pick topic dialog is rendered', async () => {
- const dialog = element.$.confirmCherrypick;
- await flush();
+ const dialog = queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ );
+ await element.updateComplete;
const changesTable = queryAndAssert(dialog, 'table');
const headers = Array.from(changesTable.querySelectorAll('th'));
const expectedHeadings = [
@@ -1006,7 +1060,10 @@
});
test('changes with duplicate project show an error', async () => {
- const dialog = element.$.confirmCherrypick;
+ const dialog = queryAndAssert<GrConfirmCherrypickDialog>(
+ element,
+ '#confirmCherrypick'
+ );
const error = queryAndAssert<HTMLSpanElement>(
dialog,
'.error-message'
@@ -1028,7 +1085,7 @@
project: 'A' as RepoName,
},
]);
- await flush();
+ await element.updateComplete;
assert.equal(
error.innerText,
'Two changes cannot be of the same' + ' project'
@@ -1040,8 +1097,8 @@
suite('move change', () => {
let fireActionStub: sinon.SinonStub;
- setup(() => {
- fireActionStub = sinon.stub(element, '_fireAction');
+ setup(async () => {
+ fireActionStub = sinon.stub(element, 'fireAction');
sinon.stub(window, 'alert');
element.actions = {
move: {
@@ -1051,25 +1108,31 @@
enabled: true,
},
};
+ await element.updateComplete;
});
test('works', () => {
- element._handleMoveTap();
+ element.handleMoveTap();
- element._handleMoveConfirm();
+ element.handleMoveConfirm();
assert.equal(fireActionStub.callCount, 0);
- element.$.confirmMove.branch = 'master' as BranchName;
- element._handleMoveConfirm();
+ queryAndAssert<GrConfirmMoveDialog>(element, '#confirmMove').branch =
+ 'master' as BranchName;
+ element.handleMoveConfirm();
assert.equal(fireActionStub.callCount, 1);
});
test('branch name cleared when re-open move', () => {
const emptyBranchName = '';
- element.$.confirmMove.branch = 'master' as BranchName;
+ queryAndAssert<GrConfirmMoveDialog>(element, '#confirmMove').branch =
+ 'master' as BranchName;
- element._handleMoveTap();
- assert.equal(element.$.confirmMove.branch, emptyBranchName);
+ element.handleMoveTap();
+ assert.equal(
+ queryAndAssert<GrConfirmMoveDialog>(element, '#confirmMove').branch,
+ emptyBranchName
+ );
});
});
@@ -1084,20 +1147,24 @@
key
);
element.removeActionButton(key);
- await flush();
+ await element.updateComplete;
assert.notOk(query(element, '[data-action-key="' + key + '"]'));
keyTapped.resolve();
});
- await flush();
- tap(queryAndAssert(element, '[data-action-key="' + key + '"]'));
+ await element.updateComplete;
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
+ element,
+ '[data-action-key="' + key + '"]'
+ ).click();
await keyTapped;
});
- test('_setLoadingOnButtonWithKey top-level', () => {
+ test('setLoadingOnButtonWithKey top-level', () => {
const key = 'rebase';
const type = 'revision';
- const cleanup = element._setLoadingOnButtonWithKey(type, key);
- assert.equal(element._actionLoadingMessage, 'Rebasing...');
+ const cleanup = element.setLoadingOnButtonWithKey(type, key);
+ assert.equal(element.actionLoadingMessage, 'Rebasing...');
const button = queryAndAssert<GrButton>(
element,
@@ -1112,29 +1179,29 @@
assert.isFalse(button.hasAttribute('loading'));
assert.isFalse(button.disabled);
- assert.isNotOk(element._actionLoadingMessage);
+ assert.isNotOk(element.actionLoadingMessage);
});
- test('_setLoadingOnButtonWithKey overflow menu', () => {
+ test('setLoadingOnButtonWithKey overflow menu', () => {
const key = 'cherrypick';
const type = 'revision';
- const cleanup = element._setLoadingOnButtonWithKey(type, key);
- assert.equal(element._actionLoadingMessage, 'Cherry-picking...');
- assert.include(element._disabledMenuActions, 'cherrypick');
+ const cleanup = element.setLoadingOnButtonWithKey(type, key);
+ assert.equal(element.actionLoadingMessage, 'Cherry-picking...');
+ assert.include(element.disabledMenuActions, 'cherrypick');
assert.isFunction(cleanup);
cleanup();
- assert.notOk(element._actionLoadingMessage);
- assert.notInclude(element._disabledMenuActions, 'cherrypick');
+ assert.notOk(element.actionLoadingMessage);
+ assert.notInclude(element.disabledMenuActions, 'cherrypick');
});
suite('abandon change', () => {
let alertStub: sinon.SinonStub;
let fireActionStub: sinon.SinonStub;
- setup(() => {
- fireActionStub = sinon.stub(element, '_fireAction');
+ setup(async () => {
+ fireActionStub = sinon.stub(element, 'fireAction');
alertStub = sinon.stub(window, 'alert');
element.actions = {
abandon: {
@@ -1144,43 +1211,63 @@
enabled: true,
},
};
- return element.reload();
+ await element.updateComplete;
+ // test
+ await element.reload();
});
test('abandon change with message', async () => {
const newAbandonMsg = 'Test Abandon Message';
- element.$.confirmAbandonDialog.message = newAbandonMsg;
- await flush();
- const abandonButton = queryAndAssert(
+ queryAndAssert<GrConfirmAbandonDialog>(
+ element,
+ '#confirmAbandonDialog'
+ ).message = newAbandonMsg;
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="abandon"]'
- );
- tap(abandonButton);
+ ).click();
- assert.equal(element.$.confirmAbandonDialog.message, newAbandonMsg);
+ assert.equal(
+ queryAndAssert<GrConfirmAbandonDialog>(
+ element,
+ '#confirmAbandonDialog'
+ ).message,
+ newAbandonMsg
+ );
});
test('abandon change with no message', async () => {
- await flush();
- const abandonButton = queryAndAssert(
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="abandon"]'
- );
- tap(abandonButton);
+ ).click();
- assert.equal(element.$.confirmAbandonDialog.message, '');
+ assert.equal(
+ queryAndAssert<GrConfirmAbandonDialog>(
+ element,
+ '#confirmAbandonDialog'
+ ).message,
+ ''
+ );
});
test('works', () => {
- element.$.confirmAbandonDialog.message = 'original message';
- const restoreButton = queryAndAssert(
+ queryAndAssert<GrConfirmAbandonDialog>(
+ element,
+ '#confirmAbandonDialog'
+ ).message = 'original message';
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="abandon"]'
- );
- tap(restoreButton);
+ ).click();
- element.$.confirmAbandonDialog.message = 'foo message';
- element._handleAbandonDialogConfirm();
+ queryAndAssert<GrConfirmAbandonDialog>(
+ element,
+ '#confirmAbandonDialog'
+ ).message = 'foo message';
+ element.handleAbandonDialogConfirm();
assert.notOk(alertStub.called);
const action = {
@@ -1206,29 +1293,48 @@
suite('revert change', () => {
let fireActionStub: sinon.SinonStub;
- setup(() => {
- fireActionStub = sinon.stub(element, '_fireAction');
+ setup(async () => {
+ fireActionStub = sinon.stub(element, 'fireAction');
element.commitMessage = 'random commit message';
- element.change!.current_revision = 'abcdef' as CommitId;
- element.actions = {
- revert: {
- method: HttpMethod.POST,
- label: 'Revert',
- title: 'Revert the change',
- enabled: true,
+ element.change = {
+ ...createChangeViewChange(),
+ current_revision: 'abcdef' as CommitId,
+ actions: {
+ revert: {
+ method: HttpMethod.POST,
+ label: 'Revert',
+ title: 'Revert the change',
+ enabled: true,
+ },
},
};
- return element.reload();
+ await element.updateComplete;
+ // test
+ await element.reload();
});
test('revert change with plugin hook', async () => {
const newRevertMsg = 'Modified revert msg';
sinon
- .stub(element.$.confirmRevertDialog, 'modifyRevertMsg')
+ .stub(
+ queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
+ ),
+ 'modifyRevertMsg'
+ )
.callsFake(() => newRevertMsg);
element.change = {
...createChangeViewChange(),
current_revision: 'abc1234' as CommitId,
+ actions: {
+ revert: {
+ method: HttpMethod.POST,
+ label: 'Revert',
+ title: 'Revert the change',
+ enabled: true,
+ },
+ },
};
stubRestApi('getChanges').returns(
Promise.resolve([
@@ -1248,27 +1354,41 @@
);
sinon
.stub(
- element.$.confirmRevertDialog,
+ queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
+ ),
'populateRevertSubmissionMessage'
)
.callsFake(() => 'original msg');
- await flush();
- const revertButton = queryAndAssert(
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="revert"]'
+ ).click();
+ await element.updateComplete;
+ assert.equal(
+ queryAndAssert<GrConfirmRevertDialog>(element, '#confirmRevertDialog')
+ .message,
+ newRevertMsg
);
- tap(revertButton);
- await flush();
- assert.equal(element.$.confirmRevertDialog.message, newRevertMsg);
});
suite('revert change submitted together', () => {
let getChangesStub: sinon.SinonStub;
- setup(() => {
+ setup(async () => {
element.change = {
...createChangeViewChange(),
submission_id: '199 0' as ChangeSubmissionId,
current_revision: '2000' as CommitId,
+ actions: {
+ revert: {
+ method: HttpMethod.POST,
+ label: 'Revert',
+ title: 'Revert the change',
+ enabled: true,
+ },
+ },
};
getChangesStub = stubRestApi('getChanges').returns(
Promise.resolve([
@@ -1286,17 +1406,21 @@
},
])
);
+ await element.updateComplete;
});
test('confirm revert dialog shows both options', async () => {
- const revertButton = queryAndAssert(
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="revert"]'
- );
- tap(revertButton);
- await flush();
+ ).click();
+ await element.updateComplete;
assert.equal(getChangesStub.args[0][1], 'submissionid: "199 0"');
- const confirmRevertDialog = element.$.confirmRevertDialog;
+ const confirmRevertDialog = queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
+ );
+ await element.updateComplete;
const revertSingleChangeLabel = queryAndAssert<HTMLLabelElement>(
confirmRevertDialog,
'.revertSingleChange'
@@ -1324,12 +1448,12 @@
'23456:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa...' +
'\n';
assert.equal(confirmRevertDialog.message, expectedMsg);
- const radioInputs = queryAll(
+ const radioInputs = queryAll<HTMLInputElement>(
confirmRevertDialog,
'input[name="revertOptions"]'
);
- tap(radioInputs[0]);
- await flush();
+ radioInputs[0].click();
+ await element.updateComplete;
expectedMsg =
'Revert "random commit message"\n\nThis reverts ' +
'commit 2000.\n\nReason' +
@@ -1338,33 +1462,43 @@
});
test('submit fails if message is not edited', async () => {
- const revertButton = queryAndAssert(
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="revert"]'
+ ).click();
+ const confirmRevertDialog = queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
);
- const confirmRevertDialog = element.$.confirmRevertDialog;
- tap(revertButton);
const fireStub = sinon.stub(confirmRevertDialog, 'dispatchEvent');
- await flush();
- const confirmButton = queryAndAssert(
- queryAndAssert(element.$.confirmRevertDialog, 'gr-dialog'),
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
+ queryAndAssert(
+ queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
+ ),
+ 'gr-dialog'
+ ),
'#confirm'
- );
- tap(confirmButton);
- await flush();
+ ).click();
+ await element.updateComplete;
assert.isTrue(confirmRevertDialog.showErrorMessage);
assert.isFalse(fireStub.called);
});
test('message modification is retained on switching', async () => {
- const revertButton = queryAndAssert(
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="revert"]'
+ ).click();
+ await element.updateComplete;
+ const confirmRevertDialog = queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
);
- const confirmRevertDialog = element.$.confirmRevertDialog;
- tap(revertButton);
- await flush();
- const radioInputs = queryAll(
+ await element.updateComplete;
+ const radioInputs = queryAll<HTMLInputElement>(
confirmRevertDialog,
'input[name="revertOptions"]'
);
@@ -1387,25 +1521,35 @@
const newRevertMsg = revertSubmissionMsg + 'random';
const newSingleChangeMsg = singleChangeMsg + 'random';
confirmRevertDialog.message = newRevertMsg;
- tap(radioInputs[0]);
- await flush();
+ await element.updateComplete;
+ radioInputs[0].click();
+ await element.updateComplete;
assert.equal(confirmRevertDialog.message, singleChangeMsg);
confirmRevertDialog.message = newSingleChangeMsg;
- tap(radioInputs[1]);
- await flush();
+ await element.updateComplete;
+ radioInputs[1].click();
+ await element.updateComplete;
assert.equal(confirmRevertDialog.message, newRevertMsg);
- tap(radioInputs[0]);
- await flush();
+ radioInputs[0].click();
+ await element.updateComplete;
assert.equal(confirmRevertDialog.message, newSingleChangeMsg);
});
});
suite('revert single change', () => {
- setup(() => {
+ setup(async () => {
element.change = {
...createChangeViewChange(),
submission_id: '199' as ChangeSubmissionId,
current_revision: '2000' as CommitId,
+ actions: {
+ revert: {
+ method: HttpMethod.POST,
+ label: 'Revert',
+ title: 'Revert the change',
+ enabled: true,
+ },
+ },
};
stubRestApi('getChanges').returns(
Promise.resolve([
@@ -1417,35 +1561,45 @@
},
])
);
+ await element.updateComplete;
});
test('submit fails if message is not edited', async () => {
- const revertButton = queryAndAssert(
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="revert"]'
+ ).click();
+ const confirmRevertDialog = queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
);
- const confirmRevertDialog = element.$.confirmRevertDialog;
- tap(revertButton);
const fireStub = sinon.stub(confirmRevertDialog, 'dispatchEvent');
- await flush();
- const confirmButton = queryAndAssert(
- queryAndAssert(element.$.confirmRevertDialog, 'gr-dialog'),
+ await element.updateComplete;
+ queryAndAssert<GrButton>(
+ queryAndAssert(
+ queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
+ ),
+ 'gr-dialog'
+ ),
'#confirm'
- );
- tap(confirmButton);
- await flush();
+ ).click();
+ await element.updateComplete;
assert.isTrue(confirmRevertDialog.showErrorMessage);
assert.isFalse(fireStub.called);
});
test('confirm revert dialog shows no radio button', async () => {
- const revertButton = queryAndAssert(
+ queryAndAssert<GrButton>(
element,
'gr-button[data-action-key="revert"]'
+ ).click();
+ await element.updateComplete;
+ const confirmRevertDialog = queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
);
- tap(revertButton);
- await flush();
- const confirmRevertDialog = element.$.confirmRevertDialog;
const radioInputs = queryAll(
confirmRevertDialog,
'input[name="revertOptions"]'
@@ -1458,12 +1612,18 @@
assert.equal(confirmRevertDialog.message, msg);
let editedMsg = msg + 'hello';
confirmRevertDialog.message += 'hello';
- const confirmButton = queryAndAssert(
- queryAndAssert(element.$.confirmRevertDialog, 'gr-dialog'),
+ const confirmButton = queryAndAssert<GrButton>(
+ queryAndAssert(
+ queryAndAssert<GrConfirmRevertDialog>(
+ element,
+ '#confirmRevertDialog'
+ ),
+ 'gr-dialog'
+ ),
'#confirm'
);
- tap(confirmButton);
- await flush();
+ confirmButton.click();
+ await element.updateComplete;
// Contains generic template reason so doesn't submit
assert.isFalse(fireActionStub.called);
confirmRevertDialog.message = confirmRevertDialog.message.replace(
@@ -1471,8 +1631,8 @@
''
);
editedMsg = editedMsg.replace('<INSERT REASONING HERE>', '');
- tap(confirmButton);
- await flush();
+ confirmButton.click();
+ await element.updateComplete;
assert.equal(fireActionStub.getCall(0).args[0], '/revert');
assert.equal(fireActionStub.getCall(0).args[1].__key, 'revert');
assert.equal(fireActionStub.getCall(0).args[3].message, editedMsg);
@@ -1481,7 +1641,7 @@
});
suite('mark change private', () => {
- setup(() => {
+ setup(async () => {
const privateAction = {
__key: 'private',
__type: 'change',
@@ -1501,34 +1661,41 @@
element.changeNum = 2 as NumericChangeId;
element.latestPatchNum = 2 as PatchSetNum;
- return element.reload();
+ await element.updateComplete;
+ await element.reload();
});
test(
'make sure the mark private change button is not outside of the ' +
'overflow menu',
async () => {
- await flush();
+ await element.updateComplete;
assert.isNotOk(query(element, '[data-action-key="private"]'));
}
);
test('private change', async () => {
- await flush();
+ await element.updateComplete;
assert.isOk(
- query(element.$.moreActions, 'span[data-id="private-change"]')
+ query(
+ queryAndAssert<GrDropdown>(element, '#moreActions'),
+ 'span[data-id="private-change"]'
+ )
);
element.setActionOverflow(ActionType.CHANGE, 'private', false);
- await flush();
+ await element.updateComplete;
assert.isOk(query(element, '[data-action-key="private"]'));
assert.isNotOk(
- query(element.$.moreActions, 'span[data-id="private-change"]')
+ query(
+ queryAndAssert<GrDropdown>(element, '#moreActions'),
+ 'span[data-id="private-change"]'
+ )
);
});
});
suite('unmark private change', () => {
- setup(() => {
+ setup(async () => {
const unmarkPrivateAction = {
__key: 'private.delete',
__type: 'change',
@@ -1548,28 +1715,35 @@
element.changeNum = 2 as NumericChangeId;
element.latestPatchNum = 2 as PatchSetNum;
- return element.reload();
+ await element.updateComplete;
+ await element.reload();
});
test(
'make sure the unmark private change button is not outside of the ' +
'overflow menu',
async () => {
- await flush();
+ await element.updateComplete;
assert.isNotOk(query(element, '[data-action-key="private.delete"]'));
}
);
test('unmark the private change', async () => {
- await flush();
+ await element.updateComplete;
assert.isOk(
- query(element.$.moreActions, 'span[data-id="private.delete-change"]')
+ query(
+ queryAndAssert<GrDropdown>(element, '#moreActions'),
+ 'span[data-id="private.delete-change"]'
+ )
);
element.setActionOverflow(ActionType.CHANGE, 'private.delete', false);
- await flush();
+ await element.updateComplete;
assert.isOk(query(element, '[data-action-key="private.delete"]'));
assert.isNotOk(
- query(element.$.moreActions, 'span[data-id="private.delete-change"]')
+ query(
+ queryAndAssert<GrDropdown>(element, '#moreActions'),
+ 'span[data-id="private.delete-change"]'
+ )
);
});
});
@@ -1578,52 +1752,49 @@
let fireActionStub: sinon.SinonStub;
let deleteAction: ActionInfo;
- setup(() => {
- fireActionStub = sinon.stub(element, '_fireAction');
- element.change = {
- ...createChangeViewChange(),
- current_revision: 'abc1234' as CommitId,
- };
+ setup(async () => {
+ fireActionStub = sinon.stub(element, 'fireAction');
deleteAction = {
method: HttpMethod.DELETE,
label: 'Delete Change',
title: 'Delete change X_X',
enabled: true,
};
- element.actions = {
- '/': deleteAction,
+ element.change = {
+ ...createChangeViewChange(),
+ current_revision: 'abc1234' as CommitId,
+ actions: {
+ '/': deleteAction,
+ },
};
+ await element.updateComplete;
});
test('does not delete on action', () => {
- element._handleDeleteTap();
+ element.handleDeleteTap();
assert.isFalse(fireActionStub.called);
});
test('shows confirm dialog', async () => {
- element._handleDeleteTap();
+ element.handleDeleteTap();
assert.isFalse(
queryAndAssert<GrDialog>(element, '#confirmDeleteDialog').hidden
);
- tap(
- queryAndAssert(
- queryAndAssert(element, '#confirmDeleteDialog'),
- 'gr-button[primary]'
- )
- );
- await flush();
+ queryAndAssert<GrButton>(
+ queryAndAssert(element, '#confirmDeleteDialog'),
+ 'gr-button[primary]'
+ ).click();
+ await element.updateComplete;
assert.isTrue(fireActionStub.calledWith('/', deleteAction, false));
});
test('hides delete confirm on cancel', async () => {
- element._handleDeleteTap();
- tap(
- queryAndAssert(
- queryAndAssert(element, '#confirmDeleteDialog'),
- 'gr-button:not([primary])'
- )
- );
- await flush();
+ element.handleDeleteTap();
+ queryAndAssert<GrButton>(
+ queryAndAssert(element, '#confirmDeleteDialog'),
+ 'gr-button:not([primary])'
+ ).click();
+ await element.updateComplete;
assert.isTrue(
queryAndAssert<GrDialog>(element, '#confirmDeleteDialog').hidden
);
@@ -1649,7 +1820,7 @@
foo: ['-1', ' 0', '+1'],
},
};
- await flush();
+ await element.updateComplete;
});
test('added when can approve', () => {
@@ -1670,7 +1841,7 @@
// Assert approve button gets removed from list of buttons.
element.hideQuickApproveAction();
- await flush();
+ await element.updateComplete;
const approveButtonUpdated = query(
element,
"gr-button[data-action-key='review']"
@@ -1680,8 +1851,10 @@
});
test('is first in list of secondary actions', () => {
- const approveButton =
- element.$.secondaryActions.querySelector('gr-button');
+ const approveButton = queryAndAssert<HTMLElement>(
+ element,
+ '#secondaryActions'
+ ).querySelector('gr-button');
assert.equal(approveButton!.getAttribute('data-label'), 'foo+1');
});
@@ -1691,7 +1864,7 @@
status: ChangeStatus.MERGED,
};
- await flush();
+ await element.updateComplete;
const approveButton = query(
element,
"gr-button[data-action-key='review']"
@@ -1713,7 +1886,7 @@
foo: [' 0', '+1'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = query(
element,
"gr-button[data-action-key='review']"
@@ -1732,7 +1905,7 @@
bar: [],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = query(
element,
"gr-button[data-action-key='review']"
@@ -1758,7 +1931,7 @@
'Code-Review': ['-1', ' 0', '+1'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = query(
element,
"gr-button[data-action-key='review']"
@@ -1767,9 +1940,12 @@
});
test('approves when tapped', async () => {
- const fireActionStub = sinon.stub(element, '_fireAction');
- tap(queryAndAssert(element, "gr-button[data-action-key='review']"));
- await flush();
+ const fireActionStub = sinon.stub(element, 'fireAction');
+ queryAndAssert<GrButton>(
+ element,
+ "gr-button[data-action-key='review']"
+ ).click();
+ await element.updateComplete;
assert.isTrue(fireActionStub.called);
assert.isTrue(fireActionStub.calledWith('/review'));
const payload = fireActionStub.lastCall.args[3];
@@ -1789,7 +1965,7 @@
bar: [' 0', '+1', '+2'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = query(
element,
"gr-button[data-action-key='review']"
@@ -1819,7 +1995,7 @@
'Code-Review': [' 0', '+1', '+2'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = queryAndAssert(
element,
"gr-button[data-action-key='review']"
@@ -1845,7 +2021,7 @@
bar: [' 0', '+1', '+2'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = queryAndAssert(
element,
"gr-button[data-action-key='review']"
@@ -1871,7 +2047,7 @@
bar: [' 0', '+1'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = query(
element,
"gr-button[data-action-key='review']"
@@ -1897,7 +2073,7 @@
bar: [' 0', '+1', '+2'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = queryAndAssert(
element,
"gr-button[data-action-key='review']"
@@ -1923,8 +2099,8 @@
'Code-Review': [' 0', '+1', '+2'],
},
};
- await flush();
- const approveButton = queryAndAssert(
+ await element.updateComplete;
+ const approveButton = queryAndAssert<GrButton>(
element,
"gr-button[data-action-key='review']"
);
@@ -1956,7 +2132,7 @@
'Code-Review': [' 0', '+1', '+2'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = query(
element,
"gr-button[data-action-key='review']"
@@ -1983,7 +2159,7 @@
'Code-Review': [' 0', '+1', '+2'],
},
};
- await flush();
+ await element.updateComplete;
const approveButton = query(
element,
"gr-button[data-action-key='review']"
@@ -1996,8 +2172,8 @@
const handler = sinon.stub();
element.addEventListener('download-tap', handler);
assert.ok(element.revisionActions.download);
- element._handleDownloadTap();
- await flush();
+ element.handleDownloadTap();
+ await element.updateComplete;
assert.isTrue(handler.called);
});
@@ -2010,26 +2186,26 @@
assert.isFalse(reloadStub.called);
});
- test('_toSentenceCase', () => {
- assert.equal(element._toSentenceCase('blah blah'), 'Blah blah');
- assert.equal(element._toSentenceCase('BLAH BLAH'), 'Blah blah');
- assert.equal(element._toSentenceCase('b'), 'B');
- assert.equal(element._toSentenceCase(''), '');
- assert.equal(element._toSentenceCase('!@#$%^&*()'), '!@#$%^&*()');
+ test('toSentenceCase', () => {
+ assert.equal(element.toSentenceCase('blah blah'), 'Blah blah');
+ assert.equal(element.toSentenceCase('BLAH BLAH'), 'Blah blah');
+ assert.equal(element.toSentenceCase('b'), 'B');
+ assert.equal(element.toSentenceCase(''), '');
+ assert.equal(element.toSentenceCase('!@#$%^&*()'), '!@#$%^&*()');
});
suite('setActionOverflow', () => {
test('move action from overflow', async () => {
assert.isNotOk(query(element, '[data-action-key="cherrypick"]'));
assert.strictEqual(
- element.$.moreActions.items![0].id,
+ queryAndAssert<GrDropdown>(element, '#moreActions').items![0].id,
'cherrypick-revision'
);
element.setActionOverflow(ActionType.REVISION, 'cherrypick', false);
- await flush();
+ await element.updateComplete;
assert.isOk(query(element, '[data-action-key="cherrypick"]'));
assert.notEqual(
- element.$.moreActions.items![0].id,
+ queryAndAssert<GrDropdown>(element, '#moreActions').items![0].id,
'cherrypick-revision'
);
});
@@ -2037,15 +2213,15 @@
test('move action to overflow', async () => {
assert.isOk(query(element, '[data-action-key="submit"]'));
element.setActionOverflow(ActionType.REVISION, 'submit', true);
- await flush();
+ await element.updateComplete;
assert.isNotOk(query(element, '[data-action-key="submit"]'));
assert.strictEqual(
- element.$.moreActions.items![3].id,
+ queryAndAssert<GrDropdown>(element, '#moreActions').items![3].id,
'submit-revision'
);
});
- suite('_waitForChangeReachable', () => {
+ suite('waitForChangeReachable', () => {
let clock: SinonFakeTimers;
setup(() => {
clock = sinon.useFakeTimers();
@@ -2066,13 +2242,13 @@
const tickAndFlush = async (repetitions: number) => {
for (let i = 1; i <= repetitions; i++) {
clock.tick(1000);
- await flush();
+ await element.updateComplete;
}
};
test('succeed', async () => {
stubRestApi('getChange').callsFake(makeGetChange(5));
- const promise = element._waitForChangeReachable(
+ const promise = element.waitForChangeReachable(
123 as NumericChangeId
);
tickAndFlush(5);
@@ -2082,7 +2258,7 @@
test('fail', async () => {
stubRestApi('getChange').callsFake(makeGetChange(6));
- const promise = element._waitForChangeReachable(
+ const promise = element.waitForChangeReachable(
123 as NumericChangeId
);
tickAndFlush(6);
@@ -2092,14 +2268,14 @@
});
});
- suite('_send', () => {
+ suite('send', () => {
let cleanup: sinon.SinonStub;
const payload = {foo: 'bar'};
let onShowError: sinon.SinonStub;
let onShowAlert: sinon.SinonStub;
let getResponseObjectStub: sinon.SinonStub;
- setup(() => {
+ setup(async () => {
cleanup = sinon.stub();
element.changeNum = 42 as NumericChangeId;
element.latestPatchNum = 12 as PatchSetNum;
@@ -2109,6 +2285,7 @@
messages: createChangeMessages(1),
};
element.change._number = 42 as NumericChangeId;
+ await element.updateComplete;
onShowError = sinon.stub();
element.addEventListener('show-error', onShowError);
@@ -2135,7 +2312,7 @@
});
test('change action', async () => {
- await element._send(
+ await element.send(
HttpMethod.DELETE,
payload,
'/endpoint',
@@ -2157,7 +2334,7 @@
});
suite('show revert submission dialog', () => {
- setup(() => {
+ setup(async () => {
element.change!.submission_id = '199' as ChangeSubmissionId;
element.change!.current_revision = '2000' as CommitId;
stubRestApi('getChanges').returns(
@@ -2176,6 +2353,7 @@
},
])
);
+ await element.updateComplete;
});
});
@@ -2192,7 +2370,7 @@
});
test('revert submission single change', async () => {
- await element._send(
+ await element.send(
HttpMethod.POST,
{message: 'Revert submission'},
'/revert_submission',
@@ -2200,7 +2378,7 @@
cleanup,
{} as UIActionInfo
);
- await element._handleResponse(
+ await element.handleResponse(
{
__key: 'revert_submission',
__type: ActionType.CHANGE,
@@ -2224,7 +2402,7 @@
],
})
);
- showActionDialogStub = sinon.stub(element, '_showActionDialog');
+ showActionDialogStub = sinon.stub(element, 'showActionDialog');
navigateToSearchQueryStub = sinon.stub(
GerritNav,
'navigateToSearchQuery'
@@ -2232,7 +2410,7 @@
});
test('revert submission multiple change', async () => {
- await element._send(
+ await element.send(
HttpMethod.POST,
{message: 'Revert submission'},
'/revert_submission',
@@ -2240,7 +2418,7 @@
cleanup,
{} as UIActionInfo
);
- await element._handleResponse(
+ await element.handleResponse(
{
__key: 'revert_submission',
__type: ActionType.CHANGE,
@@ -2254,7 +2432,7 @@
});
test('revision action', async () => {
- await element._send(
+ await element.send(
HttpMethod.DELETE,
payload,
'/endpoint',
@@ -2285,7 +2463,7 @@
const sendStub = stubRestApi('executeChangeAction');
return element
- ._send(
+ .send(
HttpMethod.DELETE,
payload,
'/endpoint',
@@ -2317,10 +2495,10 @@
return Promise.resolve(undefined);
}
);
- const handleErrorStub = sinon.stub(element, '_handleResponseError');
+ const handleErrorStub = sinon.stub(element, 'handleResponseError');
return element
- ._send(
+ .send(
HttpMethod.DELETE,
payload,
'/endpoint',
@@ -2338,12 +2516,12 @@
});
});
- test('_handleAction reports', () => {
- sinon.stub(element, '_fireAction');
- sinon.stub(element, '_handleChangeAction');
+ test('handleAction reports', () => {
+ sinon.stub(element, 'fireAction');
+ sinon.stub(element, 'handleChangeAction');
const reportStub = stubReporting('reportInteraction');
- element._handleAction(ActionType.CHANGE, 'key');
+ element.handleAction(ActionType.CHANGE, 'key');
assert.isTrue(reportStub.called);
assert.equal(reportStub.lastCall.args[0], 'change-key');
});
@@ -2354,7 +2532,7 @@
let changeRevisionActions: ActionNameToActionInfoMap = {};
- setup(() => {
+ setup(async () => {
stubRestApi('getChangeRevisionActions').returns(
Promise.resolve(changeRevisionActions)
);
@@ -2364,7 +2542,9 @@
.stub(getPluginLoader(), 'awaitPluginsLoaded')
.returns(Promise.resolve());
- element = basicFixture.instantiate();
+ element = await fixture<GrChangeActions>(html`
+ <gr-change-actions></gr-change-actions>
+ `);
// getChangeRevisionActions is not called without
// set the following properties
element.change = createChangeViewChange();
@@ -2372,33 +2552,23 @@
element.latestPatchNum = 2 as PatchSetNum;
stubRestApi('getRepoBranches').returns(Promise.resolve([]));
- return element.reload();
+ await element.updateComplete;
+ await element.reload();
});
test('confirmSubmitDialog and confirmRebase properties are changed', () => {
changeRevisionActions = {};
element.reload();
- assert.strictEqual(element.$.confirmSubmitDialog.action, null);
- assert.strictEqual(element.$.confirmRebase.rebaseOnCurrent, null);
- });
-
- test('_computeRebaseOnCurrent', () => {
- const rebaseAction = {
- enabled: true,
- label: 'Rebase',
- method: HttpMethod.POST,
- title: 'Rebase onto tip of branch or parent change',
- };
-
- // When rebase is enabled initially, rebaseOnCurrent should be set to
- // true.
- assert.isTrue(element._computeRebaseOnCurrent(rebaseAction));
-
- rebaseAction.enabled = false;
-
- // When rebase is not enabled initially, rebaseOnCurrent should be set to
- // false.
- assert.isFalse(element._computeRebaseOnCurrent(rebaseAction));
+ assert.strictEqual(
+ queryAndAssert<GrConfirmSubmitDialog>(element, '#confirmSubmitDialog')
+ .action,
+ null
+ );
+ assert.strictEqual(
+ queryAndAssert<GrConfirmRebaseDialog>(element, '#confirmRebase')
+ .rebaseOnCurrent,
+ null
+ );
});
});
});
diff --git a/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata.ts b/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata.ts
index cd51627..2c80a86 100644
--- a/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata.ts
+++ b/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata.ts
@@ -33,21 +33,14 @@
import '../gr-commit-info/gr-commit-info';
import '../gr-reviewer-list/gr-reviewer-list';
import '../../shared/gr-account-list/gr-account-list';
-import {dom, EventApi} from '@polymer/polymer/lib/legacy/polymer.dom';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-change-metadata_html';
-import {
- GrReviewerSuggestionsProvider,
- SUGGESTIONS_PROVIDERS_USERS_TYPES,
-} from '../../../scripts/gr-reviewer-suggestions-provider/gr-reviewer-suggestions-provider';
import {GerritNav} from '../../core/gr-navigation/gr-navigation';
import {
ChangeStatus,
GpgKeyInfoStatus,
+ InheritedBooleanInfoConfiguredValue,
SubmitType,
} from '../../../constants/constants';
import {changeIsOpen, isOwner} from '../../../utils/change-util';
-import {customElement, property, observe} from '@polymer/decorators';
import {
AccountDetailInfo,
AccountInfo,
@@ -56,7 +49,7 @@
ChangeInfo,
CommitId,
CommitInfo,
- ElementPropertyDeepChange,
+ ConfigInfo,
GpgKeyInfo,
Hashtag,
isAccount,
@@ -97,10 +90,17 @@
getCodeReviewLabel,
showNewSubmitRequirements,
} from '../../../utils/label-util';
+import {LitElement, css, html, nothing, PropertyValues} from 'lit';
+import {customElement, property, query, state} from 'lit/decorators';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {fontStyles} from '../../../styles/gr-font-styles';
+import {changeMetadataStyles} from '../../../styles/gr-change-metadata-shared-styles';
+import {when} from 'lit/directives/when';
+import {ifDefined} from 'lit/directives/if-defined';
const HASHTAG_ADD_MESSAGE = 'Add Hashtag';
-enum ChangeRole {
+export enum ChangeRole {
OWNER = 'owner',
UPLOADER = 'uploader',
AUTHOR = 'author',
@@ -129,213 +129,719 @@
message: string;
}
-export interface GrChangeMetadata {
- $: {
- webLinks: HTMLElement;
- };
-}
-
@customElement('gr-change-metadata')
-export class GrChangeMetadata extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrChangeMetadata extends LitElement {
/**
* Fired when the change topic is changed.
*
* @event topic-changed
*/
+ @query('#webLinks') webLinks?: HTMLElement;
- @property({type: Object})
- change?: ParsedChangeInfo;
+ @property({type: Object}) change?: ParsedChangeInfo;
- @property({type: Object})
- revertedChange?: ChangeInfo;
+ @property({type: Object}) revertedChange?: ChangeInfo;
- @property({type: Object, notify: true})
- labels?: LabelNameToInfoMap;
+ @property({type: Object}) account?: AccountDetailInfo;
- @property({type: Object})
- account?: AccountDetailInfo;
+ @property({type: Object}) revision?: RevisionInfo | EditRevisionInfo;
- @property({type: Object})
- revision?: RevisionInfo | EditRevisionInfo;
+ @property({type: Object}) commitInfo?: CommitInfoWithRequiredCommit;
- @property({type: Object})
- commitInfo?: CommitInfoWithRequiredCommit;
+ @property({type: Object}) serverConfig?: ServerInfo;
- @property({type: Boolean, computed: '_computeIsMutable(account)'})
- _mutable = false;
+ @property({type: Boolean}) parentIsCurrent?: boolean;
- @property({type: Object})
- serverConfig?: ServerInfo;
+ @property({type: Object}) repoConfig?: ConfigInfo;
- @property({type: Boolean})
- parentIsCurrent?: boolean;
+ // private but used in test
+ @state() mutable = false;
- @property({type: String})
- readonly _notCurrentMessage = NOT_CURRENT_MESSAGE;
+ @state() private readonly notCurrentMessage = NOT_CURRENT_MESSAGE;
- @property({
- type: Boolean,
- computed: '_computeTopicReadOnly(_mutable, change)',
- })
- _topicReadOnly = true;
+ // private but used in test
+ @state() topicReadOnly = true;
- @property({
- type: Boolean,
- computed: '_computeHashtagReadOnly(_mutable, change)',
- })
- _hashtagReadOnly = true;
+ // private but used in test
+ @state() hashtagReadOnly = true;
- @property({
- type: Object,
- computed: '_computePushCertificateValidation(serverConfig, change)',
- })
- _pushCertificateValidation?: PushCertificateValidationInfo;
+ @state() private pushCertificateValidation?: PushCertificateValidationInfo;
- @property({type: Boolean, computed: '_computeShowRequirements(change)'})
- _showRequirements = false;
+ // private but used in test
+ @state() settingTopic = false;
- @property({type: Boolean, computed: '_computeIsWip(change)'})
- _isWip = false;
+ // private but used in test
+ @state() currentParents: ParentCommitInfo[] = [];
- @property({type: Boolean})
- _settingTopic = false;
+ @state() private showAllSections = false;
- @property({type: Array, computed: '_computeParents(change, revision)'})
- _currentParents: ParentCommitInfo[] = [];
+ @state() private queryTopic?: AutocompleteQuery;
- @property({type: Object})
- _CHANGE_ROLE = ChangeRole;
-
- @property({type: Object})
- _SECTION = Metadata;
-
- @property({type: Boolean})
- _showAllSections = false;
-
- @property({type: Object})
- queryTopic?: AutocompleteQuery;
-
- restApiService = getAppContext().restApiService;
+ private restApiService = getAppContext().restApiService;
private readonly reporting = getAppContext().reportingService;
private readonly flagsService = getAppContext().flagsService;
- override ready() {
- super.ready();
- this.queryTopic = (input: string) => this._getTopicSuggestions(input);
+ constructor() {
+ super();
+ this.queryTopic = (input: string) => this.getTopicSuggestions(input);
}
- @observe('change.labels')
- _labelsChanged(labels?: LabelNameToInfoMap) {
- this.labels = {...labels};
+ static override styles = [
+ sharedStyles,
+ fontStyles,
+ changeMetadataStyles,
+ css`
+ :host {
+ display: table;
+ }
+ gr-change-requirements,
+ gr-submit-requirements {
+ --requirements-horizontal-padding: var(--metadata-horizontal-padding);
+ }
+ gr-editable-label {
+ max-width: 9em;
+ }
+ .webLink {
+ display: block;
+ }
+ gr-account-chip[disabled],
+ gr-linked-chip[disabled] {
+ opacity: 0;
+ pointer-events: none;
+ }
+ .hashtagChip {
+ padding-bottom: var(--spacing-s);
+ }
+ /* consistent with section .title, .value */
+ .hashtagChip:not(last-of-type) {
+ padding-bottom: var(--spacing-s);
+ }
+ .hashtagChip:last-of-type {
+ display: inline;
+ vertical-align: top;
+ }
+ .parentList.merge {
+ list-style-type: decimal;
+ padding-left: var(--spacing-l);
+ }
+ .parentList gr-commit-info {
+ display: inline-block;
+ }
+ .hideDisplay,
+ #parentNotCurrentMessage {
+ display: none;
+ }
+ .icon {
+ margin: -3px 0;
+ }
+ .icon.help,
+ .icon.notTrusted {
+ color: var(--warning-foreground);
+ }
+ .icon.invalid {
+ color: var(--negative-red-text-color);
+ }
+ .icon.trusted {
+ color: var(--positive-green-text-color);
+ }
+ .parentList.notCurrent.nonMerge #parentNotCurrentMessage {
+ --arrow-color: var(--warning-foreground);
+ display: inline-block;
+ }
+ .oldSeparatedSection {
+ margin-top: var(--spacing-l);
+ padding: var(--spacing-m) 0;
+ }
+ .separatedSection {
+ padding: var(--spacing-m) 0;
+ }
+ .hashtag gr-linked-chip,
+ .topic gr-linked-chip {
+ --linked-chip-text-color: var(--link-color);
+ }
+ gr-reviewer-list {
+ --account-max-length: 100px;
+ max-width: 285px;
+ }
+ .metadata-title {
+ color: var(--deemphasized-text-color);
+ padding-left: var(--metadata-horizontal-padding);
+ }
+ .metadata-header {
+ display: flex;
+ justify-content: space-between;
+ align-items: flex-end;
+ /* The goal is to achieve alignment of the owner account chip and the
+ commit message box. Their top border should be on the same line. */
+ margin-bottom: var(--spacing-s);
+ }
+ .show-all-button iron-icon {
+ color: inherit;
+ --iron-icon-height: 18px;
+ --iron-icon-width: 18px;
+ }
+ gr-vote-chip {
+ --gr-vote-chip-width: 14px;
+ --gr-vote-chip-height: 14px;
+ }
+ `,
+ ];
+
+ override render() {
+ if (!this.change) return nothing;
+ return html`<div>
+ <div class="metadata-header">
+ <h3 class="metadata-title heading-3">Change Info</h3>
+ ${this.renderShowAllButton()}
+ </div>
+ ${this.renderSubmitted()} ${this.renderUpdated()} ${this.renderOwner()}
+ ${this.renderNonOwner(ChangeRole.UPLOADER)}
+ ${this.renderNonOwner(ChangeRole.AUTHOR)}
+ ${this.renderNonOwner(ChangeRole.COMMITTER)} ${this.renderReviewers()}
+ ${this.renderCCs()} ${this.renderProjectBranch()} ${this.renderParent()}
+ ${this.renderMergedAs()} ${this.renderShowReverCreatedAs()}
+ ${this.renderTopic()} ${this.renderCherryPickOf()}
+ ${this.renderStrategy()} ${this.renderHashTags()}
+ ${this.renderSubmitRequirements()} ${this.renderWeblinks()}
+ <gr-endpoint-decorator name="change-metadata-item">
+ <gr-endpoint-param
+ name="labels"
+ .value=${{...this.change?.labels}}
+ ></gr-endpoint-param>
+ <gr-endpoint-param
+ name="change"
+ .value=${this.change}
+ ></gr-endpoint-param>
+ <gr-endpoint-param
+ name="revision"
+ .value=${this.revision}
+ ></gr-endpoint-param>
+ </gr-endpoint-decorator>
+ </div>`;
}
- @observe('change')
- _changeChanged(_: ParsedChangeInfo) {
- this._settingTopic = false;
+ private renderShowAllButton() {
+ return html`<gr-button
+ link
+ class="show-all-button"
+ @click=${this.onShowAllClick}
+ >${this.showAllSections ? 'Show less' : 'Show all'}
+ <iron-icon
+ icon="gr-icons:expand-more"
+ ?hidden=${this.showAllSections}
+ ></iron-icon
+ ><iron-icon
+ icon="gr-icons:expand-less"
+ ?hidden=${!this.showAllSections}
+ ></iron-icon>
+ </gr-button>`;
}
- _computeHideStrategy(change?: ParsedChangeInfo) {
- return !changeIsOpen(change);
+ private renderSubmitted() {
+ if (!this.change!.submitted) return nothing;
+ return html`<section class=${this.computeDisplayState(Metadata.SUBMITTED)}>
+ <span class="title">Submitted</span>
+ <span class="value">
+ <gr-date-formatter
+ withTooltip
+ .dateStr=${this.change!.submitted}
+ showYesterday
+ ></gr-date-formatter>
+ </span>
+ </section> `;
+ }
+
+ private renderUpdated() {
+ return html`<section class=${this.computeDisplayState(Metadata.UPDATED)}>
+ <span class="title">
+ <gr-tooltip-content
+ has-tooltip
+ title="Last update of (meta)data for this change."
+ >
+ Updated
+ </gr-tooltip-content>
+ </span>
+ <span class="value">
+ <gr-date-formatter
+ withTooltip
+ .dateStr=${this.change!.updated}
+ showYesterday
+ ></gr-date-formatter>
+ </span>
+ </section>`;
+ }
+
+ private renderOwner() {
+ const change = this.change!;
+ return html`<section class=${this.computeDisplayState(Metadata.OWNER)}>
+ <span class="title">
+ <gr-tooltip-content
+ has-tooltip
+ title="This user created or uploaded the first patchset of this change."
+ >
+ Owner
+ </gr-tooltip-content>
+ </span>
+ <span class="value">
+ <gr-account-chip
+ .account=${change.owner}
+ .change=${change}
+ highlightAttention
+ .vote=${this.computeVote(change.owner)}
+ .label=${this.computeCodeReviewLabel()}
+ >
+ <gr-vote-chip
+ slot="vote-chip"
+ .vote=${this.computeVote(change.owner)}
+ .label=${this.computeCodeReviewLabel()}
+ circle-shape
+ ></gr-vote-chip>
+ </gr-account-chip>
+ ${when(
+ this.pushCertificateValidation,
+ () => html`<gr-tooltip-content
+ has-tooltip
+ title=${this.pushCertificateValidation!.message}
+ >
+ <iron-icon
+ class="icon ${this.pushCertificateValidation!.class}"
+ icon=${this.pushCertificateValidation!.icon}
+ >
+ </iron-icon>
+ </gr-tooltip-content>`
+ )}
+ </span>
+ </section>`;
+ }
+
+ renderNonOwner(role: ChangeRole) {
+ if (!this.getNonOwnerRole(role)) return nothing;
+ let title = '';
+ let name = '';
+ if (role === ChangeRole.UPLOADER) {
+ title =
+ "This user uploaded the patchset to Gerrit (typically by running the 'git push' command).";
+ name = 'Uploader';
+ } else if (role === ChangeRole.AUTHOR) {
+ title = 'This user wrote the code change.';
+ name = 'Author';
+ } else if (role === ChangeRole.COMMITTER) {
+ title =
+ 'This user committed the code change to the Git repository (typically to the local Git repo before uploading).';
+ name = 'Committer';
+ }
+ return html`<section>
+ <span class="title">
+ <gr-tooltip-content has-tooltip .title=${title}>
+ ${name}
+ </gr-tooltip-content>
+ </span>
+ <span class="value">
+ <gr-account-chip
+ .account=${this.getNonOwnerRole(role)}
+ .change=${this.change}
+ ?highlightAttention=${role === ChangeRole.UPLOADER}
+ .vote=${this.computeVoteForRole(role)}
+ .label=${this.computeCodeReviewLabel()}
+ >
+ <gr-vote-chip
+ slot="vote-chip"
+ .vote=${this.computeVoteForRole(role)}
+ .label=${this.computeCodeReviewLabel()}
+ circle-shape
+ ></gr-vote-chip>
+ </gr-account-chip>
+ </span>
+ </section>`;
+ }
+
+ private renderReviewers() {
+ return html`<section class=${this.computeDisplayState(Metadata.REVIEWERS)}>
+ <span class="title">Reviewers</span>
+ <span class="value">
+ <gr-reviewer-list
+ .change=${this.change}
+ ?mutable=${this.mutable}
+ reviewers-only
+ .account=${this.account}
+ ></gr-reviewer-list>
+ </span>
+ </section>`;
+ }
+
+ private renderCCs() {
+ return html`<section class=${this.computeDisplayState(Metadata.CC)}>
+ <span class="title">CC</span>
+ <span class="value">
+ <gr-reviewer-list
+ .change=${this.change}
+ ?mutable=${this.mutable}
+ ccs-only
+ .account=${this.account}
+ ></gr-reviewer-list>
+ </span>
+ </section>`;
+ }
+
+ private renderProjectBranch() {
+ const change = this.change!;
+ return when(
+ this.computeShowRepoBranchTogether(),
+ () =>
+ html`<section class=${this.computeDisplayState(Metadata.REPO_BRANCH)}>
+ <span class="title">Repo | Branch</span>
+ <span class="value">
+ <a href=${this.computeProjectUrl(change.project)}
+ >${change.project}</a
+ >
+ |
+ <a href=${this.computeBranchUrl(change.project, change.branch)}
+ >${change.branch}</a
+ >
+ </span>
+ </section>`,
+
+ () => html` <section
+ class=${this.computeDisplayState(Metadata.REPO_BRANCH)}
+ >
+ <span class="title">Repo</span>
+ <span class="value">
+ <a href=${this.computeProjectUrl(change.project)}>
+ <gr-limited-text
+ limit="40"
+ .text=${change.project}
+ ></gr-limited-text>
+ </a>
+ </span>
+ </section>
+ <section class=${this.computeDisplayState(Metadata.REPO_BRANCH)}>
+ <span class="title">Branch</span>
+ <span class="value">
+ <a href=${this.computeBranchUrl(change.project, change.branch)}>
+ <gr-limited-text
+ limit="40"
+ .text=${change.branch}
+ ></gr-limited-text>
+ </a>
+ </span>
+ </section>`
+ );
+ }
+
+ private renderParent() {
+ return html`<section class=${this.computeDisplayState(Metadata.PARENT)}>
+ <span class="title"
+ >${this.currentParents.length > 1 ? 'Parents' : 'Parent'}</span
+ >
+ <span class="value">
+ <ol class=${this.computeParentListClass()}>
+ ${this.currentParents.map(
+ parent => html` <li>
+ <gr-commit-info
+ .change=${this.change}
+ .commitInfo=${parent}
+ .serverConfig=${this.serverConfig}
+ ></gr-commit-info>
+ <gr-tooltip-content
+ id="parentNotCurrentMessage"
+ has-tooltip
+ show-icon
+ .title=${this.notCurrentMessage}
+ ></gr-tooltip-content>
+ </li>`
+ )}
+ </ol>
+ </span>
+ </section>`;
+ }
+
+ private renderMergedAs() {
+ const changeMerged = this.change?.status === ChangeStatus.MERGED;
+ if (!changeMerged) return nothing;
+ return html`<section class=${this.computeDisplayState(Metadata.MERGED_AS)}>
+ <span class="title">Merged As</span>
+ <span class="value">
+ <gr-commit-info
+ .change=${this.change}
+ .commitInfo=${this.computeMergedCommitInfo(
+ this.change?.current_revision,
+ this.change?.revisions
+ )}
+ .serverConfig=${this.serverConfig}
+ ></gr-commit-info>
+ </span>
+ </section>`;
+ }
+
+ private renderShowReverCreatedAs() {
+ if (!this.showRevertCreatedAs()) return nothing;
+
+ return html`<section
+ class=${this.computeDisplayState(Metadata.REVERT_CREATED_AS)}
+ >
+ <span class="title">${this.getRevertSectionTitle()}</span>
+ <span class="value">
+ <gr-commit-info
+ .change=${this.change}
+ .commitInfo=${this.computeRevertCommit()}
+ .serverConfig=${this.serverConfig}
+ ></gr-commit-info>
+ </span>
+ </section>`;
+ }
+
+ private renderTopic() {
+ const showTopic = this.change?.topic || !this.topicReadOnly;
+ if (!showTopic) return nothing;
+
+ return html`<section
+ class="topic ${this.computeDisplayState(Metadata.TOPIC, this.account)}"
+ >
+ <span class="title">Topic</span>
+ <span class="value">
+ ${when(
+ this.showTopicChip(),
+ () => html` <gr-linked-chip
+ .text=${this.change?.topic}
+ limit="40"
+ href=${GerritNav.getUrlForTopic(this.change!.topic!)}
+ ?removable=${!this.topicReadOnly}
+ @remove=${this.handleTopicRemoved}
+ ></gr-linked-chip>`
+ )}
+ ${when(
+ this.showAddTopic(),
+ () =>
+ html` <gr-editable-label
+ class="topicEditableLabel"
+ labelText="Add a topic"
+ .value=${this.change?.topic}
+ maxLength="1024"
+ .placeholder=${this.computeTopicPlaceholder()}
+ ?readOnly=${this.topicReadOnly}
+ @changed=${this.handleTopicChanged}
+ showAsEditPencil
+ autocomplete
+ .query=${this.queryTopic}
+ ></gr-editable-label>`
+ )}
+ </span>
+ </section>`;
+ }
+
+ private renderCherryPickOf() {
+ if (!this.showCherryPickOf()) return nothing;
+ return html` <section
+ class=${this.computeDisplayState(Metadata.CHERRY_PICK_OF)}
+ >
+ <span class="title">Cherry pick of</span>
+ <span class="value">
+ <a
+ href=${this.computeCherryPickOfUrl(
+ this.change?.cherry_pick_of_change,
+ this.change?.cherry_pick_of_patch_set,
+ this.change?.project
+ )}
+ >
+ <gr-limited-text
+ text="${this.change?.cherry_pick_of_change},${this.change
+ ?.cherry_pick_of_patch_set}"
+ limit="40"
+ >
+ </gr-limited-text>
+ </a>
+ </span>
+ </section>`;
+ }
+
+ private renderStrategy() {
+ if (!changeIsOpen(this.change)) return nothing;
+ return html`<section
+ class="strategy ${this.computeDisplayState(Metadata.STRATEGY)}"
+ >
+ <span class="title">Strategy</span>
+ <span class="value">${this.computeStrategy()}</span>
+ </section>`;
+ }
+
+ private renderHashTags() {
+ return html`<section
+ class="hashtag ${this.computeDisplayState(Metadata.HASHTAGS)}"
+ >
+ <span class="title">Hashtags</span>
+ <span class="value">
+ ${(this.change?.hashtags ?? []).map(
+ hashtag => html`<gr-linked-chip
+ class="hashtagChip"
+ .text=${hashtag}
+ href=${this.computeHashtagUrl(hashtag)}
+ ?removable=${!this.hashtagReadOnly}
+ @remove=${this.handleHashtagRemoved}
+ limit="40"
+ >
+ </gr-linked-chip>`
+ )}
+ ${when(
+ !this.hashtagReadOnly,
+ () => html`
+ <gr-editable-label
+ uppercase
+ labelText="Add a hashtag"
+ .placeholder=${this.computeHashtagPlaceholder()}
+ .readOnly=${this.hashtagReadOnly}
+ @changed=${this.handleHashtagChanged}
+ showAsEditPencil
+ ></gr-editable-label>
+ `
+ )}
+ </span>
+ </section>`;
+ }
+
+ private renderSubmitRequirements() {
+ if (this.showNewSubmitRequirements()) {
+ return html`<div class="separatedSection">
+ <gr-submit-requirements
+ .change=${this.change}
+ .account=${this.account}
+ .mutable=${this.mutable}
+ ></gr-submit-requirements>
+ </div>`;
+ } else {
+ return html` <div class="oldSeparatedSection">
+ <gr-change-requirements
+ .change=${this.change}
+ .account=${this.account}
+ .mutable=${this.mutable}
+ ></gr-change-requirements>
+ </div>`;
+ }
+ }
+
+ private renderWeblinks() {
+ const webLinks = this.computeWebLinks();
+ if (!webLinks.length) return nothing;
+ return html`<section id="webLinks">
+ <span class="title">Links</span>
+ <span class="value">
+ ${webLinks.map(
+ link => html`<a
+ href=${ifDefined(link.url)}
+ class="webLink"
+ rel="noopener"
+ target="_blank"
+ >
+ ${link.name}
+ </a>`
+ )}
+ </span>
+ </section>`;
+ }
+
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('account')) {
+ this.mutable = this.computeIsMutable();
+ }
+ if (changedProperties.has('mutable') || changedProperties.has('change')) {
+ this.topicReadOnly = this.computeTopicReadOnly();
+ this.hashtagReadOnly = this.computeHashtagReadOnly();
+ }
+ if (changedProperties.has('change')) {
+ this.settingTopic = false;
+ }
+ if (
+ changedProperties.has('serverConfig') ||
+ changedProperties.has('change') ||
+ changedProperties.has('repoConfig')
+ ) {
+ this.pushCertificateValidation = this.computePushCertificateValidation();
+ }
+ if (changedProperties.has('revision') || changedProperties.has('change')) {
+ this.currentParents = this.computeParents();
+ }
}
/**
* @return If array is empty, returns undefined instead so
* an existential check can be used to hide or show the webLinks
* section.
+ * private but used in test
*/
- _computeWebLinks(
- commitInfo?: CommitInfoWithRequiredCommit,
- serverConfig?: ServerInfo
- ) {
- if (!commitInfo) return undefined;
+ computeWebLinks() {
+ if (!this.commitInfo) return [];
const weblinks = GerritNav.getChangeWeblinks(
this.change ? this.change.project : ('' as RepoName),
- commitInfo.commit,
+ this.commitInfo.commit,
{
- weblinks: commitInfo.web_links,
- config: serverConfig,
+ weblinks: this.commitInfo.web_links,
+ config: this.serverConfig,
}
);
- return weblinks.length ? weblinks : undefined;
+ return weblinks.length ? weblinks : [];
}
- _isChangeMerged(change?: ParsedChangeInfo) {
- return change?.status === ChangeStatus.MERGED;
- }
-
- _computeStrategy(change?: ParsedChangeInfo) {
- if (!change?.submit_type) {
+ private computeStrategy() {
+ if (!this.change?.submit_type) {
return '';
}
- return SubmitTypeLabel.get(change.submit_type);
+ return SubmitTypeLabel.get(this.change.submit_type);
}
- _computeLabelNames(labels?: LabelNameToInfoMap) {
+ // private but used in test
+ computeLabelNames(labels?: LabelNameToInfoMap) {
return labels ? Object.keys(labels).sort() : [];
}
- _handleTopicChanged(e: CustomEvent<string>) {
+ // private but used in test
+ handleTopicChanged(e: CustomEvent<string>) {
if (!this.change) {
throw new Error('change must be set');
}
const lastTopic = this.change.topic;
const topic = e.detail.length ? e.detail : undefined;
- this._settingTopic = true;
+ this.settingTopic = true;
const topicChangedForChangeNumber = this.change._number;
+ const change = this.change;
this.restApiService
.setChangeTopic(topicChangedForChangeNumber, topic)
.then(newTopic => {
if (this.change?._number !== topicChangedForChangeNumber) return;
- this._settingTopic = false;
- this.set(['change', 'topic'], newTopic);
+ this.settingTopic = false;
+ if (this.change === change) {
+ this.change.topic = newTopic as TopicName;
+ this.requestUpdate();
+ }
if (newTopic !== lastTopic) {
fireEvent(this, 'topic-changed');
}
});
}
- _showAddTopic(
- changeRecord?: ElementPropertyDeepChange<GrChangeMetadata, 'change'>,
- settingTopic?: boolean,
- topicReadOnly?: boolean
- ) {
- const hasTopic = !!changeRecord?.base?.topic;
- return !hasTopic && !settingTopic && topicReadOnly === false;
+ // private but used in test
+ showAddTopic() {
+ const hasTopic = !!this.change?.topic;
+ return !hasTopic && !this.settingTopic && this.topicReadOnly === false;
}
- _showTopic(
- changeRecord?: ElementPropertyDeepChange<GrChangeMetadata, 'change'>,
- topicReadOnly?: boolean
- ) {
- const hasTopic = !!changeRecord?.base?.topic;
- return hasTopic || !topicReadOnly;
+ // private but used in test
+ showTopicChip() {
+ const hasTopic = !!this.change?.topic;
+ return hasTopic && !this.settingTopic;
}
- _showTopicChip(
- changeRecord?: ElementPropertyDeepChange<GrChangeMetadata, 'change'>,
- settingTopic?: boolean
- ) {
- const hasTopic = !!changeRecord?.base?.topic;
- return hasTopic && !settingTopic;
- }
-
- _showCherryPickOf(
- changeRecord?: ElementPropertyDeepChange<GrChangeMetadata, 'change'>
- ) {
+ // private but used in test
+ showCherryPickOf() {
const hasCherryPickOf =
- !!changeRecord?.base?.cherry_pick_of_change &&
- !!changeRecord?.base?.cherry_pick_of_patch_set;
+ !!this.change?.cherry_pick_of_change &&
+ !!this.change?.cherry_pick_of_patch_set;
return hasCherryPickOf;
}
- _handleHashtagChanged(e: CustomEvent<string>) {
+ // private but used in test
+ handleHashtagChanged(e: CustomEvent<string>) {
if (!this.change) {
throw new Error('change must be set');
}
@@ -343,57 +849,53 @@
if (!newHashtag?.length) {
return;
}
+ const change = this.change;
this.restApiService
.setChangeHashtag(this.change._number, {add: [newHashtag as Hashtag]})
.then(newHashtag => {
- this.set(['change', 'hashtags'], newHashtag);
- fireEvent(this, 'hashtag-changed');
+ if (this.change === change) {
+ this.change.hashtags = newHashtag;
+ this.requestUpdate();
+ fireEvent(this, 'hashtag-changed');
+ }
});
}
- _computeTopicReadOnly(mutable?: boolean, change?: ParsedChangeInfo) {
- return !mutable || !change?.actions?.topic?.enabled;
+ // private but used in test
+ computeTopicReadOnly() {
+ return !this.mutable || !this.change?.actions?.topic?.enabled;
}
- _computeHashtagReadOnly(mutable?: boolean, change?: ParsedChangeInfo) {
- return !mutable || !change?.actions?.hashtags?.enabled;
+ // private but used in test
+ computeHashtagReadOnly() {
+ return !this.mutable || !this.change?.actions?.hashtags?.enabled;
}
- _computeTopicPlaceholder(_topicReadOnly?: boolean) {
+ private computeTopicPlaceholder() {
// Action items in Material Design are uppercase -- placeholder label text
// is sentence case.
- return _topicReadOnly ? 'No topic' : 'ADD TOPIC';
+ return this.topicReadOnly ? 'No topic' : 'ADD TOPIC';
}
- _computeHashtagPlaceholder(_hashtagReadOnly?: boolean) {
- return _hashtagReadOnly ? '' : HASHTAG_ADD_MESSAGE;
- }
-
- _computeShowRequirements(change?: ParsedChangeInfo) {
- if (!change) {
- return false;
- }
- if (change.status !== ChangeStatus.NEW) {
- // TODO(maximeg) change this to display the stored
- // requirements, once it is implemented server-side.
- return false;
- }
- const hasRequirements =
- !!change.requirements && Object.keys(change.requirements).length > 0;
- const hasLabels = !!change.labels && Object.keys(change.labels).length > 0;
- return hasRequirements || hasLabels || !!change.work_in_progress;
+ private computeHashtagPlaceholder() {
+ return this.hashtagReadOnly ? '' : HASHTAG_ADD_MESSAGE;
}
/**
+ * private but used in test
+ *
* @return object representing data for the push validation.
*/
- _computePushCertificateValidation(
- serverConfig?: ServerInfo,
- change?: ParsedChangeInfo
- ): PushCertificateValidationInfo | undefined {
- if (!change || !serverConfig?.receive?.enable_signed_push) return undefined;
+ computePushCertificateValidation():
+ | PushCertificateValidationInfo
+ | undefined {
+ if (!this.change || !this.serverConfig?.receive?.enable_signed_push)
+ return undefined;
- const rev = change.revisions[change.current_revision];
+ if (!this.isEnabledSignedPushOnRepo()) {
+ return undefined;
+ }
+ const rev = this.change.revisions[this.change.current_revision];
if (!rev.push_certificate?.key) {
return {
class: 'help',
@@ -408,13 +910,13 @@
return {
class: 'invalid',
icon: 'gr-icons:close',
- message: this._problems('Push certificate is invalid', key),
+ message: this.problems('Push certificate is invalid', key),
};
case GpgKeyInfoStatus.OK:
return {
class: 'notTrusted',
icon: 'gr-icons:info',
- message: this._problems(
+ message: this.problems(
'Push certificate is valid, but key is not trusted',
key
),
@@ -423,7 +925,7 @@
return {
class: 'trusted',
icon: 'gr-icons:check',
- message: this._problems(
+ message: this.problems(
'Push certificate is valid and key is trusted',
key
),
@@ -436,7 +938,21 @@
}
}
- _problems(msg: string, key: GpgKeyInfo) {
+ // private but used in test
+ isEnabledSignedPushOnRepo() {
+ if (!this.repoConfig?.enable_signed_push) return false;
+
+ const enableSignedPush = this.repoConfig.enable_signed_push;
+ return (
+ (enableSignedPush.configured_value ===
+ InheritedBooleanInfoConfiguredValue.INHERIT &&
+ enableSignedPush.inherited_value) ||
+ enableSignedPush.configured_value ===
+ InheritedBooleanInfoConfiguredValue.TRUE
+ );
+ }
+
+ private problems(msg: string, key: GpgKeyInfo) {
if (!key?.problems || key.problems.length === 0) {
return msg;
}
@@ -444,16 +960,17 @@
return [msg + ':'].concat(key.problems).join('\n');
}
- _computeShowRepoBranchTogether(repo?: RepoName, branch?: BranchName) {
- return !!repo && !!branch && repo.length + branch.length < 40;
+ private computeShowRepoBranchTogether() {
+ const {project, branch} = this.change!;
+ return !!project && !!branch && project.length + branch.length < 40;
}
- _computeProjectUrl(project?: RepoName) {
+ private computeProjectUrl(project?: RepoName) {
if (!project) return '';
return GerritNav.getUrlForProjectChanges(project);
}
- _computeBranchUrl(project?: RepoName, branch?: BranchName) {
+ private computeBranchUrl(project?: RepoName, branch?: BranchName) {
if (!project || !branch || !this.change || !this.change.status) return '';
return GerritNav.getUrlForBranch(
branch,
@@ -464,7 +981,7 @@
);
}
- _computeCherryPickOfUrl(
+ private computeCherryPickOfUrl(
change?: NumericChangeId,
patchset?: PatchSetNum,
project?: RepoName
@@ -475,70 +992,62 @@
return GerritNav.getUrlForChangeById(change, project, patchset);
}
- _computeTopicUrl(topic: TopicName) {
- return GerritNav.getUrlForTopic(topic);
- }
-
- _computeHashtagUrl(hashtag: Hashtag) {
+ private computeHashtagUrl(hashtag: Hashtag) {
return GerritNav.getUrlForHashtag(hashtag);
}
- _handleTopicRemoved(e: CustomEvent) {
+ private handleTopicRemoved(e: CustomEvent) {
if (!this.change) {
throw new Error('change must be set');
}
const target = e.composedPath()[0] as GrLinkedChip;
target.disabled = true;
+ const change = this.change;
this.restApiService
.setChangeTopic(this.change._number)
.then(() => {
target.disabled = false;
- this.set(['change', 'topic'], '');
- fireEvent(this, 'topic-changed');
+ if (this.change === change) {
+ this.change.topic = '' as TopicName;
+ this.requestUpdate();
+ fireEvent(this, 'topic-changed');
+ }
})
.catch(() => {
target.disabled = false;
});
}
- _handleHashtagRemoved(e: CustomEvent) {
+ // private but used in test
+ handleHashtagRemoved(e: CustomEvent) {
e.preventDefault();
if (!this.change) {
throw new Error('change must be set');
}
- const target = (dom(e) as EventApi).rootTarget as GrLinkedChip;
+ const target = e.target as GrLinkedChip;
target.disabled = true;
+ const change = this.change;
this.restApiService
- .setChangeHashtag(this.change._number, {remove: [target.text as Hashtag]})
+ .setChangeHashtag(change._number, {remove: [target.text as Hashtag]})
.then(newHashtags => {
target.disabled = false;
- this.set(['change', 'hashtags'], newHashtags);
+ if (this.change === change) {
+ this.change.hashtags = newHashtags;
+ this.requestUpdate();
+ }
})
.catch(() => {
target.disabled = false;
});
}
- _computeIsWip(change?: ParsedChangeInfo) {
- return !!change?.work_in_progress;
- }
-
- _computeShowRoleClass(change?: ParsedChangeInfo, role?: ChangeRole) {
- return this._getNonOwnerRole(change, role) ? '' : 'hideDisplay';
- }
-
- _computeDisplayState(
- showAllSections: boolean,
- change: ParsedChangeInfo | undefined,
- section: Metadata,
- account?: AccountDetailInfo
- ) {
+ private computeDisplayState(section: Metadata, account?: AccountDetailInfo) {
// special case for Topic - show always for owners, others when set
if (section === Metadata.TOPIC) {
if (
- showAllSections ||
- isOwner(change, account) ||
- isSectionSet(section, change)
+ this.showAllSections ||
+ isOwner(this.change, account) ||
+ isSectionSet(section, this.change)
) {
return '';
} else {
@@ -546,89 +1055,88 @@
}
}
if (
- showAllSections ||
+ this.showAllSections ||
DisplayRules.ALWAYS_SHOW.includes(section) ||
(DisplayRules.SHOW_IF_SET.includes(section) &&
- isSectionSet(section, change))
+ isSectionSet(section, this.change))
) {
return '';
}
return 'hideDisplay';
}
- _computeMergedCommitInfo(
- current_revision: CommitId,
- revisions: {[revisionId: string]: RevisionInfo}
- ) {
- const rev = revisions[current_revision];
- if (!rev || !rev.commit) {
- return {};
- }
+ // private but used in test
+ computeMergedCommitInfo(
+ currentrevision?: CommitId,
+ revisions?: {[revisionId: string]: RevisionInfo | EditRevisionInfo}
+ ): CommitInfo | undefined {
+ if (!currentrevision || !revisions) return;
+ const rev = revisions[currentrevision];
+ if (!rev || !rev.commit) return;
// CommitInfo.commit is optional. Set commit in all cases to avoid error
// in <gr-commit-info>. @see Issue 5337
if (!rev.commit.commit) {
- rev.commit.commit = current_revision;
+ rev.commit.commit = currentrevision;
}
return rev.commit;
}
- _getRevertSectionTitle(
- _change?: ParsedChangeInfo,
- revertedChange?: ChangeInfo
- ) {
- return revertedChange?.status === ChangeStatus.MERGED
+ private getRevertSectionTitle() {
+ return this.revertedChange?.status === ChangeStatus.MERGED
? 'Revert Submitted As'
: 'Revert Created As';
}
- _showRevertCreatedAs(change?: ParsedChangeInfo) {
- if (!change?.messages) return false;
- return getRevertCreatedChangeIds(change.messages).length > 0;
+ // private but used in test
+ showRevertCreatedAs() {
+ if (!this.change?.messages) return false;
+ return getRevertCreatedChangeIds(this.change.messages).length > 0;
}
- _computeRevertCommit(change?: ParsedChangeInfo, revertedChange?: ChangeInfo) {
+ // private but used in test
+ computeRevertCommit(): CommitInfo | undefined {
+ const {revertedChange, change} = this;
if (revertedChange?.current_revision && revertedChange?.revisions) {
+ // TODO(TS): Fix typing
return {
- commit: this._computeMergedCommitInfo(
+ commit: this.computeMergedCommitInfo(
revertedChange.current_revision,
revertedChange.revisions
),
- };
+ } as CommitInfo;
}
if (!change?.messages) return undefined;
- return {commit: getRevertCreatedChangeIds(change.messages)?.[0]};
+ // TODO(TS): Fix typing
+ return {
+ commit: getRevertCreatedChangeIds(change.messages)?.[0],
+ } as unknown as CommitInfo;
}
- _computeShowAllLabelText(showAllSections: boolean) {
- if (showAllSections) {
- return 'Show less';
- } else {
- return 'Show all';
- }
- }
-
- _onShowAllClick() {
- this._showAllSections = !this._showAllSections;
+ // private but used in test
+ onShowAllClick() {
+ this.showAllSections = !this.showAllSections;
this.reporting.reportInteraction(Interaction.TOGGLE_SHOW_ALL_BUTTON, {
sectionName: 'metadata',
- toState: this._showAllSections ? 'Show all' : 'Show less',
+ toState: this.showAllSections ? 'Show all' : 'Show less',
});
}
/**
* Get the user with the specified role on the change. Returns undefined if the
* user with that role is the same as the owner.
+ * private but used in test
*/
- _getNonOwnerRole(change?: ParsedChangeInfo, role?: ChangeRole) {
- if (!change?.revisions?.[change.current_revision]) return undefined;
+ getNonOwnerRole(role: ChangeRole) {
+ if (!this.change?.revisions?.[this.change.current_revision])
+ return undefined;
- const rev = change.revisions[change.current_revision];
+ const rev = this.change.revisions[this.change.current_revision];
if (!rev) return undefined;
if (
role === ChangeRole.UPLOADER &&
rev.uploader &&
- change.owner._account_id !== rev.uploader._account_id
+ this.change.owner._account_id !== rev.uploader._account_id
) {
return rev.uploader;
}
@@ -636,7 +1144,7 @@
if (
role === ChangeRole.AUTHOR &&
rev.commit?.author &&
- change.owner.email !== rev.commit.author.email
+ this.change.owner.email !== rev.commit.author.email
) {
return rev.commit.author;
}
@@ -644,7 +1152,7 @@
if (
role === ChangeRole.COMMITTER &&
rev.commit?.committer &&
- change.owner.email !== rev.commit.committer.email &&
+ this.change.owner.email !== rev.commit.committer.email &&
!(
rev.uploader?.email && rev.uploader.email === rev.commit.committer.email
)
@@ -655,48 +1163,32 @@
return undefined;
}
- _computeParents(
- change?: ParsedChangeInfo,
- revision?: RevisionInfo | EditRevisionInfo
- ): ParentCommitInfo[] {
- if (!revision || !revision.commit) {
- if (!change || !change.current_revision) {
- return [];
- }
- revision = change.revisions[change.current_revision];
- if (!revision || !revision.commit) {
- return [];
- }
+ // private but used in test
+ computeParents(): ParentCommitInfo[] {
+ const {change, revision} = this;
+ if (!revision?.commit) {
+ if (!change?.current_revision) return [];
+ const newRevision = change.revisions[change.current_revision];
+ return newRevision?.commit?.parents ?? [];
}
- return revision.commit.parents;
+ return revision?.commit?.parents ?? [];
}
- _computeParentsLabel(parents?: ParentCommitInfo[]) {
- return parents && parents.length > 1 ? 'Parents' : 'Parent';
- }
-
- _computeParentListClass(
- parents?: ParentCommitInfo[],
- parentIsCurrent?: boolean
- ) {
- // Undefined check for polymer 2
- if (parents === undefined || parentIsCurrent === undefined) {
- return '';
- }
-
+ // private but used in test
+ computeParentListClass() {
return [
'parentList',
- parents && parents.length > 1 ? 'merge' : 'nonMerge',
- parentIsCurrent ? 'current' : 'notCurrent',
+ this.currentParents.length > 1 ? 'merge' : 'nonMerge',
+ this.parentIsCurrent ? 'current' : 'notCurrent',
].join(' ');
}
- _computeIsMutable(account?: AccountDetailInfo) {
- return account && !!Object.keys(account).length;
+ private computeIsMutable() {
+ return !!this.account && !!Object.keys(this.account).length;
}
editTopic() {
- if (this._topicReadOnly || !this.change || this.change.topic) {
+ if (this.topicReadOnly || !this.change || this.change.topic) {
return;
}
// Cannot use `this.$.ID` syntax because the element exists inside of a
@@ -706,20 +1198,9 @@
).open();
}
- _getReviewerSuggestionsProvider(change?: ParsedChangeInfo) {
- if (!change) {
- return undefined;
- }
- const provider = GrReviewerSuggestionsProvider.create(
- this.restApiService,
- change._number,
- SUGGESTIONS_PROVIDERS_USERS_TYPES.ANY
- );
- provider.init();
- return provider;
- }
-
- _getTopicSuggestions(input: string): Promise<AutocompleteSuggestion[]> {
+ private getTopicSuggestions(
+ input: string
+ ): Promise<AutocompleteSuggestion[]> {
return this.restApiService
.getChangesWithSimilarTopic(input)
.then(response =>
@@ -733,31 +1214,28 @@
);
}
- _showNewSubmitRequirements(change?: ParsedChangeInfo) {
- return showNewSubmitRequirements(this.flagsService, change);
+ private showNewSubmitRequirements() {
+ return showNewSubmitRequirements(this.flagsService, this.change);
}
- _computeVoteForRole(role?: ChangeRole, change?: ParsedChangeInfo) {
- const reviewer = this._getNonOwnerRole(change, role);
+ private computeVoteForRole(role: ChangeRole) {
+ const reviewer = this.getNonOwnerRole(role);
if (reviewer && isAccount(reviewer)) {
- return this._computeVote(reviewer, change);
+ return this.computeVote(reviewer);
} else {
return;
}
}
- _computeVote(
- reviewer: AccountInfo,
- change?: ParsedChangeInfo
- ): ApprovalInfo | undefined {
- const codeReviewLabel = this._computeCodeReviewLabel(change);
+ private computeVote(reviewer: AccountInfo): ApprovalInfo | undefined {
+ const codeReviewLabel = this.computeCodeReviewLabel();
if (!codeReviewLabel || !isDetailedLabelInfo(codeReviewLabel)) return;
return getApprovalInfo(codeReviewLabel, reviewer);
}
- _computeCodeReviewLabel(change?: ParsedChangeInfo): LabelInfo | undefined {
- if (!change || !change.labels) return;
- return getCodeReviewLabel(change.labels);
+ private computeCodeReviewLabel(): LabelInfo | undefined {
+ if (!this.change?.labels) return;
+ return getCodeReviewLabel(this.change.labels);
}
}
diff --git a/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata_html.ts b/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata_html.ts
deleted file mode 100644
index 012c0d5..0000000
--- a/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata_html.ts
+++ /dev/null
@@ -1,560 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="gr-change-metadata-shared-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <style include="gr-font-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <style include="shared-styles">
- :host {
- display: table;
- }
- gr-change-requirements,
- gr-submit-requirements {
- --requirements-horizontal-padding: var(--metadata-horizontal-padding);
- }
- gr-editable-label {
- max-width: 9em;
- }
- .webLink {
- display: block;
- }
- gr-account-chip[disabled],
- gr-linked-chip[disabled] {
- opacity: 0;
- pointer-events: none;
- }
- .hashtagChip {
- padding-bottom: var(--spacing-s);
- }
- /* consistent with section .title, .value */
- .hashtagChip:not(last-of-type) {
- padding-bottom: var(--spacing-s);
- }
- .hashtagChip:last-of-type {
- display: inline;
- vertical-align: top;
- }
- .parentList.merge {
- list-style-type: decimal;
- padding-left: var(--spacing-l);
- }
- .parentList gr-commit-info {
- display: inline-block;
- }
- .hideDisplay,
- #parentNotCurrentMessage {
- display: none;
- }
- .icon {
- margin: -3px 0;
- }
- .icon.help,
- .icon.notTrusted {
- color: var(--warning-foreground);
- }
- .icon.invalid {
- color: var(--negative-red-text-color);
- }
- .icon.trusted {
- color: var(--positive-green-text-color);
- }
- .parentList.notCurrent.nonMerge #parentNotCurrentMessage {
- --arrow-color: var(--warning-foreground);
- display: inline-block;
- }
- .oldSeparatedSection {
- margin-top: var(--spacing-l);
- padding: var(--spacing-m) 0;
- }
- .separatedSection {
- padding: var(--spacing-m) 0;
- }
- .hashtag gr-linked-chip,
- .topic gr-linked-chip {
- --linked-chip-text-color: var(--link-color);
- }
- gr-reviewer-list {
- --account-max-length: 100px;
- max-width: 285px;
- }
- .metadata-title {
- color: var(--deemphasized-text-color);
- padding-left: var(--metadata-horizontal-padding);
- }
- .metadata-header {
- display: flex;
- justify-content: space-between;
- align-items: flex-end;
- /* The goal is to achieve alignment of the owner account chip and the
- commit message box. Their top border should be on the same line. */
- margin-bottom: var(--spacing-s);
- }
- .show-all-button iron-icon {
- color: inherit;
- --iron-icon-height: 18px;
- --iron-icon-width: 18px;
- }
- gr-vote-chip {
- --gr-vote-chip-width: 14px;
- --gr-vote-chip-height: 14px;
- }
- </style>
- <div>
- <div class="metadata-header">
- <h3 class="metadata-title heading-3">Change Info</h3>
- <gr-button link="" class="show-all-button" on-click="_onShowAllClick"
- >[[_computeShowAllLabelText(_showAllSections)]]
- <iron-icon
- icon="gr-icons:expand-more"
- hidden$="[[_showAllSections]]"
- ></iron-icon
- ><iron-icon
- icon="gr-icons:expand-less"
- hidden$="[[!_showAllSections]]"
- ></iron-icon>
- </gr-button>
- </div>
- <template is="dom-if" if="[[change.submitted]]">
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.SUBMITTED)]]"
- >
- <span class="title">Submitted</span>
- <span class="value">
- <gr-date-formatter
- withTooltip
- date-str="[[change.submitted]]"
- showYesterday=""
- ></gr-date-formatter>
- </span>
- </section>
- </template>
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.UPDATED)]]"
- >
- <span class="title">
- <gr-tooltip-content
- has-tooltip=""
- title="Last update of (meta)data for this change."
- >
- Updated
- </gr-tooltip-content>
- </span>
- <span class="value">
- <gr-date-formatter
- withTooltip
- date-str="[[change.updated]]"
- showYesterday
- ></gr-date-formatter>
- </span>
- </section>
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.OWNER)]]"
- >
- <span class="title">
- <gr-tooltip-content
- has-tooltip=""
- title="This user created or uploaded the first patchset of this change."
- >
- Owner
- </gr-tooltip-content>
- </span>
- <span class="value">
- <gr-account-chip
- account="[[change.owner]]"
- change="[[change]]"
- highlightAttention
- vote="[[_computeVote(change.owner, change)]]"
- label="[[_computeCodeReviewLabel(change)]]"
- >
- <template is="dom-if" if="[[_showNewSubmitRequirements(change)]]">
- <gr-vote-chip
- slot="vote-chip"
- vote="[[_computeVote(change.owner, change)]]"
- label="[[_computeCodeReviewLabel(change)]]"
- circle-shape
- ></gr-vote-chip>
- </template>
- </gr-account-chip>
- <template is="dom-if" if="[[_pushCertificateValidation]]">
- <gr-tooltip-content
- has-tooltip=""
- title$="[[_pushCertificateValidation.message]]"
- >
- <iron-icon
- class$="icon [[_pushCertificateValidation.class]]"
- icon="[[_pushCertificateValidation.icon]]"
- >
- </iron-icon>
- </gr-tooltip-content>
- </template>
- </span>
- </section>
- <section class$="[[_computeShowRoleClass(change, _CHANGE_ROLE.UPLOADER)]]">
- <span class="title">
- <gr-tooltip-content
- has-tooltip=""
- title="This user uploaded the patchset to Gerrit (typically by running the 'git push' command)."
- >
- Uploader
- </gr-tooltip-content>
- </span>
- <span class="value">
- <gr-account-chip
- account="[[_getNonOwnerRole(change, _CHANGE_ROLE.UPLOADER)]]"
- change="[[change]]"
- highlightAttention
- vote="[[_computeVoteForRole(_CHANGE_ROLE.UPLOADER, change)]]"
- label="[[_computeCodeReviewLabel(change)]]"
- >
- <template is="dom-if" if="[[_showNewSubmitRequirements(change)]]">
- <gr-vote-chip
- slot="vote-chip"
- vote="[[_computeVoteForRole(_CHANGE_ROLE.UPLOADER, change)]]"
- label="[[_computeCodeReviewLabel(change)]]"
- circle-shape
- ></gr-vote-chip>
- </template>
- </gr-account-chip>
- </span>
- </section>
- <section class$="[[_computeShowRoleClass(change, _CHANGE_ROLE.AUTHOR)]]">
- <span class="title">
- <gr-tooltip-content
- has-tooltip=""
- title="This user wrote the code change."
- >
- Author
- </gr-tooltip-content>
- </span>
- <span class="value">
- <gr-account-chip
- account="[[_getNonOwnerRole(change, _CHANGE_ROLE.AUTHOR)]]"
- change="[[change]]"
- vote="[[_computeVoteForRole(_CHANGE_ROLE.AUTHOR, change)]]"
- label="[[_computeCodeReviewLabel(change)]]"
- >
- <template is="dom-if" if="[[_showNewSubmitRequirements(change)]]">
- <gr-vote-chip
- slot="vote-chip"
- vote="[[_computeVoteForRole(_CHANGE_ROLE.AUTHOR, change)]]"
- label="[[_computeCodeReviewLabel(change)]]"
- circle-shape
- ></gr-vote-chip>
- </template>
- </gr-account-chip>
- </span>
- </section>
- <section class$="[[_computeShowRoleClass(change, _CHANGE_ROLE.COMMITTER)]]">
- <span class="title">
- <gr-tooltip-content
- has-tooltip=""
- title="This user committed the code change to the Git repository (typically to the local Git repo before uploading)."
- >
- Committer
- </gr-tooltip-content>
- </span>
- <span class="value">
- <gr-account-chip
- account="[[_getNonOwnerRole(change, _CHANGE_ROLE.COMMITTER)]]"
- change="[[change]]"
- vote="[[_computeVoteForRole(_CHANGE_ROLE.COMMITTER, change)]]"
- label="[[_computeCodeReviewLabel(change)]]"
- >
- <template is="dom-if" if="[[_showNewSubmitRequirements(change)]]">
- <gr-vote-chip
- slot="vote-chip"
- vote="[[_computeVoteForRole(_CHANGE_ROLE.COMMITTER, change)]]"
- label="[[_computeCodeReviewLabel(change)]]"
- circle-shape
- ></gr-vote-chip>
- </template>
- </gr-account-chip>
- </span>
- </section>
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.REVIEWERS)]]"
- >
- <span class="title">Reviewers</span>
- <span class="value">
- <gr-reviewer-list
- change="{{change}}"
- mutable="[[_mutable]]"
- reviewers-only=""
- account="[[account]]"
- ></gr-reviewer-list>
- </span>
- </section>
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.CC)]]"
- >
- <span class="title">CC</span>
- <span class="value">
- <gr-reviewer-list
- change="{{change}}"
- mutable="[[_mutable]]"
- ccs-only=""
- account="[[account]]"
- ></gr-reviewer-list>
- </span>
- </section>
- <template
- is="dom-if"
- if="[[_computeShowRepoBranchTogether(change.project, change.branch)]]"
- >
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.REPO_BRANCH)]]"
- >
- <span class="title">Repo | Branch</span>
- <span class="value">
- <a href$="[[_computeProjectUrl(change.project)]]"
- >[[change.project]]</a
- >
- |
- <a href$="[[_computeBranchUrl(change.project, change.branch)]]"
- >[[change.branch]]</a
- >
- </span>
- </section>
- </template>
- <template
- is="dom-if"
- if="[[!_computeShowRepoBranchTogether(change.project, change.branch)]]"
- >
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.REPO_BRANCH)]]"
- >
- <span class="title">Repo</span>
- <span class="value">
- <a href$="[[_computeProjectUrl(change.project)]]">
- <gr-limited-text
- limit="40"
- text="[[change.project]]"
- ></gr-limited-text>
- </a>
- </span>
- </section>
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.REPO_BRANCH)]]"
- >
- <span class="title">Branch</span>
- <span class="value">
- <a href$="[[_computeBranchUrl(change.project, change.branch)]]">
- <gr-limited-text
- limit="40"
- text="[[change.branch]]"
- ></gr-limited-text>
- </a>
- </span>
- </section>
- </template>
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.PARENT)]]"
- >
- <span class="title">[[_computeParentsLabel(_currentParents)]]</span>
- <span class="value">
- <ol
- class$="[[_computeParentListClass(_currentParents, parentIsCurrent)]]"
- >
- <template is="dom-repeat" items="[[_currentParents]]" as="parent">
- <li>
- <gr-commit-info
- change="[[change]]"
- commit-info="[[parent]]"
- server-config="[[serverConfig]]"
- ></gr-commit-info>
- <gr-tooltip-content
- id="parentNotCurrentMessage"
- has-tooltip
- show-icon
- title$="[[_notCurrentMessage]]"
- ></gr-tooltip-content>
- </li>
- </template>
- </ol>
- </span>
- </section>
- <template is="dom-if" if="[[_isChangeMerged(change)]]">
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.MERGED_AS)]]"
- >
- <span class="title">Merged As</span>
- <span class="value">
- <gr-commit-info
- change="[[change]]"
- commit-info="[[_computeMergedCommitInfo(change.current_revision, change.revisions)]]"
- server-config="[[serverConfig]]"
- ></gr-commit-info>
- </span>
- </section>
- </template>
- <template is="dom-if" if="[[_showRevertCreatedAs(change)]]">
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.REVERT_CREATED_AS)]]"
- >
- <span class="title"
- >[[_getRevertSectionTitle(change, revertedChange)]]</span
- >
- <span class="value">
- <gr-commit-info
- change="[[change]]"
- commit-info="[[_computeRevertCommit(change, revertedChange)]]"
- server-config="[[serverConfig]]"
- ></gr-commit-info>
- </span>
- </section>
- </template>
- <template is="dom-if" if="[[_showTopic(change.*, _topicReadOnly)]]">
- <section
- class$="topic [[_computeDisplayState(_showAllSections, change, _SECTION.TOPIC, account)]]"
- >
- <span class="title">Topic</span>
- <span class="value">
- <template
- is="dom-if"
- if="[[_showTopicChip(change.*, _settingTopic)]]"
- >
- <gr-linked-chip
- text="[[change.topic]]"
- limit="40"
- href="[[_computeTopicUrl(change.topic)]]"
- removable="[[!_topicReadOnly]]"
- on-remove="_handleTopicRemoved"
- ></gr-linked-chip>
- </template>
- <template
- is="dom-if"
- if="[[_showAddTopic(change.*, _settingTopic, _topicReadOnly)]]"
- >
- <gr-editable-label
- class="topicEditableLabel"
- labelText="Add a topic"
- value="[[change.topic]]"
- maxLength="1024"
- placeholder="[[_computeTopicPlaceholder(_topicReadOnly)]]"
- read-only="[[_topicReadOnly]]"
- on-changed="_handleTopicChanged"
- showAsEditPencil
- autocomplete="true"
- query="[[queryTopic]]"
- ></gr-editable-label>
- </template>
- </span>
- </section>
- </template>
- <template is="dom-if" if="[[_showCherryPickOf(change.*)]]">
- <section
- class$="[[_computeDisplayState(_showAllSections, change, _SECTION.CHERRY_PICK_OF)]]"
- >
- <span class="title">Cherry pick of</span>
- <span class="value">
- <a
- href$="[[_computeCherryPickOfUrl(change.cherry_pick_of_change, change.cherry_pick_of_patch_set, change.project)]]"
- >
- <gr-limited-text
- text="[[change.cherry_pick_of_change]],[[change.cherry_pick_of_patch_set]]"
- limit="40"
- >
- </gr-limited-text>
- </a>
- </span>
- </section>
- </template>
- <section
- class$="strategy [[_computeDisplayState(_showAllSections, change, _SECTION.STRATEGY)]]"
- hidden$="[[_computeHideStrategy(change)]]"
- >
- <span class="title">Strategy</span>
- <span class="value">[[_computeStrategy(change)]]</span>
- </section>
- <section
- class$="hashtag [[_computeDisplayState(_showAllSections, change, _SECTION.HASHTAGS)]]"
- >
- <span class="title">Hashtags</span>
- <span class="value">
- <template is="dom-repeat" items="[[change.hashtags]]">
- <gr-linked-chip
- class="hashtagChip"
- text="[[item]]"
- href="[[_computeHashtagUrl(item)]]"
- removable="[[!_hashtagReadOnly]]"
- on-remove="_handleHashtagRemoved"
- limit="40"
- >
- </gr-linked-chip>
- </template>
- <template is="dom-if" if="[[!_hashtagReadOnly]]">
- <gr-editable-label
- uppercase=""
- labelText="Add a hashtag"
- placeholder="[[_computeHashtagPlaceholder(_hashtagReadOnly)]]"
- read-only="[[_hashtagReadOnly]]"
- on-changed="_handleHashtagChanged"
- showAsEditPencil
- ></gr-editable-label>
- </template>
- </span>
- </section>
- <template is="dom-if" if="[[_showNewSubmitRequirements(change)]]">
- <div class="separatedSection">
- <gr-submit-requirements
- change="[[change]]"
- account="[[account]]"
- mutable="[[_mutable]]"
- ></gr-submit-requirements>
- </div>
- </template>
- <template is="dom-if" if="[[!_showNewSubmitRequirements(change)]]">
- <div class="oldSeparatedSection">
- <gr-change-requirements
- change="{{change}}"
- account="[[account]]"
- mutable="[[_mutable]]"
- ></gr-change-requirements>
- </div>
- </template>
- <section
- id="webLinks"
- hidden$="[[!_computeWebLinks(commitInfo, serverConfig)]]"
- >
- <span class="title">Links</span>
- <span class="value">
- <template
- is="dom-repeat"
- items="[[_computeWebLinks(commitInfo, serverConfig)]]"
- as="link"
- >
- <a href="[[link.url]]" class="webLink" rel="noopener" target="_blank">
- [[link.name]]
- </a>
- </template>
- </span>
- </section>
- <gr-endpoint-decorator name="change-metadata-item">
- <gr-endpoint-param name="labels" value="[[labels]]"></gr-endpoint-param>
- <gr-endpoint-param name="change" value="[[change]]"></gr-endpoint-param>
- <gr-endpoint-param
- name="revision"
- value="[[revision]]"
- ></gr-endpoint-param>
- </gr-endpoint-decorator>
- </div>
-`;
diff --git a/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata_test.ts b/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata_test.ts
index 8ff2460..a000445 100644
--- a/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-change-metadata/gr-change-metadata_test.ts
@@ -19,13 +19,12 @@
import './gr-change-metadata';
import {GerritNav} from '../../core/gr-navigation/gr-navigation';
import {getPluginLoader} from '../../shared/gr-js-api-interface/gr-plugin-loader';
-import {GrChangeMetadata} from './gr-change-metadata';
+import {ChangeRole, GrChangeMetadata} from './gr-change-metadata';
import {
createServerInfo,
createUserConfig,
createParsedChange,
createAccountWithId,
- createRequirement,
createCommitInfoWithRequiredCommit,
createWebLinkInfo,
createGerritInfo,
@@ -33,12 +32,13 @@
createCommit,
createRevision,
createAccountDetailWithId,
+ createConfig,
} from '../../../test/test-data-generators';
import {
ChangeStatus,
SubmitType,
- RequirementStatus,
GpgKeyInfoStatus,
+ InheritedBooleanInfoConfiguredValue,
} from '../../../constants/constants';
import {
EmailAddress,
@@ -48,218 +48,246 @@
RevisionInfo,
ParentCommitInfo,
TopicName,
- ElementPropertyDeepChange,
PatchSetNum,
NumericChangeId,
LabelValueToDescriptionMap,
Hashtag,
+ CommitInfo,
} from '../../../types/common';
import {tap} from '@polymer/iron-test-helpers/mock-interactions';
import {GrEditableLabel} from '../../shared/gr-editable-label/gr-editable-label';
import {PluginApi} from '../../../api/plugin';
import {GrEndpointDecorator} from '../../plugins/gr-endpoint-decorator/gr-endpoint-decorator';
-import {queryAndAssert, stubRestApi} from '../../../test/test-utils';
+import {
+ queryAndAssert,
+ resetPlugins,
+ stubRestApi,
+} from '../../../test/test-utils';
import {ParsedChangeInfo} from '../../../types/types';
import {GrLinkedChip} from '../../shared/gr-linked-chip/gr-linked-chip';
import {GrButton} from '../../shared/gr-button/gr-button';
import {GrRouter} from '../../core/gr-router/gr-router';
+import {nothing} from 'lit';
const basicFixture = fixtureFromElement('gr-change-metadata');
suite('gr-change-metadata tests', () => {
let element: GrChangeMetadata;
- setup(() => {
+ setup(async () => {
stubRestApi('getLoggedIn').returns(Promise.resolve(false));
stubRestApi('getConfig').returns(
Promise.resolve({
...createServerInfo(),
user: {
...createUserConfig(),
- anonymous_coward_name: 'test coward name',
+ anonymouscowardname: 'test coward name',
},
})
);
element = basicFixture.instantiate();
+ element.change = createParsedChange();
+ await element.updateComplete;
});
- test('_computeMergedCommitInfo', () => {
+ test('renders', async () => {
+ await element.updateComplete;
+ expect(element).shadowDom.to.equal(/* HTML */ `<div>
+ <div class="metadata-header">
+ <h3 class="heading-3 metadata-title">Change Info</h3>
+ <gr-button
+ class="show-all-button"
+ link=""
+ role="button"
+ tabindex="0"
+ aria-disabled="false"
+ >
+ Show all <iron-icon icon="gr-icons:expand-more"> </iron-icon>
+ <iron-icon hidden="" icon="gr-icons:expand-less"> </iron-icon>
+ </gr-button>
+ </div>
+ <section class="hideDisplay">
+ <span class="title">
+ <gr-tooltip-content
+ has-tooltip=""
+ title="Last update of (meta)data for this change."
+ >
+ Updated
+ </gr-tooltip-content>
+ </span>
+ <span class="value">
+ <gr-date-formatter showyesterday="" withtooltip="">
+ </gr-date-formatter>
+ </span>
+ </section>
+ <section>
+ <span class="title">
+ <gr-tooltip-content
+ has-tooltip=""
+ title="This user created or uploaded the first patchset of this change."
+ >
+ Owner
+ </gr-tooltip-content>
+ </span>
+ <span class="value">
+ <gr-account-chip highlightattention=""
+ ><gr-vote-chip circle-shape="" slot="vote-chip"> </gr-vote-chip
+ ></gr-account-chip>
+ </span>
+ </section>
+ <section>
+ <span class="title">
+ <gr-tooltip-content
+ has-tooltip=""
+ title="This user wrote the code change."
+ >
+ Author
+ </gr-tooltip-content>
+ </span>
+ <span class="value">
+ <gr-account-chip><gr-vote-chip circle-shape="" slot="vote-chip"></gr-vote-chip
+ ></gr-account-chip>
+ </span>
+ </section>
+ <section>
+ <span class="title">
+ <gr-tooltip-content
+ has-tooltip=""
+ title="This user committed the code change to the Git repository (typically to the local Git repo before uploading)."
+ >
+ Committer
+ </gr-tooltip-content>
+ </span>
+ <span class="value">
+ <gr-account-chip><gr-vote-chip circle-shape="" slot="vote-chip"></gr-account-chip>
+ </span>
+ </section>
+ <section>
+ <span class="title"> Reviewers </span>
+ <span class="value">
+ <gr-reviewer-list reviewers-only=""> </gr-reviewer-list>
+ </span>
+ </section>
+ <section class="hideDisplay">
+ <span class="title"> CC </span>
+ <span class="value">
+ <gr-reviewer-list ccs-only=""> </gr-reviewer-list>
+ </span>
+ </section>
+ <section>
+ <span class="title">
+ Repo | Branch
+ </span>
+ <span class="value">
+ <a href="">
+ test-project
+ </a>
+ |
+ <a href="">
+ test-branch
+ </a>
+ </span>
+ </section>
+ <section class="hideDisplay">
+ <span class="title">Parent</span>
+ <span class="value">
+ <ol class="nonMerge notCurrent parentList"></ol>
+ </span>
+ </section>
+ <section class="hideDisplay strategy">
+ <span class="title"> Strategy </span> <span class="value"> </span>
+ </section>
+ <section class="hashtag hideDisplay">
+ <span class="title"> Hashtags </span>
+ <span class="value"> </span>
+ </section>
+ <div class="oldSeparatedSection">
+ <gr-change-requirements></gr-change-requirements>
+ </div>
+ <gr-endpoint-decorator name="change-metadata-item">
+ <gr-endpoint-param name="labels"> </gr-endpoint-param>
+ <gr-endpoint-param name="change"> </gr-endpoint-param>
+ <gr-endpoint-param name="revision"> </gr-endpoint-param>
+ </gr-endpoint-decorator>
+ </div>`);
+ });
+
+ test('computeMergedCommitInfo', () => {
const dummyRevs: {[revisionId: string]: RevisionInfo} = {
1: createRevision(1),
2: createRevision(2),
};
assert.deepEqual(
- element._computeMergedCommitInfo('0' as CommitId, dummyRevs),
- {}
+ element.computeMergedCommitInfo('0' as CommitId, dummyRevs),
+ undefined
);
assert.deepEqual(
- element._computeMergedCommitInfo('1' as CommitId, dummyRevs),
+ element.computeMergedCommitInfo('1' as CommitId, dummyRevs),
dummyRevs[1].commit
);
// Regression test for issue 5337.
- const commit = element._computeMergedCommitInfo('2' as CommitId, dummyRevs);
- assert.notDeepEqual(commit, dummyRevs[2]);
+ const commit = element.computeMergedCommitInfo('2' as CommitId, dummyRevs);
+ assert.notDeepEqual(commit, dummyRevs[2] as unknown as CommitInfo);
assert.deepEqual(commit, dummyRevs[2].commit);
});
- test('computed fields', () => {
- assert.isFalse(
- element._computeHideStrategy({
- ...createParsedChange(),
- status: ChangeStatus.NEW,
- })
- );
- assert.isTrue(
- element._computeHideStrategy({
- ...createParsedChange(),
- status: ChangeStatus.MERGED,
- })
- );
- assert.isTrue(
- element._computeHideStrategy({
- ...createParsedChange(),
- status: ChangeStatus.ABANDONED,
- })
- );
- assert.equal(
- element._computeStrategy({
- ...createParsedChange(),
- submit_type: SubmitType.CHERRY_PICK,
- }),
- 'Cherry Pick'
- );
- assert.equal(
- element._computeStrategy({
- ...createParsedChange(),
- submit_type: SubmitType.REBASE_ALWAYS,
- }),
- 'Rebase Always'
- );
- });
-
- test('computed fields requirements', () => {
- assert.isFalse(
- element._computeShowRequirements({
- ...createParsedChange(),
- status: ChangeStatus.MERGED,
- })
- );
- assert.isFalse(
- element._computeShowRequirements({
- ...createParsedChange(),
- status: ChangeStatus.ABANDONED,
- })
- );
-
- // No labels and no requirements: submit status is useless
- assert.isFalse(
- element._computeShowRequirements({
- ...createParsedChange(),
- status: ChangeStatus.NEW,
- labels: {},
- })
- );
-
- // Work in Progress: submit status should be present
- assert.isTrue(
- element._computeShowRequirements({
- ...createParsedChange(),
- status: ChangeStatus.NEW,
- labels: {},
- work_in_progress: true,
- })
- );
-
- // We have at least one reason to display Submit Status
- assert.isTrue(
- element._computeShowRequirements({
- ...createParsedChange(),
- status: ChangeStatus.NEW,
- labels: {
- Verified: {
- approved: createAccountWithId(),
- },
- },
- requirements: [],
- })
- );
- assert.isTrue(
- element._computeShowRequirements({
- ...createParsedChange(),
- status: ChangeStatus.NEW,
- labels: {},
- requirements: [
- {
- ...createRequirement(),
- fallbackText: 'Resolve all comments',
- status: RequirementStatus.OK,
- },
- ],
- })
- );
- });
-
- test('show strategy for open change', () => {
+ test('show strategy for open change', async () => {
element.change = {
...createParsedChange(),
status: ChangeStatus.NEW,
submit_type: SubmitType.CHERRY_PICK,
labels: {},
};
- flush();
+ await element.updateComplete;
const strategy = element.shadowRoot?.querySelector('.strategy');
assert.ok(strategy);
assert.isFalse(strategy?.hasAttribute('hidden'));
- assert.equal(strategy?.children[1].innerHTML, 'Cherry Pick');
+ assert.equal(strategy?.children[1].textContent, 'Cherry Pick');
});
- test('hide strategy for closed change', () => {
+ test('hide strategy for closed change', async () => {
element.change = {
...createParsedChange(),
status: ChangeStatus.MERGED,
labels: {},
};
- flush();
- assert.isTrue(
- element.shadowRoot?.querySelector('.strategy')?.hasAttribute('hidden')
- );
+ await element.updateComplete;
+ assert.isNull(element.shadowRoot?.querySelector('.strategy'));
});
- test('weblinks use GerritNav interface', () => {
+ test('weblinks use GerritNav interface', async () => {
const weblinksStub = sinon
.stub(GerritNav, '_generateWeblinks')
.returns([{name: 'stubb', url: '#s'}]);
element.commitInfo = createCommitInfoWithRequiredCommit();
element.serverConfig = createServerInfo();
- flush();
- const webLinks = element.$.webLinks;
+ await element.updateComplete;
+ const webLinks = element.webLinks!;
assert.isTrue(weblinksStub.called);
- assert.isFalse(webLinks.hasAttribute('hidden'));
- assert.equal(element._computeWebLinks(element.commitInfo)?.length, 1);
+ assert.isNotNull(webLinks);
+ assert.equal(element.computeWebLinks().length, 1);
});
- test('weblinks hidden when no weblinks', () => {
+ test('weblinks hidden when no weblinks', async () => {
element.commitInfo = createCommitInfoWithRequiredCommit();
element.serverConfig = createServerInfo();
- flush();
- const webLinks = element.$.webLinks;
- assert.isTrue(webLinks.hasAttribute('hidden'));
+ await element.updateComplete;
+ assert.isNull(element.webLinks);
});
- test('weblinks hidden when only gitiles weblink', () => {
+ test('weblinks hidden when only gitiles weblink', async () => {
element.commitInfo = {
...createCommitInfoWithRequiredCommit(),
web_links: [{...createWebLinkInfo(), name: 'gitiles', url: '#'}],
};
element.serverConfig = createServerInfo();
- flush();
- const webLinks = element.$.webLinks;
- assert.isTrue(webLinks.hasAttribute('hidden'));
- assert.equal(element._computeWebLinks(element.commitInfo), null);
+ await element.updateComplete;
+ assert.isNull(element.webLinks);
+ assert.equal(element.computeWebLinks().length, 0);
});
- test('weblinks hidden when sole weblink is set as primary', () => {
+ test('weblinks hidden when sole weblink is set as primary', async () => {
const browser = 'browser';
element.commitInfo = {
...createCommitInfoWithRequiredCommit(),
@@ -272,12 +300,11 @@
primary_weblink_name: browser,
},
};
- flush();
- const webLinks = element.$.webLinks;
- assert.isTrue(webLinks.hasAttribute('hidden'));
+ await element.updateComplete;
+ assert.isNull(element.webLinks);
});
- test('weblinks are visible when other weblinks', () => {
+ test('weblinks are visible when other weblinks', async () => {
const router = new GrRouter();
sinon
.stub(GerritNav, '_generateWeblinks')
@@ -287,10 +314,10 @@
...createCommitInfoWithRequiredCommit(),
web_links: [{...createWebLinkInfo(), name: 'test', url: '#'}],
};
- flush();
- const webLinks = element.$.webLinks;
+ await element.updateComplete;
+ const webLinks = element.webLinks!;
assert.isFalse(webLinks.hasAttribute('hidden'));
- assert.equal(element._computeWebLinks(element.commitInfo)?.length, 1);
+ assert.equal(element.computeWebLinks().length, 1);
// With two non-gitiles weblinks, there are two returned.
element.commitInfo = {
...createCommitInfoWithRequiredCommit(),
@@ -299,10 +326,10 @@
{...createWebLinkInfo(), name: 'test2', url: '#'},
],
};
- assert.equal(element._computeWebLinks(element.commitInfo)?.length, 2);
+ assert.equal(element.computeWebLinks().length, 2);
});
- test('weblinks are visible when gitiles and other weblinks', () => {
+ test('weblinks are visible when gitiles and other weblinks', async () => {
const router = new GrRouter();
sinon
.stub(GerritNav, '_generateWeblinks')
@@ -315,14 +342,14 @@
{...createWebLinkInfo(), name: 'gitiles', url: '#'},
],
};
- flush();
- const webLinks = element.$.webLinks;
+ await element.updateComplete;
+ const webLinks = element.webLinks!;
assert.isFalse(webLinks.hasAttribute('hidden'));
// Only the non-gitiles weblink is returned.
- assert.equal(element._computeWebLinks(element.commitInfo)?.length, 1);
+ assert.equal(element.computeWebLinks().length, 1);
});
- suite('_getNonOwnerRole', () => {
+ suite('getNonOwnerRole', () => {
let change: ParsedChangeInfo | undefined;
setup(() => {
@@ -356,95 +383,85 @@
});
suite('role=uploader', () => {
- test('_getNonOwnerRole for uploader', () => {
- assert.deepEqual(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.UPLOADER),
- {
- ...createAccountWithId(),
- email: 'ghi@def' as EmailAddress,
- _account_id: 1011123 as AccountId,
- }
- );
+ test('getNonOwnerRole for uploader', () => {
+ element.change = change;
+ assert.deepEqual(element.getNonOwnerRole(ChangeRole.UPLOADER), {
+ ...createAccountWithId(),
+ email: 'ghi@def' as EmailAddress,
+ _account_id: 1011123 as AccountId,
+ });
});
- test('_getNonOwnerRole that it does not return uploader', () => {
+ test('getNonOwnerRole that it does not return uploader', () => {
// Set the uploader email to be the same as the owner.
change!.revisions.rev1.uploader!._account_id = 1019328 as AccountId;
- assert.isNotOk(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.UPLOADER)
- );
+ element.change = change;
+ assert.isNotOk(element.getNonOwnerRole(ChangeRole.UPLOADER));
});
- test('_computeShowRoleClass show uploader', () => {
- assert.equal(
- element._computeShowRoleClass(change, element._CHANGE_ROLE.UPLOADER),
- ''
- );
+ test('computeShowRoleClass show uploader', () => {
+ element.change = change;
+ assert.notEqual(element.renderNonOwner(ChangeRole.UPLOADER), nothing);
});
- test('_computeShowRoleClass hide uploader', () => {
+ test('computeShowRoleClass hide uploader', () => {
// Set the uploader email to be the same as the owner.
change!.revisions.rev1.uploader!._account_id = 1019328 as AccountId;
- assert.equal(
- element._computeShowRoleClass(change, element._CHANGE_ROLE.UPLOADER),
- 'hideDisplay'
- );
+ element.change = change;
+ assert.equal(element.renderNonOwner(ChangeRole.UPLOADER), nothing);
});
});
suite('role=committer', () => {
- test('_getNonOwnerRole for committer', () => {
+ test('getNonOwnerRole for committer', () => {
change!.revisions.rev1.uploader!.email = 'ghh@def' as EmailAddress;
- assert.deepEqual(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.COMMITTER),
- {...createGitPerson(), email: 'ghi@def' as EmailAddress}
- );
+ element.change = change;
+ assert.deepEqual(element.getNonOwnerRole(ChangeRole.COMMITTER), {
+ ...createGitPerson(),
+ email: 'ghi@def' as EmailAddress,
+ });
});
- test('_getNonOwnerRole is null if committer is same as uploader', () => {
- assert.isNotOk(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.COMMITTER)
- );
+ test('getNonOwnerRole is null if committer is same as uploader', () => {
+ element.change = change;
+ assert.isNotOk(element.getNonOwnerRole(ChangeRole.COMMITTER));
});
- test('_getNonOwnerRole that it does not return committer', () => {
+ test('getNonOwnerRole that it does not return committer', () => {
// Set the committer email to be the same as the owner.
change!.revisions.rev1.commit!.committer.email =
'abc@def' as EmailAddress;
- assert.isNotOk(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.COMMITTER)
- );
+ element.change = change;
+ assert.isNotOk(element.getNonOwnerRole(ChangeRole.COMMITTER));
});
- test('_getNonOwnerRole null for committer with no commit', () => {
+ test('getNonOwnerRole null for committer with no commit', () => {
delete change!.revisions.rev1.commit;
- assert.isNotOk(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.COMMITTER)
- );
+ element.change = change;
+ assert.isNotOk(element.getNonOwnerRole(ChangeRole.COMMITTER));
});
});
suite('role=author', () => {
- test('_getNonOwnerRole for author', () => {
- assert.deepEqual(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.AUTHOR),
- {...createGitPerson(), email: 'jkl@def' as EmailAddress}
- );
+ test('getNonOwnerRole for author', () => {
+ element.change = change;
+ assert.deepEqual(element.getNonOwnerRole(ChangeRole.AUTHOR), {
+ ...createGitPerson(),
+ email: 'jkl@def' as EmailAddress,
+ });
});
- test('_getNonOwnerRole that it does not return author', () => {
+ test('getNonOwnerRole that it does not return author', () => {
// Set the author email to be the same as the owner.
change!.revisions.rev1.commit!.author.email = 'abc@def' as EmailAddress;
- assert.isNotOk(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.AUTHOR)
- );
+ element.change = change;
+ assert.isNotOk(element.getNonOwnerRole(ChangeRole.AUTHOR));
});
- test('_getNonOwnerRole null for author with no commit', () => {
+ test('getNonOwnerRole null for author with no commit', () => {
delete change!.revisions.rev1.commit;
- assert.isNotOk(
- element._getNonOwnerRole(change, element._CHANGE_ROLE.AUTHOR)
- );
+ element.change = change;
+ assert.isNotOk(element.getNonOwnerRole(ChangeRole.AUTHOR));
});
});
});
@@ -479,6 +496,13 @@
labels: {},
mergeable: true,
};
+ element.repoConfig = {
+ ...createConfig(),
+ enable_signed_push: {
+ configured_value: 'TRUE' as InheritedBooleanInfoConfiguredValue,
+ value: true,
+ },
+ };
});
test('Push Certificate Validation test BAD', () => {
@@ -489,10 +513,9 @@
problems: ['No public keys found for key ID E5E20E52'],
},
};
- const result = element._computePushCertificateValidation(
- serverConfig,
- change
- );
+ element.change = change;
+ element.serverConfig = serverConfig;
+ const result = element.computePushCertificateValidation();
assert.equal(
result?.message,
'Push certificate is invalid:\n' +
@@ -509,10 +532,9 @@
status: GpgKeyInfoStatus.TRUSTED,
},
};
- const result = element._computePushCertificateValidation(
- serverConfig,
- change
- );
+ element.change = change;
+ element.serverConfig = serverConfig;
+ const result = element.computePushCertificateValidation();
assert.equal(
result?.message,
'Push certificate is valid and key is trusted'
@@ -523,10 +545,9 @@
test('Push Certificate Validation is missing test', () => {
change!.revisions.rev1 = createRevision(1);
- const result = element._computePushCertificateValidation(
- serverConfig,
- change
- );
+ element.change = change;
+ element.serverConfig = serverConfig;
+ const result = element.computePushCertificateValidation();
assert.equal(
result?.message,
'This patch set was created without a push certificate'
@@ -534,9 +555,41 @@
assert.equal(result?.icon, 'gr-icons:help');
assert.equal(result?.class, 'help');
});
+
+ test('computePushCertificateValidation returns undefined', () => {
+ element.change = change;
+ delete serverConfig!.receive!.enable_signed_push;
+ element.serverConfig = serverConfig;
+ assert.isUndefined(element.computePushCertificateValidation());
+ });
+
+ test('isEnabledSignedPushOnRepo', () => {
+ change!.revisions.rev1!.push_certificate = {
+ certificate: 'Push certificate',
+ key: {
+ status: GpgKeyInfoStatus.TRUSTED,
+ },
+ };
+ element.change = change;
+ element.serverConfig = serverConfig;
+ element.repoConfig!.enable_signed_push!.configured_value =
+ InheritedBooleanInfoConfiguredValue.INHERIT;
+ element.repoConfig!.enable_signed_push!.inherited_value = true;
+ assert.isTrue(element.isEnabledSignedPushOnRepo());
+
+ element.repoConfig!.enable_signed_push!.inherited_value = false;
+ assert.isFalse(element.isEnabledSignedPushOnRepo());
+
+ element.repoConfig!.enable_signed_push!.configured_value =
+ InheritedBooleanInfoConfiguredValue.TRUE;
+ assert.isTrue(element.isEnabledSignedPushOnRepo());
+
+ element.repoConfig = undefined;
+ assert.isFalse(element.isEnabledSignedPushOnRepo());
+ });
});
- test('_computeParents', () => {
+ test('computeParents', () => {
const parents: ParentCommitInfo[] = [
{...createCommit(), commit: '123' as CommitId, subject: 'abc'},
];
@@ -544,7 +597,9 @@
...createRevision(1),
commit: {...createCommit(), parents},
};
- assert.equal(element._computeParents(undefined, revision), parents);
+ element.change = undefined;
+ element.revision = revision;
+ assert.equal(element.computeParents(), parents);
const change = (current_revision: CommitId): ParsedChangeInfo => {
return {
...createParsedChange(),
@@ -552,22 +607,25 @@
revisions: {456: revision},
};
};
- const change_bad_revision = change('789' as CommitId);
- assert.deepEqual(
- element._computeParents(change_bad_revision, createRevision()),
- []
- );
- const change_no_commit: ParsedChangeInfo = {
+ const changebadrevision = change('789' as CommitId);
+ element.change = changebadrevision;
+ element.revision = createRevision();
+ assert.deepEqual(element.computeParents(), []);
+ const changenocommit: ParsedChangeInfo = {
...createParsedChange(),
current_revision: '456' as CommitId,
revisions: {456: createRevision()},
};
- assert.deepEqual(element._computeParents(change_no_commit, undefined), []);
- const change_good = change('456' as CommitId);
- assert.equal(element._computeParents(change_good, undefined), parents);
+ element.change = changenocommit;
+ element.revision = undefined;
+ assert.deepEqual(element.computeParents(), []);
+ const changegood = change('456' as CommitId);
+ element.change = changegood;
+ element.revision = undefined;
+ assert.equal(element.computeParents(), parents);
});
- test('_currentParents', () => {
+ test('currentParents', async () => {
const revision = (parent: CommitId): RevisionInfo => {
return {
...createRevision(),
@@ -584,93 +642,116 @@
owner: {},
};
element.revision = revision('222' as CommitId);
- assert.equal(element._currentParents[0].commit, '222');
+ await element.updateComplete;
+ assert.equal(element.currentParents[0].commit, '222');
element.revision = revision('333' as CommitId);
- assert.equal(element._currentParents[0].commit, '333');
+ await element.updateComplete;
+ assert.equal(element.currentParents[0].commit, '333');
element.revision = undefined;
- assert.equal(element._currentParents[0].commit, '111');
+ await element.updateComplete;
+ assert.equal(element.currentParents[0].commit, '111');
element.change = createParsedChange();
- assert.deepEqual(element._currentParents, []);
+ await element.updateComplete;
+ assert.deepEqual(element.currentParents, []);
});
- test('_computeParentsLabel', () => {
+ test('computeParentListClass', () => {
const parent: ParentCommitInfo = {
...createCommit(),
commit: 'abc123' as CommitId,
subject: 'My parent commit',
};
- assert.equal(element._computeParentsLabel([parent]), 'Parent');
- assert.equal(element._computeParentsLabel([parent, parent]), 'Parents');
- });
-
- test('_computeParentListClass', () => {
- const parent: ParentCommitInfo = {
- ...createCommit(),
- commit: 'abc123' as CommitId,
- subject: 'My parent commit',
- };
+ element.currentParents = [parent];
+ element.parentIsCurrent = true;
assert.equal(
- element._computeParentListClass([parent], true),
+ element.computeParentListClass(),
'parentList nonMerge current'
);
+ element.currentParents = [parent];
+ element.parentIsCurrent = false;
assert.equal(
- element._computeParentListClass([parent], false),
+ element.computeParentListClass(),
'parentList nonMerge notCurrent'
);
+ element.currentParents = [parent, parent];
+ element.parentIsCurrent = false;
assert.equal(
- element._computeParentListClass([parent, parent], false),
+ element.computeParentListClass(),
'parentList merge notCurrent'
);
- assert.equal(
- element._computeParentListClass([parent, parent], true),
- 'parentList merge current'
- );
+ element.currentParents = [parent, parent];
+ element.parentIsCurrent = true;
+ assert.equal(element.computeParentListClass(), 'parentList merge current');
});
- test('_showAddTopic', () => {
- const changeRecord: ElementPropertyDeepChange<GrChangeMetadata, 'change'> =
- {
- base: {...createParsedChange()},
- path: '',
- value: undefined,
- };
- assert.isTrue(element._showAddTopic(undefined, false, false));
+ test('showAddTopic', () => {
+ const change = createParsedChange();
+ element.change = undefined;
+ element.settingTopic = false;
+ element.topicReadOnly = false;
+ assert.isTrue(element.showAddTopic());
// do not show for 'readonly'
- assert.isFalse(element._showAddTopic(undefined, false, true));
- assert.isTrue(element._showAddTopic(changeRecord, false, false));
- assert.isFalse(element._showAddTopic(changeRecord, true, false));
- changeRecord.base!.topic = 'foo' as TopicName;
- assert.isFalse(element._showAddTopic(changeRecord, true, false));
- assert.isFalse(element._showAddTopic(changeRecord, false, false));
+ element.change = undefined;
+ element.settingTopic = false;
+ element.topicReadOnly = true;
+ assert.isFalse(element.showAddTopic());
+ element.change = change;
+ element.settingTopic = false;
+ element.topicReadOnly = false;
+ assert.isTrue(element.showAddTopic());
+ element.change = change;
+ element.settingTopic = true;
+ element.topicReadOnly = false;
+ assert.isFalse(element.showAddTopic());
+ change.topic = 'foo' as TopicName;
+ element.change = change;
+ element.settingTopic = true;
+ element.topicReadOnly = false;
+ assert.isFalse(element.showAddTopic());
+ element.change = change;
+ element.settingTopic = false;
+ element.topicReadOnly = false;
+ assert.isFalse(element.showAddTopic());
});
- test('_showTopicChip', () => {
- const changeRecord: ElementPropertyDeepChange<GrChangeMetadata, 'change'> =
- {
- base: {...createParsedChange()},
- path: '',
- value: undefined,
- };
- assert.isFalse(element._showTopicChip(undefined, false));
- assert.isFalse(element._showTopicChip(changeRecord, false));
- assert.isFalse(element._showTopicChip(changeRecord, true));
- changeRecord.base!.topic = 'foo' as TopicName;
- assert.isFalse(element._showTopicChip(changeRecord, true));
- assert.isTrue(element._showTopicChip(changeRecord, false));
+ test('showTopicChip', async () => {
+ const change = createParsedChange();
+ element.change = change;
+ element.settingTopic = true;
+ await element.updateComplete;
+ assert.isFalse(element.showTopicChip());
+ element.change = change;
+ element.settingTopic = false;
+ await element.updateComplete;
+ assert.isFalse(element.showTopicChip());
+ element.change = change;
+ element.settingTopic = true;
+ await element.updateComplete;
+ assert.isFalse(element.showTopicChip());
+ change.topic = 'foo' as TopicName;
+ element.change = change;
+ element.settingTopic = true;
+ await element.updateComplete;
+ assert.isFalse(element.showTopicChip());
+ element.change = change;
+ element.settingTopic = false;
+ await element.updateComplete;
+ assert.isTrue(element.showTopicChip());
});
- test('_showCherryPickOf', () => {
- const changeRecord: ElementPropertyDeepChange<GrChangeMetadata, 'change'> =
- {
- base: {...createParsedChange()},
- path: '',
- value: undefined,
- };
- assert.isFalse(element._showCherryPickOf(undefined));
- assert.isFalse(element._showCherryPickOf(changeRecord));
- changeRecord.base!.cherry_pick_of_change = 123 as NumericChangeId;
- changeRecord.base!.cherry_pick_of_patch_set = 1 as PatchSetNum;
- assert.isTrue(element._showCherryPickOf(changeRecord));
+ test('showCherryPickOf', async () => {
+ element.change = undefined;
+ await element.updateComplete;
+ assert.isFalse(element.showCherryPickOf());
+ const change = createParsedChange();
+ element.change = change;
+ await element.updateComplete;
+ assert.isFalse(element.showCherryPickOf());
+ change.cherry_pick_of_change = 123 as NumericChangeId;
+ change.cherry_pick_of_patch_set = 1 as PatchSetNum;
+ element.change = change;
+ await element.updateComplete;
+ assert.isTrue(element.showCherryPickOf());
});
suite('Topic removal', () => {
@@ -695,22 +776,28 @@
};
});
- test('_computeTopicReadOnly', () => {
+ test('computeTopicReadOnly', () => {
let mutable = false;
- assert.isTrue(element._computeTopicReadOnly(mutable, change));
+ element.mutable = mutable;
+ element.change = change;
+ assert.isTrue(element.computeTopicReadOnly());
mutable = true;
- assert.isTrue(element._computeTopicReadOnly(mutable, change));
+ element.mutable = mutable;
+ assert.isTrue(element.computeTopicReadOnly());
change!.actions!.topic!.enabled = true;
- assert.isFalse(element._computeTopicReadOnly(mutable, change));
+ element.mutable = mutable;
+ element.change = change;
+ assert.isFalse(element.computeTopicReadOnly());
mutable = false;
- assert.isTrue(element._computeTopicReadOnly(mutable, change));
+ element.mutable = mutable;
+ assert.isTrue(element.computeTopicReadOnly());
});
test('topic read only hides delete button', async () => {
element.account = createAccountDetailWithId();
element.change = change;
sinon.stub(GerritNav, 'getUrlForTopic').returns('/q/topic:test');
- await flush();
+ await element.updateComplete;
const chip = queryAndAssert<GrLinkedChip>(element, 'gr-linked-chip');
const button = queryAndAssert<GrButton>(chip, 'gr-button');
assert.isTrue(button.hasAttribute('hidden'));
@@ -721,7 +808,7 @@
change.actions!.topic!.enabled = true;
element.change = change;
sinon.stub(GerritNav, 'getUrlForTopic').returns('/q/topic:test');
- await flush();
+ await element.updateComplete;
const chip = queryAndAssert<GrLinkedChip>(element, 'gr-linked-chip');
const button = queryAndAssert<GrButton>(chip, 'gr-button');
assert.isFalse(button.hasAttribute('hidden'));
@@ -748,40 +835,57 @@
};
});
- test('_computeHashtagReadOnly', async () => {
- await flush();
+ test('computeHashtagReadOnly', async () => {
+ await element.updateComplete;
let mutable = false;
- assert.isTrue(element._computeHashtagReadOnly(mutable, change));
+ element.change = change;
+ element.mutable = mutable;
+ await element.updateComplete;
+ assert.isTrue(element.computeHashtagReadOnly());
mutable = true;
- assert.isTrue(element._computeHashtagReadOnly(mutable, change));
+ element.change = change;
+ element.mutable = mutable;
+ await element.updateComplete;
+ assert.isTrue(element.computeHashtagReadOnly());
change!.actions!.hashtags!.enabled = true;
- assert.isFalse(element._computeHashtagReadOnly(mutable, change));
+ element.change = change;
+ element.mutable = mutable;
+ await element.updateComplete;
+ assert.isFalse(element.computeHashtagReadOnly());
mutable = false;
- assert.isTrue(element._computeHashtagReadOnly(mutable, change));
+ element.change = change;
+ element.mutable = mutable;
+ await element.updateComplete;
+ assert.isTrue(element.computeHashtagReadOnly());
});
test('hashtag read only hides delete button', async () => {
- await flush();
element.account = createAccountDetailWithId();
element.change = change;
sinon
.stub(GerritNav, 'getUrlForHashtag')
.returns('/q/hashtag:test+(status:open%20OR%20status:merged)');
- await flush();
+ await element.updateComplete;
+ assert.isTrue(element.mutable, 'Mutable');
+ assert.isFalse(
+ element.change.actions?.hashtags?.enabled,
+ 'hashtags disabled'
+ );
+ assert.isTrue(element.hashtagReadOnly, 'hashtag read only');
const chip = queryAndAssert<GrLinkedChip>(element, 'gr-linked-chip');
const button = queryAndAssert<GrButton>(chip, 'gr-button');
- assert.isTrue(button.hasAttribute('hidden'));
+ assert.isTrue(button.hasAttribute('hidden'), 'button hidden');
});
test('hashtag not read only does not hide delete button', async () => {
- await flush();
+ await element.updateComplete;
element.account = createAccountDetailWithId();
change!.actions!.hashtags!.enabled = true;
element.change = change;
sinon
.stub(GerritNav, 'getUrlForHashtag')
.returns('/q/hashtag:test+(status:open%20OR%20status:merged)');
- await flush();
+ await element.updateComplete;
const chip = queryAndAssert<GrLinkedChip>(element, 'gr-linked-chip');
const button = queryAndAssert<GrButton>(chip, 'gr-button');
assert.isFalse(button.hasAttribute('hidden'));
@@ -789,8 +893,8 @@
});
suite('remove reviewer votes', () => {
- setup(() => {
- sinon.stub(element, '_computeTopicReadOnly').returns(true);
+ setup(async () => {
+ sinon.stub(element, 'computeTopicReadOnly').returns(true);
element.change = {
...createParsedChange(),
topic: 'the topic' as TopicName,
@@ -803,7 +907,7 @@
},
removable_reviewers: [],
};
- flush();
+ await element.updateComplete;
});
test('changing topic', () => {
@@ -811,7 +915,7 @@
const setChangeTopicStub = stubRestApi('setChangeTopic').returns(
Promise.resolve(newTopic)
);
- element._handleTopicChanged(new CustomEvent('test', {detail: newTopic}));
+ element.handleTopicChanged(new CustomEvent('test', {detail: newTopic}));
const topicChangedSpy = sinon.spy();
element.addEventListener('topic-changed', topicChangedSpy);
assert.isTrue(
@@ -829,7 +933,7 @@
Promise.resolve(newTopic)
);
sinon.stub(GerritNav, 'getUrlForTopic').returns('/q/topic:the+new+topic');
- await flush();
+ await element.updateComplete;
const chip = queryAndAssert<GrLinkedChip>(element, 'gr-linked-chip');
const remove = queryAndAssert(chip, '#remove');
const topicChangedSpy = sinon.spy();
@@ -845,12 +949,12 @@
});
test('changing hashtag', async () => {
- await flush();
+ await element.updateComplete;
const newHashtag: Hashtag[] = ['new hashtag' as Hashtag];
const setChangeHashtagStub = stubRestApi('setChangeHashtag').returns(
Promise.resolve(newHashtag)
);
- element._handleHashtagChanged(
+ element.handleHashtagChanged(
new CustomEvent('test', {detail: 'new hashtag'})
);
assert.isTrue(
@@ -870,7 +974,7 @@
...createParsedChange(),
actions: {topic: {enabled: true}},
};
- await flush();
+ await element.updateComplete;
const label = element.shadowRoot!.querySelector(
'.topicEditableLabel'
@@ -878,38 +982,47 @@
assert.ok(label);
const openStub = sinon.stub(label, 'open');
element.editTopic();
- await flush();
+ await element.updateComplete;
assert.isTrue(openStub.called);
});
suite('plugin endpoints', () => {
- test('endpoint params', async () => {
+ setup(async () => {
+ resetPlugins();
+ element = basicFixture.instantiate();
element.change = createParsedChange();
element.revision = createRevision();
+ await element.updateComplete;
+ });
+
+ teardown(() => {
+ resetPlugins();
+ });
+
+ test('endpoint params', async () => {
interface MetadataGrEndpointDecorator extends GrEndpointDecorator {
plugin: PluginApi;
change: ParsedChangeInfo;
revision: RevisionInfo;
}
- let hookEl: MetadataGrEndpointDecorator;
let plugin: PluginApi;
window.Gerrit.install(
p => {
plugin = p;
- plugin
- .hook('change-metadata-item')
- .getLastAttached()
- .then(el => (hookEl = el as MetadataGrEndpointDecorator));
},
'0.1',
'http://some/plugins/url.js'
);
+ await element.updateComplete;
+ const hookEl = (await plugin!
+ .hook('change-metadata-item')
+ .getLastAttached()) as MetadataGrEndpointDecorator;
getPluginLoader().loadPlugins([]);
- await flush();
- assert.strictEqual(hookEl!.plugin, plugin!);
- assert.strictEqual(hookEl!.change, element.change);
- assert.strictEqual(hookEl!.revision, element.revision);
+ await element.updateComplete;
+ assert.strictEqual(hookEl.plugin, plugin!);
+ assert.strictEqual(hookEl.change, element.change);
+ assert.strictEqual(hookEl.revision, element.revision);
});
});
});
diff --git a/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view.ts b/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view.ts
index e8448b7..c8eb6a8 100644
--- a/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view.ts
+++ b/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view.ts
@@ -174,6 +174,7 @@
import {GrMessagesList} from '../gr-messages-list/gr-messages-list';
import {GrThreadList} from '../gr-thread-list/gr-thread-list';
import {
+ fire,
fireAlert,
fireDialogChange,
fireEvent,
@@ -283,7 +284,7 @@
@property({type: Object, observer: '_paramsChanged'})
params?: AppElementChangeViewParams;
- @property({type: Object, notify: true, observer: '_viewStateChanged'})
+ @property({type: Object, observer: '_viewStateChanged'})
viewState: Partial<ChangeViewState> = {};
@property({type: String})
@@ -632,6 +633,12 @@
private connected$ = new BehaviorSubject(false);
+ /**
+ * For `connectedCallback()` to distinguish between connecting to the DOM for
+ * the first time or if just re-connecting.
+ */
+ private isFirstConnection = true;
+
/** Simply reflects the router-model value. */
// visible for testing
routerPatchNum?: PatchSetNum;
@@ -648,12 +655,29 @@
'fullscreen-overlay-opened',
() => this._handleHideBackgroundContent()
);
-
this.addEventListener('fullscreen-overlay-closed', () =>
this._handleShowBackgroundContent()
);
-
this.addEventListener('open-reply-dialog', () => this._openReplyDialog());
+ this.addEventListener('change-message-deleted', () => fireReload(this));
+ this.addEventListener('editable-content-save', e =>
+ this._handleCommitMessageSave(e)
+ );
+ this.addEventListener('editable-content-cancel', () =>
+ this._handleCommitMessageCancel()
+ );
+ this.addEventListener('open-fix-preview', e => this._onOpenFixPreview(e));
+ this.addEventListener('close-fix-preview', e => this._onCloseFixPreview(e));
+
+ this.addEventListener(EventType.SHOW_PRIMARY_TAB, e =>
+ this._setActivePrimaryTab(e)
+ );
+ this.addEventListener('reload', e => {
+ this.loadData(
+ /* isLocationChange= */ false,
+ /* clearPatchset= */ e.detail && e.detail.clearPatchset
+ );
+ });
}
private setupSubscriptions() {
@@ -698,24 +722,23 @@
override connectedCallback() {
super.connectedCallback();
+ this.firstConnectedCallback();
this.connected$.next(true);
- this.setupSubscriptions();
- this._throttledToggleChangeStar = throttleWrap<KeyboardEvent>(_ =>
- this._handleToggleChangeStar()
- );
- this._getServerConfig().then(config => {
- this._serverConfig = config;
- this._replyDisabled = false;
- });
- this._getLoggedIn().then(loggedIn => {
- this._loggedIn = loggedIn;
- if (loggedIn) {
- this.restApiService.getAccount().then(acct => {
- this._account = acct;
- });
- }
- });
+ // Make sure to reverse everything below this line in disconnectedCallback().
+ // Or consider using either firstConnectedCallback() or constructor().
+ this.setupSubscriptions();
+ document.addEventListener('visibilitychange', this.handleVisibilityChange);
+ document.addEventListener('scroll', this.handleScroll);
+ }
+
+ /**
+ * For initialization that should only happen once, not again when
+ * re-connecting to the DOM later.
+ */
+ private firstConnectedCallback() {
+ if (!this.isFirstConnection) return;
+ this.isFirstConnection = false;
getPluginLoader()
.awaitPluginsLoaded()
@@ -733,26 +756,21 @@
})
.then(() => this._initActiveTabs(this.params));
- this.addEventListener('change-message-deleted', () => fireReload(this));
- this.addEventListener('editable-content-save', e =>
- this._handleCommitMessageSave(e)
+ this._throttledToggleChangeStar = throttleWrap<KeyboardEvent>(_ =>
+ this._handleToggleChangeStar()
);
- this.addEventListener('editable-content-cancel', () =>
- this._handleCommitMessageCancel()
- );
- this.addEventListener('open-fix-preview', e => this._onOpenFixPreview(e));
- this.addEventListener('close-fix-preview', e => this._onCloseFixPreview(e));
- document.addEventListener('visibilitychange', this.handleVisibilityChange);
- document.addEventListener('scroll', this.handleScroll);
+ this._getServerConfig().then(config => {
+ this._serverConfig = config;
+ this._replyDisabled = false;
+ });
- this.addEventListener(EventType.SHOW_PRIMARY_TAB, e =>
- this._setActivePrimaryTab(e)
- );
- this.addEventListener('reload', e => {
- this.loadData(
- /* isLocationChange= */ false,
- /* clearPatchset= */ e.detail && e.detail.clearPatchset
- );
+ this._getLoggedIn().then(loggedIn => {
+ this._loggedIn = loggedIn;
+ if (loggedIn) {
+ this.restApiService.getAccount().then(acct => {
+ this._account = acct;
+ });
+ }
});
}
@@ -943,6 +961,8 @@
assertIsDefined(this._change, '_change');
if (!this._changeNum)
throw new Error('missing required changeNum property');
+ // to prevent 2 requests at the same time
+ if (this.$.commitMessageEditor.disabled) return;
// Trim trailing whitespace from each line.
const message = e.detail.content.replace(TRAILING_WHITESPACE_REGEX, '');
@@ -1507,6 +1527,9 @@
if (this.viewState.showReplyDialog) {
this._openReplyDialog(FocusTarget.ANY);
this.set('viewState.showReplyDialog', false);
+ fire(this, 'view-state-change-view-changed', {
+ value: this.viewState as ChangeViewState,
+ });
}
});
}
@@ -1521,6 +1544,9 @@
}
this.set('viewState.changeNum', this._changeNum);
this.set('viewState.patchRange', this._patchRange);
+ fire(this, 'view-state-change-view-changed', {
+ value: this.viewState as ChangeViewState,
+ });
}
private updateTitle(change?: ChangeInfo | ParsedChangeInfo) {
@@ -2635,11 +2661,18 @@
createTitle(shortcutName: Shortcut, section: ShortcutSection) {
return this.shortcuts.createTitle(shortcutName, section);
}
+
+ _handleRevisionActionsChanged(
+ e: CustomEvent<{value: ActionNameToActionInfoMap}>
+ ) {
+ this._currentRevisionActions = e.detail.value;
+ }
}
declare global {
interface HTMLElementEventMap {
'toggle-star': CustomEvent<ChangeStarToggleStarDetail>;
+ 'view-state-change-view-changed': ValueChangedEvent<ChangeViewState>;
}
interface HTMLElementTagNameMap {
'gr-change-view': GrChangeView;
diff --git a/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view_html.ts b/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view_html.ts
index 72021e5..025a74b 100644
--- a/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view_html.ts
+++ b/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view_html.ts
@@ -362,8 +362,7 @@
change="[[_change]]"
disable-edit="[[disableEdit]]"
has-parent="[[hasParent]]"
- actions="[[_change.actions]]"
- revision-actions="{{_currentRevisionActions}}"
+ revision-actions="[[_currentRevisionActions]]"
account="[[_account]]"
change-num="[[_changeNum]]"
change-status="[[_change.status]]"
@@ -379,6 +378,7 @@
on-stop-edit-tap="_handleStopEditTap"
on-download-tap="_handleOpenDownloadDialog"
on-included-tap="_handleOpenIncludedInDialog"
+ on-revision-actions-changed="_handleRevisionActionsChanged"
></gr-change-actions>
</div>
<!-- end commit actions -->
@@ -396,6 +396,7 @@
commit-info="[[_commitInfo]]"
server-config="[[_serverConfig]]"
parent-is-current="[[_parentIsCurrent]]"
+ repo-config="[[_projectConfig]]"
on-show-reply-dialog="_handleShowReplyDialog"
>
</gr-change-metadata>
diff --git a/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view_test.ts b/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view_test.ts
index 32dde8c..45a6530 100644
--- a/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-change-view/gr-change-view_test.ts
@@ -34,8 +34,6 @@
import {GerritNav} from '../../core/gr-navigation/gr-navigation';
import {getPluginLoader} from '../../shared/gr-js-api-interface/gr-plugin-loader';
import {EventType, PluginApi} from '../../../api/plugin';
-
-import 'lodash/lodash';
import {
mockPromise,
queryAndAssert,
@@ -1531,7 +1529,7 @@
);
});
- test('_handleCommitMessageSave trims trailing whitespace', () => {
+ test('_handleCommitMessageSave trims trailing whitespace', async () => {
element._change = createChangeViewChange();
// Response code is 500, because we want to avoid window reloading
const putStub = stubRestApi('putChangeCommitMessage').returns(
@@ -1543,10 +1541,10 @@
element._handleCommitMessageSave(mockEvent('test \n test '));
assert.equal(putStub.lastCall.args[1], 'test\n test');
-
+ element.$.commitMessageEditor.disabled = false;
element._handleCommitMessageSave(mockEvent(' test\ntest'));
assert.equal(putStub.lastCall.args[1], ' test\ntest');
-
+ element.$.commitMessageEditor.disabled = false;
element._handleCommitMessageSave(mockEvent('\n\n\n\n\n\n\n\n'));
assert.equal(putStub.lastCall.args[1], '\n\n\n\n\n\n\n\n');
});
@@ -2127,7 +2125,7 @@
element._change = {
...createChangeViewChange(),
};
- sinon.stub(element.$.metadata, '_computeLabelNames');
+ sinon.stub(element.$.metadata, 'computeLabelNames');
navigateToChangeStub.restore();
const promise = mockPromise();
sinon.stub(GerritNav, 'navigateToChange').callsFake((...args) => {
diff --git a/polygerrit-ui/app/elements/change/gr-confirm-cherrypick-dialog/gr-confirm-cherrypick-dialog.ts b/polygerrit-ui/app/elements/change/gr-confirm-cherrypick-dialog/gr-confirm-cherrypick-dialog.ts
index fb8f279..f8103fd 100644
--- a/polygerrit-ui/app/elements/change/gr-confirm-cherrypick-dialog/gr-confirm-cherrypick-dialog.ts
+++ b/polygerrit-ui/app/elements/change/gr-confirm-cherrypick-dialog/gr-confirm-cherrypick-dialog.ts
@@ -39,7 +39,6 @@
ChangeStatus,
ProgressStatus,
} from '../../../constants/constants';
-import {dom, EventApi} from '@polymer/polymer/lib/legacy/polymer.dom';
import {fireEvent} from '../../../utils/event-util';
import {css, html, LitElement, PropertyValues} from 'lit';
import {sharedStyles} from '../../../styles/shared-styles';
@@ -423,9 +422,7 @@
}
private toggleChangeSelected(e: Event) {
- const changeId = ((dom(e) as EventApi).localTarget as HTMLElement).dataset[
- 'item'
- ]! as ChangeInfoId;
+ const changeId = (e.target as HTMLElement).dataset['item']! as ChangeInfoId;
if (this.selectedChangeIds.has(changeId))
this.selectedChangeIds.delete(changeId);
else this.selectedChangeIds.add(changeId);
diff --git a/polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog.ts b/polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog.ts
index ae97a1b..25c403f 100644
--- a/polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog.ts
+++ b/polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog.ts
@@ -201,7 +201,7 @@
id="parentInput"
.query=${this.query}
no-debounce
- text=${this.text}
+ .text=${this.text}
@text-changed=${(e: ValueChangedEvent) =>
(this.text = e.detail.value)}
@click=${this.handleEnterChangeNumberClick}
diff --git a/polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog_test.ts b/polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog_test.ts
index 17afe92..bc000af 100644
--- a/polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-confirm-rebase-dialog/gr-confirm-rebase-dialog_test.ts
@@ -18,9 +18,9 @@
import '../../../test/common-test-setup-karma';
import './gr-confirm-rebase-dialog';
import {GrConfirmRebaseDialog, RebaseChange} from './gr-confirm-rebase-dialog';
-import {queryAndAssert, stubRestApi} from '../../../test/test-utils';
+import {queryAndAssert, stubRestApi, waitUntil} from '../../../test/test-utils';
import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
-import {NumericChangeId} from '../../../types/common';
+import {NumericChangeId, BranchName} from '../../../types/common';
import {createChangeViewChange} from '../../../test/test-data-generators';
import {fixture, html} from '@open-wc/testing-helpers';
@@ -34,79 +34,57 @@
});
test('render', async () => {
- expect(element).shadowDom.to.equal(/* HTML*/ `
- <gr-dialog
- id="confirmDialog"
- confirm-label="Rebase"
- role="dialog"
- >
- <div class="header" slot="header">Confirm rebase</div>
- <div class="main" slot="main">
- <div
- id="rebaseOnParent"
- class="rebaseOption"
- hidden=""
- >
- <input id="rebaseOnParentInput" name="rebaseOptions" type="radio" />
- <label id="rebaseOnParentLabel" for="rebaseOnParentInput">
- Rebase on parent change
- </label>
- </div>
- <div
- id="parentUpToDateMsg"
- class="message"
- hidden=""
- >
- This change is up to date with its parent.
- </div>
- <div
- id="rebaseOnTip"
- class="rebaseOption"
- hidden=""
- >
- <input
- disabled=""
- id="rebaseOnTipInput"
- name="rebaseOptions"
- type="radio"
- />
- <label id="rebaseOnTipLabel" for="rebaseOnTipInput">
- Rebase on top of the branch<span hidden=""
- >
- (breaks relation chain)
- </span>
- </label>
- </div>
- <div
- id="tipUpToDateMsg"
- class="message"
- >
- Change is up to date with the target branch already ()
- </div>
- <div id="rebaseOnOther" class="rebaseOption">
- <input
- id="rebaseOnOtherInput"
- name="rebaseOptions"
- type="radio"
- />
- <label id="rebaseOnOtherLabel" for="rebaseOnOtherInput">
- Rebase on a specific change, ref, or commit
- <span hidden=""> (breaks relation chain) </span>
- </label>
- </div>
- <div class="parentRevisionContainer">
- <gr-autocomplete
- id="parentInput"
- no-debounce=""
- allow-non-suggested-values
- placeholder="Change number, ref, or commit hash"
- text=""
- >
- </gr-autocomplete>
- </div>
+ element.branch = 'test' as BranchName;
+ await element.updateComplete;
+ expect(element).shadowDom.to.equal(/* HTML */ `<gr-dialog
+ confirm-label="Rebase"
+ id="confirmDialog"
+ role="dialog"
+ >
+ <div class="header" slot="header">Confirm rebase</div>
+ <div class="main" slot="main">
+ <div class="rebaseOption" hidden="" id="rebaseOnParent">
+ <input id="rebaseOnParentInput" name="rebaseOptions" type="radio" />
+ <label for="rebaseOnParentInput" id="rebaseOnParentLabel">
+ Rebase on parent change
+ </label>
</div>
- </gr-dialog>
- `);
+ <div class="message" hidden="" id="parentUpToDateMsg">
+ This change is up to date with its parent.
+ </div>
+ <div class="rebaseOption" hidden="" id="rebaseOnTip">
+ <input
+ disabled=""
+ id="rebaseOnTipInput"
+ name="rebaseOptions"
+ type="radio"
+ />
+ <label for="rebaseOnTipInput" id="rebaseOnTipLabel">
+ Rebase on top of the test branch
+ <span hidden=""> (breaks relation chain) </span>
+ </label>
+ </div>
+ <div class="message" id="tipUpToDateMsg">
+ Change is up to date with the target branch already (test)
+ </div>
+ <div class="rebaseOption" id="rebaseOnOther">
+ <input id="rebaseOnOtherInput" name="rebaseOptions" type="radio" />
+ <label for="rebaseOnOtherInput" id="rebaseOnOtherLabel">
+ Rebase on a specific change, ref, or commit
+ <span hidden=""> (breaks relation chain) </span>
+ </label>
+ </div>
+ <div class="parentRevisionContainer">
+ <gr-autocomplete
+ allow-non-suggested-values=""
+ id="parentInput"
+ no-debounce=""
+ placeholder="Change number, ref, or commit hash"
+ >
+ </gr-autocomplete>
+ </div>
+ </div>
+ </gr-dialog> `);
});
test('controls with parent and rebase on current available', async () => {
@@ -318,14 +296,13 @@
null,
'enter'
);
+ await element.updateComplete;
element.text = '1';
- await element.updateComplete;
- assert.isTrue(recentChangesSpy.calledOnce);
+ await waitUntil(() => recentChangesSpy.calledOnce);
element.text = '12';
- await element.updateComplete;
- assert.isTrue(recentChangesSpy.calledTwice);
+ await waitUntil(() => recentChangesSpy.calledTwice);
});
});
});
diff --git a/polygerrit-ui/app/elements/change/gr-file-list/gr-file-list.ts b/polygerrit-ui/app/elements/change/gr-file-list/gr-file-list.ts
index 7625756..237e126 100644
--- a/polygerrit-ui/app/elements/change/gr-file-list/gr-file-list.ts
+++ b/polygerrit-ui/app/elements/change/gr-file-list/gr-file-list.ts
@@ -373,7 +373,7 @@
fileCursor = new GrCursorManager();
// private but used in test
- diffCursor = new GrDiffCursor();
+ diffCursor?: GrDiffCursor;
constructor() {
super();
@@ -453,6 +453,8 @@
shouldSuppress: true,
})
);
+ this.diffCursor = new GrDiffCursor();
+ this.diffCursor.replaceDiffs(this.diffs);
}
override disconnectedCallback() {
@@ -460,7 +462,7 @@
s.unsubscribe();
}
this.subscriptions = [];
- this.diffCursor.dispose();
+ this.diffCursor?.dispose();
this.fileCursor.unsetCursor();
this._cancelDiffs();
this.loadingTask?.cancel();
@@ -643,7 +645,7 @@
this._expandedFiles.length,
this._files.length
);
- this.diffCursor.handleDiffUpdate();
+ this.diffCursor?.handleDiffUpdate();
}
/**
@@ -885,12 +887,12 @@
_handleLeftPane() {
if (this._noDiffsExpanded()) return;
- this.diffCursor.moveLeft();
+ this.diffCursor?.moveLeft();
}
_handleRightPane() {
if (this._noDiffsExpanded()) return;
- this.diffCursor.moveRight();
+ this.diffCursor?.moveRight();
}
_handleToggleInlineDiff() {
@@ -900,7 +902,7 @@
_handleCursorNext(e: KeyboardEvent) {
if (this.filesExpanded === FilesExpandedState.ALL) {
- this.diffCursor.moveDown();
+ this.diffCursor?.moveDown();
this._displayLine = true;
} else {
if (e.key === Key.DOWN) return;
@@ -911,7 +913,7 @@
_handleCursorPrev(e: KeyboardEvent) {
if (this.filesExpanded === FilesExpandedState.ALL) {
- this.diffCursor.moveUp();
+ this.diffCursor?.moveUp();
this._displayLine = true;
} else {
if (e.key === Key.UP) return;
@@ -922,7 +924,7 @@
_handleNewComment() {
this.classList.remove('hideComments');
- this.diffCursor.createCommentInPlace();
+ this.diffCursor?.createCommentInPlace();
}
handleOpenFile() {
@@ -935,22 +937,22 @@
_handleNextChunk() {
if (this._noDiffsExpanded()) return;
- this.diffCursor.moveToNextChunk();
+ this.diffCursor?.moveToNextChunk();
}
_handleNextComment() {
if (this._noDiffsExpanded()) return;
- this.diffCursor.moveToNextCommentThread();
+ this.diffCursor?.moveToNextCommentThread();
}
_handlePrevChunk() {
if (this._noDiffsExpanded()) return;
- this.diffCursor.moveToPreviousChunk();
+ this.diffCursor?.moveToPreviousChunk();
}
_handlePrevComment() {
if (this._noDiffsExpanded()) return;
- this.diffCursor.moveToPreviousCommentThread();
+ this.diffCursor?.moveToPreviousCommentThread();
}
_handleToggleFileReviewed() {
@@ -975,7 +977,7 @@
}
_openCursorFile() {
- const diff = this.diffCursor.getTargetDiffElement();
+ const diff = this.diffCursor?.getTargetDiffElement();
if (!this.change || !diff || !this.patchRange || !diff.path) {
throw new Error('change, diff and patchRange must be all set and valid');
}
@@ -1192,7 +1194,7 @@
_updateDiffCursor() {
// Overwrite the cursor's list of diffs:
- this.diffCursor.replaceDiffs(this.diffs);
+ this.diffCursor?.replaceDiffs(this.diffs);
}
_filesChanged() {
@@ -1325,7 +1327,7 @@
}
this._updateDiffCursor();
- this.diffCursor.reInitAndUpdateStops();
+ this.diffCursor?.reInitAndUpdateStops();
}
// private but used in test
@@ -1407,7 +1409,7 @@
* prevented the issue of scrolling to top when we expand the second
* file individually.
*/
- this.diffCursor.reInitAndUpdateStops();
+ this.diffCursor?.reInitAndUpdateStops();
}
/** Cancel the rendering work of every diff in the list */
diff --git a/polygerrit-ui/app/elements/change/gr-file-list/gr-file-list_test.ts b/polygerrit-ui/app/elements/change/gr-file-list/gr-file-list_test.ts
index 042ffc1..cc977f1 100644
--- a/polygerrit-ui/app/elements/change/gr-file-list/gr-file-list_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-file-list/gr-file-list_test.ts
@@ -14,10 +14,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
import '../../../test/common-test-setup-karma';
import '../../shared/gr-date-formatter/gr-date-formatter';
-import {getMockDiffResponse} from '../../../test/mocks/diff-response';
import './gr-file-list';
import {createCommentApiMockWithTemplateElement} from '../../../test/mocks/comment-api';
import {FilesExpandedState} from '../gr-file-list-constants';
@@ -47,11 +45,16 @@
import {
createChangeComments,
createCommit,
+ createDiff,
createParsedChange,
createRevision,
} from '../../../test/test-data-generators';
import {createDefaultDiffPrefs} from '../../../constants/constants';
-import {queryAll, queryAndAssert} from '../../../utils/common-util';
+import {
+ assertIsDefined,
+ queryAll,
+ queryAndAssert,
+} from '../../../utils/common-util';
import {GrFileList, NormalizedFileInfo} from './gr-file-list';
import {DiffPreferencesInfo} from '../../../types/diff';
import {GrButton} from '../../shared/gr-button/gr-button';
@@ -75,6 +78,15 @@
});
});
+function createFilesByPath(count: number) {
+ return Array(count)
+ .fill(0)
+ .reduce((_filesByPath, _, idx) => {
+ _filesByPath[`'/file${idx}`] = {lines_inserted: 9};
+ return _filesByPath;
+ }, {});
+}
+
suite('gr-file-list tests', () => {
let element: GrFileList;
let commentApiWrapper: any;
@@ -110,14 +122,205 @@
.callsFake(() => Promise.resolve());
});
+ test('renders', () => {
+ expect(element).shadowDom.to.equal(/* HTML */ `<h3
+ class="assistive-tech-only"
+ >
+ File list
+ </h3>
+ <div aria-label="Files list" id="container" role="grid">
+ <div class="header-row row" role="row">
+ <dom-if style="display: none;">
+ <template is="dom-if"> </template>
+ </dom-if>
+ <div class="path" role="columnheader">File</div>
+ <div class="comments desktop" role="columnheader">Comments</div>
+ <div class="comments mobile" role="columnheader" title="Comments">
+ C
+ </div>
+ <div class="desktop sizeBars" role="columnheader">Size</div>
+ <div class="header-stats" role="columnheader">Delta</div>
+ <dom-if style="display: none;">
+ <template is="dom-if"> </template>
+ </dom-if>
+ <div
+ aria-hidden="true"
+ class="hideOnEdit reviewed"
+ hidden="true"
+ ></div>
+ <div aria-hidden="true" class="editFileControls showOnEdit"></div>
+ <div aria-hidden="true" class="show-hide"></div>
+ </div>
+ <dom-repeat
+ as="file"
+ id="files"
+ style="display: none;"
+ target-framerate="1"
+ >
+ <template is="dom-repeat"> </template>
+ </dom-repeat>
+ <dom-if style="display: none;">
+ <template is="dom-if"> </template>
+ </dom-if>
+ </div>
+ <div class="row totalChanges" hidden="true">
+ <div class="total-stats">
+ <div>
+ <span aria-label="Total 0 lines added" class="added" tabindex="0">
+ +0
+ </span>
+ <span
+ aria-label="Total 0 lines removed"
+ class="removed"
+ tabindex="0"
+ >
+ -0
+ </span>
+ </div>
+ </div>
+ <dom-if style="display: none;">
+ <template is="dom-if"> </template>
+ </dom-if>
+ <div class="hideOnEdit reviewed" hidden="true"></div>
+ <div class="editFileControls showOnEdit"></div>
+ <div class="show-hide"></div>
+ </div>
+ <div class="row totalChanges" hidden="true">
+ <div class="total-stats">
+ <span aria-label="Total bytes inserted: +/-0 B " class="added">
+ +/-0 B
+ </span>
+ <span aria-label="Total bytes removed: +/-0 B" class="removed">
+ +/-0 B
+ </span>
+ </div>
+ </div>
+ <div class="controlRow invisible row">
+ <gr-button
+ aria-disabled="false"
+ class="fileListButton"
+ id="incrementButton"
+ link=""
+ role="button"
+ tabindex="0"
+ >
+ Show -200 more
+ </gr-button>
+ <gr-tooltip-content title="">
+ <gr-button
+ aria-disabled="false"
+ class="fileListButton"
+ id="showAllButton"
+ link=""
+ role="button"
+ tabindex="0"
+ >
+ Show all 0 files
+ </gr-button>
+ </gr-tooltip-content>
+ </div>
+ <gr-diff-preferences-dialog
+ id="diffPreferencesDialog"
+ ></gr-diff-preferences-dialog>`);
+ });
+
+ test('renders file row', () => {
+ element._filesByPath = createFilesByPath(1);
+ flush();
+ const fileRows = queryAll<HTMLDivElement>(element, '.file-row');
+ expect(fileRows?.[0]).dom.equal(/* HTML */ `<div
+ class="file-row row"
+ data-file='{"path":"'/file0"}'
+ role="row"
+ tabindex="-1"
+ >
+ <dom-if style="display: none;">
+ <template is="dom-if"> </template>
+ </dom-if>
+ <span class="path" role="gridcell">
+ <a class="pathLink">
+ <span class="fullFileName" title="'/file0"> '/file0 </span>
+ <span class="truncatedFileName" title="'/file0"> …/file0 </span>
+ <gr-file-status-chip> </gr-file-status-chip>
+ <gr-copy-clipboard hideinput=""> </gr-copy-clipboard>
+ </a>
+ <dom-if style="display: none;">
+ <template is="dom-if"> </template>
+ </dom-if>
+ </span>
+ <div role="gridcell">
+ <div class="comments desktop">
+ <span class="drafts"> </span> <span> </span>
+ <span class="noCommentsScreenReaderText"> No comments </span>
+ </div>
+ <div class="comments mobile">
+ <span class="drafts"> </span> <span> </span>
+ <span class="noCommentsScreenReaderText"> No comments </span>
+ </div>
+ </div>
+ <div class="desktop" role="gridcell">
+ <div
+ aria-label="A bar that represents the addition and deletion ratio for the current file"
+ class="sizeBars"
+ ></div>
+ </div>
+ <div class="stats" role="gridcell">
+ <div>
+ <span aria-label="9 lines added" class="added" tabindex="0">
+ +9
+ </span>
+ <span aria-label="0 lines removed" class="removed" tabindex="0">
+ -0
+ </span>
+ <span hidden="true"> +/-0 B </span>
+ </div>
+ </div>
+ <dom-if style="display: none;">
+ <template is="dom-if"> </template>
+ </dom-if>
+ <div class="hideOnEdit reviewed" hidden="true" role="gridcell">
+ <span aria-hidden="true" class="reviewedLabel"> Reviewed </span>
+ <span
+ aria-checked="false"
+ aria-label="Reviewed"
+ class="reviewedSwitch"
+ role="switch"
+ tabindex="0"
+ >
+ <span
+ class="markReviewed"
+ tabindex="-1"
+ title="Mark as reviewed (shortcut: r)"
+ >
+ MARK REVIEWED
+ </span>
+ </span>
+ </div>
+ <div class="editFileControls showOnEdit" role="gridcell">
+ <dom-if style="display: none;">
+ <template is="dom-if"> </template>
+ </dom-if>
+ </div>
+ <div class="show-hide" role="gridcell">
+ <span
+ aria-checked="false"
+ aria-label="Expand file"
+ class="show-hide"
+ data-expand="true"
+ data-path="'/file0"
+ role="switch"
+ tabindex="0"
+ >
+ <iron-icon class="show-hide-icon" id="icon" tabindex="-1">
+ </iron-icon>
+ </span>
+ </div>
+ </div>`);
+ });
+
test('correct number of files are shown', () => {
element.fileListIncrement = 300;
- element._filesByPath = Array(500)
- .fill(0)
- .reduce((_filesByPath, _, idx) => {
- _filesByPath[`'/file${idx}`] = {lines_inserted: 9};
- return _filesByPath;
- }, {});
+ element._filesByPath = createFilesByPath(500);
flush();
assert.equal(
@@ -148,13 +351,7 @@
test('rendering each row calls the _reportRenderedRow method', () => {
const renderedStub = sinon.stub(element, '_reportRenderedRow');
- element._filesByPath = Array(10)
- .fill(0)
- .reduce((_filesByPath, _, idx) => {
- _filesByPath[`/file${idx}`] = {lines_inserted: 9};
- return _filesByPath;
- }, {});
- flush();
+ element._filesByPath = createFilesByPath(10);
assert.equal(queryAll<HTMLDivElement>(element, '.file-row').length, 10);
assert.equal(renderedStub.callCount, 10);
});
@@ -702,6 +899,7 @@
MockInteractions.pressAndReleaseKeyOn(element, 75, null, 'k');
assert.equal(element.fileCursor.index, 1);
assert.equal(element.selectedIndex, 1);
+ assertIsDefined(element.diffCursor);
const createCommentInPlaceStub = sinon.stub(
element.diffCursor,
@@ -819,6 +1017,7 @@
});
test('shift+left/shift+right', () => {
+ assertIsDefined(element.diffCursor);
const moveLeftStub = sinon.stub(element.diffCursor, 'moveLeft');
const moveRightStub = sinon.stub(element.diffCursor, 'moveRight');
@@ -1093,6 +1292,7 @@
test('expandAllDiffs and collapseAllDiffs', () => {
const collapseStub = sinon.stub(element, '_clearCollapsedDiffs');
+ assertIsDefined(element.diffCursor);
const cursorUpdateStub = sinon.stub(
element.diffCursor,
'handleDiffUpdate'
@@ -1754,7 +1954,7 @@
syntax_highlighting: true,
ignore_whitespace: 'IGNORE_NONE',
};
- diff.diff = getMockDiffResponse();
+ diff.diff = createDiff();
await listenOnce(diff, 'render');
}
@@ -1765,6 +1965,7 @@
await setupDiff(diffs[i]);
}
+ assertIsDefined(element.diffCursor);
element._updateDiffCursor();
element.diffCursor.handleDiffUpdate();
return diffs;
@@ -1925,6 +2126,7 @@
setup(() => {
sinon.stub(element, '_renderInOrder').returns(Promise.resolve());
+ assertIsDefined(element.diffCursor);
nextCommentStub = sinon.stub(
element.diffCursor,
'moveToNextCommentThread'
diff --git a/polygerrit-ui/app/elements/change/gr-message/gr-message.ts b/polygerrit-ui/app/elements/change/gr-message/gr-message.ts
index 8664de3..f9afd8c 100644
--- a/polygerrit-ui/app/elements/change/gr-message/gr-message.ts
+++ b/polygerrit-ui/app/elements/change/gr-message/gr-message.ts
@@ -21,12 +21,11 @@
import '../../shared/gr-button/gr-button';
import '../../shared/gr-date-formatter/gr-date-formatter';
import '../../shared/gr-formatted-text/gr-formatted-text';
-import '../../../styles/shared-styles';
import '../gr-message-scores/gr-message-scores';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-message_html';
+import {css, html, LitElement, nothing, PropertyValues} from 'lit';
import {MessageTag, SpecialFilePath} from '../../../constants/constants';
-import {customElement, property, computed, observe} from '@polymer/decorators';
+import {customElement, property, state} from 'lit/decorators';
+import {hasOwnProperty} from '../../../utils/common-util';
import {
ChangeInfo,
ServerInfo,
@@ -38,13 +37,16 @@
PatchSetNum,
AccountInfo,
BasePatchSetNum,
+ LabelNameToInfoMap,
} from '../../../types/common';
import {
ChangeMessage,
CommentThread,
+ isFormattedReviewerUpdate,
LabelExtreme,
PATCH_SET_PREFIX_PATTERN,
} from '../../../utils/comment-util';
+import {LABEL_TITLE_SCORE_PATTERN} from '../gr-message-scores/gr-message-scores';
import {getAppContext} from '../../../services/app-context';
import {pluralize} from '../../../utils/string-util';
import {GerritNav} from '../../core/gr-navigation/gr-navigation';
@@ -54,6 +56,9 @@
computePredecessor,
} from '../../../utils/patch-set-util';
import {isServiceUser, replaceTemplates} from '../../../utils/account-util';
+import {assertIsDefined} from '../../../utils/common-util';
+import {when} from 'lit/directives/when';
+import {FormattedReviewerUpdateInfo} from '../../../types/types';
const UPLOADED_NEW_PATCHSET_PATTERN = /Uploaded patch set (\d+)./;
const MERGED_PATCHSET_PATTERN = /(\d+) is the latest approved patch-set/;
@@ -68,11 +73,7 @@
}
@customElement('gr-message')
-export class GrMessage extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrMessage extends LitElement {
/**
* Fired when this message's reply link is tapped.
*
@@ -98,12 +99,11 @@
changeNum?: NumericChangeId;
@property({type: Object})
- message: ChangeMessage | undefined;
+ message?: ChangeMessage | (ChangeMessage & FormattedReviewerUpdateInfo);
@property({type: Array})
commentThreads: CommentThread[] = [];
- @computed('message')
get author() {
return this.message?.author || this.message?.updated_by;
}
@@ -114,31 +114,8 @@
@property({type: Boolean})
hideAutomated = false;
- @property({
- type: Boolean,
- reflectToAttribute: true,
- computed: '_computeIsHidden(hideAutomated, isAutomated)',
- })
- override hidden = false;
-
- @computed('message')
- get isAutomated() {
- return !!this.message && this._computeIsAutomated(this.message);
- }
-
- @computed('message')
- get showOnBehalfOf() {
- return !!this.message && this._computeShowOnBehalfOf(this.message);
- }
-
- @property({
- type: Boolean,
- computed: '_computeShowReplyButton(message, _loggedIn)',
- })
- showReplyButton = false;
-
@property({type: String})
- projectName?: string;
+ projectName?: RepoName;
/**
* A mapping from label names to objects representing the minimum and
@@ -147,51 +124,23 @@
@property({type: Object})
labelExtremes?: LabelExtreme;
- @property({type: Object})
- _projectConfig?: ConfigInfo;
+ @state()
+ private projectConfig?: ConfigInfo;
@property({type: Boolean})
- _loggedIn = false;
+ loggedIn = false;
- @property({type: Boolean})
- _isAdmin = false;
+ @state()
+ private isAdmin = false;
- @property({type: Boolean})
- _isDeletingChangeMsg = false;
-
- @property({type: Boolean, computed: '_computeExpanded(message.expanded)'})
- _expanded = false;
-
- @property({
- type: String,
- computed:
- '_computeMessageContentExpanded(_expanded, message.message,' +
- ' message.accounts_in_message,' +
- ' message.tag)',
- })
- _messageContentExpanded = '';
-
- @property({
- type: String,
- computed:
- '_computeMessageContentCollapsed(message.message,' +
- ' message.accounts_in_message,' +
- ' message.tag,' +
- ' commentThreads)',
- })
- _messageContentCollapsed = '';
-
- @property({
- type: String,
- computed: '_computeCommentCountText(commentThreads)',
- })
- _commentCountText = '';
+ @state()
+ private isDeletingChangeMsg = false;
private readonly restApiService = getAppContext().restApiService;
constructor() {
super();
- this.addEventListener('click', e => this._handleClick(e));
+ this.addEventListener('click', e => this.handleClick(e));
}
override connectedCallback() {
@@ -200,44 +149,382 @@
this.config = config;
});
this.restApiService.getLoggedIn().then(loggedIn => {
- this._loggedIn = loggedIn;
+ this.loggedIn = loggedIn;
});
this.restApiService.getIsAdmin().then(isAdmin => {
- this._isAdmin = !!isAdmin;
+ this.isAdmin = !!isAdmin;
});
}
- @observe('message.expanded')
- _updateExpandedClass(expanded: boolean) {
- if (expanded) {
+ static override get styles() {
+ return css`
+ :host {
+ display: block;
+ position: relative;
+ cursor: pointer;
+ overflow-y: hidden;
+ }
+ :host(.expanded) {
+ cursor: auto;
+ }
+ .collapsed .contentContainer {
+ align-items: center;
+ color: var(--deemphasized-text-color);
+ display: flex;
+ white-space: nowrap;
+ }
+ .contentContainer {
+ padding: var(--spacing-m) var(--spacing-l);
+ }
+ .expanded .contentContainer {
+ background-color: var(--background-color-secondary);
+ }
+ .collapsed .contentContainer {
+ background-color: var(--background-color-primary);
+ }
+ div.serviceUser.expanded div.contentContainer {
+ background-color: var(
+ --background-color-service-user,
+ var(--background-color-secondary)
+ );
+ }
+ div.serviceUser.collapsed div.contentContainer {
+ background-color: var(
+ --background-color-service-user,
+ var(--background-color-primary)
+ );
+ }
+ .name {
+ font-weight: var(--font-weight-bold);
+ }
+ .message {
+ --gr-formatted-text-prose-max-width: 120ch;
+ }
+ .collapsed .message {
+ max-width: none;
+ overflow: hidden;
+ text-overflow: ellipsis;
+ }
+ .collapsed .author,
+ .collapsed .content,
+ .collapsed .message,
+ .collapsed .updateCategory,
+ gr-account-chip {
+ display: inline;
+ }
+ gr-button {
+ margin: 0 -4px;
+ }
+ .collapsed gr-thread-list,
+ .collapsed .replyBtn,
+ .collapsed .deleteBtn,
+ .collapsed .hideOnCollapsed,
+ .hideOnOpen {
+ display: none;
+ }
+ .replyBtn {
+ margin-right: var(--spacing-m);
+ }
+ .collapsed .hideOnOpen {
+ display: block;
+ }
+ .collapsed .content {
+ flex: 1;
+ margin-right: var(--spacing-m);
+ min-width: 0;
+ overflow: hidden;
+ }
+ .collapsed .content.messageContent {
+ text-overflow: ellipsis;
+ }
+ .collapsed .dateContainer {
+ position: static;
+ }
+ .collapsed .author {
+ overflow: hidden;
+ color: var(--primary-text-color);
+ margin-right: var(--spacing-s);
+ }
+ .authorLabel {
+ min-width: 130px;
+ --account-max-length: 120px;
+ margin-right: var(--spacing-s);
+ }
+ .expanded .author {
+ cursor: pointer;
+ margin-bottom: var(--spacing-m);
+ }
+ .expanded .content {
+ padding-left: 40px;
+ }
+ .dateContainer {
+ position: absolute;
+ /* right and top values should match .contentContainer padding */
+ right: var(--spacing-l);
+ top: var(--spacing-m);
+ }
+ .dateContainer gr-button {
+ margin-right: var(--spacing-m);
+ color: var(--deemphasized-text-color);
+ }
+ .dateContainer .patchset:before {
+ content: 'Patchset ';
+ }
+ .dateContainer .patchsetDiffButton {
+ margin-right: var(--spacing-m);
+ --gr-button-padding: 0 var(--spacing-m);
+ }
+ span.date {
+ color: var(--deemphasized-text-color);
+ }
+ span.date:hover {
+ text-decoration: underline;
+ }
+ .dateContainer iron-icon {
+ cursor: pointer;
+ vertical-align: top;
+ }
+ .commentsSummary {
+ margin-right: var(--spacing-s);
+ min-width: 115px;
+ }
+ .expanded .commentsSummary {
+ display: none;
+ }
+ .commentsIcon {
+ vertical-align: top;
+ }
+ gr-account-label::part(gr-account-label-text) {
+ font-weight: var(--font-weight-bold);
+ }
+ iron-icon {
+ --iron-icon-height: 20px;
+ --iron-icon-width: 20px;
+ }
+ @media screen and (max-width: 50em) {
+ .expanded .content {
+ padding-left: 0;
+ }
+ .commentsSummary {
+ min-width: 0px;
+ }
+ .authorLabel {
+ width: 100px;
+ }
+ .dateContainer .patchset:before {
+ content: 'PS ';
+ }
+ }
+ `;
+ }
+
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('projectName')) {
+ this.projectNameChanged();
+ }
+ }
+
+ override render() {
+ if (!this.message) return nothing;
+ if (this.hideAutomated && this.computeIsAutomated()) return nothing;
+ this.updateExpandedClass();
+ return html` <div class=${this.computeClass()}>
+ <div class="contentContainer">
+ ${this.renderAuthor()} ${this.renderCommentsSummary()}
+ ${this.renderMessageContent()} ${this.renderReviewerUpdate()}
+ ${this.renderDateContainer()}
+ </div>
+ </div>`;
+ }
+
+ private renderAuthor() {
+ assertIsDefined(this.message, 'message');
+ return html` <div class="author" @click=${this.handleAuthorClick}>
+ ${when(
+ this.computeShowOnBehalfOf(),
+ () => html`
+ <span>
+ <span class="name">${this.message?.real_author?.name}</span>
+ on behalf of
+ </span>
+ `
+ )}
+ <gr-account-label
+ .account=${this.author}
+ class="authorLabel"
+ ></gr-account-label>
+ <gr-message-scores
+ .labelExtremes=${this.labelExtremes}
+ .message=${this.message}
+ .change=${this.change}
+ ></gr-message-scores>
+ </div>`;
+ }
+
+ private renderCommentsSummary() {
+ if (!this.commentThreads?.length) return nothing;
+
+ const commentCountText = pluralize(this.commentThreads.length, 'comment');
+ return html`
+ <div class="commentsSummary">
+ <iron-icon icon="gr-icons:comment" class="commentsIcon"></iron-icon>
+ <span class="numberOfComments">${commentCountText}</span>
+ </div>
+ `;
+ }
+
+ private renderMessageContent() {
+ if (!this.message?.message) return nothing;
+ const messageContentCollapsed =
+ this.computeMessageContent(
+ false,
+ this.message.message.substring(0, 1000),
+ this.message.accounts_in_message,
+ this.message.tag,
+ this.change?.labels
+ ) || this.patchsetCommentSummary();
+ return html` <div class="content messageContent">
+ <div class="message hideOnOpen">${messageContentCollapsed}</div>
+ ${this.renderExpandedMessageContent()}
+ </div>`;
+ }
+
+ private renderExpandedMessageContent() {
+ if (!this.message?.expanded) return nothing;
+ const messageContentExpanded = this.computeMessageContent(
+ true,
+ this.message.message,
+ this.message.accounts_in_message,
+ this.message.tag,
+ this.change?.labels
+ );
+ return html`
+ <gr-formatted-text
+ noTrailingMargin
+ class="message hideOnCollapsed"
+ .content=${messageContentExpanded}
+ .config=${this.projectConfig?.commentlinks}
+ ></gr-formatted-text>
+ ${when(messageContentExpanded, () => this.renderActionContainer())}
+ <gr-thread-list
+ ?hidden=${!this.commentThreads.length}
+ .threads=${this.commentThreads}
+ hide-dropdown
+ show-comment-context
+ .messageId=${this.message.id}
+ >
+ </gr-thread-list>
+ `;
+ }
+
+ private renderActionContainer() {
+ if (!this.computeShowReplyButton()) return nothing;
+ return html` <div class="replyActionContainer">
+ <gr-button class="replyBtn" link="" @click=${this.handleReplyTap}>
+ Reply
+ </gr-button>
+ ${when(
+ this.isAdmin,
+ () => html`
+ <gr-button
+ ?disabled=${this.isDeletingChangeMsg}
+ class="deleteBtn"
+ link=""
+ @click=${this.handleDeleteMessage}
+ >
+ Delete
+ </gr-button>
+ `
+ )}
+ </div>`;
+ }
+
+ private renderReviewerUpdate() {
+ assertIsDefined(this.message, 'message');
+ if (!isFormattedReviewerUpdate(this.message)) return;
+ return html` <div class="content">
+ ${this.message.updates.map(update => this.renderMessageUpdate(update))}
+ </div>`;
+ }
+
+ private renderMessageUpdate(update: {
+ message: string;
+ reviewers: AccountInfo[];
+ }) {
+ return html`<div class="updateCategory">
+ ${update.message}
+ ${update.reviewers.map(
+ reviewer => html`
+ <gr-account-chip .account=${reviewer} .change=${this.change}>
+ </gr-account-chip>
+ `
+ )}
+ </div>`;
+ }
+
+ private renderDateContainer() {
+ return html`<span class="dateContainer">
+ ${this.renderDiffButton()}
+ ${when(
+ this.message?._revision_number,
+ () => html`
+ <span class="patchset">${this.message?._revision_number} |</span>
+ `
+ )}
+ ${when(
+ this.message?.id,
+ () => html`
+ <span class="date" @click=${this.handleAnchorClick}>
+ <gr-date-formatter
+ withTooltip
+ showDateAndTime
+ .dateStr=${this.message?.date}
+ ></gr-date-formatter>
+ </span>
+ `,
+ () => html`
+ <span class="date">
+ <gr-date-formatter
+ withTooltip
+ showDateAndTime
+ .dateStr=${this.message?.date}
+ ></gr-date-formatter>
+ </span>
+ `
+ )}
+ <iron-icon
+ id="expandToggle"
+ @click=${this.toggleExpanded}
+ title="Toggle expanded state"
+ icon=${this.computeExpandToggleIcon()}
+ ></iron-icon>
+ </span>`;
+ }
+
+ private renderDiffButton() {
+ if (!this.showViewDiffButton()) return nothing;
+ return html` <gr-button
+ class="patchsetDiffButton"
+ @click=${this.handleViewPatchsetDiff}
+ link
+ >
+ View Diff
+ </gr-button>`;
+ }
+
+ private updateExpandedClass() {
+ if (this.message?.expanded) {
this.classList.add('expanded');
} else {
this.classList.remove('expanded');
}
}
- _computeCommentCountText(commentThreads?: CommentThread[]) {
- if (!commentThreads?.length) {
- return undefined;
- }
-
- return pluralize(commentThreads.length, 'comment');
- }
-
- _computeMessageContentExpanded(
- expanded: boolean,
- content?: string,
- accountsInMessage?: AccountInfo[],
- tag?: ReviewInputTag
- ) {
- if (!expanded) return '';
- return this._computeMessageContent(true, content, accountsInMessage, tag);
- }
-
- _patchsetCommentSummary(commentThreads: CommentThread[] = []) {
+ // Private but used in tests.
+ patchsetCommentSummary() {
const id = this.message?.id;
if (!id) return '';
- const patchsetThreads = commentThreads.filter(
+ const patchsetThreads = (this.commentThreads ?? []).filter(
thread => thread.path === SpecialFilePath.PATCHSET_LEVEL_COMMENTS
);
for (const thread of patchsetThreads) {
@@ -258,45 +545,29 @@
return '';
}
- _computeMessageContentCollapsed(
- content?: string,
- accountsInMessage?: AccountInfo[],
- tag?: ReviewInputTag,
- commentThreads?: CommentThread[]
- ) {
- // Content is under text-overflow, so it's always shorten
- const shortenedContent = content?.substring(0, 1000);
- const summary = this._computeMessageContent(
- false,
- shortenedContent,
- accountsInMessage,
- tag
- );
- if (summary || !commentThreads) return summary;
- return this._patchsetCommentSummary(commentThreads);
- }
-
- _showViewDiffButton(message?: ChangeMessage) {
+ private showViewDiffButton() {
return (
- this._isNewPatchsetTag(message?.tag) || this._isMergePatchset(message)
+ this.isNewPatchsetTag(this.message?.tag) ||
+ this.isMergePatchset(this.message)
);
}
- _isMergePatchset(message?: ChangeMessage) {
+ private isMergePatchset(message?: ChangeMessage) {
return (
message?.tag === MessageTag.TAG_MERGED &&
message?.message.match(MERGED_PATCHSET_PATTERN)
);
}
- _isNewPatchsetTag(tag?: ReviewInputTag) {
+ private isNewPatchsetTag(tag?: ReviewInputTag) {
return (
tag === MessageTag.TAG_NEW_PATCHSET ||
tag === MessageTag.TAG_NEW_WIP_PATCHSET
);
}
- _handleViewPatchsetDiff(e: Event) {
+ // Private but used in tests
+ handleViewPatchsetDiff(e: Event) {
if (!this.message || !this.change) return;
let patchNum: PatchSetNum;
let basePatchNum: PatchSetNum;
@@ -323,14 +594,16 @@
e.stopPropagation();
}
- _computeMessageContent(
+ // private but used in tests
+ computeMessageContent(
isExpanded: boolean,
content?: string,
accountsInMessage?: AccountInfo[],
- tag?: ReviewInputTag
+ tag?: ReviewInputTag,
+ labels?: LabelNameToInfoMap
) {
if (!content) return '';
- const isNewPatchSet = this._isNewPatchsetTag(tag);
+ const isNewPatchSet = this.isNewPatchsetTag(tag);
if (accountsInMessage) {
content = replaceTemplates(content, accountsInMessage, this.config);
@@ -347,8 +620,24 @@
if (line.startsWith('(') && line.endsWith(' comments)')) {
return false;
}
- if (!isNewPatchSet && line.match(PATCH_SET_PREFIX_PATTERN)) {
- return false;
+ if (!isNewPatchSet && labels) {
+ // Legacy change messages may contain the 'Patch Set' prefix
+ // and a message(not containing label scores) on the same line.
+ // To handle them correctly, only filter out lines which contain
+ // the 'Patch Set' prefix and label scores.
+ const match = line.match(PATCH_SET_PREFIX_PATTERN);
+ if (match && match[1]) {
+ const message = match[1].split(' ');
+ if (
+ message
+ .map(s => s.match(LABEL_TITLE_SCORE_PATTERN))
+ .filter(
+ ms => ms && ms.length === 4 && hasOwnProperty(labels, ms[2])
+ ).length === message.length
+ ) {
+ return false;
+ }
+ }
}
return true;
});
@@ -363,7 +652,7 @@
// Only make this replacement if the line starts with Patch Set, since if
// it starts with "Uploaded patch set" (e.g for votes) we want to keep the
// "Uploaded patch set".
- if (isNewPatchSet && line.startsWith('Patch Set')) {
+ if (line.startsWith('Patch Set')) {
line = line.replace(PATCH_SET_PREFIX_PATTERN, '$1');
}
return line;
@@ -371,74 +660,68 @@
return mappedLines.join('\n').trim();
}
- _computeAuthor(message: ChangeMessage) {
- return message.author || message.updated_by;
- }
-
- _computeShowOnBehalfOf(message: ChangeMessage) {
- const author = this._computeAuthor(message);
+ // private but used in tests
+ computeShowOnBehalfOf() {
+ if (!this.message) return false;
return !!(
- author &&
- message.real_author &&
- author._account_id !== message.real_author._account_id
+ this.author &&
+ this.message.real_author &&
+ this.author._account_id !== this.message.real_author._account_id
);
}
- _computeShowReplyButton(message?: ChangeMessage, loggedIn?: boolean) {
+ // private but used in tests.
+ computeShowReplyButton() {
return (
- message &&
- !!message.message &&
- loggedIn &&
- !this._computeIsAutomated(message)
+ !!this.message &&
+ !!this.message.message &&
+ this.loggedIn &&
+ !this.computeIsAutomated()
);
}
- _computeExpanded(expanded: boolean) {
- return expanded;
- }
-
- _handleClick(e: Event) {
- if (this.message?.expanded) {
+ private handleClick(e: Event) {
+ if (!this.message || this.message?.expanded) {
return;
}
e.stopPropagation();
- this.set('message.expanded', true);
+ this.message.expanded = true;
+ this.requestUpdate();
}
- _handleAuthorClick(e: Event) {
- if (!this.message?.expanded) {
+ private handleAuthorClick(e: Event) {
+ if (!this.message || !this.message?.expanded) {
return;
}
e.stopPropagation();
- this.set('message.expanded', false);
+ this.message.expanded = false;
+ this.requestUpdate();
}
- _computeIsAutomated(message: ChangeMessage) {
+ // private but used in tests.
+ computeIsAutomated() {
return !!(
- message.reviewer ||
- this._computeIsReviewerUpdate(message) ||
- (message.tag && message.tag.startsWith('autogenerated'))
+ this.message?.reviewer ||
+ this.computeIsReviewerUpdate() ||
+ (this.message?.tag && this.message.tag.startsWith('autogenerated'))
);
}
- _computeIsHidden(hideAutomated: boolean, isAutomated: boolean) {
- return hideAutomated && isAutomated;
+ private computeIsReviewerUpdate() {
+ return this.message?.type === 'REVIEWER_UPDATE';
}
- _computeIsReviewerUpdate(message: ChangeMessage) {
- return message.type === 'REVIEWER_UPDATE';
- }
-
- _computeClass(expanded?: boolean, author?: AccountInfo) {
+ private computeClass() {
+ const expanded = this.message?.expanded;
const classes = [];
classes.push(expanded ? 'expanded' : 'collapsed');
- if (isServiceUser(author)) classes.push('serviceUser');
+ if (isServiceUser(this.author)) classes.push('serviceUser');
return classes.join(' ');
}
- _handleAnchorClick(e: Event) {
+ private handleAnchorClick(e: Event) {
e.preventDefault();
- // The element which triggers _handleAnchorClick is rendered only if
+ // The element which triggers handleAnchorClick is rendered only if
// message.id defined: the element is wrapped in dom-if if="[[message.id]]"
const detail: MessageAnchorTapDetail = {
id: this.message!.id,
@@ -452,7 +735,7 @@
);
}
- _handleReplyTap(e: Event) {
+ private handleReplyTap(e: Event) {
e.preventDefault();
this.dispatchEvent(
new CustomEvent('reply', {
@@ -463,14 +746,14 @@
);
}
- _handleDeleteMessage(e: Event) {
+ private handleDeleteMessage(e: Event) {
e.preventDefault();
if (!this.message || !this.message.id || !this.changeNum) return;
- this._isDeletingChangeMsg = true;
+ this.isDeletingChangeMsg = true;
this.restApiService
.deleteChangeCommitMessage(this.changeNum, this.message.id)
.then(() => {
- this._isDeletingChangeMsg = false;
+ this.isDeletingChangeMsg = false;
this.dispatchEvent(
new CustomEvent('change-message-deleted', {
detail: {message: this.message},
@@ -481,23 +764,25 @@
});
}
- @observe('projectName')
- _projectNameChanged(name?: string) {
- if (!name) {
- this._projectConfig = undefined;
+ private projectNameChanged() {
+ if (!this.projectName) {
+ this.projectConfig = undefined;
return;
}
- this.restApiService.getProjectConfig(name as RepoName).then(config => {
- this._projectConfig = config;
+ this.restApiService.getProjectConfig(this.projectName).then(config => {
+ this.projectConfig = config;
});
}
- _computeExpandToggleIcon(expanded: boolean) {
- return expanded ? 'gr-icons:expand-less' : 'gr-icons:expand-more';
+ private computeExpandToggleIcon() {
+ return this.message?.expanded
+ ? 'gr-icons:expand-less'
+ : 'gr-icons:expand-more';
}
- _toggleExpanded(e: Event) {
+ private toggleExpanded(e: Event) {
e.stopPropagation();
- this.set('message.expanded', !this.message?.expanded);
+ if (!this.message) return;
+ this.message = {...this.message, expanded: !this.message.expanded};
}
}
diff --git a/polygerrit-ui/app/elements/change/gr-message/gr-message_html.ts b/polygerrit-ui/app/elements/change/gr-message/gr-message_html.ts
deleted file mode 100644
index 70e6381..0000000
--- a/polygerrit-ui/app/elements/change/gr-message/gr-message_html.ts
+++ /dev/null
@@ -1,307 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style>
- :host {
- display: block;
- position: relative;
- cursor: pointer;
- overflow-y: hidden;
- }
- :host(.expanded) {
- cursor: auto;
- }
- .collapsed .contentContainer {
- align-items: center;
- color: var(--deemphasized-text-color);
- display: flex;
- white-space: nowrap;
- }
- .contentContainer {
- padding: var(--spacing-m) var(--spacing-l);
- }
- .expanded .contentContainer {
- background-color: var(--background-color-secondary);
- }
- .collapsed .contentContainer {
- background-color: var(--background-color-primary);
- }
- div.serviceUser.expanded div.contentContainer {
- background-color: var(
- --background-color-service-user,
- var(--background-color-secondary)
- );
- }
- div.serviceUser.collapsed div.contentContainer {
- background-color: var(
- --background-color-service-user,
- var(--background-color-primary)
- );
- }
- .name {
- font-weight: var(--font-weight-bold);
- }
- .message {
- --gr-formatted-text-prose-max-width: 120ch;
- }
- .collapsed .message {
- max-width: none;
- overflow: hidden;
- text-overflow: ellipsis;
- }
- .collapsed .author,
- .collapsed .content,
- .collapsed .message,
- .collapsed .updateCategory,
- gr-account-chip {
- display: inline;
- }
- gr-button {
- margin: 0 -4px;
- }
- .collapsed gr-thread-list,
- .collapsed .replyBtn,
- .collapsed .deleteBtn,
- .collapsed .hideOnCollapsed,
- .hideOnOpen {
- display: none;
- }
- .replyBtn {
- margin-right: var(--spacing-m);
- }
- .collapsed .hideOnOpen {
- display: block;
- }
- .collapsed .content {
- flex: 1;
- margin-right: var(--spacing-m);
- min-width: 0;
- overflow: hidden;
- }
- .collapsed .content.messageContent {
- text-overflow: ellipsis;
- }
- .collapsed .dateContainer {
- position: static;
- }
- .collapsed .author {
- overflow: hidden;
- color: var(--primary-text-color);
- margin-right: var(--spacing-s);
- }
- .authorLabel {
- min-width: 130px;
- --account-max-length: 120px;
- margin-right: var(--spacing-s);
- }
- .expanded .author {
- cursor: pointer;
- margin-bottom: var(--spacing-m);
- }
- .expanded .content {
- padding-left: 40px;
- }
- .dateContainer {
- position: absolute;
- /* right and top values should match .contentContainer padding */
- right: var(--spacing-l);
- top: var(--spacing-m);
- }
- .dateContainer gr-button {
- margin-right: var(--spacing-m);
- color: var(--deemphasized-text-color);
- }
- .dateContainer .patchset:before {
- content: 'Patchset ';
- }
- .dateContainer .patchsetDiffButton {
- margin-right: var(--spacing-m);
- --gr-button-padding: 0 var(--spacing-m);
- }
- span.date {
- color: var(--deemphasized-text-color);
- }
- span.date:hover {
- text-decoration: underline;
- }
- .dateContainer iron-icon {
- cursor: pointer;
- vertical-align: top;
- }
- .commentsSummary {
- margin-right: var(--spacing-s);
- min-width: 115px;
- }
- .expanded .commentsSummary {
- display: none;
- }
- .commentsIcon {
- vertical-align: top;
- }
- gr-account-label::part(gr-account-label-text) {
- font-weight: var(--font-weight-bold);
- }
- iron-icon {
- --iron-icon-height: 20px;
- --iron-icon-width: 20px;
- }
- @media screen and (max-width: 50em) {
- .expanded .content {
- padding-left: 0;
- }
- .commentsSummary {
- min-width: 0px;
- }
- .authorLabel {
- width: 100px;
- }
- .dateContainer .patchset:before {
- content: 'PS ';
- }
- }
- </style>
- <div class$="[[_computeClass(_expanded, author)]]">
- <div class="contentContainer">
- <div class="author" on-click="_handleAuthorClick">
- <span hidden$="[[!showOnBehalfOf]]">
- <span class="name">[[message.real_author.name]]</span>
- on behalf of
- </span>
- <gr-account-label
- account="[[author]]"
- class="authorLabel"
- ></gr-account-label>
- <gr-message-scores
- label-extremes="[[labelExtremes]]"
- message="[[message]]"
- change="[[change]]"
- ></gr-message-scores>
- </div>
- <template is="dom-if" if="[[_commentCountText]]">
- <div class="commentsSummary">
- <iron-icon icon="gr-icons:comment" class="commentsIcon"></iron-icon>
- <span class="numberOfComments">[[_commentCountText]]</span>
- </div>
- </template>
- <template is="dom-if" if="[[message.message]]">
- <div class="content messageContent">
- <div class="message hideOnOpen">[[_messageContentCollapsed]]</div>
- <template is="dom-if" if="[[_expanded]]">
- <gr-formatted-text
- noTrailingMargin
- class="message hideOnCollapsed"
- content="[[_messageContentExpanded]]"
- config="[[_projectConfig.commentlinks]]"
- ></gr-formatted-text>
- <template is="dom-if" if="[[_messageContentExpanded]]">
- <div
- class="replyActionContainer"
- hidden$="[[!showReplyButton]]"
- hidden=""
- >
- <gr-button
- class="replyBtn"
- link=""
- small=""
- on-click="_handleReplyTap"
- >
- Reply
- </gr-button>
- <gr-button
- disabled$="[[_isDeletingChangeMsg]]"
- class="deleteBtn"
- hidden$="[[!_isAdmin]]"
- hidden=""
- link=""
- small=""
- on-click="_handleDeleteMessage"
- >
- Delete
- </gr-button>
- </div>
- </template>
- <gr-thread-list
- hidden$="[[!commentThreads.length]]"
- threads="[[commentThreads]]"
- hide-dropdown
- show-comment-context
- message-id="[[message.id]]"
- >
- </gr-thread-list>
- </template>
- </div>
- </template>
- <template is="dom-if" if="[[_computeIsReviewerUpdate(message)]]">
- <div class="content">
- <template is="dom-repeat" items="[[message.updates]]" as="update">
- <div class="updateCategory">
- [[update.message]]
- <template
- is="dom-repeat"
- items="[[update.reviewers]]"
- as="reviewer"
- >
- <gr-account-chip account="[[reviewer]]" change="[[change]]">
- </gr-account-chip>
- </template>
- </div>
- </template>
- </div>
- </template>
- <span class="dateContainer">
- <template is="dom-if" if="[[_showViewDiffButton(message)]]">
- <gr-button
- class="patchsetDiffButton"
- on-click="_handleViewPatchsetDiff"
- link
- >
- View Diff
- </gr-button>
- </template>
- <template is="dom-if" if="[[message._revision_number]]">
- <span class="patchset">[[message._revision_number]] |</span>
- </template>
- <template is="dom-if" if="[[!message.id]]">
- <span class="date">
- <gr-date-formatter
- withTooltip
- showDateAndTime
- date-str="[[message.date]]"
- ></gr-date-formatter>
- </span>
- </template>
- <template is="dom-if" if="[[message.id]]">
- <span class="date" on-click="_handleAnchorClick">
- <gr-date-formatter
- withTooltip
- showDateAndTime
- date-str="[[message.date]]"
- ></gr-date-formatter>
- </span>
- </template>
- <iron-icon
- id="expandToggle"
- on-click="_toggleExpanded"
- title="Toggle expanded state"
- icon="[[_computeExpandToggleIcon(_expanded)]]"
- ></iron-icon>
- </span>
- </div>
- </div>
-`;
diff --git a/polygerrit-ui/app/elements/change/gr-message/gr-message_test.ts b/polygerrit-ui/app/elements/change/gr-message/gr-message_test.ts
index ffe59f0..6e550ac 100644
--- a/polygerrit-ui/app/elements/change/gr-message/gr-message_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-message/gr-message_test.ts
@@ -24,6 +24,7 @@
createChangeMessage,
createComment,
createRevisions,
+ createLabelInfo,
} from '../../../test/test-data-generators';
import {
mockPromise,
@@ -51,8 +52,8 @@
import {GrButton} from '../../shared/gr-button/gr-button';
import {CommentSide} from '../../../constants/constants';
import {SinonStubbedMember} from 'sinon';
-
-const basicFixture = fixtureFromElement('gr-message');
+import {html} from 'lit';
+import {fixture} from '@open-wc/testing-helpers';
suite('gr-message tests', () => {
let element: GrMessage;
@@ -60,8 +61,7 @@
suite('when admin and logged in', () => {
setup(async () => {
stubRestApi('getIsAdmin').returns(Promise.resolve(true));
- element = basicFixture.instantiate();
- await flush();
+ element = await fixture<GrMessage>(html`<gr-message></gr-message>`);
});
test('reply event', async () => {
@@ -85,9 +85,7 @@
promise.resolve();
});
await flush();
- assert.isFalse(
- queryAndAssert<HTMLElement>(element, '.replyActionContainer').hidden
- );
+ assert.isOk(query<HTMLElement>(element, '.replyActionContainer'));
tap(queryAndAssert(element, '.replyBtn'));
await promise;
});
@@ -106,9 +104,9 @@
_revision_number: 1 as PatchSetNum,
expanded: true,
};
+ await element.updateComplete;
- await flush();
- assert.isFalse(queryAndAssert<HTMLElement>(element, '.deleteBtn').hidden);
+ assert.isOk(query<HTMLElement>(element, '.deleteBtn'));
});
test('delete change message', async () => {
@@ -126,11 +124,13 @@
_revision_number: 1 as PatchSetNum,
expanded: true,
};
+ await element.updateComplete;
const promise = mockPromise();
element.addEventListener(
'change-message-deleted',
- (e: CustomEvent<ChangeMessageDeletedEventDetail>) => {
+ async (e: CustomEvent<ChangeMessageDeletedEventDetail>) => {
+ await element.updateComplete;
assert.deepEqual(e.detail.message, element.message);
assert.isFalse(
queryAndAssert<GrButton>(element, '.deleteBtn').disabled
@@ -138,82 +138,192 @@
promise.resolve();
}
);
- await flush();
tap(queryAndAssert(element, '.deleteBtn'));
+ await element.updateComplete;
assert.isTrue(queryAndAssert<GrButton>(element, '.deleteBtn').disabled);
await promise;
});
- test('autogenerated prefix hiding', () => {
+ test('autogenerated prefix hiding', async () => {
element.message = {
...createChangeMessage(),
tag: 'autogenerated:gerrit:test' as ReviewInputTag,
expanded: false,
};
+ await element.updateComplete;
- assert.isTrue(element.isAutomated);
- assert.isFalse(element.hidden);
+ assert.isTrue(element.computeIsAutomated());
+ expect(element).shadowDom.to.equal(/* HTML */ `<div class="collapsed">
+ <div class="contentContainer">
+ <div class="author">
+ <gr-account-label class="authorLabel"> </gr-account-label>
+ <gr-message-scores> </gr-message-scores>
+ </div>
+ <div class="content messageContent">
+ <div class="hideOnOpen message">
+ This is a message with id cm_id_1
+ </div>
+ </div>
+ <span class="dateContainer">
+ <span class="date">
+ <gr-date-formatter showdateandtime="" withtooltip="">
+ </gr-date-formatter>
+ </span>
+ <iron-icon
+ icon="gr-icons:expand-more"
+ id="expandToggle"
+ title="Toggle expanded state"
+ >
+ </iron-icon>
+ </span>
+ </div>
+ </div>`);
element.hideAutomated = true;
+ await element.updateComplete;
- assert.isTrue(element.hidden);
+ expect(element).shadowDom.to.equal(/* HTML */ '');
});
- test('reviewer message treated as autogenerated', () => {
+ test('reviewer message treated as autogenerated', async () => {
element.message = {
...createChangeMessage(),
tag: 'autogenerated:gerrit:test' as ReviewInputTag,
reviewer: {},
expanded: false,
};
+ await element.updateComplete;
- assert.isTrue(element.isAutomated);
- assert.isFalse(element.hidden);
+ assert.isTrue(element.computeIsAutomated());
+ expect(element).shadowDom.to.equal(/* HTML */ `<div class="collapsed">
+ <div class="contentContainer">
+ <div class="author">
+ <gr-account-label class="authorLabel"> </gr-account-label>
+ <gr-message-scores> </gr-message-scores>
+ </div>
+ <div class="content messageContent">
+ <div class="hideOnOpen message">
+ This is a message with id cm_id_1
+ </div>
+ </div>
+ <span class="dateContainer">
+ <span class="date">
+ <gr-date-formatter showdateandtime="" withtooltip="">
+ </gr-date-formatter>
+ </span>
+ <iron-icon
+ icon="gr-icons:expand-more"
+ id="expandToggle"
+ title="Toggle expanded state"
+ >
+ </iron-icon>
+ </span>
+ </div>
+ </div>`);
element.hideAutomated = true;
+ await element.updateComplete;
- assert.isTrue(element.hidden);
+ expect(element).shadowDom.to.equal(/* HTML */ '');
});
- test('batch reviewer message treated as autogenerated', () => {
+ test('batch reviewer message treated as autogenerated', async () => {
element.message = {
...createChangeMessage(),
type: 'REVIEWER_UPDATE',
reviewer: {},
expanded: false,
+ updates: [],
};
+ await element.updateComplete;
- assert.isTrue(element.isAutomated);
- assert.isFalse(element.hidden);
+ assert.isTrue(element.computeIsAutomated());
+ expect(element).shadowDom.to.equal(/* HTML */ `<div class="collapsed">
+ <div class="contentContainer">
+ <div class="author">
+ <gr-account-label class="authorLabel"> </gr-account-label>
+ <gr-message-scores> </gr-message-scores>
+ </div>
+ <div class="content messageContent">
+ <div class="hideOnOpen message">
+ This is a message with id cm_id_1
+ </div>
+ </div>
+ <div class="content"></div>
+ <span class="dateContainer">
+ <span class="date">
+ <gr-date-formatter showdateandtime="" withtooltip="">
+ </gr-date-formatter>
+ </span>
+ <iron-icon
+ icon="gr-icons:expand-more"
+ id="expandToggle"
+ title="Toggle expanded state"
+ >
+ </iron-icon>
+ </span>
+ </div>
+ </div>`);
element.hideAutomated = true;
+ await element.updateComplete;
- assert.isTrue(element.hidden);
+ expect(element).shadowDom.to.equal(/* HTML */ '');
});
- test('tag that is not autogenerated prefix does not hide', () => {
+ test('tag that is not autogenerated prefix does not hide', async () => {
element.message = {
...createChangeMessage(),
tag: 'something' as ReviewInputTag,
expanded: false,
};
+ await element.updateComplete;
- assert.isFalse(element.isAutomated);
- assert.isFalse(element.hidden);
+ assert.isFalse(element.computeIsAutomated());
+ const rendered = /* HTML */ `<div class="collapsed">
+ <div class="contentContainer">
+ <div class="author">
+ <gr-account-label class="authorLabel"> </gr-account-label>
+ <gr-message-scores> </gr-message-scores>
+ </div>
+ <div class="content messageContent">
+ <div class="hideOnOpen message">
+ This is a message with id cm_id_1
+ </div>
+ </div>
+ <span class="dateContainer">
+ <span class="date">
+ <gr-date-formatter showdateandtime="" withtooltip="">
+ </gr-date-formatter>
+ </span>
+ <iron-icon
+ icon="gr-icons:expand-more"
+ id="expandToggle"
+ title="Toggle expanded state"
+ >
+ </iron-icon>
+ </span>
+ </div>
+ </div>`;
+ expect(element).shadowDom.to.equal(rendered);
element.hideAutomated = true;
+ await element.updateComplete;
+ console.error(element.computeIsAutomated());
- assert.isFalse(element.hidden);
+ expect(element).shadowDom.to.equal(rendered);
});
test('reply button hidden unless logged in', () => {
- const message = {
+ element.message = {
...createChangeMessage(),
message: 'Uploaded patch set 1.',
expanded: false,
};
- assert.isFalse(element._computeShowReplyButton(message, false));
- assert.isTrue(element._computeShowReplyButton(message, true));
+ element.loggedIn = false;
+ assert.isFalse(element.computeShowReplyButton());
+ element.loggedIn = true;
+ assert.isTrue(element.computeShowReplyButton());
});
test('_computeShowOnBehalfOf', () => {
@@ -222,29 +332,32 @@
message: '...',
expanded: false,
};
- assert.isNotOk(element._computeShowOnBehalfOf(message));
+ element.message = message;
+ assert.isNotOk(element.computeShowOnBehalfOf());
message.author = {_account_id: 1115495 as AccountId};
- assert.isNotOk(element._computeShowOnBehalfOf(message));
+ assert.isNotOk(element.computeShowOnBehalfOf());
message.real_author = {_account_id: 1115495 as AccountId};
- assert.isNotOk(element._computeShowOnBehalfOf(message));
+ assert.isNotOk(element.computeShowOnBehalfOf());
message.real_author._account_id = 123456 as AccountId;
- assert.isOk(element._computeShowOnBehalfOf(message));
+ assert.isOk(element.computeShowOnBehalfOf());
message.updated_by = message.author;
delete message.author;
- assert.isOk(element._computeShowOnBehalfOf(message));
+ assert.isOk(element.computeShowOnBehalfOf());
delete message.updated_by;
- assert.isNotOk(element._computeShowOnBehalfOf(message));
+ assert.isNotOk(element.computeShowOnBehalfOf());
});
- test('clicking on date link fires event', () => {
+ test('clicking on date link fires event', async () => {
element.message = {
...createChangeMessage(),
type: 'REVIEWER_UPDATE',
reviewer: {},
id: '47c43261_55aa2c41' as ChangeMessageId,
expanded: false,
+ updates: [],
};
- flush();
+ await element.updateComplete;
+
const stub = sinon.stub();
element.addEventListener('message-anchor-tap', stub);
const dateEl = queryAndAssert(element, '.date');
@@ -252,7 +365,7 @@
tap(dateEl);
assert.isTrue(stub.called);
- assert.deepEqual(stub.lastCall.args[0].detail, {id: element.message.id});
+ assert.deepEqual(stub.lastCall.args[0].detail, {id: element.message?.id});
});
suite('uploaded patchset X message navigates to X - 1 vs X', () => {
@@ -267,7 +380,7 @@
...createChangeMessage(),
message: 'Uploaded patch set 1.',
};
- element._handleViewPatchsetDiff(new MouseEvent('click'));
+ element.handleViewPatchsetDiff(new MouseEvent('click'));
assert.isTrue(
navStub.calledWithExactly(element.change!, {
patchNum: 1 as PatchSetNum,
@@ -281,7 +394,7 @@
...createChangeMessage(),
message: 'Uploaded patch set 2.',
};
- element._handleViewPatchsetDiff(new MouseEvent('click'));
+ element.handleViewPatchsetDiff(new MouseEvent('click'));
assert.isTrue(
navStub.calledWithExactly(element.change!, {
patchNum: 2 as PatchSetNum,
@@ -293,7 +406,7 @@
...createChangeMessage(),
message: 'Uploaded patch set 200.',
};
- element._handleViewPatchsetDiff(new MouseEvent('click'));
+ element.handleViewPatchsetDiff(new MouseEvent('click'));
assert.isTrue(
navStub.calledWithExactly(element.change!, {
patchNum: 200 as PatchSetNum,
@@ -307,7 +420,7 @@
...createChangeMessage(),
message: 'Commit message updated.',
};
- element._handleViewPatchsetDiff(new MouseEvent('click'));
+ element.handleViewPatchsetDiff(new MouseEvent('click'));
assert.isTrue(
navStub.calledWithExactly(element.change!, {
patchNum: 4 as PatchSetNum,
@@ -321,7 +434,7 @@
...createChangeMessage(),
message: 'abcd↵3 is the latest approved patch-set.↵abc',
};
- element._handleViewPatchsetDiff(new MouseEvent('click'));
+ element.handleViewPatchsetDiff(new MouseEvent('click'));
assert.isTrue(
navStub.calledWithExactly(element.change!, {
patchNum: 4 as PatchSetNum,
@@ -332,22 +445,28 @@
});
suite('compute messages', () => {
+ const labels = {
+ 'Code-Review': createLabelInfo(1),
+ 'Code-Style': createLabelInfo(1),
+ };
test('empty', () => {
assert.equal(
- element._computeMessageContent(
+ element.computeMessageContent(
true,
'',
undefined,
- '' as ReviewInputTag
+ '' as ReviewInputTag,
+ labels
),
''
);
assert.equal(
- element._computeMessageContent(
+ element.computeMessageContent(
false,
'',
undefined,
- '' as ReviewInputTag
+ '' as ReviewInputTag,
+ labels
),
''
);
@@ -356,13 +475,19 @@
test('new patchset', () => {
const original = 'Uploaded patch set 1.';
const tag = 'autogenerated:gerrit:newPatchSet' as ReviewInputTag;
- let actual = element._computeMessageContent(true, original, [], tag);
+ let actual = element.computeMessageContent(true, original, [], tag);
assert.equal(
actual,
- element._computeMessageContentCollapsed(original, [], tag, [])
+ element.computeMessageContent(true, original, [], tag, labels)
);
assert.equal(actual, original);
- actual = element._computeMessageContent(false, original, [], tag);
+ actual = element.computeMessageContent(
+ false,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, original);
});
@@ -370,13 +495,25 @@
const original = 'Patch Set 27: Patch Set 26 was rebased';
const tag = 'autogenerated:gerrit:newPatchSet' as ReviewInputTag;
const expected = 'Patch Set 26 was rebased';
- let actual = element._computeMessageContent(true, original, [], tag);
+ let actual = element.computeMessageContent(
+ true,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
assert.equal(
actual,
- element._computeMessageContentCollapsed(original, [], tag, [])
+ element.computeMessageContent(true, original, [], tag)
);
- actual = element._computeMessageContent(false, original, [], tag);
+ actual = element.computeMessageContent(
+ false,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
});
@@ -384,31 +521,89 @@
const original = 'Patch Set 1:\n\nThis change is ready for review.';
const tag = undefined;
const expected = 'This change is ready for review.';
- let actual = element._computeMessageContent(true, original, [], tag);
+ let actual = element.computeMessageContent(
+ true,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
assert.equal(
actual,
- element._computeMessageContentCollapsed(original, [], tag, [])
+ element.computeMessageContent(true, original, [], tag)
);
- actual = element._computeMessageContent(false, original, [], tag);
+ actual = element.computeMessageContent(
+ false,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
});
test('new patchset with vote', () => {
const original = 'Uploaded patch set 2: Code-Review+1';
const tag = 'autogenerated:gerrit:newPatchSet' as ReviewInputTag;
const expected = 'Uploaded patch set 2: Code-Review+1';
- let actual = element._computeMessageContent(true, original, [], tag);
+ let actual = element.computeMessageContent(
+ true,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
- actual = element._computeMessageContent(false, original, [], tag);
+ actual = element.computeMessageContent(
+ false,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
});
test('vote', () => {
const original = 'Patch Set 1: Code-Style+1';
const tag = undefined;
const expected = '';
- let actual = element._computeMessageContent(true, original, [], tag);
+ let actual = element.computeMessageContent(
+ true,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
- actual = element._computeMessageContent(false, original, [], tag);
+ actual = element.computeMessageContent(
+ false,
+ original,
+ [],
+ tag,
+ labels
+ );
+ assert.equal(actual, expected);
+ });
+
+ test('legacy change message', () => {
+ const original = 'Patch Set 1: Legacy Message';
+ const tag = undefined;
+ const expected = 'Legacy Message';
+ let actual = element.computeMessageContent(
+ true,
+ original,
+ [],
+ tag,
+ labels
+ );
+ assert.equal(actual, expected);
+ actual = element.computeMessageContent(
+ false,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
});
@@ -416,9 +611,21 @@
const original = 'Patch Set 1:\n\n(3 comments)';
const tag = undefined;
const expected = '';
- let actual = element._computeMessageContent(true, original, [], tag);
+ let actual = element.computeMessageContent(
+ true,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
- actual = element._computeMessageContent(false, original, [], tag);
+ actual = element.computeMessageContent(
+ false,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
});
@@ -432,18 +639,20 @@
createAccountWithIdNameAndEmail(1),
createAccountWithIdNameAndEmail(2),
];
- let actual = element._computeMessageContent(
+ let actual = element.computeMessageContent(
true,
original,
accountsInMessage,
- tag
+ tag,
+ labels
);
assert.equal(actual, expected);
- actual = element._computeMessageContent(
+ actual = element.computeMessageContent(
false,
original,
accountsInMessage,
- tag
+ tag,
+ labels
);
assert.equal(actual, expected);
});
@@ -454,9 +663,21 @@
const tag = undefined;
const expected =
'Removed vote: \n\n * Code-Style+1 by Gerrit Account 1\n * Code-Style-1 by Gerrit Account 2';
- let actual = element._computeMessageContent(true, original, [], tag);
+ let actual = element.computeMessageContent(
+ true,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
- actual = element._computeMessageContent(false, original, [], tag);
+ actual = element.computeMessageContent(
+ false,
+ original,
+ [],
+ tag,
+ labels
+ );
assert.equal(actual, expected);
});
});
@@ -466,11 +687,10 @@
setup(async () => {
stubRestApi('getLoggedIn').returns(Promise.resolve(false));
stubRestApi('getIsAdmin').returns(Promise.resolve(false));
- element = basicFixture.instantiate();
- await flush();
+ element = await fixture<GrMessage>(html`<gr-message></gr-message>`);
});
- test('reply and delete button should be hidden', () => {
+ test('reply and delete button should be hidden', async () => {
element.message = {
...createChangeMessage(),
id: '47c43261_55aa2c41' as ChangeMessageId,
@@ -485,25 +705,24 @@
expanded: true,
};
- flush();
- assert.isTrue(
- queryAndAssert<HTMLElement>(element, '.replyActionContainer').hidden
- );
- assert.isTrue(queryAndAssert<HTMLElement>(element, '.deleteBtn').hidden);
+ await element.updateComplete;
+ assert.isNotOk(query<HTMLElement>(element, '.replyActionContainer'));
+ assert.isNotOk(query<HTMLElement>(element, '.deleteBtn'));
});
});
- suite('patchset comment summary', () => {
- setup(() => {
- element = basicFixture.instantiate();
+ suite('patchset comment summary', async () => {
+ setup(async () => {
+ element = await fixture<GrMessage>(html`<gr-message></gr-message>`);
element.message = {
...createChangeMessage(),
id: '6a07f64a82f96e7337ca5f7f84cfc73abf8ac2a3' as ChangeMessageId,
};
+ await element.updateComplete;
});
test('single patchset comment posted', () => {
- const threads = [
+ element.commentThreads = [
{
comments: [
{
@@ -516,7 +735,6 @@
message: 'testing the load',
unresolved: false,
path: '/PATCHSET_LEVEL',
- collapsed: false,
},
],
patchNum: 1 as PatchSetNum,
@@ -525,23 +743,15 @@
commentSide: CommentSide.REVISION,
},
];
+ assert.equal(element.patchsetCommentSummary(), 'testing the load');
assert.equal(
- element._computeMessageContentCollapsed(
- '',
- undefined,
- undefined,
- threads
- ),
- 'testing the load'
- );
- assert.equal(
- element._computeMessageContent(false, '', undefined, undefined),
+ element.computeMessageContent(false, '', undefined, undefined),
''
);
});
test('single patchset comment with reply', () => {
- const threads = [
+ element.commentThreads = [
{
comments: [
{
@@ -552,7 +762,6 @@
message: 'testing the load',
unresolved: false,
path: '/PATCHSET_LEVEL',
- collapsed: false,
},
{
change_message_id: '6a07f64a82f96e7337ca5f7f84cfc73abf8ac2a3',
@@ -564,7 +773,6 @@
unresolved: false,
path: '/PATCHSET_LEVEL',
__draft: true,
- collapsed: true,
},
],
patchNum: 1 as PatchSetNum,
@@ -573,17 +781,9 @@
commentSide: CommentSide.REVISION,
},
];
+ assert.equal(element.patchsetCommentSummary(), 'n');
assert.equal(
- element._computeMessageContentCollapsed(
- '',
- undefined,
- undefined,
- threads
- ),
- 'n'
- );
- assert.equal(
- element._computeMessageContent(false, '', undefined, undefined),
+ element.computeMessageContent(false, '', undefined, undefined),
''
);
});
@@ -592,11 +792,10 @@
suite('when logged in but not admin', () => {
setup(async () => {
stubRestApi('getIsAdmin').returns(Promise.resolve(false));
- element = basicFixture.instantiate();
- await flush();
+ element = await fixture<GrMessage>(html`<gr-message></gr-message>`);
});
- test('can see reply but not delete button', () => {
+ test('can see reply but not delete button', async () => {
element.message = {
...createChangeMessage(),
id: '47c43261_55aa2c41' as ChangeMessageId,
@@ -610,17 +809,16 @@
_revision_number: 1 as PatchSetNum,
expanded: true,
};
+ await element.updateComplete;
- flush();
- assert.isFalse(
- queryAndAssert<HTMLElement>(element, '.replyActionContainer').hidden
- );
- assert.isTrue(queryAndAssert<HTMLElement>(element, '.deleteBtn').hidden);
+ assert.isOk(query<HTMLElement>(element, '.replyActionContainer'));
+ assert.isNotOk(query<HTMLElement>(element, '.deleteBtn'));
});
- test('reply button shown when message is updated', () => {
+ test('reply button shown when message is updated', async () => {
element.message = undefined;
- flush();
+ await element.updateComplete;
+
let replyEl = query(element, '.replyActionContainer');
// We don't even expect the button to show up in the DOM when the message
// is undefined.
@@ -639,10 +837,10 @@
_revision_number: 1 as PatchSetNum,
expanded: true,
};
- flush();
+ await element.updateComplete;
+
replyEl = queryAndAssert(element, '.replyActionContainer');
assert.isOk(replyEl);
- assert.isFalse((replyEl as HTMLElement).hidden);
});
});
});
diff --git a/polygerrit-ui/app/elements/change/gr-messages-list/gr-messages-list.ts b/polygerrit-ui/app/elements/change/gr-messages-list/gr-messages-list.ts
index 28acbea..f6b0ad4 100644
--- a/polygerrit-ui/app/elements/change/gr-messages-list/gr-messages-list.ts
+++ b/polygerrit-ui/app/elements/change/gr-messages-list/gr-messages-list.ts
@@ -57,6 +57,7 @@
import {commentsModelToken} from '../../../models/comments/comments-model';
import {changeModelToken} from '../../../models/change/change-model';
import {resolve, DIPolymerElement} from '../../../models/dependency';
+import {queryAll} from '../../../utils/common-util';
/**
* The content of the enum is also used in the UI for the button text.
@@ -305,7 +306,7 @@
super.disconnectedCallback();
}
- scrollToMessage(messageID: string) {
+ async scrollToMessage(messageID: string) {
const selector = `[data-message-id="${messageID}"]`;
const el = this.shadowRoot!.querySelector(selector) as
| GrMessage
@@ -317,13 +318,15 @@
);
return;
}
- if (!el) {
+ if (!el || !el.message) {
this._showAllActivity = true;
setTimeout(() => this.scrollToMessage(messageID));
return;
}
- el.set('message.expanded', true);
+ el.message.expanded = true;
+ el.requestUpdate();
+ await el.updateComplete;
let top = el.offsetTop;
for (
let offsetParent = el.offsetParent as HTMLElement | null;
@@ -409,11 +412,14 @@
}
_updateExpandedStateOfAllMessages(exp: boolean) {
- if (this._combinedMessages) {
- for (let i = 0; i < this._combinedMessages.length; i++) {
- this._combinedMessages[i].expanded = exp;
- this.notifyPath(`_combinedMessages.${i}.expanded`);
- }
+ if (!this._combinedMessages) return;
+
+ for (let i = 0; i < this._combinedMessages.length; i++) {
+ this._combinedMessages[i].expanded = exp;
+ this.notifyPath(`_combinedMessages.${i}.expanded`);
+ }
+ for (const message of queryAll<GrMessage>(this, 'gr-message')) {
+ message.requestUpdate('message');
}
}
diff --git a/polygerrit-ui/app/elements/change/gr-messages-list/gr-messages-list_test.ts b/polygerrit-ui/app/elements/change/gr-messages-list/gr-messages-list_test.ts
index 283ea357..b9cb616 100644
--- a/polygerrit-ui/app/elements/change/gr-messages-list/gr-messages-list_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-messages-list/gr-messages-list_test.ts
@@ -41,6 +41,7 @@
UrlEncodedCommentId,
} from '../../../types/common';
import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
+import {assertIsDefined} from '../../../utils/common-util';
createCommentApiMockWithTemplateElement(
'gr-messages-list-comment-mock-api',
@@ -167,43 +168,53 @@
await flush();
});
- test('expand/collapse all', () => {
+ test('expand/collapse all', async () => {
let allMessageEls = getMessages();
for (const message of allMessageEls) {
- message._expanded = false;
+ assertIsDefined(message.message);
+ message.message = {...message.message, expanded: false};
+ await message.updateComplete;
}
MockInteractions.tap(allMessageEls[1]);
- assert.isTrue(allMessageEls[1]._expanded);
+ assert.isTrue(allMessageEls[1].message?.expanded);
MockInteractions.tap(queryAndAssert(element, '#collapse-messages'));
allMessageEls = getMessages();
for (const message of allMessageEls) {
- assert.isTrue(message._expanded);
+ assert.isTrue(message.message?.expanded);
}
MockInteractions.tap(queryAndAssert(element, '#collapse-messages'));
allMessageEls = getMessages();
for (const message of allMessageEls) {
- assert.isFalse(message._expanded);
+ assert.isFalse(message.message?.expanded);
}
});
test('expand/collapse from external keypress', () => {
// Start with one expanded message. -> not all collapsed
element.scrollToMessage(messages[1].id);
- assert.isFalse([...getMessages()].filter(m => m._expanded).length === 0);
+ assert.isFalse(
+ [...getMessages()].filter(m => m.message?.expanded).length === 0
+ );
// Press 'z' -> all collapsed
element.handleExpandCollapse(false);
- assert.isTrue([...getMessages()].filter(m => m._expanded).length === 0);
+ assert.isTrue(
+ [...getMessages()].filter(m => m.message?.expanded).length === 0
+ );
// Press 'x' -> all expanded
element.handleExpandCollapse(true);
- assert.isTrue([...getMessages()].filter(m => !m._expanded).length === 0);
+ assert.isTrue(
+ [...getMessages()].filter(m => !m.message?.expanded).length === 0
+ );
// Press 'z' -> all collapsed
element.handleExpandCollapse(false);
- assert.isTrue([...getMessages()].filter(m => m._expanded).length === 0);
+ assert.isTrue(
+ [...getMessages()].filter(m => m.message?.expanded).length === 0
+ );
});
test('showAllActivity does not appear when all msgs are important', () => {
@@ -211,50 +222,52 @@
assert.isNotOk(query(element, '.showAllActivityToggle'));
});
- test('scroll to message', () => {
+ test('scroll to message', async () => {
const allMessageEls = getMessages();
for (const message of allMessageEls) {
- message.set('message.expanded', false);
+ assertIsDefined(message.message);
+ message.message = {...message.message, expanded: false};
}
const scrollToStub = sinon.stub(window, 'scrollTo');
const highlightStub = sinon.stub(element, '_highlightEl');
- element.scrollToMessage('invalid');
+ await element.scrollToMessage('invalid');
for (const message of allMessageEls) {
+ assertIsDefined(message.message);
assert.isFalse(
- message._expanded,
+ message.message.expanded,
'expected gr-message to not be expanded'
);
}
const messageID = messages[1].id;
- element.scrollToMessage(messageID);
+ await element.scrollToMessage(messageID);
assert.isTrue(
queryAndAssert<GrMessage>(element, `[data-message-id="${messageID}"]`)
- ._expanded
+ .message?.expanded
);
assert.isTrue(scrollToStub.calledOnce);
assert.isTrue(highlightStub.calledOnce);
});
- test('scroll to message offscreen', () => {
+ test('scroll to message offscreen', async () => {
const scrollToStub = sinon.stub(window, 'scrollTo');
const highlightStub = sinon.stub(element, '_highlightEl');
element.messages = generateRandomMessages(25);
- flush();
+ await element.updateComplete;
assert.isFalse(scrollToStub.called);
assert.isFalse(highlightStub.called);
const messageID = element.messages[1].id;
- element.scrollToMessage(messageID);
+ await element.scrollToMessage(messageID);
assert.isTrue(scrollToStub.calledOnce);
assert.isTrue(highlightStub.calledOnce);
assert.isTrue(
queryAndAssert<GrMessage>(element, `[data-message-id="${messageID}"]`)
- ._expanded
+ .message?.expanded
);
});
diff --git a/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog-it_test.ts b/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog-it_test.ts
index 13cead6..5bd5d08 100644
--- a/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog-it_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog-it_test.ts
@@ -90,8 +90,8 @@
<gr-reply-dialog></gr-reply-dialog>
`);
setupElement(element);
- // Allow the elements created by dom-repeat to be stamped.
- flush();
+
+ await element.updateComplete;
});
teardown(() => {
@@ -101,13 +101,13 @@
test('submit blocked when invalid email is supplied to ccs', () => {
const sendStub = sinon.stub(element, 'send').returns(Promise.resolve());
- element.$.ccs.entry!.setText('test');
+ element.ccsList!.entry!.setText('test');
MockInteractions.tap(queryAndAssert(element, 'gr-button.send'));
- assert.isFalse(element.$.ccs.submitEntryText());
+ assert.isFalse(element.ccsList!.submitEntryText());
assert.isFalse(sendStub.called);
flush();
- element.$.ccs.entry!.setText('test@test.test');
+ element.ccsList!.entry!.setText('test@test.test');
MockInteractions.tap(queryAndAssert(element, 'gr-button.send'));
assert.isTrue(sendStub.called);
});
diff --git a/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog.ts b/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog.ts
index c7b1982..3e766c9 100644
--- a/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog.ts
+++ b/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog.ts
@@ -27,7 +27,6 @@
import '../gr-label-scores/gr-label-scores';
import '../gr-thread-list/gr-thread-list';
import '../../../styles/shared-styles';
-import {htmlTemplate} from './gr-reply-dialog_html';
import {
GrReviewerSuggestionsProvider,
SUGGESTIONS_PROVIDERS_USERS_TYPES,
@@ -47,11 +46,11 @@
} from '../../../utils/account-util';
import {IronA11yAnnouncer} from '@polymer/iron-a11y-announcer/iron-a11y-announcer';
import {TargetElement} from '../../../api/plugin';
-import {customElement, observe, property} from '@polymer/decorators';
import {FixIronA11yAnnouncer} from '../../../types/types';
import {
AccountAddition,
AccountInfoInput,
+ AccountInput,
AccountInputDetail,
GrAccountList,
GroupInfoInput,
@@ -70,9 +69,7 @@
isReviewerGroupSuggestion,
ParsedJSON,
PatchSetNum,
- ProjectInfo,
ReviewerInput,
- Reviewers,
ReviewInput,
ReviewResult,
ServerInfo,
@@ -82,7 +79,6 @@
import {GrButton} from '../../shared/gr-button/gr-button';
import {GrLabelScores} from '../gr-label-scores/gr-label-scores';
import {GrLabelScoreRow} from '../gr-label-score-row/gr-label-score-row';
-import {PolymerDeepPropertyChange} from '@polymer/polymer/interfaces';
import {
areSetsEqual,
assertIsDefined,
@@ -113,10 +109,15 @@
import {getReplyByReason} from '../../../utils/attention-set-util';
import {addShortcut, Key, Modifier} from '../../../utils/dom-util';
import {RestApiService} from '../../../services/gr-rest-api/gr-rest-api';
-import {resolve, DIPolymerElement} from '../../../models/dependency';
+import {resolve} from '../../../models/dependency';
import {changeModelToken} from '../../../models/change/change-model';
-import {LabelNameToValuesMap} from '../../../api/rest-api';
-import {ValueChangedEvent} from '../../../types/events';
+import {ConfigInfo, LabelNameToValuesMap} from '../../../api/rest-api';
+import {css, html, PropertyValues, LitElement} from 'lit';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {when} from 'lit/directives/when';
+import {classMap} from 'lit/directives/class-map';
+import {BindValueChangeEvent, ValueChangedEvent} from '../../../types/events';
+import {customElement, property, state, query} from 'lit/decorators';
const STORAGE_DEBOUNCE_INTERVAL_MS = 400;
@@ -152,24 +153,8 @@
const EMPTY_REPLY_MESSAGE = 'Cannot send an empty reply.';
-export interface GrReplyDialog {
- $: {
- reviewers: GrAccountList;
- ccs: GrAccountList;
- cancelButton: GrButton;
- sendButton: GrButton;
- labelScores: GrLabelScores;
- textarea: GrTextarea;
- reviewerConfirmationOverlay: GrOverlay;
- };
-}
-
@customElement('gr-reply-dialog')
-export class GrReplyDialog extends DIPolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrReplyDialog extends LitElement {
/**
* Fired when a reply is successfully sent.
*
@@ -229,131 +214,129 @@
@property({type: Boolean})
canBeStarted = false;
- @property({type: Boolean, reflectToAttribute: true})
+ @property({type: Boolean, reflect: true})
disabled = false;
- @property({
- type: Boolean,
- computed: '_computeHasDrafts(draft, draftCommentThreads.*)',
- })
- hasDrafts = false;
-
- @property({type: String, observer: '_draftChanged'})
- draft = '';
-
- @property({type: Object})
- filterReviewerSuggestion: (input: Suggestion) => boolean;
-
- @property({type: Object})
- filterCCSuggestion: (input: Suggestion) => boolean;
+ @property({type: Array})
+ draftCommentThreads: CommentThread[] | undefined;
@property({type: Object})
permittedLabels?: LabelNameToValuesMap;
@property({type: Object})
- projectConfig?: ProjectInfo;
+ projectConfig?: ConfigInfo;
@property({type: Object})
serverConfig?: ServerInfo;
- @property({type: String})
+ @query('#reviewers') reviewersList?: GrAccountList;
+
+ @query('#ccs') ccsList?: GrAccountList;
+
+ @query('#cancelButton') cancelButton?: GrButton;
+
+ @query('#sendButton') sendButton?: GrButton;
+
+ @query('#labelScores') labelScores?: GrLabelScores;
+
+ @query('#textarea') textarea?: GrTextarea;
+
+ @query('#reviewerConfirmationOverlay')
+ reviewerConfirmationOverlay?: GrOverlay;
+
+ @state()
+ draft = '';
+
+ @state()
+ filterReviewerSuggestion: (input: Suggestion) => boolean;
+
+ @state()
+ filterCCSuggestion: (input: Suggestion) => boolean;
+
+ @state()
knownLatestState?: LatestPatchState;
- @property({type: Boolean})
+ @state()
underReview = true;
- @property({type: Object})
- _account?: AccountInfo;
+ @state()
+ account?: AccountInfo;
- @property({type: Array})
- _ccs: (AccountInfo | GroupInfo)[] = [];
+ @state()
+ ccs: (AccountInfoInput | GroupInfoInput)[] = [];
- @property({type: Number})
- _attentionCcsCount = 0;
+ @state()
+ attentionCcsCount = 0;
- @property({type: Object, observer: '_reviewerPendingConfirmationUpdated'})
- _ccPendingConfirmation: SuggestedReviewerGroupInfo | null = null;
+ @state()
+ ccPendingConfirmation: SuggestedReviewerGroupInfo | null = null;
- @property({
- type: String,
- computed: '_computeMessagePlaceholder(canBeStarted)',
- })
- _messagePlaceholder?: string;
+ @state()
+ messagePlaceholder?: string;
- @property({type: Object})
- _owner?: AccountInfo;
+ @state()
+ owner?: AccountInfo;
- @property({type: Object, computed: '_computeUploader(change)'})
- _uploader?: AccountInfo;
+ @state()
+ uploader?: AccountInfo;
- @property({type: Object})
- _pendingConfirmationDetails: SuggestedReviewerGroupInfo | null = null;
+ @state()
+ pendingConfirmationDetails: SuggestedReviewerGroupInfo | null = null;
- @property({type: Boolean})
- _includeComments = true;
+ @state()
+ includeComments = true;
- @property({type: Array})
- _reviewers: (AccountInfo | GroupInfo)[] = [];
+ @state() reviewers: AccountInput[] = [];
- @property({type: Object, observer: '_reviewerPendingConfirmationUpdated'})
- _reviewerPendingConfirmation: SuggestedReviewerGroupInfo | null = null;
+ @state()
+ reviewerPendingConfirmation: SuggestedReviewerGroupInfo | null = null;
- @property({type: Boolean, observer: '_handleHeightChanged'})
- _previewFormatting = false;
+ @state()
+ previewFormatting = false;
- @property({type: String, computed: '_computeSendButtonLabel(canBeStarted)'})
- _sendButtonLabel?: string;
+ @state()
+ sendButtonLabel?: string;
- @property({type: Boolean})
- _savingComments = false;
+ @state()
+ savingComments = false;
- @property({type: Boolean})
- _reviewersMutated = false;
+ @state()
+ reviewersMutated = false;
/**
* Signifies that the user has changed their vote on a label or (if they have
* not yet voted on a label) if a selected vote is different from the default
* vote.
*/
- @property({type: Boolean})
- _labelsChanged = false;
+ @state()
+ labelsChanged = false;
- @property({type: String})
- readonly _saveTooltip: string = ButtonTooltips.SAVE;
+ @state()
+ readonly saveTooltip: string = ButtonTooltips.SAVE;
- @property({type: String})
- _pluginMessage = '';
+ @state()
+ pluginMessage = '';
- @property({type: Boolean})
- _commentEditing = false;
+ @state()
+ commentEditing = false;
- @property({type: Boolean})
- _attentionExpanded = false;
+ @state()
+ attentionExpanded = false;
- @property({type: Object})
- _currentAttentionSet: Set<AccountId> = new Set();
+ @state()
+ currentAttentionSet: Set<AccountId> = new Set();
- @property({type: Object})
- _newAttentionSet: Set<AccountId> = new Set();
+ @state()
+ newAttentionSet: Set<AccountId> = new Set();
- @property({
- type: Boolean,
- computed:
- '_computeSendButtonDisabled(canBeStarted, ' +
- 'draftCommentThreads, draft, _reviewersMutated, _labelsChanged, ' +
- '_includeComments, disabled, _commentEditing, change, _account)',
- observer: '_sendDisabledChanged',
- })
- _sendDisabled?: boolean;
+ @state()
+ sendDisabled?: boolean;
- @property({type: Array, observer: '_handleHeightChanged'})
- draftCommentThreads: CommentThread[] | undefined;
+ @state()
+ isResolvedPatchsetLevelComment = true;
- @property({type: Boolean})
- _isResolvedPatchsetLevelComment = true;
-
- @property({type: Array, computed: '_computeAllReviewers(_reviewers.*)'})
- _allReviewers: (AccountInfo | GroupInfo)[] = [];
+ @state()
+ allReviewers: (AccountInfo | GroupInfo)[] = [];
private readonly restApiService: RestApiService =
getAppContext().restApiService;
@@ -362,16 +345,306 @@
private readonly jsAPI = getAppContext().jsApiService;
- private storeTask?: DelayedTask;
+ storeTask?: DelayedTask;
/** Called in disconnectedCallback. */
private cleanups: (() => void)[] = [];
+ static override styles = [
+ sharedStyles,
+ css`
+ :host {
+ background-color: var(--dialog-background-color);
+ display: block;
+ max-height: 90vh;
+ }
+ :host([disabled]) {
+ pointer-events: none;
+ }
+ :host([disabled]) .container {
+ opacity: 0.5;
+ }
+ section {
+ border-top: 1px solid var(--border-color);
+ flex-shrink: 0;
+ padding: var(--spacing-m) var(--spacing-xl);
+ width: 100%;
+ }
+ section.labelsContainer {
+ /* We want the :hover highlight to extend to the border of the dialog. */
+ padding: var(--spacing-m) 0;
+ }
+ .stickyBottom {
+ background-color: var(--dialog-background-color);
+ box-shadow: 0px 0px 8px 0px rgba(60, 64, 67, 0.15);
+ margin-top: var(--spacing-s);
+ bottom: 0;
+ position: sticky;
+ /* @see Issue 8602 */
+ z-index: 1;
+ }
+ .stickyBottom.newReplyDialog {
+ margin-top: unset;
+ }
+ .actions {
+ display: flex;
+ justify-content: space-between;
+ }
+ .actions .right gr-button {
+ margin-left: var(--spacing-l);
+ }
+ .peopleContainer,
+ .labelsContainer {
+ flex-shrink: 0;
+ }
+ .peopleContainer {
+ border-top: none;
+ display: table;
+ }
+ .peopleList {
+ display: flex;
+ }
+ .peopleListLabel {
+ color: var(--deemphasized-text-color);
+ margin-top: var(--spacing-xs);
+ min-width: 6em;
+ padding-right: var(--spacing-m);
+ }
+ gr-account-list {
+ display: flex;
+ flex-wrap: wrap;
+ flex: 1;
+ }
+ #reviewerConfirmationOverlay {
+ padding: var(--spacing-l);
+ text-align: center;
+ }
+ .reviewerConfirmationButtons {
+ margin-top: var(--spacing-l);
+ }
+ .groupName {
+ font-weight: var(--font-weight-bold);
+ }
+ .groupSize {
+ font-style: italic;
+ }
+ .textareaContainer {
+ min-height: 12em;
+ position: relative;
+ }
+ .newReplyDialog.textareaContainer {
+ min-height: unset;
+ }
+ textareaContainer,
+ #textarea,
+ gr-endpoint-decorator[name='reply-text'] {
+ display: flex;
+ width: 100%;
+ }
+ .newReplyDialog .textareaContainer,
+ #textarea,
+ gr-endpoint-decorator[name='reply-text'] {
+ display: block;
+ width: unset;
+ font-family: var(--monospace-font-family);
+ font-size: var(--font-size-code);
+ line-height: calc(var(--font-size-code) + var(--spacing-s));
+ font-weight: var(--font-weight-normal);
+ }
+ .newReplyDialog#textarea {
+ padding: var(--spacing-m);
+ }
+ gr-endpoint-decorator[name='reply-text'] {
+ flex-direction: column;
+ }
+ #textarea {
+ flex: 1;
+ }
+ .previewContainer {
+ border-top: none;
+ }
+ .previewContainer gr-formatted-text {
+ background: var(--table-header-background-color);
+ padding: var(--spacing-l);
+ }
+ #checkingStatusLabel,
+ #notLatestLabel {
+ margin-left: var(--spacing-l);
+ }
+ #checkingStatusLabel {
+ color: var(--deemphasized-text-color);
+ font-style: italic;
+ }
+ #notLatestLabel,
+ #savingLabel {
+ color: var(--error-text-color);
+ }
+ #savingLabel {
+ display: none;
+ }
+ #savingLabel.saving {
+ display: inline;
+ }
+ #pluginMessage {
+ color: var(--deemphasized-text-color);
+ margin-left: var(--spacing-l);
+ margin-bottom: var(--spacing-m);
+ }
+ #pluginMessage:empty {
+ display: none;
+ }
+ .preview-formatting {
+ margin-left: var(--spacing-m);
+ }
+ .attention-icon {
+ width: 14px;
+ height: 14px;
+ vertical-align: top;
+ position: relative;
+ top: 3px;
+ --iron-icon-height: 24px;
+ --iron-icon-width: 24px;
+ }
+ .attention .edit-attention-button {
+ vertical-align: top;
+ --gr-button-padding: 0px 4px;
+ }
+ .attention .edit-attention-button iron-icon {
+ color: inherit;
+ }
+ .attention a,
+ .attention-detail a {
+ text-decoration: none;
+ }
+ .attentionSummary {
+ display: flex;
+ justify-content: space-between;
+ }
+ .attentionSummary {
+ /* The account label for selection is misbehaving currently: It consumes
+ 26px height instead of 20px, which is the default line-height and thus
+ the max that can be nicely fit into an inline layout flow. We
+ acknowledge that using a fixed 26px value here is a hack and not a
+ great solution. */
+ line-height: 26px;
+ }
+ .attentionSummary gr-account-label,
+ .attention-detail gr-account-label {
+ --account-max-length: 120px;
+ display: inline-block;
+ padding: var(--spacing-xs) var(--spacing-m);
+ user-select: none;
+ --label-border-radius: 8px;
+ }
+ .attentionSummary gr-account-label {
+ margin: 0 var(--spacing-xs);
+ line-height: var(--line-height-normal);
+ vertical-align: top;
+ }
+ .attention-detail .peopleListValues {
+ line-height: calc(var(--line-height-normal) + 10px);
+ }
+ .attention-detail gr-account-label {
+ line-height: var(--line-height-normal);
+ }
+ .attentionSummary gr-account-label:focus,
+ .attention-detail gr-account-label:focus {
+ outline: none;
+ }
+ .attentionSummary gr-account-label:hover,
+ .attention-detail gr-account-label:hover {
+ box-shadow: var(--elevation-level-1);
+ cursor: pointer;
+ }
+ .attention-detail .attentionDetailsTitle {
+ display: flex;
+ justify-content: space-between;
+ }
+ .attention-detail .selectUsers {
+ color: var(--deemphasized-text-color);
+ margin-bottom: var(--spacing-m);
+ }
+ .attentionTip {
+ padding: var(--spacing-m);
+ border: 1px solid var(--border-color);
+ border-radius: var(--border-radius);
+ margin-top: var(--spacing-m);
+ background-color: var(--assignee-highlight-color);
+ }
+ .attentionTip div iron-icon {
+ margin-right: var(--spacing-s);
+ }
+ .patchsetLevelContainer {
+ width: 80ch;
+ border-radius: var(--border-radius);
+ box-shadow: var(--elevation-level-2);
+ }
+ .patchsetLevelContainer.resolved {
+ background-color: var(--comment-background-color);
+ }
+ .patchsetLevelContainer.unresolved {
+ background-color: var(--unresolved-comment-background-color);
+ }
+ .labelContainer {
+ padding-left: var(--spacing-m);
+ padding-bottom: var(--spacing-m);
+ }
+ `,
+ ];
+
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('draft')) {
+ this.draftChanged(changedProperties.get('draft') as string);
+ }
+ if (changedProperties.has('ccPendingConfirmation')) {
+ this.pendingConfirmationUpdated(this.ccPendingConfirmation);
+ }
+ if (changedProperties.has('reviewerPendingConfirmation')) {
+ this.pendingConfirmationUpdated(this.reviewerPendingConfirmation);
+ }
+ if (changedProperties.has('change')) {
+ this.computeUploader();
+ this.changeUpdated();
+ }
+ if (changedProperties.has('canBeStarted')) {
+ this.computeMessagePlaceholder();
+ this.computeSendButtonLabel();
+ }
+ if (changedProperties.has('reviewFormatting')) {
+ this.handleHeightChanged();
+ }
+ if (changedProperties.has('draftCommentThreads')) {
+ this.handleHeightChanged();
+ }
+ if (changedProperties.has('reviewers')) {
+ this.computeAllReviewers();
+ }
+ if (changedProperties.has('sendDisabled')) {
+ this.sendDisabledChanged();
+ }
+ if (changedProperties.has('attentionExpanded')) {
+ this.onAttentionExpandedChange();
+ }
+ if (
+ changedProperties.has('account') ||
+ changedProperties.has('reviewers') ||
+ changedProperties.has('ccs') ||
+ changedProperties.has('change') ||
+ changedProperties.has('draftCommentThreads') ||
+ changedProperties.has('includeComments') ||
+ changedProperties.has('labelsChanged') ||
+ changedProperties.has('draft')
+ ) {
+ this.computeNewAttention();
+ }
+ }
+
constructor() {
super();
this.filterReviewerSuggestion =
- this._filterReviewerSuggestionGenerator(false);
- this.filterCCSuggestion = this._filterReviewerSuggestionGenerator(true);
+ this.filterReviewerSuggestionGenerator(false);
+ this.filterCCSuggestion = this.filterReviewerSuggestionGenerator(true);
+ this.jsAPI.addElement(TargetElement.REPLY_DIALOG, this);
}
override connectedCallback() {
@@ -379,23 +652,23 @@
(
IronA11yAnnouncer as unknown as FixIronA11yAnnouncer
).requestAvailability();
- this._getAccount().then(account => {
- if (account) this._account = account;
+ this.restApiService.getAccount().then(account => {
+ if (account) this.account = account;
});
this.cleanups.push(
addShortcut(this, {key: Key.ENTER, modifiers: [Modifier.CTRL_KEY]}, _ =>
- this._submit()
+ this.submit()
)
);
this.cleanups.push(
addShortcut(this, {key: Key.ENTER, modifiers: [Modifier.META_KEY]}, _ =>
- this._submit()
+ this.submit()
)
);
this.cleanups.push(addShortcut(this, {key: Key.ESC}, _ => this.cancel()));
this.addEventListener('comment-editing-changed', e => {
- this._commentEditing = (e as CustomEvent).detail;
+ this.commentEditing = (e as CustomEvent).detail;
});
// Plugins on reply-reviewers endpoint can take advantage of these
@@ -404,22 +677,17 @@
this.addEventListener('add-reviewer', e => {
// Only support account type, see more from:
// elements/shared/gr-account-list/gr-account-list.js#addAccountItem
- this.$.reviewers.addAccountItem({
+ this.reviewersList?.addAccountItem({
account: (e as CustomEvent).detail.reviewer,
count: 1,
});
});
this.addEventListener('remove-reviewer', e => {
- this.$.reviewers.removeAccount((e as CustomEvent).detail.reviewer);
+ this.reviewersList?.removeAccount((e as CustomEvent).detail.reviewer);
});
}
- override ready() {
- super.ready();
- this.jsAPI.addElement(TargetElement.REPLY_DIALOG, this);
- }
-
override disconnectedCallback() {
this.storeTask?.cancel();
for (const cleanup of this.cleanups) cleanup();
@@ -427,6 +695,498 @@
super.disconnectedCallback();
}
+ override render() {
+ if (!this.change) return;
+ this.sendDisabled = this.computeSendButtonDisabled();
+ return html`
+ <div tabindex="-1">
+ <section class="peopleContainer">
+ <gr-endpoint-decorator name="reply-reviewers">
+ <gr-endpoint-param
+ name="change"
+ .value=${this.change}
+ ></gr-endpoint-param>
+ <gr-endpoint-param name="reviewers" .value=${this.allReviewers}>
+ </gr-endpoint-param>
+ ${this.renderReviewerList()}
+ <gr-endpoint-slot name="below"></gr-endpoint-slot>
+ </gr-endpoint-decorator>
+ ${this.renderCCList()} ${this.renderReviewConfirmation()}
+ </section>
+ <section class="labelsContainer">${this.renderLabels()}</section>
+ <section class="newReplyDialog textareaContainer">
+ ${this.renderReplyText()}
+ </section>
+ ${when(
+ this.previewFormatting,
+ () => html`
+ <section class="previewContainer">
+ <gr-formatted-text
+ .content=${this.draft}
+ .config=${this.projectConfig?.commentlinks}
+ ></gr-formatted-text>
+ </section>
+ `
+ )}
+ ${this.renderDraftsSection()}
+ <div class="stickyBottom newReplyDialog">
+ <gr-endpoint-decorator name="reply-bottom">
+ <gr-endpoint-param
+ name="change"
+ .value=${this.change}
+ ></gr-endpoint-param>
+ ${this.renderAttentionSummarySection()}
+ ${this.renderAttentionDetailsSection()}
+ <gr-endpoint-slot name="above-actions"></gr-endpoint-slot>
+ ${this.renderActionsSection()}
+ </gr-endpoint-decorator>
+ </div>
+ </div>
+ `;
+ }
+
+ private renderReviewerList() {
+ return html`
+ <div class="peopleList">
+ <div class="peopleListLabel">Reviewers</div>
+ <gr-account-list
+ id="reviewers"
+ .accounts=${this.getAccountListCopy(this.reviewers)}
+ @account-added=${this.accountAdded}
+ @accounts-changed=${this.handleReviewersChanged}
+ .removableValues=${this.change?.removable_reviewers}
+ .filter=${this.filterReviewerSuggestion}
+ .pendingConfirmation=${this.reviewerPendingConfirmation}
+ @pending-confirmation-changed=${this
+ .handleReviewersConfirmationChanged}
+ .placeholder=${'Add reviewer...'}
+ @account-text-changed=${this.handleAccountTextEntry}
+ .suggestionsProvider=${this.getReviewerSuggestionsProvider(
+ this.change
+ )}
+ >
+ </gr-account-list>
+ <gr-endpoint-slot name="right"></gr-endpoint-slot>
+ </div>
+ `;
+ }
+
+ private renderCCList() {
+ return html`
+ <div class="peopleList">
+ <div class="peopleListLabel">CC</div>
+ <gr-account-list
+ id="ccs"
+ .accounts=${this.getAccountListCopy(this.ccs)}
+ @account-added=${this.accountAdded}
+ @accounts-changed=${this.handleCcsChanged}
+ .removableValues=${this.change?.removable_reviewers}
+ .filter=${this.filterCCSuggestion}
+ .pendingConfirmation=${this.ccPendingConfirmation}
+ @pending-confirmation-changed=${this.handleCcsConfirmationChanged}
+ allow-any-input
+ .placeholder=${'Add CC...'}
+ @account-text-changed=${this.handleAccountTextEntry}
+ .suggestionsProvider=${this.getCcSuggestionsProvider(this.change)}
+ >
+ </gr-account-list>
+ </div>
+ `;
+ }
+
+ private renderReviewConfirmation() {
+ return html`
+ <gr-overlay
+ id="reviewerConfirmationOverlay"
+ @iron-overlay-canceled=${this.cancelPendingReviewer}
+ >
+ <div class="reviewerConfirmation">
+ Group
+ <span class="groupName">
+ ${this.pendingConfirmationDetails?.group.name}
+ </span>
+ has
+ <span class="groupSize">
+ ${this.pendingConfirmationDetails?.count}
+ </span>
+ members.
+ <br />
+ Are you sure you want to add them all?
+ </div>
+ <div class="reviewerConfirmationButtons">
+ <gr-button @click=${this.confirmPendingReviewer}>Yes</gr-button>
+ <gr-button @click=${this.cancelPendingReviewer}>No</gr-button>
+ </div>
+ </gr-overlay>
+ `;
+ }
+
+ private renderLabels() {
+ if (!this.change || !this.account || !this.permittedLabels) return;
+ return html`
+ <gr-endpoint-decorator name="reply-label-scores">
+ <gr-label-scores
+ id="labelScores"
+ .account=${this.account}
+ .change=${this.change}
+ @labels-changed=${this._handleLabelsChanged}
+ .permittedLabels=${this.permittedLabels}
+ ></gr-label-scores>
+ <gr-endpoint-param
+ name="change"
+ .value=${this.change}
+ ></gr-endpoint-param>
+ </gr-endpoint-decorator>
+ <div id="pluginMessage">${this.pluginMessage}</div>
+ `;
+ }
+
+ private renderReplyText() {
+ if (!this.change) return;
+ return html`
+ <div
+ class=${classMap({
+ patchsetLevelContainer: true,
+ [this.getUnresolvedPatchsetLevelClass(
+ this.isResolvedPatchsetLevelComment
+ )]: true,
+ })}
+ >
+ <gr-endpoint-decorator name="reply-text">
+ <gr-textarea
+ id="textarea"
+ class="message newReplyDialog"
+ .autocomplete=${'on'}
+ .placeholder=${this.messagePlaceholder}
+ monospace
+ ?disabled=${this.disabled}
+ .rows=${4}
+ .text=${this.draft}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ this.draft = e.detail.value;
+ this.handleHeightChanged();
+ }}
+ >
+ </gr-textarea>
+ <gr-endpoint-param name="change" .value=${this.change}>
+ </gr-endpoint-param>
+ </gr-endpoint-decorator>
+ <div class="labelContainer">
+ <label>
+ <input
+ id="resolvedPatchsetLevelCommentCheckbox"
+ type="checkbox"
+ ?checked=${this.isResolvedPatchsetLevelComment}
+ @change=${this.handleResolvedPatchsetLevelCommentCheckboxChanged}
+ />
+ Resolved
+ </label>
+ <label class="preview-formatting">
+ <input
+ type="checkbox"
+ ?checked=${this.previewFormatting}
+ @change=${this.handlePreviewFormattingChanged}
+ />
+ Preview formatting
+ </label>
+ </div>
+ </div>
+ `;
+ }
+
+ private renderDraftsSection() {
+ if (this.computeHideDraftList(this.draftCommentThreads)) return;
+ return html`
+ <section class="draftsContainer">
+ <div class="includeComments">
+ <input
+ type="checkbox"
+ id="includeComments"
+ @change=${this.handleIncludeCommentsChanged}
+ ?checked=${this.includeComments}
+ />
+ <label for="includeComments"
+ >Publish ${this.computeDraftsTitle(this.draftCommentThreads)}</label
+ >
+ </div>
+ ${when(
+ this.includeComments,
+ () => html`
+ <gr-thread-list
+ id="commentList"
+ .threads=${this.draftCommentThreads!}
+ hide-dropdown
+ >
+ </gr-thread-list>
+ `
+ )}
+ <span
+ id="savingLabel"
+ class=${this.computeSavingLabelClass(this.savingComments)}
+ >
+ Saving comments...
+ </span>
+ </section>
+ `;
+ }
+
+ private renderAttentionSummarySection() {
+ if (this.attentionExpanded) return;
+ return html`
+ <section class="attention">
+ <div class="attentionSummary">
+ <div>
+ ${when(
+ this.computeShowNoAttentionUpdate(),
+ () => html` <span>${this.computeDoNotUpdateMessage()}</span> `
+ )}
+ ${when(
+ !this.computeShowNoAttentionUpdate(),
+ () => html`
+ <span>Bring to attention of</span>
+ ${this.computeNewAttentionAccounts().map(
+ account => html`
+ <gr-account-label
+ .account=${account}
+ .forceAttention=${this.computeHasNewAttention(account)}
+ .selected=${this.computeHasNewAttention(account)}
+ .hideHovercard=${true}
+ .selectionChipStyle=${true}
+ @click=${this.handleAttentionClick}
+ ></gr-account-label>
+ `
+ )}
+ `
+ )}
+ <gr-tooltip-content
+ has-tooltip
+ title=${this.computeAttentionButtonTitle()}
+ >
+ <gr-button
+ class="edit-attention-button"
+ @click=${this.handleAttentionModify}
+ ?disabled=${this.sendDisabled}
+ link
+ position-below
+ data-label="Edit"
+ data-action-type="change"
+ data-action-key="edit"
+ role="button"
+ tabindex="0"
+ >
+ <iron-icon icon="gr-icons:edit"></iron-icon>
+ Modify
+ </gr-button>
+ </gr-tooltip-content>
+ </div>
+ <div>
+ <a
+ href="https://gerrit-review.googlesource.com/Documentation/user-attention-set.html"
+ target="_blank"
+ >
+ <iron-icon
+ icon="gr-icons:help-outline"
+ title="read documentation"
+ ></iron-icon>
+ </a>
+ </div>
+ </div>
+ </section>
+ `;
+ }
+
+ private renderAttentionDetailsSection() {
+ if (!this.attentionExpanded) return;
+ return html`
+ <section class="attention-detail">
+ <div class="attentionDetailsTitle">
+ <div>
+ <span>Modify attention to</span>
+ </div>
+ <div></div>
+ <div>
+ <a
+ href="https://gerrit-review.googlesource.com/Documentation/user-attention-set.html"
+ target="_blank"
+ >
+ <iron-icon
+ icon="gr-icons:help-outline"
+ title="read documentation"
+ ></iron-icon>
+ </a>
+ </div>
+ </div>
+ <div class="selectUsers">
+ <span
+ >Select chips to set who will be in the attention set after sending
+ this reply</span
+ >
+ </div>
+ <div class="peopleList">
+ <div class="peopleListLabel">Owner</div>
+ <div class="peopleListValues">
+ <gr-account-label
+ .account=${this.owner}
+ ?forceAttention=${this.computeHasNewAttention(this.owner)}
+ .selected=${this.computeHasNewAttention(this.owner)}
+ .hideHovercard=${true}
+ .selectionChipStyle=${true}
+ @click=${this.handleAttentionClick}
+ >
+ </gr-account-label>
+ </div>
+ </div>
+ ${when(
+ this.uploader,
+ () => html`
+ <div class="peopleList">
+ <div class="peopleListLabel">Uploader</div>
+ <div class="peopleListValues">
+ <gr-account-label
+ .account=${this.uploader}
+ ?forceAttention=${this.computeHasNewAttention(this.uploader)}
+ .selected=${this.computeHasNewAttention(this.uploader)}
+ .hideHovercard=${true}
+ .selectionChipStyle=${true}
+ @click=${this.handleAttentionClick}
+ >
+ </gr-account-label>
+ </div>
+ </div>
+ `
+ )}
+ <div class="peopleList">
+ <div class="peopleListLabel">Reviewers</div>
+ <div class="peopleListValues">
+ ${this.removeServiceUsers(this.reviewers).map(
+ account => html`
+ <gr-account-label
+ .account=${account}
+ ?forceAttention=${this.computeHasNewAttention(account)}
+ .selected=${this.computeHasNewAttention(account)}
+ .hideHovercard=${true}
+ .selectionChipStyle=${true}
+ @click=${this.handleAttentionClick}
+ >
+ </gr-account-label>
+ `
+ )}
+ </div>
+ </div>
+
+ ${when(
+ this.attentionCcsCount,
+ () => html`
+ <div class="peopleList">
+ <div class="peopleListLabel">CC</div>
+ <div class="peopleListValues">
+ ${this.removeServiceUsers(this.ccs).map(
+ account => html`
+ <gr-account-label
+ .account=${account}
+ ?forceAttention=${this.computeHasNewAttention(account)}
+ .selected=${this.computeHasNewAttention(account)}
+ .hideHovercard=${true}
+ .selectionChipStyle=${true}
+ @click=${this.handleAttentionClick}
+ >
+ </gr-account-label>
+ `
+ )}
+ </div>
+ </div>
+ `
+ )}
+ ${when(
+ this.computeShowAttentionTip(
+ this.account,
+ this.owner,
+ this.currentAttentionSet,
+ this.newAttentionSet
+ ),
+ () => html`
+ <div class="attentionTip">
+ <iron-icon
+ class="pointer"
+ icon="gr-icons:lightbulb-outline"
+ ></iron-icon>
+ Be mindful of requiring attention from too many users.
+ </div>
+ `
+ )}
+ </section>
+ `;
+ }
+
+ private renderActionsSection() {
+ return html`
+ <section class="actions">
+ <div class="left">
+ ${when(
+ this.knownLatestState === LatestPatchState.CHECKING,
+ () => html`
+ <span id="checkingStatusLabel">
+ Checking whether patch ${this.patchNum} is latest...
+ </span>
+ `
+ )}
+ ${when(
+ this.knownLatestState === LatestPatchState.NOT_LATEST,
+ () => html`
+ <span id="notLatestLabel">
+ ${this.computePatchSetWarning()}
+ <gr-button link @click=${this._reload}>Reload</gr-button>
+ </span>
+ `
+ )}
+ </div>
+ <div class="right">
+ <gr-button
+ link
+ id="cancelButton"
+ class="action cancel"
+ @click=${this.cancelTapHandler}
+ >Cancel</gr-button
+ >
+ ${when(
+ this.canBeStarted,
+ () => html`
+ <!-- Use 'Send' here as the change may only about reviewers / ccs
+ and when this button is visible, the next button will always
+ be 'Start review' -->
+ <gr-tooltip-content has-tooltip title=${this.saveTooltip}>
+ <gr-button
+ link
+ ?disabled=${this.knownLatestState ===
+ LatestPatchState.NOT_LATEST}
+ class="action save"
+ @click=${this.saveClickHandler}
+ >Send As WIP</gr-button
+ >
+ </gr-tooltip-content>
+ `
+ )}
+ <gr-tooltip-content
+ has-tooltip
+ title=${this.computeSendButtonTooltip(
+ this.canBeStarted,
+ this.commentEditing
+ )}
+ >
+ <gr-button
+ id="sendButton"
+ primary
+ ?disabled=${this.sendDisabled}
+ class="action send"
+ @click=${this.sendTapHandler}
+ >${this.sendButtonLabel}
+ </gr-button>
+ </gr-tooltip-content>
+ </div>
+ </section>
+ `;
+ }
+
/**
* Note that this method is not actually *opening* the dialog. Opening and
* showing the dialog is dealt with by the overlay. This method is used by the
@@ -444,48 +1204,57 @@
: LatestPatchState.NOT_LATEST;
});
- this._focusOn(focusTarget);
+ this.focusOn(focusTarget);
if (quote?.length) {
// If a reply quote has been provided, use it.
this.draft = quote;
} else {
// Otherwise, check for an unsaved draft in localstorage.
- this.draft = this._loadStoredDraft();
+ this.draft = this.loadStoredDraft();
}
if (this.restApiService.hasPendingDiffDrafts()) {
- this._savingComments = true;
+ this.savingComments = true;
this.restApiService.awaitPendingDiffDrafts().then(() => {
fireEvent(this, 'comment-refresh');
- this._savingComments = false;
+ this.savingComments = false;
});
}
}
- _computeHasDrafts(
- draft: string,
- draftCommentThreads: PolymerDeepPropertyChange<
- CommentThread[] | undefined,
- CommentThread[] | undefined
- >
- ) {
- if (draftCommentThreads.base === undefined) return false;
- return draft.length > 0 || draftCommentThreads.base.length > 0;
+ hasDrafts() {
+ if (this.draftCommentThreads === undefined) return false;
+ return this.draft.length > 0 || this.draftCommentThreads.length > 0;
}
override focus() {
- this._focusOn(FocusTarget.ANY);
+ this.focusOn(FocusTarget.ANY);
}
getFocusStops() {
- const end = this._sendDisabled ? this.$.cancelButton : this.$.sendButton;
- if (!this.$.reviewers.focusStart) return undefined;
+ const end = this.sendDisabled ? this.cancelButton : this.sendButton;
+ if (!this.reviewersList?.focusStart || !end) return undefined;
return {
- start: this.$.reviewers.focusStart,
+ start: this.reviewersList.focusStart,
end,
};
}
- setLabelValue(label: string, value: string) {
+ private handleResolvedPatchsetLevelCommentCheckboxChanged(e: Event) {
+ if (!(e.target instanceof HTMLInputElement)) return;
+ this.isResolvedPatchsetLevelComment = e.target.checked;
+ }
+
+ private handlePreviewFormattingChanged(e: Event) {
+ if (!(e.target instanceof HTMLInputElement)) return;
+ this.previewFormatting = e.target.checked;
+ }
+
+ private handleIncludeCommentsChanged(e: Event) {
+ if (!(e.target instanceof HTMLInputElement)) return;
+ this.includeComments = e.target.checked;
+ }
+
+ setLabelValue(label: string, value: string): void {
const selectorEl =
this.getLabelScores().shadowRoot?.querySelector<GrLabelScoreRow>(
`gr-label-score-row[name="${label}"]`
@@ -509,14 +1278,14 @@
? ReviewerType.CC
: ReviewerType.REVIEWER;
const isReviewer = ReviewerType.REVIEWER === reviewerType;
- const array = isReviewer ? this._ccs : this._reviewers;
+ const array = isReviewer ? this.ccs : this.reviewers;
const index = array.findIndex(
reviewer => accountOrGroupKey(reviewer) === key
);
if (index >= 0) {
// Remove any accounts that already exist as a CC for reviewer
// or vice versa.
- this.splice(isReviewer ? '_ccs' : '_reviewers', index, 1);
+ array.splice(index, 1);
const moveFrom = isReviewer ? 'CC' : 'reviewer';
const moveTo = isReviewer ? 'reviewer' : 'CC';
const id = account.name || key;
@@ -541,33 +1310,27 @@
reviewers.push(reviewer);
});
};
- addToReviewInput(this.$.reviewers.additions(), ReviewerState.REVIEWER);
- addToReviewInput(this.$.ccs.additions(), ReviewerState.CC);
+ addToReviewInput(this.reviewersList!.additions(), ReviewerState.REVIEWER);
+ addToReviewInput(this.ccsList!.additions(), ReviewerState.CC);
addToReviewInput(
- this.$.reviewers.removals().filter(
+ this.reviewersList!.removals().filter(
r =>
isReviewerOrCC(change, r) &&
// ignore removal from reviewer request if being added to CC
- !this.$.ccs
- .additions()
- .some(
- account =>
- mapReviewer(account).reviewer === mapReviewer(r).reviewer
- )
+ !this.ccsList!.additions().some(
+ account => mapReviewer(account).reviewer === mapReviewer(r).reviewer
+ )
),
ReviewerState.REMOVED
);
addToReviewInput(
- this.$.ccs.removals().filter(
+ this.ccsList!.removals().filter(
r =>
isReviewerOrCC(change, r) &&
// ignore removal from CC request if being added as reviewer
- !this.$.reviewers
- .additions()
- .some(
- account =>
- mapReviewer(account).reviewer === mapReviewer(r).reviewer
- )
+ !this.reviewersList!.additions().some(
+ account => mapReviewer(account).reviewer === mapReviewer(r).reviewer
+ )
),
ReviewerState.REMOVED
);
@@ -589,23 +1352,23 @@
reviewInput.ready = true;
}
- const reason = getReplyByReason(this._account, this.serverConfig);
+ const reason = getReplyByReason(this.account, this.serverConfig);
reviewInput.ignore_automatic_attention_set_rules = true;
reviewInput.add_to_attention_set = [];
- for (const user of this._newAttentionSet) {
- if (!this._currentAttentionSet.has(user)) {
+ for (const user of this.newAttentionSet) {
+ if (!this.currentAttentionSet.has(user)) {
reviewInput.add_to_attention_set.push({user, reason});
}
}
reviewInput.remove_from_attention_set = [];
- for (const user of this._currentAttentionSet) {
- if (!this._newAttentionSet.has(user)) {
+ for (const user of this.currentAttentionSet) {
+ if (!this.newAttentionSet.has(user)) {
reviewInput.remove_from_attention_set.push({user, reason});
}
}
this.reportAttentionSetChanges(
- this._attentionExpanded,
+ this.attentionExpanded,
reviewInput.add_to_attention_set,
reviewInput.remove_from_attention_set
);
@@ -613,7 +1376,7 @@
if (this.draft) {
const comment: CommentInput = {
message: this.draft,
- unresolved: !this._isResolvedPatchsetLevelComment,
+ unresolved: !this.isResolvedPatchsetLevelComment,
};
reviewInput.comments = {
[SpecialFilePath.PATCHSET_LEVEL_COMMENTS]: [comment],
@@ -624,8 +1387,8 @@
reviewInput.reviewers = this.computeReviewers(this.change);
this.disabled = true;
- const errFn = (r?: Response | null) => this._handle400Error(r);
- return this._saveReview(reviewInput, errFn)
+ const errFn = (r?: Response | null) => this.handle400Error(r);
+ return this.saveReview(reviewInput, errFn)
.then(response => {
if (!response) {
// Null or undefined response indicates that an error handler
@@ -638,7 +1401,7 @@
}
this.draft = '';
- this._includeComments = true;
+ this.includeComments = true;
this.dispatchEvent(
new CustomEvent('send', {
composed: true,
@@ -658,31 +1421,31 @@
});
}
- _focusOn(section?: FocusTarget) {
+ focusOn(section?: FocusTarget) {
// Safeguard- always want to focus on something.
if (!section || section === FocusTarget.ANY) {
- section = this._chooseFocusTarget();
+ section = this.chooseFocusTarget();
}
if (section === FocusTarget.BODY) {
const textarea = queryAndAssert<GrTextarea>(this, 'gr-textarea');
setTimeout(() => textarea.getNativeTextarea().focus());
} else if (section === FocusTarget.REVIEWERS) {
- const reviewerEntry = this.$.reviewers.focusStart;
+ const reviewerEntry = this.reviewersList?.focusStart;
setTimeout(() => reviewerEntry?.focus());
} else if (section === FocusTarget.CCS) {
- const ccEntry = this.$.ccs.focusStart;
+ const ccEntry = this.ccsList?.focusStart;
setTimeout(() => ccEntry?.focus());
}
}
- _chooseFocusTarget() {
+ chooseFocusTarget() {
// If we are the owner and the reviewers field is empty, focus on that.
if (
- this._account &&
+ this.account &&
this.change &&
this.change.owner &&
- this._account._account_id === this.change.owner._account_id &&
- (!this._reviewers || this._reviewers.length === 0)
+ this.account._account_id === this.change.owner._account_id &&
+ (!this.reviewers || this.reviewers?.length === 0)
) {
return FocusTarget.REVIEWERS;
}
@@ -691,15 +1454,15 @@
return FocusTarget.BODY;
}
- _isOwner(account?: AccountInfo, change?: ChangeInfo) {
+ isOwner(account?: AccountInfo, change?: ChangeInfo) {
if (!account || !change || !change.owner) return false;
return account._account_id === change.owner._account_id;
}
- _handle400Error(r?: Response | null) {
+ handle400Error(r?: Response | null) {
if (!r) throw new Error('Response is empty.');
let response: Response = r;
- // A call to _saveReview could fail with a server error if erroneous
+ // A call to saveReview could fail with a server error if erroneous
// reviewers were requested. This is signalled with a 400 Bad Request
// status. The default gr-rest-api error handling would result in a large
// JSON response body being displayed to the user in the gr-error-manager
@@ -734,45 +1497,42 @@
});
}
- _computeHideDraftList(draftCommentThreads?: CommentThread[]) {
+ computeHideDraftList(draftCommentThreads?: CommentThread[]) {
return !draftCommentThreads || draftCommentThreads.length === 0;
}
- _computeDraftsTitle(draftCommentThreads?: CommentThread[]) {
+ computeDraftsTitle(draftCommentThreads?: CommentThread[]) {
const total = draftCommentThreads ? draftCommentThreads.length : 0;
return pluralize(total, 'Draft');
}
- _computeMessagePlaceholder(canBeStarted: boolean) {
- return canBeStarted
+ computeMessagePlaceholder() {
+ this.messagePlaceholder = this.canBeStarted
? 'Add a note for your reviewers...'
: 'Say something nice...';
}
- @observe('change.reviewers.*', 'change.owner')
- _changeUpdated(
- changeRecord: PolymerDeepPropertyChange<Reviewers, Reviewers>,
- owner: AccountInfo
- ) {
- if (changeRecord === undefined || owner === undefined) return;
- this._rebuildReviewerArrays(changeRecord.base, owner);
+ changeUpdated() {
+ if (this.change === undefined) return;
+ this.rebuildReviewerArrays();
}
- _rebuildReviewerArrays(changeReviewers: Reviewers, owner: AccountInfo) {
- this._owner = owner;
+ rebuildReviewerArrays() {
+ if (!this.change?.owner || !this.change?.reviewers) return;
+ this.owner = this.change.owner;
const reviewers = [];
const ccs = [];
- if (changeReviewers) {
- for (const key of Object.keys(changeReviewers)) {
+ if (this.change.reviewers) {
+ for (const key of Object.keys(this.change.reviewers)) {
if (key !== 'REVIEWER' && key !== 'CC') {
this.reporting.error(new Error(`Unexpected reviewer state: ${key}`));
continue;
}
- if (!changeReviewers[key]) continue;
- for (const entry of changeReviewers[key]!) {
- if (entry._account_id === owner._account_id) {
+ if (!this.change.reviewers[key]) continue;
+ for (const entry of this.change.reviewers[key]!) {
+ if (entry._account_id === this.owner._account_id) {
continue;
}
switch (key) {
@@ -787,172 +1547,140 @@
}
}
- this._ccs = ccs;
- this._reviewers = reviewers;
+ this.ccs = ccs;
+ this.reviewers = reviewers;
}
- _handleAttentionModify() {
- this._attentionExpanded = true;
+ handleAttentionModify() {
+ this.attentionExpanded = true;
}
- @observe('_attentionExpanded')
- _onAttentionExpandedChange() {
+ onAttentionExpandedChange() {
// If the attention-detail section is expanded without dispatching this
// event, then the dialog may expand beyond the screen's bottom border.
fireEvent(this, 'iron-resize');
}
- _showAttentionSummary(attentionExpanded?: boolean) {
- return !attentionExpanded;
- }
-
- _showAttentionDetails(attentionExpanded?: boolean) {
- return attentionExpanded;
- }
-
- _computeAttentionButtonTitle(sendDisabled?: boolean) {
+ computeAttentionButtonTitle(sendDisabled?: boolean) {
return sendDisabled
? 'Modify the attention set by adding a comment or use the account ' +
'hovercard in the change page.'
: 'Edit attention set changes';
}
- _handleAttentionClick(e: Event) {
+ handleAttentionClick(e: Event) {
const id = (e.target as GrAccountChip)?.account?._account_id;
if (!id) return;
- const selfId = (this._account && this._account._account_id) || -1;
+ const selfId = (this.account && this.account._account_id) || -1;
const ownerId =
(this.change && this.change.owner && this.change.owner._account_id) || -1;
const self = id === selfId ? '_SELF' : '';
- const role = id === ownerId ? '_OWNER' : '_REVIEWER';
+ const role = id === ownerId ? 'OWNER' : '_REVIEWER';
- if (this._newAttentionSet.has(id)) {
- this._newAttentionSet.delete(id);
+ if (this.newAttentionSet.has(id)) {
+ this.newAttentionSet.delete(id);
this.reporting.reportInteraction(Interaction.ATTENTION_SET_CHIP, {
action: `REMOVE${self}${role}`,
});
} else {
- this._newAttentionSet.add(id);
+ this.newAttentionSet.add(id);
this.reporting.reportInteraction(Interaction.ATTENTION_SET_CHIP, {
action: `ADD${self}${role}`,
});
}
- // Ensure that Polymer picks up the change.
- this._newAttentionSet = new Set(this._newAttentionSet);
+ this.requestUpdate();
}
- _computeHasNewAttention(
- account?: AccountInfo,
- newAttention?: Set<AccountId>
- ) {
- return (
- newAttention &&
+ computeHasNewAttention(account?: AccountInfo) {
+ return !!(
account &&
account._account_id &&
- newAttention.has(account._account_id)
+ this.newAttentionSet?.has(account._account_id)
);
}
- @observe(
- '_account',
- '_reviewers.*',
- '_ccs.*',
- 'change',
- 'draftCommentThreads',
- '_includeComments',
- '_labelsChanged',
- 'hasDrafts'
- )
- _computeNewAttention(
- currentUser?: AccountInfo,
- reviewers?: PolymerDeepPropertyChange<
- AccountInfoInput[],
- AccountInfoInput[]
- >,
- ccs?: PolymerDeepPropertyChange<AccountInfoInput[], AccountInfoInput[]>,
- change?: ChangeInfo,
- draftCommentThreads?: CommentThread[],
- includeComments?: boolean,
- _labelsChanged?: boolean,
- hasDrafts?: boolean
- ) {
+ computeNewAttention() {
if (
- currentUser === undefined ||
- currentUser._account_id === undefined ||
- reviewers === undefined ||
- ccs === undefined ||
- change === undefined ||
- draftCommentThreads === undefined ||
- includeComments === undefined
+ this.account?._account_id === undefined ||
+ this.change === undefined ||
+ this.includeComments === undefined ||
+ this.draftCommentThreads === undefined
) {
return;
}
// The draft comments are only relevant for the attention set as long as the
// user actually plans to publish their drafts.
- draftCommentThreads = includeComments ? draftCommentThreads : [];
- const hasVote = !!_labelsChanged;
- const isOwner = this._isOwner(currentUser, change);
- const isUploader = this._uploader?._account_id === currentUser._account_id;
- this._attentionCcsCount = removeServiceUsers(ccs.base).length;
- this._currentAttentionSet = new Set(
- Object.keys(change.attention_set || {}).map(id => Number(id) as AccountId)
+ const draftCommentThreads = this.includeComments
+ ? this.draftCommentThreads
+ : [];
+ const hasVote = !!this.labelsChanged;
+ const isOwner = this.isOwner(this.account, this.change);
+ const isUploader = this.uploader?._account_id === this.account._account_id;
+ this.attentionCcsCount = removeServiceUsers(this.ccs).length;
+ this.currentAttentionSet = new Set(
+ Object.keys(this.change.attention_set || {}).map(
+ id => Number(id) as AccountId
+ )
);
- const newAttention = new Set(this._currentAttentionSet);
- if (change.status === ChangeStatus.NEW) {
+ const newAttention = new Set(this.currentAttentionSet);
+ if (this.change.status === ChangeStatus.NEW) {
// Add everyone that the user is replying to in a comment thread.
- this._computeCommentAccounts(draftCommentThreads).forEach(id =>
+ this.computeCommentAccounts(draftCommentThreads).forEach(id =>
newAttention.add(id)
);
// Remove the current user.
- newAttention.delete(currentUser._account_id);
+ newAttention.delete(this.account._account_id);
// Add all new reviewers, but not the current reviewer, if they are also
// sending a draft or a label vote.
const notIsReviewerAndHasDraftOrLabel = (r: AccountInfo) =>
- !(r._account_id === currentUser._account_id && (hasDrafts || hasVote));
- reviewers.base
- .filter(r => r._account_id)
+ !(
+ r._account_id === this.account!._account_id &&
+ (this.hasDrafts() || hasVote)
+ );
+ this.reviewers
+ .filter(r => isAccount(r))
.filter(r => r._pendingAdd || (this.canBeStarted && isOwner))
.filter(notIsReviewerAndHasDraftOrLabel)
- .forEach(r => newAttention.add(r._account_id!));
+ .forEach(r => newAttention.add((r as AccountInfo)._account_id!));
// Add owner and uploader, if someone else replies.
- if (hasDrafts || hasVote) {
- if (this._uploader?._account_id && !isUploader) {
- newAttention.add(this._uploader._account_id);
+ if (this.hasDrafts() || hasVote) {
+ if (this.uploader?._account_id && !isUploader) {
+ newAttention.add(this.uploader._account_id);
}
- if (change.owner?._account_id && !isOwner) {
- newAttention.add(change.owner._account_id);
+ if (this.change.owner?._account_id && !isOwner) {
+ newAttention.add(this.change.owner._account_id);
}
}
} else {
// The only reason for adding someone to the attention set for merged or
// abandoned changes is that someone makes a comment thread unresolved.
const hasUnresolvedDraft = draftCommentThreads.some(isUnresolved);
- if (change.owner && hasUnresolvedDraft) {
- // A change owner must have an _account_id.
- newAttention.add(change.owner._account_id!);
+ if (this.change.owner && hasUnresolvedDraft) {
+ // A change owner must have an account_id.
+ newAttention.add(this.change.owner._account_id!);
}
// Remove the current user.
- newAttention.delete(currentUser._account_id);
+ newAttention.delete(this.account._account_id);
}
// Finally make sure that everyone in the attention set is still active as
// owner, reviewer or cc.
- const allAccountIds = this._allAccounts()
+ const allAccountIds = this.allAccounts()
.map(a => a._account_id)
.filter(id => !!id);
- this._newAttentionSet = new Set(
+ this.newAttentionSet = new Set(
[...newAttention].filter(id => allAccountIds.includes(id))
);
- this._attentionExpanded = this._computeShowAttentionTip(
- currentUser,
- change.owner,
- this._currentAttentionSet,
- this._newAttentionSet
+ this.attentionExpanded = this.computeShowAttentionTip(
+ this.account,
+ this.change.owner,
+ this.currentAttentionSet,
+ this.newAttentionSet
);
}
- _computeShowAttentionTip(
+ computeShowAttentionTip(
currentUser?: AccountInfo,
owner?: AccountInfo,
currentAttentionSet?: Set<AccountId>,
@@ -967,7 +1695,7 @@
return isOwner && addedIds.length > 2;
}
- _computeCommentAccounts(threads: CommentThread[]) {
+ computeCommentAccounts(threads: CommentThread[]) {
const crLabel = this.change?.labels?.[StandardLabels.CODE_REVIEW];
const maxCrVoteAccountIds = getMaxAccounts(crLabel).map(a => a._account_id);
const accountIds = new Set<AccountId>();
@@ -975,7 +1703,7 @@
const unresolved = isUnresolved(thread);
thread.comments.forEach(comment => {
if (comment.author) {
- // A comment author must have an _account_id.
+ // A comment author must have an account_id.
const authorId = comment.author._account_id!;
const hasGivenMaxReviewVote = maxCrVoteAccountIds.includes(authorId);
if (unresolved || !hasGivenMaxReviewVote) accountIds.add(authorId);
@@ -985,110 +1713,93 @@
return accountIds;
}
- _computeShowNoAttentionUpdate(
- config?: ServerInfo,
- currentAttentionSet?: Set<AccountId>,
- newAttentionSet?: Set<AccountId>,
- sendDisabled?: boolean
- ) {
- return (
- sendDisabled ||
- this._computeNewAttentionAccounts(
- config,
- currentAttentionSet,
- newAttentionSet
- ).length === 0
- );
+ computeShowNoAttentionUpdate() {
+ return this.sendDisabled || this.computeNewAttentionAccounts().length === 0;
}
- _computeDoNotUpdateMessage(
- currentAttentionSet?: Set<AccountId>,
- newAttentionSet?: Set<AccountId>,
- sendDisabled?: boolean
- ) {
- if (!currentAttentionSet || !newAttentionSet) return '';
- if (sendDisabled || areSetsEqual(currentAttentionSet, newAttentionSet)) {
+ computeDoNotUpdateMessage() {
+ if (!this.currentAttentionSet || !this.newAttentionSet) return '';
+ if (
+ this.sendDisabled ||
+ areSetsEqual(this.currentAttentionSet, this.newAttentionSet)
+ ) {
return 'No changes to the attention set.';
}
- if (containsAll(currentAttentionSet, newAttentionSet)) {
+ if (containsAll(this.currentAttentionSet, this.newAttentionSet)) {
return 'No additions to the attention set.';
}
this.reporting.error(
new Error(
- '_computeDoNotUpdateMessage()' +
+ 'computeDoNotUpdateMessage()' +
'should not be called when users were added to the attention set.'
)
);
return '';
}
- _computeNewAttentionAccounts(
- _?: ServerInfo,
- currentAttentionSet?: Set<AccountId>,
- newAttentionSet?: Set<AccountId>
- ) {
- if (currentAttentionSet === undefined || newAttentionSet === undefined) {
+ computeNewAttentionAccounts(): AccountInfo[] {
+ if (
+ this.currentAttentionSet === undefined ||
+ this.newAttentionSet === undefined
+ ) {
return [];
}
- return [...newAttentionSet]
- .filter(id => !currentAttentionSet.has(id))
- .map(id => this._findAccountById(id))
- .filter(account => !!account);
+ return [...this.newAttentionSet]
+ .filter(id => !this.currentAttentionSet.has(id))
+ .map(id => this.findAccountById(id))
+ .filter(account => !!account) as AccountInfo[];
}
- _findAccountById(accountId: AccountId) {
- return this._allAccounts().find(r => r._account_id === accountId);
+ findAccountById(accountId: AccountId) {
+ return this.allAccounts().find(r => r._account_id === accountId);
}
- _allAccounts() {
+ allAccounts() {
let allAccounts: (AccountInfoInput | GroupInfoInput)[] = [];
if (this.change && this.change.owner) allAccounts.push(this.change.owner);
- if (this._uploader) allAccounts.push(this._uploader);
- if (this._reviewers) allAccounts = [...allAccounts, ...this._reviewers];
- if (this._ccs) allAccounts = [...allAccounts, ...this._ccs];
+ if (this.uploader) allAccounts.push(this.uploader);
+ if (this.reviewers) allAccounts = [...allAccounts, ...this.reviewers];
+ if (this.ccs) allAccounts = [...allAccounts, ...this.ccs];
return removeServiceUsers(allAccounts.filter(isAccount));
}
- /**
- * The newAttentionSet param is only used to force re-computation.
- */
- _removeServiceUsers(accounts: AccountInfo[], _: Set<AccountId>) {
+ removeServiceUsers(accounts: AccountInfo[]) {
return removeServiceUsers(accounts);
}
- _computeUploader(change: ChangeInfo) {
+ computeUploader() {
if (
- !change ||
- !change.current_revision ||
- !change.revisions ||
- !change.revisions[change.current_revision]
+ !this.change?.current_revision ||
+ !this.change?.revisions?.[this.change.current_revision]
) {
- return undefined;
+ this.uploader = undefined;
+ return;
}
- const rev = change.revisions[change.current_revision];
+ const rev = this.change.revisions[this.change.current_revision];
if (
!rev.uploader ||
- change.owner._account_id === rev.uploader._account_id
+ this.change?.owner._account_id === rev.uploader._account_id
) {
- return undefined;
+ this.uploader = undefined;
+ return;
}
- return rev.uploader;
+ this.uploader = rev.uploader;
}
/**
* Generates a function to filter out reviewer/CC entries. When isCCs is
- * truthy, the function filters out entries that already exist in this._ccs.
- * When falsy, the function filters entries that exist in this._reviewers.
+ * truthy, the function filters out entries that already exist in this.ccs.
+ * When falsy, the function filters entries that exist in this.reviewers.
*/
- _filterReviewerSuggestionGenerator(
+ filterReviewerSuggestionGenerator(
isCCs: boolean
): (input: Suggestion) => boolean {
return suggestion => {
let entry: AccountInfo | GroupInfo;
if (isReviewerAccountSuggestion(suggestion)) {
entry = suggestion.account;
- if (entry._account_id === this._owner?._account_id) {
+ if (entry._account_id === this.owner?._account_id) {
return false;
}
} else if (isReviewerGroupSuggestion(suggestion)) {
@@ -1104,24 +1815,20 @@
const finder = (entry: AccountInfo | GroupInfo) =>
accountOrGroupKey(entry) === key;
if (isCCs) {
- return this._ccs.find(finder) === undefined;
+ return this.ccs.find(finder) === undefined;
}
- return this._reviewers.find(finder) === undefined;
+ return this.reviewers.find(finder) === undefined;
};
}
- _getAccount() {
- return this.restApiService.getAccount();
- }
-
- _cancelTapHandler(e: Event) {
+ cancelTapHandler(e: Event) {
e.preventDefault();
this.cancel();
}
cancel() {
assertIsDefined(this.change, 'change');
- if (!this._owner) throw new Error('missing required _owner property');
+ if (!this.owner) throw new Error('missing required owner property');
this.dispatchEvent(
new CustomEvent('cancel', {
composed: true,
@@ -1129,36 +1836,36 @@
})
);
queryAndAssert<GrTextarea>(this, 'gr-textarea').closeDropdown();
- this.$.reviewers.clearPendingRemovals();
- this._rebuildReviewerArrays(this.change.reviewers, this._owner);
+ this.reviewersList?.clearPendingRemovals();
+ this.rebuildReviewerArrays();
}
- _saveClickHandler(e: Event) {
+ saveClickHandler(e: Event) {
e.preventDefault();
- if (!this.$.ccs.submitEntryText()) {
+ if (!this.ccsList?.submitEntryText()) {
// Do not proceed with the save if there is an invalid email entry in
// the text field of the CC entry.
return;
}
- this.send(this._includeComments, false);
+ this.send(this.includeComments, false);
}
- _sendTapHandler(e: Event) {
+ sendTapHandler(e: Event) {
e.preventDefault();
- this._submit();
+ this.submit();
}
- _submit() {
- if (!this.$.ccs.submitEntryText()) {
+ submit() {
+ if (!this.ccsList?.submitEntryText()) {
// Do not proceed with the send if there is an invalid email entry in
// the text field of the CC entry.
return;
}
- if (this._sendDisabled) {
+ if (this.sendDisabled) {
fireAlert(this, EMPTY_REPLY_MESSAGE);
return;
}
- return this.send(this._includeComments, this.canBeStarted).catch(err => {
+ return this.send(this.includeComments, this.canBeStarted).catch(err => {
this.dispatchEvent(
new CustomEvent('show-error', {
bubbles: true,
@@ -1169,7 +1876,7 @@
});
}
- _saveReview(review: ReviewInput, errFn?: ErrorCallback) {
+ saveReview(review: ReviewInput, errFn?: ErrorCallback) {
assertIsDefined(this.change, 'change');
assertIsDefined(this.patchNum, 'patchNum');
return this.restApiService.saveChangeReview(
@@ -1180,43 +1887,43 @@
);
}
- _reviewerPendingConfirmationUpdated(reviewer: RawAccountInput | null) {
+ pendingConfirmationUpdated(reviewer: RawAccountInput | null) {
if (reviewer === null) {
- this.$.reviewerConfirmationOverlay.close();
+ this.reviewerConfirmationOverlay?.close();
} else {
- this._pendingConfirmationDetails =
- this._ccPendingConfirmation || this._reviewerPendingConfirmation;
- this.$.reviewerConfirmationOverlay.open();
+ this.pendingConfirmationDetails =
+ this.ccPendingConfirmation || this.reviewerPendingConfirmation;
+ this.reviewerConfirmationOverlay?.open();
}
}
- _confirmPendingReviewer() {
- if (this._ccPendingConfirmation) {
- this.$.ccs.confirmGroup(this._ccPendingConfirmation.group);
- this._focusOn(FocusTarget.CCS);
+ confirmPendingReviewer() {
+ if (this.ccPendingConfirmation) {
+ this.ccsList?.confirmGroup(this.ccPendingConfirmation.group);
+ this.focusOn(FocusTarget.CCS);
return;
}
- if (this._reviewerPendingConfirmation) {
- this.$.reviewers.confirmGroup(this._reviewerPendingConfirmation.group);
- this._focusOn(FocusTarget.REVIEWERS);
+ if (this.reviewerPendingConfirmation) {
+ this.reviewersList?.confirmGroup(this.reviewerPendingConfirmation.group);
+ this.focusOn(FocusTarget.REVIEWERS);
return;
}
this.reporting.error(
- new Error('_confirmPendingReviewer called without pending confirm')
+ new Error('confirmPendingReviewer called without pending confirm')
);
}
- _cancelPendingReviewer() {
- this._ccPendingConfirmation = null;
- this._reviewerPendingConfirmation = null;
+ cancelPendingReviewer() {
+ this.ccPendingConfirmation = null;
+ this.reviewerPendingConfirmation = null;
- const target = this._ccPendingConfirmation
+ const target = this.ccPendingConfirmation
? FocusTarget.CCS
: FocusTarget.REVIEWERS;
- this._focusOn(target);
+ this.focusOn(target);
}
- _getStorageLocation(): StorageLocation {
+ getStorageLocation(): StorageLocation {
assertIsDefined(this.change, 'change');
return {
changeNum: this.change._number,
@@ -1225,77 +1932,73 @@
};
}
- _loadStoredDraft() {
- const draft = this.storage.getDraftComment(this._getStorageLocation());
+ loadStoredDraft() {
+ const draft = this.storage.getDraftComment(this.getStorageLocation());
return draft?.message ?? '';
}
- _handleAccountTextEntry() {
+ handleAccountTextEntry() {
// When either of the account entries has input added to the autocomplete,
// it should trigger the save button to enable/
//
// Note: if the text is removed, the save button will not get disabled.
- this._reviewersMutated = true;
+ this.reviewersMutated = true;
}
- _draftChanged(newDraft: string, oldDraft?: string) {
+ draftChanged(oldDraft: string) {
this.storeTask = debounce(
this.storeTask,
() => {
- if (!newDraft.length && oldDraft) {
+ if (!this.draft.length && oldDraft) {
// If the draft has been modified to be empty, then erase the storage
// entry.
- this.storage.eraseDraftComment(this._getStorageLocation());
- } else if (newDraft.length) {
- this.storage.setDraftComment(this._getStorageLocation(), this.draft);
+ this.storage.eraseDraftComment(this.getStorageLocation());
+ } else if (this.draft.length) {
+ this.storage.setDraftComment(this.getStorageLocation(), this.draft);
}
},
STORAGE_DEBOUNCE_INTERVAL_MS
);
}
- _handleHeightChanged() {
+ handleHeightChanged() {
fireEvent(this, 'autogrow');
}
- getLabelScores() {
- return this.$.labelScores || queryAndAssert(this, 'gr-label-scores');
+ getLabelScores(): GrLabelScores {
+ return this.labelScores || queryAndAssert(this, 'gr-label-scores');
}
_handleLabelsChanged() {
- this._labelsChanged =
+ this.labelsChanged =
Object.keys(this.getLabelScores().getLabelValues(false)).length !== 0;
}
// To decouple account-list and reply dialog
- _getAccountListCopy(list: (AccountInfo | GroupInfo)[]) {
+ getAccountListCopy(list: (AccountInfo | GroupInfo)[]) {
return list.slice();
}
- _handleReviewersChanged(e: ValueChangedEvent<(AccountInfo | GroupInfo)[]>) {
- this._reviewers = e.detail.value.slice();
- this._reviewersMutated = true;
+ handleReviewersChanged(e: ValueChangedEvent<(AccountInfo | GroupInfo)[]>) {
+ this.reviewers = e.detail.value.slice();
+ this.reviewersMutated = true;
}
- _handleCcsChanged(e: ValueChangedEvent<(AccountInfo | GroupInfo)[]>) {
- this._ccs = e.detail.value.slice();
- this._reviewersMutated = true;
+ handleCcsChanged(e: ValueChangedEvent<(AccountInfo | GroupInfo)[]>) {
+ this.ccs = e.detail.value.slice();
+ this.reviewersMutated = true;
}
- _handleReviewersConfirmationChanged(
+ handleReviewersConfirmationChanged(
e: ValueChangedEvent<SuggestedReviewerGroupInfo | null>
) {
- this._reviewerPendingConfirmation = e.detail.value;
+ this.reviewerPendingConfirmation = e.detail.value;
}
- _handleCcsConfirmationChanged(
+ handleCcsConfirmationChanged(
e: ValueChangedEvent<SuggestedReviewerGroupInfo | null>
) {
- this._ccPendingConfirmation = e.detail.value;
- }
-
- _isState(knownLatestState?: LatestPatchState, value?: LatestPatchState) {
- return knownLatestState === value;
+ this.ccPendingConfirmation = e.detail.value;
}
_reload() {
@@ -1303,82 +2006,77 @@
this.cancel();
}
- _computeSendButtonLabel(canBeStarted: boolean) {
- return canBeStarted
+ computeSendButtonLabel() {
+ this.sendButtonLabel = this.canBeStarted
? ButtonLabels.SEND + ' and ' + ButtonLabels.START_REVIEW
: ButtonLabels.SEND;
}
- _computeSendButtonTooltip(canBeStarted?: boolean, commentEditing?: boolean) {
+ computeSendButtonTooltip(canBeStarted?: boolean, commentEditing?: boolean) {
if (commentEditing) {
return ButtonTooltips.DISABLED_COMMENT_EDITING;
}
return canBeStarted ? ButtonTooltips.START_REVIEW : ButtonTooltips.SEND;
}
- _computeSavingLabelClass(savingComments: boolean) {
+ computeSavingLabelClass(savingComments: boolean) {
return savingComments ? 'saving' : '';
}
- _computeSendButtonDisabled(
- canBeStarted?: boolean,
- draftCommentThreads?: CommentThread[],
- text?: string,
- reviewersMutated?: boolean,
- labelsChanged?: boolean,
- includeComments?: boolean,
- disabled?: boolean,
- commentEditing?: boolean,
- change?: ChangeInfo,
- account?: AccountInfo
- ) {
+ computeSendButtonDisabled() {
if (
- canBeStarted === undefined ||
- draftCommentThreads === undefined ||
- text === undefined ||
- reviewersMutated === undefined ||
- labelsChanged === undefined ||
- includeComments === undefined ||
- disabled === undefined ||
- commentEditing === undefined ||
- change?.labels === undefined ||
- account === undefined
+ this.canBeStarted === undefined ||
+ this.draftCommentThreads === undefined ||
+ this.draft === undefined ||
+ this.reviewersMutated === undefined ||
+ this.labelsChanged === undefined ||
+ this.includeComments === undefined ||
+ this.disabled === undefined ||
+ this.commentEditing === undefined ||
+ this.change?.labels === undefined ||
+ this.account === undefined
) {
return undefined;
}
- if (commentEditing || disabled) {
+ if (this.commentEditing || this.disabled) {
return true;
}
- if (canBeStarted === true) {
+ if (this.canBeStarted === true) {
return false;
}
- const existingVote = Object.values(change.labels).some(
- label => isDetailedLabelInfo(label) && getApprovalInfo(label, account)
+ const existingVote = Object.values(this.change.labels).some(
+ label =>
+ isDetailedLabelInfo(label) && getApprovalInfo(label, this.account!)
);
- const revotingOrNewVote = labelsChanged || existingVote;
- const hasDrafts = includeComments && draftCommentThreads.length;
+ const revotingOrNewVote = this.labelsChanged || existingVote;
+ const hasDrafts =
+ this.includeComments && this.draftCommentThreads.length > 0;
return (
- !hasDrafts && !text.length && !reviewersMutated && !revotingOrNewVote
+ !hasDrafts &&
+ !this.draft.length &&
+ !this.reviewersMutated &&
+ !revotingOrNewVote
);
}
- _computePatchSetWarning(patchNum?: PatchSetNum, labelsChanged?: boolean) {
- let str = `Patch ${patchNum} is not latest.`;
- if (labelsChanged) {
+ computePatchSetWarning() {
+ let str = `Patch ${this.patchNum} is not latest.`;
+ if (this.labelsChanged) {
str += ' Voting may have no effect.';
}
return str;
}
setPluginMessage(message: string) {
- this._pluginMessage = message;
+ this.pluginMessage = message;
}
- _sendDisabledChanged() {
+ sendDisabledChanged() {
this.dispatchEvent(new CustomEvent('send-disabled-changed'));
}
- _getReviewerSuggestionsProvider(change: ChangeInfo) {
+ getReviewerSuggestionsProvider(change?: ChangeInfo) {
+ if (!change) return;
const provider = GrReviewerSuggestionsProvider.create(
this.restApiService,
change._number,
@@ -1388,7 +2086,8 @@
return provider;
}
- _getCcSuggestionsProvider(change: ChangeInfo) {
+ getCcSuggestionsProvider(change?: ChangeInfo) {
+ if (!change) return;
const provider = GrReviewerSuggestionsProvider.create(
this.restApiService,
change._number,
@@ -1406,24 +2105,24 @@
const actions = modified ? ['MODIFIED'] : ['NOT_MODIFIED'];
const ownerId =
(this.change && this.change.owner && this.change.owner._account_id) || -1;
- const selfId = (this._account && this._account._account_id) || -1;
+ const selfId = (this.account && this.account._account_id) || -1;
for (const added of addedSet || []) {
const addedId = added.user;
const self = addedId === selfId ? '_SELF' : '';
- const role = addedId === ownerId ? '_OWNER' : '_REVIEWER';
+ const role = addedId === ownerId ? 'OWNER' : '_REVIEWER';
actions.push('ADD' + self + role);
}
for (const removed of removedSet || []) {
const removedId = removed.user;
const self = removedId === selfId ? '_SELF' : '';
- const role = removedId === ownerId ? '_OWNER' : '_REVIEWER';
+ const role = removedId === ownerId ? 'OWNER' : '_REVIEWER';
actions.push('REMOVE' + self + role);
}
this.reporting.reportInteraction('attention-set-actions', {actions});
}
- _computeAllReviewers() {
- return [...this._reviewers];
+ computeAllReviewers() {
+ this.allReviewers = [...this.reviewers];
}
}
diff --git a/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog_html.ts b/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog_html.ts
deleted file mode 100644
index c4b3578..0000000
--- a/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog_html.ts
+++ /dev/null
@@ -1,652 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="shared-styles">
- :host {
- background-color: var(--dialog-background-color);
- display: block;
- max-height: 90vh;
- }
- :host([disabled]) {
- pointer-events: none;
- }
- :host([disabled]) .container {
- opacity: 0.5;
- }
- section {
- border-top: 1px solid var(--border-color);
- flex-shrink: 0;
- padding: var(--spacing-m) var(--spacing-xl);
- width: 100%;
- }
- section.labelsContainer {
- /* We want the :hover highlight to extend to the border of the dialog. */
- padding: var(--spacing-m) 0;
- }
- .stickyBottom {
- background-color: var(--dialog-background-color);
- box-shadow: 0px 0px 8px 0px rgba(60, 64, 67, 0.15);
- margin-top: var(--spacing-s);
- bottom: 0;
- position: sticky;
- /* @see Issue 8602 */
- z-index: 1;
- }
- .stickyBottom.newReplyDialog {
- margin-top: unset;
- }
- .actions {
- display: flex;
- justify-content: space-between;
- }
- .actions .right gr-button {
- margin-left: var(--spacing-l);
- }
- .peopleContainer,
- .labelsContainer {
- flex-shrink: 0;
- }
- .peopleContainer {
- border-top: none;
- display: table;
- }
- .peopleList {
- display: flex;
- }
- .peopleListLabel {
- color: var(--deemphasized-text-color);
- margin-top: var(--spacing-xs);
- min-width: 6em;
- padding-right: var(--spacing-m);
- }
- gr-account-list {
- display: flex;
- flex-wrap: wrap;
- flex: 1;
- }
- #reviewerConfirmationOverlay {
- padding: var(--spacing-l);
- text-align: center;
- }
- .reviewerConfirmationButtons {
- margin-top: var(--spacing-l);
- }
- .groupName {
- font-weight: var(--font-weight-bold);
- }
- .groupSize {
- font-style: italic;
- }
- .textareaContainer {
- min-height: 12em;
- position: relative;
- }
- .newReplyDialog.textareaContainer {
- min-height: unset;
- }
- textareaContainer,
- #textarea,
- gr-endpoint-decorator[name='reply-text'] {
- display: flex;
- width: 100%;
- }
- .newReplyDialog .textareaContainer,
- #textarea,
- gr-endpoint-decorator[name='reply-text'] {
- display: block;
- width: unset;
- font-family: var(--monospace-font-family);
- font-size: var(--font-size-code);
- line-height: calc(var(--font-size-code) + var(--spacing-s));
- font-weight: var(--font-weight-normal);
- }
- .newReplyDialog#textarea {
- padding: var(--spacing-m);
- }
- gr-endpoint-decorator[name='reply-text'] {
- flex-direction: column;
- }
- #textarea {
- flex: 1;
- }
- .previewContainer {
- border-top: none;
- }
- .previewContainer gr-formatted-text {
- background: var(--table-header-background-color);
- padding: var(--spacing-l);
- }
- #checkingStatusLabel,
- #notLatestLabel {
- margin-left: var(--spacing-l);
- }
- #checkingStatusLabel {
- color: var(--deemphasized-text-color);
- font-style: italic;
- }
- #notLatestLabel,
- #savingLabel {
- color: var(--error-text-color);
- }
- #savingLabel {
- display: none;
- }
- #savingLabel.saving {
- display: inline;
- }
- #pluginMessage {
- color: var(--deemphasized-text-color);
- margin-left: var(--spacing-l);
- margin-bottom: var(--spacing-m);
- }
- #pluginMessage:empty {
- display: none;
- }
- .preview-formatting {
- margin-left: var(--spacing-m);
- }
- .attention-icon {
- width: 14px;
- height: 14px;
- vertical-align: top;
- position: relative;
- top: 3px;
- --iron-icon-height: 24px;
- --iron-icon-width: 24px;
- }
- .attention .edit-attention-button {
- vertical-align: top;
- --gr-button-padding: 0px 4px;
- }
- .attention .edit-attention-button iron-icon {
- color: inherit;
- }
- .attention a,
- .attention-detail a {
- text-decoration: none;
- }
- .attentionSummary {
- display: flex;
- justify-content: space-between;
- }
- .attentionSummary {
- /* The account label for selection is misbehaving currently: It consumes
- 26px height instead of 20px, which is the default line-height and thus
- the max that can be nicely fit into an inline layout flow. We
- acknowledge that using a fixed 26px value here is a hack and not a
- great solution. */
- line-height: 26px;
- }
- .attentionSummary gr-account-label,
- .attention-detail gr-account-label {
- --account-max-length: 120px;
- display: inline-block;
- padding: var(--spacing-xs) var(--spacing-m);
- user-select: none;
- --label-border-radius: 8px;
- }
- .attentionSummary gr-account-label {
- margin: 0 var(--spacing-xs);
- line-height: var(--line-height-normal);
- vertical-align: top;
- }
- .attention-detail .peopleListValues {
- line-height: calc(var(--line-height-normal) + 10px);
- }
- .attention-detail gr-account-label {
- line-height: var(--line-height-normal);
- }
- .attentionSummary gr-account-label:focus,
- .attention-detail gr-account-label:focus {
- outline: none;
- }
- .attentionSummary gr-account-label:hover,
- .attention-detail gr-account-label:hover {
- box-shadow: var(--elevation-level-1);
- cursor: pointer;
- }
- .attention-detail .attentionDetailsTitle {
- display: flex;
- justify-content: space-between;
- }
- .attention-detail .selectUsers {
- color: var(--deemphasized-text-color);
- margin-bottom: var(--spacing-m);
- }
- .attentionTip {
- padding: var(--spacing-m);
- border: 1px solid var(--border-color);
- border-radius: var(--border-radius);
- margin-top: var(--spacing-m);
- background-color: var(--assignee-highlight-color);
- }
- .attentionTip div iron-icon {
- margin-right: var(--spacing-s);
- }
- .patchsetLevelContainer {
- width: 80ch;
- border-radius: var(--border-radius);
- box-shadow: var(--elevation-level-2);
- }
- .patchsetLevelContainer.resolved{
- background-color: var(--comment-background-color);
- }
- .patchsetLevelContainer.unresolved{
- background-color: var(--unresolved-comment-background-color);
- }
- .labelContainer {
- padding-left: var(--spacing-m);
- padding-bottom: var(--spacing-m);
- }
-
- </style>
- <div tabindex="-1">
- <section class="peopleContainer">
- <gr-endpoint-decorator name="reply-reviewers">
- <gr-endpoint-param name="change" value="[[change]]"></gr-endpoint-param>
- <gr-endpoint-param name="reviewers" value="[[_allReviewers]]">
- </gr-endpoint-param>
- <div class="peopleList">
- <div class="peopleListLabel">Reviewers</div>
- <gr-account-list
- id="reviewers"
- accounts="[[_getAccountListCopy(_reviewers)]]"
- on-account-added="accountAdded"
- on-accounts-changed="_handleReviewersChanged"
- removable-values="[[change.removable_reviewers]]"
- filter="[[filterReviewerSuggestion]]"
- pending-confirmation="[[_reviewerPendingConfirmation]]"
- on-pending-confirmation-changed="_handleReviewersConfirmationChanged"
- placeholder="Add reviewer..."
- on-account-text-changed="_handleAccountTextEntry"
- suggestions-provider="[[_getReviewerSuggestionsProvider(change)]]"
- >
- </gr-account-list>
- <gr-endpoint-slot name="right"></gr-endpoint-slot>
- </div>
- <gr-endpoint-slot name="below"></gr-endpoint-slot>
- </gr-endpoint-decorator>
- <div class="peopleList">
- <div class="peopleListLabel">CC</div>
- <gr-account-list
- id="ccs"
- accounts="[[_getAccountListCopy(_ccs)]]"
- on-account-added="accountAdded"
- on-accounts-changed="_handleCcsChanged"
- filter="[[filterCCSuggestion]]"
- pending-confirmation="[[_ccPendingConfirmation]]"
- pending-confirmation-changed="_handleCcsConfirmationChanged"
- allow-any-input=""
- placeholder="Add CC..."
- on-account-text-changed="_handleAccountTextEntry"
- suggestions-provider="[[_getCcSuggestionsProvider(change)]]"
- >
- </gr-account-list>
- </div>
- <gr-overlay
- id="reviewerConfirmationOverlay"
- on-iron-overlay-canceled="_cancelPendingReviewer"
- >
- <div class="reviewerConfirmation">
- Group
- <span class="groupName">
- [[_pendingConfirmationDetails.group.name]]
- </span>
- has
- <span class="groupSize"> [[_pendingConfirmationDetails.count]] </span>
- members.
- <br />
- Are you sure you want to add them all?
- </div>
- <div class="reviewerConfirmationButtons">
- <gr-button on-click="_confirmPendingReviewer">Yes</gr-button>
- <gr-button on-click="_cancelPendingReviewer">No</gr-button>
- </div>
- </gr-overlay>
- </section>
-
- <section class="labelsContainer">
- <gr-endpoint-decorator name="reply-label-scores">
- <gr-label-scores
- id="labelScores"
- account="[[_account]]"
- change="[[change]]"
- on-labels-changed="_handleLabelsChanged"
- permitted-labels="[[permittedLabels]]"
- ></gr-label-scores>
- <gr-endpoint-param name="change" value="[[change]]"></gr-endpoint-param>
- </gr-endpoint-decorator>
- <div id="pluginMessage">[[_pluginMessage]]</div>
- </section>
- <section class="newReplyDialog textareaContainer">
- <div class$="patchsetLevelContainer [[getUnresolvedPatchsetLevelClass(_isResolvedPatchsetLevelComment)]]">
- <gr-endpoint-decorator name="reply-text">
- <gr-textarea
- id="textarea"
- class="message newReplyDialog"
- autocomplete="on"
- placeholder="[[_messagePlaceholder]]"
- monospace="true"
- disabled="{{disabled}}"
- rows="4"
- text="{{draft}}"
- on-bind-value-changed="_handleHeightChanged"
- >
- </gr-textarea>
- <gr-endpoint-param name="change" value="[[change]]">
- </gr-endpoint-param>
- </gr-endpoint-decorator>
- <div class="labelContainer">
- <label>
- <input
- id="resolvedPatchsetLevelCommentCheckbox"
- type="checkbox"
- checked="{{_isResolvedPatchsetLevelComment::change}}"
- />
- Resolved
- </label>
- <label class="preview-formatting">
- <input type="checkbox" checked="{{_previewFormatting::change}}" />
- Preview formatting
- </label>
- </div>
- </div>
- </section>
- <template is="dom-if" if="[[_previewFormatting]]">
- <section class="previewContainer">
- <gr-formatted-text
- content="[[draft]]"
- config="[[projectConfig.commentlinks]]"
- ></gr-formatted-text>
- </template>
- </section>
-
- <section
- class="draftsContainer"
- hidden$="[[_computeHideDraftList(draftCommentThreads)]]"
- >
- <div class="includeComments">
- <input
- type="checkbox"
- id="includeComments"
- checked="{{_includeComments::change}}"
- />
- <label for="includeComments"
- >Publish [[_computeDraftsTitle(draftCommentThreads)]]</label
- >
- </div>
- <gr-thread-list
- id="commentList"
- hidden$="[[!_includeComments]]"
- threads="[[draftCommentThreads]]"
- hide-dropdown=""
- >
- </gr-thread-list>
- <span
- id="savingLabel"
- class$="[[_computeSavingLabelClass(_savingComments)]]"
- >
- Saving comments...
- </span>
- </section>
- <div class="stickyBottom newReplyDialog">
- <gr-endpoint-decorator name="reply-bottom">
- <gr-endpoint-param name="change" value="[[change]]"></gr-endpoint-param>
- <section
- hidden$="[[!_showAttentionSummary(_attentionExpanded)]]"
- class="attention"
- >
- <div class="attentionSummary">
- <div>
- <template
- is="dom-if"
- if="[[_computeShowNoAttentionUpdate(serverConfig, _currentAttentionSet, _newAttentionSet, _sendDisabled)]]"
- >
- <span
- >[[_computeDoNotUpdateMessage(_currentAttentionSet,
- _newAttentionSet, _sendDisabled)]]</span
- >
- </template>
- <template
- is="dom-if"
- if="[[!_computeShowNoAttentionUpdate(serverConfig, _currentAttentionSet, _newAttentionSet, _sendDisabled)]]"
- >
- <span>Bring to attention of</span>
- <template
- is="dom-repeat"
- items="[[_computeNewAttentionAccounts(serverConfig, _currentAttentionSet, _newAttentionSet)]]"
- as="account"
- >
- <gr-account-label
- account="[[account]]"
- force-attention="[[_computeHasNewAttention(account, _newAttentionSet)]]"
- selected="[[_computeHasNewAttention(account, _newAttentionSet)]]"
- hideHovercard
- selectionChipStyle
- on-click="_handleAttentionClick"
- ></gr-account-label>
- </template>
- </template>
- <gr-tooltip-content
- has-tooltip
- title="[[_computeAttentionButtonTitle(_sendDisabled)]]"
- >
- <gr-button
- class="edit-attention-button"
- on-click="_handleAttentionModify"
- disabled="[[_sendDisabled]]"
- link=""
- position-below=""
- data-label="Edit"
- data-action-type="change"
- data-action-key="edit"
- role="button"
- tabindex="0"
- >
- <iron-icon icon="gr-icons:edit"></iron-icon>
- Modify
- </gr-button>
- </gr-tooltip-content>
- </div>
- <div>
- <a
- href="https://gerrit-review.googlesource.com/Documentation/user-attention-set.html"
- target="_blank"
- >
- <iron-icon
- icon="gr-icons:help-outline"
- title="read documentation"
- ></iron-icon>
- </a>
- </div>
- </div>
- </section>
- <section
- hidden$="[[!_showAttentionDetails(_attentionExpanded)]]"
- class="attention-detail"
- >
- <div class="attentionDetailsTitle">
- <div>
- <span>Modify attention to</span>
- </div>
- <div></div>
- <div>
- <a
- href="https://gerrit-review.googlesource.com/Documentation/user-attention-set.html"
- target="_blank"
- >
- <iron-icon
- icon="gr-icons:help-outline"
- title="read documentation"
- ></iron-icon>
- </a>
- </div>
- </div>
- <div class="selectUsers">
- <span
- >Select chips to set who will be in the attention set after sending
- this reply</span
- >
- </div>
- <div class="peopleList">
- <div class="peopleListLabel">Owner</div>
- <div class="peopleListValues">
- <gr-account-label
- account="[[_owner]]"
- force-attention="[[_computeHasNewAttention(_owner, _newAttentionSet)]]"
- selected="[[_computeHasNewAttention(_owner, _newAttentionSet)]]"
- hideHovercard
- selectionChipStyle
- on-click="_handleAttentionClick"
- >
- </gr-account-label>
- </div>
- </div>
- <template is="dom-if" if="[[_uploader]]">
- <div class="peopleList">
- <div class="peopleListLabel">Uploader</div>
- <div class="peopleListValues">
- <gr-account-label
- account="[[_uploader]]"
- force-attention="[[_computeHasNewAttention(_uploader, _newAttentionSet)]]"
- selected="[[_computeHasNewAttention(_uploader, _newAttentionSet)]]"
- hideHovercard
- selectionChipStyle
- on-click="_handleAttentionClick"
- >
- </gr-account-label>
- </div>
- </div>
- </template>
- <div class="peopleList">
- <div class="peopleListLabel">Reviewers</div>
- <div class="peopleListValues">
- <template
- is="dom-repeat"
- items="[[_removeServiceUsers(_reviewers, _newAttentionSet)]]"
- as="account"
- >
- <gr-account-label
- account="[[account]]"
- force-attention="[[_computeHasNewAttention(account, _newAttentionSet)]]"
- selected="[[_computeHasNewAttention(account, _newAttentionSet)]]"
- hideHovercard
- selectionChipStyle
- on-click="_handleAttentionClick"
- >
- </gr-account-label>
- </template>
- </div>
- </div>
- <template is="dom-if" if="[[_attentionCcsCount]]">
- <div class="peopleList">
- <div class="peopleListLabel">CC</div>
- <div class="peopleListValues">
- <template
- is="dom-repeat"
- items="[[_removeServiceUsers(_ccs, _newAttentionSet)]]"
- as="account"
- >
- <gr-account-label
- account="[[account]]"
- force-attention="[[_computeHasNewAttention(account, _newAttentionSet)]]"
- selected="[[_computeHasNewAttention(account, _newAttentionSet)]]"
- hideHovercard
- selectionChipStyle
- on-click="_handleAttentionClick"
- >
- </gr-account-label>
- </template>
- </div>
- </div>
- </template>
- <template
- is="dom-if"
- if="[[_computeShowAttentionTip(_account, _owner, _currentAttentionSet, _newAttentionSet)]]"
- >
- <div class="attentionTip">
- <iron-icon
- class="pointer"
- icon="gr-icons:lightbulb-outline"
- ></iron-icon>
- Be mindful of requiring attention from too many users.
- </div>
- </template>
- </section>
- <gr-endpoint-slot name="above-actions"></gr-endpoint-slot>
- <section class="actions">
- <div class="left">
- <span
- id="checkingStatusLabel"
- hidden$="[[!_isState(knownLatestState, 'checking')]]"
- >
- Checking whether patch [[patchNum]] is latest...
- </span>
- <span
- id="notLatestLabel"
- hidden$="[[!_isState(knownLatestState, 'not-latest')]]"
- >
- [[_computePatchSetWarning(patchNum, _labelsChanged)]]
- <gr-button link="" on-click="_reload">Reload</gr-button>
- </span>
- </div>
- <div class="right">
- <gr-button
- link=""
- id="cancelButton"
- class="action cancel"
- on-click="_cancelTapHandler"
- >Cancel</gr-button
- >
- <template is="dom-if" if="[[canBeStarted]]">
- <!-- Use 'Send' here as the change may only about reviewers / ccs
- and when this button is visible, the next button will always
- be 'Start review' -->
- <gr-tooltip-content
- has-tooltip=""
- title$="[[_saveTooltip]]"
- >
- <gr-button
- link=""
- disabled="[[_isState(knownLatestState, 'not-latest')]]"
- class="action save"
- on-click="_saveClickHandler"
- >Send As WIP</gr-button
- >
- </gr-tooltip-content>
- </template>
- <gr-tooltip-content
- has-tooltip=""
- title$="[[_computeSendButtonTooltip(canBeStarted, _commentEditing)]]"
- >
- <gr-button
- id="sendButton"
- primary=""
- disabled="[[_sendDisabled]]"
- class="action send"
- on-click="_sendTapHandler"
- >[[_sendButtonLabel]]
- </gr-button>
- </gr-tooltip-content>
- </div>
- </section>
- </gr-endpoint-decorator>
- </div>
- </div>
-`;
diff --git a/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog_test.ts b/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog_test.ts
index 5ea5cb4..c800c87 100644
--- a/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog_test.ts
+++ b/polygerrit-ui/app/elements/change/gr-reply-dialog/gr-reply-dialog_test.ts
@@ -61,17 +61,14 @@
UrlEncodedCommentId,
} from '../../../types/common';
import {CommentThread} from '../../../utils/comment-util';
-import {PolymerDeepPropertyChange} from '@polymer/polymer/interfaces';
-import {
- AccountInfoInput,
- GrAccountList,
-} from '../../shared/gr-account-list/gr-account-list';
+import {GrAccountList} from '../../shared/gr-account-list/gr-account-list';
import {GrLabelScoreRow} from '../gr-label-score-row/gr-label-score-row';
import {GrLabelScores} from '../gr-label-scores/gr-label-scores';
import {GrThreadList} from '../gr-thread-list/gr-thread-list';
import {GrAutocomplete} from '../../shared/gr-autocomplete/gr-autocomplete';
-
-const basicFixture = fixtureFromElement('gr-reply-dialog');
+import {fixture, html} from '@open-wc/testing-helpers';
+import {accountKey} from '../../../utils/account-util';
+import {GrButton} from '../../shared/gr-button/gr-button';
function cloneableResponse(status: number, text: string) {
return {
@@ -102,12 +99,6 @@
let setDraftCommentStub: sinon.SinonStub;
let eraseDraftCommentStub: sinon.SinonStub;
- const emptyAccountInfoInputChanges =
- [] as unknown as PolymerDeepPropertyChange<
- AccountInfoInput[],
- AccountInfoInput[]
- >;
-
let lastId = 1;
const makeAccount = function () {
return {_account_id: lastId++ as AccountId};
@@ -123,7 +114,10 @@
stubRestApi('getChange').returns(Promise.resolve({...createChange()}));
stubRestApi('getChangeSuggestedReviewers').returns(Promise.resolve([]));
- element = basicFixture.instantiate();
+ element = await fixture<GrReplyDialog>(html`
+ <gr-reply-dialog></gr-reply-dialog>
+ `);
+
element.change = {
...createChange(),
_number: changeNum,
@@ -162,17 +156,13 @@
setDraftCommentStub = stubStorage('setDraftComment');
eraseDraftCommentStub = stubStorage('eraseDraftComment');
- // sinon.stub(patchSetUtilMockProxy, 'fetchChangeUpdates')
- // .returns(Promise.resolve({isLatest: true}));
-
- // Allow the elements created by dom-repeat to be stamped.
- await flush();
+ await element.updateComplete;
});
function stubSaveReview(
jsonResponseProducer: (input: ReviewInput) => ReviewResult | void
) {
- return sinon.stub(element, '_saveReview').callsFake(
+ return sinon.stub(element, 'saveReview').callsFake(
review =>
new Promise((resolve, reject) => {
try {
@@ -206,15 +196,18 @@
test('default to publishing draft comments with reply', async () => {
// Async tick is needed because iron-selector content is distributed and
// distributed content requires an observer to be set up.
- await flush();
+ await element.updateComplete;
element.draft = 'I wholeheartedly disapprove';
+ element.draftCommentThreads = [createCommentThread([createComment()])];
+
+ element.includeComments = true;
const saveReviewPromise = interceptSaveReview();
// This is needed on non-Blink engines most likely due to the ways in
// which the dom-repeat elements are stamped.
- await flush();
+ await element.updateComplete;
tap(queryAndAssert(element, '.send'));
- await flush();
+ await element.updateComplete;
const review = await saveReviewPromise;
assert.deepEqual(review, {
@@ -232,7 +225,9 @@
],
},
reviewers: [],
- add_to_attention_set: [],
+ add_to_attention_set: [
+ {reason: '<GERRIT_ACCOUNT_1> replied on the change', user: 999},
+ ],
remove_from_attention_set: [],
ignore_automatic_attention_set_rules: true,
});
@@ -242,13 +237,13 @@
});
test('modified attention set', async () => {
- await flush();
- element._account = {_account_id: 123 as AccountId};
- element._newAttentionSet = new Set([314 as AccountId]);
+ await element.updateComplete;
+ element.account = {_account_id: 123 as AccountId};
+ element.newAttentionSet = new Set([314 as AccountId]);
const saveReviewPromise = interceptSaveReview();
const modifyButton = queryAndAssert(element, '.edit-attention-button');
tap(modifyButton);
- await flush();
+ await element.updateComplete;
tap(queryAndAssert(element, '.send'));
const review = await saveReviewPromise;
@@ -269,13 +264,13 @@
});
test('modified attention set by anonymous', async () => {
- await flush();
- element._account = {};
- element._newAttentionSet = new Set([314 as AccountId]);
+ await element.updateComplete;
+ element.account = {};
+ element.newAttentionSet = new Set([314 as AccountId]);
const saveReviewPromise = interceptSaveReview();
const modifyButton = queryAndAssert(element, '.edit-attention-button');
tap(modifyButton);
- await flush();
+ await element.updateComplete;
tap(queryAndAssert(element, '.send'));
const review = await saveReviewPromise;
@@ -293,11 +288,12 @@
remove_from_attention_set: [],
ignore_automatic_attention_set_rules: true,
});
- element._newAttentionSet = new Set();
- await flush();
+ element.newAttentionSet = new Set();
+ await element.updateComplete;
});
- function checkComputeAttention(
+ async function checkComputeAttention(
+ element: GrReplyDialog,
status: ChangeStatus,
userId?: AccountId,
reviewerIds?: AccountId[],
@@ -309,12 +305,11 @@
hasDraft = true,
includeComments = true
) {
- const user = {_account_id: userId};
- const reviewers = {
- base: reviewerIds?.map(id => {
+ element.account = {_account_id: userId};
+ element.reviewers =
+ reviewerIds?.map(id => {
return {_account_id: id};
- }),
- } as PolymerDeepPropertyChange<AccountInfoInput[], AccountInfoInput[]>;
+ }) ?? [];
let draftThreads: CommentThread[] = [];
if (hasDraft) {
draftThreads = [
@@ -333,6 +328,9 @@
...createChange(),
owner: {_account_id: ownerId},
status,
+ reviewers: {
+ [ReviewerState.REVIEWER]: element.reviewers,
+ },
};
attSetIds?.forEach(id => {
if (!change.attention_set) change.attention_set = {};
@@ -348,25 +346,19 @@
};
}
element.change = change;
- element._reviewers = reviewers.base!;
+ element.ccs = [];
+ element.draftCommentThreads = draftThreads;
+ element.includeComments = includeComments;
- flush();
- const hasDrafts = draftThreads.length > 0;
- element._computeNewAttention(
- user,
- reviewers,
- emptyAccountInfoInputChanges,
- change,
- draftThreads,
- includeComments,
- undefined,
- hasDrafts
- );
- assert.sameMembers([...element._newAttentionSet], expectedIds!);
+ await element.updateComplete;
+
+ element.computeNewAttention();
+ assert.sameMembers([...element.newAttentionSet], expectedIds!);
}
- test('computeNewAttention NEW', () => {
- checkComputeAttention(
+ test('computeNewAttention NEW', async () => {
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[],
@@ -375,7 +367,8 @@
[],
[999 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[],
@@ -384,7 +377,8 @@
[],
[999 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId],
@@ -393,7 +387,8 @@
[],
[999 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId],
@@ -402,7 +397,8 @@
[],
[22 as AccountId, 999 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId],
@@ -411,7 +407,8 @@
[22 as AccountId],
[22 as AccountId, 999 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -421,7 +418,8 @@
[22 as AccountId, 33 as AccountId, 999 as AccountId]
);
// If the owner replies, then do not add them.
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[],
@@ -430,7 +428,8 @@
[],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[],
@@ -439,7 +438,8 @@
[],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId],
@@ -449,7 +449,8 @@
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId],
@@ -458,7 +459,8 @@
[22 as AccountId],
[22 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -467,7 +469,8 @@
[22 as AccountId],
[22 as AccountId, 33 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -476,7 +479,8 @@
[22 as AccountId],
[22 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -485,7 +489,8 @@
[22 as AccountId, 33 as AccountId],
[22 as AccountId, 33 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -495,7 +500,8 @@
[22 as AccountId, 33 as AccountId]
);
// with uploader
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[],
@@ -505,7 +511,8 @@
[2 as AccountId],
2 as AccountId
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[],
@@ -515,7 +522,8 @@
[2 as AccountId],
2 as AccountId
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.NEW,
1 as AccountId,
[],
@@ -527,8 +535,9 @@
);
});
- test('computeNewAttention MERGED', () => {
- checkComputeAttention(
+ test('computeNewAttention MERGED', async () => {
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
undefined,
[],
@@ -539,7 +548,8 @@
undefined,
false
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[],
@@ -550,7 +560,8 @@
undefined,
false
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[],
@@ -561,7 +572,8 @@
undefined,
true
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[],
@@ -573,7 +585,8 @@
true,
false
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[],
@@ -584,7 +597,8 @@
undefined,
false
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId],
@@ -595,7 +609,8 @@
undefined,
false
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId],
@@ -606,7 +621,8 @@
undefined,
false
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId],
@@ -615,7 +631,8 @@
[22 as AccountId],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -624,7 +641,8 @@
[22 as AccountId],
[33 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[],
@@ -633,7 +651,8 @@
[],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[],
@@ -644,7 +663,8 @@
undefined,
true
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[],
@@ -653,7 +673,8 @@
[],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[],
@@ -664,7 +685,8 @@
undefined,
true
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId],
@@ -673,7 +695,8 @@
[],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId],
@@ -682,7 +705,8 @@
[22 as AccountId],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -691,7 +715,8 @@
[22 as AccountId],
[33 as AccountId]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -700,7 +725,8 @@
[22 as AccountId],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -709,7 +735,8 @@
[22 as AccountId, 33 as AccountId],
[]
);
- checkComputeAttention(
+ await checkComputeAttention(
+ element,
ChangeStatus.MERGED,
1 as AccountId,
[22 as AccountId, 33 as AccountId],
@@ -720,118 +747,86 @@
);
});
- test('computeNewAttention when adding reviewers', () => {
- const user = {_account_id: 1 as AccountId};
- const reviewers = {
- base: [
- {_account_id: 1 as AccountId, _pendingAdd: true},
- {_account_id: 2 as AccountId, _pendingAdd: true},
- ],
- } as PolymerDeepPropertyChange<AccountInfoInput[], AccountInfoInput[]>;
- const change = {
+ test('computeNewAttention when adding reviewers', async () => {
+ element.account = {_account_id: 1 as AccountId};
+ element.change = {
...createChange(),
owner: {_account_id: 5 as AccountId},
status: ChangeStatus.NEW,
attention_set: {},
};
- element.change = change;
- element._reviewers = reviewers.base;
- flush();
+ // let rebuildReviewers triggered by change update finish running
+ await element.updateComplete;
- element._computeNewAttention(
- user,
- reviewers,
- emptyAccountInfoInputChanges,
- change,
- [],
- true
- );
- assert.sameMembers([...element._newAttentionSet], [1, 2]);
+ element.reviewers = [
+ {_account_id: 1 as AccountId, _pendingAdd: true},
+ {_account_id: 2 as AccountId, _pendingAdd: true},
+ ];
+ element.ccs = [];
+ element.draftCommentThreads = [];
+ element.includeComments = true;
+ element.canBeStarted = true;
+ await element.updateComplete;
+ assert.sameMembers([...element.newAttentionSet], [1, 2]);
// If the user votes on the change, then they should not be added to the
// attention set, even if they have just added themselves as reviewer.
// But voting should also add the owner (5).
- const labelsChanged = true;
- element._computeNewAttention(
- user,
- reviewers,
- emptyAccountInfoInputChanges,
- change,
- [],
- true,
- labelsChanged
- );
- assert.sameMembers([...element._newAttentionSet], [2, 5]);
+ element.labelsChanged = true;
+ await element.updateComplete;
+ assert.sameMembers([...element.newAttentionSet], [2, 5]);
});
- test('computeNewAttention when sending wip change for review', () => {
- const reviewers = {
- base: [{...createAccountWithId(2)}, {...createAccountWithId(3)}],
- } as PolymerDeepPropertyChange<AccountInfoInput[], AccountInfoInput[]>;
- const change = {
+ test('computeNewAttention when sending wip change for review', async () => {
+ element.change = {
...createChange(),
owner: {_account_id: 1 as AccountId},
status: ChangeStatus.NEW,
attention_set: {},
};
- element.change = change;
- element._reviewers = reviewers.base;
- flush();
+ // let rebuildReviewers triggered by change update finish running
+ await element.updateComplete;
+
+ element.reviewers = [
+ {...createAccountWithId(2)},
+ {...createAccountWithId(3)},
+ ];
+
+ element.ccs = [];
+ element.draftCommentThreads = [];
+ element.includeComments = false;
+ element.account = {_account_id: 1 as AccountId};
+
+ await element.updateComplete;
// For an active change there is no reason to add anyone to the set.
- let user = {_account_id: 1 as AccountId};
- element._computeNewAttention(
- user,
- reviewers,
- emptyAccountInfoInputChanges,
- change,
- [],
- false
- );
- assert.sameMembers([...element._newAttentionSet], []);
+ element.computeNewAttention();
+ assert.sameMembers([...element.newAttentionSet], []);
// If the change is "work in progress" and the owner sends a reply, then
// add all reviewers.
element.canBeStarted = true;
- flush();
- user = {_account_id: 1 as AccountId};
- element._computeNewAttention(
- user,
- reviewers,
- emptyAccountInfoInputChanges,
- change,
- [],
- false
- );
- assert.sameMembers([...element._newAttentionSet], [2, 3]);
+ element.computeNewAttention();
+ await element.updateComplete;
+ assert.sameMembers([...element.newAttentionSet], [2, 3]);
// ... but not when someone else replies.
- user = {_account_id: 4 as AccountId};
- element._computeNewAttention(
- user,
- reviewers,
- emptyAccountInfoInputChanges,
- change,
- [],
- false
- );
- assert.sameMembers([...element._newAttentionSet], []);
+ element.account = {_account_id: 4 as AccountId};
+ element.computeNewAttention();
+ assert.sameMembers([...element.newAttentionSet], []);
});
test('computeNewAttentionAccounts', () => {
- element._reviewers = [
+ element.reviewers = [
{_account_id: 123 as AccountId, display_name: 'Ernie'},
{_account_id: 321 as AccountId, display_name: 'Bert'},
];
- element._ccs = [{_account_id: 7 as AccountId, display_name: 'Elmo'}];
- const compute = (currentAtt: AccountId[], newAtt: AccountId[]) =>
- element
- ._computeNewAttentionAccounts(
- undefined,
- new Set(currentAtt),
- new Set(newAtt)
- )
- .map(a => a!._account_id);
+ element.ccs = [{_account_id: 7 as AccountId, display_name: 'Elmo'}];
+ const compute = (currentAtt: AccountId[], newAtt: AccountId[]) => {
+ element.currentAttentionSet = new Set(currentAtt);
+ element.newAttentionSet = new Set(newAtt);
+ return element.computeNewAttentionAccounts().map(a => a?._account_id);
+ };
assert.sameMembers(compute([], []), []);
assert.sameMembers(compute([], [999 as AccountId]), [999 as AccountId]);
@@ -850,7 +845,7 @@
);
});
- test('_computeCommentAccounts', () => {
+ test('computeCommentAccounts', () => {
element.change = {
...createChange(),
labels: {
@@ -906,7 +901,7 @@
]),
},
];
- const actualAccounts = [...element._computeCommentAccounts(threads)];
+ const actualAccounts = [...element.computeCommentAccounts(threads)];
// Account 3 is not included, because the comment is resolved *and* they
// have given the highest possible vote on the Code-Review label.
assert.sameMembers(actualAccounts, [1, 2, 4]);
@@ -921,13 +916,15 @@
// Async tick is needed because iron-selector content is distributed and
// distributed content requires an observer to be set up.
- await flush();
+ await element.updateComplete;
element.draft = 'I wholeheartedly disapprove';
+ element.draftCommentThreads = [createCommentThread([createComment()])];
+
const saveReviewPromise = interceptSaveReview();
// This is needed on non-Blink engines most likely due to the ways in
// which the dom-repeat elements are stamped.
- await flush();
+ await element.updateComplete;
tap(queryAndAssert(element, '.send'));
const review = await saveReviewPromise;
@@ -946,7 +943,9 @@
],
},
reviewers: [],
- add_to_attention_set: [],
+ add_to_attention_set: [
+ {reason: '<GERRIT_ACCOUNT_1> replied on the change', user: 999},
+ ],
remove_from_attention_set: [],
ignore_automatic_attention_set_rules: true,
});
@@ -954,6 +953,8 @@
test('label picker', async () => {
element.draft = 'I wholeheartedly disapprove';
+ element.draftCommentThreads = [createCommentThread([createComment()])];
+
const saveReviewPromise = interceptSaveReview();
sinon.stub(element.getLabelScores(), 'getLabelValues').callsFake(() => {
@@ -965,12 +966,12 @@
// This is needed on non-Blink engines most likely due to the ways in
// which the dom-repeat elements are stamped.
- await flush();
+ await element.updateComplete;
tap(queryAndAssert(element, '.send'));
assert.isTrue(element.disabled);
const review = await saveReviewPromise;
- await flush();
+ await element.updateComplete;
assert.isFalse(
element.disabled,
'Element should be enabled when done sending reply.'
@@ -991,29 +992,35 @@
],
},
reviewers: [],
- add_to_attention_set: [],
+ add_to_attention_set: [
+ {user: 999, reason: '<GERRIT_ACCOUNT_1> replied on the change'},
+ ],
remove_from_attention_set: [],
ignore_automatic_attention_set_rules: true,
});
});
test('keep draft comments with reply', async () => {
+ element.draftCommentThreads = [createCommentThread([createComment()])];
+ await element.updateComplete;
+
tap(queryAndAssert(element, '#includeComments'));
- assert.equal(element._includeComments, false);
+ assert.equal(element.includeComments, false);
// Async tick is needed because iron-selector content is distributed and
// distributed content requires an observer to be set up.
- await flush();
+ await element.updateComplete;
element.draft = 'I wholeheartedly disapprove';
+
const saveReviewPromise = interceptSaveReview();
// This is needed on non-Blink engines most likely due to the ways in
// which the dom-repeat elements are stamped.
- await flush();
+ await element.updateComplete;
tap(queryAndAssert(element, '.send'));
const review = await saveReviewPromise;
- await flush();
+ await element.updateComplete;
assert.deepEqual(review, {
drafts: 'KEEP',
labels: {
@@ -1029,14 +1036,15 @@
],
},
reviewers: [],
- add_to_attention_set: [],
+ add_to_attention_set: [
+ {reason: '<GERRIT_ACCOUNT_1> replied on the change', user: 999},
+ ],
remove_from_attention_set: [],
ignore_automatic_attention_set_rules: true,
});
});
test('getlabelValue returns value', async () => {
- await flush();
const el = queryAndAssert<GrLabelScoreRow>(
queryAndAssert(element, 'gr-label-scores'),
'gr-label-score-row[name="Verified"]'
@@ -1046,7 +1054,6 @@
});
test('getlabelValue when no score is selected', async () => {
- await flush();
const el = queryAndAssert<GrLabelScoreRow>(
queryAndAssert(element, 'gr-label-scores'),
'gr-label-score-row[name="Code-Review"]'
@@ -1056,12 +1063,12 @@
});
test('setlabelValue', async () => {
- element._account = {_account_id: 1 as AccountId};
- await flush();
+ element.account = {_account_id: 1 as AccountId};
+ await element.updateComplete;
const label = 'Verified';
const value = '+1';
element.setLabelValue(label, value);
- await flush();
+ await element.updateComplete;
const labels = queryAndAssert<GrLabelScores>(
element,
@@ -1122,9 +1129,9 @@
'.reviewerConfirmationButtons gr-button:last-child'
);
- element._ccPendingConfirmation = null;
- element._reviewerPendingConfirmation = null;
- flush();
+ element.ccPendingConfirmation = null;
+ element.reviewerPendingConfirmation = null;
+ await element.updateComplete;
assert.isFalse(
isVisible(queryAndAssert(element, 'reviewerConfirmationOverlay'))
);
@@ -1136,29 +1143,29 @@
name: 'name' as GroupName,
};
if (cc) {
- element._ccPendingConfirmation = {
+ element.ccPendingConfirmation = {
group,
confirm: false,
count: 1,
};
} else {
- element._reviewerPendingConfirmation = {
+ element.reviewerPendingConfirmation = {
group,
confirm: false,
count: 1,
};
}
- flush();
+ await element.updateComplete;
if (cc) {
assert.deepEqual(
- element._ccPendingConfirmation,
- element._pendingConfirmationDetails
+ element.ccPendingConfirmation,
+ element.pendingConfirmationDetails
);
} else {
assert.deepEqual(
- element._reviewerPendingConfirmation,
- element._pendingConfirmationDetails
+ element.reviewerPendingConfirmation,
+ element.pendingConfirmationDetails
);
}
@@ -1186,7 +1193,7 @@
const reviewersEntry = queryAndAssert<GrAccountList>(element, '#reviewers');
assert.isTrue(
isFocusInsideElement(
- queryAndAssert<GrAutocomplete>(reviewersEntry.entry, '#input').$.input
+ queryAndAssert<GrAutocomplete>(reviewersEntry.entry, '#input').input!
)
);
@@ -1203,13 +1210,13 @@
// Reopen confirmation dialog.
observer = overlayObserver('opened');
if (cc) {
- element._ccPendingConfirmation = {
+ element.ccPendingConfirmation = {
group,
confirm: false,
count: 1,
};
} else {
- element._reviewerPendingConfirmation = {
+ element.reviewerPendingConfirmation = {
group,
confirm: false,
count: 1,
@@ -1247,7 +1254,7 @@
const ccsEntry = queryAndAssert<GrAccountList>(element, '#ccs');
assert.isTrue(
isFocusInsideElement(
- queryAndAssert<GrAutocomplete>(ccsEntry.entry, '#input').$.input
+ queryAndAssert<GrAutocomplete>(ccsEntry.entry, '#input').input!
)
);
} else {
@@ -1257,7 +1264,7 @@
);
assert.isTrue(
isFocusInsideElement(
- queryAndAssert<GrAutocomplete>(reviewersEntry.entry, '#input').$.input
+ queryAndAssert<GrAutocomplete>(reviewersEntry.entry, '#input').input!
)
);
}
@@ -1271,16 +1278,15 @@
testConfirmationDialog(false);
});
- test('_getStorageLocation', () => {
- const actual = element._getStorageLocation();
+ test('getStorageLocation', () => {
+ const actual = element.getStorageLocation();
assert.equal(actual.changeNum, changeNum);
assert.equal(actual.patchNum, '@change');
assert.equal(actual.path, '@change');
});
- test('_reviewersMutated when account-text-change is fired from ccs', () => {
- flush();
- assert.isFalse(element._reviewersMutated);
+ test('reviewersMutated when account-text-change is fired from ccs', () => {
+ assert.isFalse(element.reviewersMutated);
assert.isTrue(queryAndAssert<GrAccountList>(element, '#ccs').allowAnyInput);
assert.isFalse(
queryAndAssert<GrAccountList>(element, '#reviewers').allowAnyInput
@@ -1288,7 +1294,7 @@
queryAndAssert(element, '#ccs').dispatchEvent(
new CustomEvent('account-text-changed', {bubbles: true, composed: true})
);
- assert.isTrue(element._reviewersMutated);
+ assert.isTrue(element.reviewersMutated);
});
test('gets draft from storage on open', () => {
@@ -1329,17 +1335,19 @@
const clock = sinon.useFakeTimers();
const firstEdit = 'hello';
- const location = element._getStorageLocation();
+ const location = element.getStorageLocation();
element.draft = firstEdit;
clock.tick(1000);
- await flush();
+ await element.updateComplete;
+ await element.storeTask?.flush();
assert.isTrue(setDraftCommentStub.calledWith(location, firstEdit));
element.draft = '';
clock.tick(1000);
- await flush();
+ await element.updateComplete;
+ await element.storeTask?.flush();
assert.isTrue(eraseDraftCommentStub.calledWith(location));
});
@@ -1369,7 +1377,7 @@
};
addListenerForTest(document, 'server-error', listener);
- await flush();
+ await element.updateComplete;
element.send(false, false);
await promise;
});
@@ -1395,7 +1403,7 @@
// Async tick is needed because iron-selector content is distributed and
// distributed content requires an observer to be set up.
- await flush();
+ await element.updateComplete;
element.send(false, false);
await promise;
});
@@ -1406,11 +1414,11 @@
const reviewer2 = makeGroup();
const cc1 = makeAccount();
const cc2 = makeGroup();
- let filter = element._filterReviewerSuggestionGenerator(false);
+ let filter = element.filterReviewerSuggestionGenerator(false);
- element._owner = owner;
- element._reviewers = [reviewer1, reviewer2];
- element._ccs = [cc1, cc2];
+ element.owner = owner;
+ element.reviewers = [reviewer1, reviewer2];
+ element.ccs = [cc1, cc2];
assert.isTrue(filter({account: makeAccount()} as Suggestion));
assert.isTrue(filter({group: makeGroup()} as Suggestion));
@@ -1422,35 +1430,41 @@
assert.isFalse(filter({account: reviewer1} as Suggestion));
assert.isFalse(filter({group: reviewer2} as Suggestion));
- filter = element._filterReviewerSuggestionGenerator(true);
+ filter = element.filterReviewerSuggestionGenerator(true);
// Existing and pending CCs should be excluded when isCC = true;.
assert.isFalse(filter({account: cc1} as Suggestion));
assert.isFalse(filter({group: cc2} as Suggestion));
});
- test('_focusOn', async () => {
- const chooseFocusTargetSpy = sinon.spy(element, '_chooseFocusTarget');
- element._focusOn();
- await flush();
+ test('focusOn', async () => {
+ await element.updateComplete;
+ const clock = sinon.useFakeTimers();
+ const chooseFocusTargetSpy = sinon.spy(element, 'chooseFocusTarget');
+ element.focusOn();
+ // element.focus() is called after a setTimeout(). The focusOn() method
+ // does not trigger any changes in the element hence element.updateComplete
+ // resolves immediately and cannot be used here, hence tick the clock here
+ // explicitly instead
+ clock.tick(1);
assert.equal(chooseFocusTargetSpy.callCount, 1);
assert.equal(element?.shadowRoot?.activeElement?.tagName, 'GR-TEXTAREA');
assert.equal(element?.shadowRoot?.activeElement?.id, 'textarea');
- element._focusOn(element.FocusTarget.ANY);
- await flush();
+ element.focusOn(element.FocusTarget.ANY);
+ clock.tick(1);
assert.equal(chooseFocusTargetSpy.callCount, 2);
assert.equal(element?.shadowRoot?.activeElement?.tagName, 'GR-TEXTAREA');
assert.equal(element?.shadowRoot?.activeElement?.id, 'textarea');
- element._focusOn(element.FocusTarget.BODY);
- await flush();
+ element.focusOn(element.FocusTarget.BODY);
+ clock.tick(1);
assert.equal(chooseFocusTargetSpy.callCount, 2);
assert.equal(element?.shadowRoot?.activeElement?.tagName, 'GR-TEXTAREA');
assert.equal(element?.shadowRoot?.activeElement?.id, 'textarea');
- element._focusOn(element.FocusTarget.REVIEWERS);
- await flush();
+ element.focusOn(element.FocusTarget.REVIEWERS);
+ clock.tick(1);
assert.equal(chooseFocusTargetSpy.callCount, 2);
assert.equal(
element?.shadowRoot?.activeElement?.tagName,
@@ -1458,44 +1472,45 @@
);
assert.equal(element?.shadowRoot?.activeElement?.id, 'reviewers');
- element._focusOn(element.FocusTarget.CCS);
- await flush();
+ element.focusOn(element.FocusTarget.CCS);
+ clock.tick(1);
assert.equal(chooseFocusTargetSpy.callCount, 2);
assert.equal(
element?.shadowRoot?.activeElement?.tagName,
'GR-ACCOUNT-LIST'
);
assert.equal(element?.shadowRoot?.activeElement?.id, 'ccs');
+ clock.restore();
});
- test('_chooseFocusTarget', () => {
- element._account = undefined;
- assert.strictEqual(element._chooseFocusTarget(), element.FocusTarget.BODY);
+ test('chooseFocusTarget', () => {
+ element.account = undefined;
+ assert.strictEqual(element.chooseFocusTarget(), element.FocusTarget.BODY);
- element._account = {_account_id: 1 as AccountId};
- assert.strictEqual(element._chooseFocusTarget(), element.FocusTarget.BODY);
+ element.account = {_account_id: 1 as AccountId};
+ assert.strictEqual(element.chooseFocusTarget(), element.FocusTarget.BODY);
element.change!.owner = {_account_id: 2 as AccountId};
- assert.strictEqual(element._chooseFocusTarget(), element.FocusTarget.BODY);
+ assert.strictEqual(element.chooseFocusTarget(), element.FocusTarget.BODY);
element.change!.owner._account_id = 1 as AccountId;
assert.strictEqual(
- element._chooseFocusTarget(),
+ element.chooseFocusTarget(),
element.FocusTarget.REVIEWERS
);
- element._reviewers = [];
+ element.reviewers = [];
assert.strictEqual(
- element._chooseFocusTarget(),
+ element.chooseFocusTarget(),
element.FocusTarget.REVIEWERS
);
- element._reviewers.push({});
- assert.strictEqual(element._chooseFocusTarget(), element.FocusTarget.BODY);
+ element.reviewers.push({});
+ assert.strictEqual(element.chooseFocusTarget(), element.FocusTarget.BODY);
});
test('only send labels that have changed', async () => {
- await flush();
+ await element.updateComplete;
stubSaveReview((review: ReviewInput) => {
assert.deepEqual(review?.labels, {
'Code-Review': 0,
@@ -1520,9 +1535,7 @@
await promise;
});
- test('moving from cc to reviewer', () => {
- flush();
-
+ test('moving from cc to reviewer', async () => {
const reviewer1 = makeAccount();
const reviewer2 = makeAccount();
const reviewer3 = makeAccount();
@@ -1530,41 +1543,36 @@
const cc2 = makeAccount();
const cc3 = makeAccount();
const cc4 = makeAccount();
- element._reviewers = [reviewer1, reviewer2, reviewer3];
- element._ccs = [cc1, cc2, cc3, cc4];
- element.push('_reviewers', cc1);
- element.$.reviewers.dispatchEvent(
+ element.reviewers = [reviewer1, reviewer2, reviewer3];
+ element.ccs = [cc1, cc2, cc3, cc4];
+ element.reviewers.push(cc1);
+ element.reviewersList!.dispatchEvent(
new CustomEvent('account-added', {
detail: {account: cc1},
})
);
- flush();
+ await element.updateComplete;
- assert.deepEqual(element._reviewers, [
- reviewer1,
- reviewer2,
- reviewer3,
- cc1,
- ]);
- assert.deepEqual(element._ccs, [cc2, cc3, cc4]);
+ assert.deepEqual(element.reviewers, [reviewer1, reviewer2, reviewer3, cc1]);
+ assert.deepEqual(element.ccs, [cc2, cc3, cc4]);
- element.push('_reviewers', cc4);
- element.$.reviewers.dispatchEvent(
+ element.reviewers.push(cc4);
+ element.reviewersList!.dispatchEvent(
new CustomEvent('account-added', {
detail: {account: cc4},
})
);
- flush();
+ await element.updateComplete;
- element.push('_reviewers', cc3);
- element.$.reviewers.dispatchEvent(
+ element.reviewers.push(cc3);
+ element.reviewersList!.dispatchEvent(
new CustomEvent('account-added', {
detail: {account: cc3},
})
);
- flush();
+ await element.updateComplete;
- assert.deepEqual(element._reviewers, [
+ assert.deepEqual(element.reviewers, [
reviewer1,
reviewer2,
reviewer3,
@@ -1572,54 +1580,65 @@
cc4,
cc3,
]);
- assert.deepEqual(element._ccs, [cc2]);
+ assert.deepEqual(element.ccs, [cc2]);
});
- test('update attention section when reviewers and ccs change', () => {
- element._account = makeAccount();
- element._reviewers = [makeAccount(), makeAccount()];
- element._ccs = [makeAccount(), makeAccount()];
+ test('update attention section when reviewers and ccs change', async () => {
+ element.account = makeAccount();
+ element.reviewers = [makeAccount(), makeAccount()];
+ element.ccs = [makeAccount(), makeAccount()];
element.draftCommentThreads = [];
+
const modifyButton = queryAndAssert(element, '.edit-attention-button');
tap(modifyButton);
- flush();
- // "Modify" button disabled, because "Send" button is disabled.
- assert.isFalse(element._attentionExpanded);
+ await element.updateComplete;
+
+ assert.isFalse(element.attentionExpanded);
+
element.draft = 'a test comment';
+ await element.updateComplete;
+
tap(modifyButton);
- flush();
- assert.isTrue(element._attentionExpanded);
+
+ await element.updateComplete;
+
+ assert.isTrue(element.attentionExpanded);
let accountLabels = Array.from(
queryAll(element, '.attention-detail gr-account-label')
);
assert.equal(accountLabels.length, 5);
- element.push('_reviewers', makeAccount());
- element.push('_ccs', makeAccount());
- flush();
+ element.reviewers = [...element.reviewers, makeAccount()];
+ element.ccs = [...element.ccs, makeAccount()];
+ await element.updateComplete;
// The 'attention modified' section collapses and resets when reviewers or
// ccs change.
- assert.isFalse(element._attentionExpanded);
+ assert.isFalse(element.attentionExpanded);
tap(queryAndAssert(element, '.edit-attention-button'));
- flush();
+ await element.updateComplete;
- assert.isTrue(element._attentionExpanded);
+ assert.isTrue(element.attentionExpanded);
accountLabels = Array.from(
queryAll(element, '.attention-detail gr-account-label')
);
assert.equal(accountLabels.length, 7);
- element.pop('_reviewers');
- element.pop('_reviewers');
- element.pop('_ccs');
- element.pop('_ccs');
+ element.reviewers.pop();
+ element.reviewers.pop();
+ element.ccs.pop();
+ element.ccs.pop();
+ element.reviewers = [...element.reviewers];
+ element.ccs = [...element.ccs]; // trigger willUpdate observer
+
+ await element.updateComplete;
tap(queryAndAssert(element, '.edit-attention-button'));
- flush();
+
+ await element.updateComplete;
accountLabels = Array.from(
queryAll(element, '.attention-detail gr-account-label')
@@ -1627,9 +1646,7 @@
assert.equal(accountLabels.length, 3);
});
- test('moving from reviewer to cc', () => {
- flush();
-
+ test('moving from reviewer to cc', async () => {
const reviewer1 = makeAccount();
const reviewer2 = makeAccount();
const reviewer3 = makeAccount();
@@ -1637,38 +1654,38 @@
const cc2 = makeAccount();
const cc3 = makeAccount();
const cc4 = makeAccount();
- element._reviewers = [reviewer1, reviewer2, reviewer3];
- element._ccs = [cc1, cc2, cc3, cc4];
- element.push('_ccs', reviewer1);
- element.$.ccs.dispatchEvent(
+ element.reviewers = [reviewer1, reviewer2, reviewer3];
+ element.ccs = [cc1, cc2, cc3, cc4];
+ element.ccs.push(reviewer1);
+ element.ccsList!.dispatchEvent(
new CustomEvent('account-added', {
detail: {account: reviewer1},
})
);
- flush();
+ await element.updateComplete;
- assert.deepEqual(element._reviewers, [reviewer2, reviewer3]);
- assert.deepEqual(element._ccs, [cc1, cc2, cc3, cc4, reviewer1]);
+ assert.deepEqual(element.reviewers, [reviewer2, reviewer3]);
+ assert.deepEqual(element.ccs, [cc1, cc2, cc3, cc4, reviewer1]);
- element.push('_ccs', reviewer3);
- element.$.ccs.dispatchEvent(
+ element.ccs.push(reviewer3);
+ element.ccsList!.dispatchEvent(
new CustomEvent('account-added', {
detail: {account: reviewer3},
})
);
- flush();
+ await element.updateComplete;
- element.push('_ccs', reviewer2);
- element.$.ccs.dispatchEvent(
+ element.ccs.push(reviewer2);
+ element.ccsList!.dispatchEvent(
new CustomEvent('account-added', {
detail: {account: reviewer2},
})
);
- flush();
+ await element.updateComplete;
- assert.deepEqual(element._reviewers, []);
- assert.deepEqual(element._ccs, [
+ assert.deepEqual(element.reviewers, []);
+ assert.deepEqual(element.ccs, [
cc1,
cc2,
cc3,
@@ -1680,7 +1697,6 @@
});
test('migrate reviewers between states', async () => {
- flush();
const reviewers = queryAndAssert<GrAccountList>(element, '#reviewers');
const ccs = queryAndAssert<GrAccountList>(element, '#ccs');
const reviewer1 = makeAccount();
@@ -1688,14 +1704,14 @@
const cc1 = makeAccount();
const cc2 = makeAccount();
const cc3 = makeAccount();
+ element.reviewers = [reviewer1, reviewer2];
+ element.ccs = [cc1, cc2, cc3];
+
element.change!.reviewers = {
[ReviewerState.CC]: [],
[ReviewerState.REVIEWER]: [{_account_id: 33 as AccountId}],
};
- await flush();
-
- element._reviewers = [reviewer1, reviewer2];
- element._ccs = [cc1, cc2, cc3];
+ await element.updateComplete;
const mutations: ReviewerInput[] = [];
@@ -1703,7 +1719,7 @@
mutations.push(...review.reviewers!);
});
- assert.isFalse(element._reviewersMutated);
+ assert.isFalse(element.reviewersMutated);
// Remove and add to other field.
reviewers.dispatchEvent(
@@ -1714,8 +1730,8 @@
})
);
- await flush();
- assert.isTrue(element._reviewersMutated);
+ await element.updateComplete;
+ assert.isTrue(element.reviewersMutated);
ccs.entry!.dispatchEvent(
new CustomEvent('add', {
detail: {value: {account: reviewer1}},
@@ -1745,8 +1761,16 @@
})
);
- // Add to other field without removing from former field.
- // (Currently not possible in UI, but this is a good consistency check).
+ assert.deepEqual(
+ element.reviewers.map(v => accountKey(v)),
+ [reviewer2, cc1].map(v => accountKey(v))
+ );
+ assert.deepEqual(
+ element.ccs.map(v => accountKey(v)),
+ [cc2, reviewer1].map(v => accountKey(v))
+ );
+
+ // Add to Reviewer/CC which will automatically remove from CC/Reviewer.
reviewers.entry!.dispatchEvent(
new CustomEvent('add', {
detail: {value: {account: cc2}},
@@ -1754,6 +1778,18 @@
bubbles: true,
})
);
+
+ await element.updateComplete;
+
+ assert.deepEqual(
+ element.reviewers.map(v => accountKey(v)),
+ [reviewer2, cc1, cc2].map(v => accountKey(v))
+ );
+ assert.deepEqual(
+ element.ccs.map(v => accountKey(v)),
+ [reviewer1].map(v => accountKey(v))
+ );
+
ccs.entry!.dispatchEvent(
new CustomEvent('add', {
detail: {value: {account: reviewer2}},
@@ -1762,6 +1798,17 @@
})
);
+ await element.updateComplete;
+
+ assert.deepEqual(
+ element.reviewers.map(v => accountKey(v)),
+ [cc1, cc2].map(v => accountKey(v))
+ );
+ assert.deepEqual(
+ element.ccs.map(v => accountKey(v)),
+ [reviewer1, reviewer2].map(v => accountKey(v))
+ );
+
const mapReviewer = function (
reviewer: AccountInfo,
opt_state?: ReviewerState
@@ -1777,8 +1824,9 @@
// Send and purge and verify moves, delete cc3.
await element.send(false, false);
- await flush();
- expect(mutations).to.have.lengthOf(5);
+ await element.updateComplete;
+ assert.equal(mutations.length, 5);
+
expect(mutations[0]).to.deep.equal(
mapReviewer(cc1, ReviewerState.REVIEWER)
);
@@ -1800,12 +1848,12 @@
});
test('Ignore removal requests if being added as reviewer/CC', async () => {
- flush();
+ await element.updateComplete;
const reviewers = queryAndAssert<GrAccountList>(element, '#reviewers');
const ccs = queryAndAssert<GrAccountList>(element, '#ccs');
const reviewer1 = makeAccount();
- element._reviewers = [reviewer1];
- element._ccs = [];
+ element.reviewers = [reviewer1];
+ element.ccs = [];
element.change!.reviewers = {
[ReviewerState.CC]: [],
@@ -1843,11 +1891,11 @@
});
});
- test('emits cancel on esc key', () => {
+ test('emits cancel on esc key', async () => {
const cancelHandler = sinon.spy();
element.addEventListener('cancel', cancelHandler);
pressAndReleaseKeyOn(element, 27, null, 'Escape');
- flush();
+ await element.updateComplete;
assert.isTrue(cancelHandler.called);
});
@@ -1866,26 +1914,30 @@
await promise;
});
- test('_computeMessagePlaceholder', () => {
+ test('computeMessagePlaceholder', async () => {
+ element.canBeStarted = false;
+ await element.updateComplete;
+ assert.equal(element.messagePlaceholder, 'Say something nice...');
+
+ element.canBeStarted = true;
+ await element.updateComplete;
assert.equal(
- element._computeMessagePlaceholder(false),
- 'Say something nice...'
- );
- assert.equal(
- element._computeMessagePlaceholder(true),
+ element.messagePlaceholder,
'Add a note for your reviewers...'
);
});
- test('_computeSendButtonLabel', () => {
- assert.equal(element._computeSendButtonLabel(false), 'Send');
- assert.equal(
- element._computeSendButtonLabel(true),
- 'Send and Start review'
- );
+ test('computeSendButtonLabel', async () => {
+ element.canBeStarted = false;
+ await element.updateComplete;
+ assert.equal(element.sendButtonLabel, 'Send');
+
+ element.canBeStarted = true;
+ await element.updateComplete;
+ assert.equal(element.sendButtonLabel, 'Send and Start review');
});
- test('_handle400Error reviewers and CCs', async () => {
+ test('handle400Error reviewers and CCs', async () => {
const error1 = 'error 1';
const error2 = 'error 2';
const error3 = 'error 3';
@@ -1915,18 +1967,18 @@
});
};
addListenerForTest(document, 'server-error', listener);
- element._handle400Error(cloneableResponse(400, text) as Response);
+ element.handle400Error(cloneableResponse(400, text) as Response);
await promise;
});
test('fires height change when the drafts comments load', async () => {
// Flush DOM operations before binding to the autogrow event so we don't
// catch the events fired from the initial layout.
- await flush();
+ await element.updateComplete;
const autoGrowHandler = sinon.stub();
element.addEventListener('autogrow', autoGrowHandler);
element.draftCommentThreads = [];
- await flush();
+ await element.updateComplete;
assert.isTrue(autoGrowHandler.called);
});
@@ -1937,18 +1989,18 @@
sendStub = sinon.stub(element, 'send').callsFake(() => Promise.resolve());
element.canBeStarted = true;
// Flush to make both Start/Save buttons appear in DOM.
- await flush();
+ await element.updateComplete;
});
test('start review sets ready', async () => {
tap(queryAndAssert(element, '.send'));
- await flush();
+ await element.updateComplete;
assert.isTrue(sendStub.calledWith(true, true));
});
test("save review doesn't set ready", async () => {
tap(queryAndAssert(element, '.save'));
- await flush();
+ await element.updateComplete;
assert.isTrue(sendStub.calledWith(true, false));
});
});
@@ -1975,7 +2027,7 @@
assert.isFalse(element.disabled);
}
- test('error occurs in _saveReview', () => {
+ test('error occurs in saveReview', () => {
stubSaveReview(() => {
throw expectedError;
});
@@ -1996,209 +2048,163 @@
element.open();
assert.isFalse(refreshSpy.called);
- assert.isTrue(element._savingComments);
+ assert.isTrue(element.savingComments);
promise.resolve();
- await flush();
+ await element.updateComplete;
assert.isTrue(refreshSpy.called);
- assert.isFalse(element._savingComments);
+ assert.isFalse(element.savingComments);
});
test('no', () => {
stubRestApi('hasPendingDiffDrafts').returns(0);
element.open();
- assert.isFalse(element._savingComments);
+ assert.isFalse(element.savingComments);
});
});
});
- test('_computeSendButtonDisabled_canBeStarted', () => {
+ test('computeSendButtonDisabled_canBeStarted', () => {
// Mock canBeStarted
- assert.isFalse(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ true,
- /* draftCommentThreads= */ [],
- /* text= */ '',
- /* reviewersMutated= */ false,
- /* labelsChanged= */ false,
- /* includeComments= */ false,
- /* disabled= */ false,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ makeAccount()
- )
- );
+ element.canBeStarted = true;
+ element.draftCommentThreads = [];
+ element.draft = '';
+ element.reviewersMutated = false;
+ element.labelsChanged = false;
+ element.includeComments = false;
+ element.disabled = false;
+ element.commentEditing = false;
+ element.account = makeAccount();
+ assert.isFalse(element.computeSendButtonDisabled());
});
- test('_computeSendButtonDisabled_allFalse', () => {
+ test('computeSendButtonDisabled_allFalse', () => {
// Mock everything false
- assert.isTrue(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ false,
- /* draftCommentThreads= */ [],
- /* text= */ '',
- /* reviewersMutated= */ false,
- /* labelsChanged= */ false,
- /* includeComments= */ false,
- /* disabled= */ false,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ makeAccount()
- )
- );
+ element.canBeStarted = false;
+ element.draftCommentThreads = [];
+ element.draft = '';
+ element.reviewersMutated = false;
+ element.labelsChanged = false;
+ element.includeComments = false;
+ element.disabled = false;
+ element.commentEditing = false;
+ element.account = makeAccount();
+ assert.isTrue(element.computeSendButtonDisabled());
});
- test('_computeSendButtonDisabled_draftCommentsSend', () => {
- // Mock nonempty comment draft array, with sending comments.
- assert.isFalse(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ false,
- /* draftCommentThreads= */ [
- {...createCommentThread([createComment()])},
- ],
- /* text= */ '',
- /* reviewersMutated= */ false,
- /* labelsChanged= */ false,
- /* includeComments= */ true,
- /* disabled= */ false,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ makeAccount()
- )
- );
+ test('computeSendButtonDisabled_draftCommentsSend', () => {
+ // Mock nonempty comment draft array; with sending comments.
+ element.canBeStarted = false;
+ element.draftCommentThreads = [{...createCommentThread([createComment()])}];
+ element.draft = '';
+ element.reviewersMutated = false;
+ element.labelsChanged = false;
+ element.includeComments = true;
+ element.disabled = false;
+ element.commentEditing = false;
+ element.account = makeAccount();
+ assert.isFalse(element.computeSendButtonDisabled());
});
- test('_computeSendButtonDisabled_draftCommentsDoNotSend', () => {
- // Mock nonempty comment draft array, without sending comments.
- assert.isTrue(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ false,
- /* draftCommentThreads= */ [
- {...createCommentThread([createComment()])},
- ],
- /* text= */ '',
- /* reviewersMutated= */ false,
- /* labelsChanged= */ false,
- /* includeComments= */ false,
- /* disabled= */ false,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ makeAccount()
- )
- );
+ test('computeSendButtonDisabled_draftCommentsDoNotSend', () => {
+ // Mock nonempty comment draft array; without sending comments.
+ element.canBeStarted = false;
+ element.draftCommentThreads = [{...createCommentThread([createComment()])}];
+ element.draft = '';
+ element.reviewersMutated = false;
+ element.labelsChanged = false;
+ element.includeComments = false;
+ element.disabled = false;
+ element.commentEditing = false;
+ element.account = makeAccount();
+
+ assert.isTrue(element.computeSendButtonDisabled());
});
- test('_computeSendButtonDisabled_changeMessage', () => {
+ test('computeSendButtonDisabled_changeMessage', () => {
// Mock nonempty change message.
- assert.isFalse(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ false,
- /* draftCommentThreads= */ [
- {...createCommentThread([createComment()])},
- ],
- /* text= */ 'test',
- /* reviewersMutated= */ false,
- /* labelsChanged= */ false,
- /* includeComments= */ false,
- /* disabled= */ false,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ makeAccount()
- )
- );
+ element.canBeStarted = false;
+ element.draftCommentThreads = [{...createCommentThread([createComment()])}];
+ element.draft = 'test';
+ element.reviewersMutated = false;
+ element.labelsChanged = false;
+ element.includeComments = false;
+ element.disabled = false;
+ element.commentEditing = false;
+ element.account = makeAccount();
+
+ assert.isFalse(element.computeSendButtonDisabled());
});
- test('_computeSendButtonDisabled_reviewersChanged', () => {
+ test('computeSendButtonDisabledreviewersChanged', () => {
// Mock reviewers mutated.
- assert.isFalse(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ false,
- /* draftCommentThreads= */ [
- {...createCommentThread([createComment()])},
- ],
- /* text= */ '',
- /* reviewersMutated= */ true,
- /* labelsChanged= */ false,
- /* includeComments= */ false,
- /* disabled= */ false,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ makeAccount()
- )
- );
+ element.canBeStarted = false;
+ element.draftCommentThreads = [{...createCommentThread([createComment()])}];
+ element.draft = '';
+ element.reviewersMutated = true;
+ element.labelsChanged = false;
+ element.includeComments = false;
+ element.disabled = false;
+ element.commentEditing = false;
+ element.account = makeAccount();
+
+ assert.isFalse(element.computeSendButtonDisabled());
});
- test('_computeSendButtonDisabled_labelsChanged', () => {
+ test('computeSendButtonDisabled_labelsChanged', () => {
// Mock labels changed.
- assert.isFalse(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ false,
- /* draftCommentThreads= */ [
- {...createCommentThread([createComment()])},
- ],
- /* text= */ '',
- /* reviewersMutated= */ false,
- /* labelsChanged= */ true,
- /* includeComments= */ false,
- /* disabled= */ false,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ makeAccount()
- )
- );
+ element.canBeStarted = false;
+ element.draftCommentThreads = [{...createCommentThread([createComment()])}];
+ element.draft = '';
+ element.reviewersMutated = false;
+ element.labelsChanged = true;
+ element.includeComments = false;
+ element.disabled = false;
+ element.commentEditing = false;
+ element.account = makeAccount();
+
+ assert.isFalse(element.computeSendButtonDisabled());
});
- test('_computeSendButtonDisabled_dialogDisabled', () => {
+ test('computeSendButtonDisabled_dialogDisabled', () => {
// Whole dialog is disabled.
- assert.isTrue(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ false,
- /* draftCommentThreads= */ [
- {...createCommentThread([createComment()])},
- ],
- /* text= */ '',
- /* reviewersMutated= */ false,
- /* labelsChanged= */ true,
- /* includeComments= */ false,
- /* disabled= */ true,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ makeAccount()
- )
- );
+ element.canBeStarted = false;
+ element.draftCommentThreads = [{...createCommentThread([createComment()])}];
+ element.draft = '';
+ element.reviewersMutated = false;
+ element.labelsChanged = true;
+ element.includeComments = false;
+ element.disabled = true;
+ element.commentEditing = false;
+ element.account = makeAccount();
+
+ assert.isTrue(element.computeSendButtonDisabled());
});
- test('_computeSendButtonDisabled_existingVote', async () => {
+ test('computeSendButtonDisabled_existingVote', async () => {
const account = createAccountWithId();
(
element.change!.labels![StandardLabels.CODE_REVIEW]! as DetailedLabelInfo
).all = [account];
- await flush();
+ element.canBeStarted = false;
+ element.draftCommentThreads = [{...createCommentThread([createComment()])}];
+ element.draft = '';
+ element.reviewersMutated = false;
+ element.labelsChanged = false;
+ element.includeComments = false;
+ element.disabled = false;
+ element.commentEditing = false;
+ element.account = account;
// User has already voted.
- assert.isFalse(
- element._computeSendButtonDisabled(
- /* canBeStarted= */ false,
- /* draftCommentThreads= */ [
- {...createCommentThread([createComment()])},
- ],
- /* text= */ '',
- /* reviewersMutated= */ false,
- /* labelsChanged= */ false,
- /* includeComments= */ false,
- /* disabled= */ false,
- /* commentEditing= */ false,
- /* change= */ element.change,
- /* account= */ account
- )
- );
+ assert.isFalse(element.computeSendButtonDisabled());
});
test('_submit blocked when no mutations exist', async () => {
const sendStub = sinon.stub(element, 'send').returns(Promise.resolve());
element.draftCommentThreads = [];
- await flush();
+ await element.updateComplete;
tap(queryAndAssert(element, 'gr-button.send'));
assert.isFalse(sendStub.called);
@@ -2215,7 +2221,7 @@
]),
},
];
- await flush();
+ await element.updateComplete;
tap(queryAndAssert(element, 'gr-button.send'));
assert.isTrue(sendStub.called);
@@ -2225,11 +2231,11 @@
// Setting draftCommentThreads to an empty object causes _sendDisabled to be
// computed to false.
element.draftCommentThreads = [];
- await flush();
+ await element.updateComplete;
assert.equal(
element.getFocusStops()!.end,
- queryAndAssert(element, '#cancelButton')
+ queryAndAssert<GrButton>(element, '#cancelButton')
);
element.draftCommentThreads = [
{
@@ -2243,16 +2249,17 @@
]),
},
];
- await flush();
+ await element.updateComplete;
assert.equal(
element.getFocusStops()!.end,
- queryAndAssert(element, '#sendButton')
+ queryAndAssert<GrButton>(element, '#sendButton')
);
});
- test('setPluginMessage', () => {
+ test('setPluginMessage', async () => {
element.setPluginMessage('foo');
+ await element.updateComplete;
assert.equal(queryAndAssert(element, '#pluginMessage').textContent, 'foo');
});
});
diff --git a/polygerrit-ui/app/elements/checks/gr-checks-runs.ts b/polygerrit-ui/app/elements/checks/gr-checks-runs.ts
index 81d757e..b18a5ff 100644
--- a/polygerrit-ui/app/elements/checks/gr-checks-runs.ts
+++ b/polygerrit-ui/app/elements/checks/gr-checks-runs.ts
@@ -317,6 +317,8 @@
renderETA() {
if (this.run.status !== RunStatus.RUNNING) return;
if (!this.run.finishedTimestamp) return;
+ const now = new Date();
+ if (this.run.finishedTimestamp.getTime() < now.getTime()) return;
const eta = durationString(new Date(), this.run.finishedTimestamp, true);
return html`<span class="eta">ETA: ${eta}</span>`;
}
diff --git a/polygerrit-ui/app/elements/core/gr-router/gr-router.ts b/polygerrit-ui/app/elements/core/gr-router/gr-router.ts
index 896787d..8c17285 100644
--- a/polygerrit-ui/app/elements/core/gr-router/gr-router.ts
+++ b/polygerrit-ui/app/elements/core/gr-router/gr-router.ts
@@ -100,7 +100,7 @@
// Redirects /groups/self to /settings/#Groups for GWT compatibility
GROUP_SELF: /^\/groups\/self/,
- // Matches /admin/groups/[uuid-]<group>,info (backwords compat with gwtui)
+ // Matches /admin/groups/[uuid-]<group>,info (backwards compat with gwtui)
// Redirects to /admin/groups/[uuid-]<group>
GROUP_INFO: /^\/admin\/groups\/(?:uuid-)?(.+),info$/,
@@ -786,7 +786,7 @@
* @param authRedirect If true, then auth is checked before
* executing the handler. If the user is not logged in, it will redirect
* to the login flow and the handler will not be executed. The login
- * redirect specifies the matched URL to be used after successfull auth.
+ * redirect specifies the matched URL to be used after successful auth.
*/
mapRoute(
pattern: string | RegExp,
@@ -885,383 +885,349 @@
next();
});
- this.mapRoute(
- RoutePattern.ROOT,
- 'handleRootRoute',
- this.handleRootRoute.bind(this)
+ this.mapRoute(RoutePattern.ROOT, 'handleRootRoute', ctx =>
+ this.handleRootRoute(ctx)
);
- this.mapRoute(
- RoutePattern.DASHBOARD,
- 'handleDashboardRoute',
- this.handleDashboardRoute.bind(this)
+ this.mapRoute(RoutePattern.DASHBOARD, 'handleDashboardRoute', ctx =>
+ this.handleDashboardRoute(ctx)
);
this.mapRoute(
RoutePattern.CUSTOM_DASHBOARD,
'handleCustomDashboardRoute',
- this.handleCustomDashboardRoute.bind(this)
+ ctx => this.handleCustomDashboardRoute(ctx)
);
this.mapRoute(
RoutePattern.PROJECT_DASHBOARD,
'handleProjectDashboardRoute',
- this.handleProjectDashboardRoute.bind(this)
+ ctx => this.handleProjectDashboardRoute(ctx)
);
this.mapRoute(
RoutePattern.LEGACY_PROJECT_DASHBOARD,
'handleLegacyProjectDashboardRoute',
- this.handleLegacyProjectDashboardRoute.bind(this)
+ ctx => this.handleLegacyProjectDashboardRoute(ctx)
);
this.mapRoute(
RoutePattern.GROUP_INFO,
'handleGroupInfoRoute',
- this.handleGroupInfoRoute.bind(this),
+ ctx => this.handleGroupInfoRoute(ctx),
true
);
this.mapRoute(
RoutePattern.GROUP_AUDIT_LOG,
'handleGroupAuditLogRoute',
- this.handleGroupAuditLogRoute.bind(this),
+ ctx => this.handleGroupAuditLogRoute(ctx),
true
);
this.mapRoute(
RoutePattern.GROUP_MEMBERS,
'handleGroupMembersRoute',
- this.handleGroupMembersRoute.bind(this),
+ ctx => this.handleGroupMembersRoute(ctx),
true
);
this.mapRoute(
RoutePattern.GROUP_LIST_OFFSET,
'handleGroupListOffsetRoute',
- this.handleGroupListOffsetRoute.bind(this),
+ ctx => this.handleGroupListOffsetRoute(ctx),
true
);
this.mapRoute(
RoutePattern.GROUP_LIST_FILTER_OFFSET,
'handleGroupListFilterOffsetRoute',
- this.handleGroupListFilterOffsetRoute.bind(this),
+ ctx => this.handleGroupListFilterOffsetRoute(ctx),
true
);
this.mapRoute(
RoutePattern.GROUP_LIST_FILTER,
'handleGroupListFilterRoute',
- this.handleGroupListFilterRoute.bind(this),
+ ctx => this.handleGroupListFilterRoute(ctx),
true
);
this.mapRoute(
RoutePattern.GROUP_SELF,
'handleGroupSelfRedirectRoute',
- this.handleGroupSelfRedirectRoute.bind(this),
+ ctx => this.handleGroupSelfRedirectRoute(ctx),
true
);
this.mapRoute(
RoutePattern.GROUP,
'handleGroupRoute',
- this.handleGroupRoute.bind(this),
+ ctx => this.handleGroupRoute(ctx),
true
);
- this.mapRoute(
- RoutePattern.PROJECT_OLD,
- 'handleProjectsOldRoute',
- this.handleProjectsOldRoute.bind(this)
+ this.mapRoute(RoutePattern.PROJECT_OLD, 'handleProjectsOldRoute', ctx =>
+ this.handleProjectsOldRoute(ctx)
);
this.mapRoute(
RoutePattern.REPO_COMMANDS,
'handleRepoCommandsRoute',
- this.handleRepoCommandsRoute.bind(this),
+ ctx => this.handleRepoCommandsRoute(ctx),
true
);
- this.mapRoute(
- RoutePattern.REPO_GENERAL,
- 'handleRepoGeneralRoute',
- this.handleRepoGeneralRoute.bind(this)
+ this.mapRoute(RoutePattern.REPO_GENERAL, 'handleRepoGeneralRoute', ctx =>
+ this.handleRepoGeneralRoute(ctx)
);
- this.mapRoute(
- RoutePattern.REPO_ACCESS,
- 'handleRepoAccessRoute',
- this.handleRepoAccessRoute.bind(this)
+ this.mapRoute(RoutePattern.REPO_ACCESS, 'handleRepoAccessRoute', ctx =>
+ this.handleRepoAccessRoute(ctx)
);
this.mapRoute(
RoutePattern.REPO_DASHBOARDS,
'handleRepoDashboardsRoute',
- this.handleRepoDashboardsRoute.bind(this)
+ ctx => this.handleRepoDashboardsRoute(ctx)
);
this.mapRoute(
RoutePattern.BRANCH_LIST_OFFSET,
'handleBranchListOffsetRoute',
- this.handleBranchListOffsetRoute.bind(this)
+ ctx => this.handleBranchListOffsetRoute(ctx)
);
this.mapRoute(
RoutePattern.BRANCH_LIST_FILTER_OFFSET,
'handleBranchListFilterOffsetRoute',
- this.handleBranchListFilterOffsetRoute.bind(this)
+ ctx => this.handleBranchListFilterOffsetRoute(ctx)
);
this.mapRoute(
RoutePattern.BRANCH_LIST_FILTER,
'handleBranchListFilterRoute',
- this.handleBranchListFilterRoute.bind(this)
+ ctx => this.handleBranchListFilterRoute(ctx)
);
this.mapRoute(
RoutePattern.TAG_LIST_OFFSET,
'handleTagListOffsetRoute',
- this.handleTagListOffsetRoute.bind(this)
+ ctx => this.handleTagListOffsetRoute(ctx)
);
this.mapRoute(
RoutePattern.TAG_LIST_FILTER_OFFSET,
'handleTagListFilterOffsetRoute',
- this.handleTagListFilterOffsetRoute.bind(this)
+ ctx => this.handleTagListFilterOffsetRoute(ctx)
);
this.mapRoute(
RoutePattern.TAG_LIST_FILTER,
'handleTagListFilterRoute',
- this.handleTagListFilterRoute.bind(this)
+ ctx => this.handleTagListFilterRoute(ctx)
);
this.mapRoute(
RoutePattern.LEGACY_CREATE_GROUP,
'handleCreateGroupRoute',
- this.handleCreateGroupRoute.bind(this),
+ ctx => this.handleCreateGroupRoute(ctx),
true
);
this.mapRoute(
RoutePattern.LEGACY_CREATE_PROJECT,
'handleCreateProjectRoute',
- this.handleCreateProjectRoute.bind(this),
+ ctx => this.handleCreateProjectRoute(ctx),
true
);
this.mapRoute(
RoutePattern.REPO_LIST_OFFSET,
'handleRepoListOffsetRoute',
- this.handleRepoListOffsetRoute.bind(this)
+ ctx => this.handleRepoListOffsetRoute(ctx)
);
this.mapRoute(
RoutePattern.REPO_LIST_FILTER_OFFSET,
'handleRepoListFilterOffsetRoute',
- this.handleRepoListFilterOffsetRoute.bind(this)
+ ctx => this.handleRepoListFilterOffsetRoute(ctx)
);
this.mapRoute(
RoutePattern.REPO_LIST_FILTER,
'handleRepoListFilterRoute',
- this.handleRepoListFilterRoute.bind(this)
+ ctx => this.handleRepoListFilterRoute(ctx)
);
- this.mapRoute(
- RoutePattern.REPO,
- 'handleRepoRoute',
- this.handleRepoRoute.bind(this)
+ this.mapRoute(RoutePattern.REPO, 'handleRepoRoute', ctx =>
+ this.handleRepoRoute(ctx)
);
- this.mapRoute(
- RoutePattern.PLUGINS,
- 'handlePassThroughRoute',
- this.handlePassThroughRoute.bind(this)
+ this.mapRoute(RoutePattern.PLUGINS, 'handlePassThroughRoute', () =>
+ this.handlePassThroughRoute()
);
this.mapRoute(
RoutePattern.PLUGIN_LIST_OFFSET,
'handlePluginListOffsetRoute',
- this.handlePluginListOffsetRoute.bind(this),
+ ctx => this.handlePluginListOffsetRoute(ctx),
true
);
this.mapRoute(
RoutePattern.PLUGIN_LIST_FILTER_OFFSET,
'handlePluginListFilterOffsetRoute',
- this.handlePluginListFilterOffsetRoute.bind(this),
+ ctx => this.handlePluginListFilterOffsetRoute(ctx),
true
);
this.mapRoute(
RoutePattern.PLUGIN_LIST_FILTER,
'handlePluginListFilterRoute',
- this.handlePluginListFilterRoute.bind(this),
+ ctx => this.handlePluginListFilterRoute(ctx),
true
);
this.mapRoute(
RoutePattern.PLUGIN_LIST,
'handlePluginListRoute',
- this.handlePluginListRoute.bind(this),
+ ctx => this.handlePluginListRoute(ctx),
true
);
this.mapRoute(
RoutePattern.QUERY_LEGACY_SUFFIX,
'handleQueryLegacySuffixRoute',
- this.handleQueryLegacySuffixRoute.bind(this)
+ ctx => this.handleQueryLegacySuffixRoute(ctx)
);
- this.mapRoute(
- RoutePattern.QUERY,
- 'handleQueryRoute',
- this.handleQueryRoute.bind(this)
+ this.mapRoute(RoutePattern.QUERY, 'handleQueryRoute', ctx =>
+ this.handleQueryRoute(ctx)
);
this.mapRoute(
RoutePattern.CHANGE_ID_QUERY,
'handleChangeIdQueryRoute',
- this.handleChangeIdQueryRoute.bind(this)
+ ctx => this.handleChangeIdQueryRoute(ctx)
);
this.mapRoute(
RoutePattern.DIFF_LEGACY_LINENUM,
'handleLegacyLinenum',
- this.handleLegacyLinenum.bind(this)
+ ctx => this.handleLegacyLinenum(ctx)
);
this.mapRoute(
RoutePattern.CHANGE_NUMBER_LEGACY,
'handleChangeNumberLegacyRoute',
- this.handleChangeNumberLegacyRoute.bind(this)
+ ctx => this.handleChangeNumberLegacyRoute(ctx)
);
this.mapRoute(
RoutePattern.DIFF_EDIT,
'handleDiffEditRoute',
- this.handleDiffEditRoute.bind(this),
+ ctx => this.handleDiffEditRoute(ctx),
true
);
this.mapRoute(
RoutePattern.CHANGE_EDIT,
'handleChangeEditRoute',
- this.handleChangeEditRoute.bind(this),
+ ctx => this.handleChangeEditRoute(ctx),
true
);
- this.mapRoute(
- RoutePattern.COMMENT,
- 'handleCommentRoute',
- this.handleCommentRoute.bind(this)
+ this.mapRoute(RoutePattern.COMMENT, 'handleCommentRoute', ctx =>
+ this.handleCommentRoute(ctx)
);
- this.mapRoute(
- RoutePattern.COMMENTS_TAB,
- 'handleCommentsRoute',
- this.handleCommentsRoute.bind(this)
+ this.mapRoute(RoutePattern.COMMENTS_TAB, 'handleCommentsRoute', ctx =>
+ this.handleCommentsRoute(ctx)
);
- this.mapRoute(
- RoutePattern.DIFF,
- 'handleDiffRoute',
- this.handleDiffRoute.bind(this)
+ this.mapRoute(RoutePattern.DIFF, 'handleDiffRoute', ctx =>
+ this.handleDiffRoute(ctx)
);
- this.mapRoute(
- RoutePattern.CHANGE,
- 'handleChangeRoute',
- this.handleChangeRoute.bind(this)
+ this.mapRoute(RoutePattern.CHANGE, 'handleChangeRoute', ctx =>
+ this.handleChangeRoute(ctx)
);
- this.mapRoute(
- RoutePattern.CHANGE_LEGACY,
- 'handleChangeLegacyRoute',
- this.handleChangeLegacyRoute.bind(this)
+ this.mapRoute(RoutePattern.CHANGE_LEGACY, 'handleChangeLegacyRoute', ctx =>
+ this.handleChangeLegacyRoute(ctx)
);
this.mapRoute(
RoutePattern.AGREEMENTS,
'handleAgreementsRoute',
- this.handleAgreementsRoute.bind(this),
+ () => this.handleAgreementsRoute(),
true
);
this.mapRoute(
RoutePattern.NEW_AGREEMENTS,
'handleNewAgreementsRoute',
- this.handleNewAgreementsRoute.bind(this),
+ ctx => this.handleNewAgreementsRoute(ctx),
true
);
this.mapRoute(
RoutePattern.SETTINGS_LEGACY,
'handleSettingsLegacyRoute',
- this.handleSettingsLegacyRoute.bind(this),
+ ctx => this.handleSettingsLegacyRoute(ctx),
true
);
this.mapRoute(
RoutePattern.SETTINGS,
'handleSettingsRoute',
- this.handleSettingsRoute.bind(this),
+ ctx => this.handleSettingsRoute(ctx),
true
);
- this.mapRoute(
- RoutePattern.REGISTER,
- 'handleRegisterRoute',
- this.handleRegisterRoute.bind(this)
+ this.mapRoute(RoutePattern.REGISTER, 'handleRegisterRoute', ctx =>
+ this.handleRegisterRoute(ctx)
);
- this.mapRoute(
- RoutePattern.LOG_IN_OR_OUT,
- 'handlePassThroughRoute',
- this.handlePassThroughRoute.bind(this)
+ this.mapRoute(RoutePattern.LOG_IN_OR_OUT, 'handlePassThroughRoute', () =>
+ this.handlePassThroughRoute()
);
this.mapRoute(
RoutePattern.IMPROPERLY_ENCODED_PLUS,
'handleImproperlyEncodedPlusRoute',
- this.handleImproperlyEncodedPlusRoute.bind(this)
+ ctx => this.handleImproperlyEncodedPlusRoute(ctx)
);
- this.mapRoute(
- RoutePattern.PLUGIN_SCREEN,
- 'handlePluginScreen',
- this.handlePluginScreen.bind(this)
+ this.mapRoute(RoutePattern.PLUGIN_SCREEN, 'handlePluginScreen', ctx =>
+ this.handlePluginScreen(ctx)
);
this.mapRoute(
RoutePattern.DOCUMENTATION_SEARCH_FILTER,
'handleDocumentationSearchRoute',
- this.handleDocumentationSearchRoute.bind(this)
+ ctx => this.handleDocumentationSearchRoute(ctx)
);
// redirects /Documentation/q/* to /Documentation/q/filter:*
this.mapRoute(
RoutePattern.DOCUMENTATION_SEARCH,
'handleDocumentationSearchRedirectRoute',
- this.handleDocumentationSearchRedirectRoute.bind(this)
+ ctx => this.handleDocumentationSearchRedirectRoute(ctx)
);
- // Makes sure /Documentation/* links work (doin't return 404)
+ // Makes sure /Documentation/* links work (don't return 404)
this.mapRoute(
RoutePattern.DOCUMENTATION,
'handleDocumentationRedirectRoute',
- this.handleDocumentationRedirectRoute.bind(this)
+ ctx => this.handleDocumentationRedirectRoute(ctx)
);
// Note: this route should appear last so it only catches URLs unmatched
// by other patterns.
- this.mapRoute(
- RoutePattern.DEFAULT,
- 'handleDefaultRoute',
- this.handleDefaultRoute.bind(this)
+ this.mapRoute(RoutePattern.DEFAULT, 'handleDefaultRoute', () =>
+ this.handleDefaultRoute()
);
page.start();
diff --git a/polygerrit-ui/app/elements/core/gr-search-bar/gr-search-bar_test.ts b/polygerrit-ui/app/elements/core/gr-search-bar/gr-search-bar_test.ts
index a97ae96..dfdb187 100644
--- a/polygerrit-ui/app/elements/core/gr-search-bar/gr-search-bar_test.ts
+++ b/polygerrit-ui/app/elements/core/gr-search-bar/gr-search-bar_test.ts
@@ -19,7 +19,7 @@
import './gr-search-bar';
import {GrSearchBar} from './gr-search-bar';
import '../../../scripts/util';
-import {mockPromise} from '../../../test/test-utils';
+import {mockPromise, waitUntil} from '../../../test/test-utils';
import {_testOnly_clearDocsBaseUrlCache} from '../../../utils/url-util';
import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
import {
@@ -93,7 +93,7 @@
null,
'enter'
);
- assert.isTrue(blurSpy.called);
+ await waitUntil(() => blurSpy.called);
});
test('empty search query does not trigger nav', async () => {
@@ -138,7 +138,7 @@
null,
'enter'
);
- assert.isTrue(searchSpy.called);
+ await waitUntil(() => searchSpy.called);
});
test('undefined predicate query triggers nav', async () => {
@@ -153,7 +153,7 @@
null,
'enter'
);
- assert.isTrue(searchSpy.called);
+ await waitUntil(() => searchSpy.called);
});
test('empty undefined predicate query triggers nav', async () => {
@@ -168,7 +168,7 @@
null,
'enter'
);
- assert.isTrue(searchSpy.called);
+ await waitUntil(() => searchSpy.called);
});
test('keyboard shortcuts', async () => {
diff --git a/polygerrit-ui/app/elements/diff/gr-diff-view/gr-diff-view.ts b/polygerrit-ui/app/elements/diff/gr-diff-view/gr-diff-view.ts
index 5f50a23..1c64a7e 100644
--- a/polygerrit-ui/app/elements/diff/gr-diff-view/gr-diff-view.ts
+++ b/polygerrit-ui/app/elements/diff/gr-diff-view/gr-diff-view.ts
@@ -104,9 +104,18 @@
getPatchRangeForCommentUrl,
isInBaseOfPatchRange,
} from '../../../utils/comment-util';
-import {AppElementParams, AppElementDiffViewParam} from '../../gr-app-types';
-import {EventType, OpenFixPreviewEvent} from '../../../types/events';
-import {fireAlert, fireEvent, fireTitleChange} from '../../../utils/event-util';
+import {AppElementDiffViewParam, AppElementParams} from '../../gr-app-types';
+import {
+ EventType,
+ OpenFixPreviewEvent,
+ ValueChangedEvent,
+} from '../../../types/events';
+import {
+ fire,
+ fireAlert,
+ fireEvent,
+ fireTitleChange,
+} from '../../../utils/event-util';
import {GerritView} from '../../../services/router/router-model';
import {assertIsDefined} from '../../../utils/common-util';
import {addGlobalShortcut, Key, toggleClass} from '../../../utils/dom-util';
@@ -177,7 +186,7 @@
@property({type: Object, observer: '_paramsChanged'})
params?: AppElementParams;
- @property({type: Object, notify: true})
+ @property({type: Object})
changeViewState: Partial<ChangeViewState> = {};
@property({type: Object})
@@ -283,11 +292,11 @@
override keyboardShortcuts(): ShortcutListener[] {
return [
- listen(Shortcut.LEFT_PANE, _ => this.cursor.moveLeft()),
- listen(Shortcut.RIGHT_PANE, _ => this.cursor.moveRight()),
+ listen(Shortcut.LEFT_PANE, _ => this.cursor?.moveLeft()),
+ listen(Shortcut.RIGHT_PANE, _ => this.cursor?.moveRight()),
listen(Shortcut.NEXT_LINE, _ => this._handleNextLine()),
listen(Shortcut.PREV_LINE, _ => this._handlePrevLine()),
- listen(Shortcut.VISIBLE_LINE, _ => this.cursor.moveToVisibleArea()),
+ listen(Shortcut.VISIBLE_LINE, _ => this.cursor?.moveToVisibleArea()),
listen(Shortcut.NEXT_FILE_WITH_COMMENTS, _ =>
this._moveToNextFileWithComment()
),
@@ -373,7 +382,7 @@
_onRenderHandler?: EventListener;
- private cursor = new GrDiffCursor();
+ private cursor?: GrDiffCursor;
private subscriptions: Subscription[] = [];
@@ -469,9 +478,10 @@
this.getChangeModel().diffPath$.subscribe(path => (this._path = path))
);
this.addEventListener('open-fix-preview', e => this._onOpenFixPreview(e));
+ this.cursor = new GrDiffCursor();
this.cursor.replaceDiffs([this.$.diffHost]);
this._onRenderHandler = (_: Event) => {
- this.cursor.reInitCursor();
+ this.cursor?.reInitCursor();
};
this.$.diffHost.addEventListener('render', this._onRenderHandler);
this.cleanups.push(
@@ -483,9 +493,10 @@
}
override disconnectedCallback() {
- this.cursor.dispose();
+ this.cursor?.dispose();
if (this._onRenderHandler) {
this.$.diffHost.removeEventListener('render', this._onRenderHandler);
+ this._onRenderHandler = undefined;
}
for (const cleanup of this.cleanups) cleanup();
this.cleanups = [];
@@ -627,7 +638,7 @@
_handlePrevLine() {
this.$.diffHost.displayLine = true;
- this.cursor.moveUp();
+ this.cursor?.moveUp();
}
_onOpenFixPreview(e: OpenFixPreviewEvent) {
@@ -636,7 +647,7 @@
_handleNextLine() {
this.$.diffHost.displayLine = true;
- this.cursor.moveDown();
+ this.cursor?.moveDown();
}
_moveToPreviousFileWithComment() {
@@ -680,7 +691,7 @@
_handleNewComment() {
this.classList.remove('hideComments');
- this.cursor.createCommentInPlace();
+ this.cursor?.createCommentInPlace();
}
_handlePrevFile() {
@@ -696,14 +707,14 @@
}
_handleNextChunk() {
- const result = this.cursor.moveToNextChunk();
- if (result === CursorMoveResult.CLIPPED && this.cursor.isAtEnd()) {
+ const result = this.cursor?.moveToNextChunk();
+ if (result === CursorMoveResult.CLIPPED && this.cursor?.isAtEnd()) {
this.showToastAndNavigateFile('next', 'n');
}
}
_handleNextCommentThread() {
- const result = this.cursor.moveToNextCommentThread();
+ const result = this.cursor?.moveToNextCommentThread();
if (result === CursorMoveResult.CLIPPED) {
this._navigateToNextFileWithCommentThread();
}
@@ -748,14 +759,14 @@
}
_handlePrevChunk() {
- this.cursor.moveToPreviousChunk();
- if (this.cursor.isAtStart()) {
+ this.cursor?.moveToPreviousChunk();
+ if (this.cursor?.isAtStart()) {
this.showToastAndNavigateFile('previous', 'p');
}
}
_handlePrevCommentThread() {
- this.cursor.moveToPreviousCommentThread();
+ this.cursor?.moveToPreviousCommentThread();
}
// Similar to gr-change-view._handleOpenReplyDialog
@@ -767,6 +778,9 @@
}
this.set('changeViewState.showReplyDialog', true);
+ fire(this, 'view-state-change-view-changed', {
+ value: this.changeViewState as ChangeViewState,
+ });
this._navToChangeView();
});
}
@@ -895,7 +909,7 @@
if (!this._patchRange) return;
// TODO(taoalpha): add a shortcut for editing
- const cursorAddress = this.cursor.getAddress();
+ const cursorAddress = this.cursor?.getAddress();
const editUrl = GerritNav.getEditUrlForDiff(
this._change,
this._path,
@@ -1124,6 +1138,10 @@
// changeNum has not changed, so check if there are changes in patchRange
// path. If no changes then we can simply render the view as is.
this.reporting.reportInteraction('diff-view-re-rendered');
+ // Make sure to re-initialize the cursor because this is typically
+ // done on the 'render' event which doesn't fire in this path as
+ // rerendering is avoided.
+ this.cursor?.reInitCursor();
return;
}
@@ -1222,6 +1240,7 @@
if (this._focusLineNum === undefined) {
return;
}
+ if (!this.cursor) return;
if (leftSide) {
this.cursor.side = Side.LEFT;
} else {
@@ -1251,6 +1270,9 @@
if (!this._fileList || this._fileList.length === 0) return;
this.set('changeViewState.selectedFileIndex', this._fileList.indexOf(path));
+ fire(this, 'view-state-change-view-changed', {
+ value: this.changeViewState as ChangeViewState,
+ });
}
_getDiffUrl(
@@ -1813,6 +1835,9 @@
}
declare global {
+ interface HTMLElementEventMap {
+ 'view-state-change-view-changed': ValueChangedEvent<ChangeViewState>;
+ }
interface HTMLElementTagNameMap {
'gr-diff-view': GrDiffView;
}
diff --git a/polygerrit-ui/app/elements/diff/gr-diff-view/gr-diff-view_test.js b/polygerrit-ui/app/elements/diff/gr-diff-view/gr-diff-view_test.js
index 3945941..331e527 100644
--- a/polygerrit-ui/app/elements/diff/gr-diff-view/gr-diff-view_test.js
+++ b/polygerrit-ui/app/elements/diff/gr-diff-view/gr-diff-view_test.js
@@ -31,6 +31,7 @@
import {EditPatchSetNum} from '../../../types/common.js';
import {CursorMoveResult} from '../../../api/core.js';
import {Side} from '../../../api/diff.js';
+import {assertIsDefined} from '../../../utils/common-util.js';
const basicFixture = fixtureFromElement('gr-diff-view');
@@ -473,6 +474,7 @@
MockInteractions.pressAndReleaseKeyOn(element, 188, null, ',');
assert(showPrefsStub.calledOnce);
+ assertIsDefined(element.cursor);
let scrollStub = sinon.stub(element.cursor, 'moveToNextChunk');
MockInteractions.pressAndReleaseKeyOn(element, 78, null, 'n');
assert(scrollStub.calledOnce);
@@ -529,6 +531,7 @@
test('moveToNextCommentThread navigates to next file', () => {
const diffNavStub = sinon.stub(GerritNav, 'navigateToDiff');
const diffChangeStub = sinon.stub(element, '_navigateToChange');
+ assertIsDefined(element.cursor);
sinon.stub(element.cursor, 'isAtEnd').returns(true);
element._changeNum = '42';
const comment = {
@@ -904,6 +907,7 @@
b: {_number: 2, commit: {parents: []}},
},
};
+ assertIsDefined(element.cursor);
sinon.stub(element.cursor, 'getAddress')
.returns({number: lineNumber, isLeftSide: false});
const redirectStub = sinon.stub(GerritNav, 'navigateToRelativeUrl');
@@ -1440,6 +1444,7 @@
});
test('_initCursor', () => {
+ assertIsDefined(element.cursor);
assert.isNotOk(element.cursor.initialLineNumber);
// Does nothing when params specify no cursor address:
@@ -1486,6 +1491,7 @@
test('_onLineSelected', () => {
const getUrlStub = sinon.stub(GerritNav, 'getUrlForDiffById');
const replaceStateStub = sinon.stub(history, 'replaceState');
+ assertIsDefined(element.cursor);
sinon.stub(element.cursor, 'getAddress')
.returns({number: 123, isLeftSide: false});
@@ -1508,6 +1514,7 @@
test('line selected on left side', () => {
const getUrlStub = sinon.stub(GerritNav, 'getUrlForDiffById');
const replaceStateStub = sinon.stub(history, 'replaceState');
+ assertIsDefined(element.cursor);
sinon.stub(element.cursor, 'getAddress')
.returns({number: 123, isLeftSide: true});
@@ -1785,6 +1792,7 @@
dispatchEventStub = sinon.stub(
element, 'dispatchEvent').callThrough();
navToFileStub = sinon.stub(element, '_navToFile');
+ assertIsDefined(element.cursor);
moveToPreviousChunkStub =
sinon.stub(element.cursor, 'moveToPreviousChunk');
moveToNextChunkStub =
diff --git a/polygerrit-ui/app/elements/diff/gr-patch-range-select/gr-patch-range-select.ts b/polygerrit-ui/app/elements/diff/gr-patch-range-select/gr-patch-range-select.ts
index 39fc048..1656f5f 100644
--- a/polygerrit-ui/app/elements/diff/gr-patch-range-select/gr-patch-range-select.ts
+++ b/polygerrit-ui/app/elements/diff/gr-patch-range-select/gr-patch-range-select.ts
@@ -453,13 +453,13 @@
const patchSetValue = convertToPatchSetNum(e.detail.value)!;
const latestPatchNum = computeLatestPatchNum(this.availablePatches);
if (target === this.patchNumDropdown) {
- if (detail.patchNum === e.detail.value) return;
+ if (detail.patchNum === patchSetValue) return;
this.reporting.reportInteraction('right-patchset-changed', {
previous: detail.patchNum,
- current: e.detail.value,
+ current: patchSetValue,
latest: latestPatchNum,
commentCount: this.changeComments?.computeCommentThreadCount({
- patchNum: e.detail.value as PatchSetNum,
+ patchNum: patchSetValue,
}),
});
detail.patchNum = patchSetValue;
@@ -467,7 +467,7 @@
if (detail.basePatchNum === patchSetValue) return;
this.reporting.reportInteraction('left-patchset-changed', {
previous: detail.basePatchNum,
- current: e.detail.value,
+ current: patchSetValue,
commentCount: this.changeComments?.computeCommentThreadCount({
patchNum: patchSetValue,
}),
diff --git a/polygerrit-ui/app/elements/diff/gr-patch-range-select/gr-patch-range-select_test.ts b/polygerrit-ui/app/elements/diff/gr-patch-range-select/gr-patch-range-select_test.ts
index dc501c8..c4e710d 100644
--- a/polygerrit-ui/app/elements/diff/gr-patch-range-select/gr-patch-range-select_test.ts
+++ b/polygerrit-ui/app/elements/diff/gr-patch-range-select/gr-patch-range-select_test.ts
@@ -23,7 +23,7 @@
import '../../../test/mocks/comment-api';
import {RevisionInfo as RevisionInfoClass} from '../../shared/revision-info/revision-info';
import {ChangeComments} from '../gr-comment-api/gr-comment-api';
-import {stubRestApi} from '../../../test/test-utils';
+import {stubReporting, stubRestApi} from '../../../test/test-utils';
import {
BasePatchSetNum,
EditPatchSetNum,
@@ -45,6 +45,7 @@
GrDropdownList,
} from '../../shared/gr-dropdown-list/gr-dropdown-list';
import {queryAndAssert} from '../../../test/test-utils';
+import {fire} from '../../../utils/event-util';
const basicFixture = fixtureFromElement('gr-patch-range-select');
@@ -418,4 +419,30 @@
patchNum: 'edit',
});
});
+
+ test('handlePatchChange', async () => {
+ element.availablePatches = [
+ {num: 'edit', sha: '1'} as PatchSet,
+ {num: 3, sha: '2'} as PatchSet,
+ {num: 2, sha: '3'} as PatchSet,
+ {num: 1, sha: '4'} as PatchSet,
+ ];
+ element.revisions = [
+ createRevision(2),
+ createRevision(3),
+ createRevision(1),
+ createRevision(4),
+ ];
+ element.revisionInfo = getInfo(element.revisions);
+ element.patchNum = 1 as PatchSetNum;
+ element.basePatchNum = 'PARENT' as BasePatchSetNum;
+ await element.updateComplete;
+
+ const stub = stubReporting('reportInteraction');
+ fire(element.patchNumDropdown!, 'value-change', {value: '1'});
+ assert.isFalse(stub.called);
+
+ fire(element.patchNumDropdown!, 'value-change', {value: '2'});
+ assert.isTrue(stub.called);
+ });
});
diff --git a/polygerrit-ui/app/elements/edit/gr-edit-controls/gr-edit-controls_test.ts b/polygerrit-ui/app/elements/edit/gr-edit-controls/gr-edit-controls_test.ts
index b307c20..8376d34 100644
--- a/polygerrit-ui/app/elements/edit/gr-edit-controls/gr-edit-controls_test.ts
+++ b/polygerrit-ui/app/elements/edit/gr-edit-controls/gr-edit-controls_test.ts
@@ -19,7 +19,7 @@
import './gr-edit-controls';
import {GrEditControls} from './gr-edit-controls';
import {GerritNav} from '../../core/gr-navigation/gr-navigation';
-import {queryAll, stubRestApi} from '../../../test/test-utils';
+import {queryAll, stubRestApi, waitUntil} from '../../../test/test-utils';
import {createChange, createRevision} from '../../../test/test-data-generators';
import {GrAutocomplete} from '../../shared/gr-autocomplete/gr-autocomplete';
import {CommitId, NumericChangeId, PatchSetNum} from '../../../types/common';
@@ -28,6 +28,7 @@
import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
import {fixture, html} from '@open-wc/testing-helpers';
import {GrButton} from '../../shared/gr-button/gr-button';
+import '../../shared/gr-dialog/gr-dialog';
suite('gr-edit-controls tests', () => {
let element: GrEditControls;
@@ -89,18 +90,20 @@
assert.isTrue(hideDialogStub.called);
assert.isTrue(element.openDialog!.disabled);
assert.isFalse(queryStub.called);
- // Setup _focused manually - in headless mode Chrome sometimes don't
+ // Setup focused manually - in headless mode Chrome sometimes don't
// setup focus. flush and/or flushAsynchronousOperations don't help
- openAutoComplete._focused = true;
+ openAutoComplete.focused = true;
openAutoComplete.noDebounce = true;
openAutoComplete.text = 'src/test.cpp';
await element.updateComplete;
assert.isTrue(queryStub.called);
- assert.isFalse(element.openDialog!.disabled);
- MockInteractions.tap(
- queryAndAssert(element.openDialog, 'gr-button[primary]')
- );
- assert.isTrue(editDiffStub.called);
+ await waitUntil(() => !element.openDialog!.disabled);
+ queryAndAssert<GrButton>(
+ element.openDialog,
+ 'gr-button[primary]'
+ ).click();
+ await waitUntil(() => editDiffStub.called);
+
assert.isTrue(navStub.called);
assert.deepEqual(editDiffStub.lastCall.args, [
element.change,
@@ -117,13 +120,13 @@
openAutoComplete.noDebounce = true;
openAutoComplete.text = 'src/test.cpp';
await element.updateComplete;
- assert.isFalse(element.openDialog!.disabled);
+ await waitUntil(() => !element.openDialog!.disabled);
MockInteractions.tap(
queryAndAssert<GrButton>(element.openDialog, 'gr-button')
);
assert.isFalse(editDiffStub.called);
assert.isFalse(navStub.called);
- assert.isTrue(closeDialogSpy.called);
+ await waitUntil(() => closeDialogSpy.called);
assert.equal(element.path, '');
});
});
@@ -150,14 +153,14 @@
await showDialogSpy.lastCall.returnValue;
assert.isTrue(element.deleteDialog!.disabled);
assert.isFalse(queryStub.called);
- // Setup _focused manually - in headless mode Chrome sometimes don't
+ // Setup focused manually - in headless mode Chrome sometimes don't
// setup focus. flush and/or flushAsynchronousOperations don't help
- deleteAutocomplete._focused = true;
+ deleteAutocomplete.focused = true;
deleteAutocomplete.noDebounce = true;
deleteAutocomplete.text = 'src/test.cpp';
await element.updateComplete;
assert.isTrue(queryStub.called);
- assert.isFalse(element.deleteDialog!.disabled);
+ await waitUntil(() => !element.deleteDialog!.disabled);
MockInteractions.tap(
queryAndAssert(element.deleteDialog, 'gr-button[primary]')
);
@@ -176,14 +179,14 @@
await showDialogSpy.lastCall.returnValue;
assert.isTrue(element.deleteDialog!.disabled);
assert.isFalse(queryStub.called);
- // Setup _focused manually - in headless mode Chrome sometimes don't
+ // Setup focused manually - in headless mode Chrome sometimes don't
// setup focus. flush and/or flushAsynchronousOperations don't help
- deleteAutocomplete._focused = true;
+ deleteAutocomplete.focused = true;
deleteAutocomplete.noDebounce = true;
deleteAutocomplete.text = 'src/test.cpp';
await element.updateComplete;
assert.isTrue(queryStub.called);
- assert.isFalse(element.deleteDialog!.disabled);
+ await waitUntil(() => !element.deleteDialog!.disabled);
MockInteractions.tap(
queryAndAssert(element.deleteDialog, 'gr-button[primary]')
);
@@ -205,11 +208,11 @@
'gr-autocomplete'
).text = 'src/test.cpp';
await element.updateComplete;
- assert.isFalse(element.deleteDialog!.disabled);
+ await waitUntil(() => !element.deleteDialog!.disabled);
MockInteractions.tap(queryAndAssert(element.deleteDialog, 'gr-button'));
assert.isFalse(eventStub.called);
assert.isTrue(closeDialogSpy.called);
- assert.equal(element.path, '');
+ await waitUntil(() => element.path === '');
});
});
});
@@ -235,9 +238,9 @@
await showDialogSpy.lastCall.returnValue;
assert.isTrue(element.renameDialog!.disabled);
assert.isFalse(queryStub.called);
- // Setup _focused manually - in headless mode Chrome sometimes don't
+ // Setup focused manually - in headless mode Chrome sometimes don't
// setup focus. flush and/or flushAsynchronousOperations don't help
- renameAutocomplete._focused = true;
+ renameAutocomplete.focused = true;
renameAutocomplete.noDebounce = true;
renameAutocomplete.text = 'src/test.cpp';
await element.updateComplete;
@@ -266,9 +269,9 @@
await showDialogSpy.lastCall.returnValue;
assert.isTrue(element.renameDialog!.disabled);
assert.isFalse(queryStub.called);
- // Setup _focused manually - in headless mode Chrome sometimes don't
+ // Setup focused manually - in headless mode Chrome sometimes don't
// setup focus. flush and/or flushAsynchronousOperations don't help
- renameAutocomplete._focused = true;
+ renameAutocomplete.focused = true;
renameAutocomplete.noDebounce = true;
renameAutocomplete.text = 'src/test.cpp';
await element.updateComplete;
@@ -305,8 +308,7 @@
MockInteractions.tap(queryAndAssert(element.renameDialog, 'gr-button'));
assert.isFalse(eventStub.called);
assert.isTrue(closeDialogSpy.called);
- assert.equal(element.path, '');
- assert.equal(element.newPath, '');
+ await waitUntil(() => element.path === '');
});
});
});
diff --git a/polygerrit-ui/app/elements/gr-app-element.ts b/polygerrit-ui/app/elements/gr-app-element.ts
index bec99663..a78e59f 100644
--- a/polygerrit-ui/app/elements/gr-app-element.ts
+++ b/polygerrit-ui/app/elements/gr-app-element.ts
@@ -14,7 +14,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-import '../styles/shared-styles';
+
import '../styles/themes/app-theme';
import '../styles/themes/dark-theme';
import {applyTheme as applyDarkTheme} from '../styles/themes/dark-theme';
@@ -37,24 +37,12 @@
import './settings/gr-cla-view/gr-cla-view';
import './settings/gr-registration-dialog/gr-registration-dialog';
import './settings/gr-settings-view/gr-settings-view';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-app-element_html';
import {getBaseUrl} from '../utils/url-util';
-import {
- KeyboardShortcutMixin,
- Shortcut,
- ShortcutListener,
-} from '../mixins/keyboard-shortcut-mixin/keyboard-shortcut-mixin';
+import {Shortcut} from '../mixins/keyboard-shortcut-mixin/keyboard-shortcut-mixin';
import {GerritNav} from './core/gr-navigation/gr-navigation';
import {getAppContext} from '../services/app-context';
-import {flush} from '@polymer/polymer/lib/utils/flush';
-import {customElement, observe, property} from '@polymer/decorators';
import {GrRouter} from './core/gr-router/gr-router';
-import {
- AccountDetailInfo,
- ElementPropertyDeepChange,
- ServerInfo,
-} from '../types/common';
+import {AccountDetailInfo, ServerInfo} from '../types/common';
import {
constructServerErrorMsg,
GrErrorManager,
@@ -64,6 +52,8 @@
import {
AppElementJustRegisteredParams,
AppElementParams,
+ AppElementPluginScreenParams,
+ AppElementSearchParam,
isAppElementJustRegisteredParams,
} from './gr-app-types';
import {GrMainHeader} from './core/gr-main-header/gr-main-header';
@@ -77,14 +67,19 @@
TitleChangeEventDetail,
ValueChangedEvent,
} from '../types/events';
-import {ChangeListViewState, ViewState} from '../types/types';
+import {ChangeListViewState, ChangeViewState, ViewState} from '../types/types';
import {GerritView} from '../services/router/router-model';
import {LifeCycle} from '../constants/reporting';
import {fireIronAnnounce} from '../utils/event-util';
-import {assertIsDefined} from '../utils/common-util';
-import {listen} from '../services/shortcuts/shortcuts-service';
-import {resolve, DIPolymerElement} from '../models/dependency';
+import {resolve} from '../models/dependency';
import {browserModelToken} from '../models/browser/browser-model';
+import {sharedStyles} from '../styles/shared-styles';
+import {LitElement, PropertyValues, html, css, nothing} from 'lit';
+import {customElement, property, query, state} from 'lit/decorators';
+import {ShortcutController} from './lit/shortcut-controller';
+import {cache} from 'lit/directives/cache';
+import {assertIsDefined} from '../utils/common-util';
+import './gr-css-mixins';
interface ErrorInfo {
text: string;
@@ -92,120 +87,92 @@
moreInfo?: string;
}
-export interface GrAppElement {
- $: {
- errorManager: GrErrorManager;
- errorView: HTMLDivElement;
- mainHeader: GrMainHeader;
- };
-}
-
-type DomIf = PolymerElement & {
- restamp: boolean;
-};
-
-// This avoids JSC_DYNAMIC_EXTENDS_WITHOUT_JSDOC closure compiler error.
-const base = KeyboardShortcutMixin(DIPolymerElement);
-
// TODO(TS): implement AppElement interface from gr-app-types.ts
@customElement('gr-app-element')
-export class GrAppElement extends base {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrAppElement extends LitElement {
/**
* Fired when the URL location changes.
*
* @event location-change
*/
+ @query('#errorManager') errorManager?: GrErrorManager;
+
+ @query('#errorView') errorView?: HTMLDivElement;
+
+ @query('#mainHeader') mainHeader?: GrMainHeader;
+
+ @query('#registrationOverlay') registrationOverlay?: GrOverlay;
+
+ @query('#registrationDialog') registrationDialog?: GrRegistrationDialog;
+
+ @query('#keyboardShortcuts') keyboardShortcuts?: GrOverlay;
+
+ @query('gr-settings-view') settingdView?: GrSettingsView;
+
@property({type: Object})
params?: AppElementParams;
- @property({type: Object, observer: '_accountChanged'})
- _account?: AccountDetailInfo;
+ @state() private account?: AccountDetailInfo;
- @property({type: Number})
- _lastGKeyPressTimestamp: number | null = null;
+ @state() private serverConfig?: ServerInfo;
- @property({type: Object})
- _serverConfig?: ServerInfo;
+ @state() private version?: string;
- @property({type: String})
- _version?: string;
+ @state() private showChangeListView?: boolean;
- @property({type: Boolean})
- _showChangeListView?: boolean;
+ @state() private showDashboardView?: boolean;
- @property({type: Boolean})
- _showDashboardView?: boolean;
+ @state() private showChangeView?: boolean;
- @property({type: Boolean})
- _showChangeView?: boolean;
+ @state() private showDiffView?: boolean;
- @property({type: Boolean})
- _showDiffView?: boolean;
+ @state() private showSettingsView?: boolean;
- @property({type: Boolean})
- _showSettingsView?: boolean;
+ @state() private showAdminView?: boolean;
- @property({type: Boolean})
- _showAdminView?: boolean;
+ @state() private showCLAView?: boolean;
- @property({type: Boolean})
- _showCLAView?: boolean;
+ @state() private showEditorView?: boolean;
- @property({type: Boolean})
- _showEditorView?: boolean;
+ @state() private showPluginScreen?: boolean;
- @property({type: Boolean})
- _showPluginScreen?: boolean;
+ @state() private showDocumentationSearch?: boolean;
- @property({type: Boolean})
- _showDocumentationSearch?: boolean;
+ @state() private viewState?: ViewState;
- @property({type: Object})
- _viewState?: ViewState;
+ @state() private lastError?: ErrorInfo;
- @property({type: Object})
- _lastError?: ErrorInfo;
+ // private but used in test
+ @state() lastSearchPage?: string;
- @property({type: String})
- _lastSearchPage?: string;
+ @state() private path?: string;
- @property({type: String})
- _path?: string;
+ @state() private settingsUrl?: string;
- @property({type: String, computed: '_computePluginScreenName(params)'})
- _pluginScreenName?: string;
+ @state() private mobileSearch = false;
- @property({type: String})
- _settingsUrl?: string;
+ @state() private loginUrl = '/login';
- @property({type: Boolean})
- mobileSearch = false;
+ @state() private loadRegistrationDialog = false;
- @property({type: String})
- _loginUrl = '/login';
-
- @property({type: Boolean})
- loadRegistrationDialog = false;
-
- @property({type: Boolean})
- loadKeyboardShortcutsDialog = false;
+ @state() private loadKeyboardShortcutsDialog = false;
// TODO(milutin) - remove once new gr-dialog will do it out of the box
// This removes footer, header from a11y tree, when a dialog on view
// (e.g. reply dialog) is open
- @property({type: Boolean})
- _footerHeaderAriaHidden = false;
+ @state() private footerHeaderAriaHidden = false;
// TODO(milutin) - remove once new gr-dialog will do it out of the box
// This removes main page from a11y tree, when a dialog on gr-app-element
// (e.g. shortcut dialog) is open
- @property({type: Boolean})
- _mainAriaHidden = false;
+ @state() private mainAriaHidden = false;
+
+ // Triggers dom-if unsetting/setting restamp behaviour in lit
+ @state() private invalidateChangeViewCache = false;
+
+ // Triggers dom-if unsetting/setting restamp behaviour in lit
+ @state() private invalidateDiffViewCache = false;
readonly router = new GrRouter();
@@ -215,58 +182,60 @@
private readonly getBrowserModel = resolve(this, browserModelToken);
- override keyboardShortcuts(): ShortcutListener[] {
- return [
- listen(Shortcut.OPEN_SHORTCUT_HELP_DIALOG, _ =>
- this._showKeyboardShortcuts()
- ),
- listen(Shortcut.GO_TO_USER_DASHBOARD, _ => this._goToUserDashboard()),
- listen(Shortcut.GO_TO_OPENED_CHANGES, _ => this._goToOpenedChanges()),
- listen(Shortcut.GO_TO_MERGED_CHANGES, _ => this._goToMergedChanges()),
- listen(Shortcut.GO_TO_ABANDONED_CHANGES, _ =>
- this._goToAbandonedChanges()
- ),
- listen(Shortcut.GO_TO_WATCHED_CHANGES, _ => this._goToWatchedChanges()),
- ];
- }
+ private readonly shortcuts = new ShortcutController(this);
constructor() {
super();
document.addEventListener(EventType.PAGE_ERROR, e => {
- this._handlePageError(e);
+ this.handlePageError(e);
});
this.addEventListener(EventType.TITLE_CHANGE, e => {
- this._handleTitleChange(e);
+ this.handleTitleChange(e);
});
this.addEventListener(EventType.DIALOG_CHANGE, e => {
- this._handleDialogChange(e as CustomEvent<DialogChangeEventDetail>);
+ this.handleDialogChange(e as CustomEvent<DialogChangeEventDetail>);
});
this.addEventListener(EventType.LOCATION_CHANGE, e =>
- this._handleLocationChange(e)
+ this.handleLocationChange(e)
);
this.addEventListener(EventType.RECREATE_CHANGE_VIEW, () =>
- this.handleRecreateView(GerritView.CHANGE)
+ this.handleRecreateView()
);
this.addEventListener(EventType.RECREATE_DIFF_VIEW, () =>
- this.handleRecreateView(GerritView.DIFF)
+ this.handleRecreateView()
);
- document.addEventListener(EventType.GR_RPC_LOG, e => this._handleRpcLog(e));
+ document.addEventListener(EventType.GR_RPC_LOG, e => this.handleRpcLog(e));
+ this.shortcuts.addAbstract(Shortcut.OPEN_SHORTCUT_HELP_DIALOG, () =>
+ this.showKeyboardShortcuts()
+ );
+ this.shortcuts.addAbstract(Shortcut.GO_TO_USER_DASHBOARD, () =>
+ this.goToUserDashboard()
+ );
+ this.shortcuts.addAbstract(Shortcut.GO_TO_OPENED_CHANGES, () =>
+ this.goToOpenedChanges()
+ );
+ this.shortcuts.addAbstract(Shortcut.GO_TO_MERGED_CHANGES, () =>
+ this.goToMergedChanges()
+ );
+ this.shortcuts.addAbstract(Shortcut.GO_TO_ABANDONED_CHANGES, () =>
+ this.goToAbandonedChanges()
+ );
+ this.shortcuts.addAbstract(Shortcut.GO_TO_WATCHED_CHANGES, () =>
+ this.goToWatchedChanges()
+ );
}
override connectedCallback() {
super.connectedCallback();
const resizeObserver = this.getBrowserModel().observeWidth();
resizeObserver.observe(this);
- }
- override ready() {
- super.ready();
- this._updateLoginUrl();
+ this.updateLoginUrl();
this.reporting.appStarted();
this.router.start();
this.restApiService.getAccount().then(account => {
- this._account = account;
+ this.account = account;
if (account) {
this.reporting.reportLifeCycle(LifeCycle.STARTED_AS_USER);
} else {
@@ -274,11 +243,11 @@
}
});
this.restApiService.getConfig().then(config => {
- this._serverConfig = config;
+ this.serverConfig = config;
});
this.restApiService.getVersion().then(version => {
- this._version = version;
- this._logWelcome();
+ this.version = version;
+ this.logWelcome();
});
const isDarkTheme = !!window.localStorage.getItem('dark-theme');
@@ -288,9 +257,9 @@
// Note: this is evaluated here to ensure that it only happens after the
// router has been initialized. @see Issue 7837
- this._settingsUrl = GerritNav.getUrlForSettings();
+ this.settingsUrl = GerritNav.getUrlForSettings();
- this._viewState = {
+ this.viewState = {
changeView: {
changeNum: null,
patchRange: null,
@@ -308,85 +277,372 @@
};
}
- _accountChanged(account?: AccountDetailInfo) {
- if (!account) return;
+ static override get styles() {
+ return [
+ sharedStyles,
+ css`
+ :host {
+ background-color: var(--background-color-tertiary);
+ display: flex;
+ flex-direction: column;
+ min-height: 100%;
+ }
+ gr-main-header,
+ footer {
+ color: var(--primary-text-color);
+ }
+ gr-main-header {
+ background: var(
+ --header-background,
+ var(--header-background-color, #eee)
+ );
+ padding: var(--header-padding);
+ border-bottom: var(--header-border-bottom);
+ border-image: var(--header-border-image);
+ border-right: 0;
+ border-left: 0;
+ border-top: 0;
+ box-shadow: var(--header-box-shadow);
+ /* Make sure the header is above the main content, to preserve box-shadow
+ visibility. We need 2 here instead of 1, because dropdowns in the
+ header should be shown on top of the sticky diff header, which has a
+ z-index of 1. */
+ z-index: 2;
+ }
+ footer {
+ background: var(
+ --footer-background,
+ var(--footer-background-color, #eee)
+ );
+ border-top: var(--footer-border-top);
+ display: flex;
+ justify-content: space-between;
+ padding: var(--spacing-m) var(--spacing-l);
+ z-index: 100;
+ }
+ main {
+ flex: 1;
+ padding-bottom: var(--spacing-xxl);
+ position: relative;
+ }
+ .errorView {
+ align-items: center;
+ display: none;
+ flex-direction: column;
+ justify-content: center;
+ position: absolute;
+ top: 0;
+ right: 0;
+ bottom: 0;
+ left: 0;
+ }
+ .errorView.show {
+ display: flex;
+ }
+ .errorEmoji {
+ font-size: 2.6rem;
+ }
+ .errorText,
+ .errorMoreInfo {
+ margin-top: var(--spacing-m);
+ }
+ .errorText {
+ font-family: var(--header-font-family);
+ font-size: var(--font-size-h3);
+ font-weight: var(--font-weight-h3);
+ line-height: var(--line-height-h3);
+ }
+ .errorMoreInfo {
+ color: var(--deemphasized-text-color);
+ }
+ `,
+ ];
+ }
+
+ override render() {
+ return html`
+ <gr-css-mixins></gr-css-mixins>
+ <gr-endpoint-decorator name="banner"></gr-endpoint-decorator>
+ <gr-main-header
+ id="mainHeader"
+ .searchQuery=${(this.params as AppElementSearchParam)?.query}
+ @mobile-search=${this.mobileSearchToggle}
+ @show-keyboard-shortcuts=${this.handleShowKeyboardShortcuts}
+ .mobileSearchHidden=${!this.mobileSearch}
+ .loginUrl=${this.loginUrl}
+ ?aria-hidden=${this.footerHeaderAriaHidden}
+ >
+ </gr-main-header>
+ <main ?aria-hidden=${this.mainAriaHidden}>
+ ${this.renderMobileSearch()} ${this.renderChangeListView()}
+ ${this.renderDashboardView()} ${this.renderChangeView()}
+ ${this.renderEditorView()} ${this.renderDiffView()}
+ ${this.renderSettingsView()} ${this.renderAdminView()}
+ ${this.renderPluginScreen()} ${this.renderCLAView()}
+ ${this.renderDocumentationSearch()}
+ <div id="errorView" class="errorView">
+ <div class="errorEmoji">${this.lastError?.emoji}</div>
+ <div class="errorText">${this.lastError?.text}</div>
+ <div class="errorMoreInfo">${this.lastError?.moreInfo}</div>
+ </div>
+ </main>
+ <footer ?aria-hidden=${this.footerHeaderAriaHidden}>
+ <div>
+ Powered by
+ <a
+ href="https://www.gerritcodereview.com/"
+ rel="noopener"
+ target="_blank"
+ >Gerrit Code Review</a
+ >
+ (${this.version})
+ <gr-endpoint-decorator name="footer-left"></gr-endpoint-decorator>
+ </div>
+ <div>
+ Press “?” for keyboard shortcuts
+ <gr-endpoint-decorator name="footer-right"></gr-endpoint-decorator>
+ </div>
+ </footer>
+ ${this.renderKeyboardShortcutsDialog()} ${this.renderRegistrationDialog()}
+ <gr-endpoint-decorator name="plugin-overlay"></gr-endpoint-decorator>
+ <gr-error-manager
+ id="errorManager"
+ .loginUrl=${this.loginUrl}
+ ></gr-error-manager>
+ <gr-plugin-host id="plugins" .config=${this.serverConfig}>
+ </gr-plugin-host>
+ <gr-external-style
+ id="externalStyleForAll"
+ name="app-theme"
+ ></gr-external-style>
+ <gr-external-style
+ id="externalStyleForTheme"
+ .name=${this.getThemeEndpoint()}
+ ></gr-external-style>
+ `;
+ }
+
+ private renderMobileSearch() {
+ if (!this.mobileSearch) return nothing;
+ return html`
+ <gr-smart-search
+ id="search"
+ label="Search for changes"
+ .searchQuery=${(this.params as AppElementSearchParam)?.query}
+ .serverConfig=${this.serverConfig}
+ >
+ </gr-smart-search>
+ `;
+ }
+
+ private renderChangeListView() {
+ if (!this.showChangeListView) return nothing;
+ return html`
+ <gr-change-list-view
+ .params=${this.params}
+ .account=${this.account}
+ .viewState=${this.viewState?.changeListView}
+ @view-state-change-list-view-changed=${this.handleViewStateChanged}
+ ></gr-change-list-view>
+ `;
+ }
+
+ private renderDashboardView() {
+ if (!this.showDashboardView) return nothing;
+ return html`
+ <gr-dashboard-view
+ .account=${this.account}
+ .params=${this.params}
+ .viewState=${this.viewState?.dashboardView}
+ ></gr-dashboard-view>
+ `;
+ }
+
+ private renderChangeView() {
+ if (this.invalidateChangeViewCache) {
+ this.updateComplete.then(() => (this.invalidateChangeViewCache = false));
+ return nothing;
+ }
+ return cache(this.showChangeView ? this.changeViewTemplate() : nothing);
+ }
+
+ // Template as not to create duplicates, for renderChangeView() only.
+ private changeViewTemplate() {
+ return html`
+ <gr-change-view
+ .params=${this.params}
+ .viewState=${this.viewState?.changeView}
+ .backPage=${this.lastSearchPage}
+ @view-state-change-view-changed=${this.handleViewStateChangeViewChanged}
+ ></gr-change-view>
+ `;
+ }
+
+ private renderEditorView() {
+ if (!this.showEditorView) return nothing;
+ return html`<gr-editor-view .params=${this.params}></gr-editor-view>`;
+ }
+
+ private renderDiffView() {
+ if (this.invalidateDiffViewCache) {
+ this.updateComplete.then(() => (this.invalidateDiffViewCache = false));
+ return nothing;
+ }
+ return cache(this.showDiffView ? this.diffViewTemplate() : nothing);
+ }
+
+ private diffViewTemplate() {
+ return html`
+ <gr-diff-view
+ .params=${this.params}
+ .changeViewState=${this.viewState?.changeView}
+ @view-state-change-view-changed=${this.handleViewStateChangeViewChanged}
+ ></gr-diff-view>
+ `;
+ }
+
+ private renderSettingsView() {
+ if (!this.showSettingsView) return nothing;
+ return html`
+ <gr-settings-view
+ .params=${this.params}
+ @account-detail-update=${this.handleAccountDetailUpdate}
+ >
+ </gr-settings-view>
+ `;
+ }
+
+ private renderAdminView() {
+ if (!this.showAdminView) return nothing;
+ return html`<gr-admin-view
+ .path=${this.path}
+ .params=${this.params}
+ ></gr-admin-view>`;
+ }
+
+ private renderPluginScreen() {
+ if (!this.showPluginScreen) return nothing;
+ return html`
+ <gr-endpoint-decorator .name=${this.computePluginScreenName()}>
+ <gr-endpoint-param
+ name="token"
+ .value=${(this.params as AppElementPluginScreenParams).screen}
+ ></gr-endpoint-param>
+ </gr-endpoint-decorator>
+ `;
+ }
+
+ private renderCLAView() {
+ if (!this.showCLAView) return nothing;
+ return html`<gr-cla-view></gr-cla-view>`;
+ }
+
+ private renderDocumentationSearch() {
+ if (!this.showDocumentationSearch) return nothing;
+ return html`
+ <gr-documentation-search .params=${this.params}></gr-documentation-search>
+ `;
+ }
+
+ private renderKeyboardShortcutsDialog() {
+ if (!this.loadKeyboardShortcutsDialog) return nothing;
+ return html`
+ <gr-overlay
+ id="keyboardShortcuts"
+ with-backdrop=""
+ @iron-overlay-canceled=${this.onOverlayCanceled}
+ >
+ <gr-keyboard-shortcuts-dialog
+ @close=${this.handleKeyboardShortcutDialogClose}
+ ></gr-keyboard-shortcuts-dialog>
+ </gr-overlay>
+ `;
+ }
+
+ private renderRegistrationDialog() {
+ if (!this.loadRegistrationDialog) return nothing;
+ return html`
+ <gr-overlay id="registrationOverlay" with-backdrop="">
+ <gr-registration-dialog
+ id="registrationDialog"
+ .settingsUrl=${this.settingsUrl}
+ @account-detail-update=${this.handleAccountDetailUpdate}
+ @close=${this.handleRegistrationDialogClose}
+ >
+ </gr-registration-dialog>
+ </gr-overlay>
+ `;
+ }
+
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('account')) {
+ this.accountChanged();
+ }
+
+ if (changedProperties.has('params')) {
+ this.viewChanged();
+
+ this.paramsChanged();
+ }
+ }
+
+ private accountChanged() {
+ if (!this.account) return;
// Preferences are cached when a user is logged in; warm them.
this.restApiService.getPreferences();
this.restApiService.getDiffPreferences();
this.restApiService.getEditPreferences();
- this.$.errorManager.knownAccountId =
- (this._account && this._account._account_id) || null;
+ if (this.errorManager)
+ this.errorManager.knownAccountId =
+ (this.account && this.account._account_id) || null;
}
/**
* Throws away the view and re-creates it. The view itself fires an event, if
* it wants to be re-created.
*/
- private handleRecreateView(view: GerritView.DIFF | GerritView.CHANGE) {
- const isDiff = view === GerritView.DIFF;
- const domId = isDiff ? '#dom-if-diff-view' : '#dom-if-change-view';
- const domIf = this.root!.querySelector(domId) as DomIf;
- assertIsDefined(domIf, '<dom-if> for the view');
- // The rendering of DomIf is debounced, so just changing _show...View and
- // restamp properties back and forth won't work. That is why we are using
- // timeouts.
- // The first timeout is needed, because the _viewChanged() observer also
- // affects _show...View and would change _show...View=false directly back to
- // _show...View=true.
- setTimeout(() => {
- this._showChangeView = false;
- this._showDiffView = false;
- domIf.restamp = true;
- setTimeout(() => {
- this._showChangeView = this.params?.view === GerritView.CHANGE;
- this._showDiffView = this.params?.view === GerritView.DIFF;
- domIf.restamp = false;
- }, 1);
- }, 1);
+ private handleRecreateView() {
+ this.invalidateChangeViewCache = true;
+ this.invalidateDiffViewCache = true;
}
- @observe('params.*')
- _viewChanged() {
+ private async viewChanged() {
const view = this.params?.view;
- this.$.errorView.classList.remove('show');
- this._showChangeListView = view === GerritView.SEARCH;
- this._showDashboardView = view === GerritView.DASHBOARD;
- this._showChangeView = view === GerritView.CHANGE;
- this._showDiffView = view === GerritView.DIFF;
- this._showSettingsView = view === GerritView.SETTINGS;
- // _showAdminView must be in sync with the gr-admin-view AdminViewParams type
- this._showAdminView =
+ this.errorView?.classList.remove('show');
+ this.showChangeListView = view === GerritView.SEARCH;
+ this.showDashboardView = view === GerritView.DASHBOARD;
+ this.showChangeView = view === GerritView.CHANGE;
+ this.showDiffView = view === GerritView.DIFF;
+ this.showSettingsView = view === GerritView.SETTINGS;
+ // showAdminView must be in sync with the gr-admin-view AdminViewParams type
+ this.showAdminView =
view === GerritView.ADMIN ||
view === GerritView.GROUP ||
view === GerritView.REPO;
- this._showCLAView = view === GerritView.AGREEMENTS;
- this._showEditorView = view === GerritView.EDIT;
+ this.showCLAView = view === GerritView.AGREEMENTS;
+ this.showEditorView = view === GerritView.EDIT;
const isPluginScreen = view === GerritView.PLUGIN_SCREEN;
- this._showPluginScreen = false;
+ this.showPluginScreen = false;
// Navigation within plugin screens does not restamp gr-endpoint-decorator
- // because _showPluginScreen value does not change. To force restamp,
- // change _showPluginScreen value between true and false.
+ // because showPluginScreen value does not change. To force restamp,
+ // change showPluginScreen value between true and false.
if (isPluginScreen) {
- setTimeout(() => (this._showPluginScreen = true), 1);
+ setTimeout(() => (this.showPluginScreen = true), 1);
}
- this._showDocumentationSearch = view === GerritView.DOCUMENTATION_SEARCH;
+ this.showDocumentationSearch = view === GerritView.DOCUMENTATION_SEARCH;
if (
this.params &&
isAppElementJustRegisteredParams(this.params) &&
this.params.justRegistered
) {
this.loadRegistrationDialog = true;
- flush();
- const registrationOverlay = this.shadowRoot!.querySelector(
- '#registrationOverlay'
- ) as GrOverlay;
- const registrationDialog = this.shadowRoot!.querySelector(
- '#registrationDialog'
- ) as GrRegistrationDialog;
- registrationOverlay.open();
- registrationDialog.loadData().then(() => {
- registrationOverlay.refit();
+ await this.updateComplete;
+ assertIsDefined(this.registrationOverlay, 'registrationOverlay');
+ assertIsDefined(this.registrationDialog, 'registrationDialog');
+ this.registrationOverlay.open();
+ this.registrationDialog.loadData().then(() => {
+ this.registrationOverlay!.refit();
});
}
// To fix bug announce read after each new view, we reset announce with
@@ -394,27 +650,28 @@
fireIronAnnounce(this, ' ');
}
- _handlePageError(e: CustomEvent<PageErrorEventDetail>) {
+ private handlePageError(e: CustomEvent<PageErrorEventDetail>) {
const props = [
- '_showChangeListView',
- '_showDashboardView',
- '_showChangeView',
- '_showDiffView',
- '_showSettingsView',
- '_showAdminView',
+ 'showChangeListView',
+ 'showDashboardView',
+ 'showChangeView',
+ 'showDiffView',
+ 'showSettingsView',
+ 'showAdminView',
];
for (const showProp of props) {
- this.set(showProp, false);
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ (this as any)[showProp as any] = false;
}
- this.$.errorView.classList.add('show');
+ this.errorView?.classList.add('show');
const response = e.detail.response;
const err: ErrorInfo = {
text: [response?.status, response?.statusText].join(' '),
};
if (response?.status === 404) {
err.emoji = '¯\\_(ツ)_/¯';
- this._lastError = err;
+ this.lastError = err;
} else {
err.emoji = 'o_O';
if (response) {
@@ -428,29 +685,29 @@
errorText: text,
trace,
});
- this._lastError = err;
+ this.lastError = err;
});
}
}
}
- _handleLocationChange(e: LocationChangeEvent) {
- this._updateLoginUrl();
+ private handleLocationChange(e: LocationChangeEvent) {
+ this.updateLoginUrl();
const hash = e.detail.hash.substring(1);
let pathname = e.detail.pathname;
if (pathname.startsWith('/c/') && Number(hash) > 0) {
pathname += '@' + hash;
}
- this._path = pathname;
+ this.path = pathname;
}
- _updateLoginUrl() {
+ private updateLoginUrl() {
const baseUrl = getBaseUrl();
if (baseUrl) {
// Strip the canonical path from the path since needing canonical in
// the path is unneeded and breaks the url.
- this._loginUrl =
+ this.loginUrl =
baseUrl +
'/login/' +
encodeURIComponent(
@@ -460,7 +717,7 @@
window.location.hash
);
} else {
- this._loginUrl =
+ this.loginUrl =
'/login/' +
encodeURIComponent(
window.location.pathname +
@@ -470,18 +727,15 @@
}
}
- @observe('params.*')
- _paramsChanged(
- paramsRecord: ElementPropertyDeepChange<GrAppElement, 'params'>
- ) {
- const params = paramsRecord.base;
+ // private but used in test
+ paramsChanged() {
const viewsToCheck = [GerritView.SEARCH, GerritView.DASHBOARD];
- if (params?.view && viewsToCheck.includes(params.view)) {
- this._lastSearchPage = location.pathname;
+ if (this.params?.view && viewsToCheck.includes(this.params.view)) {
+ this.lastSearchPage = location.pathname;
}
}
- _handleTitleChange(e: CustomEvent<TitleChangeEventDetail>) {
+ private handleTitleChange(e: CustomEvent<TitleChangeEventDetail>) {
if (e.detail.title) {
document.title = e.detail.title + ' · Gerrit Code Review';
} else {
@@ -489,98 +743,93 @@
}
}
- _handleDialogChange(e: CustomEvent<DialogChangeEventDetail>) {
+ private handleDialogChange(e: CustomEvent<DialogChangeEventDetail>) {
if (e.detail.canceled) {
- this._footerHeaderAriaHidden = false;
+ this.footerHeaderAriaHidden = false;
} else if (e.detail.opened) {
- this._footerHeaderAriaHidden = true;
+ this.footerHeaderAriaHidden = true;
}
}
- handleShowKeyboardShortcuts() {
+ private async handleShowKeyboardShortcuts() {
this.loadKeyboardShortcutsDialog = true;
- flush();
- (this.shadowRoot!.querySelector('#keyboardShortcuts') as GrOverlay).open();
+ await this.updateComplete;
+ assertIsDefined(this.keyboardShortcuts, 'keyboardShortcuts');
+ this.keyboardShortcuts.open();
}
- _showKeyboardShortcuts() {
+ private async showKeyboardShortcuts() {
// same shortcut should close the dialog if pressed again
// when dialog is open
this.loadKeyboardShortcutsDialog = true;
- flush();
- const keyboardShortcuts = this.shadowRoot!.querySelector(
- '#keyboardShortcuts'
- ) as GrOverlay;
- if (!keyboardShortcuts) return;
- if (keyboardShortcuts.opened) {
- keyboardShortcuts.cancel();
+ await this.updateComplete;
+ if (!this.keyboardShortcuts) return;
+ if (this.keyboardShortcuts.opened) {
+ this.keyboardShortcuts.cancel();
return;
}
- keyboardShortcuts.open();
- this._footerHeaderAriaHidden = true;
- this._mainAriaHidden = true;
+ this.keyboardShortcuts.open();
+ this.footerHeaderAriaHidden = true;
+ this.mainAriaHidden = true;
}
- _handleKeyboardShortcutDialogClose() {
- (
- this.shadowRoot!.querySelector('#keyboardShortcuts') as GrOverlay
- ).cancel();
+ private handleKeyboardShortcutDialogClose() {
+ assertIsDefined(this.keyboardShortcuts, 'keyboardShortcuts');
+ this.keyboardShortcuts.close();
}
onOverlayCanceled() {
- this._footerHeaderAriaHidden = false;
- this._mainAriaHidden = false;
+ this.footerHeaderAriaHidden = false;
+ this.mainAriaHidden = false;
}
- _handleAccountDetailUpdate() {
- this.$.mainHeader.reload();
+ private handleAccountDetailUpdate() {
+ this.mainHeader?.reload();
if (this.params?.view === GerritView.SETTINGS) {
- (
- this.shadowRoot!.querySelector('gr-settings-view') as GrSettingsView
- ).reloadAccountDetail();
+ assertIsDefined(this.settingdView, 'settingdView');
+ this.settingdView.reloadAccountDetail();
}
}
- _handleRegistrationDialogClose() {
+ private handleRegistrationDialogClose() {
// The registration dialog is visible only if this.params is
// instanceof AppElementJustRegisteredParams
(this.params as AppElementJustRegisteredParams).justRegistered = false;
- (
- this.shadowRoot!.querySelector('#registrationOverlay') as GrOverlay
- ).close();
+ assertIsDefined(this.registrationOverlay, 'registrationOverlay');
+ this.registrationOverlay.close();
}
- _goToOpenedChanges() {
+ private goToOpenedChanges() {
GerritNav.navigateToStatusSearch('open');
}
- _goToUserDashboard() {
+ private goToUserDashboard() {
GerritNav.navigateToUserDashboard();
}
- _goToMergedChanges() {
+ private goToMergedChanges() {
GerritNav.navigateToStatusSearch('merged');
}
- _goToAbandonedChanges() {
+ private goToAbandonedChanges() {
GerritNav.navigateToStatusSearch('abandoned');
}
- _goToWatchedChanges() {
+ private goToWatchedChanges() {
// The query is hardcoded, and doesn't respect custom menu entries
GerritNav.navigateToSearchQuery('is:watched is:open');
}
- _computePluginScreenName(params: AppElementParams) {
- if (params.view !== GerritView.PLUGIN_SCREEN) return '';
- if (!params.plugin || !params.screen) return '';
- return `${params.plugin}-screen-${params.screen}`;
+ private computePluginScreenName() {
+ if (this.params?.view !== GerritView.PLUGIN_SCREEN) return '';
+ if (!this.params.plugin || !this.params.screen) return '';
+ return `${this.params.plugin}-screen-${this.params.screen}`;
}
- _logWelcome() {
+ private logWelcome() {
console.group('Runtime Info');
console.info('Gerrit UI (PolyGerrit)');
- console.info(`Gerrit Server Version: ${this._version}`);
+ console.info(`Gerrit Server Version: ${this.version}`);
if (window.VERSION_INFO) {
console.info(`UI Version Info: ${window.VERSION_INFO}`);
}
@@ -592,11 +841,11 @@
* Note: the REST API interface cannot use gr-reporting directly because
* that would create a cyclic dependency.
*/
- _handleRpcLog(e: RpcLogEvent) {
+ private handleRpcLog(e: RpcLogEvent) {
this.reporting.reportRpcTiming(e.detail.anonymizedUrl, e.detail.elapsed);
}
- _mobileSearchToggle() {
+ private mobileSearchToggle() {
this.mobileSearch = !this.mobileSearch;
}
@@ -607,10 +856,20 @@
: 'app-theme-light';
}
- _handleViewStateChanged(e: ValueChangedEvent<ChangeListViewState>) {
- if (!this._viewState) return;
- this._viewState.changeListView = {
- ...this._viewState.changeListView,
+ private handleViewStateChanged(e: ValueChangedEvent<ChangeListViewState>) {
+ if (!this.viewState) return;
+ this.viewState.changeListView = {
+ ...this.viewState.changeListView,
+ ...e.detail.value,
+ };
+ }
+
+ private handleViewStateChangeViewChanged(
+ e: ValueChangedEvent<ChangeViewState>
+ ) {
+ if (!this.viewState) return;
+ this.viewState.changeView = {
+ ...this.viewState.changeView,
...e.detail.value,
};
}
diff --git a/polygerrit-ui/app/elements/gr-app-element_html.ts b/polygerrit-ui/app/elements/gr-app-element_html.ts
deleted file mode 100644
index 097f559..0000000
--- a/polygerrit-ui/app/elements/gr-app-element_html.ts
+++ /dev/null
@@ -1,233 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="shared-styles">
- :host {
- background-color: var(--background-color-tertiary);
- display: flex;
- flex-direction: column;
- min-height: 100%;
- }
- gr-main-header,
- footer {
- color: var(--primary-text-color);
- }
- gr-main-header {
- background: var(
- --header-background,
- var(--header-background-color, #eee)
- );
- padding: var(--header-padding);
- border-bottom: var(--header-border-bottom);
- border-image: var(--header-border-image);
- border-right: 0;
- border-left: 0;
- border-top: 0;
- box-shadow: var(--header-box-shadow);
- /* Make sure the header is above the main content, to preserve box-shadow
- visibility. We need 2 here instead of 1, because dropdowns in the
- header should be shown on top of the sticky diff header, which has a
- z-index of 1. */
- z-index: 2;
- }
- footer {
- background: var(
- --footer-background,
- var(--footer-background-color, #eee)
- );
- border-top: var(--footer-border-top);
- display: flex;
- justify-content: space-between;
- padding: var(--spacing-m) var(--spacing-l);
- z-index: 100;
- }
- main {
- flex: 1;
- padding-bottom: var(--spacing-xxl);
- position: relative;
- }
- .errorView {
- align-items: center;
- display: none;
- flex-direction: column;
- justify-content: center;
- position: absolute;
- top: 0;
- right: 0;
- bottom: 0;
- left: 0;
- }
- .errorView.show {
- display: flex;
- }
- .errorEmoji {
- font-size: 2.6rem;
- }
- .errorText,
- .errorMoreInfo {
- margin-top: var(--spacing-m);
- }
- .errorText {
- font-family: var(--header-font-family);
- font-size: var(--font-size-h3);
- font-weight: var(--font-weight-h3);
- line-height: var(--line-height-h3);
- }
- .errorMoreInfo {
- color: var(--deemphasized-text-color);
- }
- </style>
- <gr-endpoint-decorator name="banner"></gr-endpoint-decorator>
- <gr-main-header
- id="mainHeader"
- search-query="[[params.query]]"
- on-mobile-search="_mobileSearchToggle"
- on-show-keyboard-shortcuts="handleShowKeyboardShortcuts"
- mobile-search-hidden="[[!mobileSearch]]"
- login-url="[[_loginUrl]]"
- aria-hidden="[[_footerHeaderAriaHidden]]"
- >
- </gr-main-header>
- <main aria-hidden="[[_mainAriaHidden]]">
- <template is="dom-if" if="[[mobileSearch]]">
- <gr-smart-search
- id="search"
- label="Search for changes"
- search-query="[[params.query]]"
- server-config="[[_serverConfig]]"
- hidden="[[!mobileSearch]]"
- >
- </gr-smart-search>
- </template>
- <template is="dom-if" if="[[_showChangeListView]]" restamp="true">
- <gr-change-list-view
- params="[[params]]"
- account="[[_account]]"
- view-state="[[_viewState.changeListView]]"
- on-view-state-changed="_handleViewStateChanged"
- ></gr-change-list-view>
- </template>
- <template is="dom-if" if="[[_showDashboardView]]" restamp="true">
- <gr-dashboard-view
- account="[[_account]]"
- params="[[params]]"
- view-state="{{_viewState.dashboardView}}"
- ></gr-dashboard-view>
- </template>
- <!-- Note that the change view does not have restamp="true" set, because we
- want to re-use it as long as the change number does not change. -->
- <template id="dom-if-change-view" is="dom-if" if="[[_showChangeView]]">
- <gr-change-view
- params="[[params]]"
- view-state="{{_viewState.changeView}}"
- back-page="[[_lastSearchPage]]"
- ></gr-change-view>
- </template>
- <template is="dom-if" if="[[_showEditorView]]" restamp="true">
- <gr-editor-view params="[[params]]"></gr-editor-view>
- </template>
- <!-- Note that the diff view does not have restamp="true" set, because we
- want to re-use it as long as the change number does not change. -->
- <template id="dom-if-diff-view" is="dom-if" if="[[_showDiffView]]">
- <gr-diff-view
- params="[[params]]"
- change-view-state="{{_viewState.changeView}}"
- ></gr-diff-view>
- </template>
- <template is="dom-if" if="[[_showSettingsView]]" restamp="true">
- <gr-settings-view
- params="[[params]]"
- on-account-detail-update="_handleAccountDetailUpdate"
- >
- </gr-settings-view>
- </template>
- <template is="dom-if" if="[[_showAdminView]]" restamp="true">
- <gr-admin-view path="[[_path]]" params="[[params]]"></gr-admin-view>
- </template>
- <template is="dom-if" if="[[_showPluginScreen]]" restamp="true">
- <gr-endpoint-decorator name="[[_pluginScreenName]]">
- <gr-endpoint-param
- name="token"
- value="[[params.screen]]"
- ></gr-endpoint-param>
- </gr-endpoint-decorator>
- </template>
- <template is="dom-if" if="[[_showCLAView]]" restamp="true">
- <gr-cla-view></gr-cla-view>
- </template>
- <template is="dom-if" if="[[_showDocumentationSearch]]" restamp="true">
- <gr-documentation-search params="[[params]]"> </gr-documentation-search>
- </template>
- <div id="errorView" class="errorView">
- <div class="errorEmoji">[[_lastError.emoji]]</div>
- <div class="errorText">[[_lastError.text]]</div>
- <div class="errorMoreInfo">[[_lastError.moreInfo]]</div>
- </div>
- </main>
- <footer r="contentinfo" aria-hidden="[[_footerHeaderAriaHidden]]">
- <div>
- Powered by
- <a href="https://www.gerritcodereview.com/" rel="noopener" target="_blank"
- >Gerrit Code Review</a
- >
- ([[_version]])
- <gr-endpoint-decorator name="footer-left"></gr-endpoint-decorator>
- </div>
- <div>
- Press “?” for keyboard shortcuts
- <gr-endpoint-decorator name="footer-right"></gr-endpoint-decorator>
- </div>
- </footer>
- <template is="dom-if" if="[[loadKeyboardShortcutsDialog]]">
- <gr-overlay
- id="keyboardShortcuts"
- with-backdrop=""
- on-iron-overlay-canceled="onOverlayCanceled"
- >
- <gr-keyboard-shortcuts-dialog
- on-close="_handleKeyboardShortcutDialogClose"
- ></gr-keyboard-shortcuts-dialog>
- </gr-overlay>
- </template>
- <template is="dom-if" if="[[loadRegistrationDialog]]">
- <gr-overlay id="registrationOverlay" with-backdrop="">
- <gr-registration-dialog
- id="registrationDialog"
- settings-url="[[_settingsUrl]]"
- on-account-detail-update="_handleAccountDetailUpdate"
- on-close="_handleRegistrationDialogClose"
- >
- </gr-registration-dialog>
- </gr-overlay>
- </template>
- <gr-endpoint-decorator name="plugin-overlay"></gr-endpoint-decorator>
- <gr-error-manager
- id="errorManager"
- login-url="[[_loginUrl]]"
- ></gr-error-manager>
- <gr-plugin-host id="plugins" config="[[_serverConfig]]"> </gr-plugin-host>
- <gr-external-style
- id="externalStyleForAll"
- name="app-theme"
- ></gr-external-style>
- <gr-external-style
- id="externalStyleForTheme"
- name="[[getThemeEndpoint()]]"
- ></gr-external-style>
-`;
diff --git a/polygerrit-ui/app/elements/gr-app_test.ts b/polygerrit-ui/app/elements/gr-app_test.ts
index 74c4979..251f3ea 100644
--- a/polygerrit-ui/app/elements/gr-app_test.ts
+++ b/polygerrit-ui/app/elements/gr-app_test.ts
@@ -49,7 +49,7 @@
stubRestApi('probePath').returns(Promise.resolve(false));
grApp = await fixture<GrApp>(html`<gr-app id="app"></gr-app>`);
- await flush();
+ await grApp.updateComplete;
});
test('reporting', () => {
@@ -68,21 +68,13 @@
test('_paramsChanged sets search page', () => {
const grAppElement = queryAndAssert<GrAppElement>(grApp, '#app-element');
- const paramsForChangeView = createAppElementChangeViewParams();
- const paramsForSearchView = createAppElementSearchViewParams();
- grAppElement._paramsChanged({
- base: paramsForChangeView,
- value: paramsForChangeView,
- path: '',
- });
- assert.notOk(grAppElement._lastSearchPage);
+ grAppElement.params = createAppElementChangeViewParams();
+ grAppElement.paramsChanged();
+ assert.notOk(grAppElement.lastSearchPage);
- grAppElement._paramsChanged({
- base: paramsForSearchView,
- value: paramsForSearchView,
- path: '',
- });
- assert.ok(grAppElement._lastSearchPage);
+ grAppElement.params = createAppElementSearchViewParams();
+ grAppElement.paramsChanged();
+ assert.ok(grAppElement.lastSearchPage);
});
});
diff --git a/polygerrit-ui/app/elements/gr-css-mixins.ts b/polygerrit-ui/app/elements/gr-css-mixins.ts
new file mode 100644
index 0000000..7a57a17
--- /dev/null
+++ b/polygerrit-ui/app/elements/gr-css-mixins.ts
@@ -0,0 +1,69 @@
+/**
+ * @license
+ * 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.
+ */
+
+import {PolymerElement} from '@polymer/polymer/polymer-element';
+import {customElement} from '@polymer/decorators';
+import {html} from '@polymer/polymer/lib/utils/html-tag';
+
+@customElement('gr-css-mixins')
+export class GrCssMixins extends PolymerElement {
+ /* eslint-disable lit/prefer-static-styles */
+ static get template() {
+ return html`
+ <style>
+ :host {
+ /* If you want to use css-mixins in Lit elements, then you have to first
+ use them in a PolymerElement somewhere. We are collecting all css-
+ mixin usage here, but we may move them somewhere else later when
+ converting gr-app-element to Lit. In the Lit element you can then use
+ the css variables directly such as --paper-input-container_-_padding,
+ so you don't have to mess with mixins at all.
+ */
+ --paper-input-container: {
+ padding: 8px 0;
+ }
+ --paper-input-container-input: {
+ font-size: var(--font-size-normal);
+ line-height: var(--line-height-normal);
+ color: var(--primary-text-color);
+ }
+ --paper-input-container-underline: {
+ height: 0;
+ display: none;
+ }
+ --paper-input-container-underline-focus: {
+ height: 0;
+ display: none;
+ }
+ --paper-input-container-underline-disabled: {
+ height: 0;
+ display: none;
+ }
+ --paper-input-container-label: {
+ display: none;
+ }
+ }
+ </style>
+ `;
+ }
+}
+
+declare global {
+ interface HTMLElementTagNameMap {
+ 'gr-css-mixins': GrCssMixins;
+ }
+}
diff --git a/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator.ts b/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator.ts
index 8a01ef7..64548ac 100644
--- a/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator.ts
+++ b/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator.ts
@@ -1,39 +1,24 @@
/**
* @license
- * 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.
+ * Copyright 2017 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
*/
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-endpoint-decorator_html';
+import {html, LitElement} from 'lit';
+import {customElement, property} from 'lit/decorators';
import {
getPluginEndpoints,
ModuleInfo,
} from '../../shared/gr-js-api-interface/gr-plugin-endpoints';
import {getPluginLoader} from '../../shared/gr-js-api-interface/gr-plugin-loader';
-import {customElement, property} from '@polymer/decorators';
import {PluginApi} from '../../../api/plugin';
import {HookApi, PluginElement} from '../../../api/hook';
import {getAppContext} from '../../../services/app-context';
+import {assertIsDefined} from '../../../utils/common-util';
const INIT_PROPERTIES_TIMEOUT_MS = 10000;
@customElement('gr-endpoint-decorator')
-export class GrEndpointDecorator extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrEndpointDecorator extends LitElement {
/**
* If set, then this endpoint only invokes callbacks registered by the target
* plugin. For example this is used for the `check-result-expanded` endpoint.
@@ -43,39 +28,51 @@
@property({type: String})
targetPlugin?: string;
+ /** Required. */
@property({type: String})
- name!: string;
+ name?: string;
- @property({type: Object})
- _domHooks = new Map<PluginElement, HookApi<PluginElement>>();
+ private readonly domHooks = new Map<PluginElement, HookApi<PluginElement>>();
- @property({type: Object})
- _initializedPlugins = new Map<string, boolean>();
-
- /**
- * This is the callback that the plugin endpoint manager should be calling
- * when a new element is registered for this endpoint. It points to
- * _initModule().
- */
- _endpointCallBack: (info: ModuleInfo) => void = () => {};
+ private readonly initializedPlugins = new Map<string, boolean>();
private readonly reporting = getAppContext().reportingService;
+ override render() {
+ return html`<slot></slot>`;
+ }
+
+ override connectedCallback() {
+ super.connectedCallback();
+ assertIsDefined(this.name);
+ getPluginEndpoints().onNewEndpoint(this.name, this.initModule);
+ getPluginLoader()
+ .awaitPluginsLoaded()
+ .then(() => {
+ assertIsDefined(this.name);
+ const modules = getPluginEndpoints().getDetails(this.name);
+ for (const module of modules) {
+ this.initModule(module);
+ }
+ });
+ }
+
override disconnectedCallback() {
- for (const [el, domHook] of this._domHooks) {
+ for (const [el, domHook] of this.domHooks) {
domHook.handleInstanceDetached(el);
}
- getPluginEndpoints().onDetachedEndpoint(this.name, this._endpointCallBack);
+ assertIsDefined(this.name);
+ getPluginEndpoints().onDetachedEndpoint(this.name, this.initModule);
super.disconnectedCallback();
}
- _initDecoration(
+ private initDecoration(
name: string,
plugin: PluginApi,
slot?: string
): Promise<HTMLElement> {
const el = document.createElement(name) as PluginElement;
- return this._initProperties(
+ return this.initProperties(
el,
plugin,
// The direct children are slotted into <slot>, so this is identical to
@@ -88,13 +85,16 @@
if (slot && slotEl?.parentNode) {
slotEl.parentNode.insertBefore(el, slotEl.nextSibling);
} else {
- this._appendChild(el);
+ this.appendChild(el);
}
return el;
});
}
- _initReplacement(name: string, plugin: PluginApi): Promise<HTMLElement> {
+ private initReplacement(
+ name: string,
+ plugin: PluginApi
+ ): Promise<HTMLElement> {
// The direct children are slotted into <slot>, so they are identical to
// this.shadowRoot.querySelector('slot').assignedElements().
const directChildren = [...this.childNodes];
@@ -104,16 +104,16 @@
.filter(node => node.nodeName !== 'SLOT')
.forEach(node => node.remove());
const el = document.createElement(name);
- return this._initProperties(el, plugin).then((el: HTMLElement) =>
- this._appendChild(el)
+ return this.initProperties(el, plugin).then((el: HTMLElement) =>
+ this.appendChild(el)
);
}
- _getEndpointParams() {
+ private getEndpointParams() {
return Array.from(this.querySelectorAll('gr-endpoint-param'));
}
- _initProperties(
+ private initProperties(
el: PluginElement,
plugin: PluginApi,
content?: Element | null
@@ -128,7 +128,7 @@
if (content) {
el.content = content as HTMLElement;
}
- const expectProperties = this._getEndpointParams().map(paramEl => {
+ const expectProperties = this.getEndpointParams().map(paramEl => {
const helper = plugin.attributeHelper(paramEl);
// TODO: this should be replaced by accessing the property directly
const paramName = paramEl.getAttribute('name');
@@ -170,53 +170,40 @@
});
}
- _appendChild(el: HTMLElement): HTMLElement {
- if (!this.root) throw Error('plugin endpoint decorator missing root');
- return this.root.appendChild(el);
- }
-
- _initModule({moduleName, plugin, type, domHook, slot}: ModuleInfo) {
+ private readonly initModule = ({
+ moduleName,
+ plugin,
+ type,
+ domHook,
+ slot,
+ }: ModuleInfo) => {
const name = plugin.getPluginName() + '.' + moduleName;
if (this.targetPlugin) {
if (this.targetPlugin !== plugin.getPluginName()) return;
}
- if (this._initializedPlugins.get(name)) {
+ if (this.initializedPlugins.get(name)) {
return;
}
let initPromise;
switch (type) {
case 'decorate':
- initPromise = this._initDecoration(moduleName, plugin, slot);
+ initPromise = this.initDecoration(moduleName, plugin, slot);
break;
case 'replace':
- initPromise = this._initReplacement(moduleName, plugin);
+ initPromise = this.initReplacement(moduleName, plugin);
break;
}
if (!initPromise) {
throw Error(`unknown endpoint type ${type} used by plugin ${name}`);
}
- this._initializedPlugins.set(name, true);
+ this.initializedPlugins.set(name, true);
initPromise.then(el => {
if (domHook) {
domHook.handleInstanceAttached(el);
- this._domHooks.set(el, domHook);
+ this.domHooks.set(el, domHook);
}
});
- }
-
- override ready() {
- super.ready();
- if (!this.name) return;
- this._endpointCallBack = (info: ModuleInfo) => this._initModule(info);
- getPluginEndpoints().onNewEndpoint(this.name, this._endpointCallBack);
- getPluginLoader()
- .awaitPluginsLoaded()
- .then(() =>
- getPluginEndpoints()
- .getDetails(this.name)
- .forEach(this._initModule, this)
- );
- }
+ };
}
declare global {
diff --git a/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator_html.ts b/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator_html.ts
deleted file mode 100644
index 94196df..0000000
--- a/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator_html.ts
+++ /dev/null
@@ -1,19 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html` <slot></slot> `;
diff --git a/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator_test.ts b/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator_test.ts
index f5096ea..d7acc61 100644
--- a/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator_test.ts
+++ b/polygerrit-ui/app/elements/plugins/gr-endpoint-decorator/gr-endpoint-decorator_test.ts
@@ -1,60 +1,75 @@
/**
* @license
- * 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.
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
*/
-
import '../../../test/common-test-setup-karma';
import './gr-endpoint-decorator';
import '../gr-endpoint-param/gr-endpoint-param';
import '../gr-endpoint-slot/gr-endpoint-slot';
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-import {resetPlugins} from '../../../test/test-utils';
+import {fixture, html} from '@open-wc/testing-helpers';
+import {
+ mockPromise,
+ queryAndAssert,
+ resetPlugins,
+} from '../../../test/test-utils';
import {getPluginLoader} from '../../shared/gr-js-api-interface/gr-plugin-loader';
import {GrEndpointDecorator} from './gr-endpoint-decorator';
import {PluginApi} from '../../../api/plugin';
import {GrEndpointParam} from '../gr-endpoint-param/gr-endpoint-param';
-const basicFixture = fixtureFromTemplate(
- html`<div>
- <gr-endpoint-decorator name="first">
- <gr-endpoint-param name="someparam" value="barbar"></gr-endpoint-param>
- <p>
- <span>test slot</span>
- <gr-endpoint-slot name="test"></gr-endpoint-slot>
- </p>
- </gr-endpoint-decorator>
- <gr-endpoint-decorator name="second">
- <gr-endpoint-param name="someparam" value="foofoo"></gr-endpoint-param>
- </gr-endpoint-decorator>
- <gr-endpoint-decorator name="banana">
- <gr-endpoint-param name="someParam" value="yes"></gr-endpoint-param>
- </gr-endpoint-decorator>
- </div>`
-);
-
suite('gr-endpoint-decorator', () => {
- let container: GrEndpointDecorator;
+ let container: HTMLElement;
let plugin: PluginApi;
let decorationHook: any;
let decorationHookWithSlot: any;
let replacementHook: any;
+ let first: GrEndpointDecorator;
+ let second: GrEndpointDecorator;
+ let banana: GrEndpointDecorator;
setup(async () => {
resetPlugins();
- container = basicFixture.instantiate() as GrEndpointDecorator;
+ container = await fixture(
+ html`<div>
+ <gr-endpoint-decorator name="first">
+ <gr-endpoint-param
+ name="first-param"
+ .value=${'barbar'}
+ ></gr-endpoint-param>
+ <p>
+ <span>test slot</span>
+ <gr-endpoint-slot name="test"></gr-endpoint-slot>
+ </p>
+ </gr-endpoint-decorator>
+ <gr-endpoint-decorator name="second">
+ <gr-endpoint-param
+ name="second-param"
+ .value=${'foofoo'}
+ ></gr-endpoint-param>
+ </gr-endpoint-decorator>
+ <gr-endpoint-decorator name="banana">
+ <gr-endpoint-param
+ name="banana-param"
+ .value=${'yes'}
+ ></gr-endpoint-param>
+ </gr-endpoint-decorator>
+ </div>`
+ );
+ first = queryAndAssert<GrEndpointDecorator>(
+ container,
+ 'gr-endpoint-decorator[name="first"]'
+ );
+ second = queryAndAssert<GrEndpointDecorator>(
+ container,
+ 'gr-endpoint-decorator[name="second"]'
+ );
+ banana = queryAndAssert<GrEndpointDecorator>(
+ container,
+ 'gr-endpoint-decorator[name="banana"]'
+ );
+
window.Gerrit.install(
p => {
plugin = p;
@@ -64,18 +79,33 @@
);
// Decoration
decorationHook = plugin.registerCustomComponent('first', 'some-module');
+ const decorationHookPromise = mockPromise();
+ decorationHook.onAttached(() => decorationHookPromise.resolve());
+
+ // Decoration with slot
decorationHookWithSlot = plugin.registerCustomComponent(
'first',
'some-module-2',
{slot: 'test'}
);
+ const decorationHookSlotPromise = mockPromise();
+ decorationHookWithSlot.onAttached(() =>
+ decorationHookSlotPromise.resolve()
+ );
+
// Replacement
replacementHook = plugin.registerCustomComponent('second', 'other-module', {
replace: true,
});
+ const replacementHookPromise = mockPromise();
+ replacementHook.onAttached(() => replacementHookPromise.resolve());
+
// Mimic all plugins loaded.
getPluginLoader().loadPlugins([]);
- await flush();
+
+ await decorationHookPromise;
+ await decorationHookSlotPromise;
+ await replacementHookPromise;
});
teardown(() => {
@@ -89,17 +119,15 @@
assert.equal(endpoints.length, 3);
});
- test('decoration', () => {
- const element = container.querySelector(
- 'gr-endpoint-decorator[name="first"]'
- ) as GrEndpointDecorator;
- const modules = Array.from(element.root!.children).filter(
+ test('first decoration', () => {
+ const element = first;
+ const modules = Array.from(element.children).filter(
element => element.nodeName === 'SOME-MODULE'
);
assert.equal(modules.length, 1);
const [module] = modules;
assert.isOk(module);
- assert.equal((module as any)['someparam'], 'barbar');
+ assert.equal((module as any)['first-param'], 'barbar');
return decorationHook
.getLastAttached()
.then((element: any) => {
@@ -112,14 +140,12 @@
});
test('decoration with slot', () => {
- const element = container.querySelector(
- 'gr-endpoint-decorator[name="first"]'
- ) as GrEndpointDecorator;
+ const element = first;
const modules = [...element.querySelectorAll('some-module-2')];
assert.equal(modules.length, 1);
const [module] = modules;
assert.isOk(module);
- assert.equal((module as any)['someparam'], 'barbar');
+ assert.equal((module as any)['first-param'], 'barbar');
return decorationHookWithSlot
.getLastAttached()
.then((element: any) => {
@@ -132,14 +158,12 @@
});
test('replacement', () => {
- const element = container.querySelector(
- 'gr-endpoint-decorator[name="second"]'
- ) as GrEndpointDecorator;
- const module = Array.from(element.root!.children).find(
+ const element = second;
+ const module = Array.from(element.children).find(
element => element.nodeName === 'OTHER-MODULE'
);
assert.isOk(module);
- assert.equal((module as any)['someparam'], 'foofoo');
+ assert.equal((module as any)['second-param'], 'foofoo');
return replacementHook
.getLastAttached()
.then((element: any) => {
@@ -152,73 +176,92 @@
});
test('late registration', async () => {
- plugin.registerCustomComponent('banana', 'noob-noob');
- await flush();
- const element = container.querySelector(
- 'gr-endpoint-decorator[name="banana"]'
- ) as GrEndpointDecorator;
- const module = Array.from(element.root!.children).find(
+ const bananaHook = plugin.registerCustomComponent('banana', 'noob-noob');
+ const bananaHookPromise = mockPromise();
+ bananaHook.onAttached(() => bananaHookPromise.resolve());
+ await bananaHookPromise;
+
+ const element = banana;
+ const module = Array.from(element.children).find(
element => element.nodeName === 'NOOB-NOOB'
);
assert.isOk(module);
});
test('two modules', async () => {
- plugin.registerCustomComponent('banana', 'mod-one');
- plugin.registerCustomComponent('banana', 'mod-two');
- await flush();
- const element = container.querySelector(
- 'gr-endpoint-decorator[name="banana"]'
- ) as GrEndpointDecorator;
- const module1 = Array.from(element.root!.children).find(
+ const bananaHook1 = plugin.registerCustomComponent('banana', 'mod-one');
+ const bananaHookPromise1 = mockPromise();
+ bananaHook1.onAttached(() => bananaHookPromise1.resolve());
+ await bananaHookPromise1;
+
+ const bananaHook = plugin.registerCustomComponent('banana', 'mod-two');
+ const bananaHookPromise2 = mockPromise();
+ bananaHook.onAttached(() => bananaHookPromise2.resolve());
+ await bananaHookPromise2;
+
+ const element = banana;
+ const module1 = Array.from(element.children).find(
element => element.nodeName === 'MOD-ONE'
);
assert.isOk(module1);
- const module2 = Array.from(element.root!.children).find(
+ const module2 = Array.from(element.children).find(
element => element.nodeName === 'MOD-TWO'
);
assert.isOk(module2);
});
test('late param setup', async () => {
- const element = container.querySelector(
- 'gr-endpoint-decorator[name="banana"]'
- ) as GrEndpointDecorator;
- const param = element.querySelector('gr-endpoint-param') as GrEndpointParam;
+ let element = banana;
+ const param = queryAndAssert<GrEndpointParam>(element, 'gr-endpoint-param');
param['value'] = undefined;
- plugin.registerCustomComponent('banana', 'noob-noob');
- await flush();
- let module = Array.from(element.root!.children).find(
+ await param.updateComplete;
+
+ const bananaHook = plugin.registerCustomComponent('banana', 'noob-noob');
+ const bananaHookPromise = mockPromise();
+ bananaHook.onAttached(() => bananaHookPromise.resolve());
+
+ element = queryAndAssert<GrEndpointDecorator>(
+ container,
+ 'gr-endpoint-decorator[name="banana"]'
+ );
+ let module = Array.from(element.children).find(
element => element.nodeName === 'NOOB-NOOB'
);
// Module waits for param to be defined.
assert.isNotOk(module);
const value = {abc: 'def'};
param.value = value;
+ await param.updateComplete;
+ await bananaHookPromise;
- await flush();
- module = Array.from(element.root!.children).find(
+ module = Array.from(element.children).find(
element => element.nodeName === 'NOOB-NOOB'
);
assert.isOk(module);
- assert.strictEqual((module as any)['someParam'], value);
+ assert.strictEqual((module as any)['banana-param'], value);
});
test('param is bound', async () => {
- const element = container.querySelector(
- 'gr-endpoint-decorator[name="banana"]'
- ) as GrEndpointDecorator;
- const param = element.querySelector('gr-endpoint-param') as GrEndpointParam;
+ const element = banana;
+ const param = queryAndAssert<GrEndpointParam>(element, 'gr-endpoint-param');
const value1 = {abc: 'def'};
const value2 = {def: 'abc'};
param.value = value1;
- plugin.registerCustomComponent('banana', 'noob-noob');
- await flush();
- const module = Array.from(element.root!.children).find(
+ await param.updateComplete;
+
+ const bananaHook = plugin.registerCustomComponent('banana', 'noob-noob');
+ const bananaHookPromise = mockPromise();
+ bananaHook.onAttached(() => bananaHookPromise.resolve());
+ await bananaHookPromise;
+
+ const module = Array.from(element.children).find(
element => element.nodeName === 'NOOB-NOOB'
);
- assert.strictEqual((module as any)['someParam'], value1);
+ assert.isOk(module);
+ assert.strictEqual((module as any)['banana-param'], value1);
+
param.value = value2;
- assert.strictEqual((module as any)['someParam'], value2);
+ await param.updateComplete;
+ assert.strictEqual((module as any)['banana-param'], value2);
});
});
diff --git a/polygerrit-ui/app/elements/plugins/gr-endpoint-param/gr-endpoint-param.ts b/polygerrit-ui/app/elements/plugins/gr-endpoint-param/gr-endpoint-param.ts
index ee89c86..5a00c37 100644
--- a/polygerrit-ui/app/elements/plugins/gr-endpoint-param/gr-endpoint-param.ts
+++ b/polygerrit-ui/app/elements/plugins/gr-endpoint-param/gr-endpoint-param.ts
@@ -1,21 +1,10 @@
/**
* @license
- * 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.
+ * Copyright 2017 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
*/
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {customElement, property} from '@polymer/decorators';
+import {LitElement, PropertyValues} from 'lit';
+import {customElement, property} from 'lit/decorators';
declare global {
interface HTMLElementTagNameMap {
@@ -24,26 +13,18 @@
}
@customElement('gr-endpoint-param')
-export class GrEndpointParam extends PolymerElement {
- @property({type: String, reflectToAttribute: true})
+export class GrEndpointParam extends LitElement {
+ @property({type: String, reflect: true})
name = '';
- @property({
- type: Object,
- notify: true,
- observer: '_valueChanged',
- })
+ @property({type: Object})
value?: unknown;
- _valueChanged(value: unknown) {
- /* In polymer 2 the following change was made:
- "Property change notifications (property-changed events) aren't fired when
- the value changes as a result of a binding from the host"
- (see https://polymer-library.polymer-project.org/2.0/docs/about_20).
- To workaround this problem, we fire the event from the observer.
- In some cases this fire the event twice, but our code is
- ready for it.
- */
- this.dispatchEvent(new CustomEvent('value-changed', {detail: {value}}));
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('value')) {
+ this.dispatchEvent(
+ new CustomEvent('value-changed', {detail: {value: this.value}})
+ );
+ }
}
}
diff --git a/polygerrit-ui/app/elements/plugins/gr-endpoint-slot/gr-endpoint-slot.ts b/polygerrit-ui/app/elements/plugins/gr-endpoint-slot/gr-endpoint-slot.ts
index f15b046..d6d1866 100644
--- a/polygerrit-ui/app/elements/plugins/gr-endpoint-slot/gr-endpoint-slot.ts
+++ b/polygerrit-ui/app/elements/plugins/gr-endpoint-slot/gr-endpoint-slot.ts
@@ -1,21 +1,10 @@
/**
* @license
- * 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.
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
*/
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {customElement, property} from '@polymer/decorators';
+import {LitElement} from 'lit';
+import {customElement, property} from 'lit/decorators';
declare global {
interface HTMLElementTagNameMap {
@@ -28,7 +17,7 @@
* the registered element should appear inside of the endpoint.
*/
@customElement('gr-endpoint-slot')
-export class GrEndpointSlot extends PolymerElement {
+export class GrEndpointSlot extends LitElement {
@property({type: String})
name!: string;
}
@@ -40,6 +29,6 @@
* This should help catch errors when you assign an element without
* name to GrEndpointSlot type.
*/
-export interface GrEndpointSlot extends PolymerElement {
+export interface GrEndpointSlot extends LitElement {
name: string;
}
diff --git a/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info.ts b/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info.ts
index 6bf0780..bb6f256 100644
--- a/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info.ts
+++ b/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info.ts
@@ -19,89 +19,238 @@
import '../../shared/gr-date-formatter/gr-date-formatter';
import '../../../styles/gr-form-styles';
import '../../../styles/shared-styles';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-account-info_html';
-import {customElement, property, observe} from '@polymer/decorators';
import {AccountDetailInfo, ServerInfo} from '../../../types/common';
import {EditableAccountField} from '../../../constants/constants';
import {getAppContext} from '../../../services/app-context';
-import {fireEvent} from '../../../utils/event-util';
+import {fire, fireEvent} from '../../../utils/event-util';
+import {LitElement, css, html, nothing, PropertyValues} from 'lit';
+import {customElement, property, state} from 'lit/decorators';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {formStyles} from '../../../styles/gr-form-styles';
+import {when} from 'lit/directives/when';
+import {BindValueChangeEvent, ValueChangedEvent} from '../../../types/events';
@customElement('gr-account-info')
-export class GrAccountInfo extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrAccountInfo extends LitElement {
/**
* Fired when account details are changed.
*
* @event account-detail-update
*/
- @property({
- type: Boolean,
- notify: true,
- computed: '_computeUsernameMutable(_serverConfig, _account.username)',
- })
- usernameMutable?: boolean;
+ // private but used in test
+ @state() nameMutable?: boolean;
- @property({
- type: Boolean,
- notify: true,
- computed: '_computeNameMutable(_serverConfig)',
- })
- nameMutable?: boolean;
+ @property({type: Boolean}) hasUnsavedChanges = false;
- @property({
- type: Boolean,
- notify: true,
- computed:
- '_computeHasUnsavedChanges(_hasNameChange, ' +
- '_hasUsernameChange, _hasStatusChange, _hasDisplayNameChange)',
- })
- hasUnsavedChanges?: boolean;
+ // private but used in test
+ @state() hasNameChange = false;
- @property({type: Boolean})
- _hasNameChange?: boolean;
+ // private but used in test
+ @state() hasUsernameChange = false;
- @property({type: Boolean})
- _hasUsernameChange?: boolean;
+ // private but used in test
+ @state() hasDisplayNameChange = false;
- @property({type: Boolean})
- _hasDisplayNameChange?: boolean;
+ // private but used in test
+ @state() hasStatusChange = false;
- @property({type: Boolean})
- _hasStatusChange?: boolean;
+ // private but used in test
+ @state() loading = false;
- @property({type: Boolean})
- _loading = false;
+ @state() private saving = false;
- @property({type: Boolean})
- _saving = false;
+ // private but used in test
+ @state() account?: AccountDetailInfo;
- @property({type: Object})
- _account?: AccountDetailInfo;
+ // private but used in test
+ @state() serverConfig?: ServerInfo;
- @property({type: Object})
- _serverConfig?: ServerInfo;
+ // private but used in test
+ @state() username?: string;
- @property({type: String, observer: '_usernameChanged'})
- _username?: string;
-
- @property({type: String})
- _avatarChangeUrl = '';
+ @state() private avatarChangeUrl = '';
private readonly restApiService = getAppContext().restApiService;
+ static override styles = [
+ sharedStyles,
+ formStyles,
+ css`
+ gr-avatar {
+ height: 120px;
+ width: 120px;
+ margin-right: var(--spacing-xs);
+ vertical-align: -0.25em;
+ }
+ div section.hide {
+ display: none;
+ }
+ `,
+ ];
+
+ override render() {
+ if (!this.account || this.loading) return nothing;
+ return html`<div class="gr-form-styles">
+ <section>
+ <span class="title"></span>
+ <span class="value">
+ <gr-avatar .account=${this.account} imageSize="120"></gr-avatar>
+ </span>
+ </section>
+ ${when(
+ this.avatarChangeUrl,
+ () => html` <section>
+ <span class="title"></span>
+ <span class="value">
+ <a href=${this.avatarChangeUrl}> Change avatar </a>
+ </span>
+ </section>`
+ )}
+ <section>
+ <span class="title">ID</span>
+ <span class="value">${this.account._account_id}</span>
+ </section>
+ <section>
+ <span class="title">Email</span>
+ <span class="value">${this.account.email}</span>
+ </section>
+ <section>
+ <span class="title">Registered</span>
+ <span class="value">
+ <gr-date-formatter
+ withTooltip
+ .dateStr=${this.account.registered_on}
+ ></gr-date-formatter>
+ </span>
+ </section>
+ <section id="usernameSection">
+ <span class="title">Username</span>
+ ${when(
+ this.computeUsernameEditable(),
+ () => html`<span class="value">
+ <iron-input
+ @keydown=${this.handleKeydown}
+ .bindValue=${this.username}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ if (this.username === e.detail.value) return;
+ this.username = e.detail.value;
+ this.hasUsernameChange = true;
+ }}
+ id="usernameIronInput"
+ >
+ <input
+ id="usernameInput"
+ ?disabled=${this.saving}
+ @keydown=${this.handleKeydown}
+ />
+ </iron-input>
+ </span>`,
+ () => html`<span class="value">${this.username}</span>`
+ )}
+ </section>
+ <section id="nameSection">
+ <label class="title" for="nameInput">Full name</label>
+ ${when(
+ this.nameMutable,
+ () => html`<span class="value">
+ <iron-input
+ @keydown=${this.handleKeydown}
+ .bindValue=${this.account?.name}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ const oldAccount = this.account;
+ if (!oldAccount || oldAccount.name === e.detail.value) return;
+ this.account = {...oldAccount, name: e.detail.value};
+ this.hasNameChange = true;
+ }}
+ id="nameIronInput"
+ >
+ <input
+ id="nameInput"
+ ?disabled=${this.saving}
+ @keydown=${this.handleKeydown}
+ />
+ </iron-input>
+ </span>`,
+ () => html` <span class="value">${this.account?.name}</span>`
+ )}
+ </section>
+ <section>
+ <label class="title" for="displayNameInput">Display name</label>
+ <span class="value">
+ <iron-input
+ @keydown=${this.handleKeydown}
+ .bindValue=${this.account.display_name}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ const oldAccount = this.account;
+ if (!oldAccount || oldAccount.display_name === e.detail.value) {
+ return;
+ }
+ this.account = {...oldAccount, display_name: e.detail.value};
+ this.hasDisplayNameChange = true;
+ }}
+ >
+ <input
+ id="displayNameInput"
+ ?disabled=${this.saving}
+ @keydown=${this.handleKeydown}
+ />
+ </iron-input>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="statusInput">About me (e.g. employer)</label>
+ <span class="value">
+ <iron-input
+ id="statusIronInput"
+ @keydown=${this.handleKeydown}
+ .bindValue=${this.account?.status}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ const oldAccount = this.account;
+ if (!oldAccount || oldAccount.status === e.detail.value) return;
+ this.account = {...oldAccount, status: e.detail.value};
+ this.hasStatusChange = true;
+ }}
+ >
+ <input
+ id="statusInput"
+ ?disabled=${this.saving}
+ @keydown=${this.handleKeydown}
+ />
+ </iron-input>
+ </span>
+ </section>
+ </div>`;
+ }
+
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('serverConfig')) {
+ this.nameMutable = this.computeNameMutable();
+ }
+
+ if (
+ changedProperties.has('hasNameChange') ||
+ changedProperties.has('hasUsernameChange') ||
+ changedProperties.has('hasStatusChange') ||
+ changedProperties.has('hasDisplayNameChange')
+ ) {
+ this.hasUnsavedChanges = this.computeHasUnsavedChanges();
+ }
+ if (changedProperties.has('hasUnsavedChanges')) {
+ fire(this, 'unsaved-changes-changed', {
+ value: this.hasUnsavedChanges,
+ });
+ }
+ }
+
loadData() {
const promises = [];
- this._loading = true;
+ this.loading = true;
promises.push(
this.restApiService.getConfig().then(config => {
- this._serverConfig = config;
+ this.serverConfig = config;
})
);
@@ -110,26 +259,26 @@
promises.push(
this.restApiService.getAccount().then(account => {
if (!account) return;
- this._hasNameChange = false;
- this._hasUsernameChange = false;
- this._hasDisplayNameChange = false;
- this._hasStatusChange = false;
+ this.hasNameChange = false;
+ this.hasUsernameChange = false;
+ this.hasDisplayNameChange = false;
+ this.hasStatusChange = false;
// Provide predefined value for username to trigger computation of
// username mutability.
account.username = account.username || '';
- this._account = account;
- this._username = account.username;
+ this.account = account;
+ this.username = account.username;
})
);
promises.push(
this.restApiService.getAvatarChangeUrl().then(url => {
- this._avatarChangeUrl = url || '';
+ this.avatarChangeUrl = url || '';
})
);
return Promise.all(promises).then(() => {
- this._loading = false;
+ this.loading = false;
});
}
@@ -138,132 +287,90 @@
return Promise.resolve();
}
- this._saving = true;
+ this.saving = true;
// Set only the fields that have changed.
// Must be done in sequence to avoid race conditions (@see Issue 5721)
- return this._maybeSetName()
- .then(() => this._maybeSetUsername())
- .then(() => this._maybeSetDisplayName())
- .then(() => this._maybeSetStatus())
+ return this.maybeSetName()
+ .then(() => this.maybeSetUsername())
+ .then(() => this.maybeSetDisplayName())
+ .then(() => this.maybeSetStatus())
.then(() => {
- this._hasNameChange = false;
- this._hasDisplayNameChange = false;
- this._hasStatusChange = false;
- this._saving = false;
+ this.hasNameChange = false;
+ this.hasUsernameChange = false;
+ this.hasDisplayNameChange = false;
+ this.hasStatusChange = false;
+ this.saving = false;
fireEvent(this, 'account-detail-update');
});
}
- _maybeSetName() {
+ private maybeSetName() {
// Note that we are intentionally not acting on this._account.name being the
// empty string (which is falsy).
- return this._hasNameChange && this.nameMutable && this._account?.name
- ? this.restApiService.setAccountName(this._account.name)
+ return this.hasNameChange && this.nameMutable && this.account?.name
+ ? this.restApiService.setAccountName(this.account.name)
: Promise.resolve();
}
- _maybeSetUsername() {
+ private maybeSetUsername() {
// Note that we are intentionally not acting on this._username being the
// empty string (which is falsy).
- return this._hasUsernameChange && this.usernameMutable && this._username
- ? this.restApiService.setAccountUsername(this._username)
+ return this.hasUsernameChange &&
+ this.computeUsernameEditable() &&
+ this.username
+ ? this.restApiService.setAccountUsername(this.username)
: Promise.resolve();
}
- _maybeSetDisplayName() {
- return this._hasDisplayNameChange &&
- this._account?.display_name !== undefined
- ? this.restApiService.setAccountDisplayName(this._account.display_name)
+ private maybeSetDisplayName() {
+ return this.hasDisplayNameChange && this.account?.display_name !== undefined
+ ? this.restApiService.setAccountDisplayName(this.account.display_name)
: Promise.resolve();
}
- _maybeSetStatus() {
- return this._hasStatusChange && this._account?.status !== undefined
- ? this.restApiService.setAccountStatus(this._account.status)
+ private maybeSetStatus() {
+ return this.hasStatusChange && this.account?.status !== undefined
+ ? this.restApiService.setAccountStatus(this.account.status)
: Promise.resolve();
}
- _computeHasUnsavedChanges(
- nameChanged: boolean,
- usernameChanged: boolean,
- statusChanged: boolean,
- displayNameChanged: boolean
- ) {
+ private computeHasUnsavedChanges() {
return (
- nameChanged || usernameChanged || statusChanged || displayNameChanged
+ this.hasNameChange ||
+ this.hasUsernameChange ||
+ this.hasStatusChange ||
+ this.hasDisplayNameChange
);
}
- _computeUsernameMutable(config: ServerInfo, username?: string) {
- // Polymer 2: check for undefined
- if ([config, username].includes(undefined)) {
- return undefined;
- }
-
- // Username may not be changed once it is set.
+ // private but used in test
+ computeUsernameEditable() {
return (
- config.auth.editable_account_fields.includes(
+ !!this.serverConfig?.auth.editable_account_fields.includes(
EditableAccountField.USER_NAME
- ) && !username
+ ) && !this.account?.username
);
}
- _computeNameMutable(config: ServerInfo) {
- return config.auth.editable_account_fields.includes(
+ private computeNameMutable() {
+ return !!this.serverConfig?.auth.editable_account_fields.includes(
EditableAccountField.FULL_NAME
);
}
- @observe('_account.status')
- _statusChanged() {
- if (this._loading) {
- return;
- }
- this._hasStatusChange = true;
- }
-
- @observe('_account.display_name')
- _displayNameChanged() {
- if (this._loading) {
- return;
- }
- this._hasDisplayNameChange = true;
- }
-
- _usernameChanged() {
- if (this._loading || !this._account) {
- return;
- }
- this._hasUsernameChange =
- (this._account.username || '') !== (this._username || '');
- }
-
- @observe('_account.name')
- _nameChanged() {
- if (this._loading) {
- return;
- }
- this._hasNameChange = true;
- }
-
- _handleKeydown(e: KeyboardEvent) {
+ private handleKeydown(e: KeyboardEvent) {
if (e.keyCode === 13) {
// Enter
e.stopPropagation();
this.save();
}
}
-
- _hideAvatarChangeUrl(avatarChangeUrl: string) {
- if (!avatarChangeUrl) {
- return 'hide';
- }
-
- return '';
- }
}
declare global {
+ interface HTMLElementEventMap {
+ 'unsaved-changes-changed': ValueChangedEvent<boolean>;
+ }
interface HTMLElementTagNameMap {
'gr-account-info': GrAccountInfo;
}
diff --git a/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info_html.ts b/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info_html.ts
deleted file mode 100644
index a6ea1f6..0000000
--- a/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info_html.ts
+++ /dev/null
@@ -1,129 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="shared-styles">
- gr-avatar {
- height: 120px;
- width: 120px;
- margin-right: var(--spacing-xs);
- vertical-align: -0.25em;
- }
- div section.hide {
- display: none;
- }
- </style>
- <style include="gr-form-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <div class="gr-form-styles">
- <section>
- <span class="title"></span>
- <span class="value">
- <gr-avatar account="[[_account]]" imageSize="120"></gr-avatar>
- </span>
- </section>
- <section class$="[[_hideAvatarChangeUrl(_avatarChangeUrl)]]">
- <span class="title"></span>
- <span class="value">
- <a href$="[[_avatarChangeUrl]]"> Change avatar </a>
- </span>
- </section>
- <section>
- <span class="title">ID</span>
- <span class="value">[[_account._account_id]]</span>
- </section>
- <section>
- <span class="title">Email</span>
- <span class="value">[[_account.email]]</span>
- </section>
- <section>
- <span class="title">Registered</span>
- <span class="value">
- <gr-date-formatter
- withTooltip
- date-str="[[_account.registered_on]]"
- ></gr-date-formatter>
- </span>
- </section>
- <section id="usernameSection">
- <span class="title">Username</span>
- <span hidden$="[[usernameMutable]]" class="value">[[_username]]</span>
- <span hidden$="[[!usernameMutable]]" class="value">
- <iron-input
- on-keydown="_handleKeydown"
- bind-value="{{_username}}"
- id="usernameIronInput"
- >
- <input
- id="usernameInput"
- disabled="[[_saving]]"
- on-keydown="_handleKeydown"
- />
- </iron-input>
- </span>
- </section>
- <section id="nameSection">
- <label class="title" for="nameInput">Full name</label>
- <span hidden$="[[nameMutable]]" class="value">[[_account.name]]</span>
- <span hidden$="[[!nameMutable]]" class="value">
- <iron-input
- on-keydown="_handleKeydown"
- bind-value="{{_account.name}}"
- id="nameIronInput"
- >
- <input
- id="nameInput"
- disabled="[[_saving]]"
- on-keydown="_handleKeydown"
- />
- </iron-input>
- </span>
- </section>
- <section>
- <label class="title" for="displayNameInput">Display name</label>
- <span class="value">
- <iron-input
- on-keydown="_handleKeydown"
- bind-value="{{_account.display_name}}"
- >
- <input
- id="displayNameInput"
- disabled="[[_saving]]"
- on-keydown="_handleKeydown"
- />
- </iron-input>
- </span>
- </section>
- <section>
- <label class="title" for="statusInput">About me (e.g. employer)</label>
- <span class="value">
- <iron-input
- on-keydown="_handleKeydown"
- bind-value="{{_account.status}}"
- >
- <input
- id="statusInput"
- disabled="[[_saving]]"
- on-keydown="_handleKeydown"
- />
- </iron-input>
- </span>
- </section>
- </div>
-`;
diff --git a/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info_test.ts b/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info_test.ts
index a12d289..03ad8a5 100644
--- a/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info_test.ts
+++ b/polygerrit-ui/app/elements/settings/gr-account-info/gr-account-info_test.ts
@@ -17,18 +17,20 @@
import '../../../test/common-test-setup-karma';
import './gr-account-info';
-import {SinonSpyMember, stubRestApi} from '../../../test/test-utils';
+import {query, queryAll, stubRestApi} from '../../../test/test-utils';
import {GrAccountInfo} from './gr-account-info';
import {AccountDetailInfo, ServerInfo} from '../../../types/common';
import {
createAccountDetailWithId,
createAccountWithIdNameAndEmail,
+ createAuth,
createPreferences,
createServerInfo,
} from '../../../test/test-data-generators';
import {IronInputElement} from '@polymer/iron-input';
import {SinonStubbedMember} from 'sinon';
import {RestApiService} from '../../../services/gr-rest-api/gr-rest-api';
+import {EditableAccountField} from '../../../api/rest-api';
const basicFixture = fixtureFromElement('gr-account-info');
@@ -38,13 +40,13 @@
let config: ServerInfo;
function queryIronInput(selector: string): IronInputElement {
- const input = element.root?.querySelector<IronInputElement>(selector);
+ const input = query<IronInputElement>(element, selector);
if (!input) assert.fail(`<iron-input> with id ${selector} not found.`);
return input;
}
function valueOf(title: string): Element {
- const sections = element.root?.querySelectorAll('section') ?? [];
+ const sections = queryAll<HTMLElement>(element, 'section') ?? [];
let titleEl;
for (let i = 0; i < sections.length; i++) {
titleEl = sections[i].querySelector('.title');
@@ -66,7 +68,7 @@
element = basicFixture.instantiate();
await element.loadData();
- await flush();
+ await element.updateComplete;
});
test('renders', () => {
@@ -78,10 +80,6 @@
<gr-avatar hidden="" imagesize="120"></gr-avatar>
</span>
</section>
- <section class="hide">
- <span class="title"></span>
- <span class="value"><a href="">Change avatar</a></span>
- </section>
<section>
<span class="title">ID</span>
<span class="value">123</span>
@@ -99,20 +97,10 @@
<section id="usernameSection">
<span class="title">Username</span>
<span class="value"></span>
- <span class="value" hidden="true">
- <iron-input id="usernameIronInput">
- <input id="usernameInput" />
- </iron-input>
- </span>
</section>
<section id="nameSection">
<label class="title" for="nameInput">Full name</label>
<span class="value">User-123</span>
- <span class="value" hidden="true">
- <iron-input id="nameIronInput">
- <input id="nameInput" />
- </iron-input>
- </span>
</section>
<section>
<label class="title" for="displayNameInput">Display name</label>
@@ -127,7 +115,7 @@
About me (e.g. employer)
</label>
<span class="value">
- <iron-input>
+ <iron-input id="statusIronInput">
<input id="statusInput" />
</iron-input>
</span>
@@ -137,7 +125,7 @@
});
test('basic account info render', () => {
- assert.isFalse(element._loading);
+ assert.isFalse(element.loading);
assert.equal(valueOf('ID').textContent, `${account._account_id}`);
assert.equal(valueOf('Email').textContent, account.email);
@@ -145,55 +133,62 @@
});
test('full name render (immutable)', () => {
- const section = element.$.nameSection;
+ const section = query<HTMLElement>(element, '#nameSection')!;
const displaySpan = section.querySelectorAll('.value')[0];
const inputSpan = section.querySelectorAll('.value')[1];
assert.isFalse(element.nameMutable);
assert.isFalse(displaySpan.hasAttribute('hidden'));
assert.equal(displaySpan.textContent, account.name);
- assert.isTrue(inputSpan.hasAttribute('hidden'));
+ assert.isUndefined(inputSpan);
});
- test('full name render (mutable)', () => {
- element.set('_serverConfig', {
- auth: {editable_account_fields: ['FULL_NAME']},
- });
+ test('full name render (mutable)', async () => {
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ ...createAuth(),
+ editable_account_fields: [EditableAccountField.FULL_NAME],
+ },
+ };
- const section = element.$.nameSection;
- const displaySpan = section.querySelectorAll('.value')[0];
- const inputSpan = section.querySelectorAll('.value')[1];
+ await element.updateComplete;
+ const section = query<HTMLElement>(element, '#nameSection')!;
+ const inputSpan = section.querySelectorAll('.value')[0];
assert.isTrue(element.nameMutable);
- assert.isTrue(displaySpan.hasAttribute('hidden'));
assert.equal(queryIronInput('#nameIronInput').bindValue, account.name);
assert.isFalse(inputSpan.hasAttribute('hidden'));
});
test('username render (immutable)', () => {
- const section = element.$.usernameSection;
+ const section = query<HTMLElement>(element, '#usernameSection')!;
const displaySpan = section.querySelectorAll('.value')[0];
const inputSpan = section.querySelectorAll('.value')[1];
- assert.isFalse(element.usernameMutable);
+ assert.isFalse(element.computeUsernameEditable());
assert.isFalse(displaySpan.hasAttribute('hidden'));
assert.equal(displaySpan.textContent, account.username);
- assert.isTrue(inputSpan.hasAttribute('hidden'));
+ assert.isUndefined(inputSpan);
});
- test('username render (mutable)', () => {
- element.set('_serverConfig', {
- auth: {editable_account_fields: ['USER_NAME']},
- });
- element.set('_account.username', '');
- element.set('_username', '');
+ test('username render (mutable)', async () => {
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ ...createAuth(),
+ editable_account_fields: [EditableAccountField.USER_NAME],
+ },
+ };
+ element.account!.username = '';
+ element.username = '';
- const section = element.$.usernameSection;
- const displaySpan = section.querySelectorAll('.value')[0];
- const inputSpan = section.querySelectorAll('.value')[1];
+ await element.updateComplete;
- assert.isTrue(element.usernameMutable);
- assert.isTrue(displaySpan.hasAttribute('hidden'));
+ const section = query<HTMLElement>(element, '#usernameSection')!;
+ const inputSpan = section.querySelectorAll('.value')[0];
+
+ assert.isTrue(element.computeUsernameEditable());
assert.equal(
queryIronInput('#usernameIronInput').bindValue,
account.username
@@ -202,21 +197,23 @@
});
suite('account info edit', () => {
- let nameChangedSpy: SinonSpyMember<typeof element._nameChanged>;
- let usernameChangedSpy: SinonSpyMember<typeof element._usernameChanged>;
- let statusChangedSpy: SinonSpyMember<typeof element._statusChanged>;
let nameStub: SinonStubbedMember<RestApiService['setAccountName']>;
let usernameStub: SinonStubbedMember<RestApiService['setAccountUsername']>;
let statusStub: SinonStubbedMember<RestApiService['setAccountStatus']>;
- setup(() => {
- nameChangedSpy = sinon.spy(element, '_nameChanged');
- usernameChangedSpy = sinon.spy(element, '_usernameChanged');
- statusChangedSpy = sinon.spy(element, '_statusChanged');
- element.set('_serverConfig', {
- auth: {editable_account_fields: ['FULL_NAME', 'USER_NAME']},
- });
+ setup(async () => {
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ ...createAuth(),
+ editable_account_fields: [
+ EditableAccountField.FULL_NAME,
+ EditableAccountField.USER_NAME,
+ ],
+ },
+ };
+ await element.updateComplete;
nameStub = stubRestApi('setAccountName').resolves();
usernameStub = stubRestApi('setAccountUsername').resolves();
statusStub = stubRestApi('setAccountStatus').resolves();
@@ -226,10 +223,11 @@
assert.isTrue(element.nameMutable);
assert.isFalse(element.hasUnsavedChanges);
- element.set('_account.name', 'new name');
-
- assert.isTrue(nameChangedSpy.called);
- assert.isFalse(statusChangedSpy.called);
+ const statusInputEl = queryIronInput('#nameIronInput');
+ statusInputEl.bindValue = 'new name';
+ await element.updateComplete;
+ assert.isTrue(element.hasNameChange);
+ assert.isFalse(element.hasStatusChange);
assert.isTrue(element.hasUnsavedChanges);
await element.save();
@@ -241,14 +239,25 @@
});
test('username', async () => {
- element.set('_account.username', '');
- element._hasUsernameChange = false;
- assert.isTrue(element.usernameMutable);
+ element.account!.username = '';
+ element.username = 't';
+ element.hasUsernameChange = false;
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ ...createAuth(),
+ editable_account_fields: [EditableAccountField.USER_NAME],
+ },
+ };
+ await element.updateComplete;
+ assert.isTrue(element.computeUsernameEditable());
- element.set('_username', 'new username');
-
- assert.isTrue(usernameChangedSpy.called);
- assert.isFalse(statusChangedSpy.called);
+ const statusInputEl = queryIronInput('#usernameIronInput');
+ statusInputEl.bindValue = 'new username';
+ await element.updateComplete;
+ assert.isTrue(element.hasUsernameChange);
+ assert.isFalse(element.hasNameChange);
+ assert.isFalse(element.hasStatusChange);
assert.isTrue(element.hasUnsavedChanges);
await element.save();
@@ -262,10 +271,11 @@
test('status', async () => {
assert.isFalse(element.hasUnsavedChanges);
- element.set('_account.status', 'new status');
-
- assert.isFalse(nameChangedSpy.called);
- assert.isTrue(statusChangedSpy.called);
+ const statusInputEl = queryIronInput('#statusIronInput');
+ statusInputEl.bindValue = 'new status';
+ await element.updateComplete;
+ assert.isFalse(element.hasNameChange);
+ assert.isTrue(element.hasStatusChange);
assert.isTrue(element.hasUnsavedChanges);
await element.save();
@@ -278,17 +288,18 @@
});
suite('edit name and status', () => {
- let nameChangedSpy: SinonSpyMember<typeof element._nameChanged>;
- let statusChangedSpy: SinonSpyMember<typeof element._statusChanged>;
let nameStub: SinonStubbedMember<RestApiService['setAccountName']>;
let statusStub: SinonStubbedMember<RestApiService['setAccountStatus']>;
- setup(() => {
- nameChangedSpy = sinon.spy(element, '_nameChanged');
- statusChangedSpy = sinon.spy(element, '_statusChanged');
- element.set('_serverConfig', {
- auth: {editable_account_fields: ['FULL_NAME']},
- });
+ setup(async () => {
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ ...createAuth(),
+ editable_account_fields: [EditableAccountField.FULL_NAME],
+ },
+ };
+ await element.updateComplete;
nameStub = stubRestApi('setAccountName').resolves();
statusStub = stubRestApi('setAccountStatus').resolves();
@@ -299,13 +310,15 @@
assert.isTrue(element.nameMutable);
assert.isFalse(element.hasUnsavedChanges);
- element.set('_account.name', 'new name');
+ const inputEl = queryIronInput('#nameIronInput');
+ inputEl.bindValue = 'new name';
+ await element.updateComplete;
+ assert.isTrue(element.hasNameChange);
- assert.isTrue(nameChangedSpy.called);
-
- element.set('_account.status', 'new status');
-
- assert.isTrue(statusChangedSpy.called);
+ const statusInputEl = queryIronInput('#statusIronInput');
+ statusInputEl.bindValue = 'new status';
+ await element.updateComplete;
+ assert.isTrue(element.hasStatusChange);
assert.isTrue(element.hasUnsavedChanges);
@@ -320,18 +333,23 @@
});
suite('set status but read name', () => {
- let statusChangedSpy: SinonSpyMember<typeof element._statusChanged>;
let statusStub: SinonStubbedMember<RestApiService['setAccountStatus']>;
- setup(() => {
- statusChangedSpy = sinon.spy(element, '_statusChanged');
- element.set('_serverConfig', {auth: {editable_account_fields: []}});
+ setup(async () => {
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ ...createAuth(),
+ editable_account_fields: [],
+ },
+ };
+ await element.updateComplete;
statusStub = stubRestApi('setAccountStatus').resolves();
});
test('read full name but set status', async () => {
- const section = element.$.nameSection;
+ const section = query<HTMLElement>(element, '#nameSection')!;
const displaySpan = section.querySelectorAll('.value')[0];
const inputSpan = section.querySelectorAll('.value')[1];
@@ -341,11 +359,12 @@
assert.isFalse(displaySpan.hasAttribute('hidden'));
assert.equal(displaySpan.textContent, account.name);
- assert.isTrue(inputSpan.hasAttribute('hidden'));
+ assert.isUndefined(inputSpan);
- element.set('_account.status', 'new status');
-
- assert.isTrue(statusChangedSpy.called);
+ const inputEl = queryIronInput('#statusIronInput');
+ inputEl.bindValue = 'new status';
+ await element.updateComplete;
+ assert.isTrue(element.hasStatusChange);
assert.isTrue(element.hasUnsavedChanges);
@@ -356,27 +375,27 @@
});
});
- test('_usernameChanged compares usernames with loose equality', () => {
- element._account = createAccountDetailWithId();
- element._username = '';
- element._hasUsernameChange = false;
- element._loading = false;
- // _usernameChanged is an observer, but call it here after setting
- // _hasUsernameChange in the test to force recomputation.
- element._usernameChanged();
- flush();
+ test('_usernameChanged compares usernames with loose equality', async () => {
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ ...createAuth(),
+ editable_account_fields: [EditableAccountField.USER_NAME],
+ },
+ };
+ element.account = createAccountDetailWithId();
+ element.username = 't';
+ element.hasUsernameChange = false;
+ element.loading = false;
+ // usernameChanged is an observer, but call it here after setting
+ // hasUsernameChange in the test to force recomputation.
+ await element.updateComplete;
+ assert.isFalse(element.hasUsernameChange);
- assert.isFalse(element._hasUsernameChange);
+ const inputEl = queryIronInput('#usernameIronInput');
+ inputEl.bindValue = 'test';
+ await element.updateComplete;
- element.set('_username', 'test');
- flush();
-
- assert.isTrue(element._hasUsernameChange);
- });
-
- test('_hideAvatarChangeUrl', () => {
- assert.equal(element._hideAvatarChangeUrl(''), 'hide');
-
- assert.equal(element._hideAvatarChangeUrl('https://example.com'), '');
+ assert.isTrue(element.hasUsernameChange);
});
});
diff --git a/polygerrit-ui/app/elements/settings/gr-cla-view/gr-cla-view.ts b/polygerrit-ui/app/elements/settings/gr-cla-view/gr-cla-view.ts
index f429c22..c8c06c9 100644
--- a/polygerrit-ui/app/elements/settings/gr-cla-view/gr-cla-view.ts
+++ b/polygerrit-ui/app/elements/settings/gr-cla-view/gr-cla-view.ts
@@ -90,12 +90,6 @@
#claNewAgreementsLabel {
font-weight: var(--font-weight-bold);
}
- #claNewAgreement {
- display: none;
- }
- #claNewAgreement.show {
- display: block;
- }
.contributorAgreementButton {
font-weight: var(--font-weight-bold);
}
@@ -166,7 +160,7 @@
Please review the agreement.</a
>
</div>
- ${this.renderAgreementsTextBox()} ${this.computeHideAgreementTextbox()}
+ ${this.renderAgreementsTextBox()}
</div>
`;
}
@@ -223,14 +217,12 @@
// private but used in test
getAgreementsUrl(configUrl: string) {
if (!configUrl) return '';
- let url;
+
if (configUrl.startsWith('http:') || configUrl.startsWith('https:')) {
- url = configUrl;
- } else {
- url = getBaseUrl() + '/' + configUrl;
+ return configUrl;
}
- return url;
+ return `${getBaseUrl()}/${configUrl}`;
}
private readonly handleShowAgreement = (e: Event) => {
diff --git a/polygerrit-ui/app/elements/settings/gr-gpg-editor/gr-gpg-editor.ts b/polygerrit-ui/app/elements/settings/gr-gpg-editor/gr-gpg-editor.ts
index 3c54c59..97804946 100644
--- a/polygerrit-ui/app/elements/settings/gr-gpg-editor/gr-gpg-editor.ts
+++ b/polygerrit-ui/app/elements/settings/gr-gpg-editor/gr-gpg-editor.ts
@@ -15,7 +15,6 @@
* limitations under the License.
*/
import '@polymer/iron-autogrow-textarea/iron-autogrow-textarea';
-import '../../../styles/gr-form-styles';
import '../../shared/gr-button/gr-button';
import '../../shared/gr-copy-clipboard/gr-copy-clipboard';
import '../../shared/gr-overlay/gr-overlay';
@@ -26,8 +25,8 @@
import {getAppContext} from '../../../services/app-context';
import {css, html, LitElement} from 'lit';
import {customElement, property, query, state} from 'lit/decorators';
-import {sharedStyles} from '../../../styles/shared-styles';
import {formStyles} from '../../../styles/gr-form-styles';
+import {sharedStyles} from '../../../styles/shared-styles';
import {assertIsDefined} from '../../../utils/common-util';
import {BindValueChangeEvent} from '../../../types/events';
import {fire} from '../../../utils/event-util';
@@ -63,8 +62,8 @@
private readonly restApiService = getAppContext().restApiService;
static override styles = [
- sharedStyles,
formStyles,
+ sharedStyles,
css`
.keyHeader {
width: 9em;
@@ -84,6 +83,9 @@
#existing {
margin-bottom: var(--spacing-l);
}
+ iron-autogrow-textarea {
+ background-color: var(--view-background-color);
+ }
`,
];
diff --git a/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog.ts b/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog.ts
index 67ff0c4..6305639 100644
--- a/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog.ts
+++ b/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog.ts
@@ -17,22 +17,17 @@
import '@polymer/iron-input/iron-input';
import '../../../styles/gr-form-styles';
import '../../shared/gr-button/gr-button';
-import '../../../styles/shared-styles';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-registration-dialog_html';
-import {customElement, property, observe} from '@polymer/decorators';
import {ServerInfo, AccountDetailInfo} from '../../../types/common';
import {EditableAccountField} from '../../../constants/constants';
import {getAppContext} from '../../../services/app-context';
import {fireEvent} from '../../../utils/event-util';
-
-export interface GrRegistrationDialog {
- $: {
- name: HTMLInputElement;
- username: HTMLInputElement;
- displayName: HTMLInputElement;
- };
-}
+import {LitElement, css, html, PropertyValues} from 'lit';
+import {customElement, property, query, state} from 'lit/decorators';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {formStyles} from '../../../styles/gr-form-styles';
+import {when} from 'lit/directives/when';
+import {ifDefined} from 'lit/directives/if-defined';
+import {BindValueChangeEvent} from '../../../types/events';
declare global {
interface HTMLElementTagNameMap {
@@ -41,11 +36,7 @@
}
@customElement('gr-registration-dialog')
-export class GrRegistrationDialog extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrRegistrationDialog extends LitElement {
/**
* Fired when account details are changed.
*
@@ -57,171 +48,286 @@
*
* @event close
*/
- @property({type: String})
- settingsUrl?: string;
+ @query('#name') nameInput?: HTMLInputElement;
- @property({type: Object})
- _account: Partial<AccountDetailInfo> = {};
+ @query('#username') usernameInput?: HTMLInputElement;
- @property({type: Boolean})
- _loading = true;
+ @query('#displayName') displayName?: HTMLInputElement;
- @property({type: Boolean})
- _saving = false;
+ @property() settingsUrl?: string;
- @property({type: Object})
- _serverConfig?: ServerInfo;
+ @state() account: Partial<AccountDetailInfo> = {};
- @property({
- computed: '_computeUsernameMutable(_account.username)',
- type: Boolean,
- })
- _usernameMutable = false;
+ @state() loading = true;
- @property({type: Boolean})
- _hasUsernameChange?: boolean;
+ @state() saving = false;
- @property({type: String, observer: '_usernameChanged'})
- _username?: string;
+ @state() serverConfig?: ServerInfo;
- @property({
- type: Boolean,
- notify: true,
- computed: '_computeNameMutable(_serverConfig)',
- })
- _nameMutable?: boolean;
+ @state() usernameMutable = false;
- @property({type: Boolean})
- _hasNameChange?: boolean;
+ @state() hasUsernameChange?: boolean;
- @property({type: Boolean})
- _hasDisplayNameChange?: boolean;
+ @state() username?: string;
+
+ @state() nameMutable?: boolean;
+
+ @state() hasNameChange?: boolean;
+
+ @state() hasDisplayNameChange?: boolean;
private readonly restApiService = getAppContext().restApiService;
- override ready() {
- super.ready();
- this._ensureAttribute('role', 'dialog');
+ override connectedCallback() {
+ super.connectedCallback();
+ if (!this.getAttribute('role')) {
+ this.setAttribute('role', 'dialog');
+ }
+ }
+
+ static override styles = [
+ sharedStyles,
+ formStyles,
+ css`
+ :host {
+ display: block;
+ }
+ main {
+ max-width: 46em;
+ }
+ :host(.loading) main {
+ display: none;
+ }
+ .loadingMessage {
+ display: none;
+ font-style: italic;
+ }
+ :host(.loading) .loadingMessage {
+ display: block;
+ }
+ hr {
+ margin-top: var(--spacing-l);
+ margin-bottom: var(--spacing-l);
+ }
+ header {
+ border-bottom: 1px solid var(--border-color);
+ font-weight: var(--font-weight-bold);
+ margin-bottom: var(--spacing-l);
+ }
+ .container {
+ padding: var(--spacing-m) var(--spacing-xl);
+ }
+ footer {
+ display: flex;
+ justify-content: flex-end;
+ }
+ footer gr-button {
+ margin-left: var(--spacing-l);
+ }
+ input {
+ width: 20em;
+ }
+ `,
+ ];
+
+ override render() {
+ return html`<div class="container gr-form-styles">
+ <header>Please confirm your contact information</header>
+ <div class="loadingMessage">Loading...</div>
+ <main>
+ <p>
+ The following contact information was automatically obtained when you
+ signed in to the site. This information is used to display who you are
+ to others, and to send updates to code reviews you have either started
+ or subscribed to.
+ </p>
+ <hr />
+ <section>
+ <span class="title">Full Name</span>
+ ${when(
+ this.nameMutable,
+ () => html`<span class="value">
+ <iron-input
+ .bindValue=${this.account.name}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ const oldAccount = this.account;
+ if (!oldAccount || oldAccount.name === e.detail.value) return;
+ this.account = {...oldAccount, name: e.detail.value};
+ this.hasNameChange = true;
+ }}
+ >
+ <input id="name" ?disabled=${this.saving} />
+ </iron-input>
+ </span>`,
+ () => html`<span class="value">${this.account.name}</span>`
+ )}
+ </section>
+ <section>
+ <span class="title">Display Name</span>
+ <span class="value">
+ <iron-input
+ .bindValue=${this.account.display_name}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ const oldAccount = this.account;
+ if (!oldAccount || oldAccount.display_name === e.detail.value) {
+ return;
+ }
+ this.account = {...oldAccount, display_name: e.detail.value};
+ this.hasDisplayNameChange = true;
+ }}
+ >
+ <input id="displayName" ?disabled=${this.saving} />
+ </iron-input>
+ </span>
+ </section>
+ ${when(
+ this.computeUsernameEditable(),
+ () => html`<section>
+ <span class="title">Username</span>
+ ${when(
+ this.usernameMutable,
+ () => html` <span class="value">
+ <iron-input
+ .bindValue=${this.username}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ if (!this.usernameInput || this.username === e.detail.value)
+ return;
+ this.username = e.detail.value;
+ this.hasUsernameChange = true;
+ }}
+ >
+ <input id="username" ?disabled=${this.saving} />
+ </iron-input>
+ </span>`,
+ () => html`<span class="value">${this.username}</span>`
+ )}
+ </section>`
+ )}
+ <hr />
+ <p>
+ More configuration options for Gerrit may be found in the
+ <a @click=${this.close} href=${ifDefined(this.settingsUrl)}
+ >settings</a
+ >.
+ </p>
+ </main>
+ <footer>
+ <gr-button
+ id="closeButton"
+ link
+ ?disabled=${this.saving}
+ @click=${this.handleClose}
+ >Close</gr-button
+ >
+ <gr-button
+ id="saveButton"
+ primary
+ link
+ ?disabled=${this.computeSaveDisabled()}
+ @click=${this.handleSave}
+ >Save</gr-button
+ >
+ </footer>
+ </div>`;
+ }
+
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('account')) {
+ this.usernameMutable = !this.account.username;
+ }
+ if (changedProperties.has('serverConfig')) {
+ this.nameMutable = this.computeNameMutable();
+ }
+ if (changedProperties.has('loading')) {
+ this.classList.toggle('loading', this.loading);
+ }
}
loadData() {
- this._loading = true;
+ this.loading = true;
const loadAccount = this.restApiService.getAccount().then(account => {
if (!account) return;
- this._hasNameChange = false;
- this._hasUsernameChange = false;
- this._hasDisplayNameChange = false;
+ this.hasNameChange = false;
+ this.hasUsernameChange = false;
+ this.hasDisplayNameChange = false;
// Provide predefined value for username to trigger computation of
// username mutability.
account.username = account.username || '';
- this._account = account;
- this._username = account.username;
+ this.account = account;
+ this.username = account.username;
});
const loadConfig = this.restApiService.getConfig().then(config => {
- this._serverConfig = config;
+ this.serverConfig = config;
});
return Promise.all([loadAccount, loadConfig]).then(() => {
- this._loading = false;
+ this.loading = false;
});
}
- _usernameChanged() {
- if (this._loading || !this._account) {
- return;
- }
- this._hasUsernameChange =
- (this._account.username || '') !== (this._username || '');
- }
-
- @observe('_account.display_name')
- _displayNameChanged() {
- if (this._loading || !this._account) {
- return;
- }
- this._hasDisplayNameChange = true;
- }
-
- @observe('_account.name')
- _nameChanged() {
- if (this._loading || !this._account) {
- return;
- }
- this._hasNameChange = true;
- }
-
- _computeUsernameMutable(username?: string) {
- // Username may not be changed once it is set.
- return !username;
- }
-
- _computeUsernameEditable(config?: ServerInfo) {
- return !!config?.auth.editable_account_fields.includes(
+ // private but used in test
+ computeUsernameEditable() {
+ return !!this.serverConfig?.auth.editable_account_fields.includes(
EditableAccountField.USER_NAME
);
}
- _computeNameMutable(config: ServerInfo) {
- return config.auth.editable_account_fields.includes(
+ private computeNameMutable() {
+ return !!this.serverConfig?.auth.editable_account_fields.includes(
EditableAccountField.FULL_NAME
);
}
- _save() {
- this._saving = true;
+ // private but used in test
+ save() {
+ this.saving = true;
const promises = [];
// Note that we are intentionally not acting on this._username being the
// empty string (which is falsy).
- if (this._hasUsernameChange && this._usernameMutable && this._username) {
- promises.push(this.restApiService.setAccountUsername(this._username));
+ if (this.hasUsernameChange && this.usernameMutable && this.username) {
+ promises.push(this.restApiService.setAccountUsername(this.username));
}
- if (this._hasNameChange && this._nameMutable && this._account?.name) {
- promises.push(this.restApiService.setAccountName(this._account.name));
+ if (this.hasNameChange && this.nameMutable && this.account?.name) {
+ promises.push(this.restApiService.setAccountName(this.account.name));
}
- if (this._hasDisplayNameChange && this._account?.display_name) {
+ if (this.hasDisplayNameChange && this.account?.display_name) {
promises.push(
- this.restApiService.setAccountDisplayName(this._account.display_name)
+ this.restApiService.setAccountDisplayName(this.account.display_name)
);
}
return Promise.all(promises).then(() => {
- this._saving = false;
+ this.saving = false;
fireEvent(this, 'account-detail-update');
});
}
- _handleSave(e: Event) {
+ private handleSave(e: Event) {
e.preventDefault();
- this._save().then(() => this.close());
+ this.save().then(() => this.close());
}
- _handleClose(e: Event) {
+ private handleClose(e: Event) {
e.preventDefault();
this.close();
}
- close() {
- this._saving = true; // disable buttons indefinitely
+ private close() {
+ this.saving = true; // disable buttons indefinitely
fireEvent(this, 'close');
}
- _computeSaveDisabled(
- displayName?: string,
- name?: string,
- username?: string,
- saving?: boolean
- ) {
- return saving || (!displayName && !name && !username);
- }
-
- @observe('_loading')
- _loadingChanged() {
- this.classList.toggle('loading', this._loading);
+ // private but used in test
+ computeSaveDisabled() {
+ return (
+ this.saving ||
+ (!this.account?.display_name && !this.account.name && !this.username)
+ );
}
}
diff --git a/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog_html.ts b/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog_html.ts
deleted file mode 100644
index 4484631..0000000
--- a/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog_html.ts
+++ /dev/null
@@ -1,128 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="gr-form-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <style include="shared-styles">
- :host {
- display: block;
- }
- main {
- max-width: 46em;
- }
- :host(.loading) main {
- display: none;
- }
- .loadingMessage {
- display: none;
- font-style: italic;
- }
- :host(.loading) .loadingMessage {
- display: block;
- }
- hr {
- margin-top: var(--spacing-l);
- margin-bottom: var(--spacing-l);
- }
- header {
- border-bottom: 1px solid var(--border-color);
- font-weight: var(--font-weight-bold);
- margin-bottom: var(--spacing-l);
- }
- .container {
- padding: var(--spacing-m) var(--spacing-xl);
- }
- footer {
- display: flex;
- justify-content: flex-end;
- }
- footer gr-button {
- margin-left: var(--spacing-l);
- }
- input {
- width: 20em;
- }
- </style>
- <div class="container gr-form-styles">
- <header>Please confirm your contact information</header>
- <div class="loadingMessage">Loading...</div>
- <main>
- <p>
- The following contact information was automatically obtained when you
- signed in to the site. This information is used to display who you are
- to others, and to send updates to code reviews you have either started
- or subscribed to.
- </p>
- <hr />
- <section>
- <span class="title">Full Name</span>
- <span hidden$="[[_nameMutable]]" class="value">[[_account.name]]</span>
- <span hidden$="[[!_nameMutable]]" class="value">
- <iron-input bind-value="{{_account.name}}">
- <input id="name" disabled="[[_saving]]" />
- </iron-input>
- </span>
- </section>
- <section>
- <span class="title">Display Name</span>
- <span class="value">
- <iron-input bind-value="{{_account.display_name}}">
- <input id="displayName" disabled="[[_saving]]" />
- </iron-input>
- </span>
- </section>
- <template is="dom-if" if="[[_computeUsernameEditable(_serverConfig)]]">
- <section>
- <span class="title">Username</span>
- <span hidden$="[[_usernameMutable]]" class="value"
- >[[_username]]</span
- >
- <span hidden$="[[!_usernameMutable]]" class="value">
- <iron-input bind-value="{{_username}}">
- <input id="username" disabled="[[_saving]]" />
- </iron-input>
- </span>
- </section>
- </template>
- <hr />
- <p>
- More configuration options for Gerrit may be found in the
- <a on-click="close" href$="[[settingsUrl]]">settings</a>.
- </p>
- </main>
- <footer>
- <gr-button
- id="closeButton"
- link=""
- disabled="[[_saving]]"
- on-click="_handleClose"
- >Close</gr-button
- >
- <gr-button
- id="saveButton"
- primary=""
- link=""
- disabled="[[_computeSaveDisabled(_account.display_name, _account.name, _username, _saving)]]"
- on-click="_handleSave"
- >Save</gr-button
- >
- </footer>
- </div>
-`;
diff --git a/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog_test.ts b/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog_test.ts
index 78b7d60..4118a20 100644
--- a/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog_test.ts
+++ b/polygerrit-ui/app/elements/settings/gr-registration-dialog/gr-registration-dialog_test.ts
@@ -19,11 +19,13 @@
import {GrRegistrationDialog} from './gr-registration-dialog';
import {queryAndAssert, stubRestApi} from '../../../test/test-utils';
import {AccountDetailInfo, Timestamp} from '../../../types/common';
-import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
import {AuthType, EditableAccountField} from '../../../constants/constants';
-import {createServerInfo} from '../../../test/test-data-generators';
-
-const basicFixture = fixtureFromElement('gr-registration-dialog');
+import {
+ createAccountWithId,
+ createServerInfo,
+} from '../../../test/test-data-generators';
+import {fixture, html} from '@open-wc/testing-helpers';
+import {GrButton} from '../../shared/gr-button/gr-button';
suite('gr-registration-dialog tests', () => {
let element: GrRegistrationDialog;
@@ -31,7 +33,7 @@
let _listeners: {[key: string]: EventListenerOrEventListenerObject};
- setup(() => {
+ setup(async () => {
_listeners = {};
account = {
@@ -70,9 +72,12 @@
})
);
- element = basicFixture.instantiate();
+ element = await fixture<GrRegistrationDialog>(
+ html`<gr-registration-dialog></gr-registration-dialog>`
+ );
- return element.loadData();
+ await element.loadData();
+ await element.updateComplete;
});
teardown(() => {
@@ -92,7 +97,7 @@
function save() {
const promise = listen('account-detail-update');
- MockInteractions.tap(queryAndAssert(element, '#saveButton'));
+ queryAndAssert<GrButton>(element, '#saveButton').click();
return promise;
}
@@ -101,31 +106,103 @@
if (opt_action) {
opt_action();
} else {
- MockInteractions.tap(queryAndAssert(element, '#closeButton'));
+ queryAndAssert<GrButton>(element, '#closeButton').click();
}
return promise;
}
+ test('renders', () => {
+ // cannot format with /* HTML */, because it breaks test
+ expect(element).shadowDom.to.equal(/* HTML*/ `<div
+ class="container gr-form-styles"
+ >
+ <header>Please confirm your contact information</header>
+ <div class="loadingMessage">Loading...</div>
+ <main>
+ <p>
+ The following contact information was automatically obtained when you
+ signed in to the site. This information is used to display who you are
+ to others, and to send updates to code reviews you have either started
+ or subscribed to.
+ </p>
+ <hr />
+ <section>
+ <span class="title"> Full Name </span>
+ <span class="value">
+ <iron-input>
+ <input id="name">
+ </iron-input>
+ </span>
+ </section>
+ <section>
+ <span class="title"> Display Name </span>
+ <span class="value">
+ <iron-input> <input id="displayName" /> </iron-input>
+ </span>
+ </section>
+ <section>
+ <span class="title"> Username </span>
+ <span class="value">
+ <iron-input>
+ <input id="username">
+ </iron-input>
+ </span>
+ </section>
+ <hr />
+ <p>
+ More configuration options for Gerrit may be found in the
+ <a> settings </a> .
+ </p>
+ </main>
+ <footer>
+ <gr-button
+ aria-disabled="false"
+ id="closeButton"
+ link=""
+ role="button"
+ tabindex="0"
+ >
+ Close
+ </gr-button>
+ <gr-button
+ aria-disabled="false"
+ id="saveButton"
+ link=""
+ primary=""
+ role="button"
+ tabindex="0"
+ >
+ Save
+ </gr-button>
+ </footer>
+ </div>`);
+ });
+
test('fires the close event on close', async () => {
await close();
});
test('fires the close event on save', async () => {
- await close(() =>
- MockInteractions.tap(queryAndAssert(element, '#saveButton'))
- );
+ await close(() => {
+ queryAndAssert<GrButton>(element, '#saveButton').click();
+ });
});
test('saves account details', async () => {
- await flush();
+ await element.updateComplete;
- element.set('_account.username', '');
- element._hasUsernameChange = false;
- assert.isTrue(element._usernameMutable);
+ element.account.username = '';
+ element.hasUsernameChange = false;
+ await element.updateComplete;
+ assert.isTrue(element.usernameMutable);
- element.set('_username', 'new username');
- element.set('_account.name', 'new name');
- element.set('_account.display_name', 'new display name');
+ element.username = 'new username';
+ element.hasUsernameChange = true;
+ element.account.name = 'new name';
+ element.hasNameChange = true;
+ element.account.display_name = 'new display name';
+ element.hasDisplayNameChange = true;
+ await element.updateComplete;
// Nothing should be committed yet.
assert.equal(account.name, 'name');
@@ -139,39 +216,43 @@
assert.equal(account.display_name, 'new display name');
});
- test('save btn disabled', () => {
- const compute = element._computeSaveDisabled;
- assert.isTrue(compute('', '', '', false));
- assert.isFalse(compute('', '', 'test', false));
- assert.isFalse(compute('', 'test', '', false));
- assert.isFalse(compute('test', '', '', false));
- assert.isTrue(compute('test', 'test', 'test', true));
- assert.isFalse(compute('test', 'test', 'test', false));
+ test('save btn disabled', async () => {
+ element.account = {};
+ element.saving = false;
+ await element.updateComplete;
+ assert.isTrue(element.computeSaveDisabled());
+ element.account = {
+ ...createAccountWithId(),
+ display_name: 'test',
+ name: 'test',
+ };
+ element.username = 'test';
+ element.saving = true;
+ await element.updateComplete;
+ assert.isTrue(element.computeSaveDisabled());
+ element.saving = false;
+ await element.updateComplete;
+ assert.isFalse(element.computeSaveDisabled());
});
- test('_computeUsernameMutable', () => {
- assert.isTrue(element._computeUsernameMutable(undefined));
- assert.isFalse(element._computeUsernameMutable('abc'));
- });
-
- test('_computeUsernameEditable', () => {
- assert.isTrue(
- element._computeUsernameEditable({
- ...createServerInfo(),
- auth: {
- auth_type: AuthType.HTTP,
- editable_account_fields: [EditableAccountField.USER_NAME],
- },
- })
- );
- assert.isFalse(
- element._computeUsernameEditable({
- ...createServerInfo(),
- auth: {
- auth_type: AuthType.HTTP,
- editable_account_fields: [],
- },
- })
- );
+ test('_computeUsernameEditable', async () => {
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ auth_type: AuthType.HTTP,
+ editable_account_fields: [EditableAccountField.USER_NAME],
+ },
+ };
+ await element.updateComplete;
+ assert.isTrue(element.computeUsernameEditable());
+ element.serverConfig = {
+ ...createServerInfo(),
+ auth: {
+ auth_type: AuthType.HTTP,
+ editable_account_fields: [],
+ },
+ };
+ await element.updateComplete;
+ assert.isFalse(element.computeUsernameEditable());
});
});
diff --git a/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view.ts b/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view.ts
index 7a8a771..9c448d9 100644
--- a/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view.ts
+++ b/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view.ts
@@ -16,12 +16,6 @@
*/
import '@polymer/iron-input/iron-input';
import '@polymer/paper-toggle-button/paper-toggle-button';
-import '../../../styles/gr-font-styles';
-import '../../../styles/gr-form-styles';
-import '../../../styles/gr-menu-page-styles';
-import '../../../styles/gr-page-nav-styles';
-import '../../../styles/gr-paper-styles';
-import '../../../styles/shared-styles';
import '../../plugins/gr-endpoint-decorator/gr-endpoint-decorator';
import '../gr-change-table-editor/gr-change-table-editor';
import '../../shared/gr-button/gr-button';
@@ -39,10 +33,7 @@
import '../gr-menu-editor/gr-menu-editor';
import '../gr-ssh-editor/gr-ssh-editor';
import '../gr-watched-projects-editor/gr-watched-projects-editor';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-settings-view_html';
import {getDocsBaseUrl} from '../../../utils/url-util';
-import {customElement, property, observe} from '@polymer/decorators';
import {AppElementParams} from '../../gr-app-types';
import {GrAccountInfo} from '../gr-account-info/gr-account-info';
import {GrWatchedProjectsEditor} from '../gr-watched-projects-editor/gr-watched-projects-editor';
@@ -66,24 +57,22 @@
} from '../../../constants/constants';
import {columnNames} from '../../change-list/gr-change-list/gr-change-list';
import {windowLocationReload} from '../../../utils/dom-util';
-import {ValueChangedEvent} from '../../../types/events';
-
-const PREFS_SECTION_FIELDS: Array<keyof PreferencesInput> = [
- 'changes_per_page',
- 'date_format',
- 'time_format',
- 'email_strategy',
- 'diff_view',
- 'publish_comments_on_push',
- 'disable_keyboard_shortcuts',
- 'disable_token_highlighting',
- 'work_in_progress_by_default',
- 'default_base_for_merges',
- 'signed_off_by',
- 'email_format',
- 'size_bar_in_change_table',
- 'relative_date_in_change_table',
-];
+import {BindValueChangeEvent, ValueChangedEvent} from '../../../types/events';
+import {LitElement, css, html} from 'lit';
+import {
+ customElement,
+ property,
+ query,
+ queryAsync,
+ state,
+} from 'lit/decorators';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {paperStyles} from '../../../styles/gr-paper-styles';
+import {fontStyles} from '../../../styles/gr-font-styles';
+import {when} from 'lit/directives/when';
+import {pageNavStyles} from '../../../styles/gr-page-nav-styles';
+import {menuPageStyles} from '../../../styles/gr-menu-page-styles';
+import {formStyles} from '../../../styles/gr-form-styles';
const GERRIT_DOCS_BASE_URL =
'https://gerrit-review.googlesource.com/' + 'Documentation';
@@ -98,39 +87,8 @@
LocalPrefsToPrefs,
}
-export interface GrSettingsView {
- $: {
- accountInfo: GrAccountInfo;
- watchedProjectsEditor: GrWatchedProjectsEditor;
- groupList: GrGroupList;
- identities: GrIdentities;
- diffPrefs: GrDiffPreferences;
- sshEditor: GrSshEditor;
- gpgEditor: GrGpgEditor;
- emailEditor: GrEmailEditor;
- insertSignedOff: HTMLInputElement;
- workInProgressByDefault: HTMLInputElement;
- showSizeBarsInFileList: HTMLInputElement;
- publishCommentsOnPush: HTMLInputElement;
- disableKeyboardShortcuts: HTMLInputElement;
- disableTokenHighlighting: HTMLInputElement;
- relativeDateInChangeTable: HTMLInputElement;
- changesPerPageSelect: HTMLInputElement;
- dateTimeFormatSelect: HTMLInputElement;
- timeFormatSelect: HTMLInputElement;
- emailNotificationsSelect: HTMLInputElement;
- emailFormatSelect: HTMLInputElement;
- defaultBaseForMergesSelect: HTMLInputElement;
- diffViewSelect: HTMLInputElement;
- };
-}
-
@customElement('gr-settings-view')
-export class GrSettingsView extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrSettingsView extends LitElement {
/**
* Fired when the title of the page should change.
*
@@ -143,66 +101,106 @@
* @event show-alert
*/
- @property({type: Object})
- prefs: PreferencesInput = {};
+ @query('#accountInfo', true) accountInfo!: GrAccountInfo;
- @property({type: Object})
- params?: AppElementParams;
+ @query('#watchedProjectsEditor', true)
+ watchedProjectsEditor!: GrWatchedProjectsEditor;
- @property({type: Boolean})
- _accountInfoChanged?: boolean;
+ @query('#groupList', true) groupList!: GrGroupList;
- @property({type: Object})
- _localPrefs: PreferencesInput = {};
+ @query('#identities', true) identities!: GrIdentities;
- @property({type: Array})
- _localChangeTableColumns: string[] = [];
+ @query('#diffPrefs') diffPrefs!: GrDiffPreferences;
- @property({type: Boolean})
- _loading = true;
+ @queryAsync('#sshEditor') sshEditorPromise!: Promise<GrSshEditor>;
- @property({type: Boolean})
- _changeTableChanged = false;
+ @queryAsync('#gpgEditor') gpgEditorPromise!: Promise<GrGpgEditor>;
- @property({type: Boolean})
- _prefsChanged = false;
+ @query('#emailEditor', true) emailEditor!: GrEmailEditor;
- @property({type: Boolean})
- _diffPrefsChanged = false;
+ @query('#insertSignedOff') insertSignedOff!: HTMLInputElement;
- @property({type: Boolean})
- _watchedProjectsChanged = false;
+ @query('#workInProgressByDefault') workInProgressByDefault!: HTMLInputElement;
- @property({type: Boolean})
- _keysChanged = false;
+ @query('#showSizeBarsInFileList') showSizeBarsInFileList!: HTMLInputElement;
- @property({type: Boolean})
- _gpgKeysChanged = false;
+ @query('#publishCommentsOnPush') publishCommentsOnPush!: HTMLInputElement;
- @property({type: String})
- _newEmail?: string;
+ @query('#disableKeyboardShortcuts')
+ disableKeyboardShortcuts!: HTMLInputElement;
- @property({type: Boolean})
- _addingEmail = false;
+ @query('#disableTokenHighlighting')
+ disableTokenHighlighting!: HTMLInputElement;
- @property({type: String})
- _lastSentVerificationEmail?: string | null = null;
+ @query('#relativeDateInChangeTable')
+ relativeDateInChangeTable!: HTMLInputElement;
- @property({type: Object})
- _serverConfig?: ServerInfo;
+ @query('#changesPerPageSelect') changesPerPageSelect!: HTMLInputElement;
- @property({type: String})
- _docsBaseUrl?: string | null;
+ @query('#dateTimeFormatSelect') dateTimeFormatSelect!: HTMLInputElement;
- @property({type: Boolean})
- _emailsChanged = false;
+ @query('#timeFormatSelect') timeFormatSelect!: HTMLInputElement;
- @property({type: Boolean})
- _showNumber?: boolean;
+ @query('#emailNotificationsSelect')
+ emailNotificationsSelect!: HTMLInputElement;
- @property({type: Boolean})
- _isDark = false;
+ @query('#emailFormatSelect') emailFormatSelect!: HTMLInputElement;
+ @query('#defaultBaseForMergesSelect')
+ defaultBaseForMergesSelect!: HTMLInputElement;
+
+ @query('#diffViewSelect') diffViewSelect!: HTMLInputElement;
+
+ @state() prefs: PreferencesInput = {};
+
+ @property({type: Object}) params?: AppElementParams;
+
+ @state() private accountInfoChanged = false;
+
+ @state() private localPrefs: PreferencesInput = {};
+
+ // private but used in test
+ @state() localChangeTableColumns: string[] = [];
+
+ @state() private loading = true;
+
+ @state() private changeTableChanged = false;
+
+ // private but used in test
+ @state() prefsChanged = false;
+
+ @state() private diffPrefsChanged = false;
+
+ @state() private watchedProjectsChanged = false;
+
+ @state() private keysChanged = false;
+
+ @state() private gpgKeysChanged = false;
+
+ // private but used in test
+ @state() newEmail?: string;
+
+ // private but used in test
+ @state() addingEmail = false;
+
+ // private but used in test
+ @state() lastSentVerificationEmail?: string | null = null;
+
+ // private but used in test
+ @state() serverConfig?: ServerInfo;
+
+ // private but used in test
+ @state() docsBaseUrl?: string | null;
+
+ @state() private emailsChanged = false;
+
+ // private but used in test
+ @state() showNumber?: boolean;
+
+ // private but used in test
+ @state() isDark = false;
+
+ // private but used in test
public _testOnly_loadingPromise?: Promise<void>;
private readonly restApiService = getAppContext().restApiService;
@@ -213,14 +211,16 @@
// we need to manually calling scrollIntoView when hash changed
window.addEventListener('location-change', this.handleLocationChange);
fireTitleChange(this, 'Settings');
+ }
- this._isDark = !!window.localStorage.getItem('dark-theme');
+ override firstUpdated() {
+ this.isDark = !!window.localStorage.getItem('dark-theme');
const promises: Array<Promise<unknown>> = [
- this.$.accountInfo.loadData(),
- this.$.watchedProjectsEditor.loadData(),
- this.$.groupList.loadData(),
- this.$.identities.loadData(),
+ this.accountInfo.loadData(),
+ this.watchedProjectsEditor.loadData(),
+ this.groupList.loadData(),
+ this.identities.loadData(),
];
// TODO(dhruvsri): move this to the service
@@ -230,9 +230,9 @@
throw new Error('getPreferences returned undefined');
}
this.prefs = prefs;
- this._showNumber = !!prefs.legacycid_in_change_table;
- this._copyPrefs(CopyPrefsDirection.PrefsToLocalPrefs);
- this._localChangeTableColumns =
+ this.showNumber = !!prefs.legacycid_in_change_table;
+ this.copyPrefs(CopyPrefsDirection.PrefsToLocalPrefs);
+ this.localChangeTableColumns =
prefs.change_table.length === 0
? columnNames
: prefs.change_table.map(column =>
@@ -243,24 +243,24 @@
promises.push(
this.restApiService.getConfig().then(config => {
- this._serverConfig = config;
+ this.serverConfig = config;
const configPromises: Array<Promise<void>> = [];
- if (this._serverConfig && this._serverConfig.sshd) {
- configPromises.push(this.$.sshEditor.loadData());
+ if (this.serverConfig?.sshd) {
+ configPromises.push(
+ this.sshEditorPromise.then(sshEditor => sshEditor.loadData())
+ );
}
- if (
- this._serverConfig &&
- this._serverConfig.receive &&
- this._serverConfig.receive.enable_signed_push
- ) {
- configPromises.push(this.$.gpgEditor.loadData());
+ if (this.serverConfig?.receive?.enable_signed_push) {
+ configPromises.push(
+ this.gpgEditorPromise.then(gpgEditor => gpgEditor.loadData())
+ );
}
configPromises.push(
getDocsBaseUrl(config, this.restApiService).then(baseUrl => {
- this._docsBaseUrl = baseUrl;
+ this.docsBaseUrl = baseUrl;
})
);
@@ -280,34 +280,726 @@
if (message) {
fireAlert(this, message);
}
- this.$.emailEditor.loadData();
+ this.emailEditor.loadData();
})
);
} else {
- promises.push(this.$.emailEditor.loadData());
+ promises.push(this.emailEditor.loadData());
}
this._testOnly_loadingPromise = Promise.all(promises).then(() => {
- this._loading = false;
+ this.loading = false;
// Handle anchor tag for initial load
this.handleLocationChange();
});
}
+ static override styles = [
+ sharedStyles,
+ paperStyles,
+ fontStyles,
+ formStyles,
+ menuPageStyles,
+ pageNavStyles,
+ css`
+ :host {
+ color: var(--primary-text-color);
+ }
+ h2 {
+ font-family: var(--header-font-family);
+ font-size: var(--font-size-h2);
+ font-weight: var(--font-weight-h2);
+ line-height: var(--line-height-h2);
+ }
+ .newEmailInput {
+ width: 20em;
+ }
+ #email {
+ margin-bottom: var(--spacing-l);
+ }
+ .main section.darkToggle {
+ display: block;
+ }
+ .filters p,
+ .darkToggle p {
+ margin-bottom: var(--spacing-l);
+ }
+ .queryExample em {
+ color: violet;
+ }
+ .toggle {
+ align-items: center;
+ display: flex;
+ margin-bottom: var(--spacing-l);
+ margin-right: var(--spacing-l);
+ }
+ `,
+ ];
+
+ override render() {
+ const isLoading = this.loading || this.loading === undefined;
+ return html`<div class="loading" ?hidden=${!isLoading}>Loading...</div>
+ <div ?hidden=${isLoading}>
+ <gr-page-nav class="navStyles">
+ <ul>
+ <li><a href="#Profile">Profile</a></li>
+ <li><a href="#Preferences">Preferences</a></li>
+ <li><a href="#DiffPreferences">Diff Preferences</a></li>
+ <li><a href="#EditPreferences">Edit Preferences</a></li>
+ <li><a href="#Menu">Menu</a></li>
+ <li><a href="#ChangeTableColumns">Change Table Columns</a></li>
+ <li><a href="#Notifications">Notifications</a></li>
+ <li><a href="#EmailAddresses">Email Addresses</a></li>
+ ${when(
+ this.showHttpAuth(),
+ () =>
+ html`<li><a href="#HTTPCredentials">HTTP Credentials</a></li>`
+ )}
+ ${when(
+ this.serverConfig?.sshd,
+ () => html`<li><a href="#SSHKeys"> SSH Keys </a></li>`
+ )}
+ ${when(
+ this.serverConfig?.receive?.enable_signed_push,
+ () => html`<li><a href="#GPGKeys"> GPG Keys </a></li>`
+ )}
+ <li><a href="#Groups">Groups</a></li>
+ <li><a href="#Identities">Identities</a></li>
+ ${when(
+ this.serverConfig?.auth.use_contributor_agreements,
+ () => html`<li><a href="#Agreements">Agreements</a></li>`
+ )}
+ <li><a href="#MailFilters">Mail Filters</a></li>
+ <gr-endpoint-decorator name="settings-menu-item">
+ </gr-endpoint-decorator>
+ </ul>
+ </gr-page-nav>
+ <div class="main gr-form-styles">
+ <h1 class="heading-1">User Settings</h1>
+ <h2 id="Theme">Theme</h2>
+ <section class="darkToggle">
+ <div class="toggle">
+ <paper-toggle-button
+ aria-labelledby="darkThemeToggleLabel"
+ ?checked=${this.isDark}
+ @change=${this.handleToggleDark}
+ @click=${this.onTapDarkToggle}
+ ></paper-toggle-button>
+ <div id="darkThemeToggleLabel">Dark theme</div>
+ </div>
+ </section>
+ <h2
+ id="Profile"
+ class=${this.computeHeaderClass(this.accountInfoChanged)}
+ >
+ Profile
+ </h2>
+ <fieldset id="profile">
+ <gr-account-info
+ id="accountInfo"
+ ?hasUnsavedChanges=${this.accountInfoChanged}
+ @unsaved-changes-changed=${(e: ValueChangedEvent<boolean>) => {
+ this.accountInfoChanged = e.detail.value;
+ }}
+ ></gr-account-info>
+ <gr-button
+ @click=${() => {
+ this.accountInfo.save();
+ }}
+ ?disabled=${!this.accountInfoChanged}
+ >Save changes</gr-button
+ >
+ </fieldset>
+ <h2
+ id="Preferences"
+ class=${this.computeHeaderClass(this.prefsChanged)}
+ >
+ Preferences
+ </h2>
+ <fieldset id="preferences">
+ <section>
+ <label class="title" for="changesPerPageSelect"
+ >Changes per page</label
+ >
+ <span class="value">
+ <gr-select
+ .bindValue=${this.convertToString(
+ this.localPrefs.changes_per_page
+ )}
+ @change=${() => {
+ this.localPrefs.changes_per_page = Number(
+ this.changesPerPageSelect.value
+ ) as 10 | 25 | 50 | 100;
+ this.prefsChanged = true;
+ }}
+ >
+ <select id="changesPerPageSelect">
+ <option value="10">10 rows per page</option>
+ <option value="25">25 rows per page</option>
+ <option value="50">50 rows per page</option>
+ <option value="100">100 rows per page</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="dateTimeFormatSelect"
+ >Date/time format</label
+ >
+ <span class="value">
+ <gr-select
+ .bindValue=${this.convertToString(
+ this.localPrefs.date_format
+ )}
+ @change=${() => {
+ this.localPrefs.date_format = this.dateTimeFormatSelect
+ .value as DateFormat;
+ this.prefsChanged = true;
+ }}
+ >
+ <select id="dateTimeFormatSelect">
+ <option value="STD">Jun 3 ; Jun 3, 2016</option>
+ <option value="US">06/03 ; 06/03/16</option>
+ <option value="ISO">06-03 ; 2016-06-03</option>
+ <option value="EURO">3. Jun ; 03.06.2016</option>
+ <option value="UK">03/06 ; 03/06/2016</option>
+ </select>
+ </gr-select>
+ <gr-select
+ .bindValue=${this.convertToString(
+ this.localPrefs.time_format
+ )}
+ aria-label="Time Format"
+ @change=${() => {
+ this.localPrefs.time_format = this.timeFormatSelect
+ .value as TimeFormat;
+ this.prefsChanged = true;
+ }}
+ >
+ <select id="timeFormatSelect">
+ <option value="HHMM_12">4:10 PM</option>
+ <option value="HHMM_24">16:10</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="emailNotificationsSelect"
+ >Email notifications</label
+ >
+ <span class="value">
+ <gr-select
+ .bindValue=${this.convertToString(
+ this.localPrefs.email_strategy
+ )}
+ @change=${() => {
+ this.localPrefs.email_strategy = this
+ .emailNotificationsSelect.value as EmailStrategy;
+ this.prefsChanged = true;
+ }}
+ >
+ <select id="emailNotificationsSelect">
+ <option value="CC_ON_OWN_COMMENTS">Every comment</option>
+ <option value="ENABLED">
+ Only comments left by others
+ </option>
+ <option value="ATTENTION_SET_ONLY">
+ Only when I am in the attention set
+ </option>
+ <option value="DISABLED">None</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section
+ ?hidden=${!this.convertToString(this.localPrefs.email_format)}
+ >
+ <label class="title" for="emailFormatSelect">Email format</label>
+ <span class="value">
+ <gr-select
+ .bindValue=${this.convertToString(
+ this.localPrefs.email_format
+ )}
+ @change=${() => {
+ this.localPrefs.email_format = this.emailFormatSelect
+ .value as EmailFormat;
+ this.prefsChanged = true;
+ }}
+ >
+ <select id="emailFormatSelect">
+ <option value="HTML_PLAINTEXT">HTML and plaintext</option>
+ <option value="PLAINTEXT">Plaintext only</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section ?hidden=${!this.localPrefs.default_base_for_merges}>
+ <span class="title">Default Base For Merges</span>
+ <span class="value">
+ <gr-select
+ .bindValue=${this.convertToString(
+ this.localPrefs.default_base_for_merges
+ )}
+ @change=${() => {
+ this.localPrefs.default_base_for_merges = this
+ .defaultBaseForMergesSelect.value as DefaultBase;
+ this.prefsChanged = true;
+ }}
+ >
+ <select id="defaultBaseForMergesSelect">
+ <option value="AUTO_MERGE">Auto Merge</option>
+ <option value="FIRST_PARENT">First Parent</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="relativeDateInChangeTable"
+ >Show Relative Dates In Changes Table</label
+ >
+ <span class="value">
+ <input
+ id="relativeDateInChangeTable"
+ type="checkbox"
+ ?checked=${this.localPrefs.relative_date_in_change_table}
+ @change=${() => {
+ this.localPrefs.relative_date_in_change_table =
+ this.relativeDateInChangeTable.checked;
+ this.prefsChanged = true;
+ }}
+ />
+ </span>
+ </section>
+ <section>
+ <span class="title">Diff view</span>
+ <span class="value">
+ <gr-select
+ .bindValue=${this.convertToString(this.localPrefs.diff_view)}
+ @change=${() => {
+ this.localPrefs.diff_view = this.diffViewSelect
+ .value as DiffViewMode;
+ this.prefsChanged = true;
+ }}
+ >
+ <select id="diffViewSelect">
+ <option value="SIDE_BY_SIDE">Side by side</option>
+ <option value="UNIFIED_DIFF">Unified diff</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label for="showSizeBarsInFileList" class="title"
+ >Show size bars in file list</label
+ >
+ <span class="value">
+ <input
+ id="showSizeBarsInFileList"
+ type="checkbox"
+ ?checked=${this.localPrefs.size_bar_in_change_table}
+ @change=${() => {
+ this.localPrefs.size_bar_in_change_table =
+ this.showSizeBarsInFileList.checked;
+ this.prefsChanged = true;
+ }}
+ />
+ </span>
+ </section>
+ <section>
+ <label for="publishCommentsOnPush" class="title"
+ >Publish comments on push</label
+ >
+ <span class="value">
+ <input
+ id="publishCommentsOnPush"
+ type="checkbox"
+ ?checked=${this.localPrefs.publish_comments_on_push}
+ @change=${() => {
+ this.localPrefs.publish_comments_on_push =
+ this.publishCommentsOnPush.checked;
+ this.prefsChanged = true;
+ }}
+ />
+ </span>
+ </section>
+ <section>
+ <label for="workInProgressByDefault" class="title"
+ >Set new changes to "work in progress" by default</label
+ >
+ <span class="value">
+ <input
+ id="workInProgressByDefault"
+ type="checkbox"
+ ?checked=${this.localPrefs.work_in_progress_by_default}
+ @change=${() => {
+ this.localPrefs.work_in_progress_by_default =
+ this.workInProgressByDefault.checked;
+ this.prefsChanged = true;
+ }}
+ />
+ </span>
+ </section>
+ <section>
+ <label for="disableKeyboardShortcuts" class="title"
+ >Disable all keyboard shortcuts</label
+ >
+ <span class="value">
+ <input
+ id="disableKeyboardShortcuts"
+ type="checkbox"
+ ?checked=${this.localPrefs.disable_keyboard_shortcuts}
+ @change=${() => {
+ this.localPrefs.disable_keyboard_shortcuts =
+ this.disableKeyboardShortcuts.checked;
+ this.prefsChanged = true;
+ }}
+ />
+ </span>
+ </section>
+ <section>
+ <label for="disableTokenHighlighting" class="title"
+ >Disable token highlighting on hover</label
+ >
+ <span class="value">
+ <input
+ id="disableTokenHighlighting"
+ type="checkbox"
+ ?checked=${this.localPrefs.disable_token_highlighting}
+ @change=${() => {
+ this.localPrefs.disable_token_highlighting =
+ this.disableTokenHighlighting.checked;
+ this.prefsChanged = true;
+ }}
+ />
+ </span>
+ </section>
+ <section>
+ <label for="insertSignedOff" class="title">
+ Insert Signed-off-by Footer For Inline Edit Changes
+ </label>
+ <span class="value">
+ <input
+ id="insertSignedOff"
+ type="checkbox"
+ ?checked=${this.localPrefs.signed_off_by}
+ @change=${() => {
+ this.localPrefs.signed_off_by =
+ this.insertSignedOff.checked;
+ this.prefsChanged = true;
+ }}
+ />
+ </span>
+ </section>
+ <gr-button
+ id="savePrefs"
+ @click=${this.handleSavePreferences}
+ ?disabled=${!this.prefsChanged}
+ >Save changes</gr-button
+ >
+ </fieldset>
+ <h2
+ id="DiffPreferences"
+ class=${this.computeHeaderClass(this.diffPrefsChanged)}
+ >
+ Diff Preferences
+ </h2>
+ <fieldset id="diffPreferences">
+ <gr-diff-preferences
+ id="diffPrefs"
+ @has-unsaved-changes-changed=${(
+ e: ValueChangedEvent<boolean>
+ ) => {
+ this.diffPrefsChanged = e.detail.value;
+ }}
+ ></gr-diff-preferences>
+ <gr-button
+ id="saveDiffPrefs"
+ @click=${() => {
+ this.diffPrefs.save();
+ }}
+ ?disabled=${!this.diffPrefsChanged}
+ >Save changes</gr-button
+ >
+ </fieldset>
+ <gr-edit-preferences id="EditPreferences"></gr-edit-preferences>
+ <gr-menu-editor id="Menu"></gr-menu-editor>
+ <h2
+ id="ChangeTableColumns"
+ class=${this.computeHeaderClass(this.changeTableChanged)}
+ >
+ Change Table Columns
+ </h2>
+ <fieldset id="changeTableColumns">
+ <gr-change-table-editor
+ .showNumber=${this.showNumber}
+ @show-number-changed=${(e: ValueChangedEvent<boolean>) => {
+ this.showNumber = e.detail.value;
+ this.changeTableChanged = true;
+ }}
+ .serverConfig=${this.serverConfig}
+ .displayedColumns=${this.localChangeTableColumns}
+ @displayed-columns-changed=${(e: ValueChangedEvent<string[]>) => {
+ this.localChangeTableColumns = e.detail.value;
+ this.changeTableChanged = true;
+ }}
+ >
+ </gr-change-table-editor>
+ <gr-button
+ id="saveChangeTable"
+ @click=${this.handleSaveChangeTable}
+ ?disabled=${!this.changeTableChanged}
+ >Save changes</gr-button
+ >
+ </fieldset>
+ <h2
+ id="Notifications"
+ class=${this.computeHeaderClass(this.watchedProjectsChanged)}
+ >
+ Notifications
+ </h2>
+ <fieldset id="watchedProjects">
+ <gr-watched-projects-editor
+ ?hasUnsavedChanges=${this.watchedProjectsChanged}
+ @has-unsaved-changes-changed=${(
+ e: ValueChangedEvent<boolean>
+ ) => {
+ this.watchedProjectsChanged = e.detail.value;
+ }}
+ id="watchedProjectsEditor"
+ ></gr-watched-projects-editor>
+ <gr-button
+ @click=${() => {
+ this.watchedProjectsEditor.save();
+ }}
+ ?disabled=${!this.watchedProjectsChanged}
+ id="_handleSaveWatchedProjects"
+ >Save changes</gr-button
+ >
+ </fieldset>
+ <h2
+ id="EmailAddresses"
+ class=${this.computeHeaderClass(this.emailsChanged)}
+ >
+ Email Addresses
+ </h2>
+ <fieldset id="email">
+ <gr-email-editor
+ id="emailEditor"
+ ?hasUnsavedChanges=${this.emailsChanged}
+ @has-unsaved-changes-changed=${(
+ e: ValueChangedEvent<boolean>
+ ) => {
+ this.emailsChanged = e.detail.value;
+ }}
+ ></gr-email-editor>
+ <gr-button
+ @click=${() => {
+ this.emailEditor.save();
+ }}
+ ?disabled=${!this.emailsChanged}
+ >Save changes</gr-button
+ >
+ </fieldset>
+ <fieldset id="newEmail">
+ <section>
+ <span class="title">New email address</span>
+ <span class="value">
+ <iron-input
+ class="newEmailInput"
+ .bindValue=${this.newEmail}
+ @bind-value-changed=${(e: BindValueChangeEvent) => {
+ this.newEmail = e.detail.value;
+ }}
+ @keydown=${this.handleNewEmailKeydown}
+ >
+ <input
+ class="newEmailInput"
+ type="text"
+ ?disabled=${this.addingEmail}
+ @keydown=${this.handleNewEmailKeydown}
+ placeholder="email@example.com"
+ />
+ </iron-input>
+ </span>
+ </section>
+ <section
+ id="verificationSentMessage"
+ ?hidden=${!this.lastSentVerificationEmail}
+ >
+ <p>
+ A verification email was sent to
+ <em>${this.lastSentVerificationEmail}</em>. Please check your
+ inbox.
+ </p>
+ </section>
+ <gr-button
+ ?disabled=${!this.computeAddEmailButtonEnabled()}
+ @click=${this.handleAddEmailButton}
+ >Send verification</gr-button
+ >
+ </fieldset>
+ ${when(
+ this.showHttpAuth(),
+ () => html` <div>
+ <h2 id="HTTPCredentials">HTTP Credentials</h2>
+ <fieldset>
+ <gr-http-password id="httpPass"></gr-http-password>
+ </fieldset>
+ </div>`
+ )}
+ ${when(
+ this.serverConfig?.sshd,
+ () => html`<h2
+ id="SSHKeys"
+ class=${this.computeHeaderClass(this.keysChanged)}
+ >
+ SSH keys
+ </h2>
+ <gr-ssh-editor
+ id="sshEditor"
+ ?hasUnsavedChanges=${this.keysChanged}
+ @has-unsaved-changes-changed=${(
+ e: ValueChangedEvent<boolean>
+ ) => {
+ this.keysChanged = e.detail.value;
+ }}
+ ></gr-ssh-editor>`
+ )}
+ ${when(
+ this.serverConfig?.receive?.enable_signed_push,
+ () => html`<div>
+ <h2
+ id="GPGKeys"
+ class=${this.computeHeaderClass(this.gpgKeysChanged)}
+ >
+ GPG keys
+ </h2>
+ <gr-gpg-editor
+ id="gpgEditor"
+ ?hasUnsavedChanges=${this.gpgKeysChanged}
+ @has-unsaved-changes-changed=${(
+ e: ValueChangedEvent<boolean>
+ ) => {
+ this.gpgKeysChanged = e.detail.value;
+ }}
+ ></gr-gpg-editor>
+ </div>`
+ )}
+ <h2 id="Groups">Groups</h2>
+ <fieldset>
+ <gr-group-list id="groupList"></gr-group-list>
+ </fieldset>
+ <h2 id="Identities">Identities</h2>
+ <fieldset>
+ <gr-identities
+ id="identities"
+ .serverConfig=${this.serverConfig}
+ ></gr-identities>
+ </fieldset>
+ ${when(
+ this.serverConfig?.auth.use_contributor_agreements,
+ () => html`<h2 id="Agreements">Agreements</h2>
+ <fieldset>
+ <gr-agreements-list id="agreementsList"></gr-agreements-list>
+ </fieldset>`
+ )}
+ <h2 id="MailFilters">Mail Filters</h2>
+ <fieldset class="filters">
+ <p>
+ Gerrit emails include metadata about the change to support writing
+ mail filters.
+ </p>
+ <p>
+ Here are some example Gmail queries that can be used for filters
+ or for searching through archived messages. View the
+ <a
+ href=${this.getFilterDocsLink(this.docsBaseUrl)}
+ target="_blank"
+ rel="nofollow"
+ >Gerrit documentation</a
+ >
+ for the complete set of footers.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <th>Name</th>
+ <th>Query</th>
+ </tr>
+ <tr>
+ <td>Changes requesting my review</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Reviewer: <em>Your Name</em>
+ <<em>your.email@example.com</em>>"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Changes requesting my attention</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Attention: <em>Your Name</em>
+ <<em>your.email@example.com</em>>"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Changes from a specific owner</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Owner: <em>Owner name</em>
+ <<em>owner.email@example.com</em>>"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Changes targeting a specific branch</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Branch: <em>branch-name</em>"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Changes in a specific project</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Project: <em>project-name</em>"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Messages related to a specific Change ID</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Change-Id: <em>Change ID</em>"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Messages related to a specific change number</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Change-Number: <em>change number</em>"
+ </code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </fieldset>
+ <gr-endpoint-decorator name="settings-screen">
+ </gr-endpoint-decorator>
+ </div>
+ </div>`;
+ }
+
override disconnectedCallback() {
window.removeEventListener('location-change', this.handleLocationChange);
super.disconnectedCallback();
}
- handleUnsavedChangesChanged(e: ValueChangedEvent) {
- this._keysChanged = !!e.detail.value;
- }
-
- _handleGpgEditorHasSavedChanges(e: ValueChangedEvent<boolean>) {
- this._gpgKeysChanged = e.detail.value;
- }
-
private readonly handleLocationChange = () => {
// Handle anchor tag after dom attached
const urlHash = window.location.hash;
@@ -321,176 +1013,82 @@
};
reloadAccountDetail() {
- Promise.all([this.$.accountInfo.loadData(), this.$.emailEditor.loadData()]);
+ Promise.all([this.accountInfo.loadData(), this.emailEditor.loadData()]);
}
- _isLoading() {
- return this._loading || this._loading === undefined;
- }
-
- _copyPrefs(direction: CopyPrefsDirection) {
- let to;
- let from;
+ private copyPrefs(direction: CopyPrefsDirection) {
if (direction === CopyPrefsDirection.LocalPrefsToPrefs) {
- from = this._localPrefs;
- to = 'prefs';
+ this.prefs = {
+ ...this.localPrefs,
+ };
} else {
- from = this.prefs;
- to = '_localPrefs';
- }
- for (let i = 0; i < PREFS_SECTION_FIELDS.length; i++) {
- this.set([to, PREFS_SECTION_FIELDS[i]], from[PREFS_SECTION_FIELDS[i]]);
+ this.localPrefs = {
+ ...this.prefs,
+ };
}
}
- @observe('_localChangeTableColumns', '_showNumber')
- _handleChangeTableChanged() {
- if (this._isLoading()) {
- return;
- }
- this._changeTableChanged = true;
- }
-
- @observe('_localPrefs.*')
- _handlePrefsChanged() {
- if (this._isLoading()) {
- return;
- }
- this._prefsChanged = true;
- }
-
- _handleRelativeDateInChangeTable() {
- this.set(
- '_localPrefs.relative_date_in_change_table',
- this.$.relativeDateInChangeTable.checked
- );
- }
-
- _handleShowSizeBarsInFileListChanged() {
- this.set(
- '_localPrefs.size_bar_in_change_table',
- this.$.showSizeBarsInFileList.checked
- );
- }
-
- _handlePublishCommentsOnPushChanged() {
- this.set(
- '_localPrefs.publish_comments_on_push',
- this.$.publishCommentsOnPush.checked
- );
- }
-
- _handleDisableKeyboardShortcutsChanged() {
- this.set(
- '_localPrefs.disable_keyboard_shortcuts',
- this.$.disableKeyboardShortcuts.checked
- );
- }
-
- _handleDisableTokenHighlightingChanged() {
- this.set(
- '_localPrefs.disable_token_highlighting',
- this.$.disableTokenHighlighting.checked
- );
- }
-
- _handleWorkInProgressByDefault() {
- this.set(
- '_localPrefs.work_in_progress_by_default',
- this.$.workInProgressByDefault.checked
- );
- }
-
- _handleInsertSignedOff() {
- this.set('_localPrefs.signed_off_by', this.$.insertSignedOff.checked);
- }
-
- _handleSaveAccountInfo() {
- this.$.accountInfo.save();
- }
-
- _handleSavePreferences() {
- this._copyPrefs(CopyPrefsDirection.LocalPrefsToPrefs);
+ // private but used in test
+ handleSavePreferences() {
+ this.copyPrefs(CopyPrefsDirection.LocalPrefsToPrefs);
return this.restApiService.savePreferences(this.prefs).then(() => {
- this._prefsChanged = false;
+ this.prefsChanged = false;
});
}
- _handleSaveChangeTable() {
- this.set('prefs.change_table', this._localChangeTableColumns);
- this.set('prefs.legacycid_in_change_table', this._showNumber);
+ // private but used in test
+ handleSaveChangeTable() {
+ this.prefs.change_table = this.localChangeTableColumns;
+ this.prefs.legacycid_in_change_table = this.showNumber;
return this.restApiService.savePreferences(this.prefs).then(() => {
- this._changeTableChanged = false;
+ this.changeTableChanged = false;
});
}
- _handleSaveDiffPreferences() {
- this.$.diffPrefs.save();
- }
-
- _handleSaveWatchedProjects() {
- this.$.watchedProjectsEditor.save();
- }
-
- _computeHeaderClass(changed?: boolean) {
+ private computeHeaderClass(changed?: boolean) {
return changed ? 'edited' : '';
}
- _handleSaveEmails() {
- this.$.emailEditor.save();
- }
-
- _handleNewEmailKeydown(e: KeyboardEvent) {
+ // private but used in test
+ handleNewEmailKeydown(e: KeyboardEvent) {
if (e.keyCode === 13) {
// Enter
e.stopPropagation();
- this._handleAddEmailButton();
+ this.handleAddEmailButton();
}
}
- _isNewEmailValid(newEmail?: string): newEmail is string {
+ // private but used in test
+ isNewEmailValid(newEmail?: string): newEmail is string {
return !!newEmail && newEmail.includes('@');
}
- _computeAddEmailButtonEnabled(newEmail?: string, addingEmail?: boolean) {
- return this._isNewEmailValid(newEmail) && !addingEmail;
+ // private but used in test
+ computeAddEmailButtonEnabled() {
+ return this.isNewEmailValid(this.newEmail) && !this.addingEmail;
}
- _handleAddEmailButton() {
- if (!this._isNewEmailValid(this._newEmail)) return;
+ // private but used in test
+ handleAddEmailButton() {
+ if (!this.isNewEmailValid(this.newEmail)) return;
- this._addingEmail = true;
- this.restApiService.addAccountEmail(this._newEmail).then(response => {
- this._addingEmail = false;
+ this.addingEmail = true;
+ this.restApiService.addAccountEmail(this.newEmail).then(response => {
+ this.addingEmail = false;
// If it was unsuccessful.
if (response.status < 200 || response.status >= 300) {
return;
}
- this._lastSentVerificationEmail = this._newEmail;
- this._newEmail = '';
+ this.lastSentVerificationEmail = this.newEmail;
+ this.newEmail = '';
});
}
- _handleShowNumberChanged(e: ValueChangedEvent<boolean>) {
- this._showNumber = e.detail.value;
- }
-
- _handleDisplayedColumnsChanged(e: ValueChangedEvent<string[]>) {
- this._localChangeTableColumns = e.detail.value;
- }
-
- _handleHasEmailsChanged(e: ValueChangedEvent<boolean>) {
- this._emailsChanged = e.detail.value;
- }
-
- _handleHasProjectsChanged(e: ValueChangedEvent<boolean>) {
- this._watchedProjectsChanged = e.detail.value;
- }
-
- _getFilterDocsLink(docsBaseUrl?: string | null) {
+ // private but used in test
+ getFilterDocsLink(docsBaseUrl?: string | null) {
let base = docsBaseUrl;
if (!base || !ABSOLUTE_URL_PATTERN.test(base)) {
base = GERRIT_DOCS_BASE_URL;
@@ -502,8 +1100,8 @@
return base + GERRIT_DOCS_FILTER_PATH;
}
- _handleToggleDark() {
- if (this._isDark) {
+ private handleToggleDark() {
+ if (this.isDark) {
window.localStorage.removeItem('dark-theme');
} else {
window.localStorage.setItem('dark-theme', 'true');
@@ -511,14 +1109,17 @@
this.reloadPage();
}
+ // private but used in test
reloadPage() {
+ fireAlert(this, 'Reloading...');
windowLocationReload();
}
- _showHttpAuth(config?: ServerInfo) {
- if (config && config.auth && config.auth.git_basic_auth_policy) {
+ // private but used in test
+ showHttpAuth() {
+ if (this.serverConfig?.auth?.git_basic_auth_policy) {
return HTTP_AUTH.includes(
- config.auth.git_basic_auth_policy.toUpperCase()
+ this.serverConfig.auth.git_basic_auth_policy.toUpperCase()
);
}
@@ -528,57 +1129,17 @@
/**
* Work around a issue on iOS when clicking turns into double tap
*/
- _onTapDarkToggle(e: Event) {
+ private onTapDarkToggle(e: Event) {
e.preventDefault();
}
- _handleChangesPerPage() {
- this.set(
- '_localPrefs.changes_per_page',
- Number(this.$.changesPerPageSelect.value)
- );
- }
-
- _handleDateFormat() {
- this.set('_localPrefs.date_format', this.$.dateTimeFormatSelect.value);
- }
-
- _handleTimeFormat() {
- this.set('_localPrefs.time_format', this.$.timeFormatSelect.value);
- }
-
- _handleEmailStrategy() {
- this.set(
- '_localPrefs.email_strategy',
- this.$.emailNotificationsSelect.value
- );
- }
-
- _handleEmailFormat() {
- this.set('_localPrefs.email_format', this.$.emailFormatSelect.value);
- }
-
- _handleDefaultBaseForMerges() {
- this.set(
- '_localPrefs.default_base_for_merges',
- this.$.defaultBaseForMergesSelect.value
- );
- }
-
- _handleDiffView() {
- this.set(
- '_localPrefs.diff_view',
- this.$.diffViewSelect.value as DiffViewMode
- );
- }
-
/**
* bind-value has type string so we have to convert anything inputed
* to string.
*
* This is so typescript template checker doesn't fail.
*/
- _convertToString(
+ private convertToString(
key?:
| DateFormat
| DefaultBase
@@ -590,10 +1151,6 @@
) {
return key !== undefined ? String(key) : '';
}
-
- _handleHasUnsavedChangesChanged(e: ValueChangedEvent<boolean>) {
- this._diffPrefsChanged = e.detail.value;
- }
}
declare global {
diff --git a/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view_html.ts b/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view_html.ts
deleted file mode 100644
index 00f85d8..0000000
--- a/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view_html.ts
+++ /dev/null
@@ -1,590 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="gr-font-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <style include="gr-paper-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <style include="shared-styles">
- :host {
- color: var(--primary-text-color);
- }
- h2 {
- font-family: var(--header-font-family);
- font-size: var(--font-size-h2);
- font-weight: var(--font-weight-h2);
- line-height: var(--line-height-h2);
- }
- .newEmailInput {
- width: 20em;
- }
- #email {
- margin-bottom: var(--spacing-l);
- }
- .main section.darkToggle {
- display: block;
- }
- .filters p,
- .darkToggle p {
- margin-bottom: var(--spacing-l);
- }
- .queryExample em {
- color: violet;
- }
- .toggle {
- align-items: center;
- display: flex;
- margin-bottom: var(--spacing-l);
- margin-right: var(--spacing-l);
- }
- </style>
- <style include="gr-form-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <style include="gr-menu-page-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <style include="gr-page-nav-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
- <div class="loading" hidden$="[[!_loading]]">Loading...</div>
- <div hidden$="[[_loading]]" hidden="">
- <gr-page-nav class="navStyles">
- <ul>
- <li><a href="#Profile">Profile</a></li>
- <li><a href="#Preferences">Preferences</a></li>
- <li><a href="#DiffPreferences">Diff Preferences</a></li>
- <li><a href="#EditPreferences">Edit Preferences</a></li>
- <li><a href="#Menu">Menu</a></li>
- <li><a href="#ChangeTableColumns">Change Table Columns</a></li>
- <li><a href="#Notifications">Notifications</a></li>
- <li><a href="#EmailAddresses">Email Addresses</a></li>
- <template is="dom-if" if="[[_showHttpAuth(_serverConfig)]]">
- <li><a href="#HTTPCredentials">HTTP Credentials</a></li>
- </template>
- <li hidden$="[[!_serverConfig.sshd]]">
- <a href="#SSHKeys"> SSH Keys </a>
- </li>
- <li hidden$="[[!_serverConfig.receive.enable_signed_push]]">
- <a href="#GPGKeys"> GPG Keys </a>
- </li>
- <li><a href="#Groups">Groups</a></li>
- <li><a href="#Identities">Identities</a></li>
- <template
- is="dom-if"
- if="[[_serverConfig.auth.use_contributor_agreements]]"
- >
- <li>
- <a href="#Agreements">Agreements</a>
- </li>
- </template>
- <li><a href="#MailFilters">Mail Filters</a></li>
- <gr-endpoint-decorator name="settings-menu-item">
- </gr-endpoint-decorator>
- </ul>
- </gr-page-nav>
- <div class="main gr-form-styles">
- <h1 class="heading-1">User Settings</h1>
- <h2 id="Theme">Theme</h2>
- <section class="darkToggle">
- <div class="toggle">
- <paper-toggle-button
- aria-labelledby="darkThemeToggleLabel"
- checked="[[_isDark]]"
- on-change="_handleToggleDark"
- on-click="_onTapDarkToggle"
- ></paper-toggle-button>
- <div id="darkThemeToggleLabel">
- Dark theme (the toggle reloads the page)
- </div>
- </div>
- </section>
- <h2 id="Profile" class$="[[_computeHeaderClass(_accountInfoChanged)]]">
- Profile
- </h2>
- <fieldset id="profile">
- <gr-account-info
- id="accountInfo"
- has-unsaved-changes="{{_accountInfoChanged}}"
- ></gr-account-info>
- <gr-button
- on-click="_handleSaveAccountInfo"
- disabled="[[!_accountInfoChanged]]"
- >Save changes</gr-button
- >
- </fieldset>
- <h2 id="Preferences" class$="[[_computeHeaderClass(_prefsChanged)]]">
- Preferences
- </h2>
- <fieldset id="preferences">
- <section>
- <label class="title" for="changesPerPageSelect"
- >Changes per page</label
- >
- <span class="value">
- <gr-select
- bind-value="[[_convertToString(_localPrefs.changes_per_page)]]"
- on-change="_handleChangesPerPage"
- >
- <select id="changesPerPageSelect">
- <option value="10">10 rows per page</option>
- <option value="25">25 rows per page</option>
- <option value="50">50 rows per page</option>
- <option value="100">100 rows per page</option>
- </select>
- </gr-select>
- </span>
- </section>
- <section>
- <label class="title" for="dateTimeFormatSelect"
- >Date/time format</label
- >
- <span class="value">
- <gr-select
- bind-value="[[_convertToString(_localPrefs.date_format)]]"
- on-change="_handleDateFormat"
- >
- <select id="dateTimeFormatSelect">
- <option value="STD">Jun 3 ; Jun 3, 2016</option>
- <option value="US">06/03 ; 06/03/16</option>
- <option value="ISO">06-03 ; 2016-06-03</option>
- <option value="EURO">3. Jun ; 03.06.2016</option>
- <option value="UK">03/06 ; 03/06/2016</option>
- </select>
- </gr-select>
- <gr-select
- bind-value="[[_convertToString(_localPrefs.time_format)]]"
- aria-label="Time Format"
- on-change="_handleTimeFormat"
- >
- <select id="timeFormatSelect">
- <option value="HHMM_12">4:10 PM</option>
- <option value="HHMM_24">16:10</option>
- </select>
- </gr-select>
- </span>
- </section>
- <section>
- <label class="title" for="emailNotificationsSelect"
- >Email notifications</label
- >
- <span class="value">
- <gr-select
- bind-value="[[_convertToString(_localPrefs.email_strategy)]]"
- on-change="_handleEmailStrategy"
- >
- <select id="emailNotificationsSelect">
- <option value="CC_ON_OWN_COMMENTS">Every comment</option>
- <option value="ENABLED">Only comments left by others</option>
- <option value="ATTENTION_SET_ONLY">
- Only when I am in the attention set
- </option>
- <option value="DISABLED">None</option>
- </select>
- </gr-select>
- </span>
- </section>
- <section hidden$="[[!_convertToString(_localPrefs.email_format)]]">
- <label class="title" for="emailFormatSelect">Email format</label>
- <span class="value">
- <gr-select
- bind-value="[[_convertToString(_localPrefs.email_format)]]"
- on-change="_handleEmailFormat"
- >
- <select id="emailFormatSelect">
- <option value="HTML_PLAINTEXT">HTML and plaintext</option>
- <option value="PLAINTEXT">Plaintext only</option>
- </select>
- </gr-select>
- </span>
- </section>
- <section hidden$="[[!_localPrefs.default_base_for_merges]]">
- <span class="title">Default Base For Merges</span>
- <span class="value">
- <gr-select
- bind-value="[[_convertToString(_localPrefs.default_base_for_merges)]]"
- on-change="_handleDefaultBaseForMerges"
- >
- <select id="defaultBaseForMergesSelect">
- <option value="AUTO_MERGE">Auto Merge</option>
- <option value="FIRST_PARENT">First Parent</option>
- </select>
- </gr-select>
- </span>
- </section>
- <section>
- <label class="title" for="relativeDateInChangeTable"
- >Show Relative Dates In Changes Table</label
- >
- <span class="value">
- <input
- id="relativeDateInChangeTable"
- type="checkbox"
- checked$="[[_localPrefs.relative_date_in_change_table]]"
- on-change="_handleRelativeDateInChangeTable"
- />
- </span>
- </section>
- <section>
- <span class="title">Diff view</span>
- <span class="value">
- <gr-select
- bind-value="[[_convertToString(_localPrefs.diff_view)]]"
- on-change="_handleDiffView"
- >
- <select id="diffViewSelect">
- <option value="SIDE_BY_SIDE">Side by side</option>
- <option value="UNIFIED_DIFF">Unified diff</option>
- </select>
- </gr-select>
- </span>
- </section>
- <section>
- <label for="showSizeBarsInFileList" class="title"
- >Show size bars in file list</label
- >
- <span class="value">
- <input
- id="showSizeBarsInFileList"
- type="checkbox"
- checked$="[[_localPrefs.size_bar_in_change_table]]"
- on-change="_handleShowSizeBarsInFileListChanged"
- />
- </span>
- </section>
- <section>
- <label for="publishCommentsOnPush" class="title"
- >Publish comments on push</label
- >
- <span class="value">
- <input
- id="publishCommentsOnPush"
- type="checkbox"
- checked$="[[_localPrefs.publish_comments_on_push]]"
- on-change="_handlePublishCommentsOnPushChanged"
- />
- </span>
- </section>
- <section>
- <label for="workInProgressByDefault" class="title"
- >Set new changes to "work in progress" by default</label
- >
- <span class="value">
- <input
- id="workInProgressByDefault"
- type="checkbox"
- checked$="[[_localPrefs.work_in_progress_by_default]]"
- on-change="_handleWorkInProgressByDefault"
- />
- </span>
- </section>
- <section>
- <label for="disableKeyboardShortcuts" class="title"
- >Disable all keyboard shortcuts</label
- >
- <span class="value">
- <input
- id="disableKeyboardShortcuts"
- type="checkbox"
- checked$="[[_localPrefs.disable_keyboard_shortcuts]]"
- on-change="_handleDisableKeyboardShortcutsChanged"
- />
- </span>
- </section>
- <section>
- <label for="disableTokenHighlighting" class="title"
- >Disable token highlighting on hover</label
- >
- <span class="value">
- <input
- id="disableTokenHighlighting"
- type="checkbox"
- checked$="[[_localPrefs.disable_token_highlighting]]"
- on-change="_handleDisableTokenHighlightingChanged"
- />
- </span>
- </section>
- <section>
- <label for="insertSignedOff" class="title">
- Insert Signed-off-by Footer For Inline Edit Changes
- </label>
- <span class="value">
- <input
- id="insertSignedOff"
- type="checkbox"
- checked$="[[_localPrefs.signed_off_by]]"
- on-change="_handleInsertSignedOff"
- />
- </span>
- </section>
- <gr-button
- id="savePrefs"
- on-click="_handleSavePreferences"
- disabled="[[!_prefsChanged]]"
- >Save changes</gr-button
- >
- </fieldset>
- <h2
- id="DiffPreferences"
- class$="[[_computeHeaderClass(_diffPrefsChanged)]]"
- >
- Diff Preferences
- </h2>
- <fieldset id="diffPreferences">
- <gr-diff-preferences
- id="diffPrefs"
- on-has-unsaved-changes-changed="_handleHasUnsavedChangesChanged"
- ></gr-diff-preferences>
- <gr-button
- id="saveDiffPrefs"
- on-click="_handleSaveDiffPreferences"
- disabled$="[[!_diffPrefsChanged]]"
- >Save changes</gr-button
- >
- </fieldset>
- <gr-edit-preferences id="editPrefs"></gr-edit-preferences>
- <gr-menu-editor></gr-menu-editor>
- <h2
- id="ChangeTableColumns"
- class$="[[_computeHeaderClass(_changeTableChanged)]]"
- >
- Change Table Columns
- </h2>
- <fieldset id="changeTableColumns">
- <gr-change-table-editor
- show-number="[[_showNumber]]"
- on-show-number-changed="_handleShowNumberChanged"
- server-config="[[_serverConfig]]"
- displayed-columns="[[_localChangeTableColumns]]"
- on-displayed-columns-changed="_handleDisplayedColumnsChanged"
- >
- </gr-change-table-editor>
- <gr-button
- id="saveChangeTable"
- on-click="_handleSaveChangeTable"
- disabled="[[!_changeTableChanged]]"
- >Save changes</gr-button
- >
- </fieldset>
- <h2
- id="Notifications"
- class$="[[_computeHeaderClass(_watchedProjectsChanged)]]"
- >
- Notifications
- </h2>
- <fieldset id="watchedProjects">
- <gr-watched-projects-editor
- has-unsaved-changes="[[_watchedProjectsChanged]]"
- on-has-unsaved-changes-changed="_handleHasProjectsChanged"
- id="watchedProjectsEditor"
- ></gr-watched-projects-editor>
- <gr-button
- on-click="_handleSaveWatchedProjects"
- disabled$="[[!_watchedProjectsChanged]]"
- id="_handleSaveWatchedProjects"
- >Save changes</gr-button
- >
- </fieldset>
- <h2 id="EmailAddresses" class$="[[_computeHeaderClass(_emailsChanged)]]">
- Email Addresses
- </h2>
- <fieldset id="email">
- <gr-email-editor
- id="emailEditor"
- has-unsaved-changes="[[_emailsChanged]]"
- on-has-unsaved-changes-changed="_handleHasEmailsChanged"
- ></gr-email-editor>
- <gr-button on-click="_handleSaveEmails" disabled$="[[!_emailsChanged]]"
- >Save changes</gr-button
- >
- </fieldset>
- <fieldset id="newEmail">
- <section>
- <span class="title">New email address</span>
- <span class="value">
- <iron-input
- class="newEmailInput"
- bind-value="{{_newEmail}}"
- type="text"
- on-keydown="_handleNewEmailKeydown"
- placeholder="email@example.com"
- >
- <input
- class="newEmailInput"
- type="text"
- disabled="[[_addingEmail]]"
- on-keydown="_handleNewEmailKeydown"
- placeholder="email@example.com"
- />
- </iron-input>
- </span>
- </section>
- <section
- id="verificationSentMessage"
- hidden$="[[!_lastSentVerificationEmail]]"
- >
- <p>
- A verification email was sent to
- <em>[[_lastSentVerificationEmail]]</em>. Please check your inbox.
- </p>
- </section>
- <gr-button
- disabled="[[!_computeAddEmailButtonEnabled(_newEmail, _addingEmail)]]"
- on-click="_handleAddEmailButton"
- >Send verification</gr-button
- >
- </fieldset>
- <template is="dom-if" if="[[_showHttpAuth(_serverConfig)]]">
- <div>
- <h2 id="HTTPCredentials">HTTP Credentials</h2>
- <fieldset>
- <gr-http-password id="httpPass"></gr-http-password>
- </fieldset>
- </div>
- </template>
- <div hidden$="[[!_serverConfig.sshd]]">
- <h2 id="SSHKeys" class$="[[_computeHeaderClass(_keysChanged)]]">
- SSH keys
- </h2>
- <gr-ssh-editor
- id="sshEditor"
- has-unsaved-changes-changed="handleUnsavedChangesChanged"
- ></gr-ssh-editor>
- </div>
- <div hidden$="[[!_serverConfig.receive.enable_signed_push]]">
- <h2 id="GPGKeys" class$="[[_computeHeaderClass(_gpgKeysChanged)]]">
- GPG keys
- </h2>
- <gr-gpg-editor
- id="gpgEditor"
- has-unsaved-changes="[[_gpgKeysChanged]]"
- on-has-unsaved-changes-changed="_handleGpgEditorHasSavedChanges"
- ></gr-gpg-editor>
- </div>
- <h2 id="Groups">Groups</h2>
- <fieldset>
- <gr-group-list id="groupList"></gr-group-list>
- </fieldset>
- <h2 id="Identities">Identities</h2>
- <fieldset>
- <gr-identities
- id="identities"
- server-config="[[_serverConfig]]"
- ></gr-identities>
- </fieldset>
- <template
- is="dom-if"
- if="[[_serverConfig.auth.use_contributor_agreements]]"
- >
- <h2 id="Agreements">Agreements</h2>
- <fieldset>
- <gr-agreements-list id="agreementsList"></gr-agreements-list>
- </fieldset>
- </template>
- <h2 id="MailFilters">Mail Filters</h2>
- <fieldset class="filters">
- <p>
- Gerrit emails include metadata about the change to support writing
- mail filters.
- </p>
- <p>
- Here are some example Gmail queries that can be used for filters or
- for searching through archived messages. View the
- <a
- href$="[[_getFilterDocsLink(_docsBaseUrl)]]"
- target="_blank"
- rel="nofollow"
- >Gerrit documentation</a
- >
- for the complete set of footers.
- </p>
- <table>
- <tbody>
- <tr>
- <th>Name</th>
- <th>Query</th>
- </tr>
- <tr>
- <td>Changes requesting my review</td>
- <td>
- <code class="queryExample">
- "Gerrit-Reviewer: <em>Your Name</em>
- <<em>your.email@example.com</em>>"
- </code>
- </td>
- </tr>
- <tr>
- <td>Changes requesting my attention</td>
- <td>
- <code class="queryExample">
- "Gerrit-Attention: <em>Your Name</em>
- <<em>your.email@example.com</em>>"
- </code>
- </td>
- </tr>
- <tr>
- <td>Changes from a specific owner</td>
- <td>
- <code class="queryExample">
- "Gerrit-Owner: <em>Owner name</em>
- <<em>owner.email@example.com</em>>"
- </code>
- </td>
- </tr>
- <tr>
- <td>Changes targeting a specific branch</td>
- <td>
- <code class="queryExample">
- "Gerrit-Branch: <em>branch-name</em>"
- </code>
- </td>
- </tr>
- <tr>
- <td>Changes in a specific project</td>
- <td>
- <code class="queryExample">
- "Gerrit-Project: <em>project-name</em>"
- </code>
- </td>
- </tr>
- <tr>
- <td>Messages related to a specific Change ID</td>
- <td>
- <code class="queryExample">
- "Gerrit-Change-Id: <em>Change ID</em>"
- </code>
- </td>
- </tr>
- <tr>
- <td>Messages related to a specific change number</td>
- <td>
- <code class="queryExample">
- "Gerrit-Change-Number: <em>change number</em>"
- </code>
- </td>
- </tr>
- </tbody>
- </table>
- </fieldset>
- <gr-endpoint-decorator name="settings-screen"> </gr-endpoint-decorator>
- </div>
- </div>
-`;
diff --git a/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view_test.ts b/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view_test.ts
index 7f81f42..6a8f575 100644
--- a/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view_test.ts
+++ b/polygerrit-ui/app/elements/settings/gr-settings-view/gr-settings-view_test.ts
@@ -19,7 +19,7 @@
import './gr-settings-view';
import {GrSettingsView} from './gr-settings-view';
import {GerritView} from '../../../services/router/router-model';
-import {queryAndAssert, stubRestApi} from '../../../test/test-utils';
+import {queryAll, queryAndAssert, stubRestApi} from '../../../test/test-utils';
import {
AuthInfo,
AccountDetailInfo,
@@ -56,7 +56,7 @@
let config: ServerInfo;
function valueOf(title: string, id: string) {
- const sections = element.root?.querySelectorAll(`#${id} section`) ?? [];
+ const sections = queryAll(element, `#${id} section`);
let titleEl;
for (let i = 0; i < sections.length; i++) {
titleEl = sections[i].querySelector('.title');
@@ -122,10 +122,420 @@
stubRestApi('getAccountEmails').returns(Promise.resolve(undefined));
stubRestApi('getConfig').returns(Promise.resolve(config));
element = basicFixture.instantiate();
+ await element.updateComplete;
// Allow the element to render.
if (element._testOnly_loadingPromise)
await element._testOnly_loadingPromise;
+ await element.updateComplete;
+ });
+
+ test('renders', async () => {
+ sinon
+ .stub(element, 'getFilterDocsLink')
+ .returns('https://test.com/user-notify.html');
+ element.docsBaseUrl = 'https://test.com';
+ await element.updateComplete;
+ // this cannot be formatted with /* HTML */, because it breaks test
+ expect(element).shadowDom.to.equal(/* HTML*/ `<div
+ class="loading"
+ hidden=""
+ >
+ Loading...
+ </div>
+ <div>
+ <gr-page-nav class="navStyles">
+ <ul>
+ <li><a href="#Profile"> Profile </a></li>
+ <li><a href="#Preferences"> Preferences </a></li>
+ <li><a href="#DiffPreferences"> Diff Preferences </a></li>
+ <li><a href="#EditPreferences"> Edit Preferences </a></li>
+ <li><a href="#Menu"> Menu </a></li>
+ <li><a href="#ChangeTableColumns"> Change Table Columns </a></li>
+ <li><a href="#Notifications"> Notifications </a></li>
+ <li><a href="#EmailAddresses"> Email Addresses </a></li>
+ <li><a href="#Groups"> Groups </a></li>
+ <li><a href="#Identities"> Identities </a></li>
+ <li><a href="#MailFilters"> Mail Filters </a></li>
+ <gr-endpoint-decorator name="settings-menu-item">
+ </gr-endpoint-decorator>
+ </ul>
+ </gr-page-nav>
+ <div class="gr-form-styles main">
+ <h1 class="heading-1">User Settings</h1>
+ <h2 id="Theme">Theme</h2>
+ <section class="darkToggle">
+ <div class="toggle">
+ <paper-toggle-button
+ aria-disabled="false"
+ aria-labelledby="darkThemeToggleLabel"
+ aria-pressed="false"
+ role="button"
+ style="touch-action: none;"
+ tabindex="0"
+ toggles=""
+ >
+ </paper-toggle-button>
+ <div id="darkThemeToggleLabel">
+ Dark theme
+ </div>
+ </div>
+ </section>
+ <h2 id="Profile">Profile</h2>
+ <fieldset id="profile">
+ <gr-account-info id="accountInfo"> </gr-account-info>
+ <gr-button
+ aria-disabled="true"
+ disabled=""
+ role="button"
+ tabindex="-1"
+ >
+ Save changes
+ </gr-button>
+ </fieldset>
+ <h2 id="Preferences">Preferences</h2>
+ <fieldset id="preferences">
+ <section>
+ <label class="title" for="changesPerPageSelect">
+ Changes per page
+ </label>
+ <span class="value">
+ <gr-select>
+ <select id="changesPerPageSelect">
+ <option value="10">10 rows per page</option>
+ <option value="25">25 rows per page</option>
+ <option value="50">50 rows per page</option>
+ <option value="100">100 rows per page</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="dateTimeFormatSelect">
+ Date/time format
+ </label>
+ <span class="value">
+ <gr-select>
+ <select id="dateTimeFormatSelect">
+ <option value="STD">Jun 3 ; Jun 3, 2016</option>
+ <option value="US">06/03 ; 06/03/16</option>
+ <option value="ISO">06-03 ; 2016-06-03</option>
+ <option value="EURO">3. Jun ; 03.06.2016</option>
+ <option value="UK">03/06 ; 03/06/2016</option>
+ </select>
+ </gr-select>
+ <gr-select aria-label="Time Format">
+ <select id="timeFormatSelect">
+ <option value="HHMM_12">4:10 PM</option>
+ <option value="HHMM_24">16:10</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="emailNotificationsSelect">
+ Email notifications
+ </label>
+ <span class="value">
+ <gr-select>
+ <select id="emailNotificationsSelect">
+ <option value="CC_ON_OWN_COMMENTS">Every comment</option>
+ <option value="ENABLED">
+ Only comments left by others
+ </option>
+ <option value="ATTENTION_SET_ONLY">
+ Only when I am in the attention set
+ </option>
+ <option value="DISABLED">None</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="emailFormatSelect">
+ Email format
+ </label>
+ <span class="value">
+ <gr-select>
+ <select id="emailFormatSelect">
+ <option value="HTML_PLAINTEXT">HTML and plaintext</option>
+ <option value="PLAINTEXT">Plaintext only</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <span class="title"> Default Base For Merges </span>
+ <span class="value">
+ <gr-select>
+ <select id="defaultBaseForMergesSelect">
+ <option value="AUTO_MERGE">Auto Merge</option>
+ <option value="FIRST_PARENT">First Parent</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="relativeDateInChangeTable">
+ Show Relative Dates In Changes Table
+ </label>
+ <span class="value">
+ <input id="relativeDateInChangeTable" type="checkbox" />
+ </span>
+ </section>
+ <section>
+ <span class="title"> Diff view </span>
+ <span class="value">
+ <gr-select>
+ <select id="diffViewSelect">
+ <option value="SIDE_BY_SIDE">Side by side</option>
+ <option value="UNIFIED_DIFF">Unified diff</option>
+ </select>
+ </gr-select>
+ </span>
+ </section>
+ <section>
+ <label class="title" for="showSizeBarsInFileList">
+ Show size bars in file list
+ </label>
+ <span class="value">
+ <input
+ checked=""
+ id="showSizeBarsInFileList"
+ type="checkbox"
+ />
+ </span>
+ </section>
+ <section>
+ <label class="title" for="publishCommentsOnPush">
+ Publish comments on push
+ </label>
+ <span class="value">
+ <input id="publishCommentsOnPush" type="checkbox" />
+ </span>
+ </section>
+ <section>
+ <label class="title" for="workInProgressByDefault">
+ Set new changes to "work in progress" by default
+ </label>
+ <span class="value">
+ <input id="workInProgressByDefault" type="checkbox" />
+ </span>
+ </section>
+ <section>
+ <label class="title" for="disableKeyboardShortcuts">
+ Disable all keyboard shortcuts
+ </label>
+ <span class="value">
+ <input id="disableKeyboardShortcuts" type="checkbox" />
+ </span>
+ </section>
+ <section>
+ <label class="title" for="disableTokenHighlighting">
+ Disable token highlighting on hover
+ </label>
+ <span class="value">
+ <input id="disableTokenHighlighting" type="checkbox" />
+ </span>
+ </section>
+ <section>
+ <label class="title" for="insertSignedOff">
+ Insert Signed-off-by Footer For Inline Edit Changes
+ </label>
+ <span class="value">
+ <input id="insertSignedOff" type="checkbox" />
+ </span>
+ </section>
+ <gr-button
+ aria-disabled="true"
+ disabled=""
+ id="savePrefs"
+ role="button"
+ tabindex="-1"
+ >
+ Save changes
+ </gr-button>
+ </fieldset>
+ <h2 id="DiffPreferences">Diff Preferences</h2>
+ <fieldset id="diffPreferences">
+ <gr-diff-preferences id="diffPrefs"> </gr-diff-preferences>
+ <gr-button
+ aria-disabled="true"
+ disabled=""
+ id="saveDiffPrefs"
+ role="button"
+ tabindex="-1"
+ >
+ Save changes
+ </gr-button>
+ </fieldset>
+ <gr-edit-preferences id="EditPreferences"> </gr-edit-preferences>
+ <gr-menu-editor id="Menu"> </gr-menu-editor>
+ <h2 id="ChangeTableColumns">Change Table Columns</h2>
+ <fieldset id="changeTableColumns">
+ <gr-change-table-editor> </gr-change-table-editor>
+ <gr-button
+ aria-disabled="true"
+ disabled=""
+ id="saveChangeTable"
+ role="button"
+ tabindex="-1"
+ >
+ Save changes
+ </gr-button>
+ </fieldset>
+ <h2 id="Notifications">Notifications</h2>
+ <fieldset id="watchedProjects">
+ <gr-watched-projects-editor id="watchedProjectsEditor">
+ </gr-watched-projects-editor>
+ <gr-button
+ aria-disabled="true"
+ disabled=""
+ id="_handleSaveWatchedProjects"
+ role="button"
+ tabindex="-1"
+ >
+ Save changes
+ </gr-button>
+ </fieldset>
+ <h2 id="EmailAddresses">Email Addresses</h2>
+ <fieldset id="email">
+ <gr-email-editor id="emailEditor"> </gr-email-editor>
+ <gr-button
+ aria-disabled="true"
+ disabled=""
+ role="button"
+ tabindex="-1"
+ >
+ Save changes
+ </gr-button>
+ </fieldset>
+ <fieldset id="newEmail">
+ <section>
+ <span class="title"> New email address </span>
+ <span class="value">
+ <iron-input class="newEmailInput">
+ <input
+ class="newEmailInput"
+ placeholder="email@example.com"
+ type="text"
+ />
+ </iron-input>
+ </span>
+ </section>
+ <section hidden="" id="verificationSentMessage">
+ <p>
+ A verification email was sent to <em>
+ </em>
+ . Please check your
+ inbox.
+ </p>
+ </section>
+ <gr-button
+ aria-disabled="true"
+ disabled=""
+ role="button"
+ tabindex="-1"
+ >
+ Send verification
+ </gr-button>
+ </fieldset>
+ <h2 id="Groups">Groups</h2>
+ <fieldset><gr-group-list id="groupList"> </gr-group-list></fieldset>
+ <h2 id="Identities">Identities</h2>
+ <fieldset>
+ <gr-identities id="identities"> </gr-identities>
+ </fieldset>
+ <h2 id="MailFilters">Mail Filters</h2>
+ <fieldset class="filters">
+ <p>
+ Gerrit emails include metadata about the change to support writing
+ mail filters.
+ </p>
+ <p>
+ Here are some example Gmail queries that can be used for filters
+ or for searching through archived messages. View the
+ <a
+ href="https://test.com/user-notify.html"
+ rel="nofollow"
+ target="_blank"
+ >
+ Gerrit documentation
+ </a>
+ for the complete set of footers.
+ </p>
+ <table>
+ <tbody>
+ <tr>
+ <th>Name</th>
+ <th>Query</th>
+ </tr>
+ <tr>
+ <td>Changes requesting my review</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Reviewer: <em> Your Name </em> <
+ <em> your.email@example.com </em> >"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Changes requesting my attention</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Attention: <em> Your Name </em> <
+ <em> your.email@example.com </em> >"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Changes from a specific owner</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Owner: <em> Owner name </em> <
+ <em> owner.email@example.com </em> >"
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Changes targeting a specific branch</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Branch: <em> branch-name </em> "
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Changes in a specific project</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Project: <em> project-name </em> "
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Messages related to a specific Change ID</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Change-Id: <em> Change ID </em> "
+ </code>
+ </td>
+ </tr>
+ <tr>
+ <td>Messages related to a specific change number</td>
+ <td>
+ <code class="queryExample">
+ "Gerrit-Change-Number: <em> change number </em> "
+ </code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </fieldset>
+ <gr-endpoint-decorator name="settings-screen">
+ </gr-endpoint-decorator>
+ </div>
+ </div>`);
});
test('theme changing', async () => {
@@ -141,7 +551,7 @@
assert.isTrue(window.localStorage.getItem('dark-theme') === 'true');
assert.isTrue(reloadStub.calledOnce);
- element._isDark = true;
+ element.isDark = true;
await flush();
MockInteractions.tap(themeToggle);
assert.isFalse(window.localStorage.getItem('dark-theme') === 'true');
@@ -258,14 +668,14 @@
false
);
- assert.isFalse(element._prefsChanged);
+ assert.isFalse(element.prefsChanged);
const publishOnPush = valueOf('Publish comments on push', 'preferences')!
.firstElementChild!;
MockInteractions.tap(publishOnPush);
- assert.isTrue(element._prefsChanged);
+ assert.isTrue(element.prefsChanged);
stubRestApi('savePreferences').callsFake(prefs => {
assertMenusEqual(prefs.my, preferences.my);
@@ -274,8 +684,8 @@
});
// Save the change.
- await element._handleSavePreferences();
- assert.isFalse(element._prefsChanged);
+ await element.handleSavePreferences();
+ assert.isFalse(element.prefsChanged);
});
test('publish comments on push', async () => {
@@ -285,7 +695,7 @@
)!.firstElementChild!;
MockInteractions.tap(publishCommentsOnPush);
- assert.isTrue(element._prefsChanged);
+ assert.isTrue(element.prefsChanged);
stubRestApi('savePreferences').callsFake(prefs => {
assert.equal(prefs.publish_comments_on_push, true);
@@ -293,8 +703,8 @@
});
// Save the change.
- await element._handleSavePreferences();
- assert.isFalse(element._prefsChanged);
+ await element.handleSavePreferences();
+ assert.isFalse(element.prefsChanged);
});
test('set new changes work-in-progress', async () => {
@@ -304,7 +714,7 @@
)!.firstElementChild!;
MockInteractions.tap(newChangesWorkInProgress);
- assert.isTrue(element._prefsChanged);
+ assert.isTrue(element.prefsChanged);
stubRestApi('savePreferences').callsFake(prefs => {
assert.equal(prefs.work_in_progress_by_default, true);
@@ -312,37 +722,40 @@
});
// Save the change.
- await element._handleSavePreferences();
- assert.isFalse(element._prefsChanged);
+ await element.handleSavePreferences();
+ assert.isFalse(element.prefsChanged);
});
- test('add email validation', () => {
- assert.isFalse(element._isNewEmailValid('invalid email'));
- assert.isTrue(element._isNewEmailValid('vaguely@valid.email'));
+ test('add email validation', async () => {
+ assert.isFalse(element.isNewEmailValid('invalid email'));
+ assert.isTrue(element.isNewEmailValid('vaguely@valid.email'));
- assert.isFalse(
- element._computeAddEmailButtonEnabled('invalid email', true)
- );
- assert.isFalse(
- element._computeAddEmailButtonEnabled('vaguely@valid.email', true)
- );
- assert.isTrue(
- element._computeAddEmailButtonEnabled('vaguely@valid.email', false)
- );
+ element.newEmail = 'invalid email';
+ element.addingEmail = true;
+ await element.updateComplete;
+ assert.isFalse(element.computeAddEmailButtonEnabled());
+ element.newEmail = 'vaguely@valid.email';
+ element.addingEmail = true;
+ await element.updateComplete;
+ assert.isFalse(element.computeAddEmailButtonEnabled());
+ element.newEmail = 'vaguely@valid.email';
+ element.addingEmail = false;
+ await element.updateComplete;
+ assert.isTrue(element.computeAddEmailButtonEnabled());
});
test('add email does not save invalid', () => {
const addEmailStub = stubAddAccountEmail(201);
- assert.isFalse(element._addingEmail);
- assert.isNotOk(element._lastSentVerificationEmail);
- element._newEmail = 'invalid email';
+ assert.isFalse(element.addingEmail);
+ assert.isNotOk(element.lastSentVerificationEmail);
+ element.newEmail = 'invalid email';
- element._handleAddEmailButton();
+ element.handleAddEmailButton();
- assert.isFalse(element._addingEmail);
+ assert.isFalse(element.addingEmail);
assert.isFalse(addEmailStub.called);
- assert.isNotOk(element._lastSentVerificationEmail);
+ assert.isNotOk(element.lastSentVerificationEmail);
assert.isFalse(addEmailStub.called);
});
@@ -350,62 +763,59 @@
test('add email does save valid', async () => {
const addEmailStub = stubAddAccountEmail(201);
- assert.isFalse(element._addingEmail);
- assert.isNotOk(element._lastSentVerificationEmail);
- element._newEmail = 'valid@email.com';
+ assert.isFalse(element.addingEmail);
+ assert.isNotOk(element.lastSentVerificationEmail);
+ element.newEmail = 'valid@email.com';
- element._handleAddEmailButton();
+ element.handleAddEmailButton();
- assert.isTrue(element._addingEmail);
+ assert.isTrue(element.addingEmail);
assert.isTrue(addEmailStub.called);
assert.isTrue(addEmailStub.called);
await addEmailStub.lastCall.returnValue;
- assert.isOk(element._lastSentVerificationEmail);
+ assert.isOk(element.lastSentVerificationEmail);
});
test('add email does not set last-email if error', async () => {
const addEmailStub = stubAddAccountEmail(500);
- assert.isNotOk(element._lastSentVerificationEmail);
- element._newEmail = 'valid@email.com';
+ assert.isNotOk(element.lastSentVerificationEmail);
+ element.newEmail = 'valid@email.com';
- element._handleAddEmailButton();
+ element.handleAddEmailButton();
assert.isTrue(addEmailStub.called);
await addEmailStub.lastCall.returnValue;
- assert.isNotOk(element._lastSentVerificationEmail);
+ assert.isNotOk(element.lastSentVerificationEmail);
});
test('emails are loaded without emailToken', () => {
- const emailEditorLoadDataStub = sinon.stub(
- element.$.emailEditor,
- 'loadData'
- );
+ const emailEditorLoadDataStub = sinon.stub(element.emailEditor, 'loadData');
element.params = {
view: GerritView.SETTINGS,
} as AppElementSettingsParam;
- element.connectedCallback();
+ element.firstUpdated();
assert.isTrue(emailEditorLoadDataStub.calledOnce);
});
- test('_handleSaveChangeTable', () => {
+ test('handleSaveChangeTable', () => {
let newColumns = ['Owner', 'Project', 'Branch'];
- element._localChangeTableColumns = newColumns.slice(0);
- element._showNumber = false;
- element._handleSaveChangeTable();
+ element.localChangeTableColumns = newColumns.slice(0);
+ element.showNumber = false;
+ element.handleSaveChangeTable();
assert.deepEqual(element.prefs.change_table, newColumns);
assert.isNotOk(element.prefs.legacycid_in_change_table);
newColumns = ['Size'];
- element._localChangeTableColumns = newColumns;
- element._showNumber = true;
- element._handleSaveChangeTable();
+ element.localChangeTableColumns = newColumns;
+ element.showNumber = true;
+ element.handleSaveChangeTable();
assert.deepEqual(element.prefs.change_table, newColumns);
assert.isTrue(element.prefs.legacycid_in_change_table);
});
- test('_showHttpAuth', () => {
+ test('showHttpAuth', async () => {
const serverConfig: ServerInfo = {
...createServerInfo(),
auth: {
@@ -413,41 +823,48 @@
} as AuthInfo,
};
- assert.isTrue(element._showHttpAuth(serverConfig));
+ element.serverConfig = serverConfig;
+ await element.updateComplete;
+ assert.isTrue(element.showHttpAuth());
- serverConfig.auth.git_basic_auth_policy = 'HTTP_LDAP';
- assert.isTrue(element._showHttpAuth(serverConfig));
+ element.serverConfig.auth.git_basic_auth_policy = 'HTTP_LDAP';
+ await element.updateComplete;
+ assert.isTrue(element.showHttpAuth());
- serverConfig.auth.git_basic_auth_policy = 'LDAP';
- assert.isFalse(element._showHttpAuth(serverConfig));
+ element.serverConfig.auth.git_basic_auth_policy = 'LDAP';
+ await element.updateComplete;
+ assert.isFalse(element.showHttpAuth());
- serverConfig.auth.git_basic_auth_policy = 'OAUTH';
- assert.isFalse(element._showHttpAuth(serverConfig));
+ element.serverConfig.auth.git_basic_auth_policy = 'OAUTH';
+ await element.updateComplete;
+ assert.isFalse(element.showHttpAuth());
- assert.isFalse(element._showHttpAuth(undefined));
+ element.serverConfig = undefined;
+ await element.updateComplete;
+ assert.isFalse(element.showHttpAuth());
});
- suite('_getFilterDocsLink', () => {
+ suite('getFilterDocsLink', () => {
test('with http: docs base URL', () => {
const base = 'http://example.com/';
- const result = element._getFilterDocsLink(base);
+ const result = element.getFilterDocsLink(base);
assert.equal(result, 'http://example.com/user-notify.html');
});
test('with http: docs base URL without slash', () => {
const base = 'http://example.com';
- const result = element._getFilterDocsLink(base);
+ const result = element.getFilterDocsLink(base);
assert.equal(result, 'http://example.com/user-notify.html');
});
test('with https: docs base URL', () => {
const base = 'https://example.com/';
- const result = element._getFilterDocsLink(base);
+ const result = element.getFilterDocsLink(base);
assert.equal(result, 'https://example.com/user-notify.html');
});
test('without docs base URL', () => {
- const result = element._getFilterDocsLink(null);
+ const result = element.getFilterDocsLink(null);
assert.equal(
result,
'https://gerrit-review.googlesource.com/' +
@@ -457,7 +874,7 @@
test('ignores non HTTP links', () => {
const base = 'javascript://alert("evil");';
- const result = element._getFilterDocsLink(base);
+ const result = element.getFilterDocsLink(base);
assert.equal(
result,
'https://gerrit-review.googlesource.com/' +
@@ -474,7 +891,7 @@
let emailEditorLoadDataStub: sinon.SinonStub;
setup(() => {
- emailEditorLoadDataStub = sinon.stub(element.$.emailEditor, 'loadData');
+ emailEditorLoadDataStub = sinon.stub(element.emailEditor, 'loadData');
confirmEmailStub = stubRestApi('confirmEmail').returns(
new Promise(resolve => {
resolveConfirm = resolve;
@@ -482,7 +899,7 @@
);
element.params = {view: GerritView.SETTINGS, emailToken: 'foo'};
- element.connectedCallback();
+ element.firstUpdated();
});
test('it is used to confirm email via rest API', () => {
diff --git a/polygerrit-ui/app/elements/settings/gr-ssh-editor/gr-ssh-editor.ts b/polygerrit-ui/app/elements/settings/gr-ssh-editor/gr-ssh-editor.ts
index 72c87b2..ae20c4e 100644
--- a/polygerrit-ui/app/elements/settings/gr-ssh-editor/gr-ssh-editor.ts
+++ b/polygerrit-ui/app/elements/settings/gr-ssh-editor/gr-ssh-editor.ts
@@ -15,25 +15,20 @@
* limitations under the License.
*/
import '@polymer/iron-autogrow-textarea/iron-autogrow-textarea';
-import '../../../styles/gr-form-styles';
import '../../shared/gr-button/gr-button';
import '../../shared/gr-copy-clipboard/gr-copy-clipboard';
import '../../shared/gr-overlay/gr-overlay';
-import '../../../styles/shared-styles';
-import {dom, EventApi} from '@polymer/polymer/lib/legacy/polymer.dom';
import {SshKeyInfo} from '../../../types/common';
import {GrButton} from '../../shared/gr-button/gr-button';
import {IronAutogrowTextareaElement} from '@polymer/iron-autogrow-textarea/iron-autogrow-textarea';
import {GrOverlay} from '../../shared/gr-overlay/gr-overlay';
import {getAppContext} from '../../../services/app-context';
-import {LitElement, html} from 'lit';
+import {LitElement, css, html, PropertyValues} from 'lit';
import {customElement, property, query, state} from 'lit/decorators';
-import {sharedStyles} from '../../../styles/shared-styles';
-import {css} from 'lit';
-import {BindValueChangeEvent} from '../../../types/events';
-import {fire} from '../../../utils/event-util';
-import {PropertyValues} from 'lit';
import {formStyles} from '../../../styles/gr-form-styles';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {fire} from '../../../utils/event-util';
+import {BindValueChangeEvent} from '../../../types/events';
declare global {
interface HTMLElementTagNameMap {
@@ -69,8 +64,8 @@
static override get styles() {
return [
- sharedStyles,
formStyles,
+ sharedStyles,
css`
.statusHeader {
width: 4em;
@@ -102,6 +97,9 @@
min-width: 27em;
width: auto;
}
+ iron-autogrow-textarea {
+ background-color: var(--view-background-color);
+ }
`,
];
}
@@ -170,8 +168,8 @@
<iron-autogrow-textarea
id="newKey"
autocomplete="on"
- .bindValue=${this.newKey}
placeholder="New SSH Key"
+ .bindValue=${this.newKey}
@bind-value-changed=${(e: BindValueChangeEvent) => {
this.newKey = e.detail.value;
}}
@@ -241,14 +239,14 @@
}
private showKey(e: Event) {
- const el = (dom(e) as EventApi).localTarget as GrButton;
+ const el = e.target as GrButton;
const index = Number(el.getAttribute('data-index')!);
this.keyToView = this.keys[index];
this.viewKeyOverlay.open();
}
private handleDeleteKey(e: Event) {
- const el = (dom(e) as EventApi).localTarget as GrButton;
+ const el = e.target as GrButton;
const index = Number(el.getAttribute('data-index')!);
this.keysToRemove.push(this.keys[index]);
this.keys.splice(index, 1);
diff --git a/polygerrit-ui/app/elements/settings/gr-watched-projects-editor/gr-watched-projects-editor.ts b/polygerrit-ui/app/elements/settings/gr-watched-projects-editor/gr-watched-projects-editor.ts
index fa96059..bd3cc22 100644
--- a/polygerrit-ui/app/elements/settings/gr-watched-projects-editor/gr-watched-projects-editor.ts
+++ b/polygerrit-ui/app/elements/settings/gr-watched-projects-editor/gr-watched-projects-editor.ts
@@ -114,10 +114,10 @@
<th>
<gr-autocomplete
id="newProject"
- query=${this.query}
+ .query=${this.query}
threshold="1"
- allow-non-suggested-values=""
- tab-complete=""
+ allow-non-suggested-values
+ tab-complete
placeholder="Repo"
></gr-autocomplete>
</th>
diff --git a/polygerrit-ui/app/elements/settings/gr-watched-projects-editor/gr-watched-projects-editor_test.ts b/polygerrit-ui/app/elements/settings/gr-watched-projects-editor/gr-watched-projects-editor_test.ts
index bc21460..b540be8 100644
--- a/polygerrit-ui/app/elements/settings/gr-watched-projects-editor/gr-watched-projects-editor_test.ts
+++ b/polygerrit-ui/app/elements/settings/gr-watched-projects-editor/gr-watched-projects-editor_test.ts
@@ -18,17 +18,19 @@
import '../../../test/common-test-setup-karma';
import './gr-watched-projects-editor';
import {GrWatchedProjectsEditor} from './gr-watched-projects-editor';
-import {stubRestApi} from '../../../test/test-utils';
+import {stubRestApi, waitUntil} from '../../../test/test-utils';
import {ProjectWatchInfo} from '../../../types/common';
import {queryAll, queryAndAssert} from '../../../test/test-utils';
import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
import {IronInputElement} from '@polymer/iron-input';
import {assertIsDefined} from '../../../utils/common-util';
+import {GrAutocomplete} from '../../shared/gr-autocomplete/gr-autocomplete';
const basicFixture = fixtureFromElement('gr-watched-projects-editor');
suite('gr-watched-projects-editor tests', () => {
let element: GrWatchedProjectsEditor;
+ let suggestionStub: sinon.SinonStub;
setup(async () => {
const projects = [
@@ -55,7 +57,7 @@
] as ProjectWatchInfo[];
stubRestApi('getWatchedProjects').returns(Promise.resolve(projects));
- stubRestApi('getSuggestedProjects').callsFake(input => {
+ suggestionStub = stubRestApi('getSuggestedProjects').callsFake(input => {
if (input.startsWith('th')) {
return Promise.resolve({
'the project': {
@@ -120,6 +122,24 @@
assert.equal(projects[0].name, 'the project');
});
+ test('autocompletes repo input', async () => {
+ const repoAutocomplete = queryAndAssert<GrAutocomplete>(
+ element,
+ 'gr-autocomplete'
+ );
+ const repoInput = queryAndAssert<HTMLInputElement>(
+ repoAutocomplete,
+ '#input'
+ );
+
+ repoInput.focus();
+ repoAutocomplete.text = 'the';
+ await waitUntil(() => suggestionStub.called);
+ await repoAutocomplete.updateComplete;
+
+ assert.isTrue(suggestionStub.calledWith('the'));
+ });
+
test('_canAddProject', () => {
assert.isFalse(element.canAddProject(null, null, null));
diff --git a/polygerrit-ui/app/elements/shared/gr-account-entry/gr-account-entry.ts b/polygerrit-ui/app/elements/shared/gr-account-entry/gr-account-entry.ts
index 71023a1..6060826 100644
--- a/polygerrit-ui/app/elements/shared/gr-account-entry/gr-account-entry.ts
+++ b/polygerrit-ui/app/elements/shared/gr-account-entry/gr-account-entry.ts
@@ -81,10 +81,10 @@
.borderless=${this.borderless}
.placeholder=${this.placeholder}
.query=${this.querySuggestions}
- .allowNonSuggestedValues=${this.allowAnyInput}
+ allow-non-suggested-values=${this.allowAnyInput}
@commit=${this.handleInputCommit}
- clear-on-commit=""
- warn-uncommitted=""
+ clear-on-commit
+ warn-uncommitted
.text=${this.inputText}
.verticalOffset=${24}
@text-changed=${this.handleTextChanged}
diff --git a/polygerrit-ui/app/elements/shared/gr-account-entry/gr-account-entry_test.ts b/polygerrit-ui/app/elements/shared/gr-account-entry/gr-account-entry_test.ts
index 8b3452e..f08da9e 100644
--- a/polygerrit-ui/app/elements/shared/gr-account-entry/gr-account-entry_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-account-entry/gr-account-entry_test.ts
@@ -19,7 +19,7 @@
import './gr-account-entry';
import {GrAccountEntry} from './gr-account-entry';
import {fixture, html} from '@open-wc/testing-helpers';
-import {queryAndAssert} from '../../../test/test-utils';
+import {queryAndAssert, waitUntil} from '../../../test/test-utils';
import {GrAutocomplete} from '../gr-autocomplete/gr-autocomplete';
import {PaperInputElementExt} from '../../../types/types';
@@ -30,6 +30,7 @@
element = await fixture<GrAccountEntry>(html`
<gr-account-entry></gr-account-entry>
`);
+ await element.updateComplete;
});
test('account-text-changed fired when input text changed and allowAnyInput', async () => {
@@ -40,10 +41,10 @@
element.addEventListener('account-text-changed', changeStub);
queryAndAssert<GrAutocomplete>(element, '#input').text = 'a';
await element.updateComplete;
- assert.isTrue(changeStub.calledOnce);
+ await waitUntil(() => changeStub.calledOnce);
queryAndAssert<GrAutocomplete>(element, '#input').text = 'ab';
await element.updateComplete;
- assert.isTrue(changeStub.calledTwice);
+ await waitUntil(() => changeStub.calledTwice);
});
test('account-text-changed not fired when input text changed without allowAnyInput', async () => {
@@ -57,8 +58,8 @@
});
test('setText', async () => {
- // Spy on query, as that is called when _updateSuggestions proceeds.
- const suggestSpy = sinon.spy(
+ // Stub on query, as that is called when _updateSuggestions proceeds.
+ const suggestStub = sinon.stub(
queryAndAssert<GrAutocomplete>(element, '#input'),
'query'
);
@@ -70,6 +71,6 @@
queryAndAssert<PaperInputElementExt>(input, '#input').value,
'test text'
);
- assert.isFalse(suggestSpy.called);
+ assert.isFalse(suggestStub.called);
});
});
diff --git a/polygerrit-ui/app/elements/shared/gr-account-list/gr-account-list.ts b/polygerrit-ui/app/elements/shared/gr-account-list/gr-account-list.ts
index ddf177a..1143b4e 100644
--- a/polygerrit-ui/app/elements/shared/gr-account-list/gr-account-list.ts
+++ b/polygerrit-ui/app/elements/shared/gr-account-list/gr-account-list.ts
@@ -407,7 +407,7 @@
private handleInputKeydown(e: KeyboardEvent) {
const target = e.target as GrAccountEntry;
const entryInput = queryAndAssert<GrAutocomplete>(target, '#input');
- const input = this.getOwnNativeInput(entryInput.$.input);
+ const input = this.getOwnNativeInput(entryInput.input!);
if (
input.selectionStart !== input.selectionEnd ||
input.selectionStart !== 0
diff --git a/polygerrit-ui/app/elements/shared/gr-account-list/gr-account-list_test.ts b/polygerrit-ui/app/elements/shared/gr-account-list/gr-account-list_test.ts
index 5d7d312..981ad32 100644
--- a/polygerrit-ui/app/elements/shared/gr-account-list/gr-account-list_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-account-list/gr-account-list_test.ts
@@ -30,7 +30,7 @@
GroupName,
Suggestion,
} from '../../../types/common';
-import {queryAll, queryAndAssert} from '../../../test/test-utils';
+import {queryAll, queryAndAssert, waitUntil} from '../../../test/test-utils';
import {ReviewerSuggestionsProvider} from '../../../scripts/gr-reviewer-suggestions-provider/gr-reviewer-suggestions-provider';
import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
import {GrAutocomplete} from '../gr-autocomplete/gr-autocomplete';
@@ -429,12 +429,12 @@
'#input'
);
input.text = 'newTest';
- MockInteractions.focus(input.$.input);
+ MockInteractions.focus(input.input!);
input.noDebounce = true;
await element.updateComplete;
assert.isTrue(getSuggestionsStub.calledOnce);
assert.equal(getSuggestionsStub.lastCall.args[0], 'newTest');
- assert.equal(makeSuggestionItemSpy.getCalls().length, 2);
+ await waitUntil(() => makeSuggestionItemSpy.getCalls().length === 2);
});
suite('allowAnyInput', () => {
@@ -466,28 +466,28 @@
queryAndAssert<GrAccountEntry>(element, '#entry'),
'#input'
);
- sinon.stub(input, '_updateSuggestions');
+ sinon.stub(input, 'updateSuggestions');
sinon.stub(element, 'computeRemovable').returns(true);
- await await element.updateComplete;
+ await element.updateComplete;
// Next line is a workaround for Firefox not moving cursor
// on input field update
- assert.equal(element.getOwnNativeInput(input.$.input).selectionStart, 0);
+ assert.equal(element.getOwnNativeInput(input.input!).selectionStart, 0);
input.text = 'test';
- MockInteractions.focus(input.$.input);
+ MockInteractions.focus(input.input!);
await element.updateComplete;
assert.equal(element.accounts.length, 2);
MockInteractions.pressAndReleaseKeyOn(
- element.getOwnNativeInput(input.$.input),
+ element.getOwnNativeInput(input.input!),
8
); // Backspace
- assert.equal(element.accounts.length, 2);
+ await waitUntil(() => element.accounts.length === 2);
input.text = '';
+ await input.updateComplete;
MockInteractions.pressAndReleaseKeyOn(
- element.getOwnNativeInput(input.$.input),
+ element.getOwnNativeInput(input.input!),
8
); // Backspace
- await element.updateComplete;
- assert.equal(element.accounts.length, 1);
+ await waitUntil(() => element.accounts.length === 1);
});
test('arrow key navigation', async () => {
@@ -498,11 +498,11 @@
input.text = '';
element.accounts = [makeAccount(), makeAccount()];
await element.updateComplete;
- MockInteractions.focus(input.$.input);
- await await element.updateComplete;
+ MockInteractions.focus(input.input!);
+ await element.updateComplete;
const chips = element.accountChips;
const chipsOneSpy = sinon.spy(chips[1], 'focus');
- MockInteractions.pressAndReleaseKeyOn(input.$.input, 37); // Left
+ MockInteractions.pressAndReleaseKeyOn(input.input!, 37); // Left
assert.isTrue(chipsOneSpy.called);
const chipsZeroSpy = sinon.spy(chips[0], 'focus');
MockInteractions.pressAndReleaseKeyOn(chips[1], 37); // Left
diff --git a/polygerrit-ui/app/elements/shared/gr-autocomplete-dropdown/gr-autocomplete-dropdown.ts b/polygerrit-ui/app/elements/shared/gr-autocomplete-dropdown/gr-autocomplete-dropdown.ts
index 7216502..97b6be1 100644
--- a/polygerrit-ui/app/elements/shared/gr-autocomplete-dropdown/gr-autocomplete-dropdown.ts
+++ b/polygerrit-ui/app/elements/shared/gr-autocomplete-dropdown/gr-autocomplete-dropdown.ts
@@ -55,6 +55,10 @@
// This avoids JSC_DYNAMIC_EXTENDS_WITHOUT_JSDOC closure compiler error.
const base = IronFitMixin(PolymerElement, IronFitBehavior as IronFitBehavior);
+/**
+ * @attr {String} vertical-align - inherited from IronOverlay
+ * @attr {String} horizontal-align - inherited from IronOverlay
+ */
@customElement('gr-autocomplete-dropdown')
export class GrAutocompleteDropdown extends base {
static get template() {
@@ -132,9 +136,7 @@
open() {
this.isHidden = false;
- this._resetCursorStops();
- // Refit should run after we call Polymer.flush inside _resetCursorStops
- this.refit();
+ this.onSuggestionsChanged();
}
getCurrentText() {
@@ -219,7 +221,7 @@
}
@observe('suggestions')
- _resetCursorStops() {
+ onSuggestionsChanged() {
if (this.suggestions.length > 0) {
if (!this.isHidden) {
flush();
@@ -231,6 +233,7 @@
} else {
this.cursor.stops = [];
}
+ this.refit();
}
@observe('index')
diff --git a/polygerrit-ui/app/elements/shared/gr-autocomplete-dropdown/gr-autocomplete-dropdown_test.ts b/polygerrit-ui/app/elements/shared/gr-autocomplete-dropdown/gr-autocomplete-dropdown_test.ts
index 86de3b3..f8478cd 100644
--- a/polygerrit-ui/app/elements/shared/gr-autocomplete-dropdown/gr-autocomplete-dropdown_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-autocomplete-dropdown/gr-autocomplete-dropdown_test.ts
@@ -135,7 +135,7 @@
});
test('updated suggestions resets cursor stops', () => {
- const resetStopsSpy = sinon.spy(element, '_resetCursorStops');
+ const resetStopsSpy = sinon.spy(element, 'onSuggestionsChanged');
element.suggestions = [];
assert.isTrue(resetStopsSpy.called);
});
diff --git a/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete.ts b/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete.ts
index 36baf87..04fdd0f 100644
--- a/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete.ts
+++ b/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete.ts
@@ -19,27 +19,21 @@
import '../gr-cursor-manager/gr-cursor-manager';
import '../gr-icons/gr-icons';
import '../../../styles/shared-styles';
-import {flush} from '@polymer/polymer/lib/legacy/polymer.dom';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-autocomplete_html';
-import {property, customElement, observe} from '@polymer/decorators';
import {GrAutocompleteDropdown} from '../gr-autocomplete-dropdown/gr-autocomplete-dropdown';
import {PaperInputElementExt} from '../../../types/types';
-import {fireEvent} from '../../../utils/event-util';
+import {fire, fireEvent} from '../../../utils/event-util';
import {debounce, DelayedTask} from '../../../utils/async-util';
import {PropertyType} from '../../../types/common';
import {modifierPressed} from '../../../utils/dom-util';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {LitElement, html, css, PropertyValues} from 'lit';
+import {customElement, property, query, state} from 'lit/decorators';
+import {ValueChangedEvent} from '../../../types/events';
+import {IronInputElement} from '@polymer/iron-input';
const TOKENIZE_REGEX = /(?:[^\s"]+|"[^"]*")+/g;
const DEBOUNCE_WAIT_MS = 200;
-export interface GrAutocomplete {
- $: {
- input: PaperInputElementExt;
- suggestions: GrAutocompleteDropdown;
- };
-}
-
export type AutocompleteQuery<T = string> = (
text: string
) => Promise<Array<AutocompleteSuggestion<T>>>;
@@ -48,6 +42,10 @@
interface HTMLElementTagNameMap {
'gr-autocomplete': GrAutocomplete;
}
+ interface HTMLElementEventMap {
+ 'text-changed': ValueChangedEvent<string>;
+ 'value-changed': ValueChangedEvent<string>;
+ }
}
export interface AutocompleteSuggestion<T = string> {
@@ -65,10 +63,7 @@
CustomEvent<AutocompleteCommitEventDetail>;
@customElement('gr-autocomplete')
-export class GrAutocomplete extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
+export class GrAutocomplete extends LitElement {
/**
* Fired when a value is chosen.
*
@@ -101,6 +96,10 @@
@property({type: Object})
query?: AutocompleteQuery = () => Promise.resolve([]);
+ @query('#input') input?: PaperInputElementExt;
+
+ @query('#suggestions') suggestionsDropdown?: GrAutocompleteDropdown;
+
/**
* The number of characters that must be typed before suggestions are
* made. If threshold is zero, default suggestions are enabled.
@@ -108,7 +107,7 @@
@property({type: Number})
threshold = 1;
- @property({type: Boolean})
+ @property({type: Boolean, attribute: 'allow-non-suggested-values'})
allowNonSuggestedValues = false;
@property({type: Boolean})
@@ -117,7 +116,7 @@
@property({type: Boolean})
disabled = false;
- @property({type: Boolean})
+ @property({type: Boolean, attribute: 'show-search-icon'})
showSearchIcon = false;
/**
@@ -129,13 +128,13 @@
@property({type: Number})
verticalOffset = 31;
- @property({type: String, notify: true})
+ @property({type: String})
text = '';
@property({type: String})
placeholder = '';
- @property({type: Boolean})
+ @property({type: Boolean, attribute: 'clear-on-commit'})
clearOnCommit = false;
/**
@@ -143,10 +142,10 @@
* When false, tab key not caught, and focus is removed from the element.
* See Issue 4556, Issue 6645.
*/
- @property({type: Boolean})
+ @property({type: Boolean, attribute: 'tab-complete'})
tabComplete = false;
- @property({type: String, notify: true})
+ @property({type: String})
value = '';
/**
@@ -160,29 +159,17 @@
* When true and uncommitted text is left in the autocomplete input after
* blurring, the text will appear red.
*/
- @property({type: Boolean})
+ @property({type: Boolean, attribute: 'warn-uncommitted'})
warnUncommitted = false;
/**
* When true, querying for suggestions is not debounced w/r/t keypresses
*/
- @property({type: Boolean})
+ @property({type: Boolean, attribute: 'no-debounce'})
noDebounce = false;
- @property({type: Array})
- _suggestions: AutocompleteSuggestion[] = [];
-
- @property({type: Array})
- _suggestionEls = [];
-
- @property({type: Number})
- _index: number | null = null;
-
- @property({type: Boolean})
- _disableSuggestions = false;
-
- @property({type: Boolean})
- _focused = false;
+ @property({type: Boolean, attribute: 'show-blue-focus-border'})
+ showBlueFocusBorder = false;
/**
* Invisible label for input element. This label is exposed to
@@ -191,18 +178,88 @@
@property({type: String})
label = '';
- /** The DOM element of the selected suggestion. */
- @property({type: Object})
- _selected: HTMLElement | null = null;
+ @state() suggestions: AutocompleteSuggestion[] = [];
+
+ @state() index: number | null = null;
+
+ @state() disableSuggestions = false;
+
+ // private but used in tests
+ focused = false;
+
+ @state() selected: HTMLElement | null = null;
private updateSuggestionsTask?: DelayedTask;
- get _nativeInput() {
- // In Polymer 2 inputElement isn't nativeInput anymore
- return (this.$.input.$.nativeInput ||
- this.$.input.inputElement) as HTMLInputElement;
+ get nativeInput() {
+ return (this.input!.inputElement as IronInputElement)
+ .inputElement as HTMLInputElement;
}
+ static override styles = [
+ sharedStyles,
+ css`
+ .searchIcon {
+ display: none;
+ }
+ .searchIcon.showSearchIcon {
+ display: inline-block;
+ }
+ iron-icon {
+ margin: 0 var(--spacing-xs);
+ vertical-align: top;
+ }
+ paper-input.borderless {
+ border: none;
+ padding: 0;
+ }
+ paper-input {
+ background-color: var(--view-background-color);
+ color: var(--primary-text-color);
+ border: 1px solid var(--border-color);
+ border-radius: var(--border-radius);
+ padding: var(--spacing-s);
+ --paper-input-container_-_padding: 0;
+ --paper-input-container-input_-_font-size: var(--font-size-normal);
+ --paper-input-container-input_-_line-height: var(--line-height-normal);
+ /* This is a hack for not being able to set height:0 on the underline
+ of a paper-input 2.2.3 element. All the underline fixes below only
+ actually work in 3.x.x, so the height must be adjusted directly as
+ a workaround until we are on Polymer 3. */
+ height: var(--line-height-normal);
+ --paper-input-container-underline-height: 0;
+ --paper-input-container-underline-wrapper-height: 0;
+ --paper-input-container-underline-focus-height: 0;
+ --paper-input-container-underline-legacy-height: 0;
+ --paper-input-container-underline_-_height: 0;
+ --paper-input-container-underline_-_display: none;
+ --paper-input-container-underline-focus_-_height: 0;
+ --paper-input-container-underline-focus_-_display: none;
+ --paper-input-container-underline-disabled_-_height: 0;
+ --paper-input-container-underline-disabled_-_display: none;
+ /* Hide label for input. The label is still visible for
+ screen readers. Workaround found at:
+ https://github.com/PolymerElements/paper-input/issues/478 */
+ --paper-input-container-label_-_display: none;
+ }
+ paper-input.showBlueFocusBorder:focus {
+ border: 2px solid var(--input-focus-border-color);
+ /*
+ * The goal is to have a thicker blue border when focused and a thinner
+ * gray border when blurred. To avoid shifting neighboring elements
+ * around when the border size changes, a negative margin is added to
+ * compensate. box-sizing: border-box; will not work since there is
+ * important padding to add around the content.
+ */
+ margin: -1px;
+ }
+ paper-input.warnUncommitted {
+ --paper-input-container-input_-_color: var(--error-text-color);
+ --paper-input-container-input_-_font-size: inherit;
+ }
+ `,
+ ];
+
override connectedCallback() {
super.connectedCallback();
document.addEventListener('click', this.handleBodyClick);
@@ -214,98 +271,163 @@
super.disconnectedCallback();
}
+ override willUpdate(changedProperties: PropertyValues) {
+ if (
+ changedProperties.has('text') ||
+ changedProperties.has('threshold') ||
+ changedProperties.has('noDebounce')
+ ) {
+ this.updateSuggestions();
+ }
+ if (
+ changedProperties.has('suggestions') ||
+ changedProperties.has('focused')
+ ) {
+ this.maybeOpenDropdown();
+ }
+ if (changedProperties.has('text')) {
+ fire(this, 'text-changed', {value: this.text});
+ }
+ if (changedProperties.has('value')) {
+ fire(this, 'value-changed', {value: this.value});
+ }
+ }
+
+ override render() {
+ return html`
+ <paper-input
+ .noLabelFloat=${true}
+ id="input"
+ class=${this.computeClass()}
+ ?disabled=${this.disabled}
+ .value=${this.text}
+ @value-changed=${(e: CustomEvent) => {
+ this.text = e.detail.value;
+ }}
+ .placeholder=${this.placeholder}
+ @keydown=${this.handleKeydown}
+ @focus=${this.onInputFocus}
+ @blur=${this.onInputBlur}
+ autocomplete="off"
+ .label=${this.label}
+ >
+ <div slot="prefix">
+ <iron-icon
+ icon="gr-icons:search"
+ class="searchIcon ${this.computeShowSearchIconClass(
+ this.showSearchIcon
+ )}"
+ >
+ </iron-icon>
+ </div>
+
+ <div slot="suffix">
+ <slot name="suffix"></slot>
+ </div>
+ </paper-input>
+ <gr-autocomplete-dropdown
+ vertical-align="top"
+ .verticalOffset=${this.verticalOffset}
+ horizontal-align="left"
+ id="suggestions"
+ @item-selected=${this.handleItemSelect}
+ .suggestions=${this.suggestions}
+ role="listbox"
+ .index=${this.index}
+ >
+ </gr-autocomplete-dropdown>
+ `;
+ }
+
get focusStart() {
- return this.$.input;
+ return this.input;
}
override focus() {
- this._nativeInput.focus();
+ this.nativeInput.focus();
}
selectAll() {
- const nativeInputElement = this._nativeInput;
- if (!this.$.input.value) {
+ const nativeInputElement = this.nativeInput;
+ if (!this.input?.value) {
return;
}
- nativeInputElement.setSelectionRange(0, this.$.input.value.length);
+ nativeInputElement.setSelectionRange(0, this.input?.value.length);
}
clear() {
this.text = '';
}
- _handleItemSelect(e: CustomEvent) {
+ handleItemSelect(e: CustomEvent) {
if (e.detail.trigger === 'click') {
- this._selected = e.detail.selected;
+ this.selected = e.detail.selected;
this._commit();
e.stopPropagation();
e.preventDefault();
} else if (e.detail.trigger === 'enter') {
- this._handleInputCommit();
+ this.handleInputCommit();
e.stopPropagation();
e.preventDefault();
} else if (e.detail.trigger === 'tab') {
if (this.tabComplete) {
- this._handleInputCommit(true);
+ this.handleInputCommit(true);
e.stopPropagation();
e.preventDefault();
this.focus();
} else {
- this._focused = false;
+ this.setFocus(false);
}
}
}
- get _inputElement() {
- // Polymer2: this.$ can be undefined when this is first evaluated.
- return this.$ && this.$.input;
- }
-
/**
* Set the text of the input without triggering the suggestion dropdown.
*
* @param text The new text for the input.
*/
- setText(text: string) {
- this._disableSuggestions = true;
+ async setText(text: string) {
+ this.disableSuggestions = true;
this.text = text;
- this._disableSuggestions = false;
+ // if we disableSuggestions immediately then suggestions are requested in
+ // updateSuggestions
+ await this.updateComplete;
+ this.disableSuggestions = false;
}
- _onInputFocus() {
- this._focused = true;
- this._updateSuggestions(this.text, this.threshold, this.noDebounce);
- this.$.input.classList.remove('warnUncommitted');
+ onInputFocus() {
+ this.setFocus(true);
+ this.updateSuggestions();
+ this.input?.classList.remove('warnUncommitted');
// Needed so that --paper-input-container-input updated style is applied.
- this.updateStyles();
+ this.requestUpdate();
}
- _onInputBlur() {
- this.$.input.classList.toggle(
+ onInputBlur() {
+ this.input?.classList.toggle(
'warnUncommitted',
- this.warnUncommitted && !!this.text.length && !this._focused
+ this.warnUncommitted && !!this.text.length && !this.focused
);
// Needed so that --paper-input-container-input updated style is applied.
- this.updateStyles();
+ this.requestUpdate();
}
- @observe('text', 'threshold', 'noDebounce')
- _updateSuggestions(text?: string, threshold?: number, noDebounce?: boolean) {
+ updateSuggestions() {
if (
- text === undefined ||
- threshold === undefined ||
- noDebounce === undefined
+ this.text === undefined ||
+ this.threshold === undefined ||
+ this.noDebounce === undefined
)
return;
- // Reset _suggestions for every update
+ // Reset suggestions for every update
// This will also prevent from carrying over suggestions:
// @see Issue 12039
- this._suggestions = [];
+ this.suggestions = [];
// TODO(taoalpha): Also skip if text has not changed
- if (this._disableSuggestions) {
+ if (this.disableSuggestions) {
return;
}
@@ -314,33 +436,32 @@
return;
}
- if (text.length < threshold) {
+ if (this.text.length < this.threshold) {
this.value = '';
return;
}
- if (!this._focused) {
+ if (!this.focused) {
return;
}
const update = () => {
- query(text).then(suggestions => {
- if (text !== this.text) {
+ query(this.text).then(suggestions => {
+ if (this.text !== this.text) {
// Late response.
return;
}
for (const suggestion of suggestions) {
- suggestion.text = suggestion.name;
+ suggestion.text = suggestion?.name ?? '';
}
- this._suggestions = suggestions;
- flush();
- if (this._index === -1) {
+ this.suggestions = suggestions;
+ if (this.index === -1) {
this.value = '';
}
});
};
- if (noDebounce) {
+ if (this.noDebounce) {
update();
} else {
this.updateSuggestionsTask = debounce(
@@ -351,44 +472,52 @@
}
}
- @observe('_suggestions', '_focused')
- _maybeOpenDropdown(suggestions: AutocompleteSuggestion[], focused: boolean) {
- if (suggestions.length > 0 && focused) {
- this.$.suggestions.open();
- return;
- }
- this.$.suggestions.close();
+ setFocus(focused: boolean) {
+ if (focused === this.focused) return;
+ this.focused = focused;
+ this.maybeOpenDropdown();
}
- _computeClass(borderless?: boolean) {
- return borderless ? 'borderless' : '';
+ maybeOpenDropdown() {
+ if (this.suggestions.length > 0 && this.focused) {
+ this.suggestionsDropdown?.open();
+ return;
+ }
+ this.suggestionsDropdown?.close();
+ }
+
+ computeClass() {
+ const classes = [];
+ if (this.borderless) classes.push('borderless');
+ if (this.showBlueFocusBorder) classes.push('showBlueFocusBorder');
+ return classes.join(' ');
}
/**
- * _handleKeydown used for key handling in the this.$.input.
+ * handleKeydown used for key handling in the this.input?.
*/
- _handleKeydown(e: KeyboardEvent) {
- this._focused = true;
+ handleKeydown(e: KeyboardEvent) {
+ this.setFocus(true);
switch (e.keyCode) {
case 38: // Up
e.preventDefault();
- this.$.suggestions.cursorUp();
+ this.suggestionsDropdown?.cursorUp();
break;
case 40: // Down
e.preventDefault();
- this.$.suggestions.cursorDown();
+ this.suggestionsDropdown?.cursorDown();
break;
case 27: // Escape
e.preventDefault();
- this._cancel();
+ this.cancel();
break;
case 9: // Tab
- if (this._suggestions.length > 0 && this.tabComplete) {
+ if (this.suggestions.length > 0 && this.tabComplete) {
e.preventDefault();
- this._handleInputCommit(true);
this.focus();
+ this.handleInputCommit(true);
} else {
- this._focused = false;
+ this.setFocus(false);
}
break;
case 13: // Enter
@@ -396,7 +525,7 @@
break;
}
e.preventDefault();
- this._handleInputCommit();
+ this.handleInputCommit();
break;
default:
// For any normal keypress, return focus to the input to allow for
@@ -407,36 +536,37 @@
// been based on a previous input. Clear them. This prevents an
// outdated suggestion from being used if the input keystroke is
// immediately followed by a commit keystroke. @see Issue 8655
- this._suggestions = [];
+ this.suggestions = [];
}
this.dispatchEvent(
new CustomEvent('input-keydown', {
- detail: {keyCode: e.keyCode, input: this.$.input},
+ detail: {keyCode: e.keyCode, input: this.input},
composed: true,
bubbles: true,
})
);
}
- _cancel() {
- if (this._suggestions.length) {
- this.set('_suggestions', []);
+ cancel() {
+ if (this.suggestions.length) {
+ this.suggestions = [];
+ this.requestUpdate();
} else {
fireEvent(this, 'cancel');
}
}
- _handleInputCommit(_tabComplete?: boolean) {
+ handleInputCommit(_tabComplete?: boolean) {
// Nothing to do if the dropdown is not open.
- if (!this.allowNonSuggestedValues && this.$.suggestions.isHidden) {
+ if (!this.allowNonSuggestedValues && this.suggestionsDropdown?.isHidden) {
return;
}
- this._selected = this.$.suggestions.getCursorTarget();
+ this.selected = this.suggestionsDropdown?.getCursorTarget() ?? null;
this._commit(_tabComplete);
}
- _updateValue(
+ updateValue(
suggestion: HTMLElement | null,
suggestions: AutocompleteSuggestion[]
) {
@@ -468,7 +598,7 @@
return;
}
}
- this._focused = false;
+ this.setFocus(false);
};
/**
@@ -478,10 +608,10 @@
* autocomplete suggestion in order to handle cases like tab-to-complete
* without firing the commit event.
*/
- _commit(silent?: boolean) {
+ async _commit(silent?: boolean) {
// Allow values that are not in suggestion list iff suggestions are empty.
- if (this._suggestions.length > 0) {
- this._updateValue(this._selected, this._suggestions);
+ if (this.suggestions.length > 0) {
+ this.updateValue(this.selected, this.suggestions);
} else {
this.value = this.text || '';
}
@@ -492,20 +622,23 @@
if (this.multi) {
this.setText(this.value);
} else {
- if (!this.clearOnCommit && this._selected) {
- const dataSet = this._selected.dataset;
+ if (!this.clearOnCommit && this.selected) {
+ const dataSet = this.selected.dataset;
// index property cannot be null for the data-set
if (dataSet) {
const index = Number(dataSet['index']!);
if (isNaN(index)) return;
- this.setText(this._suggestions[index].name || '');
+ this.setText(this.suggestions[index]?.name || '');
}
} else {
this.clear();
}
}
- this._suggestions = [];
+ this.suggestions = [];
+ // we need willUpdate to send text-changed event before we can send the
+ // 'commit' event
+ await this.updateComplete;
if (!silent) {
this.dispatchEvent(
new CustomEvent('commit', {
@@ -517,7 +650,7 @@
}
}
- _computeShowSearchIconClass(showSearchIcon: boolean) {
+ computeShowSearchIconClass(showSearchIcon: boolean) {
return showSearchIcon ? 'showSearchIcon' : '';
}
}
diff --git a/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete_html.ts b/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete_html.ts
deleted file mode 100644
index bdb65ea..0000000
--- a/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete_html.ts
+++ /dev/null
@@ -1,122 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="shared-styles">
- .searchIcon {
- display: none;
- }
- .searchIcon.showSearchIcon {
- display: inline-block;
- }
- iron-icon {
- margin: 0 var(--spacing-xs);
- vertical-align: top;
- }
- paper-input.borderless {
- border: none;
- padding: 0;
- }
- paper-input {
- background-color: var(--view-background-color);
- color: var(--primary-text-color);
- border: 1px solid var(--border-color);
- border-radius: var(--border-radius);
- padding: var(--spacing-s);
- --paper-input-container: {
- padding: 0;
- }
- --paper-input-container-input: {
- font-size: var(--font-size-normal);
- line-height: var(--line-height-normal);
- }
- /* This is a hack for not being able to set height:0 on the underline
- of a paper-input 2.2.3 element. All the underline fixes below only
- actually work in 3.x.x, so the height must be adjusted directly as
- a workaround until we are on Polymer 3. */
- height: var(--line-height-normal);
- --paper-input-container-underline-height: 0;
- --paper-input-container-underline-wrapper-height: 0;
- --paper-input-container-underline-focus-height: 0;
- --paper-input-container-underline-legacy-height: 0;
- --paper-input-container-underline: {
- height: 0;
- display: none;
- }
- --paper-input-container-underline-focus: {
- height: 0;
- display: none;
- }
- --paper-input-container-underline-disabled: {
- height: 0;
- display: none;
- }
- /* Hide label for input. The label is still visible for
- screen readers. Workaround found at:
- https://github.com/PolymerElements/paper-input/issues/478 */
- --paper-input-container-label: {
- display: none;
- }
- }
- paper-input.warnUncommitted {
- --paper-input-container-input: {
- color: var(--error-text-color);
- font-size: inherit;
- }
- }
- </style>
- <paper-input
- no-label-float=""
- id="input"
- class$="[[_computeClass(borderless)]]"
- disabled$="[[disabled]]"
- value="{{text}}"
- placeholder="[[placeholder]]"
- on-keydown="_handleKeydown"
- on-focus="_onInputFocus"
- on-blur="_onInputBlur"
- autocomplete="off"
- label="[[label]]"
- >
- <!-- prefix as attribute is required to for polymer 1 -->
- <div slot="prefix" prefix="">
- <iron-icon
- icon="gr-icons:search"
- class$="searchIcon [[_computeShowSearchIconClass(showSearchIcon)]]"
- >
- </iron-icon>
- </div>
-
- <!-- suffix as attribute is required to for polymer 1 -->
- <div slot="suffix" suffix="">
- <slot name="suffix"></slot>
- </div>
- </paper-input>
- <gr-autocomplete-dropdown
- vertical-align="top"
- vertical-offset="[[verticalOffset]]"
- horizontal-align="left"
- id="suggestions"
- on-item-selected="_handleItemSelect"
- suggestions="[[_suggestions]]"
- role="listbox"
- index="[[_index]]"
- position-target="[[_inputElement]]"
- >
- </gr-autocomplete-dropdown>
-`;
diff --git a/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete_test.ts b/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete_test.ts
index 375d3f3..7f66b60 100644
--- a/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-autocomplete/gr-autocomplete_test.ts
@@ -16,17 +16,13 @@
*/
import '../../../test/common-test-setup-karma';
import './gr-autocomplete';
-import {html} from '@polymer/polymer/lib/utils/html-tag';
import {AutocompleteSuggestion, GrAutocomplete} from './gr-autocomplete';
import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
import {assertIsDefined} from '../../../utils/common-util';
-import {queryAll, queryAndAssert} from '../../../test/test-utils';
+import {queryAll, queryAndAssert, waitUntil} from '../../../test/test-utils';
import {GrAutocompleteDropdown} from '../gr-autocomplete-dropdown/gr-autocomplete-dropdown';
import {PaperInputElement} from '@polymer/paper-input/paper-input';
-
-const basicFixture = fixtureFromTemplate(
- html`<gr-autocomplete no-debounce></gr-autocomplete>`
-);
+import {fixture, html} from '@open-wc/testing-helpers';
suite('gr-autocomplete tests', () => {
let element: GrAutocomplete;
@@ -40,11 +36,14 @@
const inputEl = () => queryAndAssert<HTMLInputElement>(element, '#input');
- setup(() => {
- element = basicFixture.instantiate() as GrAutocomplete;
+ setup(async () => {
+ element = await fixture(
+ html`<gr-autocomplete no-debounce></gr-autocomplete>`
+ );
+ await element.updateComplete;
});
- test('renders', () => {
+ test('renders', async () => {
let promise: Promise<AutocompleteSuggestion[]> = Promise.resolve([]);
const queryStub = sinon.spy(
(input: string) =>
@@ -62,12 +61,14 @@
focusOnInput();
element.text = 'blah';
+ await waitUntil(() => queryStub.called);
assert.isTrue(queryStub.called);
- element._focused = true;
+ element.setFocus(true);
assertIsDefined(promise);
- return promise.then(() => {
+ return promise.then(async () => {
+ await element.updateComplete;
assert.isFalse(suggestionsEl().isHidden);
const suggestions = queryAll<HTMLElement>(suggestionsEl(), 'li');
assert.equal(suggestions.length, 5);
@@ -81,19 +82,21 @@
});
test('selectAll', async () => {
- await flush();
- const nativeInput = element._nativeInput;
+ await element.updateComplete;
+ const nativeInput = element.nativeInput;
const selectionStub = sinon.stub(nativeInput, 'setSelectionRange');
element.selectAll();
+ await element.updateComplete;
assert.isFalse(selectionStub.called);
inputEl().value = 'test';
+ await element.updateComplete;
element.selectAll();
assert.isTrue(selectionStub.called);
});
- test('esc key behavior', () => {
+ test('esc key behavior', async () => {
let promise: Promise<AutocompleteSuggestion[]> = Promise.resolve([]);
const queryStub = sinon.spy(
(_: string) =>
@@ -105,26 +108,30 @@
assert.isTrue(suggestionsEl().isHidden);
- element._focused = true;
+ element.setFocus(true);
element.text = 'blah';
+ await element.updateComplete;
- return promise.then(() => {
- assert.isFalse(suggestionsEl().isHidden);
+ return promise.then(async () => {
+ await waitUntil(() => !suggestionsEl().isHidden);
const cancelHandler = sinon.spy();
element.addEventListener('cancel', cancelHandler);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 27, null, 'esc');
+ await waitUntil(() => suggestionsEl().isHidden);
+
assert.isFalse(cancelHandler.called);
- assert.isTrue(suggestionsEl().isHidden);
- assert.equal(element._suggestions.length, 0);
+ assert.equal(element.suggestions.length, 0);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 27, null, 'esc');
+ await element.updateComplete;
+
assert.isTrue(cancelHandler.called);
});
});
- test('emits commit and handles cursor movement', () => {
+ test('emits commit and handles cursor movement', async () => {
let promise: Promise<AutocompleteSuggestion[]> = Promise.resolve([]);
const queryStub = sinon.spy(
(input: string) =>
@@ -137,14 +144,16 @@
] as AutocompleteSuggestion[]))
);
element.query = queryStub;
-
+ await element.updateComplete;
assert.isTrue(suggestionsEl().isHidden);
assert.equal(suggestionsEl().cursor.index, -1);
- element._focused = true;
- element.text = 'blah';
+ element.setFocus(true);
- return promise.then(() => {
- assert.isFalse(suggestionsEl().isHidden);
+ element.text = 'blah';
+ await element.updateComplete;
+
+ return promise.then(async () => {
+ await waitUntil(() => !suggestionsEl().isHidden);
const commitHandler = sinon.spy();
element.addEventListener('commit', commitHandler);
@@ -152,28 +161,33 @@
assert.equal(suggestionsEl().cursor.index, 0);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 40, null, 'down');
+ await element.updateComplete;
assert.equal(suggestionsEl().cursor.index, 1);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 40, null, 'down');
+ await element.updateComplete;
assert.equal(suggestionsEl().cursor.index, 2);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 38, null, 'up');
+ await element.updateComplete;
assert.equal(suggestionsEl().cursor.index, 1);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 13, null, 'enter');
+ await element.updateComplete;
assert.equal(element.value, '1');
- assert.isTrue(commitHandler.called);
+
+ await waitUntil(() => commitHandler.called);
assert.equal(commitHandler.getCall(0).args[0].detail.value, 1);
assert.isTrue(suggestionsEl().isHidden);
- assert.isTrue(element._focused);
+ assert.isTrue(element.focused);
});
});
- test('clear-on-commit behavior (off)', () => {
+ test('clear-on-commit behavior (off)', async () => {
let promise: Promise<AutocompleteSuggestion[]> = Promise.resolve([]);
const queryStub = sinon.spy(() => {
promise = Promise.resolve([
@@ -184,19 +198,21 @@
element.query = queryStub;
focusOnInput();
element.text = 'blah';
+ await waitUntil(() => element.suggestions.length > 0);
- return promise.then(() => {
+ return promise.then(async () => {
const commitHandler = sinon.spy();
element.addEventListener('commit', commitHandler);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 13, null, 'enter');
- assert.isTrue(commitHandler.called);
+ await waitUntil(() => commitHandler.called);
+
assert.equal(element.text, 'suggestion');
});
});
- test('clear-on-commit behavior (on)', () => {
+ test('clear-on-commit behavior (on)', async () => {
let promise: Promise<AutocompleteSuggestion[]> = Promise.resolve([]);
const queryStub = sinon.spy(() => {
promise = Promise.resolve([
@@ -207,20 +223,24 @@
element.query = queryStub;
focusOnInput();
element.text = 'blah';
+
+ await waitUntil(() => element.suggestions.length > 0);
+
element.clearOnCommit = true;
- return promise.then(() => {
+ return promise.then(async () => {
const commitHandler = sinon.spy();
element.addEventListener('commit', commitHandler);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 13, null, 'enter');
- assert.isTrue(commitHandler.called);
+ await waitUntil(() => commitHandler.called);
+
assert.equal(element.text, '');
});
});
- test('threshold guards the query', () => {
+ test('threshold guards the query', async () => {
const queryStub = sinon.spy(() =>
Promise.resolve([] as AutocompleteSuggestion[])
);
@@ -228,17 +248,21 @@
element.threshold = 2;
focusOnInput();
element.text = 'a';
+ await element.updateComplete;
assert.isFalse(queryStub.called);
+
element.text = 'ab';
- assert.isTrue(queryStub.called);
+ await element.updateComplete;
+ await waitUntil(() => queryStub.called);
});
- test('noDebounce=false debounces the query', () => {
- const clock = sinon.useFakeTimers();
+ test('noDebounce=false debounces the query', async () => {
const queryStub = sinon.spy(() =>
Promise.resolve([] as AutocompleteSuggestion[])
);
+
element.query = queryStub;
+ await element.updateComplete;
element.noDebounce = false;
focusOnInput();
element.text = 'a';
@@ -246,23 +270,27 @@
// not called right away
assert.isFalse(queryStub.called);
- // but called after a while
- clock.tick(1000);
- assert.isTrue(queryStub.called);
+ await waitUntil(() => queryStub.called);
});
- test('_computeClass respects border property', () => {
- assert.equal(element._computeClass(), '');
- assert.equal(element._computeClass(false), '');
- assert.equal(element._computeClass(true), 'borderless');
+ test('computeClass respects border property', () => {
+ element.borderless = false;
+ assert.equal(element.computeClass(), '');
+ element.borderless = true;
+ assert.equal(element.computeClass(), 'borderless');
+ element.showBlueFocusBorder = true;
+ assert.equal(element.computeClass(), 'borderless showBlueFocusBorder');
});
- test('undefined or empty text results in no suggestions', () => {
- element._updateSuggestions(undefined, 0, undefined);
- assert.equal(element._suggestions.length, 0);
+ test('empty text results in no suggestions', async () => {
+ element.text = '';
+ element.threshold = 0;
+ element.noDebounce = false;
+ await element.updateComplete;
+ assert.equal(element.suggestions.length, 0);
});
- test('when focused', () => {
+ test('when focused', async () => {
let promise: Promise<AutocompleteSuggestion[]> = Promise.resolve([]);
const queryStub = sinon
.stub()
@@ -274,15 +302,16 @@
element.query = queryStub;
focusOnInput();
element.text = 'bla';
- assert.equal(element._focused, true);
- flush();
- return promise.then(() => {
- assert.equal(element._suggestions.length, 1);
+ assert.equal(element.focused, true);
+ await element.updateComplete;
+ return promise.then(async () => {
+ await waitUntil(() => element.suggestions.length > 0);
+ assert.equal(element.suggestions.length, 1);
assert.equal(queryStub.notCalled, false);
});
});
- test('when not focused', () => {
+ test('when not focused', async () => {
let promise: Promise<AutocompleteSuggestion[]> = Promise.resolve([]);
const queryStub = sinon
.stub()
@@ -293,14 +322,14 @@
);
element.query = queryStub;
element.text = 'bla';
- assert.equal(element._focused, false);
- flush();
+ assert.equal(element.focused, false);
+ await element.updateComplete;
return promise.then(() => {
- assert.equal(element._suggestions.length, 0);
+ assert.equal(element.suggestions.length, 0);
});
});
- test('suggestions should not carry over', () => {
+ test('suggestions should not carry over', async () => {
let promise: Promise<AutocompleteSuggestion[]> = Promise.resolve([]);
const queryStub = sinon
.stub()
@@ -312,15 +341,19 @@
element.query = queryStub;
focusOnInput();
element.text = 'bla';
- flush();
- return promise.then(() => {
- assert.equal(element._suggestions.length, 1);
- element._updateSuggestions('', 0, false);
- assert.equal(element._suggestions.length, 0);
+ await element.updateComplete;
+ return promise.then(async () => {
+ await waitUntil(() => element.suggestions.length > 0);
+ assert.equal(element.suggestions.length, 1);
+ element.text = '';
+ element.threshold = 0;
+ element.noDebounce = false;
+ await element.updateComplete;
+ assert.equal(element.suggestions.length, 0);
});
});
- test('multi completes only the last part of the query', () => {
+ test('multi completes only the last part of the query', async () => {
let promise;
const queryStub = sinon
.stub()
@@ -333,139 +366,160 @@
focusOnInput();
element.text = 'blah blah';
element.multi = true;
+ await element.updateComplete;
- return promise.then(() => {
+ return promise.then(async () => {
const commitHandler = sinon.spy();
element.addEventListener('commit', commitHandler);
+ await waitUntil(() => element.suggestionsDropdown?.isHidden === false);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 13, null, 'enter');
- assert.isTrue(commitHandler.called);
+ await waitUntil(() => commitHandler.called);
assert.equal(element.text, 'blah 0');
});
});
- test('tabComplete flag functions', () => {
+ test('tabComplete flag functions', async () => {
// commitHandler checks for the commit event, whereas commitSpy checks for
// the _commit function of the element.
const commitHandler = sinon.spy();
element.addEventListener('commit', commitHandler);
const commitSpy = sinon.spy(element, '_commit');
- element._focused = true;
+ element.setFocus(true);
- element._suggestions = [{text: 'tunnel snakes rule!'}];
+ element.suggestions = [{text: 'tunnel snakes rule!', name: ''}];
element.tabComplete = false;
MockInteractions.pressAndReleaseKeyOn(inputEl(), 9, null, 'tab');
+ await element.updateComplete;
+
assert.isFalse(commitHandler.called);
assert.isFalse(commitSpy.called);
- assert.isFalse(element._focused);
+ assert.isFalse(element.focused);
element.tabComplete = true;
- element._focused = true;
+ await element.updateComplete;
+ element.setFocus(true);
+ await element.updateComplete;
MockInteractions.pressAndReleaseKeyOn(inputEl(), 9, null, 'tab');
+
+ await waitUntil(() => commitSpy.called);
assert.isFalse(commitHandler.called);
- assert.isTrue(commitSpy.called);
- assert.isTrue(element._focused);
+ assert.isTrue(element.focused);
});
- test('_focused flag properly triggered', () => {
- flush();
- assert.isFalse(element._focused);
+ test('focused flag properly triggered', async () => {
+ await element.updateComplete;
+ assert.isFalse(element.focused);
const input = queryAndAssert<PaperInputElement>(
element,
'paper-input'
).inputElement;
MockInteractions.focus(input);
- assert.isTrue(element._focused);
+ assert.isTrue(element.focused);
});
- test('search icon shows with showSearchIcon property', () => {
- flush();
+ test('search icon shows with showSearchIcon property', async () => {
assert.equal(
getComputedStyle(queryAndAssert(element, 'iron-icon')).display,
'none'
);
element.showSearchIcon = true;
+ await element.updateComplete;
+
assert.notEqual(
getComputedStyle(queryAndAssert(element, 'iron-icon')).display,
'none'
);
});
- test('vertical offset overridden by param if it exists', () => {
+ test('vertical offset overridden by param if it exists', async () => {
assert.equal(suggestionsEl().verticalOffset, 31);
+
element.verticalOffset = 30;
+ await element.updateComplete;
+
assert.equal(suggestionsEl().verticalOffset, 30);
});
- test('_focused flag shows/hides the suggestions', () => {
+ test('focused flag shows/hides the suggestions', async () => {
const openStub = sinon.stub(suggestionsEl(), 'open');
const closedStub = sinon.stub(suggestionsEl(), 'close');
- element._suggestions = [{text: 'hello'}, {text: 'its me'}];
+ element.suggestions = [{text: 'hello'}, {text: 'its me'}];
assert.isFalse(openStub.called);
- assert.isTrue(closedStub.calledOnce);
- element._focused = true;
- assert.isTrue(openStub.calledOnce);
- element._suggestions = [];
- assert.isTrue(closedStub.calledTwice);
+ await waitUntil(() => closedStub.calledOnce);
+ element.setFocus(true);
+ await waitUntil(() => openStub.calledOnce);
+ element.suggestions = [];
+ await waitUntil(() => closedStub.calledTwice);
assert.isTrue(openStub.calledOnce);
});
test(
- '_handleInputCommit with autocomplete hidden does nothing without' +
+ 'handleInputCommit with autocomplete hidden does nothing without' +
'without allowNonSuggestedValues',
() => {
const commitStub = sinon.stub(element, '_commit');
suggestionsEl().isHidden = true;
- element._handleInputCommit();
+ element.handleInputCommit();
assert.isFalse(commitStub.called);
}
);
test(
- '_handleInputCommit with autocomplete hidden with' +
+ 'handleInputCommit with autocomplete hidden with' +
'allowNonSuggestedValues',
() => {
const commitStub = sinon.stub(element, '_commit');
element.allowNonSuggestedValues = true;
suggestionsEl().isHidden = true;
- element._handleInputCommit();
+ element.handleInputCommit();
assert.isTrue(commitStub.called);
}
);
- test('_handleInputCommit with autocomplete open calls commit', () => {
+ test('handleInputCommit with autocomplete open calls commit', () => {
const commitStub = sinon.stub(element, '_commit');
suggestionsEl().isHidden = false;
- element._handleInputCommit();
+ element.handleInputCommit();
assert.isTrue(commitStub.calledOnce);
});
test(
- '_handleInputCommit with autocomplete open calls commit' +
+ 'handleInputCommit with autocomplete open calls commit' +
'with allowNonSuggestedValues',
() => {
const commitStub = sinon.stub(element, '_commit');
element.allowNonSuggestedValues = true;
suggestionsEl().isHidden = false;
- element._handleInputCommit();
+ element.handleInputCommit();
assert.isTrue(commitStub.calledOnce);
}
);
- test('issue 8655', () => {
+ test('issue 8655', async () => {
function makeSuggestion(s: string) {
return {name: s, text: s, value: s};
}
- const keydownSpy = sinon.spy(element, '_handleKeydown');
+ const keydownSpy = sinon.spy(element, 'handleKeydown');
+ element.requestUpdate();
+ await element.updateComplete;
+
+ // const dispatchEventStub = sinon.stub(element, 'dispatchEvent');
element.setText('file:');
- element._suggestions = [makeSuggestion('file:'), makeSuggestion('-file:')];
+ element.suggestions = [makeSuggestion('file:'), makeSuggestion('-file:')];
+ await element.updateComplete;
+
MockInteractions.pressAndReleaseKeyOn(inputEl(), 88, null, 'x');
// Must set the value, because the MockInteraction does not.
inputEl().value = 'file:x';
+
assert.isTrue(keydownSpy.calledOnce);
+
MockInteractions.pressAndReleaseKeyOn(inputEl(), 13, null, 'enter');
+ await element.updateComplete;
assert.isTrue(keydownSpy.calledTwice);
+
assert.equal(element.text, 'file:x');
});
@@ -477,50 +531,56 @@
commitSpy = sinon.spy(element, '_commit');
});
- test('enter does not call focus', () => {
- element._suggestions = [{text: 'sugar bombs'}];
+ test('enter does not call focus', async () => {
+ element.suggestions = [{text: 'sugar bombs'}];
+
focusSpy = sinon.spy(element, 'focus');
MockInteractions.pressAndReleaseKeyOn(inputEl(), 13, null, 'enter');
- flush();
- assert.isTrue(commitSpy.called);
+ // Dropdown is hidden without focus so this should never happen?
+ await waitUntil(() => commitSpy.called);
+
assert.isFalse(focusSpy.called);
- assert.equal(element._suggestions.length, 0);
+ assert.equal(element.suggestions.length, 0);
});
- test('tab in input, tabComplete = true', () => {
+ test('tab in input, tabComplete = true', async () => {
focusSpy = sinon.spy(element, 'focus');
const commitHandler = sinon.stub();
element.addEventListener('commit', commitHandler);
element.tabComplete = true;
- element._suggestions = [{text: 'tunnel snakes drool'}];
- MockInteractions.pressAndReleaseKeyOn(inputEl(), 9, null, 'tab');
- flush();
+ element.suggestions = [{text: 'tunnel snakes drool'}];
- assert.isTrue(commitSpy.called);
+ MockInteractions.pressAndReleaseKeyOn(inputEl(), 9, null, 'tab');
+
+ await waitUntil(() => commitSpy.called);
+
assert.isTrue(focusSpy.called);
assert.isFalse(commitHandler.called);
- assert.equal(element._suggestions.length, 0);
+ assert.equal(element.suggestions.length, 0);
});
- test('tab in input, tabComplete = false', () => {
- element._suggestions = [{text: 'sugar bombs'}];
+ test('tab in input, tabComplete = false', async () => {
+ element.suggestions = [{text: 'sugar bombs'}];
focusSpy = sinon.spy(element, 'focus');
MockInteractions.pressAndReleaseKeyOn(inputEl(), 9, null, 'tab');
- flush();
+ await element.updateComplete;
assert.isFalse(commitSpy.called);
assert.isFalse(focusSpy.called);
- assert.equal(element._suggestions.length, 1);
+ await waitUntil(() => element.suggestions.length > 0);
+ assert.equal(element.suggestions.length, 1);
});
test('tab on suggestion, tabComplete = false', async () => {
- element._suggestions = [{name: 'sugar bombs'}];
- element._focused = true;
+ element.suggestions = [{name: 'sugar bombs'}];
+ element.setFocus(true);
// When tabComplete is false, do not focus.
element.tabComplete = false;
focusSpy = sinon.spy(element, 'focus');
- flush();
+
+ await element.updateComplete;
+
assert.isFalse(suggestionsEl().isHidden);
MockInteractions.pressAndReleaseKeyOn(
@@ -529,18 +589,20 @@
null,
'Tab'
);
- await flush();
+ await element.updateComplete;
assert.isFalse(commitSpy.called);
- assert.isFalse(element._focused);
+ assert.isFalse(element.focused);
});
test('tab on suggestion, tabComplete = true', async () => {
- element._suggestions = [{name: 'sugar bombs'}];
- element._focused = true;
+ element.suggestions = [{name: 'sugar bombs'}];
+ element.setFocus(true);
// When tabComplete is true, focus.
element.tabComplete = true;
focusSpy = sinon.spy(element, 'focus');
- flush();
+
+ await element.updateComplete;
+
assert.isFalse(suggestionsEl().isHidden);
MockInteractions.pressAndReleaseKeyOn(
@@ -549,42 +611,52 @@
null,
'Tab'
);
- await flush();
+ await element.updateComplete;
assert.isTrue(commitSpy.called);
- assert.isTrue(element._focused);
+ assert.isTrue(element.focused);
});
- test('tap on suggestion commits, does not call focus', () => {
+ test('tap on suggestion commits, does not call focus', async () => {
focusSpy = sinon.spy(element, 'focus');
- element._focused = true;
- element._suggestions = [{name: 'first suggestion'}];
- flush();
- assert.isFalse(suggestionsEl().isHidden);
- MockInteractions.tap(queryAndAssert(suggestionsEl(), 'li:first-child'));
- flush();
+ element.setFocus(true);
+ element.suggestions = [{name: 'first suggestion'}];
+ await element.updateComplete;
+
+ await waitUntil(() => !suggestionsEl().isHidden);
+ MockInteractions.tap(queryAndAssert(suggestionsEl(), 'li:first-child'));
+
+ await waitUntil(() => suggestionsEl().isHidden);
assert.isFalse(focusSpy.called);
assert.isTrue(commitSpy.called);
- assert.isTrue(suggestionsEl().isHidden);
});
});
- test('input-keydown event fired', () => {
+ test('input-keydown event fired', async () => {
const listener = sinon.spy();
element.addEventListener('input-keydown', listener);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 9, null, 'tab');
- flush();
+ await element.updateComplete;
assert.isTrue(listener.called);
});
- test('enter with modifier does not complete', () => {
- const handleSpy = sinon.spy(element, '_handleKeydown');
- const commitStub = sinon.stub(element, '_handleInputCommit');
+ test('enter with modifier does not complete', async () => {
+ const dispatchEventStub = sinon.stub(element, 'dispatchEvent');
+ const commitStub = sinon.stub(element, 'handleInputCommit');
MockInteractions.pressAndReleaseKeyOn(inputEl(), 13, 'ctrl', 'enter');
- assert.isTrue(handleSpy.called);
+ await element.updateComplete;
+
+ assert.equal(dispatchEventStub.lastCall.args[0].type, 'input-keydown');
+ assert.equal(
+ (dispatchEventStub.lastCall.args[0] as CustomEvent).detail.keyCode,
+ 13
+ );
+
assert.isFalse(commitStub.called);
MockInteractions.pressAndReleaseKeyOn(inputEl(), 13, null, 'enter');
+ await element.updateComplete;
+
assert.isTrue(commitStub.called);
});
diff --git a/polygerrit-ui/app/elements/shared/gr-button/gr-button.ts b/polygerrit-ui/app/elements/shared/gr-button/gr-button.ts
index 7e7dca6..1282666 100644
--- a/polygerrit-ui/app/elements/shared/gr-button/gr-button.ts
+++ b/polygerrit-ui/app/elements/shared/gr-button/gr-button.ts
@@ -31,6 +31,7 @@
}
/**
* @attr {Boolean} no-uppercase - text in button is not uppercased
+ * @attr {Boolean} position-below
* @attr {Boolean} primary - set primary button color
* @attr {Boolean} secondary - set secondary button color
*/
diff --git a/polygerrit-ui/app/elements/shared/gr-comment/gr-comment_test.ts b/polygerrit-ui/app/elements/shared/gr-comment/gr-comment_test.ts
index 62dcd69..bda076d 100644
--- a/polygerrit-ui/app/elements/shared/gr-comment/gr-comment_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-comment/gr-comment_test.ts
@@ -504,7 +504,7 @@
element.messageText = 'is that the horse from horsing around??';
element.editing = true;
await element.updateComplete;
- pressKey(element.textarea!.$.textarea.textarea, 's', Modifier.CTRL_KEY);
+ pressKey(element.textarea!.textarea!.textarea, 's', Modifier.CTRL_KEY);
assert.isTrue(spy.called);
});
diff --git a/polygerrit-ui/app/elements/shared/gr-dialog/gr-dialog.ts b/polygerrit-ui/app/elements/shared/gr-dialog/gr-dialog.ts
index cf385e8..4df53da 100644
--- a/polygerrit-ui/app/elements/shared/gr-dialog/gr-dialog.ts
+++ b/polygerrit-ui/app/elements/shared/gr-dialog/gr-dialog.ts
@@ -147,7 +147,7 @@
id="confirm"
link
primary
- @click=${(e: Event) => this._handleConfirm(e)}
+ @click=${this._handleConfirm}
?disabled=${this.disabled}
title=${this.confirmTooltip ?? ''}
>
diff --git a/polygerrit-ui/app/elements/shared/gr-diff-preferences/gr-diff-preferences.ts b/polygerrit-ui/app/elements/shared/gr-diff-preferences/gr-diff-preferences.ts
index de12c98..44b6fa2 100644
--- a/polygerrit-ui/app/elements/shared/gr-diff-preferences/gr-diff-preferences.ts
+++ b/polygerrit-ui/app/elements/shared/gr-diff-preferences/gr-diff-preferences.ts
@@ -301,20 +301,22 @@
// We have to wrap boolean values in Boolean() to ensure undefined values
// use false rather than undefined.
return (
+ Boolean(this.originalDiffPrefs?.syntax_highlighting) !==
+ Boolean(this.diffPrefs?.syntax_highlighting) ||
this.originalDiffPrefs?.context !== this.diffPrefs?.context ||
Boolean(this.originalDiffPrefs?.line_wrapping) !==
Boolean(this.diffPrefs?.line_wrapping) ||
this.originalDiffPrefs?.line_length !== this.diffPrefs?.line_length ||
this.originalDiffPrefs?.tab_size !== this.diffPrefs?.tab_size ||
this.originalDiffPrefs?.font_size !== this.diffPrefs?.font_size ||
+ this.originalDiffPrefs?.ignore_whitespace !==
+ this.diffPrefs?.ignore_whitespace ||
Boolean(this.originalDiffPrefs?.show_tabs) !==
Boolean(this.diffPrefs?.show_tabs) ||
Boolean(this.originalDiffPrefs?.show_whitespace_errors) !==
Boolean(this.diffPrefs?.show_whitespace_errors) ||
Boolean(this.originalDiffPrefs?.manual_review) !==
- Boolean(this.diffPrefs?.manual_review) ||
- Boolean(this.originalDiffPrefs?.ignore_whitespace) !==
- Boolean(this.diffPrefs?.ignore_whitespace)
+ Boolean(this.diffPrefs?.manual_review)
);
}
diff --git a/polygerrit-ui/app/elements/shared/gr-editable-content/gr-editable-content.ts b/polygerrit-ui/app/elements/shared/gr-editable-content/gr-editable-content.ts
index 9fbcfa8..5d0f52a 100644
--- a/polygerrit-ui/app/elements/shared/gr-editable-content/gr-editable-content.ts
+++ b/polygerrit-ui/app/elements/shared/gr-editable-content/gr-editable-content.ts
@@ -147,15 +147,7 @@
background-color: var(--view-background-color);
width: 100%;
display: block;
-
- /* You have to also repeat everything from shared-styles here, because
- you can only *replace* --iron-autogrow-textarea vars as a whole. */
- --iron-autogrow-textarea: {
- box-sizing: border-box;
- padding: var(--spacing-m);
- overflow-y: hidden;
- white-space: pre;
- }
+ --iron-autogrow-textarea_-_padding: var(--spacing-m);
}
.editButtons {
display: flex;
@@ -431,8 +423,9 @@
}
}
- handleEditCommitMessage() {
+ async handleEditCommitMessage() {
this.editing = true;
+ await this.updateComplete;
this.focusTextarea();
}
}
diff --git a/polygerrit-ui/app/elements/shared/gr-formatted-text/gr-formatted-text.ts b/polygerrit-ui/app/elements/shared/gr-formatted-text/gr-formatted-text.ts
index 9507620..44a176d 100644
--- a/polygerrit-ui/app/elements/shared/gr-formatted-text/gr-formatted-text.ts
+++ b/polygerrit-ui/app/elements/shared/gr-formatted-text/gr-formatted-text.ts
@@ -90,6 +90,9 @@
display: block;
font-family: var(--font-family);
}
+ a {
+ color: var(--link-color);
+ }
p,
ul,
code,
@@ -127,13 +130,11 @@
list-style-type: disc;
margin-left: var(--spacing-xl);
}
- code,
- gr-linked-text.pre {
+ .inline-code,
+ code {
font-family: var(--monospace-font-family);
font-size: var(--font-size-code);
line-height: var(--line-height-mono);
- }
- gr-linked-text.pre {
background-color: var(--background-color-secondary);
border: 1px solid var(--border-color);
padding: 1px var(--spacing-s);
@@ -275,7 +276,12 @@
} else {
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const [_, text, url] = m;
- result.push({type: 'link', text, url});
+ // Disallow javascript protocol in the href as an XSS mitigation
+ if (url.trimStart().startsWith('javascript:')) {
+ result.push({type: 'link', text, url: ''});
+ } else {
+ result.push({type: 'link', text, url});
+ }
}
}
}
@@ -350,21 +356,9 @@
return /^\s+$/.test(line);
}
- private renderText(content: string, isPre?: boolean): TemplateResult {
+ private renderInlineText(content: string): TemplateResult {
return html`
<gr-linked-text
- class=${isPre ? 'pre' : ''}
- .config=${this.config}
- content=${content}
- pre
- ></gr-linked-text>
- `;
- }
-
- private renderInlineText(content: string, isPre?: boolean): TemplateResult {
- return html`
- <gr-linked-text
- class=${isPre ? 'pre' : ''}
.config=${this.config}
content=${content}
pre
@@ -377,6 +371,10 @@
return html`<a href=${url}>${text}</a>`;
}
+ private renderInlineCode(text: string): TemplateResult {
+ return html`<span class="inline-code">${text}</span>`;
+ }
+
private renderInlineItem(span: InlineItem): TemplateResult {
switch (span.type) {
case 'text':
@@ -384,7 +382,7 @@
case 'link':
return this.renderLink(span.text, span.url);
case 'code':
- return this.renderInlineText(span.text, true);
+ return this.renderInlineCode(span.text);
default:
return html``;
}
@@ -411,7 +409,7 @@
case 'code':
return html`<code>${block.text}</code>`;
case 'pre':
- return this.renderText(block.text, true);
+ return html`<pre><code>${block.text}</code></pre>`;
case 'list':
return html`
<ul>
diff --git a/polygerrit-ui/app/elements/shared/gr-formatted-text/gr-formatted-text_test.ts b/polygerrit-ui/app/elements/shared/gr-formatted-text/gr-formatted-text_test.ts
index 80c36ee..3a23a38 100644
--- a/polygerrit-ui/app/elements/shared/gr-formatted-text/gr-formatted-text_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-formatted-text/gr-formatted-text_test.ts
@@ -110,6 +110,20 @@
assertTextBlock(result[0], [{type: 'link', text: 'text', url: 'url'}]);
});
+ test('link with javascript protocol does not set href', () => {
+ const comment = '[text](javascript:alert`1`)';
+ const result = element._computeBlocks(comment);
+ assert.lengthOf(result, 1);
+ assertTextBlock(result[0], [{type: 'link', text: 'text', url: ''}]);
+ });
+
+ test('link with whitespace and javascript protocol does not set href', () => {
+ const comment = '[text]( javascript:alert`1`)';
+ const result = element._computeBlocks(comment);
+ assert.lengthOf(result, 1);
+ assertTextBlock(result[0], [{type: 'link', text: 'text', url: ''}]);
+ });
+
test('parse inline code', () => {
const comment = 'text `code`';
const result = element._computeBlocks(comment);
diff --git a/polygerrit-ui/app/elements/shared/gr-icons/gr-icons.ts b/polygerrit-ui/app/elements/shared/gr-icons/gr-icons.ts
index 4456381..dc2cbc7 100644
--- a/polygerrit-ui/app/elements/shared/gr-icons/gr-icons.ts
+++ b/polygerrit-ui/app/elements/shared/gr-icons/gr-icons.ts
@@ -25,7 +25,7 @@
<g id="expand-less"><path d="M12 8l-6 6 1.41 1.41L12 10.83l4.59 4.58L18 14z"></path></g>
<!-- This SVG is a copy from iron-icons https://github.com/PolymerElements/iron-icons/blob/master/iron-icons.js -->
<g id="expand-more"><path d="M16.59 8.59L12 13.17 7.41 8.59 6 10l6 6 6-6z"></path></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#unfold_more -->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=unfold_more -->
<g id="unfold-more"><path d="M0 0h24v24H0z" fill="none"></path><path d="M12 5.83L15.17 9l1.41-1.41L12 3 7.41 7.59 8.83 9 12 5.83zm0 12.34L8.83 15l-1.41 1.41L12 21l4.59-4.59L15.17 15 12 18.17z"></path></g>
<!-- This SVG is a copy from iron-icons https://github.com/PolymerElements/iron-icons/blob/master/iron-icons.js -->
<g id="search"><path d="M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path></g>
@@ -61,11 +61,11 @@
<g id="info"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm1 15h-2v-6h2v6zm0-8h-2V7h2v2z"></path></g>
<!-- This SVG is a copy from iron-icons https://github.com/PolymerElements/iron-icons/blob/master/iron-icons.js -->
<g id="info-outline"><path d="M11 17h2v-6h-2v6zm1-15C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 18c-4.41 0-8-3.59-8-8s3.59-8 8-8 8 3.59 8 8-3.59 8-8 8zM11 9h2V7h-2v2z"></path></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#ic_hourglass_full-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=ic_hourglass_full-->
<g id="hourglass"><path d="M6 2v6h.01L6 8.01 10 12l-4 4 .01.01H6V22h12v-5.99h-.01L18 16l-4-4 4-3.99-.01-.01H18V2H6z"></path><path d="M0 0h24v24H0V0z" fill="none"></path></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#mode_comment-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=mode_comment-->
<g id="comment"><path d="M21.99 4c0-1.1-.89-2-1.99-2H4c-1.1 0-2 .9-2 2v12c0 1.1.9 2 2 2h14l4 4-.01-18z"></path><path d="M0 0h24v24H0z" fill="none"></path></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#calendar_today-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=calendar_today-->
<g id="calendar"><path d="M20 3h-1V1h-2v2H7V1H5v2H4c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h16c1.1 0 2-.9 2-2V5c0-1.1-.9-2-2-2zm0 18H4V8h16v13z"></path><path d="M0 0h24v24H0z" fill="none"></path></g>
<!-- This SVG is a copy from iron-icons https://github.com/PolymerElements/iron-icons/blob/master/iron-icons.js -->
<g id="error"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm1 15h-2v-2h2v2zm0-4h-2V7h2v6z"></path></g>
@@ -77,11 +77,13 @@
<g id="unified"><path d="M4,2 L17,2 C18.1045695,2 19,2.8954305 19,4 L19,16 C19,17.1045695 18.1045695,18 17,18 L4,18 C2.8954305,18 2,17.1045695 2,16 L2,4 L2,4 C2,2.8954305 2.8954305,2 4,2 L4,2 Z M4,7 L4,9 L17,9 L17,7 L4,7 Z M4,11 L4,13 L17,13 L17,11 L4,11 Z" id="Combined-Shape" transform="scale(1.12, 1.2)"></path></g>
<!-- This SVG is a copy from iron-icons https://github.com/PolymerElements/iron-icons/blob/master/iron-icons.js -->
<g id="content-copy"><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"></path></g>
+ <!-- This SVG is a copy from iron-icons https://github.com/PolymerElements/iron-icons/blob/master/iron-icons.js -->
+ <g id="build"><path d="M22.7 19l-9.1-9.1c.9-2.3.4-5-1.5-6.9-2-2-5-2.4-7.4-1.3L9 6 6 9 1.6 4.7C.4 7.1.9 10.1 2.9 12.1c1.9 1.9 4.6 2.4 6.9 1.5l9.1 9.1c.4.4 1 .4 1.4 0l2.3-2.3c.5-.4.5-1.1.1-1.4z"></path></g>
<!-- This is a custom PolyGerrit SVG -->
<g id="check"><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"></path></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#check_circle-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=check_circle-->
<g id="check-circle"><path d="M0 0h24v24H0z" fill="none"/><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm-2 15l-5-5 1.41-1.41L10 14.17l7.59-7.59L19 8l-9 9z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#check_circle_outline-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=check_circle_outline-->
<g id="check-circle-outline"><path d="M0 0h24v24H0V0zm0 0h24v24H0V0z" fill="none"/><path d="M16.59 7.58L10 14.17l-3.59-3.58L5 12l5 5 8-8zM12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 18c-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8-3.58 8-8 8z"/></g>
<!-- This SVG is a copy from https://fonts.google.com/icons?selected=Material+Icons:event_busy&icon.query=check+circle-->
<g id="check-circle-filled"><path d="M12,2C6.48,2,2,6.48,2,12c0,5.52,4.48,10,10,10s10-4.48,10-10C22,6.48,17.52,2,12,2z M10,17l-4-4l1.4-1.4l2.6,2.6l6.6-6.6 L18,9L10,17z"/><path d="M0,0h24v24H0V0z" fill="none"/></g>
@@ -110,45 +112,45 @@
<g id="review"><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41z"></path></g>
<!-- This is a custom PolyGerrit SVG -->
<g id="zeroState"><path d="M22 9V7h-2V5c0-1.1-.9-2-2-2H4c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h14c1.1 0 2-.9 2-2v-2h2v-2h-2v-2h2v-2h-2V9h2zm-4 10H4V5h14v14zM6 13h5v4H6zm6-6h4v3h-4zM6 7h5v5H6zm6 4h4v6h-4z"></path></g>
- <!-- This SVG is an adaptation of material.io https://material.io/icons/#label_important-->
+ <!-- This SVG is an adaptation of material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=label_important-->
<g id="attention"><path d="M1 23 l13 0 c.67 0 1.27 -.33 1.63 -.84 l7.37 -10.16 l-7.37 -10.16 c-.36 -.51 -.96 -.84 -1.63 -.84 L1 1 L7 12 z"></path></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#pets-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=pets-->
<g id="pets"><circle cx="4.5" cy="9.5" r="2.5"/><circle cx="9" cy="5.5" r="2.5"/><circle cx="15" cy="5.5" r="2.5"/><circle cx="19.5" cy="9.5" r="2.5"/><path d="M17.34 14.86c-.87-1.02-1.6-1.89-2.48-2.91-.46-.54-1.05-1.08-1.75-1.32-.11-.04-.22-.07-.33-.09-.25-.04-.52-.04-.78-.04s-.53 0-.79.05c-.11.02-.22.05-.33.09-.7.24-1.28.78-1.75 1.32-.87 1.02-1.6 1.89-2.48 2.91-1.31 1.31-2.92 2.76-2.62 4.79.29 1.02 1.02 2.03 2.33 2.32.73.15 3.06-.44 5.54-.44h.18c2.48 0 4.81.58 5.54.44 1.31-.29 2.04-1.31 2.33-2.32.31-2.04-1.3-3.49-2.61-4.8z"/><path d="M0 0h24v24H0z" fill="none"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#visibility-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=visibility-->
<g id="ready"><path d="M0 0h24v24H0z" fill="none"/><path d="M12 4.5C7 4.5 2.73 7.61 1 12c1.73 4.39 6 7.5 11 7.5s9.27-3.11 11-7.5c-1.73-4.39-6-7.5-11-7.5zM12 17c-2.76 0-5-2.24-5-5s2.24-5 5-5 5 2.24 5 5-2.24 5-5 5zm0-8c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z"/></g>
<!-- This SVG is a copy from iron-icons https://github.com/PolymerElements/iron-icons -->
<g id="schedule"><path d="M11.99 2C6.47 2 2 6.48 2 12s4.47 10 9.99 10C17.52 22 22 17.52 22 12S17.52 2 11.99 2zM12 20c-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8-3.58 8-8 8zm.5-13H11v6l5.25 3.15.75-1.23-4.5-2.67z"></path></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#bug_report-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=bug_report-->
<g id="bug"><path d="M0 0h24v24H0z" fill="none"/><path d="M20 8h-2.81c-.45-.78-1.07-1.45-1.82-1.96L17 4.41 15.59 3l-2.17 2.17C12.96 5.06 12.49 5 12 5c-.49 0-.96.06-1.41.17L8.41 3 7 4.41l1.62 1.63C7.88 6.55 7.26 7.22 6.81 8H4v2h2.09c-.05.33-.09.66-.09 1v1H4v2h2v1c0 .34.04.67.09 1H4v2h2.81c1.04 1.79 2.97 3 5.19 3s4.15-1.21 5.19-3H20v-2h-2.09c.05-.33.09-.66.09-1v-1h2v-2h-2v-1c0-.34-.04-.67-.09-1H20V8zm-6 8h-4v-2h4v2zm0-4h-4v-2h4v2z"/></g>
<!-- This SVG is a copy from material.io https://fonts.gstatic.com/s/i/googlematerialicons/move_item/v1/24px.svg -->
<g id="move-item"><path d="M15,19H5V5h10v4h2V5c0-1.1-0.89-2-2-2H5C3.9,3,3,3.9,3,5v14c0,1.1,0.9,2,2,2h10c1.11,0,2-0.9,2-2v-4h-2V19z"/><polygon points="20.01,8.01 18.59,9.41 20.17,11 8,11 8,13 20.17,13 18.59,14.59 20.01,15.99 24,12"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#warning-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=warning-->
<g id="warning"><path d="M0 0h24v24H0z" fill="none"/><path d="M1 21h22L12 2 1 21zm12-3h-2v-2h2v2zm0-4h-2v-4h2v4z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#timelapse-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=timelapse-->
<g id="timelapse"><path d="M0 0h24v24H0z" fill="none"/><path d="M16.24 7.76C15.07 6.59 13.54 6 12 6v6l-4.24 4.24c2.34 2.34 6.14 2.34 8.49 0 2.34-2.34 2.34-6.14-.01-8.48zM12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm0 18c-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8-3.58 8-8 8z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#mark_chat_read-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=mark_chat_read-->
<g id="markChatRead"><path d="M12,18l-6,0l-4,4V4c0-1.1,0.9-2,2-2h16c1.1,0,2,0.9,2,2v7l-2,0V4H4v12l8,0V18z M23,14.34l-1.41-1.41l-4.24,4.24l-2.12-2.12 l-1.41,1.41L17.34,20L23,14.34z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#message-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=message-->
<g id="message"><path d="M0 0h24v24H0z" fill="none"/><path d="M20 2H4c-1.1 0-1.99.9-1.99 2L2 22l4-4h14c1.1 0 2-.9 2-2V4c0-1.1-.9-2-2-2zm-2 12H6v-2h12v2zm0-3H6V9h12v2zm0-3H6V6h12v2z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#launch-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=launch-->
<g id="launch"><path d="M0 0h24v24H0z" fill="none"/><path d="M19 19H5V5h7V3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2v-7h-2v7zM14 3v2h3.59l-9.83 9.83 1.41 1.41L19 6.41V10h2V3h-7z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#filter-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=filter-->
<g id="filter"><path d="M0,0h24 M24,24H0" fill="none"/><path d="M4.25,5.61C6.27,8.2,10,13,10,13v6c0,0.55,0.45,1,1,1h2c0.55,0,1-0.45,1-1v-6c0,0,3.72-4.8,5.74-7.39 C20.25,4.95,19.78,4,18.95,4H5.04C4.21,4,3.74,4.95,4.25,5.61z"/><path d="M0,0h24v24H0V0z" fill="none"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#arrow_drop_down-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=arrow_drop_down-->
<g id="arrowDropDown"><path d="M0 0h24v24H0z" fill="none"/><path d="M7 10l5 5 5-5z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#arrow_drop_up-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=arrow_drop_up-->
<g id="arrowDropUp"><path d="M0 0h24v24H0z" fill="none"/><path d="M7 14l5-5 5 5z"/></g>
<!-- This is just a placeholder, i.e. an empty icon that has the same size as a normal icon. -->
<g id="placeholder"><path d="M0 0h24v24H0z" fill="none"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#insert_photo-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=insert_photo-->
<g id="insert-photo"><path d="M0 0h24v24H0z" fill="none"/><path d="M21 19V5c0-1.1-.9-2-2-2H5c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h14c1.1 0 2-.9 2-2zM8.5 13.5l2.5 3.01L14.5 12l4.5 6H5l3.5-4.5z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#download-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=download-->
<g id="download"><path d="M0 0h24v24H0z" fill="none"/><path d="M5,20h14v-2H5V20z M19,9h-4V3H9v6H5l7,7L19,9z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#system_update-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=system_update-->
<g id="system-update"><path d="M0 0h24v24H0z" fill="none"/><path d="M17 1.01L7 1c-1.1 0-2 .9-2 2v18c0 1.1.9 2 2 2h10c1.1 0 2-.9 2-2V3c0-1.1-.9-1.99-2-1.99zM17 19H7V5h10v14zm-1-6h-3V8h-2v5H8l4 4 4-4z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#swap_horiz-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=swap_horiz-->
<g id="swapHoriz"><path d="M0 0h24v24H0z" fill="none"/><path d="M6.99 11L3 15l3.99 4v-3H14v-2H6.99v-3zM21 9l-3.99-4v3H10v2h7.01v3L21 9z"/></g>
- <!-- This SVG is a copy from material.io https://material.io/icons/#link-->
+ <!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material+Icons&icon.query=link-->
<g id="link"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/></g>
<!-- This SVG is a copy from material.io https://fonts.google.com/icons?selected=Material%20Icons%3Aplay_arrow-->
<g id="playArrow"><path d="M0 0h24v24H0z" fill="none"/><path d="M8 5v14l11-7z"/></g>
diff --git a/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api.ts b/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api.ts
index 18ea5de..82528cd 100644
--- a/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api.ts
+++ b/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api.ts
@@ -25,6 +25,7 @@
PrimaryActionKey,
RevisionActions,
} from '../../../api/change-actions';
+import {PropertyDeclaration} from 'lit';
export interface UIActionInfo extends RequireProperties<ActionInfo, 'label'> {
__key: string;
@@ -40,7 +41,6 @@
ChangeActions: Record<string, string>;
ActionType: Record<string, string>;
primaryActionKeys: string[];
- push(propName: 'primaryActionKeys', value: string): void;
hideQuickApproveAction(): void;
setActionOverflow(type: ActionType, key: string, overflow: boolean): void;
setActionPriority(
@@ -57,6 +57,11 @@
value: UIActionInfo[T]
): void;
getActionDetails(actionName: string): ActionInfo | undefined;
+ requestUpdate(
+ name?: PropertyKey,
+ oldValue?: unknown,
+ options?: PropertyDeclaration
+ ): void;
}
export class GrChangeActionsInterface implements ChangeActionsPluginApi {
@@ -111,7 +116,8 @@
return;
}
- el.push('primaryActionKeys', key);
+ el.primaryActionKeys.push(key);
+ el.requestUpdate();
}
removePrimaryActionKey(key: string) {
@@ -127,19 +133,16 @@
setActionOverflow(type: ActionType, key: string, overflow: boolean) {
this.reporting.trackApi(this.plugin, 'actions', 'setActionOverflow');
- // TODO(TS): remove return, unclear why it was written
this.ensureEl().setActionOverflow(type, key, overflow);
}
setActionPriority(type: ActionType, key: string, priority: ActionPriority) {
this.reporting.trackApi(this.plugin, 'actions', 'setActionPriority');
- // TODO(TS): remove return, unclear why it was written
this.ensureEl().setActionPriority(type, key, priority);
}
setActionHidden(type: ActionType, key: string, hidden: boolean) {
this.reporting.trackApi(this.plugin, 'actions', 'setActionHidden');
- // TODO(TS): remove return, unclear why it was written
this.ensureEl().setActionHidden(type, key, hidden);
}
@@ -150,7 +153,6 @@
remove(key: string) {
this.reporting.trackApi(this.plugin, 'actions', 'remove');
- // TODO(TS): remove return, unclear why it was written
this.ensureEl().removeActionButton(key);
}
diff --git a/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api_test.ts b/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api_test.ts
index fceb518..4dfc638 100644
--- a/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-actions-js-api_test.ts
@@ -32,10 +32,10 @@
ChangeActionsPluginApi,
PrimaryActionKey,
} from '../../../api/change-actions';
-import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
import {GrButton} from '../gr-button/gr-button';
import {IronIconElement} from '@polymer/iron-icon';
import {ChangeViewChangeInfo} from '../../../types/common';
+import {GrDropdown} from '../gr-dropdown/gr-dropdown';
suite('gr-change-actions-js-api-interface tests', () => {
let element: GrChangeActions;
@@ -77,7 +77,6 @@
element = await fixture<GrChangeActions>(html`
<gr-change-actions></gr-change-actions>
`);
- sinon.stub(element, '_editStatusChanged');
element.change = {} as ChangeViewChangeInfo;
element._hasKnownChainState = false;
window.Gerrit.install(
@@ -118,22 +117,21 @@
assert.deepEqual(element.primaryActionKeys, []);
});
- test('action buttons', () => {
+ test('action buttons', async () => {
const key = changeActions.add(ActionType.REVISION, 'Bork!');
const handler = sinon.spy();
changeActions.addTapListener(key, handler);
- flush();
- MockInteractions.tap(
- queryAndAssert<GrButton>(element, `[data-action-key="${key}"]`)
- );
+ await element.updateComplete;
+ queryAndAssert<GrButton>(element, `[data-action-key="${key}"]`).click();
+ await element.updateComplete;
assert(handler.calledOnce);
changeActions.removeTapListener(key, handler);
- MockInteractions.tap(
- queryAndAssert<GrButton>(element, `[data-action-key="${key}"]`)
- );
+ await element.updateComplete;
+ queryAndAssert<GrButton>(element, `[data-action-key="${key}"]`).click();
+ await element.updateComplete;
assert(handler.calledOnce);
changeActions.remove(key);
- flush();
+ await element.updateComplete;
assert.isUndefined(
query<GrButton>(element, `[data-action-key="${key}"]`)
);
@@ -141,7 +139,7 @@
test('action button properties', async () => {
const key = changeActions.add(ActionType.REVISION, 'Bork!');
- flush();
+ await element.updateComplete;
const button = queryAndAssert<GrButton>(
element,
`[data-action-key="${key}"]`
@@ -153,7 +151,7 @@
changeActions.setTitle(key, 'Yo hint');
changeActions.setEnabled(key, false);
changeActions.setIcon(key, 'pupper');
- await flush();
+ await element.updateComplete;
assert.equal(button.getAttribute('data-label'), 'Yo');
assert.equal(button.parentElement!.getAttribute('title'), 'Yo hint');
assert.isTrue(button.disabled);
@@ -165,39 +163,44 @@
test('hide action buttons', async () => {
const key = changeActions.add(ActionType.REVISION, 'Bork!');
- await flush();
+ await element.updateComplete;
let button = query<GrButton>(element, `[data-action-key="${key}"]`);
assert.isOk(button);
assert.isFalse(button!.hasAttribute('hidden'));
changeActions.setActionHidden(ActionType.REVISION, key, true);
- flush();
+ await element.updateComplete;
button = query<GrButton>(element, `[data-action-key="${key}"]`);
assert.isNotOk(button);
});
test('move action button to overflow', async () => {
const key = changeActions.add(ActionType.REVISION, 'Bork!');
- await flush();
- assert.isTrue(element.$.moreActions.hidden);
+ await element.updateComplete;
+ assert.isTrue(queryAndAssert<GrDropdown>(element, '#moreActions').hidden);
assert.isOk(
queryAndAssert<GrButton>(element, `[data-action-key="${key}"]`)
);
changeActions.setActionOverflow(ActionType.REVISION, key, true);
- await flush();
+ await element.updateComplete;
assert.isNotOk(query<GrButton>(element, `[data-action-key="${key}"]`));
- assert.isFalse(element.$.moreActions.hidden);
- assert.strictEqual(element.$.moreActions.items![0].name, 'Bork!');
+ assert.isFalse(
+ queryAndAssert<GrDropdown>(element, '#moreActions').hidden
+ );
+ assert.strictEqual(
+ queryAndAssert<GrDropdown>(element, '#moreActions').items![0].name,
+ 'Bork!'
+ );
});
- test('change actions priority', () => {
+ test('change actions priority', async () => {
const key1 = changeActions.add(ActionType.REVISION, 'Bork!');
const key2 = changeActions.add(ActionType.CHANGE, 'Squanch?');
- flush();
+ await element.updateComplete;
let buttons = queryAll<GrButton>(element, '[data-action-key]');
assert.equal(buttons[0].getAttribute('data-action-key'), key1);
assert.equal(buttons[1].getAttribute('data-action-key'), key2);
changeActions.setActionPriority(ActionType.REVISION, key1, 10);
- flush();
+ await element.updateComplete;
buttons = queryAll<GrButton>(element, '[data-action-key]');
assert.equal(buttons[0].getAttribute('data-action-key'), key2);
assert.equal(buttons[1].getAttribute('data-action-key'), key1);
diff --git a/polygerrit-ui/app/elements/shared/gr-label-info/gr-label-info.ts b/polygerrit-ui/app/elements/shared/gr-label-info/gr-label-info.ts
index b1d3914..13375b3 100644
--- a/polygerrit-ui/app/elements/shared/gr-label-info/gr-label-info.ts
+++ b/polygerrit-ui/app/elements/shared/gr-label-info/gr-label-info.ts
@@ -24,7 +24,6 @@
import '../gr-icons/gr-icons';
import '../gr-label/gr-label';
import '../gr-tooltip-content/gr-tooltip-content';
-import {dom, EventApi} from '@polymer/polymer/lib/legacy/polymer.dom';
import {
AccountInfo,
LabelInfo,
@@ -448,7 +447,7 @@
if (!this.change) return;
e.preventDefault();
- let target = (dom(e) as EventApi).rootTarget as GrButton;
+ let target = e.composedPath()[0] as GrButton;
while (!target.classList.contains('deleteBtn')) {
if (!target.parentElement) {
return;
diff --git a/polygerrit-ui/app/elements/shared/gr-labeled-autocomplete/gr-labeled-autocomplete.ts b/polygerrit-ui/app/elements/shared/gr-labeled-autocomplete/gr-labeled-autocomplete.ts
index c020a9c..df37497 100644
--- a/polygerrit-ui/app/elements/shared/gr-labeled-autocomplete/gr-labeled-autocomplete.ts
+++ b/polygerrit-ui/app/elements/shared/gr-labeled-autocomplete/gr-labeled-autocomplete.ts
@@ -102,7 +102,7 @@
override willUpdate(changedProperties: PropertyValues) {
if (changedProperties.has('text')) {
- fire(this, 'text-changed', this.text);
+ fire(this, 'text-changed', {value: this.text});
}
}
@@ -126,9 +126,6 @@
}
declare global {
- interface HTMLElementEventMap {
- 'text-changed': CustomEvent<string>;
- }
interface HTMLElementTagNameMap {
'gr-labeled-autocomplete': GrLabeledAutocomplete;
}
diff --git a/polygerrit-ui/app/elements/shared/gr-repo-branch-picker/gr-repo-branch-picker.ts b/polygerrit-ui/app/elements/shared/gr-repo-branch-picker/gr-repo-branch-picker.ts
index 9c88c5c..90ce8bb 100644
--- a/polygerrit-ui/app/elements/shared/gr-repo-branch-picker/gr-repo-branch-picker.ts
+++ b/polygerrit-ui/app/elements/shared/gr-repo-branch-picker/gr-repo-branch-picker.ts
@@ -140,15 +140,17 @@
private branchResponseToSuggestions(res: BranchInfo[] | undefined) {
if (!res) return [];
- return res.map(branchInfo => {
- let branch;
- if (branchInfo.ref.startsWith(REF_PREFIX)) {
- branch = branchInfo.ref.substring(REF_PREFIX.length);
- } else {
- branch = branchInfo.ref;
- }
- return {name: branch, value: branch};
- });
+ return res
+ .filter(branchInfo => branchInfo.ref !== 'HEAD')
+ .map(branchInfo => {
+ let branch;
+ if (branchInfo.ref.startsWith(REF_PREFIX)) {
+ branch = branchInfo.ref.substring(REF_PREFIX.length);
+ } else {
+ branch = branchInfo.ref;
+ }
+ return {name: branch, value: branch};
+ });
}
// private but used in test
diff --git a/polygerrit-ui/app/elements/shared/gr-repo-branch-picker/gr-repo-branch-picker_test.ts b/polygerrit-ui/app/elements/shared/gr-repo-branch-picker/gr-repo-branch-picker_test.ts
index f8b1343..4c53a03 100644
--- a/polygerrit-ui/app/elements/shared/gr-repo-branch-picker/gr-repo-branch-picker_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-repo-branch-picker/gr-repo-branch-picker_test.ts
@@ -82,8 +82,9 @@
setup(() => {
getRepoBranchesStub = stubRestApi('getRepoBranches').returns(
Promise.resolve([
- {ref: 'refs/heads/stable-2.10' as GitRef, revision: '123'},
- {ref: 'refs/heads/stable-2.11' as GitRef, revision: '1234'},
+ {ref: 'HEAD' as GitRef, revision: 'main'},
+ {ref: 'refs/heads/stable-2.10' as GitRef, revision: '123af'},
+ {ref: 'refs/heads/stable-2.11' as GitRef, revision: '1234b'},
{ref: 'refs/heads/stable-2.12' as GitRef, revision: '12345'},
{ref: 'refs/heads/stable-2.13' as GitRef, revision: '123456'},
{ref: 'refs/heads/stable-2.14' as GitRef, revision: '1234567'},
diff --git a/polygerrit-ui/app/elements/shared/gr-rest-api-interface/gr-etag-decorator_test.ts b/polygerrit-ui/app/elements/shared/gr-rest-api-interface/gr-etag-decorator_test.ts
index 91e7baf..ce2c72f 100644
--- a/polygerrit-ui/app/elements/shared/gr-rest-api-interface/gr-etag-decorator_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-rest-api-interface/gr-etag-decorator_test.ts
@@ -16,7 +16,6 @@
*/
import '../../../test/common-test-setup-karma';
-import 'lodash/lodash';
import {GrEtagDecorator} from './gr-etag-decorator';
suite('gr-etag-decorator', () => {
@@ -61,9 +60,9 @@
test('discards etags in order used', () => {
etag.collect('/foo', fakeRequest('bar'), '');
- _.times(29, i => {
+ for (let i = 0; i < 29; i++) {
etag.collect(`/qaz/${i}`, fakeRequest('qaz'), '');
- });
+ }
let options = etag.getOptions('/foo');
assert.strictEqual(options!.headers!.get('If-None-Match'), 'bar');
etag.collect('/zaq', fakeRequest('zaq'), '');
diff --git a/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea.ts b/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea.ts
index 60aa092..e0c49c9 100644
--- a/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea.ts
+++ b/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea.ts
@@ -19,11 +19,7 @@
import '../gr-overlay/gr-overlay';
import '@polymer/iron-autogrow-textarea/iron-autogrow-textarea';
import '../../../styles/shared-styles';
-import {flush} from '@polymer/polymer/lib/legacy/polymer.dom';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-textarea_html';
import {getAppContext} from '../../../services/app-context';
-import {customElement, property} from '@polymer/decorators';
import {IronAutogrowTextareaElement} from '@polymer/iron-autogrow-textarea/iron-autogrow-textarea';
import {
GrAutocompleteDropdown,
@@ -31,8 +27,13 @@
ItemSelectedEvent,
} from '../gr-autocomplete-dropdown/gr-autocomplete-dropdown';
import {addShortcut, Key} from '../../../utils/dom-util';
-import {BindValueChangeEvent} from '../../../types/events';
+import {BindValueChangeEvent, ValueChangedEvent} from '../../../types/events';
import {fire} from '../../../utils/event-util';
+import {LitElement, css, html} from 'lit';
+import {customElement, property, query, state} from 'lit/decorators';
+import {sharedStyles} from '../../../styles/shared-styles';
+import {PropertyValues} from 'lit';
+import {classMap} from 'lit/directives/class-map';
const MAX_ITEMS_DROPDOWN = 10;
@@ -64,15 +65,6 @@
match: string;
}
-export interface GrTextarea {
- $: {
- textarea: IronAutogrowTextareaElement;
- emojiSuggestions: GrAutocompleteDropdown;
- caratSpan: HTMLSpanElement;
- hiddenText: HTMLDivElement;
- };
-}
-
declare global {
interface HTMLElementEventMap {
'item-selected': CustomEvent<ItemSelectedEvent>;
@@ -80,62 +72,48 @@
}
@customElement('gr-textarea')
-export class GrTextarea extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
+export class GrTextarea extends LitElement {
/**
* @event bind-value-changed
*/
- @property({type: String})
- autocomplete?: string;
+ @query('#textarea') textarea?: IronAutogrowTextareaElement;
- @property({type: Boolean})
- disabled?: boolean;
+ @query('#emojiSuggestions') emojiSuggestions?: GrAutocompleteDropdown;
- @property({type: Number})
- rows?: number;
+ @query('#caratSpan', true) caratSpan?: HTMLSpanElement;
- @property({type: Number})
- maxRows?: number;
+ @query('#hiddenText') hiddenText?: HTMLDivElement;
- @property({type: String})
- placeholder?: string;
+ @property() autocomplete?: string;
- @property({type: String, notify: true, observer: '_handleTextChanged'})
- text = '';
+ @property({type: Boolean}) disabled?: boolean;
- @property({type: Boolean})
- hideBorder = false;
+ @property({type: Number}) rows?: number;
+
+ @property({type: Number}) maxRows?: number;
+
+ @property({type: String}) placeholder?: string;
+
+ @property({type: String}) text = '';
+
+ @property({type: Boolean, attribute: 'hide-border'}) hideBorder = false;
/** Text input should be rendered in monospace font. */
- @property({type: Boolean})
- monospace = false;
+ @property({type: Boolean}) monospace = false;
/** Text input should be rendered in code font, which is smaller than the
standard monospace font. */
- @property({type: Boolean})
- code = false;
+ @property({type: Boolean}) code = false;
- @property({type: Number})
- _colonIndex: number | null = null;
+ @state() colonIndex: number | null = null;
- @property({type: String, observer: '_determineSuggestions'})
- _currentSearchString?: string;
+ @state() currentSearchString?: string;
- @property({type: Boolean})
- _hideEmojiAutocomplete = true;
+ @state() hideEmojiAutocomplete = true;
- @property({type: Number})
- _index: number | null = null;
+ @state() private index: number | null = null;
- @property({type: Array})
- _suggestions: EmojiSuggestion[] = [];
-
- @property({type: Number})
- readonly _verticalOffset = 20;
- // Offset makes dropdown appear below text.
+ @state() suggestions: EmojiSuggestion[] = [];
// Accessed in tests.
readonly reporting = getAppContext().reportingService;
@@ -153,52 +131,139 @@
override connectedCallback() {
super.connectedCallback();
- this.cleanups.push(
- addShortcut(this, {key: Key.UP}, e => this._handleUpKey(e), {
- doNotPrevent: true,
- })
- );
- this.cleanups.push(
- addShortcut(this, {key: Key.DOWN}, e => this._handleDownKey(e), {
- doNotPrevent: true,
- })
- );
- this.cleanups.push(
- addShortcut(this, {key: Key.TAB}, e => this._handleTabKey(e), {
- doNotPrevent: true,
- })
- );
- this.cleanups.push(
- addShortcut(this, {key: Key.ENTER}, e => this._handleEnterByKey(e), {
- doNotPrevent: true,
- })
- );
- this.cleanups.push(
- addShortcut(this, {key: Key.ESC}, e => this._handleEscKey(e), {
- doNotPrevent: true,
- })
- );
- }
-
- override ready() {
- super.ready();
if (this.monospace) {
this.classList.add('monospace');
}
if (this.code) {
this.classList.add('code');
}
- if (this.hideBorder) {
- this.$.textarea.classList.add('noBorder');
+ this.cleanups.push(
+ addShortcut(this, {key: Key.UP}, e => this.handleUpKey(e), {
+ doNotPrevent: true,
+ })
+ );
+ this.cleanups.push(
+ addShortcut(this, {key: Key.DOWN}, e => this.handleDownKey(e), {
+ doNotPrevent: true,
+ })
+ );
+ this.cleanups.push(
+ addShortcut(this, {key: Key.TAB}, e => this.handleTabKey(e), {
+ doNotPrevent: true,
+ })
+ );
+ this.cleanups.push(
+ addShortcut(this, {key: Key.ENTER}, e => this.handleEnterByKey(e), {
+ doNotPrevent: true,
+ })
+ );
+ this.cleanups.push(
+ addShortcut(this, {key: Key.ESC}, e => this.handleEscKey(e), {
+ doNotPrevent: true,
+ })
+ );
+ }
+
+ static override styles = [
+ sharedStyles,
+ css`
+ :host {
+ display: flex;
+ position: relative;
+ }
+ :host(.monospace) {
+ font-family: var(--monospace-font-family);
+ font-size: var(--font-size-mono);
+ line-height: var(--line-height-mono);
+ font-weight: var(--font-weight-normal);
+ }
+ :host(.code) {
+ font-family: var(--monospace-font-family);
+ font-size: var(--font-size-code);
+ /* usually 16px = 12px + 4px */
+ line-height: calc(var(--font-size-code) + var(--spacing-s));
+ font-weight: var(--font-weight-normal);
+ }
+ #emojiSuggestions {
+ font-family: var(--font-family);
+ }
+ gr-autocomplete {
+ display: inline-block;
+ }
+ #textarea {
+ background-color: var(--view-background-color);
+ width: 100%;
+ }
+ #hiddenText #emojiSuggestions {
+ visibility: visible;
+ white-space: normal;
+ }
+ iron-autogrow-textarea {
+ position: relative;
+ }
+ #textarea.noBorder {
+ border: none;
+ }
+ #hiddenText {
+ display: block;
+ float: left;
+ position: absolute;
+ visibility: hidden;
+ width: 100%;
+ white-space: pre-wrap;
+ }
+ `,
+ ];
+
+ override render() {
+ return html`
+ <div id="hiddenText"></div>
+ <!-- When the autocomplete is open, the span is moved at the end of
+ hiddenText in order to correctly position the dropdown. After being moved,
+ it is set as the positionTarget for the emojiSuggestions dropdown. -->
+ <span id="caratSpan"></span>
+ <gr-autocomplete-dropdown
+ id="emojiSuggestions"
+ .suggestions=${this.suggestions}
+ .index=${this.index}
+ .verticalOffset=${20}
+ @dropdown-closed=${this.resetEmojiDropdown}
+ @item-selected=${this.handleEmojiSelect}
+ >
+ </gr-autocomplete-dropdown>
+ <iron-autogrow-textarea
+ id="textarea"
+ class=${classMap({noBorder: this.hideBorder})}
+ .autocomplete=${this.autocomplete}
+ .placeholder=${this.placeholder}
+ ?disabled=${this.disabled}
+ .rows=${this.rows}
+ .maxRows=${this.maxRows}
+ .value=${this.text}
+ @value-changed=${(e: ValueChangedEvent) => {
+ this.text = e.detail.value;
+ }}
+ @bind-value-changed=${this.onValueChanged}
+ ></iron-autogrow-textarea>
+ `;
+ }
+
+ override willUpdate(changedProperties: PropertyValues) {
+ if (changedProperties.has('text')) {
+ this.handleTextChanged(this.text);
+ }
+ if (changedProperties.has('currentSearchString')) {
+ this.determineSuggestions(this.currentSearchString!);
}
}
+ // private but used in test
closeDropdown() {
- this.$.emojiSuggestions.close();
+ this.emojiSuggestions?.close();
}
getNativeTextarea() {
- return this.$.textarea.textarea;
+ return this.textarea!.textarea;
}
putCursorAtEnd() {
@@ -211,85 +276,87 @@
});
}
- _handleEscKey(e: KeyboardEvent) {
- if (this._hideEmojiAutocomplete) {
+ private handleEscKey(e: KeyboardEvent) {
+ if (this.hideEmojiAutocomplete) {
return;
}
e.preventDefault();
e.stopPropagation();
- this._resetEmojiDropdown();
+ this.resetEmojiDropdown();
}
- _handleUpKey(e: KeyboardEvent) {
- if (this._hideEmojiAutocomplete) {
+ private handleUpKey(e: KeyboardEvent) {
+ if (this.hideEmojiAutocomplete) {
return;
}
e.preventDefault();
e.stopPropagation();
- this.$.emojiSuggestions.cursorUp();
- this.$.textarea.textarea.focus();
+ this.emojiSuggestions!.cursorUp();
+ this.textarea!.textarea.focus();
this.disableEnterKeyForSelectingEmoji = false;
}
- _handleDownKey(e: KeyboardEvent) {
- if (this._hideEmojiAutocomplete) {
+ private handleDownKey(e: KeyboardEvent) {
+ if (this.hideEmojiAutocomplete) {
return;
}
e.preventDefault();
e.stopPropagation();
- this.$.emojiSuggestions.cursorDown();
- this.$.textarea.textarea.focus();
+ this.emojiSuggestions!.cursorDown();
+ this.textarea!.textarea.focus();
this.disableEnterKeyForSelectingEmoji = false;
}
- _handleTabKey(e: KeyboardEvent) {
+ private handleTabKey(e: KeyboardEvent) {
// Tab should have normal behavior if the picker is closed or if the user
// has only typed ':'.
- if (this._hideEmojiAutocomplete || this.disableEnterKeyForSelectingEmoji) {
+ if (this.hideEmojiAutocomplete || this.disableEnterKeyForSelectingEmoji) {
return;
}
e.preventDefault();
e.stopPropagation();
- this._setEmoji(this.$.emojiSuggestions.getCurrentText());
+ this.setEmoji(this.emojiSuggestions!.getCurrentText());
}
- _handleEnterByKey(e: KeyboardEvent) {
+ // private but used in test
+ handleEnterByKey(e: KeyboardEvent) {
// Enter should have newline behavior if the picker is closed or if the user
// has only typed ':'. Also make sure that shortcuts aren't clobbered.
- if (this._hideEmojiAutocomplete || this.disableEnterKeyForSelectingEmoji) {
+ if (this.hideEmojiAutocomplete || this.disableEnterKeyForSelectingEmoji) {
this.indent(e);
return;
}
e.preventDefault();
e.stopPropagation();
- this._setEmoji(this.$.emojiSuggestions.getCurrentText());
+ this.setEmoji(this.emojiSuggestions!.getCurrentText());
}
- _handleEmojiSelect(e: CustomEvent<ItemSelectedEvent>) {
+ // private but used in test
+ handleEmojiSelect(e: CustomEvent<ItemSelectedEvent>) {
if (e.detail.selected?.dataset['value']) {
- this._setEmoji(e.detail.selected?.dataset['value']);
+ this.setEmoji(e.detail.selected?.dataset['value']);
}
}
- _setEmoji(text: string) {
- if (this._colonIndex === null) {
+ private setEmoji(text: string) {
+ if (this.colonIndex === null) {
return;
}
- const colonIndex = this._colonIndex;
- this.text = this._getText(text);
- this.$.textarea.selectionStart = colonIndex + 1;
- this.$.textarea.selectionEnd = colonIndex + 1;
+ const colonIndex = this.colonIndex;
+ this.text = this.getText(text);
+ this.textarea!.selectionStart = colonIndex + 1;
+ this.textarea!.selectionEnd = colonIndex + 1;
this.reporting.reportInteraction('select-emoji', {type: text});
- this._resetEmojiDropdown();
+ this.resetEmojiDropdown();
}
- _getText(value: string) {
+ private getText(value: string) {
if (!this.text) return '';
return (
- this.text.substr(0, this._colonIndex || 0) +
+ this.text.substr(0, this.colonIndex || 0) +
value +
- this.text.substr(this.$.textarea.selectionStart)
+ this.text.substr(this.textarea!.selectionStart)
);
}
@@ -298,27 +365,29 @@
* the text up until the point of interest. Then caratSpan element is added
* to the end and is set to be the positionTarget for the dropdown. Together
* this allows the dropdown to appear near where the user is typing.
+ * private but used in test
*/
- _updateCaratPosition() {
- this._hideEmojiAutocomplete = false;
- if (typeof this.$.textarea.value === 'string') {
- this.$.hiddenText.textContent = this.$.textarea.value.substr(
+ updateCaratPosition() {
+ this.hideEmojiAutocomplete = false;
+ if (typeof this.textarea!.value === 'string') {
+ this.hiddenText!.textContent = this.textarea!.value.substr(
0,
- this.$.textarea.selectionStart
+ this.textarea!.selectionStart
);
}
- const caratSpan = this.$.caratSpan;
- this.$.hiddenText.appendChild(caratSpan);
- this.$.emojiSuggestions.positionTarget = caratSpan;
- this._openEmojiDropdown();
+ const caratSpan = this.caratSpan!;
+ this.hiddenText!.appendChild(caratSpan);
+ this.emojiSuggestions!.positionTarget = caratSpan;
+ this.openEmojiDropdown();
}
/**
- * _handleKeydown used for key handling in the this.$.textarea AND all child
+ * handleKeydown used for key handling in the this.textarea! AND all child
* autocomplete options.
+ * private but used in test
*/
- _onValueChanged(e: BindValueChangeEvent) {
+ onValueChanged(e: BindValueChangeEvent) {
// Relay the event.
fire(this, 'bind-value-changed', {value: e.detail.value});
// If cursor is not in textarea (just opened with colon as last char),
@@ -332,9 +401,9 @@
const charAtCursor =
e.detail && e.detail.value
- ? e.detail.value[this.$.textarea.selectionStart - 1]
+ ? e.detail.value[this.textarea!.selectionStart - 1]
: '';
- if (charAtCursor !== ':' && this._colonIndex === null) {
+ if (charAtCursor !== ':' && this.colonIndex === null) {
return;
}
@@ -342,88 +411,95 @@
// colons after space or in beginning of textarea
if (charAtCursor === ':') {
if (
- this.$.textarea.selectionStart < 2 ||
- e.detail.value[this.$.textarea.selectionStart - 2] === ' '
+ this.textarea!.selectionStart < 2 ||
+ e.detail.value[this.textarea!.selectionStart - 2] === ' '
) {
- this._colonIndex = this.$.textarea.selectionStart - 1;
+ this.colonIndex = this.textarea!.selectionStart - 1;
}
}
- if (this._colonIndex === null) {
+ if (this.colonIndex === null) {
return;
}
- this._currentSearchString = e.detail.value.substr(
- this._colonIndex + 1,
- this.$.textarea.selectionStart - this._colonIndex - 1
+ this.currentSearchString = e.detail.value.substr(
+ this.colonIndex + 1,
+ this.textarea!.selectionStart - this.colonIndex - 1
);
+ this.determineSuggestions(this.currentSearchString);
// Under the following conditions, close and reset the dropdown:
// - The cursor is no longer at the end of the current search string
// - The search string is an space or new line
// - The colon has been removed
// - There are no suggestions that match the search string
if (
- this.$.textarea.selectionStart !==
- this._currentSearchString.length + this._colonIndex + 1 ||
- this._currentSearchString === ' ' ||
- this._currentSearchString === '\n' ||
- !(e.detail.value[this._colonIndex] === ':') ||
- !this._suggestions ||
- !this._suggestions.length
+ this.textarea!.selectionStart !==
+ this.currentSearchString.length + this.colonIndex + 1 ||
+ this.currentSearchString === ' ' ||
+ this.currentSearchString === '\n' ||
+ !(e.detail.value[this.colonIndex] === ':') ||
+ !this.suggestions ||
+ !this.suggestions.length
) {
- this._resetEmojiDropdown();
+ this.resetEmojiDropdown();
// Otherwise open the dropdown and set the position to be just below the
// cursor.
- } else if (this.$.emojiSuggestions.isHidden) {
- this._updateCaratPosition();
+ } else if (this.emojiSuggestions!.isHidden) {
+ this.updateCaratPosition();
}
- this.$.textarea.textarea.focus();
+ this.textarea!.textarea.focus();
}
- _openEmojiDropdown() {
- this.$.emojiSuggestions.open();
+ private openEmojiDropdown() {
+ this.emojiSuggestions!.open();
this.reporting.reportInteraction('open-emoji-dropdown');
}
- _formatSuggestions(matchedSuggestions: EmojiSuggestion[]) {
+ // private but used in test
+ formatSuggestions(matchedSuggestions: EmojiSuggestion[]) {
const suggestions = [];
for (const suggestion of matchedSuggestions) {
suggestion.dataValue = suggestion.value;
suggestion.text = `${suggestion.value} ${suggestion.match}`;
suggestions.push(suggestion);
}
- this.set('_suggestions', suggestions);
+ this.suggestions = suggestions;
}
- _determineSuggestions(emojiText: string) {
+ // private but used in test
+ determineSuggestions(emojiText: string) {
if (!emojiText.length) {
- this._formatSuggestions(ALL_SUGGESTIONS);
+ this.formatSuggestions(ALL_SUGGESTIONS);
this.disableEnterKeyForSelectingEmoji = true;
} else {
const matches = ALL_SUGGESTIONS.filter(suggestion =>
suggestion.match.includes(emojiText)
).slice(0, MAX_ITEMS_DROPDOWN);
- this._formatSuggestions(matches);
+ this.formatSuggestions(matches);
this.disableEnterKeyForSelectingEmoji = false;
}
}
- _resetEmojiDropdown() {
+ // private but used in test
+ resetEmojiDropdown() {
// hide and reset the autocomplete dropdown.
- flush();
- this._currentSearchString = '';
- this._hideEmojiAutocomplete = true;
+ this.requestUpdate();
+ this.currentSearchString = '';
+ this.hideEmojiAutocomplete = true;
this.closeDropdown();
- this._colonIndex = null;
- this.$.textarea.textarea.focus();
+ this.colonIndex = null;
+ this.textarea!.textarea.focus();
}
- _handleTextChanged(text: string) {
+ private handleTextChanged(text: string) {
// This is a bit redundant, because the `text` property has `notify:true`,
// so whenever the `text` changes the component fires two identical events
// `text-changed` and `value-changed`.
this.dispatchEvent(
new CustomEvent('value-changed', {detail: {value: text}})
);
+ this.dispatchEvent(
+ new CustomEvent('text-changed', {detail: {value: text}})
+ );
}
private indent(e: KeyboardEvent): void {
@@ -433,8 +509,10 @@
// When nothing is selected, selectionStart is the caret position. We want
// the indentation level of the current line, not the end of the text which
// may be different.
- const currentLine = this.$.textarea.textarea.value
- .substr(0, this.$.textarea.selectionStart)
+ const currentLine = this.textarea!.textarea.value.substr(
+ 0,
+ this.textarea!.selectionStart
+ )
.split('\n')
.pop();
const currentLineIndentation = currentLine?.match(/^\s*/)?.[0];
diff --git a/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea_html.ts b/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea_html.ts
deleted file mode 100644
index d55481b..0000000
--- a/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea_html.ts
+++ /dev/null
@@ -1,94 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="shared-styles">
- :host {
- display: flex;
- position: relative;
- }
- :host(.monospace) {
- font-family: var(--monospace-font-family);
- font-size: var(--font-size-mono);
- line-height: var(--line-height-mono);
- font-weight: var(--font-weight-normal);
- }
- :host(.code) {
- font-family: var(--monospace-font-family);
- font-size: var(--font-size-code);
- /* usually 16px = 12px + 4px */
- line-height: calc(var(--font-size-code) + var(--spacing-s));
- font-weight: var(--font-weight-normal);
- }
- #emojiSuggestions {
- font-family: var(--font-family);
- }
- gr-autocomplete {
- display: inline-block;
- }
- #textarea {
- background-color: var(--view-background-color);
- width: 100%;
- }
- #hiddenText #emojiSuggestions {
- visibility: visible;
- white-space: normal;
- }
- iron-autogrow-textarea {
- position: relative;
- }
- #textarea.noBorder {
- border: none;
- }
- #hiddenText {
- display: block;
- float: left;
- position: absolute;
- visibility: hidden;
- width: 100%;
- white-space: pre-wrap;
- }
- </style>
- <div id="hiddenText"></div>
- <!-- When the autocomplete is open, the span is moved at the end of
- hiddenText in order to correctly position the dropdown. After being moved,
- it is set as the positionTarget for the emojiSuggestions dropdown. -->
- <span id="caratSpan"></span>
- <gr-autocomplete-dropdown
- vertical-align="top"
- horizontal-align="left"
- dynamic-align=""
- id="emojiSuggestions"
- suggestions="[[_suggestions]]"
- index="[[_index]]"
- vertical-offset="[[_verticalOffset]]"
- on-dropdown-closed="_resetEmojiDropdown"
- on-item-selected="_handleEmojiSelect"
- >
- </gr-autocomplete-dropdown>
- <iron-autogrow-textarea
- id="textarea"
- autocomplete="[[autocomplete]]"
- placeholder="[[placeholder]]"
- disabled="[[disabled]]"
- rows="[[rows]]"
- max-rows="[[maxRows]]"
- value="{{text}}"
- on-bind-value-changed="_onValueChanged"
- ></iron-autogrow-textarea>
-`;
diff --git a/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea_test.ts b/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea_test.ts
index 318c720..a3b5bf4 100644
--- a/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea_test.ts
+++ b/polygerrit-ui/app/elements/shared/gr-textarea/gr-textarea_test.ts
@@ -18,26 +18,31 @@
import '../../../test/common-test-setup-karma';
import './gr-textarea';
import {GrTextarea} from './gr-textarea';
-import {html} from '@polymer/polymer/lib/utils/html-tag';
import * as MockInteractions from '@polymer/iron-test-helpers/mock-interactions';
import {ItemSelectedEvent} from '../gr-autocomplete-dropdown/gr-autocomplete-dropdown';
-
-const basicFixture = fixtureFromElement('gr-textarea');
-
-const monospaceFixture = fixtureFromTemplate(html`
- <gr-textarea monospace="true"></gr-textarea>
-`);
-
-const hideBorderFixture = fixtureFromTemplate(html`
- <gr-textarea hide-border="true"></gr-textarea>
-`);
+import {waitUntil} from '../../../test/test-utils';
+import {fixture, html} from '@open-wc/testing-helpers';
suite('gr-textarea tests', () => {
let element: GrTextarea;
- setup(() => {
- element = basicFixture.instantiate();
+ setup(async () => {
+ element = await fixture<GrTextarea>(html`<gr-textarea></gr-textarea>`);
sinon.stub(element.reporting, 'reportInteraction');
+ await element.updateComplete;
+ });
+
+ test('renders', () => {
+ expect(element).shadowDom.to.equal(/* HTML */ `<div id="hiddenText"></div>
+ <span id="caratSpan"> </span>
+ <gr-autocomplete-dropdown
+ id="emojiSuggestions"
+ is-hidden=""
+ style="position: fixed; top: 150px; left: 392.5px; box-sizing: border-box; max-height: 300px; max-width: 785px;"
+ >
+ </gr-autocomplete-dropdown>
+ <iron-autogrow-textarea aria-disabled="false" id="textarea">
+ </iron-autogrow-textarea> `);
});
test('monospace is set properly', () => {
@@ -45,91 +50,103 @@
});
test('hideBorder is set properly', () => {
- assert.isFalse(element.$.textarea.classList.contains('noBorder'));
+ assert.isFalse(element.textarea!.classList.contains('noBorder'));
});
- test('emoji selector is not open with the textarea lacks focus', () => {
- element.$.textarea.selectionStart = 1;
- element.$.textarea.selectionEnd = 1;
+ test('emoji selector is not open with the textarea lacks focus', async () => {
+ element.textarea!.selectionStart = 1;
+ element.textarea!.selectionEnd = 1;
element.text = ':';
- assert.isFalse(!element.$.emojiSuggestions.isHidden);
+ await element.updateComplete;
+ assert.isFalse(!element.emojiSuggestions!.isHidden);
});
- test('emoji selector is not open when a general text is entered', () => {
- MockInteractions.focus(element.$.textarea);
- element.$.textarea.selectionStart = 9;
- element.$.textarea.selectionEnd = 9;
+ test('emoji selector is not open when a general text is entered', async () => {
+ MockInteractions.focus(element.textarea!);
+ await waitUntil(() => element.textarea!.focused === true);
+ element.textarea!.selectionStart = 9;
+ element.textarea!.selectionEnd = 9;
element.text = 'some text';
- assert.isFalse(!element.$.emojiSuggestions.isHidden);
+ await element.updateComplete;
+ assert.isFalse(!element.emojiSuggestions!.isHidden);
});
- test('emoji selector opens when a colon is typed & the textarea has focus', () => {
- MockInteractions.focus(element.$.textarea);
+ test('emoji selector is open when a colon is typed & the textarea has focus', async () => {
// Needed for Safari tests. selectionStart is not updated when text is
// updated.
- element.$.textarea.selectionStart = 1;
- element.$.textarea.selectionEnd = 1;
+ const listenerStub = sinon.stub();
+ element.addEventListener('bind-value-changed', listenerStub);
+ MockInteractions.focus(element.textarea!);
+ await waitUntil(() => element.textarea!.focused === true);
+ element.textarea!.selectionStart = 1;
+ element.textarea!.selectionEnd = 1;
element.text = ':';
- flush();
- assert.isFalse(element.$.emojiSuggestions.isHidden);
- assert.equal(element._colonIndex, 0);
- assert.isFalse(element._hideEmojiAutocomplete);
- assert.equal(element._currentSearchString, '');
+ await element.updateComplete;
+ assert.equal(listenerStub.lastCall.args[0].detail.value, ':');
+ assert.isTrue(element.textarea!.focused);
+ assert.isFalse(element.emojiSuggestions!.isHidden);
+ assert.equal(element.colonIndex, 0);
+ assert.isFalse(element.hideEmojiAutocomplete);
+ assert.equal(element.currentSearchString, '');
});
- test('emoji selector opens when a colon is typed after space', () => {
- MockInteractions.focus(element.$.textarea);
+ test('emoji selector opens when a colon is typed after space', async () => {
+ MockInteractions.focus(element.textarea!);
+ await waitUntil(() => element.textarea!.focused === true);
// Needed for Safari tests. selectionStart is not updated when text is
// updated.
- element.$.textarea.selectionStart = 2;
- element.$.textarea.selectionEnd = 2;
+ element.textarea!.selectionStart = 2;
+ element.textarea!.selectionEnd = 2;
element.text = ' :';
- flush();
- assert.isFalse(element.$.emojiSuggestions.isHidden);
- assert.equal(element._colonIndex, 1);
- assert.isFalse(element._hideEmojiAutocomplete);
- assert.equal(element._currentSearchString, '');
+ await element.updateComplete;
+ assert.isFalse(element.emojiSuggestions!.isHidden);
+ assert.equal(element.colonIndex, 1);
+ assert.isFalse(element.hideEmojiAutocomplete);
+ assert.equal(element.currentSearchString, '');
});
- test('emoji selector doesn`t open when a colon is typed after character', () => {
- MockInteractions.focus(element.$.textarea);
+ test('emoji selector doesn`t open when a colon is typed after character', async () => {
+ MockInteractions.focus(element.textarea!);
+ await waitUntil(() => element.textarea!.focused === true);
// Needed for Safari tests. selectionStart is not updated when text is
// updated.
- element.$.textarea.selectionStart = 5;
- element.$.textarea.selectionEnd = 5;
+ element.textarea!.selectionStart = 5;
+ element.textarea!.selectionEnd = 5;
element.text = 'test:';
- flush();
- assert.isTrue(element.$.emojiSuggestions.isHidden);
- assert.isTrue(element._hideEmojiAutocomplete);
+ await element.updateComplete;
+ assert.isTrue(element.emojiSuggestions!.isHidden);
+ assert.isTrue(element.hideEmojiAutocomplete);
});
- test('emoji selector opens when a colon is typed and some substring', () => {
- MockInteractions.focus(element.$.textarea);
+ test('emoji selector opens when a colon is typed and some substring', async () => {
+ MockInteractions.focus(element.textarea!);
+ await waitUntil(() => element.textarea!.focused === true);
// Needed for Safari tests. selectionStart is not updated when text is
// updated.
- element.$.textarea.selectionStart = 1;
- element.$.textarea.selectionEnd = 1;
+ element.textarea!.selectionStart = 1;
+ element.textarea!.selectionEnd = 1;
element.text = ':';
- element.$.textarea.selectionStart = 2;
- element.$.textarea.selectionEnd = 2;
+ await element.updateComplete;
+ element.textarea!.selectionStart = 2;
+ element.textarea!.selectionEnd = 2;
element.text = ':t';
- flush();
- assert.isFalse(element.$.emojiSuggestions.isHidden);
- assert.equal(element._colonIndex, 0);
- assert.isFalse(element._hideEmojiAutocomplete);
- assert.equal(element._currentSearchString, 't');
+ await element.updateComplete;
+ assert.isFalse(element.emojiSuggestions!.isHidden);
+ assert.equal(element.colonIndex, 0);
+ assert.isFalse(element.hideEmojiAutocomplete);
+ assert.equal(element.currentSearchString, 't');
});
- test('emoji selector opens when a colon is typed in middle of text', () => {
- MockInteractions.focus(element.$.textarea);
+ test('emoji selector opens when a colon is typed in middle of text', async () => {
+ MockInteractions.focus(element.textarea!);
// Needed for Safari tests. selectionStart is not updated when text is
// updated.
- element.$.textarea.selectionStart = 1;
- element.$.textarea.selectionEnd = 1;
+ element.textarea!.selectionStart = 1;
+ element.textarea!.selectionEnd = 1;
// Since selectionStart is on Chrome set always on end of text, we
// stub it to 1
const text = ': hello';
- sinon.stub(element.$, 'textarea').value({
+ sinon.stub(element, 'textarea').value({
selectionStart: 1,
value: text,
textarea: {
@@ -137,49 +154,55 @@
},
});
element.text = text;
- flush();
- assert.isFalse(element.$.emojiSuggestions.isHidden);
- assert.equal(element._colonIndex, 0);
- assert.isFalse(element._hideEmojiAutocomplete);
- assert.equal(element._currentSearchString, '');
+ await element.updateComplete;
+ assert.isFalse(element.emojiSuggestions!.isHidden);
+ assert.equal(element.colonIndex, 0);
+ assert.isFalse(element.hideEmojiAutocomplete);
+ assert.equal(element.currentSearchString, '');
});
- test('emoji selector closes when text changes before the colon', () => {
- const resetStub = sinon.stub(element, '_resetEmojiDropdown');
- MockInteractions.focus(element.$.textarea);
- flush();
- element.$.textarea.selectionStart = 10;
- element.$.textarea.selectionEnd = 10;
- element.text = 'test test ';
- element.$.textarea.selectionStart = 12;
- element.$.textarea.selectionEnd = 12;
- element.text = 'test test :';
- element.$.textarea.selectionStart = 15;
- element.$.textarea.selectionEnd = 15;
- element.text = 'test test :smi';
- assert.equal(element._currentSearchString, 'smi');
+ test('emoji selector closes when text changes before the colon', async () => {
+ const resetStub = sinon.stub(element, 'resetEmojiDropdown');
+ MockInteractions.focus(element.textarea!);
+ await waitUntil(() => element.textarea!.focused === true);
+ await element.updateComplete;
+ element.textarea!.selectionStart = 10;
+ element.textarea!.selectionEnd = 10;
+ element.text = 'test test ';
+ await element.updateComplete;
+ element.textarea!.selectionStart = 12;
+ element.textarea!.selectionEnd = 12;
+ element.text = 'test test :';
+ await element.updateComplete;
+ element.textarea!.selectionStart = 15;
+ element.textarea!.selectionEnd = 15;
+ element.text = 'test test :smi';
+ await element.updateComplete;
+
+ assert.equal(element.currentSearchString, 'smi');
assert.isFalse(resetStub.called);
element.text = 'test test test :smi';
+ await element.updateComplete;
assert.isTrue(resetStub.called);
});
- test('_resetEmojiDropdown', () => {
+ test('resetEmojiDropdown', async () => {
const closeSpy = sinon.spy(element, 'closeDropdown');
- element._resetEmojiDropdown();
- assert.equal(element._currentSearchString, '');
- assert.isTrue(element._hideEmojiAutocomplete);
- assert.equal(element._colonIndex, null);
+ element.resetEmojiDropdown();
+ assert.equal(element.currentSearchString, '');
+ assert.isTrue(element.hideEmojiAutocomplete);
+ assert.equal(element.colonIndex, null);
- element.$.emojiSuggestions.open();
- flush();
- element._resetEmojiDropdown();
+ element.emojiSuggestions!.open();
+ await element.updateComplete;
+ element.resetEmojiDropdown();
assert.isTrue(closeSpy.called);
});
- test('_determineSuggestions', () => {
+ test('determineSuggestions', () => {
const emojiText = 'tear';
- const formatSpy = sinon.spy(element, '_formatSuggestions');
- element._determineSuggestions(emojiText);
+ const formatSpy = sinon.spy(element, 'formatSuggestions');
+ element.determineSuggestions(emojiText);
assert.isTrue(formatSpy.called);
assert.isTrue(
formatSpy.lastCall.calledWithExactly([
@@ -194,120 +217,124 @@
);
});
- test('_formatSuggestions', () => {
+ test('formatSuggestions', () => {
const matchedSuggestions = [
{value: '😢', match: 'tear'},
{value: '😂', match: 'tears'},
];
- element._formatSuggestions(matchedSuggestions);
+ element.formatSuggestions(matchedSuggestions);
assert.deepEqual(
[
{value: '😢', dataValue: '😢', match: 'tear', text: '😢 tear'},
{value: '😂', dataValue: '😂', match: 'tears', text: '😂 tears'},
],
- element._suggestions
+ element.suggestions
);
});
- test('_handleEmojiSelect', () => {
- element.$.textarea.selectionStart = 16;
- element.$.textarea.selectionEnd = 16;
+ test('handleEmojiSelect', async () => {
+ element.textarea!.selectionStart = 16;
+ element.textarea!.selectionEnd = 16;
element.text = 'test test :tears';
- element._colonIndex = 10;
+ element.colonIndex = 10;
+ await element.updateComplete;
const selectedItem = {dataset: {value: '😂'}} as unknown as HTMLElement;
const event = new CustomEvent<ItemSelectedEvent>('item-selected', {
detail: {trigger: 'click', selected: selectedItem},
});
- element._handleEmojiSelect(event);
+ element.handleEmojiSelect(event);
assert.equal(element.text, 'test test 😂');
});
- test('_updateCaratPosition', () => {
- element.$.textarea.selectionStart = 4;
- element.$.textarea.selectionEnd = 4;
+ test('updateCaratPosition', async () => {
+ element.textarea!.selectionStart = 4;
+ element.textarea!.selectionEnd = 4;
element.text = 'test';
- element._updateCaratPosition();
+ await element.updateComplete;
+ element.updateCaratPosition();
assert.deepEqual(
- element.$.hiddenText.innerHTML,
- element.text + element.$.caratSpan.outerHTML
+ element.hiddenText!.innerHTML,
+ element.text + element.caratSpan!.outerHTML
);
});
test('newline receives matching indentation', async () => {
const indentCommand = sinon.stub(document, 'execCommand');
- element.$.textarea.value = ' a';
- element._handleEnterByKey(
+ element.textarea!.value = ' a';
+ element.handleEnterByKey(
new KeyboardEvent('keydown', {key: 'Enter', keyCode: 13})
);
- await flush();
+ await element.updateComplete;
assert.deepEqual(indentCommand.args[0], ['insertText', false, '\n ']);
});
- test('emoji dropdown is closed when iron-overlay-closed is fired', () => {
- const resetSpy = sinon.spy(element, '_resetEmojiDropdown');
- element.$.emojiSuggestions.dispatchEvent(
+ test('emoji dropdown is closed when iron-overlay-closed is fired', async () => {
+ const resetSpy = sinon.spy(element, 'closeDropdown');
+ element.emojiSuggestions!.dispatchEvent(
new CustomEvent('dropdown-closed', {
composed: true,
bubbles: true,
})
);
+ await element.updateComplete;
assert.isTrue(resetSpy.called);
});
- test('_onValueChanged fires bind-value-changed', () => {
+ test('onValueChanged fires bind-value-changed', () => {
const listenerStub = sinon.stub();
const eventObject = new CustomEvent('bind-value-changed', {
detail: {currentTarget: {focused: false}, value: ''},
});
element.addEventListener('bind-value-changed', listenerStub);
- element._onValueChanged(eventObject);
+ element.onValueChanged(eventObject);
assert.isTrue(listenerStub.called);
});
- suite('keyboard shortcuts', () => {
- function setupDropdown() {
- MockInteractions.focus(element.$.textarea);
- element.$.textarea.selectionStart = 1;
- element.$.textarea.selectionEnd = 1;
+ suite('keyboard shortcuts', async () => {
+ async function setupDropdown() {
+ MockInteractions.focus(element.textarea!);
+ element.textarea!.selectionStart = 1;
+ element.textarea!.selectionEnd = 1;
element.text = ':';
- element.$.textarea.selectionStart = 1;
- element.$.textarea.selectionEnd = 2;
+ await element.updateComplete;
+ element.textarea!.selectionStart = 1;
+ element.textarea!.selectionEnd = 2;
element.text = ':1';
- flush();
+ await element.updateComplete;
}
- test('escape key', () => {
- const resetSpy = sinon.spy(element, '_resetEmojiDropdown');
+ test('escape key', async () => {
+ const resetSpy = sinon.spy(element, 'resetEmojiDropdown');
MockInteractions.pressAndReleaseKeyOn(
- element.$.textarea,
+ element.textarea!,
27,
null,
'Escape'
);
assert.isFalse(resetSpy.called);
- setupDropdown();
+ await setupDropdown();
MockInteractions.pressAndReleaseKeyOn(
- element.$.textarea,
+ element.textarea!,
27,
null,
'Escape'
);
assert.isTrue(resetSpy.called);
- assert.isFalse(!element.$.emojiSuggestions.isHidden);
+ assert.isFalse(!element.emojiSuggestions!.isHidden);
});
- test('up key', () => {
- const upSpy = sinon.spy(element.$.emojiSuggestions, 'cursorUp');
+ test('up key', async () => {
+ const upSpy = sinon.spy(element.emojiSuggestions!, 'cursorUp');
MockInteractions.pressAndReleaseKeyOn(
- element.$.textarea,
+ element.textarea!,
38,
null,
'ArrowUp'
);
assert.isFalse(upSpy.called);
- setupDropdown();
+ await setupDropdown();
MockInteractions.pressAndReleaseKeyOn(
- element.$.textarea,
+ element.textarea!,
38,
null,
'ArrowUp'
@@ -315,18 +342,18 @@
assert.isTrue(upSpy.called);
});
- test('down key', () => {
- const downSpy = sinon.spy(element.$.emojiSuggestions, 'cursorDown');
+ test('down key', async () => {
+ const downSpy = sinon.spy(element.emojiSuggestions!, 'cursorDown');
MockInteractions.pressAndReleaseKeyOn(
- element.$.textarea,
+ element.textarea!,
40,
null,
'ArrowDown'
);
assert.isFalse(downSpy.called);
- setupDropdown();
+ await setupDropdown();
MockInteractions.pressAndReleaseKeyOn(
- element.$.textarea,
+ element.textarea!,
40,
null,
'ArrowDown'
@@ -334,37 +361,37 @@
assert.isTrue(downSpy.called);
});
- test('enter key', () => {
- const enterSpy = sinon.spy(element.$.emojiSuggestions, 'getCursorTarget');
+ test('enter key', async () => {
+ const enterSpy = sinon.spy(element.emojiSuggestions!, 'getCursorTarget');
MockInteractions.pressAndReleaseKeyOn(
- element.$.textarea,
+ element.textarea!,
13,
null,
'Enter'
);
assert.isFalse(enterSpy.called);
- setupDropdown();
+ await setupDropdown();
MockInteractions.pressAndReleaseKeyOn(
- element.$.textarea,
+ element.textarea!,
13,
null,
'Enter'
);
assert.isTrue(enterSpy.called);
- flush();
+ await element.updateComplete;
assert.equal(element.text, '💯');
});
- test('enter key - ignored on just colon without more information', () => {
- const enterSpy = sinon.spy(element.$.emojiSuggestions, 'getCursorTarget');
- MockInteractions.pressAndReleaseKeyOn(element.$.textarea, 13);
+ test('enter key - ignored on just colon without more information', async () => {
+ const enterSpy = sinon.spy(element.emojiSuggestions!, 'getCursorTarget');
+ MockInteractions.pressAndReleaseKeyOn(element.textarea!, 13);
assert.isFalse(enterSpy.called);
- MockInteractions.focus(element.$.textarea);
- element.$.textarea.selectionStart = 1;
- element.$.textarea.selectionEnd = 1;
+ MockInteractions.focus(element.textarea!);
+ element.textarea!.selectionStart = 1;
+ element.textarea!.selectionEnd = 1;
element.text = ':';
- flush();
- MockInteractions.pressAndReleaseKeyOn(element.$.textarea, 13);
+ await element.updateComplete;
+ MockInteractions.pressAndReleaseKeyOn(element.textarea!, 13);
assert.isFalse(enterSpy.called);
});
});
@@ -378,8 +405,11 @@
let element: GrTextarea;
- setup(() => {
- element = monospaceFixture.instantiate() as GrTextarea;
+ setup(async () => {
+ element = await fixture<GrTextarea>(
+ html`<gr-textarea monospace></gr-textarea>`
+ );
+ await element.updateComplete;
});
test('monospace is set properly', () => {
@@ -396,12 +426,15 @@
let element: GrTextarea;
- setup(() => {
- element = hideBorderFixture.instantiate() as GrTextarea;
+ setup(async () => {
+ element = await fixture<GrTextarea>(
+ html`<gr-textarea hide-border></gr-textarea>`
+ );
+ await element.updateComplete;
});
test('hideBorder is set properly', () => {
- assert.isTrue(element.$.textarea.classList.contains('noBorder'));
+ assert.isTrue(element.textarea!.classList.contains('noBorder'));
});
});
});
diff --git a/polygerrit-ui/app/elements/shared/gr-vote-chip/gr-vote-chip.ts b/polygerrit-ui/app/elements/shared/gr-vote-chip/gr-vote-chip.ts
index 146a01e..c4aa413 100644
--- a/polygerrit-ui/app/elements/shared/gr-vote-chip/gr-vote-chip.ts
+++ b/polygerrit-ui/app/elements/shared/gr-vote-chip/gr-vote-chip.ts
@@ -126,6 +126,12 @@
.container {
position: relative;
}
+ /* fix for firefox only */
+ @supports (-moz-appearance: none) {
+ .container.more {
+ display: inline-block;
+ }
+ }
`,
];
}
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element.ts b/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element.ts
index aabdf57..e426e66 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element.ts
+++ b/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element.ts
@@ -32,6 +32,7 @@
import {CoverageRange, DiffLayer} from '../../../types/types';
import {
GrDiffProcessor,
+ GroupConsumer,
KeyLocations,
} from '../gr-diff-processor/gr-diff-processor';
import {
@@ -47,7 +48,6 @@
GrDiffGroupType,
hideInContextControl,
} from '../gr-diff/gr-diff-group';
-import {PolymerSpliceChange} from '@polymer/polymer/interfaces';
import {getLineNumber, getSideByLineEl} from '../gr-diff/gr-diff-utils';
import {fireAlert, fireEvent} from '../../../utils/event-util';
import {afterNextRender} from '@polymer/polymer/lib/utils/render-status';
@@ -58,12 +58,6 @@
const COMMIT_MSG_PATH = '/COMMIT_MSG';
const COMMIT_MSG_LINE_LENGTH = 72;
-export interface GrDiffBuilderElement {
- $: {
- processor: GrDiffProcessor;
- };
-}
-
export function getLineNumberCellWidth(prefs: DiffPreferencesInfo) {
return prefs.font_size * 4;
}
@@ -94,7 +88,10 @@
}
@customElement('gr-diff-builder')
-export class GrDiffBuilderElement extends PolymerElement {
+export class GrDiffBuilderElement
+ extends PolymerElement
+ implements GroupConsumer
+{
static get template() {
return htmlTemplate;
}
@@ -200,6 +197,8 @@
private rangeLayer = new GrRangedCommentLayer();
+ private processor = new GrDiffProcessor();
+
constructor() {
super();
afterNextRender(this, () => {
@@ -212,9 +211,11 @@
}
);
});
+ this.processor.consumer = this;
}
override disconnectedCallback() {
+ this.processor.cancel();
if (this._builder) {
this._builder.clear();
}
@@ -264,8 +265,8 @@
}
this._builder = this._getDiffBuilder();
- this.$.processor.context = this.prefs.context;
- this.$.processor.keyLocations = keyLocations;
+ this.processor.context = this.prefs.context;
+ this.processor.keyLocations = keyLocations;
this._clearDiffContent();
this._builder.addColumns(
@@ -277,7 +278,7 @@
fireEvent(this, 'render-start');
this._cancelableRenderPromise = util.makeCancelable(
- this.$.processor.process(this.diff.content, isBinary).then(() => {
+ this.processor.process(this.diff.content, isBinary).then(() => {
if (this.isImageDiff) {
(this._builder as GrDiffBuilderImage).renderDiff();
}
@@ -414,7 +415,7 @@
}
cancel() {
- this.$.processor.cancel();
+ this.processor.cancel();
if (this._cancelableRenderPromise) {
this._cancelableRenderPromise.cancel();
this._cancelableRenderPromise = null;
@@ -490,28 +491,20 @@
}
/**
- * Forward groups added by the processor to the builder for rendering.
+ * Called when the processor starts converting the diff information from the
+ * server into chunks.
*/
- @observe('_groups.splices')
- _groupsChanged(changeRecord: PolymerSpliceChange<GrDiffGroup[]>) {
- if (!changeRecord || !this._builder) return;
+ clearGroups() {
+ if (!this._builder) return;
+ this._builder.clearGroups();
+ }
- // The processor either removes all groups or adds new ones to the end,
- // so let's simplify the Polymer splices.
- const isRemoval = changeRecord.indexSplices.find(
- splice => splice.removed.length > 0
- );
- if (isRemoval) {
- this._builder.clearGroups();
- return;
- }
- for (const splice of changeRecord.indexSplices) {
- const added = splice.object.slice(
- splice.index,
- splice.index + splice.addedCount
- );
- this._builder.addGroups(added);
- }
+ /**
+ * Called when the processor is done converting a chunk of the diff.
+ */
+ addGroup(group: GrDiffGroup) {
+ if (!this._builder) return;
+ this._builder.addGroups([group]);
fireEvent(this, 'render-progress');
}
@@ -613,7 +606,7 @@
updateRenderPrefs(renderPrefs: RenderPreferences) {
this._builder?.updateRenderPrefs(renderPrefs);
- this.$.processor.updateRenderPrefs(renderPrefs);
+ this.processor.updateRenderPrefs(renderPrefs);
}
}
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element_html.ts b/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element_html.ts
index 581f0fb..bd0e034 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element_html.ts
+++ b/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element_html.ts
@@ -20,5 +20,4 @@
<div class="contentWrapper">
<slot></slot>
</div>
- <gr-diff-processor id="processor" groups="{{_groups}}"></gr-diff-processor>
`;
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element_test.js b/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element_test.js
index 42d9edf..0ad21b0 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element_test.js
+++ b/polygerrit-ui/app/embed/diff/gr-diff-builder/gr-diff-builder-element_test.js
@@ -15,7 +15,7 @@
* limitations under the License.
*/
import '../../../test/common-test-setup-karma.js';
-import {getMockDiffResponse} from '../../../test/mocks/diff-response.js';
+import {createDiff} from '../../../test/test-data-generators.js';
import './gr-diff-builder-element.js';
import {stubBaseUrl} from '../../../test/test-utils.js';
import {GrAnnotation} from '../gr-diff-highlight/gr-annotation.js';
@@ -554,7 +554,7 @@
setup(() => {
element = basicFixture.instantiate();
element.viewMode = 'SIDE_BY_SIDE';
- processStub = sinon.stub(element.$.processor, 'process')
+ processStub = sinon.stub(element.processor, 'process')
.returns(Promise.resolve());
keyLocations = {left: {}, right: {}};
element.prefs = {
@@ -668,7 +668,7 @@
});
test('cancel cancels the processor', () => {
- const processorCancelStub = sinon.stub(element.$.processor, 'cancel');
+ const processorCancelStub = sinon.stub(element.processor, 'cancel');
element.cancel();
assert.isTrue(processorCancelStub.called);
});
@@ -775,7 +775,7 @@
setup(async () => {
element = mockDiffFixture.instantiate();
- diff = getMockDiffResponse();
+ diff = createDiff();
element.diff = diff;
keyLocations = {left: {}, right: {}};
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-cursor/gr-diff-cursor.ts b/polygerrit-ui/app/embed/diff/gr-diff-cursor/gr-diff-cursor.ts
index dfe8a15..5e2dec0 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-cursor/gr-diff-cursor.ts
+++ b/polygerrit-ui/app/embed/diff/gr-diff-cursor/gr-diff-cursor.ts
@@ -125,9 +125,9 @@
}
dispose() {
+ this.cursorManager.unsetCursor();
if (this.targetSubscription) this.targetSubscription.unsubscribe();
window.removeEventListener('scroll', this._boundHandleWindowScroll);
- this.cursorManager.unsetCursor();
}
// Don't remove - used by clients embedding gr-diff outside of Gerrit.
@@ -290,6 +290,7 @@
* reset the scroll behavior, use reInit() instead.
*/
reInitCursor() {
+ this._updateStops();
if (!this.diffRow) {
// does not scroll during init unless requested
this.cursorManager.scrollMode = this.initialLineNumber
@@ -323,7 +324,6 @@
}
handleDiffUpdate() {
- this._updateStops();
this.reInitCursor();
}
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-cursor/gr-diff-cursor_test.js b/polygerrit-ui/app/embed/diff/gr-diff-cursor/gr-diff-cursor_test.js
index 609b33e..c64f484 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-cursor/gr-diff-cursor_test.js
+++ b/polygerrit-ui/app/embed/diff/gr-diff-cursor/gr-diff-cursor_test.js
@@ -20,7 +20,7 @@
import './gr-diff-cursor.js';
import {fixture, html} from '@open-wc/testing-helpers';
import {listenOnce, mockPromise} from '../../../test/test-utils.js';
-import {getMockDiffResponse} from '../../../test/mocks/diff-response.js';
+import {createDiff} from '../../../test/test-data-generators.js';
import {createDefaultDiffPrefs} from '../../../constants/constants.js';
import {GrDiffCursor} from './gr-diff-cursor.js';
@@ -52,7 +52,7 @@
};
diffElement.addEventListener('render', setupDone);
- diff = getMockDiffResponse();
+ diff = createDiff();
diffElement.prefs = createDefaultDiffPrefs();
diffElement.diff = diff;
await promise;
@@ -468,7 +468,7 @@
promise.resolve();
}
diffElement.addEventListener('render', renderHandler);
- diffElement._diffChanged(getMockDiffResponse());
+ diffElement._diffChanged(createDiff());
await promise;
});
@@ -495,7 +495,7 @@
cursor.initialLineNumber = 10;
cursor.side = 'right';
- diffElement._diffChanged(getMockDiffResponse());
+ diffElement._diffChanged(createDiff());
await promise;
});
@@ -548,7 +548,7 @@
end_line: 6,
end_character: 1,
};
- diffElement.$.highlights.selectedRange = {
+ diffElement.highlights.selectedRange = {
side: 'right',
range: someRange,
};
@@ -661,8 +661,8 @@
const diffRenderedPromises =
diffElements.map(diffEl => listenOnce(diffEl, 'render'));
- diffElements[0].diff = getMockDiffResponse();
- diffElements[2].diff = getMockDiffResponse();
+ diffElements[0].diff = createDiff();
+ diffElements[2].diff = createDiff();
await Promise.all([diffRenderedPromises[0], diffRenderedPromises[2]]);
const lastLine = diffElements[0].diff.meta_b.lines;
@@ -683,7 +683,7 @@
assert.equal(cursor.getTargetLineElement().textContent, lastLine);
// Diff 1 finishing to load
- diffElements[1].diff = getMockDiffResponse();
+ diffElements[1].diff = createDiff();
await diffRenderedPromises[1];
// Now we can go down
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight.ts b/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight.ts
index 2ee6c9f..0714645 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight.ts
+++ b/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight.ts
@@ -1,43 +1,25 @@
/**
* @license
- * 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.
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
*/
import '../../../styles/shared-styles';
import '../gr-selection-action-box/gr-selection-action-box';
-import {dom, EventApi} from '@polymer/polymer/lib/legacy/polymer.dom';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-diff-highlight_html';
import {GrAnnotation} from './gr-annotation';
import {normalize} from './gr-range-normalizer';
import {strToClassName} from '../../../utils/dom-util';
-import {customElement, property} from '@polymer/decorators';
import {Side} from '../../../constants/constants';
import {CommentRange} from '../../../types/common';
import {GrSelectionActionBox} from '../gr-selection-action-box/gr-selection-action-box';
-import {GrDiffBuilderElement} from '../gr-diff-builder/gr-diff-builder-element';
import {FILE} from '../gr-diff/gr-diff-line';
import {
getLineElByChild,
getLineNumberByChild,
- getRange,
- getSide,
getSideByLineEl,
GrDiffThreadElement,
} from '../gr-diff/gr-diff-utils';
import {debounce, DelayedTask} from '../../../utils/async-util';
-import {queryAndAssert} from '../../../utils/common-util';
+import {assertIsDefined, queryAndAssert} from '../../../utils/common-util';
interface SidedRange {
side: Side;
@@ -56,51 +38,65 @@
end: NormalizedPosition | null;
}
-@customElement('gr-diff-highlight')
-export class GrDiffHighlight extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
+/**
+ * The methods that we actually want to call on the builder. We don't want a
+ * fully blown dependency on GrDiffBuilderElement.
+ */
+export interface DiffBuilderInterface {
+ getContentTdByLineEl(lineEl?: Element): Element | null;
+}
- @property({type: Array, notify: true})
- commentRanges: SidedRange[] = [];
-
- @property({type: Boolean})
- loggedIn?: boolean;
-
- @property({type: Object})
- _cachedDiffBuilder?: GrDiffBuilderElement;
-
- @property({type: Object, notify: true})
+/**
+ * Handles showing, positioning and interacting with <gr-selection-action-box>.
+ *
+ * Toggles a css class for highlighting comment ranges when the mouse leaves or
+ * enters a comment thread element.
+ */
+export class GrDiffHighlight {
selectedRange?: SidedRange;
+ private diffBuilder?: DiffBuilderInterface;
+
+ private diffTable?: HTMLElement;
+
private selectionChangeTask?: DelayedTask;
- constructor() {
- super();
- this.addEventListener('comment-thread-mouseleave', e =>
- this._handleCommentThreadMouseleave(e)
+ init(diffTable: HTMLElement, diffBuilder: DiffBuilderInterface) {
+ this.cleanup();
+
+ this.diffTable = diffTable;
+ this.diffBuilder = diffBuilder;
+
+ diffTable.addEventListener(
+ 'comment-thread-mouseleave',
+ this.handleCommentThreadMouseleave
);
- this.addEventListener('comment-thread-mouseenter', e =>
- this._handleCommentThreadMouseenter(e)
+ diffTable.addEventListener(
+ 'comment-thread-mouseenter',
+ this.handleCommentThreadMouseenter
);
- this.addEventListener('create-comment-requested', e =>
- this._handleRangeCommentRequest(e)
+ diffTable.addEventListener(
+ 'create-comment-requested',
+ this.handleRangeCommentRequest
);
}
- override disconnectedCallback() {
+ cleanup() {
this.selectionChangeTask?.cancel();
- super.disconnectedCallback();
- }
-
- get diffBuilder() {
- if (!this._cachedDiffBuilder) {
- this._cachedDiffBuilder = this.querySelector(
- 'gr-diff-builder'
- ) as GrDiffBuilderElement;
+ if (this.diffTable) {
+ this.diffTable.removeEventListener(
+ 'comment-thread-mouseleave',
+ this.handleCommentThreadMouseleave
+ );
+ this.diffTable.removeEventListener(
+ 'comment-thread-mouseenter',
+ this.handleCommentThreadMouseenter
+ );
+ this.diffTable.removeEventListener(
+ 'create-comment-requested',
+ this.handleRangeCommentRequest
+ );
}
- return this._cachedDiffBuilder;
}
/**
@@ -129,18 +125,17 @@
// removed.
// If you wait longer than 50 ms, then you don't properly catch a very
// quick 'c' press after the selection change. If you wait less than 10
- // ms, then you will have about 50 _handleSelection calls when doing a
+ // ms, then you will have about 50 handleSelection() calls when doing a
// simple drag for select.
this.selectionChangeTask = debounce(
this.selectionChangeTask,
- () => this._handleSelection(selection, isMouseUp),
+ () => this.handleSelection(selection, isMouseUp),
10
);
}
- _getThreadEl(e: Event): GrDiffThreadElement | null {
- const path = (dom(e) as EventApi).path || [];
- for (const pathEl of path) {
+ private getThreadEl(e: Event): GrDiffThreadElement | null {
+ for (const pathEl of e.composedPath()) {
if (
pathEl instanceof HTMLElement &&
pathEl.classList.contains('comment-thread')
@@ -151,130 +146,74 @@
return null;
}
- _toggleRangeElHighlight(
- threadEl: GrDiffThreadElement,
+ private toggleRangeElHighlight(
+ threadEl: GrDiffThreadElement | null,
highlightRange = false
) {
- // We don't want to re-create the line just for highlighting the range which
- // is creating annoying bugs: @see Issue 12934
- // As gr-ranged-comment-layer now does not notify the layer re-render and
- // lack of access to the thread or the lineEl from the ranged-comment-layer,
- // need to update range class for styles here.
- let curNode: HTMLElement | null = threadEl.assignedSlot;
- while (curNode) {
- if (curNode.nodeName === 'TABLE') break;
- curNode = curNode.parentElement;
- }
- if (curNode?.querySelectorAll) {
- if (highlightRange) {
- const rangeNodes = curNode.querySelectorAll(
- `.range.${strToClassName(threadEl.rootId)}`
- );
- rangeNodes.forEach(rangeNode => {
- rangeNode.classList.add('rangeHoverHighlight');
- });
- const hintNode = threadEl.parentElement?.querySelector(
- `gr-ranged-comment-hint[threadElRootId="${threadEl.rootId}"]`
- );
- if (hintNode) {
- hintNode.shadowRoot
- ?.querySelectorAll('.rangeHighlight')
- .forEach(highlightNode =>
- highlightNode.classList.add('rangeHoverHighlight')
- );
- }
- } else {
- const rangeNodes = curNode.querySelectorAll(
- `.rangeHoverHighlight.${strToClassName(threadEl.rootId)}`
- );
- rangeNodes.forEach(rangeNode => {
- rangeNode.classList.remove('rangeHoverHighlight');
- });
- const hintNode = threadEl.parentElement?.querySelector(
- `gr-ranged-comment-hint[threadElRootId="${threadEl.rootId}"]`
- );
- if (hintNode) {
- hintNode.shadowRoot
- ?.querySelectorAll('.rangeHoverHighlight')
- .forEach(highlightNode =>
- highlightNode.classList.remove('rangeHoverHighlight')
- );
- }
- }
- }
- }
-
- _handleCommentThreadMouseenter(e: Event) {
- const threadEl = this._getThreadEl(e)!;
- const index = this._indexForThreadEl(threadEl);
-
- if (index !== undefined) {
- this.set(['commentRanges', index, 'hovering'], true);
- }
-
- this._toggleRangeElHighlight(threadEl, /* highlightRange= */ true);
- }
-
- _handleCommentThreadMouseleave(e: Event) {
- const threadEl = this._getThreadEl(e)!;
- const index = this._indexForThreadEl(threadEl);
-
- if (index !== undefined) {
- this.set(['commentRanges', index, 'hovering'], false);
- }
-
- this._toggleRangeElHighlight(threadEl, /* highlightRange= */ false);
- }
-
- _indexForThreadEl(threadEl: HTMLElement) {
- const side = getSide(threadEl);
- const range = getRange(threadEl);
- if (!side || !range) return undefined;
- return this._indexOfCommentRange(side, range);
- }
-
- _indexOfCommentRange(side: Side, range: CommentRange) {
- function rangesEqual(a: CommentRange, b: CommentRange) {
- if (!a && !b) {
- return true;
- }
- if (!a || !b) {
- return false;
- }
- return (
- a.start_line === b.start_line &&
- a.start_character === b.start_character &&
- a.end_line === b.end_line &&
- a.end_character === b.end_character
+ const rootId = threadEl?.rootId;
+ if (!rootId) return;
+ if (!this.diffTable) return;
+ if (highlightRange) {
+ const selector = `.range.${strToClassName(rootId)}`;
+ const rangeNodes = this.diffTable.querySelectorAll(selector);
+ rangeNodes.forEach(rangeNode => {
+ rangeNode.classList.add('rangeHoverHighlight');
+ });
+ const hintNode = this.diffTable.querySelector(
+ `gr-ranged-comment-hint[threadElRootId="${rootId}"]`
);
+ hintNode?.shadowRoot
+ ?.querySelectorAll('.rangeHighlight')
+ .forEach(highlightNode =>
+ highlightNode.classList.add('rangeHoverHighlight')
+ );
+ } else {
+ const selector = `.rangeHoverHighlight.${strToClassName(rootId)}`;
+ const rangeNodes = this.diffTable.querySelectorAll(selector);
+ rangeNodes.forEach(rangeNode => {
+ rangeNode.classList.remove('rangeHoverHighlight');
+ });
+ const hintNode = this.diffTable.querySelector(
+ `gr-ranged-comment-hint[threadElRootId="${rootId}"]`
+ );
+ hintNode?.shadowRoot
+ ?.querySelectorAll('.rangeHoverHighlight')
+ .forEach(highlightNode =>
+ highlightNode.classList.remove('rangeHoverHighlight')
+ );
}
-
- return this.commentRanges.findIndex(
- commentRange =>
- commentRange.side === side && rangesEqual(commentRange.range, range)
- );
}
+ private handleCommentThreadMouseenter = (e: Event) => {
+ const threadEl = this.getThreadEl(e);
+ this.toggleRangeElHighlight(threadEl, /* highlightRange= */ true);
+ };
+
+ private handleCommentThreadMouseleave = (e: Event) => {
+ const threadEl = this.getThreadEl(e);
+ this.toggleRangeElHighlight(threadEl, /* highlightRange= */ false);
+ };
+
/**
* Get current normalized selection.
* Merges multiple ranges, accounts for triple click, accounts for
* syntax highligh, convert native DOM Range objects to Gerrit concepts
* (line, side, etc).
*/
- _getNormalizedRange(selection: Selection | Range) {
+ private getNormalizedRange(selection: Selection | Range) {
/* On Safari the ShadowRoot.getSelection() isn't there and the only thing
we can get is a single Range */
if (selection instanceof Range) {
- return this._normalizeRange(selection);
+ return this.normalizeRange(selection);
}
const rangeCount = selection.rangeCount;
if (rangeCount === 0) {
return null;
} else if (rangeCount === 1) {
- return this._normalizeRange(selection.getRangeAt(0));
+ return this.normalizeRange(selection.getRangeAt(0));
} else {
- const startRange = this._normalizeRange(selection.getRangeAt(0));
- const endRange = this._normalizeRange(
+ const startRange = this.normalizeRange(selection.getRangeAt(0));
+ const endRange = this.normalizeRange(
selection.getRangeAt(rangeCount - 1)
);
return {
@@ -289,15 +228,15 @@
*
* @return fixed normalized range
*/
- _normalizeRange(domRange: Range): NormalizedRange {
+ private normalizeRange(domRange: Range): NormalizedRange {
const range = normalize(domRange);
- return this._fixTripleClickSelection(
+ return this.fixTripleClickSelection(
{
- start: this._normalizeSelectionSide(
+ start: this.normalizeSelectionSide(
range.startContainer,
range.startOffset
),
- end: this._normalizeSelectionSide(range.endContainer, range.endOffset),
+ end: this.normalizeSelectionSide(range.endContainer, range.endOffset),
},
domRange
);
@@ -313,7 +252,7 @@
* @param domRange DOM Range object
* @return fixed normalized range
*/
- _fixTripleClickSelection(range: NormalizedRange, domRange: Range) {
+ private fixTripleClickSelection(range: NormalizedRange, domRange: Range) {
if (!range.start) {
// Selection outside of current diff.
return range;
@@ -334,7 +273,7 @@
end.column === 0 &&
end.line === start.line + 1;
const content = domRange.cloneContents().querySelector('.contentText');
- const lineLength = (content && this._getLength(content)) || 0;
+ const lineLength = (content && this.getLength(content)) || 0;
if (lineLength && (endsAtBeginningOfNextLine || endsAtOtherEmptySide)) {
// Move the selection to the end of the previous line.
range.end = {
@@ -355,12 +294,14 @@
* @param node td.content child
* @param offset offset within node
*/
- _normalizeSelectionSide(
+ private normalizeSelectionSide(
node: Node | null,
offset: number
): NormalizedPosition | null {
let column;
- if (!node || !this.contains(node)) return null;
+ if (!this.diffTable) return null;
+ if (!this.diffBuilder) return null;
+ if (!node || !this.diffTable.contains(node)) return null;
const lineEl = getLineElByChild(node);
if (!lineEl) return null;
const side = getSideByLineEl(lineEl);
@@ -376,10 +317,10 @@
} else {
const thread = contentTd.querySelector('.comment-thread');
if (thread?.contains(node)) {
- column = this._getLength(contentText);
+ column = this.getLength(contentText);
node = contentText;
} else {
- column = this._convertOffsetToColumn(node, offset);
+ column = this.convertOffsetToColumn(node, offset);
}
}
@@ -398,7 +339,8 @@
* collapsed section, so don't need to worry about this case for
* positioning the tooltip.
*/
- _positionActionBox(
+ // visible for testing
+ positionActionBox(
actionBox: GrSelectionActionBox,
startLine: number,
range: Text | Element | Range
@@ -412,7 +354,7 @@
actionBox.placeBelow(range);
}
- _isRangeValid(range: NormalizedRange | null) {
+ private isRangeValid(range: NormalizedRange | null) {
if (!range || !range.start || !range.start.node || !range.end) {
return false;
}
@@ -425,15 +367,16 @@
);
}
- _handleSelection(selection: Selection | Range, isMouseUp: boolean) {
+ // visible for testing
+ handleSelection(selection: Selection | Range, isMouseUp: boolean) {
/* On Safari, the selection events may return a null range that should
be ignored */
- if (!selection) {
- return;
- }
- const normalizedRange = this._getNormalizedRange(selection);
- if (!this._isRangeValid(normalizedRange)) {
- this._removeActionBox();
+ if (!selection) return;
+ if (!this.diffTable) return;
+
+ const normalizedRange = this.getNormalizedRange(selection);
+ if (!this.isRangeValid(normalizedRange)) {
+ this.removeActionBox();
return;
}
/* On Safari the ShadowRoot.getSelection() isn't there and the only thing
@@ -463,8 +406,8 @@
// start.column with the content length), we just check if the selection
// is empty to see that it's at the end of a line.
const content = domRange.cloneContents().querySelector('.contentText');
- if (isMouseUp && this._getLength(content) === 0) {
- this._fireCreateRangeComment(start.side, {
+ if (isMouseUp && this.getLength(content) === 0) {
+ this.fireCreateRangeComment(start.side, {
start_line: start.line,
start_character: 0,
end_line: start.line,
@@ -474,10 +417,10 @@
return;
}
- let actionBox = this.shadowRoot!.querySelector('gr-selection-action-box');
+ let actionBox = this.diffTable.querySelector('gr-selection-action-box');
if (!actionBox) {
actionBox = document.createElement('gr-selection-action-box');
- this.root!.insertBefore(actionBox, this.root!.firstElementChild);
+ this.diffTable.appendChild(actionBox);
}
this.selectedRange = {
range: {
@@ -489,10 +432,10 @@
side: start.side,
};
if (start.line === end.line) {
- this._positionActionBox(actionBox, start.line, domRange);
+ this.positionActionBox(actionBox, start.line, domRange);
} else if (start.node instanceof Text) {
if (start.column) {
- this._positionActionBox(
+ this.positionActionBox(
actionBox,
start.line,
start.node.splitText(start.column)
@@ -505,44 +448,41 @@
(start.node.firstChild instanceof Element ||
start.node.firstChild instanceof Text)
) {
- this._positionActionBox(actionBox, start.line, start.node.firstChild);
+ this.positionActionBox(actionBox, start.line, start.node.firstChild);
} else if (start.node instanceof Element || start.node instanceof Text) {
- this._positionActionBox(actionBox, start.line, start.node);
+ this.positionActionBox(actionBox, start.line, start.node);
} else {
console.warn('Failed to position comment action box.');
- this._removeActionBox();
+ this.removeActionBox();
}
}
- _fireCreateRangeComment(side: Side, range: CommentRange) {
- this.dispatchEvent(
+ private fireCreateRangeComment(side: Side, range: CommentRange) {
+ this.diffTable?.dispatchEvent(
new CustomEvent('create-range-comment', {
detail: {side, range},
composed: true,
bubbles: true,
})
);
- this._removeActionBox();
+ this.removeActionBox();
}
- _handleRangeCommentRequest(e: Event) {
+ private handleRangeCommentRequest = (e: Event) => {
e.stopPropagation();
- if (!this.selectedRange) {
- throw Error('Selected Range is needed for new range comment!');
- }
+ assertIsDefined(this.selectedRange, 'selectedRange');
const {side, range} = this.selectedRange;
- this._fireCreateRangeComment(side, range);
- }
+ this.fireCreateRangeComment(side, range);
+ };
- _removeActionBox() {
+ // visible for testing
+ removeActionBox() {
this.selectedRange = undefined;
- const actionBox = this.shadowRoot!.querySelector('gr-selection-action-box');
- if (actionBox) {
- this.root!.removeChild(actionBox);
- }
+ const actionBox = this.diffTable?.querySelector('gr-selection-action-box');
+ if (actionBox) actionBox.remove();
}
- _convertOffsetToColumn(el: Node, offset: number) {
+ private convertOffsetToColumn(el: Node, offset: number) {
if (el instanceof Element && el.classList.contains('content')) {
return offset;
}
@@ -552,7 +492,7 @@
) {
if (el.previousSibling) {
el = el.previousSibling;
- offset += this._getLength(el);
+ offset += this.getLength(el);
} else {
el = el.parentElement!;
}
@@ -566,18 +506,24 @@
*
* @param node this is sometimes passed as null.
*/
- _getLength(node: Node | null): number {
+ // visible for testing
+ getLength(node: Node | null): number {
if (node === null) return 0;
if (node instanceof Element && node.classList.contains('content')) {
- return this._getLength(queryAndAssert(node, '.contentText'));
+ return this.getLength(queryAndAssert(node, '.contentText'));
} else {
return GrAnnotation.getLength(node);
}
}
}
+export interface CreateRangeCommentEventDetail {
+ side: Side;
+ range: CommentRange;
+}
+
declare global {
- interface HTMLElementTagNameMap {
- 'gr-diff-highlight': GrDiffHighlight;
+ interface HTMLElementEventMap {
+ 'create-range-comment': CustomEvent<CreateRangeCommentEventDetail>;
}
}
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_html.ts b/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_html.ts
deleted file mode 100644
index 5a6cb1c..0000000
--- a/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_html.ts
+++ /dev/null
@@ -1,35 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <style include="shared-styles">
- :host {
- position: relative;
- }
- gr-selection-action-box {
- /**
- * Needs z-index to appear above wrapped content, since it's inserted
- * into DOM before it.
- */
- z-index: 10;
- }
- </style>
- <div class="contentWrapper">
- <slot></slot>
- </div>
-`;
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_test.js b/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_test.js
deleted file mode 100644
index 4c1295f..0000000
--- a/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_test.js
+++ /dev/null
@@ -1,589 +0,0 @@
-/**
- * @license
- * 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.
- */
-
-import '../../../test/common-test-setup-karma.js';
-import './gr-diff-highlight.js';
-import {_getTextOffset} from './gr-range-normalizer.js';
-import {html} from '@polymer/polymer/lib/utils/html-tag.js';
-
-// Splitting long lines in html into shorter rows breaks tests:
-// zero-length text nodes and new lines are not expected in some places
-/* eslint-disable max-len */
-const basicFixture = fixtureFromTemplate(html`
-<style>
- .tab-indicator:before {
- color: #C62828;
- /* >> character */
- content: '\\00BB';
- }
- </style>
- <gr-diff-highlight>
- <table id="diffTable">
-
- <tbody class="section both">
- <tr class="diff-row side-by-side" left-type="both" right-type="both">
- <td class="left lineNum" data-value="1"></td>
- <td class="content both"><div class="contentText">[1] Nam cum ad me in Cumanum salutandi causa uterque venisset,</div></td>
- <td class="right lineNum" data-value="1"></td>
- <td class="content both"><div class="contentText">[1] Nam cum ad me in Cumanum salutandi causa uterque</div></td>
- </tr>
- </tbody>
-
- <tbody class="section delta">
- <tr class="diff-row side-by-side" left-type="remove" right-type="add">
- <td class="left lineNum" data-value="2"></td>
- <!-- Next tag is formatted to eliminate zero-length text nodes. -->
- <td class="content remove"><div class="contentText">na💢ti <hl class="foo">te, inquit</hl>, sumus <hl class="bar">aliquando</hl> otiosum, <hl>certe</hl> a <hl><span class="tab-indicator" style="tab-size:8;">\u0009</span></hl>udiam, <hl>quid</hl> sit, <span class="tab-indicator" style="tab-size:8;">\u0009</span>quod <hl>Epicurum</hl></div></td>
- <td class="right lineNum" data-value="2"></td>
- <!-- Next tag is formatted to eliminate zero-length text nodes. -->
- <td class="content add"><div class="contentText">nacti , <hl>,</hl> sumus <hl><span class="tab-indicator" style="tab-size:8;">\u0009</span></hl> otiosum, <span class="tab-indicator" style="tab-size:8;">\u0009</span> audiam, sit, quod</div></td>
- </tr>
- </tbody>
-
-<tbody class="section both">
- <tr class="diff-row side-by-side" left-type="both" right-type="both">
- <td class="left lineNum" data-value="138"></td>
- <td class="content both"><div class="contentText">[14] Nam cum ad me in Cumanum salutandi causa uterque venisset,</div></td>
- <td class="right lineNum" data-value="119"></td>
- <td class="content both"><div class="contentText">[14] Nam cum ad me in Cumanum salutandi causa uterque venisset,</div></td>
- </tr>
- </tbody>
-
- <tbody class="section delta">
- <tr class="diff-row side-by-side" left-type="remove" right-type="add">
- <td class="left lineNum" data-value="140"></td>
- <!-- Next tag is formatted to eliminate zero-length text nodes. -->
- <td class="content remove"><div class="contentText">na💢ti <hl class="foo">te, inquit</hl>, sumus <hl class="bar">aliquando</hl> otiosum, <hl>certe</hl> a <hl><span class="tab-indicator" style="tab-size:8;">\u0009</span></hl>udiam, <hl>quid</hl> sit, <span class="tab-indicator" style="tab-size:8;">\u0009</span>quod <hl>Epicurum</hl></div><div class="comment-thread">
- [Yet another random diff thread content here]
- </div></td>
- <td class="right lineNum" data-value="120"></td>
- <!-- Next tag is formatted to eliminate zero-length text nodes. -->
- <td class="content add"><div class="contentText">nacti , <hl>,</hl> sumus <hl><span class="tab-indicator" style="tab-size:8;">\u0009</span></hl> otiosum, <span class="tab-indicator" style="tab-size:8;">\u0009</span> audiam, sit, quod</div></td>
- </tr>
- </tbody>
-
- <tbody class="section both">
- <tr class="diff-row side-by-side" left-type="both" right-type="both">
- <td class="left lineNum" data-value="141"></td>
- <td class="content both"><div class="contentText">nam et<hl><span class="tab-indicator" style="tab-size:8;">\u0009</span></hl>complectitur<span class="tab-indicator" style="tab-size:8;">\u0009</span>verbis, quod vult, et dicit plane, quod intellegam;</div></td>
- <td class="right lineNum" data-value="130"></td>
- <td class="content both"><div class="contentText">nam et complectitur verbis, quod vult, et dicit plane, quod intellegam;</div></td>
- </tr>
- </tbody>
-
- <tbody class="section contextControl">
- <tr class="diff-row side-by-side" left-type="contextControl" right-type="contextControl">
- <td class="left contextLineNum"></td>
- <td>
- <gr-button>+10↑</gr-button>
- -
- <gr-button>Show 21 common lines</gr-button>
- -
- <gr-button>+10↓</gr-button>
- </td>
- <td class="right contextLineNum"></td>
- <td>
- <gr-button>+10↑</gr-button>
- -
- <gr-button>Show 21 common lines</gr-button>
- -
- <gr-button>+10↓</gr-button>
- </td>
- </tr>
- </tbody>
-
- <tbody class="section delta total">
- <tr class="diff-row side-by-side" left-type="blank" right-type="add">
- <td class="left"></td>
- <td class="blank"></td>
- <td class="right lineNum" data-value="146"></td>
- <td class="content add"><div class="contentText">[17] Quid igitur est? inquit; audire enim cupio, quid non probes. Principio, inquam,</div></td>
- </tr>
- </tbody>
-
- <tbody class="section both">
- <tr class="diff-row side-by-side" left-type="both" right-type="both">
- <td class="left lineNum" data-value="165"></td>
- <td class="content both"><div class="contentText"></div></td>
- <td class="right lineNum" data-value="147"></td>
- <td class="content both"><div class="contentText">in physicis, <hl><span class="tab-indicator" style="tab-size:8;">\u0009</span></hl> quibus maxime gloriatur, primum totus est alienus. Democritea dicit</div></td>
- </tr>
- </tbody>
-
- </table>
- </gr-diff-highlight>
-`);
-/* eslint-enable max-len */
-
-suite('gr-diff-highlight', () => {
- let element;
-
- setup(() => {
- element = basicFixture.instantiate()[1];
- });
-
- suite('comment events', () => {
- let builder;
-
- setup(() => {
- builder = {
- getContentsByLineRange: sinon.stub().returns([]),
- getLineElByChild: sinon.stub().returns({}),
- getSideByLineEl: sinon.stub().returns('other-side'),
- };
- element._cachedDiffBuilder = builder;
- });
-
- test('comment-thread-mouseenter from line comments is ignored', () => {
- const threadEl = document.createElement('div');
- threadEl.className = 'comment-thread';
- threadEl.setAttribute('diff-side', 'right');
- threadEl.setAttribute('line-num', 3);
- element.appendChild(threadEl);
- element.commentRanges = [{side: 'right'}];
-
- sinon.stub(element, 'set');
- threadEl.dispatchEvent(new CustomEvent(
- 'comment-thread-mouseenter', {bubbles: true, composed: true}));
- assert.isFalse(element.set.called);
- });
-
- test('comment-thread-mouseenter from ranged comment causes set', () => {
- const threadEl = document.createElement('div');
- threadEl.className = 'comment-thread';
- threadEl.setAttribute('diff-side', 'right');
- threadEl.setAttribute('line-num', 3);
- threadEl.setAttribute('range', JSON.stringify({
- start_line: 3,
- start_character: 4,
- end_line: 5,
- end_character: 6,
- }));
- element.appendChild(threadEl);
- element.commentRanges = [{side: 'right', range: {
- start_line: 3,
- start_character: 4,
- end_line: 5,
- end_character: 6,
- }}];
-
- sinon.stub(element, 'set');
- threadEl.dispatchEvent(new CustomEvent(
- 'comment-thread-mouseenter', {bubbles: true, composed: true}));
- assert.isTrue(element.set.called);
- const args = element.set.lastCall.args;
- assert.deepEqual(args[0], ['commentRanges', 0, 'hovering']);
- assert.deepEqual(args[1], true);
- });
-
- test('comment-thread-mouseleave from line comments is ignored', () => {
- const threadEl = document.createElement('div');
- threadEl.className = 'comment-thread';
- threadEl.setAttribute('diff-side', 'right');
- threadEl.setAttribute('line-num', 3);
- element.appendChild(threadEl);
- element.commentRanges = [{side: 'right'}];
-
- sinon.stub(element, 'set');
- threadEl.dispatchEvent(new CustomEvent(
- 'comment-thread-mouseleave', {bubbles: true, composed: true}));
- assert.isFalse(element.set.called);
- });
-
- test(`create-range-comment for range when create-comment-requested
- is fired`, () => {
- sinon.stub(element, '_removeActionBox');
- element.selectedRange = {
- side: 'left',
- range: {
- start_line: 7,
- start_character: 11,
- end_line: 24,
- end_character: 42,
- },
- };
- const requestEvent = new CustomEvent('create-comment-requested');
- let createRangeEvent;
- element.addEventListener('create-range-comment', e => {
- createRangeEvent = e;
- });
- element.dispatchEvent(requestEvent);
- assert.deepEqual(element.selectedRange, createRangeEvent.detail);
- assert.isTrue(element._removeActionBox.called);
- });
- });
-
- suite('selection', () => {
- let diff;
- let builder;
- let contentStubs;
-
- const stubContent = (line, side, opt_child) => {
- const contentTd = diff.querySelector(
- `.${side}.lineNum[data-value="${line}"] ~ .content`);
- const contentText = contentTd.querySelector('.contentText');
- const lineEl = diff.querySelector(
- `.${side}.lineNum[data-value="${line}"]`);
- contentStubs.push({
- lineEl,
- contentTd,
- contentText,
- });
- builder.getContentTdByLineEl.withArgs(lineEl).returns(contentTd);
- builder.getLineNumberByChild.withArgs(lineEl).returns(line);
- builder.getContentTdByLine.withArgs(line, side).returns(contentTd);
- builder.getSideByLineEl.withArgs(lineEl).returns(side);
- return contentText;
- };
-
- const emulateSelection = (startNode, startOffset, endNode, endOffset) => {
- const selection = document.getSelection();
- const range = document.createRange();
- range.setStart(startNode, startOffset);
- range.setEnd(endNode, endOffset);
- selection.addRange(range);
- element._handleSelection(selection);
- };
-
- const getLineElByChild = node => {
- const stubs = contentStubs.find(stub => stub.contentTd.contains(node));
- return stubs && stubs.lineEl;
- };
-
- setup(() => {
- contentStubs = [];
- stub('gr-selection-action-box', 'placeAbove');
- stub('gr-selection-action-box', 'placeBelow');
- diff = element.querySelector('#diffTable');
- builder = {
- getContentTdByLine: sinon.stub(),
- getContentTdByLineEl: sinon.stub(),
- getLineElByChild,
- getLineNumberByChild: sinon.stub(),
- getSideByLineEl: sinon.stub(),
- };
- element._cachedDiffBuilder = builder;
- });
-
- teardown(() => {
- contentStubs = null;
- document.getSelection().removeAllRanges();
- });
-
- test('single first line', () => {
- const content = stubContent(1, 'right');
- sinon.spy(element, '_positionActionBox');
- emulateSelection(content.firstChild, 5, content.firstChild, 12);
- const actionBox = element.shadowRoot
- .querySelector('gr-selection-action-box');
- assert.isTrue(actionBox.positionBelow);
- });
-
- test('multiline starting on first line', () => {
- const startContent = stubContent(1, 'right');
- const endContent = stubContent(2, 'right');
- sinon.spy(element, '_positionActionBox');
- emulateSelection(
- startContent.firstChild, 10, endContent.lastChild, 7);
- const actionBox = element.shadowRoot
- .querySelector('gr-selection-action-box');
- assert.isTrue(actionBox.positionBelow);
- });
-
- test('single line', () => {
- const content = stubContent(138, 'left');
- sinon.spy(element, '_positionActionBox');
- emulateSelection(content.firstChild, 5, content.firstChild, 12);
- const actionBox = element.shadowRoot
- .querySelector('gr-selection-action-box');
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 138,
- start_character: 5,
- end_line: 138,
- end_character: 12,
- });
- assert.equal(side, 'left');
- assert.notOk(actionBox.positionBelow);
- });
-
- test('multiline', () => {
- const startContent = stubContent(119, 'right');
- const endContent = stubContent(120, 'right');
- sinon.spy(element, '_positionActionBox');
- emulateSelection(
- startContent.firstChild, 10, endContent.lastChild, 7);
- const actionBox = element.shadowRoot
- .querySelector('gr-selection-action-box');
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 119,
- start_character: 10,
- end_line: 120,
- end_character: 36,
- });
- assert.equal(side, 'right');
- assert.notOk(actionBox.positionBelow);
- });
-
- test('multiple ranges aka firefox implementation', () => {
- const startContent = stubContent(119, 'right');
- const endContent = stubContent(120, 'right');
-
- const startRange = document.createRange();
- startRange.setStart(startContent.firstChild, 10);
- startRange.setEnd(startContent.firstChild, 11);
-
- const endRange = document.createRange();
- endRange.setStart(endContent.lastChild, 6);
- endRange.setEnd(endContent.lastChild, 7);
-
- const getRangeAtStub = sinon.stub();
- getRangeAtStub
- .onFirstCall().returns(startRange)
- .onSecondCall()
- .returns(endRange);
- const selection = {
- rangeCount: 2,
- getRangeAt: getRangeAtStub,
- removeAllRanges: sinon.stub(),
- };
- element._handleSelection(selection);
- const {range} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 119,
- start_character: 10,
- end_line: 120,
- end_character: 36,
- });
- });
-
- test('multiline grow end highlight over tabs', () => {
- const startContent = stubContent(119, 'right');
- const endContent = stubContent(120, 'right');
- emulateSelection(startContent.firstChild, 10, endContent.firstChild, 2);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 119,
- start_character: 10,
- end_line: 120,
- end_character: 2,
- });
- assert.equal(side, 'right');
- });
-
- test('collapsed', () => {
- const content = stubContent(138, 'left');
- emulateSelection(content.firstChild, 5, content.firstChild, 5);
- assert.isOk(document.getSelection().getRangeAt(0).startContainer);
- assert.isFalse(!!element.selectedRange);
- });
-
- test('starts inside hl', () => {
- const content = stubContent(140, 'left');
- const hl = content.querySelector('.foo');
- emulateSelection(hl.firstChild, 2, hl.nextSibling, 7);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 140,
- start_character: 8,
- end_line: 140,
- end_character: 23,
- });
- assert.equal(side, 'left');
- });
-
- test('ends inside hl', () => {
- const content = stubContent(140, 'left');
- const hl = content.querySelector('.bar');
- emulateSelection(hl.previousSibling, 2, hl.firstChild, 3);
- const {range} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 140,
- start_character: 18,
- end_line: 140,
- end_character: 27,
- });
- });
-
- test('multiple hl', () => {
- const content = stubContent(140, 'left');
- const hl = content.querySelectorAll('hl')[4];
- emulateSelection(content.firstChild, 2, hl.firstChild, 2);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 140,
- start_character: 2,
- end_line: 140,
- end_character: 61,
- });
- assert.equal(side, 'left');
- });
-
- test('starts outside of diff', () => {
- const contentText = stubContent(140, 'left');
- const contentTd = contentText.parentElement;
-
- emulateSelection(contentTd.parentElement, 0,
- contentText.firstChild, 2);
- assert.isFalse(!!element.selectedRange);
- });
-
- test('ends outside of diff', () => {
- const content = stubContent(140, 'left');
- emulateSelection(content.nextElementSibling.firstChild, 2,
- content.firstChild, 2);
- assert.isFalse(!!element.selectedRange);
- });
-
- test('starts and ends on different sides', () => {
- const startContent = stubContent(140, 'left');
- const endContent = stubContent(130, 'right');
- emulateSelection(startContent.firstChild, 2, endContent.firstChild, 2);
- assert.isFalse(!!element.selectedRange);
- });
-
- test('starts in comment thread element', () => {
- const startContent = stubContent(140, 'left');
- const comment = startContent.parentElement.querySelector(
- '.comment-thread');
- const endContent = stubContent(141, 'left');
- emulateSelection(comment.firstChild, 2, endContent.firstChild, 4);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 140,
- start_character: 83,
- end_line: 141,
- end_character: 4,
- });
- assert.equal(side, 'left');
- });
-
- test('ends in comment thread element', () => {
- const content = stubContent(140, 'left');
- const comment = content.parentElement.querySelector(
- '.comment-thread');
- emulateSelection(content.firstChild, 4, comment.firstChild, 1);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 140,
- start_character: 4,
- end_line: 140,
- end_character: 83,
- });
- assert.equal(side, 'left');
- });
-
- test('starts in context element', () => {
- const contextControl =
- diff.querySelector('.contextControl').querySelector('gr-button');
- const content = stubContent(146, 'right');
- emulateSelection(contextControl, 0, content.firstChild, 7);
- // TODO (viktard): Select nearest line.
- assert.isFalse(!!element.selectedRange);
- });
-
- test('ends in context element', () => {
- const contextControl =
- diff.querySelector('.contextControl').querySelector('gr-button');
- const content = stubContent(141, 'left');
- emulateSelection(content.firstChild, 2, contextControl, 1);
- // TODO (viktard): Select nearest line.
- assert.isFalse(!!element.selectedRange);
- });
-
- test('selection containing context element', () => {
- const startContent = stubContent(130, 'right');
- const endContent = stubContent(146, 'right');
- emulateSelection(startContent.firstChild, 3, endContent.firstChild, 14);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 130,
- start_character: 3,
- end_line: 146,
- end_character: 14,
- });
- assert.equal(side, 'right');
- });
-
- test('ends at a tab', () => {
- const content = stubContent(140, 'left');
- emulateSelection(
- content.firstChild, 1, content.querySelector('span'), 0);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 140,
- start_character: 1,
- end_line: 140,
- end_character: 51,
- });
- assert.equal(side, 'left');
- });
-
- test('starts at a tab', () => {
- const content = stubContent(140, 'left');
- emulateSelection(
- content.querySelectorAll('hl')[3], 0,
- content.querySelectorAll('span')[1].nextSibling, 1);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 140,
- start_character: 51,
- end_line: 140,
- end_character: 71,
- });
- assert.equal(side, 'left');
- });
-
- test('properly accounts for syntax highlighting', () => {
- const content = stubContent(140, 'left');
- const spy = sinon.spy(element, '_normalizeRange');
- emulateSelection(
- content.querySelectorAll('hl')[3], 0,
- content.querySelectorAll('span')[1], 0);
- const spyCall = spy.getCall(0);
- const range = document.getSelection().getRangeAt(0);
- assert.notDeepEqual(spyCall.returnValue, range);
- });
-
- test('GrRangeNormalizer._getTextOffset computes text offset', () => {
- let content = stubContent(140, 'left');
- let child = content.lastChild.lastChild;
- let result = _getTextOffset(content, child);
- assert.equal(result, 75);
- content = stubContent(146, 'right');
- child = content.lastChild;
- result = _getTextOffset(content, child);
- assert.equal(result, 0);
- });
-
- test('_fixTripleClickSelection', () => {
- const startContent = stubContent(119, 'right');
- const endContent = stubContent(120, 'right');
- emulateSelection(startContent.firstChild, 0, endContent.firstChild, 0);
- const {range, side} = element.selectedRange;
- assert.deepEqual(range, {
- start_line: 119,
- start_character: 0,
- end_line: 119,
- end_character: element._getLength(startContent),
- });
- assert.equal(side, 'right');
- });
- });
-});
-
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_test.ts b/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_test.ts
new file mode 100644
index 0000000..b819754
--- /dev/null
+++ b/polygerrit-ui/app/embed/diff/gr-diff-highlight/gr-diff-highlight_test.ts
@@ -0,0 +1,713 @@
+/**
+ * @license
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import '../../../test/common-test-setup-karma';
+import './gr-diff-highlight';
+import {_getTextOffset} from './gr-range-normalizer';
+import {fixture, fixtureCleanup, html} from '@open-wc/testing-helpers';
+import {
+ GrDiffHighlight,
+ DiffBuilderInterface,
+ CreateRangeCommentEventDetail,
+} from './gr-diff-highlight';
+import {Side} from '../../../api/diff';
+import {SinonStubbedMember} from 'sinon';
+import {queryAndAssert} from '../../../utils/common-util';
+import {GrDiffThreadElement} from '../gr-diff/gr-diff-utils';
+import {waitQueryAndAssert, waitUntil} from '../../../test/test-utils';
+import {GrSelectionActionBox} from '../gr-selection-action-box/gr-selection-action-box';
+
+// Splitting long lines in html into shorter rows breaks tests:
+// zero-length text nodes and new lines are not expected in some places
+/* eslint-disable max-len, lit/prefer-static-styles */
+/* prettier-ignore */
+const diffTable = html`
+ <table id="diffTable">
+ <tbody class="section both">
+ <tr class="diff-row side-by-side" left-type="both" right-type="both">
+ <td class="left lineNum" data-value="1"></td>
+ <td class="content both"><div class="contentText">[1] Nam cum ad me in Cumanum salutandi causa uterque venisset,</div></td>
+ <td class="right lineNum" data-value="1"></td>
+ <td class="content both"><div class="contentText">[1] Nam cum ad me in Cumanum salutandi causa uterque</div></td>
+ </tr>
+ </tbody>
+
+ <tbody class="section delta">
+ <tr class="diff-row side-by-side" left-type="remove" right-type="add">
+ <td class="left lineNum" data-value="2"></td>
+ <!-- Next tag is formatted to eliminate zero-length text nodes. -->
+ <td class="content remove"><div class="contentText">na💢ti <hl class="foo range generated_id314">te, inquit</hl>, sumus<hl class="bar">aliquando</hl> otiosum, <hl>certe</hl> a<hl><span class="tab-indicator" style="tab-size:8;"> </span></hl>udiam, <hl>quid</hl> sit,<span class="tab-indicator" style="tab-size:8;"> </span>quod<hl>Epicurum</hl></div></td>
+ <td class="right lineNum" data-value="2"></td>
+ <!-- Next tag is formatted to eliminate zero-length text nodes. -->
+ <td class="content add"><div class="contentText">nacti , <hl>,</hl> sumus<hl><span class="tab-indicator" style="tab-size:8;"> </span></hl>otiosum,<span class="tab-indicator" style="tab-size:8;"> </span> audiam,sit, quod</div></td>
+ </tr>
+ </tbody>
+
+ <tbody class="section both">
+ <tr class="diff-row side-by-side" left-type="both" right-type="both">
+ <td class="left lineNum" data-value="138"></td>
+ <td class="content both"><div class="contentText">[14] Nam cum ad me in Cumanum salutandi causa uterque venisset,</div></td>
+ <td class="right lineNum" data-value="119"></td>
+ <td class="content both"><div class="contentText">[14] Nam cum ad me in Cumanum salutandi causa uterque venisset,</div></td>
+ </tr>
+ </tbody>
+
+ <tbody class="section delta">
+ <tr class="diff-row side-by-side" left-type="remove" right-type="add">
+ <td class="left lineNum" data-value="140"></td>
+ <!-- Next tag is formatted to eliminate zero-length text nodes. -->
+ <td class="content remove"><div class="contentText">na💢ti <hl class="foo">te, inquit</hl>, sumus <hl class="bar">aliquando</hl> otiosum, <hl>certe</hl> a <hl><span class="tab-indicator" style="tab-size:8;">\u0009</span></hl>udiam, <hl>quid</hl> sit, <span class="tab-indicator" style="tab-size:8;">\u0009</span>quod <hl>Epicurum</hl></div><div class="comment-thread">
+ [Yet another random diff thread content here]
+ </div></td>
+ <td class="right lineNum" data-value="120"></td>
+ <!-- Next tag is formatted to eliminate zero-length text nodes. -->
+ <td class="content add"><div class="contentText">nacti , <hl>,</hl> sumus <hl><span class="tab-indicator" style="tab-size:8;">\u0009</span></hl> otiosum, <span class="tab-indicator" style="tab-size:8;">\u0009</span> audiam, sit, quod</div></td>
+ </tr>
+ </tbody>
+
+ <tbody class="section both">
+ <tr class="diff-row side-by-side" left-type="both" right-type="both">
+ <td class="left lineNum" data-value="141"></td>
+ <td class="content both"><div class="contentText">nam et<hl><span class="tab-indicator" style="tab-size:8;"> </span></hl>complectitur<span class="tab-indicator" style="tab-size:8;"></span>verbis, quod vult, et dicit plane, quod intellegam;</div></td>
+ <td class="right lineNum" data-value="130"></td>
+ <td class="content both"><div class="contentText">nam et complectitur verbis, quod vult, et dicit plane, quodintellegam;</div></td>
+ </tr>
+ </tbody>
+
+ <tbody class="section contextControl">
+ <tr
+ class="diff-row side-by-side"
+ left-type="contextControl"
+ right-type="contextControl"
+ >
+ <td class="left contextLineNum"></td>
+ <td>
+ <gr-button>+10↑</gr-button>
+ -
+ <gr-button>Show 21 common lines</gr-button>
+ -
+ <gr-button>+10↓</gr-button>
+ </td>
+ <td class="right contextLineNum"></td>
+ <td>
+ <gr-button>+10↑</gr-button>
+ -
+ <gr-button>Show 21 common lines</gr-button>
+ -
+ <gr-button>+10↓</gr-button>
+ </td>
+ </tr>
+ </tbody>
+
+ <tbody class="section delta total">
+ <tr class="diff-row side-by-side" left-type="blank" right-type="add">
+ <td class="left"></td>
+ <td class="blank"></td>
+ <td class="right lineNum" data-value="146"></td>
+ <td class="content add"><div class="contentText">[17] Quid igitur est? inquit; audire enim cupio, quid non probes. Principio, inquam,</div></td>
+ </tr>
+ </tbody>
+
+ <tbody class="section both">
+ <tr class="diff-row side-by-side" left-type="both" right-type="both">
+ <td class="left lineNum" data-value="165"></td>
+ <td class="content both"><div class="contentText"></div></td>
+ <td class="right lineNum" data-value="147"></td>
+ <td class="content both"><div class="contentText">in physicis, <hl><span class="tab-indicator" style="tab-size:8;"> </span></hl>quibus maxime gloriatur, primum totus est alienus. Democritea dicit</div></td>
+ </tr>
+ </tbody>
+ </table>
+`;
+/* eslint-enable max-len */
+
+suite('gr-diff-highlight', () => {
+ suite('comment events', () => {
+ let threadEl: GrDiffThreadElement;
+ let hlRange: HTMLElement;
+ let element: GrDiffHighlight;
+ let diff: HTMLElement;
+ let builder: {
+ getContentTdByLineEl: SinonStubbedMember<
+ DiffBuilderInterface['getContentTdByLineEl']
+ >;
+ };
+
+ setup(async () => {
+ diff = await fixture<HTMLTableElement>(diffTable);
+ builder = {
+ getContentTdByLineEl: sinon.stub(),
+ };
+ element = new GrDiffHighlight();
+ element.init(diff, builder);
+ hlRange = queryAndAssert(diff, 'hl.range.generated_id314');
+
+ threadEl = document.createElement(
+ 'div'
+ ) as unknown as GrDiffThreadElement;
+ threadEl.className = 'comment-thread';
+ threadEl.rootId = 'id314';
+ diff.appendChild(threadEl);
+ });
+
+ teardown(() => {
+ element.cleanup();
+ threadEl.remove();
+ });
+
+ test('comment-thread-mouseenter toggles rangeHoverHighlight class', async () => {
+ assert.isFalse(hlRange.classList.contains('rangeHoverHighlight'));
+ threadEl.dispatchEvent(
+ new CustomEvent('comment-thread-mouseenter', {
+ bubbles: true,
+ composed: true,
+ })
+ );
+ await waitUntil(() => hlRange.classList.contains('rangeHoverHighlight'));
+ assert.isTrue(hlRange.classList.contains('rangeHoverHighlight'));
+ });
+
+ test('comment-thread-mouseleave toggles rangeHoverHighlight class', async () => {
+ hlRange.classList.add('rangeHoverHighlight');
+ threadEl.dispatchEvent(
+ new CustomEvent('comment-thread-mouseleave', {
+ bubbles: true,
+ composed: true,
+ })
+ );
+ await waitUntil(() => !hlRange.classList.contains('rangeHoverHighlight'));
+ assert.isFalse(hlRange.classList.contains('rangeHoverHighlight'));
+ });
+
+ test(`create-range-comment for range when create-comment-requested
+ is fired`, () => {
+ const removeActionBoxStub = sinon.stub(element, 'removeActionBox');
+ element.selectedRange = {
+ side: Side.LEFT,
+ range: {
+ start_line: 7,
+ start_character: 11,
+ end_line: 24,
+ end_character: 42,
+ },
+ };
+ const requestEvent = new CustomEvent('create-comment-requested');
+ let createRangeEvent: CustomEvent<CreateRangeCommentEventDetail>;
+ diff.addEventListener('create-range-comment', e => {
+ createRangeEvent = e;
+ });
+ diff.dispatchEvent(requestEvent);
+ if (!createRangeEvent!) assert.fail('event not set');
+ assert.deepEqual(element.selectedRange, createRangeEvent.detail);
+ assert.isTrue(removeActionBoxStub.called);
+ });
+ });
+
+ suite('selection', () => {
+ let element: GrDiffHighlight;
+ let diff: HTMLElement;
+ let builder: {
+ getContentTdByLineEl: SinonStubbedMember<
+ DiffBuilderInterface['getContentTdByLineEl']
+ >;
+ };
+ let contentStubs;
+
+ setup(async () => {
+ diff = await fixture<HTMLTableElement>(diffTable);
+ builder = {
+ getContentTdByLineEl: sinon.stub(),
+ };
+ element = new GrDiffHighlight();
+ element.init(diff, builder);
+ contentStubs = [];
+ stub('gr-selection-action-box', 'placeAbove');
+ stub('gr-selection-action-box', 'placeBelow');
+ });
+
+ teardown(() => {
+ fixtureCleanup();
+ element.cleanup();
+ contentStubs = null;
+ document.getSelection()!.removeAllRanges();
+ });
+
+ const stubContent = (line: number, side: Side) => {
+ const contentTd = diff.querySelector(
+ `.${side}.lineNum[data-value="${line}"] ~ .content`
+ );
+ if (!contentTd) assert.fail('content td not found');
+ const contentText = contentTd.querySelector('.contentText');
+ const lineEl =
+ diff.querySelector(`.${side}.lineNum[data-value="${line}"]`) ??
+ undefined;
+ contentStubs.push({
+ lineEl,
+ contentTd,
+ contentText,
+ });
+ builder.getContentTdByLineEl.withArgs(lineEl).returns(contentTd);
+ return contentText;
+ };
+
+ const emulateSelection = (
+ startNode: Node,
+ startOffset: number,
+ endNode: Node,
+ endOffset: number
+ ) => {
+ const selection = document.getSelection();
+ if (!selection) assert.fail('no selection');
+ selection.removeAllRanges();
+ const range = document.createRange();
+ range.setStart(startNode, startOffset);
+ range.setEnd(endNode, endOffset);
+ selection.addRange(range);
+ element.handleSelection(selection, false);
+ };
+
+ test('single first line', () => {
+ const content = stubContent(1, Side.RIGHT);
+ sinon.spy(element, 'positionActionBox');
+ if (!content?.firstChild) assert.fail('content first child not found');
+ emulateSelection(content.firstChild, 5, content.firstChild, 12);
+ const actionBox = diff.querySelector('gr-selection-action-box');
+ if (!actionBox) assert.fail('action box not found');
+ assert.isTrue(actionBox.positionBelow);
+ });
+
+ test('multiline starting on first line', () => {
+ const startContent = stubContent(1, Side.RIGHT);
+ const endContent = stubContent(2, Side.RIGHT);
+ sinon.spy(element, 'positionActionBox');
+ if (!startContent?.firstChild) {
+ assert.fail('first child of start content not found');
+ }
+ if (!endContent?.lastChild) {
+ assert.fail('last child of end content not found');
+ }
+ emulateSelection(startContent.firstChild, 10, endContent.lastChild, 7);
+ const actionBox = diff.querySelector('gr-selection-action-box');
+ if (!actionBox) assert.fail('action box not found');
+ assert.isTrue(actionBox.positionBelow);
+ });
+
+ test('single line', async () => {
+ const content = stubContent(138, Side.LEFT);
+ sinon.spy(element, 'positionActionBox');
+ if (!content?.firstChild) assert.fail('content first child not found');
+ emulateSelection(content.firstChild, 5, content.firstChild, 12);
+ const actionBox = await waitQueryAndAssert<GrSelectionActionBox>(
+ diff,
+ 'gr-selection-action-box'
+ );
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 138,
+ start_character: 5,
+ end_line: 138,
+ end_character: 12,
+ });
+ assert.equal(side, Side.LEFT);
+ assert.notOk(actionBox.positionBelow);
+ });
+
+ test('multiline', () => {
+ const startContent = stubContent(119, Side.RIGHT);
+ const endContent = stubContent(120, Side.RIGHT);
+ sinon.spy(element, 'positionActionBox');
+ if (!startContent?.firstChild) {
+ assert.fail('first child of start content not found');
+ }
+ if (!endContent?.lastChild) {
+ assert.fail('last child of end content');
+ }
+ emulateSelection(startContent.firstChild, 10, endContent.lastChild, 7);
+ const actionBox = diff.querySelector('gr-selection-action-box');
+ if (!actionBox) assert.fail('action box not found');
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 119,
+ start_character: 10,
+ end_line: 120,
+ end_character: 36,
+ });
+ assert.equal(side, Side.RIGHT);
+ assert.notOk(actionBox.positionBelow);
+ });
+
+ test('multiple ranges aka firefox implementation', () => {
+ const startContent = stubContent(119, Side.RIGHT);
+ const endContent = stubContent(120, Side.RIGHT);
+ if (!startContent?.firstChild) {
+ assert.fail('first child of start content not found');
+ }
+ if (!endContent?.lastChild) {
+ assert.fail('last child of end content');
+ }
+
+ const startRange = document.createRange();
+ startRange.setStart(startContent.firstChild, 10);
+ startRange.setEnd(startContent.firstChild, 11);
+
+ const endRange = document.createRange();
+ endRange.setStart(endContent.lastChild, 6);
+ endRange.setEnd(endContent.lastChild, 7);
+
+ const getRangeAtStub = sinon.stub();
+ getRangeAtStub
+ .onFirstCall()
+ .returns(startRange)
+ .onSecondCall()
+ .returns(endRange);
+ const selection = {
+ rangeCount: 2,
+ getRangeAt: getRangeAtStub,
+ removeAllRanges: sinon.stub(),
+ } as unknown as Selection;
+ element.handleSelection(selection, false);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 119,
+ start_character: 10,
+ end_line: 120,
+ end_character: 36,
+ });
+ });
+
+ test('multiline grow end highlight over tabs', () => {
+ const startContent = stubContent(119, Side.RIGHT);
+ const endContent = stubContent(120, Side.RIGHT);
+ if (!startContent?.firstChild) {
+ assert.fail('first child of start content not found');
+ }
+ if (!endContent?.firstChild) {
+ assert.fail('first child of end content not found');
+ }
+ emulateSelection(startContent.firstChild, 10, endContent.firstChild, 2);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 119,
+ start_character: 10,
+ end_line: 120,
+ end_character: 2,
+ });
+ assert.equal(side, Side.RIGHT);
+ });
+
+ test('collapsed', () => {
+ const content = stubContent(138, Side.LEFT);
+ if (!content?.firstChild) {
+ assert.fail('first child of content not found');
+ }
+ emulateSelection(content.firstChild, 5, content.firstChild, 5);
+ const sel = document.getSelection();
+ if (!sel) assert.fail('no selection');
+ assert.isOk(sel.getRangeAt(0).startContainer);
+ assert.isFalse(!!element.selectedRange);
+ });
+
+ test('starts inside hl', () => {
+ const content = stubContent(140, Side.LEFT);
+ if (!content) {
+ assert.fail('content not found');
+ }
+ const hl = content.querySelector('.foo');
+ if (!hl?.firstChild) {
+ assert.fail('first child of hl element not found');
+ }
+ if (!hl?.nextSibling) {
+ assert.fail('next sibling of hl element not found');
+ }
+ emulateSelection(hl.firstChild, 2, hl.nextSibling, 7);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 140,
+ start_character: 8,
+ end_line: 140,
+ end_character: 23,
+ });
+ assert.equal(side, Side.LEFT);
+ });
+
+ test('ends inside hl', () => {
+ const content = stubContent(140, Side.LEFT);
+ if (!content) assert.fail('content not found');
+ const hl = content.querySelector('.bar');
+ if (!hl) assert.fail('hl inside content not found');
+ if (!hl.previousSibling) assert.fail('previous sibling not found');
+ if (!hl.firstChild) assert.fail('first child not found');
+ emulateSelection(hl.previousSibling, 2, hl.firstChild, 3);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 140,
+ start_character: 18,
+ end_line: 140,
+ end_character: 27,
+ });
+ });
+
+ test('multiple hl', () => {
+ const content = stubContent(140, Side.LEFT);
+ if (!content) assert.fail('content not found');
+ if (!content.firstChild) assert.fail('first child not found');
+ const hl = content.querySelectorAll('hl')[4];
+ if (!hl) assert.fail('hl not found');
+ if (!hl.firstChild) assert.fail('first child of hl not found');
+ emulateSelection(content.firstChild, 2, hl.firstChild, 2);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 140,
+ start_character: 2,
+ end_line: 140,
+ end_character: 61,
+ });
+ assert.equal(side, Side.LEFT);
+ });
+
+ test('starts outside of diff', () => {
+ const contentText = stubContent(140, Side.LEFT);
+ if (!contentText) assert.fail('content not found');
+ if (!contentText.firstChild) assert.fail('child not found');
+ const contentTd = contentText.parentElement;
+ if (!contentTd) assert.fail('content td not found');
+ if (!contentTd.parentElement) assert.fail('parent of td not found');
+
+ emulateSelection(contentTd.parentElement, 0, contentText.firstChild, 2);
+ assert.isFalse(!!element.selectedRange);
+ });
+
+ test('ends outside of diff', () => {
+ const content = stubContent(140, Side.LEFT);
+ if (!content) assert.fail('content not found');
+ if (!content.firstChild) assert.fail('child not found');
+ if (!content.nextElementSibling) assert.fail('sibling not found');
+ if (!content.nextElementSibling.firstChild) {
+ assert.fail('sibling child not found');
+ }
+ emulateSelection(
+ content.nextElementSibling.firstChild,
+ 2,
+ content.firstChild,
+ 2
+ );
+ assert.isFalse(!!element.selectedRange);
+ });
+
+ test('starts and ends on different sides', () => {
+ const startContent = stubContent(140, Side.LEFT);
+ const endContent = stubContent(130, Side.RIGHT);
+ if (!startContent?.firstChild) {
+ assert.fail('first child of start content not found');
+ }
+ if (!endContent?.firstChild) {
+ assert.fail('first child of end content not found');
+ }
+ emulateSelection(startContent.firstChild, 2, endContent.firstChild, 2);
+ assert.isFalse(!!element.selectedRange);
+ });
+
+ test('starts in comment thread element', () => {
+ const startContent = stubContent(140, Side.LEFT);
+ if (!startContent?.parentElement) {
+ assert.fail('parent el of start content not found');
+ }
+ const comment =
+ startContent.parentElement.querySelector('.comment-thread');
+ if (!comment?.firstChild) {
+ assert.fail('first child of comment not found');
+ }
+ const endContent = stubContent(141, Side.LEFT);
+ if (!endContent?.firstChild) {
+ assert.fail('first child of end content not found');
+ }
+ emulateSelection(comment.firstChild, 2, endContent.firstChild, 4);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 140,
+ start_character: 83,
+ end_line: 141,
+ end_character: 4,
+ });
+ assert.equal(side, Side.LEFT);
+ });
+
+ test('ends in comment thread element', () => {
+ const content = stubContent(140, Side.LEFT);
+ if (!content?.firstChild) {
+ assert.fail('first child of content not found');
+ }
+ if (!content?.parentElement) {
+ assert.fail('parent element of content not found');
+ }
+ const comment = content.parentElement.querySelector('.comment-thread');
+ if (!comment?.firstChild) {
+ assert.fail('first child of comment element not found');
+ }
+ emulateSelection(content.firstChild, 4, comment.firstChild, 1);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 140,
+ start_character: 4,
+ end_line: 140,
+ end_character: 83,
+ });
+ assert.equal(side, Side.LEFT);
+ });
+
+ test('starts in context element', () => {
+ const contextControl = diff
+ .querySelector('.contextControl')!
+ .querySelector('gr-button');
+ if (!contextControl) assert.fail('context control not found');
+ const content = stubContent(146, Side.RIGHT);
+ if (!content) assert.fail('content not found');
+ if (!content.firstChild) assert.fail('content child not found');
+ emulateSelection(contextControl, 0, content.firstChild, 7);
+ // TODO (viktard): Select nearest line.
+ assert.isFalse(!!element.selectedRange);
+ });
+
+ test('ends in context element', () => {
+ const contextControl = diff
+ .querySelector('.contextControl')!
+ .querySelector('gr-button');
+ if (!contextControl) {
+ assert.fail('context control element not found');
+ }
+ const content = stubContent(141, Side.LEFT);
+ if (!content?.firstChild) {
+ assert.fail('first child of content element not found');
+ }
+ emulateSelection(content.firstChild, 2, contextControl, 1);
+ // TODO (viktard): Select nearest line.
+ assert.isFalse(!!element.selectedRange);
+ });
+
+ test('selection containing context element', () => {
+ const startContent = stubContent(130, Side.RIGHT);
+ const endContent = stubContent(146, Side.RIGHT);
+ if (!startContent?.firstChild) {
+ assert.fail('first child of start content not found');
+ }
+ if (!endContent?.firstChild) {
+ assert.fail('first child of end content not found');
+ }
+ emulateSelection(startContent.firstChild, 3, endContent.firstChild, 14);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 130,
+ start_character: 3,
+ end_line: 146,
+ end_character: 14,
+ });
+ assert.equal(side, Side.RIGHT);
+ });
+
+ test('ends at a tab', () => {
+ const content = stubContent(140, Side.LEFT);
+ if (!content?.firstChild) {
+ assert.fail('first child of content element not found');
+ }
+ const span = content.querySelector('span');
+ if (!span) assert.fail('span element not found');
+ emulateSelection(content.firstChild, 1, span, 0);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 140,
+ start_character: 1,
+ end_line: 140,
+ end_character: 51,
+ });
+ assert.equal(side, Side.LEFT);
+ });
+
+ test('starts at a tab', () => {
+ const content = stubContent(140, Side.LEFT);
+ if (!content) assert.fail('content element not found');
+ emulateSelection(
+ content.querySelectorAll('hl')[3],
+ 0,
+ content.querySelectorAll('span')[1].nextSibling!,
+ 1
+ );
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 140,
+ start_character: 51,
+ end_line: 140,
+ end_character: 71,
+ });
+ assert.equal(side, Side.LEFT);
+ });
+
+ test('properly accounts for syntax highlighting', () => {
+ const content = stubContent(140, Side.LEFT);
+ if (!content) assert.fail('content element not found');
+ emulateSelection(
+ content.querySelectorAll('hl')[3],
+ 0,
+ content.querySelectorAll('span')[1],
+ 0
+ );
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 140,
+ start_character: 51,
+ end_line: 140,
+ end_character: 69,
+ });
+ assert.equal(side, Side.LEFT);
+ });
+
+ test('GrRangeNormalizer.getTextOffset computes text offset', () => {
+ let content = stubContent(140, Side.LEFT);
+ if (!content) assert.fail('content element not found');
+ if (!content.lastChild) assert.fail('last child of content not found');
+ let child = content.lastChild.lastChild;
+ if (!child) assert.fail('last child of last child of content not found');
+ let result = _getTextOffset(content, child);
+ assert.equal(result, 75);
+ content = stubContent(146, Side.RIGHT);
+ if (!content) assert.fail('content element not found');
+ child = content.lastChild;
+ if (!child) assert.fail('child element not found');
+ result = _getTextOffset(content, child);
+ assert.equal(result, 0);
+ });
+
+ test('fixTripleClickSelection', () => {
+ const startContent = stubContent(119, Side.RIGHT);
+ const endContent = stubContent(120, Side.RIGHT);
+ if (!startContent?.firstChild) {
+ assert.fail('first child of start content not found');
+ }
+ if (!endContent) assert.fail('end content not found');
+ if (!endContent.firstChild) assert.fail('first child not found');
+ emulateSelection(startContent.firstChild, 0, endContent.firstChild, 0);
+ if (!element.selectedRange) assert.fail('no range selected');
+ const {range, side} = element.selectedRange;
+ assert.deepEqual(range, {
+ start_line: 119,
+ start_character: 0,
+ end_line: 119,
+ end_character: element.getLength(startContent),
+ });
+ assert.equal(side, Side.RIGHT);
+ });
+ });
+});
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor.ts b/polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor.ts
index b588bc7..4a1e5be 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor.ts
+++ b/polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor.ts
@@ -1,20 +1,8 @@
/**
* @license
- * 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.
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
*/
-import {PolymerElement} from '@polymer/polymer/polymer-element';
import {
GrDiffLine,
GrDiffLineType,
@@ -28,15 +16,16 @@
hideInContextControl,
} from '../gr-diff/gr-diff-group';
import {CancelablePromise, util} from '../../../scripts/util';
-import {customElement, property} from '@polymer/decorators';
import {DiffContent} from '../../../types/diff';
import {Side} from '../../../constants/constants';
import {debounce, DelayedTask} from '../../../utils/async-util';
import {RenderPreferences} from '../../../api/diff';
+import {assertIsDefined} from '../../../utils/common-util';
const WHOLE_FILE = -1;
-interface State {
+// visible for testing
+export interface State {
lineNums: {
left: number;
right: number;
@@ -59,7 +48,7 @@
* into a series of chunks that are this size at most.
*
* Note: The value of 120 is chosen so that it is larger than the default
- * _asyncThreshold of 64, but feel free to tune this constant to your
+ * asyncThreshold of 64, but feel free to tune this constant to your
* performance needs.
*/
function calcMaxGroupSize(asyncThreshold?: number): number {
@@ -67,6 +56,12 @@
return asyncThreshold * 2;
}
+/** Interface for listening to the output of the processor. */
+export interface GroupConsumer {
+ addGroup(group: GrDiffGroup): void;
+ clearGroups(): void;
+}
+
/**
* Converts the API's `DiffContent`s to `GrDiffGroup`s for rendering.
*
@@ -92,55 +87,29 @@
* that the part that is within the context or has comments is shown, while
* the rest is not.
*/
-@customElement('gr-diff-processor')
-export class GrDiffProcessor extends PolymerElement {
- @property({type: Number})
+export class GrDiffProcessor {
context = 3;
- /**
- * The builder elements watches this (two-way data binding and @observe) and
- * thus passes each added group on to the renderer (i.e. gr-diff-builder).
- * You must only add to this array and not modify it later (only when
- * resetting). The source of truth is then held by gr-diff-builder, which also
- * reflects expanding and collapsing of groups.
- */
- @property({type: Array, notify: true})
- groups: GrDiffGroup[] = [];
+ consumer?: GroupConsumer;
- @property({type: Object})
keyLocations: KeyLocations = {left: {}, right: {}};
- @property({type: Number})
- _asyncThreshold = 64;
+ private asyncThreshold = 64;
- @property({type: Number})
- _nextStepHandle: number | null = null;
+ private nextStepHandle: number | null = null;
- @property({type: Object})
- _processPromise: CancelablePromise<void> | null = null;
+ private processPromise: CancelablePromise<void> | null = null;
- @property({type: Boolean})
- _isScrolling?: boolean;
+ // visible for testing
+ isScrolling?: boolean;
private resetIsScrollingTask?: DelayedTask;
- override connectedCallback() {
- super.connectedCallback();
- window.addEventListener('scroll', this.handleWindowScroll);
- }
-
- override disconnectedCallback() {
- this.resetIsScrollingTask?.cancel();
- this.cancel();
- window.removeEventListener('scroll', this.handleWindowScroll);
- super.disconnectedCallback();
- }
-
private readonly handleWindowScroll = () => {
- this._isScrolling = true;
+ this.isScrolling = true;
this.resetIsScrollingTask = debounce(
this.resetIsScrollingTask,
- () => (this._isScrolling = false),
+ () => (this.isScrolling = false),
50
);
};
@@ -156,10 +125,12 @@
// Cancel any still running process() calls, because they append to the
// same groups field.
this.cancel();
+ window.addEventListener('scroll', this.handleWindowScroll);
- this.groups = [];
- this.push('groups', this._makeGroup('LOST'));
- this.push('groups', this._makeGroup(FILE));
+ assertIsDefined(this.consumer, 'consumer');
+ this.consumer.clearGroups();
+ this.consumer.addGroup(this.makeGroup('LOST'));
+ this.consumer.addGroup(this.makeGroup(FILE));
// If it's a binary diff, we won't be rendering hunks of text differences
// so finish processing.
@@ -167,33 +138,34 @@
return Promise.resolve();
}
- this._processPromise = util.makeCancelable(
+ this.processPromise = util.makeCancelable(
new Promise(resolve => {
const state = {
lineNums: {left: 0, right: 0},
chunkIndex: 0,
};
- chunks = this._splitLargeChunks(chunks);
- chunks = this._splitCommonChunksWithKeyLocations(chunks);
+ chunks = this.splitLargeChunks(chunks);
+ chunks = this.splitCommonChunksWithKeyLocations(chunks);
let currentBatch = 0;
const nextStep = () => {
- if (this._isScrolling) {
- this._nextStepHandle = window.setTimeout(nextStep, 100);
+ if (this.isScrolling) {
+ this.nextStepHandle = window.setTimeout(nextStep, 100);
return;
}
// If we are done, resolve the promise.
if (state.chunkIndex >= chunks.length) {
resolve();
- this._nextStepHandle = null;
+ this.nextStepHandle = null;
return;
}
// Process the next chunk and incorporate the result.
- const stateUpdate = this._processNext(state, chunks);
+ const stateUpdate = this.processNext(state, chunks);
for (const group of stateUpdate.groups) {
- this.push('groups', group);
+ assertIsDefined(this.consumer, 'consumer');
+ this.consumer.addGroup(group);
currentBatch += group.lines.length;
}
state.lineNums.left += stateUpdate.lineDelta.left;
@@ -201,9 +173,9 @@
// Increment the index and recurse.
state.chunkIndex = stateUpdate.newChunkIndex;
- if (currentBatch >= this._asyncThreshold) {
+ if (currentBatch >= this.asyncThreshold) {
currentBatch = 0;
- this._nextStepHandle = window.setTimeout(nextStep, 1);
+ this.nextStepHandle = window.setTimeout(nextStep, 1);
} else {
nextStep.call(this);
}
@@ -212,8 +184,9 @@
nextStep.call(this);
})
);
- return this._processPromise.finally(() => {
- this._processPromise = null;
+ return this.processPromise.finally(() => {
+ this.processPromise = null;
+ window.removeEventListener('scroll', this.handleWindowScroll);
});
}
@@ -221,20 +194,22 @@
* Cancel any jobs that are running.
*/
cancel() {
- if (this._nextStepHandle !== null) {
- window.clearTimeout(this._nextStepHandle);
- this._nextStepHandle = null;
+ if (this.nextStepHandle !== null) {
+ window.clearTimeout(this.nextStepHandle);
+ this.nextStepHandle = null;
}
- if (this._processPromise) {
- this._processPromise.cancel();
+ if (this.processPromise) {
+ this.processPromise.cancel();
}
+ window.removeEventListener('scroll', this.handleWindowScroll);
}
/**
* Process the next uncollapsible chunk, or the next collapsible chunks.
*/
- _processNext(state: State, chunks: DiffContent[]) {
- const firstUncollapsibleChunkIndex = this._firstUncollapsibleChunkIndex(
+ // visible for testing
+ processNext(state: State, chunks: DiffContent[]) {
+ const firstUncollapsibleChunkIndex = this.firstUncollapsibleChunkIndex(
chunks,
state.chunkIndex
);
@@ -242,11 +217,11 @@
const chunk = chunks[state.chunkIndex];
return {
lineDelta: {
- left: this._linesLeft(chunk).length,
- right: this._linesRight(chunk).length,
+ left: this.linesLeft(chunk).length,
+ right: this.linesRight(chunk).length,
},
groups: [
- this._chunkToGroup(
+ this.chunkToGroup(
chunk,
state.lineNums.left + 1,
state.lineNums.right + 1
@@ -256,33 +231,33 @@
};
}
- return this._processCollapsibleChunks(
+ return this.processCollapsibleChunks(
state,
chunks,
firstUncollapsibleChunkIndex
);
}
- _linesLeft(chunk: DiffContent) {
+ private linesLeft(chunk: DiffContent) {
return chunk.ab || chunk.a || [];
}
- _linesRight(chunk: DiffContent) {
+ private linesRight(chunk: DiffContent) {
return chunk.ab || chunk.b || [];
}
- _firstUncollapsibleChunkIndex(chunks: DiffContent[], offset: number) {
+ private firstUncollapsibleChunkIndex(chunks: DiffContent[], offset: number) {
let chunkIndex = offset;
while (
chunkIndex < chunks.length &&
- this._isCollapsibleChunk(chunks[chunkIndex])
+ this.isCollapsibleChunk(chunks[chunkIndex])
) {
chunkIndex++;
}
return chunkIndex;
}
- _isCollapsibleChunk(chunk: DiffContent) {
+ private isCollapsibleChunk(chunk: DiffContent) {
return (chunk.ab || chunk.common || chunk.skip) && !chunk.keyLocation;
}
@@ -296,7 +271,7 @@
* 3) Visible context after the hidden common code, unless it's the very
* end of the file.
*/
- _processCollapsibleChunks(
+ private processCollapsibleChunks(
state: State,
chunks: DiffContent[],
firstUncollapsibleChunkIndex: number
@@ -306,11 +281,11 @@
firstUncollapsibleChunkIndex
);
const lineCount = collapsibleChunks.reduce(
- (sum, chunk) => sum + this._commonChunkLength(chunk),
+ (sum, chunk) => sum + this.commonChunkLength(chunk),
0
);
- let groups = this._chunksToGroups(
+ let groups = this.chunksToGroups(
collapsibleChunks,
state.lineNums.left + 1,
state.lineNums.right + 1
@@ -336,7 +311,7 @@
};
}
- _commonChunkLength(chunk: DiffContent) {
+ private commonChunkLength(chunk: DiffContent) {
if (chunk.skip) {
return chunk.skip;
}
@@ -347,31 +322,31 @@
'common chunk needs same number of a and b lines: ',
chunk
);
- return this._linesLeft(chunk).length;
+ return this.linesLeft(chunk).length;
}
- _chunksToGroups(
+ private chunksToGroups(
chunks: DiffContent[],
offsetLeft: number,
offsetRight: number
): GrDiffGroup[] {
return chunks.map(chunk => {
- const group = this._chunkToGroup(chunk, offsetLeft, offsetRight);
- const chunkLength = this._commonChunkLength(chunk);
+ const group = this.chunkToGroup(chunk, offsetLeft, offsetRight);
+ const chunkLength = this.commonChunkLength(chunk);
offsetLeft += chunkLength;
offsetRight += chunkLength;
return group;
});
}
- _chunkToGroup(
+ private chunkToGroup(
chunk: DiffContent,
offsetLeft: number,
offsetRight: number
): GrDiffGroup {
const type =
chunk.ab || chunk.skip ? GrDiffGroupType.BOTH : GrDiffGroupType.DELTA;
- const lines = this._linesFromChunk(chunk, offsetLeft, offsetRight);
+ const lines = this.linesFromChunk(chunk, offsetLeft, offsetRight);
const options = {
moveDetails: chunk.move_details,
dueToRebase: !!chunk.due_to_rebase,
@@ -395,10 +370,14 @@
}
}
- _linesFromChunk(chunk: DiffContent, offsetLeft: number, offsetRight: number) {
+ private linesFromChunk(
+ chunk: DiffContent,
+ offsetLeft: number,
+ offsetRight: number
+ ) {
if (chunk.ab) {
return chunk.ab.map((row, i) =>
- this._lineFromRow(GrDiffLineType.BOTH, offsetLeft, offsetRight, row, i)
+ this.lineFromRow(GrDiffLineType.BOTH, offsetLeft, offsetRight, row, i)
);
}
let lines: GrDiffLine[] = [];
@@ -406,7 +385,7 @@
// Avoiding a.push(...b) because that causes callstack overflows for
// large b, which can occur when large files are added removed.
lines = lines.concat(
- this._linesFromRows(
+ this.linesFromRows(
GrDiffLineType.REMOVE,
chunk.a,
offsetLeft,
@@ -418,7 +397,7 @@
// Avoiding a.push(...b) because that causes callstack overflows for
// large b, which can occur when large files are added removed.
lines = lines.concat(
- this._linesFromRows(
+ this.linesFromRows(
GrDiffLineType.ADD,
chunk.b,
offsetRight,
@@ -429,21 +408,22 @@
return lines;
}
- _linesFromRows(
+ // visible for testing
+ linesFromRows(
lineType: GrDiffLineType,
rows: string[],
offset: number,
intralineInfos?: number[][]
): GrDiffLine[] {
const grDiffHighlights = intralineInfos
- ? this._convertIntralineInfos(rows, intralineInfos)
+ ? this.convertIntralineInfos(rows, intralineInfos)
: undefined;
return rows.map((row, i) =>
- this._lineFromRow(lineType, offset, offset, row, i, grDiffHighlights)
+ this.lineFromRow(lineType, offset, offset, row, i, grDiffHighlights)
);
}
- _lineFromRow(
+ private lineFromRow(
type: GrDiffLineType,
offsetLeft: number,
offsetRight: number,
@@ -464,7 +444,7 @@
return line;
}
- _makeGroup(number: LineNumber) {
+ private makeGroup(number: LineNumber) {
const line = new GrDiffLine(GrDiffLineType.BOTH);
line.beforeNumber = number;
line.afterNumber = number;
@@ -486,12 +466,13 @@
* @param chunks Chunks as returned from the server
* @return Finer grained chunks.
*/
- _splitLargeChunks(chunks: DiffContent[]): DiffContent[] {
+ // visible for testing
+ splitLargeChunks(chunks: DiffContent[]): DiffContent[] {
const newChunks = [];
for (const chunk of chunks) {
if (!chunk.ab) {
- for (const subChunk of this._breakdownChunk(chunk)) {
+ for (const subChunk of this.breakdownChunk(chunk)) {
newChunks.push(subChunk);
}
continue;
@@ -501,7 +482,7 @@
// chunks so they can be rendered incrementally. Note: this is not
// enabled for any other context preference because manipulating the
// chunks in this way violates assumptions by the context grouper logic.
- const MAX_GROUP_SIZE = calcMaxGroupSize(this._asyncThreshold);
+ const MAX_GROUP_SIZE = calcMaxGroupSize(this.asyncThreshold);
if (this.context === -1 && chunk.ab.length > MAX_GROUP_SIZE * 2) {
// Split large shared chunks in two, where the first is the maximum
// group size.
@@ -522,7 +503,8 @@
* @param chunks DiffContents as returned from server.
* @return Finer grained DiffContents.
*/
- _splitCommonChunksWithKeyLocations(chunks: DiffContent[]): DiffContent[] {
+ // visible for testing
+ splitCommonChunksWithKeyLocations(chunks: DiffContent[]): DiffContent[] {
const result = [];
let leftLineNum = 1;
let rightLineNum = 1;
@@ -545,8 +527,8 @@
'DiffContent with common=true must always have equal length'
);
}
- const numLines = this._commonChunkLength(chunk);
- const chunkEnds = this._findChunkEndsAtKeyLocations(
+ const numLines = this.commonChunkLength(chunk);
+ const chunkEnds = this.findChunkEndsAtKeyLocations(
numLines,
leftLineNum,
rightLineNum
@@ -562,7 +544,7 @@
});
} else if (chunk.ab) {
result.push(
- ...this._splitAtChunkEnds(chunk.ab, chunkEnds).map(
+ ...this.splitAtChunkEnds(chunk.ab, chunkEnds).map(
({lines, keyLocation}) => {
return {
...chunk,
@@ -573,8 +555,8 @@
)
);
} else if (chunk.common) {
- const aChunks = this._splitAtChunkEnds(chunk.a!, chunkEnds);
- const bChunks = this._splitAtChunkEnds(chunk.b!, chunkEnds);
+ const aChunks = this.splitAtChunkEnds(chunk.a!, chunkEnds);
+ const bChunks = this.splitAtChunkEnds(chunk.b!, chunkEnds);
result.push(
...aChunks.map(({lines, keyLocation}, i) => {
return {
@@ -595,7 +577,7 @@
* @return Offsets of the new chunk ends, including whether it's a key
* location.
*/
- _findChunkEndsAtKeyLocations(
+ private findChunkEndsAtKeyLocations(
numLines: number,
leftOffset: number,
rightOffset: number
@@ -628,7 +610,7 @@
return result;
}
- _splitAtChunkEnds(lines: string[], chunkEnds: ChunkEnd[]) {
+ private splitAtChunkEnds(lines: string[], chunkEnds: ChunkEnd[]) {
const result = [];
let lastChunkEndOffset = 0;
for (const {offset, keyLocation} of chunkEnds) {
@@ -645,7 +627,8 @@
* Converts `IntralineInfo`s return by the API to `GrLineHighlights` used
* for rendering.
*/
- _convertIntralineInfos(
+ // visible for testing
+ convertIntralineInfos(
rows: string[],
intralineInfos: number[][]
): Highlights[] {
@@ -695,7 +678,8 @@
* of that type using the MAX_GROUP_SIZE. If the group is a shared chunk
* or a delta it is returned as the single element of the result array.
*/
- _breakdownChunk(chunk: DiffContent): DiffContent[] {
+ // visible for testing
+ breakdownChunk(chunk: DiffContent): DiffContent[] {
let key: 'a' | 'b' | 'ab' | null = null;
const {a, b, ab, move_details} = chunk;
if (a?.length && !b?.length) {
@@ -712,8 +696,8 @@
return [chunk];
}
- const MAX_GROUP_SIZE = calcMaxGroupSize(this._asyncThreshold);
- return this._breakdown(chunk[key]!, MAX_GROUP_SIZE).map(subChunkLines => {
+ const MAX_GROUP_SIZE = calcMaxGroupSize(this.asyncThreshold);
+ return this.breakdown(chunk[key]!, MAX_GROUP_SIZE).map(subChunkLines => {
const subChunk: DiffContent = {};
subChunk[key!] = subChunkLines;
if (chunk.due_to_rebase) {
@@ -730,7 +714,8 @@
* Given an array and a size, return an array of arrays where no inner array
* is larger than that size, preserving the original order.
*/
- _breakdown<T>(array: T[], size: number): T[][] {
+ // visible for testing
+ breakdown<T>(array: T[], size: number): T[][] {
if (!array.length) {
return [];
}
@@ -741,18 +726,12 @@
const head = array.slice(0, array.length - size);
const tail = array.slice(array.length - size);
- return this._breakdown(head, size).concat([tail]);
+ return this.breakdown(head, size).concat([tail]);
}
updateRenderPrefs(renderPrefs: RenderPreferences) {
if (renderPrefs.num_lines_rendered_at_once) {
- this._asyncThreshold = renderPrefs.num_lines_rendered_at_once;
+ this.asyncThreshold = renderPrefs.num_lines_rendered_at_once;
}
}
}
-
-declare global {
- interface HTMLElementTagNameMap {
- 'gr-diff-processor': GrDiffProcessor;
- }
-}
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor_test.js b/polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor_test.ts
similarity index 65%
rename from polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor_test.js
rename to polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor_test.ts
index bebdf34..60a1cba 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor_test.js
+++ b/polygerrit-ui/app/embed/diff/gr-diff-processor/gr-diff-processor_test.ts
@@ -1,66 +1,52 @@
/**
* @license
- * 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.
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
*/
-
-import '../../../test/common-test-setup-karma.js';
-import 'lodash/lodash.js';
-import './gr-diff-processor.js';
-import {GrDiffLineType, FILE} from '../gr-diff/gr-diff-line.js';
-import {GrDiffGroup, GrDiffGroupType} from '../gr-diff/gr-diff-group.js';
-
-const basicFixture = fixtureFromElement('gr-diff-processor');
+import '../../../test/common-test-setup-karma';
+import './gr-diff-processor';
+import {GrDiffLineType, FILE, GrDiffLine} from '../gr-diff/gr-diff-line';
+import {GrDiffGroup, GrDiffGroupType} from '../gr-diff/gr-diff-group';
+import {GrDiffProcessor, State} from './gr-diff-processor';
+import {DiffContent} from '../../../types/diff';
suite('gr-diff-processor tests', () => {
const WHOLE_FILE = -1;
const loremIpsum =
- 'Lorem ipsum dolor sit amet, ei nonumes vituperata ius. ' +
- 'Duo animal omnesque fabellas et. Id has phaedrum dignissim ' +
- 'deterruisset, pro ei petentium comprehensam, ut vis solum dicta. ' +
- 'Eos cu aliquam labores qualisque, usu postea inermis te, et solum ' +
- 'fugit assum per.';
+ 'Lorem ipsum dolor sit amet, ei nonumes vituperata ius. ' +
+ 'Duo animal omnesque fabellas et. Id has phaedrum dignissim ' +
+ 'deterruisset, pro ei petentium comprehensam, ut vis solum dicta. ' +
+ 'Eos cu aliquam labores qualisque, usu postea inermis te, et solum ' +
+ 'fugit assum per.';
- let element;
+ let element: GrDiffProcessor;
+ let groups: GrDiffGroup[];
- setup(() => {
-
- });
+ setup(() => {});
suite('not logged in', () => {
setup(() => {
- element = basicFixture.instantiate();
-
+ groups = [];
+ element = new GrDiffProcessor();
+ element.consumer = {
+ addGroup(group: GrDiffGroup) {
+ groups.push(group);
+ },
+ clearGroups() {
+ groups = [];
+ },
+ };
element.context = 4;
});
test('process loaded content', () => {
- const content = [
+ const content: DiffContent[] = [
{
- ab: [
- '<!DOCTYPE html>',
- '<meta charset="utf-8">',
- ],
+ ab: ['<!DOCTYPE html>', '<meta charset="utf-8">'],
},
{
- a: [
- ' Welcome ',
- ' to the wooorld of tomorrow!',
- ],
- b: [
- ' Hello, world!',
- ],
+ a: [' Welcome ', ' to the wooorld of tomorrow!'],
+ b: [' Hello, world!'],
},
{
ab: [
@@ -71,8 +57,7 @@
},
];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
assert.equal(groups.length, 4);
@@ -87,9 +72,15 @@
assert.equal(group.type, GrDiffGroupType.BOTH);
assert.equal(group.lines.length, 2);
- function beforeNumberFn(l) { return l.beforeNumber; }
- function afterNumberFn(l) { return l.afterNumber; }
- function textFn(l) { return l.text; }
+ function beforeNumberFn(l: GrDiffLine) {
+ return l.beforeNumber;
+ }
+ function afterNumberFn(l: GrDiffLine) {
+ return l.afterNumber;
+ }
+ function textFn(l: GrDiffLine) {
+ return l.text;
+ }
assert.deepEqual(group.lines.map(beforeNumberFn), [1, 2]);
assert.deepEqual(group.lines.map(afterNumberFn), [1, 2]);
@@ -109,9 +100,7 @@
' Welcome ',
' to the wooorld of tomorrow!',
]);
- assert.deepEqual(group.adds.map(textFn), [
- ' Hello, world!',
- ]);
+ assert.deepEqual(group.adds.map(textFn), [' Hello, world!']);
group = groups[3];
assert.equal(group.type, GrDiffGroupType.BOTH);
@@ -127,12 +116,9 @@
});
test('first group is for file', () => {
- const content = [
- {b: ['foo']},
- ];
+ const content = [{b: ['foo']}];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
assert.equal(groups[0].type, GrDiffGroupType.BOTH);
@@ -147,13 +133,15 @@
test('at the beginning, larger than context', () => {
element.context = 10;
const content = [
- {ab: new Array(100)
- .fill('all work and no play make jack a dull boy')},
+ {
+ ab: new Array(100).fill(
+ 'all work and no play make jack a dull boy'
+ ),
+ },
{a: ['all work and no play make andybons a dull boy']},
];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -176,17 +164,14 @@
test('at the beginning with skip chunks', async () => {
element.context = 10;
const content = [
- {ab: new Array(20)
- .fill('all work and no play make jack a dull boy')},
+ {ab: new Array(20).fill('all work and no play make jack a dull boy')},
{skip: 43900},
- {ab: new Array(30)
- .fill('some other content')},
+ {ab: new Array(30).fill('some other content')},
{a: ['some other content']},
];
- await element.process(content);
+ await element.process(content, false);
- const groups = element.groups;
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -227,13 +212,11 @@
test('at the beginning, smaller than context', () => {
element.context = 10;
const content = [
- {ab: new Array(5)
- .fill('all work and no play make jack a dull boy')},
+ {ab: new Array(5).fill('all work and no play make jack a dull boy')},
{a: ['all work and no play make andybons a dull boy']},
];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -250,12 +233,14 @@
element.context = 10;
const content = [
{a: ['all work and no play make andybons a dull boy']},
- {ab: new Array(100)
- .fill('all work and no play make jill a dull girl')},
+ {
+ ab: new Array(100).fill(
+ 'all work and no play make jill a dull girl'
+ ),
+ },
];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -264,16 +249,14 @@
assert.equal(groups[2].type, GrDiffGroupType.BOTH);
assert.equal(groups[2].lines.length, 10);
for (const l of groups[2].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
assert.equal(groups[3].type, GrDiffGroupType.CONTEXT_CONTROL);
assert.instanceOf(groups[3].contextGroups[0], GrDiffGroup);
assert.equal(groups[3].contextGroups[0].lines.length, 90);
for (const l of groups[3].contextGroups[0].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
});
});
@@ -282,12 +265,10 @@
element.context = 10;
const content = [
{a: ['all work and no play make andybons a dull boy']},
- {ab: new Array(5)
- .fill('all work and no play make jill a dull girl')},
+ {ab: new Array(5).fill('all work and no play make jill a dull girl')},
];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -296,8 +277,7 @@
assert.equal(groups[2].type, GrDiffGroupType.BOTH);
assert.equal(groups[2].lines.length, 5);
for (const l of groups[2].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
});
});
@@ -306,30 +286,26 @@
element.context = 10;
const content = [
{a: ['all work and no play make andybons a dull boy']},
- {ab: new Array(3)
- .fill('all work and no play make jill a dull girl')},
+ {ab: new Array(3).fill('all work and no play make jill a dull girl')},
{
- a: new Array(3).fill(
- 'all work and no play make jill a dull girl'),
+ a: new Array(3).fill('all work and no play make jill a dull girl'),
b: new Array(3).fill(
- ' all work and no play make jill a dull girl'),
+ ' all work and no play make jill a dull girl'
+ ),
common: true,
},
- {ab: new Array(3)
- .fill('all work and no play make jill a dull girl')},
+ {ab: new Array(3).fill('all work and no play make jill a dull girl')},
{
- a: new Array(3).fill(
- 'all work and no play make jill a dull girl'),
+ a: new Array(3).fill('all work and no play make jill a dull girl'),
b: new Array(3).fill(
- ' all work and no play make jill a dull girl'),
+ ' all work and no play make jill a dull girl'
+ ),
common: true,
},
- {ab: new Array(3)
- .fill('all work and no play make jill a dull girl')},
+ {ab: new Array(3).fill('all work and no play make jill a dull girl')},
];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -341,8 +317,7 @@
assert.equal(groups[2].type, GrDiffGroupType.BOTH);
assert.equal(groups[2].lines.length, 3);
for (const l of groups[2].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
assert.equal(groups[3].type, GrDiffGroupType.DELTA);
@@ -350,19 +325,19 @@
assert.equal(groups[3].adds.length, 3);
assert.equal(groups[3].removes.length, 3);
for (const l of groups[3].removes) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
for (const l of groups[3].adds) {
assert.equal(
- l.text, ' all work and no play make jill a dull girl');
+ l.text,
+ ' all work and no play make jill a dull girl'
+ );
}
assert.equal(groups[4].type, GrDiffGroupType.BOTH);
assert.equal(groups[4].lines.length, 3);
for (const l of groups[4].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
// The next chunk is partially shown, so it results in two groups
@@ -372,12 +347,13 @@
assert.equal(groups[5].adds.length, 1);
assert.equal(groups[5].removes.length, 1);
for (const l of groups[5].removes) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
for (const l of groups[5].adds) {
assert.equal(
- l.text, ' all work and no play make jill a dull girl');
+ l.text,
+ ' all work and no play make jill a dull girl'
+ );
}
assert.equal(groups[6].type, GrDiffGroupType.CONTEXT_CONTROL);
@@ -387,22 +363,20 @@
assert.equal(groups[6].contextGroups[0].removes.length, 2);
assert.equal(groups[6].contextGroups[0].adds.length, 2);
for (const l of groups[6].contextGroups[0].removes) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
for (const l of groups[6].contextGroups[0].adds) {
assert.equal(
- l.text, ' all work and no play make jill a dull girl');
+ l.text,
+ ' all work and no play make jill a dull girl'
+ );
}
// The final chunk is completely hidden
- assert.equal(
- groups[6].contextGroups[1].type,
- GrDiffGroupType.BOTH);
+ assert.equal(groups[6].contextGroups[1].type, GrDiffGroupType.BOTH);
assert.equal(groups[6].contextGroups[1].lines.length, 3);
for (const l of groups[6].contextGroups[1].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
});
});
@@ -411,13 +385,15 @@
element.context = 10;
const content = [
{a: ['all work and no play make andybons a dull boy']},
- {ab: new Array(100)
- .fill('all work and no play make jill a dull girl')},
+ {
+ ab: new Array(100).fill(
+ 'all work and no play make jill a dull girl'
+ ),
+ },
{a: ['all work and no play make andybons a dull boy']},
];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -426,23 +402,20 @@
assert.equal(groups[2].type, GrDiffGroupType.BOTH);
assert.equal(groups[2].lines.length, 10);
for (const l of groups[2].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
assert.equal(groups[3].type, GrDiffGroupType.CONTEXT_CONTROL);
assert.instanceOf(groups[3].contextGroups[0], GrDiffGroup);
assert.equal(groups[3].contextGroups[0].lines.length, 80);
for (const l of groups[3].contextGroups[0].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
assert.equal(groups[4].type, GrDiffGroupType.BOTH);
assert.equal(groups[4].lines.length, 10);
for (const l of groups[4].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
});
});
@@ -451,13 +424,11 @@
element.context = 10;
const content = [
{a: ['all work and no play make andybons a dull boy']},
- {ab: new Array(5)
- .fill('all work and no play make jill a dull girl')},
+ {ab: new Array(5).fill('all work and no play make jill a dull girl')},
{a: ['all work and no play make andybons a dull boy']},
];
- return element.process(content).then(() => {
- const groups = element.groups;
+ return element.process(content, false).then(() => {
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -466,8 +437,7 @@
assert.equal(groups[2].type, GrDiffGroupType.BOTH);
assert.equal(groups[2].lines.length, 5);
for (const l of groups[2].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
});
});
@@ -477,17 +447,14 @@
element.context = 10;
const content = [
{a: ['all work and no play make andybons a dull boy']},
- {ab: new Array(20)
- .fill('all work and no play make jill a dull girl')},
+ {ab: new Array(20).fill('all work and no play make jill a dull girl')},
{skip: 60},
- {ab: new Array(20)
- .fill('all work and no play make jill a dull girl')},
+ {ab: new Array(20).fill('all work and no play make jill a dull girl')},
{a: ['all work and no play make andybons a dull boy']},
];
- await element.process(content);
+ await element.process(content, false);
- const groups = element.groups;
groups.shift(); // remove portedThreadsWithoutRangeGroup
// group[0] is the file group
@@ -501,8 +468,7 @@
assert.instanceOf(commonGroup.contextGroups[0], GrDiffGroup);
assert.equal(commonGroup.contextGroups[0].lines.length, 10);
for (const l of commonGroup.contextGroups[0].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
// Skipped group
@@ -517,8 +483,7 @@
// Hidden context after
assert.equal(commonGroup.contextGroups[2].lines.length, 10);
for (const l of commonGroup.contextGroups[2].lines) {
- assert.equal(
- l.text, 'all work and no play make jill a dull girl');
+ assert.equal(l.text, 'all work and no play make jill a dull girl');
}
// group[4] is the displayed part of the second ab
});
@@ -536,7 +501,7 @@
'',
'Licensed under the Apache License, Version 2.0 (the "License");',
'you may not use this file except in compliance with the ' +
- 'License.',
+ 'License.',
'You may obtain a copy of the License at',
'',
'http://www.apache.org/licenses/LICENSE-2.0',
@@ -546,12 +511,11 @@
'"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.',
+ 'License.',
],
},
];
- const result =
- element._splitCommonChunksWithKeyLocations(content);
+ const result = element.splitCommonChunksWithKeyLocations(content);
assert.deepEqual(result, [
{
ab: ['Copyright (C) 2015 The Android Open Source Project'],
@@ -562,7 +526,7 @@
'',
'Licensed under the Apache License, Version 2.0 (the "License");',
'you may not use this file except in compliance with the ' +
- 'License.',
+ 'License.',
'You may obtain a copy of the License at',
'',
'http://www.apache.org/licenses/LICENSE-2.0',
@@ -572,8 +536,7 @@
keyLocation: false,
},
{
- ab: [
- 'software distributed under the License is distributed on an '],
+ ab: ['software distributed under the License is distributed on an '],
keyLocation: true,
},
{
@@ -581,7 +544,7 @@
'"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.',
+ 'License.',
],
keyLocation: false,
},
@@ -591,11 +554,12 @@
test('breaks down shared chunks w/ whole-file', () => {
const maxGroupSize = 128;
const size = maxGroupSize * 2 + 5;
- const content = [{
- ab: _.times(size, () => `${Math.random()}`),
- }];
+ const ab = Array(size)
+ .fill(0)
+ .map(() => `${Math.random()}`);
+ const content = [{ab}];
element.context = -1;
- const result = element._splitLargeChunks(content);
+ const result = element.splitLargeChunks(content);
assert.equal(result.length, 2);
assert.deepEqual(result[0].ab, content[0].ab.slice(0, maxGroupSize));
assert.deepEqual(result[1].ab, content[0].ab.slice(maxGroupSize));
@@ -604,10 +568,13 @@
test('breaks down added chunks', () => {
const maxGroupSize = 128;
const size = maxGroupSize * 2 + 5;
- const content = _.times(size, () => `${Math.random()}`);
+ const content = Array(size)
+ .fill(0)
+ .map(() => `${Math.random()}`);
element.context = 5;
- const splitContent = element._splitLargeChunks([{a: [], b: content}])
- .map(r => r.b);
+ const splitContent = element
+ .splitLargeChunks([{a: [], b: content}])
+ .map(r => r.b);
assert.equal(splitContent.length, 3);
assert.deepEqual(splitContent[0], content.slice(0, 5));
assert.deepEqual(splitContent[1], content.slice(5, maxGroupSize + 5));
@@ -617,10 +584,13 @@
test('breaks down removed chunks', () => {
const maxGroupSize = 128;
const size = maxGroupSize * 2 + 5;
- const content = _.times(size, () => `${Math.random()}`);
+ const content = Array(size)
+ .fill(0)
+ .map(() => `${Math.random()}`);
element.context = 5;
- const splitContent = element._splitLargeChunks([{a: content, b: []}])
- .map(r => r.a);
+ const splitContent = element
+ .splitLargeChunks([{a: content, b: []}])
+ .map(r => r.a);
assert.equal(splitContent.length, 3);
assert.deepEqual(splitContent[0], content.slice(0, 5));
assert.deepEqual(splitContent[1], content.slice(5, maxGroupSize + 5));
@@ -629,24 +599,30 @@
test('does not break down moved chunks', () => {
const size = 120 * 2 + 5;
- const content = _.times(size, () => `${Math.random()}`);
+ const content = Array(size)
+ .fill(0)
+ .map(() => `${Math.random()}`);
element.context = 5;
- const splitContent = element._splitLargeChunks([{
- a: content,
- b: [],
- move_details: {changed: false},
- }]).map(r => r.a);
+ const splitContent = element
+ .splitLargeChunks([
+ {
+ a: content,
+ b: [],
+ move_details: {changed: false, range: {start: 1, end: 1}},
+ },
+ ])
+ .map(r => r.a);
assert.equal(splitContent.length, 1);
assert.deepEqual(splitContent[0], content);
});
test('does not break-down common chunks w/ context', () => {
- const content = [{
- ab: _.times(75, () => `${Math.random()}`),
- }];
+ const ab = Array(75)
+ .fill(0)
+ .map(() => `${Math.random()}`);
+ const content = [{ab}];
element.context = 4;
- const result =
- element._splitCommonChunksWithKeyLocations(content);
+ const result = element.splitCommonChunksWithKeyLocations(content);
assert.equal(result.length, 1);
assert.deepEqual(result[0].ab, content[0].ab);
assert.isFalse(result[0].keyLocation);
@@ -658,15 +634,15 @@
let content = [
' <section class="summary">',
' <gr-linked-text content="' +
- '[[_computeCurrentRevisionMessage(change)]]"></gr-linked-text>',
+ '[[_computeCurrentRevisionMessage(change)]]"></gr-linked-text>',
' </section>',
];
let highlights = [
- [31, 34], [42, 26],
+ [31, 34],
+ [42, 26],
];
- let results = element._convertIntralineInfos(content,
- highlights);
+ let results = element.convertIntralineInfos(content, highlights);
assert.deepEqual(results, [
{
contentIndex: 0,
@@ -687,8 +663,12 @@
endIndex: 6,
},
]);
- const lines = element._linesFromRows(
- GrDiffGroupType.BOTH, content, 0, highlights);
+ const lines = element.linesFromRows(
+ GrDiffLineType.BOTH,
+ content,
+ 0,
+ highlights
+ );
assert.equal(lines.length, 3);
assert.isTrue(lines[0].hasIntralineInfo);
assert.equal(lines[0].highlights.length, 1);
@@ -715,7 +695,7 @@
[12, 67],
[14, 29],
];
- results = element._convertIntralineInfos(content, highlights);
+ results = element.convertIntralineInfos(content, highlights);
assert.deepEqual(results, [
{
contentIndex: 0,
@@ -746,41 +726,29 @@
});
test('scrolling pauses rendering', () => {
- const contentRow = {
- ab: [
- '',
- '',
- ],
- };
- const content = _.times(200, _.constant(contentRow));
- element._isScrolling = true;
- element.process(content);
+ const content = Array(200).fill({ab: ['', '']});
+ element.isScrolling = true;
+ element.process(content, false);
// Just the files group - no more processing during scrolling.
- assert.equal(element.groups.length, 2);
+ assert.equal(groups.length, 2);
- element._isScrolling = false;
- element.process(content);
+ element.isScrolling = false;
+ element.process(content, false);
// More groups have been processed. How many does not matter here.
- assert.isAtLeast(element.groups.length, 3);
+ assert.isAtLeast(groups.length, 3);
});
test('image diffs', () => {
- const contentRow = {
- ab: [
- '',
- '',
- ],
- };
- const content = _.times(200, _.constant(contentRow));
+ const content = Array(200).fill({ab: ['', '']});
element.process(content, true);
- assert.equal(element.groups.length, 2);
+ assert.equal(groups.length, 2);
// Image diffs don't process content, just the 'FILE' line.
- assert.equal(element.groups[0].lines.length, 1);
+ assert.equal(groups[0].lines.length, 1);
});
- suite('_processNext', () => {
- let rows;
+ suite('processNext', () => {
+ let rows: string[];
setup(() => {
rows = loremIpsum.split(' ');
@@ -788,16 +756,12 @@
test('WHOLE_FILE', () => {
element.context = WHOLE_FILE;
- const state = {
+ const state: State = {
lineNums: {left: 10, right: 100},
chunkIndex: 1,
};
- const chunks = [
- {a: ['foo']},
- {ab: rows},
- {a: ['bar']},
- ];
- const result = element._processNext(state, chunks);
+ const chunks = [{a: ['foo']}, {ab: rows}, {a: ['bar']}];
+ const result = element.processNext(state, chunks);
// Results in one, uncollapsed group with all rows.
assert.equal(result.groups.length, 1);
@@ -806,16 +770,22 @@
// Line numbers are set correctly.
assert.equal(
- result.groups[0].lines[0].beforeNumber,
- state.lineNums.left + 1);
+ result.groups[0].lines[0].beforeNumber,
+ state.lineNums.left + 1
+ );
assert.equal(
- result.groups[0].lines[0].afterNumber,
- state.lineNums.right + 1);
+ result.groups[0].lines[0].afterNumber,
+ state.lineNums.right + 1
+ );
- assert.equal(result.groups[0].lines[rows.length - 1].beforeNumber,
- state.lineNums.left + rows.length);
- assert.equal(result.groups[0].lines[rows.length - 1].afterNumber,
- state.lineNums.right + rows.length);
+ assert.equal(
+ result.groups[0].lines[rows.length - 1].beforeNumber,
+ state.lineNums.left + rows.length
+ );
+ assert.equal(
+ result.groups[0].lines[rows.length - 1].afterNumber,
+ state.lineNums.right + rows.length
+ );
});
test('WHOLE_FILE with skip chunks still get collapsed', () => {
@@ -826,13 +796,8 @@
chunkIndex: 1,
};
const skip = 10000;
- const chunks = [
- {a: ['foo']},
- {skip},
- {ab: rows},
- {a: ['bar']},
- ];
- const result = element._processNext(state, chunks);
+ const chunks = [{a: ['foo']}, {skip}, {ab: rows}, {a: ['bar']}];
+ const result = element.processNext(state, chunks);
// Results in one, uncollapsed group with all rows.
assert.equal(result.groups.length, 1);
assert.equal(result.groups[0].type, GrDiffGroupType.CONTEXT_CONTROL);
@@ -842,31 +807,27 @@
const [skippedGroup, abGroup] = result.groups[0].contextGroups;
// Line numbers are set correctly.
- assert.deepEqual(
- skippedGroup.lineRange,
- {
- left: {
- start_line: lineNums.left + 1,
- end_line: lineNums.left + skip,
- },
- right: {
- start_line: lineNums.right + 1,
- end_line: lineNums.right + skip,
- },
- });
+ assert.deepEqual(skippedGroup.lineRange, {
+ left: {
+ start_line: lineNums.left + 1,
+ end_line: lineNums.left + skip,
+ },
+ right: {
+ start_line: lineNums.right + 1,
+ end_line: lineNums.right + skip,
+ },
+ });
- assert.deepEqual(
- abGroup.lineRange,
- {
- left: {
- start_line: lineNums.left + skip + 1,
- end_line: lineNums.left + skip + rows.length,
- },
- right: {
- start_line: lineNums.right + skip + 1,
- end_line: lineNums.right + skip + rows.length,
- },
- });
+ assert.deepEqual(abGroup.lineRange, {
+ left: {
+ start_line: lineNums.left + skip + 1,
+ end_line: lineNums.left + skip + rows.length,
+ },
+ right: {
+ start_line: lineNums.right + skip + 1,
+ end_line: lineNums.right + skip + rows.length,
+ },
+ });
});
test('with context', () => {
@@ -875,12 +836,8 @@
lineNums: {left: 10, right: 100},
chunkIndex: 1,
};
- const chunks = [
- {a: ['foo']},
- {ab: rows},
- {a: ['bar']},
- ];
- const result = element._processNext(state, chunks);
+ const chunks = [{a: ['foo']}, {ab: rows}, {a: ['bar']}];
+ const result = element.processNext(state, chunks);
const expectedCollapseSize = rows.length - 2 * element.context;
assert.equal(result.groups.length, 3, 'Results in three groups');
@@ -891,8 +848,10 @@
assert.equal(result.groups[2].lines.length, element.context);
// The collapsed group has the hidden lines as its context group.
- assert.equal(result.groups[1].contextGroups[0].lines.length,
- expectedCollapseSize);
+ assert.equal(
+ result.groups[1].contextGroups[0].lines.length,
+ expectedCollapseSize
+ );
});
test('first', () => {
@@ -901,12 +860,8 @@
lineNums: {left: 10, right: 100},
chunkIndex: 0,
};
- const chunks = [
- {ab: rows},
- {a: ['foo']},
- {a: ['bar']},
- ];
- const result = element._processNext(state, chunks);
+ const chunks = [{ab: rows}, {a: ['foo']}, {a: ['bar']}];
+ const result = element.processNext(state, chunks);
const expectedCollapseSize = rows.length - element.context;
assert.equal(result.groups.length, 2, 'Results in two groups');
@@ -915,8 +870,10 @@
assert.equal(result.groups[1].lines.length, element.context);
// The collapsed group has the hidden lines as its context group.
- assert.equal(result.groups[0].contextGroups[0].lines.length,
- expectedCollapseSize);
+ assert.equal(
+ result.groups[0].contextGroups[0].lines.length,
+ expectedCollapseSize
+ );
});
test('few-rows', () => {
@@ -927,12 +884,8 @@
lineNums: {left: 10, right: 100},
chunkIndex: 0,
};
- const chunks = [
- {ab: rows},
- {a: ['foo']},
- {a: ['bar']},
- ];
- const result = element._processNext(state, chunks);
+ const chunks = [{ab: rows}, {a: ['foo']}, {a: ['bar']}];
+ const result = element.processNext(state, chunks);
// Results in one uncollapsed group with all rows.
assert.equal(result.groups.length, 1, 'Results in one group');
@@ -946,12 +899,8 @@
lineNums: {left: 10, right: 100},
chunkIndex: 1,
};
- const chunks = [
- {a: ['foo']},
- {ab: rows},
- {a: ['bar']},
- ];
- const result = element._processNext(state, chunks);
+ const chunks = [{a: ['foo']}, {ab: rows}, {a: ['bar']}];
+ const result = element.processNext(state, chunks);
// Results in one uncollapsed group with all rows.
assert.equal(result.groups.length, 1, 'Results in one group');
@@ -959,40 +908,39 @@
});
suite('with key location', () => {
- let state;
- let chunks;
+ let state: State;
+ let chunks: DiffContent[];
setup(() => {
state = {
lineNums: {left: 10, right: 100},
+ chunkIndex: 0,
};
element.context = 10;
- chunks = [
- {ab: rows},
- {ab: ['foo'], keyLocation: true},
- {ab: rows},
- ];
+ chunks = [{ab: rows}, {ab: ['foo'], keyLocation: true}, {ab: rows}];
});
test('context before', () => {
state.chunkIndex = 0;
- const result = element._processNext(state, chunks);
+ const result = element.processNext(state, chunks);
// The first chunk is split into two groups:
// 1) A context-control, hiding everything but the context before
// the key location.
// 2) The context before the key location.
- // The key location is not processed in this call to _processNext
+ // The key location is not processed in this call to processNext
assert.equal(result.groups.length, 2);
// The collapsed group has the hidden lines as its context group.
- assert.equal(result.groups[0].contextGroups[0].lines.length,
- rows.length - element.context);
+ assert.equal(
+ result.groups[0].contextGroups[0].lines.length,
+ rows.length - element.context
+ );
assert.equal(result.groups[1].lines.length, element.context);
});
test('key location itself', () => {
state.chunkIndex = 1;
- const result = element._processNext(state, chunks);
+ const result = element.processNext(state, chunks);
// The second chunk results in a single group, that is just the
// line with the key location
@@ -1004,7 +952,7 @@
test('context after', () => {
state.chunkIndex = 2;
- const result = element._processNext(state, chunks);
+ const result = element.processNext(state, chunks);
// The last chunk is split into two groups:
// 1) The context after the key location.
@@ -1013,109 +961,113 @@
assert.equal(result.groups.length, 2);
assert.equal(result.groups[0].lines.length, element.context);
// The collapsed group has the hidden lines as its context group.
- assert.equal(result.groups[1].contextGroups[0].lines.length,
- rows.length - element.context);
+ assert.equal(
+ result.groups[1].contextGroups[0].lines.length,
+ rows.length - element.context
+ );
});
});
});
suite('gr-diff-processor helpers', () => {
- let rows;
+ let rows: string[];
setup(() => {
rows = loremIpsum.split(' ');
});
- test('_linesFromRows', () => {
+ test('linesFromRows', () => {
const startLineNum = 10;
- let result = element._linesFromRows(GrDiffLineType.ADD, rows,
- startLineNum + 1);
+ let result = element.linesFromRows(
+ GrDiffLineType.ADD,
+ rows,
+ startLineNum + 1
+ );
assert.equal(result.length, rows.length);
assert.equal(result[0].type, GrDiffLineType.ADD);
assert.notOk(result[0].hasIntralineInfo);
assert.equal(result[0].afterNumber, startLineNum + 1);
assert.notOk(result[0].beforeNumber);
- assert.equal(result[result.length - 1].afterNumber,
- startLineNum + rows.length);
+ assert.equal(
+ result[result.length - 1].afterNumber,
+ startLineNum + rows.length
+ );
assert.notOk(result[result.length - 1].beforeNumber);
- result = element._linesFromRows(GrDiffLineType.REMOVE, rows,
- startLineNum + 1);
+ result = element.linesFromRows(
+ GrDiffLineType.REMOVE,
+ rows,
+ startLineNum + 1
+ );
assert.equal(result.length, rows.length);
assert.equal(result[0].type, GrDiffLineType.REMOVE);
assert.notOk(result[0].hasIntralineInfo);
assert.equal(result[0].beforeNumber, startLineNum + 1);
assert.notOk(result[0].afterNumber);
- assert.equal(result[result.length - 1].beforeNumber,
- startLineNum + rows.length);
+ assert.equal(
+ result[result.length - 1].beforeNumber,
+ startLineNum + rows.length
+ );
assert.notOk(result[result.length - 1].afterNumber);
});
});
- suite('_breakdown*', () => {
- test('_breakdownChunk breaks down additions', () => {
- sinon.spy(element, '_breakdown');
+ suite('breakdown*', () => {
+ test('breakdownChunk breaks down additions', () => {
+ const breakdownSpy = sinon.spy(element, 'breakdown');
const chunk = {b: ['blah', 'blah', 'blah']};
- const result = element._breakdownChunk(chunk);
+ const result = element.breakdownChunk(chunk);
assert.deepEqual(result, [chunk]);
- assert.isTrue(element._breakdown.called);
+ assert.isTrue(breakdownSpy.called);
});
- test('_breakdownChunk keeps due_to_rebase for broken down additions',
- () => {
- sinon.spy(element, '_breakdown');
- const chunk = {b: ['blah', 'blah', 'blah'], due_to_rebase: true};
- const result = element._breakdownChunk(chunk);
- for (const subResult of result) {
- assert.isTrue(subResult.due_to_rebase);
- }
- });
+ test('breakdownChunk keeps due_to_rebase for broken down additions', () => {
+ sinon.spy(element, 'breakdown');
+ const chunk = {b: ['blah', 'blah', 'blah'], due_to_rebase: true};
+ const result = element.breakdownChunk(chunk);
+ for (const subResult of result) {
+ assert.isTrue(subResult.due_to_rebase);
+ }
+ });
- test('_breakdown common case', () => {
- const array = 'Lorem ipsum dolor sit amet, suspendisse inceptos'
- .split(' ');
+ test('breakdown common case', () => {
+ const array = 'Lorem ipsum dolor sit amet, suspendisse inceptos'.split(
+ ' '
+ );
const size = 3;
- const result = element._breakdown(array, size);
+ const result = element.breakdown(array, size);
for (const subResult of result) {
assert.isAtMost(subResult.length, size);
}
- const flattened = result
- .reduce((a, b) => a.concat(b), []);
+ const flattened = result.reduce((a, b) => a.concat(b), []);
assert.deepEqual(flattened, array);
});
- test('_breakdown smaller than size', () => {
- const array = 'Lorem ipsum dolor sit amet, suspendisse inceptos'
- .split(' ');
+ test('breakdown smaller than size', () => {
+ const array = 'Lorem ipsum dolor sit amet, suspendisse inceptos'.split(
+ ' '
+ );
const size = 10;
const expected = [array];
- const result = element._breakdown(array, size);
+ const result = element.breakdown(array, size);
assert.deepEqual(result, expected);
});
- test('_breakdown empty', () => {
- const array = [];
+ test('breakdown empty', () => {
+ const array: string[] = [];
const size = 10;
- const expected = [];
+ const expected: string[][] = [];
- const result = element._breakdown(array, size);
+ const result = element.breakdown(array, size);
assert.deepEqual(result, expected);
});
});
});
-
- test('detaching cancels', () => {
- element = basicFixture.instantiate();
- sinon.stub(element, 'cancel');
- element.disconnectedCallback();
- assert(element.cancel.called);
- });
});
-
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection.ts b/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection.ts
index 2665ef0..4bb8cc3 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection.ts
+++ b/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection.ts
@@ -1,39 +1,23 @@
/**
* @license
- * 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.
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
*/
import '../../../styles/shared-styles';
-import {addListener} from '@polymer/polymer/lib/utils/gestures';
-import {dom, EventApi} from '@polymer/polymer/lib/legacy/polymer.dom';
-import {PolymerElement} from '@polymer/polymer/polymer-element';
-import {htmlTemplate} from './gr-diff-selection_html';
import {
normalize,
NormalizedRange,
} from '../gr-diff-highlight/gr-range-normalizer';
import {descendedFromClass, querySelectorAll} from '../../../utils/dom-util';
-import {customElement, property, observe} from '@polymer/decorators';
import {DiffInfo} from '../../../types/diff';
import {Side} from '../../../constants/constants';
-import {GrDiffBuilderElement} from '../gr-diff-builder/gr-diff-builder-element';
import {
getLineElByChild,
getSide,
getSideByLineEl,
isThreadEl,
} from '../gr-diff/gr-diff-utils';
+import {assertIsDefined} from '../../../utils/common-util';
/**
* Possible CSS classes indicating the state of selection. Dynamically added/
@@ -55,49 +39,35 @@
return {left: null, right: null};
}
-@customElement('gr-diff-selection')
-export class GrDiffSelection extends PolymerElement {
- static get template() {
- return htmlTemplate;
- }
-
- @property({type: Object})
+export class GrDiffSelection {
+ // visible for testing
diff?: DiffInfo;
- @property({type: Object})
- _cachedDiffBuilder?: GrDiffBuilderElement;
+ // visible for testing
+ diffTable?: HTMLElement;
- @property({type: Object})
- _linesCache: LinesCache = {left: null, right: null};
+ // visible for testing
+ linesCache: LinesCache = getNewCache();
- constructor() {
- super();
- this.addEventListener('copy', e => this._handleCopy(e));
- addListener(this, 'down', e => this._handleDown(e));
+ init(diff: DiffInfo, diffTable: HTMLElement) {
+ this.cleanup();
+ this.diff = diff;
+ this.diffTable = diffTable;
+ this.diffTable.classList.add(SelectionClass.RIGHT);
+ this.diffTable.addEventListener('copy', this.handleCopy);
+ this.diffTable.addEventListener('mousedown', this.handleDown);
+ this.linesCache = getNewCache();
}
- override connectedCallback() {
- super.connectedCallback();
- this.classList.add(SelectionClass.RIGHT);
+ cleanup() {
+ if (!this.diffTable) return;
+ this.diffTable.removeEventListener('copy', this.handleCopy);
+ this.diffTable.removeEventListener('mousedown', this.handleDown);
}
- get diffBuilder() {
- if (!this._cachedDiffBuilder) {
- this._cachedDiffBuilder = this.querySelector(
- 'gr-diff-builder'
- ) as GrDiffBuilderElement;
- }
- return this._cachedDiffBuilder;
- }
-
- @observe('diff')
- _diffChanged() {
- this._linesCache = getNewCache();
- }
-
- _handleDownOnRangeComment(node: Element) {
+ handleDownOnRangeComment(node: Element) {
if (isThreadEl(node)) {
- this._setClasses([
+ this.setClasses([
SelectionClass.COMMENT,
getSide(node) === Side.LEFT
? SelectionClass.LEFT
@@ -108,14 +78,13 @@
return false;
}
- _handleDown(e: Event) {
+ handleDown = (e: Event) => {
const target = e.target;
if (!(target instanceof Element)) return;
- // Handle the down event on comment thread in Polymer 2
- const handled = this._handleDownOnRangeComment(target);
+ const handled = this.handleDownOnRangeComment(target);
if (handled) return;
const lineEl = getLineElByChild(target);
- const blameSelected = this._elementDescendedFromClass(target, 'blame');
+ const blameSelected = descendedFromClass(target, 'blame', this.diffTable);
if (!lineEl && !blameSelected) {
return;
}
@@ -125,9 +94,10 @@
if (blameSelected) {
targetClasses.push(SelectionClass.BLAME);
} else if (lineEl) {
- const commentSelected = this._elementDescendedFromClass(
+ const commentSelected = descendedFromClass(
target,
- 'gr-comment'
+ 'gr-comment',
+ this.diffTable
);
const side = getSideByLineEl(lineEl);
@@ -140,60 +110,50 @@
}
}
- this._setClasses(targetClasses);
- }
+ this.setClasses(targetClasses);
+ };
/**
* Set the provided list of classes on the element, to the exclusion of all
* other SelectionClass values.
*/
- _setClasses(targetClasses: string[]) {
+ setClasses(targetClasses: string[]) {
+ if (!this.diffTable) return;
// Remove any selection classes that do not belong.
for (const className of Object.values(SelectionClass)) {
if (!targetClasses.includes(className)) {
- this.classList.remove(className);
+ this.diffTable.classList.remove(className);
}
}
// Add new selection classes iff they are not already present.
- for (const _class of targetClasses) {
- if (!this.classList.contains(_class)) {
- this.classList.add(_class);
+ for (const targetClass of targetClasses) {
+ if (!this.diffTable.classList.contains(targetClass)) {
+ this.diffTable.classList.add(targetClass);
}
}
}
- _getCopyEventTarget(e: Event) {
- return (dom(e) as EventApi).rootTarget;
- }
-
- /**
- * Utility function to determine whether an element is a descendant of
- * another element with the particular className.
- */
- _elementDescendedFromClass(element: Element, className: string) {
- return descendedFromClass(element, className, this.diffBuilder.diffElement);
- }
-
- _handleCopy(e: ClipboardEvent) {
+ handleCopy = (e: ClipboardEvent) => {
let commentSelected = false;
- const target = this._getCopyEventTarget(e);
+ const target = e.composedPath()[0];
if (!(target instanceof Element)) return;
if (target instanceof HTMLTextAreaElement) return;
- if (!this._elementDescendedFromClass(target, 'diff-row')) return;
- if (this.classList.contains(SelectionClass.COMMENT)) {
+ if (!descendedFromClass(target, 'diff-row', this.diffTable)) return;
+ if (!this.diffTable) return;
+ if (this.diffTable.classList.contains(SelectionClass.COMMENT)) {
commentSelected = true;
}
const lineEl = getLineElByChild(target);
if (!lineEl) return;
const side = getSideByLineEl(lineEl);
- const text = this._getSelectedText(side, commentSelected);
+ const text = this.getSelectedText(side, commentSelected);
if (text && e.clipboardData) {
e.clipboardData.setData('Text', text);
e.preventDefault();
}
- }
+ };
- _getSelection() {
+ getSelection() {
const diffHosts = querySelectorAll(document.body, 'gr-diff');
if (!diffHosts.length) return document.getSelection();
@@ -219,13 +179,13 @@
* @param commentSelected Whether or not a comment is selected.
* @return The selected text.
*/
- _getSelectedText(side: Side, commentSelected: boolean) {
- const sel = this._getSelection();
+ getSelectedText(side: Side, commentSelected: boolean) {
+ const sel = this.getSelection();
if (!sel || sel.rangeCount !== 1) {
return ''; // No multi-select support yet.
}
if (commentSelected) {
- return this._getCommentLines(sel, side);
+ return this.getCommentLines(sel, side);
}
const range = normalize(sel.getRangeAt(0));
const startLineEl = getLineElByChild(range.startContainer);
@@ -250,7 +210,7 @@
if (endLineDataValue) endLineNum = Number(endLineDataValue);
}
- return this._getRangeFromDiff(
+ return this.getRangeFromDiff(
startLineNum,
range.startOffset,
endLineNum,
@@ -262,7 +222,7 @@
/**
* Query the diff object for the selected lines.
*/
- _getRangeFromDiff(
+ getRangeFromDiff(
startLineNum: number,
startOffset: number,
endLineNum: number | undefined,
@@ -274,7 +234,7 @@
startLineNum -= skipChunk.skip!;
if (endLineNum) endLineNum -= skipChunk.skip!;
}
- const lines = this._getDiffLines(side).slice(startLineNum - 1, endLineNum);
+ const lines = this.getDiffLines(side).slice(startLineNum - 1, endLineNum);
if (lines.length) {
lines[lines.length - 1] = lines[lines.length - 1].substring(0, endOffset);
lines[0] = lines[0].substring(startOffset);
@@ -288,9 +248,9 @@
* @param side The side that is currently selected.
* @return An array of strings indexed by line number.
*/
- _getDiffLines(side: Side): string[] {
- if (this._linesCache[side]) {
- return this._linesCache[side]!;
+ getDiffLines(side: Side): string[] {
+ if (this.linesCache[side]) {
+ return this.linesCache[side]!;
}
if (!this.diff) return [];
let lines: string[] = [];
@@ -303,7 +263,7 @@
lines = lines.concat(chunk.b);
}
}
- this._linesCache[side] = lines;
+ this.linesCache[side] = lines;
return lines;
}
@@ -315,11 +275,11 @@
* @param side The side that is currently selected.
* @return The selected comment text.
*/
- _getCommentLines(sel: Selection, side: Side) {
+ getCommentLines(sel: Selection, side: Side) {
const range = normalize(sel.getRangeAt(0));
const content = [];
- // Query the diffElement for comments.
- const messages = this.diffBuilder.diffElement.querySelectorAll(
+ assertIsDefined(this.diffTable, 'diffTable');
+ const messages = this.diffTable.querySelectorAll(
`.side-by-side [data-side="${side}"] .message *, .unified .message *`
);
@@ -339,9 +299,9 @@
if (
el.id === 'output' &&
- !this._elementDescendedFromClass(el, 'collapsed')
+ !descendedFromClass(el, 'collapsed', this.diffTable)
) {
- content.push(this._getTextContentForRange(el, sel, range));
+ content.push(this.getTextContentForRange(el, sel, range));
}
}
}
@@ -359,7 +319,7 @@
* @param range The normalized selection range.
* @return The text within the selection.
*/
- _getTextContentForRange(
+ getTextContentForRange(
domNode: Node,
sel: Selection,
range: NormalizedRange
@@ -379,15 +339,9 @@
}
} else {
for (const childNode of domNode.childNodes) {
- text += this._getTextContentForRange(childNode, sel, range);
+ text += this.getTextContentForRange(childNode, sel, range);
}
}
return text;
}
}
-
-declare global {
- interface HTMLElementTagNameMap {
- 'gr-diff-selection': GrDiffSelection;
- }
-}
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_html.ts b/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_html.ts
deleted file mode 100644
index bd0e034..0000000
--- a/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_html.ts
+++ /dev/null
@@ -1,23 +0,0 @@
-/**
- * @license
- * 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.
- */
-import {html} from '@polymer/polymer/lib/utils/html-tag';
-
-export const htmlTemplate = html`
- <div class="contentWrapper">
- <slot></slot>
- </div>
-`;
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_test.js b/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_test.js
deleted file mode 100644
index 15454f9..0000000
--- a/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_test.js
+++ /dev/null
@@ -1,389 +0,0 @@
-/**
- * @license
- * 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.
- */
-import '../../../test/common-test-setup-karma.js';
-import './gr-diff-selection.js';
-import {html} from '@polymer/polymer/lib/utils/html-tag.js';
-
-// Splitting long lines in html into shorter rows breaks tests:
-// zero-length text nodes and new lines are not expected in some places
-/* eslint-disable max-len */
-const basicFixture = fixtureFromTemplate(html`
-<gr-diff-selection>
- <table id="diffTable" class="side-by-side">
- <tr class="diff-row">
- <td class="blame" data-line-number="1"></td>
- <td class="lineNum left" data-value="1">1</td>
- <td class="content">
- <div class="contentText" data-side="left">ba ba</div>
- <div data-side="left">
- <div class="comment-thread">
- <div class="gr-formatted-text message">
- <span id="output" class="gr-linked-text">This is a comment</span>
- </div>
- </div>
- </div>
- </td>
- <td class="lineNum right" data-value="1">1</td>
- <td class="content">
- <div class="contentText" data-side="right">some other text</div>
- </td>
- </tr>
- <tr class="diff-row">
- <td class="blame" data-line-number="2"></td>
- <td class="lineNum left" data-value="2">2</td>
- <td class="content">
- <div class="contentText" data-side="left">zin</div>
- </td>
- <td class="lineNum right" data-value="2">2</td>
- <td class="content">
- <div class="contentText" data-side="right">more more more</div>
- <div data-side="right">
- <div class="comment-thread">
- <div class="gr-formatted-text message">
- <span id="output" class="gr-linked-text">This is a comment on the right</span>
- </div>
- </div>
- </div>
- </td>
- </tr>
- <tr class="diff-row">
- <td class="blame" data-line-number="3"></td>
- <td class="lineNum left" data-value="3">3</td>
- <td class="content">
- <div class="contentText" data-side="left">ga ga</div>
- <div data-side="left">
- <div class="comment-thread">
- <div class="gr-formatted-text message">
- <span id="output" class="gr-linked-text">This is <a>a</a> different comment 💩 unicode is fun</span>
- </div>
- </div>
- </div>
- </td>
- <td class="lineNum right" data-value="3">3</td>
- </tr>
- <tr class="diff-row">
- <td class="blame" data-line-number="4"></td>
- <td class="lineNum left" data-value="4">4</td>
- <td class="content">
- <div class="contentText" data-side="left">ga ga</div>
- <div data-side="left">
- <div class="comment-thread">
- <textarea data-side="right">test for textarea copying</textarea>
- </div>
- </div>
- </td>
- <td class="lineNum right" data-value="4">4</td>
- </tr>
- <tr class="not-diff-row">
- <td class="other">
- <div class="contentText" data-side="right">some other text</div>
- </td>
- </tr>
- </table>
- </gr-diff-selection>
-`);
-/* eslint-enable max-len */
-
-suite('gr-diff-selection', () => {
- let element;
-
- const emulateCopyOn = function(target) {
- const fakeEvent = {
- target,
- preventDefault: sinon.stub(),
- clipboardData: {
- setData: sinon.stub(),
- },
- };
- element._getCopyEventTarget.returns(target);
- element._handleCopy(fakeEvent);
- return fakeEvent;
- };
-
- setup(() => {
- element = basicFixture.instantiate();
-
- sinon.stub(element, '_getCopyEventTarget');
- element._cachedDiffBuilder = {
- getLineElByChild: sinon.stub().returns({}),
- getSideByLineEl: sinon.stub(),
- diffElement: element.querySelector('#diffTable'),
- };
- element.diff = {
- content: [
- {
- a: ['ba ba'],
- b: ['some other text'],
- },
- {
- a: ['zin'],
- b: ['more more more'],
- },
- {
- a: ['ga ga'],
- b: ['some other text'],
- },
- ],
- };
- });
-
- test('applies selected-left on left side click', () => {
- element.classList.add('selected-right');
- const lineNumberEl = element.querySelector('.lineNum.left');
- MockInteractions.down(lineNumberEl);
- assert.isTrue(
- element.classList.contains('selected-left'), 'adds selected-left');
- assert.isFalse(
- element.classList.contains('selected-right'),
- 'removes selected-right');
- });
-
- test('applies selected-right on right side click', () => {
- element.classList.add('selected-left');
- const lineNumberEl = element.querySelector('.lineNum.right');
- MockInteractions.down(lineNumberEl);
- assert.isTrue(
- element.classList.contains('selected-right'), 'adds selected-right');
- assert.isFalse(
- element.classList.contains('selected-left'), 'removes selected-left');
- });
-
- test('applies selected-blame on blame click', () => {
- element.classList.add('selected-left');
- element.diffBuilder.getLineElByChild.returns(null);
- sinon.stub(element, '_elementDescendedFromClass').callsFake(
- (el, className) => className === 'blame');
- MockInteractions.down(element);
- assert.isTrue(
- element.classList.contains('selected-blame'), 'adds selected-right');
- assert.isFalse(
- element.classList.contains('selected-left'), 'removes selected-left');
- });
-
- test('ignores copy for non-content Element', () => {
- sinon.stub(element, '_getSelectedText');
- emulateCopyOn(element.querySelector('.not-diff-row'));
- assert.isFalse(element._getSelectedText.called);
- });
-
- test('asks for text for left side Elements', () => {
- element._cachedDiffBuilder.getSideByLineEl.returns('left');
- sinon.stub(element, '_getSelectedText');
- emulateCopyOn(element.querySelector('div.contentText'));
- assert.deepEqual(['left', false], element._getSelectedText.lastCall.args);
- });
-
- test('reacts to copy for content Elements', () => {
- sinon.stub(element, '_getSelectedText');
- emulateCopyOn(element.querySelector('div.contentText'));
- assert.isTrue(element._getSelectedText.called);
- });
-
- test('copy event is prevented for content Elements', () => {
- sinon.stub(element, '_getSelectedText');
- element._cachedDiffBuilder.getSideByLineEl.returns('left');
- element._getSelectedText.returns('test');
- const event = emulateCopyOn(element.querySelector('div.contentText'));
- assert.isTrue(event.preventDefault.called);
- });
-
- test('inserts text into clipboard on copy', () => {
- sinon.stub(element, '_getSelectedText').returns('the text');
- const event = emulateCopyOn(element.querySelector('div.contentText'));
- assert.deepEqual(
- ['Text', 'the text'], event.clipboardData.setData.lastCall.args);
- });
-
- test('_setClasses adds given SelectionClass values, removes others', () => {
- element.classList.add('selected-right');
- element._setClasses(['selected-comment', 'selected-left']);
- assert.isTrue(element.classList.contains('selected-comment'));
- assert.isTrue(element.classList.contains('selected-left'));
- assert.isFalse(element.classList.contains('selected-right'));
- assert.isFalse(element.classList.contains('selected-blame'));
-
- element._setClasses(['selected-blame']);
- assert.isFalse(element.classList.contains('selected-comment'));
- assert.isFalse(element.classList.contains('selected-left'));
- assert.isFalse(element.classList.contains('selected-right'));
- assert.isTrue(element.classList.contains('selected-blame'));
- });
-
- test('_setClasses removes before it ads', () => {
- element.classList.add('selected-right');
- const addStub = sinon.stub(element.classList, 'add');
- const removeStub = sinon.stub(element.classList, 'remove').callsFake(
- () => {
- assert.isFalse(addStub.called);
- });
- element._setClasses(['selected-comment', 'selected-left']);
- assert.isTrue(addStub.called);
- assert.isTrue(removeStub.called);
- });
-
- test('copies content correctly', () => {
- // Fetch the line number.
- element._cachedDiffBuilder.getLineElByChild = function(child) {
- while (!child.classList.contains('content') && child.parentElement) {
- child = child.parentElement;
- }
- return child.previousElementSibling;
- };
-
- element.classList.add('selected-left');
- element.classList.remove('selected-right');
-
- const selection = document.getSelection();
- selection.removeAllRanges();
- const range = document.createRange();
- range.setStart(element.querySelector('div.contentText').firstChild, 3);
- range.setEnd(
- element.querySelectorAll('div.contentText')[4].firstChild, 2);
- selection.addRange(range);
- assert.equal(element._getSelectedText('left'), 'ba\nzin\nga');
- });
-
- test('copies comments', () => {
- element.classList.add('selected-left');
- element.classList.add('selected-comment');
- element.classList.remove('selected-right');
- const selection = document.getSelection();
- selection.removeAllRanges();
- const range = document.createRange();
- range.setStart(
- element.querySelector('.gr-formatted-text *').firstChild, 3);
- range.setEnd(
- element.querySelectorAll('.gr-formatted-text *')[2].childNodes[2], 7);
- selection.addRange(range);
- assert.equal('s is a comment\nThis is a differ',
- element._getSelectedText('left', true));
- });
-
- test('respects astral chars in comments', () => {
- element.classList.add('selected-left');
- element.classList.add('selected-comment');
- element.classList.remove('selected-right');
- const selection = document.getSelection();
- selection.removeAllRanges();
- const range = document.createRange();
- const nodes = element.querySelectorAll('.gr-formatted-text *');
- range.setStart(nodes[2].childNodes[2], 13);
- range.setEnd(nodes[2].childNodes[2], 23);
- selection.addRange(range);
- assert.equal('mment 💩 u',
- element._getSelectedText('left', true));
- });
-
- test('defers to default behavior for textarea', () => {
- element.classList.add('selected-left');
- element.classList.remove('selected-right');
- const selectedTextSpy = sinon.spy(element, '_getSelectedText');
- emulateCopyOn(element.querySelector('textarea'));
- assert.isFalse(selectedTextSpy.called);
- });
-
- test('regression test for 4794', () => {
- element._cachedDiffBuilder.getLineElByChild = function(child) {
- while (!child.classList.contains('content') && child.parentElement) {
- child = child.parentElement;
- }
- return child.previousElementSibling;
- };
-
- element.classList.add('selected-right');
- element.classList.remove('selected-left');
-
- const selection = document.getSelection();
- selection.removeAllRanges();
- const range = document.createRange();
- range.setStart(
- element.querySelectorAll('div.contentText')[1].firstChild, 4);
- range.setEnd(
- element.querySelectorAll('div.contentText')[1].firstChild, 10);
- selection.addRange(range);
- assert.equal(element._getSelectedText('right'), ' other');
- });
-
- test('copies to end of side (issue 7895)', () => {
- element._cachedDiffBuilder.getLineElByChild = function(child) {
- // Return null for the end container.
- if (child.textContent === 'ga ga') { return null; }
- while (!child.classList.contains('content') && child.parentElement) {
- child = child.parentElement;
- }
- return child.previousElementSibling;
- };
- element.classList.add('selected-left');
- element.classList.remove('selected-right');
- const selection = document.getSelection();
- selection.removeAllRanges();
- const range = document.createRange();
- range.setStart(element.querySelector('div.contentText').firstChild, 3);
- range.setEnd(
- element.querySelectorAll('div.contentText')[4].firstChild, 2);
- selection.addRange(range);
- assert.equal(element._getSelectedText('left'), 'ba\nzin\nga');
- });
-
- suite('_getTextContentForRange', () => {
- let selection;
- let range;
- let nodes;
-
- setup(() => {
- element.classList.add('selected-left');
- element.classList.add('selected-comment');
- element.classList.remove('selected-right');
- selection = document.getSelection();
- selection.removeAllRanges();
- range = document.createRange();
- nodes = element.querySelectorAll('.gr-formatted-text *');
- });
-
- test('multi level element contained in range', () => {
- range.setStart(nodes[2].childNodes[0], 1);
- range.setEnd(nodes[2].childNodes[2], 7);
- selection.addRange(range);
- assert.equal(element._getTextContentForRange(element, selection, range),
- 'his is a differ');
- });
-
- test('multi level element as startContainer of range', () => {
- range.setStart(nodes[2].childNodes[1], 0);
- range.setEnd(nodes[2].childNodes[2], 7);
- selection.addRange(range);
- assert.equal(element._getTextContentForRange(element, selection, range),
- 'a differ');
- });
-
- test('startContainer === endContainer', () => {
- range.setStart(nodes[0].firstChild, 2);
- range.setEnd(nodes[0].firstChild, 12);
- selection.addRange(range);
- assert.equal(element._getTextContentForRange(element, selection, range),
- 'is is a co');
- });
- });
-
- test('cache is reset when diff changes', () => {
- element._linesCache = {left: 'test', right: 'test'};
- element.diff = {};
- flush();
- assert.deepEqual(element._linesCache, {left: null, right: null});
- });
-});
-
diff --git a/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_test.ts b/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_test.ts
new file mode 100644
index 0000000..b44114a
--- /dev/null
+++ b/polygerrit-ui/app/embed/diff/gr-diff-selection/gr-diff-selection_test.ts
@@ -0,0 +1,390 @@
+/**
+ * @license
+ * Copyright 2016 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import '../../../test/common-test-setup-karma';
+import './gr-diff-selection';
+import {GrDiffSelection} from './gr-diff-selection';
+import {createDiff} from '../../../test/test-data-generators';
+import {DiffInfo, Side} from '../../../api/diff';
+import {GrFormattedText} from '../../../elements/shared/gr-formatted-text/gr-formatted-text';
+import {fixture, html} from '@open-wc/testing-helpers';
+import {mouseDown} from '../../../test/test-utils';
+
+const diffTableTemplate = html`
+ <table id="diffTable" class="side-by-side">
+ <tr class="diff-row">
+ <td class="blame" data-line-number="1"></td>
+ <td class="lineNum left" data-value="1">1</td>
+ <td class="content">
+ <div class="contentText" data-side="left">ba ba</div>
+ <div data-side="left">
+ <div class="comment-thread">
+ <div class="gr-formatted-text message">
+ <span id="output" class="gr-linked-text">This is a comment</span>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td class="lineNum right" data-value="1">1</td>
+ <td class="content">
+ <div class="contentText" data-side="right">some other text</div>
+ </td>
+ </tr>
+ <tr class="diff-row">
+ <td class="blame" data-line-number="2"></td>
+ <td class="lineNum left" data-value="2">2</td>
+ <td class="content">
+ <div class="contentText" data-side="left">zin</div>
+ </td>
+ <td class="lineNum right" data-value="2">2</td>
+ <td class="content">
+ <div class="contentText" data-side="right">more more more</div>
+ <div data-side="right">
+ <div class="comment-thread">
+ <div class="gr-formatted-text message">
+ <span id="output" class="gr-linked-text"
+ >This is a comment on the right</span
+ >
+ </div>
+ </div>
+ </div>
+ </td>
+ </tr>
+ <tr class="diff-row">
+ <td class="blame" data-line-number="3"></td>
+ <td class="lineNum left" data-value="3">3</td>
+ <td class="content">
+ <div class="contentText" data-side="left">ga ga</div>
+ <div data-side="left">
+ <div class="comment-thread">
+ <div class="gr-formatted-text message">
+ <span id="output" class="gr-linked-text"
+ >This is <a>a</a> different comment 💩 unicode is fun</span
+ >
+ </div>
+ </div>
+ </div>
+ </td>
+ <td class="lineNum right" data-value="3">3</td>
+ </tr>
+ <tr class="diff-row">
+ <td class="blame" data-line-number="4"></td>
+ <td class="lineNum left" data-value="4">4</td>
+ <td class="content">
+ <div class="contentText" data-side="left">ga ga</div>
+ <div data-side="left">
+ <div class="comment-thread">
+ <textarea data-side="right">test for textarea copying</textarea>
+ </div>
+ </div>
+ </td>
+ <td class="lineNum right" data-value="4">4</td>
+ </tr>
+ <tr class="not-diff-row">
+ <td class="other">
+ <div class="contentText" data-side="right">some other text</div>
+ </td>
+ </tr>
+ </table>
+`;
+
+suite('gr-diff-selection', () => {
+ let element: GrDiffSelection;
+ let diffTable: HTMLTableElement;
+
+ const emulateCopyOn = function (target: HTMLElement | null) {
+ const fakeEvent = {
+ target,
+ preventDefault: sinon.stub(),
+ composedPath() {
+ return [target];
+ },
+ clipboardData: {
+ setData: sinon.stub(),
+ },
+ };
+ element.handleCopy(fakeEvent as unknown as ClipboardEvent);
+ return fakeEvent;
+ };
+
+ setup(async () => {
+ element = new GrDiffSelection();
+ diffTable = await fixture<HTMLTableElement>(diffTableTemplate);
+
+ const diff: DiffInfo = {
+ ...createDiff(),
+ content: [
+ {
+ a: ['ba ba'],
+ b: ['some other text'],
+ },
+ {
+ a: ['zin'],
+ b: ['more more more'],
+ },
+ {
+ a: ['ga ga'],
+ b: ['some other text'],
+ },
+ ],
+ };
+ element.init(diff, diffTable);
+ });
+
+ test('applies selected-left on left side click', () => {
+ element.diffTable!.classList.add('selected-right');
+ const lineNumberEl = diffTable.querySelector<HTMLElement>('.lineNum.left');
+ if (!lineNumberEl) assert.fail('line number element missing');
+ mouseDown(lineNumberEl);
+ assert.isTrue(
+ element.diffTable!.classList.contains('selected-left'),
+ 'adds selected-left'
+ );
+ assert.isFalse(
+ element.diffTable!.classList.contains('selected-right'),
+ 'removes selected-right'
+ );
+ });
+
+ test('applies selected-right on right side click', () => {
+ element.diffTable!.classList.add('selected-left');
+ const lineNumberEl = diffTable.querySelector<HTMLElement>('.lineNum.right');
+ if (!lineNumberEl) assert.fail('line number element missing');
+ mouseDown(lineNumberEl);
+ assert.isTrue(
+ element.diffTable!.classList.contains('selected-right'),
+ 'adds selected-right'
+ );
+ assert.isFalse(
+ element.diffTable!.classList.contains('selected-left'),
+ 'removes selected-left'
+ );
+ });
+
+ test('applies selected-blame on blame click', () => {
+ element.diffTable!.classList.add('selected-left');
+ const blameDiv = document.createElement('div');
+ blameDiv.classList.add('blame');
+ element.diffTable!.appendChild(blameDiv);
+ mouseDown(blameDiv);
+ assert.isTrue(
+ element.diffTable!.classList.contains('selected-blame'),
+ 'adds selected-right'
+ );
+ assert.isFalse(
+ element.diffTable!.classList.contains('selected-left'),
+ 'removes selected-left'
+ );
+ });
+
+ test('ignores copy for non-content Element', () => {
+ const getSelectedTextStub = sinon.stub(element, 'getSelectedText');
+ emulateCopyOn(diffTable.querySelector('.not-diff-row'));
+ assert.isFalse(getSelectedTextStub.called);
+ });
+
+ test('asks for text for left side Elements', () => {
+ const getSelectedTextStub = sinon.stub(element, 'getSelectedText');
+ emulateCopyOn(diffTable.querySelector('div.contentText'));
+ assert.deepEqual([Side.LEFT, false], getSelectedTextStub.lastCall.args);
+ });
+
+ test('reacts to copy for content Elements', () => {
+ const getSelectedTextStub = sinon.stub(element, 'getSelectedText');
+ emulateCopyOn(diffTable.querySelector('div.contentText'));
+ assert.isTrue(getSelectedTextStub.called);
+ });
+
+ test('copy event is prevented for content Elements', () => {
+ const getSelectedTextStub = sinon.stub(element, 'getSelectedText');
+ getSelectedTextStub.returns('test');
+ const event = emulateCopyOn(diffTable.querySelector('div.contentText'));
+ assert.isTrue(event.preventDefault.called);
+ });
+
+ test('inserts text into clipboard on copy', () => {
+ sinon.stub(element, 'getSelectedText').returns('the text');
+ const event = emulateCopyOn(diffTable.querySelector('div.contentText'));
+ assert.deepEqual(
+ ['Text', 'the text'],
+ event.clipboardData.setData.lastCall.args
+ );
+ });
+
+ test('setClasses adds given SelectionClass values, removes others', () => {
+ element.diffTable!.classList.add('selected-right');
+ element.setClasses(['selected-comment', 'selected-left']);
+ assert.isTrue(element.diffTable!.classList.contains('selected-comment'));
+ assert.isTrue(element.diffTable!.classList.contains('selected-left'));
+ assert.isFalse(element.diffTable!.classList.contains('selected-right'));
+ assert.isFalse(element.diffTable!.classList.contains('selected-blame'));
+
+ element.setClasses(['selected-blame']);
+ assert.isFalse(element.diffTable!.classList.contains('selected-comment'));
+ assert.isFalse(element.diffTable!.classList.contains('selected-left'));
+ assert.isFalse(element.diffTable!.classList.contains('selected-right'));
+ assert.isTrue(element.diffTable!.classList.contains('selected-blame'));
+ });
+
+ test('setClasses removes before it ads', () => {
+ element.diffTable!.classList.add('selected-right');
+ const addStub = sinon.stub(element.diffTable!.classList, 'add');
+ const removeStub = sinon
+ .stub(element.diffTable!.classList, 'remove')
+ .callsFake(() => {
+ assert.isFalse(addStub.called);
+ });
+ element.setClasses(['selected-comment', 'selected-left']);
+ assert.isTrue(addStub.called);
+ assert.isTrue(removeStub.called);
+ });
+
+ test('copies content correctly', () => {
+ element.diffTable!.classList.add('selected-left');
+ element.diffTable!.classList.remove('selected-right');
+
+ const selection = document.getSelection();
+ if (selection === null) assert.fail('no selection');
+ selection.removeAllRanges();
+ const range = document.createRange();
+ range.setStart(diffTable.querySelector('div.contentText')!.firstChild!, 3);
+ range.setEnd(
+ diffTable.querySelectorAll('div.contentText')[4]!.firstChild!,
+ 2
+ );
+ selection.addRange(range);
+ assert.equal(element.getSelectedText(Side.LEFT, false), 'ba\nzin\nga');
+ });
+
+ test('copies comments', () => {
+ element.diffTable!.classList.add('selected-left');
+ element.diffTable!.classList.add('selected-comment');
+ element.diffTable!.classList.remove('selected-right');
+ const selection = document.getSelection();
+ if (selection === null) assert.fail('no selection');
+ selection.removeAllRanges();
+ const range = document.createRange();
+ range.setStart(
+ diffTable.querySelector('.gr-formatted-text *')!.firstChild!,
+ 3
+ );
+ range.setEnd(
+ diffTable.querySelectorAll('.gr-formatted-text *')[2].childNodes[2],
+ 7
+ );
+ selection.addRange(range);
+ assert.equal(
+ 's is a comment\nThis is a differ',
+ element.getSelectedText(Side.LEFT, true)
+ );
+ });
+
+ test('respects astral chars in comments', () => {
+ element.diffTable!.classList.add('selected-left');
+ element.diffTable!.classList.add('selected-comment');
+ element.diffTable!.classList.remove('selected-right');
+ const selection = document.getSelection();
+ if (selection === null) assert.fail('no selection');
+ selection.removeAllRanges();
+ const range = document.createRange();
+ const nodes = diffTable.querySelectorAll('.gr-formatted-text *');
+ range.setStart(nodes[2].childNodes[2], 13);
+ range.setEnd(nodes[2].childNodes[2], 23);
+ selection.addRange(range);
+ assert.equal('mment 💩 u', element.getSelectedText(Side.LEFT, true));
+ });
+
+ test('defers to default behavior for textarea', () => {
+ element.diffTable!.classList.add('selected-left');
+ element.diffTable!.classList.remove('selected-right');
+ const selectedTextSpy = sinon.spy(element, 'getSelectedText');
+ emulateCopyOn(diffTable.querySelector('textarea'));
+ assert.isFalse(selectedTextSpy.called);
+ });
+
+ test('regression test for 4794', () => {
+ element.diffTable!.classList.add('selected-right');
+ element.diffTable!.classList.remove('selected-left');
+
+ const selection = document.getSelection();
+ if (!selection) assert.fail('no selection');
+ selection.removeAllRanges();
+ const range = document.createRange();
+ range.setStart(
+ diffTable.querySelectorAll('div.contentText')[1]!.firstChild!,
+ 4
+ );
+ range.setEnd(
+ diffTable.querySelectorAll('div.contentText')[1]!.firstChild!,
+ 10
+ );
+ selection.addRange(range);
+ assert.equal(element.getSelectedText(Side.RIGHT, false), ' other');
+ });
+
+ test('copies to end of side (issue 7895)', () => {
+ element.diffTable!.classList.add('selected-left');
+ element.diffTable!.classList.remove('selected-right');
+ const selection = document.getSelection();
+ if (selection === null) assert.fail('no selection');
+ selection.removeAllRanges();
+ const range = document.createRange();
+ range.setStart(diffTable.querySelector('div.contentText')!.firstChild!, 3);
+ range.setEnd(
+ diffTable.querySelectorAll('div.contentText')[4]!.firstChild!,
+ 2
+ );
+ selection.addRange(range);
+ assert.equal(element.getSelectedText(Side.LEFT, false), 'ba\nzin\nga');
+ });
+
+ suite('getTextContentForRange', () => {
+ let selection: Selection;
+ let range: Range;
+ let nodes: NodeListOf<GrFormattedText>;
+
+ setup(() => {
+ element.diffTable!.classList.add('selected-left');
+ element.diffTable!.classList.add('selected-comment');
+ element.diffTable!.classList.remove('selected-right');
+ const s = document.getSelection();
+ if (s === null) assert.fail('no selection');
+ selection = s;
+ selection.removeAllRanges();
+ range = document.createRange();
+ nodes = diffTable.querySelectorAll('.gr-formatted-text *');
+ });
+
+ test('multi level element contained in range', () => {
+ range.setStart(nodes[2].childNodes[0], 1);
+ range.setEnd(nodes[2].childNodes[2], 7);
+ selection.addRange(range);
+ assert.equal(
+ element.getTextContentForRange(diffTable, selection, range),
+ 'his is a differ'
+ );
+ });
+
+ test('multi level element as startContainer of range', () => {
+ range.setStart(nodes[2].childNodes[1], 0);
+ range.setEnd(nodes[2].childNodes[2], 7);
+ selection.addRange(range);
+ assert.equal(
+ element.getTextContentForRange(diffTable, selection, range),
+ 'a differ'
+ );
+ });
+
+ test('startContainer === endContainer', () => {
+ range.setStart(nodes[0].firstChild!, 2);
+ range.setEnd(nodes[0].firstChild!, 12);
+ selection.addRange(range);
+ assert.equal(
+ element.getTextContentForRange(diffTable, selection, range),
+ 'is is a co'
+ );
+ });
+ });
+});
diff --git a/polygerrit-ui/app/embed/diff/gr-diff/gr-diff.ts b/polygerrit-ui/app/embed/diff/gr-diff/gr-diff.ts
index a38ec91..34c2a33 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff/gr-diff.ts
+++ b/polygerrit-ui/app/embed/diff/gr-diff/gr-diff.ts
@@ -80,6 +80,7 @@
import {isSafari, toggleClass} from '../../../utils/dom-util';
import {assertIsDefined} from '../../../utils/common-util';
import {debounce, DelayedTask} from '../../../utils/async-util';
+import {GrDiffSelection} from '../gr-diff-selection/gr-diff-selection';
const NO_NEWLINE_LEFT = 'No newline at end of left file.';
const NO_NEWLINE_RIGHT = 'No newline at end of right file.';
@@ -99,7 +100,6 @@
export interface GrDiff {
$: {
- highlights: GrDiffHighlight;
diffBuilder: GrDiffBuilderElement;
diffTable: HTMLTableElement;
};
@@ -294,6 +294,10 @@
private renderDiffTableTask?: DelayedTask;
+ private diffSelection = new GrDiffSelection();
+
+ private highlights = new GrDiffHighlight();
+
constructor() {
super();
this._setLoading(true);
@@ -315,6 +319,8 @@
this.renderDiffTableTask?.cancel();
this._unobserveIncrementalNodes();
this._unobserveNodes();
+ this.diffSelection.cleanup();
+ this.highlights.cleanup();
super.disconnectedCallback();
}
@@ -357,7 +363,7 @@
// and pass the shadow DOM selection into gr-diff-highlight, where the
// corresponding range is determined and normalized.
const selection = this._getShadowOrDocumentSelection();
- this.$.highlights.handleSelectionChange(selection, false);
+ this.highlights.handleSelectionChange(selection, false);
};
private readonly handleMouseUp = () => {
@@ -365,7 +371,7 @@
// mouse-up if there's a selection that just covers a line change. We
// can't do that on selection change since the user may still be dragging.
const selection = this._getShadowOrDocumentSelection();
- this.$.highlights.handleSelectionChange(selection, true);
+ this.highlights.handleSelectionChange(selection, true);
};
/** Gets the current selection, preferring the shadow DOM selection. */
@@ -404,7 +410,7 @@
const range = getRange(threadEl);
if (!range) return undefined;
- return {side, range, hovering: false, rootId: threadEl.rootId};
+ return {side, range, rootId: threadEl.rootId};
}
// TODO(brohlfs): Rewrite `.map().filter() as ...` with `.reduce()` instead.
@@ -430,7 +436,6 @@
this.push('_commentRanges', {
side: Side.RIGHT,
range: this.highlightRange,
- hovering: true,
rootId: '',
});
}
@@ -498,7 +503,7 @@
}
isRangeSelected() {
- return !!this.$.highlights.selectedRange;
+ return !!this.highlights.selectedRange;
}
toggleLeftDiff() {
@@ -590,7 +595,7 @@
if (!this.isRangeSelected()) {
throw Error('Selection is needed for new range comment');
}
- const selectedRange = this.$.highlights.selectedRange;
+ const selectedRange = this.highlights.selectedRange;
if (!selectedRange) throw Error('selected range not set');
const {side, range} = selectedRange;
this._createCommentForSelection(side, range);
@@ -813,6 +818,10 @@
this._diffLength = this.getDiffLength(newValue);
this._debounceRenderDiffTable();
}
+ if (this.diff) {
+ this.diffSelection.init(this.diff, this.$.diffTable);
+ this.highlights.init(this.$.diffTable, this.$.diffBuilder);
+ }
}
/**
diff --git a/polygerrit-ui/app/embed/diff/gr-diff/gr-diff_html.ts b/polygerrit-ui/app/embed/diff/gr-diff/gr-diff_html.ts
index e05e85a..6d36b89 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff/gr-diff_html.ts
+++ b/polygerrit-ui/app/embed/diff/gr-diff/gr-diff_html.ts
@@ -487,6 +487,10 @@
color: var(--link-color);
padding: var(--spacing-m) 0 var(--spacing-m) 48px;
}
+ #diffTable {
+ /* for gr-selection-action-box positioning */
+ position: relative;
+ }
#diffTable:focus {
outline: none;
}
@@ -670,6 +674,14 @@
.token-highlight {
background-color: var(--token-highlighting-color, #fffd54);
}
+
+ gr-selection-action-box {
+ /**
+ * Needs z-index to appear above wrapped content, since it's inserted
+ * into DOM before it.
+ */
+ z-index: 10;
+ }
</style>
<style include="gr-syntax-theme">
/* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
@@ -686,44 +698,36 @@
class$="[[_computeContainerClass(loggedIn, viewMode, displayLine)]]"
on-click="_handleTap"
>
- <gr-diff-selection diff="[[diff]]">
- <gr-diff-highlight
- id="highlights"
- logged-in="[[loggedIn]]"
- comment-ranges="{{_commentRanges}}"
- >
- <gr-diff-builder
- id="diffBuilder"
- comment-ranges="[[_commentRanges]]"
- coverage-ranges="[[coverageRanges]]"
- diff="[[diff]]"
- path="[[path]]"
- view-mode="[[viewMode]]"
- is-image-diff="[[isImageDiff]]"
- base-image="[[baseImage]]"
- layers="[[layers]]"
- revision-image="[[revisionImage]]"
- use-new-image-diff-ui="[[useNewImageDiffUi]]"
- >
- <table
- id="diffTable"
- class$="[[_diffTableClass]]"
- role="presentation"
- contenteditable$="[[isContentEditable]]"
- ></table>
+ <gr-diff-builder
+ id="diffBuilder"
+ comment-ranges="[[_commentRanges]]"
+ coverage-ranges="[[coverageRanges]]"
+ diff="[[diff]]"
+ path="[[path]]"
+ view-mode="[[viewMode]]"
+ is-image-diff="[[isImageDiff]]"
+ base-image="[[baseImage]]"
+ layers="[[layers]]"
+ revision-image="[[revisionImage]]"
+ use-new-image-diff-ui="[[useNewImageDiffUi]]"
+ >
+ <table
+ id="diffTable"
+ class$="[[_diffTableClass]]"
+ role="presentation"
+ contenteditable$="[[isContentEditable]]"
+ ></table>
- <template
- is="dom-if"
- if="[[showNoChangeMessage(_loading, prefs, _diffLength, diff)]]"
- >
- <div class="whitespace-change-only-message">
- This file only contains whitespace changes. Modify the whitespace
- setting to see the changes.
- </div>
- </template>
- </gr-diff-builder>
- </gr-diff-highlight>
- </gr-diff-selection>
+ <template
+ is="dom-if"
+ if="[[showNoChangeMessage(_loading, prefs, _diffLength, diff)]]"
+ >
+ <div class="whitespace-change-only-message">
+ This file only contains whitespace changes. Modify the whitespace
+ setting to see the changes.
+ </div>
+ </template>
+ </gr-diff-builder>
</div>
<div class$="[[_computeNewlineWarningClass(_newlineWarning, _loading)]]">
[[_newlineWarning]]
diff --git a/polygerrit-ui/app/embed/diff/gr-diff/gr-diff_test.js b/polygerrit-ui/app/embed/diff/gr-diff/gr-diff_test.js
index 714005e..c8d8a2f 100644
--- a/polygerrit-ui/app/embed/diff/gr-diff/gr-diff_test.js
+++ b/polygerrit-ui/app/embed/diff/gr-diff/gr-diff_test.js
@@ -14,9 +14,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
import '../../../test/common-test-setup-karma.js';
-import {getMockDiffResponse} from '../../../test/mocks/diff-response.js';
+import {createDiff} from '../../../test/test-data-generators.js';
import './gr-diff.js';
import {GrDiffBuilderImage} from '../gr-diff-builder/gr-diff-builder-image.js';
import {getComputedStyleValue} from '../../../utils/dom-util.js';
@@ -51,21 +50,21 @@
setup(() => {
element = basicFixture.instantiate();
- sinon.stub(element.$.highlights, 'handleSelectionChange');
+ sinon.stub(element.highlights, 'handleSelectionChange');
});
test('enabled if logged in', async () => {
element.loggedIn = true;
emulateSelection();
await flush();
- assert.isTrue(element.$.highlights.handleSelectionChange.called);
+ assert.isTrue(element.highlights.handleSelectionChange.called);
});
test('ignored if logged out', async () => {
element.loggedIn = false;
emulateSelection();
await flush();
- assert.isFalse(element.$.highlights.handleSelectionChange.called);
+ assert.isFalse(element.highlights.handleSelectionChange.called);
});
});
@@ -191,7 +190,7 @@
element.changeNum = 123;
element.patchRange = {basePatchNum: 1, patchNum: 2};
element.path = 'file.txt';
- element.$.diffBuilder.diff = getMockDiffResponse();
+ element.$.diffBuilder.diff = createDiff();
element.$.diffBuilder.prefs = {...MINIMAL_PREFS};
element.$.diffBuilder._builder = element.$.diffBuilder._getDiffBuilder();
@@ -526,7 +525,7 @@
suite('getCursorStops', () => {
function setupDiff() {
- element.diff = getMockDiffResponse();
+ element.diff = createDiff();
element.prefs = {
context: 10,
tab_size: 8,
@@ -807,7 +806,7 @@
return Promise.resolve({});
});
sinon.stub(element, 'getDiffLength').returns(10000);
- element.diff = getMockDiffResponse();
+ element.diff = createDiff();
element.noRenderOnPrefsChange = true;
});
@@ -1217,7 +1216,7 @@
});
test('getDiffLength', () => {
- const diff = getMockDiffResponse();
+ const diff = createDiff();
assert.equal(element.getDiffLength(diff), 52);
});
diff --git a/polygerrit-ui/app/embed/diff/gr-ranged-comment-layer/gr-ranged-comment-layer.ts b/polygerrit-ui/app/embed/diff/gr-ranged-comment-layer/gr-ranged-comment-layer.ts
index 6c8a5e9..70cec64 100644
--- a/polygerrit-ui/app/embed/diff/gr-ranged-comment-layer/gr-ranged-comment-layer.ts
+++ b/polygerrit-ui/app/embed/diff/gr-ranged-comment-layer/gr-ranged-comment-layer.ts
@@ -20,7 +20,6 @@
export interface CommentRangeLayer {
side: Side;
range: CommentRange;
- hovering: boolean;
// New drafts don't have a rootId.
rootId?: string;
}
@@ -40,7 +39,6 @@
* highlights.
*/
interface CommentRangeLineLayer {
- hovering: boolean;
longRange: boolean;
id: string;
// start char (0-based)
@@ -59,7 +57,7 @@
const RANGE_BASE_ONLY = 'style-scope gr-diff range';
const RANGE_HIGHLIGHT = 'style-scope gr-diff range rangeHighlight';
-const HOVER_HIGHLIGHT = 'style-scope gr-diff range rangeHoverHighlight';
+// Note that there is also `rangeHoverHighlight` being set by GrDiffHighlight.
export class GrRangedCommentLayer implements DiffLayer {
private knownRanges: CommentRangeLayer[] = [];
@@ -95,11 +93,8 @@
el,
range.start,
range.end - range.start,
- (range.hovering
- ? HOVER_HIGHLIGHT
- : range.longRange
- ? RANGE_BASE_ONLY
- : RANGE_HIGHLIGHT) + ` ${strToClassName(range.id)}`
+ (range.longRange ? RANGE_BASE_ONLY : RANGE_HIGHLIGHT) +
+ ` ${strToClassName(range.id)}`
);
}
}
@@ -139,17 +134,15 @@
}
private addRange(commentRange: CommentRangeLayer) {
- const {side, range, hovering} = commentRange;
+ const {side, range} = commentRange;
const longRange = isLongCommentRange(range);
this.updateRangesMap({
side,
range,
- hovering,
- operation: (forLine, startChar, endChar, hovering) => {
+ operation: (forLine, startChar, endChar) => {
forLine.push({
start: startChar,
end: endChar,
- hovering,
id: id(commentRange),
longRange,
});
@@ -158,11 +151,10 @@
}
private removeRange(commentRange: CommentRangeLayer) {
- const {side, range, hovering} = commentRange;
+ const {side, range} = commentRange;
this.updateRangesMap({
side,
range,
- hovering,
operation: forLine => {
const index = forLine.findIndex(
lineRange => id(commentRange) === lineRange.id
@@ -175,21 +167,19 @@
private updateRangesMap(options: {
side: Side;
range: CommentRange;
- hovering: boolean;
operation: (
forLine: CommentRangeLineLayer[],
start: number,
- end: number,
- hovering: boolean
+ end: number
) => void;
}) {
- const {side, range, hovering, operation} = options;
+ const {side, range, operation} = options;
const forSide = this.rangesMap[side] || (this.rangesMap[side] = {});
for (let line = range.start_line; line <= range.end_line; line++) {
const forLine = forSide[line] || (forSide[line] = []);
const start = line === range.start_line ? range.start_character : 0;
const end = line === range.end_line ? range.end_character : -1;
- operation(forLine, start, end, hovering);
+ operation(forLine, start, end);
}
this.notifyUpdateRange(range.start_line, range.end_line, side);
}
@@ -199,25 +189,20 @@
const lineNum = side === Side.LEFT ? line.beforeNumber : line.afterNumber;
if (lineNum === 'FILE' || lineNum === 'LOST') return [];
const ranges: CommentRangeLineLayer[] = this.rangesMap[side][lineNum] || [];
- return (
- ranges
- .map(range => {
- // Make a copy, so that the normalization below does not mess with
- // our map.
- range = {...range};
- range.end = range.end === -1 ? line.text.length : range.end;
+ return ranges.map(range => {
+ // Make a copy, so that the normalization below does not mess with
+ // our map.
+ range = {...range};
+ range.end = range.end === -1 ? line.text.length : range.end;
- // Normalize invalid ranges where the start is after the end but the
- // start still makes sense. Set the end to the end of the line.
- // @see Issue 5744
- if (range.start >= range.end && range.start < line.text.length) {
- range.end = line.text.length;
- }
+ // Normalize invalid ranges where the start is after the end but the
+ // start still makes sense. Set the end to the end of the line.
+ // @see Issue 5744
+ if (range.start >= range.end && range.start < line.text.length) {
+ range.end = line.text.length;
+ }
- return range;
- })
- // Sort the ranges so that hovering highlights are on top.
- .sort((a, b) => (a.hovering && !b.hovering ? 1 : 0))
- );
+ return range;
+ });
}
}
diff --git a/polygerrit-ui/app/embed/diff/gr-ranged-comment-layer/gr-ranged-comment-layer_test.ts b/polygerrit-ui/app/embed/diff/gr-ranged-comment-layer/gr-ranged-comment-layer_test.ts
index 4e35645..15d14e3 100644
--- a/polygerrit-ui/app/embed/diff/gr-ranged-comment-layer/gr-ranged-comment-layer_test.ts
+++ b/polygerrit-ui/app/embed/diff/gr-ranged-comment-layer/gr-ranged-comment-layer_test.ts
@@ -24,7 +24,6 @@
start_line: 36,
},
rootId: 'a',
- hovering: false,
};
const rangeB: CommentRangeLayer = {
@@ -36,7 +35,6 @@
start_line: 10,
},
rootId: 'b',
- hovering: false,
};
const rangeC: CommentRangeLayer = {
@@ -47,7 +45,6 @@
start_character: 5,
start_line: 100,
},
- hovering: false,
};
const rangeD: CommentRangeLayer = {
@@ -59,7 +56,6 @@
start_line: 55,
},
rootId: 'd',
- hovering: false,
};
const rangeE: CommentRangeLayer = {
@@ -70,7 +66,6 @@
start_character: 1,
start_line: 60,
},
- hovering: false,
};
suite('gr-ranged-comment-layer', () => {
diff --git a/polygerrit-ui/app/package.json b/polygerrit-ui/app/package.json
index 4557f92..37f7a9f 100644
--- a/polygerrit-ui/app/package.json
+++ b/polygerrit-ui/app/package.json
@@ -40,7 +40,7 @@
"highlight.js": "^11.5.0",
"highlightjs-closure-templates": "https://github.com/highlightjs/highlightjs-closure-templates",
"highlightjs-structured-text": "https://github.com/highlightjs/highlightjs-structured-text",
- "lit": "^2.1.1",
+ "lit": "^2.2.3",
"page": "^1.11.6",
"polymer-bridges": "file:../../polymer-bridges/",
"polymer-resin": "^2.0.1",
diff --git a/polygerrit-ui/app/services/gr-rest-api/gr-rest-api-impl.ts b/polygerrit-ui/app/services/gr-rest-api/gr-rest-api-impl.ts
index 8e6a147..2729e69 100644
--- a/polygerrit-ui/app/services/gr-rest-api/gr-rest-api-impl.ts
+++ b/polygerrit-ui/app/services/gr-rest-api/gr-rest-api-impl.ts
@@ -97,6 +97,7 @@
HashtagsInput,
ImagesForDiff,
IncludedInInfo,
+ LabelNameToLabelTypeInfoMap,
MergeableInfo,
NameToProjectInfoMap,
NumericChangeId,
@@ -130,11 +131,13 @@
TagInput,
TopMenuEntryInfo,
UrlEncodedCommentId,
+ UrlEncodedRepoName,
} from '../../types/common';
import {
DiffInfo,
DiffPreferencesInfo,
IgnoreWhitespaceType,
+ WebLinkInfo,
} from '../../types/diff';
import {
CancelConditionCallback,
@@ -148,6 +151,7 @@
createDefaultEditPrefs,
createDefaultPreferences,
HttpMethod,
+ ProjectState,
ReviewerState,
} from '../../constants/constants';
import {firePageError, fireServerError} from '../../utils/event-util';
@@ -1429,36 +1433,26 @@
filter: string | undefined,
reposPerPage: number,
offset?: number
- ) {
- const defaultFilter = 'state:active OR state:read-only';
- const namePartDelimiters = /[@.\-\s/_]/g;
+ ): [boolean, string] {
+ const defaultFilter = '';
offset = offset || 0;
-
- if (filter && !filter.includes(':') && filter.match(namePartDelimiters)) {
- // The query language specifies hyphens as operators. Split the string
- // by hyphens and 'AND' the parts together as 'inname:' queries.
- // If the filter includes a semicolon, the user is using a more complex
- // query so we trust them and don't do any magic under the hood.
- const originalFilter = filter;
- filter = '';
- originalFilter.split(namePartDelimiters).forEach(part => {
- if (part) {
- filter += (filter === '' ? 'inname:' : ' AND inname:') + part;
- }
- });
- }
- // Check if filter is now empty which could be either because the user did
- // not provide it or because the user provided only a split character.
- if (!filter) {
- filter = defaultFilter;
- }
-
- filter = filter.trim();
+ filter ??= defaultFilter;
const encodedFilter = encodeURIComponent(filter);
- return (
- `/projects/?n=${reposPerPage + 1}&S=${offset}` + `&query=${encodedFilter}`
- );
+ if (filter.includes(':')) {
+ // If the filter includes a semicolon, the user is using a more complex
+ // query so we trust them and don't do any magic under the hood.
+ return [
+ true,
+ `/projects/?n=${reposPerPage + 1}&S=${offset}` +
+ `&query=${encodedFilter}`,
+ ];
+ }
+
+ return [
+ false,
+ `/projects/?n=${reposPerPage + 1}&S=${offset}` + `&d=&m=${encodedFilter}`,
+ ];
}
invalidateGroupsCache() {
@@ -1491,14 +1485,47 @@
reposPerPage: number,
offset?: number
): Promise<ProjectInfoWithName[] | undefined> {
- const url = this._getReposUrl(filter, reposPerPage, offset);
+ const [isQuery, url] = this._getReposUrl(filter, reposPerPage, offset);
// TODO(kaspern): Rename rest api from /projects/ to /repos/ once backend
// supports it.
- return this._fetchSharedCacheURL({
- url, // The url contains query,so the response is an array, not map
- anonymizedUrl: '/projects/?*',
- }) as Promise<ProjectInfoWithName[] | undefined>;
+ // If query then return directly as the result will be expected to be an array
+ if (isQuery) {
+ return this._fetchSharedCacheURL({
+ url, // The url contains query,so the response is an array, not map
+ anonymizedUrl: '/projects/?*',
+ }) as Promise<ProjectInfoWithName[] | undefined>;
+ }
+ const result: Promise<NameToProjectInfoMap[] | undefined> =
+ this._fetchSharedCacheURL({
+ url, // The url contains query,so the response is an array, not map
+ anonymizedUrl: '/projects/?*',
+ }) as Promise<NameToProjectInfoMap[] | undefined>;
+ return this._transformToArray(result);
+ }
+
+ _transformToArray(
+ res: Promise<NameToProjectInfoMap[] | undefined>
+ ): Promise<ProjectInfoWithName[] | undefined> {
+ return res.then(response => {
+ const reposList: ProjectInfoWithName[] = [];
+ for (const [name, project] of Object.entries(response ?? {})) {
+ const projectInfo: ProjectInfoWithName = {
+ id: project.id as unknown as UrlEncodedRepoName,
+ name: name as RepoName,
+ parent: project.parent as unknown as RepoName,
+ description: project.description as unknown as string,
+ state: project.state as unknown as ProjectState,
+ branches: project.branches as unknown as {
+ [branchName: string]: CommitId;
+ },
+ labels: project.labels as unknown as LabelNameToLabelTypeInfoMap,
+ web_links: project.web_links as unknown as WebLinkInfo[],
+ };
+ reposList.push(projectInfo);
+ }
+ return reposList;
+ });
}
setRepoHead(repo: RepoName, ref: GitRef) {
diff --git a/polygerrit-ui/app/services/gr-rest-api/gr-rest-api-impl_test.js b/polygerrit-ui/app/services/gr-rest-api/gr-rest-api-impl_test.js
index fbfd152..d8c3ff2 100644
--- a/polygerrit-ui/app/services/gr-rest-api/gr-rest-api-impl_test.js
+++ b/polygerrit-ui/app/services/gr-rest-api/gr-rest-api-impl_test.js
@@ -677,16 +677,19 @@
});
test('normal use', () => {
- const defaultQuery = 'state%3Aactive%20OR%20state%3Aread-only';
+ const defaultQuery = '';
- assert.equal(element._getReposUrl('test', 25),
- '/projects/?n=26&S=0&query=test');
+ assert.equal(element._getReposUrl('test', 25).toString(),
+ [false, '/projects/?n=26&S=0&d=&m=test'].toString());
- assert.equal(element._getReposUrl(null, 25),
- `/projects/?n=26&S=0&query=${defaultQuery}`);
+ assert.equal(element._getReposUrl(null, 25).toString(),
+ [false, `/projects/?n=26&S=0&d=&m=${defaultQuery}`].toString());
- assert.equal(element._getReposUrl('test', 25, 25),
- '/projects/?n=26&S=25&query=test');
+ assert.equal(element._getReposUrl('test', 25, 25).toString(),
+ [false, '/projects/?n=26&S=25&d=&m=test'].toString());
+
+ assert.equal(element._getReposUrl('inname:test', 25, 25).toString(),
+ [true, '/projects/?n=26&S=25&query=inname%3Atest'].toString());
});
test('invalidateReposCache', () => {
@@ -714,67 +717,74 @@
});
suite('getRepos', () => {
- const defaultQuery = 'state%3Aactive%20OR%20state%3Aread-only';
+ const defaultQuery = '';
let fetchCacheURLStub;
setup(() => {
fetchCacheURLStub =
- sinon.stub(element._restApiHelper, 'fetchCacheURL');
+ sinon.stub(element._restApiHelper, 'fetchCacheURL')
+ .returns(Promise.resolve([]));
});
test('normal use', () => {
element.getRepos('test', 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- '/projects/?n=26&S=0&query=test');
+ '/projects/?n=26&S=0&d=&m=test');
element.getRepos(null, 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- `/projects/?n=26&S=0&query=${defaultQuery}`);
+ `/projects/?n=26&S=0&d=&m=${defaultQuery}`);
element.getRepos('test', 25, 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- '/projects/?n=26&S=25&query=test');
+ '/projects/?n=26&S=25&d=&m=test');
});
test('with blank', () => {
element.getRepos('test/test', 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- '/projects/?n=26&S=0&query=inname%3Atest%20AND%20inname%3Atest');
+ '/projects/?n=26&S=0&d=&m=test%2Ftest');
});
test('with hyphen', () => {
element.getRepos('foo-bar', 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- '/projects/?n=26&S=0&query=inname%3Afoo%20AND%20inname%3Abar');
+ '/projects/?n=26&S=0&d=&m=foo-bar');
});
test('with leading hyphen', () => {
element.getRepos('-bar', 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- '/projects/?n=26&S=0&query=inname%3Abar');
+ '/projects/?n=26&S=0&d=&m=-bar');
});
test('with trailing hyphen', () => {
element.getRepos('foo-bar-', 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- '/projects/?n=26&S=0&query=inname%3Afoo%20AND%20inname%3Abar');
+ '/projects/?n=26&S=0&d=&m=foo-bar-');
});
test('with underscore', () => {
element.getRepos('foo_bar', 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- '/projects/?n=26&S=0&query=inname%3Afoo%20AND%20inname%3Abar');
+ '/projects/?n=26&S=0&d=&m=foo_bar');
});
test('with underscore', () => {
element.getRepos('foo_bar', 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- '/projects/?n=26&S=0&query=inname%3Afoo%20AND%20inname%3Abar');
+ '/projects/?n=26&S=0&d=&m=foo_bar');
});
test('hyphen only', () => {
element.getRepos('-', 25);
assert.equal(fetchCacheURLStub.lastCall.args[0].url,
- `/projects/?n=26&S=0&query=${defaultQuery}`);
+ `/projects/?n=26&S=0&d=&m=-`);
+ });
+
+ test('using query', () =>{
+ element.getRepos('description:project', 25);
+ assert.equal(fetchCacheURLStub.lastCall.args[0].url,
+ `/projects/?n=26&S=0&query=description%3Aproject`);
});
});
diff --git a/polygerrit-ui/app/styles/gr-change-metadata-shared-styles.ts b/polygerrit-ui/app/styles/gr-change-metadata-shared-styles.ts
index 67a6963..aa16473 100644
--- a/polygerrit-ui/app/styles/gr-change-metadata-shared-styles.ts
+++ b/polygerrit-ui/app/styles/gr-change-metadata-shared-styles.ts
@@ -18,40 +18,39 @@
// Mark the file as a module. Otherwise typescript assumes this is a script
// and $_documentContainer is a global variable.
// See: https://www.typescriptlang.org/docs/handbook/modules.html
-export {};
+import {css} from 'lit';
+
+export const changeMetadataStyles = css`
+ section {
+ display: table-row;
+ }
+
+ section:not(:first-of-type) .title,
+ section:not(:first-of-type) .value {
+ padding-top: var(--spacing-s);
+ }
+
+ .title,
+ .value {
+ display: table-cell;
+ vertical-align: top;
+ }
+
+ .title {
+ color: var(--deemphasized-text-color);
+ max-width: 20em;
+ padding-left: var(--metadata-horizontal-padding);
+ padding-right: var(--metadata-horizontal-padding);
+ word-break: break-word;
+ }
+`;
const $_documentContainer = document.createElement('template');
-
$_documentContainer.innerHTML = `<dom-module id="gr-change-metadata-shared-styles">
<template>
- <style include="shared-styles">
- /* Workaround for empty style block - see https://github.com/Polymer/tools/issues/408 */
- </style>
<style>
- section {
- display: table-row;
- }
-
- section:not(:first-of-type) .title,
- section:not(:first-of-type) .value {
- padding-top: var(--spacing-s);
- }
-
- .title,
- .value {
- display: table-cell;
- vertical-align: top;
- }
-
- .title {
- color: var(--deemphasized-text-color);
- max-width: 20em;
- padding-left: var(--metadata-horizontal-padding);
- padding-right: var(--metadata-horizontal-padding);
- word-break: break-word;
- }
+ ${changeMetadataStyles.cssText}
</style>
</template>
</dom-module>`;
-
document.head.appendChild($_documentContainer.content);
diff --git a/polygerrit-ui/app/styles/gr-table-styles.ts b/polygerrit-ui/app/styles/gr-table-styles.ts
index 6871499..ce01555 100644
--- a/polygerrit-ui/app/styles/gr-table-styles.ts
+++ b/polygerrit-ui/app/styles/gr-table-styles.ts
@@ -93,7 +93,7 @@
text-decoration: underline;
}
.genericList .description {
- width: 99%;
+ width: var(--generic-list-description-width, 99%);
}
.genericList .loadingMsg {
color: var(--deemphasized-text-color);
diff --git a/polygerrit-ui/app/styles/shared-styles.ts b/polygerrit-ui/app/styles/shared-styles.ts
index e99cf27..a83e897 100644
--- a/polygerrit-ui/app/styles/shared-styles.ts
+++ b/polygerrit-ui/app/styles/shared-styles.ts
@@ -138,6 +138,8 @@
box-sizing: border-box;
padding: var(--spacing-s);
}
+ --iron-autogrow-textarea_-_box-sizing: border-box;
+ --iron-autogrow-textarea_-_padding: var(--spacing-s);
}
a {
color: var(--link-color);
diff --git a/polygerrit-ui/app/styles/themes/app-theme.ts b/polygerrit-ui/app/styles/themes/app-theme.ts
index e04dd92..0aae217 100644
--- a/polygerrit-ui/app/styles/themes/app-theme.ts
+++ b/polygerrit-ui/app/styles/themes/app-theme.ts
@@ -285,6 +285,7 @@
/* misc colors */
--border-color: var(--gray-300);
+ --input-focus-border-color: var(--blue-800);
--comment-separator-color: var(--gray-300);
/* checks tag colors */
diff --git a/polygerrit-ui/app/styles/themes/dark-theme.ts b/polygerrit-ui/app/styles/themes/dark-theme.ts
index d66ea55..6f19924 100644
--- a/polygerrit-ui/app/styles/themes/dark-theme.ts
+++ b/polygerrit-ui/app/styles/themes/dark-theme.ts
@@ -155,6 +155,7 @@
/* misc colors */
--border-color: var(--gray-700);
+ --input-focus-border-color: var(--blue-200);
--comment-separator-color: var(--border-color);
/* checks tag colors */
diff --git a/polygerrit-ui/app/test/mocks/diff-response.ts b/polygerrit-ui/app/test/mocks/diff-response.ts
deleted file mode 100644
index 46d30b6..0000000
--- a/polygerrit-ui/app/test/mocks/diff-response.ts
+++ /dev/null
@@ -1,137 +0,0 @@
-/**
- * @license
- * 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.
- */
-
-import {DiffInfo} from '../../types/diff';
-
-export function getMockDiffResponse(): DiffInfo {
- // Return new response, so tests can't affect each other - if a test somehow
- // modifies it, the future calls return original value
- // Do not put it to a const outside of a method
- return {
- meta_a: {
- name: 'lorem-ipsum.txt',
- content_type: 'text/plain',
- lines: 45,
- },
- meta_b: {
- name: 'lorem-ipsum.txt',
- content_type: 'text/plain',
- lines: 48,
- },
- intraline_status: 'OK',
- change_type: 'MODIFIED',
- diff_header: [
- 'diff --git a/lorem-ipsum.txt b/lorem-ipsum.txt',
- 'index b2adcf4..554ae49 100644',
- '--- a/lorem-ipsum.txt',
- '+++ b/lorem-ipsum.txt',
- ],
- content: [
- {
- ab: [
- 'Lorem ipsum dolor sit amet, suspendisse inceptos vehicula, ' +
- 'nulla phasellus.',
- 'Mattis lectus.',
- 'Sodales duis.',
- 'Orci a faucibus.',
- ],
- },
- {
- b: [
- 'Nullam neque, ligula ac, id blandit.',
- 'Sagittis tincidunt torquent, tempor nunc amet.',
- 'At rhoncus id.',
- ],
- },
- {
- ab: [
- 'Sem nascetur, erat ut, non in.',
- 'A donec, venenatis pellentesque dis.',
- 'Mauris mauris.',
- 'Quisque nisl duis, facilisis viverra.',
- 'Justo purus, semper eget et.',
- ],
- },
- {
- a: [
- 'Est amet, vestibulum pellentesque.',
- 'Erat ligula.',
- 'Justo eros.',
- 'Fringilla quisque.',
- ],
- },
- {
- ab: [
- 'Arcu eget, rhoncus amet cursus, ipsum elementum.',
- 'Eros suspendisse.',
- ],
- },
- {
- a: ['Rhoncus tempor, ultricies aliquam ipsum.'],
- b: ['Rhoncus tempor, ultricies praesent ipsum.'],
- edit_a: [[26, 7]],
- edit_b: [[26, 8]],
- },
- {
- ab: [
- 'Sollicitudin duis.',
- 'Blandit blandit, ante nisl fusce.',
- 'Felis ac at, tellus consectetuer.',
- 'Sociis ligula sapien, egestas leo.',
- 'Cum pulvinar, sed mauris, cursus neque velit.',
- 'Augue porta lobortis.',
- 'Nibh lorem, amet fermentum turpis, vel pulvinar diam.',
- 'Id quam ipsum, id urna et, massa suspendisse.',
- 'Ac nec, nibh praesent.',
- 'Rutrum vestibulum.',
- 'Est tellus, bibendum habitasse.',
- 'Justo facilisis, vel nulla.',
- 'Donec eu, vulputate neque aliquam, nulla dui.',
- 'Risus adipiscing in.',
- 'Lacus arcu arcu.',
- 'Urna velit.',
- 'Urna a dolor.',
- 'Lectus magna augue, convallis mattis tortor, sed tellus ' +
- 'consequat.',
- 'Etiam dui, blandit wisi.',
- 'Mi nec.',
- 'Vitae eget vestibulum.',
- 'Ullamcorper nunc ante, nec imperdiet felis, consectetur in.',
- 'Ac eget.',
- 'Vel fringilla, interdum pellentesque placerat, proin ante.',
- ],
- },
- {
- b: [
- 'Eu congue risus.',
- 'Enim ac, quis elementum.',
- 'Non et elit.',
- 'Etiam aliquam, diam vel nunc.',
- ],
- },
- {
- ab: [
- 'Nec at.',
- 'Arcu mauris, venenatis lacus fermentum, praesent duis.',
- 'Pellentesque amet et, tellus duis.',
- 'Ipsum arcu vitae, justo elit, sed libero tellus.',
- 'Metus rutrum euismod, vivamus sodales, vel arcu nisl.',
- ],
- },
- ],
- };
-}
diff --git a/polygerrit-ui/app/test/test-data-generators.ts b/polygerrit-ui/app/test/test-data-generators.ts
index 04b6c93..8c33c79 100644
--- a/polygerrit-ui/app/test/test-data-generators.ts
+++ b/polygerrit-ui/app/test/test-data-generators.ts
@@ -33,6 +33,7 @@
CommentInfo,
CommentLinkInfo,
CommentLinks,
+ CommentRange,
CommitId,
CommitInfo,
ConfigInfo,
@@ -50,6 +51,7 @@
GroupId,
GroupInfo,
InheritedBooleanInfo,
+ LabelInfo,
MaxObjectSizeLimitInfo,
MergeableInfo,
NumericChangeId,
@@ -122,6 +124,7 @@
} from '../api/rest-api';
import {RunResult} from '../models/checks/checks-model';
import {Category, RunStatus} from '../api/checks';
+import {DiffInfo} from '../api/diff';
const TEST_DEFAULT_EXPRESSION = 'label:Verified=MAX -label:Verified=MIN';
export const TEST_PROJECT_NAME: RepoName = 'test-project' as RepoName;
@@ -237,6 +240,30 @@
};
}
+export function createLabelInfo(score = 1): LabelInfo {
+ return {
+ all: [
+ {
+ value: score,
+ permitted_voting_range: {
+ min: -1,
+ max: 1,
+ },
+ _account_id: 1000 as AccountId,
+ name: 'Foo',
+ email: 'foo@example.com' as EmailAddress,
+ username: 'foo',
+ },
+ ],
+ values: {
+ '-1': 'Fail',
+ ' 0': 'No score',
+ '+1': 'Pass',
+ },
+ default_value: 0,
+ };
+}
+
export function createCommit(): CommitInfo {
return {
parents: [],
@@ -467,6 +494,122 @@
};
}
+export function createDiff(): DiffInfo {
+ return {
+ meta_a: {
+ name: 'lorem-ipsum.txt',
+ content_type: 'text/plain',
+ lines: 45,
+ },
+ meta_b: {
+ name: 'lorem-ipsum.txt',
+ content_type: 'text/plain',
+ lines: 48,
+ },
+ intraline_status: 'OK',
+ change_type: 'MODIFIED',
+ diff_header: [
+ 'diff --git a/lorem-ipsum.txt b/lorem-ipsum.txt',
+ 'index b2adcf4..554ae49 100644',
+ '--- a/lorem-ipsum.txt',
+ '+++ b/lorem-ipsum.txt',
+ ],
+ content: [
+ {
+ ab: [
+ 'Lorem ipsum dolor sit amet, suspendisse inceptos vehicula, ' +
+ 'nulla phasellus.',
+ 'Mattis lectus.',
+ 'Sodales duis.',
+ 'Orci a faucibus.',
+ ],
+ },
+ {
+ b: [
+ 'Nullam neque, ligula ac, id blandit.',
+ 'Sagittis tincidunt torquent, tempor nunc amet.',
+ 'At rhoncus id.',
+ ],
+ },
+ {
+ ab: [
+ 'Sem nascetur, erat ut, non in.',
+ 'A donec, venenatis pellentesque dis.',
+ 'Mauris mauris.',
+ 'Quisque nisl duis, facilisis viverra.',
+ 'Justo purus, semper eget et.',
+ ],
+ },
+ {
+ a: [
+ 'Est amet, vestibulum pellentesque.',
+ 'Erat ligula.',
+ 'Justo eros.',
+ 'Fringilla quisque.',
+ ],
+ },
+ {
+ ab: [
+ 'Arcu eget, rhoncus amet cursus, ipsum elementum.',
+ 'Eros suspendisse.',
+ ],
+ },
+ {
+ a: ['Rhoncus tempor, ultricies aliquam ipsum.'],
+ b: ['Rhoncus tempor, ultricies praesent ipsum.'],
+ edit_a: [[26, 7]],
+ edit_b: [[26, 8]],
+ },
+ {
+ ab: [
+ 'Sollicitudin duis.',
+ 'Blandit blandit, ante nisl fusce.',
+ 'Felis ac at, tellus consectetuer.',
+ 'Sociis ligula sapien, egestas leo.',
+ 'Cum pulvinar, sed mauris, cursus neque velit.',
+ 'Augue porta lobortis.',
+ 'Nibh lorem, amet fermentum turpis, vel pulvinar diam.',
+ 'Id quam ipsum, id urna et, massa suspendisse.',
+ 'Ac nec, nibh praesent.',
+ 'Rutrum vestibulum.',
+ 'Est tellus, bibendum habitasse.',
+ 'Justo facilisis, vel nulla.',
+ 'Donec eu, vulputate neque aliquam, nulla dui.',
+ 'Risus adipiscing in.',
+ 'Lacus arcu arcu.',
+ 'Urna velit.',
+ 'Urna a dolor.',
+ 'Lectus magna augue, convallis mattis tortor, sed tellus ' +
+ 'consequat.',
+ 'Etiam dui, blandit wisi.',
+ 'Mi nec.',
+ 'Vitae eget vestibulum.',
+ 'Ullamcorper nunc ante, nec imperdiet felis, consectetur in.',
+ 'Ac eget.',
+ 'Vel fringilla, interdum pellentesque placerat, proin ante.',
+ ],
+ },
+ {
+ b: [
+ 'Eu congue risus.',
+ 'Enim ac, quis elementum.',
+ 'Non et elit.',
+ 'Etiam aliquam, diam vel nunc.',
+ ],
+ },
+ {
+ ab: [
+ 'Nec at.',
+ 'Arcu mauris, venenatis lacus fermentum, praesent duis.',
+ 'Pellentesque amet et, tellus duis.',
+ 'Ipsum arcu vitae, justo elit, sed libero tellus.',
+ 'Metus rutrum euismod, vivamus sodales, vel arcu nisl.',
+ ],
+ },
+ ],
+ };
+}
+
export function createMergeable(): MergeableInfo {
return {
submit_type: SubmitType.MERGE_IF_NECESSARY,
@@ -535,6 +678,15 @@
};
}
+export function createRange(): CommentRange {
+ return {
+ start_line: 1,
+ start_character: 0,
+ end_line: 1,
+ end_character: 1,
+ };
+}
+
export function createComment(
extra: Partial<CommentInfo | DraftInfo> = {}
): CommentInfo {
diff --git a/polygerrit-ui/app/test/test-utils.ts b/polygerrit-ui/app/test/test-utils.ts
index 0c63de0..985bec1 100644
--- a/polygerrit-ui/app/test/test-utils.ts
+++ b/polygerrit-ui/app/test/test-utils.ts
@@ -296,6 +296,19 @@
element.dispatchEvent(new KeyboardEvent('keydown', eventOptions));
}
+export function mouseDown(element: HTMLElement) {
+ const rect = element.getBoundingClientRect();
+ const eventOptions = {
+ bubbles: true,
+ composed: true,
+ clientX: (rect.left + rect.right) / 2,
+ clientY: (rect.top + rect.bottom) / 2,
+ screenX: (rect.left + rect.right) / 2,
+ screenY: (rect.top + rect.bottom) / 2,
+ };
+ element.dispatchEvent(new MouseEvent('mousedown', eventOptions));
+}
+
export function assertFails(promise: Promise<unknown>, error?: unknown) {
promise
.then((_v: unknown) => {
diff --git a/polygerrit-ui/app/utils/comment-util.ts b/polygerrit-ui/app/utils/comment-util.ts
index 2aefa99..669c491 100644
--- a/polygerrit-ui/app/utils/comment-util.ts
+++ b/polygerrit-ui/app/utils/comment-util.ts
@@ -38,6 +38,7 @@
import {isMergeParent, getParentIndex} from './patch-set-util';
import {DiffInfo} from '../types/diff';
import {LineNumber} from '../api/diff';
+import {FormattedReviewerUpdateInfo} from '../types/types';
export interface DraftCommentProps {
// This must be true for all drafts. Drafts received from the backend will be
@@ -98,6 +99,12 @@
commentThreads: CommentThread[];
}
+export function isFormattedReviewerUpdate(
+ message: ChangeMessage
+): message is ChangeMessage & FormattedReviewerUpdateInfo {
+ return message.type === 'REVIEWER_UPDATE';
+}
+
export type LabelExtreme = {[labelName: string]: VotingRangeInfo};
export const PATCH_SET_PREFIX_PATTERN =
diff --git a/polygerrit-ui/app/yarn.lock b/polygerrit-ui/app/yarn.lock
index 1846c6a..e0b18be 100644
--- a/polygerrit-ui/app/yarn.lock
+++ b/polygerrit-ui/app/yarn.lock
@@ -2,10 +2,10 @@
# yarn lockfile v1
-"@lit/reactive-element@^1.1.0":
- version "1.2.0"
- resolved "https://registry.yarnpkg.com/@lit/reactive-element/-/reactive-element-1.2.0.tgz#c62444a0e3d3f8d3a6875ad56f867279aa89fa88"
- integrity sha512-7i/Fz8enAQ2AN5DyJ2i2AFERufjP6x1NjuHoNgDyJkjjHxEoo8kVyyHxu1A9YyeShlksjt5FvpvENBDuivQHLA==
+"@lit/reactive-element@^1.3.0":
+ version "1.3.2"
+ resolved "https://registry.yarnpkg.com/@lit/reactive-element/-/reactive-element-1.3.2.tgz#43e470537b6ec2c23510c07812616d5aa27a17cd"
+ integrity sha512-A2e18XzPMrIh35nhIdE4uoqRzoIpEU5vZYuQN4S3Ee1zkGdYC27DP12pewbw/RLgPHzaE4kx/YqxMzebOpm0dA==
"@mapbox/node-pre-gyp@^1.0.0":
version "1.0.5"
@@ -679,29 +679,29 @@
resolved "https://registry.yarnpkg.com/isarray/-/isarray-1.0.0.tgz#bb935d48582cba168c06834957a54a3e07124f11"
integrity sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE=
-lit-element@^3.1.0:
- version "3.1.1"
- resolved "https://registry.yarnpkg.com/lit-element/-/lit-element-3.1.1.tgz#562d5ccbc8ba0c01d8ba4a0ac3576263167d2ccb"
- integrity sha512-14ClnMAU8EXnzC+M2/KDd3SFmNUn1QUw1+GxWkEMwGV3iaH8ObunMlO5svzvaWlkSV0WlxJCi40NGnDVJ2XZKQ==
+lit-element@^3.2.0:
+ version "3.2.0"
+ resolved "https://registry.yarnpkg.com/lit-element/-/lit-element-3.2.0.tgz#9c981c55dfd9a8f124dc863edb62cc529d434db7"
+ integrity sha512-HbE7yt2SnUtg5DCrWt028oaU4D5F4k/1cntAFHTkzY8ZIa8N0Wmu92PxSxucsQSOXlODFrICkQ5x/tEshKi13g==
dependencies:
- "@lit/reactive-element" "^1.1.0"
- lit-html "^2.1.0"
+ "@lit/reactive-element" "^1.3.0"
+ lit-html "^2.2.0"
-lit-html@^2.1.0:
- version "2.1.1"
- resolved "https://registry.yarnpkg.com/lit-html/-/lit-html-2.1.1.tgz#f4da485798a0d967514d31730d387350fafb79f7"
- integrity sha512-E4BImK6lopAYanJpvcGaAG8kQFF1ccIulPu2BRNZI7acFB6i4ujjjsnaPVFT1j/4lD9r8GKih0Y8d7/LH8SeyQ==
+lit-html@^2.2.0:
+ version "2.2.3"
+ resolved "https://registry.yarnpkg.com/lit-html/-/lit-html-2.2.3.tgz#dcb2744d0f0c1800b2eb2de37bc42384434a74f7"
+ integrity sha512-vI4j3eWwtQaR8q/O63juZVliBIFMio716X719/lSsGH4UWPy2/7Qf377jsNs4cx3gCHgIbx8yxFgXFQ/igZyXQ==
dependencies:
"@types/trusted-types" "^2.0.2"
-lit@^2.1.1:
- version "2.1.1"
- resolved "https://registry.yarnpkg.com/lit/-/lit-2.1.1.tgz#65f43abca945988f696391f762c645ba51966b0b"
- integrity sha512-yqDqf36IhXwOxIQSFqCMgpfvDCRdxLCLZl7m/+tO5C9W/OBHUj17qZpiMBT35v97QMVKcKEi1KZ3hZRyTwBNsQ==
+lit@^2.2.3:
+ version "2.2.3"
+ resolved "https://registry.yarnpkg.com/lit/-/lit-2.2.3.tgz#77203d8f247de7c0d4955817f89e40c927349b9c"
+ integrity sha512-5/v+r9dH3Pw/o0rhp/qYk3ERvOUclNF31bWb0FiW6MPgwdQIr+/KCt/p3zcd8aPl8lIGnxdGrVcZA+gWS6oFOQ==
dependencies:
- "@lit/reactive-element" "^1.1.0"
- lit-element "^3.1.0"
- lit-html "^2.1.0"
+ "@lit/reactive-element" "^1.3.0"
+ lit-element "^3.2.0"
+ lit-html "^2.2.0"
lru-cache@^6.0.0:
version "6.0.0"
diff --git a/polygerrit-ui/package.json b/polygerrit-ui/package.json
index 0dc7074..cdc03aa 100644
--- a/polygerrit-ui/package.json
+++ b/polygerrit-ui/package.json
@@ -4,7 +4,6 @@
"browser": true,
"dependencies": {
"@types/chai": "^4.2.16",
- "@types/lodash": "^4.14.168",
"@types/mocha": "^8.2.2",
"@types/sinon": "^10.0.0"
},
@@ -20,11 +19,10 @@
"karma-chrome-launcher": "^3.1.0",
"karma-mocha": "^2.0.1",
"karma-mocha-reporter": "^2.2.5",
- "lodash": "^4.17.21",
"mocha": "8.3.2",
"sinon": "^10.0.0",
"source-map-support": "^0.5.19"
},
"license": "Apache-2.0",
"private": true
-}
+}
\ No newline at end of file
diff --git a/polygerrit-ui/yarn.lock b/polygerrit-ui/yarn.lock
index 95f6438..44dd946 100644
--- a/polygerrit-ui/yarn.lock
+++ b/polygerrit-ui/yarn.lock
@@ -1343,11 +1343,6 @@
dependencies:
"@types/koa" "*"
-"@types/lodash@^4.14.168":
- version "4.14.172"
- resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.172.tgz#aad774c28e7bfd7a67de25408e03ee5a8c3d028a"
- integrity sha512-/BHF5HAx3em7/KkzVKm3LrsD6HZAXuXO1AJZQ3cRRBZj4oHZDviWPYu0aEplAqDFNHZPW6d3G7KN+ONcCCC7pw==
-
"@types/lru-cache@^5.1.0":
version "5.1.1"
resolved "https://registry.yarnpkg.com/@types/lru-cache/-/lru-cache-5.1.1.tgz#c48c2e27b65d2a153b19bfc1a317e30872e01eef"
diff --git a/tools/BUILD b/tools/BUILD
index 8d6d48f..4e4e5f0 100644
--- a/tools/BUILD
+++ b/tools/BUILD
@@ -1,5 +1,6 @@
load(
"@bazel_tools//tools/jdk:default_java_toolchain.bzl",
+ "NONPREBUILT_TOOLCHAIN_CONFIGURATION",
"default_java_toolchain",
)
load("@rules_java//java:defs.bzl", "java_package_configuration")
@@ -8,6 +9,7 @@
default_java_toolchain(
name = "error_prone_warnings_toolchain_java11",
+ configuration = NONPREBUILT_TOOLCHAIN_CONFIGURATION,
package_configuration = [
":error_prone",
],
diff --git a/tools/bzl/pkg_war.bzl b/tools/bzl/pkg_war.bzl
index 43e9b3e..c9ac0fe 100644
--- a/tools/bzl/pkg_war.bzl
+++ b/tools/bzl/pkg_war.bzl
@@ -22,6 +22,7 @@
"//lib/bouncycastle:bcpkix",
"//lib/bouncycastle:bcprov",
"//lib/bouncycastle:bcpg",
+ "//lib/log:impl-log4j",
"//prolog:gerrit-prolog-common",
"//resources:log4j-config",
]
diff --git a/tools/deps.bzl b/tools/deps.bzl
index 81708da..c4cbc40 100644
--- a/tools/deps.bzl
+++ b/tools/deps.bzl
@@ -62,8 +62,8 @@
maven_jar(
name = "servlet-api",
- artifact = "org.apache.tomcat:tomcat-servlet-api:8.5.23",
- sha1 = "021a212688ec94fe77aff74ab34cc74f6f940e60",
+ artifact = "javax.servlet:javax.servlet-api:3.1.0",
+ sha1 = "3cd63d075497751784b2fa84be59432f4905bf7c",
)
# JGit's transitive dependencies
@@ -75,16 +75,10 @@
sha1 = "9feecc2b24d6bc9ff865af8d082f192238a293eb",
)
- # TODO(davido): Switch to official release once available.
- # Use custom release that fixed compatibility with JDK 17:
- # https://github.com/google/gson/issues/1875
- java_import_external(
+ maven_jar(
name = "gson",
- jar_sha256 = "d68e2a0f4b97143988f2ceef593947acc3f9d9e9618569c26264e63179887d49",
- jar_urls = [
- "https://github.com/davido/gson/releases/download/v2.9.0/gson-2.9.0.jar",
- ],
- licenses = ["unencumbered"], # public domain
+ artifact = "com.google.code.gson:gson:2.9.0",
+ sha1 = "8a1167e089096758b49f9b34066ef98b2f4b37aa",
)
maven_jar(
diff --git a/tools/maven/gerrit-acceptance-framework_pom.xml b/tools/maven/gerrit-acceptance-framework_pom.xml
index eb56cc1..cbef8a9 100644
--- a/tools/maven/gerrit-acceptance-framework_pom.xml
+++ b/tools/maven/gerrit-acceptance-framework_pom.xml
@@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.google.gerrit</groupId>
<artifactId>gerrit-acceptance-framework</artifactId>
- <version>3.6.0-rc1</version>
+ <version>3.6.3-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Gerrit Code Review - Acceptance Test Framework</name>
<description>Framework for Gerrit's acceptance tests</description>
diff --git a/tools/maven/gerrit-extension-api_pom.xml b/tools/maven/gerrit-extension-api_pom.xml
index ff026d3..af19102 100644
--- a/tools/maven/gerrit-extension-api_pom.xml
+++ b/tools/maven/gerrit-extension-api_pom.xml
@@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.google.gerrit</groupId>
<artifactId>gerrit-extension-api</artifactId>
- <version>3.6.0-rc1</version>
+ <version>3.6.3-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Gerrit Code Review - Extension API</name>
<description>API for Gerrit Extensions</description>
diff --git a/tools/maven/gerrit-plugin-api_pom.xml b/tools/maven/gerrit-plugin-api_pom.xml
index 2d0b57a..d238c98 100644
--- a/tools/maven/gerrit-plugin-api_pom.xml
+++ b/tools/maven/gerrit-plugin-api_pom.xml
@@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.google.gerrit</groupId>
<artifactId>gerrit-plugin-api</artifactId>
- <version>3.6.0-rc1</version>
+ <version>3.6.3-SNAPSHOT</version>
<packaging>jar</packaging>
<name>Gerrit Code Review - Plugin API</name>
<description>API for Gerrit Plugins</description>
diff --git a/tools/maven/gerrit-war_pom.xml b/tools/maven/gerrit-war_pom.xml
index 27f5962..cc3feb2 100644
--- a/tools/maven/gerrit-war_pom.xml
+++ b/tools/maven/gerrit-war_pom.xml
@@ -2,7 +2,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.google.gerrit</groupId>
<artifactId>gerrit-war</artifactId>
- <version>3.6.0-rc1</version>
+ <version>3.6.3-SNAPSHOT</version>
<packaging>war</packaging>
<name>Gerrit Code Review - WAR</name>
<description>Gerrit WAR</description>
diff --git a/tools/node_tools/yarn.lock b/tools/node_tools/yarn.lock
index 669ab8d..3f9d3a4 100644
--- a/tools/node_tools/yarn.lock
+++ b/tools/node_tools/yarn.lock
@@ -2385,7 +2385,7 @@
resolved "https://registry.yarnpkg.com/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz#5a6b865b2c44357be3d5ebc2a467b032719a7005"
integrity sha512-2/kNscPhpcxrOigMZzbiWF7dz8ilhb/nIHU3EyZiXWXpeq/au8qJ8VhdftMkty3n7Gj6HIGalQG8oiBNB3AJgA==
-cacheable-request@^7.0.1:
+cacheable-request@^7.0.2:
version "7.0.2"
resolved "https://registry.yarnpkg.com/cacheable-request/-/cacheable-request-7.0.2.tgz#ea0d0b889364a25854757301ca12b2da77f91d27"
integrity sha512-pouW8/FmiPQbuGpkXQ9BAPv/Mo5xDGANgSNXzTzJ8DrKGuXOssM4wIQRjfanNRh3Yu5cfYPvcorqbhg2KIJtew==
@@ -4309,16 +4309,16 @@
integrity sha512-OIPNCxsG2lkIvf+P5FNfJ/Km95CsXOBecS9ZcAU6m2Rq3svc0Apl9nB3GMDNKfQ9asNv4KjyAqGwPQFrVle3Yg==
got@^11.8.2:
- version "11.8.2"
- resolved "https://registry.yarnpkg.com/got/-/got-11.8.2.tgz#7abb3959ea28c31f3576f1576c1effce23f33599"
- integrity sha512-D0QywKgIe30ODs+fm8wMZiAcZjypcCodPNuMz5H9Mny7RJ+IjJ10BdmGW7OM7fHXP+O7r6ZwapQ/YQmMSvB0UQ==
+ version "11.8.3"
+ resolved "https://registry.yarnpkg.com/got/-/got-11.8.3.tgz#f496c8fdda5d729a90b4905d2b07dbd148170770"
+ integrity sha512-7gtQ5KiPh1RtGS9/Jbv1ofDpBFuq42gyfEib+ejaRBJuj/3tQFeR5+gw57e4ipaU8c/rCjvX6fkQz2lyDlGAOg==
dependencies:
"@sindresorhus/is" "^4.0.0"
"@szmarczak/http-timer" "^4.0.5"
"@types/cacheable-request" "^6.0.1"
"@types/responselike" "^1.0.0"
cacheable-lookup "^5.0.3"
- cacheable-request "^7.0.1"
+ cacheable-request "^7.0.2"
decompress-response "^6.0.0"
http2-wrapper "^1.0.0-beta.5.2"
lowercase-keys "^2.0.0"
@@ -8597,11 +8597,16 @@
resolved "https://registry.yarnpkg.com/triple-beam/-/triple-beam-1.3.0.tgz#a595214c7298db8339eeeee083e4d10bd8cb8dd9"
integrity sha512-XrHUvV5HpdLmIj4uVMxHggLbFSZYIn7HEWsqePZcI50pco+MPqJ50wMGY794X7AOOhxOBAjbkqfAbEe/QMp2Lw==
-tslib@^1.8.1, tslib@^1.9.0:
+tslib@^1.8.1:
version "1.14.1"
resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.14.1.tgz#cf2d38bdc34a134bcaf1091c41f6619e2f672d00"
integrity sha512-Xni35NKzjgMrwevysHTCArtLDpPvye8zV/0E4EyYn43P7/7qvQwPh9BGkHewbMulVntbigmcT7rdX3BNo9wRJg==
+tslib@^1.9.0:
+ version "1.10.0"
+ resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.10.0.tgz#c3c19f95973fb0a62973fb09d90d961ee43e5c8a"
+ integrity sha512-qOebF53frne81cf0S9B41ByenJ3/IuH8yJKngAX35CmiZySA0khhkovshKK+jGCaMnVomla7gVlIcc3EvKPbTQ==
+
tsutils@3.21.0:
version "3.21.0"
resolved "https://registry.yarnpkg.com/tsutils/-/tsutils-3.21.0.tgz#b48717d394cea6c1e096983eed58e9d61715b623"
diff --git a/version.bzl b/version.bzl
index 1a2671f..367b172 100644
--- a/version.bzl
+++ b/version.bzl
@@ -2,4 +2,4 @@
# Used by :api_install and :api_deploy targets
# when talking to the destination repository.
#
-GERRIT_VERSION = "3.6.0-rc1"
+GERRIT_VERSION = "3.6.3-SNAPSHOT"
diff --git a/yarn.lock b/yarn.lock
index e6fa177..406f567 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -38,9 +38,9 @@
regenerator-runtime "^0.13.4"
"@bazel/concatjs@^5.1.0":
- version "5.1.0"
- resolved "https://registry.yarnpkg.com/@bazel/concatjs/-/concatjs-5.1.0.tgz#f4321dec4a225c3ceac41b2dc7ec7c3dd3dd5e21"
- integrity sha512-sj+vxHVB/swh7awOfQ37h3p/gxSPgLSnUkDt6POrj26qkfi7HrLB1ZkWAPFIIxjEhsBp1LchoHiezjw2GylZQg==
+ version "5.4.0"
+ resolved "https://registry.yarnpkg.com/@bazel/concatjs/-/concatjs-5.4.0.tgz#04e752a6ea3e684f00879e6683657c4ede72df6e"
+ integrity sha512-jlupaDKxqFS3B1lttOIgkKxirP7v5Qx7KCFtOXO7JxtvYJD/qKtKXEQggTrGKJqLPyiZlNiYimHHGICLSWIZcQ==
dependencies:
protobufjs "6.8.8"
source-map-support "0.5.9"
