checkly 0.0.0-canary.58c867e

package/dist/services/playwright-project-bundler.js

@@ -0,0 +1,243 @@
+import fs from 'node:fs/promises';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import semver from 'semver';
+import { detectNearestPackageJson } from './check-parser/package-files/package-manager.js';
+import { PackageJsonFile } from './check-parser/package-files/package-json-file.js';
+import { lineage } from './check-parser/package-files/walk.js';
+import { PlaywrightConfig } from './playwright-config.js';
+import { findFilesWithPattern, pathToPosix } from './util.js';
+import { Session } from '../constructs/session.js';
+export class PlaywrightProjectBundler {
+    // Cache the in-flight bundle promise keyed by (config, include). Many checks
+    // are generated from one shared Playwright codebase, so they call bundle()
+    // with identical arguments; without this each call would re-load the config
+    // module, re-resolve the Playwright version, and re-glob the project
+    // directory. Caching the promise (not the resolved value) also collapses
+    // concurrent callers onto a single computation. The NUL separator keeps the
+    // config path and the serialized include patterns from colliding.
+    #cache = new Map();
+    async bundle(playwrightConfig, include) {
+        const cacheKey = `${playwrightConfig}\0${JSON.stringify(include)}`;
+        const cached = this.#cache.get(cacheKey);
+        if (cached !== undefined) {
+            return await cached;
+        }
+        const promise = this.bundleProject(playwrightConfig, include);
+        this.#cache.set(cacheKey, promise);
+        return await promise;
+    }
+    // The actual bundling, separated from the cache wrapper above so it can be
+    // overridden in tests. Not part of the public surface.
+    async bundleProject(playwrightConfig, include) {
+        const dir = path.resolve(path.dirname(playwrightConfig));
+        const filePath = path.resolve(dir, playwrightConfig);
+        // No need of loading everything if there is no lockfile
+        const pwtConfig = await Session.loadFile(filePath);
+        const pwConfigParsed = new PlaywrightConfig(filePath, pwtConfig);
+        const playwrightVersion = await resolvePlaywrightVersion(dir);
+        const parser = Session.getPlaywrightParser();
+        const { files, errors } = await parser.getFilesAndDependencies(pwConfigParsed);
+        if (errors.length) {
+            throw new Error(`Error loading playwright project files: ${errors.map((e) => e).join(', ')}`);
+        }
+        function includeTargets(dirName) {
+            return include.some(value => {
+                return value.startsWith(`${dirName}/`) || value.includes(`/${dirName}/`);
+            });
+        }
+        const defaultIgnores = [
+            {
+                pattern: '**/node_modules/**',
+                skipIf: () => includeTargets('node_modules'),
+            },
+            {
+                pattern: '**/.git/**',
+                skipIf: () => includeTargets('.git'),
+            },
+        ];
+        const ignoredFiles = [...Session.ignoreDirectoriesMatch];
+        for (const ignore of defaultIgnores) {
+            if (!ignore.skipIf()) {
+                ignoredFiles.push(ignore.pattern);
+            }
+        }
+        const autoIncludes = getAutoIncludes(Session.basePath, dir, Session.packageManager, include);
+        const effectiveIncludes = [...include, ...autoIncludes];
+        const includedFiles = await findFilesWithPattern(dir, effectiveIncludes, ignoredFiles);
+        for (const filePath of includedFiles) {
+            files.push({
+                filePath,
+                physical: true,
+            });
+        }
+        return {
+            browsers: pwConfigParsed.getBrowsers(),
+            playwrightVersion,
+            relativePlaywrightConfigPath: Session.contextRelativePosixPath(filePath),
+            workingDir: Session.relativePosixPath(Session.contextPath),
+            files,
+        };
+    }
+}
+export function normalizeVersion(v) {
+    const cleaned = semver.valid(semver.clean(v ?? '') || '')
+        ?? semver.coerce(v ?? '')?.version;
+    return cleaned && semver.valid(cleaned) ? cleaned : undefined;
+}
+export function getAutoIncludes(basePath, globCwd, packageManager, existingIncludes) {
+    const autoIncludes = [];
+    if (packageManager.name === 'pnpm') {
+        const patchesDir = path.join(basePath, 'patches');
+        const alreadyIncluded = existingIncludes.some(p => path.resolve(globCwd, p).startsWith(patchesDir));
+        if (!alreadyIncluded) {
+            const patchesPattern = pathToPosix(path.join(path.relative(globCwd, basePath), 'patches', '*.patch'));
+            autoIncludes.push(patchesPattern);
+        }
+    }
+    return autoIncludes;
+}
+const PLAYWRIGHT_TEST = '@playwright/test';
+/**
+ * Resolves the @playwright/test version that should run in the cloud.
+ *
+ * The project's lockfile is the source of truth: the version it pins is what
+ * CI and other developers resolve, and it stays correct even when the local
+ * node_modules has drifted (e.g. after switching branches without
+ * reinstalling). When no usable lockfile answer is available — no lockfile, an
+ * unsupported/unparseable format, or the package isn't pinned for the relevant
+ * workspace member — we fall back to reading the installed package.
+ */
+export async function resolvePlaywrightVersion(cwd) {
+    const lockfileVersion = await getPlaywrightVersionFromLockfile(cwd);
+    if (lockfileVersion !== undefined) {
+        return lockfileVersion;
+    }
+    return await getPlaywrightVersionFromPackage(cwd);
+}
+function playwrightRange(packageJson) {
+    return packageJson.dependencies?.[PLAYWRIGHT_TEST]
+        ?? packageJson.devDependencies?.[PLAYWRIGHT_TEST];
+}
+/**
+ * Resolves the @playwright/test version from the workspace lockfile, scoped to
+ * the workspace member that owns the Playwright config. Returns `undefined`
+ * when no answer can be derived from the lockfile, signalling the caller to
+ * fall back.
+ */
+async function getPlaywrightVersionFromLockfile(cwd) {
+    const workspaceResult = Session.workspace;
+    if (!workspaceResult.isOk()) {
+        return undefined;
+    }
+    const workspace = workspaceResult.unwrap();
+    if (!workspace.lockfile.isOk()) {
+        return undefined;
+    }
+    const lockfilePath = workspace.lockfile.unwrap();
+    const packageManager = Session.packageManager;
+    // Normalize both paths through realpath so the directory walk and the
+    // relative importer paths line up with the workspace root even when the
+    // config is reached through a symlink (e.g. macOS /tmp -> /private/tmp).
+    let configDir;
+    let workspaceRoot;
+    try {
+        configDir = await fs.realpath(cwd);
+        workspaceRoot = await fs.realpath(workspace.root.path);
+    }
+    catch {
+        return undefined;
+    }
+    // Walk from the config directory up to the workspace root, building the chain
+    // of candidate importers Node would consult when resolving the package from
+    // the config directory. Resolution must mirror that walk: a package required
+    // from a member that doesn't declare it resolves to a physically-enclosing
+    // member's copy, not necessarily the root's.
+    const importers = [];
+    let consumingRange;
+    let reachedRoot = false;
+    for (const dir of lineage(configDir, { root: workspaceRoot })) {
+        // A directory contributes a declared range only when it actually has a
+        // package.json declaring the dep. Intermediate directories still
+        // participate (by position) so npm's physical node_modules walk and pnpm's
+        // importer lookup see them.
+        const packageJson = await PackageJsonFile.loadFromFilePath(PackageJsonFile.filePath(dir));
+        const declaredRange = packageJson ? playwrightRange(packageJson) : undefined;
+        // The consuming package is the nearest package.json at or above the config;
+        // its declared range anchors the drift check below.
+        if (consumingRange === undefined && declaredRange !== undefined) {
+            consumingRange = declaredRange;
+        }
+        importers.push({ relPath: toImporterRelPath(workspaceRoot, dir), declaredRange });
+        if (dir === workspaceRoot) {
+            reachedRoot = true;
+            break;
+        }
+    }
+    // If the walk never reached the workspace root, the relative paths don't
+    // describe importers under this workspace — don't trust them.
+    if (!reachedRoot) {
+        return undefined;
+    }
+    const raw = await packageManager.resolvePackageVersionFromLockfile(lockfilePath, {
+        packageName: PLAYWRIGHT_TEST,
+        importers,
+    });
+    if (raw === undefined) {
+        return undefined;
+    }
+    const version = normalizeVersion(raw);
+    if (version === undefined) {
+        return undefined;
+    }
+    // Drift guard: if the consuming package declares a range the resolved version
+    // doesn't satisfy, its package.json was changed without re-resolving the
+    // lockfile (or the install is otherwise inconsistent). The cloud runs the
+    // resolved version, so warn rather than silently using a mismatched pin.
+    if (consumingRange !== undefined) {
+        const validRange = semver.validRange(consumingRange);
+        if (validRange && !semver.satisfies(version, validRange)) {
+            process.stderr.write(`Warning: resolved @playwright/test version ${version} does not satisfy the range `
+                + `"${consumingRange}" declared in package.json. The lockfile may be out of date; run `
+                + `your package manager's install command to update it.\n`);
+        }
+    }
+    return version;
+}
+function toImporterRelPath(rootPath, packagePath) {
+    const rel = path.relative(rootPath, packagePath);
+    if (rel === '' || rel === '.') {
+        return '.';
+    }
+    return pathToPosix(rel);
+}
+export async function getPlaywrightVersionFromPackage(cwd) {
+    try {
+        const require = createRequire(path.join(cwd, 'noop.js'));
+        const playwrightPath = require.resolve(`${PLAYWRIGHT_TEST}/package.json`);
+        const playwrightPkg = require(playwrightPath);
+        const version = normalizeVersion(playwrightPkg.version);
+        if (!version) {
+            throw new Error('Invalid version found in @playwright/test package.json');
+        }
+        const packageJson = await detectNearestPackageJson(cwd);
+        const range = playwrightRange(packageJson);
+        if (!range) {
+            return version;
+        }
+        const validRange = semver.validRange(range);
+        if (validRange && !semver.satisfies(version, validRange)) {
+            throw new Error(`Installed @playwright/test version ${version} does not satisfy the required range "${range}" in package.json. `
+                + 'Please run your package manager\'s install command to sync node_modules.');
+        }
+        return version;
+    }
+    catch (error) {
+        // @ts-ignore
+        if (error instanceof Error && error.code === 'MODULE_NOT_FOUND') {
+            throw new Error('Could not find @playwright/test package. Make sure it is installed.', { cause: error });
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=playwright-project-bundler.js.map

package/dist/services/playwright-project-bundler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"playwright-project-bundler.js","sourceRoot":"","sources":["../../src/services/playwright-project-bundler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAA;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAC3C,OAAO,IAAI,MAAM,WAAW,CAAA;AAE5B,OAAO,MAAM,MAAM,QAAQ,CAAA;AAG3B,OAAO,EAAE,wBAAwB,EAAkB,MAAM,iDAAiD,CAAA;AAC1G,OAAO,EAAE,eAAe,EAAE,MAAM,mDAAmD,CAAA;AAEnF,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAA;AAC9D,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAA;AAUlD,MAAM,OAAO,wBAAwB;IACnC,6EAA6E;IAC7E,2EAA2E;IAC3E,4EAA4E;IAC5E,qEAAqE;IACrE,yEAAyE;IACzE,4EAA4E;IAC5E,kEAAkE;IAClE,MAAM,GAAG,IAAI,GAAG,EAA4C,CAAA;IAE5D,KAAK,CAAC,MAAM,CAAE,gBAAwB,EAAE,OAAiB;QACvD,MAAM,QAAQ,GAAG,GAAG,gBAAgB,KAAK,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAA;QAClE,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACxC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,MAAM,MAAM,CAAA;QACrB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;QAC7D,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAA;QAClC,OAAO,MAAM,OAAO,CAAA;IACtB,CAAC;IAED,2EAA2E;IAC3E,uDAAuD;IAC7C,KAAK,CAAC,aAAa,CAAE,gBAAwB,EAAE,OAAiB;QACxE,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAA;QACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAA;QAEpD,wDAAwD;QACxD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAElD,MAAM,cAAc,GAAG,IAAI,gBAAgB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;QAEhE,MAAM,iBAAiB,GAAG,MAAM,wBAAwB,CAAC,GAAG,CAAC,CAAA;QAE7D,MAAM,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAA;QAC5C,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAA;QAC9E,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,2CAA2C,MAAM,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACvG,CAAC;QAED,SAAS,cAAc,CAAE,OAAe;YACtC,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAC1B,OAAO,KAAK,CAAC,UAAU,CAAC,GAAG,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,OAAO,GAAG,CAAC,CAAA;YAC1E,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,MAAM,cAAc,GAAG;YACrB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,MAAM,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC;aAC7C;YACD;gBACE,OAAO,EAAE,YAAY;gBACrB,MAAM,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,MAAM,CAAC;aACrC;SACF,CAAA;QAED,MAAM,YAAY,GAAG,CAAC,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAA;QACxD,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;gBACrB,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;YACnC,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,CAAC,QAAS,EAAE,GAAG,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAA;QAC7F,MAAM,iBAAiB,GAAG,CAAC,GAAG,OAAO,EAAE,GAAG,YAAY,CAAC,CAAA;QAEvD,MAAM,aAAa,GAAG,MAAM,oBAAoB,CAC9C,GAAG,EACH,iBAAiB,EACjB,YAAY,CACb,CAAA;QAED,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC;gBACT,QAAQ;gBACR,QAAQ,EAAE,IAAI;aACf,CAAC,CAAA;QACJ,CAAC;QAED,OAAO;YACL,QAAQ,EAAE,cAAc,CAAC,WAAW,EAAE;YACtC,iBAAiB;YACjB,4BAA4B,EAAE,OAAO,CAAC,wBAAwB,CAAC,QAAQ,CAAC;YACxE,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,WAAY,CAAC;YAC3D,KAAK;SACN,CAAA;IACH,CAAC;CACF;AAED,MAAM,UAAU,gBAAgB,CAAE,CAAsB;IACtD,MAAM,OAAO,GACX,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;WACtC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,CAAA;IACpC,OAAO,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAA;AAC/D,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,QAAgB,EAChB,OAAe,EACf,cAA8B,EAC9B,gBAA0B;IAE1B,MAAM,YAAY,GAAa,EAAE,CAAA;IAEjC,IAAI,cAAc,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;QACjD,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAA;QACnG,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,cAAc,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAA;YACrG,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAED,OAAO,YAAY,CAAA;AACrB,CAAC;AAED,MAAM,eAAe,GAAG,kBAAkB,CAAA;AAE1C;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAAE,GAAW;IACzD,MAAM,eAAe,GAAG,MAAM,gCAAgC,CAAC,GAAG,CAAC,CAAA;IACnE,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,OAAO,MAAM,+BAA+B,CAAC,GAAG,CAAC,CAAA;AACnD,CAAC;AAED,SAAS,eAAe,CAAE,WAA4B;IACpD,OAAO,WAAW,CAAC,YAAY,EAAE,CAAC,eAAe,CAAC;WAC7C,WAAW,CAAC,eAAe,EAAE,CAAC,eAAe,CAAC,CAAA;AACrD,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gCAAgC,CAAE,GAAW;IAC1D,MAAM,eAAe,GAAG,OAAO,CAAC,SAAS,CAAA;IACzC,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,EAAE,CAAA;IAC1C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;QAC/B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAA;IAChD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,CAAA;IAE7C,sEAAsE;IACtE,wEAAwE;IACxE,yEAAyE;IACzE,IAAI,SAAiB,CAAA;IACrB,IAAI,aAAqB,CAAA;IACzB,IAAI,CAAC;QACH,SAAS,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QAClC,aAAa,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACxD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,8EAA8E;IAC9E,4EAA4E;IAC5E,6EAA6E;IAC7E,2EAA2E;IAC3E,6CAA6C;IAC7C,MAAM,SAAS,GAAwB,EAAE,CAAA;IACzC,IAAI,cAAkC,CAAA;IACtC,IAAI,WAAW,GAAG,KAAK,CAAA;IACvB,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,EAAE,CAAC;QAC9D,uEAAuE;QACvE,iEAAiE;QACjE,2EAA2E;QAC3E,4BAA4B;QAC5B,MAAM,WAAW,GAAG,MAAM,eAAe,CAAC,gBAAgB,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;QACzF,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAE5E,4EAA4E;QAC5E,oDAAoD;QACpD,IAAI,cAAc,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;YAChE,cAAc,GAAG,aAAa,CAAA;QAChC,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,iBAAiB,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE,aAAa,EAAE,CAAC,CAAA;QAEjF,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;YAC1B,WAAW,GAAG,IAAI,CAAA;YAClB,MAAK;QACP,CAAC;IACH,CAAC;IAED,yEAAyE;IACzE,8DAA8D;IAC9D,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,iCAAiC,CAAC,YAAY,EAAE;QAC/E,WAAW,EAAE,eAAe;QAC5B,SAAS;KACV,CAAC,CAAA;IAEF,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAA;IACrC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,8EAA8E;IAC9E,yEAAyE;IACzE,0EAA0E;IAC1E,yEAAyE;IACzE,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;QACpD,IAAI,UAAU,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;YACzD,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,8CAA8C,OAAO,8BAA8B;kBACjF,IAAI,cAAc,mEAAmE;kBACrF,wDAAwD,CAC3D,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,iBAAiB,CAAE,QAAgB,EAAE,WAAmB;IAC/D,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAA;IAChD,IAAI,GAAG,KAAK,EAAE,IAAI,GAAG,KAAK,GAAG,EAAE,CAAC;QAC9B,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAA;AACzB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAE,GAAW;IAChE,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAA;QACxD,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,eAAe,eAAe,CAAC,CAAA;QACzE,MAAM,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;QAC7C,MAAM,OAAO,GAAG,gBAAgB,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QAEvD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC3E,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,GAAG,CAAC,CAAA;QACvD,MAAM,KAAK,GAAG,eAAe,CAAC,WAAW,CAAC,CAAA;QAE1C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,OAAO,CAAA;QAChB,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,UAAU,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,KAAK,CACb,sCAAsC,OAAO,yCAAyC,KAAK,qBAAqB;kBAC9G,0EAA0E,CAC7E,CAAA;QACH,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,aAAa;QACb,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,qEAAqE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;QAC1G,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC"}

package/dist/services/project-parser.d.ts

@@ -0,0 +1,30 @@
+import { Project, CheckFilter } from '../constructs/index.js';
+import { CheckConfigDefaults, PlaywrightSlimmedProp } from './checkly-config-loader.js';
+import { type Construct } from '../constructs/construct.js';
+import { Runtime } from '../runtimes/index.js';
+type ProjectParseOpts = {
+    directory: string;
+    projectLogicalId: string;
+    projectName: string;
+    repoUrl?: string;
+    checkMatch?: string | string[];
+    checkFilter?: CheckFilter;
+    includeTestOnlyChecks?: boolean;
+    browserCheckMatch?: string | string[];
+    multiStepCheckMatch?: string | string[];
+    ignoreDirectoriesMatch?: string[];
+    checkDefaults?: CheckConfigDefaults;
+    browserCheckDefaults?: CheckConfigDefaults;
+    availableRuntimes: Record<string, Runtime>;
+    defaultRuntimeId: string;
+    verifyRuntimeDependencies?: boolean;
+    checklyConfigConstructs?: Construct[];
+    playwrightConfigPath?: string;
+    include?: string | string[];
+    playwrightChecks?: PlaywrightSlimmedProp[];
+    loadPlaywrightChecksOnly?: boolean;
+    warnOnWebServerConfig?: boolean;
+    enableWorkspaces?: boolean;
+};
+export declare function parseProject(opts: ProjectParseOpts): Promise<Project>;
+export {};

package/dist/services/project-parser.js

@@ -0,0 +1,291 @@
+import * as path from 'path';
+import Debug from 'debug';
+import { findFilesWithPattern, getPlaywrightConfigPath, pathToPosix, } from './util.js';
+import { Check, BrowserCheck, Project, Session, PrivateLocation, PrivateLocationCheckAssignment, PrivateLocationGroupAssignment, MultiStepCheck, } from '../constructs/index.js';
+import { Ref } from '../constructs/ref.js';
+import { isEntrypoint } from '../constructs/construct.js';
+import { PlaywrightCheck } from '../constructs/playwright-check.js';
+import { detectNearestPackageJson, detectPackageManager, fauxWorkspaceFromPackageJson, NoPackageJsonFoundError, } from './check-parser/package-files/package-manager.js';
+import { Err, Ok } from './check-parser/package-files/result.js';
+const debug = Debug('checkly:cli:services:project-parser');
+const BASE_CHECK_DEFAULTS = {};
+async function findBasePath(packageManager, directory, { ignoreWorkspaces = false }) {
+    try {
+        if (ignoreWorkspaces) {
+            const nearestPackageJson = await detectNearestPackageJson(directory);
+            const workspace = await fauxWorkspaceFromPackageJson(packageManager, nearestPackageJson);
+            return {
+                basePath: workspace.root.path,
+                contextPath: workspace.root.path,
+                workspace: Ok(workspace),
+            };
+        }
+        const workspace = await packageManager.lookupWorkspace(directory);
+        // If we can't locate a real workspace, set up a faux workspace instead.
+        // Makes usage easier since we can rely on a workspace being available.
+        if (!workspace) {
+            return await findBasePath(packageManager, directory, {
+                ignoreWorkspaces: true,
+            });
+        }
+        // We've found a workspace. Let's try to figure out whether we're a part
+        // of it.
+        const nearestPackageJson = await detectNearestPackageJson(directory, {
+            root: workspace.root.path,
+        });
+        const contextPath = nearestPackageJson.basePath;
+        // If the nearest workspace includes the nearest package, then use the
+        // workspace root as the project root.
+        if (workspace.memberByPath(contextPath) !== undefined) {
+            return {
+                basePath: workspace.root.path,
+                contextPath,
+                workspace: Ok(workspace),
+            };
+        }
+        // Otherwise, use the config dir as the project root.
+        return await findBasePath(packageManager, directory, {
+            ignoreWorkspaces: true,
+        });
+    }
+    catch (err) {
+        if (err instanceof NoPackageJsonFoundError) {
+            return {
+                basePath: directory,
+                contextPath: directory,
+                workspace: Err(err),
+            };
+        }
+        throw err;
+    }
+}
+export async function parseProject(opts) {
+    const { directory, checkMatch = '**/*.check.{js,ts}', checkFilter, includeTestOnlyChecks = false, browserCheckMatch, multiStepCheckMatch, projectLogicalId, projectName, repoUrl, ignoreDirectoriesMatch = [], checkDefaults = {}, browserCheckDefaults = {}, availableRuntimes, defaultRuntimeId, verifyRuntimeDependencies, checklyConfigConstructs, playwrightConfigPath, include, playwrightChecks, loadPlaywrightChecksOnly, warnOnWebServerConfig, enableWorkspaces = true, } = opts;
+    const project = new Project(projectLogicalId, {
+        name: projectName,
+        repoUrl,
+    });
+    if (includeTestOnlyChecks) {
+        project.allowTestOnly(true);
+    }
+    const packageManager = await detectPackageManager(directory);
+    debug(`Detected package manager ${packageManager.name}`);
+    const { basePath, contextPath, workspace } = await findBasePath(packageManager, directory, {
+        ignoreWorkspaces: !enableWorkspaces,
+    });
+    const filteredConstructs = loadPlaywrightChecksOnly
+        ? checklyConfigConstructs?.filter(c => !(c instanceof PlaywrightCheck))
+        : checklyConfigConstructs;
+    filteredConstructs?.forEach(construct => project.addResource(construct.type, construct.logicalId, construct));
+    Session.project = project;
+    Session.basePath = basePath;
+    Session.contextPath = contextPath;
+    Session.checkDefaults = Object.assign({}, BASE_CHECK_DEFAULTS, checkDefaults);
+    Session.checkFilter = checkFilter;
+    Session.browserCheckDefaults = browserCheckDefaults;
+    Session.availableRuntimes = availableRuntimes;
+    Session.defaultRuntimeId = defaultRuntimeId;
+    Session.verifyRuntimeDependencies = verifyRuntimeDependencies ?? true;
+    Session.ignoreDirectoriesMatch = ignoreDirectoriesMatch;
+    Session.warnOnWebServerConfig = warnOnWebServerConfig;
+    Session.packageManager = packageManager;
+    Session.workspace = workspace;
+    // TODO: Do we really need all of the ** globs, or could we just put node_modules?
+    const ignoreDirectories = ['**/node_modules/**', '**/.git/**', ...ignoreDirectoriesMatch];
+    if (!loadPlaywrightChecksOnly) {
+        await loadAllCheckFiles(directory, checkMatch, ignoreDirectories);
+        // Load sequentially because otherwise Session.checkFileAbsolutePath and
+        // Session.checkFilePath are going to be subject to race conditions.
+        await loadAllBrowserChecks(directory, browserCheckMatch, ignoreDirectories, project);
+        await loadAllMultiStepChecks(directory, multiStepCheckMatch, ignoreDirectories, project);
+    }
+    await loadPlaywrightChecks(directory, playwrightChecks, playwrightConfigPath, include);
+    // private-location must be processed after all checks and groups are loaded.
+    await loadAllPrivateLocationsSlugNames(project);
+    return project;
+}
+function setCheckFilePaths(checkFile, directory) {
+    const relPath = pathToPosix(path.relative(directory, checkFile));
+    Session.checkFileAbsolutePath = checkFile;
+    Session.checkFilePath = relPath;
+    return relPath;
+}
+function resetCheckFilePaths() {
+    Session.checkFilePath = undefined;
+    Session.checkFileAbsolutePath = undefined;
+}
+// eslint-disable-next-line require-await
+async function loadPlaywrightChecks(directory, playwrightChecks, playwrightConfigPath, include) {
+    if (playwrightChecks?.length) {
+        try {
+            for (const playwrightCheckProps of playwrightChecks) {
+                const configPath = getPlaywrightConfigPath(playwrightCheckProps, playwrightConfigPath, directory);
+                setCheckFilePaths(configPath, directory);
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                const playwrightCheck = new PlaywrightCheck(playwrightCheckProps.logicalId, {
+                    ...playwrightCheckProps,
+                    playwrightConfigPath: configPath,
+                    include,
+                });
+            }
+        }
+        finally {
+            resetCheckFilePaths();
+        }
+    }
+    else {
+        try {
+            if (!playwrightConfigPath) {
+                return;
+            }
+            setCheckFilePaths(playwrightConfigPath, directory);
+            const resolvedPlaywrightConfigPath = path.resolve(directory, playwrightConfigPath);
+            const basePath = path.basename(resolvedPlaywrightConfigPath);
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const playwrightCheck = new PlaywrightCheck(basePath, {
+                name: basePath,
+                playwrightConfigPath: resolvedPlaywrightConfigPath,
+                include,
+            });
+        }
+        finally {
+            resetCheckFilePaths();
+        }
+    }
+}
+async function loadAllCheckFiles(directory, checkFilePattern, ignorePattern) {
+    const checkFiles = await findFilesWithPattern(directory, checkFilePattern, ignorePattern);
+    for (const checkFile of checkFiles) {
+        try {
+            setCheckFilePaths(checkFile, directory);
+            await Session.loadFile(checkFile);
+        }
+        finally {
+            resetCheckFilePaths();
+        }
+    }
+}
+function getExistingEntrypoints(project) {
+    const files = new Set();
+    Object.values(project.data.check).forEach(check => {
+        if (check instanceof BrowserCheck && isEntrypoint(check.code)) {
+            const absoluteEntrypoint = check.resolveContentFilePath(check.code.entrypoint);
+            const relativeEntrypoint = Session.relativePosixPath(absoluteEntrypoint);
+            files.add(relativeEntrypoint);
+            return;
+        }
+        if (check instanceof MultiStepCheck && isEntrypoint(check.code)) {
+            const absoluteEntrypoint = check.resolveContentFilePath(check.code.entrypoint);
+            const relativeEntrypoint = Session.relativePosixPath(absoluteEntrypoint);
+            files.add(relativeEntrypoint);
+            return;
+        }
+    });
+    return files;
+}
+async function loadAllBrowserChecks(directory, browserCheckFilePattern, ignorePattern, project) {
+    if (!browserCheckFilePattern) {
+        return;
+    }
+    const checkFiles = await findFilesWithPattern(directory, browserCheckFilePattern, ignorePattern);
+    const preexistingCheckFiles = getExistingEntrypoints(project);
+    for (const checkFile of checkFiles) {
+        try {
+            const relPath = setCheckFilePaths(checkFile, directory);
+            // Don't create an additional check if the checkFile was already added
+            // to a check in loadAllCheckFiles.
+            if (preexistingCheckFiles.has(relPath)) {
+                continue;
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const browserCheck = new BrowserCheck(pathToPosix(relPath), {
+                name: path.basename(checkFile),
+                code: {
+                    entrypoint: checkFile,
+                },
+            });
+        }
+        finally {
+            resetCheckFilePaths();
+        }
+    }
+}
+async function loadAllMultiStepChecks(directory, multiStepCheckFilePattern, ignorePattern, project) {
+    if (!multiStepCheckFilePattern) {
+        return;
+    }
+    const checkFiles = await findFilesWithPattern(directory, multiStepCheckFilePattern, ignorePattern);
+    const preexistingCheckFiles = getExistingEntrypoints(project);
+    for (const checkFile of checkFiles) {
+        try {
+            const relPath = setCheckFilePaths(checkFile, directory);
+            // Don't create an additional check if the checkFile was already added
+            // to a check in loadAllCheckFiles.
+            if (preexistingCheckFiles.has(relPath)) {
+                continue;
+            }
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const multistepCheck = new MultiStepCheck(pathToPosix(relPath), {
+                name: path.basename(checkFile),
+                code: {
+                    entrypoint: checkFile,
+                },
+            });
+        }
+        finally {
+            resetCheckFilePaths();
+        }
+    }
+}
+// TODO: create a function to process slug names for check or check-group to reduce duplicated code.
+async function loadAllPrivateLocationsSlugNames(project) {
+    /**
+     * Search for slug names in all Checks and CheckGroups privateLocations properties. Then, create non-member
+     * private-locations and assigments if needed.
+     * This logic allow as to get the private-location id searching by slug names and make use
+     * of PrivateLocation.fromId() under the hood.
+     */
+    const resourcesWithSlugNames = [...Object.values(project.data.check), ...Object.values(project.data['check-group'])]
+        .filter(g => g.privateLocations?.some(pl => typeof pl === 'string'));
+    if (!resourcesWithSlugNames.length) {
+        return;
+    }
+    const privateLocations = await Session.getPrivateLocations();
+    resourcesWithSlugNames.forEach(resource => {
+        // only slug names strings are processed here, the instances referenced are handle by the resource class
+        const resourceSlugNames = resource.privateLocations?.filter(pl => typeof pl === 'string') ?? [];
+        resourceSlugNames.forEach(sn => {
+            // check if the slug name could be replaced by the instance within the project
+            const isSlugNameFromProjectPrivateLocation = Object.values(project.data['private-location']).find(pl => pl.slugName === sn);
+            if (isSlugNameFromProjectPrivateLocation) {
+                throw new Error(`${resource.constructor.name} '${resource.logicalId}' is using a slug name '${sn}' to reference project private-location. Please, replace the slug name with the instance.`);
+            }
+            const privateLocation = privateLocations.find(pl => pl.slugName === sn);
+            if (!privateLocation) {
+                throw new Error(`${resource.constructor.name} '${resource.logicalId}' is using a private-location '${sn}' not found in your account. Please, review your configuration and try again.`);
+            }
+            // only create the non member private-location if it wasn't already added
+            const privateLocationAlreadyCreated = Object.values(project.data['private-location']).find(pl => pl.physicalId === privateLocation.id);
+            let privateLocationLogicalId;
+            if (!privateLocationAlreadyCreated) {
+                const nonMemberPrivateLocation = PrivateLocation.fromId(privateLocation.id);
+                privateLocationLogicalId = nonMemberPrivateLocation.logicalId;
+            }
+            else {
+                privateLocationLogicalId = privateLocationAlreadyCreated.logicalId;
+            }
+            // create the private-location/check assignment
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const assignment = resource instanceof Check
+                ? new PrivateLocationCheckAssignment(`private-location-check-assignment#${resource.logicalId}#${privateLocationLogicalId}`, {
+                    privateLocationId: Ref.from(privateLocationLogicalId),
+                    checkId: Ref.from(resource.logicalId),
+                })
+                : new PrivateLocationGroupAssignment(`private-location-group-assignment#${resource.logicalId}#${privateLocationLogicalId}`, {
+                    privateLocationId: Ref.from(privateLocationLogicalId),
+                    groupId: Ref.from(resource.logicalId),
+                });
+        });
+    });
+}
+//# sourceMappingURL=project-parser.js.map

package/dist/services/project-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-parser.js","sourceRoot":"","sources":["../../src/services/project-parser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAA;AAC5B,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EACL,oBAAoB,EAAE,uBAAuB,EAC7C,WAAW,GACZ,MAAM,WAAW,CAAA;AAClB,OAAO,EACL,KAAK,EAAE,YAAY,EAAc,OAAO,EAAE,OAAO,EACjD,eAAe,EAAE,8BAA8B,EAAE,8BAA8B,EAAE,cAAc,GAEhG,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAE1C,OAAO,EAAE,YAAY,EAAkB,MAAM,4BAA4B,CAAA;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,mCAAmC,CAAA;AACnE,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EACpB,4BAA4B,EAC5B,uBAAuB,GAExB,MAAM,iDAAiD,CAAA;AACxD,OAAO,EAAE,GAAG,EAAE,EAAE,EAAU,MAAM,wCAAwC,CAAA;AAIxE,MAAM,KAAK,GAAG,KAAK,CAAC,qCAAqC,CAAC,CAAA;AA2B1D,MAAM,mBAAmB,GAAG,EAC3B,CAAA;AAED,KAAK,UAAU,YAAY,CACzB,cAA8B,EAC9B,SAAiB,EACjB,EAAE,gBAAgB,GAAG,KAAK,EAAE;IAM5B,IAAI,CAAC;QACH,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,kBAAkB,GAAG,MAAM,wBAAwB,CAAC,SAAS,CAAC,CAAA;YAEpE,MAAM,SAAS,GAAG,MAAM,4BAA4B,CAClD,cAAc,EACd,kBAAkB,CACnB,CAAA;YAED,OAAO;gBACL,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;gBAC7B,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;gBAChC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC;aACzB,CAAA;QACH,CAAC;QAED,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,eAAe,CAAC,SAAS,CAAC,CAAA;QAEjE,wEAAwE;QACxE,uEAAuE;QACvE,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,MAAM,YAAY,CAAC,cAAc,EAAE,SAAS,EAAE;gBACnD,gBAAgB,EAAE,IAAI;aACvB,CAAC,CAAA;QACJ,CAAC;QAED,wEAAwE;QACxE,SAAS;QACT,MAAM,kBAAkB,GAAG,MAAM,wBAAwB,CAAC,SAAS,EAAE;YACnE,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;SAC1B,CAAC,CAAA;QAEF,MAAM,WAAW,GAAG,kBAAkB,CAAC,QAAQ,CAAA;QAE/C,sEAAsE;QACtE,sCAAsC;QACtC,IAAI,SAAS,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,SAAS,EAAE,CAAC;YACtD,OAAO;gBACL,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;gBAC7B,WAAW;gBACX,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC;aACzB,CAAA;QACH,CAAC;QAED,qDAAqD;QACrD,OAAO,MAAM,YAAY,CAAC,cAAc,EAAE,SAAS,EAAE;YACnD,gBAAgB,EAAE,IAAI;SACvB,CAAC,CAAA;IACJ,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,IAAI,GAAG,YAAY,uBAAuB,EAAE,CAAC;YAC3C,OAAO;gBACL,QAAQ,EAAE,SAAS;gBACnB,WAAW,EAAE,SAAS;gBACtB,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC;aACpB,CAAA;QACH,CAAC;QAED,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAE,IAAsB;IACxD,MAAM,EACJ,SAAS,EACT,UAAU,GAAG,oBAAoB,EACjC,WAAW,EACX,qBAAqB,GAAG,KAAK,EAC7B,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,sBAAsB,GAAG,EAAE,EAC3B,aAAa,GAAG,EAAE,EAClB,oBAAoB,GAAG,EAAE,EACzB,iBAAiB,EACjB,gBAAgB,EAChB,yBAAyB,EACzB,uBAAuB,EACvB,oBAAoB,EACpB,OAAO,EACP,gBAAgB,EAChB,wBAAwB,EACxB,qBAAqB,EACrB,gBAAgB,GAAG,IAAI,GACxB,GAAG,IAAI,CAAA;IAER,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,gBAAgB,EAAE;QAC5C,IAAI,EAAE,WAAW;QACjB,OAAO;KACR,CAAC,CAAA;IAEF,IAAI,qBAAqB,EAAE,CAAC;QAC1B,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;IAC7B,CAAC;IAED,MAAM,cAAc,GAAG,MAAM,oBAAoB,CAAC,SAAS,CAAC,CAAA;IAC5D,KAAK,CAAC,4BAA4B,cAAc,CAAC,IAAI,EAAE,CAAC,CAAA;IAExD,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,SAAS,EAAE;QACzF,gBAAgB,EAAE,CAAC,gBAAgB;KACpC,CAAC,CAAA;IAEF,MAAM,kBAAkB,GAAG,wBAAwB;QACjD,CAAC,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,eAAe,CAAC,CAAC;QACvE,CAAC,CAAC,uBAAuB,CAAA;IAE3B,kBAAkB,EAAE,OAAO,CACzB,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CACjF,CAAA;IACD,OAAO,CAAC,OAAO,GAAG,OAAO,CAAA;IACzB,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC3B,OAAO,CAAC,WAAW,GAAG,WAAW,CAAA;IACjC,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,mBAAmB,EAAE,aAAa,CAAC,CAAA;IAC7E,OAAO,CAAC,WAAW,GAAG,WAAW,CAAA;IACjC,OAAO,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;IACnD,OAAO,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC7C,OAAO,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;IAC3C,OAAO,CAAC,yBAAyB,GAAG,yBAAyB,IAAI,IAAI,CAAA;IACrE,OAAO,CAAC,sBAAsB,GAAG,sBAAsB,CAAA;IACvD,OAAO,CAAC,qBAAqB,GAAG,qBAAqB,CAAA;IACrD,OAAO,CAAC,cAAc,GAAG,cAAc,CAAA;IACvC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAA;IAE7B,kFAAkF;IAClF,MAAM,iBAAiB,GAAG,CAAC,oBAAoB,EAAE,YAAY,EAAE,GAAG,sBAAsB,CAAC,CAAA;IAEzF,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC9B,MAAM,iBAAiB,CAAC,SAAS,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAA;QACjE,wEAAwE;QACxE,oEAAoE;QACpE,MAAM,oBAAoB,CAAC,SAAS,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAA;QACpF,MAAM,sBAAsB,CAAC,SAAS,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAA;IAC1F,CAAC;IACD,MAAM,oBAAoB,CAAC,SAAS,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAA;IAEtF,6EAA6E;IAC7E,MAAM,gCAAgC,CAAC,OAAO,CAAC,CAAA;IAE/C,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,iBAAiB,CAAE,SAAiB,EAAE,SAAiB;IAC9D,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAA;IAEhE,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAA;IACzC,OAAO,CAAC,aAAa,GAAG,OAAO,CAAA;IAE/B,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAS,mBAAmB;IAC1B,OAAO,CAAC,aAAa,GAAG,SAAS,CAAA;IACjC,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAA;AAC3C,CAAC;AAED,yCAAyC;AACzC,KAAK,UAAU,oBAAoB,CACjC,SAAiB,EACjB,gBAA0C,EAC1C,oBAA6B,EAC7B,OAA2B;IAE3B,IAAI,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAC7B,IAAI,CAAC;YACH,KAAK,MAAM,oBAAoB,IAAI,gBAAgB,EAAE,CAAC;gBACpD,MAAM,UAAU,GAAG,uBAAuB,CAAC,oBAAoB,EAAE,oBAAoB,EAAE,SAAS,CAAC,CAAA;gBACjG,iBAAiB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAA;gBACxC,6DAA6D;gBAC7D,MAAM,eAAe,GAAG,IAAI,eAAe,CAAC,oBAAoB,CAAC,SAAS,EAAE;oBAC1E,GAAG,oBAAoB;oBACvB,oBAAoB,EAAE,UAAU;oBAChC,OAAO;iBACR,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,mBAAmB,EAAE,CAAA;QACvB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,CAAC;YACH,IAAI,CAAC,oBAAoB,EAAE,CAAC;gBAC1B,OAAM;YACR,CAAC;YACD,iBAAiB,CAAC,oBAAoB,EAAE,SAAS,CAAC,CAAA;YAClD,MAAM,4BAA4B,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAA;YAClF,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CAAC,CAAA;YAC5D,6DAA6D;YAC7D,MAAM,eAAe,GAAG,IAAI,eAAe,CAAC,QAAQ,EAAE;gBACpD,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,4BAA4B;gBAClD,OAAO;aACR,CAAC,CAAA;QACJ,CAAC;gBAAS,CAAC;YACT,mBAAmB,EAAE,CAAA;QACvB,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,iBAAiB,CAC9B,SAAiB,EACjB,gBAAmC,EACnC,aAAuB;IAEvB,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,SAAS,EAAE,gBAAgB,EAAE,aAAa,CAAC,CAAA;IACzF,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;YACvC,MAAM,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAA;QACnC,CAAC;gBAAS,CAAC;YACT,mBAAmB,EAAE,CAAA;QACvB,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAAE,OAAgB;IAC/C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAA;IAE/B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAChD,IAAI,KAAK,YAAY,YAAY,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAC9D,MAAM,kBAAkB,GAAG,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YAC9E,MAAM,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAA;YACxE,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;YAC7B,OAAM;QACR,CAAC;QAED,IAAI,KAAK,YAAY,cAAc,IAAI,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YAChE,MAAM,kBAAkB,GAAG,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YAC9E,MAAM,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAA;YACxE,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;YAC7B,OAAM;QACR,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,KAAK,CAAA;AACd,CAAC;AAED,KAAK,UAAU,oBAAoB,CACjC,SAAiB,EACjB,uBAAsD,EACtD,aAAuB,EACvB,OAAgB;IAEhB,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC7B,OAAM;IACR,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,SAAS,EAAE,uBAAuB,EAAE,aAAa,CAAC,CAAA;IAChG,MAAM,qBAAqB,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAE7D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;YACvD,sEAAsE;YACtE,mCAAmC;YACnC,IAAI,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACvC,SAAQ;YACV,CAAC;YAED,6DAA6D;YAC7D,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;gBAC1D,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAC9B,IAAI,EAAE;oBACJ,UAAU,EAAE,SAAS;iBACtB;aACF,CAAC,CAAA;QACJ,CAAC;gBAAS,CAAC;YACT,mBAAmB,EAAE,CAAA;QACvB,CAAC;IACH,CAAC;AACH,CAAC;AAED,KAAK,UAAU,sBAAsB,CACnC,SAAiB,EACjB,yBAAwD,EACxD,aAAuB,EACvB,OAAgB;IAEhB,IAAI,CAAC,yBAAyB,EAAE,CAAC;QAC/B,OAAM;IACR,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,oBAAoB,CAAC,SAAS,EAAE,yBAAyB,EAAE,aAAa,CAAC,CAAA;IAClG,MAAM,qBAAqB,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAA;IAE7D,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAA;YACvD,sEAAsE;YACtE,mCAAmC;YACnC,IAAI,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;gBACvC,SAAQ;YACV,CAAC;YAED,6DAA6D;YAC7D,MAAM,cAAc,GAAG,IAAI,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE;gBAC9D,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBAC9B,IAAI,EAAE;oBACJ,UAAU,EAAE,SAAS;iBACtB;aACF,CAAC,CAAA;QACJ,CAAC;gBAAS,CAAC;YACT,mBAAmB,EAAE,CAAA;QACvB,CAAC;IACH,CAAC;AACH,CAAC;AAED,oGAAoG;AACpG,KAAK,UAAU,gCAAgC,CAC7C,OAAgB;IAEhB;;;;;OAKG;IACH,MAAM,sBAAsB,GAC1B,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;SAClF,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAA;IAExE,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,CAAC;QACnC,OAAM;IACR,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,mBAAmB,EAAE,CAAA;IAE5D,sBAAsB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxC,wGAAwG;QACxG,MAAM,iBAAiB,GAAG,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAA;QAE/F,iBAAiB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YAC7B,8EAA8E;YAC9E,MAAM,oCAAoC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAA;YAC3H,IAAI,oCAAoC,EAAE,CAAC;gBACzC,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,2BAA2B,EAAE,2FAA2F,CAAC,CAAA;YAC9L,CAAC;YAED,MAAM,eAAe,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,QAAQ,KAAK,EAAE,CAAC,CAAA;YACvE,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,kCAAkC,EAAE,+EAA+E,CAAC,CAAA;YACzL,CAAC;YAED,yEAAyE;YACzE,MAAM,6BAA6B,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,UAAU,KAAK,eAAe,CAAC,EAAE,CAAC,CAAA;YACtI,IAAI,wBAAgC,CAAA;YACpC,IAAI,CAAC,6BAA6B,EAAE,CAAC;gBACnC,MAAM,wBAAwB,GAAG,eAAe,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA;gBAC3E,wBAAwB,GAAG,wBAAwB,CAAC,SAAS,CAAA;YAC/D,CAAC;iBAAM,CAAC;gBACN,wBAAwB,GAAG,6BAA6B,CAAC,SAAS,CAAA;YACpE,CAAC;YAED,+CAA+C;YAC/C,6DAA6D;YAC7D,MAAM,UAAU,GAAG,QAAQ,YAAY,KAAK;gBAC1C,CAAC,CAAC,IAAI,8BAA8B,CAAC,qCAAqC,QAAQ,CAAC,SAAS,IAAI,wBAAwB,EAAE,EAAE;oBACxH,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC;oBACrD,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;iBACtC,CAAC;gBACJ,CAAC,CAAC,IAAI,8BAA8B,CAAC,qCAAqC,QAAQ,CAAC,SAAS,IAAI,wBAAwB,EAAE,EAAE;oBACxH,iBAAiB,EAAE,GAAG,CAAC,IAAI,CAAC,wBAAwB,CAAC;oBACrD,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;iBACtC,CAAC,CAAA;QACR,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/services/proxy.d.ts

@@ -0,0 +1,32 @@
+import type { AxiosRequestConfig, CreateAxiosDefaults } from 'axios';
+import type { Agent } from 'node:http';
+/**
+ * Returns the proxy URL that applies to `targetUrl` based on the standard proxy
+ * environment variables (`HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`, `NO_PROXY`,
+ * and their lowercase variants), or `undefined` when the connection should be
+ * made directly.
+ */
+export declare function getProxyUrl(targetUrl: string): string | undefined;
+/**
+ * Returns a proxy agent for connecting to `targetUrl` based on the standard
+ * proxy environment variables (`HTTP_PROXY`, `HTTPS_PROXY`, `ALL_PROXY`,
+ * `NO_PROXY`, and their lowercase variants), or `undefined` when no proxy
+ * applies and the connection should be made directly.
+ *
+ * `http(s)://` proxies are tunneled via the agent matching the target's scheme;
+ * `socks://`, `socks4://`, and `socks5://` proxies use the SOCKS agent (which
+ * handles both HTTP and HTTPS targets).
+ */
+export declare function createProxyAgent(targetUrl: string): Agent | undefined;
+/**
+ * Installs a proxy agent on an axios config for requests to `targetUrl` and
+ * disables axios's own proxy handling.
+ *
+ * `proxy: false` is mandatory: without it, axios re-reads the proxy environment
+ * variables itself and rewrites the request, appending the proxy's port to
+ * portless target URLs (e.g. `https://api.checklyhq.com` becomes
+ * `https://api.checklyhq.com:8080`). Letting the agent own all proxy behavior
+ * keeps the target URL intact. When no proxy applies the agent is omitted and
+ * the request connects directly.
+ */
+export declare function assignProxy<T extends CreateAxiosDefaults | AxiosRequestConfig>(targetUrl: string, axiosConfig: T): T;