add type json-schemas for all data models

README.md

@@ -226,6 +226,12 @@ cp cobuy-config/*.js cobuy/config
 heroku run npm run db migrate:latest --app=cobuy
 ```
 
+### JSON schema
+
+All models must have an assoicated JSON schema. See [#118](https://github.com/root-systems/cobuy/issues/118) for more info.
+
+We're using [json-schema-faker](https://github.com/json-schema-faker/json-schema-faker/#faking-values) to fake data for tests and storybook.
+
 ### How to [storybook](https://storybook.js.org)
 
 So you want to tell a story about dumb React components, ey?

agents/schemas/profile.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/schema#",
+  "id": "agents/Profile",
+  "title": "Profile",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "integer",
+      "description": "Id referencing profile"
+    },
+    "agentId": {
+      "type": "integer",
+      "description": "Id referencing agent"
+    },
+    "name": {
+      "type": "string",
+      "faker": "name.findName",
+      "description": "An agent name"
+    },
+    "description": {
+      "type": "string",
+      "description": "Agent biography"
+    },
+    "avatar" : {
+      "type": "string",
+      "faker": "internet.avatar",
+      "format": "uri",
+      "description": "Agent avatar image link"
+    }
+  },
+  "required": [
+    "id",
+    "agentId"
+  ]
+}

agents/stories/Profile.js

@@ -2,17 +2,17 @@ import React from 'react'
 import { storiesOf } from '@storybook/react'
 import { action } from '@storybook/addon-actions'
 import { reduxForm, Field } from 'redux-form'
+import h from 'react-hyperscript'
+import jsf from 'json-schema-faker'
 
+import schema from '../schemas/profile'
 import Profile from '../components/Profile'
 
-const alice = {
-  profile: {
-    name: 'Alice',
-    description: 'a cool cat',
-    avatar: 'http://dinosaur.is/images/mikey-small.jpg'
-  }
-}
+const profile = jsf(schema)
+
 storiesOf('agents.Profile', module)
   .add('basic', () => (
-    <Profile agent={alice} />
+      h(Profile, {
+        initialValues: profile
+      })
   ))

app/schemas.js

@@ -0,0 +1,11 @@
+const Ajv = require('ajv')
+const ajv = new Ajv()
+
+const taskPlanSchema = require('../tasks/schemas/taskPlan')
+const taskRecipeSchema = require('../tasks/schemas/taskRecipe')
+ajv.addSchema([
+  taskRecipeSchema,
+  taskPlanSchema
+])
+
+export default ajv

ordering/services/orders.js

@@ -58,9 +58,9 @@ function createPrereqTaskPlan (hook) {
   // const assigneeId = hook.params.agent.id
 
   const assigneeId = hook.params.credential.agentId
-  const params = JSON.stringify({
+  const params = {
     contextAgentId: hook.data.agentId
-  })
+  }
   return taskPlans.create({ taskRecipeId, params, assigneeId })
   .then(() => {
     return hook

package.json

@@ -58,6 +58,7 @@
     "@ahdinosaur/react-fela": "^4.3.5",
     "@f/create-action": "^1.1.1",
     "@root-systems/redux-form-validators": "^1.1.0",
+    "ajv": "^5.2.2",
     "babel-plugin-ramda": "^1.2.0",
     "babel-plugin-transform-class-properties": "^6.24.1",
     "babel-plugin-transform-object-rest-spread": "^6.23.0",
@@ -108,6 +109,7 @@
     "dependency-check": "^2.8.0",
     "maildev": "^1.0.0-rc3",
     "npm-run-all": "^4.0.2",
+    "json-schema-faker": "^0.4.3",
     "precinct": "^3.6.0",
     "sqlite3": "3.1.8"
   }

tasks/data/mock.js

@@ -90,7 +90,7 @@ export const mockEnhancedTaskPlans = {
     taskRecipeId: 'finishPrereqs',
     taskRecipe: finishPrereqs,
     params: {
-      contextAgent: group
+      contextAgentId: group.id
     }
   },
   2: {
@@ -100,7 +100,7 @@ export const mockEnhancedTaskPlans = {
     taskRecipeId: 'setupGroup',
     taskRecipe: setupGroup,
     params: {
-      contextAgent: group
+      contextAgentId: group.id
     }
   },
   3: {
@@ -110,7 +110,7 @@ export const mockEnhancedTaskPlans = {
     taskRecipeId: 'setupSupplier',
     taskRecipe: setupSupplier,
     params: {
-      contextAgent: group
+      contextAgentId: group.id
     }
   }
 }

tasks/schemas/taskPlan.json

@@ -0,0 +1,36 @@
+{
+  "id": "/tasks/taskPlan",
+  "title": "Task Plan",
+  "description": "An assignment of the task to an agent",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "#/definitions/id"
+    },
+    "parentTaskPlanID": {
+      "$ref": "#/definitions/id"
+    },
+    "assigneeId": {
+      "type": "integer",
+      "description": "Person or group or related agents (e.g. admins) being assigned"
+    },
+    "taskRecipeId": {
+      "$ref": "/tasks/taskRecipe#/definitions/id",
+      "description": "Task recipe that this taask plan is related to"
+    },
+    "params": {
+      "type": "object",
+      "description": "Util paramaters"
+    }
+  },
+  "required": [
+    "assigneeId",
+    "taskRecipeId"
+  ],
+  "definitions": {
+    "id": {
+      "type": "integer",
+      "description": "Id referencing task plan"
+    }
+  }
+}

tasks/schemas/taskRecipe.json

@@ -0,0 +1,36 @@
+{
+  "id": "/tasks/taskRecipe",
+  "title": "Task Recipe",
+  "description": "An abstract description of the task",
+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "#/definitions/id"
+    },
+    "ownerAgentId": {
+      "type": "integer",
+      "description": "Id of the agent that owns the recipe"
+    },
+    "childTaskRecipes": {
+      "type": "array",
+      "items": [
+        {
+          "$ref": "#"
+        }
+      ],
+      "description": "Task recipes that make up this task recipe..."
+    }
+  },
+  "definitions": {
+    "id": {
+      "enum": [
+        "setupGroup",
+        "setupSupplier",
+        "finishPrereqs"
+      ]
+    }
+  },
+  "required": [
+    "id"
+  ]
+}

tasks/services/plans.js

@@ -1,6 +1,8 @@
 const feathersKnex = require('feathers-knex')
-const { iff } = require('feathers-hooks-common')
 import { isEmpty, ifElse, is, assoc, prop, map, pipe, __ } from 'ramda'
+const { iff, validateSchema } = require('feathers-hooks-common')
+const taskPlanSchema = require('../schemas/taskPlan')
+import ajv from '../../app/schemas'
 import * as taskRecipes from '../../tasks/data/recipes'
 
 module.exports = function () {
@@ -16,8 +18,17 @@ module.exports = function () {
 
 const hooks = {
   before: {
-    all: [
-      // encodeParams
+    create: [
+      validateSchema(taskPlanSchema, ajv),
+      encodeParams
+    ],
+    update: [
+      validateSchema(taskPlanSchema, ajv),
+      encodeParams
+    ],
+    patch: [
+      validateSchema(taskPlanSchema, ajv),
+      encodeParams
     ]
   },
   after: {
@@ -46,11 +57,11 @@ function createChildTaskPlans (hook) {
         parentTaskPlanId: hook.result.id,
         assigneeId: hook.data.assigneeId,
         taskRecipeId: childTaskRecipe.id,
-        params: hook.data.params
+        params: hook.result.params
       })
     })
   )
-  .then(() => hook)
+    .then(() => hook)
 }
 
 const transformProp = transformer => propName => object => pipe(
@@ -77,5 +88,4 @@ function decodeParams (hook) {
   if (hook.result) {
     hook.result = transformPropMaybeArray(JSON.parse)('params')(hook.result)
   }
-  return hook
 }

tasks/util/validateTaskPlan.test.js

@@ -0,0 +1,30 @@
+import test from 'ava'
+import * as mock from '../data/mock'
+import ajv from '../../app/schemas'
+
+const { validateSchema } = require('feathers-hooks-common')
+const schema = require('../schemas/taskPlan')
+
+let hookBefore
+
+test.beforeEach(t => {
+  hookBefore = {
+    type: 'before',
+    method: 'create',
+    params: { provider: 'rest' },
+    data: mock.mockTaskPlans[1]
+  }
+  console.log(hookBefore.data)
+})
+
+test('works with simple plan', (t) => {
+  try {
+    validateSchema(schema, ajv)(hookBefore)
+  } catch (err) {
+    if (err.errors) {
+      console.log('validation errors: ', err.errors)
+    }
+    t.fail('validation failed unexpectedly')
+  }
+  t.pass('recipe was validated')
+})