@api-client/core 0.3.4 → 0.3.7

package/build/src/runtime/node/ProjectParallelRunner.d.ts

@@ -0,0 +1,81 @@
+/// <reference types="node" />
+import { Worker } from 'cluster';
+import { HttpProject, IHttpProject } from '../../models/HttpProject.js';
+import { IProjectRunnerOptions } from './ProjectRunner.js';
+import { IProjectExecutionLog } from '../reporters/Reporter.js';
+import { BaseRunner } from './BaseRunner.js';
+export declare type WorkerStatus = 'initializing' | 'ready' | 'running' | 'finished' | 'error';
+export interface IWorkerInfo {
+    /**
+     * Whether the worker is online.
+     */
+    online: boolean;
+    /**
+     * The number of iterations the worker is performing.
+     */
+    iterations: number;
+    /**
+     * The current status of the worker.
+     */
+    status: WorkerStatus;
+    /**
+     * Optional error message received from the worker.
+     */
+    message?: string;
+}
+interface WorkerInfoInternal extends IWorkerInfo {
+    worker: Worker;
+}
+export interface IWorkerMessage {
+    cmd: string;
+    data?: unknown;
+}
+export interface IProjectParallelRunnerOptions extends IProjectRunnerOptions {
+}
+export interface IProjectParallelWorkerOptions extends IProjectRunnerOptions {
+    project: IHttpProject;
+}
+export interface ProjectParallelRunner {
+    /**
+     * Dispatched when a status of a worker change.
+     * This can be used to render the current status.
+     */
+    on(event: 'status', listener: (info: IWorkerInfo[]) => void): this;
+    /**
+     * Dispatched when a status of a worker change.
+     * This can be used to render the current status.
+     */
+    once(event: 'status', listener: (info: IWorkerInfo[]) => void): this;
+}
+/**
+ * Runs a project in parallel.
+ * It creates a number of workers determined by the number of CPUs available on the current machine
+ * and the number of iterations defined in the configuration options.
+ *
+ * When the number of iterations is greater then the number of CPUs then
+ * the program distributes the remaining iterations among created workers.
+ *
+ * The program dispatched the `status` event. It is dispatched each time when the worker status
+ * change. This event can be user to refresh the UI to reflect the newest state.
+ */
+export declare class ProjectParallelRunner extends BaseRunner {
+    project: HttpProject;
+    options: IProjectParallelRunnerOptions;
+    workers: WorkerInfoInternal[];
+    private mainResolver?;
+    private mainRejecter?;
+    constructor(project: HttpProject, opts?: IProjectParallelRunnerOptions);
+    execute(): Promise<IProjectExecutionLog>;
+    private _execute;
+    private getStatusWorkers;
+    private distributeIterations;
+    private setupWorker;
+    private _messageHandler;
+    private _exitHandler;
+    private setOnline;
+    private setRunResult;
+    private runWhenReady;
+    private finishWhenReady;
+    private setRunError;
+}
+export {};

package/build/src/runtime/node/ProjectParallelRunner.js

