checkly 0.0.0-pr.1006.b6b3be2

package/dist/rest/heartbeat-checks.d.ts

@@ -0,0 +1,11 @@
+import type { AxiosInstance } from 'axios';
+export interface HeartbeatCheck {
+    pingUrl: string;
+    name: string;
+}
+declare class HeartbeatChecks {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    get(id: string): Promise<import("axios").AxiosResponse<HeartbeatCheck, any>>;
+}
+export default HeartbeatChecks;

package/dist/rest/heartbeat-checks.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class HeartbeatChecks {
+    constructor(api) {
+        this.api = api;
+    }
+    get(id) {
+        return this.api.get(`/v1/checks/${id}`, {
+            transformResponse: (data) => {
+                const { heartbeat: { pingUrl }, name } = JSON.parse(data);
+                return { pingUrl, name };
+            },
+        });
+    }
+}
+exports.default = HeartbeatChecks;
+//# sourceMappingURL=heartbeat-checks.js.map

package/dist/rest/heartbeat-checks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"heartbeat-checks.js","sourceRoot":"","sources":["../../src/rest/heartbeat-checks.ts"],"names":[],"mappings":";;AAOA,MAAM,eAAe;IAEnB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,GAAG,CAAE,EAAU;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,cAAc,EAAE,EAAE,EAAE;YACtD,iBAAiB,EAAE,CAAC,IAAS,EAAE,EAAE;gBAC/B,MAAM,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBACzD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;YAC1B,CAAC;SACF,CAAC,CAAA;IACJ,CAAC;CACF;AAED,kBAAe,eAAe,CAAA"}

package/dist/rest/locations.d.ts

@@ -0,0 +1,11 @@
+import type { AxiosInstance } from 'axios';
+export interface Location {
+    name: string;
+    region: string;
+}
+declare class Locations {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    getAll(): Promise<import("axios").AxiosResponse<Location[], any>>;
+}
+export default Locations;

package/dist/rest/locations.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Locations {
+    constructor(api) {
+        this.api = api;
+    }
+    getAll() {
+        return this.api.get('/v1/locations');
+    }
+}
+exports.default = Locations;
+//# sourceMappingURL=locations.js.map

package/dist/rest/locations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locations.js","sourceRoot":"","sources":["../../src/rest/locations.ts"],"names":[],"mappings":";;AAOA,MAAM,SAAS;IAEb,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAkB,eAAe,CAAC,CAAA;IACvD,CAAC;CACF;AAED,kBAAe,SAAS,CAAA"}

package/dist/rest/private-locations.d.ts

@@ -0,0 +1,10 @@
+import type { AxiosInstance } from 'axios';
+export interface PrivateLocationApi {
+    id: string;
+    slugName: string;
+}
+export default class PrivateLocations {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    getAll(): Promise<import("axios").AxiosResponse<PrivateLocationApi[], any>>;
+}

package/dist/rest/private-locations.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PrivateLocations {
+    constructor(api) {
+        this.api = api;
+    }
+    getAll() {
+        return this.api.get('/v1/private-locations');
+    }
+}
+exports.default = PrivateLocations;
+//# sourceMappingURL=private-locations.js.map

package/dist/rest/private-locations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-locations.js","sourceRoot":"","sources":["../../src/rest/private-locations.ts"],"names":[],"mappings":";;AAOA,MAAqB,gBAAgB;IAEnC,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAA4B,uBAAuB,CAAC,CAAA;IACzE,CAAC;CACF;AATD,mCASC"}

package/dist/rest/projects.d.ts

