Improve Plot Wizard Error Handling (#4770)

Author: julieg18

extension/src/fileSystem/index.test.ts

@@ -182,7 +182,7 @@ describe('loadDataFiles', () => {
     for (const file of dataFiles) {
       const resultWithErr = await loadDataFiles([file])
 
-      expect(resultWithErr).toStrictEqual(undefined)
+      expect(resultWithErr).toStrictEqual([{ data: undefined, file }])
     }
   })
 
@@ -201,7 +201,23 @@ describe('loadDataFiles', () => {
       .mockReturnValueOnce(mockJsonContent)
 
     const resultWithErr = await loadDataFiles(dataFiles)
-    expect(resultWithErr).toStrictEqual(undefined)
+    expect(resultWithErr).toStrictEqual([
+      {
+        data: [
+          { acc: 0.69, epoch: 10 },
+          { acc: 0.345, epoch: 11 }
+        ],
+        file: 'values.csv'
+      },
+      { data: undefined, file: 'file.tsv' },
+      {
+        data: [
+          { acc: 0.69, epoch: 10 },
+          { acc: 0.345, epoch: 11 }
+        ],
+        file: 'file.json'
+      }
+    ])
   })
 })
 
@@ -608,8 +624,8 @@ describe('addPlotToDvcYamlFile', () => {
 
     addPlotToDvcYamlFile('/', {
       template: 'simple',
-      x: { file: '/data.json', key: 'epochs' },
-      y: { file: '/data.json', key: 'accuracy' }
+      x: { file: 'data.json', key: 'epochs' },
+      y: { file: 'data.json', key: 'accuracy' }
     })
 
     expect(mockedWriteFileSync).toHaveBeenCalledWith(
@@ -636,8 +652,8 @@ describe('addPlotToDvcYamlFile', () => {
 
     addPlotToDvcYamlFile('/', {
       template: 'simple',
-      x: { file: '/data.json', key: 'epochs' },
-      y: { file: '/acc.json', key: 'accuracy' }
+      x: { file: 'data.json', key: 'epochs' },
+      y: { file: 'acc.json', key: 'accuracy' }
     })
 
     expect(mockedWriteFileSync).toHaveBeenCalledWith(
@@ -654,8 +670,8 @@ describe('addPlotToDvcYamlFile', () => {
 
     addPlotToDvcYamlFile('/', {
       template: 'simple',
-      x: { file: '/data.json', key: 'epochs' },
-      y: { file: '/data.json', key: 'accuracy' }
+      x: { file: 'data.json', key: 'epochs' },
+      y: { file: 'data.json', key: 'accuracy' }
     })
 
     mockDvcYamlContent.splice(7, 0, ...mockPlotYamlContent)
@@ -676,8 +692,8 @@ describe('addPlotToDvcYamlFile', () => {
 
     addPlotToDvcYamlFile('/', {
       template: 'simple',
-      x: { file: '/data.json', key: 'epochs' },
-      y: { file: '/data.json', key: 'accuracy' }
+      x: { file: 'data.json', key: 'epochs' },
+      y: { file: 'data.json', key: 'accuracy' }
     })
 
     expect(mockedWriteFileSync).toHaveBeenCalledWith(
@@ -713,8 +729,8 @@ describe('addPlotToDvcYamlFile', () => {
 
     addPlotToDvcYamlFile('/', {
       template: 'simple',
-      x: { file: '/data.json', key: 'epochs' },
-      y: { file: '/data.json', key: 'accuracy' }
+      x: { file: 'data.json', key: 'epochs' },
+      y: { file: 'data.json', key: 'accuracy' }
     })
 
     expect(mockedWriteFileSync).toHaveBeenCalledWith(

extension/src/fileSystem/index.ts

@@ -214,31 +214,27 @@ const loadYamlAsDoc = (
   }
 }
 
-const getPlotYamlObj = (cwd: string, plot: PlotConfigData) => {
+const getPlotYamlObj = (plot: PlotConfigData) => {
   const { x, y, template } = plot
   const plotName = `${template}_plot`
   return {
     [plotName]: {
       template,
-      x: x.file === y.file ? x.key : { [relative(cwd, x.file)]: x.key },
-      y: { [relative(cwd, y.file)]: y.key }
+      x: x.file === y.file ? x.key : { [x.file]: x.key },
+      y: { [y.file]: y.key }
     }
   }
 }
 
-const getPlotsYaml = (
-  cwd: string,
-  plotObj: PlotConfigData,
-  indentSearchLines: string[]
-) => {
+const getPlotsYaml = (plotObj: PlotConfigData, indentSearchLines: string[]) => {
   const indentReg = /^( +)[^ ]/
   const indentLine = indentSearchLines.find(line => indentReg.test(line)) || ''
   const spacesMatches = indentLine.match(indentReg)
   const spaces = spacesMatches?.[1]
 
   return yaml
     .stringify(
-      { plots: [getPlotYamlObj(cwd, plotObj)] },
+      { plots: [getPlotYamlObj(plotObj)] },
       { indent: spaces ? spaces.length : 2 }
     )
     .split('\n')
@@ -258,7 +254,7 @@ export const addPlotToDvcYamlFile = (cwd: string, plotObj: PlotConfigData) => {
   const plots = doc.get('plots', true) as yaml.YAMLSeq | undefined
 
   if (!plots?.range) {
-    const plotYaml = getPlotsYaml(cwd, plotObj, dvcYamlLines)
+    const plotYaml = getPlotsYaml(plotObj, dvcYamlLines)
     dvcYamlLines.push(...plotYaml)
     writeFileSync(dvcYamlFile, dvcYamlLines.join('\n'))
     return
@@ -272,7 +268,6 @@ export const addPlotToDvcYamlFile = (cwd: string, plotObj: PlotConfigData) => {
 
   const plotsStartPos = lineCounter.linePos(plots.range[0]).line - 1
   const plotYaml = getPlotsYaml(
-    cwd,
     plotObj,
     dvcYamlLines.slice(plotsStartPos, insertLineNum)
   )
@@ -342,15 +337,10 @@ const loadDataFile = (file: string): unknown => {
 
 export const loadDataFiles = async (
   files: string[]
-): Promise<{ file: string; data: unknown }[] | undefined> => {
+): Promise<{ file: string; data: unknown }[]> => {
   const filesData: { file: string; data: unknown }[] = []
   for (const file of files) {
     const data = await loadDataFile(file)
-
-    if (!data) {
-      return undefined
-    }
-
     filesData.push({ data, file })
   }
   return filesData