add flexible date comparison for conditions

Author: m0nggh

packages/backend/src/apps/toolbox/__tests__/common/condition-is-true.test.ts

@@ -94,6 +94,41 @@ describe('Condition is true', () => {
     expect(result).toEqual(expectedResult)
   })
 
+  /**
+   * Typical datetime formats:
+   * yyyy-MM-dd HH:mm
+   * dd MMM yyyy
+   * dd/MM/yyyy HH:mm:ss
+   * ISO format
+   */
+  it.each([
+    { text: '2024-11-06 12:00', expectedResult: true },
+    { text: '03/11/2024 12:00:30', expectedResult: false },
+  ])('supports before', ({ text, expectedResult }) => {
+    const result = conditionIsTrue({
+      field: '04 Nov 2024',
+      is: 'is',
+      condition: 'before',
+      text,
+    })
+
+    expect(result).toEqual(expectedResult)
+  })
+
+  it.each([
+    { text: '2024-11-06T12:00:00.500+08:00', expectedResult: false },
+    { text: '03 Nov 2024 23:59', expectedResult: true },
+  ])('supports after', ({ text, expectedResult }) => {
+    const result = conditionIsTrue({
+      field: '04 Nov 2024',
+      is: 'is',
+      condition: 'after',
+      text,
+    })
+
+    expect(result).toEqual(expectedResult)
+  })
+
   it.each([
     { field: 'hello', text: 9.9, condition: 'equals', expectedResult: true },
     { field: 10, text: 10, condition: 'gte', expectedResult: false },
@@ -135,6 +170,25 @@ describe('Condition is true', () => {
     },
   )
 
+  it.each([
+    { field: 10, condition: 'gte', text: 'abc' },
+    { field: 'abc', condition: 'lt', text: 10 },
+    { field: '04 Nov 2024', condition: 'before', text: 'abc' },
+    { field: 'abc', condition: 'before', text: '04 Nov 2024' },
+  ])(
+    'throws an error for invalid field or value for comparison',
+    ({ field, condition, text }) => {
+      expect(() =>
+        conditionIsTrue({
+          field,
+          is: 'is',
+          condition,
+          text,
+        }),
+      ).toThrowError()
+    },
+  )
+
   it('throws an error for unsupported conditions', () => {
     expect(() =>
       conditionIsTrue({

packages/backend/src/apps/toolbox/common/condition-is-true.ts

@@ -6,9 +6,14 @@ function compareNumbers(
   value: IJSONValue,
 ): boolean {
   // WARNING: can only compare safely up till Number.MAX_SAFE_INTEGER but BigInt cannot compare floats...
-  if (isNaN(Number(field)) || isNaN(Number(value))) {
-    throw new Error('Non-number used in field or value for comparison')
+  if (isNaN(Number(field))) {
+    throw new Error('Non-number used in field for comparison')
   }
+
+  if (isNaN(Number(value))) {
+    throw new Error('Non-number used in value for comparison')
+  }
+
   switch (condition) {
     case 'gte':
       return Number(field) >= Number(value)
@@ -21,6 +26,29 @@ function compareNumbers(
   }
 }
 
+function compareDates(
+  field: IJSONValue,
+  condition: 'before' | 'after',
+  value: IJSONValue,
+) {
+  const fieldTimestamp = new Date(field as string).getTime()
+  if (isNaN(fieldTimestamp)) {
+    throw new Error('Invalid date used in field for comparison')
+  }
+
+  const valueTimestamp = new Date(value as string).getTime()
+  if (isNaN(valueTimestamp)) {
+    throw new Error('Invalid date used in value for comparison')
+  }
+
+  switch (condition) {
+    case 'before':
+      return fieldTimestamp < valueTimestamp
+    case 'after':
+      return fieldTimestamp > valueTimestamp
+  }
+}
+
 export default function conditionIsTrue(conditionArgs: IJSONObject): boolean {
   // `value` is named `text` for legacy reasons.
   const { field, is, condition, text: value } = conditionArgs
@@ -30,6 +58,10 @@ export default function conditionIsTrue(conditionArgs: IJSONObject): boolean {
     case 'equals':
       result = field === value
       break
+    case 'before':
+    case 'after':
+      result = compareDates(field, condition, value)
+      break
     case 'gte':
     case 'gt':
     case 'lte':

packages/backend/src/apps/toolbox/common/get-condition-args.ts

@@ -39,12 +39,39 @@ export default function getConditionArgs({
       variables: false,
       showOptionValue: false,
       options: [
-        { label: 'Equals to', value: 'equals' },
-        { label: 'Greater than ', value: 'gt' },
-        { label: 'Greater than or equals to', value: 'gte' },
-        { label: 'Less than', value: 'lt' },
-        { label: 'Less than or equals to', value: 'lte' },
-        { label: 'Contains', value: 'contains' },
+        {
+          label: 'Equals to',
+          value: 'equals',
+          description: 'Used for text values',
+        },
+        {
+          label: 'Contains',
+          value: 'contains',
+          description: 'Used for text values',
+        },
+
+        { label: 'Greater than', value: 'gt', description: 'Used for numbers' },
+        {
+          label: 'Greater than or equals to',
+          value: 'gte',
+          description: 'Used for numbers',
+        },
+        { label: 'Less than', value: 'lt', description: 'Used for numbers' },
+        {
+          label: 'Less than or equals to',
+          value: 'lte',
+          description: 'Used for numbers',
+        },
+        {
+          label: 'Before',
+          value: 'before',
+          description: 'Used for dates',
+        },
+        {
+          label: 'After',
+          value: 'after',
+          description: 'Used for dates',
+        },
         { label: 'Empty', value: 'empty' },
       ],
     },