@sockethub/server 5.0.0-alpha.3

package/dist/middleware/validate.test.data.js

@@ -0,0 +1,263 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = [
+    {
+        "name": "mismatched types",
+        "valid": false,
+        "type": "credentials",
+        "input": {
+            "id": "blah",
+            "type": "send",
+            "context": "fake",
+            "actor": {
+                "id": "dood@irc.freenode.net",
+                "type": "person",
+                "name": "dood"
+            },
+            "target": {
+                "id": "irc.freenode.net/service",
+                "type": "person",
+                "name": "service"
+            },
+            "object": {
+                "type": "credentials",
+                "user": 'foo',
+                "pass": 'bar'
+            }
+        },
+        'error': "Error: credential activity streams must have credentials set as type"
+    },
+    {
+        "name": "basic",
+        "valid": true,
+        "type": "credentials",
+        "input": {
+            "id": "blah",
+            "type": "credentials",
+            "context": "fake",
+            "actor": {
+                "id": "dood@irc.freenode.net",
+                "type": "person",
+                "name": "dood"
+            },
+            "object": {
+                'type': 'credentials',
+                "user": 'foo',
+                "pass": 'bar'
+            }
+        },
+        "output": "same"
+    },
+    {
+        "name": "no type specified",
+        "valid": false,
+        "type": "credentials",
+        "input": {
+            "actor": "hyper_rau@localhost",
+            "context": "fake",
+            "object": {
+                "username": "hyper_rau",
+                "password": "123",
+                "server": "localhost",
+                "port": 5222,
+                "resource": "laptop"
+            }
+        },
+        "error": "Error: credential activity streams must have credentials set as type"
+    },
+    {
+        "name": "basic person",
+        "type": "activity-object",
+        "valid": true,
+        "input": {
+            "id": "blah",
+            "type": "person",
+            "name": "dood"
+        },
+        "output": "same"
+    },
+    {
+        "name": "person with extras",
+        "valid": true,
+        "type": "activity-object",
+        "input": {
+            "id": "blah",
+            "type": "person",
+            "name": "bob",
+            "hello": "there",
+            "i": [
+                "am",
+                "extras"
+            ]
+        },
+        "output": "same"
+    },
+    {
+        "name": "alone credentials (as activity-object)",
+        "valid": false,
+        "type": "activity-object",
+        "input": {
+            "type": "credentials",
+            "nick": "sh-9K3Vk",
+            "port": 6667,
+            "secure": false,
+            "server": "irc.freenode.net"
+        },
+        "error": "Error: /object: must match exactly one schema in oneOf: " +
+            "credentials, feed, message, me, person, room, service, website, " +
+            "attendance, presence, relationship, topic, address"
+    },
+    {
+        "name": "alone credentials (as credentials)",
+        "valid": false,
+        "type": "credentials",
+        "input": {
+            "type": "credentials",
+            "nick": "sh-9K3Vk",
+            "port": 6667,
+            "secure": false,
+            "server": "irc.freenode.net"
+        },
+        "error": "Error: platform context undefined not registered with this Sockethub instance."
+    },
+    {
+        "name": "new person",
+        "valid": true,
+        "type": "activity-object",
+        "input": {
+            "id": "sh-9K3Vk@irc.freenode.net",
+            "type": "person",
+            "name": "sh-9K3Vk",
+            "image": {
+                "height": 250,
+                "mediaType": "image/jpeg",
+                "url": "http://example.org/image.jpg",
+                "width": 250
+            },
+            "url": "http://sockethub.org"
+        },
+        "output": "same"
+    },
+    {
+        "name": "new person",
+        "valid": true,
+        "type": "activity-object",
+        "input": {
+            "id": "irc://sh-9K3Vk@irc.freenode.net",
+            "type": "person",
+            "name": "sh-9K3Vk",
+            "url": "http://sockethub.org"
+        },
+        "output": "same"
+    },
+    {
+        "name": "bad parent object",
+        "valid": false,
+        "type": "activity-stream",
+        "input": {
+            "string": "this is a string",
+            "array": [
+                "this",
+                "is",
+                {
+                    "an": "array"
+                }
+            ],
+            "as": {
+                "id": "blah",
+                "type": "send",
+                "context": "hello",
+                "actor": {
+                    "name": "dood"
+                },
+                "target": {
+                    "type": "person",
+                    "name": "bob"
+                },
+                "object": {
+                    "type": "credentials"
+                }
+            },
+            "noId": {
+                "name": "dood"
+            },
+            "noId2": {
+                "type": "person",
+                "name": "bob"
+            },
+            "noDisplayName": {
+                "id": "larg"
+            }
+        },
+        "error": "Error: platform context undefined not registered with this Sockethub instance."
+    },
+    {
+        "name": "unexpected AS",
+        "valid": false,
+        "type": "message",
+        "input": {
+            "actor": "irc://uuu@localhost",
+            "type": "join",
+            "context": "fake",
+            "target": "irc://irc.dooder.net/a-room"
+        },
+        "error": "Error: /actor: must be object"
+    },
+    {
+        "name": "missing type property",
+        "valid": false,
+        "type": "message",
+        "input": {
+            "actor": { "id": "irc://uuu@localhost", "type": "person" },
+            "context": "fake",
+            "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
+        },
+        "error": "Error: activity stream: must have required property \'type\'"
+    },
+    {
+        "name": "invalid context property",
+        "valid": false,
+        "type": "message",
+        "input": {
+            "actor": { "id": "irc://uuu@localhost", "type": "person" },
+            "type": "foo",
+            "context": "foobar",
+            "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
+        },
+        "error": "Error: platform context foobar not registered with this Sockethub instance."
+    },
+    {
+        "name": "missing actor property",
+        "valid": false,
+        "type": "message",
+        "input": {
+            "type": "foo",
+            "context": "fake",
+            "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
+        },
+        "error": "Error: activity stream: must have required property \'actor\'"
+    },
+    {
+        "name": "traditional message",
+        "valid": true,
+        "type": "message",
+        "input": {
+            "type": "echo",
+            "context": "fake",
+            "actor": { "id": "irc://uuu@localhost", "type": "person" }
+        }
+    },
+    {
+        "name": "message with wrong type",
+        "valid": false,
+        "type": "message",
+        "input": {
+            "type": "foorg",
+            "context": "fake",
+            "actor": { "id": "irc://uuu@localhost", "type": "person" }
+        },
+        "error": "Error: platform type foorg not supported by fake platform. " +
+            "(types: credentials, echo, fail)"
+    }
+];
+//# sourceMappingURL=/middleware/validate.test.data.js.map

