feat: update all versions of fromFlux (#3776)

Author: TCL735

package.json

@@ -158,7 +158,7 @@
     "@docsearch/react": "^3.0.0-alpha.37",
     "@influxdata/clockface": "^3.1.14",
     "@influxdata/flux-lsp-browser": "^0.8.0",
-    "@influxdata/giraffe": "^2.23.1",
+    "@influxdata/giraffe": "^2.24.1",
     "@influxdata/influxdb-templates": "0.9.0",
     "@influxdata/react-custom-scrollbars": "4.3.8",
     "abortcontroller-polyfill": "^1.3.0",

src/alerting/utils/history.test.ts

@@ -33,6 +33,7 @@ describe('history utils', () => {
   beforeEach(jest.clearAllMocks)
 
   const fluxGroupKeyUnion = ['']
+  const resultColumnNames = []
   const length = 100
   const cols = 20
   const table: Table = {
@@ -51,6 +52,7 @@ describe('history utils', () => {
       mocked(fromFlux).mockImplementationOnce(() => ({
         table: {...table, length: 0},
         fluxGroupKeyUnion,
+        resultColumnNames,
       }))
 
       const actual = await processResponse({
@@ -70,6 +72,7 @@ describe('history utils', () => {
       mocked(fromFlux).mockImplementationOnce(() => ({
         table,
         fluxGroupKeyUnion,
+        resultColumnNames,
       }))
       const expected = range(length).map(i =>
         Object.fromEntries([

src/alerting/utils/statusEvents.test.ts

@@ -21,6 +21,7 @@ describe('process statuses response', () => {
   beforeEach(jest.clearAllMocks)
 
   const fluxGroupKeyUnion = ['']
+  const resultColumnNames = []
   const length = 100
   const cols = 20
   const table: Table = {
@@ -38,6 +39,7 @@ describe('process statuses response', () => {
     mocked(fromFlux).mockImplementationOnce(() => ({
       table: {...table, length: 0},
       fluxGroupKeyUnion,
+      resultColumnNames,
     }))
 
     const actual = await processStatusesResponse({
@@ -55,7 +57,11 @@ describe('process statuses response', () => {
   })
 
   it('process single table', async () => {
-    mocked(fromFlux).mockImplementationOnce(() => ({table, fluxGroupKeyUnion}))
+    mocked(fromFlux).mockImplementationOnce(() => ({
+      table,
+      fluxGroupKeyUnion,
+      resultColumnNames,
+    }))
     const expected = range(length).map(i =>
       Object.fromEntries([
         ['table', 0],

src/shared/contexts/csv.worker.ts

@@ -1,12 +1,16 @@
 import {csvParse, csvParseRows} from 'd3-dsv'
 
+const RESULT_COLUMN_INDEX = 1
 interface FromFluxResult {
   error?: Error
   // The single parsed `Table`
   table: Table
 
   // The union of unique group keys from all input Flux tables
   fluxGroupKeyUnion: string[]
+
+  // All possible values of the "result" column
+  resultColumnNames: string[]
 }
 
 type Column =
@@ -87,6 +91,7 @@ const assert = (condition: boolean, errorMessage: string) => {
 const fromFlux = (fluxCSV: string): FromFluxResult => {
   const columns: Columns = {}
   const fluxGroupKeyUnion = new Set<string>()
+  const resultColumnNames = new Set<string>()
   let tableLength = 0
 
   try {
@@ -101,11 +106,29 @@ const fromFlux = (fluxCSV: string): FromFluxResult => {
     let columnDefault: any = ''
 
     for (const chunk of chunks) {
-      tableText = chunk
-        .split('\n')
-        .filter(line => !line.startsWith('#'))
-        .join('\n')
-        .trim()
+      const splittedChunk = chunk.split('\n')
+
+      const tableTexts = []
+      const annotationTexts = []
+
+      splittedChunk.forEach(line => {
+        if (line.startsWith('#')) {
+          annotationTexts.push(line)
+        } else {
+          tableTexts.push(line)
+        }
+        if (line.startsWith('#default')) {
+          const defaults = line.split(',')
+          if (
+            defaults.length >= RESULT_COLUMN_INDEX + 1 &&
+            defaults[RESULT_COLUMN_INDEX].length
+          ) {
+            resultColumnNames.add(defaults[RESULT_COLUMN_INDEX])
+          }
+        }
+      })
+
+      tableText = tableTexts.join('\n').trim()
 
       assert(
         !!tableText,
@@ -114,11 +137,7 @@ const fromFlux = (fluxCSV: string): FromFluxResult => {
 
       tableData = csvParse(tableText)
 
-      annotationText = chunk
-        .split('\n')
-        .filter(line => line.startsWith('#'))
-        .join('\n')
-        .trim()
+      annotationText = annotationTexts.join('\n').trim()
 
       assert(
         !!annotationText,
@@ -182,16 +201,18 @@ const fromFlux = (fluxCSV: string): FromFluxResult => {
     const result = {
       table,
       fluxGroupKeyUnion: Array.from(fluxGroupKeyUnion),
+      resultColumnNames: Array.from(resultColumnNames),
     }
 
     return result
   } catch (error) {
     return {
+      error,
       table: {
         columns: {},
       },
       fluxGroupKeyUnion: [],
-      error,
+      resultColumnNames: [],
     }
   }
 }

src/shared/utils/fromFlux.legacy.ts

@@ -26,5 +26,6 @@ export default function fromFluxLegacy(csv: string): FromFluxResult {
       newTable(parsedFlux.table.length)
     ),
     fluxGroupKeyUnion: parsedFlux.fluxGroupKeyUnion,
+    resultColumnNames: parsedFlux.resultColumnNames,
   }
 }

src/shared/utils/fromFlux.test.ts

@@ -143,6 +143,66 @@ describe('fromFlux', () => {
     expect(fluxGroupKeyUnion).toEqual(['a', 'c', 'd'])
   })
 
+  test('returns all result column names', () => {
+    const CSV = `#group,true,false,false,true
+#datatype,string,string,string,string
+#default,new,,,
+,result,b,c,d
+,,0,0,0
+
+#group,false,false,true,false
+#datatype,string,string,string,string
+#default,old,,,
+,result,b,c,d
+,,0,0,0`
+
+    const flux = fromFlux(CSV)
+    const fluxLegacy = fromFluxLegacy(CSV)
+
+    expect(flux.resultColumnNames).toEqual(['new', 'old'])
+    expect(fluxLegacy.resultColumnNames).toEqual(['new', 'old'])
+  })
+
+  test('handles blank result column names', () => {
+    const CSV = `#group,true,false,false,true
+#datatype,string,string,string,string
+#default,,,,
+,result,b,c,d
+,,0,0,0
+
+#group,false,false,true,false
+#datatype,string,string,string,string
+#default,,,,
+,result,b,c,d
+,,0,0,0`
+
+    const flux = fromFlux(CSV)
+    const fluxLegacy = fromFluxLegacy(CSV)
+
+    expect(flux.resultColumnNames).toEqual([])
+    expect(fluxLegacy.resultColumnNames).toEqual([])
+  })
+
+  test('handles missing result column', () => {
+    const CSV = `#group,true,false,false,true
+#datatype,string,string,string,string
+#default,_result,,,
+,a,b,c,d
+,,0,0,0
+
+#group,false,false,true,false
+#datatype,string,string,string,string
+#default,_result,,,
+,a,b,c,d
+,,0,0,0`
+
+    const flux = fromFlux(CSV)
+    const fluxLegacy = fromFluxLegacy(CSV)
+
+    expect(flux.resultColumnNames).toEqual([])
+    expect(fluxLegacy.resultColumnNames).toEqual([])
+  })
+
   test('parses empty numeric values as null', () => {
     const CSV = `#group,false,false,true,true,false,true,true,true,true,true
 #datatype,string,long,dateTime:RFC3339,dateTime:RFC3339,dateTime:RFC3339,double,string,string,string,string

src/shared/utils/fromFlux.ts

@@ -135,6 +135,7 @@ export interface ParsedFlux {
     length: number
   }
   fluxGroupKeyUnion: string[]
+  resultColumnNames: string[]
 }
 
 export default function fromFlux(csv: string): ParsedFlux {
@@ -347,12 +348,20 @@ export default function fromFlux(csv: string): ParsedFlux {
       }
     })
 
+  const resultColumnNames = new Set<string>()
+  output?.result?.data.forEach(columnName => {
+    if (String(columnName).length > 0) {
+      resultColumnNames.add(String(columnName))
+    }
+  })
+
   return {
     table: {
       columnKeys: Object.keys(output),
       columns: output,
       length: runningTotal,
     },
     fluxGroupKeyUnion: Object.keys(groupKey),
+    resultColumnNames: Array.from(resultColumnNames),
   }
 }

src/timeMachine/selectors/index.ts

@@ -115,11 +115,13 @@ const getVisTableMemoized = memoizeOne(fromFlux)
 
 export const getVisTable = (
   state: AppState
-): {table: Table; fluxGroupKeyUnion: string[]} => {
+): {table: Table; fluxGroupKeyUnion: string[]; resultColumnNames: string[]} => {
   const files = getActiveTimeMachine(state).queryResults.files || []
-  const {table, fluxGroupKeyUnion} = getVisTableMemoized(files.join('\n\n'))
+  const {table, fluxGroupKeyUnion, resultColumnNames} = getVisTableMemoized(
+    files.join('\n\n')
+  )
 
-  return {table, fluxGroupKeyUnion}
+  return {table, fluxGroupKeyUnion, resultColumnNames}
 }
 
 const getNumericColumnsMemoized = memoizeOne(getNumericColumnsUtil)

src/visualization/types/Map/view.test.tsx

@@ -33,6 +33,7 @@ const setup = () => {
     result: {
       table,
       fluxGroupKeyUnion: ['', ''],
+      resultColumnNames: [],
       results: {},
     },
   }

src/visualization/types/Scatter/TimeAutoToggle.test.tsx

@@ -51,6 +51,7 @@ describe('Time Domain Auto Toggle', () => {
       results: {
         table,
         fluxGroupKeyUnion: ['', ''],
+        resultColumnNames: [],
         ...results,
       },
       update: jest.fn(),