FED-1919 Codemod to add required flux actions / store prop(s) #268

aaronlademann-wf · 2023-12-13T22:39:07Z

Motivation

The null safety over_react major release will make a breaking change in which FluxPropsMixin's store and actions props are required, so that they can be made non-nullable.

Making store required shouldn't affect most usages, but actions will definitely affect some consumers.

While the actions prop will be present in usages in most cases, there are usages that only wire up a component to redraw on the store, because the actions aren't used.

Changes

Create a RequiredFluxProps() codemod class that patches invoked and un-invoked builders that mix-in FluxUiPropsMixin when either the actions or store prop(s) are missing.
- Adds the missing setter with a null value unless an in-scope var with matching type is found.
- If an in-scope var is found with a matching type - that var is set as the value.
Write tests for all conceivable patch cases

QA

Verify the changes produced by this batch that executes this codemod.

FED-1919

aviary3-wk · 2023-12-13T22:40:21Z

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.

I didn’t touch these files.

to make this easier to read through / understand codemod flow

aaronlademann-wf · 2023-12-13T22:59:45Z

lib/src/dart3_suggestors/null_safety_prep/required_flux_props.dart

+
+bool _isFnComponentDeclaration(Expression? varInitializer) =>
+    varInitializer is MethodInvocation &&
+    varInitializer.methodName.name.startsWith('uiF');


Should account for both uiFunction and uiForwardRef

aaronlademann-wf · 2023-12-13T23:01:49Z

