@lwrjs/dev-proxy-server 0.16.10 → 0.16.12

package/build/cjs/middleware.cjs

@@ -63,15 +63,23 @@ function parseHostAndProto(urlString) {
     proto: "https"
   };
 }
-function addLocalProxyMiddleware(app, defaultHost, remoteOrigin) {
+function addLocalProxyMiddleware(app, config) {
+  const {defaultHost, basePath, remoteOrigin} = config;
   const domainAndPort = parseHostAndProto(defaultHost).host;
-  app.use("/", (0, import_http_proxy_middleware.createProxyMiddleware)({
+  const hasBasePath = basePath && basePath !== "/";
+  app.use(basePath || "/", (0, import_http_proxy_middleware.createProxyMiddleware)({
     target: defaultHost,
     changeOrigin: true,
+    pathRewrite: (path, req) => {
+      return hasBasePath ? path.replace(basePath, "") : path;
+    },
     onProxyReq: (proxyRequest, incomingRequest) => {
       const hostHeader = incomingRequest.headers.host;
       if (hostHeader !== domainAndPort) {
         proxyRequest.setHeader(HOST, domainAndPort);
+        if (hasBasePath) {
+          proxyRequest.setHeader("X-Mobify-Request-Class", `basePath=${basePath}`);
+        }
         const forwarded = incomingRequest.headers.forwarded;
         proxyRequest.setHeader("Forwarded", forwarded ? forwarded : getForwardedHeader(incomingRequest, remoteOrigin));
         if (process.env.AUTH_TOKEN && !proxyRequest.path.startsWith("/mobify/bundle/")) {
@@ -88,7 +96,7 @@ function addRemoteProxyMiddleware(app, proxyConfig) {
     const [path, target] = entry;
     const targetHost = parseHostAndProto(target).host;
     const pathRewrite = mobifyRules && (path.indexOf("/mobify/proxy") === 0 || path.indexOf("/mobify/caching") === 0) ? {[path]: ""} : void 0;
-    app.use(path, (0, import_http_proxy_middleware.createProxyMiddleware)({
+    const middleware = (0, import_http_proxy_middleware.createProxyMiddleware)({
       target,
       pathRewrite,
       logLevel: resolveLogLevel(import_diagnostics.logger.getLogLevel()),
@@ -111,7 +119,11 @@ function addRemoteProxyMiddleware(app, proxyConfig) {
           addAuthCookie(proxyRequest, process.env.AUTH_TOKEN);
         }
       }
-    }));
+    });
+    if (proxyConfig.basePath) {
+      app.use(proxyConfig.basePath + path, middleware);
+    }
+    app.use(path, middleware);
   }
 }
 function resolveLogLevel(currentLevel) {

package/build/cjs/proxy-server.cjs

@@ -31,9 +31,11 @@ var import_middleware = __toModule(require("./middleware.cjs"));
 var LwrProxyServer = class {
   constructor(config) {
     this.proxyServer = (0, import_express.default)();
+    if (config.basePath && !config.basePath.startsWith("/"))
+      config.basePath = "/" + config.basePath;
     this.config = config;
     (0, import_middleware.addRemoteProxyMiddleware)(this.proxyServer, this.config);
-    (0, import_middleware.addLocalProxyMiddleware)(this.proxyServer, this.config.defaultHost, this.config.remoteOrigin);
+    (0, import_middleware.addLocalProxyMiddleware)(this.proxyServer, this.config);
   }
   async listen(callback) {
     const {proxyServer, config} = this;

package/build/es/middleware.d.ts

@@ -1,5 +1,5 @@
 import type { Application as ExpressApp } from 'express';
-import type { LwrProxyConfiguration } from './proxy-server.js';
+import type { LocalProxyServerConfig, LwrProxyConfiguration } from './proxy-server.js';
 /**
  * Proxy middleware for handling requests that are served by the LWR server or lambda.
  *
@@ -7,7 +7,7 @@ import type { LwrProxyConfiguration } from './proxy-server.js';
  * @param defaultHost - A URL string pointing to the local proxy server for handling requests.
  * @param remoteOrigin - A URL string representing the value of the first entry in the `_proxy` configuration file.
  */
-export declare function addLocalProxyMiddleware(app: ExpressApp, defaultHost: string, remoteOrigin?: string): void;
+export declare function addLocalProxyMiddleware(app: ExpressApp, config: LocalProxyServerConfig): void;
 /**
  * Middleware to handle API request proxying to a configured remote origin.
  *

package/build/es/middleware.js

@@ -77,12 +77,18 @@ function parseHostAndProto(urlString) {
  * @param defaultHost - A URL string pointing to the local proxy server for handling requests.
  * @param remoteOrigin - A URL string representing the value of the first entry in the `_proxy` configuration file.
  */
-export function addLocalProxyMiddleware(app, defaultHost, remoteOrigin) {
+export function addLocalProxyMiddleware(app, config) {
+    const { defaultHost, basePath, remoteOrigin } = config;
     // Extract the domain and port from the defaultHost URL string.
     const domainAndPort = parseHostAndProto(defaultHost).host;
-    app.use('/', createProxyMiddleware({
+    const hasBasePath = basePath && basePath !== '/';
+    app.use(basePath || '/', createProxyMiddleware({
         target: defaultHost,
         changeOrigin: true,
+        pathRewrite: (path, req) => {
+            // Strip off the basePath from the request URL
+            return hasBasePath ? path.replace(basePath, '') : path;
+        },
         onProxyReq: (proxyRequest, incomingRequest) => {
             // Set the Host header to the target
             const hostHeader = incomingRequest.headers.host;
@@ -90,6 +96,10 @@ export function addLocalProxyMiddleware(app, defaultHost, remoteOrigin) {
             if (hostHeader !== domainAndPort) {
                 // Setting the Host Header to the domain and port for the proxy server URL
                 proxyRequest.setHeader(HOST, domainAndPort);
+                if (hasBasePath) {
+                    // Add X-Mobify-Request-Class header with basePath value
+                    proxyRequest.setHeader('X-Mobify-Request-Class', `basePath=${basePath}`);
+                }
                 // Add the `Forwarded` header if it is not already set.
                 const forwarded = incomingRequest.headers.forwarded;
                 proxyRequest.setHeader('Forwarded', 
@@ -125,7 +135,7 @@ export function addRemoteProxyMiddleware(app, proxyConfig) {
         const pathRewrite = mobifyRules && (path.indexOf('/mobify/proxy') === 0 || path.indexOf('/mobify/caching') === 0)
             ? { [path]: '' }
             : undefined;
-        app.use(path, createProxyMiddleware({
+        const middleware = createProxyMiddleware({
             target,
             pathRewrite,
             logLevel: resolveLogLevel(logger.getLogLevel()),
@@ -156,7 +166,14 @@ export function addRemoteProxyMiddleware(app, proxyConfig) {
                     addAuthCookie(proxyRequest, process.env.AUTH_TOKEN);
                 }
             },
-        }));
+        });
+        // Proxy all configured routes at the basePath path (if one exists)
+        if (proxyConfig.basePath) {
+            app.use(proxyConfig.basePath + path, middleware);
+        }
+        // Also proxy the same routes at the root (probably not needed for all routes but doesn't hurt)
+        // this covers the /cdn-cgi scenario (which seems to always be requested at the root)
+        app.use(path, middleware);
     }
 }
 function resolveLogLevel(currentLevel) {

package/build/es/proxy-server.d.ts

@@ -2,12 +2,18 @@ import { Application as ExpressApp } from 'express';
 export interface LwrProxyConfiguration {
     proxyConfigs: ProxyConfigDefinition[];
     remoteOrigin?: string;
+    basePath?: string;
 }
 type ProxyConfigDefinition = Array<string>;
 export interface LwrProxyServerConfig extends LwrProxyConfiguration {
     port: number;
     defaultHost: string;
 }
+export interface LocalProxyServerConfig {
+    defaultHost: string;
+    basePath?: string;
+    remoteOrigin?: string;
+}
 /**
  * A simple configuration-enabled local development proxy server.
  */

package/build/es/proxy-server.js

@@ -6,9 +6,11 @@ import { addLocalProxyMiddleware, addRemoteProxyMiddleware } from './middleware.
 export class LwrProxyServer {
     constructor(config) {
         this.proxyServer = express();
+        if (config.basePath && !config.basePath.startsWith('/'))
+            config.basePath = '/' + config.basePath;
         this.config = config;
         addRemoteProxyMiddleware(this.proxyServer, this.config);
-        addLocalProxyMiddleware(this.proxyServer, this.config.defaultHost, this.config.remoteOrigin);
+        addLocalProxyMiddleware(this.proxyServer, this.config);
     }
     async listen(callback) {
         const { proxyServer, config } = this;

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.16.10",
+    "version": "0.16.12",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -33,13 +33,13 @@
         "build": "tsc -b"
     },
     "dependencies": {
-        "@lwrjs/diagnostics": "0.16.10",
-        "@lwrjs/shared-utils": "0.16.10",
+        "@lwrjs/diagnostics": "0.16.12",
+        "@lwrjs/shared-utils": "0.16.12",
         "express": "^4.20.0",
         "http-proxy-middleware": "2.0.7"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.16.10"
+        "@lwrjs/types": "0.16.12"
     },
     "engines": {
         "node": ">=18.0.0"
@@ -47,5 +47,5 @@
     "volta": {
         "extends": "../../../package.json"
     },
-    "gitHead": "03ff25c3eb0445af45adeec09d0295115156724b"
+    "gitHead": "53e1f3a51a839e565a77d9f7a9a781fc5a515147"
 }