checkly 0.0.0-pr.686.4c0f5e3

package/dist/services/abstract-check-runner.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Events = void 0;
+const api_1 = require("../rest/api");
+const socket_client_1 = require("./socket-client");
+const p_queue_1 = require("p-queue");
+const uuid = require("uuid");
+const node_events_1 = require("node:events");
+// eslint-disable-next-line no-restricted-syntax
+var Events;
+(function (Events) {
+    Events["CHECK_REGISTERED"] = "CHECK_REGISTERED";
+    Events["CHECK_INPROGRESS"] = "CHECK_INPROGRESS";
+    Events["CHECK_FAILED"] = "CHECK_FAILED";
+    Events["CHECK_SUCCESSFUL"] = "CHECK_SUCCESSFUL";
+    Events["CHECK_FINISHED"] = "CHECK_FINISHED";
+    Events["RUN_STARTED"] = "RUN_STARTED";
+    Events["RUN_FINISHED"] = "RUN_FINISHED";
+    Events["ERROR"] = "ERROR";
+})(Events = exports.Events || (exports.Events = {}));
+class AbstractCheckRunner extends node_events_1.EventEmitter {
+    constructor(accountId, timeout, verbose) {
+        super();
+        this.checks = new Map();
+        this.timeouts = new Map();
+        this.queue = new p_queue_1.default({ autoStart: false, concurrency: 1 });
+        this.timeout = timeout;
+        this.verbose = verbose;
+        this.accountId = accountId;
+    }
+    async run() {
+        let socketClient = null;
+        try {
+            socketClient = await socket_client_1.SocketClient.connect();
+            const checkRunSuiteId = uuid.v4();
+            // Configure the socket listener and allChecksFinished listener before starting checks to avoid race conditions
+            await this.configureResultListener(checkRunSuiteId, socketClient);
+            const { testSessionId, checks } = await this.scheduleChecks(checkRunSuiteId);
+            this.testSessionId = testSessionId;
+            this.checks = new Map(checks.map(({ check, checkRunId, testResultId }) => [checkRunId, { check, testResultId }]));
+            // `processMessage()` assumes that `this.timeouts` always has an entry for non-timed-out checks.
+            // To ensure that this is the case, we call `setAllTimeouts()` before `queue.start()`.
+            // Otherwise, we risk a race condition where check results are received before the timeout is set.
+            // This would cause `processMessage()` to mistakenly skip check results and consider the checks timed-out.
+            this.setAllTimeouts();
+            // `allChecksFinished` should be started before processing check results in `queue.start()`.
+            // Otherwise, there could be a race condition causing check results to be missed by `allChecksFinished()`.
+            const allChecksFinished = this.allChecksFinished();
+            // Start the queue after the test session run rest call is completed to avoid race conditions
+            this.queue.start();
+            /// / Need to structure the checks depending on how it went
+            this.emit(Events.RUN_STARTED, checks, testSessionId);
+            await allChecksFinished;
+            this.emit(Events.RUN_FINISHED, testSessionId);
+        }
+        catch (err) {
+            this.disableAllTimeouts();
+            this.emit(Events.ERROR, err);
+        }
+        finally {
+            if (socketClient) {
+                await socketClient.end();
+            }
+        }
+    }
+    async configureResultListener(checkRunSuiteId, socketClient) {
+        socketClient.on('message', (topic, rawMessage) => {
+            const message = JSON.parse(rawMessage.toString('utf8'));
+            const topicComponents = topic.split('/');
+            const checkRunId = topicComponents[4];
+            const subtopic = topicComponents[5];
+            this.queue.add(() => this.processMessage(checkRunId, subtopic, message));
+        });
+        await socketClient.subscribe(`account/${this.accountId}/ad-hoc-check-results/${checkRunSuiteId}/+/+`);
+    }
+    async processMessage(checkRunId, subtopic, message) {
+        if (!this.timeouts.has(checkRunId)) {
+            // The check has already timed out. We return early to avoid reporting a duplicate result.
+            return;
+        }
+        if (!this.checks.get(checkRunId)) {
+            // The check has no checkRunId associated.
+            return;
+        }
+        const { check, testResultId } = this.checks.get(checkRunId);
+        if (subtopic === 'run-start') {
+            this.emit(Events.CHECK_INPROGRESS, check);
+        }
+        else if (subtopic === 'run-end') {
+            this.disableTimeout(checkRunId);
+            const { result } = message;
+            const { region, logPath, checkRunDataPath, } = result.assets;
+            if (logPath && (this.verbose || result.hasFailures)) {
+                result.logs = await api_1.assets.getLogs(region, logPath);
+            }
+            if (checkRunDataPath && (this.verbose || result.hasFailures)) {
+                result.checkRunData = await api_1.assets.getCheckRunData(region, checkRunDataPath);
+            }
+            const links = testResultId && result.hasFailures && await this.getShortLinks(testResultId);
+            this.emit(Events.CHECK_SUCCESSFUL, checkRunId, check, result, links);
+            this.emit(Events.CHECK_FINISHED, check);
+        }
+        else if (subtopic === 'error') {
+            this.disableTimeout(checkRunId);
+            this.emit(Events.CHECK_FAILED, checkRunId, check, message);
+            this.emit(Events.CHECK_FINISHED, check);
+        }
+    }
+    allChecksFinished() {
+        let finishedCheckCount = 0;
+        const numChecks = this.checks.size;
+        if (numChecks === 0) {
+            return Promise.resolve();
+        }
+        return new Promise((resolve) => {
+            this.on(Events.CHECK_FINISHED, () => {
+                finishedCheckCount++;
+                if (finishedCheckCount === numChecks)
+                    resolve();
+            });
+        });
+    }
+    setAllTimeouts() {
+        Array.from(this.checks.entries()).forEach(([checkRunId, { check }]) => this.timeouts.set(checkRunId, setTimeout(() => {
+            this.timeouts.delete(checkRunId);
+            this.emit(Events.CHECK_FAILED, check, `Reached timeout of ${this.timeout} seconds waiting for check result.`);
+            this.emit(Events.CHECK_FINISHED, check);
+        }, this.timeout * 1000)));
+    }
+    disableAllTimeouts() {
+        if (!this.checks) {
+            return;
+        }
+        Array.from(this.checks.entries()).forEach(([checkRunId]) => this.disableTimeout(checkRunId));
+    }
+    disableTimeout(checkRunId) {
+        const timeout = this.timeouts.get(checkRunId);
+        clearTimeout(timeout);
+        this.timeouts.delete(checkRunId);
+    }
+    async getShortLinks(testResultId) {
+        try {
+            if (!this.testSessionId) {
+                return;
+            }
+            const { data: links } = await api_1.testSessions.getResultShortLinks(this.testSessionId, testResultId);
+            return links;
+        }
+        catch {
+        }
+    }
+}
+exports.default = AbstractCheckRunner;
+//# sourceMappingURL=abstract-check-runner.js.map