package/dist/middleware/validate.test.data.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.test.data.js","sourceRoot":"/","sources":["middleware/validate.test.data.ts"],"names":[],"mappings":";;AAAA,kBAAe;IACb;QACE,MAAM,EAAE,kBAAkB;QAC1B,OAAO,EAAE,KAAK;QACd,MAAM,EAAE,aAAa;QACrB,OAAO,EAAC;YACN,IAAI,EAAC,MAAM;YACX,MAAM,EAAC,MAAM;YACb,SAAS,EAAC,MAAM;YAChB,OAAO,EAAC;gBACN,IAAI,EAAC,uBAAuB;gBAC5B,MAAM,EAAC,QAAQ;gBACf,MAAM,EAAC,MAAM;aACd;YACD,QAAQ,EAAC;gBACP,IAAI,EAAC,0BAA0B;gBAC/B,MAAM,EAAC,QAAQ;gBACf,MAAM,EAAC,SAAS;aACjB;YACD,QAAQ,EAAC;gBACP,MAAM,EAAC,aAAa;gBACpB,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,KAAK;aACd;SACF;QACD,OAAO,EAAE,sEAAsE;KAChF;IACD;QACE,MAAM,EAAE,OAAO;QACf,OAAO,EAAC,IAAI;QACZ,MAAM,EAAC,aAAa;QACpB,OAAO,EAAC;YACN,IAAI,EAAC,MAAM;YACX,MAAM,EAAC,aAAa;YACpB,SAAS,EAAC,MAAM;YAChB,OAAO,EAAC;gBACN,IAAI,EAAC,uBAAuB;gBAC5B,MAAM,EAAC,QAAQ;gBACf,MAAM,EAAC,MAAM;aACd;YACD,QAAQ,EAAC;gBACP,MAAM,EAAE,aAAa;gBACrB,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,KAAK;aACd;SACF;QACD,QAAQ,EAAC,MAAM;KAChB;IACD;QACE,MAAM,EAAC,mBAAmB;QAC1B,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,aAAa;QACpB,OAAO,EAAC;YACN,OAAO,EAAC,qBAAqB;YAC7B,SAAS,EAAC,MAAM;YAChB,QAAQ,EAAC;gBACP,UAAU,EAAC,WAAW;gBACtB,UAAU,EAAC,KAAK;gBAChB,QAAQ,EAAC,WAAW;gBACpB,MAAM,EAAC,IAAI;gBACX,UAAU,EAAC,QAAQ;aACpB;SACF;QACD,OAAO,EAAE,sEAAsE;KAChF;IACD;QACE,MAAM,EAAC,cAAc;QACrB,MAAM,EAAC,iBAAiB;QACxB,OAAO,EAAC,IAAI;QACZ,OAAO,EAAC;YACN,IAAI,EAAC,MAAM;YACX,MAAM,EAAC,QAAQ;YACf,MAAM,EAAC,MAAM;SACd;QACD,QAAQ,EAAC,MAAM;KAChB;IACD;QACE,MAAM,EAAC,oBAAoB;QAC3B,OAAO,EAAC,IAAI;QACZ,MAAM,EAAC,iBAAiB;QACxB,OAAO,EAAC;YACN,IAAI,EAAC,MAAM;YACX,MAAM,EAAC,QAAQ;YACf,MAAM,EAAC,KAAK;YACZ,OAAO,EAAC,OAAO;YACf,GAAG,EAAC;gBACF,IAAI;gBACJ,QAAQ;aACT;SACF;QACD,QAAQ,EAAC,MAAM;KAChB;IACD;QACE,MAAM,EAAC,wCAAwC;QAC/C,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,iBAAiB;QACxB,OAAO,EAAC;YACN,MAAM,EAAC,aAAa;YACpB,MAAM,EAAC,UAAU;YACjB,MAAM,EAAC,IAAI;YACX,QAAQ,EAAC,KAAK;YACd,QAAQ,EAAC,kBAAkB;SAC5B;QACD,OAAO,EACL,0DAA0D;YAC1D,kEAAkE;YAClE,oDAAoD;KACvD;IACD;QACE,MAAM,EAAC,oCAAoC;QAC3C,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,aAAa;QACpB,OAAO,EAAC;YACN,MAAM,EAAC,aAAa;YACpB,MAAM,EAAC,UAAU;YACjB,MAAM,EAAC,IAAI;YACX,QAAQ,EAAC,KAAK;YACd,QAAQ,EAAC,kBAAkB;SAC5B;QACD,OAAO,EAAE,gFAAgF;KAC1F;IACD;QACE,MAAM,EAAC,YAAY;QACnB,OAAO,EAAC,IAAI;QACZ,MAAM,EAAC,iBAAiB;QACxB,OAAO,EAAC;YACN,IAAI,EAAC,2BAA2B;YAChC,MAAM,EAAC,QAAQ;YACf,MAAM,EAAC,UAAU;YACjB,OAAO,EAAC;gBACN,QAAQ,EAAC,GAAG;gBACZ,WAAW,EAAC,YAAY;gBACxB,KAAK,EAAC,8BAA8B;gBACpC,OAAO,EAAC,GAAG;aACZ;YACD,KAAK,EAAC,sBAAsB;SAC7B;QACD,QAAQ,EAAC,MAAM;KAChB;IACD;QACE,MAAM,EAAC,YAAY;QACnB,OAAO,EAAC,IAAI;QACZ,MAAM,EAAC,iBAAiB;QACxB,OAAO,EAAC;YACN,IAAI,EAAC,iCAAiC;YACtC,MAAM,EAAC,QAAQ;YACf,MAAM,EAAC,UAAU;YACjB,KAAK,EAAC,sBAAsB;SAC7B;QACD,QAAQ,EAAC,MAAM;KAChB;IACD;QACE,MAAM,EAAC,mBAAmB;QAC1B,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,iBAAiB;QACxB,OAAO,EAAC;YACN,QAAQ,EAAC,kBAAkB;YAC3B,OAAO,EAAC;gBACN,MAAM;gBACN,IAAI;gBACJ;oBACE,IAAI,EAAC,OAAO;iBACb;aACF;YACD,IAAI,EAAC;gBACH,IAAI,EAAC,MAAM;gBACX,MAAM,EAAC,MAAM;gBACb,SAAS,EAAC,OAAO;gBACjB,OAAO,EAAC;oBACN,MAAM,EAAC,MAAM;iBACd;gBACD,QAAQ,EAAC;oBACP,MAAM,EAAC,QAAQ;oBACf,MAAM,EAAC,KAAK;iBACb;gBACD,QAAQ,EAAC;oBACP,MAAM,EAAC,aAAa;iBACrB;aACF;YACD,MAAM,EAAC;gBACL,MAAM,EAAC,MAAM;aACd;YACD,OAAO,EAAC;gBACN,MAAM,EAAC,QAAQ;gBACf,MAAM,EAAC,KAAK;aACb;YACD,eAAe,EAAC;gBACd,IAAI,EAAC,MAAM;aACZ;SACF;QACD,OAAO,EAAE,gFAAgF;KAC1F;IACD;QACE,MAAM,EAAC,eAAe;QACtB,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,SAAS;QAChB,OAAO,EAAC;YACN,OAAO,EAAC,qBAAqB;YAC7B,MAAM,EAAC,MAAM;YACb,SAAS,EAAC,MAAM;YAChB,QAAQ,EAAC,6BAA6B;SACvC;QACD,OAAO,EAAE,+BAA+B;KACzC;IACD;QACE,MAAM,EAAC,uBAAuB;QAC9B,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,SAAS;QAChB,OAAO,EAAC;YACN,OAAO,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ,EAAE;YAC1D,SAAS,EAAC,MAAM;YAChB,QAAQ,EAAE,EAAE,IAAI,EAAE,6BAA6B,EAAE,MAAM,EAAE,MAAM,EAAE;SAClE;QACD,OAAO,EAAE,8DAA8D;KACxE;IACD;QACE,MAAM,EAAC,0BAA0B;QACjC,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,SAAS;QAChB,OAAO,EAAC;YACN,OAAO,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ,EAAE;YAC1D,MAAM,EAAC,KAAK;YACZ,SAAS,EAAE,QAAQ;YACnB,QAAQ,EAAE,EAAE,IAAI,EAAE,6BAA6B,EAAE,MAAM,EAAE,MAAM,EAAE;SAClE;QACD,OAAO,EAAE,6EAA6E;KACvF;IACD;QACE,MAAM,EAAC,wBAAwB;QAC/B,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,SAAS;QAChB,OAAO,EAAC;YACN,MAAM,EAAE,KAAK;YACb,SAAS,EAAC,MAAM;YAChB,QAAQ,EAAE,EAAE,IAAI,EAAE,6BAA6B,EAAE,MAAM,EAAE,MAAM,EAAE;SAClE;QACD,OAAO,EAAE,+DAA+D;KACzE;IACD;QACE,MAAM,EAAC,qBAAqB;QAC5B,OAAO,EAAC,IAAI;QACZ,MAAM,EAAC,SAAS;QAChB,OAAO,EAAC;YACN,MAAM,EAAE,MAAM;YACd,SAAS,EAAE,MAAM;YACjB,OAAO,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ,EAAE;SAC3D;KACF;IACD;QACE,MAAM,EAAC,yBAAyB;QAChC,OAAO,EAAC,KAAK;QACb,MAAM,EAAC,SAAS;QAChB,OAAO,EAAC;YACN,MAAM,EAAE,OAAO;YACf,SAAS,EAAE,MAAM;YACjB,OAAO,EAAE,EAAE,IAAI,EAAE,qBAAqB,EAAE,MAAM,EAAE,QAAQ,EAAE;SAC3D;QACD,OAAO,EAAE,6DAA6D;YACpE,kCAAkC;KACrC;CACF,CAAC"}

