Function expectDocShot

test/e2e/doc-shots.test.ts:229–284

(page: Page, asset: string)

const docShots = getDocShotMap();

const expectDocShot = async (page: Page, asset: string): Promise<void> => {
  const shot = docShots.get(asset);
  if (shot == null) {
    throw new Error(`No doc shot metadata found for ${asset}`);
  }
  expect(normalizePath(new URL(page.url()).pathname)).toEqual(
    normalizePath(shot.page),
  );

  const frameLocator = shot.framed ? page.locator('iframe').first() : undefined;

  if (shot.framed) {
    await prepareFirstFrame(page);
  }

  await applyDocShotStyle(page, shot);
  await waitForDocShotReady(page, shot);
  await waitForDocShotImages(page, shot);
  await performDocShotClicks(page, shot);
  await stabilizeDocShot(page, shot);

  const locator = shot.framed
    ? await expectedFramedElement(page, shot.selector)
    : await expectedElement(page, shot.selector);
  const clip = await getClip(page, locator, shot.marginRem, frameLocator);

  if (shot.framed) {
    // Keep the framed capture path aligned with the known-good one-off flow:
    // a full-page render here stabilizes the later clipped screenshot.
    await page.screenshot({
      fullPage: true,
      animations: 'disabled',
      caret: 'hide',
      omitBackground: shot.omitBackground,
      scale: 'device',
      style: shot.style,
    });
  }

  const normalizedScreenshot = await page.screenshot({
    animations: 'disabled',
    caret: 'hide',
    clip,
    omitBackground: shot.omitBackground,
    scale: 'device',
    style: shot.style,
  });
  const snapshotPath = test.info().snapshotPath(...shot.asset.split('/'));

  if (process.env.UPDATE_DOC_SHOTS == '1') {
    mkdirSync(dirname(snapshotPath), {recursive: true});
    writeFileSync(snapshotPath, normalizedScreenshot);
  }

  expect(normalizedScreenshot).toMatchSnapshot(shot.asset.split('/'));
};

const {afterAll, beforeAll, describe} = test;