@@ -0,0 +1,46 @@
+import type { AxiosInstance } from 'axios';
+import type { GitInformation } from '../services/util';
+export interface Project {
+    name: string;
+    logicalId: string;
+    repoUrl?: string;
+}
+type ProjectResponse = Project & {
+    id: string;
+    created_at: string;
+};
+export interface Change {
+    logicalId: string;
+    physicalId?: string | number;
+    type: string;
+    action: string;
+}
+export interface ResourceSync {
+    logicalId: string;
+    physicalId?: string | number;
+    type: string;
+    member: boolean;
+    payload: any;
+}
+export interface ProjectSync {
+    project: Project;
+    resources: Array<ResourceSync>;
+    repoInfo: GitInformation | null;
+}
+export interface ProjectDeployResponse {
+    project: Project;
+    diff: Array<Change>;
+}
+declare class Projects {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    getAll(): Promise<import("axios").AxiosResponse<ProjectResponse[], any>>;
+    get(id: string): Promise<import("axios").AxiosResponse<ProjectResponse, any>>;
+    create(project: Project): Promise<import("axios").AxiosResponse<any, any>>;
+    deleteProject(logicalId: string): Promise<import("axios").AxiosResponse<any, any>>;
+    deploy(resources: ProjectSync, { dryRun, scheduleOnDeploy }?: {
+        dryRun?: boolean | undefined;
+        scheduleOnDeploy?: boolean | undefined;
+    }): Promise<import("axios").AxiosResponse<ProjectDeployResponse, any>>;
+}
+export default Projects;

package/dist/rest/projects.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("./util");
+class Projects {
+    constructor(api) {
+        this.api = api;
+    }
+    getAll() {
+        return this.api.get('/next/projects');
+    }
+    get(id) {
+        return this.api.get(`/next/projects/${id}`);
+    }
+    create(project) {
+        return this.api.post('/next/projects', project);
+    }
+    deleteProject(logicalId) {
+        return this.api.delete(`/next/projects/${logicalId}`);
+    }
+    deploy(resources, { dryRun = false, scheduleOnDeploy = true } = {}) {
+        return this.api.post(`/next-v2/projects/deploy?dryRun=${dryRun}&scheduleOnDeploy=${scheduleOnDeploy}`, resources, { transformRequest: util_1.compressJSONPayload });
+    }
+}
+exports.default = Projects;
+//# sourceMappingURL=projects.js.map

package/dist/rest/projects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"projects.js","sourceRoot":"","sources":["../../src/rest/projects.ts"],"names":[],"mappings":";;AAEA,iCAA4C;AAmC5C,MAAM,QAAQ;IAEZ,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAyB,gBAAgB,CAAC,CAAA;IAC/D,CAAC;IAED,GAAG,CAAE,EAAU;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAkB,kBAAkB,EAAE,EAAE,CAAC,CAAA;IAC9D,CAAC;IAED,MAAM,CAAE,OAAgB;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;IACjD,CAAC;IAED,aAAa,CAAE,SAAiB;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,kBAAkB,SAAS,EAAE,CAAC,CAAA;IACvD,CAAC;IAED,MAAM,CAAE,SAAsB,EAAE,EAAE,MAAM,GAAG,KAAK,EAAE,gBAAgB,GAAG,IAAI,EAAE,GAAG,EAAE;QAC9E,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAClB,mCAAmC,MAAM,qBAAqB,gBAAgB,EAAE,EAChF,SAAS,EACT,EAAE,gBAAgB,EAAE,0BAAmB,EAAE,CAC1C,CAAA;IACH,CAAC;CACF;AAED,kBAAe,QAAQ,CAAA"}

package/dist/rest/runtimes.d.ts

@@ -0,0 +1,16 @@
+import type { AxiosInstance } from 'axios';
+export interface Runtime {
+    name: string;
+    stage?: string;
+    runtimeEndOfLife?: string;
+    description?: string;
+    dependencies: Record<string, string>;
+    multiStepSupport?: boolean;
+}
+declare class Runtimes {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    getAll(): Promise<import("axios").AxiosResponse<Runtime[], any>>;
+    get(runtimeId: string): Promise<import("axios").AxiosResponse<Runtime, any>>;
+}
+export default Runtimes;

package/dist/rest/runtimes.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Runtimes {
+    constructor(api) {
+        this.api = api;
+    }
+    getAll() {
+        return this.api.get('/v1/runtimes');
+    }
+    get(runtimeId) {
+        return this.api.get(`/v1/runtimes/${runtimeId}`);
+    }
+}
+exports.default = Runtimes;
+//# sourceMappingURL=runtimes.js.map

