@salesforce/pwa-kit-dev 3.9.0-nightly-20241206124802 → 4.0.0-extensibility-preview.0

package/configs/webpack/overrides-plugin.test.js

@@ -1,388 +0,0 @@
-"use strict";
-
-var _path = _interopRequireDefault(require("path"));
-var _overridesPlugin = _interopRequireDefault(require("./overrides-plugin"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/*
- * Copyright (c) 2023, 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 PROJECT_DIR = `src/configs/webpack/test`;
-const EXTENDS_TARGET = '@salesforce/retail-react-app';
-
-// Our main webpack config will add the leading '/' if not present in package.json
-// so we can expect the '/' to be present here
-const OVERRIDES_DIR = '/overrides';
-
-// Files in this map are the files we expect to see in overrides,
-// reflecting the files found in src/configs/webpack/test/overrides
-// This map takes the form [key, [end, rest]] where given a string /path/file.jsx
-// we split on the last '.' and the former part becomes the key and the latter becomes rest
-// To determine 'end', we split on '/index' and take the latter part of the substring. If the
-// file does not contain '/index' this becomes the filepath from the root of pwa-kit-dev
-const FS_READ_HASHMAP = new Map(Object.entries({
-  exists: ['src/configs/webpack/test/overrides/exists.jsx', ['.', 'jsx']],
-  newExtension: ['src/configs/webpack/test/overrides/newExtension.tsx', ['.', 'tsx']],
-  'path/data': ['src/configs/webpack/test/overrides/path/data.js', ['.', 'js']],
-  path: ['/index.jsx', ['index', '.', 'jsx']],
-  'path/index.mock': ['/index.mock.jsx', ['.', 'jsx']],
-  'path/nested/icon': ['src/configs/webpack/test/overrides/path/nested/icon.svg', ['.', 'svg']]
-}));
-const REWRITE_DIR = PROJECT_DIR + OVERRIDES_DIR;
-const options = {
-  overridesDir: OVERRIDES_DIR,
-  extends: [EXTENDS_TARGET],
-  projectDir: PROJECT_DIR
-};
-
-// Helper function. Expects an object with 2 properties: path and request
-const createRequestContextWith = req => {
-  return {
-    _ResolverCachePluginCacheMiss: true,
-    context: {
-      // We don't modify or read the issuer in overrides so we can
-      // leave this as a constant here
-      issuer: 'fake-file.js'
-    },
-    path: req.path,
-    request: req.request
-  };
-};
-const setupResolverAndCallback = () => {
-  const callback = jest.fn(() => null);
-  const resolver = {
-    ensureHook: jest.fn(() => null),
-    // we only care about calling the callback and the value of `requestContext`
-    doResolve: jest.fn((target, requestContext, msg, resolveContext, callback) => {
-      if (typeof callback === 'function') {
-        callback();
-      }
-      return null;
-    })
-  };
-  return {
-    callback,
-    resolver
-  };
-};
-describe('overrides plugin', () => {
-  test('class constructor setup works', () => {
-    const overridesResolver = new _overridesPlugin.default(options);
-    expect(overridesResolver.extendsHashMap).toEqual(FS_READ_HASHMAP);
-    expect(overridesResolver.projectDir).toBe(PROJECT_DIR);
-  });
-  test('resolver doResolve() hook is called for files in overrides dir', () => {
-    // exists.jsx is in FS_READ_HASHMAP
-    const REQUEST_PATH = 'exists';
-    const REQUEST_EXTENSION = '.jsx';
-    const testRequestContext = createRequestContextWith({
-      path: _path.default.join('.', 'node_modules', EXTENDS_TARGET),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    });
-    const {
-      resolver,
-      callback
-    } = setupResolverAndCallback();
-    const overridesResolver = new _overridesPlugin.default(options);
-    overridesResolver.handleHook(testRequestContext, {}, callback, resolver);
-    const expectedRequestContext = createRequestContextWith({
-      path: _path.default.join(REWRITE_DIR, REQUEST_PATH + REQUEST_EXTENSION),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    });
-    expect(callback).toHaveBeenCalled();
-    expect(resolver.doResolve).toHaveBeenCalledWith(null, expectedRequestContext, expect.anything(), expect.anything(), expect.anything());
-  });
-  test('nested and non-ts/tsx/js/jsx files rewrite if in overrides', () => {
-    const REQUEST_PATH = `path/nested/icon`;
-    const REQUEST_EXTENSION = '.svg';
-    const testRequestContext = createRequestContextWith({
-      path: _path.default.join('.', 'node_modules', EXTENDS_TARGET),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}${REQUEST_EXTENSION}`
-    });
-    const {
-      resolver,
-      callback
-    } = setupResolverAndCallback();
-    const overridesResolver = new _overridesPlugin.default(options);
-    overridesResolver.handleHook(testRequestContext, {}, callback, resolver);
-    expect(callback).toHaveBeenCalled();
-    expect(resolver.doResolve).toHaveBeenCalledWith(null, createRequestContextWith({
-      path: _path.default.join(REWRITE_DIR, REQUEST_PATH + REQUEST_EXTENSION),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}${REQUEST_EXTENSION}`
-    }), expect.anything(), expect.anything(), expect.anything());
-  });
-  test('resolver doResolve() hook is NOT called for files NOT in overrides dir', () => {
-    const REQUEST_PATH = `path/nested/does_not_exist.svg`;
-    const REQUEST_EXTENSION = '.svg';
-    const testRequestContext = createRequestContextWith({
-      path: _path.default.join('.', 'node_modules', EXTENDS_TARGET),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}${REQUEST_EXTENSION}`
-    });
-    const {
-      resolver,
-      callback
-    } = setupResolverAndCallback();
-    const overridesResolver = new _overridesPlugin.default(options);
-    overridesResolver.handleHook(testRequestContext, {}, callback, resolver);
-    expect(callback).toHaveBeenCalled();
-    expect(resolver.doResolve).not.toHaveBeenCalled();
-  });
-  test('a file that requests from relative AND base template is able to get both', () => {
-    const REQUEST_ONE_PATH = 'exists';
-    const REQUEST_ONE_EXTENSION = '.jsx';
-    const testOneRequestContext = createRequestContextWith({
-      path: _path.default.join('.', 'node_modules', EXTENDS_TARGET),
-      request: `${EXTENDS_TARGET}/${REQUEST_ONE_PATH}`
-    });
-    let {
-      resolver,
-      callback
-    } = setupResolverAndCallback();
-    const overridesResolver = new _overridesPlugin.default(options);
-    overridesResolver.handleHook(testOneRequestContext, {}, callback, resolver);
-    expect(callback).toHaveBeenCalled();
-    expect(resolver.doResolve).toHaveBeenCalledWith(null, createRequestContextWith({
-      path: _path.default.join(REWRITE_DIR, REQUEST_ONE_PATH + REQUEST_ONE_EXTENSION),
-      request: `${EXTENDS_TARGET}/exists`
-    }), expect.anything(), expect.anything(), expect.anything());
-    const REQUEST_TWO_PATH = `./exists`;
-    const testTwoRequestContext = createRequestContextWith({
-      path: './',
-      request: REQUEST_TWO_PATH
-    });
-    ({
-      resolver,
-      callback
-    } = setupResolverAndCallback());
-    const _overridesResolver = new _overridesPlugin.default(options);
-    _overridesResolver.handleHook(testTwoRequestContext, {}, callback, resolver);
-    expect(callback).toHaveBeenCalled();
-    expect(resolver.doResolve).not.toHaveBeenCalledWith();
-  });
-  test('jsx base template files can be replaced by tsx files', () => {
-    const REQUEST_PATH = 'newExtension';
-    const REQUEST_BASE_EXTENSION = '.jsx';
-    const REQUEST_OVERRIDE_EXTENSION = '.tsx';
-    const testRequestContext = createRequestContextWith({
-      path: _path.default.join('.', 'node_modules', EXTENDS_TARGET, REQUEST_PATH, REQUEST_BASE_EXTENSION),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    });
-    let {
-      resolver,
-      callback
-    } = setupResolverAndCallback();
-    const overridesResolver = new _overridesPlugin.default(options);
-    overridesResolver.handleHook(testRequestContext, {}, callback, resolver);
-    expect(callback).toHaveBeenCalled();
-    expect(resolver.doResolve).toHaveBeenCalledWith(null, createRequestContextWith({
-      path: _path.default.join(REWRITE_DIR, REQUEST_PATH + REQUEST_OVERRIDE_EXTENSION),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    }), expect.anything(), expect.anything(), expect.anything());
-  });
-  test('overridesDir and projectDir are normalized with leading slash and forward slashes', () => {
-    // In this test, all inputs use \\ to simulate Windows file paths
-    const REQUEST_PATH = 'exists';
-    const REQUEST_EXTENSION = '.jsx';
-    const testRequestContext = createRequestContextWith({
-      path: '.\\node_modules\\' + EXTENDS_TARGET,
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    });
-    const {
-      resolver,
-      callback
-    } = setupResolverAndCallback();
-
-    // NOTE: These options are not valid in package.json as it doesn't accept Windows paths
-    // in the outer calling context in configs/webpack/config.js.
-    // We have this here as the OverridesResolverPlugin technically allows for this
-    // and it lets us test that paths are being normalized
-    const windowsOptions = {
-      overridesDir: '\\overrides',
-      extends: ['@salesforce/retail-react-app'],
-      projectDir: `src\\configs\\webpack\\test`
-    };
-    const overridesResolver = new _overridesPlugin.default(windowsOptions);
-    overridesResolver.handleHook(testRequestContext, {}, callback, resolver);
-    expect(callback).toHaveBeenCalled();
-    // The assert uses path.join which normalizes '\\' to '/' on non-Windows
-    expect(resolver.doResolve).toHaveBeenCalledWith(null, createRequestContextWith({
-      path: _path.default.join(REWRITE_DIR, REQUEST_PATH + REQUEST_EXTENSION),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    }), expect.anything(), expect.anything(), expect.anything());
-  });
-  test('overrides do not return .mock files', () => {
-    // FS_READ_HASHMAP above has both index.jsx and index.mock.jsx
-    // This test checks that index.jsx is returned by the override
-    const REQUEST_PATH = `path`;
-    const testRequestContext = createRequestContextWith({
-      path: _path.default.join('.', 'node_modules', EXTENDS_TARGET),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    });
-    const {
-      resolver,
-      callback
-    } = setupResolverAndCallback();
-    const overridesResolver = new _overridesPlugin.default(options);
-    overridesResolver.handleHook(testRequestContext, {}, callback, resolver);
-    expect(callback).toHaveBeenCalled();
-    expect(resolver.doResolve).toHaveBeenCalledWith(null, createRequestContextWith({
-      path: _path.default.join(REWRITE_DIR, REQUEST_PATH, `index.jsx`),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    }), expect.anything(), expect.anything(), expect.anything());
-  });
-  test('a nested overrides folder path/to/overrides resolves correctly', () => {
-    const REQUEST_PATH = 'exists';
-    const REQUEST_EXTENSION = '.jsx';
-    const testRequestContext = createRequestContextWith({
-      path: _path.default.join('.', 'node_modules', EXTENDS_TARGET),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    });
-    const {
-      resolver,
-      callback
-    } = setupResolverAndCallback();
-    const nestedOverridesOptions = {
-      overridesDir: '/path/to/overrides',
-      extends: ['@salesforce/retail-react-app'],
-      projectDir: PROJECT_DIR
-    };
-    const overridesResolver = new _overridesPlugin.default(nestedOverridesOptions);
-    overridesResolver.handleHook(testRequestContext, {}, callback, resolver);
-    const nestedRewriteDir = 'src/configs/webpack/test/path/to/overrides';
-    expect(callback).toHaveBeenCalled();
-    expect(resolver.doResolve).toHaveBeenCalledWith(null, createRequestContextWith({
-      path: _path.default.join(nestedRewriteDir, REQUEST_PATH + REQUEST_EXTENSION),
-      request: `${EXTENDS_TARGET}/${REQUEST_PATH}`
-    }), expect.anything(), expect.anything(), expect.anything());
-  });
-});
-describe('OverridePlugin.isFromExtends', () => {
-  let os;
-  let cases;
-  if (_path.default.sep === '\\') {
-    // WINDOWS test cases
-    os = 'windows';
-    cases = [{
-      name: 'Import from a package in extends',
-      request: '@salesforce/retail-react-app/exists',
-      filepath: '.\\node_modules\\@salesforce\\retail-react-app',
-      result: true
-    }, {
-      name: 'Import from a package not in extends',
-      request: '@salesforce/express-minimal/notExists',
-      filepath: '.\\node_modules\\@salesforce\\retail-react-app',
-      result: false
-    }, {
-      name: 'Do not trigger override if filepath of issuer contains overrides directory',
-      request: '@salesforce/retail-react-app/exists',
-      filepath: 'src\\configs\\webpack\\test\\overrides\\exists',
-      result: false
-    }];
-  } else {
-    // POSIX test cases
-    os = 'posix';
-    cases = [{
-      name: 'Import from a package in extends',
-      request: '@salesforce/retail-react-app/exists',
-      filepath: './node_modules/@salesforce/retail-react-app',
-      result: true
-    }, {
-      name: 'Import from a package not in extends',
-      request: '@salesforce/express-minimal/notExists',
-      filepath: './node_modules/@salesforce/retail-react-app',
-      result: false
-    }, {
-      name: 'Do not trigger override if filepath of issuer contains overrides directory',
-      request: '@salesforce/retail-react-app/exists',
-      filepath: 'src/configs/webpack/test/overrides/exists',
-      result: false
-    }];
-  }
-  const plugin = new _overridesPlugin.default(options);
-  describe('Testing scenarios for: ' + os, () => {
-    cases.forEach(testCase =>
-    // eslint-disable-next-line jest/valid-title
-    test(testCase.name, () => {
-      const result = plugin.isFromExtends(testCase.request, testCase.filepath);
-      expect(result).toBe(testCase.result);
-    }));
-  });
-});
-describe('OverridePlugin.toOverrideRelative', () => {
-  const plugin = new _overridesPlugin.default(options);
-
-  // This is the only valid scenario since we only call this if isFromExtends is true
-  test('filepath contains extends package, extends package removed from path', () => {
-    const result = plugin.toOverrideRelative('@salesforce/retail-react-app/path/nested/icon');
-    console.log(result);
-    expect(result).toBe('path/nested/icon');
-  });
-});
-describe('OverridePlugin.findFileFromMap', () => {
-  let os;
-  let cases;
-  if (_path.default.sep === '\\') {
-    // WINDOWS test cases
-    os = 'windows';
-    cases = [{
-      name: 'request path contains nested path',
-      requestPath: 'path/nested/icon',
-      expectedResult: 'src\\configs\\webpack\\test\\overrides\\path\\nested\\icon.svg'
-    }, {
-      name: 'request path does not have file extension finds index file',
-      requestPath: 'path',
-      expectedResult: 'src\\configs\\webpack\\test\\overrides\\path\\index.jsx'
-    }, {
-      name: 'non-index file request path contains file extension',
-      requestPath: 'path/data.js',
-      expectedResult: 'src\\configs\\webpack\\test\\overrides\\path\\data.js'
-    }];
-  } else {
-    // POSIX test cases
-    os = 'posix';
-    cases = [{
-      name: 'request path contains nested path',
-      requestPath: 'path/nested/icon',
-      expectedResult: 'src/configs/webpack/test/overrides/path/nested/icon.svg'
-    }, {
-      name: 'request path does not have file extension finds index file',
-      requestPath: 'path',
-      expectedResult: 'src/configs/webpack/test/overrides/path/index.jsx'
-    }, {
-      name: 'non-index file request path contains file extension',
-      requestPath: 'path/data.js',
-      expectedResult: 'src/configs/webpack/test/overrides/path/data.js'
-    }];
-  }
-  const plugin = new _overridesPlugin.default(options);
-  describe('Testing scenarios for: ' + os, () => {
-    cases.forEach(testCase =>
-    // eslint-disable-next-line jest/valid-title
-    test(testCase.name, () => {
-      const result = plugin.findFileFromMap(testCase.requestPath, plugin._allSearchDirs);
-      expect(result).toBe(testCase.expectedResult);
-    }));
-  });
-
-  // The following test's result is the same regardless of OS
-  test('request path does not have file extension or extends dir', () => {
-    const result = plugin.findFileFromMap('@salesforce/express-minimal/notExists', plugin._allSearchDirs);
-    expect(result).toBeUndefined();
-  });
-
-  // TODO - Fix this in a future task
-  // This reproduces a bug! findFileFromMap treats the .mock as a file extension
-  // and the key becomes path/index, which is invalid (not only is path/index the wrong file,
-  // this is also the wrong key since we splice on '/index' when making the FS_READ_HASHMAP.
-  // the correct key for a path/index.js file is just 'path')
-  // This currently returns undefined rather than the path to the .mock file
-  // eslint-disable-next-line jest/no-commented-out-tests
-  // test('request path contains a '.' ie. index.mock', () => {
-  //     const result = plugin.findFileFromMap('path/index.mock', plugin._allSearchDirs)
-  //     console.log(result)
-  //     expect(result).toBe('src/configs/webpack/test/overrides/path/index.mock.jsx')
-  // })
-});

package/configs/webpack/test/overrides/exists.js

@@ -1,7 +0,0 @@
-/*
- * 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
- */
-"use strict";

package/configs/webpack/test/overrides/newExtension.js

@@ -1,7 +0,0 @@
-/*
- * 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
- */
-"use strict";

package/configs/webpack/test/overrides/path/index.js

@@ -1,7 +0,0 @@
-/*
- * 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
- */
-"use strict";

package/configs/webpack/test/overrides/path/index.mock.js

@@ -1,7 +0,0 @@
-/*
- * 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
- */
-"use strict";

package/configs/webpack/test/package.json

@@ -1,13 +0,0 @@
-{
-  "name": "my-extended-retail-app",
-  "version": "2.8.0-dev",
-  "license": "See license in LICENSE",
-  "engines": {
-    "node": "^16.11.0 || ^18.0.0 || ^20.0.0",
-    "npm": "^8.0.0 || ^9.0.0 || ^10.0.0"
-  },
-  "ccExtensibility": {
-    "extends": "retail-react-app",
-    "overridesDir": "src/configs/webpack/test/overrides"
-  }
-}