@sockethub/server 5.0.0-alpha.3

package/src/janitor.ts

@@ -0,0 +1,89 @@
+import debug from 'debug';
+
+import PlatformInstance, { platformInstances } from './platform-instance';
+import listener, { SocketInstance } from "./listener";
+
+const rmLog = debug('sockethub:server:janitor');
+
+const TICK = 15000;
+let alreadyCalled: boolean = false;
+let cycleCount: number = 0;   // a counter for each setInterval call
+let reportCount: number = 0;  // number of times a report is printed
+
+/**
+ * Every TICK the Janitor will compare existing platform instances with socket.ids (aka. sessionId)
+ * If all of the sessionIds associated with a platformInstance have no corresponding socket.id
+ * (from the http.io socket.io instance), then the platformInstance will first be flagged, if after
+ * the next TICK the same state is determined, the platform will be destroyed (this allows for page
+ * refreshes not destroying platform instances)
+ */
+function janitorCycle() {
+  if (! alreadyCalled) { alreadyCalled = true; }
+  else { return; }
+  rmLog('initializing resource manager');
+  setInterval(async () => {
+    cycleCount++;
+    const sockets: Array<SocketInstance> = await listener.io.fetchSockets();
+
+    if (! (cycleCount % 4)) {
+      reportCount++;
+      rmLog(`socket sessions: ${sockets.length} platform instances: ${platformInstances.size}`);
+    }
+
+    for (let platformInstance of platformInstances.values()) {
+      removeStaleSocketSessions(platformInstance, sockets);
+      // Static platforms are for global use, not tied to a unique to session / eg. credentials)
+      if ((! platformInstance.global) && (platformInstance.sessions.size === 0)) {
+        removeStalePlatformInstance(platformInstance);
+      } else {
+        platformInstance.flaggedForTermination = false;
+      }
+    }
+  }, TICK);
+}
+
+function socketExists(sessionId: string, sockets: Array<SocketInstance>) {
+  for (let socket of sockets) {
+    if (socket.id === sessionId) {
+      return true;
+    }
+  }
+  return false;
+}
+
+function removeSessionCallbacks(platformInstance: PlatformInstance, sessionId: string) {
+  for (const key in platformInstance.sessionCallbacks) {
+    platformInstance.sessionCallbacks[key].delete(sessionId);
+  }
+}
+
+function removeStaleSocketSessions(platformInstance: PlatformInstance,
+                                   sockets: Array<SocketInstance>) {
+  for (const sessionId of platformInstance.sessions.values()) {
+    if (! socketExists(sessionId, sockets)) {
+      rmLog('removing stale socket session reference ' + sessionId + ' in platform instance '
+        + platformInstance.id);
+      platformInstance.sessions.delete(sessionId);
+      removeSessionCallbacks(platformInstance, sessionId);
+    }
+  }
+}
+
+function removeStalePlatformInstance(platformInstance: PlatformInstance) {
+  if (platformInstance.flaggedForTermination) {
+    rmLog(`terminating platform instance ${platformInstance.id}`);
+    platformInstance.destroy(); // terminate
+  } else {
+    rmLog(`flagging for termination platform instance ${platformInstance.id} ` +
+      `(no registered sessions found)`);
+    platformInstance.flaggedForTermination = true;
+  }
+}
+
+const janitor = {
+  clean: janitorCycle,
+  alreadyCalled: alreadyCalled,
+  cycleCount: cycleCount,
+  reportCount: reportCount
+};
+export default janitor;

package/src/listener.ts

