Fix validation errors not calling callbacks #424
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
…was causing their test suite to hang. There is a sneaky little bug around our internal validations where, in several methods that accept callbacks, our validations error out directly and never invoke the given callback with the error. This can lead to code that waits for a callback that will never complete. This also affects functions wrapped in `Sync` which leverage callbacks to capture their return values. The affected methods were: - `getCookiesSync` - `getCookieString` - `getSetCookieStrings` - `serializeSync` - `serialize` - `setCookieSync` - `setCookie` - `getCookiesSync` - `getCookies` There were also several validation errors hiding in support methods. These appear to be redundant since the type signatures present already do much of the validation. These have been removed from: - `checkSameSiteContext` - `isHostPrefixConditionMet` - `isSecurePrefixConditionMet` - `cookieCompare` - `formatDate` - `permutePath`
wjhsf
approved these changes
Jun 24, 2024
| throw err | ||
| } | ||
| } | ||
|
|
||
| // These seem to be false positives; it can't detect that the value may be changed in the callback |
There was a problem hiding this comment.
Suggested change
| // These seem to be false positives; it can't detect that the value may be changed in the callback |
Comment is for the removed // eslint-disable
Comment on lines
+337
to
+341
| if (err instanceof Error) { | ||
| syncErr = err | ||
| } else { | ||
| throw err | ||
| } |
There was a problem hiding this comment.
Elsewhere we just cast err as Error, why be particular here?
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.
I noticed this issue while upgrading
tough-cookieinjsdomwhich was causing their test suite to hang. There is a sneaky little bug around our internal validations where, in several methods that accept callbacks, our validations error out directly and never invoke the given callback with the error. This can lead to code that waits for a callback that will never complete. This also affects functions wrapped inSyncwhich leverage callbacks to capture their return values.The affected methods were:
getCookiesSyncgetCookieStringgetSetCookieStringsserializeSyncserializesetCookieSyncsetCookiegetCookiesSyncgetCookiesThere were also several validation errors hiding in support methods. These appear to be redundant since the type signatures present already do much of the validation. These have been removed from:
checkSameSiteContextisHostPrefixConditionMetisSecurePrefixConditionMetcookieCompareformatDatepermutePath