feat: add cron support (#3269)

Author: drdelambre

src/flows/pipes/Schedule/view.tsx

@@ -26,6 +26,116 @@ import {isFlagEnabled} from 'src/shared/utils/featureFlag'
 
 import './style.scss'
 
+const validCron = (text: string): boolean => {
+  const isNumber = (str: string, min: number, max: number) => {
+    if (str.search(/[^\d-,\/*]/) !== -1) {
+      return false
+    }
+
+    return str.split(',').every(item => {
+      if (item.trim().endsWith('/')) {
+        return false
+      }
+      const splits = item.split('/')
+
+      if (splits.length > 2) {
+        return false
+      }
+
+      const [left, right] = splits
+      const sides = left.split('-')
+
+      if (
+        right !== undefined &&
+        (!/^\d+$/.test(right) || parseInt(right) <= 0)
+      ) {
+        return false
+      }
+
+      if (sides.length > 2) {
+        return false
+      }
+
+      if (sides.length === 1) {
+        return (
+          sides[0] === '*' ||
+          (/^\d+$/.test(sides[0]) &&
+            min <= parseInt(sides[0]) &&
+            parseInt(sides[0]) <= max)
+        )
+      }
+
+      if (!/^\d+$/.test(sides[0]) || !/^\d+$/.test(sides[1])) {
+        return false
+      }
+
+      const small = parseInt(sides[0])
+      const big = parseInt(sides[1])
+
+      return (
+        !isNaN(small) &&
+        !isNaN(big) &&
+        small <= big &&
+        min <= small &&
+        small <= max &&
+        min <= big &&
+        big <= max
+      )
+    })
+  }
+
+  const mapMonth = (str: string): string =>
+    str.toLowerCase().replace(
+      /[a-z]{3}/g,
+      _str =>
+        ({
+          jan: '1',
+          feb: '2',
+          mar: '3',
+          apr: '4',
+          may: '5',
+          jun: '6',
+          jul: '7',
+          aug: '8',
+          sep: '9',
+          oct: '10',
+          nov: '11',
+          dec: '12',
+        }[_str] || _str)
+    )
+  const mapDay = (str: string): string =>
+    str.toLowerCase().replace(
+      /[a-z]{3}/g,
+      _str =>
+        ({
+          sun: '0',
+          mon: '1',
+          tue: '2',
+          wed: '3',
+          thu: '4',
+          fri: '5',
+          sat: '6',
+        }[_str] || _str)
+    )
+  const split = text.trim().split(/\s+/)
+  if (split.length < 5 || split.length > 6) {
+    return false
+  }
+
+  if (split.length === 5) {
+    split.unshift('*')
+  }
+
+  return [
+    isNumber(split[0], 0, 59),
+    isNumber(split[1], 0, 59),
+    isNumber(split[2], 0, 23),
+    isNumber(split[3], 1, 31),
+    isNumber(mapMonth(split[4]), 1, 12),
+    isNumber(mapDay(split[5]), 0, 7),
+  ].reduce((acc, curr) => acc && curr, true)
+}
+
 const Schedule: FC<PipeProp> = ({Context}) => {
   const {id, data, update} = useContext(PipeContext)
   const {simplify, getPanelQueries} = useContext(FlowQueryContext)
@@ -37,7 +147,8 @@ const Schedule: FC<PipeProp> = ({Context}) => {
     intervalError = 'Required'
   } else if (
     data.interval !==
-    data.interval.match(/(?:(\d+(y|mo|s|m|w|h){1}))/g)?.join('')
+      data.interval.match(/(?:(\d+(y|mo|s|m|w|h){1}))/g)?.join('') &&
+    !validCron(data.interval)
   ) {
     intervalError = 'Invalid Time'
   }
@@ -98,7 +209,11 @@ const Schedule: FC<PipeProp> = ({Context}) => {
     }
 
     if (data.interval && !intervalError) {
-      params.every = data.interval
+      if (validCron(data.interval)) {
+        params.cron = `"${data.interval}"`
+      } else {
+        params.every = data.interval
+      }
     }
 
     if (data.offset && !offsetError) {
@@ -221,6 +336,23 @@ const Schedule: FC<PipeProp> = ({Context}) => {
         <FlexBox.Child grow={1} shrink={1} style={{alignSelf: 'start'}}>
           <Form.Element
             label="Every"
+            helpText={
+              ((
+                <>
+                  Supports{' '}
+                  <a
+                    href="https://docs.influxdata.com/flux/v0.x/data-types/basic/duration/#duration-syntax"
+                    target="_blank"
+                  >
+                    flux durations
+                  </a>{' '}
+                  and{' '}
+                  <a href="https://crontab.guru" target="_blank">
+                    cron intervals
+                  </a>
+                </>
+              ) as unknown) as string
+            }
             required={true}
             errorMessage={intervalError}
           >
@@ -241,6 +373,19 @@ const Schedule: FC<PipeProp> = ({Context}) => {
         <FlexBox.Child grow={1} shrink={1} style={{alignSelf: 'start'}}>
           <Form.Element
             label="Offset"
+            helpText={
+              ((
+                <>
+                  Supports{' '}
+                  <a
+                    href="https://docs.influxdata.com/flux/v0.x/data-types/basic/duration/#duration-syntax"
+                    target="_blank"
+                  >
+                    flux durations
+                  </a>
+                </>
+              ) as unknown) as string
+            }
             required={false}
             errorMessage={offsetError}
           >

src/flows/templates/types/task.ts

@@ -15,19 +15,15 @@ export default register =>
             refresh: AUTOREFRESH_DEFAULT,
             pipes: [
               {
-                activeQuery: 0,
-                queries: [
+                buckets: [],
+                tags: [
                   {
-                    text: '',
-                    editMode: 'advanced',
-                    builderConfig: {
-                      buckets: [],
-                      tags: [],
-                      functions: [],
-                    },
+                    key: '_measurement',
+                    values: [],
+                    aggregateFunctionType: 'filter',
                   },
                 ],
-                type: 'rawFluxEditor',
+                type: 'queryBuilder',
                 title: 'Query to Run',
                 visible: true,
               },
@@ -38,7 +34,7 @@ export default register =>
               },
               {
                 type: 'schedule',
-                title: 'Schedule',
+                title: 'Schedule as a Task',
                 visible: true,
               },
             ],
@@ -104,10 +100,17 @@ export default register =>
                 },
                 {
                   type: 'schedule',
-                  title: 'Schedule',
+                  title: 'Schedule as a Task',
                   visible: true,
-                  interval: taskParams.every,
+                  interval:
+                    taskParams.every ||
+                    taskParams.cron.replace(/(^")|("$)/g, ''),
                   offset: taskParams.offset,
+                  task: {
+                    id,
+                    name: resp.name,
+                    flux: resp.flux,
+                  },
                 },
               ],
             },