@@ -0,0 +1,173 @@
+import cluster from 'cluster';
+import { cpus } from 'os';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { BaseRunner } from './BaseRunner.js';
+const numCPUs = cpus().length;
+const __dirname = dirname(fileURLToPath(import.meta.url));
+/**
+ * Runs a project in parallel.
+ * It creates a number of workers determined by the number of CPUs available on the current machine
+ * and the number of iterations defined in the configuration options.
+ *
+ * When the number of iterations is greater then the number of CPUs then
+ * the program distributes the remaining iterations among created workers.
+ *
+ * The program dispatched the `status` event. It is dispatched each time when the worker status
+ * change. This event can be user to refresh the UI to reflect the newest state.
+ */
+export class ProjectParallelRunner extends BaseRunner {
+    project;
+    options;
+    workers = [];
+    mainResolver;
+    mainRejecter;
+    constructor(project, opts = {}) {
+        super();
+        this.project = project;
+        this.options = opts || {};
+        this._exitHandler = this._exitHandler.bind(this);
+    }
+    execute() {
+        return new Promise((resolve, reject) => {
+            this.mainResolver = resolve;
+            this.mainRejecter = reject;
+            this._execute();
+        });
+    }
+    _execute() {
+        try {
+            cluster.setupPrimary({
+                exec: join(__dirname, 'ProjectRunnerWorker.js'),
+                silent: true,
+            });
+            const { iterations = 1 } = this.options;
+            const poolSize = Math.min(iterations, numCPUs);
+            for (let i = 0; i < poolSize; i++) {
+                const worker = cluster.fork();
+                this.setupWorker(worker);
+            }
+            this.distributeIterations();
+            this.emit('status', this.getStatusWorkers());
+            cluster.on('exit', this._exitHandler);
+        }
+        catch (e) {
+            const cause = e;
+            this.mainRejecter(cause);
+        }
+    }
+    getStatusWorkers() {
+        const { workers } = this;
+        const result = [];
+        workers.forEach((info) => {
+            const cp = { ...info };
+            delete cp.worker;
+            result.push(cp);
+        });
+        return result;
+    }
+    distributeIterations() {
+        const workers = this.workers.length;
+        const { iterations = 1 } = this.options;
+        let iterationsRemaining = iterations - workers;
+        let currentIndex = 0;
+        while (iterationsRemaining > 0) {
+            this.workers[currentIndex].iterations += 1;
+            iterationsRemaining--;
+            currentIndex++;
+            if (currentIndex + 1 === workers) {
+                currentIndex = 0;
+            }
+        }
+    }
+    setupWorker(worker) {
+        this.workers.push({
+            worker,
+            online: false,
+            iterations: 1,
+            status: 'initializing',
+        });
+        worker.on('message', this._messageHandler.bind(this, worker));
+    }
+    _messageHandler(worker, message) {
+        switch (message.cmd) {
+            case 'online':
+                this.setOnline(worker);
+                break;
+            case 'result':
+                this.setRunResult(worker, message);
+                break;
+            case 'error':
+                this.setRunError(worker, message);
+                break;
+        }
+    }
+    _exitHandler(worker) {
+        const info = this.workers.find(i => i.worker === worker);
+        if (!info) {
+            return;
+        }
+        this.finishWhenReady();
+    }
+    setOnline(worker) {
+        const info = this.workers.find(i => i.worker === worker);
+        if (!info) {
+            return;
+        }
+        info.online = true;
+        info.status = 'ready';
+        this.runWhenReady();
+        this.emit('status', this.getStatusWorkers());
+    }
+    setRunResult(worker, message) {
+        const reports = message.data;
+        this.executed = this.executed.concat(reports);
+        worker.destroy();
+        const info = this.workers.find(i => i.worker === worker);
+        if (!info) {
+            return;
+        }
+        info.status = 'finished';
+        this.emit('status', this.getStatusWorkers());
+    }
+    runWhenReady() {
+        const waiting = this.workers.some(i => !i.online);
+        if (waiting) {
+            return;
+        }
+        this.startTime = Date.now();
+        this.workers.forEach((info) => {
+            const opts = { ...this.options, project: this.project.toJSON() };
+            opts.iterations = info.iterations;
+            info.status = 'running';
+            info.worker.send({
+                cmd: 'run',
+                data: opts,
+            });
+        });
+    }
+    async finishWhenReady() {
+        if (this.endTime) {
+            return;
+        }
+        const working = this.workers.some(i => !['finished', 'error'].includes(i.status));
+        if (working || !this.mainResolver) {
+            return;
+        }
+        this.endTime = Date.now();
+        const report = await this.createReport();
+        this.mainResolver(report);
+        cluster.off('exit', this._exitHandler);
+    }
+    setRunError(worker, message) {
+        worker.destroy();
+        const info = this.workers.find(i => i.worker === worker);
+        if (!info) {
+            return;
+        }
+        info.status = 'error';
+        info.message = message.data;
+        this.emit('status', this.getStatusWorkers());
+    }
+}
+//# sourceMappingURL=ProjectParallelRunner.js.map