package/dist/services/abstract-check-runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstract-check-runner.js","sourceRoot":"","sources":["../../src/services/abstract-check-runner.ts"],"names":[],"mappings":";;;AAAA,qCAAkD;AAClD,mDAA8C;AAC9C,qCAA4B;AAC5B,6BAA4B;AAC5B,6CAA0C;AAK1C,gDAAgD;AAChD,IAAY,MASX;AATD,WAAY,MAAM;IAChB,+CAAqC,CAAA;IACrC,+CAAqC,CAAA;IACrC,uCAA6B,CAAA;IAC7B,+CAAqC,CAAA;IACrC,2CAAiC,CAAA;IACjC,qCAA2B,CAAA;IAC3B,uCAA6B,CAAA;IAC7B,yBAAe,CAAA;AACjB,CAAC,EATW,MAAM,GAAN,cAAM,KAAN,cAAM,QASjB;AAeD,MAA8B,mBAAoB,SAAQ,0BAAY;IAWpE,YACE,SAAiB,EACjB,OAAe,EACf,OAAgB;QAEhB,KAAK,EAAE,CAAA;QACP,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAE,CAAA;QACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE,CAAA;QACzB,IAAI,CAAC,KAAK,GAAG,IAAI,iBAAM,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAA;QAC7D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAQD,KAAK,CAAC,GAAG;QACP,IAAI,YAAY,GAAG,IAAI,CAAA;QACvB,IAAI;YACF,YAAY,GAAG,MAAM,4BAAY,CAAC,OAAO,EAAE,CAAA;YAE3C,MAAM,eAAe,GAAG,IAAI,CAAC,EAAE,EAAE,CAAA;YACjC,+GAA+G;YAC/G,MAAM,IAAI,CAAC,uBAAuB,CAAC,eAAe,EAAE,YAAY,CAAC,CAAA;YAEjE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,CAAA;YAC5E,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;YAClC,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,CACnB,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC,CAC3F,CAAA;YAED,gGAAgG;YAChG,sFAAsF;YACtF,kGAAkG;YAClG,0GAA0G;YAC1G,IAAI,CAAC,cAAc,EAAE,CAAA;YACrB,4FAA4F;YAC5F,0GAA0G;YAC1G,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;YAClD,6FAA6F;YAC7F,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;YAClB,2DAA2D;YAC3D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,CAAA;YAEpD,MAAM,iBAAiB,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,CAAA;SAC9C;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,kBAAkB,EAAE,CAAA;YACzB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;SAC7B;gBAAS;YACR,IAAI,YAAY,EAAE;gBAChB,MAAM,YAAY,CAAC,GAAG,EAAE,CAAA;aACzB;SACF;IACH,CAAC;IAEO,KAAK,CAAC,uBAAuB,CAAE,eAAuB,EAAE,YAA6B;QAC3F,YAAY,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,KAAa,EAAE,UAAyB,EAAE,EAAE;YACtE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;YACvD,MAAM,eAAe,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACxC,MAAM,UAAU,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;YACrC,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;YAEnC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAA;QAC1E,CAAC,CAAC,CAAA;QACF,MAAM,YAAY,CAAC,SAAS,CAAC,WAAW,IAAI,CAAC,SAAS,yBAAyB,eAAe,MAAM,CAAC,CAAA;IACvG,CAAC;IAEO,KAAK,CAAC,cAAc,CAAE,UAAkB,EAAE,QAAgB,EAAE,OAAY;QAC9E,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YAClC,0FAA0F;YAC1F,OAAM;SACP;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;YAChC,0CAA0C;YAC1C,OAAM;SACP;QAED,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAE,CAAA;QAC5D,IAAI,QAAQ,KAAK,WAAW,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAA;SAC1C;aAAM,IAAI,QAAQ,KAAK,SAAS,EAAE;YACjC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;YAC/B,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAA;YAC1B,MAAM,EACJ,MAAM,EACN,OAAO,EACP,gBAAgB,GACjB,GAAG,MAAM,CAAC,MAAM,CAAA;YACjB,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE;gBACnD,MAAM,CAAC,IAAI,GAAG,MAAM,YAAM,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;aACpD;YACD,IAAI,gBAAgB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE;gBAC5D,MAAM,CAAC,YAAY,GAAG,MAAM,YAAM,CAAC,eAAe,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;aAC7E;YAED,MAAM,KAAK,GAAG,YAAY,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;YAE1F,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;YACpE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;SACxC;aAAM,IAAI,QAAQ,KAAK,OAAO,EAAE;YAC/B,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;YAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;YAC1D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;SACxC;IACH,CAAC;IAEO,iBAAiB;QACvB,IAAI,kBAAkB,GAAG,CAAC,CAAA;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAA;QAClC,IAAI,SAAS,KAAK,CAAC,EAAE;YACnB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;SACzB;QACD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,GAAG,EAAE;gBAClC,kBAAkB,EAAE,CAAA;gBACpB,IAAI,kBAAkB,KAAK,SAAS;oBAAE,OAAO,EAAE,CAAA;YACjD,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,cAAc;QACpB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,CACpE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,EAAE;YAC5C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;YAChC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,KAAK,EAAE,sBAAsB,IAAI,CAAC,OAAO,oCAAoC,CAAC,CAAA;YAC7G,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;QACzC,CAAC,EAAE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CACtB,CAAC,CAAA;IACN,CAAC;IAEO,kBAAkB;QACxB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,OAAM;SACP;QACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAA;IAC9F,CAAC;IAEO,cAAc,CAAE,UAAkB;QACxC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAC7C,YAAY,CAAC,OAAO,CAAC,CAAA;QACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;IAClC,CAAC;IAEO,KAAK,CAAC,aAAa,CAAE,YAAoB;QAC/C,IAAI;YACF,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;gBACvB,OAAM;aACP;YACD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,kBAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAA;YAChG,OAAO,KAAK,CAAA;SACb;QAAC,MAAM;SACP;IACH,CAAC;CACF;AA1KD,sCA0KC"}

package/dist/services/check-parser/collector.d.ts

@@ -0,0 +1,33 @@
+export type UnsupportedNpmDependencies = {
+    file: string;
+    unsupportedDependencies: string[];
+};
+export type ParseError = {
+    file: string;
+    error: string;
+};
+export declare class Collector {
+    entrypoint: string;
+    entrypointContent: string;
+    missingFiles: string[];
+    parseErrors: ParseError[];
+    unsupportedNpmDependencies: UnsupportedNpmDependencies[];
+    dependencies: Map<string, string>;
+    constructor(entrypoint: string, entrypointContent: string);
+    hasDependency(path: string): boolean;
+    addDependency(path: string, content: string): void;
+    addUnsupportedNpmDependencies(file: string, unsupportedDependencies: string[]): void;
+    addParsingError(file: string, message: string): void;
+    addMissingFile(filePath: string): void;
+    validate(): void;
+    getItems(): {
+        entrypoint: {
+            filePath: string;
+            content: string;
+        };
+        dependencies: {
+            filePath: string;
+            content: string;
+        }[];
+    };
+}

package/dist/services/check-parser/collector.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Collector = void 0;
+const errors_1 = require("./errors");
+class Collector {
+    constructor(entrypoint, entrypointContent) {
+        this.missingFiles = [];
+        this.parseErrors = [];
+        this.unsupportedNpmDependencies = [];
+        this.dependencies = new Map();
+        this.entrypoint = entrypoint;
+        this.entrypointContent = entrypointContent;
+    }
+    hasDependency(path) {
+        return this.dependencies.has(path);
+    }
+    addDependency(path, content) {
+        this.dependencies.set(path, content);
+    }
+    addUnsupportedNpmDependencies(file, unsupportedDependencies) {
+        this.unsupportedNpmDependencies.push({ file, unsupportedDependencies });
+    }
+    addParsingError(file, message) {
+        this.parseErrors.push({ file, error: message });
+    }
+    addMissingFile(filePath) {
+        this.missingFiles.push(filePath);
+    }
+    validate() {
+        if (this.missingFiles.length || this.parseErrors.length || this.unsupportedNpmDependencies.length) {
+            throw new errors_1.DependencyParseError(this.entrypoint, this.missingFiles, this.unsupportedNpmDependencies, this.parseErrors);
+        }
+    }
+    getItems() {
+        return {
+            entrypoint: {
+                filePath: this.entrypoint,
+                content: this.entrypointContent,
+            },
+            dependencies: Array.from(this.dependencies.entries(), ([key, value]) => ({
+                filePath: key,
+                content: value,
+            })),
+        };
+    }
+}
+exports.Collector = Collector;
+//# sourceMappingURL=collector.js.map

