cypress.config.ts

/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 */

import fs from 'fs';
import { defineConfig } from 'cypress';
import webpackPreprocessor from '@cypress/webpack-preprocessor';

module.exports = defineConfig({
  experimentalMemoryManagement: true,
  numTestsKeptInMemory: 0,
  defaultCommandTimeout: 15000,
  requestTimeout: 60000,
  responseTimeout: 60000,
  retries: {
    runMode: 2,
    openMode: 0,
  },
  viewportWidth: 1920,
  viewportHeight: 1080,
  video: true,
  videoCompression: false,
  trashAssetsBeforeRuns: false,
  videosFolder: 'cypress/videos',
  screenshotsFolder: 'cypress/screenshots',

  env: {
    ENGINE: {
      name: 'default',
      url: 'http://localhost:9200',
    },
    SECONDARY_ENGINE: {
      name: 'test_cluster',
      url: 'http://localhost:9200',
    },
    S3_ENGINE: {
      name: 'BasicS3Connection',
      url: process.env.S3_CONNECTION_URL,
      username: process.env.S3_CONNECTION_USERNAME,
      password: process.env.S3_CONNECTION_PASSWORD,
    },
    PROMETHEUS: {
      name: 'test-prometheus',
      url: process.env.PROMETHEUS_CONNECTION_URL,
    },
    openSearchUrl: 'http://localhost:9200',
    SECURITY_ENABLED: false,
    AGGREGATION_VIEW: false,
    username: 'admin',
    password: 'myStrongPassword123!',
    ENDPOINT_WITH_PROXY: false,
    MANAGED_SERVICE_ENDPOINT: false,
    VISBUILDER_ENABLED: true,
    DATASOURCE_MANAGEMENT_ENABLED: false,
    ML_COMMONS_DASHBOARDS_ENABLED: true,
    WAIT_FOR_LOADER_BUFFER_MS: 0,
    WAIT_MS: 2000,
    WAIT_MS_LONG: 10000,
    DISABLE_LOCAL_CLUSTER: false,
    CYPRESS_RUNTIME_ENV: 'osd',
  },
  e2e: {
    baseUrl: 'http://localhost:5601',
    specPattern: 'cypress/integration/**/*.spec.{js,jsx,ts,tsx}',
    testIsolation: false,
    setupNodeEvents,
    chromeWebSecurity: false,
  },
});

function setupNodeEvents(
  on: Cypress.PluginEvents,
  config: Cypress.PluginConfigOptions
): Cypress.PluginConfigOptions {
  const { webpackOptions } = webpackPreprocessor.defaultOptions;

  // Fix: Error: Webpack Compilation Error
  // Module not found: Error: Can't resolve 'path'
  webpackOptions!.plugins = webpackOptions!.plugins || [];
  // eslint-disable-next-line @typescript-eslint/no-var-requires
  webpackOptions!.plugins.push(new (require('node-polyfill-webpack-plugin'))());

  /**
   * By default, cypress' internal webpack preprocessor doesn't allow imports without file extensions.
   * This makes our life a bit hard since if any file in our testing dependency graph has an import without
   * the .js extension our cypress build will fail.
   *
   * This extra rule relaxes this a bit by allowing imports without file extension
   *     ex. import module from './module'
   */
  // @ts-expect-error TODO FIX ME
  webpackOptions!.module!.rules.unshift({
    test: /\.m?js/,
    resolve: {
      fullySpecified: false,
    },
  });

  /**
   * Add babel-loader to handle modern JavaScript syntax like optional chaining
   */
  // @ts-expect-error TODO FIX ME
  webpackOptions!.module!.rules.push({
    test: /\.(js|ts)$/,
    exclude: /node_modules/,
    use: {
      loader: 'babel-loader',
      options: {
        presets: [
          ['@babel/preset-env', { targets: { node: 'current' } }],
          '@babel/preset-typescript',
        ],
        plugins: [
          '@babel/plugin-proposal-optional-chaining',
          '@babel/plugin-proposal-nullish-coalescing-operator',
        ],
      },
    },
  });

  on(
    'file:preprocessor',
    webpackPreprocessor({
      webpackOptions,
    })
  );

  // Delete video files for specs where all tests passed.
  // Keeps compressed videos only for failures to aid debugging.
  on('after:spec', (spec: Cypress.Spec, results: CypressCommandLine.RunResult) => {
    if (results && results.video) {
      const hasFailures = results.tests?.some((test) =>
        test.attempts?.some((attempt) => attempt.state === 'failed')
      );
      if (!hasFailures) {
        fs.unlinkSync(results.video);
      }
    }
  });

  return config;
}