@salesforce/pwa-kit-runtime 3.8.0-preview.0-basepath → 3.8.0-preview.2-basepath

package/utils/ssr-cache.js

@@ -0,0 +1,177 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.PersistentCache = void 0;
+/*
+ * Copyright (c) 2021, 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
+ */
+/**
+ * @module progressive-web-sdk/utils/ssr-cache
+ */
+
+/**
+ * A cache implementation.
+ *
+ * See the get, put and delete methods for more details.
+ */
+class PersistentCache {
+  /**
+   * Initialize this cache module.
+   *
+   * Project code should never need to call this. The Express app
+   * provides an instance of this class.
+   *
+   * @param {Object} options - options to create cache
+   * @param {Boolean} options.useLocalCache - true to use a local disk cache,
+   * false to use a remote (S3) cache. A deployed Express app will use
+   * the remote S3 cache. The local development server will use the
+   * local disk cache.
+   * @param {String} [options.bucket] - for a remote cache, the name of the S3
+   * bucket to use.
+   * @param {String} [options.prefix] - for a remote cache, a prefix for the
+   * cache, within the S3 bucket.
+   * @param {String} [options.s3Endpoint] - for a remote cache, the S3 endpoint
+   * to use (allows for testing).
+   * @param {String} [options.accessKeyId] - for testing, override AWS access key id
+   * @param {String} [options.secretAccessKey] - for testing, override AWS
+   * secret key
+   * @param {Function} [options.sendMetric] - required function which will be
+   * called with performance metrics generated by the PersistentCache
+   * sendMetric takes a function with signature:
+   *     (name: String, value: Number, unit: String,
+   *         dimensions: Object) => undefined
+   */
+  constructor() {
+    this._cacheDeletePromise = Promise.resolve();
+  }
+
+  /**
+   * Provided for testing purposes. Calling close() will
+   * clean up any locally cached data.
+   * @private
+   */
+  close() {
+    // Doesn't do anything!
+  }
+
+  /**
+   * Return an object that represents an entry not found in the cache
+   * @param key
+   * @param namespace {String|string[]}
+   * @returns {Object}
+   * @private
+   */
+  _notFound(key, namespace) {
+    return {
+      key,
+      namespace,
+      found: false,
+      metadata: undefined,
+      data: undefined
+    };
+  }
+
+  /**
+   * Get a JavaScript object from the cache.
+   *
+   * The returned Promise will resolve either to null if there is no
+   * match in the cache, or to an object with the following
+   * properties: 'found' is a boolean that is true if the item was found
+   * in the cache, 'false' if not, 'data' is the data for the object
+   * (or undefined if the object was not found), 'metadata' is the metadata
+   * object passed to put() (or undefined if the object was not found),
+   * 'expiration' is a JS date/timestamp representing the time at which the
+   * item will expire from the cache, 'key' is the item's cache
+   * key, and 'namespace' is the item's cache namespace.
+   *
+   * If the value passed to 'put' was a Buffer, then 'data' will
+   * be a Buffer. If the value passed to 'put' was anything else,
+   * it will have been deserialized from JSON, and will be whatever
+   * type was originally passed in.
+   *
+   * If an object is in the cache under the given key, each call to this
+   * method will return a separate copy of the object.
+   *
+   * If the object is NOT in the cache, this method will return an object
+   * with 'found' set to false. This allows a then() handler to use object
+   * deconstruction on the result.
+   *
+   * Within the cache, items under the same key but in different namespaces
+   * are distinct. The default namespace is undefined.
+   *
+   * @param [namespace] {String|string[]} the cache namespace
+   * @param key {String} the cache key
+   * @returns {Promise<*>} A Promise that will resolve to the
+   * cache result, or null if there is no match in the cache.
+   */
+  get({
+    key,
+    namespace
+  }) {
+    return Promise.resolve(this._notFound(key, namespace));
+  }
+
+  /**
+   * Store a JavaScript object in the cache.
+   *
+   * If the data to be stored is a Buffer, it's stored as-is. If
+   * it's any other type, it's serialized to JSON and the JSON is
+   * stored. If the data is not JSON-serializable, then this method
+   * will throw an error.
+   *
+   * A primary use-case for this cache is storing HTTP responses,
+   * which include a status code, headers and a body. The body is
+   * typically most efficiently stored as a Buffer. Passing an object
+   * to 'data' that has a Buffer value will result in the Buffer being
+   * JSON-encoded, which is slow and takes up much more space than the
+   * origin data. The recommended way to store a response is to include
+   * the status and headers in the item's metadata, and to pass the body
+   * as a Buffer.
+   *
+   * If an expiration date/timestamp is given, the data will expire
+   * from the cache at that time. If no date/timestamp is given,
+   * the default expiration is one year from the time that the data is
+   * stored.
+   *
+   * Within the cache, items under the same key but in different namespaces
+   * are distinct. The default namespace is undefined.
+   *
+   * If put() is called to store metdata but no data, you should pass
+   * undefined for 'data'.
+   *
+   * @param key {String} the cache key.
+   * @param [namespace] {String|string[]} the cache namespace
+   * @param data {Buffer|*} the data to be stored.
+   * @param [metadata] {Object} a simple JS object with keys and values
+   * for metadata. This object MUST be JSON-seralizable.
+   * @param [expiration] {Number} the expiration date/time for the data,
+   * as a JS date/timestamp (the result of Date.getTime). If the expiration
+   * is less than PersistentCache.DELTA_THRESHOLD (midnight on January 1st, 1980)
+   * it is interpreted as a delta number of mS to be added to the current time.
+   * This allows for deltas up to ten years.
+   * @returns {Promise<*>} resolves when data has been stored, or rejects
+   * on an error
+   */
+  put() {
+    return Promise.resolve();
+  }
+
+  /**
+   * Remove a single entry from the cache.
+   * @param key {String} the cache key
+   * @param [namespace] {String|string[]} the cache namespace
+   * @returns {Promise.<*>} resolves when delete is complete
+   */
+  delete() {
+    return Promise.resolve();
+  }
+}
+
+// The timestamp value for 1980-01-01T00:00:00
+exports.PersistentCache = PersistentCache;
+PersistentCache.DELTA_THRESHOLD = 315561600000;

