allserver 2.0.0 → 2.1.0

package/README.md

@@ -343,8 +343,6 @@ More info can be found in the [`micro`](http://npmjs.com/package/micro) NPM modu
 
 Doesn't require a dedicated client transport. Use the HTTP client below.
 
-NB: not yet tested in production.
-
 ```js
 const { Allserver, ExpressTransport } = require("allserver");
 
@@ -590,6 +588,29 @@ const data = await job.waitUntilFinished(queueEvents, 30_000);
 const { success, code, message, user } = data;
 ```
 
+### In memory
+
+Sometimes you need to unit test your procedures via the `AllserverClient`. For that we have `MemoryTransport`.
+
+```js
+const { Allserver, MemoryTransport } = require("allserver");
+
+const memoryServer = Allserver({
+    procedures,
+    transport: MemoryTransport(),
+});
+
+const client = memoryServer.start();
+
+const { success, code, message, user } = await client.updateUser({
+    id: "123412341234123412341234",
+    firstName: "Fred",
+    lastName: "Flinstone",
+});
+
+assert(success === true);
+```
+
 ## `AllserverClient` options
 
 **All the arguments are optional.** But either `uri` or `transport` must be provided. We are trying to keep the highest possible DX here.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "allserver",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Multi-protocol simple RPC server and [optional] client. Boilerplate-less. Opinionated. Minimalistic. DX-first.",
   "main": "src/index.js",
   "scripts": {

package/src/client/MemoryClientTransport.js

@@ -0,0 +1,29 @@
+module.exports = require("./ClientTransport").compose({
+    name: "MemoryClientTransport",
+
+    props: {
+        _allserverContext: null,
+        uri: "memory",
+    },
+
+    init({ allserverContext }) {
+        this._allserverContext = allserverContext || this._allserverContext;
+    },
+
+    methods: {
+        async introspect(ctx) {
+            ctx.procedureName = "";
+            const result = await this.call(ctx);
+            if (!result) throw Error(); // The ClientTransport expects us to throw if call fails
+            return result;
+        },
+
+        async call(ctx) {
+            return this._allserverContext.allserver.handleCall(ctx);
+        },
+
+        createCallContext(defaultCtx) {
+            return { ...defaultCtx, ...this._allserverContext, memory: {} };
+        },
+    },
+});

package/src/index.js

@@ -23,6 +23,9 @@ module.exports = {
     get BullmqTransport() {
         return require("./server/BullmqTransport");
     },
+    get MemoryTransport() {
+        return require("./server/MemoryTransport");
+    },
 
     // client
 
@@ -41,4 +44,7 @@ module.exports = {
     get BullmqClientTransport() {
         return require("./client/BullmqClientTransport");
     },
+    get MemoryClientTransport() {
+        return require("./client/MemoryClientTransport");
+    },
 };

package/src/server/Allserver.js

@@ -66,7 +66,7 @@ module.exports = require("stampit")({
                 result = await ctx.procedure(ctx.arg, ctx);
             } catch (err) {
                 const code = err.code || "ALLSERVER_PROCEDURE_ERROR";
-                this.logger.error(code, err);
+                this.logger.error(err, code);
                 ctx.error = err;
                 ctx.result = {
                     success: false,
@@ -104,7 +104,7 @@ module.exports = require("stampit")({
                     }
                 } catch (err) {
                     const code = err.code || "ALLSERVER_MIDDLEWARE_ERROR";
-                    this.logger.error(code, err);
+                    this.logger.error(err, code);
                     ctx.error = err;
                     ctx.result = {
                         success: false,

package/src/server/MemoryTransport.js

@@ -0,0 +1,28 @@
+module.exports = require("./Transport").compose({
+    name: "MemoryTransport",
+
+    props: {
+        AllserverClient: require("../client/AllserverClient"),
+        MemoryClientTransport: require("../client/MemoryClientTransport"),
+    },
+
+    methods: {
+        startServer(defaultCtx) {
+            return this.AllserverClient({
+                transport: this.MemoryClientTransport({ allserverContext: { ...defaultCtx, memory: {} } }),
+            });
+        },
+
+        reply(ctx) {
+            return ctx.result;
+        },
+
+        getProcedureName(ctx) {
+            return ctx.procedureName;
+        },
+
+        isIntrospection(ctx) {
+            return this.getProcedureName(ctx) === "";
+        },
+    },
+});