cypress/packages/server/lib/specs-store.ts

import type Bluebird from 'bluebird'
import chokidar, { FSWatcher } from 'chokidar'
import _ from 'lodash'
import specsUtil from './util/specs'
/* eslint-disable no-duplicate-imports */
import type { CommonSearchOptions } from './util/specs'

type SpecFile = Cypress.Cypress['spec']
type SpecFiles = SpecFile[]

interface SpecsWatcherOptions {
  onSpecsChanged: (specFiles: SpecFiles) => void
}

// TODO: shouldn't this be on the trailing edge, not leading?
const debounce = (fn) => _.debounce(fn, 250, { leading: true })

export class SpecsStore {
  watcher: FSWatcher | null = null
  specFiles: SpecFiles = []

  constructor (
    private cypressConfig: Record<string, any>,
    private runner: Cypress.TestingType,
  ) {}

  get specDirectory () {
    if (this.runner === 'e2e') {
      return this.cypressConfig.resolved.integrationFolder.value
    }

    if (this.runner === 'component') {
      return this.cypressConfig.resolved.componentFolder.value
    }
  }

  get testFiles () {
    return this.cypressConfig.resolved.testFiles.value
  }

  get watchOptions (): chokidar.WatchOptions {
    return {
      cwd: this.specDirectory,
      ignored: this.cypressConfig.ignoreTestFiles,
      ignoreInitial: true,
    }
  }

  storeSpecFiles (): Bluebird<void> {
    return this.getSpecFiles()
    .then((specFiles) => {
      this.specFiles = specFiles
    })
  }

  getSpecFiles (): Bluebird<SpecFiles> {
    const searchOptions: CommonSearchOptions = {
      projectRoot: this.cypressConfig.projectRoot,
      fixturesFolder: this.cypressConfig.fixturesFolder,
      supportFile: this.cypressConfig.supportFile,
      testFiles: this.cypressConfig.testFiles,
      ignoreTestFiles: this.cypressConfig.ignoreTestFiles,
    }

    searchOptions.testFiles = this.testFiles

    return specsUtil.findSpecsOfType(this.specDirectory, searchOptions)
  }

  watch (options: SpecsWatcherOptions) {
    this.watcher = chokidar.watch(this.cypressConfig.testFiles, this.watchOptions)

    const onSpecsChanged = debounce(async () => {
      const newSpecs = await this.getSpecFiles()

      if (_.isEqual(newSpecs, this.specFiles)) return

      this.specFiles = newSpecs

      options.onSpecsChanged(newSpecs)
    })

    this.watcher.on('add', onSpecsChanged)
    this.watcher.on('unlink', onSpecsChanged)
  }

  reset (): void {
    this.watcher?.removeAllListeners()
  }
}