🐛 fix bug where filter with boolean false is dropped #66

Author: Crhistian

codegen/templates/utils/paramsSerializer.ts

@@ -17,7 +17,9 @@ export default function ParamSerializer(originalParams: {
         filterVal.forEach(val =>
           valuesArray.push(`${key}=${encodeURIComponent(val)}`)
         )
-      } else if (filterVal) {
+      }
+      // exclude null, undefined, or empty string but permit boolean false to be serialized
+      else if (typeof filterVal === 'boolean' || filterVal) {
         valuesArray.push(`${key}=${encodeURIComponent(filterVal)}`)
       }
     }

src/utils/paramsSerializer.ts

@@ -17,7 +17,9 @@ export default function ParamSerializer(originalParams: {
         filterVal.forEach(val =>
           valuesArray.push(`${key}=${encodeURIComponent(val)}`)
         )
-      } else if (filterVal) {
+      }
+      // exclude null, undefined, or empty string but permit boolean false to be serialized
+      else if (typeof filterVal === 'boolean' || filterVal) {
         valuesArray.push(`${key}=${encodeURIComponent(filterVal)}`)
       }
     }

tests/filtering.test.ts

@@ -10,13 +10,30 @@ beforeEach(() => {
   Tokens.RemoveImpersonationToken()
 })
 
-test('can filter call with boolean', async () => {
+test('can filter call with boolean (true)', async () => {
   Tokens.SetAccessToken(validToken)
-  await Me.ListProducts({ filters: { 'xp.Featued': true } })
+  await Me.ListProducts({ filters: { 'xp.Featured': true } })
   expect(mockAxios.get).toHaveBeenCalledTimes(1)
   expect(mockAxios.get).toHaveBeenCalledWith(`${apiUrl}/me/products`, {
     params: {
-      filters: { 'xp.Featued': true },
+      filters: { 'xp.Featured': true },
+    },
+    paramsSerializer: expect.any(Function),
+    timeout: 60000,
+    headers: {
+      'Content-Type': 'application/json',
+      'Authorization': `Bearer ${validToken}`,
+    },
+  })
+})
+
+test('can filter call with boolean (false)', async () => {
+  Tokens.SetAccessToken(validToken)
+  await Me.ListProducts({ filters: { IsSubmitted: false } })
+  expect(mockAxios.get).toHaveBeenCalledTimes(1)
+  expect(mockAxios.get).toHaveBeenCalledWith(`${apiUrl}/me/products`, {
+    params: {
+      filters: { IsSubmitted: false },
     },
     paramsSerializer: expect.any(Function),
     timeout: 60000,

tests/paramsSerializer.test.ts

@@ -58,3 +58,23 @@ test('should ignore undefined values', () => {
   }
   expect(serialize(params)).toBe('FirstName=Bob&xp.FavoriteColor=red')
 })
+
+test('should allow false boolean', () => {
+  const params = {
+    filters: {
+      FirstName: 'Bob',
+      IsSubmitted: false,
+    },
+  }
+  expect(serialize(params)).toBe('FirstName=Bob&IsSubmitted=false')
+})
+
+test('should allow true boolean', () => {
+  const params = {
+    filters: {
+      FirstName: 'Bob',
+      IsSubmitted: true,
+    },
+  }
+  expect(serialize(params)).toBe('FirstName=Bob&IsSubmitted=true')
+})