@salesforce/pwa-kit-react-sdk 3.8.0-preview.1-basepath → 3.8.0

package/CHANGELOG.md

@@ -1,19 +1,6 @@
-## v3.8.0-preview.1-basepath (Sep 05, 2024)
-## v3.8.0-preview.4-basepath (Sep 05, 2024)
-## v3.8.0-preview.4-basepath (Sep 05, 2024)
-## v3.8.0-preview.3-basepath (Sep 05, 2024)
-## v3.8.0-preview.3-basepath (Sep 05, 2024)
-## v3.8.0-preview.1-basepath (Sep 05, 2024)
-## v3.8.0-preview.2-basepath (Sep 05, 2024)
-## v3.8.0-preview.1-basepath (Sep 05, 2024)
-## v3.8.0-preview.1-basepath (Sep 05, 2024)
-## v3.8.0-preview.0-basepath (Sep 05, 2024)
-## v3.8.0-preview.0 (Sep 05, 2024)
-## v3.8.0-preview.basepath (Sep 05, 2024)
-## v3.8.0-dev (Aug 08, 2024)
-
-- Add support for environment level base paths, a new configuration option `envBasePath` [#1970](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1970)
-- Add support for React Router level base paths, a new `getBasePath` method to the `AppConfig` component [#1988](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1988)
+## v3.8.0 (Oct 28, 2024)
+- [Server Affinity] - Attach dwsid to SCAPI request headers [#2090](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2090)
+- Create useOrigin hook to return an app origin that takes x-forwarded-host header into consideration. [#2050](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/2050) 
 
 ## v3.7.0 (Aug 07, 2024)
 - Add `beforeHydrate` option to withReactQuery component [#1912](https://github.com/SalesforceCommerceCloud/pwa-kit/pull/1912)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/pwa-kit-react-sdk",
-  "version": "3.8.0-preview.1-basepath",
+  "version": "3.8.0",
   "description": "A library that supports the isomorphic React rendering pipeline for Commerce Cloud Managed Runtime apps",
   "homepage": "https://github.com/SalesforceCommerceCloud/pwa-kit/tree/develop/packages/pwa-kit-react-sdk#readme",
   "bugs": {
@@ -37,7 +37,7 @@
     "@loadable/babel-plugin": "^5.15.3",
     "@loadable/server": "^5.15.3",
     "@loadable/webpack-plugin": "^5.15.2",
-    "@salesforce/pwa-kit-runtime": "3.8.0-preview.1-basepath",
+    "@salesforce/pwa-kit-runtime": "3.8.0",
     "@tanstack/react-query": "^4.28.0",
     "cross-env": "^5.2.1",
     "event-emitter": "^0.3.5",
@@ -50,11 +50,11 @@
   },
   "devDependencies": {
     "@loadable/component": "^5.15.3",
-    "@salesforce/pwa-kit-dev": "3.8.0-preview.1-basepath",
+    "@salesforce/pwa-kit-dev": "3.8.0",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.4.3",
-    "internal-lib-build": "3.8.0-preview.1-basepath",
+    "internal-lib-build": "3.8.0",
     "node-html-parser": "^3.3.6",
     "nodemon": "^2.0.22",
     "react": "^18.2.0",
@@ -79,5 +79,5 @@
   "publishConfig": {
     "directory": "dist"
   },
-  "gitHead": "8704488ab2d14e7545c6acbe83fa1d4a330c6289"
+  "gitHead": "d6ed7107a4087093442b125f8cc212302046ab7e"
 }

package/ssr/browser/main.js

@@ -48,18 +48,12 @@ const OuterApp = ({
   locals,
   onHydrate
 }) => {
-  var _AppConfig$getBasePat, _AppConfig$getBasePat2;
   const AppConfig = (0, _compatibility.getAppConfig)();
   const isInitialPageRef = (0, _react.useRef)(true);
-  const basepath = ((_AppConfig$getBasePat = AppConfig.getBasePath) === null || _AppConfig$getBasePat === void 0 ? void 0 : (_AppConfig$getBasePat2 = _AppConfig$getBasePat.call(AppConfig, {
-    req: undefined,
-    res: undefined
-  })) === null || _AppConfig$getBasePat2 === void 0 ? void 0 : _AppConfig$getBasePat2.replace(/\/$/, '')) || '';
   return /*#__PURE__*/_react.default.createElement(_contexts.ServerContext.Provider, {
     value: {}
   }, /*#__PURE__*/_react.default.createElement(_reactRouterDom.BrowserRouter, {
-    ref: onHydrate,
-    basename: basepath
+    ref: onHydrate
   }, /*#__PURE__*/_react.default.createElement(_contexts.CorrelationIdProvider, {
     correlationId: () => {
       // If we are hydrating an error page use the server correlation id.

package/ssr/server/react-rendering.js

@@ -121,7 +121,7 @@ const getLocationSearch = (req, opts = {}) => {
 exports.getLocationSearch = getLocationSearch;
 const render = exports.render = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator(function* (req, res, next) {
-    var _config$app, _config$app$url, _AppConfig$getBasePat, _AppConfig$getBasePat2;
+    var _config$app, _config$app$url;
     const includeServerTimingHeader = ('__server_timing' in req.query);
     const shouldTrackPerformance = includeServerTimingHeader || process.env.SERVER_TIMING;
     res.__performanceTimer = new _performance.default({
@@ -146,15 +146,7 @@ const render = exports.render = /*#__PURE__*/function () {
     res.__performanceTimer.mark(_performance.PERFORMANCE_MARKS.routeMatching, 'start');
     let route;
     let match;
-    const basepath = ((_AppConfig$getBasePat = AppConfig.getBasePath) === null || _AppConfig$getBasePat === void 0 ? void 0 : (_AppConfig$getBasePat2 = _AppConfig$getBasePat.call(AppConfig, {
-      req,
-      res
-    })) === null || _AppConfig$getBasePat2 === void 0 ? void 0 : _AppConfig$getBasePat2.replace(/\/$/, '')) || '';
-    routes.some(r => {
-      let _route = _objectSpread({}, r);
-      if (basepath && _route !== null && _route !== void 0 && _route.path) {
-        _route.path = `${basepath}${_route.path}`;
-      }
+    routes.some(_route => {
       const _match = (0, _reactRouterDom.matchPath)(req.path, _route);
       if (_match) {
         match = _match;
@@ -267,12 +259,7 @@ const OuterApp = ({
   routerContext,
   location
 }) => {
-  var _AppConfig$getBasePat3, _AppConfig$getBasePat4;
   const AppConfig = (0, _compatibility.getAppConfig)();
-  const basepath = ((_AppConfig$getBasePat3 = AppConfig.getBasePath) === null || _AppConfig$getBasePat3 === void 0 ? void 0 : (_AppConfig$getBasePat4 = _AppConfig$getBasePat3.call(AppConfig, {
-    req,
-    res
-  })) === null || _AppConfig$getBasePat4 === void 0 ? void 0 : _AppConfig$getBasePat4.replace(/\/$/, '')) || '';
   return /*#__PURE__*/_react.default.createElement(_contexts.ServerContext.Provider, {
     value: {
       req,
@@ -280,8 +267,7 @@ const OuterApp = ({
     }
   }, /*#__PURE__*/_react.default.createElement(_reactRouterDom.StaticRouter, {
     location: location,
-    context: routerContext,
-    basename: basepath
+    context: routerContext
   }, /*#__PURE__*/_react.default.createElement(_contexts.CorrelationIdProvider, {
     correlationId: res.locals.requestId,
     resetOnPageChange: false

package/ssr/server/react-rendering.test.js

@@ -59,8 +59,7 @@ jest.mock('../universal/routes', () => {
   const PropTypes = require('prop-types');
   const errors = require('../universal/errors');
   const {
-    Redirect,
-    Link
+    Redirect
   } = require('react-router-dom');
   const {
     Helmet
@@ -93,9 +92,7 @@ jest.mock('../universal/routes', () => {
       return 'templateName';
     }
     render() {
-      return /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement("div", null, "This is a PWA"), /*#__PURE__*/React.createElement(Link, {
-        to: "/link"
-      }, "This is a link (for Router basepath testing)"));
+      return /*#__PURE__*/React.createElement("div", null, "This is a PWA");
     }
   }
   class UnknownErrorPage extends React.Component {
@@ -637,44 +634,6 @@ describe('The Node SSR Environment', () => {
       const shouldIncludeErrorStack = !(0, _ssrServer.isRemote)();
       expect(html).toContain(shouldIncludeErrorStack ? 'Error: ' : 'Internal Server Error');
     }
-  }, {
-    description: `AppConfig getBasePath works correctly`,
-    req: {
-      url: '/base/pwa'
-    },
-    mocks: () => {
-      const AppConfig = (0, _compatibility.getAppConfig)();
-      jest.spyOn(AppConfig, 'getBasePath').mockImplementation(() => {
-        return '/base';
-      });
-    },
-    assertions: res => {
-      expect(res.statusCode).toBe(200);
-      const html = res.text;
-      const doc = (0, _nodeHtmlParser.parse)(html);
-      const links = doc.querySelectorAll('a');
-      links.forEach(link => {
-        const href = link.getAttribute('href');
-        expect(href.startsWith('/base')).toBe(true);
-      });
-      expect(html).toContain('This is a PWA');
-    }
-  }, {
-    description: `AppConfig getBasePath works correctly when it is empty string`,
-    req: {
-      url: '/pwa'
-    },
-    mocks: () => {
-      const AppConfig = (0, _compatibility.getAppConfig)();
-      jest.spyOn(AppConfig, 'getBasePath').mockImplementation(() => {
-        return '';
-      });
-    },
-    assertions: res => {
-      expect(res.statusCode).toBe(200);
-      const html = res.text;
-      expect(html).toContain('This is a PWA');
-    }
   }, {
     description: `Works if the user resolves an Object with useQuery`,
     req: {

package/ssr/universal/components/_app-config/index.js

@@ -72,23 +72,6 @@ class AppConfig extends _react.default.Component {
     return {};
   }
 
-  /**
-   * Returns a base path to be included in all URLs.
-   * For example, www.example.com/basepath/category/...
-   *
-   * @param params.req - the Express.js request object (undefined on the client)
-   * @param params.res - the Express.js response object (undefined on the client)
-   *
-   * @return string - the base path (no trailing slash)
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  static getBasePath({
-    req,
-    res
-  }) {
-    return '';
-  }
-
   /**
    * This class is a React Component in order to provide this hook, which lets
    * you set up context Providers for a state-management library such as Redux.

package/ssr/universal/components/_app-config/index.test.js

@@ -17,6 +17,5 @@ describe('The default AppConfig', () => {
     })).toBeUndefined();
     expect(_index.default.freeze()).toBeUndefined();
     expect(_index.default.extraGetPropsArgs()).toEqual({});
-    expect(_index.default.getBasePath({})).toBe('');
   });
 });

package/ssr/universal/hooks/index.js

@@ -3,13 +3,13 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useServerContext = exports.useCorrelationId = void 0;
+exports.useServerContext = exports.useOrigin = exports.useCorrelationId = void 0;
 var _react = _interopRequireWildcard(require("react"));
 var _contexts = require("../contexts");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 /*
- * Copyright (c) 2022, salesforce.com, inc.
+ * Copyright (c) 2024, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
@@ -49,4 +49,36 @@ const useServerContext = () => {
   const serverContext = (0, _react.useContext)(_contexts.ServerContext);
   return serverContext;
 };
-exports.useServerContext = useServerContext;
+
+/**
+ * Returns the application's origin.
+ *
+ * By default, it will return the ORIGIN under which we are serving the page.
+ *
+ * If `fromXForwardedHeader` is true, it will use the value of `x-forwarded-proto` and `x-forwarded-host` headers in req
+ * to build origin. (it is false by default)
+ *
+ * NOTE: this is a React hook, so it has to be used in a React rendering pipeline.
+ * @returns {string} origin string
+ *
+ */
+exports.useServerContext = useServerContext;
+const useOrigin = ({
+  fromXForwardedHeader = false
+}) => {
+  const {
+    res
+  } = useServerContext();
+  if (typeof window !== 'undefined') {
+    return window.location.origin;
+  }
+  const {
+    APP_ORIGIN
+  } = process.env;
+  const xForwardedOrigin = res.locals.xForwardedOrigin;
+  if (fromXForwardedHeader && xForwardedOrigin) {
+    return xForwardedOrigin;
+  }
+  return APP_ORIGIN;
+};
+exports.useOrigin = useOrigin;

package/ssr/universal/utils.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getProxyConfigs = exports.getAssetUrl = void 0;
 var _ssrShared = require("@salesforce/pwa-kit-runtime/utils/ssr-shared");
-var _ssrPaths = require("@salesforce/pwa-kit-runtime/utils/ssr-paths");
+var _ssrNamespacePaths = require("@salesforce/pwa-kit-runtime/utils/ssr-namespace-paths");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
@@ -29,7 +29,7 @@ const onClient = typeof window !== 'undefined';
  */
 const getAssetUrl = path => {
   /* istanbul ignore next */
-  const publicPath = onClient ? `${window.Progressive.buildOrigin}` : `${(0, _ssrPaths.getBundlePath)()}/${process.env.BUNDLE_ID || 'development'}/`;
+  const publicPath = onClient ? `${window.Progressive.buildOrigin}` : `${_ssrNamespacePaths.bundleBasePath}/${process.env.BUNDLE_ID || 'development'}/`;
   return path ? `${publicPath}${path}` : publicPath;
 };
 

package/utils/url.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getAppOrigin = void 0;
 /*
- * Copyright (c) 2021, salesforce.com, inc.
+ * Copyright (c) 2024, salesforce.com, inc.
  * All rights reserved.
  * SPDX-License-Identifier: BSD-3-Clause
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
@@ -18,6 +18,8 @@ exports.getAppOrigin = void 0;
  * initialized using the `_createApp` method (This happens in your /app/ssr.js file).
  *
  * @function
+ * @deprecated use `useOrigin()` instead.
+ * This function will be removed in version 4.0.0.
  * @returns {string} Returns the ORIGIN under which we are serving the page.
  * @example
  * import {getAppOrigin} from '@salesforce/pwa-kit-react-sdk/utils/url'