#310 - introduced protocolPath to update all affected tests

Author: thehenrytsai

README.md

@@ -3,7 +3,7 @@
 # Decentralized Web Node (DWN) SDK
 
 Code Coverage
-![Statements](https://img.shields.io/badge/statements-93.86%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-93.36%25-brightgreen.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-91.54%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-93.86%25-brightgreen.svg?style=flat)
+![Statements](https://img.shields.io/badge/statements-93.86%25-brightgreen.svg?style=flat) ![Branches](https://img.shields.io/badge/branches-93.39%25-brightgreen.svg?style=flat) ![Functions](https://img.shields.io/badge/functions-91.54%25-brightgreen.svg?style=flat) ![Lines](https://img.shields.io/badge/lines-93.86%25-brightgreen.svg?style=flat)
 
 ## Introduction
 

json-schemas/records/records-write.json

@@ -104,6 +104,9 @@
         "protocol": {
           "type": "string"
         },
+        "protocolPath": {
+          "type": "string"
+        },
         "schema": {
           "type": "string"
         },

src/interfaces/records/messages/records-write.ts

@@ -33,6 +33,7 @@ import { DwnInterfaceName, DwnMethodName } from '../../../core/message.js';
 export type RecordsWriteOptions = {
   recipient?: string;
   protocol?: string;
+  protocolPath?: string;
   contextId?: string;
   schema?: string;
   recordId?: string;
@@ -137,7 +138,10 @@ export class RecordsWrite extends Message<RecordsWriteMessage> {
    * @param options.dateModified If `undefined`, it will be auto-filled with current time.
    */
   public static async create(options: RecordsWriteOptions): Promise<RecordsWrite> {
-    const currentTime = getCurrentTimeInHighPrecision();
+    if ((options.protocol === undefined && options.protocolPath !== undefined) ||
+        (options.protocol !== undefined && options.protocolPath === undefined)) {
+      throw new Error('`protocol` and `protocolPath` must both be defined or undefined at the same time');
+    }
 
     if ((options.data === undefined && options.dataCid === undefined) ||
         (options.data !== undefined && options.dataCid !== undefined)) {
@@ -152,10 +156,13 @@ export class RecordsWrite extends Message<RecordsWriteMessage> {
     const dataCid = options.dataCid ?? await Cid.computeDagPbCidFromBytes(options.data!);
     const dataSize = options.dataSize ?? options.data!.length;
 
+    const currentTime = getCurrentTimeInHighPrecision();
+
     const descriptor: RecordsWriteDescriptor = {
       interface     : DwnInterfaceName.Records,
       method        : DwnMethodName.Write,
       protocol      : options.protocol,
+      protocolPath  : options.protocolPath,
       recipient     : options.recipient!,
       schema        : options.schema,
       parentId      : options.parentId,
@@ -270,6 +277,7 @@ export class RecordsWrite extends Message<RecordsWriteMessage> {
       dateCreated                 : unsignedMessage.descriptor.dateCreated,
       contextId                   : unsignedMessage.contextId,
       protocol                    : unsignedMessage.descriptor.protocol,
+      protocolPath                : unsignedMessage.descriptor.protocolPath,
       parentId                    : unsignedMessage.descriptor.parentId,
       schema                      : unsignedMessage.descriptor.schema,
       dataFormat                  : unsignedMessage.descriptor.dataFormat,

src/interfaces/records/types.ts

@@ -12,6 +12,7 @@ export type RecordsWriteDescriptor = {
   interface: DwnInterfaceName.Records;
   method: DwnMethodName.Write;
   protocol?: string;
+  protocolPath?: string;
   recipient: string;
   schema?: string;
   parentId?: string;
@@ -76,6 +77,7 @@ export type RecordsQueryFilter = {
   attester?: string;
   recipient?: string;
   protocol?: string;
+  protocolPath?: string;
   contextId?: string;
   schema?: string;
   recordId?: string;

tests/interfaces/records/handlers/records-query.spec.ts

@@ -632,13 +632,14 @@ describe('RecordsQueryHandler.handle()', () => {
           }]
         };
 
-        const schema = 'email';
+        const schema = emailProtocolDefinition.labels.email.schema;
         const { message, dataStream } = await TestDataGenerator.generateRecordsWrite(
           {
-            requester : bob,
+            requester    : bob,
             protocol,
+            protocolPath : 'email', // this comes from `labels` in protocol definition
             schema,
-            data      : bobMessageEncryptedBytes,
+            data         : bobMessageEncryptedBytes,
             encryptionInput
           }
         );

tests/interfaces/records/handlers/records-read.spec.ts

@@ -178,6 +178,7 @@ describe('RecordsReadHandler.handle()', () => {
         const imageRecordsWrite = await TestDataGenerator.generateRecordsWrite({
           requester    : alice,
           protocol,
+          protocolPath : 'image', // this comes from `labels` in protocol definition
           schema       : protocolDefinition.labels.image.schema,
           data         : encodedImage,
           recipientDid : alice.did
@@ -219,6 +220,7 @@ describe('RecordsReadHandler.handle()', () => {
         const emailRecordsWrite = await TestDataGenerator.generateRecordsWrite({
           requester    : alice,
           protocol,
+          protocolPath : 'email', // this comes from `labels` in protocol definition
           schema       : protocolDefinition.labels.email.schema,
           data         : encodedEmail,
           recipientDid : bob.did
@@ -268,6 +270,7 @@ describe('RecordsReadHandler.handle()', () => {
         const emailRecordsWrite = await TestDataGenerator.generateRecordsWrite({
           requester    : bob,
           protocol,
+          protocolPath : 'email', // this comes from `labels` in protocol definition
           schema       : protocolDefinition.labels.email.schema,
           data         : encodedEmail,
           recipientDid : alice.did
@@ -407,10 +410,11 @@ describe('RecordsReadHandler.handle()', () => {
 
         const { message, dataStream } = await TestDataGenerator.generateRecordsWrite(
           {
-            requester : bob,
+            requester    : bob,
             protocol,
-            schema    : 'email',
-            data      : bobMessageEncryptedBytes,
+            protocolPath : 'email', // this comes from `labels` in protocol definition
+            schema       : emailProtocolDefinition.labels.email.schema,
+            data         : bobMessageEncryptedBytes,
             encryptionInput
           }
         );