package/dist/middleware.d.ts

@@ -0,0 +1,10 @@
+export default function middleware(name: string): MiddlewareChain;
+export declare class MiddlewareChain {
+    name: string;
+    private chain;
+    private errHandler;
+    private logger;
+    constructor(name: string);
+    use(func: Function): this;
+    done(): (data: any, callback: Function) => void;
+}

package/dist/middleware.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiddlewareChain = void 0;
+const debug_1 = require("debug");
+function middleware(name) {
+    return new MiddlewareChain(name);
+}
+exports.default = middleware;
+class MiddlewareChain {
+    constructor(name) {
+        this.chain = [];
+        this.errHandler = (err) => { throw err; };
+        this.name = name;
+        this.logger = (0, debug_1.debug)(`sockethub:middleware:${name}`);
+    }
+    use(func) {
+        if (typeof func !== 'function') {
+            throw new Error('middleware use() can only take a function as an argument');
+        }
+        if (func.length === 3) {
+            this.errHandler = func;
+        }
+        else if (func.length === 2) {
+            this.chain.push(func);
+        }
+        else {
+            throw new Error('middleware function provided with incorrect number of params: ' + func.length);
+        }
+        return this;
+    }
+    done() {
+        return (data, callback) => {
+            let position = 0;
+            if (typeof callback !== 'function') {
+                callback = () => { };
+            }
+            const next = (_data) => {
+                if (_data instanceof Error) {
+                    this.logger(_data);
+                    this.errHandler(_data, data, callback);
+                }
+                else if (typeof this.chain[position] === 'function') {
+                    this.chain[position++](_data, next);
+                }
+                else {
+                    callback(_data);
+                }
+            };
+            next(data);
+        };
+    }
+}
+exports.MiddlewareChain = MiddlewareChain;
+//# sourceMappingURL=/middleware.js.map