@@ -0,0 +1,79 @@
+import debug from 'debug';
+import bodyParser from 'body-parser';
+import express from 'express';
+import * as HTTP from 'http';
+import { Server } from 'socket.io';
+
+import config from './config';
+import routes from './routes';
+
+const log = debug('sockethub:server:listener');
+
+/**
+ * Handles the initialization and access of Sockethub resources.
+ *
+ *  - HTTP Server
+ *  - Express (serves resources and example routes)
+ *  - Socket.io (bidirectional websocket communication)
+ */
+class Listener {
+  io: Server;
+  http: HTTP.Server;
+
+  /**
+   * Starts the services needed for Sockethub to operate. After this command completes,
+   * the `http` and `io` class properties will be set.
+   */
+  start() {
+    // initialize express and socket.io objects
+    const app = Listener.initExpress();
+    this.http = new HTTP.Server(app);
+    this.io = new Server(this.http, {
+      path: config.get('sockethub:path'),
+      cors: {
+        origin: "*",
+        methods: [ "GET", "POST" ]
+      }
+    });
+    routes.setup(app);
+    this.startHttp();
+  }
+
+  private startHttp() {
+    this.http.listen(config.get('sockethub:port'), config.get('sockethub:host'), () => {
+      log(`sockethub listening on ` +
+        `http://${config.get('sockethub:host')}:${config.get('sockethub:port')}`);
+    });
+  };
+
+  private static initExpress() {
+    let app = express();
+    // templating engines
+    app.set('view engine', 'ejs');
+    // use bodyParser
+    app.use(bodyParser.urlencoded({extended: true}));
+    app.use(bodyParser.json());
+    return app;
+  }
+}
+
+const listener = new Listener();
+
+export interface SocketInstance {
+  id: string;
+  emit: Function;
+}
+
+export async function getSocket(sessionId: string): Promise<SocketInstance> {
+  const sockets: Array<SocketInstance> = await listener.io.fetchSockets();
+  return new Promise((resolve, reject) => {
+    for (let socket of sockets) {
+      if (sessionId === socket.id) {
+        return resolve(socket);
+      }
+    }
+    return reject(`unable to find socket for sessionId ${sessionId}`);
+  });
+}
+
+export default listener;

package/src/middleware/create-activity-object.test.ts

@@ -0,0 +1,10 @@
+import createActivityObject from "./create-activity-object";
+
+describe('Middleware: createActivityObject', () => {
+  it('Calls activity.Object.create with incoming data', (done) => {
+    // @ts-ignore
+    createActivityObject({foo: 'bar'}, (msg) => {
+      done();
+    });
+  });
+});

package/src/middleware/create-activity-object.ts

@@ -0,0 +1,13 @@
+import ActivityStreams from '@sockethub/activity-streams';
+import config from "../config";
+const activity = ActivityStreams(config.get('activity-streams:opts'));
+
+/**
+ * A simple middleware wrapper for the activity-streams Object.create method.
+ * @param obj
+ * @param done
+ */
+export default function createActivityObject(obj: any, done: Function) {
+  activity.Object.create(obj);
+  done(obj);
+}

package/src/middleware/expand-activity-stream.test.data.ts

