CPLAT-6056: Warn consumers if part directive is present but there's no generated output #302
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
Security InsightsNo security relevant content was detected by automated scans. Action Items
Questions or Comments? Reach out on Slack: #support-infosec. |
corwinsheahan-wf
changed the title
corwinsheahan-wf
changed the title
corwinsheahan-wf
changed the title
| @@ -90,6 +90,26 @@ main() { | |||
| reason: 'Expected a WARNING log for the missing over_react part.'); | |||
| }); | |||
|
|
|||
| test('warns if .over_react.g.dart part directive is present and no delcarations are present, but no code is generated', () async { | |||
There was a problem hiding this comment.
#typo: "delcarations" -> "declarations"
lib/src/builder/builder.dart
Outdated
| log.warning('Missing "part \'$expectedPart\';".'); | ||
| } | ||
|
|
||
| await _writePart(buildStep, outputId, outputs); | ||
| } else { | ||
| if (hasOutputPartDirective()) { | ||
| log.warning('An over react part directive was found in ${buildStep.inputId.path}, but no code was generated.'); |
There was a problem hiding this comment.
It might be good to indicate potential causes of this so that the user can attempt to correct them. (E.g., "The part directive may be unnecessary if the file does not contain any concrete components.")
evanweible-wf
approved these changes
Jun 10, 2019
Co-Authored-By: Evan Weible <[email protected]>
Co-Authored-By: Evan Weible <[email protected]>
…eact into warn_missing_gen_has_part
seanburke-wf
approved these changes
Jun 10, 2019
evanweible-wf
approved these changes
Jun 11, 2019
|
QA +1
|
greglittlefield-wf
approved these changes
Jun 11, 2019
|
@Workiva/release-management-p |
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.
Motivation
In cases where an
.over_react.g.dartpart directive are included in a file where there are no generations, the consumer doesn't get any error or warning messages from this builder.Changes
Log a warning when a part directive exists, but there is no output.
Release Notes
Review
See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.
Please review: @greglittlefield-wf @aaronlademann-wf @seanburke-wf
QA Checklist
Merge Checklist
While we perform many automated checks before auto-merging, some manual checks are needed: