feat: add createdBy field for all records (#142)

Co-authored-by: Gregor MacLennan <gmaclennan@digital-democracy.org>

proto/common/v1.proto

@@ -14,6 +14,8 @@ message Common_1 {
   repeated Link links = 2;
   google.protobuf.Timestamp createdAt = 3 [(required) = true];
   google.protobuf.Timestamp updatedAt = 4 [(required) = true];
+  // 32-byte hash of the discovery key of a core
+  bytes createdBy = 5 [(required) = true];
 }
 /* ignored fields and differences from common.json jsonSchema
  * id is a byte buffer here and a string in jsonSchema

schema/common/v1.json

@@ -22,6 +22,10 @@
       "type": "string",
       "format": "date-time"
     },
+    "createdBy": {
+      "description": "discovery id (hex-encoded 32-byte buffer) of the hypercore where the first version of this document is written",
+      "type": "string"
+    },
     "updatedAt": {
       "description": "RFC3339-formatted datetime of when this version of the element was created",
       "type": "string",
@@ -42,6 +46,7 @@
     "schemaName",
     "updatedAt",
     "links",
-    "versionId"
+    "versionId",
+    "createdBy"
   ]
 }

src/lib/decode-conversions.ts

@@ -250,5 +250,6 @@ function convertCommon(
     links: common.links.map((link) => getVersionId(link)),
     createdAt: common.createdAt,
     updatedAt: common.updatedAt,
+    createdBy: common.createdBy.toString('hex'),
   }
 }

src/lib/encode-conversions.ts

@@ -139,6 +139,7 @@ function convertCommon(
     docId: Buffer.from(common.docId, 'hex'),
     createdAt: common.createdAt,
     updatedAt: common.updatedAt,
+    createdBy: Buffer.from(common.createdBy, 'hex'),
     links: common.links.map((link) => parseVersionId(link)),
   }
 }

test/fixtures/cached.js

@@ -8,6 +8,7 @@ export const cachedValues = {
   projectId: randomBytes(32).toString('hex'),
   authorId: randomBytes(32).toString('hex'),
   coreId: randomBytes(32).toString('hex'),
+  createdBy: randomBytes(32).toString('hex'),
   createdAt: date,
   updatedAt: date,
   attachments: {

test/fixtures/good-docs-completed.js

@@ -16,6 +16,7 @@ export const goodDocsCompleted = [
       schemaName: 'observation',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       lat: 24.0424,
       lon: 21.0214,
@@ -75,6 +76,7 @@ export const goodDocsCompleted = [
       schemaName: 'projectSettings',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       defaultPresets: {
         point: cachedValues.defaultPresets.point,
@@ -94,6 +96,7 @@ export const goodDocsCompleted = [
       schemaName: 'field',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       tagKey: 'otherTagKey',
       type: 'number',
@@ -117,6 +120,7 @@ export const goodDocsCompleted = [
       schemaName: 'preset',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       name: 'myPreset',
       geometry: ['point', 'vertex', 'line'],
@@ -143,6 +147,7 @@ export const goodDocsCompleted = [
       schemaName: 'role',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       roleId: '6fd029a78243',
       fromIndex: 5,
@@ -156,6 +161,7 @@ export const goodDocsCompleted = [
       schemaName: 'deviceInfo',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       name: 'my device name',
     },
@@ -168,6 +174,7 @@ export const goodDocsCompleted = [
       schemaName: 'coreOwnership',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       authCoreId: Buffer.from('authCoreId').toString('hex'),
       configCoreId: Buffer.from('configCoreId').toString('hex'),

test/fixtures/good-docs-minimal.js

@@ -18,6 +18,7 @@ export const goodDocsMinimal = [
       schemaName: 'observation',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       refs: [],
       attachments: [],
@@ -33,6 +34,7 @@ export const goodDocsMinimal = [
       schemaName: 'projectSettings',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
     },
     expected: {},
@@ -44,6 +46,7 @@ export const goodDocsMinimal = [
       schemaName: 'field',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       tagKey: 'myTagKey',
       label: 'my label',
@@ -58,6 +61,7 @@ export const goodDocsMinimal = [
       schemaName: 'preset',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       name: 'myPreset',
       geometry: ['point'],
@@ -76,6 +80,7 @@ export const goodDocsMinimal = [
       schemaName: 'role',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       roleId: '3b0104e370f9',
       fromIndex: 5,
@@ -89,6 +94,7 @@ export const goodDocsMinimal = [
       schemaName: 'deviceInfo',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       name: 'my device name',
     },
@@ -101,6 +107,7 @@ export const goodDocsMinimal = [
       schemaName: 'coreOwnership',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       authCoreId: Buffer.from('authCoreId').toString('hex'),
       configCoreId: Buffer.from('configCoreId').toString('hex'),