fix: use toPlumberFormat

pregnantboy · pregnantboy · commit e77d2a85d939 · 2025-09-02T19:26:01.000+08:00
diff --git a/packages/backend/src/apps/delay/__tests__/delay-until.test.ts b/packages/backend/src/apps/delay/__tests__/delay-until.test.ts
@@ -1,3 +1,5 @@
+import '@/types/luxon-extensions'
+
 import { type IGlobalVariable } from '@plumber/types'
 
 import { DateTime } from 'luxon'
@@ -180,8 +182,8 @@ describe('Delay until action', () => {
       expect(result).toBeFalsy()
       expect(mocks.setActionItem).toBeCalledWith({
         raw: {
-          delayUntil: DateTime.now().toFormat('dd MMM yyyy'),
-          delayUntilTime: DateTime.now().toFormat('HH:mm'),
+          delayUntil: DateTime.now().toPlumberFormat('dd MMM yyyy'),
+          delayUntilTime: DateTime.now().toPlumberFormat('HH:mm'),
         },
       })
     })
diff --git a/packages/backend/src/apps/delay/actions/delay-until/index.ts b/packages/backend/src/apps/delay/actions/delay-until/index.ts
@@ -33,7 +33,7 @@ const action: IRawAction = {
       key: 'delayUntil',
       type: 'string' as const,
       required: true,
-      description: 'Delay until the date. E.g. 25 Aug 2023',
+      description: 'Delay until the date. E.g. 05 Aug 2026',
       variables: true,
     },
     {
@@ -62,7 +62,7 @@ const action: IRawAction = {
     )
 
     // check if delayUntilString is of dd MMM yyyy format, if so, force en-US to maintain consistency with FormSG
-    let delayUntilStringUSFormatted = delayUntilString
+    let delayUntilFormatted = 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',
@@ -73,13 +73,11 @@ const action: IRawAction = {
       })
     }
     if (dateTime.isValid) {
-      delayUntilStringUSFormatted = dateTime.toFormat('dd MMM yyyy', {
-        locale: 'en-US',
-      })
+      delayUntilFormatted = dateTime.toPlumberFormat('dd MMM yyyy')
     }
 
     let dataItem = {
-      delayUntil: delayUntilStringUSFormatted,
+      delayUntil: delayUntilFormatted,
       delayUntilTime: delayUntilTimeString,
     }
 
