Test whitespace for number

Author: razor-x

src/lib/parse.test.ts

@@ -24,34 +24,6 @@ test('parseUrlSearchParams: with URLSearchParams input', (t) => {
   )
 })
 
-test.todo(
-  'parseUrlSearchParams: parse empty or whitespace number params as null',
-)
-test.todo('parse empty or whitespace boolean params as null')
-test.todo('parse empty or whitespace date params as null')
-test.todo('parse empty or whitespace object params as null')
-test.todo('parse empty or whitespace record params as null')
-
-test.todo('parse empty or whitespace array params as empty')
-test.todo(
-  'cannot parse multiple empty or whitespace array params like foo=&foo=',
-)
-test.todo(
-  'cannot parse mixed empty or whitespace array params like foo=&foo=bar',
-)
-
-test.todo('parse addtional strings as true and false')
-
-test.todo('parse repeated array params like foo=bar&foo=baz')
-test.todo('parse bracket array params like foo[]=bar&foo[]=baz')
-test.todo('parse comma array params like foo=bar,baz')
-
-test.todo('cannot parse mixed array params like foo=bar,baz&foo=bar&foo[]=baz')
-test.todo('cannot parse array values containing a comma like foo=a,b&foo=b,c')
-test.todo(
-  'cannot parse array values containing a comma like foo[]=a,b&foo[]=b,c',
-)
-
 // e.g., foo.bar= would conflict with foo.bar.a= or foo.bar.b=2
 // since this would be a null object containing values (null is still a value).
 test.todo('cannot parse conflicting object keys')

src/lib/parse.ts

@@ -51,14 +51,24 @@ const parseFromParamSchema = (
 const parse = (k: string, values: string[], type: ValueType): unknown => {
   // TODO: Add better errors with coercion. If coercion fails, passthough?
   if (values.length === 0) return undefined
-  if (type === 'number') return Number(values[0])
+
+  if (values[0] == null) {
+    throw new Error(`Unexpected nil value when parsing ${k}`)
+  }
+
+  if (type === 'number') return parseNumber(values[0])
   if (type === 'boolean') return values[0] === 'true'
   if (type === 'string') return String(values[0])
   if (type === 'string_array') return values
   if (type === 'number_array') return values.map((v) => Number(v))
   throw new UnparseableSearchParamError(k, 'unsupported type')
 }
 
+const parseNumber = (v: string): number | null => {
+  if (v.trim().length === 0) return null
+  return Number(v)
+}
+
 export class UnparseableSearchParamError extends Error {
   constructor(name: string, message: string) {
     super(`Could not parse parameter: '${name}' ${message}`)

test/generous-parsing.test.ts

@@ -0,0 +1,45 @@
+import test from 'ava'
+import { z, type ZodSchema } from 'zod'
+
+import { parseUrlSearchParams } from '@seamapi/url-search-params-parser'
+
+const parseEmptyOrWhitespace = test.macro({
+  title(providedTitle) {
+    return `parses empty or whitespace ${providedTitle} params as null`
+  },
+  exec(t, type: ZodSchema) {
+    const schema = z.object({ foo: type })
+    const expected = { foo: null }
+    t.deepEqual(parseUrlSearchParams('foo=', schema), expected)
+    t.deepEqual(parseUrlSearchParams('foo=%20', schema), expected)
+    t.deepEqual(parseUrlSearchParams('foo= %20 ++ +  ', schema), expected)
+    t.deepEqual(parseUrlSearchParams('foo=+', schema), expected)
+  },
+})
+
+test('number', parseEmptyOrWhitespace, z.number())
+
+test.todo('parse empty or whitespace boolean params as null')
+test.todo('parse empty or whitespace date params as null')
+test.todo('parse empty or whitespace object params as null')
+test.todo('parse empty or whitespace record params as null')
+
+test.todo('parse empty or whitespace array params as empty')
+test.todo(
+  'cannot parse multiple empty or whitespace array params like foo=&foo=',
+)
+test.todo(
+  'cannot parse mixed empty or whitespace array params like foo=&foo=bar',
+)
+
+test.todo('parse additional strings as true and false')
+
+test.todo('parse repeated array params like foo=bar&foo=baz')
+test.todo('parse bracket array params like foo[]=bar&foo[]=baz')
+test.todo('parse comma array params like foo=bar,baz')
+
+test.todo('cannot parse mixed array params like foo=bar,baz&foo=bar&foo[]=baz')
+test.todo('cannot parse array values containing a comma like foo=a,b&foo=b,c')
+test.todo(
+  'cannot parse array values containing a comma like foo[]=a,b&foo[]=b,c',
+)