happo 6.2.5 → 6.3.0

package/dist/cli/package-4Y7MCBOA.js

@@ -1,7 +0,0 @@
-import {
-  package_default
-} from "./chunk-375RAU4V.js";
-export {
-  package_default as default
-};
-//# sourceMappingURL=package-4Y7MCBOA.js.map

package/dist/cli/startJob-OYUB63PQ.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/network/startJob.ts"],
-  "sourcesContent": ["import type { ConfigWithDefaults } from '../config/index.ts';\nimport type { EnvironmentResult } from '../environment/index.ts';\nimport type { Logger } from '../isomorphic/types.ts';\nimport makeHappoAPIRequest from './makeHappoAPIRequest.ts';\n\ninterface StartJobResult {\n  id: number;\n  url: string;\n}\n\nfunction assertResultIsStartJobResult(\n  result: unknown,\n): asserts result is StartJobResult {\n  if (typeof result !== 'object' || result === null) {\n    throw new TypeError('Result is not an object');\n  }\n\n  if (!('id' in result) || typeof result.id !== 'number') {\n    throw new TypeError('Result is missing id');\n  }\n\n  if (!('url' in result) || typeof result.url !== 'string') {\n    throw new TypeError('Result is missing url');\n  }\n}\n\n/**\n * Tell Happo that we are about to run a job\n *\n * @see https://happo.io/docs/api#createJob\n */\nexport default async function startJob(\n  config: ConfigWithDefaults,\n  { beforeSha, afterSha, link, message }: EnvironmentResult,\n  logger: Logger,\n): Promise<StartJobResult> {\n  const result = await makeHappoAPIRequest(\n    {\n      path: `/api/jobs/${beforeSha}/${afterSha}`,\n      method: 'POST',\n      body: {\n        link,\n        message,\n        project: config.project,\n      },\n    },\n    config,\n    { retryCount: 5 },\n    logger,\n  );\n\n  assertResultIsStartJobResult(result);\n\n  return result;\n}\n"],
-  "mappings": ";;;;;;;AAUA,SAAS,6BACP,QACkC;AAClC,MAAI,OAAO,WAAW,YAAY,WAAW,MAAM;AACjD,UAAM,IAAI,UAAU,yBAAyB;AAAA,EAC/C;AAEA,MAAI,EAAE,QAAQ,WAAW,OAAO,OAAO,OAAO,UAAU;AACtD,UAAM,IAAI,UAAU,sBAAsB;AAAA,EAC5C;AAEA,MAAI,EAAE,SAAS,WAAW,OAAO,OAAO,QAAQ,UAAU;AACxD,UAAM,IAAI,UAAU,uBAAuB;AAAA,EAC7C;AACF;AAOA,eAAO,SACL,QACA,EAAE,WAAW,UAAU,MAAM,QAAQ,GACrC,QACyB;AACzB,QAAM,SAAS,MAAM;AAAA,IACnB;AAAA,MACE,MAAM,aAAa,SAAS,IAAI,QAAQ;AAAA,MACxC,QAAQ;AAAA,MACR,MAAM;AAAA,QACJ;AAAA,QACA;AAAA,QACA,SAAS,OAAO;AAAA,MAClB;AAAA,IACF;AAAA,IACA;AAAA,IACA,EAAE,YAAY,EAAE;AAAA,IAChB;AAAA,EACF;AAEA,+BAA6B,MAAM;AAEnC,SAAO;AACT;",
-  "names": []
-}

