feat: support bindary buffer that has been JSON.parse(JSON.strinified())

hapijs · Aug 27, 2023 · 4e03f19 · 4e03f19
1 parent 55c3f6a
commit 4e03f19
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 3 deletions.
diff --git a/lib/types/binary.js b/lib/types/binary.js
@@ -13,10 +13,16 @@ module.exports = Any.extend({
 
     type: 'binary',
 
-    coerce: {
-        from: 'string',
-        method(value, { schema }) {
+    coerce(value, { schema }) {
 
+        if (typeof value === 'string') {
+            try {
+                return { value: Buffer.from(value, schema._flags.encoding) };
+            }
+            catch (ignoreErr) { }
+        }
+
+        if (typeof value === 'object' && value !== null && value.type === 'Buffer') {
             try {
                 return { value: Buffer.from(value, schema._flags.encoding) };
             }

diff --git a/test/types/binary.js b/test/types/binary.js
@@ -29,6 +29,18 @@ describe('binary', () => {
         expect(value.toString('utf8')).to.equal('test');
     });
 
+    it('converts a JSON encoded and decoded buffer to a buffer', () => {
+
+        const testPngMagicNumber = Buffer.from('89504E470D0A', 'hex');
+        const jsonEncodedBuffer = JSON.stringify(testPngMagicNumber);
+        const jsonDecodedBuffer = JSON.parse(jsonEncodedBuffer);
+
+        const value = Joi.binary().validate(jsonDecodedBuffer).value;
+        expect(value instanceof Buffer).to.equal(true);
+        expect(value.length).to.equal(testPngMagicNumber.length);
+        expect(value).to.equal(testPngMagicNumber);
+    });
+
     it('validates allowed buffer content', () => {
 
         const hello = Buffer.from('hello');
@@ -120,6 +132,23 @@ describe('binary', () => {
             ]);
         });
 
+        it('returns an error when a JSON encoded & decoded buffer object is used in strict mode', () => {
+
+            // Generate Buffer and stringify it as JSON.
+            const testPngMagicNumber = Buffer.from('89504E470D0A', 'hex');
+            const jsonEncodedBuffer = JSON.stringify(testPngMagicNumber);
+            const jsonDecodedBuffer = JSON.parse(jsonEncodedBuffer);
+
+            Helper.validate(Joi.binary().strict(), [
+                [jsonDecodedBuffer, false, {
+                    message: '"value" must be a buffer or a string',
+                    path: [],
+                    type: 'binary.base',
+                    context: { label: 'value', value: jsonDecodedBuffer }
+                }]
+            ]);
+        });
+
         it('accepts a buffer object', () => {
 
             Helper.validate(Joi.binary(), [