@lwrjs/dev-proxy-server 0.15.4 → 0.15.6

package/build/cjs/middleware.cjs

@@ -38,14 +38,33 @@ var ProxyLogLevels;
   ProxyLogLevels2["Error"] = "error";
   ProxyLogLevels2["Silent"] = "silent";
 })(ProxyLogLevels || (ProxyLogLevels = {}));
+var PROXY_URL_REGEX = /^([a-z][a-z0-9+\-.]*):\/\/([^/]+)/i;
 function getForwardedHeader(incomingRequest, remoteOrigin) {
-  const remoteHost = remoteOrigin?.replace(/^([a-z][a-z0-9+\-.]*):\/\//, "");
-  const hostHeader = remoteHost || incomingRequest.headers.host;
-  const hostProto = remoteHost ? "https" : incomingRequest.protocol;
-  return `host=${hostHeader};proto=${hostProto}`;
+  const {host: remoteHost, proto: remoteProto} = remoteOrigin ? parseHostAndProto(remoteOrigin) : {host: void 0, proto: void 0};
+  const host = remoteHost ?? incomingRequest.headers.host;
+  const proto = remoteProto ?? incomingRequest.protocol;
+  return `host=${host};proto=${proto}`;
+}
+function parseHostAndProto(urlString) {
+  if (!urlString) {
+    return {};
+  }
+  const match = PROXY_URL_REGEX.exec(urlString);
+  if (match) {
+    const [, proto, host] = match;
+    return {proto, host};
+  }
+  import_diagnostics.logger.warn({
+    label: "dev-proxy-server",
+    message: `Invalid remoteOrigin format: ${urlString}`
+  });
+  return {
+    host: urlString,
+    proto: "https"
+  };
 }
 function addLocalProxyMiddleware(app, defaultHost, remoteOrigin) {
-  const domainAndPort = defaultHost.replace(/^([a-z][a-z0-9+\-.]*):\/\//, "");
+  const domainAndPort = parseHostAndProto(defaultHost).host;
   app.use("/", (0, import_http_proxy_middleware.createProxyMiddleware)({
     target: defaultHost,
     changeOrigin: true,
@@ -67,7 +86,7 @@ function addRemoteProxyMiddleware(app, proxyConfig) {
   const {proxyConfigs} = proxyConfig;
   for (const entry of proxyConfigs) {
     const [path, target] = entry;
-    const targetHost = target.replace(/^([a-z][a-z0-9+\-.]*):\/\//, "");
+    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)({
       target,
@@ -85,7 +104,7 @@ function addRemoteProxyMiddleware(app, proxyConfig) {
         if (hostHeader !== target) {
           proxyRequest.setHeader(HOST, targetHost);
         }
-        proxyRequest.setHeader("Forwarded", `host=${hostHeader}`);
+        proxyRequest.setHeader("Forwarded", getForwardedHeader(incomingRequest));
         const originalPath = incomingRequest.url;
         proxyRequest.path = originalPath;
         if (process.env.AUTH_TOKEN) {

package/build/es/middleware.d.ts

@@ -1,15 +1,21 @@
 import type { Application as ExpressApp } from 'express';
 import type { LwrProxyConfiguration } from './proxy-server.js';
 /**
- * The Proxy middleware responsible for proxying all other requests not configured to external systems.
- * @param app
- * @param defaultHost
+ * Proxy middleware for handling requests that are served by the LWR server or lambda.
+ *
+ * @param app - The Express app instance to which the middleware is attached.
+ * @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;
 /**
- * The Proxy middleware responsible for proxying requests to a configured remote origin.
- * @param app
- * @param proxyConfig
+ * Middleware to handle API request proxying to a configured remote origin.
+ *
+ * This middleware forwards API requests to the specified remote origin
+ * as defined in the proxy configuration.
+ *
+ * @param app - The Express app instance to which the middleware is attached.
+ * @param proxyConfig - Configuration details initialized when the proxy server starts.
  */
 export declare function addRemoteProxyMiddleware(app: ExpressApp, proxyConfig: LwrProxyConfiguration): void;
 //# sourceMappingURL=middleware.d.ts.map

package/build/es/middleware.js

@@ -11,31 +11,90 @@ var ProxyLogLevels;
     ProxyLogLevels["Error"] = "error";
     ProxyLogLevels["Silent"] = "silent";
 })(ProxyLogLevels || (ProxyLogLevels = {}));
+// Regular expression to extract the protocol and host from a remote proxy URL.
+// Example matches:
+//   Input: "https://example.com/path"
+//   Matches: ["https://example.com", "https", "example.com"]
+// Explanation:
+//   ^                - Match the start of the string.
+//   ([a-z][a-z0-9+\-.]*) - Capture the protocol (e.g., "http", "https"), which must start with a letter and may include alphanumeric characters, "+", "-", or ".".
+//   :\/\/            - Match "://" to separate the protocol from the host.
+//   ([^/]+)          - Capture the host (everything until the first "/" or end of string).
+//   i                - Case-insensitive flag.
+const PROXY_URL_REGEX = /^([a-z][a-z0-9+\-.]*):\/\/([^/]+)/i;
+/**
+ * Constructs the `Forwarded` header value for an HTTP request.
+ *
+ * In a production environment, this header is usually added by the CDN and references the configured site domain URL.
+ * This function allows for customization by optionally overriding the protocol and host with a remote origin.
+ *
+ * @param incomingRequest - The incoming HTTP request object, contains details about the original express request.
+ * @param remoteOrigin - Optional. A remote origin URL to override the default protocol and host values.
+ * @returns The constructed `Forwarded` header string.
+ */
 function getForwardedHeader(incomingRequest, remoteOrigin) {
-    // In prod, the Forwarded header is added by the CDN and is set to the Core org
-    const remoteHost = remoteOrigin?.replace(/^([a-z][a-z0-9+\-.]*):\/\//, '');
-    const hostHeader = remoteHost || incomingRequest.headers.host;
-    const hostProto = remoteHost ? 'https' : incomingRequest.protocol;
-    return `host=${hostHeader};proto=${hostProto}`;
+    const { host: remoteHost, proto: remoteProto } = remoteOrigin
+        ? parseHostAndProto(remoteOrigin)
+        : { host: undefined, proto: undefined };
+    const host = remoteHost ?? incomingRequest.headers.host;
+    const proto = remoteProto ?? incomingRequest.protocol;
+    return `host=${host};proto=${proto}`;
+}
+/**
+ * Parses the protocol and host from a given URL string.
+ *
+ * If the URL matches the expected format, it extracts the protocol and host.
+ * If the URL is invalid, it logs a warning and returns a default protocol (`https`)
+ * and the original string as the host.
+ *
+ * @param urlString - The URL string to parse.
+ * @returns An object containing `proto` (protocol) and `host` values.
+ *          If the URL is invalid, a default protocol (`https`) and the original
+ *          string as the host are returned.
+ */
+function parseHostAndProto(urlString) {
+    if (!urlString) {
+        return {};
+    }
+    const match = PROXY_URL_REGEX.exec(urlString);
+    if (match) {
+        const [, proto, host] = match;
+        return { proto, host };
+    }
+    logger.warn({
+        label: 'dev-proxy-server',
+        message: `Invalid remoteOrigin format: ${urlString}`,
+    });
+    return {
+        host: urlString,
+        proto: 'https',
+    };
 }
 /**
- * The Proxy middleware responsible for proxying all other requests not configured to external systems.
- * @param app
- * @param defaultHost
+ * Proxy middleware for handling requests that are served by the LWR server or lambda.
+ *
+ * @param app - The Express app instance to which the middleware is attached.
+ * @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) {
-    const domainAndPort = defaultHost.replace(/^([a-z][a-z0-9+\-.]*):\/\//, '');
+    // Extract the domain and port from the defaultHost URL string.
+    const domainAndPort = parseHostAndProto(defaultHost).host;
     app.use('/', createProxyMiddleware({
         target: defaultHost,
         changeOrigin: true,
         onProxyReq: (proxyRequest, incomingRequest) => {
             // Set the Host header to the target
             const hostHeader = incomingRequest.headers.host;
+            // This will be any time we have a proxy config
             if (hostHeader !== domainAndPort) {
+                // Setting the Host Header to the domain and port for the proxy server URL
                 proxyRequest.setHeader(HOST, domainAndPort);
-                // Set the Forwarded header if it's not defined
+                // Add the `Forwarded` header if it is not already set.
                 const forwarded = incomingRequest.headers.forwarded;
-                proxyRequest.setHeader('Forwarded', forwarded ? forwarded : getForwardedHeader(incomingRequest, remoteOrigin));
+                proxyRequest.setHeader('Forwarded', 
+                // Set the `Forwarded` header using the first entry from the proxy configuration.
+                forwarded ? forwarded : getForwardedHeader(incomingRequest, remoteOrigin));
                 // Add auth token to cookies; used in the fetchController during local preview
                 if (process.env.AUTH_TOKEN && !proxyRequest.path.startsWith('/mobify/bundle/')) {
                     addAuthCookie(proxyRequest, process.env.AUTH_TOKEN);
@@ -45,17 +104,21 @@ export function addLocalProxyMiddleware(app, defaultHost, remoteOrigin) {
     }));
 }
 /**
- * The Proxy middleware responsible for proxying requests to a configured remote origin.
- * @param app
- * @param proxyConfig
+ * Middleware to handle API request proxying to a configured remote origin.
+ *
+ * This middleware forwards API requests to the specified remote origin
+ * as defined in the proxy configuration.
+ *
+ * @param app - The Express app instance to which the middleware is attached.
+ * @param proxyConfig - Configuration details initialized when the proxy server starts.
  */
 export function addRemoteProxyMiddleware(app, proxyConfig) {
     const mobifyRules = process.env.ADD_MOBIFY_PROXY_RULES === 'true';
     const { proxyConfigs } = proxyConfig;
     for (const entry of proxyConfigs) {
         const [path, target] = entry;
-        // remove the scheme from the proxyConfig host.
-        const targetHost = target.replace(/^([a-z][a-z0-9+\-.]*):\/\//, '');
+        // Extract the domain and port from the API target URL string.
+        const targetHost = parseHostAndProto(target).host;
         // TODO: Ask Commerce if this rewrite logic can be removed
         // Needed for commerce local-dev when running MRT bundles without a configured Cloudflare CDN
         // Rewrites /mobify/proxy/core and /mobify/caching/core paths (this is what pwa-kit does)
@@ -82,7 +145,8 @@ export function addRemoteProxyMiddleware(app, proxyConfig) {
                     proxyRequest.setHeader(HOST, targetHost);
                 }
                 // Add Forwarded header per https://git.soma.salesforce.com/pages/benjamin-fry/lwr-on-mrt-designs/request_path.html
-                proxyRequest.setHeader('Forwarded', `host=${hostHeader}`);
+                // Based on the incoming request's host and protocol. Is this necessary for API calls?
+                proxyRequest.setHeader('Forwarded', getForwardedHeader(incomingRequest));
                 // Preserve the original path, including double slashes
                 const originalPath = incomingRequest.url;
                 proxyRequest.path = originalPath;

package/package.json

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