jest.config.ts

/**
 * @file
 * This file is part of AdGuard Browser Extension (https://github.com/AdguardTeam/AdguardBrowserExtension).
 *
 * AdGuard Browser Extension is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AdGuard Browser Extension is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with AdGuard Browser Extension. If not, see <http://www.gnu.org/licenses/>.
 */
import type { Config } from 'jest';
import escapeStringRegexp from 'escape-string-regexp';
import * as dependencyPath from '@pnpm/dependency-path';

/**
 * Helper function that adds special pnpm filenames to the list of modules.
 * This is necessary because some modules may be placed within the `.pnpm` directory,
 * and in such cases, pnpm changes their names, e.g., `@adguard/tsurlfilter` to `.pnpm/@adguard+tsurlfilter@x.y.z`.
 * If we want to ignore certain modules in the transform step, we need to add their pnpm names to the list.
 * This function does that automatically.
 *
 * @param modules List of modules.
 *
 * @returns List of modules extended with pnpm names.
 */
const extendWithSpecialPnpmFileNames = (modules: string[]): string[] => {
    const result: string[] = [];

    modules.forEach((module) => {
        result.push(module);

        const moduleFileName = dependencyPath.depPathToFilename(module, 120);
        if (module !== moduleFileName) {
            result.push(moduleFileName);
        }
    });

    return result;
};

const transformedModules = extendWithSpecialPnpmFileNames([
    '@adguard/tsurlfilter',
    '@adguard/tswebextension',
    '@adguard/filters-downloader',
    'lodash-es',
    'nanoid',
]);

const config: Config = {
    verbose: true,
    testEnvironment: 'jsdom',
    testEnvironmentOptions: {
        // eslint-disable-next-line max-len
        userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 YaBrowser/22.11.0.2468 Yowser/2.5 Safari/537.36',
    },
    testRegex: '(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$',
    setupFiles: [
        './testSetup.ts',
    ],
    transformIgnorePatterns: [
        // https://github.com/jestjs/jest/issues/12984#issuecomment-1198204906
        `<rootDir>/node_modules/(?!(?:.pnpm/)?(${transformedModules.map(escapeStringRegexp).join('|')}))`,
        '.*\\.json',
    ],
    transform: {
        '.+\\.(js|ts|jsx|tsx)': '@swc/jest',
    },
    globals: {
        // TODO: (AG-20414) Add tests for Firefox AMO
        IS_FIREFOX_AMO: false,
        // For run tests like it's release.
        IS_RELEASE: true,
    },
};

export default config;