@@ -0,0 +1,365 @@
+export default [
+  {
+    "name": "not an object",
+    "valid": false,
+    "type": "message",
+    "input": "hello world",
+    "error": "Error: message received is not an object."
+  },
+  {
+    "name": "basic invalid type",
+    "valid":true,
+    "type":"credentials",
+    "input":{
+      "id":"foo",
+      "type":"send",
+      "context":"dummy",
+      "actor":{
+        "id":"dood@irc.freenode.net",
+        "type":"person",
+        "name":"dood"
+      },
+      "target":{
+        "id":"irc.freenode.net/service",
+        "type":"person",
+        "name":"service"
+      },
+      "object":{
+        "type":"credentials"
+      }
+    },
+    "output": "same"
+  },
+  {
+    "name": "basic valid type",
+    "valid":true,
+    "type":"credentials",
+    "input":{
+      "id":"foo",
+      "type":"credentials",
+      "context":"dummy",
+      "actor":{
+        "id":"dood@irc.freenode.net",
+        "type":"person",
+        "name":"dood"
+      },
+      "target":{
+        "id":"irc.freenode.net/service",
+        "type":"person",
+        "name":"service"
+      },
+      "object":{
+        "type":"credentials"
+      }
+    },
+    "output":"same"
+  },
+  {
+    "name":"new format",
+    "valid":true,
+    "type":"credentials",
+    "input":{
+      "type":"credentials",
+      "context":"irc",
+      "actor":{
+        "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"
+      },
+      "object":{
+        "type":"credentials",
+        "nick":"sh-9K3Vk",
+        "port":6667,
+        "secure":false,
+        "server":"irc.freenode.net"
+      }
+    },
+    "output":"same"
+  },
+  {
+    "name":"no type specified",
+    "valid":false,
+    "type":"credentials",
+    "input":{
+      "actor":"hyper_rau@localhost",
+      "context":"xmpp",
+      "object":{
+        "username":"hyper_rau",
+        "password":"123",
+        "server":"localhost",
+        "port":5222,
+        "resource":"laptop"
+      }
+    },
+    "error": "Error: activity stream must contain a type property."
+  },
+  {
+    "name": "expand unknown actor",
+    "type": "message",
+    "valid": "true",
+    "input": {
+      "context": "foo",
+      "type": "bar",
+      "actor": "foo@bar",
+      "object": {
+        "content": "bar"
+      }
+    },
+    "output": {
+      "context": "foo",
+      "type": "bar",
+      "actor": {
+        "id": "foo@bar"
+      },
+      "object": {
+        "content": "bar"
+      }
+    }
+  },
+  {
+    "name": "expand unknown actor 2",
+    "type": "message",
+    "valid": "true",
+    "input": {
+      "context": "foo",
+      "type": "bar",
+      "actor": "someone@example.org/resource",
+      "object": {
+        "content": "bar"
+      }
+    },
+    "output": {
+      "context": "foo",
+      "type": "bar",
+      "actor": {
+        "id": "someone@example.org/resource"
+      },
+      "object": {
+        "content": "bar"
+      }
+    }
+  },
+  {
+    "name": "expand unknown actor 2",
+    "type": "message",
+    "valid": "true",
+    "input": {
+      "context": "foo",
+      "type": "bar",
+      "actor": "xmpp:someone@example.org/resource",
+      "object": {
+        "content": "bar"
+      }
+    },
+    "output": {
+      "context": "foo",
+      "type": "bar",
+      "actor": {
+        "id": "xmpp:someone@example.org/resource"
+      },
+      "object": {
+        "content": "bar"
+      }
+    }
+  },
+  {
+    "name":"person",
+    "type":"message",
+    "valid":true,
+    "input":{
+      "context": "some context",
+      "type": "some type",
+      "actor": "blah",
+      "object": {}
+    },
+    "output": {
+      "context": "some context",
+      "type": "some type",
+      "actor": {
+        "id":"blah",
+        "type":"person",
+        "name":"dood"
+      },
+      "object": {}
+    }
+  },
+  {
+    "name":"person with extras",
+    "valid":true,
+    "type":"message",
+    "input": {
+      "context": "some context",
+      "type": "some type",
+      "actor": "blah2",
+      "object": {}
+    },
+    "output": {
+      "context": "some context",
+      "type": "some type",
+      "actor": {
+        "id":"blah2",
+        "type":"person",
+        "name":"bob",
+        "hello":"there",
+        "i":[
+          "am",
+          "extras"
+        ]
+      },
+      "object": {}
+    }
+  },
+  {
+    "name":"bad parent object",
+    "valid":false,
+    "type":"message",
+    "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: activity stream must contain a context property"
+  },
+  {
+    "name":"no actor specified",
+    "valid":false,
+    "type":"message",
+    "input":{
+      "type": "some type",
+      "context":"xmpp",
+      "object":{
+        "type": "error",
+        "content": "error message"
+      }
+    },
+    "error": "Error: activity stream must contain an actor property."
+  },
+  {
+    "name":"expand actor and target of unknowns",
+    "valid":true,
+    "type":"message",
+    "input":{
+      "actor":"irc://uuu@localhost",
+      "type":"join",
+      "context":"irc",
+      "target":"irc://irc.dooder.net/a-room"
+    },
+    "output":{
+      "actor":{
+        "id":"irc://uuu@localhost"
+      },
+      "type":"join",
+      "context":"irc",
+      "target":{
+        "id":"irc://irc.dooder.net/a-room"
+      }
+    }
+  },
+  {
+    "name":"expand actor and target of unknowns",
+    "valid":true,
+    "type":"message",
+    "input":{
+      "actor":"hyper_rau@localhost",
+      "type":"join",
+      "context":"xmpp",
+      "object":{
+
+      },
+      "target":"dooder"
+    },
+    "output":{
+      "actor":{
+        "id":"hyper_rau@localhost"
+      },
+      "type":"join",
+      "context":"xmpp",
+      "object":{
+
+      },
+      "target":{
+        "id":"dooder"
+      }
+    }
+  },
+  {
+    "name":"expand known person",
+    "valid":true,
+    "type":"message",
+    "input":{
+      "actor":"sh-9K3Vk@irc.freenode.net",
+      "target":"blah3",
+      "type":"send",
+      "context":"irc",
+      "object":{
+
+      }
+    },
+    "output":{
+      "actor":{
+        "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"
+      },
+      "target":{
+        "id":"blah3",
+        "type":"person",
+        "name":"bob",
+        "hello":"there",
+        "i":[
+          "am",
+          "extras"
+        ]
+      },
+      "type":"send",
+      "context":"irc",
+      "object":{
+
+      }
+    }
+  }
+];

