Refactor global functions/state into services #1843
Draft
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
matthewbastien
changed the title
matthewbastien
force-pushed
the
swiftly-fixes
branch
from
cabf22f to
499004f
Compare
matthewbastien
changed the title
matthewbastien
added
the
full-test-run
matthewbastien
force-pushed
the
swiftly-fixes
branch
2 times, most recently
from
d906db6 to
ab1609a
Compare
matthewbastien
force-pushed
the
swiftly-fixes
branch
from
ab1609a to
0f539f0
Compare
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.
Description
I've been super frustrated with random bugs popping up in test cases where dependencies were either not mocked or the test ended up mocking more than it should causing unexpected behavior. It's also really difficult to know exactly what you need to mock when a piece of code is using global functions from
"utilities.ts", static methods fromSwiftToolchain, etc.As a first step towards removing non-essential global state, I've started creating several services that can be included as dependencies to various parts of the extension:
FileSystem: for anything using Node'sfsmodule.Environment: for anything related to Nodeprocessoros.Shell: for anything related to Nodechild_process.ToolchainService: methods that create or work withSwiftToolchain.Swiftly: for working with Swiftly to use and install toolchains.These changes allow us to just use
mockObject()and make it obvious what dependencies something has.Tasks
[ ] Documentation has been updated[ ] Added an entry to CHANGELOG.md if applicable