Improve location and property_id error response to return 400 status instead of 500 server error #4884
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Ignored Deployment
|
Passing run #7739 ↗︎
Details:
Review all test suite changes for PR #4884 ↗︎ |
||||||||||||||||||||
galvana
reviewed
May 14, 2024
| ); | ||
| } catch (error) { | ||
| if (error instanceof Error) { | ||
| console.error(error); |
There was a problem hiding this comment.
Add this line before the console.error to disable the lint error
Suggested change
| console.error(error); | |
| // eslint-disable-next-line no-console | |
| console.error(error); |
| console.error(error); | ||
| res | ||
| .status(400) // 400 Bad Request. Malformed request. | ||
| .send(error.message); |
There was a problem hiding this comment.
You can do this instead of checking if error is an instance of Error and then you could fallback to still return an error message instead of just the empty return
res
.status(400) // 400 Bad Request. Malformed request.
.send(
error instanceof Error ? error.message : "An unknown error occurred."
);
Comment on lines
265
to
275
| try { | ||
| await lookupGeolocation(req); | ||
| } catch (error) { | ||
| if (error instanceof Error) { | ||
| expect(error.message).toMatch( | ||
| "Provided location (US-NewYork) query parameter is not in ISO 3166 format." | ||
| ); | ||
| } else { | ||
| expect(typeof error).toBe(Error); | ||
| } | ||
| } |
There was a problem hiding this comment.
You can simplify these checks using Jest's toThrow syntax
await expect(lookupGeolocation(req)).rejects.toThrow(
"Provided location (US-NewYork) query parameter is not in ISO 3166 format."
);
There was a problem hiding this comment.
I think for this one it throws an Error object and not a string. So I think this may not work, will check it now and comment back.
There was a problem hiding this comment.
I was wrong, this works perfectly, I like it, thanks!
galvana
approved these changes
May 15, 2024
galvana
deleted the
PROD-2035-improve-geolocation-and-property-id-error-response
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes PROD-2035
Description Of Changes
Improved validation error messages for
fides.js.Code Changes
geolocationparam is provided but is invalid, e.g. `Invalid request: geolocation "foo" is invalid, must supply an ISO 3166-2 location codeproperty_idparam, and forIS_OVERLAY_ENABLED,IS_PREFETCH_ENABLEDandFIDES_STRINGenvironment variables.Steps to Confirm
geolocationparam with wrong location text infides.js, so it checks the format.property_idparam withoutgeolocationparam.Pre-Merge Checklist
CHANGELOG.md