commit f0301a2d00950cc1a67f6f917ff0a881230a2a27
author Dariusz Luksza <dariusz@luksza.org> Sat Sep 16 13:38:58 2023 +0100
committer Dariusz Luksza <dariusz@luksza.org> Mon Sep 18 19:01:33 2023 +0100
tree f5940e811c8a3316b98fc514a2e8438d595f8ce3
parent a590f25374f3fb2b9e20b2663be6b5c48d578f7f

Make HttpCanonicalWebUrlProvider extendable

Change HttpCanonicalWebUrlProvider constructor access to `protected` to
make this clas extendable. This way plugins like virtualhost can change
value of `canonicalWebUrl` based on the HTTP context request.

The problem with different canonical web urls comes into play when
virtualhost and download-commands plugins are used together. When
looking at the virtual host site and opening `Downloads` dialog, the
main host canononical web url will be used in download urls. This may
confuse users.

In order to fix that problem we need to make the default
HttpCanonicalWebUrlProvider extendable. Then we can bind it to a custom
implemenation in virtualhost plugin.

Bug: Issue 299833801
Release-Notes: Allow modules to provide different logic for the HTTP canonicalWebUrl
Change-Id: I8321b153782e0bf8131c66ebe477902a434c6dc1

java/com/google/gerrit/common/UsedAt.java

diff --git a/java/com/google/gerrit/common/UsedAt.java b/java/com/google/gerrit/common/UsedAt.java
index 91a4da6..5ea5177 100644
--- a/java/com/google/gerrit/common/UsedAt.java
+++ b/java/com/google/gerrit/common/UsedAt.java
@@ -46,7 +46,8 @@
     PLUGIN_PULL_REPLICATION,
     PLUGIN_SERVICEUSER,
     PLUGIN_WEBSESSION_FLATFILE,
-    MODULE_GIT_REFS_FILTER
+    MODULE_GIT_REFS_FILTER,
+    MODULE_VIRTUALHOST
   }
 
   /** Reference to the project that uses the method annotated with this annotation. */

java/com/google/gerrit/httpd/HttpCanonicalWebUrlProvider.java

diff --git a/java/com/google/gerrit/httpd/HttpCanonicalWebUrlProvider.java b/java/com/google/gerrit/httpd/HttpCanonicalWebUrlProvider.java
index 6943faa..85dc200 100644
--- a/java/com/google/gerrit/httpd/HttpCanonicalWebUrlProvider.java
+++ b/java/com/google/gerrit/httpd/HttpCanonicalWebUrlProvider.java
@@ -14,6 +14,8 @@
 
 package com.google.gerrit.httpd;
 
+import com.google.gerrit.common.UsedAt;
+import com.google.gerrit.common.UsedAt.Project;
 import com.google.gerrit.server.config.CanonicalWebUrlProvider;
 import com.google.gerrit.server.config.GerritServerConfig;
 import com.google.inject.Inject;
@@ -30,7 +32,8 @@
   private Provider<HttpServletRequest> requestProvider;
 
   @Inject
-  HttpCanonicalWebUrlProvider(@GerritServerConfig Config config) {
+  @UsedAt(Project.MODULE_VIRTUALHOST)
+  protected HttpCanonicalWebUrlProvider(@GerritServerConfig Config config) {
     super(config);
   }