Convert FakeClock to a struct. #71
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
This change ensures future modifications to FakeClock will not break users.
However, this change does break current users who use FakeClock as an argument,
return value, or embed it in a struct or interface.
With limtied exception, build errors can be fixed by running:
```
$ grep -rl 'clockwork.FakeClock' /path/to/code_base | \
xargs sed -i 's/clockwork.FakeClock/*clockwork.FakeClock/g'
```
Other errors and their fixes are:
- When returning a pointer to concrete type as a clockwork.FakeClock: return
the pointer to concrete type.
- When using FakeClock in an interface composition: relace with the functions
required by the interface.
- When using FakeClock as an argument, replace with concerete type or define a
new interface.
The anternative approach would have been to use type alaises. However, this
does not provide a benefit over direct replacement, because the migration is
more complicated, harder to execute, needs to be done to the same code points,
and results in runtime failures (whereas this approach can be complie-time
checked).
DPJacques
added
enhancement
release-note/breaking-change
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 change ensures future modifications to FakeClock will not break users.
However, this change does break current users who use FakeClock as an argument, return value, or embed it in a struct or interface.
With limtied exception, build errors can be fixed by running:
Other rare build errors and their fixes are:
clockwork.FakeClock: return the pointer to concrete type instead.clockwork.FakeClockin an interface composition: replace with the functions required by the interface.clockwork.FakeClockas an argument, replace with concrete type or define a new interface.The alternative approach would have been to use type aliases. However, this does not provide a benefit over direct replacement, because the migration is more complicated, harder to execute, needs to be done to the same code points, and results in runtime failures when type converting (whereas this approach only fails at compile-time).