@cappa/core 0.18.0 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +386 -19
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +99 -3
- package/dist/index.d.mts +99 -3
- package/dist/index.mjs +381 -21
- package/dist/index.mjs.map +1 -1
- package/dist/playwright.cjs +77 -0
- package/dist/playwright.cjs.map +1 -0
- package/dist/playwright.d.cts +117 -0
- package/dist/playwright.d.mts +117 -0
- package/dist/playwright.mjs +73 -0
- package/dist/playwright.mjs.map +1 -0
- package/package.json +5 -1
package/dist/index.cjs
CHANGED
|
@@ -30,6 +30,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
|
|
|
30
30
|
enumerable: true
|
|
31
31
|
}) : target, mod));
|
|
32
32
|
//#endregion
|
|
33
|
+
const require_playwright = require("./playwright.cjs");
|
|
33
34
|
let node_fs = require("node:fs");
|
|
34
35
|
node_fs = __toESM(node_fs);
|
|
35
36
|
let _blazediff_gmsd = require("@blazediff/gmsd");
|
|
@@ -45,9 +46,10 @@ let node_path = require("node:path");
|
|
|
45
46
|
node_path = __toESM(node_path);
|
|
46
47
|
let _blazediff_core_native = require("@blazediff/core-native");
|
|
47
48
|
let _blazediff_interpret_native = require("@blazediff/interpret-native");
|
|
49
|
+
let node_child_process = require("node:child_process");
|
|
48
50
|
let node_crypto = require("node:crypto");
|
|
51
|
+
let node_module = require("node:module");
|
|
49
52
|
let playwright_core = require("playwright-core");
|
|
50
|
-
let node_child_process = require("node:child_process");
|
|
51
53
|
//#region src/features/png/util.ts
|
|
52
54
|
const pngSignature = Buffer.from([
|
|
53
55
|
137,
|
|
@@ -709,6 +711,242 @@ const attachConsoleLogging = (page, setting, logger) => {
|
|
|
709
711
|
});
|
|
710
712
|
};
|
|
711
713
|
//#endregion
|
|
714
|
+
//#region src/container.ts
|
|
715
|
+
/**
|
|
716
|
+
* Runs the official Playwright image for an exact `playwright-core` version
|
|
717
|
+
* through a container CLI (docker, podman, nerdctl, …) and hands back the
|
|
718
|
+
* `run-server` endpoint.
|
|
719
|
+
*
|
|
720
|
+
* Only subcommands all of those CLIs share are used: `version`, `image
|
|
721
|
+
* inspect`, `pull`, `inspect`, `run`, `port`, `logs`, `ps` and `rm`.
|
|
722
|
+
*/
|
|
723
|
+
/** Label on every container cappa starts; `removePlaywrightContainers` finds them by it. */
|
|
724
|
+
const CONTAINER_LABEL = "dev.cappa.playwright";
|
|
725
|
+
/** Port `run-server` listens on inside the container. */
|
|
726
|
+
const SERVER_PORT = 3e3;
|
|
727
|
+
/** Where the host's `playwright-core` is mounted inside the container. */
|
|
728
|
+
const PACKAGE_MOUNT = "/opt/playwright-core";
|
|
729
|
+
const defaultExec = (file, args) => new Promise((resolve, reject) => {
|
|
730
|
+
(0, node_child_process.execFile)(file, args, {
|
|
731
|
+
maxBuffer: 16777216,
|
|
732
|
+
windowsHide: true
|
|
733
|
+
}, (error, stdout, stderr) => {
|
|
734
|
+
if (error) reject(Object.assign(error, {
|
|
735
|
+
stdout,
|
|
736
|
+
stderr
|
|
737
|
+
}));
|
|
738
|
+
else resolve({
|
|
739
|
+
stdout: String(stdout),
|
|
740
|
+
stderr: String(stderr)
|
|
741
|
+
});
|
|
742
|
+
});
|
|
743
|
+
});
|
|
744
|
+
/** `true` once `run-server` answers plain HTTP with `Running`. */
|
|
745
|
+
const defaultProbe = async (url) => {
|
|
746
|
+
try {
|
|
747
|
+
const response = await fetch(url, { signal: AbortSignal.timeout(2e3) });
|
|
748
|
+
return response.ok && (await response.text()).includes("Running");
|
|
749
|
+
} catch {
|
|
750
|
+
return false;
|
|
751
|
+
}
|
|
752
|
+
};
|
|
753
|
+
const defaultSleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
|
|
754
|
+
const errorText = (error) => {
|
|
755
|
+
const stderr = error?.stderr;
|
|
756
|
+
if (typeof stderr === "string" && stderr.trim()) return stderr.trim();
|
|
757
|
+
return error instanceof Error ? error.message : String(error);
|
|
758
|
+
};
|
|
759
|
+
const isNotFound = (error) => error?.code === "ENOENT";
|
|
760
|
+
/** `{version}` filled in. */
|
|
761
|
+
const containerImage = (image, version) => image.replaceAll("{version}", version);
|
|
762
|
+
/**
|
|
763
|
+
* Deterministic per version, image and run arguments: changing any of them
|
|
764
|
+
* starts a fresh container instead of reusing one with stale settings.
|
|
765
|
+
*/
|
|
766
|
+
const containerName = (version, image, runArgs, packageDir = "") => {
|
|
767
|
+
const hash = (0, node_crypto.createHash)("sha256").update(JSON.stringify([
|
|
768
|
+
image,
|
|
769
|
+
runArgs,
|
|
770
|
+
packageDir
|
|
771
|
+
])).digest("hex").slice(0, 8);
|
|
772
|
+
return `cappa-playwright-v${version.replace(/[^\w.-]/g, "_")}-${hash}`;
|
|
773
|
+
};
|
|
774
|
+
/** Host port from `<cli> port` output (`127.0.0.1:49153`, maybe several lines). */
|
|
775
|
+
const parsePort = (output) => {
|
|
776
|
+
for (const line of output.split("\n")) {
|
|
777
|
+
const match = line.trim().match(/:(\d+)$/);
|
|
778
|
+
if (match) return Number(match[1]);
|
|
779
|
+
}
|
|
780
|
+
return null;
|
|
781
|
+
};
|
|
782
|
+
/**
|
|
783
|
+
* Start — or reuse — the Playwright server container for `version` and wait
|
|
784
|
+
* until it accepts connections.
|
|
785
|
+
*/
|
|
786
|
+
async function ensurePlaywrightContainer(options) {
|
|
787
|
+
const { version, packageDir, cli, runArgs, readyTimeout, log = () => {}, exec = defaultExec, probe = defaultProbe, sleep = defaultSleep, now = Date.now } = options;
|
|
788
|
+
const image = containerImage(options.image, version);
|
|
789
|
+
const name = containerName(version, image, runArgs, packageDir);
|
|
790
|
+
const deadline = now() + readyTimeout;
|
|
791
|
+
const run = async (args) => {
|
|
792
|
+
try {
|
|
793
|
+
return await exec(cli, args);
|
|
794
|
+
} catch (error) {
|
|
795
|
+
if (isNotFound(error)) throw new Error(`Container CLI "${cli}" not found. Install it, or set playwright({ container: { cli } }) / CAPPA_CONTAINER_CLI to the one you use (docker, podman, nerdctl).`, { cause: error });
|
|
796
|
+
throw error;
|
|
797
|
+
}
|
|
798
|
+
};
|
|
799
|
+
try {
|
|
800
|
+
await run(["version"]);
|
|
801
|
+
} catch (error) {
|
|
802
|
+
if (error instanceof Error && error.message.startsWith("Container CLI")) throw error;
|
|
803
|
+
throw new Error(`"${cli} version" failed.${cli === "podman" ? " Is the podman machine running (`podman machine start`)?" : " Is the daemon running?"}\n\n${errorText(error)}`, { cause: error });
|
|
804
|
+
}
|
|
805
|
+
const state = async () => {
|
|
806
|
+
try {
|
|
807
|
+
const { stdout } = await run([
|
|
808
|
+
"inspect",
|
|
809
|
+
"--format",
|
|
810
|
+
"{{.State.Running}}",
|
|
811
|
+
name
|
|
812
|
+
]);
|
|
813
|
+
return stdout.trim() === "true" ? "running" : "stopped";
|
|
814
|
+
} catch {
|
|
815
|
+
return "absent";
|
|
816
|
+
}
|
|
817
|
+
};
|
|
818
|
+
const remove = async () => {
|
|
819
|
+
await run([
|
|
820
|
+
"rm",
|
|
821
|
+
"-f",
|
|
822
|
+
name
|
|
823
|
+
]).catch(() => {});
|
|
824
|
+
};
|
|
825
|
+
const stop = async () => {
|
|
826
|
+
await remove();
|
|
827
|
+
};
|
|
828
|
+
let reused = false;
|
|
829
|
+
const current = await state();
|
|
830
|
+
if (current === "running") {
|
|
831
|
+
reused = true;
|
|
832
|
+
log(`Reusing Playwright container ${name}`);
|
|
833
|
+
} else {
|
|
834
|
+
if (current === "stopped") await remove();
|
|
835
|
+
if (!await run([
|
|
836
|
+
"image",
|
|
837
|
+
"inspect",
|
|
838
|
+
image
|
|
839
|
+
]).then(() => true, () => false)) {
|
|
840
|
+
log(`Pulling ${image} (first run only; this can take a few minutes)`);
|
|
841
|
+
try {
|
|
842
|
+
await run(["pull", image]);
|
|
843
|
+
} catch (error) {
|
|
844
|
+
throw new Error(`Could not pull ${image}. Official images exist for every released Playwright version — check that playwright-core ${version} is a release (not a prerelease) and that the registry is reachable.\n\n${errorText(error)}`, { cause: error });
|
|
845
|
+
}
|
|
846
|
+
}
|
|
847
|
+
log(`Starting Playwright ${version} container ${name}`);
|
|
848
|
+
try {
|
|
849
|
+
await run([
|
|
850
|
+
"run",
|
|
851
|
+
"-d",
|
|
852
|
+
"--init",
|
|
853
|
+
"--ipc=host",
|
|
854
|
+
"--user",
|
|
855
|
+
"pwuser",
|
|
856
|
+
"--workdir",
|
|
857
|
+
"/home/pwuser",
|
|
858
|
+
"-p",
|
|
859
|
+
`127.0.0.1::${SERVER_PORT}`,
|
|
860
|
+
"--mount",
|
|
861
|
+
`type=bind,source=${packageDir},target=${PACKAGE_MOUNT},readonly`,
|
|
862
|
+
"--label",
|
|
863
|
+
`${CONTAINER_LABEL}=${version}`,
|
|
864
|
+
"--name",
|
|
865
|
+
name,
|
|
866
|
+
...runArgs,
|
|
867
|
+
image,
|
|
868
|
+
"node",
|
|
869
|
+
`${PACKAGE_MOUNT}/cli.js`,
|
|
870
|
+
"run-server",
|
|
871
|
+
"--port",
|
|
872
|
+
String(SERVER_PORT),
|
|
873
|
+
"--host",
|
|
874
|
+
"0.0.0.0"
|
|
875
|
+
]);
|
|
876
|
+
} catch (error) {
|
|
877
|
+
if (/already in use|conflict|already exists/i.test(errorText(error))) reused = true;
|
|
878
|
+
else throw new Error(`Could not start ${image}.\n\n${errorText(error)}`, { cause: error });
|
|
879
|
+
}
|
|
880
|
+
}
|
|
881
|
+
const containerLogs = async () => {
|
|
882
|
+
const result = await run([
|
|
883
|
+
"logs",
|
|
884
|
+
"--tail",
|
|
885
|
+
"30",
|
|
886
|
+
name
|
|
887
|
+
]).catch(() => null);
|
|
888
|
+
return result ? `${result.stdout}${result.stderr}`.trim() : "";
|
|
889
|
+
};
|
|
890
|
+
let port = null;
|
|
891
|
+
let attempt = 0;
|
|
892
|
+
while (true) {
|
|
893
|
+
if (port === null) {
|
|
894
|
+
const output = await run([
|
|
895
|
+
"port",
|
|
896
|
+
name,
|
|
897
|
+
`${SERVER_PORT}/tcp`
|
|
898
|
+
]).then((r) => r.stdout, () => "");
|
|
899
|
+
port = parsePort(output);
|
|
900
|
+
}
|
|
901
|
+
if (port !== null && await probe(`http://127.0.0.1:${port}/`)) return {
|
|
902
|
+
wsEndpoint: `ws://127.0.0.1:${port}/`,
|
|
903
|
+
name,
|
|
904
|
+
image,
|
|
905
|
+
reused,
|
|
906
|
+
stop
|
|
907
|
+
};
|
|
908
|
+
attempt++;
|
|
909
|
+
if (attempt % 8 === 0 && await state() !== "running") {
|
|
910
|
+
const logs = await containerLogs();
|
|
911
|
+
await remove();
|
|
912
|
+
throw new Error(`The Playwright container ${name} exited before its server came up.${logs ? `\n\n${logs}` : ""}`);
|
|
913
|
+
}
|
|
914
|
+
if (now() >= deadline) {
|
|
915
|
+
const logs = await containerLogs();
|
|
916
|
+
throw new Error(`Timed out after ${readyTimeout}ms waiting for the Playwright server in container ${name}. Raise playwright({ container: { readyTimeout } }) if the image is still downloading.${logs ? `\n\n${logs}` : ""}`);
|
|
917
|
+
}
|
|
918
|
+
await sleep(250);
|
|
919
|
+
}
|
|
920
|
+
}
|
|
921
|
+
/**
|
|
922
|
+
* Remove every container cappa started, whatever its version. Returns their
|
|
923
|
+
* names.
|
|
924
|
+
*/
|
|
925
|
+
async function removePlaywrightContainers(options) {
|
|
926
|
+
const { cli, exec = defaultExec } = options;
|
|
927
|
+
let stdout;
|
|
928
|
+
try {
|
|
929
|
+
({stdout} = await exec(cli, [
|
|
930
|
+
"ps",
|
|
931
|
+
"-a",
|
|
932
|
+
"--filter",
|
|
933
|
+
`label=${CONTAINER_LABEL}`,
|
|
934
|
+
"--format",
|
|
935
|
+
"{{.Names}}"
|
|
936
|
+
]));
|
|
937
|
+
} catch (error) {
|
|
938
|
+
if (isNotFound(error)) throw new Error(`Container CLI "${cli}" not found.`, { cause: error });
|
|
939
|
+
throw new Error(`"${cli} ps" failed.\n\n${errorText(error)}`, { cause: error });
|
|
940
|
+
}
|
|
941
|
+
const names = stdout.split("\n").map((line) => line.trim()).filter(Boolean);
|
|
942
|
+
if (names.length > 0) await exec(cli, [
|
|
943
|
+
"rm",
|
|
944
|
+
"-f",
|
|
945
|
+
...names
|
|
946
|
+
]);
|
|
947
|
+
return names;
|
|
948
|
+
}
|
|
949
|
+
//#endregion
|
|
712
950
|
//#region src/crop.ts
|
|
713
951
|
const DEFAULT_CROP_PADDING = 8;
|
|
714
952
|
/** The crop to apply, or `undefined` for none. */
|
|
@@ -2017,9 +2255,56 @@ const LOG_SINK_LEVELS = [
|
|
|
2017
2255
|
];
|
|
2018
2256
|
/** A logger-shaped object that forwards every call to `sink`. */
|
|
2019
2257
|
const toSinkLogger = (sink) => Object.fromEntries(LOG_SINK_LEVELS.map((level) => [level, (message, ...args) => sink(level, String(message), ...args)]));
|
|
2258
|
+
const browserMap = {
|
|
2259
|
+
chromium: playwright_core.chromium,
|
|
2260
|
+
firefox: playwright_core.firefox,
|
|
2261
|
+
webkit: playwright_core.webkit
|
|
2262
|
+
};
|
|
2263
|
+
/** Where the remote-browser recipe lives; linked from connection errors. */
|
|
2264
|
+
const REMOTE_BROWSER_DOCS = "https://tim-richter.github.io/cappa/configuration/#connecting-to-a-remote-browser";
|
|
2265
|
+
/** The installed `playwright-core` version, or `null` if it cannot be read. */
|
|
2266
|
+
const clientPlaywrightVersion = () => {
|
|
2267
|
+
try {
|
|
2268
|
+
return (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href)("playwright-core/package.json").version;
|
|
2269
|
+
} catch {
|
|
2270
|
+
return null;
|
|
2271
|
+
}
|
|
2272
|
+
};
|
|
2273
|
+
/** The installed `playwright-core` directory, symlinks resolved, or `null`. */
|
|
2274
|
+
const clientPlaywrightPackageDir = () => {
|
|
2275
|
+
try {
|
|
2276
|
+
const require$1 = (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href);
|
|
2277
|
+
return (0, node_fs.realpathSync)(node_path.default.dirname(require$1.resolve("playwright-core/package.json")));
|
|
2278
|
+
} catch {
|
|
2279
|
+
return null;
|
|
2280
|
+
}
|
|
2281
|
+
};
|
|
2282
|
+
/**
|
|
2283
|
+
* Turn a raw `browserType.connect()` failure into something actionable.
|
|
2284
|
+
*
|
|
2285
|
+
* Exported for tests.
|
|
2286
|
+
*/
|
|
2287
|
+
const describeConnectError = (error, wsEndpoint, clientVersion = clientPlaywrightVersion(), container) => {
|
|
2288
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
2289
|
+
if (container && (/version mismatch/i.test(message) || /\b428\b/.test(message))) return new Error(`The container image ${container.image} runs a different Playwright version than this client${clientVersion ? ` (playwright-core ${clientVersion})` : ""}. A custom playwright({ container: { image } }) must be built from the official image for the same version — use {version} in the tag.\n\n${message}`, { cause: error });
|
|
2290
|
+
if (/version mismatch/i.test(message) || /\b428\b/.test(message)) {
|
|
2291
|
+
const image = clientVersion ? `mcr.microsoft.com/playwright:v${clientVersion}-noble` : "the mcr.microsoft.com/playwright image matching your playwright-core";
|
|
2292
|
+
return new Error(`The Playwright server at ${wsEndpoint} runs a different Playwright version than this client${clientVersion ? ` (playwright-core ${clientVersion})` : ""}. Run the server from ${image}.\n\n${message}`, { cause: error });
|
|
2293
|
+
}
|
|
2294
|
+
if (/timeout/i.test(message) && /exceeded/i.test(message)) return new Error(`Timed out connecting to the Playwright server at ${wsEndpoint}. See ${REMOTE_BROWSER_DOCS}\n\n${message}`, { cause: error });
|
|
2295
|
+
return new Error(`No Playwright server at ${wsEndpoint}. Start one with \`playwright run-server\`, or unset connectOptions.wsEndpoint to launch a local browser. See ${REMOTE_BROWSER_DOCS}\n\n${message}`, { cause: error });
|
|
2296
|
+
};
|
|
2020
2297
|
var ScreenshotTool = class {
|
|
2021
2298
|
browserType;
|
|
2022
2299
|
headless;
|
|
2300
|
+
/** Browser provider, headless mode and instance — see `UserConfig.browser`. */
|
|
2301
|
+
browserConfig;
|
|
2302
|
+
/**
|
|
2303
|
+
* Set when the browser goes away underneath the tool — a remote browser
|
|
2304
|
+
* server restarting, or a local browser crashing. `WarmBrowser` checks it so
|
|
2305
|
+
* it starts a fresh browser instead of handing out a dead one.
|
|
2306
|
+
*/
|
|
2307
|
+
disconnected = false;
|
|
2023
2308
|
viewport;
|
|
2024
2309
|
fullPage;
|
|
2025
2310
|
/** Default content crop; a screenshot's own `crop` overrides it. */
|
|
@@ -2044,14 +2329,20 @@ var ScreenshotTool = class {
|
|
|
2044
2329
|
filesystem;
|
|
2045
2330
|
logConsoleEvents;
|
|
2046
2331
|
connectionTimeout;
|
|
2332
|
+
/** The container `init()` started or reused, when `container` is on. */
|
|
2333
|
+
container = null;
|
|
2047
2334
|
defaultUserAgent = "";
|
|
2048
2335
|
/** The real logger, kept so `setLogSink(null)` restores the same instance. */
|
|
2049
2336
|
baseLogger;
|
|
2050
2337
|
/** Set while a `CaptureRunner` owns this tool — see `setCaptureSink`. */
|
|
2051
2338
|
captureSink = null;
|
|
2052
2339
|
constructor(options) {
|
|
2053
|
-
this.
|
|
2054
|
-
|
|
2340
|
+
this.browserConfig = require_playwright.resolveBrowserConfig(options.browser ?? {
|
|
2341
|
+
headless: options.headless !== false,
|
|
2342
|
+
instances: [{ browser: options.browserType || "chromium" }]
|
|
2343
|
+
});
|
|
2344
|
+
this.browserType = this.browserConfig.instances[0].browser;
|
|
2345
|
+
this.headless = this.browserConfig.headless;
|
|
2055
2346
|
this.viewport = options.viewport || {
|
|
2056
2347
|
width: 1920,
|
|
2057
2348
|
height: 1080
|
|
@@ -2126,34 +2417,85 @@ var ScreenshotTool = class {
|
|
|
2126
2417
|
* Initialize playwright and page
|
|
2127
2418
|
*/
|
|
2128
2419
|
async init() {
|
|
2129
|
-
const
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2420
|
+
const browserType = browserMap[this.browserType];
|
|
2421
|
+
if (!browserType) throw new Error(`Unsupported browser type: ${this.browserType}`);
|
|
2422
|
+
const { launchOptions, connectOptions, contextOptions } = this.browserConfig.provider.options;
|
|
2423
|
+
const launch = {
|
|
2424
|
+
...launchOptions,
|
|
2425
|
+
headless: this.headless
|
|
2426
|
+
};
|
|
2427
|
+
const container = require_playwright.resolveContainerOptions(this.browserConfig.provider.options.container);
|
|
2428
|
+
let connect = connectOptions?.wsEndpoint ? {
|
|
2429
|
+
...connectOptions,
|
|
2430
|
+
wsEndpoint: connectOptions.wsEndpoint
|
|
2431
|
+
} : null;
|
|
2432
|
+
if (connect && container) this.logger.debug(`connectOptions.wsEndpoint is set (${connect.wsEndpoint}); not starting a container.`);
|
|
2433
|
+
else if (container) {
|
|
2434
|
+
const version = clientPlaywrightVersion();
|
|
2435
|
+
const packageDir = clientPlaywrightPackageDir();
|
|
2436
|
+
if (!version || !packageDir) throw new Error("playwright({ container }) needs the installed playwright-core, but its package.json could not be read.");
|
|
2437
|
+
this.container = await ensurePlaywrightContainer({
|
|
2438
|
+
...container,
|
|
2439
|
+
version,
|
|
2440
|
+
packageDir,
|
|
2441
|
+
log: (message) => this.logger.info(message)
|
|
2442
|
+
});
|
|
2443
|
+
connect = {
|
|
2444
|
+
exposeNetwork: "<loopback>",
|
|
2445
|
+
...connectOptions,
|
|
2446
|
+
wsEndpoint: this.container.wsEndpoint
|
|
2447
|
+
};
|
|
2448
|
+
}
|
|
2449
|
+
let browser;
|
|
2450
|
+
if (connect) {
|
|
2451
|
+
const { wsEndpoint, ...options } = connect;
|
|
2452
|
+
try {
|
|
2453
|
+
browser = await browserType.connect(wsEndpoint, {
|
|
2454
|
+
...options,
|
|
2455
|
+
headers: {
|
|
2456
|
+
"x-playwright-launch-options": JSON.stringify(launch),
|
|
2457
|
+
...options.headers
|
|
2458
|
+
}
|
|
2459
|
+
});
|
|
2460
|
+
} catch (error) {
|
|
2461
|
+
throw describeConnectError(error, wsEndpoint, void 0, this.container ?? void 0);
|
|
2462
|
+
}
|
|
2463
|
+
} else browser = await browserType.launch(launch);
|
|
2136
2464
|
if (!browser) throw new Error("Something went wrong with starting the browser.");
|
|
2137
2465
|
this.browser = browser;
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2466
|
+
this.disconnected = false;
|
|
2467
|
+
browser.on("disconnected", () => {
|
|
2468
|
+
if (this.browser === browser) this.disconnected = true;
|
|
2469
|
+
});
|
|
2470
|
+
if (!contextOptions?.userAgent) {
|
|
2471
|
+
const tempCtx = await browser.newContext();
|
|
2472
|
+
const tempPage = await tempCtx.newPage();
|
|
2473
|
+
this.defaultUserAgent = await tempPage.evaluate(() => navigator.userAgent);
|
|
2474
|
+
await tempCtx.close();
|
|
2475
|
+
}
|
|
2142
2476
|
await this.createContexts();
|
|
2143
2477
|
}
|
|
2144
2478
|
/**
|
|
2145
2479
|
* Create the pool of browser contexts and pages.
|
|
2480
|
+
*
|
|
2481
|
+
* `contextOptions` from the provider merge over cappa's defaults; the
|
|
2482
|
+
* viewport and the `CappaStorybook` user-agent suffix always win, because
|
|
2483
|
+
* plugins and `isCappa()` rely on them.
|
|
2146
2484
|
*/
|
|
2147
2485
|
async createContexts() {
|
|
2148
2486
|
const browser = this.browser;
|
|
2149
2487
|
if (!browser) throw new Error("Browser not initialized");
|
|
2488
|
+
const { contextOptions, actionTimeout } = this.browserConfig.provider.options;
|
|
2489
|
+
const { viewport: _ignored, ...extraContextOptions } = contextOptions ?? {};
|
|
2150
2490
|
const results = await Promise.all(Array.from({ length: this.concurrency }, async () => {
|
|
2151
2491
|
const context = await browser.newContext({
|
|
2152
2492
|
reducedMotion: "reduce",
|
|
2153
2493
|
deviceScaleFactor: 2,
|
|
2154
|
-
|
|
2494
|
+
...extraContextOptions,
|
|
2495
|
+
userAgent: `${contextOptions?.userAgent ?? this.defaultUserAgent} CappaStorybook`,
|
|
2155
2496
|
viewport: this.viewport
|
|
2156
2497
|
});
|
|
2498
|
+
if (actionTimeout) context.setDefaultTimeout(actionTimeout);
|
|
2157
2499
|
return {
|
|
2158
2500
|
context,
|
|
2159
2501
|
page: await context.newPage()
|
|
@@ -2208,13 +2550,23 @@ var ScreenshotTool = class {
|
|
|
2208
2550
|
this.context = null;
|
|
2209
2551
|
this.page = null;
|
|
2210
2552
|
}
|
|
2211
|
-
|
|
2553
|
+
const browser = this.browser;
|
|
2554
|
+
if (browser) {
|
|
2555
|
+
this.browser = null;
|
|
2212
2556
|
try {
|
|
2213
|
-
await
|
|
2557
|
+
await browser.close();
|
|
2214
2558
|
} catch (error) {
|
|
2215
2559
|
(0, _cappa_logger.getLogger)().debug("Error closing the browser:", error);
|
|
2216
2560
|
}
|
|
2217
|
-
|
|
2561
|
+
}
|
|
2562
|
+
this.disconnected = false;
|
|
2563
|
+
const container = this.container;
|
|
2564
|
+
this.container = null;
|
|
2565
|
+
const options = require_playwright.resolveContainerOptions(this.browserConfig.provider.options.container);
|
|
2566
|
+
if (container && options && !options.keepAlive && !container.reused) try {
|
|
2567
|
+
await container.stop();
|
|
2568
|
+
} catch (error) {
|
|
2569
|
+
(0, _cappa_logger.getLogger)().debug("Error removing the Playwright container:", error);
|
|
2218
2570
|
}
|
|
2219
2571
|
}
|
|
2220
2572
|
/**
|
|
@@ -3452,6 +3804,13 @@ var WarmBrowser = class {
|
|
|
3452
3804
|
if (this.closed) throw new Error("WarmBrowser has been closed");
|
|
3453
3805
|
this.cancelIdleTimer();
|
|
3454
3806
|
this.inUse = true;
|
|
3807
|
+
if (this.tool?.disconnected === true) {
|
|
3808
|
+
const dead = this.tool;
|
|
3809
|
+
this.tool = null;
|
|
3810
|
+
try {
|
|
3811
|
+
await dead.close();
|
|
3812
|
+
} catch {}
|
|
3813
|
+
}
|
|
3455
3814
|
if (this.tool) {
|
|
3456
3815
|
await this.tool.recycleContexts();
|
|
3457
3816
|
return this.tool;
|
|
@@ -3998,7 +4357,8 @@ var LocalEngine = class {
|
|
|
3998
4357
|
width: 1920,
|
|
3999
4358
|
height: 1080
|
|
4000
4359
|
},
|
|
4001
|
-
connectionTimeout: this.options.connectionTimeout
|
|
4360
|
+
connectionTimeout: this.options.connectionTimeout,
|
|
4361
|
+
browser: this.options.browser
|
|
4002
4362
|
});
|
|
4003
4363
|
}
|
|
4004
4364
|
async listPlugins() {
|
|
@@ -5039,7 +5399,9 @@ exports.ACTION_BY_LABEL = ACTION_BY_LABEL;
|
|
|
5039
5399
|
exports.AGENT_DIRNAME = AGENT_DIRNAME;
|
|
5040
5400
|
exports.AGENT_REPORT_VERSION = AGENT_REPORT_VERSION;
|
|
5041
5401
|
exports.CONSOLE_LOG_LEVELS = CONSOLE_LOG_LEVELS;
|
|
5402
|
+
exports.CONTAINER_LABEL = CONTAINER_LABEL;
|
|
5042
5403
|
exports.CaptureRunner = CaptureRunner;
|
|
5404
|
+
exports.DEFAULT_CONTAINER_IMAGE = require_playwright.DEFAULT_CONTAINER_IMAGE;
|
|
5043
5405
|
exports.DEFAULT_CROP_PADDING = DEFAULT_CROP_PADDING;
|
|
5044
5406
|
exports.DEFAULT_DEBOUNCE_MS = DEFAULT_DEBOUNCE_MS;
|
|
5045
5407
|
exports.DEFAULT_IGNORED_DIRS = DEFAULT_IGNORED_DIRS;
|
|
@@ -5075,6 +5437,7 @@ exports.contextPadding = contextPadding;
|
|
|
5075
5437
|
exports.defineConfig = defineConfig;
|
|
5076
5438
|
exports.describeChange = describeChange;
|
|
5077
5439
|
exports.didScreenshotFail = didScreenshotFail;
|
|
5440
|
+
exports.ensurePlaywrightContainer = ensurePlaywrightContainer;
|
|
5078
5441
|
exports.filterTasks = filterTasks;
|
|
5079
5442
|
exports.findRefusedConnection = findRefusedConnection;
|
|
5080
5443
|
exports.fingerprintImages = fingerprintImages;
|
|
@@ -5094,12 +5457,16 @@ exports.mergeCaptureManifest = mergeCaptureManifest;
|
|
|
5094
5457
|
exports.normalizeChangeType = normalizeChangeType;
|
|
5095
5458
|
exports.padAndClamp = padAndClamp;
|
|
5096
5459
|
exports.parseAgentVerdict = parseAgentVerdict;
|
|
5460
|
+
exports.playwright = require_playwright.playwright;
|
|
5097
5461
|
exports.readAgentReport = readAgentReport;
|
|
5098
5462
|
exports.readCaptureManifest = readCaptureManifest;
|
|
5099
5463
|
exports.readDiffMeta = readDiffMeta;
|
|
5100
5464
|
exports.recordCaptureOrigins = recordCaptureOrigins;
|
|
5465
|
+
exports.removePlaywrightContainers = removePlaywrightContainers;
|
|
5101
5466
|
exports.renderJudgmentTiles = renderJudgmentTiles;
|
|
5102
5467
|
exports.renderOverview = renderOverview;
|
|
5468
|
+
exports.resolveBrowserConfig = require_playwright.resolveBrowserConfig;
|
|
5469
|
+
exports.resolveContainerOptions = require_playwright.resolveContainerOptions;
|
|
5103
5470
|
exports.resolveCrop = resolveCrop;
|
|
5104
5471
|
exports.resolveWebServerConfig = resolveWebServerConfig;
|
|
5105
5472
|
exports.runAgentCheck = runAgentCheck;
|