sauceVisualCheck.ts

import { ensureError, getFullPageConfig, isSkipMode } from '@saucelabs/visual';
import { parseIgnoreOptions, toIgnoreRegionIn } from '../../utils/regions';
import { getMetaInfo, getVisualApi } from '../../utils/api';
import { VISUAL_BUILD_ID_KEY } from '../../utils/constants';
import { NightwatchAPI } from 'nightwatch';
import { NightwatchCustomCommandsModel } from 'nightwatch/types/custom-command';
import { CheckOptions, RunnerSettings } from '../../types';
import { Runnable } from 'mocha';

type APIType = NightwatchAPI & {
  capabilities: Record<string, any>;
  options: RunnerSettings;
};

export default class SauceVisualCheck implements NightwatchCustomCommandsModel {
  // These are used for Cucumber
  static featureName = '';
  static scenarioName = '';

  // Mocha context can be passed, but
  //  - not for all runners,
  //  - not always as the third argument
  async command(name: string, optionsArg = {}, mochaContextArg = {}) {
    console.log(`Checking ${name}`);
    if (isSkipMode()) {
      console.log(`Checking ${name}: SKIPPED`);
      global.skipped = (global.skipped ?? 0) + 1;
      return null;
    }

    // @ts-expect-error API doesn't allow us to type the options / extra values from webdriver.
    const nightwatchBrowserObject: APIType = this.api as unknown as APIType;
    //
    // Check if the first argument is a Mocha context
    const isMochaContext = (arg: Runnable | Record<any, any>) =>
      arg.title &&
      // TODO: Replace with a non-private member / usage.
      // @ts-ignore
      arg.ctx?._runnable?.title;
    const [options, mochaContext] = (
      isMochaContext(optionsArg)
        ? [{}, optionsArg]
        : [optionsArg, mochaContextArg]
    ) as [CheckOptions, Runnable];
    //
    // Getting the suite and testname from the current test
    let module = '';
    let defaultTestName = '';
    if (nightwatchBrowserObject && nightwatchBrowserObject.currentTest) {
      module = nightwatchBrowserObject.currentTest.module || '';
      defaultTestName = nightwatchBrowserObject.currentTest.name || '';
    }
    //
    // With CucumberJS we don't get the data, so we use the static values that are being set in on of the
    // global hooks during the eventBroadcaster TestCaseStarted
    // Mocha is done through the mochaContext
    const suiteName =
      mochaContext?.title || SauceVisualCheck.featureName || module || '';
    const testName =
      // TODO: Replace with a non-private member / usage.
      // @ts-ignore
      mochaContext?.ctx?._runnable?.title ||
      SauceVisualCheck.scenarioName ||
      defaultTestName ||
      '';

    // Ignore magic
    const ignoreOptions = options.ignore ?? [];
    const resolvedIgnoreOptions = parseIgnoreOptions(ignoreOptions);
    const ignoreRegions =
      ignoreOptions.length > 0
        ? await toIgnoreRegionIn(resolvedIgnoreOptions)
        : [];
    //
    // Get more info about the session
    const {
      capabilities,
      sessionId,
      options: {
        webdriver: { host, port } = {},
        sauceVisualService: {
          captureDom: globalCaptureDom = false,
          fullPage,
        } = {},
      },
    } = nightwatchBrowserObject;
    const sauceConfig = {
      hostname: host,
      port: port,
      user: process.env.SAUCE_USERNAME,
      key: process.env.SAUCE_ACCESS_KEY,
    };
    const jobId = capabilities['jobUuid'] || sessionId;
    const buildId = process.env[VISUAL_BUILD_ID_KEY] || '';

    if (!buildId) {
      nightwatchBrowserObject.assert.fail('No buildId found');
      return null;
    }

    const api = getVisualApi(sauceConfig);
    const metaInfo = await getMetaInfo(api, sessionId, jobId);

    let result: Awaited<
      ReturnType<typeof api.createSnapshotFromWebDriver>
    > | null = null;

    try {
      result = await api.createSnapshotFromWebDriver({
        sessionId,
        jobId,
        buildUuid: buildId,
        name: name,
        ignoreRegions,
        sessionMetadata: metaInfo,
        suiteName,
        testName,
        fullPageConfig: getFullPageConfig(fullPage, options.fullPage),
        clipSelector: options.clipSelector,
        captureDom: options.captureDom ?? globalCaptureDom,
      });

      global.uploadedDiffIds.push(
        ...result.diffs.nodes.flatMap((diff) => diff.id),
      );
    } catch (e) {
      const errorMessage = ensureError(e).message ?? 'Unknown error';
      nightwatchBrowserObject.assert.fail(errorMessage);
    }

    return result;
  }
}