@sockethub/server 5.0.0-alpha.4 → 5.0.0-alpha.6

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

@@ -1,263 +0,0 @@
-"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": "https://example.org/image.jpg",
-                "width": 250
-            },
-            "url": "https://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": "https://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

@@ -1 +0,0 @@
-{"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,+BAA+B;gBACrC,OAAO,EAAC,GAAG;aACZ;YACD,KAAK,EAAC,uBAAuB;SAC9B;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,uBAAuB;SAC9B;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,4DAA4D;KACtE;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,6DAA6D;KACvE;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

@@ -1,21 +0,0 @@
-import { IActivityStream } from "@sockethub/schemas";
-export default function middleware(name: string): MiddlewareChain;
-export interface MiddlewareChainInterface {
-    (error: IActivityStream | Error, data?: IActivityStream | MiddlewareChainInterface, next?: MiddlewareChainInterface): void;
-}
-interface ErrorHandlerInterface {
-    (err: Error, data?: unknown, cb?: unknown): void;
-}
-export interface LogErrorInterface {
-    (msg: Error): void;
-}
-export declare class MiddlewareChain {
-    name: string;
-    private chain;
-    private errHandler;
-    private readonly logger;
-    constructor(name: string);
-    use(func: ErrorHandlerInterface | MiddlewareChainInterface): this;
-    done(): (data: unknown, callback: MiddlewareChainInterface) => void;
-}
-export {};

package/dist/middleware.js

@@ -1,56 +0,0 @@
-"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 = () => {
-                    // ensure we have a callback function
-                };
-            }
-            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

@@ -1 +0,0 @@
-{"version":3,"file":"middleware.js","sourceRoot":"/","sources":["middleware.ts"],"names":[],"mappings":";;;AAAA,iCAA8B;AAG9B,SAAwB,UAAU,CAAC,IAAY;IAC7C,OAAO,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAFD,6BAEC;AAgBD,MAAa,eAAe;IAM1B,YAAY,IAAY;QAJhB,UAAK,GAAoC,EAAE,CAAC;QAC5C,eAAU,GAA0B,CAAC,GAAU,EAAE,EAAE,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QAIzE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,IAAA,aAAK,EAAC,wBAAwB,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,GAAG,CAAC,IAAsD;QACxD,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,IAA6B,CAAC;SACjD;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAgC,CAAC,CAAC;SACnD;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,IAAa,EAAE,QAAkC,EAAE,EAAE;YAC3D,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;gBAClC,QAAQ,GAAG,GAAG,EAAE;oBACd,qCAAqC;gBACvC,CAAC,CAAC;aACH;YACD,MAAM,IAAI,GAAG,CAAC,KAAc,EAAE,EAAE;gBAC9B,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,KAAwB,EAAE,IAAI,CAAC,CAAC;iBACxD;qBAAM;oBACL,QAAQ,CAAC,KAAwB,CAAC,CAAC;iBACpC;YACH,CAAC,CAAC;YACF,IAAI,CAAC,IAAI,CAAC,CAAC;QACb,CAAC,CAAC;IACJ,CAAC;CACF;AA/CD,0CA+CC"}

package/dist/platform-instance.d.ts

