allserver 2.4.1 → 2.6.0

package/README.md

@@ -6,8 +6,11 @@ Think of Remote Procedure Calls using exactly the same client and server code bu
 
 Should be used in (micro)services where JavaScript is able to run - your computer, Docker, k8s, virtual machines, serverless functions (Lambdas, Google Cloud Functions, Azure Functions, etc), RaspberryPI, SharedWorker, thread, you name it.
 
+> Uber [moved](https://www.infoq.com/news/2023/10/uber-up-cloud-microservices/) most of its containerized microservices from µDeploy to a new multi-cloud platform named Up in preparation for migrating a considerable portion of its compute footprint to the cloud. **The company spent two years** working on making its many microservices portable to migrate between different computing infrastructures and container management platforms.
+
 Superpowers the `Allserver` gives you:
 
+- Move your code around infrastructures, deployment types, runtimes, platforms, etc with ease.
 - Call gRPC server methods from browser/curl/Postman.
 - Run your HTTP server as gRPC with a single line change (almost).
 - Serve same logic via HTTP and gRPC (or more) simultaneously in the same node.js process.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allserver",
-  "version": "2.4.1",
+  "version": "2.6.0",
   "description": "Multi-protocol simple RPC server and [optional] client. Boilerplate-less. Opinionated. Minimalistic. DX-first.",
   "main": "src/index.js",
   "scripts": {
@@ -34,12 +34,12 @@
   "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"
+    "@grpc/grpc-js": "1",
+    "@grpc/proto-loader": "0",
+    "bullmq": "3 - 5",
+    "express": "4",
+    "micro": "10",
+    "node-fetch": "2"
   },
   "peerDependenciesMeta": {
     "@grpc/grpc-js": {
@@ -62,17 +62,17 @@
     }
   },
   "devDependencies": {
-    "@grpc/grpc-js": "^1.1.7",
-    "@grpc/proto-loader": "^0.7.5",
-    "bullmq": "^3.10.1",
+    "@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",
+    "eslint": "^8.57.1",
+    "express": "^4.21.2",
     "lambda-local": "^1.7.3",
     "micro": "^10.0.1",
-    "mocha": "^10.2.0",
+    "mocha": "^11.7.1",
     "node-fetch": "^2.6.9",
-    "nyc": "^15.1.0",
+    "nyc": "^17.1.0",
     "prettier": "^2.1.1"
   },
   "dependencies": {

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: 0,
             // 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;
@@ -203,8 +207,8 @@ module.exports = require("stampit")({
             this[p].transport = getTransport()({ uri });
         }
 
-        if (before) this[p].before = [].concat(before).concat(this[p].before);
-        if (after) this[p].after = [].concat(after).concat(this[p].after);
+        if (before) this[p].before = [].concat(this[p].before).concat(before).filter(isFunction);
+        if (after) this[p].after = [].concat(this[p].after).concat(after).filter(isFunction);
     },
 
     methods: {
@@ -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,41 @@ 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) {
+                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`,
+                                }),
+                            this[p].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;
 
@@ -335,8 +361,9 @@ module.exports = require("stampit")({
             before,
             after,
         } = {}) {
-            if (before) before = [].concat(before);
-            if (after) after = [].concat(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,

package/src/server/Allserver.js

@@ -1,17 +1,20 @@
 const assert = require("assert");
 
-const { isObject, isBoolean, isFunction } = require("../util");
+const { isObject, isBoolean, isFunction, uniq } = require("../util");
 
 module.exports = require("stampit")({
     name: "Allserver",
 
+    deepProps: {
+        before: null,
+        after: null,
+    },
+
     props: {
         procedures: {},
         transport: null,
         logger: console,
         introspection: true,
-        before: null,
-        after: null,
 
         callsCount: 0,
     },
@@ -21,8 +24,8 @@ module.exports = require("stampit")({
         this.transport = transport || this.transport || require("./HttpTransport")();
         this.logger = logger || this.logger;
         this.introspection = introspection != null ? introspection : this.introspection;
-        this.before = before || this.before;
-        this.after = after || this.after;
+        if (before) this.before = uniq([].concat(this.before).concat(before).filter(isFunction));
+        if (after) this.after = uniq([].concat(this.after).concat(after).filter(isFunction));
 
         this._validateProcedures();
     },
@@ -178,7 +181,13 @@ module.exports = require("stampit")({
 
     statics: {
         defaults({ procedures, transport, logger, introspection, before, after } = {}) {
-            return this.props({ 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);
+
+            return this.compose({
+                props: { procedures, transport, logger, introspection },
+                deepProps: { before, after },
+            });
         },
     },
 });

package/src/server/GrpcTransport.js

@@ -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

@@ -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/util.js

@@ -5,4 +5,5 @@ module.exports = {
     isFunction: (o) => is(o, "function"),
     isObject: (o) => is(o, "object"),
     isPlainObject: (o) => o && o.constructor === Object,
+    uniq: (a) => Array.from(new Set(a)),
 };