package/dist/rest/runtimes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtimes.js","sourceRoot":"","sources":["../../src/rest/runtimes.ts"],"names":[],"mappings":";;AAWA,MAAM,QAAQ;IAEZ,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAiB,cAAc,CAAC,CAAA;IACrD,CAAC;IAED,GAAG,CAAE,SAAiB;QACpB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAU,gBAAgB,SAAS,EAAE,CAAC,CAAA;IAC3D,CAAC;CACF;AAED,kBAAe,QAAQ,CAAA"}

package/dist/rest/test-sessions.d.ts

@@ -0,0 +1,59 @@
+import type { AxiosInstance } from 'axios';
+import { GitInformation } from '../services/util';
+import { RetryStrategy } from '../constructs';
+type RunTestSessionRequest = {
+    name: string;
+    checkRunJobs: any[];
+    project: {
+        logicalId: string;
+    };
+    runLocation: string | {
+        type: 'PUBLIC';
+        region: string;
+    } | {
+        type: 'PRIVATE';
+        slugName: string;
+        id: string;
+    };
+    repoInfo?: GitInformation | null;
+    environment?: string | null;
+    shouldRecord: boolean;
+};
+type TriggerTestSessionRequest = {
+    name: string;
+    runLocation: string | {
+        type: 'PUBLIC';
+        region: string;
+    } | {
+        type: 'PRIVATE';
+        slugName: string;
+        id: string;
+    };
+    shouldRecord: boolean;
+    targetTags: string[][];
+    checkRunSuiteId: string;
+    environmentVariables: Array<{
+        key: string;
+        value: string;
+    }>;
+    repoInfo: GitInformation | null;
+    environment: string | null;
+    testRetryStrategy: RetryStrategy | null;
+};
+export type TestResultsShortLinks = {
+    testResultLink: string;
+    testTraceLinks: string[];
+    videoLinks: string[];
+    screenshotLinks: string[];
+};
+declare class TestSessions {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    run(payload: RunTestSessionRequest): Promise<import("axios").AxiosResponse<any, any>>;
+    trigger(payload: TriggerTestSessionRequest): Promise<import("axios").AxiosResponse<any, any>>;
+    getShortLink(id: string): Promise<import("axios").AxiosResponse<{
+        link: string;
+    }, any>>;
+    getResultShortLinks(testSessionId: string, testResultId: string): Promise<import("axios").AxiosResponse<TestResultsShortLinks, any>>;
+}
+export default TestSessions;

package/dist/rest/test-sessions.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("./util");
+class TestSessions {
+    constructor(api) {
+        this.api = api;
+    }
+    run(payload) {
+        return this.api.post('/next/test-sessions/run', payload, {
+            transformRequest: util_1.compressJSONPayload,
+        });
+    }
+    trigger(payload) {
+        return this.api.post('/next/test-sessions/trigger', payload);
+    }
+    getShortLink(id) {
+        return this.api.get(`/next/test-sessions/${id}/link`);
+    }
+    getResultShortLinks(testSessionId, testResultId) {
+        return this.api.get(`/next/test-sessions/${testSessionId}/results/${testResultId}/links`);
+    }
+}
+exports.default = TestSessions;
+//# sourceMappingURL=test-sessions.js.map

package/dist/rest/test-sessions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-sessions.js","sourceRoot":"","sources":["../../src/rest/test-sessions.ts"],"names":[],"mappings":";;AAGA,iCAA4C;AA+B5C,MAAM,YAAY;IAEhB,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,GAAG,CAAE,OAA8B;QACjC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,yBAAyB,EAAE,OAAO,EAAE;YACvD,gBAAgB,EAAE,0BAAmB;SACtC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,CAAE,OAAkC;QACzC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAA;IAC9D,CAAC;IAED,YAAY,CAAE,EAAU;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAmB,uBAAuB,EAAE,OAAO,CAAC,CAAA;IACzE,CAAC;IAED,mBAAmB,CAAE,aAAqB,EAAE,YAAoB;QAC9D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAwB,uBAAuB,aAAa,YAAY,YAAY,QAAQ,CAAC,CAAA;IAClH,CAAC;CACF;AAED,kBAAe,YAAY,CAAA"}

package/dist/rest/users.d.ts