package/src/middleware/expand-activity-stream.test.ts

@@ -0,0 +1,78 @@
+import { expect } from 'chai';
+
+import expandActivityStream from "./expand-activity-stream";
+
+import asObjects from "./expand-activity-stream.test.data";
+import ActivityStreams from '@sockethub/activity-streams';
+
+const activity = ActivityStreams();
+// register known activity objects
+[
+  {
+    "id":"blah",
+    "type":"person",
+    "name":"dood"
+  },
+  {
+    "id":"blah2",
+    "type":"person",
+    "name":"bob",
+    "hello":"there",
+    "i":[
+      "am",
+      "extras"
+    ]
+  },
+  {
+    "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"
+  },
+  {
+    "id":"blah3",
+    "type":"person",
+    "name":"bob",
+    "hello":"there",
+    "i":[
+      "am",
+      "extras"
+    ]
+  }
+].forEach((obj) => {
+  activity.Object.create(obj);
+});
+
+describe('Middleware: Expand Activity Stream', () => {
+  describe('AS object expansion', () => {
+    asObjects.forEach((obj) => {
+      it(`${obj.type}: ${obj.name}, should ${obj.valid ? 'pass' : 'fail'}`, (done) => {
+        // @ts-ignore
+        expandActivityStream(obj.input, (msg) => {
+          if (obj.output) {
+            if (obj.output === 'same') {
+              expect(obj.input).to.eql(msg);
+            } else {
+              expect(obj.output).to.eql(msg);
+            }
+          }
+          if (obj.valid) {
+            expect(msg instanceof Error).to.be.false;
+          } else {
+            expect(msg instanceof Error).to.be.true;
+            if (obj.error) {
+              expect(obj.error).to.equal(msg.toString());
+            }
+          }
+          done();
+        });
+      });
+    });
+  });
+});

package/src/middleware/expand-activity-stream.ts

@@ -0,0 +1,27 @@
+import ActivityStreams from '@sockethub/activity-streams';
+import { IActivityStream } from "@sockethub/schemas";
+
+import config from "../config";
+
+const activity = ActivityStreams(config.get('activity-streams:opts'));
+
+function ensureObject(msg: any) {
+  return !((typeof msg !== 'object') || (Array.isArray(msg)));
+}
+
+export default function expandActivityStream(msg: IActivityStream, done: Function) {
+  if (! ensureObject(msg)) {
+    done(new Error(`message received is not an object.`));
+  } else if (typeof msg.context !== 'string') {
+    done(new Error('activity stream must contain a context property'));
+  }  else if (typeof msg.type !== 'string') {
+    done(new Error('activity stream must contain a type property.'));
+  } else {
+    msg = activity.Stream(msg);
+    if (! msg.actor) {
+      done(new Error('activity stream must contain an actor property.'));
+    } else {
+      done(msg);
+    }
+  }
+}