OutFiles: use singleton instance instead of static fields
#6266
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
…ttings To preserve binary compatibility, these changes were made: * Added a new (inner) class `OutFiles1` to hold the non-static final fields * Deprecate the static final fields * Forward all deprected fields to their new definitions
lefou
changed the title
OutFiles: use static singleton instance instead of static fields
lefou
changed the title
OutFiles: use static singleton instance instead of static fieldsOutFiles: use singleton instance instead of static fields
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Deprecate all static final fields of
OutFilesand define those values in non-static final fields inside a singleton.The Problem
Constants that might change in subsequent releases or even between subseqent runs of Mill should not be hold by
static finalfields in Java.Since the compiler is allowed to inline those fields in their call sites, downstream bytecode may use stale values. This often happens unnoticed, but it can lead to incorrect behavior and hard to diagnose error. The probably worst case for a build tools like Mill is that we produce and publish incorrect artifacts which goes unnoticed. (E.g. if a stale value for the
outpath is used, some task might collect the wrong files.)Instead, we should either use methods (which results in more boilerplate) or non-static fields.
Impact
I choose the same name
OutFilesfor the inner singleton accessor, so that all callsite look identical, except the different import. The import changes frommill.constants.OutFilestomill.constants.OutFiles.OutFiles.To preserve binary compatibility, these changes were made:
OutFiles1to hold the non-static final fields