package/dist/services/check-parser/collector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector.js","sourceRoot":"","sources":["../../../src/services/check-parser/collector.ts"],"names":[],"mappings":";;;AAAA,qCAA+C;AAY/C,MAAa,SAAS;IAQpB,YAAa,UAAkB,EAAE,iBAAyB;QAL1D,iBAAY,GAAa,EAAE,CAAA;QAC3B,gBAAW,GAAiB,EAAE,CAAA;QAC9B,+BAA0B,GAAiC,EAAE,CAAA;QAC7D,iBAAY,GAAG,IAAI,GAAG,EAAkB,CAAA;QAGtC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAA;IAC5C,CAAC;IAED,aAAa,CAAE,IAAY;QACzB,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED,aAAa,CAAE,IAAY,EAAE,OAAe;QAC1C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IACtC,CAAC;IAED,6BAA6B,CAAE,IAAY,EAAE,uBAAiC;QAC5E,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,uBAAuB,EAAE,CAAC,CAAA;IACzE,CAAC;IAED,eAAe,CAAE,IAAY,EAAE,OAAe;QAC5C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAA;IACjD,CAAC;IAED,cAAc,CAAE,QAAgB;QAC9B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAClC,CAAC;IAED,QAAQ;QACN,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,IAAI,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE;YACjG,MAAM,IAAI,6BAAoB,CAC5B,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,0BAA0B,EAC/B,IAAI,CAAC,WAAW,CACjB,CAAA;SACF;IACH,CAAC;IAED,QAAQ;QACN,OAAO;YACL,UAAU,EAAE;gBACV,QAAQ,EAAE,IAAI,CAAC,UAAU;gBACzB,OAAO,EAAE,IAAI,CAAC,iBAAiB;aAChC;YACD,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;gBACvE,QAAQ,EAAE,GAAG;gBACb,OAAO,EAAE,KAAK;aACf,CAAC,CAAC;SACJ,CAAA;IACH,CAAC;CACF;AAxDD,8BAwDC"}