@@ -1,78 +0,0 @@
-/// <reference types="node" />
-import { ChildProcess } from 'child_process';
-import { Debugger } from 'debug';
-import { IActivityStream, CompletedJobHandler } from "@sockethub/schemas";
-import { JobQueue } from "@sockethub/data-layer";
-export declare const platformInstances: Map<string, PlatformInstance>;
-export interface PlatformInstanceParams {
-    identifier: string;
-    platform: string;
-    parentId?: string;
-    actor?: string;
-}
-export interface MessageFromParent extends Array<string | unknown> {
-    0: string;
-    1: unknown;
-}
-interface PlatformConfig {
-    persist?: boolean;
-    requireCredentials?: Array<string>;
-}
-export default class PlatformInstance {
-    id: string;
-    flaggedForTermination: boolean;
-    initialized: boolean;
-    jobQueue: JobQueue;
-    readonly global: boolean;
-    readonly completedJobHandlers: Map<string, CompletedJobHandler>;
-    readonly config: PlatformConfig;
-    readonly name: string;
-    readonly process: ChildProcess;
-    readonly debug: Debugger;
-    readonly parentId: string;
-    readonly sessions: Set<string>;
-    readonly sessionCallbacks: object;
-    private readonly actor?;
-    constructor(params: PlatformInstanceParams);
-    /**
-     * Destroys all references to this platform instance, internal listeners and controlled processes
-     */
-    shutdown(): 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

@@ -1,226 +0,0 @@
-"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 data_layer_1 = require("@sockethub/data-layer");
-const config_1 = __importDefault(require("./config"));
-const listener_1 = require("./listener");
-const nconf_1 = __importDefault(require("nconf"));
-// collection of platform instances, stored by `id`
-exports.platformInstances = new Map();
-class PlatformInstance {
-    constructor(params) {
-        this.flaggedForTermination = false;
-        this.initialized = false;
-        this.global = false;
-        this.completedJobHandlers = new Map();
-        this.config = {};
-        this.sessions = new Set();
-        this.sessionCallbacks = {
-            'close': (() => new Map())(),
-            'message': (() => new Map())()
-        };
-        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:server:platform-instance:${this.id}`);
-        const env = {};
-        if (process.env.DEBUG) {
-            env.DEBUG = process.env.DEBUG;
-        }
-        if (config_1.default.get('redis:url')) {
-            env.REDIS_URL = config_1.default.get('redis:url');
-        }
-        else {
-            env.REDIS_HOST = config_1.default.get('redis:host');
-            env.REDIS_PORT = config_1.default.get('redis:port');
-        }
-        // spin off a process
-        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 shutdown() {
-        this.debug('shutdown');
-        this.flaggedForTermination = true;
-        try {
-            await this.process.removeAllListeners('close');
-            await this.process.unref();
-            this.process.kill();
-        }
-        catch (e) {
-            // needs to happen
-        }
-        try {
-            await this.jobQueue.shutdown();
-            delete this.jobQueue;
-        }
-        catch (e) {
-            // this needs to happen
-        }
-        try {
-            exports.platformInstances.delete(this.id);
-        }
-        catch (e) {
-            // this needs to happen
-        }
-    }
-    /**
-     * When jobs are completed or failed, we prepare the results and send them to the client socket
-     */
-    initQueue(secret) {
-        this.jobQueue = new data_layer_1.JobQueue(this.parentId, this.id, secret, nconf_1.default.get('redis'));
-        this.jobQueue.initResultEvents();
-        this.jobQueue.on('global:completed', async (job, result) => {
-            await this.handleJobResult('completed', job, result);
-        });
-        this.jobQueue.on('global:failed', async (job, result) => {
-            await this.handleJobResult('failed', job, result);
-        });
-    }
-    /**
-     * 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 (const 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;
-            }
-            finally {
-                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 (const 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, job, result) {
-        const msg = job.msg;
-        if (type === 'failed') {
-            msg.error = result ? result : "job failed for unknown reason";
-            this.debug(`${job.title} ${type}: ${msg.error}`);
-        }
-        // send result to client
-        const callback = this.completedJobHandlers.get(job.title);
-        if (callback) {
-            callback(msg);
-            this.completedJobHandlers.delete(job.title);
-        }
-        else {
-            await this.sendToClient(job.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(job.sessionId, msg);
-        if ((this.config.persist) && (this.config.requireCredentials.includes(job.msg.type))) {
-            if (type === 'failed') {
-                this.debug(`critical job type ${job.msg.type} failed, flagging for termination`);
-                await this.jobQueue.pause();
-                this.initialized = false;
-                this.flaggedForTermination = true;
-            }
-            else {
-                await this.jobQueue.resume();
-                this.initialized = true;
-                this.flaggedForTermination = false;
-            }
-        }
-    }
-    /**
-     * 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.shutdown();
-    }
-    /**
-     * 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': async (e) => {
-                this.debug(`close even triggered ${this.id}: ${e}`);
-                await this.reportError(sessionId, `Error: session thread closed unexpectedly: ${e}`);
-            },
-            'message': async ([first, second, third]) => {
-                if (first === 'updateActor') {
-                    // We need to update the key to the store in order to find it in the future.
-                    this.updateIdentifier(third);
-                }
-                else if ((first === 'error') && (typeof second === "string")) {
-                    await this.reportError(sessionId, second);
-                }
-                else {
-                    // treat like a message to clients
-                    this.sendToClient(sessionId, second);
-                }
-            }
-        };
-        return funcs[listener];
-    }
-}
-exports.default = PlatformInstance;
-//# sourceMappingURL=/platform-instance.js.map

package/dist/platform-instance.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"platform-instance.js","sourceRoot":"/","sources":["platform-instance.ts"],"names":[],"mappings":";;;;;;AAAA,iDAAkD;AAClD,+BAA4B;AAC5B,iCAAwC;AAExC,sDAAiE;AAEjE,sDAA8B;AAC9B,yCAAuC;AACvC,kDAA0B;AAE1B,mDAAmD;AACtC,QAAA,iBAAiB,GAAG,IAAI,GAAG,EAA4B,CAAC;AAyBrE,MAAqB,gBAAgB;IAmBnC,YAAY,MAA8B;QAjB1C,0BAAqB,GAAG,KAAK,CAAC;QAC9B,gBAAW,GAAG,KAAK,CAAC;QAEX,WAAM,GAAY,KAAK,CAAC;QACxB,yBAAoB,GAAqC,IAAI,GAAG,EAAE,CAAC;QACnE,WAAM,GAAmB,EAAE,CAAC;QAK5B,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;QAIA,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,sCAAsC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACpE,MAAM,GAAG,GAAc,EAAE,CAAC;QAC1B,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE;YACrB,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;SAC/B;QACD,IAAI,gBAAM,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;YAC3B,GAAG,CAAC,SAAS,GAAG,gBAAM,CAAC,GAAG,CAAC,WAAW,CAAW,CAAC;SACnD;aAAM;YACL,GAAG,CAAC,UAAU,GAAG,gBAAM,CAAC,GAAG,CAAC,YAAY,CAAW,CAAC;YACpD,GAAG,CAAC,UAAU,GAAG,gBAAM,CAAC,GAAG,CAAC,YAAY,CAAW,CAAC;SACrD;QAED,qBAAqB;QACrB,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,CACb,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ;QACnB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvB,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAElC,IAAI;YACF,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SACrB;QAAC,OAAO,CAAC,EAAE;YACV,kBAAkB;SACnB;QAED,IAAI;YACF,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC/B,OAAO,IAAI,CAAC,QAAQ,CAAC;SACtB;QAAC,OAAO,CAAC,EAAE;YACV,uBAAuB;SACxB;QAED,IAAI;YACF,yBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnC;QAAC,OAAO,CAAC,EAAE;YACV,uBAAuB;SACxB;IACH,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,MAAc;QAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,qBAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,eAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACjF,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAEjC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAAkB,EAAE,KAAK,EAAE,GAAqB,EAAE,MAAc,EAAE,EAAE;YACnF,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,eAAe,EAAE,KAAK,EAAE,GAAqB,EAAE,MAAc,EAAE,EAAE;YAChF,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACpD,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,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE;gBACrD,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;oBAAS;gBACR,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;gBACxB,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,KAAK,KAAK,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;oBAChF,sDAAsD;oBACtD,GAAG,CAAC,KAAK,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;iBACjD;gBACD,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;aAC7B;QACH,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,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;YACxC,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,GAAqB,EAAE,MAAM;QACvE,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC;QACpB,IAAI,IAAI,KAAK,QAAQ,EAAE;YACrB,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,+BAA+B,CAAC;YAC9D,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,IAAI,IAAI,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;SAElD;QAED,wBAAwB;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,QAAQ,EAAE;YACZ,QAAQ,CAAC,GAAG,CAAC,CAAC;YACd,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;SAC7C;aAAM;YACL,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;SAC7C;QAED,iEAAiE;QACjE,gDAAgD;QAChD,MAAM,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAEtD,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE;YACpF,IAAI,IAAI,KAAK,QAAQ,EAAE;gBACrB,IAAI,CAAC,KAAK,CAAC,qBAAqB,GAAG,CAAC,GAAG,CAAC,IAAI,mCAAmC,CAAC,CAAC;gBACjF,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;gBAC5B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;gBACzB,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;aACnC;iBAAM;gBACL,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;gBACxB,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC;aACpC;SACF;IACH,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,YAAoB;QAC/D,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,QAAQ,EAAE,CAAC;IACxB,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,KAAK,EAAE,CAAS,EAAE,EAAE;gBAC3B,IAAI,CAAC,KAAK,CAAC,wBAAwB,IAAI,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;gBACpD,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,8CAA8C,CAAC,EAAE,CAAC,CAAC;YACvF,CAAC;YACD,SAAS,EAAE,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAsB,EAAE,EAAE;gBAC/D,IAAI,KAAK,KAAK,aAAa,EAAE;oBAC3B,4EAA4E;oBAC5E,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;iBAC9B;qBAAM,IAAI,CAAC,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,EAAE;oBAC9D,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;iBAC3C;qBAAM;oBACL,kCAAkC;oBAClC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;iBACtC;YACH,CAAC;SACF,CAAC;QACF,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzB,CAAC;CACF;AAtOD,mCAsOC"}