@flexent/protocomm-http 2.4.0

package/README.md

@@ -0,0 +1,33 @@
+# @flexent/protocomm-http
+
+HTTP handler for serving `@flexent/protocomm` protocols through `@flexent/http-server`.
+
+## Usage
+
+Extend `HttpProtocolHandler` in request scope and provide a protocol index plus implementation.
+
+```ts
+import { HttpProtocolHandler } from '@flexent/protocomm-http';
+import { dep } from 'mesh-ioc';
+
+import { appProtocol, type AppProtocol } from './protocol.js';
+import { AppProtocolImpl } from './AppProtocolImpl.js';
+
+export class AppHttpProtocolHandler extends HttpProtocolHandler<AppProtocol> {
+
+    @dep() protected appProtocolImpl!: AppProtocolImpl;
+
+    prefix = '/rpc';
+
+    get protocol() {
+        return appProtocol;
+    }
+
+    get protocolImpl() {
+        return this.appProtocolImpl;
+    }
+
+}
+```
+
+Query methods are served with `GET`. Command methods are served with `POST`.

package/out/main/HttpProtocolHandler.d.ts

@@ -0,0 +1,15 @@
+import { type HttpContext, HttpHandler, type HttpNext } from '@flexent/http-server';
+import { type Logger } from '@flexent/logger';
+import { type DomainMethodStat, type ProtocolIndex } from '@flexent/protocomm';
+import { Event } from 'nanoevent';
+export declare abstract class HttpProtocolHandler<P> extends HttpHandler {
+    protected logger: Logger;
+    methodStats: Event<DomainMethodStat>;
+    prefix: string;
+    abstract get protocol(): ProtocolIndex<P>;
+    abstract get protocolImpl(): P;
+    handle(ctx: HttpContext, next: HttpNext): Promise<void>;
+    protected handleProtocolMethod(ctx: HttpContext, next: HttpNext, domainName: string, methodName: string): Promise<void>;
+    protected parsePath(path: string): [string, string];
+    protected parseParams(ctx: HttpContext): Promise<unknown>;
+}

package/out/main/HttpProtocolHandler.js

@@ -0,0 +1,92 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { NotFoundError } from '@flexent/errors';
+import { HttpHandler } from '@flexent/http-server';
+import { MethodNotFound, } from '@flexent/protocomm';
+import { dep } from 'mesh-ioc';
+import { Event } from 'nanoevent';
+export class HttpProtocolHandler extends HttpHandler {
+    constructor() {
+        super(...arguments);
+        this.methodStats = new Event();
+        this.prefix = '';
+    }
+    async handle(ctx, next) {
+        if (!ctx.path.startsWith(this.prefix)) {
+            return await next();
+        }
+        const [domainName, methodName] = this.parsePath(ctx.path);
+        const startedAt = Date.now();
+        try {
+            await this.handleProtocolMethod(ctx, next, domainName, methodName);
+            this.methodStats.emit({
+                domain: domainName,
+                method: methodName,
+                latency: Date.now() - startedAt,
+            });
+        }
+        catch (error) {
+            this.methodStats.emit({
+                domain: domainName,
+                method: methodName,
+                latency: Date.now() - startedAt,
+                error: error.name,
+            });
+            throw error;
+        }
+    }
+    async handleProtocolMethod(ctx, next, domainName, methodName) {
+        const { methodDef, reqSchema, resSchema } = this.protocol.lookupMethod(domainName, methodName);
+        const expectedMethod = methodDef.type === 'query' ? 'GET' : 'POST';
+        if (ctx.method !== expectedMethod) {
+            return await next();
+        }
+        const params = await this.parseParams(ctx);
+        const decodedParams = reqSchema.decode(params, { strictRequired: true });
+        this.logger.debug(`>>> ${domainName}.${methodName}`, { params: decodedParams });
+        const domainImpl = this.protocolImpl[domainName];
+        const methodImpl = domainImpl?.[methodName];
+        if (!methodImpl) {
+            throw new MethodNotFound(`${domainName}.${methodName}`);
+        }
+        ctx.state.domainName = domainName;
+        ctx.state.methodName = methodName;
+        ctx.state.methodDef = methodDef;
+        ctx.state.params = decodedParams;
+        const res = await methodImpl.call(domainImpl, decodedParams);
+        const decodedRes = resSchema.decode(res);
+        this.logger.debug(`<<< ${domainName}.${methodName}`, { result: decodedRes });
+        ctx.status = 200;
+        ctx.responseBody = decodedRes;
+    }
+    parsePath(path) {
+        if (!path.startsWith(this.prefix)) {
+            throw new NotFoundError('Endpoint not found');
+        }
+        const pathWithoutPrefix = path.substring(this.prefix.length);
+        const match = /^\/([a-zA-Z0-9]+)\/([a-zA-Z0-9]+)$/.exec(pathWithoutPrefix);
+        if (!match) {
+            throw new NotFoundError('Endpoint not found');
+        }
+        return [match[1], match[2]];
+    }
+    async parseParams(ctx) {
+        if (ctx.method === 'GET') {
+            return ctx.query;
+        }
+        const body = await ctx.readRequestBody();
+        return body ?? {};
+    }
+}
+__decorate([
+    dep(),
+    __metadata("design:type", Function)
+], HttpProtocolHandler.prototype, "logger", void 0);
+//# sourceMappingURL=HttpProtocolHandler.js.map

