feat(validation): validate reserved key names (#12)

https://coveord.atlassian.net/browse/CDX-308
coveo · May 10, 2021 · ac678ad · ac678ad
1 parent c6014af
commit ac678ad
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 1 deletion.
diff --git a/src/documentBuilder.spec.ts b/src/documentBuilder.spec.ts
@@ -77,6 +77,23 @@ describe('DocumentBuilder', () => {
     expect(docBuilder.withPermanentId('id').marshal().permanentId).toBe('id');
   });
 
+  it('throws when adding a reserved key name metadata', () => {
+    const theseShouldThrow = [
+      'compressedBinaryData',
+      'compressedBinaryDataFileId',
+      'parentId',
+      'fileExtension',
+      'data',
+      'permissions',
+      'documentId',
+      'orderingId',
+    ];
+
+    for (const shouldThrow of theseShouldThrow) {
+      expect(() => docBuilder.withMetadataValue(shouldThrow, 'foo')).toThrow();
+    }
+  });
+
   it('should validate file extension', () => {
     expect(() => docBuilder.withFileExtension('nope')).toThrow();
   });

diff --git a/src/documentBuilder.ts b/src/documentBuilder.ts
@@ -132,7 +132,24 @@ export class DocumentBuilder {
    * @returns
    */
   public withMetadataValue(key: string, value: MetadataValue) {
-    // TODO: validate reserved names
+    const reservedKeyNames = [
+      'compressedBinaryData',
+      'compressedBinaryDataFileId',
+      'parentId',
+      'fileExtension',
+      'data',
+      'permissions',
+      'documentId',
+      'orderingId',
+    ];
+    if (
+      reservedKeyNames.some(
+        (reservedKey) => reservedKey.toLowerCase() === key.toLowerCase()
+      )
+    ) {
+      throw `Cannot use ${key} as a metadata key: It is a reserved key name. See https://docs.coveo.com/en/78/index-content/push-api-reference#json-document-reserved-key-names`;
+    }
+
     this.doc.metadata![key] = value;
     return this;
   }