AF-3589 Dart 2 migration guide #210

evanweible-wf · 2018-12-14T23:53:29Z

Ultimate problem:

Documentation around the migration from Dart 1 to Dart 2 is needed

How it was fixed:

Added it!

TODO

Release version of over_react that updates transformer to be compatible with the transitionary boilerplate (AF-1916 AF-1850 Make over_react compatible with our Dart2 transition plan #208)
Release Dart 2-compatible version
Make over_react_codemod OSS

Testing suggestions:

N/a, docs only

Potential areas of regression:

N/a, docs only

FYA: @greglittlefield-wf @aaronlademann-wf @kealjones-wk @corwinsheahan-wf
@sebastianmalysa-wf @robbecker-wf

aviary3-wk · 2018-12-14T23:53:46Z

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.

codecov-io · 2018-12-14T23:59:09Z

Codecov Report

Merging #210 into master will increase coverage by 0.87%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #210      +/-   ##
==========================================
+ Coverage   95.87%   96.74%   +0.87%     
==========================================
  Files          34       35       +1     
  Lines        1669     2570     +901     
==========================================
+ Hits         1600     2486     +886     
- Misses         69       84      +15

robbecker-wf

Looks great!

corwinsheahan-wf

Just some small things. This is really well done and comprehensive!

corwinsheahan-wf · 2018-12-17T15:52:42Z

doc/dart2_migration.md

+similar) functionality provided by the Dart 1 transformer, but in the form of a
+Dart 2-compatible builder. This process is not as straightforward as it may
+seem, unfortunately, because the set of limitations imposed by the builder
+pattern is more restrictive than with transformers (for good reason). In


#nit We should link to a resource which explains why this is "for good reason" (or briefly explain). It probably won't be immediately obvious why this is the case

Had the same thought this morning, I'll try to find a relevant blog post or readme from the dart team

corwinsheahan-wf · 2018-12-17T16:02:13Z

doc/dart2_migration.md

