Return 204 when there is no data

package.json

@@ -158,7 +158,7 @@
  "lint": "eslint . --max-warnings 0",
  "lint:fix": "eslint . --fix",
  "circular-dependency-check": "depcruise src",
- "test:node": "npm run compile-validators && tsc && c8 mocha \"dist/esm/tests/**/*.spec.js\"",
+ "test:node": "npm run compile-validators && tsc && c8 node --enable-source-maps node_modules/.bin/mocha \"dist/esm/tests/**/*.spec.js\"",
  "test:browser": "npm run compile-validators && cross-env karma start karma.conf.cjs",
  "test:browser-debug": "npm run compile-validators && cross-env karma start karma.conf.debug.cjs",
  "license-check": "license-report --only=prod > license-report.json && node ./build/license-check.cjs",

src/handlers/records-write.ts

@@ -163,7 +163,12 @@ export class RecordsWriteHandler implements MethodHandler {
  }
 
  const messageReply = {
- status: { code: 202, detail: 'Accepted' }
+ // In order to discern between something that was accepted as a queryable write and something that was accepted
+ // as an initial state we use separate response codes. See https://github.com/TBD54566975/dwn-sdk-js/issues/695
+ // for more details.
+ status: (newMessageIsInitialWrite && dataStream === undefined) ?
+ { code: 204, detail: 'No Content' } :
+ { code: 202, detail: 'Accepted' }
  };
 
  // delete all existing messages of the same record that are not newest, except for the initial write

tests/handlers/messages-subscribe.spec.ts

@@ -324,7 +324,7 @@ export function testMessagesSubscribeHandler(): void {
  }
  });
  const grantWriteReply = await dwn.processMessage(alice.did, grantWrite.message, { dataStream });
- expect(grantWriteReply.status.code).to.equal(202);
+ expect(grantWriteReply.status.code).to.equal(204);
 
 
  // bob attempts to use the `MessagesQuery` grant on an `MessagesSubscribe` message

tests/handlers/records-write.spec.ts

@@ -373,7 +373,7 @@ export function testRecordsWriteHandler(): void {
 
  // simulate synchronize of pruned initial `RecordsWrite`
  const reply = await dwn.processMessage(alice.did, recordsWrite.message);
- expect(reply.status.code).to.equal(202);
+ expect(reply.status.code).to.equal(204);
 
  // verify `RecordsWrite` inserted is not returned with a query
  const recordsQueryMessageData = await TestDataGenerator.generateRecordsQuery({
@@ -3009,6 +3009,7 @@ export function testRecordsWriteHandler(): void {
 
  // bob learns of metadata (ie. dataCid) of alice's secret data,
  // attempts to gain unauthorized access by writing to alice's DWN through open protocol referencing the dataCid without supplying the data
+ // which he is allowed to do, the DWN will treat the operation as an initial-write or a record that has a later and different state.
  const imageRecordsWrite = await TestDataGenerator.generateRecordsWrite({
  author : bob,
  protocol,
@@ -3019,8 +3020,8 @@ export function testRecordsWriteHandler(): void {
  dataSize,
  recipient : alice.did
  });
- const imageReply = await dwn.processMessage(alice.did, imageRecordsWrite.message, { dataStream: imageRecordsWrite.dataStream });
- expect(imageReply.status.code).to.equal(202); // allows write but is not readable or queryable
+ const imageReply = await dwn.processMessage(alice.did, imageRecordsWrite.message);
+ expect(imageReply.status.code).to.equal(204); // allows write but is not readable or queryable
 
  // verify the record is not able to be read
  const bobRecordsReadData = await RecordsRead.create({
@@ -3101,6 +3102,7 @@ export function testRecordsWriteHandler(): void {
 
  // bob learns of metadata (ie. dataCid) of alice's secret data,
  // attempts to gain unauthorized access by writing to alice's DWN through open protocol referencing the dataCid without supplying the data
+ // which he is allowed to do, the DWN will treat the operation as an initial-write or a record that has a later and different state.
  const imageRecordsWrite = await TestDataGenerator.generateRecordsWrite({
  author : bob,
  protocol,
@@ -3111,8 +3113,8 @@ export function testRecordsWriteHandler(): void {
  dataSize,
  recipient : alice.did
  });
- const imageReply = await dwn.processMessage(alice.did, imageRecordsWrite.message, { dataStream: imageRecordsWrite.dataStream });
- expect(imageReply.status.code).to.equal(202); // allows write but is not readable or queryable
+ const imageReply = await dwn.processMessage(alice.did, imageRecordsWrite.message);
+ expect(imageReply.status.code).to.equal(204); // allows write but is not readable or queryable
 
  // verify the record is not able to be read
  const bobRecordsReadData = await RecordsRead.create({
@@ -4071,7 +4073,7 @@ export function testRecordsWriteHandler(): void {
  data,
  });
  const prunedRecordsWriteReply = await dwn.processMessage(alice.did, prunedRecordsWrite.message);
- expect(prunedRecordsWriteReply.status.code).to.equal(202);
+ expect(prunedRecordsWriteReply.status.code).to.equal(204);
 
  // Update record to published, omitting dataStream
  const recordsWrite = await TestDataGenerator.generateFromRecordsWrite({
@@ -4099,7 +4101,7 @@ export function testRecordsWriteHandler(): void {
  data,
  });
  const prunedRecordsWriteReply = await dwn.processMessage(alice.did, prunedRecordsWrite.message);
- expect(prunedRecordsWriteReply.status.code).to.equal(202);
+ expect(prunedRecordsWriteReply.status.code).to.equal(204);
 
  // Update record to published, omitting dataStream
  const recordsWrite = await TestDataGenerator.generateFromRecordsWrite({
@@ -4144,7 +4146,7 @@ export function testRecordsWriteHandler(): void {
  dataSize : 4
  });
  const bobWriteReply = await dwn.processMessage(bob.did, bobWriteData.message); // intentionally missing data stream
- expect(bobWriteReply.status.code).to.equal(202); // NOTE: allows write here but does not allow read or query later
+ expect(bobWriteReply.status.code).to.equal(204); // NOTE: allows write here but does not allow read or query later
 
  const aliceQueryWriteAfterBobWriteData = await TestDataGenerator.generateRecordsQuery({
  author : alice,

tests/utils/test-data-generator.ts

@@ -396,6 +396,7 @@ export class TestDataGenerator {
 
  /**
  * Generates a RecordsWrite message for testing.
+ * `dataBytes` & `dataStream` returned will be `undefined` as long as `dataCid` or `dataSize` is given.
  * Implementation currently uses `RecordsWrite.create()`.
  * @param input.attesters Attesters of the message. Will NOT be generated if not given.
  * @param input.data Data that belongs to the record. Generated when not given only if `dataCid` and `dataSize` are also not given.