fix(spec): wrap parameterMacro to handle undefined return values#10817
Open
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Open
fix(spec): wrap parameterMacro to handle undefined return values#10817maruthang wants to merge 1 commit intoswagger-api:masterfrom
maruthang wants to merge 1 commit intoswagger-api:masterfrom
Conversation
When parameterMacro conditionally returns values, undefined gets used as a WeakMap key in swagger-client causing "Invalid value used as weak map key" error. Wrap the user-provided macro so that undefined returns are substituted with the parameter's existing default value. Fixes swagger-api#10448
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
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.
Description
Created a
wrapParameterMacroutility function that wraps the user-providedparameterMacrocallback. When the macro returnsundefined, the wrapper substitutes the parameter's existing default value, preventingundefinedfrom being used as a WeakMap key in swagger-client.Applied the wrapper in all 3 places where
parameterMacrois passed to swagger-client:resolveSpecinsrc/core/plugins/spec/actions.jsdebResolveSubtreesinsrc/core/plugins/spec/actions.jsrequestResolvedSubtreeinsrc/core/plugins/swagger-client/index.jsMotivation and Context
Fixes #10448
When
parameterMacroconditionally returns values (i.e., returnsundefinedfor some parameters), swagger-client attempts to useundefinedas a WeakMap key, which throws:TypeError: Invalid value used as weak map key. This makes it impossible to useparameterMacroto selectively override only certain parameters.How Has This Been Tested?
test/unit/core/utils/wrap-parameter-macro.jscovering:undefined0,"",null, andfalseoperationandparameterarguments to the macroundefined(no-op) whenparameterMacrois not a functionundefinedwhenparameterMacroisnullorundefined--no-verify(Husky hook has exec format issues on Windows)Screenshots (if appropriate):
N/A — no UI changes.
Checklist
My PR contains...
src/is unmodified: changes to documentation, CI, metadata, etc.)package.json)My changes...
Documentation
Automated tests