+ UiFactory<FooProps> Foo = $Foo;
+```
+
+In this example, `$Foo` would be generated by the builder.


#nit

Suggested change

In this example, `$Foo` would be generated by the builder.

In this example, the implementation for `$Foo` is generated by the over_react builder.

corwinsheahan-wf · 2018-12-17T17:02:31Z

doc/dart2_migration.md

+expected. Since the public version of the class is generated and includes the
+concrete getters and setters _as well_ as everything concrete that was defined
+in the `_$` version, you or someone else can simply extend it. No additional
+work by the builder required.


Suggested change

work by the builder required.

work by the builder is required.

It would be extended by another private version of whatever it is, right? Maybe we can show an example?

Consumers wishing to extend or implement a props/state class will extend from the publicly generated version, in their own private _$ prefixed sub class. Example:

// super_class.dart @Props() class _$SuperProps extends UiProps {...} // super_class.over_react.g.dart (generated) class SuperProps extends _$SuperProps { // concrete implementations of props accessors } // sub_class.dart @Props() class _$SubProps extends SuperProps {...} // sub_class.over_react.g.dart (generated) class SubProps extends _$SubProps { // concrete implementations of props accessors }

An example is a good idea, I'll add one.

corwinsheahan-wf · 2018-12-17T18:29:24Z

doc/dart2_migration.md

+these mixins that extend the consumer-defined version, the builder will generate
+a separate class that implements the consumer-defined mixin. This generated
+class will have concrete getters and setters implemented for all of the fields
+and any additional concrete methods, getters, and setters will be copied over.


Suggested change

and any additional concrete methods, getters, and setters will be copied over.

and any additional concrete methods, getters, and setters which are defined in the mixin will be copied over to the generated class.

corwinsheahan-wf · 2018-12-17T18:52:43Z

doc/dart2_migration.md

+Use our [`over_react_migrate_to_dart1_and_dart2` codemod script][orcm-dart1-to-dart1-and-dart2]
+to update your code to a state that is compatible with both the Dart 1
+transformer and the Dart 2 builder. _In this state, you will notice some extra
+boilerplate and comments. This will be cleaned up in the second step, but is


Suggested change

boilerplate and comments. This will be cleaned up in the second step, but is

boilerplate and comments. This will be cleaned up when the transition to dart 2 is completed and we can pull the plug on dart 1 compatibility, but is

georgelesica-wf · 2018-12-17T19:32:32Z

doc/dart2_migration.md

+2. Use our [`over_react_migrate_from_dart1_to_dart2` codemod script][orcm-dart1-to-dart2]
+   to automate the migration.
+
+If, however, you do need migrate your `over_react` code from Dart 1 to Dart 2


"need to migrate"

greglittlefield-wf

Looks great; nice job, @evanweible-wf!!

greglittlefield-wf · 2018-12-17T21:47:54Z

doc/dart2_migration.md

+- Initializing component factories
+- Generating component factory registrations
+- Replacing uninitialized props and state fields with concrete getters and
+  setters that map to the underlying, untyped `Map`s used by ReactJS.


#supernit this is the only line-item with a period

Suggested change

setters that map to the underlying, untyped `Map`s used by ReactJS.

setters that map to the underlying, untyped `Map`s used by ReactJS

evanweible-wf · 2018-12-18T00:26:42Z

@corwinsheahan-wf @greglittlefield-wf @georgelesica-wf comments addressed!

georgelesica-wf · 2018-12-18T15:25:02Z

+1

aaronlademann-wf

Awesome job @evanweible-wf!!!

robbecker-wf · 2018-12-28T17:05:11Z

doc/dart2_migration.md

@@ -255,14 +256,17 @@ props class for that component, use the following utility:

 ## Migration From Dart 1 to Dart 2

+> _The over_react codemod tool is in the process of being open-sourced, but
+> until then the links below will not be publicly accessible._


robbecker-wf · 2018-12-28T17:09:27Z

+1 LGTM Thanks for adding all the details about the transitional boilerplate!

robbecker-wf · 2018-12-28T17:21:28Z

@Workiva/release-management-p

Add Dart 2 migration guide.

fb60c46

evanweible-wf requested a review from a team as a code owner December 14, 2018 23:53

rmconsole-wf added the Merge Requirements Unmet label Dec 14, 2018

sebastianmalysa-wf approved these changes Dec 17, 2018

View reviewed changes

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Dec 17, 2018

robbecker-wf approved these changes Dec 17, 2018

View reviewed changes

corwinsheahan-wf approved these changes Dec 17, 2018

View reviewed changes

evanweible-wf added the dart2 PRs targeting our effort to get to Dart SDK 2.0 compatibility label Dec 17, 2018

georgelesica-wf reviewed Dec 17, 2018

View reviewed changes

greglittlefield-wf approved these changes Dec 17, 2018

View reviewed changes

Address review comments; add inheritance example.

8c620cf

rmconsole-wf added Merge Requirements Unmet and removed Merge Requirements Met labels Dec 17, 2018

evanweible-wf changed the title ~~Dart 2 migration guide~~ AF-3589 Dart 2 migration guide Dec 18, 2018

evanweible-wf mentioned this pull request Dec 18, 2018

AF-1916 AF-1850 Make over_react compatible with our Dart2 transition plan #208

Merged

corwinsheahan-wf approved these changes Dec 18, 2018

View reviewed changes

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Dec 18, 2018

aaronlademann-wf approved these changes Dec 20, 2018

View reviewed changes

evanweible-wf mentioned this pull request Dec 21, 2018

Version compatible issue after upgrading to Dart 2 #177

Closed

Add section about transitional boilerplate.

5fffec1

rmconsole-wf added Merge Requirements Unmet and removed Merge Requirements Met labels Dec 28, 2018

robbecker-wf reviewed Dec 28, 2018

View reviewed changes

Remove copy/pasted paragraph that isnt needed.

8f1e798

corwinsheahan-wf approved these changes Dec 28, 2018

View reviewed changes

rmconsole-wf added Merge Requirements Met and removed Merge Requirements Unmet labels Dec 28, 2018

rmconsole-wf added the RM Ready label Dec 28, 2018

rm-astro-wf merged commit 0617b4f into master Dec 28, 2018

rm-astro-wf deleted the dart2_migration_guide branch December 28, 2018 17:21

rmconsole-readonly-wk mentioned this pull request Jan 7, 2019

AF-3647 AF-3646 Release over_react 1.30.1 #221

Merged

evanweible-wf added this to the Dart 2 Compat milestone Jan 7, 2019

evanweible-wf modified the milestones: Dart 2 Compat, 2.0.0 (Dart 1 & 2 compatibility) Jan 30, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AF-3589 Dart 2 migration guide #210

AF-3589 Dart 2 migration guide #210

evanweible-wf commented Dec 14, 2018 •

edited

Loading

aviary3-wk commented Dec 14, 2018

codecov-io commented Dec 14, 2018 •

edited

Loading

robbecker-wf left a comment

corwinsheahan-wf left a comment

corwinsheahan-wf Dec 17, 2018

evanweible-wf Dec 17, 2018

corwinsheahan-wf Dec 17, 2018

corwinsheahan-wf Dec 17, 2018

georgelesica-wf Dec 17, 2018

corwinsheahan-wf Dec 17, 2018 •

edited

Loading

evanweible-wf Dec 17, 2018

corwinsheahan-wf Dec 17, 2018

corwinsheahan-wf Dec 17, 2018

georgelesica-wf Dec 17, 2018

greglittlefield-wf left a comment

greglittlefield-wf Dec 17, 2018

evanweible-wf commented Dec 18, 2018

georgelesica-wf commented Dec 18, 2018

aaronlademann-wf left a comment

robbecker-wf Dec 28, 2018

robbecker-wf commented Dec 28, 2018

robbecker-wf commented Dec 28, 2018

	In this example, `$Foo` would be generated by the builder.
	In this example, the implementation for `$Foo` is generated by the over_react builder.

	work by the builder required.
	work by the builder is required.

	and any additional concrete methods, getters, and setters will be copied over.
	and any additional concrete methods, getters, and setters which are defined in the mixin will be copied over to the generated class.

	boilerplate and comments. This will be cleaned up in the second step, but is
	boilerplate and comments. This will be cleaned up when the transition to dart 2 is completed and we can pull the plug on dart 1 compatibility, but is

	setters that map to the underlying, untyped `Map`s used by ReactJS.
	setters that map to the underlying, untyped `Map`s used by ReactJS

AF-3589 Dart 2 migration guide #210

AF-3589 Dart 2 migration guide #210

Conversation

evanweible-wf commented Dec 14, 2018 • edited Loading

Ultimate problem:

How it was fixed:

TODO

Testing suggestions:

Potential areas of regression:

aviary3-wk commented Dec 14, 2018

Security Insights

Action Items

codecov-io commented Dec 14, 2018 • edited Loading

Codecov Report

robbecker-wf left a comment

Choose a reason for hiding this comment

corwinsheahan-wf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

corwinsheahan-wf Dec 17, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

greglittlefield-wf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evanweible-wf commented Dec 18, 2018

georgelesica-wf commented Dec 18, 2018

aaronlademann-wf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robbecker-wf commented Dec 28, 2018

robbecker-wf commented Dec 28, 2018

evanweible-wf commented Dec 14, 2018 •

edited

Loading

codecov-io commented Dec 14, 2018 •

edited

Loading

corwinsheahan-wf Dec 17, 2018 •

edited

Loading