Make SnapController.add() private
#883
Merged
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
Mrtenz
reviewed
Oct 28, 2022
| @@ -1780,7 +1766,7 @@ export class SnapController extends BaseController< | |||
| * version. | |||
| * @returns The resulting snap object. | |||
| */ | |||
| async add(args: AddSnapArgs): Promise<PersistedSnap> { | |||
| private async _add(args: AddSnapArgs): Promise<PersistedSnap> { | |||
There was a problem hiding this comment.
Should we truly make it private?
Suggested change
| private async _add(args: AddSnapArgs): Promise<PersistedSnap> { | |
| async #add(args: AddSnapArgs): Promise<PersistedSnap> { |
There was a problem hiding this comment.
While we're at it, I really dislike having _ in names in general, I think the SnapController is the only place we do it. Might as well just make them normal names but have a private modifier.
There was a problem hiding this comment.
@Mrtenz Probably, but that would require more test refactoring than I am strictly willing to tackle right now 😅
There was a problem hiding this comment.
@ritave Yeah that's a good point, we can address that in a follow-up.
|
Feel free to merge upon approval. |
FrederikBolding
force-pushed
the
make-SnapController.add-private
branch
from
2fb2676
to
7232f27
Compare
FrederikBolding
approved these changes
Oct 31, 2022
Mrtenz
approved these changes
Oct 31, 2022
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 turns
SnapController.add()into a private method_add()and removes its associated action. Due to the extensive use of this method in tests, a newSnapControllerpersisted state factory is added to our test utilities and used instead ofadd(). Overall unit tests coverage has decreased slightly due to the removal of tested code.