package/out/main/HttpProtocolHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpProtocolHandler.js","sourceRoot":"","sources":["../../src/main/HttpProtocolHandler.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAoB,WAAW,EAAiB,MAAM,sBAAsB,CAAC;AAEpF,OAAO,EAGH,cAAc,GAEjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAElC,MAAM,OAAgB,mBAAuB,SAAQ,WAAW;IAAhE;;QAII,gBAAW,GAAG,IAAI,KAAK,EAAoB,CAAC;QAE5C,WAAM,GAAG,EAAE,CAAC;IAgFhB,CAAC;IA1EG,KAAK,CAAC,MAAM,CAAC,GAAgB,EAAE,IAAc;QACzC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACpC,OAAO,MAAM,IAAI,EAAE,CAAC;QACxB,CAAC;QACD,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC;YACD,MAAM,IAAI,CAAC,oBAAoB,CAAC,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YACnE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;gBAClB,MAAM,EAAE,UAAU;gBAClB,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;aAClC,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;gBAClB,MAAM,EAAE,UAAU;gBAClB,MAAM,EAAE,UAAU;gBAClB,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;gBAC/B,KAAK,EAAE,KAAK,CAAC,IAAI;aACpB,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;IAES,KAAK,CAAC,oBAAoB,CAChC,GAAgB,EAChB,IAAc,EACd,UAAkB,EAClB,UAAkB;QAElB,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAC/F,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QACnE,IAAI,GAAG,CAAC,MAAM,KAAK,cAAc,EAAE,CAAC;YAChC,OAAO,MAAM,IAAI,EAAE,CAAC;QACxB,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,UAAU,IAAI,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAChF,MAAM,UAAU,GAAI,IAAI,CAAC,YAAoB,CAAC,UAAU,CAAC,CAAC;QAC1D,MAAM,UAAU,GAAG,UAAU,EAAE,CAAC,UAAU,CAAuC,CAAC;QAClF,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,MAAM,IAAI,cAAc,CAAC,GAAG,UAAU,IAAI,UAAU,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QAClC,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC;QAClC,GAAG,CAAC,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;QAChC,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC;QACjC,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,UAAU,IAAI,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;QAC7E,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;QACjB,GAAG,CAAC,YAAY,GAAG,UAAU,CAAC;IAClC,CAAC;IAES,SAAS,CAAC,IAAY;QAC5B,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,aAAa,CAAC,oBAAoB,CAAC,CAAC;QAClD,CAAC;QACD,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7D,MAAM,KAAK,GAAG,oCAAoC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC3E,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,MAAM,IAAI,aAAa,CAAC,oBAAoB,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAChC,CAAC;IAES,KAAK,CAAC,WAAW,CAAC,GAAgB;QACxC,IAAI,GAAG,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YACvB,OAAO,GAAG,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,eAAe,EAAE,CAAC;QACzC,OAAO,IAAI,IAAI,EAAE,CAAC;IACtB,CAAC;CAEJ;AApFoB;IAAhB,GAAG,EAAE;;mDAA2B"}

package/out/main/index.d.ts

@@ -0,0 +1 @@
+export * from './HttpProtocolHandler.js';

package/out/main/index.js

@@ -0,0 +1,2 @@
+export * from './HttpProtocolHandler.js';
+//# sourceMappingURL=index.js.map

package/out/main/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/main/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC"}

package/package.json

@@ -0,0 +1,26 @@
+{
+    "name": "@flexent/protocomm-http",
+    "version": "2.4.0",
+    "description": "HTTP handler for protocomm RPC protocols",
+    "author": "Boris Okunskiy",
+    "license": "MIT",
+    "type": "module",
+    "sideEffects": false,
+    "exports": {
+        ".": "./out/main/index.js"
+    },
+    "files": [
+        "out/main/**/*"
+    ],
+    "scripts": {
+        "test": "NODE_ENV=test mocha"
+    },
+    "peerDependencies": {
+        "@flexent/errors": "^2.4.0",
+        "@flexent/http-server": "^2.4.0",
+        "@flexent/logger": "^2.4.0",
+        "@flexent/protocomm": "^2.4.0",
+        "mesh-ioc": "^4.3.1",
+        "nanoevent": "^1.0.0"
+    }
+}