package/utils/ssr-cache.test.js

@@ -0,0 +1,64 @@
+"use strict";
+
+var _ssrCache = require("./ssr-cache");
+function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
+function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; } /*
+ * Copyright (c) 2021, 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
+ */
+const localRemoteTestCases = [true, false];
+localRemoteTestCases.forEach(useLocalCache => {
+  describe(`${useLocalCache ? 'Local' : 'Remote'} noop PersistentCache`, () => {
+    const testCache = new _ssrCache.PersistentCache({
+      useLocalCache,
+      bucket: 'TestBucket',
+      s3Endpoint: 'http://localhost:4568',
+      accessKeyId: 'S3RVER',
+      secretAccessKey: 'S3RVER',
+      sendMetric: () => {}
+    });
+    const key = 'key';
+    const namespace = 'namespace';
+    const buf = Buffer.alloc(8);
+    for (let i = 0; i <= 8; i++) {
+      buf[i] = i;
+    }
+    const expiration = Date.now() + 10000;
+    test('get', /*#__PURE__*/_asyncToGenerator(function* () {
+      const result = yield testCache.get({
+        key,
+        namespace
+      });
+      expect(result.data).toBeUndefined();
+      expect(result.metadata).toBeUndefined();
+      expect(result.found).toBe(false);
+      expect(result.key).toEqual(key);
+      expect(result.namespace).toEqual(namespace);
+    }));
+    test('put', /*#__PURE__*/_asyncToGenerator(function* () {
+      yield testCache.put({
+        key,
+        namespace,
+        data: buf,
+        expiration
+      });
+      const result = yield testCache.get({
+        key,
+        namespace
+      });
+      expect(result.data).toBeUndefined();
+      expect(result.metadata).toBeUndefined();
+      expect(result.found).toBe(false);
+      expect(result.key).toEqual(key);
+      expect(result.namespace).toEqual(namespace);
+    }));
+    test('delete', /*#__PURE__*/_asyncToGenerator(function* () {
+      yield expect(testCache.delete({
+        key,
+        namespace
+      })).resolves.not.toThrow();
+    }));
+  });
+});

