From 8104b021cde7b1455fa480491eb3128974267537 Mon Sep 17 00:00:00 2001
From: Frank Hinek <frankhinek@users.noreply.github.com>
Date: Sun, 19 Nov 2023 19:52:58 -0500
Subject: [PATCH] Fix issue that was causing record.send() and record.update()
 issues

Signed-off-by: Frank Hinek <frankhinek@users.noreply.github.com>
---
 packages/api/src/record.ts        |  2 +-
 packages/api/tests/record.spec.ts | 75 ++++++++++++++++++++++++++++++-
 2 files changed, 74 insertions(+), 3 deletions(-)

diff --git a/packages/api/src/record.ts b/packages/api/src/record.ts
index 88c7fc3e9..b7df37753 100644
--- a/packages/api/src/record.ts
+++ b/packages/api/src/record.ts
@@ -366,7 +366,7 @@ export class Record implements RecordModel {
     }
 
     // Throw an error if an attempt is made to modify immutable properties. `data` has already been handled.
-    const mutableDescriptorProperties = new Set(['data', 'dataCid', 'dataSize', 'dateModified', 'datePublished', 'published']);
+    const mutableDescriptorProperties = new Set(['data', 'dataCid', 'dataSize', 'datePublished', 'messageTimestamp', 'published']);
     Record.verifyPermittedMutation(Object.keys(options), mutableDescriptorProperties);
 
     // If a new `dateModified` was not provided, remove the equivalent `messageTimestamp` property from from the
diff --git a/packages/api/tests/record.spec.ts b/packages/api/tests/record.spec.ts
index 0c13bcbfb..b0bda397a 100644
--- a/packages/api/tests/record.spec.ts
+++ b/packages/api/tests/record.spec.ts
@@ -659,6 +659,46 @@ describe('Record', () => {
       expect(await aliceRemoteEmailRecord.data.text()).to.equal(dataString);
     });
 
+    it('writes updated records to a remote DWN', async () => {
+      /**
+       * NOTE: The issue that this test was added to cover was intermittently failing the first
+       * time the updated record is sent to the remote DWN. However, it always failed on the second
+       * attempt to send the updated record to the remote DWN. As a result, this test was written
+       * to update the record twice and send it to the remote DWN after each update to ensure that
+       * the issue is covered.
+       */
+
+      // Alice writes a message to her agent connected DWN.
+      const { status, record } = await dwn.records.write({
+        data    : 'Hello, world!',
+        message : {
+          schema     : 'foo/bar',
+          dataFormat : 'text/plain'
+        }
+      });
+      expect(status.code).to.equal(202);
+
+      // Write the record to Alice's remote DWN.
+      let sendResult = await record.send(alice.did);
+      expect(sendResult.status.code).to.equal(202);
+
+      // Update the record by mutating the data property.
+      let updateResult = await record!.update({ data: 'hi' });
+      expect(updateResult.status.code).to.equal(202);
+
+      // Write the updated record to Alice's remote DWN a second time.
+      sendResult = await record!.send(alice.did);
+      expect(sendResult.status.code).to.equal(202);
+
+      // Update the record again.
+      updateResult = await record!.update({ data: 'bye' });
+      expect(updateResult.status.code).to.equal(202);
+
+      // Write the updated record to Alice's remote DWN a third time.
+      sendResult = await record!.send(alice.did);
+      expect(sendResult.status.code).to.equal(202);
+    });
+
     it(`writes records to remote DWNs for someone else's DID`, async () => {
       const dataString = 'Hello, world!';
 
@@ -1086,6 +1126,35 @@ describe('Record', () => {
       expect(updatedData).to.equal('bye');
     });
 
+    it('returns new dateModified after each update', async () => {
+      // Initial write of the record.
+      const { status, record } = await dwn.records.write({
+        data    : 'Hello, world!',
+        message : {
+          schema     : 'foo/bar',
+          dataFormat : 'text/plain'
+        }
+      });
+      const initialDateModified = record.dateModified;
+      expect(status.code).to.equal(202);
+
+      // First update of the record.
+      let updateResult = await record!.update({ data: 'hi' });
+      expect(updateResult.status.code).to.equal(202);
+
+      // Verify that the dateModified was updated.
+      const firstUpdateDateModified = record.dateModified;
+      expect(initialDateModified).to.not.equal(firstUpdateDateModified);
+
+      //  Second update of the record.
+      updateResult = await record!.update({ data: 'bye' });
+      expect(updateResult.status.code).to.equal(202);
+
+      // Verify that the dateModified was updated.
+      const secondUpdateDateModified = record.dateModified;
+      expect(firstUpdateDateModified).to.not.equal(secondUpdateDateModified);
+    });
+
     it('throws an exception when an immutable property is modified', async () => {
       const { status, record } = await dwn.records.write({
         data    : 'Hello, world!',
@@ -1098,8 +1167,10 @@ describe('Record', () => {
       expect(status.code).to.equal(202);
       expect(record).to.not.be.undefined;
 
-      // @ts-expect-error because this test intentionally specifies an immutable property that is not present in RecordUpdateOptions.
-      await expect(record!.update({ dataFormat: 'application/json' })).to.eventually.be.rejectedWith('is an immutable property. Its value cannot be changed.');
+      await expect(
+        // @ts-expect-error because this test intentionally specifies an immutable property that is not present in RecordUpdateOptions.
+        record!.update({ dataFormat: 'application/json' })
+      ).to.eventually.be.rejectedWith('is an immutable property. Its value cannot be changed.');
     });
   });
 });