package/dist/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"/","sources":["middleware.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAE9B,SAAwB,UAAU,CAAC,IAAY;IAC7C,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAFD,6BAEC;AAED,MAAa,eAAe;IAM1B,YAAY,IAAY;QAJhB,UAAK,GAAoB,EAAE,CAAC;QAC5B,eAAU,GAAa,CAAC,GAAU,EAAE,EAAE,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QAI5D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,IAAA,aAAK,EAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,GAAG,CAAC,IAAc;QAChB,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;YAC9B,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;SAC7E;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YACrB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;SACxB;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACvB;aAAM;YACL,MAAM,IAAI,KAAK,CACb,gEAAgE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;SACnF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI;QACF,OAAO,CAAC,IAAS,EAAE,QAAkB,EAAE,EAAE;YACvC,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;gBAClC,QAAQ,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;aACrB;YACD,MAAM,IAAI,GAAG,CAAC,KAAU,EAAE,EAAE;gBAC1B,IAAI,KAAK,YAAY,KAAK,EAAE;oBAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBACnB,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;iBACxC;qBAAM,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,UAAU,EAAE;oBACrD,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;iBACrC;qBAAM;oBACL,QAAQ,CAAC,KAAK,CAAC,CAAC;iBACjB;YACH,CAAC,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,CAAC;QACb,CAAC,CAAC;IACJ,CAAC;CACF;AA7CD,0CA6CC"}

