jest.config.mjs

import jest from '@jest/types';
import { defaults } from 'jest-config';
import { cpus } from 'os';
import { env } from 'process';

/**
 * This is the shared Jest configuration for all the project. Jest does not
 * typically look for this file in parent directories, so it should be symlinked
 * in all the packages, so it gets properly discovered. If some values need to
 * be overridden (for example, the coverage threshold), then a new
 * `jest.config.ts` file should be created that imports from this one and
 * modifies just what needs to be modified, typically using `overriddenConfig`.
 *
 * @type {jest.Config.InitialOptions}
 */
const config = {
  ...defaults,

  collectCoverage: true,
  coverageReporters: ['lcov', 'text'],
  coverageThreshold: {
    global: {
      branches: 60,
      statements: 60,
    },
  },
  errorOnDeprecated: true,
  // When in Continuous Integration, use only 1 worker (assuming "frugal" runner type)
  maxWorkers: env.CI === 'true' ? 1 : defaults.maxWorkers,
  testEnvironment: 'node',
  testMatch: ['**/?(*.)+(spec|test).js'],
  testRunner: 'jest-circus/runner',
  // Adjust maximum concurrency to specifically disallow running unbounded. Allow a minimum of 2 concurrent
  // tests, and a maximum of 4 (which is the libuv thread pool size - more will likely cause wait times to
  // quickly run out of control, and make everything very, very slow.)
  maxConcurrency: Math.max(Math.min(cpus().length - 1, 4), 2),
  // When in Continuous Integration, allow double the default test timeout (assuming "frugal" runner type)
  testTimeout: env.CI === 'true' ? 30_000 : undefined,
};

/**
 * Overrides the default configuration with the provided values. The merge
 * operation works deeply on objects, but overrides that are not objects (e.g:
 * arrays, strings, ...) simply replace the original value.
 *
 * @param {jest.Config.InitialOptions} overrides values to be used for overriding the orignal configuration.
 *
 * @return {jest.Config.InitialOptions}
 */
export function overriddenConfig(overrides) {
  return merge(config, overrides);

  function merge(original, override) {
    if (typeof original === 'object') {
      // Arrays are objects, too!
      if (Array.isArray(override)) {
        return override;
      }

      const result = {};
      const allKeys = new Set([
        ...Object.keys(original),
        ...Object.keys(override),
      ]);

      // TypeScript appears to choke if we do the "as any" in the same
      // expression as the key access, so we delcare surrogate varibales...
      for (const key of Array.from(allKeys).sort()) {
        const originalValue = original[key];
        const overrideValue = override[key];
        if (originalValue == null) {
          result[key] = overrideValue;
        } else if (overrideValue == null) {
          result[key] = originalValue;
        } else {
          result[key] = merge(originalValue, overrideValue);
        }
      }
      return result;
    }
    return override;
  }
}

export default config;