Merge branch 'main' into dan/hdx-2622-refactor-tasks

dhable · web-flow · commit 3804b6e0770d · 2025-10-21T05:43:43.000-05:00
diff --git a/.changeset/feat-subpath-config.md b/.changeset/feat-subpath-config.md
@@ -0,0 +1,9 @@
+---
+'@hyperdx/app': minor
+---
+
+feat: Add subpath configuration support
+
+This change allows the HyperDX frontend to be served from a subpath (e.g.,
+`/hyperdx`). It includes updated Next.js, NGINX, and Traefik configurations,
+along with documentation for the new setup.
diff --git a/.changeset/polite-dots-hear.md b/.changeset/polite-dots-hear.md
@@ -0,0 +1,5 @@
+---
+"@hyperdx/api": patch
+---
+
+revert: api esbuild
diff --git a/.env b/.env
@@ -20,6 +20,7 @@ HYPERDX_APP_PORT=8080
 HYPERDX_APP_URL=http://localhost
 HYPERDX_LOG_LEVEL=debug
 HYPERDX_OPAMP_PORT=4320
+HYPERDX_BASE_PATH=
 
 # Otel/Clickhouse config
 HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE=default
diff --git a/docker-compose.dev.yml b/docker-compose.dev.yml
@@ -83,5 +83,29 @@ services:
       interval: 1s
       timeout: 1s
       retries: 60
+
+  # nginx:
+  #   image: nginx:alpine
+  #   ports:
+  #     - '4040:4040'
+  #   volumes:
+  #     - ./proxy/nginx/nginx.conf.template:/etc/nginx/templates/default.conf.template:ro
+  #   environment:
+  #     HYPERDX_BASE_PATH: ${HYPERDX_BASE_PATH:-/}
+  #   network_mode: host
+  #   restart: always
+
+  # traefik:
+  #   image: traefik:latest
+  #   ports:
+  #     - '4040:4040'
+  #   volumes:
+  #     - ./proxy/traefik/traefik.yml:/etc/traefik/traefik.yml:ro
+  #     - ./proxy/traefik/config.yml:/etc/traefik/dynamic/config.yml:ro
+  #   environment:
+  #     HYPERDX_BASE_PATH: ${HYPERDX_BASE_PATH:-/}
+  #   network_mode: host
+  #   restart: always
+
 networks:
   internal:
diff --git a/docker/hyperdx/Dockerfile b/docker/hyperdx/Dockerfile
@@ -50,6 +50,8 @@ ENV NEXT_OUTPUT_STANDALONE true
 ENV NEXT_PUBLIC_IS_LOCAL_MODE false
 ENV NX_DAEMON=false
 RUN npx nx run-many --target=build --projects=@hyperdx/common-utils,@hyperdx/api,@hyperdx/app
+RUN rm -rf node_modules && yarn workspaces focus @hyperdx/api --production
+
 
 # prod ############################################################################################
 FROM node:${NODE_VERSION}-alpine AS prod
@@ -66,7 +68,10 @@ USER node
 
 # Set up API and App
 WORKDIR /app
-COPY --chown=node:node --from=builder /app/packages/api/dist ./packages/api
+COPY --chown=node:node --from=builder /app/node_modules ./node_modules
+COPY --chown=node:node --from=builder /app/packages/api/build ./packages/api/build
+COPY --chown=node:node --from=builder /app/packages/common-utils/dist ./packages/common-utils/dist
+COPY --chown=node:node --from=node_base /app/packages/common-utils/node_modules ./packages/common-utils/node_modules
 COPY --chown=node:node --from=builder /app/packages/app/.next/standalone ./packages/app
 COPY --chown=node:node --from=builder /app/packages/app/.next/static ./packages/app/packages/app/.next/static
 COPY --chown=node:node --from=builder /app/packages/app/public ./packages/app/packages/app/public
diff --git a/docker/hyperdx/entry.local.base.sh b/docker/hyperdx/entry.local.base.sh
@@ -67,9 +67,9 @@ echo "ClickHouse is ready!"
 npx concurrently \
   "--kill-others-on-fail" \
   "--names=API,APP,ALERT-TASK" \
-  "PORT=${HYPERDX_API_PORT:-8000} HYPERDX_APP_PORT=${HYPERDX_APP_PORT:-8080} node -r ./packages/api/tracing ./packages/api/index" \
+  "PORT=${HYPERDX_API_PORT:-8000} HYPERDX_APP_PORT=${HYPERDX_APP_PORT:-8080} node -r ./node_modules/@hyperdx/node-opentelemetry/build/src/tracing ./packages/api/build/index.js" \
   "cd ./packages/app/packages/app && HOSTNAME='0.0.0.0' HYPERDX_API_PORT=${HYPERDX_API_PORT:-8000} PORT=${HYPERDX_APP_PORT:-8080} node server.js" \
