Merge pull request #498 from xpepermint/master

Fix cert calculation bug

INTERFACE.md

@@ -109,7 +109,7 @@ import { Cert } from '@0xcert/cert';
 
 const cert = new Cert({ schema });
 const imprints = await cert.notarize(data);
-const imprints = await cert.disclose(exampleData, [ ...paths... ]);
+const imprints = await cert.disclose(defaultData, [ ...paths... ]);
 const imprint = await cert.calculate(data, imprints);
 const imprint = await cert.imprint(data);
 ```

common/config/rush/version-policies.json

@@ -2,7 +2,7 @@
   {
     "policyName": "patchAll",
     "definitionName": "lockStepVersion",
-    "version": "1.5.0",
+    "version": "1.5.2",
     "nextBump": "patch"
   }
 ]

packages/0xcert-cert/CHANGELOG.json

@@ -1,6 +1,18 @@
 {
   "name": "@0xcert/cert",
   "entries": [
+    {
+      "version": "1.5.2",
+      "tag": "@0xcert/cert_v1.5.2",
+      "date": "Fri, 10 May 2019 16:39:10 GMT",
+      "comments": {}
+    },
+    {
+      "version": "1.5.1",
+      "tag": "@0xcert/cert_v1.5.1",
+      "date": "Mon, 06 May 2019 16:02:11 GMT",
+      "comments": {}
+    },
     {
       "version": "1.5.0",
       "tag": "@0xcert/cert_v1.5.0",

packages/0xcert-cert/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Change Log - @0xcert/cert
 
-This log was last generated on Fri, 03 May 2019 12:52:02 GMT and should not be manually modified.
+This log was last generated on Fri, 10 May 2019 16:39:10 GMT and should not be manually modified.
+
+## 1.5.2
+Fri, 10 May 2019 16:39:10 GMT
+
+*Version update only*
+
+## 1.5.1
+Mon, 06 May 2019 16:02:11 GMT
+
+*Version update only*
 
 ## 1.5.0
 Fri, 03 May 2019 12:52:02 GMT

packages/0xcert-cert/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xcert/cert",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "Asset certification module for 0xcert Framework.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -72,8 +72,8 @@
     "typescript": "^3.1.1"
   },
   "dependencies": {
-    "@0xcert/utils": "1.5.0",
-    "@0xcert/merkle": "1.5.0",
-    "@0xcert/conventions": "1.5.0"
+    "@0xcert/utils": "1.5.2",
+    "@0xcert/merkle": "1.5.2",
+    "@0xcert/conventions": "1.5.2"
   }
 }

packages/0xcert-cert/src/core/cert.ts

@@ -129,11 +129,14 @@ export class Cert {
    */
   protected buildSchemaProps(data: any, schema = this.schema, prepend = []): any {
     if (schema.type === 'array') {
-      return (data || [])
+      const items = (data || [])
         .map((v, i) => {
           return this.buildSchemaProps(v, schema.items, [...prepend, i]);
         })
         .reduce((a, b) => a.concat(b), []);
+      return items.length > 0
+        ? items
+        : [this.buildSchemaProps(undefined, {}, [...prepend])]; // add empty object to preserve keys sequence
     } else if (schema.type === 'object') {
       return Object.keys(schema.properties)
         .sort()
@@ -260,7 +263,7 @@ export class Cert {
       const dataIndex = this.getPathIndexes(prop.path).pop();
       const recipeValue = recipe.values.find((v: any) => v.index === dataIndex);
 
-      if (typeof recipeValue === undefined) {
+      if (typeof recipeValue === 'undefined') {
         continue;
       }
 

packages/0xcert-cert/src/tests/core/cert/calculate-instance-method.test.ts

@@ -1,23 +1,23 @@
 import { Spec } from '@hayspec/spec';
 import { Cert } from '../../../core/cert';
-import { exampleData, exampleSchema } from '../helpers/schema';
+import { defaultData, defaultSchema } from '../helpers/schemas';
 
 const spec = new Spec();
 
 spec.test('imprints complete data object', async (ctx) => {
   const cert = new Cert({
-    schema: exampleSchema,
+    schema: defaultSchema,
   });
-  const recipes = await cert.notarize(exampleData);
-  const imprint = await cert.calculate(exampleData, recipes);
+  const recipes = await cert.notarize(defaultData);
+  const imprint = await cert.calculate(defaultData, recipes);
   ctx.is(imprint, '048c8f3384d5600792a4c8279d2c933fa43c26b81f2cab63462b72dd7488baad');
 });
 
 spec.test('validates selected paths', async (ctx) => {
   const cert = new Cert({
-    schema: exampleSchema,
+    schema: defaultSchema,
   });
-  const recipes = await cert.disclose(exampleData, [
+  const recipes = await cert.disclose(defaultData, [
     ['name'],
   ]);
   const data = { name: 'B' };
@@ -27,9 +27,9 @@ spec.test('validates selected paths', async (ctx) => {
 
 spec.test('validates selected nested paths', async (ctx) => {
   const cert = new Cert({
-    schema: exampleSchema,
+    schema: defaultSchema,
   });
-  const recipes = await cert.disclose(exampleData, [
+  const recipes = await cert.disclose(defaultData, [
     ['name'],
     ['books', 1, 'title'],
   ]);
@@ -43,9 +43,9 @@ spec.test('validates selected nested paths', async (ctx) => {
 
 spec.test('fails when data includes more data then exposed', async (ctx) => {
   const cert = new Cert({
-    schema: exampleSchema,
+    schema: defaultSchema,
   });
-  const recipes = await cert.disclose(exampleData, [
+  const recipes = await cert.disclose(defaultData, [
     ['name'],
     ['books', 1, 'title'],
   ]);
@@ -59,9 +59,9 @@ spec.test('fails when data includes more data then exposed', async (ctx) => {
 
 spec.test('pass on custom properties not defined by schema', async (ctx) => {
   const cert = new Cert({
-    schema: exampleSchema,
+    schema: defaultSchema,
   });
-  const recipes = await cert.disclose(exampleData, [
+  const recipes = await cert.disclose(defaultData, [
     ['name'],
   ]);
   const data = {
@@ -72,4 +72,17 @@ spec.test('pass on custom properties not defined by schema', async (ctx) => {
   ctx.is(imprint, '048c8f3384d5600792a4c8279d2c933fa43c26b81f2cab63462b72dd7488baad');
 });
 
+spec.test('pass on preliminary array and following object empty fields', async (ctx) => {
+  // Ref: https://github.com/0xcert/framework/issues/499
+  const cert = new Cert({
+    schema: defaultSchema,
+  });
+  const data = {
+    email: 'foo',
+  };
+  const recipes = await cert.notarize(data);
+  const imprint = await cert.calculate(data, recipes);
+  ctx.is(imprint, 'f5414c1036e8764d0ded2f3b33dd85bc511f080752a1d27eec17d647bdf7b62f');
+});
+
 export default spec;