Discuss common ErrorStructure

[sergey-shandar]

Proposed structure

type DerivedError = {
  readonly code: string
  readonly nested: Error
}
type FinalError = {
  readonly code: string
  readonly message: string
}
type Error = DerivedError | FinalError

Questions:

• helpUrl?
• consistent location format.
• nested errors.

[sergey-shandar]

@vladbarosan @veronicagg

[sergey-shandar]

Also we need unique id for each error for diff tools.
Unique fields:

• code
• file url (may be, unless renamed)
• JSON reference with some changes, for example OpenAPI
  • path should have no parameters.
  • rename of parameters should have no effect if they are in path or in body.

[vladbarosan]

@sergey-shandar when you mean unique id, you mean a code or an extra ID field ( e.g. OAD123). I thought we dont want to have an extra id on top of the code.

[sergey-shandar]

@vladbarosan The unique id of error as nothing to do with code or an extra ID field (aka error type). This is an error id which should be the same for another run of avocado on slightly modified code base. It's required for detecting new errors in PR.

[sergey-shandar]

@billytrend

[vladbarosan]

@sergey-shandar , so I think as we discussed action item here is to see what fields to calculate on ( obvious candidates are error code and jsonRef (with our without the file url ). either way we should err on the side of false positives ( i.e. report as new even if they are not )