@api-client/core 0.5.26 → 0.6.0

package/src/mocking/legacy/Http.ts

@@ -1,15 +1,14 @@
-import { Http as Base, Types, Lorem, Time, HttpRequestInit } from '@pawel-up/data-mock';
-import { randomValue } from '@pawel-up/data-mock/build/src/lib/Http.js';
+import { Http as Base, Types, Lorem, Time, IHttpRequestInit, Random } from '@pawel-up/data-mock';
 import { ArcDataMockInit } from '../LegacyInterfaces.js';
 import { HttpResponse } from './HttpResponse.js';
 import { ARCHistoryRequest, ARCSavedRequest, TransportRequest } from '../../models/legacy/request/ArcRequest.js';
 import { ARCProject } from '../../models/legacy/models/ArcLegacyProject.js';
 
-export interface RequestHistoryInit extends HttpRequestInit {
+export interface RequestHistoryInit extends IHttpRequestInit {
   noId?: boolean;
 }
 
-export interface RequestSavedInit extends HttpRequestInit {
+export interface RequestSavedInit extends IHttpRequestInit {
   forceDescription?: boolean;
   noDescription?: boolean;
   project?: string;
@@ -33,7 +32,7 @@ export declare interface GenerateSavedResult {
   requests: ARCSavedRequest[];
 }
 
-export interface TransportRequestInit extends HttpRequestInit {
+export interface TransportRequestInit extends IHttpRequestInit {
   noHttpMessage?: boolean;
 }
 
@@ -41,9 +40,12 @@ export class Http extends Base {
   LAST_TIME: number;
   types: Types;
   lorem: Lorem;
+  // @ts-ignore
   response: HttpResponse;
   time: Time;
 
+  protected _random: Random;
+
   constructor(init: ArcDataMockInit={}) {
     super(init);
     this.LAST_TIME = Date.now();
@@ -51,10 +53,11 @@ export class Http extends Base {
     this.lorem = new Lorem(init);
     this.response = new HttpResponse(init);
     this.time = new Time(init);
+    this._random = new Random(init.seed);
   }
 
   history(opts: RequestHistoryInit={}): ARCHistoryRequest {
-    const base = this.request(opts);
+    const base = this.request.request(opts);
     this.LAST_TIME -= this.types.datetime().getTime();
     const midnight = this.time.midnight(this.LAST_TIME);
 
@@ -72,7 +75,7 @@ export class Http extends Base {
   }
 
   saved(opts: RequestSavedInit={}): ARCSavedRequest {
-    const base = this.request(opts);
+    const base = this.request.request(opts);
     const time = this.types.datetime().getTime();
     const requestName = this.lorem.words(2);
     const description = this.description(opts);
@@ -165,7 +168,7 @@ export class Http extends Base {
       allow = this.types.boolean();
     }
     if (allow) {
-      return this[randomValue].pickOne(opts.projects);
+      return this._random.pickOne(opts.projects);
     }
     return undefined;
   }
@@ -214,7 +217,7 @@ export class Http extends Base {
    * @returns The transport request object
    */
   transportRequest(opts: TransportRequestInit={}): TransportRequest {
-    const base = this.request(opts);
+    const base = this.request.request(opts);
     const request: TransportRequest = {
       ...base,
       startTime: Date.now() - 1000,

package/src/mocking/legacy/HttpResponse.ts

@@ -1,4 +1,4 @@
-import { HttpResponse as Base, headersValue, payloadValue, typesValue, loremValue } from '@pawel-up/data-mock/build/src/lib/http/HttpResponse.js';
+import Base, { headersValue, payloadValue, typesValue, loremValue } from '@pawel-up/data-mock/build/src/lib/http/Response.js';
 import { Har, DataMockLocale } from '@pawel-up/data-mock';
 import { ArcDataMockInit, HttpResponseArcInit, HttpResponseRedirectInit } from '../LegacyInterfaces.js';
 import { ResponseRedirect, Response, ErrorResponse } from '../../models/legacy/request/ArcResponse.js';
@@ -36,7 +36,7 @@ export class HttpResponse extends Base {
     const url = this[headersValue].link();
     headers += `\nlocation: ${url}`;
     const { code, status } = this.redirectStatus(init);
-    const body = init.body ? this[payloadValue].payload(ct) : undefined;
+    const body = init.body ? this[payloadValue].payload(ct as string) : undefined;
     const startTime = this[typesValue].datetime().getTime();
     const duration = this[typesValue].number({ min: 10, max: 4000 });
     const result: ResponseRedirect = {
@@ -60,7 +60,7 @@ export class HttpResponse extends Base {
 
   arcResponse(init: HttpResponseArcInit = {}): Response {
     const ct = init.noBody ? undefined : this[headersValue].contentType();
-    const body = init.noBody ? undefined : this[payloadValue].payload(ct);
+    const body = init.noBody ? undefined : this[payloadValue].payload(ct as string);
     const headers = this[headersValue].headers('response', { mime: ct });
     const statusGroup = init.statusGroup ? init.statusGroup : this[typesValue].number({ min: 2, max: 5 });
     const sCode = this[typesValue].number({ min: 0, max: 99 }).toString();

package/src/mocking/lib/History.ts

@@ -1,4 +1,4 @@
-import { Internet, Types, DataMockInit, Person, Random, TypeDateTimeInit } from '@pawel-up/data-mock';
+import { Internet, Types, IDataMockInit, Person, Random, ITypeDateTimeInit } from '@pawel-up/data-mock';
 // import { randomValue } from '@pawel-up/data-mock/src/lib/Http.js';
 import { IHttpHistory, Kind as HttpHistoryKind } from '../../models/HttpHistory.js';
 import { Request, IRequestLogInit } from './Request.js';
@@ -32,7 +32,7 @@ export interface IHttpHistoryInit {
   /**
    * The created time init options.
    */
-  created?: TypeDateTimeInit;
+  created?: ITypeDateTimeInit;
 }
 
 export interface IHttpHistoryListInit extends IHttpHistoryInit {
@@ -70,7 +70,7 @@ export class History {
   random: Random;
   request: Request;
 
-  constructor(init: DataMockInit={}) {
+  constructor(init: IDataMockInit={}) {
     this.person = new Person(init);
     this.types = new Types(init.seed);
     this.internet = new Internet(init);
@@ -78,12 +78,12 @@ export class History {
     this.request = new Request(init);
   }
 
-  httpHistory(init: IHttpHistoryInit = {}): IHttpHistory {
+  async httpHistory(init: IHttpHistoryInit = {}): Promise<IHttpHistory> {
     const date = this.types.datetime(init.created);
     const result: IHttpHistory = {
       kind: HttpHistoryKind,
       created: date.getTime(),
-      log: this.request.log(init.log),
+      log: await this.request.log(init.log),
       user: '',
     }
     date.setHours(0, 0, 0, 0);
@@ -131,7 +131,7 @@ export class History {
     return result;
   }
 
-  httpHistoryList(size=25, init: IHttpHistoryListInit = {}): IHttpHistory[] {
+  async httpHistoryList(size=25, init: IHttpHistoryListInit = {}): Promise<IHttpHistory[]> {
     const { usersSize, spacesSize, projectsSize, requestsSize, appsSize } = init;
     const copy = { ...init };
     if (usersSize && typeof init.user === 'undefined') {
@@ -172,7 +172,7 @@ export class History {
 
     const result: IHttpHistory[] = [];
     for (let i = 0; i < size; i++) {
-      result.push(this.httpHistory(copy));
+      result.push(await this.httpHistory(copy));
     }
     return result;
   }

package/src/mocking/lib/Request.ts

@@ -1,4 +1,4 @@
-import { Http, Types, Lorem, Time, DataMockInit, HttpRequestInit } from '@pawel-up/data-mock';
+import { Http, Types, Lorem, Time, IDataMockInit, IHttpRequestInit } from '@pawel-up/data-mock';
 // import { randomValue } from '@pawel-up/data-mock/src/lib/Http.js';
 import { IHttpRequest, Kind as HttpRequestKind } from '../../models/HttpRequest.js';
 import { IRequest, Kind as RequestKind } from '../../models/Request.js';
@@ -7,7 +7,7 @@ import { IRequestLog, Kind as RequestLogKind } from '../../models/RequestLog.js'
 import { IResponseInit, Response } from './Response.js';
 
 export interface IRequestLogInit {
-  request?: HttpRequestInit;
+  request?: IHttpRequestInit;
   response?: IResponseInit;
   /**
    * When set it ignores size information
@@ -21,6 +21,14 @@ export interface IRequestLogInit {
   noRequest?: boolean;
 }
 
+export interface IRequestInit extends IResponseInit {
+  /**
+   * The content type to generate the body for.
+   * Has no effect when `noBody` is set.
+   */
+  contentType?: string;
+}
+
 export class Request {
   types: Types;
   lorem: Lorem;
@@ -28,7 +36,7 @@ export class Request {
   http: Http;
   response: Response;
 
-  constructor(init: DataMockInit={}) {
+  constructor(init: IDataMockInit={}) {
     this.types = new Types(init.seed);
     this.lorem = new Lorem(init);
     this.time = new Time(init);
@@ -36,7 +44,7 @@ export class Request {
     this.response = new Response(init);
   }
 
-  request(init?: HttpRequestInit): IRequest {
+  request(init?: IHttpRequestInit): IRequest {
     return {
       kind: RequestKind,
       expects: this.httpRequest(init),
@@ -47,15 +55,15 @@ export class Request {
     }
   }
 
-  httpRequest(init?: HttpRequestInit): IHttpRequest {
-    const request = this.http.request(init);
+  httpRequest(init?: IHttpRequestInit): IHttpRequest {
+    const request = this.http.request.request(init);
     return {
       kind: HttpRequestKind,
       ...request,
     }
   }
 
-  sentRequest(init?: HttpRequestInit): ISentRequest {
+  sentRequest(init?: IHttpRequestInit): ISentRequest {
     const start = this.time.timestamp();
     return {
       startTime: start,
@@ -64,7 +72,7 @@ export class Request {
     };
   }
 
-  log(init: IRequestLogInit = {}): IRequestLog {
+  async log(init: IRequestLogInit = {}): Promise<IRequestLog> {
     const result: IRequestLog = {
       kind: RequestLogKind,
     };
@@ -72,10 +80,10 @@ export class Request {
       result.request = this.sentRequest(init.request);
     }
     if (!init.noResponse) {
-      result.response = this.response.response(init.response);
+      result.response = await this.response.response(init.response);
     }
     if (init.redirects) {
-      result.redirects = this.response.redirects();
+      result.redirects = await this.response.redirects();
     }
     if (!init.noSize) {
       result.size = this.response.size();

package/src/mocking/lib/Response.ts

@@ -1,14 +1,11 @@
-import { Http, Har, Types, Lorem, Time, DataMockInit, HttpResponseInit, HarTimingInit, Internet } from '@pawel-up/data-mock';
-import { IHttpResponse, Kind as HttpResponseKind } from '../../models/HttpResponse.js';
+import { Http, Har, Types, Lorem, Time, IDataMockInit, IHttpResponseInit, IHarTimingInit, Internet, IHttpPayloadInit } from '@pawel-up/data-mock';
+import { IHttpResponse, HttpResponse, Kind as HttpResponseKind } from '../../models/HttpResponse.js';
 import { IResponse, Kind as ResponseKind } from '../../models/Response.js';
 import { IRequestsSize } from '../../models/RequestsSize.js';
 import { IResponseRedirect, Kind as ResponseRedirectKind  } from '../../models/ResponseRedirect.js';
+import { DeserializedPayload } from '../../lib/transformers/PayloadSerializer.js';
 
-export interface IResponseInit extends HttpResponseInit, HarTimingInit {
-  /**
-   * When set it does not generate a response payload.
-   */
-  noBody?: boolean;
+export interface IResponseInit extends IHttpResponseInit, IHarTimingInit {
   /**
    * The first number of the status group. Other 2 are auto generated
    */
@@ -27,7 +24,7 @@ export class Response {
   har: Har;
   internet: Internet;
 
-  constructor(init: DataMockInit={}) {
+  constructor(init: IDataMockInit={}) {
     this.types = new Types(init.seed);
     this.lorem = new Lorem(init);
     this.time = new Time(init);
@@ -36,10 +33,21 @@ export class Response {
     this.internet = new Internet(init);
   }
 
-  httpResponse(init: IResponseInit = {}): IHttpResponse {
-    const ct = init.noBody ? undefined : this.http.headers.contentType();
-    const body = init.noBody ? undefined : this.http.payload.payload(ct);
-    const headers = this.http.headers.headers('response', { mime: ct });
+  protected _getPayload(mime?: string): DeserializedPayload {
+    if (mime) {
+      return undefined;
+    }
+    switch (mime) {
+      case 'multipart/form-data': return this.http.formData.form();
+      default:
+        return this.http.payload.payload(mime as string);
+    }
+  }
+
+  async httpResponse(init: IResponseInit = {}): Promise<IHttpResponse> {
+    const mime = this.http.headers.contentType(init.payload as IHttpPayloadInit);
+    const body = this._getPayload(mime);
+    const headers = this.http.headers.headers('response', { mime: mime });
     const statusGroup = init.statusGroup ? init.statusGroup : this.types.number({ min: 2, max: 5 });
     const sCode = this.types.number({ min: 0, max: 99 }).toString();
     const code = Number(`${statusGroup}${sCode.padStart(2, '0')}`);
@@ -50,14 +58,15 @@ export class Response {
       statusText: status,
       headers,
     };
-    if (!init.noBody) {
-      result.payload = body;
+    const response = new HttpResponse(result);
+    if (body) {
+      await response.writePayload(body)
     }
-    return result;
+    return response.toJSON();
   }
 
-  response(init: IResponseInit={}): IResponse {
-    const base = this.httpResponse(init);
+  async response(init: IResponseInit={}): Promise<IResponse> {
+    const base = await this.httpResponse(init);
     const length = this.types.number({ min: 10, max: 4000 });
     const result: IResponse = {
       ...base,
@@ -78,7 +87,7 @@ export class Response {
     return result;
   }
 
-  redirect(init?: IResponseInit): IResponseRedirect {
+  async redirect(init?: IResponseInit): Promise<IResponseRedirect> {
     const start = this.time.timestamp();
     const end = this.time.timestamp({ min: start + 1 })
     const info: IResponseRedirect = {
@@ -86,16 +95,16 @@ export class Response {
       startTime: start,
       endTime: end,
       url: this.internet.uri(),
-      response: this.httpResponse({ ...init, statusGroup: 3}),
+      response: await this.httpResponse({ ...init, statusGroup: 3}),
     };
     return info;
   }
 
-  redirects(size=1, init?: IResponseInit): IResponseRedirect[] {
-    const result: IResponseRedirect[] = [];
+  async redirects(size=1, init?: IResponseInit): Promise<IResponseRedirect[]> {
+    const result: Promise<IResponseRedirect>[] = [];
     for (let i = 0; i < size; i++) {
       result.push(this.redirect(init));
     }
-    return result;
+    return Promise.all(result);
   }
 }

package/src/mocking/lib/Url.ts

@@ -1,4 +1,4 @@
-import { DataMockInit, Internet, Types } from "@pawel-up/data-mock";
+import { IDataMockInit, Internet, Types } from "@pawel-up/data-mock";
 import { IUrl } from "../../models/Url.js";
 
 /**
@@ -8,7 +8,7 @@ export class Url {
   types: Types;
   internet: Internet;
   
-  constructor(init: DataMockInit={}) {
+  constructor(init: IDataMockInit={}) {
     this.types = new Types(init.seed);
     this.internet = new Internet(init);
   }

package/src/mocking/lib/User.ts

@@ -1,5 +1,4 @@
-import { Internet, Types, DataMockInit, Person, Random } from '@pawel-up/data-mock';
-// import { randomValue } from '@pawel-up/data-mock/src/lib/Http.js';
+import { Internet, Types, IDataMockInit, Person, Random } from '@pawel-up/data-mock';
 import { IUser, Kind as UserKind } from '../../models/store/User.js';
 
 export interface IUserInit {
@@ -14,7 +13,7 @@ export class User {
   internet: Internet;
   random: Random;
 
-  constructor(init: DataMockInit={}) {
+  constructor(init: IDataMockInit={}) {
     this.person = new Person(init);
     this.types = new Types(init.seed);
     this.internet = new Internet(init);

package/src/models/RequestConfig.ts

@@ -59,6 +59,12 @@ export interface IRequestBaseConfig {
    * Whether the processor should validate certificates.
    */
   validateCertificates?: boolean;
+
+  /**
+   * Optional signal from an `AbortController`.
+   * This is populated only when executing a request. This value is opaque for the data store.
+   */
+  signal?: AbortSignal;
 }
 
 /**
@@ -150,6 +156,12 @@ export class RequestConfig {
    */
   sentMessageLimit?: number;
 
+  /**
+   * Optional signal from an `AbortController`.
+   * This is populated only when executing a request. This value is opaque for the data store.
+   */
+  signal?: AbortSignal;
+
   static withDefaults(): RequestConfig {
     return new RequestConfig({
       kind: Kind,
@@ -209,7 +221,7 @@ export class RequestConfig {
   new(init: IRequestConfig): void {
     const { 
       enabled, followRedirects, ignoreSessionCookies, validateCertificates, defaultHeaders, timeout, hosts, variables,
-      defaultAccept, defaultUserAgent, proxy, proxyPassword, proxyUsername, sentMessageLimit,
+      defaultAccept, defaultUserAgent, proxy, proxyPassword, proxyUsername, sentMessageLimit, signal,
     } = init;
     this.kind = Kind;
     if (typeof enabled === 'boolean') {
@@ -282,6 +294,11 @@ export class RequestConfig {
     } else {
       this.sentMessageLimit = undefined;
     }
+    if (signal) {
+      this.signal = signal;
+    } else {
+      this.signal = undefined;
+    }
   }
 
   toJSON(): IRequestConfig {
@@ -310,6 +327,7 @@ export class RequestConfig {
     if (Array.isArray(this.variables)) {
       result.variables = this.variables.map(i => i.toJSON());
     }
+    // DO NOT put the `signal` here.
     return result;
   }
 }

package/src/runtime/http-engine/CoreEngine.ts

@@ -74,7 +74,7 @@ export class CoreEngine extends HttpEngine {
       } else {
         await this.connect();
       }
-      if (!this.socket) {
+      if (!this.socket || this.aborted) {
         return;
       }
       const message = await this.prepareMessage();

package/src/runtime/http-engine/HttpEngine.ts

@@ -191,6 +191,31 @@ export abstract class HttpEngine extends EventEmitter {
   protected mainRejecter?: (err: SerializableError) => void;
   [mainPromiseSymbol]?: Promise<IRequestLog>;
 
+  protected _signal?: AbortSignal;
+
+  /**
+   * The abort signal to set on this request.
+   * Aborts the request when the signal fires.
+   * @type {(AbortSignal | undefined)}
+   */
+  get signal(): AbortSignal | undefined {
+    return this._signal;
+  }
+
+  set signal(value: AbortSignal | undefined) {
+    const old = this._signal;
+    if (old === value) {
+      return;
+    }
+    this._signal = value;
+    if (old) {
+      old.removeEventListener('abort', this._abortHandler);
+    }
+    if (value) {
+      value.addEventListener('abort', this._abortHandler);
+    }
+  }
+
   constructor(request: IHttpRequest, opts: HttpEngineOptions = {}) {
     super();
     this.request = new HttpRequest({ ...request });
@@ -199,6 +224,11 @@ export abstract class HttpEngine extends EventEmitter {
     this.sentRequest = new SentRequest({ ...request, startTime: Date.now() });
     this.uri = this.readUrl(request.url);
     this.hostHeader = RequestUtils.getHostHeader(request.url);
+
+    this._abortHandler = this._abortHandler.bind(this);
+    if (opts.signal) {
+      this.signal = opts.signal;
+    }
   }
 
   /**
@@ -245,6 +275,15 @@ export abstract class HttpEngine extends EventEmitter {
     this.socket = undefined;
   }
 
+  /**
+   * Handler for the `abort` event on the `AbortSignal`.
+   */
+  protected _abortHandler(): void {
+    const e = new SerializableError('Request aborted', 3);
+    this._errorRequest(e);
+    this.abort();
+  }
+
   /**
    * Sends the request.
    */

package/src/runtime/node/InteropInterfaces.ts

@@ -118,4 +118,10 @@ export interface IProjectRunnerOptions {
    * When not set it does not read system variables.
    */
   variables?: boolean | string[] | Record<string, string>;
+
+  /**
+   * Optional signal from an `AbortController`.
+   * It aborts the execution when the ``abort` event is dispatched.
+   */
+  signal?: AbortSignal;
 }

package/src/runtime/node/ProjectParallelRunner.ts

@@ -5,6 +5,7 @@ import { fileURLToPath } from 'url';
 import { HttpProject } from '../../models/HttpProject.js';
 import { IProjectExecutionLog, IProjectExecutionIteration } from '../reporters/Reporter.js';
 import { BaseRunner } from './BaseRunner.js';
+import { State } from './enums.js';
 import { IProjectParallelRunnerOptions, IProjectParallelWorkerOptions } from './InteropInterfaces.js'
 
 const numCPUs = cpus().length;
@@ -74,9 +75,13 @@ export class ProjectParallelRunner extends BaseRunner {
   constructor(project: HttpProject, opts: IProjectParallelRunnerOptions = {}) {
     super();
     this.project = project;
-    this.options = opts || {};
+    this.options = opts;
 
     this._exitHandler = this._exitHandler.bind(this);
+    this._abortHandler = this._abortHandler.bind(this);
+    if (opts.signal) {
+      this.signal = opts.signal;
+    }
   }
 
   execute(): Promise<IProjectExecutionLog> {
@@ -87,7 +92,70 @@ export class ProjectParallelRunner extends BaseRunner {
     });
   }
 
+  protected _state: State = State.Idle;
+
+  get state(): State {
+    return this._state;
+  }
+
+  protected _signal?: AbortSignal;
+
+  /**
+   * The abort signal to set on this request.
+   * Aborts the request when the signal fires.
+   * @type {(AbortSignal | undefined)}
+   */
+  get signal(): AbortSignal | undefined {
+    return this._signal;
+  }
+
+  set signal(value: AbortSignal | undefined) {
+    const old = this._signal;
+    if (old === value) {
+      return;
+    }
+    this._signal = value;
+    if (old) {
+      old.removeEventListener('abort', this._abortHandler);
+    }
+    if (value) {
+      value.addEventListener('abort', this._abortHandler);
+    }
+  }
+
+  /**
+   * Aborts the current run.
+   * The promise returned by the `execute()` method will reject if not yet resolved.
+   */
+  abort(): void {
+    this._state = State.Aborted;
+    const { workers } = this;
+    workers.forEach((info) => {
+      if (info.status !== 'error') {
+        try {
+          info.worker.destroy();
+        } catch (e) {
+          // ...
+        }
+        info.status = 'error';
+      }
+    });
+    if (this.mainRejecter) {
+      this.mainRejecter!(new Error(`The execution has been aborted.`));
+      this.mainRejecter = undefined;
+      this.mainResolver = undefined;
+    }
+  }
+
+  /**
+   * Handler for the `abort` event on the `AbortSignal`.
+   */
+  protected _abortHandler(): void {
+    this.abort();
+  }
+
   private _execute(): void {
+    this._state = State.Running as State;
     try {
       cluster.setupPrimary({
         exec: join(__dirname, 'ProjectRunnerWorker.js'),
@@ -105,6 +173,9 @@ export class ProjectParallelRunner extends BaseRunner {
     } catch (e) {
       const cause = e as Error;
       this.mainRejecter!(cause);
+      this.mainResolver = undefined
+      this.mainRejecter = undefined
+      this._state = State.Idle as State;
     }
   }
 
@@ -211,7 +282,10 @@ export class ProjectParallelRunner extends BaseRunner {
     this.endTime = Date.now();
     const report = await this.createReport();
     this.mainResolver(report);
+    this.mainResolver = undefined
+    this.mainRejecter = undefined
     cluster.off('exit', this._exitHandler);
+    this._state = State.Idle as State;
   }
 
   private setRunError(worker: Worker, message: IWorkerMessage): void {