sockethub 4.1.0 → 5.0.0-alpha.0

package/src/middleware/validate.test.data.ts

@@ -1,38 +1,62 @@
 export default [
+  {
+    "name": "mismatched types",
+    "valid": false,
+    "type": "credentials",
+    "input":{
+      "id":"blah",
+      "type":"send",
+      "context":"dummy",
+      "actor":{
+        "id":"dood@irc.freenode.net",
+        "type":"person",
+        "name":"dood"
+      },
+      "target":{
+        "id":"irc.freenode.net/sockethub",
+        "type":"person",
+        "name":"sockethub"
+      },
+      "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":"send",
+      "id":"blah",
+      "type":"credentials",
       "context":"dummy",
       "actor":{
-        "@id":"dood@irc.freenode.net",
-        "@type":"person",
-        "displayName":"dood"
-      },
-      "target":{
-        "@id":"irc.freenode.net/sockethub",
-        "@type":"person",
-        "displayName":"sockethub"
+        "id":"dood@irc.freenode.net",
+        "type":"person",
+        "name":"dood"
       },
       "object":{
-        "@type":"credentials"
+        'type': 'credentials',
+        "user": 'foo',
+        "pass": 'bar'
       }
     },
     "output":"same"
   },
   {
-    "name":"new format",
+    "name":"irc credentials",
     "valid":true,
     "type":"credentials",
     "input":{
       "context":"irc",
+      "type":"credentials",
       "actor":{
-        "@id":"sh-9K3Vk@irc.freenode.net",
-        "@type":"person",
-        "displayName":"sh-9K3Vk",
+        "id":"sh-9K3Vk@irc.freenode.net",
+        "type":"person",
+        "name":"sh-9K3Vk",
         "image":{
           "height":250,
           "mediaType":"image/jpeg",
@@ -42,7 +66,7 @@ export default [
         "url":"http://sockethub.org"
       },
       "object":{
-        "@type":"credentials",
+        "type":"credentials",
         "nick":"sh-9K3Vk",
         "port":6667,
         "secure":false,
@@ -51,6 +75,36 @@ export default [
     },
     "output":"same"
   },
+  {
+    "name":"bad irc credentials: user/nick host/server",
+    "valid":false,
+    "type":"credentials",
+    "input":{
+      "context":"irc",
+      "type":"credentials",
+      "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",
+        "user":"sh-9K3Vk",
+        "port":6667,
+        "secure":false,
+        "host":"irc.freenode.net"
+      }
+    },
+    "error":
+      "Error: /object: must NOT have additional properties"
+  },
   {
     "name":"no type specified",
     "valid":false,
@@ -65,16 +119,17 @@ export default [
         "port":5222,
         "resource":"laptop"
       }
-    }
+    },
+    "error": "Error: credential activity streams must have credentials set as type"
   },
   {
-    "name":"person",
+    "name":"basic person",
     "type":"activity-object",
     "valid":true,
     "input":{
-      "@id":"blah",
-      "@type":"person",
-      "displayName":"dood"
+      "id":"blah",
+      "type":"person",
+      "name":"dood"
     },
     "output":"same"
   },
@@ -83,9 +138,9 @@ export default [
     "valid":true,
     "type":"activity-object",
     "input":{
-      "@id":"blah",
-      "@type":"person",
-      "displayName":"bob",
+      "id":"blah",
+      "type":"person",
+      "name":"bob",
       "hello":"there",
       "i":[
         "am",
@@ -99,33 +154,38 @@ export default [
     "valid":false,
     "type":"activity-object",
     "input":{
-      "@type":"credentials",
+      "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",
+      "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",
-      "displayName":"sh-9K3Vk",
+      "id":"sh-9K3Vk@irc.freenode.net",
+      "type":"person",
+      "name":"sh-9K3Vk",
       "image":{
         "height":250,
         "mediaType":"image/jpeg",
@@ -141,9 +201,9 @@ export default [
     "valid":true,
     "type":"activity-object",
     "input":{
-      "@id":"irc://sh-9K3Vk@irc.freenode.net",
-      "@type":"person",
-      "displayName":"sh-9K3Vk",
+      "id":"irc://sh-9K3Vk@irc.freenode.net",
+      "type":"person",
+      "name":"sh-9K3Vk",
       "url":"http://sockethub.org"
     },
     "output":"same"
@@ -151,7 +211,7 @@ export default [
   {
     "name":"bad parent object",
     "valid":false,
-    "type":"activity-object",
+    "type":"activity-stream",
     "input":{
       "string":"this is a string",
       "array":[
@@ -162,125 +222,99 @@ export default [
         }
       ],
       "as":{
-        "@id":"blah",
-        "@type":"send",
+        "id":"blah",
+        "type":"send",
         "context":"hello",
         "actor":{
-          "displayName":"dood"
+          "name":"dood"
         },
         "target":{
-          "@type":"person",
-          "displayName":"bob"
+          "type":"person",
+          "name":"bob"
         },
         "object":{
-          "@type":"credentials"
+          "type":"credentials"
         }
       },
       "noId":{
-        "displayName":"dood"
+        "name":"dood"
       },
       "noId2":{
-        "@type":"person",
-        "displayName":"bob"
+        "type":"person",
+        "name":"bob"
       },
       "noDisplayName":{
-        "@id":"larg"
+        "id":"larg"
       }
-    }
+    },
+    "error": "Error: platform context undefined not registered with this sockethub instance."
   },
   {
-    "name":"expand actor and target of unknowns",
-    "valid":true,
+    "name":"unexpected AS",
+    "valid":false,
     "type":"message",
     "input":{
       "actor":"irc://uuu@localhost",
-      "@type":"join",
+      "type":"join",
       "context":"irc",
       "target":"irc://irc.dooder.net/a-room"
     },
-    "output":{
-      "actor":{
-        "@id":"irc://uuu@localhost",
-        "displayName":"uuu"
-      },
-      "@type":"join",
+    "error": "Error: /actor: must be object"
+  },
+  {
+    "name":"missing type property",
+    "valid":false,
+    "type":"message",
+    "input":{
+      "actor": { "id": "irc://uuu@localhost", "type": "person" },
       "context":"irc",
-      "target":{
-        "@id":"irc://irc.dooder.net/a-room",
-        "displayName":"/a-room"
-      }
-    }
+      "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
+    },
+    "error": "Error: activity stream: must have required property \'type\'"
   },
   {
-    "name":"expand actor and target of unknowns",
-    "valid":true,
+    "name":"invalid context property",
+    "valid":false,
     "type":"message",
     "input":{
-      "actor":"hyper_rau@localhost",
-      "@type":"join",
-      "context":"xmpp",
-      "object":{
-
-      },
-      "target":"dooder"
+      "actor": { "id": "irc://uuu@localhost", "type": "person" },
+      "type":"foo",
+      "context": "foobar",
+      "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
     },
-    "output":{
-      "actor":{
-        "@id":"hyper_rau@localhost",
-        "displayName":"hyper_rau@localhost"
-      },
-      "@type":"join",
-      "context":"xmpp",
-      "object":{
-
-      },
-      "target":{
-        "@id":"dooder",
-        "displayName":"dooder"
-      }
-    }
+    "error": "Error: platform context foobar not registered with this sockethub instance."
   },
   {
-    "name":"expand known person",
-    "valid":true,
+    "name":"missing actor property",
+    "valid":false,
     "type":"message",
     "input":{
-      "actor":"sh-9K3Vk@irc.freenode.net",
-      "target":"blah",
-      "@type":"send",
+      "type": "foo",
       "context":"irc",
-      "object":{
-
-      }
+      "target": { "id": "irc://irc.dooder.net/a-room", "type": "room" }
     },
-    "output":{
-      "actor":{
-        "@id":"sh-9K3Vk@irc.freenode.net",
-        "@type":"person",
-        "displayName":"sh-9K3Vk",
-        "image":{
-          "height":250,
-          "mediaType":"image/jpeg",
-          "url":"http://example.org/image.jpg",
-          "width":250
-        },
-        "url":"http://sockethub.org"
-      },
-      "target":{
-        "@id":"blah",
-        "@type":"person",
-        "displayName":"bob",
-        "hello":"there",
-        "i":[
-          "am",
-          "extras"
-        ]
-      },
-      "@type":"send",
-      "context":"irc",
-      "object":{
-
-      }
+    "error": "Error: activity stream: must have required property \'actor\'"
+  },
+  {
+    "name":"traditional message",
+    "valid":true,
+    "type":"message",
+    "input":{
+      "type": "update",
+      "context": "irc",
+      "actor": { "id": "irc://uuu@localhost", "type": "person" }
     }
+  },
+  {
+    "name":"message with wrong type",
+    "valid":false,
+    "type":"message",
+    "input":{
+      "type": "foorg",
+      "context": "irc",
+      "actor": { "id": "irc://uuu@localhost", "type": "person" }
+    },
+    "error": "Error: platform type foorg not supported by irc platform. " +
+      "(types: credentials, connect, update, join, leave, send, query, announce)"
   }
 ];

package/src/middleware/validate.test.ts

@@ -17,9 +17,6 @@ const validateMod = proxyquire('./validate', {
 const validate = validateMod.default;
 
 import asObjects from "./validate.test.data";
-import ActivityStreams from 'activity-streams';
-
-const activity = ActivityStreams();
 
 describe('Middleware: Validate', () => {
   describe('AS object validations', () => {
@@ -29,18 +26,18 @@ describe('Middleware: Validate', () => {
         validate(obj.type, 'tests')(obj.input, (msg) => {
           if (obj.output) {
             if (obj.output === 'same') {
-              expect(obj.input).to.eql(msg);
+              expect(msg).to.eql(obj.input);
             } else {
-              expect(obj.output).to.eql(msg);
+              expect(msg).to.eql(obj.output);
             }
           }
           if (obj.valid) {
-            expect(msg instanceof Error).to.be.false;
+            expect(msg).to.not.be.instanceof(Error);
           } else {
-            expect(msg instanceof Error).to.be.true;
-          }
-          if ((obj.valid) && (obj.type === 'activity-object')) {
-            activity.Object.create(msg);
+            expect(msg).to.be.instanceof(Error);
+            if (obj.error) {
+              expect(msg.toString()).to.equal(obj.error);
+            }
           }
           done();
         });

package/src/middleware/validate.ts

@@ -1,142 +1,49 @@
 /**
  * responsible for handling the validation and expansion (when applicable) of all incoming objects
  */
-import tv4 from 'tv4';
 import debug from 'debug';
-import URI from 'urijs';
-import ActivityStreams from 'activity-streams';
-import * as SockethubSchemas from 'sockethub-schemas';
+import * as Schemas from 'sockethub-schemas';
+import { ActivityStream } from "../sockethub";
 
-import init from '../bootstrap/init';
-import config from '../config';
-import {ActivityObject} from "../sockethub";
+// @ts-ignore
+import init from "../bootstrap/init";
 
-const activity = ActivityStreams(config.get('activity-streams:opts'));
-
-// load sockethub-activity-stream schema and register it with tv4
-// http://sockethub.org/schemas/v0/activity-stream#
-tv4.addSchema(SockethubSchemas.ActivityStream.id, SockethubSchemas.ActivityStream);
-// load sockethub-activity-object schema and register it with tv4
-// http://sockethub.org/schemas/v0/activity-object#
-tv4.addSchema(SockethubSchemas.ActivityObject.id, SockethubSchemas.ActivityObject);
-
-// educated guess on what the displayName is, if it's not defined
-// since we know the @id is a URI, we prioritize by username, then fragment (no case yet for path)
-function ensureDisplayName(msg: any) {
-  if ((msg['@id']) && (! msg.displayName)) {
-    const uri = new URI(msg['@id']);
-    return uri.username() || getUriFragment(uri) || uri.path();
-  }
-  return msg.displayName;
-}
-
-function ensureObject(msg: any) {
-  return !((typeof msg !== 'object') || (Array.isArray(msg)));
-}
-
-// expand given prop to full object if they are just strings
-// FIXME are we sure this works? What's propName for?
-function expandProp(propName, prop) {
-  return (typeof prop === 'string') ? activity.Object.get(prop, true) : prop;
-}
-
-function expandStream(msg) {
-  msg.actor.displayName = ensureDisplayName(msg.actor);
-  if (msg.target) {
-    msg.target.displayName = ensureDisplayName(msg.target);
-  }
-  return msg;
-}
-
-function getUriFragment(uri: any) {
-  const frag = uri.fragment();
-  return (frag) ? '#' + frag : undefined;
-}
-
-function processActivityObject(msg: any, done: Function) {
-  if (! validateActivityObject(msg)) {
-    return done(new Error(
-      `activity-object schema validation failed: ${tv4.error.dataPath} = ${tv4.error.message}`));
-  }
-  msg.displayName = ensureDisplayName(msg);
-  return done(msg); // passed validation, on to next handler in middleware chain
-}
-
-function processActivityStream(msg: any, done: Function) {
-  let stream;
-  try { // expands the AS object to a full object with the expected properties
-    stream = activity.Stream(msg);
-  } catch (e) {
-    return done(new Error(e));
-  }
-  msg = stream; // overwrite message with expanded as object stream
-
-  if (! validateActivityStream(msg)) {
-    return done(new Error(
-      `actvity-stream schema validation failed: ${tv4.error.dataPath}: ${tv4.error.message}`));
-  }
-  // passed validation, on to next handler in middleware chain
-  return done(expandStream(msg));
-}
-
-function processCredentials(msg: any, done: Function) {
-  msg.actor = expandProp('actor', msg.actor);
-  msg.target = expandProp('target', msg.target);
-  let credentialsSchema = tv4.getSchema(
-    `http://sockethub.org/schemas/v0/context/${msg.context}/credentials`);
-  if (! credentialsSchema) {
-    return done(new Error(`no credentials schema found for ${msg.context} context`));
-  }
-
-  if (! validateCredentials(msg, credentialsSchema)) {
-    return done(new Error(
-      `credentials schema validation failed: ${tv4.error.dataPath} = ${tv4.error.message}`));
-  }
-  // passed validation, on to next handler in middleware chain
-  return done(expandStream(msg));
-}
-
-function validateActivityObject(msg: any) {
-  return tv4.validate({ object: msg }, SockethubSchemas.ActivityObject);
-}
-
-function validateCredentials(msg: any, schema: any) {
-  return tv4.validate(msg, schema);
-}
-
-function validateActivityStream(msg: any) {
-  // TODO figure out a way to allow for special objects from platforms, without
-  // ignoring failed activity stream schema checks
-  if (! tv4.validate(msg, SockethubSchemas.ActivityStream)) {
-    return tv4.getSchema(`http://sockethub.org/schemas/v0/context/${msg.context}/messages`);
-  }
-  return true;
-}
+init.platforms.forEach((platform) => {
+  Object.keys(platform.schemas).forEach((key) => {
+    if (! platform.schemas[key]) { return; }
+    Schemas.validator.addPlatformSchema(platform.schemas[key], `${platform.id}/${key}`);
+  });
+});
 
 // called when registered with the middleware function, define the type of validation
 // that will be called when the middleware eventually does.
 export default function validate(type: string, sockethubId: string) {
   const sessionLog = debug(`sockethub:validate:${sockethubId}`);
-  // called by the middleware with the message and the next (callback) in the chain
-  return (msg: ActivityObject, done: Function) => {
+  return (msg: ActivityStream, done: Function) => {
     sessionLog('applying schema validation for ' + type);
-
-    if (! ensureObject(msg)) {
-      done(new Error(`message received is not an object.`));
-    } else if (type === 'activity-object') {
-      processActivityObject(msg, done);
-    } else if (typeof msg.context !== 'string') {
-      done(new Error('message must contain a context property'));
+    if (type === 'activity-object') {
+      const err = Schemas.validator.validateActivityObject(msg);
+      err ? done(new Error(err)) : done(msg);
     } else if (! init.platforms.has(msg.context)) {
-      done(
+      return done(
         new Error(`platform context ${msg.context} not registered with this sockethub instance.`)
       );
-    } else if ((type === 'message') && (typeof msg['@type'] !== 'string')) {
-      done(new Error('message must contain a @type property.'));
     } else if (type === 'credentials') {
-      processCredentials(msg, done);
+      const err = Schemas.validator.validateCredentials(msg);
+      err ? done(new Error(err)) : done(msg);
     } else {
-      processActivityStream(msg, done);
+      const err = Schemas.validator.validateActivityStream(msg);
+      if (err) {
+        done(new Error(err));
+      } else {
+        const platformMeta = init.platforms.get(msg.context);
+        if (!platformMeta.types.includes(msg.type)) {
+          return done(new Error(`platform type ${msg.type} not supported by ${msg.context} ` +
+            `platform. (types: ${platformMeta.types.join(', ')})`));
+        } else {
+          done(msg);
+        }
+      }
     }
   };
-};
+};