@@ -0,0 +1,12 @@
+import type { AxiosInstance } from 'axios';
+export interface User {
+    id: string;
+    name: string;
+    nickname?: string;
+}
+declare class Users {
+    api: AxiosInstance;
+    constructor(api: AxiosInstance);
+    get(): Promise<import("axios").AxiosResponse<User, any>>;
+}
+export default Users;

package/dist/rest/users.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Users {
+    constructor(api) {
+        this.api = api;
+    }
+    get() {
+        return this.api.get('/next/users/me');
+    }
+}
+exports.default = Users;
+//# sourceMappingURL=users.js.map

package/dist/rest/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../src/rest/users.ts"],"names":[],"mappings":";;AAQA,MAAM,KAAK;IAET,YAAa,GAAkB;QAC7B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,GAAG;QACD,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAO,gBAAgB,CAAC,CAAA;IAC7C,CAAC;CACF;AAED,kBAAe,KAAK,CAAA"}

package/dist/rest/util.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="node" />
+import zlib from 'node:zlib';
+import { AxiosRequestHeaders } from 'axios';
+export declare function compressJSONPayload(data: any, headers: AxiosRequestHeaders): zlib.Gzip;

package/dist/rest/util.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compressJSONPayload = void 0;
+const node_zlib_1 = __importDefault(require("node:zlib"));
+const json_stream_stringify_1 = require("json-stream-stringify");
+function compressJSONPayload(data, headers) {
+    headers['Content-Type'] = 'application/json';
+    headers['Content-Encoding'] = 'gzip';
+    const zipper = node_zlib_1.default.createGzip();
+    const streamer = new json_stream_stringify_1.JsonStreamStringify(data);
+    return streamer.pipe(zipper);
+}
+exports.compressJSONPayload = compressJSONPayload;
+//# sourceMappingURL=util.js.map

package/dist/rest/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/rest/util.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA4B;AAG5B,iEAA2D;AAE3D,SAAgB,mBAAmB,CAAE,IAAS,EAAE,OAA4B;IAC1E,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAA;IAC5C,OAAO,CAAC,kBAAkB,CAAC,GAAG,MAAM,CAAA;IAEpC,MAAM,MAAM,GAAG,mBAAI,CAAC,UAAU,EAAE,CAAA;IAChC,MAAM,QAAQ,GAAG,IAAI,2CAAmB,CAAC,IAAI,CAAC,CAAA;IAE9C,OAAO,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAC9B,CAAC;AARD,kDAQC"}

package/dist/services/abstract-check-runner.d.ts

@@ -0,0 +1,60 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import PQueue from 'p-queue';
+import { EventEmitter } from 'node:events';
+import type { Region } from '..';
+export declare enum Events {
+    CHECK_REGISTERED = "CHECK_REGISTERED",
+    CHECK_INPROGRESS = "CHECK_INPROGRESS",
+    CHECK_ATTEMPT_RESULT = "CHECK_ATTEMPT_RESULT",
+    CHECK_FAILED = "CHECK_FAILED",
+    CHECK_SUCCESSFUL = "CHECK_SUCCESSFUL",
+    CHECK_FINISHED = "CHECK_FINISHED",
+    RUN_STARTED = "RUN_STARTED",
+    RUN_FINISHED = "RUN_FINISHED",
+    ERROR = "ERROR",
+    MAX_SCHEDULING_DELAY_EXCEEDED = "MAX_SCHEDULING_DELAY_EXCEEDED"
+}
+export type PrivateRunLocation = {
+    type: 'PRIVATE';
+    id: string;
+    slugName: string;
+};
+export type PublicRunLocation = {
+    type: 'PUBLIC';
+    region: keyof Region;
+};
+export type RunLocation = PublicRunLocation | PrivateRunLocation;
+export type CheckRunId = string;
+export type SequenceId = string;
+export declare const DEFAULT_CHECK_RUN_TIMEOUT_SECONDS = 600;
+export default abstract class AbstractCheckRunner extends EventEmitter {
+    checks: Map<SequenceId, {
+        check: any;
+    }>;
+    testSessionId?: string;
+    timeouts: Map<SequenceId, NodeJS.Timeout>;
+    schedulingDelayExceededTimeout?: NodeJS.Timeout;
+    accountId: string;
+    timeout: number;
+    verbose: boolean;
+    queue: PQueue;
+    constructor(accountId: string, timeout: number, verbose: boolean);
+    abstract scheduleChecks(checkRunSuiteId: string): Promise<{
+        testSessionId?: string;
+        checks: Array<{
+            check: any;
+            sequenceId: SequenceId;
+        }>;
+    }>;
+    run(): Promise<void>;
+    private configureResultListener;
+    private processMessage;
+    processCheckResult(result: any): Promise<void>;
+    private allChecksFinished;
+    private setAllTimeouts;
+    private disableAllTimeouts;
+    private startSchedulingDelayTimeout;
+    private disableTimeout;
+    private getShortLinks;
+}

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

