@api-client/core 0.3.0

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

@@ -0,0 +1,178 @@
+import { EventEmitter } from 'events';
+import { Kind as ProjectFolderKind } from '../../models/ProjectFolder.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 ProjectRunner 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) {
+            info.error = true;
+            info.errorMessage = e.message;
+            this.emit('error', request.key, { ...requestData }, 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=ProjectRunner.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ProjectRunner.js","sourceRoot":"","sources":["../../../../src/runtime/node/ProjectRunner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAKtC,OAAO,EAAiB,IAAI,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAIzF,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,aAAc,SAAQ,YAAY;IAC7C,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,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,IAAI,CAAC,YAAY,GAAI,CAAW,CAAC,OAAO,CAAC;YACzC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,WAAW,EAAE,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;SACxE;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"}

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

@@ -0,0 +1,139 @@
+import { IRequest } from '../../models/Request.js';
+import { IHttpRequest } from '../../models/HttpRequest.js';
+import { IRequestConfig } from '../../models/RequestConfig.js';
+import { IRequestAuthorization } from '../../models/RequestAuthorization.js';
+import { IRequestActions } from '../../models/RequestActions.js';
+import { IRequestCertificate } from '../../models/ClientCertificate.js';
+import { IRequestLog } from '../../models/RequestLog.js';
+import { VariablesProcessor } from '../variables/VariablesProcessor.js';
+import { IRunnableAction } from '../../models/actions/RunnableAction.js';
+import { HttpEngineOptions } from '../http-engine/HttpEngine.js';
+import { ExecutionContext, RegistryPermission } from '../modules/ModulesRegistry.js';
+import { Logger } from '../../lib/logging/Logger.js';
+/**
+ * The main class to make HTTP requests in the API Client / ARC.
+ * This factory includes all logic components to perform the entire HTTP request lifecycle. This includes:
+ *
+ * - variables evaluation on the request object
+ * - running request actions
+ * - running request modules
+ * - choosing the execution engine
+ * - performing the request
+ * - running response actions
+ * - running response modules
+ * - reporting the response
+ *
+ * This class may not be used when not necessary but the logic should take care of the items listed above.
+ *
+ * This class splits the `IRequest` object into it's components and use them when defined.
+ * This way it is possible to use the factory only with the `IHttpRequest` interface.
+ */
+export declare class RequestFactory {
+    /**
+     * The main events bus.
+     * This target is used to dispatch the events on.
+     * The runtime should handle the events and proxy them to the corresponding context store.
+     */
+    eventTarget: EventTarget;
+    /**
+     * Request processing configuration.
+     */
+    config?: IRequestConfig;
+    /**
+     * Request authorization configuration
+     */
+    authorization?: IRequestAuthorization[];
+    /**
+     * Actions to be performed when the request is executed.
+     */
+    actions?: IRequestActions;
+    /**
+     * The list of certificates to use with the request.
+     */
+    certificates?: IRequestCertificate[];
+    /**
+     * The cumulative list of all variables to be applied to the request and other properties.
+     * The variables must be already processed for variables in values (evaluated).
+     *
+     * These variables are passed by reference. Changes made anywhere to the variables will result
+     * with updating this list.
+     */
+    variables?: Record<string, string>;
+    /**
+     * The variables processor instance.
+     */
+    variablesProcessor: VariablesProcessor;
+    logger?: Logger;
+    /**
+     * Creates an instance from the IRequest object with setting the corresponding variables.
+     * @param eventTarget The main events bus.
+     * This target is used to dispatch the events on.
+     * The runtime should handle the events and proxy them to the corresponding context store.
+     * @param request The request object to use.
+     */
+    static fromRequest(eventTarget: EventTarget, request: IRequest): RequestFactory;
+    /**
+     * @param eventTarget The main events bus.
+     * This target is used to dispatch the events on.
+     * The runtime should handle the events and proxy them to the corresponding context store.
+     */
+    constructor(eventTarget: EventTarget);
+    /**
+     * Runs the request and all tasks around the HTTp request execution like gathering
+     * environment information, running actions, and HTTP modules.
+     *
+     * @param request The request object to execute.
+     * @returns The execution log.
+     */
+    run(request: IHttpRequest): Promise<IRequestLog>;
+    /**
+     * @returns the configuration processed by the variables processor.
+     */
+    readConfig(): Promise<IRequestConfig | undefined>;
+    /**
+     * @returns the authorization data processed by the variables processor.
+     */
+    readAuthorization(): Promise<IRequestAuthorization[] | undefined>;
+    /**
+     * @returns the actions for the passed type processed by the variables processor.
+     */
+    readActions(type: keyof IRequestActions): Promise<IRunnableAction[] | undefined>;
+    /**
+     * Prepares the request object before making the HTTP request
+     * and runs actions and modules.
+     *
+     * @param request The request to execute.
+     * @returns the copy of the request object.
+     */
+    processRequest(request: IHttpRequest): Promise<IHttpRequest>;
+    /**
+     * Runs the request through the variables processor.
+     * @returns A copy of the passed request with possibly changed values.
+     */
+    processRequestVariables(request: IHttpRequest): Promise<IHttpRequest>;
+    /**
+     * Executes the request actions and modules.
+     */
+    processRequestLogic(request: IHttpRequest): Promise<void>;
+    /**
+     * Runs each action one by one.
+     * @param request The request object associated with actions
+     * @param actions The list of actions to execute.
+     */
+    processRequestActions(request: IHttpRequest, actions: IRunnableAction[]): Promise<void>;
+    processRequestModules(request: IHttpRequest): Promise<void>;
+    /**
+     * Prepares the HTTP engine configuration and executes the request,
+     * @param request The request to execute.
+     * @returns The execution log.
+     */
+    executeRequest(request: IHttpRequest): Promise<IRequestLog>;
+    /**
+     * Creates a configuration options for the HTTP engine.
+     */
+    prepareEngineConfig(): Promise<HttpEngineOptions>;
+    processResponse(log: IRequestLog): Promise<void>;
+    processResponseActions(log: IRequestLog): Promise<void>;
+    processResponseModules(log: IRequestLog): Promise<void>;
+    buildExecutionContext(permissions: RegistryPermission[]): Promise<ExecutionContext>;
+}