CPLAT-9205 Codemod for New Boilerplate

[sydneyjodon-wk]

Motivation

New over_react component boilerplate is coming soon, and our consumers deserve an easy way to make use of it!

Changes

• A migrator that acts on simple @Props() / @State() classes
  (CPLAT-9406 Create Simple Props / State Boilerplate Migrator #73)
• A migrator that acts on @Props() / @State() classes with advanced inheritance
  (CPLAT-9407 Add Advanced Props Migrator #76, Use utility class to contain map of converted classNames #79, CPLAT-9565 Address edge cases for boilerplate codemods #81, CPLAT-9677 Improve class migration short-circuit logic + consumer communication #82)
• A migrator that acts on standalone @PropsMixin() / @StateMixin() classes
  (CPLAT-9411 Add standalone PropsMixin / StateMixin migrator #77)
• A migrator that removes the public (un-prefixed) "companion" classes
  (CPLAT-9409 Remove props/state “companion” classes as part of the boilerplate update #75)
• Utilities to determine if a class is public API before performing a migration
  (CPLAT-9308 Codemod Utility to tell if Something is Public API #74, CPLAT-9576 Consume SemverHelper #80, Final cleanup for new boilerplate codemod #83)
• A migrator that removes @Props, @State(), @PropsMixin(), @StateMixin(), @Factory() and @Component2() annotations that are not required by the new boilerplate
  (CPLAT-9412 Add annotation remover #78)

Release Notes

Add codemod to assist over_react consumers in their migration to the new boilerplate changes.

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review:

QA Checklist

• Tests were updated and provide good coverage of the changeset and other affected code
• Manual testing was performed if needed
  • Steps from PR author:
    • Run the boilerplate codemod on web_skin_dart and verify that the codemod updates props and state classes as expected.
      • pub global run over_react_codemod:boilerplate_upgrade
  • Anything falling under manual testing criteria outlined in CONTRIBUTING.md

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

• A Client Platform member has reviewed these changes
• There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
• For release PRs - Version metadata in Rosie comment is correct

[aviary3-wk]

Security Insights

No security relevant content was detected by automated scans.

Action Items

• Review PR for security impact; comment "security review required" if needed or unsure
• Verify aviary.yaml coverage of security relevant code

---

Questions or Comments? Reach out on Slack: #support-infosec.

[greglittlefield-wf]

If the ignore comment is at the end of a line, it'll get applied to this line, and not the subsequent line.

So, in this case, $UnconvertedMixin would still have an analysis error.

We need this comment to be on its own line:

Suggested change

	// ignore: mixin_of_non_class, undefined_clas
	with ${publicPropsClassName}Mixin, ConvertedMixin, UnconvertedMixin,
	// ignore: mixin_of_non_class, undefined_class
	\$UnconvertedMixin;

Doesn't matter where the comment goes so long as it has one space of between it and the start of the line; dartfmt will handle it:

@Props()
class FooProps = UiProps with
 FooPropsMixinn,
 ConvertedMixin,
 UnconvertedMixin,
 // ignore: mixin_of_non_class, undefined_class
 $UnconvertedMixin;

Formatted

@Props()
class FooProps = UiProps
    with
        FooPropsMixinn,
        ConvertedMixin,
        UnconvertedMixin,
        // ignore: mixin_of_non_class, undefined_class
        $UnconvertedMixin;

[aaronlademann-wf]

+1 / QA +1

All changes were reviewed and tested in the individual PRs that merged into this integration branch (listed in the PR description).

Holistically tested via #80 as it was the last PR to go into integration.

[joebingham-wk]

+1

[joebingham-wk]

@Workiva/release-management-p

[rmconsole-wf]

+1 from RM