add changes based on code review and logging

Author: m0nggh

packages/backend/src/apps/formatter/__tests__/date-time.format.test.ts

@@ -139,26 +139,41 @@ describe('convert date time', () => {
     })
   })
 
-  // check if dd LLL yyyy format is corrected to en-US all the time
-  it('maintains dd LLL yyyy format in en-US', () => {
+  it.each([
+    {
+      inputFormat: 'formsgDateField',
+      inputValue: '01 Sept 2025',
+      toFormat: 'dd LLL yyyy',
+      expectedResult: '01 Sep 2025',
+    },
+    {
+      inputFormat: 'formsgDateField',
+      inputValue: '02 Sep 2025',
+      toFormat: 'dd LLL yyyy',
+      expectedResult: '02 Sep 2025',
+    },
+    {
+      inputFormat: 'dd LLL yyyy hh:mm a',
+      inputValue: '03 Sep 2025 11:50 pm',
+      toFormat: 'dd LLL yyyy',
+      expectedResult: '03 Sep 2025',
+    },
+    {
+      inputFormat: 'dd LLL yyyy hh:mm:ss a',
+      inputValue: '04 Sept 2025 11:45:30 pm',
+      toFormat: 'dd LLL yyyy hh:mm a',
+      expectedResult: '04 Sep 2025 11:45 pm',
+    },
+  ])('converts dd MMM yyyy format from en-SG to en-US', (testParams) => {
+    const { inputFormat, inputValue, toFormat, expectedResult } = testParams
     $.step.parameters = {
-      dateTimeFormat: 'formsgDateField',
-      formatDateTimeToFormat: 'dd LLL yyyy',
+      dateTimeFormat: inputFormat,
+      formatDateTimeToFormat: toFormat,
     }
-    spec.transformData($, '01 Sep 2024')
-    expect(mocks.setActionItem).toBeCalledWith({
-      raw: { result: '01 Sep 2024' },
-    })
-  })
+    spec.transformData($, inputValue)
 
-  it('converts dd LLL yyyy format from en-SG to en-US', () => {
-    $.step.parameters = {
-      dateTimeFormat: 'formsgDateField',
-      formatDateTimeToFormat: 'dd LLL yyyy',
-    }
-    spec.transformData($, '01 Sept 2024')
     expect(mocks.setActionItem).toBeCalledWith({
-      raw: { result: '01 Sep 2024' },
+      raw: { result: expectedResult },
     })
   })
 })

packages/backend/src/apps/formatter/actions/date-time/transforms/convert-date-time/index.ts

@@ -1,5 +1,6 @@
 import type { IGlobalVariable } from '@plumber/types'
 
+import { DateTime } from 'luxon'
 import { ZodError } from 'zod'
 
 import StepError, { GenericSolution } from '@/errors/step'
@@ -35,6 +36,22 @@ function getParams($: IGlobalVariable) /* inferred return type */ {
   }
 }
 
+// helper function to check if format contains dd LLL yyyy, if so, force en-US to maintain consistency with FormSG
+function formatStringToUSLocale(formatString: string, dateTime: DateTime) {
+  switch (formatString) {
+    case 'dd LLL yyyy':
+    case 'dd LLL yyyy hh:mm a':
+    case 'dd LLL yyyy hh:mm:ss a': {
+      const dateTimeString = dateTime.toFormat(formatString, {
+        locale: 'en-SG', // TODO: ???
+      })
+      return dateTimeString
+    }
+    default:
+      return dateTime.toFormat(formatString)
+  }
+}
+
 export const spec = {
   id: 'formatDateTime',
 
@@ -53,10 +70,7 @@ export const spec = {
       // check if format is dd LLL yyyy, if so, force en-US to maintain consistency with FormSG
       $.setActionItem({
         raw: {
-          result:
-            formatString === 'dd LLL yyyy'
-              ? dateTime.toFormat(formatString, { locale: 'en-US' })
-              : dateTime.toFormat(formatString),
+          result: formatStringToUSLocale(formatString, dateTime),
         },
       })
     } catch (error) {

packages/backend/src/services/action.ts

@@ -1,4 +1,8 @@
-import { type IActionRunResult, TestRunStepMetadata } from '@plumber/types'
+import type {
+  IActionRunResult,
+  IJSONValue,
+  TestRunStepMetadata,
+} from '@plumber/types'
 
 import {
   FOR_EACH_ITERATION_DELAY,
@@ -23,6 +27,23 @@ import { enqueueActionJob } from '@/queues/action'
 
 import getForEachMetadata from './helpers/get-for-each-metadata'
 
+// TODO on Oct: remove this once the logging is not needed anymore
+const SEPT_KEYWORD_REGEX = / Sept /
+
+function containsSeptKeyword(obj: IJSONValue): boolean {
+  if (typeof obj === 'string') {
+    return SEPT_KEYWORD_REGEX.test(obj)
+  }
+  if (Array.isArray(obj)) {
+    return obj.some((item) => containsSeptKeyword(item))
+  }
+
+  if (obj !== null && typeof obj === 'object') {
+    return Object.values(obj).some((value) => containsSeptKeyword(value))
+  }
+  return false
+}
+
 type ProcessActionOptions = {
   flowId: string
   executionId: string
@@ -209,6 +230,19 @@ export const processAction = async (options: ProcessActionOptions) => {
       metadata,
     })
 
+  // TODO on Oct: remove this once the logging is not needed anymore
+  if (!testRun && status === 'failure') {
+    if (containsSeptKeyword($.step.parameters ?? {})) {
+      logger.info('Execution contains Sept keyword', {
+        event: 'execution-contains-sept-keyword',
+        stepId,
+        flowId,
+        executionId,
+        executionStepId: executionStep.id,
+      })
+    }
+  }
+
   let nextStep = null
   switch (runResult.nextStep?.command) {
     case 'jump-to-step':

packages/frontend/src/components/NewsDrawer/NewsItem.tsx

@@ -28,7 +28,9 @@ const DATE_FORMAT = 'dd MMM yyyy'
 
 export default function NewsItem(props: NewsItemProps) {
   const { date, tag, title, details, multimedia } = props
-  const formattedDate = DateTime.fromISO(date).toFormat(DATE_FORMAT)
+  const formattedDate = DateTime.fromISO(date).toFormat(DATE_FORMAT, {
+    locale: 'en-US',
+  })
   const displayedMultimedia = useMemo(() => {
     if (!multimedia) {
       return

packages/frontend/src/helpers/dateTime.ts

@@ -15,12 +15,25 @@ export function toPrettyDateString(
     return ''
   }
 
+  // Locale en-US is used to maintain consistency with FormSG
   switch (from) {
     case 'iso':
-      return DateTime.fromISO(date as string).toFormat('dd MMM yyyy h:mm a')
+      return DateTime.fromISO(date as string).toFormat('dd MMM yyyy h:mm a', {
+        locale: 'en-US',
+      })
     case 'ms':
-      return DateTime.fromMillis(date as number).toFormat('dd MMM yyyy h:mm a')
+      return DateTime.fromMillis(date as number).toFormat(
+        'dd MMM yyyy h:mm a',
+        {
+          locale: 'en-US',
+        },
+      )
     default:
-      return DateTime.fromMillis(date as number).toFormat('dd MMM yyyy h:mm a')
+      return DateTime.fromMillis(date as number).toFormat(
+        'dd MMM yyyy h:mm a',
+        {
+          locale: 'en-US',
+        },
+      )
   }
 }