allserver 2.5.0 → 2.6.1

package/README.md

@@ -162,7 +162,7 @@ npm i allserver express
 Optionally, you can use Allserver's built-in client:
 
 ```shell
-npm i allserver node-fetch
+npm i allserver
 ```
 
 Or do HTTP requests using any module you like.
@@ -390,10 +390,8 @@ exports.handler = Allserver({
 
 #### Using built-in client
 
-You'd need to install `node-fetch` optional dependency.
-
 ```shell
-npm i allserver node-fetch
+npm i allserver
 ```
 
 Note, that this code is **same** as the gRPC client code example below!
@@ -618,13 +616,7 @@ assert(success === true);
 
 ### Bare AWS Lambda invocation
 
-First you need to install any of the AWS SDK versions.
-
-```shell
-npm i allserver aws-sdk
-```
-
-or
+First you need to install the AWS SDK v3.
 
 ```shell
 npm i allserver @aws-sdk/client-lambda
@@ -681,6 +673,9 @@ aws lambda invoke --function-name my-lambda-name --payload '{"_":{"procedureName
 - `transport`<br>
   The transport implementation object. The `uri` is ignored if this option provided. If not given then it will be automatically created based on the `uri` schema. E.g. if it starts with `http://` or `https://` then `HttpClientTransport` will be used. If starts with `grpc://` then `GrpcClientTransport` will be used. If starts with `bullmq://` then `BullmqClientTransport` is used.
 
+- `timeout=60_000`<br>
+  Set it to `0` if you don't need a timeout. If the procedure call takes longer than this value then the `AllserverClient` will return `success=false` and `code=ALLSERVER_CLIENT_TIMEOUT`.
+
 - `neverThrow=true`<br>
   Set it to `false` if you want to get exceptions when there are a network, or a server errors during a procedure call. Otherwise, the standard `{success,code,message}` object is returned from method calls. The Allserver error `code`s are always start with `"ALLSERVER_"`. E.g. `"ALLSERVER_CLIENT_MALFORMED_INTROSPECTION"`.
 
@@ -709,6 +704,7 @@ You can change the above mentioned options default values like this:
 ```js
 AllseverClient = AllserverClient.defaults({
   transport,
+  timeout,
   neverThrow,
   dynamicMethods,
   autoIntrospect,
@@ -912,7 +908,8 @@ const client = AllserverClient({
     ctx.http.headers.authorization = "Basic my-token";
   },
   async after(ctx) {
-    if (ctx.error) console.error(ctx.error); else console.log(ctx.result);
+    if (ctx.error) console.error(ctx.error);
+    else console.log(ctx.result);
   },
 });
 ```

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "allserver",
-  "version": "2.5.0",
-  "description": "Multi-protocol simple RPC server and [optional] client. Boilerplate-less. Opinionated. Minimalistic. DX-first.",
+  "version": "2.6.1",
+  "description": "Multi-protocol RPC server and [optional] client. DX-first. Minimalistic. Boilerplate-less. Opinionated.",
   "main": "src/index.js",
   "scripts": {
-    "lint": "eslint ./",
-    "test": "mocha",
-    "cov": "nyc --reporter=html npm run test"
+    "lint": "oxlint ./",
+    "test": "node --test  --test-force-exit --trace-deprecation",
+    "cov": "nyc --reporter=html node --run test"
   },
   "keywords": [
     "simple",
@@ -25,7 +25,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "http://github.com/flash-oss/allserver"
+    "url": "https://github.com/flash-oss/allserver"
   },
   "bugs": {
     "url": "https://github.com/flash-oss/allserver/issues"
@@ -34,14 +34,17 @@
   "author": "Vasyl Boroviak",
   "license": "MIT",
   "peerDependencies": {
-    "@grpc/grpc-js": "^1.1.7",
-    "@grpc/proto-loader": "^0.7.5",
-    "bullmq": "^3.10.1",
-    "express": "^4.18.2",
-    "micro": "^10.0.1",
-    "node-fetch": "^2.6.9"
+    "@aws-sdk/client-lambda": "3",
+    "@grpc/grpc-js": "1",
+    "@grpc/proto-loader": "0",
+    "bullmq": "3 - 5",
+    "express": "4 - 6",
+    "micro": "10"
   },
   "peerDependenciesMeta": {
+    "@aws-sdk/client-lambda": {
+      "optional": true
+    },
     "@grpc/grpc-js": {
       "optional": true
     },
@@ -56,41 +59,22 @@
     },
     "micro": {
       "optional": true
-    },
-    "node-fetch": {
-      "optional": true
     }
   },
   "devDependencies": {
-    "@grpc/grpc-js": "^1.1.7",
-    "@grpc/proto-loader": "^0.7.5",
-    "bullmq": "^3.10.1",
+    "@aws-sdk/client-lambda": "^3.921.0",
+    "@grpc/grpc-js": "^1.13.4",
+    "@grpc/proto-loader": "^0.8.0",
+    "bullmq": "^5.56.9",
     "cls-hooked": "^4.2.2",
-    "eslint": "^8.55.0",
-    "express": "^4.18.2",
-    "lambda-local": "^1.7.3",
+    "express": "^4.21.2",
+    "lambda-local": "^2.2.0",
     "micro": "^10.0.1",
-    "mocha": "^10.2.0",
-    "node-fetch": "^2.6.9",
-    "nyc": "^15.1.0",
+    "nyc": "^17.1.0",
+    "oxlint": "^1.25.0",
     "prettier": "^2.1.1"
   },
   "dependencies": {
-    "stampit": "^4.3.1"
-  },
-  "eslintConfig": {
-    "parserOptions": {
-      "ecmaVersion": 2022
-    },
-    "env": {
-      "es6": true,
-      "node": true,
-      "mocha": true
-    },
-    "extends": "eslint:recommended"
-  },
-  "mocha": {
-    "recursive": true,
-    "exit": true
+    "stampit": "^5.0.1"
   }
 }

package/src/client/AllserverClient.js

@@ -141,6 +141,8 @@ module.exports = require("stampit")({
         [p]: {
             // The protocol implementation strategy.
             transport: null,
+            // The maximum time to wait until returning the ALLSERVER_CLIENT_TIMEOUT error. 0 means - no timeout.
+            timeout: 60_000,
             // Disable any exception throwing when calling any methods. Otherwise, throws network and server errors.
             neverThrow: true,
             // Automatically find (introspect) and call corresponding remote procedures. Use only the methods defined in client side.
@@ -173,6 +175,7 @@ module.exports = require("stampit")({
         {
             uri,
             transport,
+            timeout,
             neverThrow,
             dynamicMethods,
             autoIntrospect,
@@ -183,6 +186,7 @@ module.exports = require("stampit")({
         },
         { stamp }
     ) {
+        this[p].timeout = timeout != null ? timeout : this[p].timeout;
         this[p].neverThrow = neverThrow != null ? neverThrow : this[p].neverThrow;
         this[p].dynamicMethods = dynamicMethods != null ? dynamicMethods : this[p].dynamicMethods;
         this[p].autoIntrospect = autoIntrospect != null ? autoIntrospect : this[p].autoIntrospect;
@@ -200,7 +204,7 @@ module.exports = require("stampit")({
             const getTransport = stamp.compose.deepConfiguration.transports[schema.toLowerCase()];
             if (!getTransport) throw new Error(`Schema not supported: ${uri}`);
 
-            this[p].transport = getTransport()({ uri });
+            this[p].transport = getTransport()({ uri, timeout: this[p].timeout });
         }
 
         if (before) this[p].before = [].concat(this[p].before).concat(before).filter(isFunction);
@@ -218,10 +222,10 @@ module.exports = require("stampit")({
                     try {
                         // This is supposed to be executed only once (per uri) unless it throws.
                         // There are only 3 situations when this throws:
-                        // * the "introspect" method not found on server,
-                        // * the network request is malformed,
+                        // * the "introspect" method not found on server, (GRPC)
+                        // * the network request is malformed, (HTTP-like)
                         // * couldn't connect to the remote host.
-                        ctx.result = await transport.introspect(ctx);
+                        ctx.result = await this._callTransport(ctx);
                     } catch (err) {
                         ctx.result = {
                             success: false,
@@ -281,19 +285,44 @@ module.exports = require("stampit")({
             return await runMiddlewares(middlewares);
         },
 
+        _callTransport(ctx) {
+            const transportMethod = ctx.isIntrospection ? "introspect" : "call";
+            // In JavaScript if the `timeout` is null or undefined or some other object this condition will return `false`
+            if (this[p].timeout > 0) {
+                let timeout = this[p].timeout;
+                // Let's give a chance to the Transport to return its native timeout response before returning Client's timeout response.
+                if (timeout >= 100) timeout = Math.round(timeout / 100 + timeout);
+                return Promise.race([
+                    this[p].transport[transportMethod](ctx),
+                    new Promise((resolve) =>
+                        setTimeout(
+                            () =>
+                                resolve({
+                                    success: false,
+                                    code: "ALLSERVER_CLIENT_TIMEOUT",
+                                    message: `The remote procedure ${ctx.procedureName} timed out in ${this[p].timeout} ms`,
+                                }),
+                            timeout
+                        )
+                    ),
+                ]);
+            }
+
+            return this[p].transport[transportMethod](ctx);
+        },
+
         async call(procedureName, arg) {
             if (!arg) arg = {};
             if (!arg._) arg._ = {};
             arg._.procedureName = procedureName;
 
-            const transport = this[p].transport;
             const defaultCtx = { procedureName, arg, client: this };
-            const ctx = transport.createCallContext(defaultCtx);
+            const ctx = this[p].transport.createCallContext(defaultCtx);
 
             await this._callMiddlewares(ctx, "before", async () => {
                 if (!ctx.result) {
                     try {
-                        ctx.result = await transport.call(ctx);
+                        ctx.result = await this._callTransport(ctx);
                     } catch (err) {
                         if (!this[p].neverThrow) throw err;
 
@@ -325,31 +354,26 @@ module.exports = require("stampit")({
     },
 
     statics: {
-        defaults({
-            transport,
-            neverThrow,
-            dynamicMethods,
-            autoIntrospect,
-            callIntrospectedProceduresOnly,
-            nameMapper,
-            before,
-            after,
-        } = {}) {
-            if (before != null) before = (Array.isArray(before) ? before : [before]).filter(isFunction);
-            if (after != null) after = (Array.isArray(after) ? after : [after]).filter(isFunction);
-
-            return this.deepProps({
-                [p]: {
-                    transport,
-                    neverThrow,
-                    dynamicMethods,
-                    callIntrospectedProceduresOnly,
-                    autoIntrospect,
-                    nameMapper,
-                    before,
-                    after,
-                },
-            });
+        /**
+         * @param [props.transport] {Object}
+         * @param [props.timeout] {number}
+         * @param [props.neverThrow] {boolean}
+         * @param [props.dynamicMethods] {Object}
+         * @param [props.autoIntrospect] {boolean}
+         * @param [props.callIntrospectedProceduresOnly] {boolean}
+         * @param [props.nameMapper] {Function}
+         * @param [props.before] {Function|Function[]}
+         * @param [props.after] {Function|Function[]}
+         * @return Copy of self
+         */
+        defaults(props = {}) {
+            props = Object.fromEntries(Object.entries(props).filter(([key, value]) => value !== undefined));
+            if (props.before)
+                props.before = (Array.isArray(props.before) ? props.before : [props.before]).filter(isFunction);
+            if (props.after)
+                props.after = (Array.isArray(props.after) ? props.after : [props.after]).filter(isFunction);
+
+            return this.deepProps({ [p]: props });
         },
 
         addTransport({ schema, Transport }) {

package/src/client/BullmqClientTransport.js

@@ -4,7 +4,6 @@ module.exports = require("./ClientTransport").compose({
     props: {
         Queue: require("bullmq").Queue,
         QueueEvents: require("bullmq").QueueEvents,
-        _timeout: 60000,
         _queue: null,
         _queueEvents: null,
         _jobsOptions: null,
@@ -22,7 +21,6 @@ module.exports = require("./ClientTransport").compose({
                 retryStrategy: null, // only one attempt to connect
             };
         }
-        this._timeout = timeout || this._timeout;
 
         this._queue = new this.Queue(queueName, { connection: connectionOptions });
         this._queue.on("error", () => {}); // The only reason we subscribe is to avoid bullmq to print errors to console
@@ -49,7 +47,7 @@ module.exports = require("./ClientTransport").compose({
             try {
                 await this._queue.waitUntilReady();
                 const job = await bullmq.queue.add(procedureName, bullmq.data, bullmq.jobsOptions);
-                return await job.waitUntilFinished(bullmq.queueEvents, this._timeout);
+                return await job.waitUntilFinished(bullmq.queueEvents, this.timeout); // this.timeout is a property of the parent ClientTransport
             } catch (err) {
                 if (err.code === "ECONNREFUSED") err.noNetToServer = true;
                 throw err;

package/src/client/ClientTransport.js

@@ -5,13 +5,16 @@ module.exports = require("stampit")({
 
     props: {
         uri: null,
+        timeout: 60_000,
     },
 
-    init({ uri }) {
+    init({ uri, timeout }) {
         if (!isFunction(this.introspect)) throw new Error("ClientTransport must implement introspect()");
         if (!isFunction(this.call)) throw new Error("ClientTransport must implement call()");
 
         this.uri = uri || this.uri;
         if (!isString(this.uri)) throw new Error("`uri` connection string is required");
+
+        this.timeout = timeout != null ? timeout : this.timeout;
     },
 });

package/src/client/GrpcClientTransport.js

@@ -4,7 +4,7 @@ module.exports = require("./ClientTransport").compose({
     name: "GrpcClientTransport",
 
     props: {
-        _fs: require("fs"),
+        _fs: require("node:fs"),
         _grpc: require("@grpc/grpc-js"),
         _protoLoader: require("@grpc/proto-loader"),
         _grpcClientForIntrospection: null,

package/src/client/HttpClientTransport.js

@@ -4,8 +4,7 @@ module.exports = require("./ClientTransport").compose({
     name: "HttpClientTransport",
 
     props: {
-        // eslint-disable-next-line no-undef
-        fetch: (typeof globalThis !== "undefined" && globalThis.fetch) || require("node-fetch"),
+        fetch: globalThis.fetch,
         headers: {
             "Content-Type": "application/json; charset=utf-8",
         },
@@ -51,7 +50,7 @@ module.exports = require("./ClientTransport").compose({
                         const json = JSON.parse(text);
                         error = new Error((json && json.message) || text);
                         if (json && json.code) error.code = json.code;
-                    } catch (err) {
+                    } catch {
                         // ignoring. Not a JSON
                     }
                 }

package/src/client/LambdaClientTransport.js

@@ -7,13 +7,7 @@ module.exports = require("./ClientTransport").compose({
 
     init() {
         if (!this.awsSdkLambdaClient) {
-            let Lambda;
-            try {
-                Lambda = require("aws-sdk").Lambda; // AWS SDK v2 adoption
-            } catch {
-                Lambda = require("@aws-sdk/client-lambda").Lambda;
-            }
-
+            const { Lambda } = require("@aws-sdk/client-lambda");
             this.awsSdkLambdaClient = new Lambda();
         }
     },
@@ -29,30 +23,48 @@ module.exports = require("./ClientTransport").compose({
         },
 
         async call(ctx) {
-            let promise = this.awsSdkLambdaClient.invoke({
-                FunctionName: this.uri.substring("lambda://".length),
-                // TODO: change to this during the next major release:
-                //  Payload: JSON.stringify(ctx.arg),
-                Payload: JSON.stringify({
-                    callContext: { ...ctx.lambda.callContext, procedureName: ctx.procedureName },
-                    callArg: ctx.lambda.callArg,
-                    ...ctx.arg,
-                }),
-            });
-            if (typeof promise.promise === "function") promise = promise.promise(); // AWS SDK v2 adoption
-            const invocationResponse = await promise;
-            return JSON.parse(Buffer.from(invocationResponse.Payload));
+            let invocationResponse;
+            try {
+                invocationResponse = await this.awsSdkLambdaClient.invoke(
+                    {
+                        FunctionName: this.uri.substring("lambda://".length),
+                        Payload: JSON.stringify(ctx.arg),
+                    },
+                    { requestTimeout: this.timeout } // this.timeout is a property of the parent ClientTransport
+                );
+                ctx.lambda.response = invocationResponse;
+            } catch (e) {
+                if (e.name.includes("ProviderError") || e.name.includes("NotFound")) e.noNetToServer = true;
+                throw e;
+            }
+
+            let json;
+            try {
+                json = JSON.parse(Buffer.from(invocationResponse.Payload));
+            } catch (e) {
+                e.code = "ALLSERVER_RPC_RESPONSE_IS_NOT_JSON";
+                throw e;
+            }
+
+            const error = new Error("Bad response payload");
+            if (json.constructor !== Object) {
+                error.code = "ALLSERVER_RPC_RESPONSE_IS_NOT_OBJECT";
+                throw error;
+            }
+
+            // Yes, the AWS Lambda sometimes returns a empty object when the Lambda runtime shuts down abruptly for no apparent reason.
+            if (Object.keys(json).length === 0) {
+                error.code = "ALLSERVER_RPC_RESPONSE_IS_EMPTY_OBJECT";
+                throw error;
+            }
+
+            return json;
         },
 
         createCallContext(defaultCtx) {
             return {
                 ...defaultCtx,
-                // TODO: change to this during the next major release:
-                //  lambda: {}
-                lambda: {
-                    callContext: {},
-                    callArg: defaultCtx.arg,
-                },
+                lambda: {},
             };
         },
     },

package/src/server/Allserver.js

@@ -1,4 +1,4 @@
-const assert = require("assert");
+const assert = require("node:assert/strict");
 
 const { isObject, isBoolean, isFunction, uniq } = require("../util");
 
@@ -180,14 +180,22 @@ module.exports = require("stampit")({
     },
 
     statics: {
-        defaults({ procedures, transport, logger, introspection, before, after } = {}) {
-            if (before != null) before = (Array.isArray(before) ? before : [before]).filter(isFunction);
-            if (after != null) after = (Array.isArray(after) ? after : [after]).filter(isFunction);
+        /**
+         * @param [propsArg.procedures] {Object}
+         * @param [propsArg.transport] {Object}
+         * @param [propsArg.logger] {Object}
+         * @param [propsArg.introspection] {boolean}
+         * @param [propsArg.before] {Object}
+         * @param [propsArg.after] {Object}
+         * @return Copy of self
+         */
+        defaults(propsArg = {}) {
+            propsArg = Object.fromEntries(Object.entries(propsArg).filter(([key, value]) => value !== undefined));
+            let { before, after, ...props } = propsArg;
+            if (before) before = (Array.isArray(before) ? before : [before]).filter(isFunction);
+            if (after) after = (Array.isArray(after) ? after : [after]).filter(isFunction);
 
-            return this.compose({
-                props: { procedures, transport, logger, introspection },
-                deepProps: { before, after },
-            });
+            return this.compose({ props, deepProps: { before, after } });
         },
     },
 });

package/src/server/ExpressTransport.js

@@ -1,4 +1,4 @@
-const { parse: parseUrl } = require("url");
+const { parse: parseUrl } = require("node:url");
 
 module.exports = require("./Transport").compose({
     name: "ExpressTransport",

package/src/server/GrpcTransport.js

@@ -4,7 +4,7 @@ module.exports = require("./Transport").compose({
     name: "GrpcTransport",
 
     props: {
-        _fs: require("fs"),
+        _fs: require("node:fs"),
         _grpc: require("@grpc/grpc-js"),
         _protoLoader: require("@grpc/proto-loader"),
         port: process.env.PORT,
@@ -81,8 +81,6 @@ module.exports = require("./Transport").compose({
                     err ? reject(err) : resolve(result)
                 );
             });
-
-            return this.server.start();
         },
         stopServer() {
             return new Promise((r) => this.server.tryShutdown(r));

package/src/server/HttpTransport.js

@@ -1,5 +1,5 @@
-const http = require("http");
-const { parse: parseUrl, URLSearchParams } = require("url");
+const http = require("node:http");
+const { parse: parseUrl, URLSearchParams } = require("node:url");
 
 module.exports = require("./Transport").compose({
     name: "HttpTransport",
@@ -22,7 +22,7 @@ module.exports = require("./Transport").compose({
                 if (bodyBuffer.length !== 0) arg = await this.micro.json(ctx.http.req);
                 ctx.arg = arg;
                 return true;
-            } catch (err) {
+            } catch {
                 return false;
             }
         },
@@ -60,6 +60,7 @@ module.exports = require("./Transport").compose({
             return new Promise((r) => {
                 if (this.server.closeIdleConnections) this.server.closeIdleConnections();
                 this.server.close(r);
+                if (this.server.closeAllConnections) this.server.closeAllConnections();
             });
         },
 

package/src/server/LambdaTransport.js

@@ -17,13 +17,11 @@ module.exports = require("./Transport").compose({
                         }
                     }
                     return true;
-                } catch (err) {
+                } catch {
                     return false;
                 }
             } else {
-                // TODO: change to this during the next major release:
-                //  ctx.arg = ctx.lambda.invoke || {};
-                ctx.arg = ctx.lambda.invoke.callArg || ctx.lambda.invoke || {};
+                ctx.arg = ctx.lambda.invoke || {};
                 return true;
             }
         },
@@ -56,11 +54,7 @@ module.exports = require("./Transport").compose({
                             headers: event?.headers,
                         };
                     } else {
-                        // TODO: change to this during the next major release:
-                        //  lambda.invoke = event || {};
-                        lambda.invoke = event?.callArg
-                            ? { callContext: event?.callContext, callArg: event?.callArg }
-                            : event || {};
+                        lambda.invoke = event || {};
                     }
 
                     this._handleRequest({ ...defaultCtx, lambda });
@@ -70,9 +64,7 @@ module.exports = require("./Transport").compose({
 
         getProcedureName(ctx) {
             const { isHttp, http, invoke } = ctx.lambda;
-            // TODO: change to this during the next major release:
-            //  return (isHttp ? http.path.substr(1) : invoke._?.procedureName) || ""; // if no procedureName then it's an introspection
-            return isHttp ? http.path.substr(1) : invoke.callContext?.procedureName || invoke._?.procedureName || ""; // if no procedureName then it's an introspection
+            return (isHttp ? http.path.substr(1) : invoke._?.procedureName) || ""; // if no procedureName then it's an introspection
         },
 
         isIntrospection(ctx) {