Quality: Mutable internal state is exposed directly by logger#1769
Open
tuanaiseo wants to merge 1 commit into
Open
Conversation
…y by logg `ImportLogger.getLogs()` returns the backing `_logs` array directly, allowing callers to mutate internal state (e.g. `push`, `splice`, clearing logs) and break encapsulation. Affected files: importLogger.ts Signed-off-by: tuanaiseo <221258316+tuanaiseo@users.noreply.github.com>
DetachHead
reviewed
Apr 7, 2026
|
|
||
| getLogs() { | ||
| return this._logs; | ||
| return [...this._logs]; |
Owner
There was a problem hiding this comment.
we should avoid copying the array at runtime which could potentially impact performance by just widening the return type to readonly string[] instead. this also prevents the returned list from being mutated, which shouldn't be allowed either
getLogs(): readonly string[] {
return this._logs;
}
}
Contributor
|
According to mypy_primer, this change doesn't affect type check results on a corpus of open source code. ✅ |
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
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.
Problem
ImportLogger.getLogs()returns the backing_logsarray directly, allowing callers to mutate internal state (e.g.push,splice, clearing logs) and break encapsulation.Severity:
mediumFile:
packages/pyright-internal/src/analyzer/importLogger.tsSolution
Return a defensive copy (
return [...this._logs]) or a readonly view (ReadonlyArray<string>) to prevent external mutation.Changes
packages/pyright-internal/src/analyzer/importLogger.ts(modified)Testing