package/dist/platform-instance.d.ts

@@ -0,0 +1,77 @@
+/// <reference types="node" />
+import { ChildProcess } from 'child_process';
+import { Debugger } from 'debug';
+import Queue from 'bull';
+import { IActivityStream } from '@sockethub/schemas';
+export declare const platformInstances: Map<string, PlatformInstance>;
+export interface PlatformInstanceParams {
+    identifier: string;
+    platform: string;
+    parentId?: string;
+    actor?: string;
+}
+export interface MessageFromParent extends Array<string | any> {
+    0: string;
+    1: any;
+}
+interface PlatformConfig {
+    persist?: boolean;
+    requireCredentials?: Array<string>;
+}
+export default class PlatformInstance {
+    flaggedForTermination: boolean;
+    id: string;
+    queue: Queue;
+    completedJobHandlers: Map<string, Function>;
+    config: PlatformConfig;
+    readonly name: string;
+    readonly process: ChildProcess;
+    readonly debug: Debugger;
+    readonly parentId: string;
+    readonly sessions: Set<string>;
+    readonly sessionCallbacks: object;
+    readonly global?: boolean;
+    private readonly actor?;
+    constructor(params: PlatformInstanceParams);
+    /**
+     * Destroys all references to this platform instance, internal listeners and controlled processes
+     */
+    destroy(): Promise<void>;
+    /**
+     * When jobs are completed or failed, we prepare the results and send them to the client socket
+     */
+    initQueue(secret: string): void;
+    /**
+     * Register listener to be called when the process emits a message.
+     * @param sessionId ID of socket connection that will receive messages from platform emits
+     */
+    registerSession(sessionId: string): void;
+    /**
+     * Sends a message to client (user), can be registered with an event emitted from the platform
+     * process.
+     * @param sessionId ID of the socket connection to send the message to
+     * @param msg ActivityStream object to send to client
+     */
+    sendToClient(sessionId: string, msg: IActivityStream): void;
+    private broadcastToSharedPeers;
+    private handleJobResult;
+    /**
+     * Sends error message to client and clears all references to this class.
+     * @param sessionId
+     * @param errorMessage
+     */
+    private reportError;
+    /**
+     * Updates the instance with a new identifier, updating the platformInstances mapping as well.
+     * @param identifier
+     */
+    private updateIdentifier;
+    /**
+     * Generates a function tied to a given client session (socket connection), the generated
+     * function will be called for each session ID registered, for every platform emit.
+     * @param listener
+     * @param sessionId
+     */
+    private callbackFunction;
+}
+export {};

package/dist/platform-instance.js

