Skip to content

Move error formatting logic out to clients #3578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattseddon merged 1 commit into from
Apr 2, 2023
Merged

Move error formatting logic out to clients #3578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
233 changes: 98 additions & 135 deletions extension/src/plots/errors/collect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
import { join } from 'path'
import {
collectErrors,
collectImageErrors,
collectPathErrorsTable
} from './collect'
import { collectErrors, collectImageErrors, collectPathErrors } from './collect'
import { EXPERIMENT_WORKSPACE_ID } from '../../cli/dvc/contract'

describe('collectErrors', () => {
Expand All @@ -14,10 +10,8 @@ describe('collectErrors', () => {
[
{
msg: 'unexpected error',
name: 'fun::plot',
rev: EXPERIMENT_WORKSPACE_ID,
source: 'metrics.json',
type: 'unexpected'
path: 'fun::plot',
rev: EXPERIMENT_WORKSPACE_ID
}
],
{}
Expand All @@ -33,17 +27,13 @@ describe('collectErrors', () => {
[
{
msg: 'unexpected error',
name: 'fun::plot',
rev: EXPERIMENT_WORKSPACE_ID,
source: 'metrics.json',
type: 'unexpected'
path: 'fun::plot',
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg: 'unexpected error',
name: 'fun::plot',
rev: 'main',
source: 'metrics.json',
type: 'unexpected'
path: 'fun::plot',
rev: 'main'
}
],
{ [EXPERIMENT_WORKSPACE_ID]: EXPERIMENT_WORKSPACE_ID, ff2489c: 'main' }
Expand All @@ -67,23 +57,21 @@ describe('collectErrors', () => {
[
{
msg: 'unexpected error',
name: 'fun::plot',
rev: EXPERIMENT_WORKSPACE_ID,
source: 'metrics.json',
type: 'unexpected'
path: 'fun::plot',
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg: 'unexpected error',
name: 'fun::plot',
rev: 'main',
source: 'metrics.json',
type: 'unexpected'
path: 'fun::plot',
rev: 'main'
}
],
{ [EXPERIMENT_WORKSPACE_ID]: EXPERIMENT_WORKSPACE_ID, ff2489c: 'main' }
)

expect(errors).toStrictEqual([{ ...newError, rev: 'main' }])
expect(errors).toStrictEqual([
{ msg: 'new error', path: 'fun::plot', rev: 'main' }
])
})

it('should collect new errors', () => {
Expand All @@ -104,16 +92,16 @@ describe('collectErrors', () => {
[
{
msg: 'unexpected error',
name: 'fun::plot',
rev: EXPERIMENT_WORKSPACE_ID,
source: 'metrics.json',
type: 'unexpected'
path: 'fun::plot',
rev: EXPERIMENT_WORKSPACE_ID
}
],
{ d7ad114: 'main' }
)

expect(errors).toStrictEqual([{ ...newError, rev: 'main' }])
expect(errors).toStrictEqual([
{ msg: 'Blue screen of death', path: 'fun::plot', rev: 'main' }
])
})
})

Expand All @@ -134,100 +122,82 @@ describe('collectImageErrors', () => {
const errors = [
{
msg: `${otherPath} - file type error\nOnly JSON, YAML, CSV and TSV formats are supported.`,
name: otherPath,
rev: EXPERIMENT_WORKSPACE_ID,
source: otherPath,
type: 'PlotMetricTypeError'
path: otherPath,
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg: "Could not find provided field ('ste') in data fields ('step, test/acc').",
name: otherPath,
rev: EXPERIMENT_WORKSPACE_ID,
source: otherPath,
type: 'FieldNotFoundError'
path: otherPath,
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg: '',
name: path,
rev: EXPERIMENT_WORKSPACE_ID,
source: path,
type: 'FileNotFoundError'
msg: `${path} not found.`,
path,
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg: '',
name: path,
rev: 'main',
source: path,
type: 'FileNotFoundError'
msg: `${path} not found.`,
path,
rev: 'main'
}
]

const error = collectImageErrors(path, EXPERIMENT_WORKSPACE_ID, errors)
expect(error).toStrictEqual(`${path} not found.`)
expect(error).toStrictEqual([`${path} not found.`])
})

it('should concatenate errors together to give a single string', () => {
it('should return an array of errors', () => {
const path = join('training', 'plots', 'images', 'mispredicted.jpg')

const errors = [
{
msg: '',
name: path,
rev: EXPERIMENT_WORKSPACE_ID,
source: path,
type: 'FileNotFoundError'
msg: `${path} not found.`,
path,
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg: 'catastrophic error',
name: path,
rev: EXPERIMENT_WORKSPACE_ID,
source: path,
type: 'SomeError'
path,
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg: '',
name: path,
rev: EXPERIMENT_WORKSPACE_ID,
source: path,
type: 'UNEXPECTEDERRRRROR'
msg: 'UNEXPECTEDERRRRROR',
path,
rev: EXPERIMENT_WORKSPACE_ID
}
]

const error = collectImageErrors(path, EXPERIMENT_WORKSPACE_ID, errors)
expect(error).toStrictEqual(
`${path} not found.\ncatastrophic error\nUNEXPECTEDERRRRROR`
)
expect(error).toStrictEqual([
`${path} not found.`,
'catastrophic error',
'UNEXPECTEDERRRRROR'
])
})
})

describe('collectPathErrorsTable', () => {
it('should return undefined if the errors do not relate to selected revisions', () => {
const rev = 'main'
const path = 'wat'
const markdownTable = collectPathErrorsTable(
const markdownTable = collectPathErrors(
path,
[EXPERIMENT_WORKSPACE_ID],
[
{
msg: '',
name: path,
rev,
source: path,
type: 'FileNotFoundError'
msg: `${path} not found.`,
path,
rev
},
{
msg: 'catastrophic error',
name: path,
rev,
source: path,
type: 'SomeError'
path,
rev
},
{
msg: '',
name: path,
rev,
source: path,
type: 'UNEXPECTEDERRRRROR'
msg: 'UNEXPECTEDERRRRROR',
path,
rev
}
]
)
Expand All @@ -237,101 +207,91 @@ describe('collectPathErrorsTable', () => {
it('should return undefined if the errors do not relate to the path', () => {
const rev = 'main'
const path = 'wat'
const markdownTable = collectPathErrorsTable(
const markdownTable = collectPathErrors(
join('other', 'path'),
[rev],
[
{
msg: '',
name: path,
rev,
source: path,
type: 'FileNotFoundError'
msg: `${path} not found.`,
path,
rev
},
{
msg: 'catastrophic error',
name: path,
rev,
source: path,
type: 'SomeError'
path,
rev
},
{
msg: '',
name: path,
rev,
source: path,
type: 'UNEXPECTEDERRRRROR'
msg: 'UNEXPECTEDERRRRROR',
path,
rev
}
]
)
expect(markdownTable).toBeUndefined()
})

it('should construct a markdown table with the error if they relate to the select revision and provided path', () => {
it('should return an array of objects containing error messages that relate to the select revision and provided path', () => {
const rev = 'a-really-long-branch-name'
const path = 'wat'
const markdownTable = collectPathErrorsTable(
const markdownTable = collectPathErrors(
path,
[EXPERIMENT_WORKSPACE_ID, rev],
[
{
msg: '',
name: path,
rev: EXPERIMENT_WORKSPACE_ID,
source: path,
type: 'FileNotFoundError'
msg: `${path} not found.`,
path,
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg: 'catastrophic error',
name: path,
rev,
source: path,
type: 'SomeError'
path,
rev
},
{
msg: 'UNEXPECTEDERRRRROR',
path,
rev
},
{
msg: '',
name: path,
rev,
source: path,
type: 'UNEXPECTEDERRRRROR'
msg: 'other path not found.',
path: 'other path',
rev: EXPERIMENT_WORKSPACE_ID
}
]
)
expect(markdownTable).toStrictEqual(
'Errors\n' +
'|||\n' +
'|--|--|\n' +
'| a-really... | UNEXPECTEDERRRRROR |\n' +
'| a-really... | catastrophic error |\n' +
'| workspace | wat not found. |'
)
expect(markdownTable).toStrictEqual([
{ msg: 'wat not found.', rev: EXPERIMENT_WORKSPACE_ID },
{ msg: 'catastrophic error', rev },
{ msg: 'UNEXPECTEDERRRRROR', rev }
])
})

it('should not duplicate entries in the table', () => {
const name = 'dvc.yaml::Accuracy'
const path = 'dvc.yaml::Accuracy'
const msg =
"Could not find provided field ('acc_') in data fields ('step, acc')."
const type = 'FieldNotFoundError'
const duplicateEntry = {
msg,
name,
path,
rev: 'aa1401b',
type
}

const markdownTable = collectPathErrorsTable(
const markdownTable = collectPathErrors(
'dvc.yaml::Accuracy',
[EXPERIMENT_WORKSPACE_ID, 'main', 'test-plots-diff', 'aa1401b'],
[
{
msg,
name,
path,
rev: 'workspace',
type
},
{
msg,
name,
path,
rev: 'test-plots-diff',
type
},
Expand All @@ -340,13 +300,16 @@ describe('collectPathErrorsTable', () => {
]
)

expect(markdownTable).toStrictEqual(
'Errors\n' +
'|||\n' +
'|--|--|\n' +
"| aa1401b | Could not find provided field ('acc_') in data fields ('step, acc'). |\n" +
"| test-plo... | Could not find provided field ('acc_') in data fields ('step, acc'). |\n" +
"| workspace | Could not find provided field ('acc_') in data fields ('step, acc'). |"
)
expect(markdownTable).toStrictEqual([
{
msg,
rev: EXPERIMENT_WORKSPACE_ID
},
{
msg,
rev: 'test-plots-diff'
},
{ msg, rev: 'aa1401b' }
])
})
})
Loading