Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support overriding ErrorWidget.builder #6302

Merged
merged 6 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/rfw/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,6 @@ build/
!**/ios/**/default.mode2v3
!**/ios/**/default.pbxuser
!**/ios/**/default.perspectivev3

# Coverage
coverage/
3 changes: 3 additions & 0 deletions packages/rfw/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 1.0.26
* Supports overriding the error widget builder.

## 1.0.25
* Adds support for wildget builders.

Expand Down
9 changes: 5 additions & 4 deletions packages/rfw/lib/src/flutter/runtime.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1559,11 +1559,12 @@ class _Subscription {
}
}

ErrorWidget _buildErrorWidget(String message) {
FlutterError.reportError(FlutterErrorDetails(
Widget _buildErrorWidget(String message) {
final FlutterErrorDetails detail = FlutterErrorDetails(
exception: message,
stack: StackTrace.current,
library: 'Remote Flutter Widgets',
));
return ErrorWidget(message);
);
FlutterError.reportError(detail);
return ErrorWidget.builder(detail);
}
2 changes: 1 addition & 1 deletion packages/rfw/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: rfw
description: "Remote Flutter widgets: a library for rendering declarative widget description files at runtime."
repository: https://github.com/flutter/packages/tree/main/packages/rfw
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+rfw%22
version: 1.0.25
version: 1.0.26

environment:
sdk: ^3.2.0
Expand Down
32 changes: 27 additions & 5 deletions packages/rfw/test/runtime_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ void main() {
),
);
expect(tester.takeException().toString(), contains('Could not find remote widget named'));
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, 'Could not find remote widget named widget in a, possibly because some dependencies were missing: b');
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, contains('Could not find remote widget named widget in a, possibly because some dependencies were missing: b'));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why "contains"? what else does it contain?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The _defaultErrorWidgetBuilder also adds "\nSee also: https://flutter.dev/docs/testing/errors" to the error message.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see. Looks like that's only included in debug builds. That's probably fine.

});

testWidgets('Missing libraries in specified widget', (WidgetTester tester) async {
Expand All @@ -258,7 +258,7 @@ void main() {
),
);
expect(tester.takeException().toString(), contains('Could not find remote widget named'));
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, 'Could not find remote widget named widget in a, possibly because some dependencies were missing: a');
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, contains('Could not find remote widget named widget in a, possibly because some dependencies were missing: a'));
});

testWidgets('Missing libraries in import via dependency', (WidgetTester tester) async {
Expand All @@ -276,7 +276,7 @@ void main() {
),
);
expect(tester.takeException().toString(), contains('Could not find remote widget named'));
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, 'Could not find remote widget named test in a, possibly because some dependencies were missing: b');
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, contains('Could not find remote widget named test in a, possibly because some dependencies were missing: b'));
});

testWidgets('Missing widget', (WidgetTester tester) async {
Expand All @@ -291,7 +291,7 @@ void main() {
),
);
expect(tester.takeException().toString(), contains('Could not find remote widget named'));
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, 'Could not find remote widget named widget in a.');
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, contains('Could not find remote widget named widget in a.'));
});

testWidgets('Runtime', (WidgetTester tester) async {
Expand Down Expand Up @@ -1152,7 +1152,29 @@ void main() {

expect(tester.takeException().toString(), contains(expectedErrorMessage));
expect(find.byType(ErrorWidget), findsOneWidget);
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, expectedErrorMessage);
expect(tester.widget<ErrorWidget>(find.byType(ErrorWidget)).message, contains(expectedErrorMessage));
});


testWidgets('Customized error widget', (WidgetTester tester) async {
final ErrorWidgetBuilder oldBuilder = ErrorWidget.builder;
ErrorWidget.builder = (FlutterErrorDetails details) {
return const Text('oopsie!', textDirection: TextDirection.ltr);
};
final Runtime runtime = Runtime()
..update(const LibraryName(<String>['a']), parseLibraryFile(''));
final DynamicContent data = DynamicContent();
await tester.pumpWidget(
RemoteWidget(
runtime: runtime,
data: data,
widget: const FullyQualifiedWidgetName(LibraryName(<String>['a']), 'widget'),
),
);
expect(tester.takeException().toString(), contains('Could not find remote widget named'));
expect(find.text('oopsie!'), findsOneWidget);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should probably also check that you can't find an ErrorWidget.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

expect(find.byType(ErrorWidget), findsNothing);
ErrorWidget.builder = oldBuilder;
});

testWidgets('Widget builders - work when scope is not used', (WidgetTester tester) async {
Expand Down