package/dist/services/check-parser/errors.d.ts

@@ -0,0 +1,8 @@
+import { ParseError, UnsupportedNpmDependencies } from './collector';
+export declare class DependencyParseError extends Error {
+    entrypoint: string;
+    missingFiles: string[];
+    unsupportedNpmDependencies: UnsupportedNpmDependencies[];
+    parseErrors: ParseError[];
+    constructor(entrypoint: string, missingFiles: string[], unsupportedNpmDependencies: UnsupportedNpmDependencies[], parseErrors: ParseError[]);
+}

package/dist/services/check-parser/errors.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DependencyParseError = void 0;
+class DependencyParseError extends Error {
+    constructor(entrypoint, missingFiles, unsupportedNpmDependencies, parseErrors) {
+        let message = `Encountered an error parsing check files for ${entrypoint}.`;
+        if (missingFiles.length) {
+            message += '\n\nThe following dependencies weren\'t found:\n';
+            for (const missingFile of missingFiles) {
+                message += `\t${missingFile}\n`;
+            }
+        }
+        if (unsupportedNpmDependencies.length) {
+            if (unsupportedNpmDependencies.some(d => d.unsupportedDependencies.some(ud => ud === 'checkly/constructs'))) {
+                message += '\n\nIt looks like you\'re trying to use checkly/constructs in a browser check file. ' +
+                    'checkly/constructs should only be used in check files: files ending in .check.ts and .check.js, ' +
+                    'or the checkMatch pattern set in your configuration. For more information see on the difference between ' +
+                    'test files and check files, see https://www.checklyhq.com/docs/cli/\n';
+            }
+            else {
+                message += '\n\nThe following NPM dependencies were used, but aren\'t supported in the runtimes.\n';
+                message += 'For more information, see https://www.checklyhq.com/docs/runtimes/.\n';
+                for (const { file, unsupportedDependencies } of unsupportedNpmDependencies) {
+                    message += `\t${file} imports unsupported dependencies:\n`;
+                    for (const unsupportedDependency of unsupportedDependencies) {
+                        message += `\t\t${unsupportedDependency}\n`;
+                    }
+                }
+            }
+        }
+        if (parseErrors.length) {
+            message += '\n\nThe following files couldn\'t be parsed:\n';
+            for (const { file, error } of parseErrors) {
+                message += `\t${file} - ${error}\n`;
+            }
+        }
+        super(message);
+        this.entrypoint = entrypoint;
+        this.missingFiles = missingFiles;
+        this.unsupportedNpmDependencies = unsupportedNpmDependencies;
+        this.parseErrors = parseErrors;
+    }
+}
+exports.DependencyParseError = DependencyParseError;
+//# sourceMappingURL=errors.js.map

package/dist/services/check-parser/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/services/check-parser/errors.ts"],"names":[],"mappings":";;;AAEA,MAAa,oBAAqB,SAAQ,KAAK;IAK7C,YACE,UAAkB,EAClB,YAAsB,EACtB,0BAAwD,EACxD,WAAyB;QAEzB,IAAI,OAAO,GAAG,gDAAgD,UAAU,GAAG,CAAA;QAC3E,IAAI,YAAY,CAAC,MAAM,EAAE;YACvB,OAAO,IAAI,kDAAkD,CAAA;YAC7D,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;gBACtC,OAAO,IAAI,KAAK,WAAW,IAAI,CAAA;aAChC;SACF;QACD,IAAI,0BAA0B,CAAC,MAAM,EAAE;YACrC,IAAI,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,oBAAoB,CAAC,CAAC,EAAE;gBAC3G,OAAO,IAAI,sFAAsF;oBAC/F,kGAAkG;oBAClG,0GAA0G;oBAC1G,uEAAuE,CAAA;aAC1E;iBAAM;gBACL,OAAO,IAAI,wFAAwF,CAAA;gBACnG,OAAO,IAAI,uEAAuE,CAAA;gBAClF,KAAK,MAAM,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,0BAA0B,EAAE;oBAC1E,OAAO,IAAI,KAAK,IAAI,sCAAsC,CAAA;oBAC1D,KAAK,MAAM,qBAAqB,IAAI,uBAAuB,EAAE;wBAC3D,OAAO,IAAI,OAAO,qBAAqB,IAAI,CAAA;qBAC5C;iBACF;aACF;SACF;QACD,IAAI,WAAW,CAAC,MAAM,EAAE;YACtB,OAAO,IAAI,gDAAgD,CAAA;YAC3D,KAAK,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,WAAW,EAAE;gBACzC,OAAO,IAAI,KAAK,IAAI,MAAM,KAAK,IAAI,CAAA;aACpC;SACF;QACD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,0BAA0B,GAAG,0BAA0B,CAAA;QAC5D,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;IAChC,CAAC;CACF;AA/CD,oDA+CC"}

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

