soajs.controller 4.3.13 → 4.3.14

package/docs/configuration-custom-registry.md

@@ -292,11 +292,24 @@ Tracks user activity by notifying a service (typically URAC) of user access.
     "serviceName": "urac",                   // Service to notify
     "serviceVersion": "3",                   // Service version
     "api": "/user/last/seen",                // API endpoint
-    "network": "internal"                    // Optional network identifier
+    "network": "internal",                   // Optional network identifier
+    "include": {                             // Optional whitelist, omit for all requests
+      "connectspaces": true
+    },
+    "targets": [                             // Optional extra APIs, same event
+      {
+        "serviceName": "authenticator",
+        "serviceVersion": "1",
+        "api": "/my/device/network",
+        "method": "put"
+      }
+    ]
   }
 }
 ```
 
+See `docs/middleware/lastSeen.md` for the `include` matching rules and the target fields.
+
 | Field | Type | Default | Description |
 |-------|------|---------|-------------|
 | `active` | boolean | `false` | Enable/disable activity tracking |

package/docs/middleware/lastSeen.md

@@ -69,7 +69,18 @@ Located in `registry.custom.gateway.value.lastSeen`:
     "serviceName": "urac",               // Target service
     "serviceVersion": "3",               // Service version
     "api": "/user/last/seen",            // API endpoint
-    "network": "internal"                // Optional network identifier
+    "network": "internal",               // Optional network identifier
+    "include": {                         // Optional whitelist, omit to trigger on everything
+      "connectspaces": true
+    },
+    "targets": [                         // Optional extra APIs notified on the same event
+      {
+        "serviceName": "authenticator",
+        "serviceVersion": "1",
+        "api": "/my/device/network",
+        "method": "put"
+      }
+    ]
   }
 }
 ```
@@ -81,6 +92,40 @@ Located in `registry.custom.gateway.value.lastSeen`:
 | `serviceVersion` | string | `"3"` | Service version |
 | `api` | string | `"/user/last/seen"` | API endpoint |
 | `network` | string | - | Network identifier in request body |
+| `include` | object | - | Whitelist of services and APIs, omit to trigger on every request |
+| `targets` | array | - | Extra APIs notified on the same event |
+
+### include
+
+Decides whether a request counts as activity. Omitting it triggers on every request.
+
+| Form | Meaning |
+|------|---------|
+| service missing from `include` | never triggers |
+| `"service": true` | every API, every method |
+| `"service": {"apis": {"/path": true}}` | that API, every method |
+| `"service": {"apis": {"/path": ["get","put"]}}` | that API, listed methods only |
+| `"apis": {"*": ...}` | any API, checked before the exact paths |
+
+API keys accept the service relative path (`/active`) or the full path
+(`/connectspaces/active`), and support path params (`/user/:id`).
+
+### targets
+
+Extra APIs notified whenever the main one is. They are not filtered on their own, the
+`include` above has already decided that the request counts as activity, so a target is
+notified on exactly the same set of requests.
+
+| Field | Type | Default | Description |
+|-------|------|---------|-------------|
+| `serviceName` | string | required | Service to notify, must be in the registry |
+| `api` | string | required | API endpoint |
+| `serviceVersion` | string | - | Service version, resolved by awareness when absent |
+| `method` | string | `"post"` | HTTP method |
+
+Each target receives the same body and the same `soajsinjectobj` header as the main
+notification. A target that is down, unknown to the registry, or missing `serviceName`
+or `api` is skipped without affecting the others.
 
 ## Request to URAC
 

package/mw/lastSeen/index.js

@@ -143,6 +143,56 @@ function isMethodMatch(methodConfig, method) {
     return false;
 }
 
