Release v1.56.0 (#1328)

- chore: handle FormSG signature field
- chore: remove for each feature flags
- chore: hex encode GatherSG field names with special characters
- feat: collaborators
- fix: collaborators cannot add Excel step

## Pre-deploy checklist
- [x] Run migration

Author: kevinkim-ogp

package-lock.json

@@ -37,7 +37,7 @@
     "@graphql-tools/schema": "10.0.25",
     "@graphql-tools/utils": "10.9.1",
     "@launchdarkly/node-server-sdk": "9.0.4",
-    "@opengovsg/formsg-sdk": "0.13.0",
+    "@opengovsg/formsg-sdk": "0.16.1",
     "@opengovsg/sgid-client": "2.3.0",
     "@plumber/types": "file:../types",
     "@taskforcesh/bullmq-pro": "7.7.1",
@@ -111,5 +111,5 @@
     "tsconfig-paths": "^4.2.0",
     "type-fest": "4.10.3"
   },
-  "version": "1.55.2"
+  "version": "1.56.0"
 }

packages/backend/package.json

@@ -894,4 +894,66 @@ describe('decrypt form response', () => {
       )
     })
   })
+
+  describe('signature field', () => {
+    it('should handle signature field with signature captured', async () => {
+      $.flow.hasFileProcessingActions = false
+      mocks.cryptoDecrypt.mockReturnValueOnce({
+        responses: [
+          {
+            _id: 'signatureField',
+            fieldType: 'signature',
+            question: 'Please sign here',
+            answerArray: [1.1, 1.2, 1.3],
+          },
+        ],
+      })
+
+      await expect(decryptFormResponse($)).resolves.toEqual(
+        SUCCESS_DECRYPT_RESPONSE,
+      )
+      expect($.request.body).toEqual(
+        expect.objectContaining({
+          fields: {
+            signatureField: {
+              fieldType: 'signature',
+              question: 'Please sign here',
+              answer: 'Signature captured',
+              order: 1,
+            },
+          },
+        }),
+      )
+    })
+
+    it('should handle signature field without signature', async () => {
+      $.flow.hasFileProcessingActions = false
+      mocks.cryptoDecrypt.mockReturnValueOnce({
+        responses: [
+          {
+            _id: 'signatureField',
+            fieldType: 'signature',
+            question: 'Please sign here',
+            answerArray: [],
+          },
+        ],
+      })
+
+      await expect(decryptFormResponse($)).resolves.toEqual(
+        SUCCESS_DECRYPT_RESPONSE,
+      )
+      expect($.request.body).toEqual(
+        expect.objectContaining({
+          fields: {
+            signatureField: {
+              fieldType: 'signature',
+              question: 'Please sign here',
+              answer: '',
+              order: 1,
+            },
+          },
+        }),
+      )
+    })
+  })
 })

packages/backend/src/apps/formsg/__tests__/auth/decrypt-form-response.test.ts

@@ -543,6 +543,15 @@ describe('new submission trigger for answer array fields', () => {
             order: 5,
             answerArray: ['51', 'BRAS BASAH ROAD', '', '', '189554'], // Some empty fields
           },
+          signatureField: {
+            question: 'Sign here',
+            fieldType: 'signature',
+            order: 6,
+            answerArray: [
+              'draw',
+              '[[123.45, 123.45, 0.5], [543.21, 543.21, 0.5]]',
+            ],
+          },
         },
       },
     } as unknown as IExecutionStep
@@ -622,5 +631,16 @@ describe('new submission trigger for answer array fields', () => {
         )
       })
     })
+
+    it('Signature type: includes all metadata for signature fields but it is hidden', async () => {
+      const metadata = await trigger.getDataOutMetadata(executionStep)
+      const signatureMetadata = metadata.fields.signatureField
+        .answerArray as IDataOutMetadatum[]
+      expect(signatureMetadata).toHaveLength(2)
+      signatureMetadata.forEach((metadata, index) => {
+        expect(metadata.isHidden).toEqual(true)
+        expect(metadata.label).toEqual(`6.${index + 1}. Sign here`)
+      })
+    })
   })
 })

packages/backend/src/apps/formsg/__tests__/triggers/new-submission.test.ts

@@ -136,7 +136,9 @@ export async function decryptFormResponse(
           )
         } else {
           rest.answerArray = (rest.answerArray as string[]).map((answer) =>
-            answer.replaceAll('\u0000', ''),
+            typeof answer === 'string'
+              ? answer.replaceAll('\u0000', '')
+              : answer,
           )
         }
       }
@@ -165,6 +167,13 @@ export async function decryptFormResponse(
         rest.answerArray = processLocalAddress(rest.answerArray as string[])
       }
 
+      // Add signature status to the response regardless of whether the user has signed or not (optional field)
+      if (rest.fieldType === 'signature') {
+        const isSignaturePresent = (rest.answerArray as string[])?.length > 0
+        rest.answer = isSignaturePresent ? 'Signature captured' : ''
+        delete rest.answerArray // we dont need to store it
+      }
+
       // Note: the order may not be sequential; fields (e.g. NRIC) can be
       // omitted from the output.
       // Note: FormSG uses dot notation for field ids for MyInfo children

packages/backend/src/apps/formsg/auth/decrypt-form-response.ts

@@ -24,7 +24,10 @@ function buildQuestionMetadatum(fieldData: IJSONObject): IDataOutMetadatum {
     question.label = 'Header'
   }
 