@@ -0,0 +1,39 @@
+type Module = {
+    localDependencies: Array<string>;
+    npmDependencies: Array<string>;
+};
+type SupportedFileExtension = '.js' | '.ts';
+declare const JS_RESOLVE_ORDER: string[];
+declare const TS_RESOLVE_ORDER: string[];
+export declare class Parser {
+    supportedModules: Set<string>;
+    constructor(supportedNpmModules: Array<string>);
+    parse(entrypoint: string): {
+        entrypoint: {
+            filePath: string;
+            content: string;
+        };
+        dependencies: {
+            filePath: string;
+            content: string;
+        }[];
+    };
+    static readDependency(filePath: string, preferedExtenstion: SupportedFileExtension): {
+        filePath: string;
+        content: string;
+    }[];
+    static tryReadFileExt(filePath: string, exts: typeof JS_RESOLVE_ORDER | typeof TS_RESOLVE_ORDER): {
+        filePath: string;
+        content: string;
+    }[];
+    static parseDependencies(filePath: string, contents: string): {
+        module: Module;
+        error?: any;
+    };
+    static jsNodeVisitor(localDependencies: Set<string>, npmDependencies: Set<string>): any;
+    static tsNodeVisitor(tsParser: any, localDependencies: Set<string>, npmDependencies: Set<string>): any;
+    static isRequireExpression(node: any): boolean;
+    static getRequireStringArg(node: any): string | null;
+    static registerDependency(importArg: string | null, localDependencies: Set<string>, npmDependencies: Set<string>): void;
+}
+export {};

package/dist/services/check-parser/parser.js