package/build/src/runtime/node/ProjectParallelRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectParallelRunner.js","sourceRoot":"","sources":["../../../../src/runtime/node/ProjectParallelRunner.ts"],"names":[],"mappings":"AAAA,OAAO,OAAmB,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAIpC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,MAAM,OAAO,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC;AAC9B,MAAM,SAAS,GAAG,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAoD1D;;;;;;;;;;GAUG;AACH,MAAM,OAAO,qBAAsB,SAAQ,UAAU;IACnD,OAAO,CAAc;IACrB,OAAO,CAAgC;IACvC,OAAO,GAAyB,EAAE,CAAC;IAC3B,YAAY,CAA0C;IACtD,YAAY,CAAwB;IAE5C,YAAY,OAAoB,EAAE,OAAsC,EAAE;QACxE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;QAE1B,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,OAAO;QACL,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;YAC5B,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;YAC3B,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,QAAQ;QACd,IAAI;YACF,OAAO,CAAC,YAAY,CAAC;gBACnB,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,wBAAwB,CAAC;gBAC/C,MAAM,EAAE,IAAI;aACb,CAAC,CAAC;YACH,MAAM,EAAE,UAAU,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;YACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC,EAAE,EAAE;gBACjC,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;gBAC9B,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;aAC1B;YACD,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC5B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;YAC7C,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;SACvC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,IAAI,CAAC,YAAa,CAAC,KAAK,CAAC,CAAC;SAC3B;IACH,CAAC;IAEO,gBAAgB;QACtB,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,MAAM,GAAkB,EAAE,CAAC;QACjC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACvB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,EAAS,CAAC;YAC9B,OAAO,EAAE,CAAC,MAAM,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,oBAAoB;QAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACpC,MAAM,EAAE,UAAU,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACxC,IAAI,mBAAmB,GAAG,UAAU,GAAG,OAAO,CAAC;QAC/C,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,OAAO,mBAAmB,GAAG,CAAC,EAAE;YAC9B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC;YAC3C,mBAAmB,EAAE,CAAC;YACtB,YAAY,EAAE,CAAC;YACf,IAAI,YAAY,GAAG,CAAC,KAAK,OAAO,EAAE;gBAChC,YAAY,GAAG,CAAC,CAAC;aAClB;SACF;IACH,CAAC;IAEO,WAAW,CAAC,MAAc;QAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;YAChB,MAAM;YACN,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,CAAC;YACb,MAAM,EAAE,cAAc;SACvB,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAChE,CAAC;IAEO,eAAe,CAAC,MAAc,EAAE,OAAuB;QAC7D,QAAQ,OAAO,CAAC,GAAG,EAAE;YACnB,KAAK,QAAQ;gBAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAAC,MAAM;YAC7C,KAAK,QAAQ;gBAAE,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAAC,MAAM;YACzD,KAAK,OAAO;gBAAE,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAAC,MAAM;SACxD;IACH,CAAC;IAEO,YAAY,CAAC,MAAc;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QACD,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAEO,SAAS,CAAC,MAAc;QAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC/C,CAAC;IAEO,YAAY,CAAC,MAAc,EAAE,OAAuB;QAC1D,MAAM,OAAO,GAAG,OAAO,CAAC,IAAoC,CAAC;QAC7D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9C,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QACD,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC/C,CAAC;IAEO,YAAY;QAClB,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,OAAO,EAAE;YACX,OAAO;SACR;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC5B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC5B,MAAM,IAAI,GAAkC,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YAChG,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;YAClC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;YACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACf,GAAG,EAAE,KAAK;gBACV,IAAI,EAAE,IAAI;aACX,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,eAAe;QAC3B,IAAI,IAAI,CAAC,OAAO,EAAE;YAChB,OAAO;SACR;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;QAClF,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE;YACjC,OAAO;SACR;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACzC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC;IAEO,WAAW,CAAC,MAAc,EAAE,OAAuB;QACzD,MAAM,CAAC,OAAO,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,EAAE;YACT,OAAO;SACR;QACD,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,IAAc,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAC/C,CAAC;CACF"}

