Skip to content

Refactoring Error Messages for the API #1852

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
nsdeschenes merged 21 commits into from
Mar 16, 2021
Merged

Refactoring Error Messages for the API #1852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
fe26f46
affiliation error messages refactored
nsdeschenes Mar 12, 2021
d01572c
dmarc summaries error messages refactored
nsdeschenes Mar 12, 2021
0164e5a
domain error messages refactored
nsdeschenes Mar 12, 2021
ae5beee
email scan error messages refactored
nsdeschenes Mar 12, 2021
d8b1904
guidance tag error messages updated
nsdeschenes Mar 12, 2021
f1b037f
notify error messages updated
nsdeschenes Mar 12, 2021
97fe66f
organization error messages updated
nsdeschenes Mar 12, 2021
2b5e37f
update summaries error messages
nsdeschenes Mar 12, 2021
d32aee6
update user error messages
nsdeschenes Mar 12, 2021
a11534f
update verified domain error messages
nsdeschenes Mar 12, 2021
b008b0b
whoops missed the test files
nsdeschenes Mar 12, 2021
5072ed2
update verified organizations error messages
nsdeschenes Mar 12, 2021
d216d65
update web-scan error messages
nsdeschenes Mar 12, 2021
d0ff3d1
run prettier on code base
nsdeschenes Mar 12, 2021
c876737
fix up translations after rebase
nsdeschenes Mar 12, 2021
f3ad724
fix grammar in update user roles error messages
nsdeschenes Mar 15, 2021
330e9f3
update user role error messages
nsdeschenes Mar 15, 2021
598116a
update translations
nsdeschenes Mar 15, 2021
b3e9287
more changes to updateUserRole error messages
nsdeschenes Mar 15, 2021
4359851
update translations
nsdeschenes Mar 15, 2021
0e993f7
fix translation issues from rebase
nsdeschenes Mar 15, 2021
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
4 changes: 2 additions & 2 deletions api-js/src/affiliation/loaders/__tests__/load-affiliation-connections-by-org-id.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -836,7 +836,7 @@ describe('given the load affiliations by org id function', () => {
await affiliationLoader({ orgId: org._id, ...connectionArgs })
} catch (err) {
expect(err).toEqual(
new Error('Unable to query affiliations. Please try again.'),
new Error('Unable to query affiliation(s). Please try again.'),
)
}

Expand Down Expand Up @@ -870,7 +870,7 @@ describe('given the load affiliations by org id function', () => {
await affiliationLoader({ orgId: org._id, ...connectionArgs })
} catch (err) {
expect(err).toEqual(
new Error('Unable to load affiliations. Please try again.'),
new Error('Unable to load affiliation(s). Please try again.'),
)
}

Expand Down
4 changes: 2 additions & 2 deletions api-js/src/affiliation/loaders/__tests__/load-affiliation-connections-by-user-id.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4403,7 +4403,7 @@ describe('given the load affiliations by user id function', () => {
})
} catch (err) {
expect(err).toEqual(
new Error('Unable to query affiliations. Please try again.'),
new Error('Unable to query affiliation(s). Please try again.'),
)
}

Expand Down Expand Up @@ -4441,7 +4441,7 @@ describe('given the load affiliations by user id function', () => {
})
} catch (err) {
expect(err).toEqual(
new Error('Unable to load affiliations. Please try again.'),
new Error('Unable to load affiliation(s). Please try again.'),
)
}

Expand Down
6 changes: 4 additions & 2 deletions api-js/src/affiliation/loaders/load-affiliation-connections-by-org-id.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,9 @@ export const affiliationConnectionLoaderByOrgId = (
console.error(
`Database error occurred while user: ${userKey} was trying to query affiliations in affiliationConnectionLoaderByOrgId, error: ${err}`,
)
throw new Error(i18n._(t`Unable to query affiliations. Please try again.`))
throw new Error(
i18n._(t`Unable to query affiliation(s). Please try again.`),
)
}

let filteredAffiliations
Expand All @@ -228,7 +230,7 @@ export const affiliationConnectionLoaderByOrgId = (
console.error(
`Cursor error occurred while user: ${userKey} was trying to gather affiliations in affiliationConnectionLoaderByOrgId, error: ${err}`,
)
throw new Error(i18n._(t`Unable to load affiliations. Please try again.`))
throw new Error(i18n._(t`Unable to load affiliation(s). Please try again.`))
}

