@salesforce/pwa-kit-runtime 3.17.1-preview.0 → 3.17.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/pwa-kit-runtime",
-  "version": "3.17.1-preview.0",
+  "version": "3.17.1",
   "description": "The PWAKit Runtime",
   "homepage": "https://github.com/SalesforceCommerceCloud/pwa-kit/tree/develop/packages/pwa-kit-runtime#readme",
   "bugs": {
@@ -48,11 +48,11 @@
   },
   "devDependencies": {
     "@loadable/component": "^5.15.3",
-    "@salesforce/pwa-kit-dev": "3.17.1-preview.0",
+    "@salesforce/pwa-kit-dev": "3.17.1",
     "@serverless/event-mocks": "^1.1.1",
     "aws-lambda-mock-context": "^3.2.1",
     "fs-extra": "^11.1.1",
-    "internal-lib-build": "3.17.1-preview.0",
+    "internal-lib-build": "3.17.1",
     "nock": "^13.3.0",
     "nodemon": "^2.0.22",
     "sinon": "^13.0.2",
@@ -60,7 +60,7 @@
     "supertest": "^4.0.2"
   },
   "peerDependencies": {
-    "@salesforce/pwa-kit-dev": "3.17.1-preview.0"
+    "@salesforce/pwa-kit-dev": "3.17.1"
   },
   "peerDependenciesMeta": {
     "@salesforce/pwa-kit-dev": {
@@ -74,5 +74,5 @@
   "publishConfig": {
     "directory": "dist"
   },
-  "gitHead": "beabe8a971b6170bddfe08ae3f5ca2f1bfe66aa7"
+  "gitHead": "d09ed57f84432913ab3e55e3073802d319c5dc3c"
 }

package/ssr/server/build-remote-server.js

@@ -27,6 +27,7 @@ var _loggerInstance = _interopRequireDefault(require("../../utils/logger-instanc
 var _httpProxyMiddleware = require("http-proxy-middleware");
 var _hybridProxy = require("../../utils/ssr-server/hybrid-proxy");
 var _convertExpressRoute = require("../../utils/ssr-server/convert-express-route");
+var _ssrConfig = require("../../utils/ssr-config");
 var _serverlessAdapter = require("@h4ad/serverless-adapter");
 var _default = require("@h4ad/serverless-adapter/lib/handlers/default");
 var _callback = require("@h4ad/serverless-adapter/lib/resolvers/callback");
@@ -445,6 +446,7 @@ const RemoteServerFactory = exports.RemoteServerFactory = {
    * @private
    */
   _setupBasePathMiddleware(app) {
+    var _getConfig, _getConfig$app, _getConfig$app$url;
     // Cache the express route regexes to avoid re-calculating them on every request.
     let expressRouteRegexes;
 
@@ -490,11 +492,19 @@ const RemoteServerFactory = exports.RemoteServerFactory = {
      * If the server receives a request containing the base path, remove it before allowing
      * the request through to the other express endpoints
      *
-     * We scope base path removal to /mobify routes and routes defined by the express app
-     * (For example /callback or /worker.js)
+     * We scope base path removal to /mobify routes, /__pwa-kit routes (when showBasePath
+     * is false), and routes defined by the express app (For example /callback or /worker.js).
      * This is to avoid affecting React Router routes where a site id or locale might be present
      * that is equal to the base path.
      *
+     * /__pwa-kit routes are a special case. These are internal PWA Kit routes
+     * (e.g. /__pwa-kit/refresh) that are registered as React Router routes and are invoked
+     * by the Storefront Preview code on Runtime Admin (which always appends a base path if set).
+     * When showBasePath is false, React Router has no basename, so we redirect to the clean
+     * URL (without base path) so the browser navigates to a path that React Router can match
+     * and hydrate correctly on the client.
+     * When showBasePath is true, React Router handles the base path via its basename prop.
+     *
      * For example, if you have a base path of /us and a site id of /us we don't want
      * to remove the /us from www.example.com/us/en-US/category/... as this route is handled by
      * React Router and the PWA multisite implementation.
@@ -502,6 +512,7 @@ const RemoteServerFactory = exports.RemoteServerFactory = {
      * @param req {express.req} the incoming request - modified in-place
      * @private
      */
+    const showBasePath = ((_getConfig = (0, _ssrConfig.getConfig)()) === null || _getConfig === void 0 ? void 0 : (_getConfig$app = _getConfig.app) === null || _getConfig$app === void 0 ? void 0 : (_getConfig$app$url = _getConfig$app.url) === null || _getConfig$app$url === void 0 ? void 0 : _getConfig$app$url.showBasePath) === true;
     const removeBasePathMiddleware = (req, res, next) => {
       const basePath = (0, _ssrNamespacePaths.getEnvBasePath)();
 
@@ -515,6 +526,17 @@ const RemoteServerFactory = exports.RemoteServerFactory = {
         return next();
       }
 
+      // /__pwa-kit routes: when showBasePath is false, the browser URL still has the
+      // base path but client-side React Router has no basename, so hydration would fail.
+      // Redirect to the clean URL so the browser navigates to a path React Router matches.
+      if (!showBasePath && req.path.startsWith(`${basePath}/__pwa-kit`)) {
+        const cleanPath = removeBasePathFromPath(req.path);
+        const {
+          search
+        } = (0, _ssrServer.parseRequestUrl)(req);
+        return res.redirect(302, cleanPath + search);
+      }
+
       // For other routes, only proceed if path equals basePath or path starts with basePath + '/'
       const pathMatchesBasePath = req.path === basePath || req.path.startsWith(basePath + '/');
       if (!pathMatchesBasePath) {

package/ssr/server/express.test.js

@@ -1192,6 +1192,11 @@ describe('SLAS private client proxy', () => {
   }));
 });
 describe('Base path tests', () => {
+  beforeEach(() => {
+    // Re-establish the getConfig mock that afterEach's restoreAllMocks clears.
+    // _setupBasePathMiddleware reads getConfig() at setup time.
+    jest.spyOn(ssrConfig, 'getConfig').mockReturnValue({});
+  });
   afterEach(() => {
     jest.restoreAllMocks();
   });
@@ -1268,4 +1273,39 @@ describe('Base path tests', () => {
       expect(response.body.message).toBe('test');
     });
   }), 15000);
+  test('should redirect /__pwa-kit routes to clean URL when showBasePath is false', /*#__PURE__*/_asyncToGenerator(function* () {
+    jest.spyOn(ssrNamespacePaths, 'getEnvBasePath').mockReturnValue('/basepath');
+    jest.spyOn(ssrConfig, 'getConfig').mockReturnValue({
+      app: {
+        url: {
+          showBasePath: false
+        }
+      }
+    });
+    const app = _buildRemoteServer.RemoteServerFactory._createApp(opts());
+    return (0, _supertest.default)(app).get('/basepath/__pwa-kit/refresh?referrer=/some-page').expect(302).then(response => {
+      // Should redirect to the clean URL without base path
+      expect(response.headers.location).toBe('/__pwa-kit/refresh?referrer=/some-page');
+    });
+  }), 15000);
+  test('should not remove base path from /__pwa-kit routes when showBasePath is true', /*#__PURE__*/_asyncToGenerator(function* () {
+    jest.spyOn(ssrNamespacePaths, 'getEnvBasePath').mockReturnValue('/basepath');
+    jest.spyOn(ssrConfig, 'getConfig').mockReturnValue({
+      app: {
+        url: {
+          showBasePath: true
+        }
+      }
+    });
+    const app = _buildRemoteServer.RemoteServerFactory._createApp(opts());
+    let capturedPath = null;
+    app.use((req, res, next) => {
+      capturedPath = req.path;
+      next();
+    });
+    return (0, _supertest.default)(app).get('/basepath/__pwa-kit/refresh').then(() => {
+      // Base path should NOT be stripped since React Router handles it via basename
+      expect(capturedPath).toBe('/basepath/__pwa-kit/refresh');
+    });
+  }), 15000);
 });