package/build/src/runtime/node/ProjectRequestRunner.d.ts

@@ -0,0 +1,125 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { Environment } from '../../models/Environment.js';
+import { Logger } from '../../lib/logging/Logger.js';
+import { IRequestLog } from '../../models/RequestLog.js';
+import { ProjectFolder } from '../../models/ProjectFolder.js';
+import { ProjectRequest } from '../../models/ProjectRequest.js';
+import { IHttpRequest } from '../../models/HttpRequest.js';
+import { HttpProject, IProjectRequestIterator } from '../../models/HttpProject.js';
+import { VariablesProcessor } from '../variables/VariablesProcessor.js';
+export interface ProjectRunnerOptions {
+    /**
+     * When provided it overrides any project / folder defined environment.
+     */
+    environment?: Environment;
+    /**
+     * Additional variables to pass to the selected environment.
+     * This can be use to pass system variables, when needed.
+     *
+     * To use system variables tou can use `init.variables = process.env`;
+     */
+    variables?: Record<string, string>;
+    /**
+     * Overrides the default logger (console).
+     */
+    logger?: Logger;
+    /**
+     * The event target to use.
+     * By default it creates its own target.
+     */
+    eventTarget?: EventTarget;
+}
+export interface ProjectRunnerRunOptions extends IProjectRequestIterator {
+}
+export interface RunResult {
+    /**
+     * The key of the request from the HttpProject that was executed.
+     */
+    key: string;
+    /**
+     * The key of parent folder of the executed request.
+     */
+    parent?: string;
+    /**
+     * Set when a fatal error occurred so the request couldn't be executed.
+     * This is not the same as error reported during a request. The log's response can still be IResponseError.
+     */
+    error?: boolean;
+    /**
+     * The error message. Always set when the `error` is `true`.
+     */
+    errorMessage?: string;
+    /**
+     * The request log.
+     * Always set when the `error` is `false`.
+     */
+    log?: IRequestLog;
+}
+export interface ProjectRequestRunner {
+    /**
+     * The request object is prepared and about to be sent to the HTTP engine
+     */
+    on(event: 'request', listener: (key: string, request: IHttpRequest) => void): this;
+    /**
+     * The response is ready.
+     */
+    on(event: 'response', listener: (key: string, log: IRequestLog) => void): this;
+    /**
+     * There was a general error during the request
+     */
+    on(event: 'error', listener: (key: string, log: IRequestLog, message: string) => void): this;
+    /**
+     * The request object is prepared and about to be sent to the HTTP engine
+     */
+    once(event: 'request', listener: (key: string, request: IHttpRequest) => void): this;
+    /**
+     * The response is ready.
+     */
+    once(event: 'response', listener: (key: string, log: IRequestLog) => void): this;
+    /**
+     * There was a general error during the request
+     */
+    once(event: 'error', listener: (key: string, log: IRequestLog, message: string) => void): this;
+}
+/**
+ * Runs requests in a project.
+ * Developers can run the entire project with the `recursive` flag set. They can also
+ * set the starting point with the `parent` options.
+ *
+ * Requests are executed in order defined in the folder.
+ */
+export declare class ProjectRequestRunner extends EventEmitter {
+    eventTarget: EventTarget;
+    logger?: Logger;
+    project: HttpProject;
+    protected masterEnvironment?: Environment;
+    protected extraVariables?: Record<string, string>;
+    /**
+     * The variables processor instance.
+     */
+    protected variablesProcessor: VariablesProcessor;
+    constructor(project: HttpProject, opts?: ProjectRunnerOptions);
+    /**
+     * Runs the request from the project root or a specified folder.
+     * @param options Run options.
+     * @returns A promise with the run result.
+     */
+    run(options?: ProjectRunnerRunOptions): Promise<RunResult[]>;
+    protected execute(request: ProjectRequest, variables: Record<string, string>): Promise<RunResult>;
+    protected getVariables(parent: HttpProject | ProjectFolder): Promise<Record<string, string>>;
+    protected createEnvironment(parent: HttpProject | ProjectFolder): Promise<Record<string, string>>;
+    /**
+     * Reads the list of the environments to apply to this runtime.
+     */
+    protected readEnvironments(parent: HttpProject | ProjectFolder): Promise<Environment[]>;
+    /**
+     * Reads the variables and the base URI from the passed environments.
+     */
+    protected applyVariables(environments: Environment[]): Promise<Record<string, string>>;
+    /**
+     * When defined it applies the serve's base URI to relative URLs.
+     * @param currentUrl The URL to process.
+     */
+    protected prepareRequestUrl(currentUrl: string, variables: Record<string, string>): string;
+}

