feat(error-check): add check for error message #198
Merged
Conversation
This file contains hidden or 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
brendarearden
force-pushed
the
feat/add-internal-error-check
branch
4 times, most recently
from
34475ff to
e18a9bb
Compare
brendarearden
requested review from
a team,
EdVinyard and
Nezteb
and removed request for
a team
brendarearden
force-pushed
the
feat/add-internal-error-check
branch
from
e18a9bb to
354811a
Compare
daniel-white
reviewed
Jun 3, 2022
| 'items' in schemaNode.fragment && | ||
| schemaNode.primaryType === SchemaNodeKind.Array && | ||
| schemaNode.fragment.items !== null && | ||
| 'x-sl-error-message' in (schemaNode.fragment.items as any) |
There was a problem hiding this comment.
is there away to avoid the .items as any twice in this block?
There was a problem hiding this comment.
Thanks Daniel for working with me on the type checking to ensure we didn't need to cast it as any!
brendarearden
force-pushed
the
feat/add-internal-error-check
branch
from
354811a to
cc3d821
Compare
EdVinyard
approved these changes
Jun 3, 2022
| const items: unknown = fragment['items']; | ||
| if (typeof items === 'object' && items !== null) { | ||
| const itemsErrorMessage = items['x-sl-error-message']; | ||
| if (typeof itemsErrorMessage === 'string') { |
There was a problem hiding this comment.
I like what y'all did here. It makes me like TypeScript even more. 🙂
brendarearden
requested review from
a team,
EdVinyard,
jasonmgillhub and
mallachari
and removed request for
a team,
Nezteb and
mallachari
lottamus
suggested changes
Jun 6, 2022
brendarearden
force-pushed
the
feat/add-internal-error-check
branch
2 times, most recently
from
35f9503 to
9d52065
Compare
lottamus
reviewed
Jun 6, 2022
brendarearden
force-pushed
the
feat/add-internal-error-check
branch
from
9d52065 to
e2de87d
Compare
lottamus
approved these changes
Jun 6, 2022
brendarearden
force-pushed
the
feat/add-internal-error-check
branch
from
e2de87d to
9e28d99
Compare
|
🎉 This PR is included in version 4.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Motivation and Context
When users are viewing public endpoints that reference internally marked schemas, we need a way to display an error message to let the user know they do not have permissions to view it.
#InsertIssueNumberHere
https://github.com/stoplightio/platform-internal/issues/10534
Description
Added a check at the toplevelschemarow and at the schemarow levels to check for the
x-sl-error-messagepropertyHow Has This Been Tested?
Manually tested changes by pulling this package into platform internal and manually making changes to the schema and schema permissions and seeing if the error message showed up as expected.
Added test coverage for SchemaRow
Screenshot(s)/recordings(s)
Types of changes
Checklist