add type json-schemas for all data models #124

michael-smith-nz · 2017-08-01T10:31:36Z

In this PR:

added docs to readme explaining json-schema and json-schema-faker
profile, taskPlan and taskRecipe json schema
profile story now uses json-faker for mock data (see gif below)
feathers hook for validating taskPlan and taskRecipe
tests for feathers validation
minor bug fixes that were blocking me

Not in this PR

schemas for models that are not being used by feathers (e.g taskWork)
dogstack auth schemas

closes #118

michael-smith-nz · 2017-08-01T13:26:18Z

agents/components/Profile.js

@@ -105,11 +105,6 @@ export default compose(
    toggleEdit: ({ setEditing }) => () => setEditing(not)
  }),
  connectForm({
-    form: 'profile',
-    initialValues: {


@ahdinosaur How can I fill the form with data from props? When I remove the initialValues the form is empty. I'm needing this to fill the Profile story with fake data.

right, ideally we pass it in from here. i think we did something about this in #120, one sec.

right, we pass in initivalValues and enableReinitialize. can either cherry-pick from there, merge that pull request as is and rebase on top, or add those lines here.

@ahdinosaur Thanks! Added those lines (see below commit)

michael-smith-nz · 2017-08-08T14:46:00Z

tasks/util/validateTaskPlan.test.js

+
+const Ajv = require('ajv')
+const { validateSchema } = require('feathers-hooks-common')
+const schema = require('../schemas/taskPlan')


Hey @ahdinosaur Would love some help here as I've been working on this problem for a while with no luck.
I'm getting this error when running this test:

[SyntaxError: Error resolving $ref pointer "http://localhost:3000/tasks/schemas/taskRecipe.json#/id". Token "id" does not exist.]

Even when the id property is in the schema

Thanks!

it seems the library expects to find referenced schemas at a particular remote URL, according to the JSON schema standard. we want to somehow locally pass in all the schemas up front and tell it not to look remotely.

ahdinosaur · 2017-08-08T22:31:53Z

tasks/schemas/taskRecipe.json

+  "type": "object",
+  "properties": {
+    "id": {
+      "$ref": "#/id"


or maybe this should be #/definitions/id?

ahdinosaur · 2017-08-23T23:24:30Z

README.md

@@ -226,6 +226,12 @@ cp cobuy-config/*.js cobuy/config
 heroku run npm run db migrate:latest --app=cobuy
 ```

+### JSON schema


👍 yay docs 📔

ahdinosaur

🥇

ahdinosaur · 2017-08-23T23:26:40Z

agents/schemas/profile.json

+  "required": [
+    "id",
+    "agentId",
+    "name"


i'm not sure if name is required. or at least, at the moment i think we create "empty" profiles when we create a group agent to be updated later.

ahdinosaur · 2017-08-23T23:26:58Z

agents/stories/Profile.js

-    avatar: 'http://dinosaur.is/images/mikey-small.jpg'
-  }
-}
+const profile = jsf(schema)


ahdinosaur · 2017-08-23T23:29:21Z

agents/schemas/profile.json

+      "description": "Id referencing profile"
+    },
+    "agentId": {
+      "type": "integer",


can this be

{ "$ref": "/agents/Agent#/definitions/id" }

oh wait nevermind, we don't have a schema for Agent. all good!

ahdinosaur · 2017-08-23T23:29:39Z

tasks/schemas/taskPlan.json

+      "description": "Person or group or related agents (e.g. admins) being assigned"
+    },
+    "taskRecipeId": {
+      "$ref": "/tasks/taskRecipe#/definitions/id",


sweet. 🍈

ahdinosaur · 2017-08-23T23:30:18Z

tasks/schemas/taskPlan.json

+{
+  "id": "/tasks/taskPlan",
+  "title": "Task Plan",
+  "description": "An assignment of the task to an agent",


yes! thanks you.

ahdinosaur · 2017-08-23T23:30:59Z

tasks/schemas/taskPlan.json

+      "description": "Id referencing task plan"
+    },
+    "parentTaskPlanID": {
+      "type": "integer",


can this be a $ref like taskRecipeId?

Oh good catch

ahdinosaur · 2017-08-23T23:33:20Z

tasks/services/plans.js

+const Ajv = require('ajv')
+const taskPlanSchema = require('../schemas/taskPlan')
+const taskRecipeSchema = require('../schemas/taskRecipe')
+const ajv = new Ajv({$data: true})


i wonder if this should be a singleton somewhere in a module. like we export the ajv object with all the schemas added in app/schema.js. then we'd require that here.

ahdinosaur · 2017-08-23T23:33:46Z

tasks/services/plans.js

-    all: [
-      // encodeParams
-    ]
+    create: [validateSchema(taskPlanSchema, ajv), encodeParams],


very legit.

minor nit: maybe format for each hook to be on its own line.

ahdinosaur · 2017-08-23T23:34:11Z

tasks/services/plans.js

@@ -46,11 +51,11 @@ function createChildTaskPlans (hook) {
        parentTaskPlanId: hook.result.id,
        assigneeId: hook.data.assigneeId,
        taskRecipeId: childTaskRecipe.id,
-        params: hook.data.params
+        params: hook.result.params


ahdinosaur · 2017-08-23T23:34:35Z

tasks/util/validateTaskPlan.test.js

@@ -0,0 +1,34 @@
+import test from 'ava'


woo hoo tests 😊

Have not tested internal $ref yet

Still need to write tests to test the self referencing taskRecipe

commiting to recieve feedback

fixes #132

michael-smith-nz · 2017-08-29T14:00:00Z

@ahdinosaur Changes and rebase made ready for merge

michael-smith-nz added the in progress label Aug 1, 2017

michael-smith-nz changed the title ~~chore(docs): add json schema info~~ add type json-schemas for all data models Aug 1, 2017

michael-smith-nz commented Aug 1, 2017

View reviewed changes

michael-smith-nz self-assigned this Aug 3, 2017

michael-smith-nz commented Aug 8, 2017

View reviewed changes

ahdinosaur reviewed Aug 8, 2017

View reviewed changes

michael-smith-nz force-pushed the chore/json-schemas branch from f2bb8df to 4f81f6a Compare August 15, 2017 13:21

michael-smith-nz assigned ahdinosaur Aug 17, 2017

michael-smith-nz requested a review from ahdinosaur August 17, 2017 16:14

michael-smith-nz unassigned ahdinosaur Aug 17, 2017

michael-smith-nz added review and removed in progress labels Aug 21, 2017

ahdinosaur reviewed Aug 23, 2017

View reviewed changes

ahdinosaur approved these changes Aug 23, 2017

View reviewed changes

michael-smith-nz added 16 commits August 29, 2017 14:53

chore(docs): add json schema info

18267d0

chore(schema) add agent profile schema

cc7920c

chore(story): add schema-faker to Profile story

04db976

feature(story): add faker to profile schema

746e2d1

chore(schema): add task plan and recipe schema

40a631e

Have not tested internal $ref yet

chore(schema): add feathers validation hook for taskRecipe

382a1e2

Still need to write tests to test the self referencing taskRecipe

chore(schema): add test for feathers validation

34b0d70

chore(tests): add test for failed task recipe validation

18fdac0

chore(tests): move taskRecipe mock data to automated

e5f39bd

chore(tests): add test for taskRecipe

20abced

commiting to recieve feedback

chore(tests): task tests passing without mock data

d6edc58

chore(schema): fic schema ids

3dfe2d3

chore(tests): finish task recipe and plan tests

5edc378

fix taskplan hook encode and decode params incorrectly

382fc71

fixes #132

update after PR changes

6e8febe

move ajv to a singleton

662ba60

michael-smith-nz force-pushed the chore/json-schemas branch from 90b9312 to 662ba60 Compare August 29, 2017 13:57

ahdinosaur merged commit 114dc88 into master Aug 30, 2017

ahdinosaur removed the review label Aug 30, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add type json-schemas for all data models #124

add type json-schemas for all data models #124

michael-smith-nz commented Aug 1, 2017 •

edited

Loading

michael-smith-nz Aug 1, 2017

ahdinosaur Aug 2, 2017

ahdinosaur Aug 2, 2017

michael-smith-nz Aug 2, 2017

michael-smith-nz Aug 8, 2017

ahdinosaur Aug 8, 2017

ahdinosaur Aug 8, 2017

ahdinosaur Aug 23, 2017

ahdinosaur left a comment

ahdinosaur Aug 23, 2017

ahdinosaur Aug 23, 2017

ahdinosaur Aug 23, 2017

ahdinosaur Aug 23, 2017

ahdinosaur Aug 23, 2017

ahdinosaur Aug 23, 2017

michael-smith-nz Aug 29, 2017

ahdinosaur Aug 23, 2017

ahdinosaur Aug 23, 2017

ahdinosaur Aug 23, 2017

ahdinosaur Aug 23, 2017

michael-smith-nz commented Aug 29, 2017

add type json-schemas for all data models #124

add type json-schemas for all data models #124

Conversation

michael-smith-nz commented Aug 1, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahdinosaur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

michael-smith-nz commented Aug 29, 2017

michael-smith-nz commented Aug 1, 2017 •

edited

Loading