@@ -0,0 +1,296 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Parser = void 0;
+const path = require("path");
+const fs = require("fs");
+const acorn = require("acorn");
+const walk = require("acorn-walk");
+const collector_1 = require("./collector");
+const errors_1 = require("./errors");
+// Our custom configuration to handle walking errors
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+const ignore = (_node, _st, _c) => { };
+const PACKAGE_EXTENSION = `${path.sep}package.json`;
+const JS_RESOLVE_ORDER = [
+    '.js',
+    PACKAGE_EXTENSION,
+    `${path.sep}index.js`,
+];
+const TS_RESOLVE_ORDER = [
+    '.ts',
+    '.js',
+    PACKAGE_EXTENSION,
+    `${path.sep}index.ts`,
+    `${path.sep}index.js`,
+];
+const supportedBuiltinModules = [
+    'assert', 'buffer', 'crypto', 'dns', 'fs', 'path', 'querystring', 'readline ', 'stream', 'string_decoder',
+    'timers', 'tls', 'url', 'util', 'zlib',
+];
+function validateEntrypoint(entrypoint) {
+    const extension = path.extname(entrypoint);
+    if (extension !== '.js' && extension !== '.ts') {
+        throw new Error(`Unsupported file extension for ${entrypoint}`);
+    }
+    try {
+        const content = fs.readFileSync(entrypoint, { encoding: 'utf-8' });
+        return { extension, content };
+    }
+    catch (err) {
+        throw new errors_1.DependencyParseError(entrypoint, [entrypoint], [], []);
+    }
+}
+let tsParser;
+function getTsParser() {
+    if (tsParser) {
+        return tsParser;
+    }
+    try {
+        tsParser = require('@typescript-eslint/typescript-estree');
+        const AST_NODE_TYPES = tsParser.AST_NODE_TYPES;
+        // Our custom configuration to handle walking errors
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        Object.values(AST_NODE_TYPES).forEach((astType) => {
+            var _a;
+            // Only handle the TS specific ones
+            if (!astType.startsWith('TS')) {
+                return;
+            }
+            walk.base[astType] = (_a = walk.base[astType]) !== null && _a !== void 0 ? _a : ignore;
+        });
+        return tsParser;
+    }
+    catch (err) {
+        if (err.code === 'ERR_MODULE_NOT_FOUND' || err.code === 'MODULE_NOT_FOUND') {
+            throw new Error('Please install "typescript" to use TypeScript-code in check files');
+        }
+        throw err;
+    }
+}
+class Parser {
+    // TODO: pass a npm matrix of supported npm modules
+    // Maybe pass a cache so we don't have to fetch files separately all the time
+    constructor(supportedNpmModules) {
+        this.supportedModules = new Set([...supportedBuiltinModules, ...supportedNpmModules]);
+    }
+    parse(entrypoint) {
+        const { extension, content } = validateEntrypoint(entrypoint);
+        /*
+      * The importing of files forms a directed graph.
+      * Vertices are source files and edges are from importing other files.
+      * We can find all of the files we need to run the check by traversing this graph.
+      * In this implementation, we use breadth first search.
+      */
+        const collector = new collector_1.Collector(entrypoint, content);
+        const bfsQueue = [{ filePath: entrypoint, content }];
+        while (bfsQueue.length > 0) {
+            // Since we just checked the length, shift() will never return undefined.
+            // We can add a not-null assertion operator (!).
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const item = bfsQueue.shift();
+            if (item.filePath.endsWith(PACKAGE_EXTENSION)) {
+                // Holds info about the main file and doesn't need to be parsed
+                continue;
+            }
+            const { module, error } = Parser.parseDependencies(item.filePath, item.content);
+            if (error) {
+                collector.addParsingError(item.filePath, error.message);
+                continue;
+            }
+            const unsupportedDependencies = module.npmDependencies.filter((dep) => !this.supportedModules.has(dep));
+            if (unsupportedDependencies.length) {
+                collector.addUnsupportedNpmDependencies(item.filePath, unsupportedDependencies);
+            }
+            const localDependenciesResolvedPaths = [];
+            module.localDependencies.forEach((localDependency) => {
+                const filePath = path.join(path.dirname(item.filePath), localDependency);
+                try {
+                    const deps = Parser.readDependency(filePath, extension);
+                    localDependenciesResolvedPaths.push(...deps);
+                }
+                catch (err) {
+                    collector.addMissingFile(filePath);
+                }
+            });
+            localDependenciesResolvedPaths.forEach(({ filePath, content }) => {
+                if (collector.hasDependency(filePath)) {
+                    return;
+                }
+                collector.addDependency(filePath, content);
+                bfsQueue.push({ filePath, content });
+            });
+        }
+        collector.validate();
+        return collector.getItems();
+    }
+    static readDependency(filePath, preferedExtenstion) {
+        // Read the specific file if it has an extension
+        if (preferedExtenstion === '.js') {
+            return Parser.tryReadFileExt(filePath, JS_RESOLVE_ORDER);
+        }
+        else {
+            return Parser.tryReadFileExt(filePath, TS_RESOLVE_ORDER);
+        }
+    }
+    static tryReadFileExt(filePath, exts) {
+        for (const extension of ['', ...exts]) {
+            try {
+                const deps = [];
+                const fullPath = filePath + extension;
+                const content = fs.readFileSync(fullPath, { encoding: 'utf-8' });
+                deps.push({ filePath: fullPath, content });
+                if (extension === PACKAGE_EXTENSION) {
+                    const { main } = JSON.parse(content);
+                    if (!main || !main.length) {
+                        // No main is defined. This means package.json doesn't have a specific entry
+                        continue;
+                    }
+                    const mainFile = path.join(filePath, main);
+                    deps.push({
+                        filePath: mainFile, content: fs.readFileSync(mainFile, { encoding: 'utf-8' }),
+                    });
+                }
+                return deps;
+            }
+            catch (err) { }
+        }
+        throw new Error(`Cannot find file ${filePath}`);
+    }
+    static parseDependencies(filePath, contents) {
+        const localDependencies = new Set();
+        const npmDependencies = new Set();
+        const extension = path.extname(filePath);
+        try {
+            if (extension === '.js') {
+                const ast = acorn.parse(contents, {
+                    allowReturnOutsideFunction: true,
+                    ecmaVersion: 'latest',
+                    allowImportExportEverywhere: true,
+                });
+                walk.simple(ast, Parser.jsNodeVisitor(localDependencies, npmDependencies));
+            }
+            else if (extension === '.ts') {
+                const tsParser = getTsParser();
+                const ast = tsParser.parse(contents, {});
+                // The AST from typescript-estree is slightly different from the type used by acorn-walk.
+                // This doesn't actually cause problems (both are "ESTree's"), but we need to ignore type errors here.
+                // @ts-ignore
+                walk.simple(ast, Parser.tsNodeVisitor(tsParser, localDependencies, npmDependencies));
+            }
+            else {
+                throw new Error(`Unsupported file extension for ${filePath}`);
+            }
+        }
+        catch (err) {
+            return {
+                module: {
+                    localDependencies: Array.from(localDependencies),
+                    npmDependencies: Array.from(npmDependencies),
+                },
+                error: err,
+            };
+        }
+        return {
+            module: {
+                localDependencies: Array.from(localDependencies),
+                npmDependencies: Array.from(npmDependencies),
+            },
+        };
+    }
+    static jsNodeVisitor(localDependencies, npmDependencies) {
+        return {
+            CallExpression(node) {
+                if (!Parser.isRequireExpression(node))
+                    return;
+                const requireStringArg = Parser.getRequireStringArg(node);
+                Parser.registerDependency(requireStringArg, localDependencies, npmDependencies);
+            },
+            ImportDeclaration(node) {
+                if (node.source.type !== 'Literal')
+                    return;
+                Parser.registerDependency(node.source.value, localDependencies, npmDependencies);
+            },
+            ExportNamedDeclaration(node) {
+                if (node.source === null)
+                    return;
+                if (node.source.type !== 'Literal')
+                    return;
+                Parser.registerDependency(node.source.value, localDependencies, npmDependencies);
+            },
+        };
+    }
+    static tsNodeVisitor(tsParser, localDependencies, npmDependencies) {
+        return {
+            ImportDeclaration(node) {
+                // For now, we only support literal strings in the import statement
+                if (node.source.type !== tsParser.TSESTree.AST_NODE_TYPES.Literal)
+                    return;
+                Parser.registerDependency(node.source.value, localDependencies, npmDependencies);
+            },
+            ExportNamedDeclaration(node) {
+                // The statement isn't importing another dependency
+                if (node.source === null)
+                    return;
+                // For now, we only support literal strings in the import statement
+                if (node.source.type !== tsParser.TSESTree.AST_NODE_TYPES.Literal)
+                    return;
+                Parser.registerDependency(node.source.value, localDependencies, npmDependencies);
+            },
+        };
+    }
+    static isRequireExpression(node) {
+        if (node.type !== 'CallExpression') {
+            // Ignore AST nodes that aren't call expressions
+            return false;
+        }
+        else if (node.arguments.length === 0) {
+            // Weird case of `require()` or `module.require()` without arguments
+            return false;
+        }
+        else if (node.callee.type === 'Identifier') {
+            // Handle the case of a simple call to `require('dependency')`
+            return node.callee.name === 'require';
+        }
+        else if (node.callee.type === 'MemberExpression') {
+            // Handle calls to `module.require('dependency')`
+            const { object, property } = node.callee;
+            return object.type === 'Identifier' &&
+                object.name === 'module' &&
+                property.type === 'Identifier' &&
+                property.name === 'require';
+        }
+        else {
+            return false;
+        }
+    }
+    static getRequireStringArg(node) {
+        if (node.arguments[0].type === 'Literal') {
+            return node.arguments[0].value;
+        }
+        else if (node.arguments[0].type === 'TemplateLiteral') {
+            return node.arguments[0].quasis[0].value.cooked;
+        }
+        else {
+            /*
+            * It might be that `require` is called with a variable - `require(myPackage)`.
+            * Unfortunately supporting that case would be complicated.
+            * We just skip the dependency and hope that the check still works.
+            */
+            return null;
+        }
+    }
+    static registerDependency(importArg, localDependencies, npmDependencies) {
+        // TODO: We currently don't support import path aliases, f.ex: `import { Something } from '@services/my-service'`
+        if (!importArg) {
+            // If there's no importArg, don't register a dependency
+        }
+        else if (importArg.startsWith('/') || importArg.startsWith('./') || importArg.startsWith('../')) {
+            localDependencies.add(importArg);
+        }
+        else {
+            npmDependencies.add(importArg);
+        }
+    }
+}
+exports.Parser = Parser;
+//# sourceMappingURL=parser.js.map