+/**
+ * Fire and forget the notification at one target.
+ *
+ * NOTE: the request is not awaited, a target that is down or slow must not affect
+ *       the original request, which has already been handed to the next middleware.
+ *
+ * @param req
+ * @param lastSeen the custom registry block, carries the shared body
+ * @param item {name, version, api, method}
+ */
+function notifyTarget(req, lastSeen, item) {
+    //NOTE: getHost resolves against the registry, an unknown service would throw on
+    //      the port lookup below and take the remaining targets down with it
+    if (!req.soajs.registry || !req.soajs.registry.services ||
+        !req.soajs.registry.services[item.name] || !req.soajs.registry.services[item.name].port) {
+        req.soajs.log.debug("lastSeen failed, service not in registry [" + item.name + "@" + item.version + " " + item.api + "]");
+        return;
+    }
+    req.soajs.awareness.getHost(item.name, item.version, (host) => {
+        if (!host) {
+            req.soajs.log.debug("lastSeen failed with no host for [" + item.name + "@" + item.version + " " + item.api + "]");
+            return;
+        }
+        item.host = host;
+        item.port = req.soajs.registry.services[item.name].port;
+
+        let options = {
+            "uri": "http://" + item.host + ":" + item.port + item.api,
+            "json": true,
+            "method": item.method || "POST"
+        };
+        if (lastSeen.network) {
+            options.body = { "network": lastSeen.network };
+        }
+        if (req.headers && req.headers.soajsinjectobj) {
+            options.headers = { "soajsinjectobj": req.headers.soajsinjectobj };
+        }
+        httpRequest(options)
+            .then(() => { })
+            .catch(({ error, body }) => {
+                if (error) {
+                    req.soajs.log.debug("lastSeen failed for [" + item.name + "@" + item.version + " " + item.api + "]");
+                    req.soajs.log.debug("lastSeen " + error.message);
+                } else {
+                    req.soajs.log.debug("lastSeen ", body);
+                }
+            });
+    });
+}
+
 /**
  *
  * @param configuration
@@ -180,39 +230,29 @@ module.exports = () => {
                 if (uracObj) {
                     userId = uracObj._id;
                 }
-                if (userId) {
-                    req.soajs.awareness.getHost(item.name, item.version, (host) => {
-                        if (host) {
-                            item.host = host;
-                            item.port = req.soajs.registry.services[item.name].port;
-
-                            let options = {
-                                "uri": "http://" + item.host + ":" + item.port + item.api,
-                                "json": true,
-                                "method": "POST"
-                            };
-                            if (lastSeen.network) {
-                                options.body = { "network": lastSeen.network };
-                            }
-                            if (req.headers && req.headers.soajsinjectobj) {
-                                options.headers = { "soajsinjectobj": req.headers.soajsinjectobj };
-                            }
-                            httpRequest(options)
-                                .then(() => { })
-                                .catch(({ error, body }) => {
-                                    if (error) {
-                                        req.soajs.log.debug("lastSeen failed for [" + item.name + "@" + item.version + " " + item.api + "]");
-                                        req.soajs.log.debug("lastSeen " + error.message);
-                                    } else {
-                                        req.soajs.log.debug("lastSeen ", body);
-                                    }
-                                });
-                        } else {
-                            req.soajs.log.debug("lastSeen failed with no host for [" + item.name + "@" + item.version + " " + item.api + "]");
+                if (!userId) {
+                    req.soajs.log.debug("lastSeen failed with no userId for [" + item.name + "@" + item.version + " " + item.api + "]");
+                    return;
+                }
+
+                notifyTarget(req, lastSeen, item);
+
+                //NOTE: additional targets are notified on the same event, they are not
+                //      filtered on their own, the include above already decided that this
+                //      request counts as activity
+                if (Array.isArray(lastSeen.targets)) {
+                    lastSeen.targets.forEach((target) => {
+                        if (!target || !target.serviceName || !target.api) {
+                            req.soajs.log.debug("lastSeen target skipped, serviceName and api are required");
+                            return;
                         }
+                        notifyTarget(req, lastSeen, {
+                            "name": target.serviceName,
+                            "version": target.serviceVersion || null,
+                            "api": target.api,
+                            "method": target.method
+                        });
                     });
-                } else {
-                    req.soajs.log.debug("lastSeen failed with no userId for [" + item.name + "@" + item.version + " " + item.api + "]");
                 }
             }
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "soajs.controller",
   "description": "soajs multi tenant API gateway",
-  "version": "4.3.13",
+  "version": "4.3.14",
   "author": {
     "name": "soajs team",
     "email": "team@soajs.org"

package/test/unit/mw/lastSeen/index.js

@@ -1009,4 +1009,172 @@ describe("Unit test for: mw - lastSeen", () => {
 
     });
 
+    describe("extra targets tests", () => {
+
+        let buildReq = (lastSeen) => {
+            return {
+                method: "GET",
+                getClientIP: () => {
+                    return "127.0.0.1";
+                },
+                soajs: {
+                    log: {
+                        debug: () => {
+                        },
+                        error: () => {
+                        }
+                    },
+                    uracDriver: {
+                        getProfile: () => {
+                            return { _id: "1111111111" };
+                        }
+                    },
+                    awareness: {
+                        getHost: (name, version, cb) => {
+                            return cb(name + ".fake");
+                        }
+                    },
+                    controller: {
+                        serviceParams: {
+                            name: "connectspaces",
+                            path: "/active",
+                            parsedUrl: { pathname: "/connectspaces/active" }
+                        }
+                    },
+                    registry: {
+                        services: {
+                            urac: { port: 4001 },
+                            authenticator: { port: 4002 }
+                        },
+                        custom: {
+                            gateway: {
+                                value: { lastSeen: lastSeen }
+                            }
+                        }
+                    }
+                }
+            };
+        };
+
+        it("notifies the extra target alongside urac, honouring its method", (done) => {
+            let req = buildReq({
+                active: true,
+                network: "YAYA",
+                targets: [{
+                    serviceName: "authenticator",
+                    serviceVersion: "1",
+                    api: "/my/device/network",
+                    method: "put"
+                }]
+            });
+            const uracScope = nock('http://urac.fake:4001')
+                .post('/user/last/seen', "{\"network\":\"YAYA\"}")
+                .reply(200, { result: true });
+            const authScope = nock('http://authenticator.fake:4002')
+                .put('/my/device/network', "{\"network\":\"YAYA\"}")
+                .reply(200, { result: true });
+
+            let functionMw = mw({});
+            functionMw(req, {}, (error) => {
+                assert.ifError(error);
+            });
+            setTimeout(() => {
+                assert.strictEqual(uracScope.isDone(), true, "urac was not notified");
+                assert.strictEqual(authScope.isDone(), true, "the extra target was not notified");
+                done();
+            }, 100);
+        });
+
+        it("defaults the extra target to post when no method is set", (done) => {
+            let req = buildReq({
+                active: true,
+                targets: [{
+                    serviceName: "authenticator",
+                    serviceVersion: "1",
+                    api: "/my/device/network"
+                }]
+            });
+            nock('http://urac.fake:4001').post('/user/last/seen').reply(200, { result: true });
+            const authScope = nock('http://authenticator.fake:4002')
+                .post('/my/device/network')
+                .reply(200, { result: true });
+
+            let functionMw = mw({});
+            functionMw(req, {}, () => {
+            });
+            setTimeout(() => {
+                assert.strictEqual(authScope.isDone(), true, "the extra target was not posted to");
+                done();
+            }, 100);
+        });
+
+        it("still notifies urac when a target names a service that is not in the registry", (done) => {
+            let req = buildReq({
+                active: true,
+                targets: [{
+                    serviceName: "doesnotexist",
+                    serviceVersion: "1",
+                    api: "/nope"
+                }]
+            });
+            const uracScope = nock('http://urac.fake:4001')
+                .post('/user/last/seen')
+                .reply(200, { result: true });
+
+            let functionMw = mw({});
+            assert.doesNotThrow(() => {
+                functionMw(req, {}, () => {
+                });
+            });
+            setTimeout(() => {
+                assert.strictEqual(uracScope.isDone(), true, "urac was not notified");
+                done();
+            }, 100);
+        });
+
+        it("skips a malformed target and still notifies urac", (done) => {
+            let req = buildReq({
+                active: true,
+                targets: [{ serviceVersion: "1" }, null]
+            });
+            const uracScope = nock('http://urac.fake:4001')
+                .post('/user/last/seen')
+                .reply(200, { result: true });
+
+            let functionMw = mw({});
+            functionMw(req, {}, () => {
+            });
+            setTimeout(() => {
+                assert.strictEqual(uracScope.isDone(), true, "urac was not notified");
+                done();
+            }, 100);
+        });
+
+        it("does not notify any target when the include filter excludes the request", (done) => {
+            let req = buildReq({
+                active: true,
+                include: { "someotherservice": true },
+                targets: [{
+                    serviceName: "authenticator",
+                    serviceVersion: "1",
+                    api: "/my/device/network",
+                    method: "put"
+                }]
+            });
+            const uracScope = nock('http://urac.fake:4001').post('/user/last/seen').reply(200, {});
+            const authScope = nock('http://authenticator.fake:4002').put('/my/device/network').reply(200, {});
+
+            let functionMw = mw({});
+            functionMw(req, {}, () => {
+            });
+            setTimeout(() => {
+                assert.strictEqual(uracScope.isDone(), false, "urac should have been skipped");
+                assert.strictEqual(authScope.isDone(), false, "the extra target should have been skipped");
+                nock.cleanAll();
+                done();
+            }, 100);
+        });
+
+    });
+
 });