Solve promise+event+memory leaks when the network fails #427
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
…work fails before a response is received
Codecov Report
@@ Coverage Diff @@
## 6-dev #427 +/- ##
==========================================
+ Coverage 96.41% 96.45% +0.03%
==========================================
Files 32 33 +1
Lines 1535 1550 +15
==========================================
+ Hits 1480 1495 +15
Misses 55 55
Continue to review full report at Codecov.
|
Aschen
suggested changes
Jul 19, 2019
test/protocol/common.test.js
Outdated
| sinon = require('sinon'), | ||
| KuzzleError = require('../../src/KuzzleError'), | ||
| AbstractWrapper = require('../../src/protocols/abstract/common'); | ||
| KuzzleError = require(`${root}/src/KuzzleError`), |
There was a problem hiding this comment.
This kind of shortcut beak editor ability to automatically refactor imports when renaming files
There was a problem hiding this comment.
I wouldn't know, I don't use IDEs 😑
I'll revert that one, since this makes code marginally more readable.
xbill82
approved these changes
Jul 22, 2019
Aschen
approved these changes
Jul 22, 2019
This was referenced Jul 26, 2019
Merged
scottinet
added a commit
that referenced
this pull request
Jul 31, 2019
# [6.2.0](https://github.com/kuzzleio/sdk-javascript/releases/tag/6.2.0) (2019-07-31) #### Bug fixes - [ [#428](#428) ] Properly handle boolean flags in HTTP querystrings ([scottinet](https://github.com/scottinet)) - [ [#427](#427) ] Solve promise+event+memory leaks when the network fails ([scottinet](https://github.com/scottinet)) - [ [#424](#424) ] Prevent pending request leak when disconnect the SDK ([Aschen](https://github.com/Aschen)) - [ [#422](#422) ] Fix bug when decoding JWT in browser ([Aschen](https://github.com/Aschen)) - [ [#420](#420) ] Fix http protocol unresolved promise on connection error ([Aschen](https://github.com/Aschen)) #### New features - [ [#419](#419) ] Add bulk:write and bulk:mWrite ([Aschen](https://github.com/Aschen)) #### Enhancements - [ [#421](#421) ] Get api routes from server:publicApi ([Aschen](https://github.com/Aschen)) - [ [#423](#423) ] Emit queryError event on malformed request ([Aschen](https://github.com/Aschen)) - [ [#417](#417) ] Security controller documentation ([benoitvidis](https://github.com/benoitvidis)) ---
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
Whenever a request is sent through
AbstractProtocol.query:When an API response is received, its requestId is used to invoke the one-time listener which, in turns, remove the entry from the pending requests map, and resolves/rejects the promise.
But nothing was ever done if the network fails, meaning that requests were created with no hope of ever receiving a corresponding response.
This leads to several leaks, and it will also block users awaiting for SDK methods that might never resolve their returned promise.
This PR fixes the problem by making sure that
AbstractProtocol.cleargets called on network disconnections (expected or not), ensuring that the pending requests map is properly cleared.This PR also enhances the "clear" method by making it unregister the one-time event, and reject the corresponding promise, to make sure that no trace remains of the pending request.
This PR builds over #424 and fixes/enhances it.