package/utils/ssr-config.client.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getConfig = void 0;
+/*
+ * Copyright (c) 2021, 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
+ */
+
+/**
+ * Returns the express app configuration file in object form that was serialized on the window object
+ *
+ * @returns - the application configuration object.
+ */
+/* istanbul ignore next */
+const getConfig = () => {
+  return window.__CONFIG__;
+};
+exports.getConfig = getConfig;

package/utils/ssr-config.client.test.js

@@ -0,0 +1,25 @@
+"use strict";
+
+var _ssrConfig = require("./ssr-config.client");
+/*
+ * Copyright (c) 2023, Salesforce, 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
+ */
+
+let windowSpy;
+beforeEach(() => {
+  windowSpy = jest.spyOn(window, 'window', 'get');
+});
+afterEach(() => {
+  windowSpy.mockRestore();
+});
+describe('Client getConfig', () => {
+  test('returns window.__CONFIG__ value', () => {
+    windowSpy.mockImplementation(() => ({
+      __CONFIG__: {}
+    }));
+    expect((0, _ssrConfig.getConfig)()).toEqual({});
+  });
+});

package/utils/ssr-config.js

@@ -0,0 +1,20 @@
+"use strict";
+
+/*
+ * Copyright (c) 2021, 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
+ */
+
+// NOTE: This conditional export by default exports the named export `getConfig`
+// for use in node environments. If specified by the `WEBPACK_TARGET` global
+// this module will export a browser safe version.
+/* global WEBPACK_TARGET */
+
+/* istanbul ignore next */
+if (typeof WEBPACK_TARGET !== 'undefined' && WEBPACK_TARGET === 'web') {
+  module.exports = require('./ssr-config.client.js');
+} else {
+  module.exports = require('./ssr-config.server.js');
+}

package/utils/ssr-config.server.js