package/build/src/runtime/node/ProjectRequestRunner.js

@@ -0,0 +1,185 @@
+import { EventEmitter } from 'events';
+import { RequestLog } from '../../models/RequestLog.js';
+import { Kind as ProjectFolderKind } from '../../models/ProjectFolder.js';
+import { SentRequest } from '../../models/SentRequest.js';
+import { ErrorResponse } from '../../models/ErrorResponse.js';
+import { VariablesStore } from './VariablesStore.js';
+import { VariablesProcessor } from '../variables/VariablesProcessor.js';
+import { RequestFactory } from './RequestFactory.js';
+import { EventTypes } from '../../events/EventTypes.js';
+/**
+ * Runs requests in a project.
+ * Developers can run the entire project with the `recursive` flag set. They can also
+ * set the starting point with the `parent` options.
+ *
+ * Requests are executed in order defined in the folder.
+ */
+export class ProjectRequestRunner extends EventEmitter {
+    eventTarget;
+    logger;
+    project;
+    masterEnvironment;
+    extraVariables;
+    /**
+     * The variables processor instance.
+     */
+    variablesProcessor = new VariablesProcessor();
+    constructor(project, opts = {}) {
+        super();
+        this.project = project;
+        this.logger = opts.logger;
+        this.eventTarget = opts.eventTarget || new EventTarget();
+        this.masterEnvironment = opts.environment;
+        this.extraVariables = opts.variables;
+    }
+    /**
+     * Runs the request from the project root or a specified folder.
+     * @param options Run options.
+     * @returns A promise with the run result.
+     */
+    async run(options) {
+        const { project } = this;
+        const executed = [];
+        for (const request of project.requestIterator(options)) {
+            const parent = request.getParent() || project;
+            let variables;
+            if (VariablesStore.has(parent)) {
+                variables = VariablesStore.get(parent);
+            }
+            else {
+                variables = await this.getVariables(parent);
+                VariablesStore.set(parent, variables);
+            }
+            const info = await this.execute(request, variables);
+            executed.push(info);
+        }
+        return executed;
+    }
+    async execute(request, variables) {
+        const config = request.getConfig();
+        const factory = new RequestFactory(this.eventTarget);
+        factory.variables = variables;
+        if (request.authorization) {
+            factory.authorization = request.authorization.map(i => i.toJSON());
+        }
+        if (request.actions) {
+            factory.actions = request.actions.toJSON();
+        }
+        if (request.clientCertificate) {
+            factory.certificates = [request.clientCertificate];
+        }
+        if (config.enabled !== false) {
+            factory.config = config.toJSON();
+        }
+        if (this.logger) {
+            factory.logger = this.logger;
+        }
+        const info = {
+            key: request.key,
+        };
+        const requestData = request.expects.toJSON();
+        requestData.url = this.prepareRequestUrl(requestData.url, variables);
+        function variableHandler(e) {
+            if (e.defaultPrevented) {
+                return;
+            }
+            const { name, value } = e.detail;
+            variables[name] = value;
+            e.preventDefault();
+            e.detail.result = Promise.resolve();
+        }
+        this.eventTarget.addEventListener(EventTypes.Environment.set, variableHandler);
+        try {
+            // Below replaces the single call to the `run()` function of the factory to 
+            // report via the events a request object that has evaluated with the Jexl library.
+            const requestCopy = await factory.processRequestVariables(requestData);
+            this.emit('request', request.key, { ...requestCopy });
+            await factory.processRequestLogic(requestCopy);
+            const result = await factory.executeRequest(requestCopy);
+            await factory.processResponse(result);
+            request.setLog(result);
+            info.log = result;
+            this.emit('response', request.key, { ...result });
+        }
+        catch (e) {
+            const cause = e;
+            info.error = true;
+            info.errorMessage = cause.message;
+            const sent = new SentRequest({ ...requestData, startTime: 0, endTime: 0, });
+            const response = ErrorResponse.fromError(info.errorMessage);
+            const log = RequestLog.fromRequestResponse(sent.toJSON(), response.toJSON()).toJSON();
+            this.emit('error', request.key, log, info.errorMessage);
+        }
+        this.eventTarget.removeEventListener(EventTypes.Environment.set, variableHandler);
+        return info;
+    }
+    async getVariables(parent) {
+        if (this.masterEnvironment) {
+            return this.applyVariables([this.masterEnvironment]);
+        }
+        return this.createEnvironment(parent);
+    }
+    async createEnvironment(parent) {
+        const envs = await this.readEnvironments(parent);
+        return this.applyVariables(envs);
+    }
+    /**
+     * Reads the list of the environments to apply to this runtime.
+     */
+    async readEnvironments(parent) {
+        const folderKey = parent.kind === ProjectFolderKind ? parent.key : undefined;
+        return this.project.readEnvironments({ folderKey });
+    }
+    /**
+     * Reads the variables and the base URI from the passed environments.
+     */
+    async applyVariables(environments) {
+        let baseUri = '';
+        const variables = [];
+        environments.forEach((environment) => {
+            const { server, variables: envVariables } = environment;
+            if (server) {
+                baseUri = server.readUri();
+            }
+            if (envVariables.length) {
+                envVariables.forEach((item) => {
+                    const defined = variables.findIndex(i => i.name === item.name);
+                    if (defined >= 0) {
+                        variables[defined] = item;
+                    }
+                    else {
+                        variables.push(item);
+                    }
+                });
+            }
+        });
+        const { extraVariables } = this;
+        const ctx = VariablesProcessor.createContextFromProperties(variables);
+        if (extraVariables) {
+            Object.keys(extraVariables).forEach((key) => {
+                ctx[key] = extraVariables[key];
+            });
+        }
+        // the `baseUri` is reserved and always set to the environment's `baseUri`.
+        ctx.baseUri = baseUri || '';
+        return this.variablesProcessor.buildContext(ctx);
+    }
+    /**
+     * When defined it applies the serve's base URI to relative URLs.
+     * @param currentUrl The URL to process.
+     */
+    prepareRequestUrl(currentUrl, variables) {
+        const { baseUri } = variables;
+        if (!baseUri) {
+            return currentUrl;
+        }
+        if (currentUrl.startsWith('http:') || currentUrl.startsWith('https:')) {
+            return currentUrl;
+        }
+        if (currentUrl.startsWith('/')) {
+            return `${baseUri}${currentUrl}`;
+        }
+        return `${baseUri}/${currentUrl}`;
+    }
+}
+//# sourceMappingURL=ProjectRequestRunner.js.map

