Release v1.55.2 (#1319)

hotfix: handle null and undefined fields

Author: kevinkim-ogp

package-lock.json

@@ -111,5 +111,5 @@
     "tsconfig-paths": "^4.2.0",
     "type-fest": "4.10.3"
   },
-  "version": "1.55.1"
+  "version": "1.55.2"
 }

packages/backend/package.json

@@ -0,0 +1,243 @@
+import { describe, expect, it } from 'vitest'
+import type { SafeParseError } from 'zod'
+
+import schema from '../../auth/schema'
+
+describe('gathersg auth schema', () => {
+  describe('valid cases', () => {
+    it('accepts updatedBy with email and name', () => {
+      const result = schema.safeParse({
+        updatedBy: {
+          email: '[email protected]',
+          name: 'John Doe',
+        },
+      })
+      expect(result.success).toBe(true)
+    })
+
+    it('accepts createdBy with email and name', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          email: '[email protected]',
+          name: 'Jane Doe',
+        },
+      })
+      expect(result.success).toBe(true)
+    })
+
+    it('accepts both updatedBy and createdBy when updatedBy has email', () => {
+      const result = schema.safeParse({
+        updatedBy: {
+          email: '[email protected]',
+          name: 'Updater',
+        },
+        createdBy: {
+          email: '[email protected]',
+          name: 'Creator',
+        },
+      })
+      expect(result.success).toBe(true)
+    })
+
+    it('accepts FormSG createdBy with formsg data', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          name: 'FormSG',
+        },
+        formsg: {
+          formId: 'form-123',
+          submissionId: 'submission-456',
+        },
+      })
+      expect(result.success).toBe(true)
+    })
+
+    it('accepts FormSG createdBy without email when formsg data is present', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          name: 'FormSG',
+        },
+        formsg: {
+          formId: '64abc123def456',
+          submissionId: 'sub-789xyz',
+        },
+      })
+      expect(result.success).toBe(true)
+    })
+  })
+
+  describe('invalid cases - missing email', () => {
+    it('rejects updatedBy without email', () => {
+      const result = schema.safeParse({
+        updatedBy: {
+          name: 'John Doe',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects createdBy without email when not FormSG', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          name: 'Regular User',
+        },
+      })
+      expect(result.success).toBe(false)
+      if (!result.success) {
+        const { issues } = (result as SafeParseError<unknown>).error
+        expect(
+          issues.some((i) => i.message.includes('createdBy.email is required')),
+        ).toBe(true)
+      }
+    })
+
+    it('rejects when both updatedBy and createdBy exist but updatedBy has no email', () => {
+      const result = schema.safeParse({
+        updatedBy: {
+          name: 'Updater',
+        },
+        createdBy: {
+          email: '[email protected]',
+          name: 'Creator',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects empty object (neither updatedBy nor createdBy)', () => {
+      const result = schema.safeParse({})
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects null values', () => {
+      const result = schema.safeParse({
+        updatedBy: null,
+        createdBy: null,
+      })
+      expect(result.success).toBe(false)
+    })
+  })
+
+  describe('FormSG invalid cases', () => {
+    it('rejects FormSG createdBy without formId', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          name: 'FormSG',
+        },
+        formsg: {
+          submissionId: 'submission-456',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects FormSG createdBy without submissionId', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          name: 'FormSG',
+        },
+        formsg: {
+          formId: 'form-123',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects FormSG createdBy with empty formId', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          name: 'FormSG',
+        },
+        formsg: {
+          formId: '',
+          submissionId: 'submission-456',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects FormSG createdBy with empty submissionId', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          name: 'FormSG',
+        },
+        formsg: {
+          formId: 'form-123',
+          submissionId: '',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects FormSG createdBy without formsg object', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          name: 'FormSG',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+  })
+
+  describe('empty string validation', () => {
+    it('rejects updatedBy with empty email', () => {
+      const result = schema.safeParse({
+        updatedBy: {
+          email: '',
+          name: 'John Doe',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects updatedBy with empty name', () => {
+      const result = schema.safeParse({
+        updatedBy: {
+          email: '[email protected]',
+          name: '',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+
+    it('rejects createdBy with empty name', () => {
+      const result = schema.safeParse({
+        createdBy: {
+          email: '[email protected]',
+          name: '',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+  })
+
+  describe('precedence logic', () => {
+    it('prioritizes updatedBy.email when both updatedBy and createdBy exist', () => {
+      // This should pass because updatedBy has email, even though createdBy doesn't
+      const result = schema.safeParse({
+        updatedBy: {
+          email: '[email protected]',
+          name: 'Updater',
+        },
+        createdBy: {
+          name: 'Creator',
+        },
+      })
+      expect(result.success).toBe(true)
+    })
+
+    it('validates updatedBy.email presence when both exist', () => {
+      // This should fail because updatedBy doesn't have email
+      const result = schema.safeParse({
+        updatedBy: {
+          name: 'Updater',
+        },
+        createdBy: {
+          email: '[email protected]',
+          name: 'Creator',
+        },
+      })
+      expect(result.success).toBe(false)
+    })
+  })
+})

packages/backend/src/apps/gathersg/__tests__/auth/schema.test.ts

@@ -12,19 +12,19 @@ const schema = z
         email: z.string().min(1),
         name: z.string().min(1),
       })
-      .optional(),
+      .nullish(),
     createdBy: z
       .object({
         email: z.string().min(1).optional(),
         name: z.string().min(1).optional(),
       })
-      .optional(),
+      .nullish(),
     formsg: z
       .object({
         formId: z.string().min(1),
         submissionId: z.string().min(1),
       })
-      .optional(),
+      .nullish(),
   })
   .refine(
     (data) => {

packages/backend/src/apps/gathersg/auth/schema.ts

@@ -1,6 +1,6 @@
 {
   "name": "frontend",
-  "version": "1.55.1",
+  "version": "1.55.2",
   "type": "module",
   "scripts": {
     "dev": "wait-on tcp:3000 && vite --host --force",

packages/frontend/package.json

@@ -2,5 +2,5 @@
   "name": "@plumber/types",
   "description": "Shared types for plumber",
   "types": "./index.d.ts",
-  "version": "1.55.1"
+  "version": "1.55.2"
 }