perf: stream bundled OpenAPI file instead of sending it wholesale #361
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
erunion
reviewed
Aug 26, 2021
| @@ -1,6 +1,6 @@ | |||
| module.exports = { | |||
| // eslint-disable-next-line global-require | |||
| cli: require('../package.json').name, | |||
| host: 'https://dash.readme.io', | |||
| host: 'https://dash.readme.com', | |||
erunion
approved these changes
Aug 26, 2021
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.
🧰 Changes
We were seeing issues where validated + bundled OpenAPI files weren't being consumed properly by our API. This PR fixes two things:
multipart/form-datapayloads and should makemulterhappy.Don't dereference a file when performing validation (to be completed once feat: stop running schema dereferencing when running validation oas-normalize#153 is merged in)(edit: see chore(deps): upgrading oas-normalize to resolve validation quirks #362!)Add some tests to confirm that files aren't dereferenced maybe?(edit: already handled inoas-normalize!)🧬 QA & Testing
Confirmed that uploading files still works with these changes, and that uploading larger files at least doesn't fail
multervalidation! If CI passes, we should be good to go.