FED-570 Unify package rename codemod #251

sydneyjodon-wk · 2023-10-12T23:42:36Z

Motivation

Codemod to migrate react_material_ui usages to unify_ui.

Changes

The codemod goes through the following process:

Updates bundle references to unify-ui
Runs UnifyRenameSuggestor:
- Updates mui namespace usages to unify (also updates the alpha versions)
- Renames any component or object usages that have new names in unify_ui
- Migrates WSD ButtonColor usages to WsdButtonColor
- Adds fixme comments for alerts, linearprogress, and badge
Updates imports
- Any special case imports where the paths are different
- Adds wsd.dart entrypoint imports as needed
- Removes any unused imports

Release Notes

Review

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

Please review:

QA Checklist

Merge Checklist

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

A Frontend Frameworks Design 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

# Conflicts: # lib/src/executables/mui_migration.dart # lib/src/mui_suggestors/unused_wsd_import_remover.dart # lib/src/util/importer.dart

aviary2-wf · 2023-10-12T23:43:51Z

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.

sydneyjodon-wk · 2023-10-17T22:22:12Z

lib/src/mui_suggestors/unused_wsd_import_remover.dart

This file was moved to the utils directory and generalized to take a package name argument

sydneyjodon-wk · 2023-10-17T22:27:48Z

lib/src/util/unused_import_remover.dart

This is the same file that I moved from the unused_wsd_importer file in the mui_suggestors - I don't know why GitHub doesn't think so

sydneyjodon-wk · 2023-10-30T22:51:02Z

ooo great catches @kealjones-wk - they were pretty straightforward fixes so I just went ahead and updated the codemod to address those! Thank you for catching those!

greglittlefield-wf

Just some #nits, really only one that would potentially be addressed.

Changes look good
Tests look good
Worked well when I tested it locally

+10

lib/src/unify_package_rename_suggestors/constants.dart

greglittlefield-wf · 2023-10-30T22:43:57Z

test/unify_package_rename_suggestors/unify_rename_suggestor_test.dart

+    import 'package:react_material_ui/react_material_ui.dart';
+
+    content() {
+      // FIXME(unify_package_rename) Check what theme provider is wrapping this component: if it is a UnifyThemeProvider, remove this FIXME - no action is required; otherwise, migrate this component back to Web Skin Dart.


#nit it looks like this fixme insertion isn't idempotent, but the idempotency tests are passing because on the second run, the unify. references are unresolved because the imports hadn't been updated.

I don't think this is worth fixing since it's so uncommon, but I thought I'd call it out.

Oh that's a good catch! Okay I'll keep that in mind and try not to re-run the codemod too much

greglittlefield-wf · 2023-10-30T22:51:32Z

test/unify_package_rename_suggestors/unify_rename_suggestor_test.dart

+  // (which is more common for the WSD context), it fails here instead of failing the first test.
+  setUpAll(resolvedContext.warmUpAnalysis);
+
+  group('UnifyRenameSuggestor', () {


#nit It makes me a bit nervous that we're not testing the import renaming and the usage renaming together, to ensure they're in sync with what they update.

But, I don't think we have an easy way of testing codemod sequences, and I don't think it'd be worth trying to set that up.

Perhaps if they were updated within the same suggestor, then that'd enable easier testing. But again, I'm not sure refactoring it would be worth it.

kealjones-wk

+10

greglittlefield-wf

+10 refresh

greglittlefield-wf · 2023-10-30T23:17:07Z

Merging once CI passes

@Workiva/release-management-p

kealjones-wk

one thing... might not matter...

kealjones-wk · 2023-10-30T23:21:30Z

lib/src/unify_package_rename_suggestors/import_renamer.dart

+          mainLibraryUnitResult.unit, mainLibraryUnitResult.lineInfo);
+      yield Patch(
+          insertInfo.leadingNewlines +
+              "import '${importInfo.uri}'${importInfo.namespace != null ? ' as ${importInfo.namespace}' : ''};" +


just throwing this out there that this doesnt seem to retain show statements

example:
import 'package:react_material_ui/styles/theme_provider.dart' as mui_theme show UnifyThemeProvider;

Ooh good catch! Yeah I think it'd be worth updating so this retains show and hide

kealjones-wk

+10

rmconsole-wf

+1 from RM

sydneyjodon-wk added 11 commits September 20, 2023 14:54

Add updator to rename mui namespace to unify in component usages

c3c8755

Add tests

c629b02

Add component renames

351db4f

Add FIXME comments

dab9ea6

Add updated namespace for wsd entrypoint

55fce19

Add ImportRenamer suggestor

e5f1cfc

Namespace updater attempt

b897413

Update importer suggestor

026c209

Add object renamer logic

a7e86ec

Add ButtonColor updates for WSD colors

3b90e49

Merge branch 'master' into FED-570-unify-package-rename

c18ca59

# Conflicts: # lib/src/executables/mui_migration.dart # lib/src/mui_suggestors/unused_wsd_import_remover.dart # lib/src/util/importer.dart

rmconsole-wf added the Merge Requirements Unmet label Oct 12, 2023

rmconsole-wf added the Skynet 2.0 Failed label Oct 12, 2023

Do some clean up

fcdef76

rmconsole-wf removed the Skynet 2.0 Failed label Oct 13, 2023

sydneyjodon-wk added 5 commits October 17, 2023 15:05

Do some more clean up

0c8e1cb

More clean up

1ce7068

Try to fix diff

ad9a1d6

Try to fix diff

b2d70f7

Try to fix diff

254c3c4

sydneyjodon-wk commented Oct 17, 2023

View reviewed changes

Format

bd6e194

sydneyjodon-wk commented Oct 17, 2023

View reviewed changes

sydneyjodon-wk added 6 commits October 17, 2023 15:37

Update tests

1315278

Fix dep validator issue

b6af6c9

Try fixing test

5077b62

Try fixing test

0244d3a

Try fixing test

42d2f85

Remove fixme

20d7c9e

sydneyjodon-wk dismissed aaronlademann-wf’s stale review via dbc4af6 October 30, 2023 22:43

Fix Alert constant updates

dda4812

Format

cb67268

greglittlefield-wf previously approved these changes Oct 30, 2023

View reviewed changes

kealjones-wk previously approved these changes Oct 30, 2023

View reviewed changes

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Oct 30, 2023

Format

e1ff537

sydneyjodon-wk dismissed stale reviews from kealjones-wk and greglittlefield-wf via e1ff537 October 30, 2023 23:12

sydneyjodon-wk requested review from greglittlefield-wf and kealjones-wk October 30, 2023 23:12

rmconsole-wf added Merge Requirements Unmet and removed Merge Requirements Met labels Oct 30, 2023

greglittlefield-wf previously approved these changes Oct 30, 2023

View reviewed changes

kealjones-wk requested changes Oct 30, 2023

View reviewed changes

Fix show / hide import updates

80a9c4d

sydneyjodon-wk dismissed greglittlefield-wf’s stale review via 80a9c4d October 30, 2023 23:41

sydneyjodon-wk requested review from kealjones-wk and greglittlefield-wf October 30, 2023 23:41

rmconsole-wf added the RM Ready label Oct 30, 2023

kealjones-wk approved these changes Oct 31, 2023

View reviewed changes

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Oct 31, 2023

rmconsole-wf approved these changes Oct 31, 2023

View reviewed changes

rmconsole3-wf merged commit 60ae76b into master Oct 31, 2023
4 checks passed

rmconsole3-wf deleted the FED-570-unify-package-rename branch October 31, 2023 02:14

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

RM-220915 Release over_react_codemod 2.30.0 #269

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FED-570 Unify package rename codemod #251

FED-570 Unify package rename codemod #251

sydneyjodon-wk commented Oct 12, 2023 •

edited

Loading

aviary2-wf commented Oct 12, 2023

sydneyjodon-wk Oct 17, 2023

sydneyjodon-wk Oct 17, 2023 •

edited

Loading

sydneyjodon-wk commented Oct 30, 2023

greglittlefield-wf left a comment

greglittlefield-wf Oct 30, 2023

sydneyjodon-wk Oct 30, 2023

greglittlefield-wf Oct 30, 2023

kealjones-wk left a comment

greglittlefield-wf left a comment

greglittlefield-wf commented Oct 30, 2023

kealjones-wk left a comment

kealjones-wk Oct 30, 2023

greglittlefield-wf Oct 30, 2023

sydneyjodon-wk Oct 30, 2023

kealjones-wk left a comment

rmconsole-wf left a comment

FED-570 Unify package rename codemod #251

FED-570 Unify package rename codemod #251

Conversation

sydneyjodon-wk commented Oct 12, 2023 • edited Loading

Motivation

Changes

Release Notes

Review

QA Checklist

Merge Checklist

aviary2-wf commented Oct 12, 2023

Security Insights

Action Items

sydneyjodon-wk Oct 17, 2023

Choose a reason for hiding this comment

sydneyjodon-wk Oct 17, 2023 • edited Loading

Choose a reason for hiding this comment

sydneyjodon-wk commented Oct 30, 2023

greglittlefield-wf left a comment

Choose a reason for hiding this comment

greglittlefield-wf Oct 30, 2023

Choose a reason for hiding this comment

sydneyjodon-wk Oct 30, 2023

Choose a reason for hiding this comment

greglittlefield-wf Oct 30, 2023

Choose a reason for hiding this comment

kealjones-wk left a comment

Choose a reason for hiding this comment

greglittlefield-wf left a comment

Choose a reason for hiding this comment

greglittlefield-wf commented Oct 30, 2023

kealjones-wk left a comment

Choose a reason for hiding this comment

kealjones-wk Oct 30, 2023

Choose a reason for hiding this comment

greglittlefield-wf Oct 30, 2023

Choose a reason for hiding this comment

sydneyjodon-wk Oct 30, 2023

Choose a reason for hiding this comment

kealjones-wk left a comment

Choose a reason for hiding this comment

rmconsole-wf left a comment

Choose a reason for hiding this comment

sydneyjodon-wk commented Oct 12, 2023 •

edited

Loading

sydneyjodon-wk Oct 17, 2023 •

edited

Loading