@thymian/plugin-request-dispatcher 0.1.0

package/README.md

@@ -0,0 +1,11 @@
+# Thymian
+
+Add resilience and HTTP conformance to your API development workflow. Thymian is a lightweight, language-agnostic library that helps you build robust APIs.
+
+## @thymian/request-dispatcher
+
+HTTP request dispatching and management.
+
+## Documentation
+
+For comprehensive documentation, visit [Thymian Documentation](https://thymian.dev/).

package/dist/decode-body.d.ts

@@ -0,0 +1,3 @@
+import { Readable } from 'stream';
+export declare function decodeBody(body?: string, encoding?: string): string | Buffer | Uint8Array | Readable | null;
+//# sourceMappingURL=decode-body.d.ts.map

package/dist/decode-body.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode-body.d.ts","sourceRoot":"","sources":["../src/decode-body.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,wBAAgB,UAAU,CACxB,IAAI,CAAC,EAAE,MAAM,EACb,QAAQ,CAAC,EAAE,MAAM,GAChB,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,IAAI,CAehD"}

package/dist/decode-body.js

@@ -0,0 +1,16 @@
+import { Readable } from 'stream';
+export function decodeBody(body, encoding) {
+    if (typeof body !== 'string') {
+        return null;
+    }
+    if (!encoding) {
+        return body;
+    }
+    switch (encoding) {
+        case 'base64':
+            return Buffer.from(body, 'base64');
+        default:
+            throw new Error(`Unknown encoding ${encoding}.`);
+    }
+}
+//# sourceMappingURL=decode-body.js.map

package/dist/decode-body.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decode-body.js","sourceRoot":"","sources":["../src/decode-body.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC,MAAM,UAAU,UAAU,CACxB,IAAa,EACb,QAAiB;IAEjB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACrC;YACE,MAAM,IAAI,KAAK,CAAC,oBAAoB,QAAQ,GAAG,CAAC,CAAC;IACrD,CAAC;AACH,CAAC"}

package/dist/dispatch.d.ts

@@ -0,0 +1,8 @@
+import type { HttpRequest, HttpResponse } from '@thymian/core';
+import type { HttpMethod } from './types.js';
+export declare function isValidHttpMethod(method: string): method is HttpMethod;
+export type HttpRequestDispatchOptions = {
+    timeout: number;
+};
+export declare function dispatchHttpRequest(httpRequest: HttpRequest, options?: Partial<HttpRequestDispatchOptions>): Promise<HttpResponse>;
+//# sourceMappingURL=dispatch.d.ts.map

package/dist/dispatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispatch.d.ts","sourceRoot":"","sources":["../src/dispatch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAI/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,IAAI,UAAU,CAYtE;AAED,MAAM,MAAM,0BAA0B,GAAG;IACvC,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,wBAAsB,mBAAmB,CACvC,WAAW,EAAE,WAAW,EACxB,OAAO,GAAE,OAAO,CAAC,0BAA0B,CAAM,GAChD,OAAO,CAAC,YAAY,CAAC,CAwCvB"}

package/dist/dispatch.js

@@ -0,0 +1,46 @@
+import { request } from 'undici';
+import { decodeBody } from './decode-body.js';
+export function isValidHttpMethod(method) {
+    return [
+        'GET',
+        'POST',
+        'PUT',
+        'DELETE',
+        'PATCH',
+        'OPTIONS',
+        'HEAD',
+        'CONNECT',
+        'TRACE',
+    ].includes(method.toUpperCase());
+}
+export async function dispatchHttpRequest(httpRequest, options = {}) {
+    const opts = {
+        timeout: 5000,
+        ...options,
+    };
+    const method = httpRequest.method.toUpperCase();
+    if (!isValidHttpMethod(method)) {
+        throw new Error('Invalid HTTP method.');
+    }
+    const start = performance.now();
+    const response = await request(new URL(httpRequest.path, httpRequest.origin).toString(), {
+        method,
+        headers: httpRequest.headers,
+        body: decodeBody(httpRequest.body, httpRequest.bodyEncoding),
+        bodyTimeout: opts.timeout,
+        headersTimeout: opts.timeout,
+    });
+    const res = {
+        bodyEncoding: '',
+        duration: performance.now() - start,
+        headers: response.headers,
+        statusCode: response.statusCode,
+        trailers: response.trailers,
+    };
+    const body = await response.body.text();
+    if (body) {
+        res.body = body;
+    }
+    return res;
+}
+//# sourceMappingURL=dispatch.js.map

package/dist/dispatch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dispatch.js","sourceRoot":"","sources":["../src/dispatch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AAEjC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,OAAO;QACL,KAAK;QACL,MAAM;QACN,KAAK;QACL,QAAQ;QACR,OAAO;QACP,SAAS;QACT,MAAM;QACN,SAAS;QACT,OAAO;KACR,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;AACnC,CAAC;AAMD,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,WAAwB,EACxB,UAA+C,EAAE;IAEjD,MAAM,IAAI,GAAG;QACX,OAAO,EAAE,IAAI;QACb,GAAG,OAAO;KACX,CAAC;IAEF,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;IAEhD,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAEhC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC5B,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EACxD;QACE,MAAM;QACN,OAAO,EAAE,WAAW,CAAC,OAAO;QAC5B,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,YAAY,CAAC;QAC5D,WAAW,EAAE,IAAI,CAAC,OAAO;QACzB,cAAc,EAAE,IAAI,CAAC,OAAO;KAC7B,CACF,CAAC;IAEF,MAAM,GAAG,GAAiB;QACxB,YAAY,EAAE,EAAE;QAChB,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;QACnC,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;KAC5B,CAAC;IAEF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAExC,IAAI,IAAI,EAAE,CAAC;QACT,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;IAClB,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,12 @@
+import { type ThymianPlugin } from '@thymian/core';
+export interface HttpRequestError extends Error {
+    code: string;
+}
+export declare function isHttpRequestError(err: unknown): err is HttpRequestError;
+export type SamplerPluginOptions = {
+    concurrency?: number;
+};
+export declare const dispatcherPlugin: ThymianPlugin<SamplerPluginOptions>;
+export * from './types.js';
+export default dispatcherPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoB,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AAKrE,MAAM,WAAW,gBAAiB,SAAQ,KAAK;IAC7C,IAAI,EAAE,MAAM,CAAC;CACd;AAED,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,gBAAgB,CAExE;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,aAAa,CAAC,oBAAoB,CAwDhE,CAAC;AAEF,cAAc,YAAY,CAAC;AAC3B,eAAe,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,49 @@
+import { ThymianBaseError } from '@thymian/core';
+import PQueue from 'p-queue';
+import { dispatchHttpRequest } from './dispatch.js';
+export function isHttpRequestError(err) {
+    return err instanceof Error && 'code' in err;
+}
+export const dispatcherPlugin = {
+    name: '@thymian/plugin-request-dispatcher',
+    version: '0.x',
+    options: {
+        type: 'object',
+        properties: {
+            concurrency: { type: 'integer', nullable: true },
+        },
+    },
+    actions: {
+        listensOn: ['core.request.dispatch'],
+    },
+    events: {},
+    plugin: async (emitter, logger, opts) => {
+        const queue = new PQueue({ concurrency: opts?.concurrency ?? 10 });
+        emitter.onAction('core.close', async (_, ctx) => {
+            await queue.onIdle();
+            ctx.reply();
+        });
+        emitter.onAction('core.request.dispatch', async ({ request, options }, ctx) => {
+            try {
+                const result = await queue.add(() => dispatchHttpRequest(request, options));
+                ctx.reply(result);
+            }
+            catch (e) {
+                if (isHttpRequestError(e) && e.code === 'ECONNREFUSED') {
+                    return ctx.error(new ThymianBaseError(`Server ${request.origin} is unavailable.`, {
+                        name: 'ServerUnavailableError',
+                        ref: 'https://thymian.dev/references/errors/server-unavailable-error/',
+                    }));
+                }
+                ctx.error(new ThymianBaseError(`Error while dispatching request: ${request.method.toUpperCase()} ${request.origin}.`, {
+                    name: 'RequestDispatchError',
+                    ref: 'https://thymian.dev/references/errors/request-dispatch-error/',
+                    cause: e,
+                }));
+            }
+        });
+    },
+};
+export * from './types.js';
+export default dispatcherPlugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAsB,MAAM,eAAe,CAAC;AACrE,OAAO,MAAM,MAAM,SAAS,CAAC;AAE7B,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAMpD,MAAM,UAAU,kBAAkB,CAAC,GAAY;IAC7C,OAAO,GAAG,YAAY,KAAK,IAAI,MAAM,IAAI,GAAG,CAAC;AAC/C,CAAC;AAMD,MAAM,CAAC,MAAM,gBAAgB,GAAwC;IACnE,IAAI,EAAE,oCAAoC;IAC1C,OAAO,EAAE,KAAK;IACd,OAAO,EAAE;QACP,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE;SACjD;KACF;IACD,OAAO,EAAE;QACP,SAAS,EAAE,CAAC,uBAAuB,CAAC;KACrC;IACD,MAAM,EAAE,EAAE;IACV,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QACtC,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,IAAI,EAAE,EAAE,CAAC,CAAC;QAEnE,OAAO,CAAC,QAAQ,CAAC,YAAY,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE;YAC9C,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC;YAErB,GAAG,CAAC,KAAK,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;QAEH,OAAO,CAAC,QAAQ,CACd,uBAAuB,EACvB,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,GAAG,EAAE,EAAE;YAClC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAClC,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CACtC,CAAC;gBAEF,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACpB,CAAC;YAAC,OAAO,CAAU,EAAE,CAAC;gBACpB,IAAI,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;oBACvD,OAAO,GAAG,CAAC,KAAK,CACd,IAAI,gBAAgB,CAAC,UAAU,OAAO,CAAC,MAAM,kBAAkB,EAAE;wBAC/D,IAAI,EAAE,wBAAwB;wBAC9B,GAAG,EAAE,iEAAiE;qBACvE,CAAC,CACH,CAAC;gBACJ,CAAC;gBACD,GAAG,CAAC,KAAK,CACP,IAAI,gBAAgB,CAClB,oCAAoC,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,IAC9D,OAAO,CAAC,MACV,GAAG,EACH;oBACE,IAAI,EAAE,sBAAsB;oBAC5B,GAAG,EAAE,+DAA+D;oBACpE,KAAK,EAAE,CAAC;iBACT,CACF,CACF,CAAC;YACJ,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,cAAc,YAAY,CAAC;AAC3B,eAAe,gBAAgB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+import type { HttpRequest, HttpResponse } from '@thymian/core';
+import type { JSONSchemaType } from '@thymian/core/ajv';
+import type { Dispatcher } from 'undici';
+export declare const httpRequestSchema: JSONSchemaType<HttpRequest>;
+export declare const httpResponseSchema: JSONSchemaType<HttpResponse>;
+export type HttpMethod = Dispatcher.RequestOptions['method'];
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEzC,eAAO,MAAM,iBAAiB,EAAE,cAAc,CAAC,WAAW,CA8BzD,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,cAAc,CAAC,YAAY,CAmClD,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC"}

package/dist/types.js

@@ -0,0 +1,68 @@
+export const httpRequestSchema = {
+    type: 'object',
+    properties: {
+        origin: { type: 'string', nullable: false },
+        path: { type: 'string', nullable: false },
+        method: { type: 'string', nullable: false },
+        body: { type: 'string', nullable: true },
+        bodyEncoding: { type: 'string', nullable: true },
+        headers: {
+            type: 'object',
+            required: [],
+            nullable: true,
+            additionalProperties: {
+                oneOf: [
+                    {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                        },
+                    },
+                    {
+                        type: 'string',
+                    },
+                ],
+            },
+        },
+        timeout: { type: 'number', nullable: true },
+    },
+    required: ['origin', 'method', 'path'],
+    additionalProperties: false,
+};
+export const httpResponseSchema = {
+    type: 'object',
+    properties: {
+        statusCode: { type: 'integer', nullable: false },
+        headers: {
+            type: 'object',
+            required: [],
+            additionalProperties: {
+                oneOf: [
+                    {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                        },
+                    },
+                    {
+                        type: 'string',
+                    },
+                ],
+            },
+        },
+        body: { type: 'string', nullable: true },
+        bodyEncoding: { type: 'string', nullable: true },
+        trailers: {
+            type: 'object',
+            required: [],
+            additionalProperties: {
+                type: 'string',
+                nullable: false,
+            },
+        },
+        duration: { type: 'number', nullable: false },
+    },
+    required: ['statusCode', 'headers', 'trailers', 'duration'],
+    additionalProperties: false,
+};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,MAAM,CAAC,MAAM,iBAAiB,GAAgC;IAC5D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;QAC3C,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;QACzC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;QAC3C,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACxC,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAChD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,EAAE;YACZ,QAAQ,EAAE,IAAI;YACd,oBAAoB,EAAE;gBACpB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;yBACf;qBACF;oBACD;wBACE,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;SACF;QACD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;KAC5C;IACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC;IACtC,oBAAoB,EAAE,KAAK;CAC5B,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAiC;IAC9D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE;QAChD,OAAO,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,EAAE;YACZ,oBAAoB,EAAE;gBACpB,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;yBACf;qBACF;oBACD;wBACE,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;SACF;QACD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACxC,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAChD,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,EAAE;YACZ,oBAAoB,EAAE;gBACpB,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;KAC9C;IACD,QAAQ,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC;IAC3D,oBAAoB,EAAE,KAAK;CACnB,CAAC"}

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@thymian/plugin-request-dispatcher",
+  "version": "0.1.0",
+  "license": "AGPL-3.0-only",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "dependencies": {
+    "@thymian/core": "0.1.0",
+    "async-mutex": "^0.5.0",
+    "p-queue": "^9.0.1",
+    "undici": "^6.21.2"
+  }
+}