firebase-js-sdk/scripts/ci-test/testConfig.ts

/**
 * @license
 * Copyright 2020 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Should not define `ignorePackages` and `onlyIncludePackages` at same time,
 * `ignorePackages` will be ignored if you do so
 */
export interface TestConfig {
  // Ignore the packages in test even if they changed
  ignorePackages?: string[];
  // Only test these packages if any changed
  onlyIncludePackages?: string[];
  // Always test these packages even if they didn't change
  alwaysIncludePackages?: string[];
}

// These tests are flaky on WebkitHeadless for some reason, so skip them.
// TODO (dlarocque): Fix the flakes and remove this
const ignoredWebkitCoreTests = process.env?.BROWSERS?.includes('WebkitHeadless')
  ? [
      '@firebase/app-check',
      '@firebase/installations',
      '@firebase/storage',
      '@firebase/storage-compat',
      '@firebase/database',
      '@firebase/database-compat'
    ]
  : [];

export const testConfig: {
  [key: string]: TestConfig | undefined;
} = {
  'core': {
    'ignorePackages': [
      ...ignoredWebkitCoreTests,
      '@firebase/firestore',
      '@firebase/firestore-compat',
      'firebase-firestore-integration-test',
      'firebase-messaging-integration-test',
      'firebase-compat-typings-test',
      '@firebase/rules-unit-testing',
      '@firebase/auth',
      '@firebase/auth-compat',
      'firebase'
    ]
  },
  'firestore': {
    'onlyIncludePackages': ['@firebase/firestore', '@firebase/firestore-compat']
  },
  'firestore-integration': {
    'onlyIncludePackages': ['firebase-firestore-integration-test']
  },
  'fcm-integration': {
    'onlyIncludePackages': ['firebase-messaging-integration-test']
  },
  'misc': {
    'onlyIncludePackages': ['@firebase/rules-unit-testing']
  },
  'auth': {
    'onlyIncludePackages': ['@firebase/auth', '@firebase/auth-compat']
  }
};