package/dist/cli/wrapper-PB35T36R.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../src/e2e/wrapper.ts"],
-  "sourcesContent": ["import { spawn } from 'node:child_process';\nimport http from 'node:http';\n\nimport type { ConfigWithDefaults, E2EIntegration } from '../config/index.ts';\nimport type { EnvironmentResult } from '../environment/index.ts';\nimport createAsyncComparison from '../network/createAsyncComparison.ts';\nimport makeHappoAPIRequest from '../network/makeHappoAPIRequest.ts';\nimport postGitHubComment from '../network/postGitHubComment.ts';\nimport startServer, { type ServerInfo } from '../network/startServer.ts';\n\nlet allRequestIds: Set<number>;\n\nasync function postAsyncReport(\n  requestIds: Array<number>,\n  environment: EnvironmentResult,\n  happoConfig: ConfigWithDefaults,\n) {\n  const { afterSha, nonce, link, message } = environment;\n  return await makeHappoAPIRequest(\n    {\n      path: `/api/async-reports/${afterSha}`,\n      method: 'POST',\n      json: true,\n      body: {\n        requestIds,\n        project: happoConfig.project,\n        nonce,\n        link,\n        message,\n      },\n    },\n    happoConfig,\n    { retryCount: 2 },\n  );\n}\n\ntype Example = {\n  component: string;\n  variant: string;\n  target: string;\n};\n\ntype Logger = Pick<Console, 'log' | 'error'>;\n\ninterface FinalizeAllOptions {\n  happoConfig: ConfigWithDefaults;\n  environment: EnvironmentResult;\n  skippedExamplesJSON?: string;\n  logger: Logger;\n}\n\nexport async function finalizeAll({\n  happoConfig,\n  environment,\n  skippedExamplesJSON,\n  logger,\n}: FinalizeAllOptions): Promise<void> {\n  const { afterSha, nonce } = environment;\n\n  if (!nonce) {\n    throw new Error('[HAPPO] Missing --nonce argument');\n  }\n\n  const body: {\n    project?: string | undefined;\n    nonce: string;\n    skippedExamples: Array<Example>;\n  } = {\n    project: happoConfig.project,\n    nonce,\n    skippedExamples: [],\n  };\n\n  if (skippedExamplesJSON) {\n    try {\n      const skippedExamples = JSON.parse(skippedExamplesJSON);\n      body.skippedExamples = skippedExamples;\n    } catch (e) {\n      logger.error('Error when parsing --skippedExamples', skippedExamplesJSON);\n      throw e;\n    }\n  }\n  await makeHappoAPIRequest(\n    {\n      path: `/api/async-reports/${afterSha}/finalize`,\n      method: 'POST',\n      json: true,\n      body,\n    },\n    happoConfig,\n    { retryCount: 3 },\n  );\n\n  if (environment.beforeSha !== environment.afterSha) {\n    const compareResult = await createAsyncComparison(\n      happoConfig,\n      environment,\n      logger,\n    );\n\n    if (environment.link && environment.githubToken && happoConfig.githubApiUrl) {\n      // githubToken and githubApiUrl are set which means that we should post\n      // a comment to the PR.\n      // https://docs.happo.io/docs/continuous-integration#posting-statuses-without-installing-the-happo-github-app\n      await postGitHubComment({\n        authToken: environment.githubToken,\n        link: environment.link,\n        statusImageUrl: compareResult.statusImageUrl,\n        compareUrl: compareResult.compareUrl,\n        githubApiUrl: happoConfig.githubApiUrl,\n      });\n    }\n  }\n}\n\nasync function finalizeHappoReport(\n  happoConfig: ConfigWithDefaults,\n  environment: EnvironmentResult,\n  logger: Logger,\n) {\n  if (!allRequestIds.size) {\n    logger.log(`[HAPPO] No snapshots were recorded. Ignoring.`);\n    return;\n  }\n  const reportResult = await postAsyncReport(\n    [...allRequestIds],\n    environment,\n    happoConfig,\n  );\n\n  if (!reportResult) {\n    throw new Error('Failed to create async Happo report');\n  }\n\n  const { beforeSha, afterSha, link, message, nonce } = environment;\n\n  const jobResult = await makeHappoAPIRequest(\n    {\n      path: `/api/jobs/${beforeSha}/${afterSha}`,\n      method: 'POST',\n      json: true,\n      body: {\n        project: happoConfig.project,\n        link,\n        message,\n      },\n    },\n    happoConfig,\n    { retryCount: 2 },\n  );\n\n  if (!jobResult) {\n    throw new Error('Failed to create Happo job');\n  }\n\n  if (!('url' in jobResult) || typeof jobResult.url !== 'string') {\n    throw new Error('Job result is missing url');\n  }\n\n  if (!nonce) {\n    // If there is a nonce, the comparison will happen when the finalize\n    // command is called.\n    const compareResult = await createAsyncComparison(\n      happoConfig,\n      environment,\n      logger,\n    );\n\n    if (\n      compareResult &&\n      environment.link &&\n      environment.githubToken &&\n      happoConfig.githubApiUrl\n    ) {\n      // githubToken and githubApiUrl is set which means that we should post\n      // a comment to the PR.\n      // https://docs.happo.io/docs/continuous-integration#posting-statuses-without-installing-the-happo-github-app\n      await postGitHubComment({\n        authToken: environment.githubToken,\n        link: environment.link,\n        statusImageUrl: compareResult.statusImageUrl,\n        compareUrl: compareResult.compareUrl,\n        githubApiUrl: happoConfig.githubApiUrl,\n      });\n    }\n  }\n  logger.log(`[HAPPO] ${jobResult.url}`);\n}\n\nfunction startE2EServer(\n  environment: EnvironmentResult,\n  happoConfig: ConfigWithDefaults,\n): Promise<ServerInfo> {\n  function requestHandler(req: http.IncomingMessage, res: http.ServerResponse) {\n    const bodyParts: Array<string> = [];\n    req.on('data', (chunk: Buffer) => {\n      bodyParts.push(chunk.toString());\n    });\n    req.on('end', async () => {\n      const potentialIds = bodyParts\n        .join('')\n        .split('\\n')\n        .filter(Boolean)\n        .map((requestId) => Number.parseInt(requestId, 10));\n\n      if (potentialIds.some((id) => Number.isNaN(id))) {\n        res.writeHead(400);\n        res.end('invalid payload');\n        return;\n      }\n\n      for (const requestId of potentialIds) {\n        allRequestIds.add(requestId);\n      }\n\n      const { nonce } = environment;\n      if (nonce && potentialIds.length) {\n        // Associate these snapRequests with the async report as soon as possible\n        await postAsyncReport(potentialIds, environment, happoConfig);\n      }\n      res.writeHead(200);\n      res.end('');\n    });\n  }\n  return startServer(requestHandler);\n}\n\nfunction assertE2EIntegration(\n  integration: NonNullable<ConfigWithDefaults['integration']>,\n): asserts integration is E2EIntegration {\n  if (integration.type !== 'cypress' && integration.type !== 'playwright') {\n    throw new Error(`Unsupported integration type: ${integration.type}`);\n  }\n}\n\n/**\n * Runs a command with the wrapper and returns the exit code.\n *\n * @param dashdashCommandParts The command to run with the wrapper\n * @param happoConfig The Happo config\n * @param environment The environment\n * @param port The port to listen on\n * @param logger The logger\n * @returns The exit code of the command\n */\nexport default async function runWithWrapper(\n  dashdashCommandParts: Array<string>,\n  happoConfig: ConfigWithDefaults,\n  environment: EnvironmentResult,\n  logger: Logger,\n  configFilePath: string,\n): Promise<number> {\n  allRequestIds = new Set<number>();\n  const e2eServer = await startE2EServer(environment, happoConfig);\n  logger.log(`[HAPPO] Listening on port ${e2eServer.port}`);\n\n  try {\n    const exitCode = await new Promise<number>((resolve, reject) => {\n      const child = spawn(dashdashCommandParts[0]!, dashdashCommandParts.slice(1), {\n        stdio: 'inherit',\n        env: {\n          ...process.env,\n          HAPPO_E2E_PORT: e2eServer.port.toString(),\n          HAPPO_CONFIG_FILE: configFilePath,\n          HAPPO_API_KEY: happoConfig.apiKey,\n          HAPPO_API_SECRET: happoConfig.apiSecret,\n        },\n        shell: process.platform == 'win32',\n      });\n\n      child.on('error', (e) => {\n        return reject(e);\n      });\n\n      const e2eIntegration = happoConfig.integration;\n      assertE2EIntegration(e2eIntegration);\n      child.on('close', async (code: number) => {\n        if (code === 0 || e2eIntegration.allowFailures) {\n          try {\n            await finalizeHappoReport(happoConfig, environment, logger);\n          } catch (e) {\n            logger.error('Failed to finalize Happo report', e);\n            return reject(e);\n          }\n        } else {\n          logger.error(\n            'Command failed with exit code ${code}. Cancelling Happo job.',\n          );\n          try {\n            await makeHappoAPIRequest(\n              {\n                path: `/api/jobs/${environment.beforeSha}/${environment.afterSha}/cancel`,\n                method: 'POST',\n                json: true,\n                body: {\n                  status: 'failure',\n                  project: happoConfig.project,\n                  link: environment.link,\n                  message: `${e2eIntegration.type} run failed`,\n                },\n              },\n              happoConfig,\n              { retryCount: 3 },\n            );\n          } catch (e) {\n            logger.error('Failed to cancel Happo job', e);\n            return reject(e);\n          }\n        }\n        resolve(code);\n      });\n    });\n    return exitCode;\n  } finally {\n    allRequestIds.clear();\n    await e2eServer.close();\n  }\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;AAAA,SAAS,aAAa;AAUtB,IAAI;AAEJ,eAAe,gBACb,YACA,aACA,aACA;AACA,QAAM,EAAE,UAAU,OAAO,MAAM,QAAQ,IAAI;AAC3C,SAAO,MAAM;AAAA,IACX;AAAA,MACE,MAAM,sBAAsB,QAAQ;AAAA,MACpC,QAAQ;AAAA,MACR,MAAM;AAAA,MACN,MAAM;AAAA,QACJ;AAAA,QACA,SAAS,YAAY;AAAA,QACrB;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,IACA;AAAA,IACA,EAAE,YAAY,EAAE;AAAA,EAClB;AACF;AAiBA,eAAsB,YAAY;AAAA,EAChC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAAsC;AACpC,QAAM,EAAE,UAAU,MAAM,IAAI;AAE5B,MAAI,CAAC,OAAO;AACV,UAAM,IAAI,MAAM,kCAAkC;AAAA,EACpD;AAEA,QAAM,OAIF;AAAA,IACF,SAAS,YAAY;AAAA,IACrB;AAAA,IACA,iBAAiB,CAAC;AAAA,EACpB;AAEA,MAAI,qBAAqB;AACvB,QAAI;AACF,YAAM,kBAAkB,KAAK,MAAM,mBAAmB;AACtD,WAAK,kBAAkB;AAAA,IACzB,SAAS,GAAG;AACV,aAAO,MAAM,wCAAwC,mBAAmB;AACxE,YAAM;AAAA,IACR;AAAA,EACF;AACA,QAAM;AAAA,IACJ;AAAA,MACE,MAAM,sBAAsB,QAAQ;AAAA,MACpC,QAAQ;AAAA,MACR,MAAM;AAAA,MACN;AAAA,IACF;AAAA,IACA;AAAA,IACA,EAAE,YAAY,EAAE;AAAA,EAClB;AAEA,MAAI,YAAY,cAAc,YAAY,UAAU;AAClD,UAAM,gBAAgB,MAAM;AAAA,MAC1B;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,QAAI,YAAY,QAAQ,YAAY,eAAe,YAAY,cAAc;AAI3E,YAAM,kBAAkB;AAAA,QACtB,WAAW,YAAY;AAAA,QACvB,MAAM,YAAY;AAAA,QAClB,gBAAgB,cAAc;AAAA,QAC9B,YAAY,cAAc;AAAA,QAC1B,cAAc,YAAY;AAAA,MAC5B,CAAC;AAAA,IACH;AAAA,EACF;AACF;AAEA,eAAe,oBACb,aACA,aACA,QACA;AACA,MAAI,CAAC,cAAc,MAAM;AACvB,WAAO,IAAI,+CAA+C;AAC1D;AAAA,EACF;AACA,QAAM,eAAe,MAAM;AAAA,IACzB,CAAC,GAAG,aAAa;AAAA,IACjB;AAAA,IACA;AAAA,EACF;AAEA,MAAI,CAAC,cAAc;AACjB,UAAM,IAAI,MAAM,qCAAqC;AAAA,EACvD;AAEA,QAAM,EAAE,WAAW,UAAU,MAAM,SAAS,MAAM,IAAI;AAEtD,QAAM,YAAY,MAAM;AAAA,IACtB;AAAA,MACE,MAAM,aAAa,SAAS,IAAI,QAAQ;AAAA,MACxC,QAAQ;AAAA,MACR,MAAM;AAAA,MACN,MAAM;AAAA,QACJ,SAAS,YAAY;AAAA,QACrB;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAAA,IACA;AAAA,IACA,EAAE,YAAY,EAAE;AAAA,EAClB;AAEA,MAAI,CAAC,WAAW;AACd,UAAM,IAAI,MAAM,4BAA4B;AAAA,EAC9C;AAEA,MAAI,EAAE,SAAS,cAAc,OAAO,UAAU,QAAQ,UAAU;AAC9D,UAAM,IAAI,MAAM,2BAA2B;AAAA,EAC7C;AAEA,MAAI,CAAC,OAAO;AAGV,UAAM,gBAAgB,MAAM;AAAA,MAC1B;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAEA,QACE,iBACA,YAAY,QACZ,YAAY,eACZ,YAAY,cACZ;AAIA,YAAM,kBAAkB;AAAA,QACtB,WAAW,YAAY;AAAA,QACvB,MAAM,YAAY;AAAA,QAClB,gBAAgB,cAAc;AAAA,QAC9B,YAAY,cAAc;AAAA,QAC1B,cAAc,YAAY;AAAA,MAC5B,CAAC;AAAA,IACH;AAAA,EACF;AACA,SAAO,IAAI,WAAW,UAAU,GAAG,EAAE;AACvC;AAEA,SAAS,eACP,aACA,aACqB;AACrB,WAAS,eAAe,KAA2B,KAA0B;AAC3E,UAAM,YAA2B,CAAC;AAClC,QAAI,GAAG,QAAQ,CAAC,UAAkB;AAChC,gBAAU,KAAK,MAAM,SAAS,CAAC;AAAA,IACjC,CAAC;AACD,QAAI,GAAG,OAAO,YAAY;AACxB,YAAM,eAAe,UAClB,KAAK,EAAE,EACP,MAAM,IAAI,EACV,OAAO,OAAO,EACd,IAAI,CAAC,cAAc,OAAO,SAAS,WAAW,EAAE,CAAC;AAEpD,UAAI,aAAa,KAAK,CAAC,OAAO,OAAO,MAAM,EAAE,CAAC,GAAG;AAC/C,YAAI,UAAU,GAAG;AACjB,YAAI,IAAI,iBAAiB;AACzB;AAAA,MACF;AAEA,iBAAW,aAAa,cAAc;AACpC,sBAAc,IAAI,SAAS;AAAA,MAC7B;AAEA,YAAM,EAAE,MAAM,IAAI;AAClB,UAAI,SAAS,aAAa,QAAQ;AAEhC,cAAM,gBAAgB,cAAc,aAAa,WAAW;AAAA,MAC9D;AACA,UAAI,UAAU,GAAG;AACjB,UAAI,IAAI,EAAE;AAAA,IACZ,CAAC;AAAA,EACH;AACA,SAAO,YAAY,cAAc;AACnC;AAEA,SAAS,qBACP,aACuC;AACvC,MAAI,YAAY,SAAS,aAAa,YAAY,SAAS,cAAc;AACvE,UAAM,IAAI,MAAM,iCAAiC,YAAY,IAAI,EAAE;AAAA,EACrE;AACF;AAYA,eAAO,eACL,sBACA,aACA,aACA,QACA,gBACiB;AACjB,kBAAgB,oBAAI,IAAY;AAChC,QAAM,YAAY,MAAM,eAAe,aAAa,WAAW;AAC/D,SAAO,IAAI,6BAA6B,UAAU,IAAI,EAAE;AAExD,MAAI;AACF,UAAM,WAAW,MAAM,IAAI,QAAgB,CAAC,SAAS,WAAW;AAC9D,YAAM,QAAQ,MAAM,qBAAqB,CAAC,GAAI,qBAAqB,MAAM,CAAC,GAAG;AAAA,QAC3E,OAAO;AAAA,QACP,KAAK;AAAA,UACH,GAAG,QAAQ;AAAA,UACX,gBAAgB,UAAU,KAAK,SAAS;AAAA,UACxC,mBAAmB;AAAA,UACnB,eAAe,YAAY;AAAA,UAC3B,kBAAkB,YAAY;AAAA,QAChC;AAAA,QACA,OAAO,QAAQ,YAAY;AAAA,MAC7B,CAAC;AAED,YAAM,GAAG,SAAS,CAAC,MAAM;AACvB,eAAO,OAAO,CAAC;AAAA,MACjB,CAAC;AAED,YAAM,iBAAiB,YAAY;AACnC,2BAAqB,cAAc;AACnC,YAAM,GAAG,SAAS,OAAO,SAAiB;AACxC,YAAI,SAAS,KAAK,eAAe,eAAe;AAC9C,cAAI;AACF,kBAAM,oBAAoB,aAAa,aAAa,MAAM;AAAA,UAC5D,SAAS,GAAG;AACV,mBAAO,MAAM,mCAAmC,CAAC;AACjD,mBAAO,OAAO,CAAC;AAAA,UACjB;AAAA,QACF,OAAO;AACL,iBAAO;AAAA,YACL;AAAA,UACF;AACA,cAAI;AACF,kBAAM;AAAA,cACJ;AAAA,gBACE,MAAM,aAAa,YAAY,SAAS,IAAI,YAAY,QAAQ;AAAA,gBAChE,QAAQ;AAAA,gBACR,MAAM;AAAA,gBACN,MAAM;AAAA,kBACJ,QAAQ;AAAA,kBACR,SAAS,YAAY;AAAA,kBACrB,MAAM,YAAY;AAAA,kBAClB,SAAS,GAAG,eAAe,IAAI;AAAA,gBACjC;AAAA,cACF;AAAA,cACA;AAAA,cACA,EAAE,YAAY,EAAE;AAAA,YAClB;AAAA,UACF,SAAS,GAAG;AACV,mBAAO,MAAM,8BAA8B,CAAC;AAC5C,mBAAO,OAAO,CAAC;AAAA,UACjB;AAAA,QACF;AACA,gBAAQ,IAAI;AAAA,MACd,CAAC;AAAA,IACH,CAAC;AACD,WAAO;AAAA,EACT,UAAE;AACA,kBAAc,MAAM;AACpB,UAAM,UAAU,MAAM;AAAA,EACxB;AACF;",
-  "names": []
-}