@@ -102,8 +100,8 @@ const action: IRawAction = {
       if (isRetry) {
         const dateTimeNow = DateTime.now()
         dataItem = {
-          delayUntil: dateTimeNow.toFormat('dd MMM yyyy', { locale: 'en-US' }), // Force en-US to maintain consistency with FormSG
-          delayUntilTime: dateTimeNow.toFormat('HH:mm'),
+          delayUntil: dateTimeNow.toPlumberFormat('dd MMM yyyy'),
+          delayUntilTime: dateTimeNow.toPlumberFormat('HH:mm'),
         }
       } else {
         throw new StepError(
diff --git a/packages/backend/src/apps/formatter/__tests__/date-time.add-subtract.test.ts b/packages/backend/src/apps/formatter/__tests__/date-time.add-subtract.test.ts
@@ -1,3 +1,5 @@
+import '@/types/luxon-extensions'
+
 import { IGlobalVariable } from '@plumber/types'
 
 import { Settings as LuxonSettings } from 'luxon'
diff --git a/packages/backend/src/apps/formatter/__tests__/date-time.common.test.ts b/packages/backend/src/apps/formatter/__tests__/date-time.common.test.ts
@@ -1,3 +1,5 @@
+import '@/types/luxon-extensions'
+
 import { DateTime, Settings as LuxonSettings } from 'luxon'
 import { describe, expect, it } from 'vitest'
 
diff --git a/packages/backend/src/apps/formatter/__tests__/date-time.format.test.ts b/packages/backend/src/apps/formatter/__tests__/date-time.format.test.ts
@@ -1,3 +1,5 @@
+import '@/types/luxon-extensions'
+
 import { IGlobalVariable } from '@plumber/types'
 
 import { Settings as LuxonSettings } from 'luxon'
diff --git a/packages/backend/src/apps/formatter/actions/date-time/common/date-time-format.ts b/packages/backend/src/apps/formatter/actions/date-time/common/date-time-format.ts
@@ -58,7 +58,8 @@ const formatConverters = Object.assign({
       // en-US parsing failed, fall back to en-SG.
       return DateTime.fromFormat(input, 'dd MMM yyyy')
     },
-    stringify: (dateTime: DateTime): string => dateTime.toFormat('dd MMM yyyy'),
+    stringify: (dateTime: DateTime): string =>
+      dateTime.toPlumberFormat('dd MMM yyyy'),
   },
   ...Object.fromEntries(
     commonDateFormats
@@ -67,9 +68,19 @@ const formatConverters = Object.assign({
         format,
         {
           description: format,
-          parse: (input: string): DateTime =>
-            DateTime.fromFormat(input, format),
-          stringify: (dateTime: DateTime): string => dateTime.toFormat(format),
+          parse: (input: string): DateTime => {
+            const result = DateTime.fromFormat(input, format, {
+              locale: 'en-US',
+            })
+            if (result.isValid) {
+              return result
+            }
+            return DateTime.fromFormat(input, format, {
+              locale: 'en-SG',
+            })
+          },
+          stringify: (dateTime: DateTime): string =>
+            dateTime.toPlumberFormat(format),
         },
       ]),
   ),
@@ -123,6 +134,12 @@ export function parseDateTime(
 ): DateTime {
   const result = formatConverters[dateTimeFormat].parse(valueToTransform)
 
+  if (dateTimeFormat === 'dd LLL yyyy' && !result.isValid) {
+    result = formatConverters[dateTimeFormat].parse(valueToTransform, {
+      locale: 'en-US',
+    })
+  }
+
   if (!result.isValid) {
     throw new Error(
       `${valueToTransform}' is not a valid ${formatConverters[dateTimeFormat].description}`,
diff --git a/packages/backend/src/apps/formatter/actions/date-time/transforms/convert-date-time/index.ts b/packages/backend/src/apps/formatter/actions/date-time/transforms/convert-date-time/index.ts
@@ -1,6 +1,5 @@
 import type { IGlobalVariable } from '@plumber/types'
 
-import { DateTime } from 'luxon'
 import { ZodError } from 'zod'
 
 import StepError, { GenericSolution } from '@/errors/step'
@@ -36,22 +35,6 @@ 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',
 
@@ -67,13 +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: formatStringToUSLocale(formatString, dateTime),
+          result: dateTime.toPlumberFormat(formatString),
         },
       })
     } catch (error) {
+      console.log('error', error)
       if (error instanceof StepError) {
         throw error
       }
diff --git a/packages/backend/src/apps/paysg/actions/create-payment/schema.ts b/packages/backend/src/apps/paysg/actions/create-payment/schema.ts
@@ -172,7 +172,7 @@ export const requestSchema = z
     description: data.description,
     amount_in_cents: data.paymentAmountCents,
     metadata: data.metadata ?? {}, // PaySG requires at least an empty metadata object.
-    due_date: data.dueDate?.toFormat('dd-MMM-yyyy')?.toUpperCase(),
+    due_date: data.dueDate?.toPlumberFormat('dd-MMM-yyyy')?.toUpperCase(),
     return_url: data.returnUrl,
   }))
 
diff --git a/packages/backend/src/apps/scheduler/__tests__/common/get-date-time-object.test.ts b/packages/backend/src/apps/scheduler/__tests__/common/get-date-time-object.test.ts
@@ -1,3 +1,5 @@
+import '@/types/luxon-extensions'
+
 import { DateTime } from 'luxon'
 import { describe, expect, it } from 'vitest'
 