@@ -0,0 +1,211 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.platformInstances = void 0;
+const child_process_1 = require("child_process");
+const path_1 = require("path");
+const debug_1 = require("debug");
+const bull_1 = __importDefault(require("bull"));
+const config_1 = __importDefault(require("./config"));
+const listener_1 = require("./listener");
+const common_1 = require("./common");
+// collection of platform instances, stored by `id`
+exports.platformInstances = new Map();
+class PlatformInstance {
+    constructor(params) {
+        this.flaggedForTermination = false;
+        this.completedJobHandlers = new Map();
+        this.config = {};
+        this.sessions = new Set();
+        this.sessionCallbacks = {
+            'close': (() => new Map())(),
+            'message': (() => new Map())()
+        };
+        this.global = false;
+        this.id = params.identifier;
+        this.name = params.platform;
+        this.parentId = params.parentId;
+        if (params.actor) {
+            this.actor = params.actor;
+        }
+        else {
+            this.global = true;
+        }
+        this.debug = (0, debug_1.debug)(`sockethub:platform-instance:${this.id}`);
+        // spin off a process
+        const env = config_1.default.get('redis:url') ? { REDIS_URL: config_1.default.get('redis:url') }
+            : { REDIS_HOST: config_1.default.get('redis:host'), REDIS_PORT: config_1.default.get('redis:port') };
+        this.process = (0, child_process_1.fork)((0, path_1.join)(__dirname, 'platform.js'), [this.parentId, this.name, this.id], { env: env });
+    }
+    /**
+     * Destroys all references to this platform instance, internal listeners and controlled processes
+     */
+    async destroy() {
+        this.debug(`cleaning up`);
+        this.flaggedForTermination = true;
+        try {
+            await this.queue.removeAllListeners();
+        }
+        catch (e) { }
+        try {
+            await this.queue.obliterate({ force: true });
+        }
+        catch (e) { }
+        try {
+            delete this.queue;
+            await this.process.removeAllListeners('close');
+            await this.process.unref();
+            await this.process.kill();
+        }
+        catch (e) { }
+        exports.platformInstances.delete(this.id);
+    }
+    /**
+     * When jobs are completed or failed, we prepare the results and send them to the client socket
+     */
+    initQueue(secret) {
+        this.queue = new bull_1.default(this.parentId + this.id, { redis: config_1.default.get('redis') });
+        this.queue.on('global:completed', (jobId, resultString) => {
+            const result = resultString ? JSON.parse(resultString) : "";
+            this.queue.getJob(jobId).then(async (job) => {
+                await this.handleJobResult('completed', (0, common_1.decryptJobData)(job, secret), result);
+                await job.remove();
+            });
+        });
+        this.queue.on('global:error', (jobId, result) => {
+            this.debug("unknown queue error", jobId, result);
+        });
+        this.queue.on('global:failed', (jobId, result) => {
+            this.queue.getJob(jobId).then(async (job) => {
+                await this.handleJobResult('failed', (0, common_1.decryptJobData)(job, secret), result);
+                await job.remove();
+            });
+        });
+    }
+    /**
+     * Register listener to be called when the process emits a message.
+     * @param sessionId ID of socket connection that will receive messages from platform emits
+     */
+    registerSession(sessionId) {
+        if (!this.sessions.has(sessionId)) {
+            this.sessions.add(sessionId);
+            for (let type of Object.keys(this.sessionCallbacks)) {
+                const cb = this.callbackFunction(type, sessionId);
+                this.process.on(type, cb);
+                this.sessionCallbacks[type].set(sessionId, cb);
+            }
+        }
+    }
+    /**
+     * Sends a message to client (user), can be registered with an event emitted from the platform
+     * process.
+     * @param sessionId ID of the socket connection to send the message to
+     * @param msg ActivityStream object to send to client
+     */
+    sendToClient(sessionId, msg) {
+        (0, listener_1.getSocket)(sessionId).then((socket) => {
+            try {
+                // this property should never be exposed externally
+                delete msg.sessionSecret;
+            }
+            catch (e) { }
+            msg.context = this.name;
+            if ((msg.type === 'error') && (typeof msg.actor === 'undefined') && (this.actor)) {
+                // ensure an actor is present if not otherwise defined
+                msg.actor = { id: this.actor, type: 'unknown' };
+            }
+            socket.emit('message', msg);
+        }, (err) => this.debug(`sendToClient ${err}`));
+    }
+    // send message to every connected socket associated with this platform instance.
+    async broadcastToSharedPeers(sessionId, msg) {
+        for (let sid of this.sessions.values()) {
+            if (sid !== sessionId) {
+                this.debug(`broadcasting message to ${sid}`);
+                await this.sendToClient(sid, msg);
+            }
+        }
+    }
+    // handle job results coming in on the queue from platform instances
+    async handleJobResult(type, jobData, result) {
+        this.debug(`${type} job ${jobData.title}`);
+        delete jobData.msg.sessionSecret;
+        let msg = jobData.msg;
+        if (type === 'failed') {
+            msg.error = result ? result : "job failed for unknown reason";
+            if ((this.config.persist) && (this.config.requireCredentials.includes(jobData.msg.type))) {
+                this.debug(`critical job type ${jobData.msg.type} failed, terminating platform instance`);
+                await this.destroy();
+            }
+        }
+        // send result to client
+        const callback = this.completedJobHandlers.get(jobData.title);
+        if (callback) {
+            callback(msg);
+            this.completedJobHandlers.delete(jobData.title);
+        }
+        else {
+            await this.sendToClient(jobData.sessionId, msg);
+        }
+        // let all related peers know of result as an independent message
+        // (not as part of a job completion, or failure)
+        await this.broadcastToSharedPeers(jobData.sessionId, msg);
+    }
+    /**
+     * Sends error message to client and clears all references to this class.
+     * @param sessionId
+     * @param errorMessage
+     */
+    async reportError(sessionId, errorMessage) {
+        const errorObject = {
+            context: this.name,
+            type: 'error',
+            actor: { id: this.actor, type: 'unknown' },
+            error: errorMessage
+        };
+        this.sendToClient(sessionId, errorObject);
+        this.sessions.clear();
+        await this.destroy();
+    }
+    /**
+     * Updates the instance with a new identifier, updating the platformInstances mapping as well.
+     * @param identifier
+     */
+    updateIdentifier(identifier) {
+        exports.platformInstances.delete(this.id);
+        this.id = identifier;
+        exports.platformInstances.set(this.id, this);
+    }
+    /**
+     * Generates a function tied to a given client session (socket connection), the generated
+     * function will be called for each session ID registered, for every platform emit.
+     * @param listener
+     * @param sessionId
+     */
+    callbackFunction(listener, sessionId) {
+        const funcs = {
+            'close': (e) => {
+                this.debug(`close even triggered ${this.id}: ${e}`);
+                this.reportError(sessionId, `Error: session thread closed unexpectedly: ${e}`);
+            },
+            'message': (data) => {
+                if (data[0] === 'updateActor') {
+                    // We need to update the key to the store in order to find it in the future.
+                    this.updateIdentifier(data[2]);
+                }
+                else if (data[0] === 'error') {
+                    this.reportError(sessionId, data[1]);
+                }
+                else {
+                    // treat like a message to clients
+                    this.sendToClient(sessionId, data[1]);
+                }
+            }
+        };
+        return funcs[listener];
+    }
+}
+exports.default = PlatformInstance;
+//# sourceMappingURL=/platform-instance.js.map