if (filteredAffiliations.affiliations.length === 0) {
Expand Down
6 changes: 4 additions & 2 deletions api-js/src/affiliation/loaders/load-affiliation-connections-by-user-id.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,9 @@ export const affiliationConnectionLoaderByUserId = (
console.error(
`Database error occurred while user: ${userKey} was trying to query affiliations in affiliationConnectionLoaderByUserId, error: ${err}`,
)
throw new Error(i18n._(t`Unable to query affiliations. Please try again.`))
throw new Error(
i18n._(t`Unable to query affiliation(s). Please try again.`),
)
}

let filteredAffiliations
Expand All @@ -409,7 +411,7 @@ export const affiliationConnectionLoaderByUserId = (
console.error(
`Cursor error occurred while user: ${userKey} was trying to gather affiliations in affiliationConnectionLoaderByUserId, error: ${err}`,
)
throw new Error(i18n._(t`Unable to load affiliations. Please try again.`))
throw new Error(i18n._(t`Unable to load affiliation(s). Please try again.`))
}

if (filteredAffiliations.affiliations.length === 0) {
Expand Down
22 changes: 14 additions & 8 deletions api-js/src/affiliation/mutations/__tests__/invite-user-to-org.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1072,9 +1072,7 @@ describe('invite user to org', () => {
)

const error = [
new GraphQLError(
'Unable to invite yourself to an org. Please try again.',
),
new GraphQLError('Unable to invite yourself to an org.'),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -1143,7 +1141,7 @@ describe('invite user to org', () => {
)

const error = [
new GraphQLError('Unable to invite user. Please try again.'),
new GraphQLError('Unable to invite user to unknown organization.'),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -1237,7 +1235,9 @@ describe('invite user to org', () => {
)

const error = [
new GraphQLError('Unable to invite user. Please try again.'),
new GraphQLError(
'Permission Denied: Please contact organization admin for help with user invitations.',
),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -1335,7 +1335,9 @@ describe('invite user to org', () => {
)

const error = [
new GraphQLError('Unable to invite user. Please try again.'),
new GraphQLError(
'Permission Denied: Please contact organization admin for help with user invitations.',
),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -1433,7 +1435,9 @@ describe('invite user to org', () => {
)

const error = [
new GraphQLError('Unable to invite user. Please try again.'),
new GraphQLError(
'Permission Denied: Please contact organization admin for help with user invitations.',
),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -1551,7 +1555,9 @@ describe('invite user to org', () => {
)

const error = [
new GraphQLError('Unable to invite user. Please try again.'),
new GraphQLError(
'Unable to add user to organization. Please try again.',
),
]

expect(response.errors).toEqual(error)
Expand Down
16 changes: 7 additions & 9 deletions api-js/src/affiliation/mutations/__tests__/remove-user-from-org.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ describe('removing a user from an organization', () => {

const error = [
new GraphQLError(
'Unable to remove user from organization. Please try again.',
'Unable to remove user from unknown organization.',
),
]

Expand Down Expand Up @@ -654,7 +654,7 @@ describe('removing a user from an organization', () => {

const error = [
new GraphQLError(
'Unable to remove user from organization. Please try again.',
'Permission Denied: Please contact organization admin for help with removing users.',
),
]

Expand Down Expand Up @@ -721,7 +721,7 @@ describe('removing a user from an organization', () => {

const error = [
new GraphQLError(
'Unable to remove user from organization. Please try again.',
'Unable to remove a user that already does not belong to this organization.',
),
]

Expand Down Expand Up @@ -788,7 +788,7 @@ describe('removing a user from an organization', () => {

const error = [
new GraphQLError(
'Unable to remove user from organization. Please try again.',
'Permission Denied: Please contact organization admin for help with removing users.',
),
]

Expand Down Expand Up @@ -854,9 +854,7 @@ describe('removing a user from an organization', () => {
)

const error = [
new GraphQLError(
'Unable to remove user from organization. Please try again.',
),
new GraphQLError('Unable to remove user from organization.'),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -923,7 +921,7 @@ describe('removing a user from an organization', () => {

const error = [
new GraphQLError(
'Unable to remove user from organization. Please try again.',
'Unable to remove unknown user from organization.',
),
]

Expand Down Expand Up @@ -997,7 +995,7 @@ describe('removing a user from an organization', () => {

const error = [
new GraphQLError(
'Unable to remove user from organization. Please try again.',
'Unable to remove user from this organization. Please try again.',
),
]

Expand Down
46 changes: 23 additions & 23 deletions api-js/src/affiliation/mutations/__tests__/update-user-role.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,11 +581,7 @@ describe('update a users role', () => {
},
)

const error = [
new GraphQLError(
'Unable to update your own role. Please try again.',
),
]
const error = [new GraphQLError('Unable to update your own role.')]

expect(response.errors).toEqual(error)
expect(consoleOutput).toEqual([
Expand Down Expand Up @@ -636,7 +632,7 @@ describe('update a users role', () => {
)

const error = [
new GraphQLError('Unable to update users role. Please try again.'),
new GraphQLError(`Unable to update role: user unknown.`),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -688,7 +684,7 @@ describe('update a users role', () => {
)

const error = [
new GraphQLError('Unable to update users role. Please try again.'),
new GraphQLError(`Unable to update role: organization unknown.`),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -747,7 +743,9 @@ describe('update a users role', () => {
)

const error = [
new GraphQLError('Unable to update users role. Please try again.'),
new GraphQLError(
'Permission Denied: Please contact organization admin for help with user role changes.',
),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -832,7 +830,9 @@ describe('update a users role', () => {
)

const error = [
new GraphQLError('Unable to update users role. Please try again.'),
new GraphQLError(
'Permission Denied: Please contact organization admin for help with user role changes.',
),
]

expect(response.errors).toEqual(error)
Expand Down Expand Up @@ -892,7 +892,7 @@ describe('update a users role', () => {

const error = [
new GraphQLError(
'Unable to update users role. Please invite user to the organization.',
'Unable to update role: user does not belong to organization.',
),
]

Expand Down Expand Up @@ -963,7 +963,7 @@ describe('update a users role', () => {

const error = [
new GraphQLError(
'Unable to update users role. Please try again.',
`Permission Denied: Please contact organization admin for help with updating user roles.`,
),
]

Expand Down Expand Up @@ -1034,7 +1034,7 @@ describe('update a users role', () => {

const error = [
new GraphQLError(
'Unable to update users role. Please try again.',
`Permission Denied: Please contact organization admin for help with updating user roles.`,
),
]

Expand Down Expand Up @@ -1106,7 +1106,7 @@ describe('update a users role', () => {

const error = [
new GraphQLError(
'Unable to update users role. Please try again.',
`Permission Denied: Please contact organization admin for help with updating user roles.`,
),
]

Expand Down Expand Up @@ -1175,7 +1175,7 @@ describe('update a users role', () => {

const error = [
new GraphQLError(
'Unable to update users role. Please try again.',
`Permission Denied: Please contact organization admin for help with updating user roles.`,
),
]

Expand Down Expand Up @@ -1306,12 +1306,12 @@ describe('update a users role', () => {
)

const error = [
new GraphQLError('Unable to update users role. Please try again.'),
new GraphQLError(`Unable to update user's role. Please try again.`),
]

expect(response.errors).toEqual(error)
expect(consoleOutput).toEqual([
`Database error occurred when user: ${user._key} attempted to update a users: ${secondaryUser._key} role, error: Error: Database error occurred.`,
`Database error occurred when user: ${user._key} attempted to update a user's: ${secondaryUser._key} role, error: Error: Database error occurred.`,
])
})
})
Expand Down Expand Up @@ -1427,12 +1427,12 @@ describe('update a users role', () => {
)

const error = [
new GraphQLError('Unable to update users role. Please try again.'),
new GraphQLError(`Unable to update user's role. Please try again.`),
]

expect(response.errors).toEqual(error)
expect(consoleOutput).toEqual([
`Transaction step error occurred when user: ${user._key} attempted to update a users: ${secondaryUser._key} role, error: Error: Transaction error occurred.`,
`Transaction step error occurred when user: ${user._key} attempted to update a user's: ${secondaryUser._key} role, error: Error: Transaction error occurred.`,
])
})
})
Expand Down Expand Up @@ -1492,12 +1492,12 @@ describe('update a users role', () => {
)

const error = [
new GraphQLError('Unable to update users role. Please try again.'),
new GraphQLError(`Unable to update user's role. Please try again.`),
]

expect(response.errors).toEqual(error)
expect(consoleOutput).toEqual([
`Transaction commit error occurred when user: ${user._key} attempted to update a users: ${secondaryUser._key} role, error: Error: Transaction error occurred.`,
`Transaction commit error occurred when user: ${user._key} attempted to update a user's: ${secondaryUser._key} role, error: Error: Transaction error occurred.`,
])
})
})
Expand Down Expand Up @@ -2691,7 +2691,7 @@ describe('update a users role', () => {

expect(response.errors).toEqual(error)
expect(consoleOutput).toEqual([
`Database error occurred when user: ${user._key} attempted to update a users: ${secondaryUser._key} role, error: Error: Database error occurred.`,
`Database error occurred when user: ${user._key} attempted to update a user's: ${secondaryUser._key} role, error: Error: Database error occurred.`,
])
})
})
Expand Down Expand Up @@ -2810,7 +2810,7 @@ describe('update a users role', () => {

expect(response.errors).toEqual(error)
expect(consoleOutput).toEqual([
`Transaction step error occurred when user: ${user._key} attempted to update a users: ${secondaryUser._key} role, error: Error: Transaction error occurred.`,
`Transaction step error occurred when user: ${user._key} attempted to update a user's: ${secondaryUser._key} role, error: Error: Transaction error occurred.`,
])
})
})
Expand Down Expand Up @@ -2873,7 +2873,7 @@ describe('update a users role', () => {

expect(response.errors).toEqual(error)
expect(consoleOutput).toEqual([
`Transaction commit error occurred when user: ${user._key} attempted to update a users: ${secondaryUser._key} role, error: Error: Transaction error occurred.`,
`Transaction commit error occurred when user: ${user._key} attempted to update a user's: ${secondaryUser._key} role, error: Error: Transaction error occurred.`,
])
})
})
Expand Down
Loading