-  "node -r ./packages/api/tracing ./packages/api/tasks/index check-alerts" \
+  "node -r ./node_modules/@hyperdx/node-opentelemetry/build/src/tracing ./packages/api/build/tasks/index.js check-alerts" \
   > /var/log/app.log 2>&1 &
 
 echo ""
diff --git a/docker/hyperdx/entry.prod.sh b/docker/hyperdx/entry.prod.sh
@@ -16,6 +16,6 @@ echo ""
 npx concurrently \
   "--kill-others-on-fail" \
   "--names=API,APP,ALERT-TASK" \
-  "PORT=${HYPERDX_API_PORT:-8000} HYPERDX_APP_PORT=${HYPERDX_APP_PORT:-8080} node -r ./packages/api/tracing ./packages/api/index" \
+  "PORT=${HYPERDX_API_PORT:-8000} HYPERDX_APP_PORT=${HYPERDX_APP_PORT:-8080} node -r ./node_modules/@hyperdx/node-opentelemetry/build/src/tracing ./packages/api/build/index.js" \
   "cd ./packages/app/packages/app && HOSTNAME='0.0.0.0' HYPERDX_API_PORT=${HYPERDX_API_PORT:-8000} PORT=${HYPERDX_APP_PORT:-8080} node server.js" \
-  "node -r ./packages/api/tracing ./packages/api/tasks/index check-alerts"
+  "node -r ./node_modules/@hyperdx/node-opentelemetry/build/src/tracing ./packages/api/build/tasks/index.js check-alerts"
diff --git a/packages/api/Dockerfile b/packages/api/Dockerfile
@@ -49,6 +49,8 @@ USER node
 
 WORKDIR /app
 
-COPY --chown=node:node --from=builder /app/packages/api/dist ./
+COPY --chown=node:node --from=builder /app/node_modules ./node_modules
+COPY --chown=node:node --from=builder /app/packages/api/build ./packages/api/build
+COPY --chown=node:node --from=builder /app/packages/common-utils/dist ./packages/common-utils/dist
 
-ENTRYPOINT ["node", "-r", "./tracing", "./index"]
+ENTRYPOINT ["node", "-r", "@hyperdx/node-opentelemetry/build/src/tracing", "./packages/api/build/index.js"]
diff --git a/packages/api/package.json b/packages/api/package.json
@@ -63,7 +63,6 @@
     "@types/supertest": "^2.0.12",
     "@types/swagger-jsdoc": "^6",
     "@types/uuid": "^8.3.4",
-    "esbuild": "^0.25.5",
     "jest": "^28.1.3",
     "migrate-mongo": "^11.0.0",
     "nodemon": "^2.0.20",
@@ -79,10 +78,10 @@
     "typescript": "5.9.3"
   },
   "scripts": {
-    "start": "node ./dist/index.js",
+    "start": "node ./build/index.js",
     "dev": "DOTENV_CONFIG_PATH=.env.development nodemon --signal SIGTERM -e ts,json --exec 'ts-node' --transpile-only -r tsconfig-paths/register -r dotenv-expand/config -r '@hyperdx/node-opentelemetry/build/src/tracing' ./src/index.ts",
     "dev-task": "DOTENV_CONFIG_PATH=.env.development nodemon --signal SIGTERM -e ts,json --exec 'ts-node' --transpile-only -r tsconfig-paths/register -r dotenv-expand/config -r '@hyperdx/node-opentelemetry/build/src/tracing' ./src/tasks/index.ts",
-    "build": "tsc -p ./tsconfig.build.json && tsc-alias -p ./tsconfig.build.json && esbuild ../../node_modules/@hyperdx/node-opentelemetry/build/src/tracing --bundle --minify --platform=node --outfile=dist/tracing.js && esbuild ./build/src/index.js ./build/src/tasks/index.js --bundle --minify --platform=node --target=node22 --outdir=dist --alias:@='./src' && mkdir -p dist/opamp && cp -r src/opamp/proto dist/opamp/proto && rimraf ./build",
+    "build": "rimraf ./build && tsc && tsc-alias && cp -r ./src/opamp/proto ./build/opamp/",
     "lint": "npx eslint --quiet . --ext .ts",
     "lint:fix": "npx eslint . --ext .ts --fix",
     "ci:lint": "yarn lint && yarn tsc --noEmit",
diff --git a/packages/api/src/opamp/utils/protobuf.ts b/packages/api/src/opamp/utils/protobuf.ts
@@ -3,14 +3,10 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as protobuf from 'protobufjs';
 
-import { IS_PROD } from '@/config';
 import logger from '@/utils/logger';
 
 // Define the root path of the proto file
-const PROTO_PATH = path.resolve(
-  __dirname,
-  `${IS_PROD ? 'opamp' : '..'}/proto/opamp.proto`,
-);
+const PROTO_PATH = path.resolve(__dirname, '../proto/opamp.proto');
 
 // Load the OpAMP proto definition
 let root: protobuf.Root;
diff --git a/packages/api/tsconfig.json b/packages/api/tsconfig.json
@@ -5,9 +5,11 @@
     "paths": {
       "@/*": ["./*"]
     },
-    "rootDir": ".",
     "outDir": "build",
-    "moduleResolution": "Node16"
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2022"
   },
   "include": ["src", "migrations", "scripts"],
   "exclude": ["node_modules"]
