cypress.config.ts

/* eslint-disable no-param-reassign */
import { defineConfig } from 'cypress';
import webpackPreprocessor from '@cypress/webpack-preprocessor';
import fs from 'fs';
import path from 'path';
import MomentTimezoneInclude from './src/app/legacy/psammead/moment-timezone-include/src';
import { webpackDirAlias } from './dirAlias';
import { DefinePlugin } from 'webpack';
import dotenv from 'dotenv';

const appDirectory = fs.realpathSync(process.cwd());
const resolvePath = (relativePath: string) =>
  path.resolve(appDirectory, relativePath);

export default defineConfig({
  reporter: 'cypress-multi-reporters',
  reporterOptions: {
    configFile: 'cypress/reporter-config.json',
  },
  e2e: {
    setupNodeEvents(on, config) {
      if (!config.env.APP_ENV) {
        config.env.APP_ENV = 'local';
      }

      const appEnv = config.env.APP_ENV;
      const env = config.env[appEnv];

      const { parsed: appConfig } = dotenv.config({
        path: `./envConfig/${config.env.APP_ENV}.env`,
      });

      // @ts-expect-error appConfig is a list of keys
      const envVars = Object.keys(appConfig).reduce((vars, key) => {
        // @ts-expect-error appConfig is a list of keys
        vars[key] = JSON.stringify(appConfig[key]);
        return vars;
      }, {});

      // TOGGLES_BFF_PATH is a secret provided via the shell env, not the envConfig .env file
      // @ts-expect-error envVars is a list of keys
      envVars.TOGGLES_BFF_PATH = JSON.stringify(process.env.TOGGLES_BFF_PATH);

      config.baseUrl = env.baseUrl;

      // Debugging console logs to see running config
      /* eslint-disable no-console */
      console.log('\n\n\n\n\n');
      console.log('Cypress running config:');
      console.log('SMOKE:', config.env.SMOKE);
      console.log('APP_ENV:', config.env.APP_ENV);
      console.log('UK:', config.env.UK);
      console.log('ONLY_SERVICE:', config.env.ONLY_SERVICE || '');
      console.log('SKIP_EU:', Boolean(config.env.SKIP_EU));
      console.log('\n\n\n\n\n');
      /* eslint-enable no-console */

      const options = {
        webpackOptions: {
          resolve: {
            extensions: ['.ts', '.tsx', '.js', '.jsx'],
            alias: {
              ...webpackDirAlias,
            },
          },

          module: {
            rules: [
              // tell Webpack to use the .babelrc to know how to transform JS/JSX to ES2015 JS
              {
                test: /\.(js|jsx|mjs)$/,
                include: [resolvePath('src')],
                use: [
                  {
                    loader: 'babel-loader',
                  },
                ],
              },
              {
                test: /\.(ts|tsx)$/,
                include: [resolvePath('src'), resolvePath('ws-nextjs-app')],
                use: [
                  'babel-loader',
                  {
                    loader: 'ts-loader',
                    options: {
                      transpileOnly: true,
                    },
                  },
                ],
              },
            ],
          },
          plugins: [
            // @ts-expect-error - TODO: fix types
            new MomentTimezoneInclude({
              startYear: 2010,
              endYear: new Date().getFullYear() + 1,
            }),
            new DefinePlugin({
              process: {
                env: envVars,
              },
            }),
          ],
        },
        watchOptions: {
          ignored: ['**/tz/**'],
        },
      };

      on('file:preprocessor', webpackPreprocessor(options));

      // Add options for the cypress terminal report (cy.logs) here
      const logPrinterOptions = {
        defaultTrimLength: 2000,
      };
      // eslint-disable-next-line global-require, @typescript-eslint/no-var-requires
      require('cypress-terminal-report/src/installLogsPrinter')(
        on,
        logPrinterOptions,
      );

      on('task', {
        log(message) {
          // eslint-disable-next-line no-console
          console.log(message);
          return null;
        },
        table(message) {
          // eslint-disable-next-line no-console
          console.table(message);
          return null;
        },
        error(message) {
          // eslint-disable-next-line no-console
          console.error(message);
          return null;
        },
      });

      return config;
    },
    env: {
      APP_ENV: 'local',
      SMOKE: true,
      UK: false,
      live: {
        baseUrl: 'https://www.bbc.com',
      },
      test: {
        baseUrl: 'https://www.test.bbc.com',
      },
      local: {
        baseUrl: 'http://localhost:7080',
      },
    },
    testIsolation: false,
    excludeSpecPattern: [
      '**/README.md',
      '**/pages/**/tests.js',
      '**/pages/**/urls.js',
      '**/pages/**/testsForAMPOnly.js',
      '**/*/pages/**/testsForCanonicalOnly.js',
      '**/pages/testsForAllPages.js',
      '**/pages/testsForAllAMPPages.js',
      '**/pages/testsForAllCanonicalPages.js',
      '**/pages/**/helper.js',
      '**/pages/**/helpers.js',
      '**/pages/**/getErrorPath.js',
      '**/pages/**/mostReadAssertions.js',
      '**/specialFeatures/utilities/**',
      '**/specialFeatures/**/testsForAMPOnly.js',
      '**/specialFeatures/**/testsForCanonicalOnly.js',
      '**/specialFeatures/**/config.js',
    ],
  },
  video: false,
  screenshotOnRunFailure: false,
  blockHosts: 'gn-web-assets.api.bbc.com',
  defaultCommandTimeout: 10000,
  pageLoadTimeout: 100000,
  responseTimeout: 70000,
  chromeWebSecurity: false,
});