package/build/src/runtime/node/ProjectRequestRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectRequestRunner.js","sourceRoot":"","sources":["../../../../src/runtime/node/ProjectRequestRunner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAe,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAErE,OAAO,EAAiB,IAAI,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAIzF,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAgFxD;;;;;;GAMG;AACH,MAAM,OAAO,oBAAqB,SAAQ,YAAY;IACpD,WAAW,CAAc;IACzB,MAAM,CAAU;IAChB,OAAO,CAAc;IAEX,iBAAiB,CAAe;IAChC,cAAc,CAA0B;IAElD;;OAEG;IACO,kBAAkB,GAAG,IAAI,kBAAkB,EAAE,CAAC;IAExD,YAAY,OAAoB,EAAE,OAA6B,EAAE;QAC/D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,WAAW,EAAE,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,OAAiC;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACzB,MAAM,QAAQ,GAAgB,EAAE,CAAC;QACjC,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE;YACtD,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,IAAI,OAAO,CAAC;YAC9C,IAAI,SAAiC,CAAC;YACtC,IAAI,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC9B,SAAS,GAAG,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;aACxC;iBAAM;gBACL,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;gBAC5C,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;aACvC;YACD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACpD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACrB;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,OAAuB,EAAE,SAAiC;QAChF,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAErD,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;QAC9B,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;SACpE;QACD,IAAI,OAAO,CAAC,OAAO,EAAE;YACnB,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;SAC5C;QACD,IAAI,OAAO,CAAC,iBAAiB,EAAE;YAC7B,OAAO,CAAC,YAAY,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;SACpD;QACD,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;YAC5B,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;SAClC;QACD,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;SAC9B;QACD,MAAM,IAAI,GAAc;YACtB,GAAG,EAAE,OAAO,CAAC,GAAG;SACjB,CAAC;QACF,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAC7C,WAAW,CAAC,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAErE,SAAS,eAAe,CAAC,CAAc;YACrC,IAAI,CAAC,CAAC,gBAAgB,EAAE;gBACtB,OAAO;aACR;YACD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC;YACjC,SAAS,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;YACxB,CAAC,CAAC,cAAc,EAAE,CAAC;YACnB,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,eAAsB,CAAC,CAAC;QAEtF,IAAI;YACF,4EAA4E;YAC5E,mFAAmF;YACnF,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;YACvE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC;YACtD,MAAM,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;YAC/C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;YACzD,MAAM,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;YACtC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACvB,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;SACnD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC;YAClC,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,EAAE,GAAG,WAAW,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;YAC5E,MAAM,QAAQ,GAAG,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC5D,MAAM,GAAG,GAAG,UAAU,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YACtF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;SACzD;QAED,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,eAAsB,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC;IACd,CAAC;IAES,KAAK,CAAC,YAAY,CAAC,MAAmC;QAC9D,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;SACtD;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAES,KAAK,CAAC,iBAAiB,CAAC,MAAmC;QACnE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,gBAAgB,CAAC,MAAmC;QAClE,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,KAAK,iBAAiB,CAAC,CAAC,CAAE,MAAwB,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QAChG,OAAO,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,cAAc,CAAC,YAA2B;QACxD,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,MAAM,SAAS,GAAe,EAAE,CAAC;QACjC,YAAY,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;YACnC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC;YACxD,IAAI,MAAM,EAAE;gBACV,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;aAC5B;YACD,IAAI,YAAY,CAAC,MAAM,EAAE;gBACvB,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC5B,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC/D,IAAI,OAAO,IAAI,CAAC,EAAE;wBAChB,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;qBAC3B;yBAAM;wBACL,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;qBACtB;gBACH,CAAC,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QACH,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;QAChC,MAAM,GAAG,GAAG,kBAAkB,CAAC,2BAA2B,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,cAAc,EAAE;YAClB,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC1C,GAAG,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC;SACJ;QACD,2EAA2E;QAC3E,GAAG,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACO,iBAAiB,CAAC,UAAkB,EAAE,SAAiC;QAC/E,MAAM,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;QAC9B,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,UAAU,CAAC;SACnB;QACD,IAAI,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;YACrE,OAAO,UAAU,CAAC;SACnB;QACD,IAAI,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YAC9B,OAAO,GAAG,OAAO,GAAG,UAAU,EAAE,CAAC;SAClC;QACD,OAAO,GAAG,OAAO,IAAI,UAAU,EAAE,CAAC;IACpC,CAAC;CACF"}