Add tests to the addCustomField method and catch error when key conta…

…ins a period
RocketChat · Jan 13, 2021 · 2f57f3a · 2f57f3a
1 parent 8073acb
commit 2f57f3a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/server/accessors/MessageBuilder.ts b/src/server/accessors/MessageBuilder.ts
@@ -202,6 +202,10 @@ export class MessageBuilder implements IMessageBuilder {
             throw new Error(`The message already contains a custom field by the key: ${ key }`);
         }
 
+        if (key.includes('.')) {
+            throw new Error(`The given key contains a period, which is not allowed. Key: ${ key }`);
+        }
+
         this.msg.customFields[key] = value;
         return this;
     }

diff --git a/tests/server/accessors/MessageBuilder.spec.ts b/tests/server/accessors/MessageBuilder.spec.ts
@@ -104,5 +104,11 @@ export class MessageBuilderAccessorTestFixture {
         Expect(mb.setParseUrls(false)).toBe(mb);
         Expect(msg.parseUrls).toEqual(false);
         Expect(mb.getParseUrls()).toEqual(false);
+
+        Expect(mb.addCustomField('thing', 'value')).toBe(mb);
+        Expect(msg.customFields).toBeDefined();
+        Expect(msg.customFields.thing).toBe('value');
+        Expect(() => mb.addCustomField('thing', 'second')).toThrowError(Error, 'The message already contains a custom field by the key: thing');
+        Expect(() => mb.addCustomField('thing.', 'second')).toThrowError(Error, 'The given key contains a period, which is not allowed. Key: thing.');
     }
 }