Support Relative Paths for Reverse Proxy (#1041)

caoccao · vanch3d · web-flow · commit dfdce15b4178 · 2025-07-18T13:14:55.000+02:00
Co-authored-by: Nicolas Van Labeke &lt;nicolas.vanlabeke@hivemq.com&gt;
diff --git a/.github/workflows/check-frontend.yml b/.github/workflows/check-frontend.yml
@@ -68,7 +68,7 @@ jobs:
           working-directory: ./hivemq-edge-frontend/
 
       - name: 🏗️ Build Application
-        run: pnpm run build
+        run: pnpm run build --base=/
 
       - name: Upload artifact
         uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
diff --git a/.gitignore b/.gitignore
@@ -21,3 +21,4 @@ out/
 /hivemq-edge/src/distribution/log/migration.log
 /hivemq-edge/src/test/resources/opc-large-config.xml
 /edge-plugins/.kotlin/
+.vscode/
diff --git a/ext/hivemq-edge-openapi-2025.12-SNAPSHOT.yaml b/ext/hivemq-edge-openapi-2025.12-SNAPSHOT.yaml
@@ -3842,6 +3842,12 @@ paths:
     get:
       description: Obtain a list of available protocol adapter types.
       operationId: getAdapterTypes
+      parameters:
+        - name: X-Original-URI
+          in: header
+          required: false
+          schema:
+            type: string
       responses:
         '200':
           content:
diff --git a/ext/openAPI/paths/api_v1_management_protocol-adapters_types.yaml b/ext/openAPI/paths/api_v1_management_protocol-adapters_types.yaml
@@ -1,6 +1,12 @@
 get:
   description: Obtain a list of available protocol adapter types.
   operationId: getAdapterTypes
+  parameters:
+    - name: X-Original-URI
+      in: header
+      required: false
+      schema:
+        type: string
   responses:
     '200':
       content:
diff --git a/hivemq-edge-frontend/.env.test b/hivemq-edge-frontend/.env.test
@@ -1,2 +1,2 @@
-VITE_API_BASE_URL=http://localhost:8080
+VITE_API_BASE_URL=http://localhost:8080/
 
diff --git a/hivemq-edge-frontend/README.md b/hivemq-edge-frontend/README.md
@@ -86,7 +86,10 @@ The web app will be running on http://localhost:3000/app/login
 To build a version ready for deployment, run the command
 
 ```shell
+# Relative path for production.
 pnpm run build
+# Absolute path for dev / test.
+pnpm run build --base=/
 ```
 
 ## OpenAPI
diff --git a/hivemq-edge-frontend/build.gradle.kts b/hivemq-edge-frontend/build.gradle.kts
@@ -23,7 +23,7 @@ val buildFrontend by tasks.registering(PnpmTask::class) {
   environment = mapOf(
     "NODE_OPTIONS" to "--max-old-space-size=4096",
   )
-  pnpmCommand.set(listOf("build", "--base=/app"))
+  pnpmCommand.set(listOf("build", "--base=./"))
   dependsOn(tasks.pnpmInstall)
   inputs.dir(project.fileTree("src"))
   inputs.dir(project.fileTree("public"))
diff --git a/hivemq-edge-frontend/cypress/e2e/Login/login.spec.cy.ts b/hivemq-edge-frontend/cypress/e2e/Login/login.spec.cy.ts
@@ -25,7 +25,7 @@ describe('Login Page', () => {
   })
 
   it('should redirect to login', () => {
-    cy.visit('/app')
+    cy.visit('/app/')
     cy.url().should('contain', '/login')
   })
 
diff --git a/hivemq-edge-frontend/cypress/pages/Page.ts b/hivemq-edge-frontend/cypress/pages/Page.ts
@@ -5,7 +5,7 @@ export abstract class Page {
     // so we must tell it to visit our website with the `cy.visit()` command.
     // Since we want to visit the same URL at the start of all our tests,
     // we include it in our beforeEach function so that it runs before each test
-    cy.visit(route || '/app', {
+    cy.visit(route || '/app/', {
       onBeforeLoad(win: Cypress.AUTWindow) {
         // This config need to be more controllable
         win.localStorage.setItem('edge.privacy', JSON.stringify({ heapAnalytics: false, sentry: false }))
diff --git a/hivemq-edge-frontend/src/__test-utils__/adapters/simulation.ts b/hivemq-edge-frontend/src/__test-utils__/adapters/simulation.ts
@@ -9,7 +9,7 @@ export const MOCK_PROTOCOL_SIMULATION: ProtocolAdapter = {
     'Simulates device message traffic to enable observation of adapter behavior without the need to configure actual devices.',
   url: 'https://docs.hivemq.com/hivemq-edge/protocol-adapters.html#simulation-adapter',
   version: 'Development Version',
-  logoUrl: '/module/images/hivemq-icon.png',
+  logoUrl: '../../module/images/hivemq-icon.png',
   author: 'HiveMQ',
   installed: true,
   capabilities: ['READ'],
diff --git a/hivemq-edge-frontend/src/api/hooks/useProtocolAdapters/__handlers__/index.ts b/hivemq-edge-frontend/src/api/hooks/useProtocolAdapters/__handlers__/index.ts
@@ -200,7 +200,7 @@ export const mockProtocolAdapter: ProtocolAdapter = {
   description: 'Without needing to configure real devices, simulate traffic from an edge device into HiveMQ Edge.',
   url: 'https://docs.hivemq.com/hivemq-edge/protocol-adapters.html#simulation-adapter',
   version: 'Development Version',
-  logoUrl: '/module/images/hivemq-icon.png',
+  logoUrl: '../../module/images/hivemq-icon.png',
   author: 'HiveMQ',
   installed: true,
   capabilities: ['READ'],
diff --git a/hivemq-edge-frontend/src/api/hooks/useProtocolAdapters/useGetAdapterTypes.spec.ts b/hivemq-edge-frontend/src/api/hooks/useProtocolAdapters/useGetAdapterTypes.spec.ts
@@ -26,7 +26,7 @@ describe('useGetAdapterTypes', () => {
       expect.objectContaining({
         id: 'simulation',
         installed: true,
-        logoUrl: '/module/images/hivemq-icon.png',
+        logoUrl: '../../module/images/hivemq-icon.png',
         name: 'Simulated Edge Device',
         protocol: 'Simulation',
         tags: ['tag1', 'tag2', 'tag3'],
diff --git a/hivemq-edge-frontend/src/config/index.ts b/hivemq-edge-frontend/src/config/index.ts
@@ -27,13 +27,31 @@ interface configType {
   }
 }
 
+/**
+ * @experimental This function is used to determine the base path for the API in production.
+ */
+function getApiBaseUrl(): string {
+  if (import.meta.env.MODE === 'development') {
+    return import.meta.env.VITE_API_BASE_URL
+  }
+  const url = window.location.href
+  if (url.endsWith('/app')) {
+    return url.substring(0, url.length - 4)
+  }
+  const index = url.lastIndexOf('/app/')
+  if (index !== -1) {
+    return url.substring(0, index)
+  }
+  return url
+}
+
 const config: configType = {
   environment: import.meta.env.MODE,
 
   isDevMode: import.meta.env.MODE === 'development',
   isProdMode: import.meta.env.MODE === 'production',
 
-  apiBaseUrl: import.meta.env.VITE_API_BASE_URL,
+  apiBaseUrl: getApiBaseUrl(),
 
   version: import.meta.env.VITE_APP_VERSION,
   documentationUrl: import.meta.env.VITE_APP_DOCUMENTATION,
diff --git a/hivemq-edge-frontend/src/modules/App/routes.tsx b/hivemq-edge-frontend/src/modules/App/routes.tsx
@@ -26,6 +26,25 @@ const ProtocolAdapters = lazy(() => import('@/modules/ProtocolAdapters/component
 
 import { dataHubRoutes } from '@/extensions/datahub/routes.tsx'
 import { MappingType } from '@/modules/Mappings/types.ts'
+import config from '@/config'
+
+/**
+ * @experimental This function is used to determine the base path for the router in production.
+ */
+function getBasename(): string {
+  if (config.isDevMode) {
+    return '/app'
+  }
+  const pathname = window.location.pathname
+  if (pathname.endsWith('/app')) {
+    return pathname.substring(0, pathname.length - 4)
+  }
+  const index = pathname.lastIndexOf('/app/')
+  if (index !== -1) {
+    return pathname.substring(0, index + 4)
+  }
+  return pathname
+}
 
 export const routes = createBrowserRouter(
   [
@@ -132,5 +151,5 @@ export const routes = createBrowserRouter(
       element: <LoginPage />,
     },
   ],
-  { basename: '/app' }
+  { basename: getBasename() }
 )
diff --git a/hivemq-edge-frontend/src/modules/ProtocolAdapters/hooks/useGetAdapterInfo.spec.ts b/hivemq-edge-frontend/src/modules/ProtocolAdapters/hooks/useGetAdapterInfo.spec.ts
@@ -40,7 +40,7 @@ describe('useGetAdapterInfo', () => {
           'Without needing to configure real devices, simulate traffic from an edge device into HiveMQ Edge.',
         id: 'simulation',
         installed: true,
-        logoUrl: '/module/images/hivemq-icon.png',
+        logoUrl: '../../module/images/hivemq-icon.png',
         name: 'Simulated Edge Device',
         protocol: 'Simulation',
       })
diff --git a/hivemq-edge-frontend/vite.config.ts b/hivemq-edge-frontend/vite.config.ts
@@ -6,6 +6,7 @@ import istanbul from 'vite-plugin-istanbul'
 
 // https://vitejs.dev/config/
 export default defineConfig({
+  base: './',
   resolve: {
     alias: {
       '@': path.resolve(__dirname, './src'),
diff --git a/hivemq-edge/src/main/java/com/hivemq/api/resources/impl/ProtocolAdapterApiUtils.java b/hivemq-edge/src/main/java/com/hivemq/api/resources/impl/ProtocolAdapterApiUtils.java
@@ -30,11 +30,12 @@
 import com.hivemq.configuration.service.ConfigurationService;
 import com.hivemq.edge.HiveMQEdgeConstants;
 import com.hivemq.edge.VersionProvider;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
 import com.hivemq.http.HttpConstants;
 import com.hivemq.protocols.ProtocolAdapterManager;
 import com.hivemq.protocols.ProtocolAdapterSchemaManager;
+import org.apache.commons.lang3.StringUtils;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -70,15 +71,29 @@ public static ProtocolAdapter convertInstalledAdapterType(
             final @NotNull ProtocolAdapterManager adapterManager,
             final @NotNull ProtocolAdapterInformation info,
             final @NotNull ConfigurationService configurationService,
-            final @NotNull VersionProvider versionProvider) {
+            final @NotNull VersionProvider versionProvider,
+            final @Nullable String xOriginalURI) {
 
         Preconditions.checkNotNull(adapterManager);
         Preconditions.checkNotNull(info);
         Preconditions.checkNotNull(configurationService);
         String logoUrl = info.getLogoUrl();
-        //noinspection ConstantValue
-        if (logoUrl != null) {
-            logoUrl = logoUrl.startsWith("/") ? "/module" + logoUrl : "/module/" + logoUrl;
+        if (StringUtils.isNotBlank(logoUrl)) {
+            while (logoUrl.startsWith(HttpConstants.SLASH)) {
+                logoUrl = logoUrl.substring(HttpConstants.SLASH.length());
+            }
+            if (StringUtils.isEmpty(xOriginalURI)) {
+                // We are not behind a reverse proxy, so we can use the absolute path.
+                logoUrl = "/module/" + logoUrl;
+            } else {
+                // We are behind a reverse proxy, so we need to use the relative path.
+                final int index = xOriginalURI.lastIndexOf("/api/v1/");
+                if (index == -1) {
+                    logoUrl = "../../module/" + logoUrl;
+                } else {
+                    logoUrl = xOriginalURI.substring(0, index) + "/module/" + logoUrl;
+                }
+            }
             logoUrl = applyAbsoluteServerAddressInDeveloperMode(logoUrl, configurationService);
         } else {
             // although it is marked as not null it is input from outside (possible customer adapter),
@@ -92,8 +107,10 @@ public static ProtocolAdapter convertInstalledAdapterType(
             return null;
         }
 
-        final ProtocolAdapterSchemaManager protocolAdapterSchemaManager =
-                new ProtocolAdapterSchemaManager(objectMapper, adapterManager.writingEnabled() ? info.configurationClassNorthAndSouthbound() : info.configurationClassNorthbound());
+        final ProtocolAdapterSchemaManager protocolAdapterSchemaManager = new ProtocolAdapterSchemaManager(objectMapper,
+                adapterManager.writingEnabled() ?
+                        info.configurationClassNorthAndSouthbound() :
+                        info.configurationClassNorthbound());
 
 
         final String rawVersion = info.getVersion();
@@ -144,7 +161,8 @@ public static ProtocolAdapter convertInstalledAdapterType(
     }
 
     private static @NotNull Set<ProtocolAdapter.Capability> getCapabilities(
-            final @NotNull ProtocolAdapterManager adapterManager, final @NotNull ProtocolAdapterInformation info) {
+            final @NotNull ProtocolAdapterManager adapterManager,
+            final @NotNull ProtocolAdapterInformation info) {
         final Set<ProtocolAdapter.Capability> capabilities = new HashSet<>();
         for (final ProtocolAdapterCapability capability : info.getCapabilities()) {
             if (capability == ProtocolAdapterCapability.WRITE && adapterManager.writingEnabled()) {
@@ -163,13 +181,16 @@ public static ProtocolAdapter convertInstalledAdapterType(
      * @return The instance to be sent across the API
      */
     public static ProtocolAdapter convertModuleAdapterType(
-            final @NotNull Module module, final @NotNull ConfigurationService configurationService) {
+            final @NotNull Module module,
+            final @NotNull ConfigurationService configurationService) {
 
         Preconditions.checkNotNull(module);
         Preconditions.checkNotNull(configurationService);
         String logoUrl = module.getLogoUrl() == null ? null : module.getLogoUrl().getUrl();
-        final String documentationUrl = module.getDocumentationLink() == null ? null : module.getDocumentationLink().getUrl();
-        final String provisioningUrl = module.getProvisioningLink() == null ? null : module.getProvisioningLink().getUrl();
+        final String documentationUrl =
+                module.getDocumentationLink() == null ? null : module.getDocumentationLink().getUrl();
+        final String provisioningUrl =
+                module.getProvisioningLink() == null ? null : module.getProvisioningLink().getUrl();
         if (logoUrl != null) {
             logoUrl = logoUrl.startsWith("/") ? "/module" + logoUrl : logoUrl;
             logoUrl = applyAbsoluteServerAddressInDeveloperMode(logoUrl, configurationService);
@@ -192,7 +213,8 @@ public static ProtocolAdapter convertModuleAdapterType(
     }
 
     public static @NotNull String applyAbsoluteServerAddressInDeveloperMode(
-            final @NotNull String logoUrl, final @NotNull ConfigurationService configurationService) {
+            final @NotNull String logoUrl,
+            final @NotNull ConfigurationService configurationService) {
         Preconditions.checkNotNull(logoUrl);
         Preconditions.checkNotNull(configurationService);
         if (Boolean.getBoolean(HiveMQEdgeConstants.DEVELOPMENT_MODE)) {
diff --git a/hivemq-edge/src/main/java/com/hivemq/api/resources/impl/ProtocolAdaptersResourceImpl.java b/hivemq-edge/src/main/java/com/hivemq/api/resources/impl/ProtocolAdaptersResourceImpl.java
@@ -150,8 +150,7 @@ public ProtocolAdaptersResourceImpl(
     }
 
     @Override
-    public @NotNull Response getAdapterTypes() {
-
+    public @NotNull Response getAdapterTypes(final @Nullable String xOriginalURI) {
         //-- Obtain the adapters installed by the runtime (these will be marked as installed = true).
         final Set<ProtocolAdapter> installedAdapters =
                 protocolAdapterManager.getAllAvailableAdapterTypes().values().stream().map(installedAdapter -> {
@@ -160,7 +159,8 @@ public ProtocolAdaptersResourceImpl(
                                 protocolAdapterManager,
                                 installedAdapter,
                                 configurationService,
-                                versionProvider);
+                                versionProvider,
+                                xOriginalURI);
                     } catch (final Throwable t) {
                         if (logger.isWarnEnabled()) {
                             logger.warn("Not able to properly load protocol adapter.", t);
diff --git a/hivemq-edge/src/main/java/com/hivemq/api/resources/impl/RootResource.java b/hivemq-edge/src/main/java/com/hivemq/api/resources/impl/RootResource.java
@@ -20,6 +20,8 @@
 import jakarta.ws.rs.GET;
 import jakarta.ws.rs.Path;
 import jakarta.ws.rs.core.Response;
+import org.jetbrains.annotations.NotNull;
+
 import java.net.URI;
 
 @Path("/")
@@ -31,8 +33,8 @@ public RootResource() {
     }
 
     @GET
-    public Response getRoot() {
-        return Response.temporaryRedirect(URI.create("/app/")).build();
+    public @NotNull Response getRoot() {
+        return Response.temporaryRedirect(URI.create("app/")).build();
     }
 
 }
diff --git a/hivemq-edge/src/main/java/com/hivemq/http/handlers/WebAppHandler.java b/hivemq-edge/src/main/java/com/hivemq/http/handlers/WebAppHandler.java
diff --git a/hivemq-edge/src/test/java/com/hivemq/embedded/internal/EmbeddedHiveMQImplHttpTest.java b/hivemq-edge/src/test/java/com/hivemq/embedded/internal/EmbeddedHiveMQImplHttpTest.java
diff --git a/hivemq-edge/src/test/java/com/hivemq/embedded/internal/EmbeddedHiveMQImplHttpsTest.java b/hivemq-edge/src/test/java/com/hivemq/embedded/internal/EmbeddedHiveMQImplHttpsTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`		`-VITE_API_BASE_URL=http://localhost:8080`
	`1`	`+VITE_API_BASE_URL=http://localhost:8080/`
`2`	`2`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ val buildFrontend by tasks.registering(PnpmTask::class) {`
`23`	`23`	`environment = mapOf(`
`24`	`24`	`"NODE_OPTIONS" to "--max-old-space-size=4096",`
`25`	`25`	`)`
`26`		`- pnpmCommand.set(listOf("build", "--base=/app"))`
	`26`	`+ pnpmCommand.set(listOf("build", "--base=./"))`
`27`	`27`	`dependsOn(tasks.pnpmInstall)`
`28`	`28`	`inputs.dir(project.fileTree("src"))`
`29`	`29`	`inputs.dir(project.fileTree("public"))`