Split reviewers plugin into GWT and non-GWT variants
The UI portions have not yet been ported to PolyGerrit, but the plugin
is still useful with no UI, particularly for auto-adding reviewers.
Split the Module file into a ClientModule and BackendModule, and leave
Module as simple wrapper that delegates to both of them. The
backend-only plugin's code lives entirely in the server directory, and
is factored out into a new plugin named reviewers-backend.
The combined Module, its gwt.xml file, as well as its GWT-specific code
(e.g. the top menu) must live directly above the "client" directory,
otherwise the GWT build fails with a mysterious error.
The gerrit_plugin rule needs to be tweaked slightly to allow multiple
rules in the same BUILD file, not all of which match the directory name.
Change-Id: I9e97987428c6e47b1f750ea05e01715ccb400caf
diff --git a/BUILD b/BUILD
index 6086d5c..96f7151 100644
--- a/BUILD
+++ b/BUILD
@@ -1,8 +1,30 @@
load("//tools/bzl:plugin.bzl", "gerrit_plugin")
+SRC = "src/main/java/com/googlesource/gerrit/plugins/reviewers/"
+
+BACKEND_SRCS = glob([
+ SRC + "common/*.java",
+ SRC + "server/*.java",
+])
+
+gerrit_plugin(
+ name = "reviewers-backend",
+ srcs = BACKEND_SRCS,
+ dir_name = "reviewers",
+ manifest_entries = [
+ # Different jar name, but use same plugin name in manifest so REST API is compatible.
+ "Gerrit-PluginName: reviewers",
+ "Gerrit-Module: com.googlesource.gerrit.plugins.reviewers.server.BackendModule",
+ ],
+ resources = glob(["src/main/resources/**/*"]),
+)
+
gerrit_plugin(
name = "reviewers",
- srcs = glob(["src/main/java/**/*.java"]),
+ srcs = BACKEND_SRCS + glob([
+ SRC + "*.java",
+ SRC + "client/*.java",
+ ]),
gwt_module = "com.googlesource.gerrit.plugins.reviewers.ReviewersForm",
manifest_entries = [
"Gerrit-PluginName: reviewers",
diff --git a/WORKSPACE b/WORKSPACE
index d847061..0d61018 100644
--- a/WORKSPACE
+++ b/WORKSPACE
@@ -3,7 +3,7 @@
load("//:bazlets.bzl", "load_bazlets")
load_bazlets(
- commit = "8c91ef43828699c7ed33976897991a427dcfe04b",
+ commit = "3a53199198db3f49a43b7708c2c3352670393717",
# local_path = "/home/<user>/projects/bazlets",
)
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/ClientModule.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/ClientModule.java
new file mode 100644
index 0000000..88c79bd
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/ClientModule.java
@@ -0,0 +1,51 @@
+// Copyright (C) 2013 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.googlesource.gerrit.plugins.reviewers;
+
+import com.google.gerrit.extensions.annotations.PluginName;
+import com.google.gerrit.extensions.config.FactoryModule;
+import com.google.gerrit.extensions.registration.DynamicSet;
+import com.google.gerrit.extensions.webui.GwtPlugin;
+import com.google.gerrit.extensions.webui.TopMenu;
+import com.google.gerrit.extensions.webui.WebUiPlugin;
+import com.google.gerrit.server.config.PluginConfigFactory;
+import com.google.inject.Inject;
+import org.eclipse.jgit.lib.Config;
+
+public class ClientModule extends FactoryModule {
+ private final boolean enableUI;
+
+ @Inject
+ public ClientModule(@PluginName String pluginName, PluginConfigFactory pluginCfgFactory) {
+ this(pluginCfgFactory.getGlobalPluginConfig(pluginName));
+ }
+
+ public ClientModule(Config c) {
+ boolean enableREST = c.getBoolean("reviewers", null, "enableREST", true);
+ this.enableUI = enableREST ? c.getBoolean("reviewers", null, "enableUI", true) : false;
+ }
+
+ public ClientModule(boolean enableUI) {
+ this.enableUI = enableUI;
+ }
+
+ @Override
+ protected void configure() {
+ if (enableUI) {
+ DynamicSet.bind(binder(), TopMenu.class).to(ReviewersTopMenu.class);
+ DynamicSet.bind(binder(), WebUiPlugin.class).toInstance(new GwtPlugin("reviewers"));
+ }
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/Module.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/Module.java
index 98dad1b..ea140b5 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/Module.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/Module.java
@@ -1,4 +1,4 @@
-// Copyright (C) 2013 The Android Open Source Project
+// Copyright (C) 2018 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -14,57 +14,24 @@
package com.googlesource.gerrit.plugins.reviewers;
-import static com.google.gerrit.server.project.ProjectResource.PROJECT_KIND;
-
import com.google.gerrit.extensions.annotations.PluginName;
-import com.google.gerrit.extensions.config.FactoryModule;
-import com.google.gerrit.extensions.events.RevisionCreatedListener;
-import com.google.gerrit.extensions.registration.DynamicSet;
-import com.google.gerrit.extensions.restapi.RestApiModule;
-import com.google.gerrit.extensions.webui.GwtPlugin;
-import com.google.gerrit.extensions.webui.TopMenu;
-import com.google.gerrit.extensions.webui.WebUiPlugin;
import com.google.gerrit.server.config.PluginConfigFactory;
+import com.google.inject.AbstractModule;
import com.google.inject.Inject;
+import com.googlesource.gerrit.plugins.reviewers.server.BackendModule;
import org.eclipse.jgit.lib.Config;
-public class Module extends FactoryModule {
- private final boolean enableUI;
- private final boolean enableREST;
+public class Module extends AbstractModule {
+ private final Config c;
@Inject
public Module(@PluginName String pluginName, PluginConfigFactory pluginCfgFactory) {
- Config c = pluginCfgFactory.getGlobalPluginConfig(pluginName);
- this.enableREST = c.getBoolean("reviewers", null, "enableREST", true);
- this.enableUI = enableREST ? c.getBoolean("reviewers", null, "enableUI", true) : false;
- }
-
- public Module(boolean enableUI, boolean enableREST) {
- this.enableUI = enableUI;
- this.enableREST = enableREST;
+ c = pluginCfgFactory.getGlobalPluginConfig(pluginName);
}
@Override
protected void configure() {
- if (enableUI) {
- DynamicSet.bind(binder(), TopMenu.class).to(ReviewersTopMenu.class);
- DynamicSet.bind(binder(), WebUiPlugin.class).toInstance(new GwtPlugin("reviewers"));
- }
-
- DynamicSet.bind(binder(), RevisionCreatedListener.class).to(ChangeEventListener.class);
- factory(DefaultReviewers.Factory.class);
- factory(ReviewersConfig.Factory.class);
-
- if (enableREST) {
- install(
- new RestApiModule() {
- @Override
- protected void configure() {
- get(PROJECT_KIND, "reviewers").to(GetReviewers.class);
- put(PROJECT_KIND, "reviewers").to(PutReviewers.class);
- get(PROJECT_KIND, "suggest_reviewers").to(SuggestProjectReviewers.class);
- }
- });
- }
+ install(new BackendModule(c));
+ install(new ClientModule(c));
}
}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/Action.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/common/Action.java
similarity index 91%
rename from src/main/java/com/googlesource/gerrit/plugins/reviewers/Action.java
rename to src/main/java/com/googlesource/gerrit/plugins/reviewers/common/Action.java
index 04a15fc..ebda5e1 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/Action.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/common/Action.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.googlesource.gerrit.plugins.reviewers;
+package com.googlesource.gerrit.plugins.reviewers.common;
public enum Action {
ADD,
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/BackendModule.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/BackendModule.java
new file mode 100644
index 0000000..08b49e0
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/BackendModule.java
@@ -0,0 +1,62 @@
+// Copyright (C) 2018 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.googlesource.gerrit.plugins.reviewers.server;
+
+import static com.google.gerrit.server.project.ProjectResource.PROJECT_KIND;
+
+import com.google.gerrit.extensions.annotations.PluginName;
+import com.google.gerrit.extensions.config.FactoryModule;
+import com.google.gerrit.extensions.events.RevisionCreatedListener;
+import com.google.gerrit.extensions.registration.DynamicSet;
+import com.google.gerrit.extensions.restapi.RestApiModule;
+import com.google.gerrit.server.config.PluginConfigFactory;
+import com.google.inject.Inject;
+import org.eclipse.jgit.lib.Config;
+
+public class BackendModule extends FactoryModule {
+ public final boolean enableREST;
+
+ @Inject
+ public BackendModule(@PluginName String pluginName, PluginConfigFactory pluginCfgFactory) {
+ this(pluginCfgFactory.getGlobalPluginConfig(pluginName));
+ }
+
+ public BackendModule(Config c) {
+ this.enableREST = c.getBoolean("reviewers", null, "enableREST", true);
+ }
+
+ public BackendModule(boolean enableREST) {
+ this.enableREST = enableREST;
+ }
+
+ @Override
+ protected void configure() {
+ DynamicSet.bind(binder(), RevisionCreatedListener.class).to(ChangeEventListener.class);
+ factory(DefaultReviewers.Factory.class);
+ factory(ReviewersConfig.Factory.class);
+
+ if (enableREST) {
+ install(
+ new RestApiModule() {
+ @Override
+ protected void configure() {
+ get(PROJECT_KIND, "reviewers").to(GetReviewers.class);
+ put(PROJECT_KIND, "reviewers").to(PutReviewers.class);
+ get(PROJECT_KIND, "suggest_reviewers").to(SuggestProjectReviewers.class);
+ }
+ });
+ }
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/ChangeEventListener.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ChangeEventListener.java
similarity index 99%
rename from src/main/java/com/googlesource/gerrit/plugins/reviewers/ChangeEventListener.java
rename to src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ChangeEventListener.java
index aa17344..2bf1295 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/ChangeEventListener.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ChangeEventListener.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.googlesource.gerrit.plugins.reviewers;
+package com.googlesource.gerrit.plugins.reviewers.server;
import com.google.common.base.Preconditions;
import com.google.common.base.Strings;
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/DefaultReviewers.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/DefaultReviewers.java
similarity index 97%
rename from src/main/java/com/googlesource/gerrit/plugins/reviewers/DefaultReviewers.java
rename to src/main/java/com/googlesource/gerrit/plugins/reviewers/server/DefaultReviewers.java
index 1d5dac4..8d4cb30 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/DefaultReviewers.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/DefaultReviewers.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.googlesource.gerrit.plugins.reviewers;
+package com.googlesource.gerrit.plugins.reviewers.server;
import com.google.gerrit.extensions.api.GerritApi;
import com.google.gerrit.extensions.api.changes.AddReviewerInput;
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/GetReviewers.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/GetReviewers.java
similarity index 96%
rename from src/main/java/com/googlesource/gerrit/plugins/reviewers/GetReviewers.java
rename to src/main/java/com/googlesource/gerrit/plugins/reviewers/server/GetReviewers.java
index b0e735f..dccc000 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/GetReviewers.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/GetReviewers.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.googlesource.gerrit.plugins.reviewers;
+package com.googlesource.gerrit.plugins.reviewers.server;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.BadRequestException;
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/PutReviewers.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/PutReviewers.java
similarity index 96%
rename from src/main/java/com/googlesource/gerrit/plugins/reviewers/PutReviewers.java
rename to src/main/java/com/googlesource/gerrit/plugins/reviewers/server/PutReviewers.java
index 7e36503..3d17659 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/PutReviewers.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/PutReviewers.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.googlesource.gerrit.plugins.reviewers;
+package com.googlesource.gerrit.plugins.reviewers.server;
import com.google.gerrit.extensions.annotations.PluginName;
import com.google.gerrit.extensions.restapi.AuthException;
@@ -25,17 +25,18 @@
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.server.account.AccountResolver;
import com.google.gerrit.server.git.meta.MetaDataUpdate;
-import com.google.gerrit.server.restapi.group.GroupsCollection;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.permissions.ProjectPermission;
import com.google.gerrit.server.project.ProjectCache;
import com.google.gerrit.server.project.ProjectResource;
+import com.google.gerrit.server.restapi.group.GroupsCollection;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.Provider;
import com.google.inject.Singleton;
-import com.googlesource.gerrit.plugins.reviewers.PutReviewers.Input;
+import com.googlesource.gerrit.plugins.reviewers.common.Action;
+import com.googlesource.gerrit.plugins.reviewers.server.PutReviewers.Input;
import java.io.IOException;
import java.util.List;
import org.eclipse.jgit.errors.ConfigInvalidException;
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/ReviewerFilterSection.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ReviewerFilterSection.java
similarity index 94%
rename from src/main/java/com/googlesource/gerrit/plugins/reviewers/ReviewerFilterSection.java
rename to src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ReviewerFilterSection.java
index 1112bdd..0dd354e 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/ReviewerFilterSection.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ReviewerFilterSection.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.googlesource.gerrit.plugins.reviewers;
+package com.googlesource.gerrit.plugins.reviewers.server;
import java.util.Set;
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/ReviewersConfig.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ReviewersConfig.java
similarity index 98%
rename from src/main/java/com/googlesource/gerrit/plugins/reviewers/ReviewersConfig.java
rename to src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ReviewersConfig.java
index 53d86af..b7daadf 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/ReviewersConfig.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/ReviewersConfig.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.googlesource.gerrit.plugins.reviewers;
+package com.googlesource.gerrit.plugins.reviewers.server;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
diff --git a/src/main/java/com/googlesource/gerrit/plugins/reviewers/SuggestProjectReviewers.java b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/SuggestProjectReviewers.java
similarity index 97%
rename from src/main/java/com/googlesource/gerrit/plugins/reviewers/SuggestProjectReviewers.java
rename to src/main/java/com/googlesource/gerrit/plugins/reviewers/server/SuggestProjectReviewers.java
index 6e44e39..34419fb 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/reviewers/SuggestProjectReviewers.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/reviewers/server/SuggestProjectReviewers.java
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-package com.googlesource.gerrit.plugins.reviewers;
+package com.googlesource.gerrit.plugins.reviewers.server;
import com.google.gerrit.extensions.common.AccountVisibility;
import com.google.gerrit.extensions.common.SuggestedReviewerInfo;
@@ -21,14 +21,14 @@
import com.google.gerrit.reviewdb.client.Account;
import com.google.gerrit.reviewdb.server.ReviewDb;
import com.google.gerrit.server.IdentifiedUser;
-import com.google.gerrit.server.restapi.change.ReviewersUtil;
-import com.google.gerrit.server.restapi.change.ReviewersUtil.VisibilityControl;
-import com.google.gerrit.server.restapi.change.SuggestReviewers;
import com.google.gerrit.server.config.GerritServerConfig;
import com.google.gerrit.server.permissions.PermissionBackend;
import com.google.gerrit.server.permissions.PermissionBackendException;
import com.google.gerrit.server.permissions.ProjectPermission;
import com.google.gerrit.server.project.ProjectResource;
+import com.google.gerrit.server.restapi.change.ReviewersUtil;
+import com.google.gerrit.server.restapi.change.ReviewersUtil.VisibilityControl;
+import com.google.gerrit.server.restapi.change.SuggestReviewers;
import com.google.gwtorm.server.OrmException;
import com.google.inject.Inject;
import com.google.inject.Provider;
diff --git a/src/main/resources/Documentation/build.md b/src/main/resources/Documentation/build.md
index 29a4928..b2f5da6 100644
--- a/src/main/resources/Documentation/build.md
+++ b/src/main/resources/Documentation/build.md
@@ -44,3 +44,11 @@
```
./tools/eclipse/project.py
```
+
+### Backend-only
+
+There are two separate plugin targets, one containing UI components
+(`reviewers`), and one with only backend components (`reviewers-backend`). The
+UI plugin is only compatible with the GWT UI, and does not work with PolyGerrit.
+Both build instructions will work with either `reviewers` or
+`reviewers-backend`.