diff --git a/packages/app/.env.development b/packages/app/.env.development
@@ -7,3 +7,4 @@ OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4318"
 OTEL_SERVICE_NAME="hdx-oss-dev-app"
 PORT=${HYPERDX_APP_PORT}
 NODE_OPTIONS="--max-http-header-size=131072"
+NEXT_PUBLIC_HYPERDX_BASE_PATH=
diff --git a/packages/app/next.config.js b/packages/app/next.config.js
@@ -8,7 +8,10 @@ const withNextra = require('nextra')({
   themeConfig: './src/nextra.config.tsx',
 });
 
+const basePath = process.env.NEXT_PUBLIC_HYPERDX_BASE_PATH;
+
 module.exports = {
+  basePath: basePath,
   experimental: {
     instrumentationHook: true,
     // External packages to prevent bundling issues with Next.js 14
@@ -57,8 +60,8 @@ module.exports = {
     productionBrowserSourceMaps: false,
     ...(process.env.NEXT_OUTPUT_STANDALONE === 'true'
       ? {
-        output: 'standalone',
-      }
+          output: 'standalone',
+        }
       : {}),
   }),
 };
diff --git a/proxy/README.md b/proxy/README.md
@@ -0,0 +1,74 @@
+# Proxy Configuration
+
+This directory contains configurations for running the HyperDX frontend behind a
+reverse proxy that serves the application under a specific subpath. This is
+useful for deployments where HyperDX is not at the root of a domain (e.g.,
+`http://example.com/hyperdx`).
+
+We provide configurations for two popular reverse proxies:
+
+- [Nginx](./nginx/nginx.conf.template)
+- [Traefik](./traefik/config.yml)
+
+## Environment Variables
+
+To configure the subpath, you need to set the following environment variables in
+your `.env` file.
+
+### `HYPERDX_BASE_PATH` and `NEXT_PUBLIC_HYPERDX_BASE_PATH`
+
+To serve the application from a subpath, two environment variables must be set
+to the **same value**:
+
+1.  `HYPERDX_BASE_PATH`: This is used by the reverse proxy (Nginx or Traefik) to
+    handle path routing and rewriting.
+2.  `NEXT_PUBLIC_HYPERDX_BASE_PATH`: This is used by the Next.js application to
+    generate correct asset links and API routes.
+
+- The value **must** start with a `/` if it's not an empty string (ex:
+  `/hyperdx`).
+- If you want to serve from the root, you can omit these variables or set them
+  to `/`.
+
+### `FRONTEND_URL`
+
+This variable should be set to the full public URL of the frontend, including
+the subpath. The API server uses this URL for various purposes such as
+generating absolute URLs for redirects, links in emails, or alerts.
+
+- It should be a full URL, including the protocol (`http` or `https`).
+- It should include the subpath defined in `HYPERDX_BASE_PATH`.
+
+**Example `.env` Configuration:**
+
+For local development with the subpath `/hyperdx`, your configuration would look
+like this:
+
+```
+HYPERDX_BASE_PATH=/hyperdx
+NEXT_PUBLIC_HYPERDX_BASE_PATH=/hyperdx
+FRONTEND_URL=http://localhost:4040/hyperdx
+```
+
+## How It Works
+
+The proxy configurations are designed to handle subpath routing with minimal
+changes to the application code. Here's a high-level overview of the logic:
+
+1.  **Root Redirect**: If a subpath is configured (e.g., `/hyperdx`), any
+    requests to the root (`/`) are automatically redirected to that subpath.
+    This ensures users always land on the correct URL.
+
+2.  **Path Rewriting**: The application's frontend code sometimes makes requests
+    to root-level paths (e.g., `/api/...` or `/_next/...`). The proxy intercepts
+    these requests, prepends the configured subpath, and forwards them to the
+    Next.js server. For example, a request for `/_next/static/chunk.js` becomes
+    a request for `/hyperdx/_next/static/chunk.js` before being sent to the
+    application.
+
+3.  **Direct Proxy**: Any requests that already include the correct subpath are
+    passed directly to the Next.js application, which is configured via
+    `basePath` to handle them correctly.
+
+This setup allows the frontend application to be developed as if it were running
+at the root, while the proxy transparently manages the subpath routing.
diff --git a/proxy/nginx/nginx.conf.template b/proxy/nginx/nginx.conf.template
@@ -0,0 +1,43 @@
+upstream app {
+    server 127.0.0.1:8080;
+}
+
+server {
+    listen 4040;
+
+    set $base_path "${HYPERDX_BASE_PATH}";
+    if ($base_path = "/") {
+        set $base_path "";
+    }
+
+    # Common proxy headers
+    proxy_http_version 1.1;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection 'upgrade';
+    proxy_set_header Host $host;
+    proxy_cache_bypass $http_upgrade;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+
+    # Redirect root to base path, if a base path is set
+    location = / {
+        if ($base_path != "") {
+            return 301 $base_path;
+        }
+        # If no base path, just proxy to the app
+        proxy_pass http://app;
+    }
+
+    # This handles assets and api calls made to the root and rewrites them to include the base path
+    location ~ ^(/api/|/_next/|/__ENV\.js$|/Icon32\.png$) {
+        # Note: $request_uri includes the original full path including query string
+        proxy_pass http://app$base_path$request_uri;
+    }
+
+    # Proxy requests that are already prefixed with the base path to the app
+    location ${HYPERDX_BASE_PATH} {
+        # The full request URI (e.g., /hyperdx/settings) is passed to the upstream
+        proxy_pass http://app;
+    }
+}
diff --git a/proxy/traefik/config.yml b/proxy/traefik/config.yml
@@ -0,0 +1,46 @@
+http:
+  routers:
+    # This handles the main app at the basepath
+    app-router:
+      entryPoints:
+        - web
+      rule: 'PathPrefix(`{{ env "HYPERDX_BASE_PATH" }}`)'
+      service: app-service
+
+    # This handles assets and api calls at the root and rewrites them
+    assets-api-router:
+      entryPoints:
+        - web
+      rule:
+        'PathPrefix(`/api`) || PathPrefix(`/_next`) || Path(`/__ENV.js`) ||
+        Path(`/Icon32.png`)'
+      service: app-service
+      middlewares:
+        - add-basepath
+
+    # This redirects from / to the basepath
+    root-redirect:
+      entryPoints:
+        - web
+      rule: 'Path(`/`)'
+      service: app-service # service is required, but redirect will happen first
+      middlewares:
+        - redirect-to-basepath
+
+  middlewares:
+    add-basepath:
+      addPrefix:
+        prefix: '{{ env "HYPERDX_BASE_PATH" }}'
+
+    redirect-to-basepath:
+      redirectRegex:
+        regex: '^/$'
+        replacement: '{{ env "HYPERDX_BASE_PATH" }}'
+        permanent: true
+
+  services:
+    app-service:
+      loadBalancer:
+        passHostHeader: true
+        servers:
+          - url: 'http://127.0.0.1:8080'
diff --git a/proxy/traefik/traefik.yml b/proxy/traefik/traefik.yml
@@ -0,0 +1,8 @@
+entryPoints:
+  web:
+    address: ':4040'
+
+providers:
+  file:
+    filename: /etc/traefik/dynamic/config.yml
+    watch: true
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     "module": "Node16",
-    "moduleResolution": "node",
+    "moduleResolution": "Node16",
     "lib": ["ES2022", "dom"],
     "allowSyntheticDefaultImports": true,
     "downlevelIteration": true,
@@ -17,6 +17,7 @@
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
-    "target": "ES2022"
+    "target": "ES2022",
+    "resolveJsonModule": true
   }
 }
diff --git a/yarn.lock b/yarn.lock

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@hyperdx/api": patch
 +---
++
 +revert: api esbuild