RM-59694 Release over_react 2.6.1+dart2 (Hotfix to update prop typedef to work around Dart 2.6 compiler regression (CPLAT-7898))

CHANGELOG.md

@@ -1,5 +1,14 @@
 # OverReact Changelog
 
+## 2.6.1
+
+> Complete `2.6.1` Changsets:
+>
+> - [Dart 2](https://github.com/Workiva/over_react/compare/2.6.0+dart2...2.6.1+dart2)
+> - Dart 1 (No Changes)
+
+* [#382] Update prop typedef to work around [Dart 2.6 compiler regression](https://github.com/dart-lang/sdk/issues/38880)
+
 ## 2.6.0
 
 > Complete `2.6.0` Changsets:

lib/src/component/prop_typedefs.dart

@@ -18,5 +18,8 @@ import 'package:over_react/over_react.dart';
 import 'package:over_react/src/component_declaration/component_base.dart' as component_base;
 import 'package:react/react_client.dart';
 
-/// A typedef for props that allow a custom rendering function to be provided to render some part of a component.
-typedef ReactElement CustomRenderFunction<TProps extends UiProps, TState extends UiState, TComponent extends component_base.UiComponent<TProps>> (TProps props, TState state, TComponent component);
+/// A custom rendering prop typedef that allows a custom rendering function to be provided
+/// with the current [props] and [state] of the [component].
+typedef ReactElement CustomRenderFunction<T extends UiProps,
+                                          S extends UiState,
+                                          C extends component_base.UiComponent> (T props, S state, C component);

pubspec.yaml

@@ -1,5 +1,5 @@
 name: over_react
-version: 2.6.0+dart2
+version: 2.6.1+dart2
 description: A library for building statically-typed React UI components using Dart.
 homepage: https://github.com/Workiva/over_react/
 authors:

test/over_react/component/fixtures/prop_typedef_fixtures.dart

@@ -0,0 +1,11 @@
+library prop_tyepdef_test_fixtures;
+
+import 'package:over_react/over_react.dart';
+
+part 'prop_typedef_fixtures/abstract_component_with_custom_render_prop.dart';
+part 'prop_typedef_fixtures/component_consuming_abstract_custom_render_prop.dart';
+part 'prop_typedef_fixtures/component_consuming_custom_render_prop.dart';
+part 'prop_typedef_fixtures/component_extending_from_abstract_component_with_custom_render_prop.dart';
+part 'prop_typedef_fixtures/component_with_custom_render_prop.dart';
+
+part 'prop_typedef_fixtures.over_react.g.dart';

test/over_react/component/fixtures/prop_typedef_fixtures/abstract_component_with_custom_render_prop.dart

@@ -0,0 +1,35 @@
+// Copyright 2019 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+part of prop_tyepdef_test_fixtures;
+
+@AbstractProps()
+abstract class _$TestAbstractCustomRendererComponentProps extends UiProps {
+  CustomRenderFunction customRenderer;
+  CustomRenderFunction<TestAbstractCustomRendererComponentProps,
+                       TestAbstractCustomRendererComponentState,
+                       TestAbstractCustomRendererComponentComponent> parameterizedCustomRenderer;
+
+  String somePropKey;
+}
+
+@AbstractState()
+abstract class _$TestAbstractCustomRendererComponentState extends UiState {
+  String someStateKey;
+}
+
+@AbstractComponent()
+abstract class TestAbstractCustomRendererComponentComponent<T extends TestAbstractCustomRendererComponentProps,
+                                                            S extends TestAbstractCustomRendererComponentState>
+    extends UiStatefulComponent<T, S> {}

test/over_react/component/fixtures/prop_typedef_fixtures/component_consuming_abstract_custom_render_prop.dart

@@ -0,0 +1,55 @@
+// Copyright 2019 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// ignore_for_file: avoid_as
+
+part of prop_tyepdef_test_fixtures;
+
+@Factory()
+UiFactory<TestConsumingAbstractCustomRendererComponentProps> TestConsumingAbstractCustomRendererComponent =
+    _$TestConsumingAbstractCustomRendererComponent;
+
+@Props()
+class _$TestConsumingAbstractCustomRendererComponentProps extends UiProps {
+  String propKeyValueToTest;
+  String stateKeyValueToTest;
+}
+
+@Component()
+class TestConsumingAbstractCustomRendererComponentComponent
+    extends UiComponent<TestConsumingAbstractCustomRendererComponentProps> {
+  @override
+  render() {
+    return (TestCustomRendererFromAbstractComponent()
+      ..somePropKey = props.propKeyValueToTest
+      ..someInitialStateKeyValue = props.stateKeyValueToTest
+      ..customRenderer = (props, state, component) {
+        return (Dom.div()
+          ..addTestId('customRendererContainer')
+        )(
+          'props.somePropKey: ${(props as TestCustomRendererFromAbstractComponentProps).somePropKey} \n'
+          'props.someStateKey: ${(state as TestCustomRendererFromAbstractComponentState).someStateKey}'
+        );
+      }
+      ..parameterizedCustomRenderer = (props, state, component) {
+        return (Dom.div()
+          ..addTestId('parameterizedCustomRendererContainer')
+        )(
+          'props.somePropKey: ${props.somePropKey} \n'
+          'props.someStateKey: ${state.someStateKey}'
+        );
+      }
+    )();
+  }
+}

test/over_react/component/fixtures/prop_typedef_fixtures/component_consuming_custom_render_prop.dart

@@ -0,0 +1,54 @@
+// Copyright 2019 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// ignore_for_file: avoid_as
+
+part of prop_tyepdef_test_fixtures;
+
+@Factory()
+UiFactory<TestConsumingCustomRendererComponentProps> TestConsumingCustomRendererComponent =
+    _$TestConsumingCustomRendererComponent;
+
+@Props()
+class _$TestConsumingCustomRendererComponentProps extends UiProps {
+  String propKeyValueToTest;
+  String stateKeyValueToTest;
+}
+
+@Component()
+class TestConsumingCustomRendererComponentComponent extends UiComponent<TestConsumingCustomRendererComponentProps> {
+  @override
+  render() {
+    return (TestCustomRendererComponent()
+      ..somePropKey = props.propKeyValueToTest
+      ..someInitialStateKeyValue = props.stateKeyValueToTest
+      ..customRenderer = (props, state, component) {
+        return (Dom.div()
+          ..addTestId('customRendererContainer')
+        )(
+          'props.somePropKey: ${(props as TestCustomRendererComponentProps).somePropKey} \n'
+          'props.someStateKey: ${(state as TestCustomRendererComponentState).someStateKey}'
+        );
+      }
+      ..parameterizedCustomRenderer = (props, state, component) {
+        return (Dom.div()
+          ..addTestId('parameterizedCustomRendererContainer')
+        )(
+          'props.somePropKey: ${props.somePropKey} \n'
+          'props.someStateKey: ${state.someStateKey}'
+        );
+      }
+    )();
+  }
+}

test/over_react/component/fixtures/prop_typedef_fixtures/component_extending_from_abstract_component_with_custom_render_prop.dart

@@ -0,0 +1,43 @@
+// Copyright 2019 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+part of prop_tyepdef_test_fixtures;
+
+@Factory()
+UiFactory<TestCustomRendererFromAbstractComponentProps> TestCustomRendererFromAbstractComponent =
+    _$TestCustomRendererFromAbstractComponent;
+
+@Props()
+class _$TestCustomRendererFromAbstractComponentProps extends TestAbstractCustomRendererComponentProps {
+  String someInitialStateKeyValue;
+}
+
+@State()
+class _$TestCustomRendererFromAbstractComponentState extends TestAbstractCustomRendererComponentState {}
+
+@Component()
+class TestCustomRendererFromAbstractComponentComponent
+    extends TestAbstractCustomRendererComponentComponent<TestCustomRendererFromAbstractComponentProps,
+                                                         TestCustomRendererFromAbstractComponentState> {
+  @override
+  Map getInitialState() => (newState()..someStateKey = props.someInitialStateKeyValue);
+
+  @override
+  render() {
+    return Dom.div()(
+      props.customRenderer(props, state, this),
+      props.parameterizedCustomRenderer(props, state, this),
+    );
+  }
+}

test/over_react/component/fixtures/prop_typedef_fixtures/component_with_custom_render_prop.dart

@@ -0,0 +1,48 @@
+// Copyright 2019 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+part of prop_tyepdef_test_fixtures;
+
+@Factory()
+UiFactory<TestCustomRendererComponentProps> TestCustomRendererComponent = _$TestCustomRendererComponent;
+
+@Props()
+class _$TestCustomRendererComponentProps extends UiProps {
+  CustomRenderFunction customRenderer;
+  CustomRenderFunction<TestCustomRendererComponentProps,
+                       TestCustomRendererComponentState,
+                       TestCustomRendererComponentComponent> parameterizedCustomRenderer;
+  String somePropKey;
+  String someInitialStateKeyValue;
+}
+
+@State()
+class _$TestCustomRendererComponentState extends UiState {
+  String someStateKey;
+}
+
+@Component()
+class TestCustomRendererComponentComponent
+    extends UiStatefulComponent<TestCustomRendererComponentProps, TestCustomRendererComponentState> {
+  @override
+  Map getInitialState() => (newState()..someStateKey = props.someInitialStateKeyValue);
+
+  @override
+  render() {
+    return Dom.div()(
+      props.customRenderer(props, state, this),
+      props.parameterizedCustomRenderer(props, state, this),
+    );
+  }
+}

test/over_react/component/prop_typedefs_test.dart

@@ -0,0 +1,59 @@
+// Copyright 2019 Workiva Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+@TestOn('browser')
+library prop_typedefs_test.dart;
+
+import 'package:test/test.dart';
+import 'package:over_react_test/over_react_test.dart';
+import './fixtures/prop_typedef_fixtures.dart';
+
+main() {
+  // Regression tests for https://github.com/dart-lang/sdk/issues/38880
+  group('CustomRenderFunction typedef', () {
+    TestJacket jacket;
+
+    tearDown(() {
+      jacket = null;
+    });
+
+    void sharedTest() {
+      final customRendererContainerNode =
+          queryByTestId(jacket.getInstance(), 'customRendererContainer');
+      expect(customRendererContainerNode, isNotNull, reason: 'test setup sanity check');
+      final parameterizedCustomRendererContainerNode =
+          queryByTestId(jacket.getInstance(), 'parameterizedCustomRendererContainer');
+      expect(parameterizedCustomRendererContainerNode, isNotNull, reason: 'test setup sanity check');
+
+      expect(customRendererContainerNode.text, 'props.somePropKey: foo \nprops.someStateKey: bar');
+      expect(parameterizedCustomRendererContainerNode.text, 'props.somePropKey: foo \nprops.someStateKey: bar');
+    }
+
+    test('works as expected when the custom render prop is defined in a concrete class', () {
+      jacket = mount((TestConsumingCustomRendererComponent()
+        ..propKeyValueToTest = 'foo'
+        ..stateKeyValueToTest = 'bar'
+      )());
+      sharedTest();
+    });
+
+    test('works as expected when the custom render prop is defined in an abstract class', () {
+      jacket = mount((TestConsumingAbstractCustomRendererComponent()
+        ..propKeyValueToTest = 'foo'
+        ..stateKeyValueToTest = 'bar'
+      )());
+      sharedTest();
+    });
+  });
+}

test/over_react_component_test.dart

@@ -27,6 +27,7 @@ import 'over_react/component/abstract_transition_test.dart' as abstract_transiti
 import 'over_react/component/dom_components_test.dart' as dom_components_test;
 import 'over_react/component/error_boundary_test.dart' as error_boundary_test;
 import 'over_react/component/prop_mixins_test.dart' as prop_mixins_test;
+import 'over_react/component/prop_typedefs_test.dart' as prop_typedefs_test;
 import 'over_react/component/resize_sensor_test.dart' as resize_sensor_test;
 
 
@@ -39,5 +40,6 @@ void main() {
   error_boundary_test.main();
   dom_components_test.main();
   prop_mixins_test.main();
+  prop_typedefs_test.main();
   resize_sensor_test.main();
 }