feat(Record): Allow copying with custom data fields (#134)

Needed in relaycorp/veraid-js#43
relaycorp · Jan 20, 2023 · 44665f1 · 44665f1
1 parent 4874a20
commit 44665f1
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 11 deletions.
diff --git a/src/lib/Zone.spec.ts b/src/lib/Zone.spec.ts
@@ -121,7 +121,7 @@ describe('Zone', () => {
         tldDnskey.rrsig.data.signature,
       );
       const mismatchingDnskeyRrsig = tldDnskey.rrsig.record.shallowCopy({
-        dataSerialised: mismatchingDnskeyRrsigData.serialise(),
+        data: mismatchingDnskeyRrsigData.serialise(),
       });
       const result = Zone.init(
         RECORD_TLD,
@@ -149,7 +149,7 @@ describe('Zone', () => {
         tldDnskey.rrsig.data.signature,
       );
       const mismatchingDnskeyRrsig = tldDnskey.rrsig.record.shallowCopy({
-        dataSerialised: mismatchingDnskeyRrsigData.serialise(),
+        data: mismatchingDnskeyRrsigData.serialise(),
       });
       const result = Zone.init(
         RECORD_TLD,

diff --git a/src/lib/utils/dns/DnsRecord.spec.ts b/src/lib/utils/dns/DnsRecord.spec.ts
@@ -312,15 +312,22 @@ describe('DnsRecord', () => {
       expect(newRecord.dataSerialised).toBe(RECORD.dataSerialised);
     });
 
-    test('New data should be used if set', () => {
+    test('New data serialisation should be used if set', () => {
       const newData = Buffer.alloc(8);
-      const newRecord = RECORD.shallowCopy({ dataSerialised: newData });
+      const newRecord = RECORD.shallowCopy({ data: newData });
 
       expect(newRecord.name).toStrictEqual(RECORD.name);
       expect(newRecord.typeId).toStrictEqual(RECORD.typeId);
       expect(newRecord.classId).toStrictEqual(RECORD.classId);
       expect(newRecord.ttl).toStrictEqual(RECORD.ttl);
       expect(newRecord.dataSerialised).toBe(newData);
     });
+
+    test('New data fields should be used if set', () => {
+      const newData = `not-${RECORD.dataFields}`;
+      const newRecord = RECORD.shallowCopy({ data: newData });
+
+      expect(newRecord.dataFields).toBe(newData);
+    });
   });
 });
diff --git a/src/lib/utils/dns/DnsRecord.ts b/src/lib/utils/dns/DnsRecord.ts
@@ -17,7 +17,7 @@ interface RecordFields {
   readonly type: number;
   readonly class: DnsClass;
   readonly ttl: number;
-  readonly dataSerialised: Buffer;
+  readonly data: unknown;
 }
 
 function deserialiseRdata(serialisation: Buffer, typeName: string, codec: Codec<any>): any {
@@ -107,8 +107,8 @@ export class DnsRecord {
     const type = partialRecord.type ?? this.typeId;
     const classId = partialRecord.class ?? this.classId;
     const ttl = partialRecord.ttl ?? this.ttl;
-    const dataSerialised = partialRecord.dataSerialised ?? this.dataSerialised;
-    return new DnsRecord(name, type, classId, ttl, dataSerialised);
+    const data = partialRecord.data ?? this.dataSerialised;
+    return new DnsRecord(name, type, classId, ttl, data);
   }
 
   /**

diff --git a/src/lib/utils/dns/RrSet.spec.ts b/src/lib/utils/dns/RrSet.spec.ts
@@ -53,7 +53,7 @@ describe('RrSet', () => {
     });
 
     test('Multiple records should be supported', () => {
-      const record2 = RECORD.shallowCopy({ dataSerialised: Buffer.from([1, 2]) });
+      const record2 = RECORD.shallowCopy({ data: Buffer.from([1, 2]) });
 
       const rrset = RrSet.init(QUESTION, [RECORD, record2]);
 
@@ -92,8 +92,8 @@ describe('RrSet', () => {
       });
 
       test('RDATA should be sorted from the left if they have same length', () => {
-        const record1 = RECORD.shallowCopy({ dataSerialised: Buffer.from([1, 0]) });
-        const record2 = RECORD.shallowCopy({ dataSerialised: Buffer.from([1, 1]) });
+        const record1 = RECORD.shallowCopy({ data: Buffer.from([1, 0]) });
+        const record2 = RECORD.shallowCopy({ data: Buffer.from([1, 1]) });
 
         const rrset = RrSet.init(QUESTION, [record2, record1]);
 

diff --git a/src/testUtils/records.ts b/src/testUtils/records.ts
@@ -8,6 +8,6 @@ export function copyDnssecRecordData<
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
   return {
     data: newData,
-    record: originalRecord.record.shallowCopy({ dataSerialised: newData.serialise() }),
+    record: originalRecord.record.shallowCopy({ data: newData.serialise() }),
   } as DnsRecord;
 }