Call DomPurify.addHook only if it exists
#5428
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
On server-side execution `dompurify` exports factory function instead of a purifier instance. Because of this, server-side code that imports SwaggerUI (e.g. via `swagger-ui-react`) fails, since `DomPurify.addHook` does not exist. This affects universal rendering apps which share code between client-side and server-side.
Contributor
|
@AlexMayants Merged! Thanks for the contribution and patience! |
mattyb678
pushed a commit
to mattyb678/swagger-ui
that referenced
this pull request
Jun 24, 2020
…5428) On server-side execution `dompurify` exports factory function instead of a purifier instance. Because of this, server-side code that imports SwaggerUI (e.g. via `swagger-ui-react`) fails, since `DomPurify.addHook` does not exist. This affects universal rendering apps which share code between client-side and server-side.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
Call
DomPurify.addHookonly if it exists.Motivation and Context
On server-side execution
dompurifyexports factory function instead of a purifier instance. Because of this, server-side code that imports SwaggerUI (e.g. viaswagger-ui-react) fails, sinceDomPurify.addHookdoes not exist.This affects universal rendering apps which share code between client-side and server-side.
Server-side script fails with message
UnhandledPromiseRejectionWarning: TypeError: _dompurify2.default.addHook is not a functionHow Has This Been Tested?
Manually tested that client-side behaviour did not change.
In our application I had to substitute
dompurifymodule with a shim in the server-side build script. After that SwaggerUI component runs without errors after page loading.Screenshots (if appropriate):
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests