update timezone format from en-sg to en-us

Author: m0nggh

packages/backend/src/apps/delay/__tests__/delay-until.test.ts

@@ -11,6 +11,8 @@ import delayApp from '../index'
 const PAST_DATE = '2023-11-08'
 const VALID_DATE = '2026-12-31' // long long time later
 const VALID_TIME = '12:00'
+const VALID_DD_MMM_YYYY_SG = '01 Sept 2026' // test Sept format to convert to en-US
+const VALID_DD_MMM_YYYY_US = '01 Sep 2026'
 const DEFAULT_TIME = '00:00'
 const INVALID_TIME = '25:00'
 const INVALID_DATE = '2025-12-32'
@@ -89,6 +91,32 @@ describe('Delay until action', () => {
     })
   })
 
+  it('returns void and maintains Sept format in en-US', async () => {
+    $.step.parameters = {
+      delayUntil: VALID_DD_MMM_YYYY_US,
+      delayUntilTime: VALID_TIME,
+    }
+
+    const result = await delayUntilAction.run($)
+    expect(result).toBeFalsy()
+    expect(mocks.setActionItem).toBeCalledWith({
+      raw: { delayUntil: VALID_DD_MMM_YYYY_US, delayUntilTime: VALID_TIME },
+    })
+  })
+
+  it('returns void and converts Sept to en-US from en-SG', async () => {
+    $.step.parameters = {
+      delayUntil: VALID_DD_MMM_YYYY_SG,
+      delayUntilTime: VALID_TIME,
+    }
+
+    const result = await delayUntilAction.run($)
+    expect(result).toBeFalsy()
+    expect(mocks.setActionItem).toBeCalledWith({
+      raw: { delayUntil: VALID_DD_MMM_YYYY_US, delayUntilTime: VALID_TIME },
+    })
+  })
+
   it('throws step error if delay until has a past timestamp', async () => {
     $.step.parameters = {
       delayUntil: PAST_DATE,

packages/backend/src/apps/delay/actions/delay-until/index.ts

@@ -61,8 +61,25 @@ const action: IRawAction = {
       delayUntilTimeString,
     )
 
+    // check if delayUntilString is of dd MMM yyyy format, if so, force en-US to maintain consistency with FormSG
+    let delayUntilStringUSFormatted = delayUntilString
+    // Try parsing with en-SG first (for "Sept"), then en-US (for "Sep"), this is for the test case to work because it is not aware of the en-US locale
+    let dateTime = DateTime.fromFormat(delayUntilString, 'dd MMM yyyy', {
+      locale: 'en-SG',
+    })
+    if (!dateTime.isValid) {
+      dateTime = DateTime.fromFormat(delayUntilString, 'dd MMM yyyy', {
+        locale: 'en-US',
+      })
+    }
+    if (dateTime.isValid) {
+      delayUntilStringUSFormatted = dateTime.toFormat('dd MMM yyyy', {
+        locale: 'en-US',
+      })
+    }
+
     let dataItem = {
-      delayUntil: delayUntilString,
+      delayUntil: delayUntilStringUSFormatted,
       delayUntilTime: delayUntilTimeString,
     }
 
@@ -85,7 +102,7 @@ const action: IRawAction = {
       if (isRetry) {
         const dateTimeNow = DateTime.now()
         dataItem = {
-          delayUntil: dateTimeNow.toFormat('dd MMM yyyy'),
+          delayUntil: dateTimeNow.toFormat('dd MMM yyyy', { locale: 'en-US' }), // Force en-US to maintain consistency with FormSG
           delayUntilTime: dateTimeNow.toFormat('HH:mm'),
         }
       } else {

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

@@ -138,4 +138,27 @@ describe('convert date time', () => {
       raw: { result: expectedResult },
     })
   })
+
+  // check if dd LLL yyyy format is corrected to en-US all the time
+  it('maintains dd LLL yyyy format in en-US', () => {
+    $.step.parameters = {
+      dateTimeFormat: 'formsgDateField',
+      formatDateTimeToFormat: 'dd LLL yyyy',
+    }
+    spec.transformData($, '01 Sep 2024')
+    expect(mocks.setActionItem).toBeCalledWith({
+      raw: { result: '01 Sep 2024' },
+    })
+  })
+
+  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' },
+    })
+  })
 })

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

@@ -50,9 +50,13 @@ export const spec = {
       const { dateTimeFormat, formatString } = getParams($)
       const dateTime = parseDateTime(dateTimeFormat, valueToTransform)
 
+      // check if format is dd LLL yyyy, if so, force en-US to maintain consistency with FormSG
       $.setActionItem({
         raw: {
-          result: dateTime.toFormat(formatString),
+          result:
+            formatString === 'dd LLL yyyy'
+              ? dateTime.toFormat(formatString, { locale: 'en-US' })
+              : dateTime.toFormat(formatString),
         },
       })
     } catch (error) {

packages/backend/src/apps/scheduler/__tests__/common/get-date-time-object.test.ts

@@ -19,4 +19,11 @@ describe('Test get date time object format', () => {
       )
     })
   })
+
+  it('dd MMM yyyy format should be corrected to en-US', () => {
+    const dateTime = DateTime.local(2025, 9, 1)
+    expect(getDateTimeObjectRepresentation(dateTime).pretty_date).toEqual(
+      '01 Sep 2025',
+    )
+  })
 })

packages/backend/src/apps/scheduler/common/get-date-time-object.ts

@@ -8,7 +8,9 @@ export default function getDateTimeObjectRepresentation(dateTime: DateTime) {
   return {
     ...defaults,
     ISO_date_time: dateTime.toISO(),
-    pretty_date: dateTime.toFormat('dd MMM yyyy'),
+    pretty_date: dateTime.toFormat('dd MMM yyyy', {
+      locale: 'en-US', // Force en-US to maintain consistency with FormSG
+    }),
     pretty_time: dateTime.toLocaleString(DateTime.TIME_WITH_SECONDS),
     pretty_day_of_week: dateTime.toFormat('cccc'),
     day_of_week: dateTime.weekday,