diff --git a/packages/backend/src/apps/scheduler/common/get-date-time-object.ts b/packages/backend/src/apps/scheduler/common/get-date-time-object.ts
@@ -8,11 +8,9 @@ export default function getDateTimeObjectRepresentation(dateTime: DateTime) {
   return {
     ...defaults,
     ISO_date_time: dateTime.toISO(),
-    pretty_date: dateTime.toFormat('dd MMM yyyy', {
-      locale: 'en-US', // Force en-US to maintain consistency with FormSG
-    }),
+    pretty_date: dateTime.toPlumberFormat('dd MMM yyyy'),
     pretty_time: dateTime.toLocaleString(DateTime.TIME_WITH_SECONDS),
-    pretty_day_of_week: dateTime.toFormat('cccc'),
+    pretty_day_of_week: dateTime.toPlumberFormat('cccc'),
     day_of_week: dateTime.weekday,
   } as IJSONObject
 }
diff --git a/packages/backend/src/config/app.ts b/packages/backend/src/config/app.ts
@@ -1,4 +1,5 @@
 import 'dotenv/config'
+import '@/types/luxon-extensions'
 
 import { Settings as LuxonSettings } from 'luxon'
 import { URL } from 'node:url'
diff --git a/packages/backend/src/helpers/generate-error-email.ts b/packages/backend/src/helpers/generate-error-email.ts
@@ -18,7 +18,7 @@ export function createBodyErrorMessage(
   flowName: string,
   pipeId: string,
 ): string {
-  const currDateTime = DateTime.now().toFormat('MMM dd yyyy, hh:mm a')
+  const currDateTime = DateTime.now().toPlumberFormat('MMM dd yyyy, hh:mm a')
   const searchParams = new URLSearchParams()
   searchParams.set('status', 'failure')
 
diff --git a/packages/backend/src/services/action.ts b/packages/backend/src/services/action.ts
@@ -28,19 +28,16 @@ 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 /
+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 (typeof obj === 'object' && obj !== null) {
+    return SEPT_KEYWORD_REGEX.test(JSON.stringify(obj))
   }
 
-  if (obj !== null && typeof obj === 'object') {
-    return Object.values(obj).some((value) => containsSeptKeyword(value))
-  }
   return false
 }
 
@@ -231,16 +228,14 @@ export const processAction = async (options: ProcessActionOptions) => {
     })
 
   // 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,
-      })
-    }
+  if (!testRun && containsSeptKeyword($.step.parameters ?? {})) {
+    logger.info('Execution contains Sept keyword', {
+      event: 'execution-contains-sept-keyword',
+      stepId,
+      flowId,
+      executionId,
+      executionStepId: executionStep.id,
+    })
   }
 
   let nextStep = null
diff --git a/packages/backend/src/types/luxon-extensions.ts b/packages/backend/src/types/luxon-extensions.ts
@@ -0,0 +1,17 @@
+import { DateTime, LocaleOptions } from 'luxon'
+
+declare module 'luxon' {
+  interface DateTime {
+    toPlumberFormat(fmt: string, opts?: LocaleOptions): string
+  }
+}
+
+DateTime.prototype.toPlumberFormat = function (
+  fmt: string,
+  opts?: LocaleOptions,
+): string {
+  return this.toFormat(fmt, {
+    locale: 'en-SG',
+    ...opts,
+  }).replace(/Sept(?!e)/, 'Sep')
+}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import '@/types/luxon-extensions'`
	`2`	`+`
`1`	`3`	`import { IGlobalVariable } from '@plumber/types'`
`2`	`4`
`3`	`5`	`import { Settings as LuxonSettings } from 'luxon'`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import '@/types/luxon-extensions'`
	`2`	`+`
`1`	`3`	`import { DateTime, Settings as LuxonSettings } from 'luxon'`
`2`	`4`	`import { describe, expect, it } from 'vitest'`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+import '@/types/luxon-extensions'`
	`2`	`+`
`1`	`3`	`import { DateTime } from 'luxon'`
`2`	`4`	`import { describe, expect, it } from 'vitest'`
`3`	`5`