Skip to content

chore(errors): simplify the precondition message #57

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
merged 2 commits into from
Aug 17, 2022
Merged

chore(errors): simplify the precondition message #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42096dc
chore(errors): handle another case for the failed precondition
Vinzius Aug 16, 2022
deee86e
feat: get rid of the switch
Vinzius Aug 17, 2022
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
10 changes: 6 additions & 4 deletions packages/clients/src/scw/errors/standard/__tests__/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ describe('PreconditionFailedError', () => {
precondition: 'unknown_precondition',
type: 'precondition_failed',
}).toString(),
).toBe('PreconditionFailedError: precondition failed: unknown precondition')
).toBe('PreconditionFailedError: precondition failed: unknown_precondition')
})

it(`parses a valid input for precondition precondition_failed`, () => {
Expand All @@ -291,7 +291,7 @@ describe('PreconditionFailedError', () => {
type: 'precondition_failed',
}).toString(),
).toBe(
'PreconditionFailedError: precondition failed: resource is still in use, All servers must be removed from the private network before deleting it.',
'PreconditionFailedError: precondition failed: resource_still_in_use, All servers must be removed from the private network before deleting it.',
)
})

Expand All @@ -303,7 +303,7 @@ describe('PreconditionFailedError', () => {
type: 'precondition_failed',
}).toString(),
).toBe(
'PreconditionFailedError: precondition failed: attribute must be set',
'PreconditionFailedError: precondition failed: attribute_must_be_set',
)
})

Expand All @@ -314,7 +314,9 @@ describe('PreconditionFailedError', () => {
precondition: 'wrong_precondition_key',
type: 'precondition_failed',
}).toString(),
).toBe('PreconditionFailedError: precondition failed: ')
).toBe(
'PreconditionFailedError: precondition failed: wrong_precondition_key',
)
})

it(`doesn't parse invalid input`, () => {
Expand Down
17 changes: 2 additions & 15 deletions packages/clients/src/scw/errors/standard/precondition-failed-error.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,12 @@ import { ScalewayError } from '../scw-error'
* @internal
*/
const buildMessage = (precondition: string, helpMessage: string): string => {
let message: string
switch (precondition) {
case 'unknown_precondition':
message = 'unknown precondition'
break
case 'resource_still_in_use':
message = 'resource is still in use'
break
case 'attribute_must_be_set':
message = 'attribute must be set'
break
default:
message = ''
}
let message = `precondition failed: ${precondition}`
if (typeof helpMessage === 'string' && helpMessage.length > 0) {
message = message.concat(', ', helpMessage)
}

return `precondition failed: ${message}`
return message
}

/**
Expand Down