@@ -0,0 +1,98 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getConfig = void 0;
+/*
+ * Copyright (c) 2021, 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
+ */
+
+/* istanbul ignore next */
+const SUPPORTED_FILE_TYPES = ['js', 'yml', 'yaml', 'json'];
+const IS_REMOTE = Object.prototype.hasOwnProperty.call(process.env, 'AWS_LAMBDA_FUNCTION_NAME');
+
+/**
+ * The implementation of getConfig below is expensive as it performs a file lookup.
+ *
+ * Since the environment config will not change unless the bundle is redeployed,
+ * this global variable helps prevent unnecessary file lookups when the server calls getConfig multiple times.
+ */
+let memoizedConfig;
+
+/**
+ * Returns the express app configuration file in object form. The file will be resolved in the
+ * the following order:
+ *
+ * {deploy_target}.ext - When the DEPLOY_TARGET environment is set (predominantly on remote environments)
+ * a file aptly named after the environment will be loaded first. Examples of this are `production.json`, or
+ * `development.json`.
+ *
+ * local.ext - Only loaded on local development environments, this file is used if you want a custom
+ * configuration that will not be used on deployed remote environments.
+ *
+ * default.ext - If you have no requirement for environment specific configurations the `default`
+ * config file will be used.
+ *
+ * package.json - If none of the files after have been found the `mobify` object defined in the
+ * projects `package.json` file.
+ *
+ * Each file marked with `ext` can optionally be terminated with `js`, `yml|yaml` or
+ * `json`. The file loaded is also determined based on that precidence of file extension.
+ *
+ * @param {Object} opts.buildDirectory - Option path to the folder containing the configution. Byt default
+ * it is the `build` folder when running remotely and the project folder when developing locally.
+ * @returns - the application configuration object.
+ */
+/* istanbul ignore next */
+const getConfig = (opts = {}) => {
+  var _process, _process$env;
+  if (memoizedConfig) return memoizedConfig;
+  const {
+    buildDirectory
+  } = opts;
+  const configDirBase = IS_REMOTE ? 'build' : '';
+  let targetName = ((_process = process) === null || _process === void 0 ? void 0 : (_process$env = _process.env) === null || _process$env === void 0 ? void 0 : _process$env.DEPLOY_TARGET) || '';
+  const targetSearchPlaces = SUPPORTED_FILE_TYPES.map(ext => `config/${targetName}.${ext}`);
+  const localeSearchPlaces = SUPPORTED_FILE_TYPES.map(ext => `config/local.${ext}`);
+  const defaultSearchPlaces = SUPPORTED_FILE_TYPES.map(ext => `config/default.${ext}`);
+  const searchFrom = buildDirectory || process.cwd() + '/' + configDirBase;
+
+  // Combined search places.
+  const searchPlaces = [...(targetName ? targetSearchPlaces : []), ...(!IS_REMOTE ? localeSearchPlaces : []), ...defaultSearchPlaces, 'package.json'];
+
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const {
+    cosmiconfigSync
+  } = require('cosmiconfig');
+
+  // Match config files based on the specificity from most to most general.
+  const explorerSync = cosmiconfigSync(targetName, {
+    packageProp: 'mobify',
+    searchPlaces: searchPlaces,
+    loaders: {
+      '.js': filepath => {
+        // Because `require` is bootstrapped by webpack, the builtin
+        // loader for `.js` files doesn't work. We have to ensure we use
+        // the right `require`.
+        const _require = eval('require');
+        const result = _require(filepath);
+        return result;
+      }
+    }
+  });
+
+  // Load the config synchronously using a custom "searchPlaces".
+  const {
+    config
+  } = explorerSync.search(searchFrom) || {};
+  if (!config) {
+    throw new Error(`Application configuration not found!\nPossible configuration file locations:\n${searchPlaces.join('\n')}`);
+  }
+  memoizedConfig = config;
+  return config;
+};
+exports.getConfig = getConfig;

package/utils/ssr-config.server.test.js

@@ -0,0 +1,50 @@
+"use strict";
+
+var _ssrConfig = require("./ssr-config.server");
+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; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
+ * Copyright (c) 2023, Salesforce, 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
+ */
+describe('Server "getConfig"', () => {
+  const env = process.env;
+  beforeEach(() => {
+    jest.resetModules();
+    process.env = _objectSpread({}, env);
+  });
+  afterEach(() => {
+    process.env = env;
+  });
+  test('throws when no config files are found running remotely', () => {
+    expect(_ssrConfig.getConfig).toThrow();
+  });
+  test('throws when no config files are found running locally', () => {
+    process.env.AWS_LAMBDA_FUNCTION_NAME = '';
+    expect(_ssrConfig.getConfig).toThrow();
+  });
+  test('config is cached', () => {
+    const mockConfig = {
+      test: 'test'
+    };
+    const mockConfigSearch = jest.fn().mockReturnValue({
+      config: mockConfig
+    });
+    jest.doMock('cosmiconfig', () => {
+      const originalModule = jest.requireActual('cosmiconfig');
+      return _objectSpread(_objectSpread({}, originalModule), {}, {
+        cosmiconfigSync: () => ({
+          search: mockConfigSearch
+        })
+      });
+    });
+    // Call getConfig multiple times
+    expect((0, _ssrConfig.getConfig)()).toBe(mockConfig);
+    expect((0, _ssrConfig.getConfig)()).toBe(mockConfig);
+    expect(mockConfigSearch).toHaveBeenCalledTimes(1);
+  });
+});

package/utils/ssr-namespace-paths.js