-  if (fieldData.fieldType === 'attachment') {
+  if (
+    fieldData.fieldType === 'attachment' ||
+    fieldData.fieldType === 'signature'
+  ) {
     question['isHidden'] = true
   }
 
@@ -69,8 +72,8 @@ function isAnswerArrayValid(fieldData: IJSONObject): boolean {
   if (!fieldData.answerArray) {
     return false
   }
-  // strict check for only table, checkbox and address variables
-  const answerArrayFields = ['table', 'checkbox', 'address']
+  // strict check for only table, checkbox, address and signature variables
+  const answerArrayFields = ['table', 'checkbox', 'address', 'signature']
   return answerArrayFields.includes(fieldData.fieldType as string)
 }
 
@@ -86,6 +89,20 @@ function buildAnswerArrayForAddress(fieldData: IJSONObject): IDataOutMetadata {
   }))
 }
 
+// Hide all the labels for the signature field
+function buildAnswerArrayForSignature(
+  fieldData: IJSONObject,
+): IDataOutMetadata {
+  const { order, question } = fieldData
+  const answerArray = fieldData.answerArray as IJSONArray
+  return answerArray.map((_, index) => ({
+    type: 'text',
+    label: `${order}.${index + 1}. ${question}`,
+    order: order ? `${order}.${index + 1}` : null,
+    isHidden: true,
+  }))
+}
+
 function buildAnswerArrayForCheckbox(
   fieldData: IJSONObject,
 ): IDataOutMetadatum {
@@ -209,6 +226,8 @@ function buildAnswerArrayMetadatum(
       return buildAnswerArrayForTable(fieldData)
     case 'address':
       return buildAnswerArrayForAddress(fieldData)
+    case 'signature':
+      return buildAnswerArrayForSignature(fieldData)
     default:
       logger.warn(`Answer array unknown fieldtype: ${fieldType}`, {
         fieldType,

packages/backend/src/apps/formsg/triggers/new-submission/get-data-out-metadata.ts

@@ -113,8 +113,9 @@ async function getMockData($: IGlobalVariable) {
     const formFields = formDetails.form.form_fields as Array<FormField>
     for (let i = 0; i < formFields.length; i++) {
       if (data.responses[formFields[i]._id]) {
+        const fieldType = data.responses[formFields[i]._id].fieldType
         // forcefully include all checkbox options in the correct order
-        if (data.responses[formFields[i]._id].fieldType === 'checkbox') {
+        if (fieldType === 'checkbox') {
           data.responses[formFields[i]._id].answerArray =
             formFields[i].fieldOptions
           // include the others option if available
@@ -125,34 +126,38 @@ async function getMockData($: IGlobalVariable) {
           }
         }
 
+        if (fieldType === 'signature') {
+          data.responses[formFields[i]._id].answer = 'Signature captured' // mock this to always be present regardless of whether the user has signed or not
+        }
+
         // formsg payload doesnt contain this anyways, so we dont return in mock data
-        if (data.responses[formFields[i]._id].fieldType === 'statement') {
+        if (fieldType === 'statement') {
           delete data.responses[formFields[i]._id]
           continue
         }
 
-        if (data.responses[formFields[i]._id].fieldType === 'address') {
+        if (fieldType === 'address') {
           data.responses[formFields[i]._id].answerArray =
             generateMockAddressData()
         }
 
-        if (data.responses[formFields[i]._id].fieldType === 'attachment') {
+        if (fieldType === 'attachment') {
           data.responses[formFields[i]._id].answer = MOCK_ATTACHMENT_FILE_PATH
         }
 
-        if (data.responses[formFields[i]._id].fieldType === 'nric') {
+        if (fieldType === 'nric') {
           data.responses[formFields[i]._id].answer = filterNric(
             $,
             data.responses[formFields[i]._id].answer,
           )
         }
 
-        if (data.responses[formFields[i]._id].fieldType === 'email') {
+        if (fieldType === 'email') {
           data.responses[formFields[i]._id].answer = $.user.email
         }
 
         // add a stringified version of the table data to the mock data
-        if (data.responses[formFields[i]._id].fieldType === 'table') {
+        if (fieldType === 'table') {
           const answerArray = data.responses[formFields[i]._id]
             .answerArray as string[][]
           const question = data.responses[formFields[i]._id].question

packages/backend/src/apps/formsg/triggers/new-submission/get-mock-data.ts

@@ -0,0 +1,43 @@
+import { describe, expect, it } from 'vitest'
+
+import { processFields } from '../../auth/decrypt-response'
+import { HEX_ENCODED_FIELD_PREFIX } from '../../common/constants'
+
+describe('processFields', () => {
+  it('should process fields with whitespace, -, _', () => {
+    const fields = {
+      name: 'John Doe',
+      email: '[email protected]',
+      'field-email': '[email protected]',
+      field_email: '[email protected]',
+      'field email': '[email protected]',
+    }
+    const processedFields = processFields(fields)
+    expect(processedFields).toEqual(fields)
+  })
+
+  it.each([
+    'field / Email',
+    'field.email',
+    'field&email',
+    'field%email',
+    'field$email',
+    'field@email',
+    'field^email',
+    'field!email',
+    'field(email)',
+  ])('should hex encode fields with special characters', (field: string) => {
+    const fields = {
+      name: 'John Doe',
+      [field]: '[email protected]',
+    }
+    const hexEncodedField = `${HEX_ENCODED_FIELD_PREFIX}${Buffer.from(
+      field,
+    ).toString('hex')}`
+    const processedFields = processFields(fields)
+    expect(processedFields).toEqual({
+      name: 'John Doe',
+      [hexEncodedField]: '[email protected]',
+    })
+  })
+})