@@ -0,0 +1,225 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_CHECK_RUN_TIMEOUT_SECONDS = exports.Events = void 0;
+const api_1 = require("../rest/api");
+const socket_client_1 = require("./socket-client");
+const p_queue_1 = __importDefault(require("p-queue"));
+const uuid = __importStar(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_ATTEMPT_RESULT"] = "CHECK_ATTEMPT_RESULT";
+    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["MAX_SCHEDULING_DELAY_EXCEEDED"] = "MAX_SCHEDULING_DELAY_EXCEEDED";
+})(Events || (exports.Events = Events = {}));
+exports.DEFAULT_CHECK_RUN_TIMEOUT_SECONDS = 600;
+const DEFAULT_SCHEDULING_DELAY_EXCEEDED_MS = 20000;
+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, sequenceId }) => [sequenceId, { check }]));
+            // `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();
+            // Add timeout to fire an event after DEFAULT_SCHEDULING_DELAY_EXCEEDED_MS to let reporters know it's time
+            // to display a hint messages if some checks are still being scheduled.
+            this.startSchedulingDelayTimeout();
+            // `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();
+            /// / Need to structure the checks depending on how it went
+            this.emit(Events.RUN_STARTED, checks, testSessionId);
+            // Start the queue after the test session run rest call is completed to avoid race conditions
+            this.queue.start();
+            await allChecksFinished;
+            this.emit(Events.RUN_FINISHED, testSessionId);
+        }
+        catch (err) {
+            this.disableAllTimeouts();
+            this.emit(Events.ERROR, err);
+        }
+        finally {
+            if (socketClient) {
+                await socketClient.endAsync();
+            }
+        }
+    }
+    async configureResultListener(checkRunSuiteId, socketClient) {
+        socketClient.on('message', (topic, rawMessage) => {
+            const message = JSON.parse(rawMessage.toString('utf8'));
+            const topicComponents = topic.split('/');
+            const sequenceId = topicComponents[4];
+            const checkRunId = topicComponents[5];
+            const subtopic = topicComponents[6];
+            this.queue.add(() => this.processMessage(sequenceId, subtopic, message));
+        });
+        await socketClient.subscribeAsync(`account/${this.accountId}/ad-hoc-check-results/${checkRunSuiteId}/+/+/+`);
+    }
+    async processMessage(sequenceId, subtopic, message) {
+        if (!sequenceId) {
+            // There should always be a sequenceId, but let's have an early return to make forwards-compatibility easier.
+            return;
+        }
+        if (!this.timeouts.has(sequenceId)) {
+            // The check has already timed out. We return early to avoid reporting a duplicate result.
+            return;
+        }
+        if (!this.checks.get(sequenceId)) {
+            return;
+        }
+        const { check } = this.checks.get(sequenceId);
+        if (subtopic === 'run-start') {
+            this.emit(Events.CHECK_INPROGRESS, check, sequenceId);
+        }
+        else if (subtopic === 'result') {
+            const { result, testResultId, resultType } = message;
+            await this.processCheckResult(result);
+            const links = testResultId && result.hasFailures && await this.getShortLinks(testResultId);
+            if (resultType === 'FINAL') {
+                this.disableTimeout(sequenceId);
+                this.emit(Events.CHECK_SUCCESSFUL, sequenceId, check, result, testResultId, links);
+                this.emit(Events.CHECK_FINISHED, check);
+            }
+            else if (resultType === 'ATTEMPT') {
+                this.emit(Events.CHECK_ATTEMPT_RESULT, sequenceId, check, result, links);
+            }
+        }
+        else if (subtopic === 'error') {
+            this.disableTimeout(sequenceId);
+            this.emit(Events.CHECK_FAILED, sequenceId, check, message);
+            this.emit(Events.CHECK_FINISHED, check);
+        }
+    }
+    async processCheckResult(result) {
+        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);
+        }
+    }
+    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(([sequenceId, { check }]) => this.timeouts.set(sequenceId, setTimeout(() => {
+            this.timeouts.delete(sequenceId);
+            let errorMessage = `Reached timeout of ${this.timeout} seconds waiting for check result.`;
+            // Checkly should always report a result within 240s.
+            // If the default timeout was used, we should point the user to the status page and support email.
+            if (this.timeout === exports.DEFAULT_CHECK_RUN_TIMEOUT_SECONDS) {
+                errorMessage += ' Checkly may be experiencing problems. Please check https://is.checkly.online or reach out to support@checklyhq.com.';
+            }
+            this.emit(Events.CHECK_FAILED, sequenceId, check, errorMessage);
+            this.emit(Events.CHECK_FINISHED, check);
+        }, this.timeout * 1000)));
+    }
+    disableAllTimeouts() {
+        if (!this.checks) {
+            return;
+        }
+        Array.from(this.checks.entries()).forEach(([checkRunId]) => this.disableTimeout(checkRunId));
+        if (this.schedulingDelayExceededTimeout) {
+            clearTimeout(this.schedulingDelayExceededTimeout);
+            this.schedulingDelayExceededTimeout = undefined;
+        }
+    }
+    startSchedulingDelayTimeout() {
+        let scheduledCheckCount = 0;
+        const numChecks = this.checks.size;
+        if (numChecks === 0) {
+            return;
+        }
+        this.schedulingDelayExceededTimeout = setTimeout(() => {
+            this.emit(Events.MAX_SCHEDULING_DELAY_EXCEEDED);
+            this.schedulingDelayExceededTimeout = undefined;
+        }, DEFAULT_SCHEDULING_DELAY_EXCEEDED_MS);
+        this.on(Events.CHECK_INPROGRESS, () => {
+            scheduledCheckCount++;
+            if (scheduledCheckCount === numChecks)
+                clearTimeout(this.schedulingDelayExceededTimeout);
+        });
+    }
+    disableTimeout(timeoutKey) {
+        const timeout = this.timeouts.get(timeoutKey);
+        clearTimeout(timeout);
+        this.timeouts.delete(timeoutKey);
+    }
+    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,sDAA4B;AAC5B,2CAA4B;AAC5B,6CAA0C;AAK1C,gDAAgD;AAChD,IAAY,MAWX;AAXD,WAAY,MAAM;IAChB,+CAAqC,CAAA;IACrC,+CAAqC,CAAA;IACrC,uDAA6C,CAAA;IAC7C,uCAA6B,CAAA;IAC7B,+CAAqC,CAAA;IACrC,2CAAiC,CAAA;IACjC,qCAA2B,CAAA;IAC3B,uCAA6B,CAAA;IAC7B,yBAAe,CAAA;IACf,yEAA+D,CAAA;AACjE,CAAC,EAXW,MAAM,sBAAN,MAAM,QAWjB;AAgBY,QAAA,iCAAiC,GAAG,GAAG,CAAA;AAEpD,MAAM,oCAAoC,GAAG,KAAK,CAAA;AAElD,MAA8B,mBAAoB,SAAQ,0BAAY;IAYpE,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,CAAC;YACH,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,EAAE,EAAE,CAAC,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,CAC/D,CAAA;YAED,gGAAgG;YAChG,sFAAsF;YACtF,kGAAkG;YAClG,0GAA0G;YAC1G,IAAI,CAAC,cAAc,EAAE,CAAA;YACrB,0GAA0G;YAC1G,uEAAuE;YACvE,IAAI,CAAC,2BAA2B,EAAE,CAAA;YAClC,4FAA4F;YAC5F,0GAA0G;YAC1G,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;YAClD,2DAA2D;YAC3D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,CAAA;YACpD,6FAA6F;YAC7F,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;YAElB,MAAM,iBAAiB,CAAA;YACvB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,CAAA;QAC/C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,kBAAkB,EAAE,CAAA;YACzB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;QAC9B,CAAC;gBAAS,CAAC;YACT,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,QAAQ,EAAE,CAAA;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,uBAAuB,CAAE,eAAuB,EAAE,YAAwB;QACtF,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,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,cAAc,CAAC,WAAW,IAAI,CAAC,SAAS,yBAAyB,eAAe,QAAQ,CAAC,CAAA;IAC9G,CAAC;IAEO,KAAK,CAAC,cAAc,CAAE,UAAsB,EAAE,QAAgB,EAAE,OAAY;QAClF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,6GAA6G;YAC7G,OAAM;QACR,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACnC,0FAA0F;YAC1F,OAAM;QACR,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,OAAM;QACR,CAAC;QAED,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAE,CAAA;QAC9C,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,KAAK,EAAE,UAAU,CAAC,CAAA;QACvD,CAAC;aAAM,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;YACjC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;YACpD,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;YACrC,MAAM,KAAK,GAAG,YAAY,IAAI,MAAM,CAAC,WAAW,IAAI,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAA;YAC1F,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;gBAC3B,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAA;gBAC/B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,gBAAgB,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,CAAA;gBAClF,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,KAAK,CAAC,CAAA;YACzC,CAAC;iBAAM,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBACpC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;YAC1E,CAAC;QACH,CAAC;aAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YAChC,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;QACzC,CAAC;IACH,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAE,MAAW;QACnC,MAAM,EACJ,MAAM,EACN,OAAO,EACP,gBAAgB,GACjB,GAAG,MAAM,CAAC,MAAM,CAAA;QACjB,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YACpD,MAAM,CAAC,IAAI,GAAG,MAAM,YAAM,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACrD,CAAC;QACD,IAAI,gBAAgB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7D,MAAM,CAAC,YAAY,GAAG,MAAM,YAAM,CAAC,eAAe,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;QAC9E,CAAC;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,CAAC;YACpB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;QAC1B,CAAC;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,YAAY,GAAG,sBAAsB,IAAI,CAAC,OAAO,oCAAoC,CAAA;YACzF,qDAAqD;YACrD,kGAAkG;YAClG,IAAI,IAAI,CAAC,OAAO,KAAK,yCAAiC,EAAE,CAAC;gBACvD,YAAY,IAAI,sHAAsH,CAAA;YACxI,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;YAC/D,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,CAAC;YACjB,OAAM;QACR,CAAC;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;QAE5F,IAAI,IAAI,CAAC,8BAA8B,EAAE,CAAC;YACxC,YAAY,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAA;YACjD,IAAI,CAAC,8BAA8B,GAAG,SAAS,CAAA;QACjD,CAAC;IACH,CAAC;IAEO,2BAA2B;QACjC,IAAI,mBAAmB,GAAG,CAAC,CAAA;QAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAA;QAClC,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;YACpB,OAAM;QACR,CAAC;QACD,IAAI,CAAC,8BAA8B,GAAG,UAAU,CAC9C,GAAG,EAAE;YACH,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,6BAA6B,CAAC,CAAA;YAC/C,IAAI,CAAC,8BAA8B,GAAG,SAAS,CAAA;QACjD,CAAC,EACD,oCAAoC,CACrC,CAAA;QACD,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,gBAAgB,EAAE,GAAG,EAAE;YACpC,mBAAmB,EAAE,CAAA;YACrB,IAAI,mBAAmB,KAAK,SAAS;gBAAE,YAAY,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAA;QAC1F,CAAC,CAAC,CAAA;IACJ,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,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;gBACxB,OAAM;YACR,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,kBAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAA;YAChG,OAAO,KAAK,CAAA;QACd,CAAC;QAAC,MAAM,CAAC;QACT,CAAC;IACH,CAAC;CACF;AAvND,sCAuNC"}