@@ -0,0 +1,60 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ssrNamespace = exports.slasPrivateProxyPath = exports.proxyBasePath = exports.healthCheckPath = exports.cachingBasePath = exports.bundleBasePath = void 0;
+/*
+ * 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
+ */
+
+/**
+ * DO NOT ADD NEW CONTENT TO THIS FILE! THIS FILE IS DEPRECATED!
+ * For all paths related code, use the ssr-path.js file
+ */
+const MOBIFY_PATH = '/mobify';
+const PROXY_PATH_BASE = `${MOBIFY_PATH}/proxy`;
+const BUNDLE_PATH_BASE = `${MOBIFY_PATH}/bundle`;
+const CACHING_PATH_BASE = `${MOBIFY_PATH}/caching`;
+const HEALTHCHECK_PATH = `${MOBIFY_PATH}/ping`;
+const SLAS_PRIVATE_CLIENT_PROXY_PATH = `${MOBIFY_PATH}/slas/private`;
+
+// The following variables were introduced in v3.7,
+// before the env base path feature was fully implemented.
+// In v3.8, we added the env base path support and the implementation has
+// changed from using static variables to functions.
+// Thus, we deprecate the following variables to avoid breaking change.
+// We will remove the deprecation in future major releases.
+/**
+ * @deprecated Use getProxyPath() instead. Import from @salesforce/pwa-kit-runtime/utils/ssr-paths
+ */
+const proxyBasePath = exports.proxyBasePath = PROXY_PATH_BASE;
+
+/**
+ * @deprecated Use getBundlePath() instead. Import from @salesforce/pwa-kit-runtime/utils/ssr-paths
+ */
+const bundleBasePath = exports.bundleBasePath = BUNDLE_PATH_BASE;
+
+/**
+ * @deprecated Use getCachingPath() instead. Import from @salesforce/pwa-kit-runtime/utils/ssr-paths
+ */
+const cachingBasePath = exports.cachingBasePath = CACHING_PATH_BASE;
+
+/**
+ * @deprecated Use getHealthCheckPath() instead. Import from @salesforce/pwa-kit-runtime/utils/ssr-paths
+ */
+const healthCheckPath = exports.healthCheckPath = HEALTHCHECK_PATH;
+
+/**
+ * @deprecated Use getSlasPrivateProxyPath() instead. Import from @salesforce/pwa-kit-runtime/utils/ssr-paths
+ */
+const slasPrivateProxyPath = exports.slasPrivateProxyPath = SLAS_PRIVATE_CLIENT_PROXY_PATH;
+
+/**
+ * @deprecated This variable is no longer used. This variable has always been an empty string.
+ * Use getEnvBasePath() instead. Import from @salesforce/pwa-kit-runtime/utils/ssr-paths
+ */
+const ssrNamespace = exports.ssrNamespace = '';

package/utils/ssr-namespace-paths.test.js

@@ -0,0 +1,30 @@
+"use strict";
+
+var _ssrNamespacePaths = require("./ssr-namespace-paths");
+/*
+ * Copyright (c) 2024, Salesforce, 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
+ */
+
+describe('ssr-namespace-paths tests', () => {
+  test('proxyBasePath is correctly set', () => {
+    expect(_ssrNamespacePaths.proxyBasePath).toBe('/mobify/proxy');
+  });
+  test('bundleBasePath is correctly set', () => {
+    expect(_ssrNamespacePaths.bundleBasePath).toBe('/mobify/bundle');
+  });
+  test('cachingBasePath is correctly set', () => {
+    expect(_ssrNamespacePaths.cachingBasePath).toBe('/mobify/caching');
+  });
+  test('healthCheckPath is correctly set', () => {
+    expect(_ssrNamespacePaths.healthCheckPath).toBe('/mobify/ping');
+  });
+  test('slasPrivateProxyPath is correctly set', () => {
+    expect(_ssrNamespacePaths.slasPrivateProxyPath).toBe('/mobify/slas/private');
+  });
+  test('ssrNamespace is an empty string', () => {
+    expect(_ssrNamespacePaths.ssrNamespace).toBe('');
+  });
+});

