fix: conn mgr access to moving averages record object #897
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
vasco-santos
force-pushed
the
fix/conn-mgr-access-to-moving-averages-object
branch
from
30dda0e to
b993194
Compare
vasco-santos
force-pushed
the
fix/conn-mgr-access-to-moving-averages-object
branch
from
003b93b to
0cd432c
Compare
achingbrain
approved these changes
Mar 9, 2021
| @@ -27,7 +27,7 @@ jobs: | |||
| strategy: | |||
| matrix: | |||
| os: [windows-latest, ubuntu-latest, macos-latest] | |||
| node: [12, 14] | |||
| node: [14] | |||
There was a problem hiding this comment.
Suggested change
| node: [14] | |
| node: [14, 15] |
There was a problem hiding this comment.
15 is blocked by #857
| @@ -82,7 +82,7 @@ class Stats extends EventEmitter { | |||
| /** | |||
| * Returns a clone of the internal movingAverages | |||
| * | |||
| * @returns {MovingAverage} | |||
| * @returns {Object} | |||
| */ | |||
| get movingAverages () { | |||
| return Object.assign({}, this._movingAverages) | |||
There was a problem hiding this comment.
This is just a shallow clone, it doesn't prevent deep values being modified by the caller - if we care about that we should manually create a copy. If we don't we should just return this._movingAverages.
There was a problem hiding this comment.
I think we do not want to allow changes. I will create an issue for this
| @@ -82,7 +82,7 @@ class Stats extends EventEmitter { | |||
| /** | |||
| * Returns a clone of the internal movingAverages | |||
| * | |||
| * @returns {MovingAverage} | |||
| * @returns {Object} | |||
There was a problem hiding this comment.
Suggested change
| * @returns {Object} |
Maybe just let the compiler infer the return type? (see comment about shallow cloning below)
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.
This PR fixes the connection manager access to the
movingAveragesgetter. After the module update with types, this broke libp2p's build.It returns an Object as we can see on:
This object contains a key for the metric and another object as value to create multiple intervals for computing the move average:
movingAverages[key][interval].movingAverage()=> This is the actual MovingAverage instance.Metrics is not a public API and is not properly typed for now, the work is being tracked on #830 . We should probably change this from an Object to a Map and properly type these moving averages record, but just fixing the bug here.
Per #896 (comment)