package/dist/platform-instance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform-instance.js","sourceRoot":"/","sources":["platform-instance.ts"],"names":[],"mappings":";;;;;;AAAA,iDAAmD;AACnD,+BAA4B;AAC5B,iCAAwC;AACxC,gDAAyB;AAGzB,sDAA8B;AAE9B,yCAAuC;AACvC,qCAA0C;AAE1C,mDAAmD;AACtC,QAAA,iBAAiB,GAAG,IAAI,GAAG,EAA4B,CAAC;AAkBrE,MAAqB,gBAAgB;IAkBnC,YAAY,MAA8B;QAjB1C,0BAAqB,GAAY,KAAK,CAAC;QAGvC,yBAAoB,GAA0B,IAAI,GAAG,EAAE,CAAC;QACxD,WAAM,GAAmB,EAAE,CAAC;QAKnB,aAAQ,GAAgB,IAAI,GAAG,EAAE,CAAC;QAClC,qBAAgB,GAAW;YAClC,OAAO,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE;YAC5B,SAAS,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,EAAE;SAC/B,CAAC;QACc,WAAM,GAAa,KAAK,CAAC;QAIvC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;QAChC,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;SAC3B;aAAM;YACL,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;SACpB;QAED,IAAI,CAAC,KAAK,GAAG,IAAA,aAAK,EAAC,+BAA+B,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAC7D,qBAAqB;QACrB,MAAM,GAAG,GAAG,gBAAM,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,gBAAM,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;YAC1E,CAAC,CAAC,EAAE,UAAU,EAAE,gBAAM,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,gBAAM,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;QACnF,IAAI,CAAC,OAAO,GAAG,IAAA,oBAAI,EACjB,IAAA,WAAI,EAAC,SAAS,EAAE,aAAa,CAAC,EAC9B,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,EACnC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;QAClB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1B,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAClC,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC;SACvC;QAAC,OAAO,CAAC,EAAE,GAAG;QACf,IAAI;YACF,MAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;SAC9C;QAAC,OAAO,CAAC,EAAE,GAAG;QACf,IAAI;YACF,OAAO,IAAI,CAAC,KAAK,CAAC;YAClB,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC3B,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SAC3B;QAAC,OAAO,CAAC,EAAE,GAAG;QACf,yBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,GAAG,IAAI,cAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,gBAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAEhF,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,kBAAkB,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE;YACxD,MAAM,MAAM,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,GAAiB,EAAE,EAAE;gBACxD,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,IAAA,uBAAc,EAAC,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;gBAC7E,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC9C,IAAI,CAAC,KAAK,CAAC,qBAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;YAC/C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,GAAiB,EAAE,EAAE;gBACxD,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAA,uBAAc,EAAC,GAAG,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC;gBAC1E,MAAM,GAAG,CAAC,MAAM,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,SAAiB;QACtC,IAAI,CAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC7B,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE;gBACnD,MAAM,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAClD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBAC1B,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;aAChD;SACF;IACH,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,SAAiB,EAAE,GAAoB;QACzD,IAAA,oBAAS,EAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;YACnC,IAAI;gBACF,mDAAmD;gBACnD,OAAO,GAAG,CAAC,aAAa,CAAC;aAC1B;YAAC,OAAO,CAAC,EAAE,GAAE;YACd,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;YACxB,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,KAAK,KAAK,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAChF,sDAAsD;gBACtD,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;aACjD;YACD,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAC9B,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,GAAG,EAAE,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,iFAAiF;IACzE,KAAK,CAAC,sBAAsB,CAAC,SAAiB,EAAE,GAAoB;QAC1E,KAAK,IAAI,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YACtC,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,IAAI,CAAC,KAAK,CAAC,2BAA2B,GAAG,EAAE,CAAC,CAAC;gBAC7C,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aACnC;SACF;IACH,CAAC;IAED,oEAAoE;IAC5D,KAAK,CAAC,eAAe,CAAC,IAAY,EAAE,OAAyB,EAAE,MAAM;QAC3E,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,QAAQ,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAC3C,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC;QACjC,IAAI,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACtB,IAAI,IAAI,KAAK,QAAQ,EAAE;YACrB,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,+BAA+B,CAAC;YAC9D,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE;gBACxF,IAAI,CAAC,KAAK,CAAC,qBAAqB,OAAO,CAAC,GAAG,CAAC,IAAI,wCAAwC,CAAC,CAAC;gBAC1F,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;aACtB;SACF;QAED,wBAAwB;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC9D,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,GAAG,CAAC,CAAC;YACd,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SACjD;aAAM;YACL,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;SACjD;QAED,iEAAiE;QACjE,gDAAgD;QAChD,MAAM,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,YAAiB;QAC5D,MAAM,WAAW,GAAoB;YACnC,OAAO,EAAE,IAAI,CAAC,IAAI;YAClB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE;YAC1C,KAAK,EAAE,YAAY;SACpB,CAAC;QACF,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAED;;;OAGG;IACK,gBAAgB,CAAC,UAAkB;QACzC,yBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClC,IAAI,CAAC,EAAE,GAAG,UAAU,CAAC;QACrB,yBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACK,gBAAgB,CAAC,QAAgB,EAAE,SAAiB;QAC1D,MAAM,KAAK,GAAG;YACZ,OAAO,EAAE,CAAC,CAAS,EAAE,EAAE;gBACrB,IAAI,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;gBACpD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,8CAA8C,CAAC,EAAE,CAAC,CAAC;YACjF,CAAC;YACD,SAAS,EAAE,CAAC,IAAyB,EAAE,EAAE;gBACvC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,aAAa,EAAE;oBAC7B,4EAA4E;oBAC5E,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;iBAChC;qBAAM,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE;oBAC9B,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;iBACtC;qBAAM;oBACL,kCAAkC;oBAClC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;iBACvC;YACH,CAAC;SACF,CAAC;QACF,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;CACF;AAnND,mCAmNC"}

package/dist/platform.d.ts

@@ -0,0 +1,6 @@
+import { IActivityStream } from "@sockethub/schemas";
+export interface PlatformSession {
+    debug(msg: string): void;
+    sendToClient(msg: IActivityStream, special?: string): void;
+    updateActor(credentials: object): void;
+}