package/utils/ssr-paths.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getSlasPrivateProxyPath = exports.getProxyPath = exports.getHealthCheckPath = exports.getEnvBasePath = exports.getCachingPath = exports.getBundlePath = void 0;
+var _ssrConfig = require("./ssr-config");
+var _loggerInstance = _interopRequireDefault(require("./logger-instance"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/*
+ * 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
+ */
+
+/**
+ * This file defines the /mobify paths used to set up our Express endpoints.
+ *
+ * If a base path for the /mobify paths is defined, the methods in here will return the
+ * basepath. ie. /basepath/mobify/...
+ */
+
+// The MOBIFY_PATH is defined separately in preparation for the future eventual removal or
+// replacement of the 'mobify' part of these paths
+const MOBIFY_PATH = '/mobify';
+const PROXY_PATH_BASE = `${MOBIFY_PATH}/proxy`;
+const BUNDLE_PATH_BASE = `${MOBIFY_PATH}/bundle`;
+const CACHING_PATH_BASE = `${MOBIFY_PATH}/caching`;
+const HEALTHCHECK_PATH = `${MOBIFY_PATH}/ping`;
+const SLAS_PRIVATE_CLIENT_PROXY_PATH = `${MOBIFY_PATH}/slas/private`;
+const getEnvBasePath = () => {
+  const config = (0, _ssrConfig.getConfig)();
+  let basePath = (config === null || config === void 0 ? void 0 : config.envBasePath) || '';
+  if (typeof basePath !== 'string') {
+    _loggerInstance.default.warn('Invalid envBasePath configuration. No base path is applied.');
+    basePath = '';
+  }
+  return basePath.replace(/\/$/, '');
+};
+exports.getEnvBasePath = getEnvBasePath;
+const getProxyPath = () => `${getEnvBasePath()}${PROXY_PATH_BASE}`;
+exports.getProxyPath = getProxyPath;
+const getBundlePath = () => `${getEnvBasePath()}${BUNDLE_PATH_BASE}`;
+exports.getBundlePath = getBundlePath;
+const getCachingPath = () => `${getEnvBasePath()}${CACHING_PATH_BASE}`;
+exports.getCachingPath = getCachingPath;
+const getHealthCheckPath = () => `${getEnvBasePath()}${HEALTHCHECK_PATH}`;
+exports.getHealthCheckPath = getHealthCheckPath;
+const getSlasPrivateProxyPath = () => `${getEnvBasePath()}${SLAS_PRIVATE_CLIENT_PROXY_PATH}`;
+exports.getSlasPrivateProxyPath = getSlasPrivateProxyPath;

package/utils/ssr-paths.test.js

@@ -0,0 +1,49 @@
+"use strict";
+
+var _ssrPaths = require("./ssr-paths");
+var _ssrConfig = require("./ssr-config");
+/*
+ * Copyright (c) 2024, Salesforce, 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
+ */
+
+jest.mock('./ssr-config', () => {
+  return {
+    getConfig: jest.fn()
+  };
+});
+const mockConfig = {
+  envBasePath: '/test'
+};
+describe('environment base path tests', () => {
+  beforeEach(() => {
+    jest.resetModules();
+    jest.resetAllMocks();
+  });
+  test('basePath is returned from config', () => {
+    _ssrConfig.getConfig.mockImplementation(() => mockConfig);
+    expect((0, _ssrPaths.getEnvBasePath)()).toBe('/test');
+  });
+  test('basePath is included in proxy path', () => {
+    _ssrConfig.getConfig.mockImplementation(() => mockConfig);
+    expect((0, _ssrPaths.getProxyPath)()).toBe('/test/mobify/proxy');
+  });
+  test('basePath is included in bundle path', () => {
+    _ssrConfig.getConfig.mockImplementation(() => mockConfig);
+    expect((0, _ssrPaths.getBundlePath)()).toBe('/test/mobify/bundle');
+  });
+  test('basePath is set to empty string if there is no config', () => {
+    _ssrConfig.getConfig.mockImplementation(() => {});
+    expect((0, _ssrPaths.getEnvBasePath)()).toBe('');
+  });
+  test('basePath is set to empty string if envBasePath is not a string', () => {
+    _ssrConfig.getConfig.mockImplementation(() => {
+      return {
+        envBasePath: () => {}
+      };
+    });
+    expect((0, _ssrPaths.getEnvBasePath)()).toBe('');
+  });
+});