Merge pull request #164 from planetscale/sanitize-buffer

Support binary data

Author: ayrton

__tests__/index.test.ts

@@ -626,6 +626,11 @@ describe('cast', () => {
     expect(cast({ name: 'test', type: 'FLOAT64' }, '2.32')).toEqual(2.32)
   })
 
+  test('casts binary data to array of 8-bit unsigned integers', () => {
+    expect(cast({ name: 'test', type: 'BLOB' }, '')).toEqual(new Uint8Array([]))
+    expect(cast({ name: 'test', type: 'BLOB' }, 'Å')).toEqual(new Uint8Array([197]))
+  })
+
   test('casts JSON string to JSON object', () => {
     expect(cast({ name: 'test', type: 'JSON' }, '{ "foo": "bar" }')).toStrictEqual({ foo: 'bar' })
   })

__tests__/text.test.ts

@@ -1,4 +1,4 @@
-import { decode, hex } from '../src/text'
+import { decode, hex, uint8Array, uint8ArrayToHex } from '../src/text'
 
 describe('text', () => {
   describe('decode', () => {
@@ -32,4 +32,17 @@ describe('text', () => {
       expect(hex('aa')).toEqual('0x6161')
     })
   })
+
+  describe('uint8Array', () => {
+    test('converts to an array of 8-bit unsigned integers', () => {
+      expect(uint8Array('')).toEqual(new Uint8Array([]))
+      expect(uint8Array('Å')).toEqual(new Uint8Array([197]))
+    })
+  })
+
+  describe('uint8ArrayToHex', () => {
+    test('converts an array of 8-bit unsigned integers to hex', () => {
+      expect(uint8ArrayToHex(new Uint8Array([197]))).toEqual('0xc5')
+    })
+  })
 })

jest.config.ts

@@ -16,7 +16,7 @@ export default {
   testEnvironment: 'node',
 
   // Automatically clear mock calls, instances, contexts and results before every test
-  clearMocks: true
+  clearMocks: true,
 
   // Indicates whether the coverage information should be collected while executing the test
   // collectCoverage: false,
@@ -90,7 +90,9 @@ export default {
   // ],
 
   // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
-  // moduleNameMapper: {},
+  moduleNameMapper: {
+    './text.js': './text'
+  },
 
   // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
   // modulePathIgnorePatterns: [],

src/index.ts

@@ -1,7 +1,7 @@
 import { format } from './sanitization.js'
 export { format } from './sanitization.js'
+import { decode, uint8Array } from './text.js'
 export { hex } from './text.js'
-import { decode } from './text.js'
 import { Version } from './version.js'
 
 type Row<T extends ExecuteAs = 'object'> = T extends 'array' ? any[] : T extends 'object' ? Record<string, any> : never
@@ -379,7 +379,7 @@ function decodeRow(row: QueryResultRow): Array<string | null> {
 }
 
 export function cast(field: Field, value: string | null): any {
-  if (value === '' || value == null) {
+  if (value == null) {
     return value
   }
 
@@ -404,14 +404,15 @@ export function cast(field: Field, value: string | null): any {
     case 'TIME':
     case 'DATETIME':
     case 'TIMESTAMP':
+      return value
     case 'BLOB':
     case 'BIT':
     case 'VARBINARY':
     case 'BINARY':
     case 'GEOMETRY':
-      return value
+      return uint8Array(value)
     case 'JSON':
-      return JSON.parse(decode(value))
+      return value ? JSON.parse(decode(value)) : value
     default:
       return decode(value)
   }

src/sanitization.ts

@@ -1,3 +1,5 @@
+import { uint8ArrayToHex } from './text.js'
+
 type Stringable = { toString: () => string }
 type Value = null | undefined | number | boolean | string | Array<Value> | Date | Stringable
 
@@ -47,6 +49,10 @@ function sanitize(value: Value): string {
     return quote(value.toISOString().slice(0, -1))
   }
 
+  if (value instanceof Uint8Array) {
+    return uint8ArrayToHex(value)
+  }
+
   return quote(value.toString())
 }
 

src/text.ts

@@ -1,14 +1,23 @@
 const decoder = new TextDecoder('utf-8')
 
 export function decode(text: string | null | undefined): string {
-  return text ? decoder.decode(Uint8Array.from(bytes(text))) : ''
+  return text ? decoder.decode(uint8Array(text)) : ''
 }
 
 export function hex(text: string): string {
   const digits = bytes(text).map((b) => b.toString(16).padStart(2, '0'))
   return `0x${digits.join('')}`
 }
 
+export function uint8Array(text: string): Uint8Array {
+  return Uint8Array.from(bytes(text))
+}
+
+export function uint8ArrayToHex(uint8: Uint8Array): string {
+  const digits = Array.from(uint8).map((i) => i.toString(16).padStart(2, '0'))
+  return `0x${digits.join('')}`
+}
+
 function bytes(text: string): number[] {
   return text.split('').map((c) => c.charCodeAt(0))
 }