lib/src/intl_suggestors/intl_migrator.dart

        node.initializer != null &&
        node.initializer is SimpleStringLiteral) {
-      SimpleStringLiteral literal = node.initializer as SimpleStringLiteral;
+      SimpleStringLiteral literal = node.initializer! as SimpleStringLiteral;


There were lints causing CI failures in a few misc. files that are unrelated to the scope of this PR.

greglittlefield-wf

Made a pass at everything except tests; will take a look at those after lunch

lib/src/dart3_suggestors/null_safety_prep/required_flux_props.dart

greglittlefield-wf

Done with second pass, just a couple small comments on tests; overall looks great!

test/dart3_suggestors/null_safety_prep/required_flux_props_test.dart

Better support for function params and class fields

greglittlefield-wf

+1 with some #nits

lib/src/dart3_suggestors/null_safety_prep/required_flux_props.dart

greglittlefield-wf

Couple more comments after reviewing the test batch

lib/src/dart3_suggestors/null_safety_prep/required_flux_props.dart

by always setting missing stores to null See: #268 (comment)

greglittlefield-wf

+10

greglittlefield-wf · 2024-01-05T21:13:24Z

@Workiva/release-management-p

rmconsole-wf

+1 from RM

aaronlademann-wf added 10 commits December 1, 2023 15:09

Stub in RequiredFluxProps suggestor / test files

1e3f876

Begin work on visitor for required flux props

10de57d

FED-1919

Progress

c60beec

All but one test passing!

4bbc2ae

All tests passing

61ef7a9

Oops

c38224a

Add case for class / fn component props

e5e98b8

Cleanup

af15a8f

Create shared tests for both invoked / uninvoked

5234055

Bin wiring

d69dbbe

rmconsole-wf added the Merge Requirements Unmet label Dec 13, 2023

aaronlademann-wf added 2 commits December 13, 2023 15:41

Format

6ab4088

Fix lints

647457b

I didn’t touch these files.

aaronlademann-wf requested review from greglittlefield-wf and sydneyjodon-wk December 13, 2023 22:49

aaronlademann-wf added 2 commits December 13, 2023 15:54

Make large method a top-level fn

927991d

to make this easier to read through / understand codemod flow

Store in separate vars to improve readability

44b1e38

aaronlademann-wf commented Dec 13, 2023

View reviewed changes

aaronlademann-wf added 2 commits December 13, 2023 16:04

Improve test file readability

b7703be

Format

e60a936

aaronlademann-wf changed the title ~~FED-1919 Add codemod to add required flux actions / store prop(s)~~ FED-1919 Codemod to add required flux actions / store prop(s) Dec 13, 2023

greglittlefield-wf requested changes Dec 18, 2023

View reviewed changes

aaronlademann-wf added 5 commits December 19, 2023 09:45

Improve types

b2597ca

Match on actual type instead of type name

a57eec6

Match on actual type instead of type name

580b82c

Remove unnecessary base class

619910d

Improve approximation of in-scope vars, add tests

aea20f0

Better support for function params and class fields

aaronlademann-wf added 5 commits December 19, 2023 13:09

Don’t consider dynamic vars as possible values

942b8e2

Fix test description

d344edc

Don’t attempt to assign a var when store/actions are dynamic

2745fc9

Add executable

9ec4ec8

Add pub get

1bf39c4

greglittlefield-wf previously approved these changes Dec 19, 2023

View reviewed changes

Address CR feedback

d36a656

aaronlademann-wf dismissed greglittlefield-wf’s stale review via d36a656 December 19, 2023 22:11

aaronlademann-wf requested a review from greglittlefield-wf December 19, 2023 22:11

rmconsole-wf added Skynet 2.0 Failed and removed Skynet 2.0 Failed labels Dec 19, 2023

greglittlefield-wf approved these changes Dec 19, 2023

View reviewed changes

greglittlefield-wf requested changes Dec 21, 2023

View reviewed changes

lib/src/dart3_suggestors/null_safety_prep/required_flux_props.dart Outdated Show resolved Hide resolved

lib/src/dart3_suggestors/null_safety_prep/required_flux_props.dart Show resolved Hide resolved

lib/src/dart3_suggestors/null_safety_prep/required_flux_props.dart Show resolved Hide resolved

aaronlademann-wf added 4 commits January 4, 2024 13:52

Remove unused import

1d1a288

Avoid unintentional behavior change

e8300cb

by always setting missing stores to null See: #268 (comment)

Don’t assign vars with null values

a603afe

Ignore PanelTitle/PanelTitleV2

0f3a754

aaronlademann-wf requested a review from greglittlefield-wf January 4, 2024 21:39

greglittlefield-wf previously approved these changes Jan 4, 2024

View reviewed changes

Skip PanelToolbar as well

7798be7

aaronlademann-wf dismissed greglittlefield-wf’s stale review via 7798be7 January 5, 2024 20:12

greglittlefield-wf approved these changes Jan 5, 2024

View reviewed changes

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Jan 5, 2024

rmconsole-wf added the RM Ready label Jan 5, 2024

rmconsole-wf approved these changes Jan 5, 2024

View reviewed changes

rmconsole3-wf merged commit b4dbaad into master Jan 5, 2024

rmconsole3-wf deleted the batch/fedx/FED-1919_required_flux_actions branch January 5, 2024 21:13

rmconsole-readonly-wk mentioned this pull request Jan 5, 2024

RM-220915 Release over_react_codemod 2.30.0 #269

Merged

FED-1919 Codemod to add required flux actions / store prop(s) #268

FED-1919 Codemod to add required flux actions / store prop(s) #268

Uh oh!

Conversation

aaronlademann-wf commented Dec 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Changes

QA

Uh oh!

aviary3-wk commented Dec 13, 2023

Security Insights

Action Items

Uh oh!

aaronlademann-wf Dec 13, 2023

Choose a reason for hiding this comment

Uh oh!

aaronlademann-wf Dec 13, 2023

Choose a reason for hiding this comment

Uh oh!

greglittlefield-wf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greglittlefield-wf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greglittlefield-wf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greglittlefield-wf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

greglittlefield-wf left a comment

Choose a reason for hiding this comment

Uh oh!

greglittlefield-wf commented Jan 5, 2024

Uh oh!

rmconsole-wf left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

aaronlademann-wf commented Dec 13, 2023 •

edited

Loading