@revoloo/cypress6/packages/server-ct/src/specs-store.ts

Cypress.io end to end testing tool

import Bluebird from 'bluebird'
import chokidar, { FSWatcher } from 'chokidar'
import _ from 'lodash'
import { findSpecsOfType } from '@packages/server/lib/util/specs'

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

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

const COMMON_SEARCH_OPTIONS = ['fixturesFolder', 'supportFile', 'projectRoot', 'javascripts', 'testFiles', 'ignoreTestFiles']

// 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) {

  }

  get specDirectory () {
    return this.cypressConfig.componentFolder || '.'
  }

  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 = _.pick(this.cypressConfig, COMMON_SEARCH_OPTIONS)

    searchOptions.searchFolder = this.specDirectory

    return findSpecsOfType(searchOptions)
  }

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

    if (options?.onSpecsChanged) {
      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()
  }
}