Skip to content

Commit

Permalink
Failure to construct ErrorWidget for build errors does not destroy tr…
Browse files Browse the repository at this point in the history
…ee (#117090)
  • Loading branch information
goderbauer authored Dec 14, 2022
1 parent 7b19b4d commit dbc9306
Show file tree
Hide file tree
Showing 2 changed files with 101 additions and 6 deletions.
15 changes: 9 additions & 6 deletions packages/flutter/lib/src/widgets/framework.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4711,12 +4711,15 @@ abstract class Element extends DiagnosticableTree implements BuildContext {
owner!._debugCurrentBuildTarget = this;
return true;
}());
performRebuild();
assert(() {
assert(owner!._debugCurrentBuildTarget == this);
owner!._debugCurrentBuildTarget = debugPreviousBuildTarget;
return true;
}());
try {
performRebuild();
} finally {
assert(() {
assert(owner!._debugCurrentBuildTarget == this);
owner!._debugCurrentBuildTarget = debugPreviousBuildTarget;
return true;
}());
}
assert(!_dirty);
}

Expand Down
92 changes: 92 additions & 0 deletions packages/flutter/test/widgets/error_widget_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';

void main() {
testWidgets('ErrorWidget displays actual error when throwing during build', (WidgetTester tester) async {
final Key container = UniqueKey();
const String errorText = 'Oh no, there was a crash!!1';

await tester.pumpWidget(
Container(
key: container,
color: Colors.red,
padding: const EdgeInsets.all(10),
child: Builder(
builder: (BuildContext context) {
throw UnsupportedError(errorText);
},
),
),
);

expect(
tester.takeException(),
isA<UnsupportedError>().having((UnsupportedError error) => error.message, 'message', contains(errorText)),
);

final ErrorWidget errorWidget = tester.widget(find.byType(ErrorWidget));
expect(errorWidget.message, contains(errorText));

// Failure in one widget shouldn't ripple through the entire tree and effect
// ancestors. Those should still be in the tree.
expect(find.byKey(container), findsOneWidget);
});

testWidgets('when constructing an ErrorWidget due to a build failure throws an error, fail gracefully', (WidgetTester tester) async {
final Key container = UniqueKey();
await tester.pumpWidget(
Container(
key: container,
color: Colors.red,
padding: const EdgeInsets.all(10),
// This widget throws during build, which causes the construction of an
// ErrorWidget with the build error. However, during construction of
// that ErrorWidget, another error is thrown.
child: const MyDoubleThrowingWidget(),
),
);

expect(
tester.takeException(),
isA<UnsupportedError>().having((UnsupportedError error) => error.message, 'message', contains(MyThrowingElement.debugFillPropertiesErrorMessage)),
);

final ErrorWidget errorWidget = tester.widget(find.byType(ErrorWidget));
expect(errorWidget.message, contains(MyThrowingElement.debugFillPropertiesErrorMessage));

// Failure in one widget shouldn't ripple through the entire tree and effect
// ancestors. Those should still be in the tree.
expect(find.byKey(container), findsOneWidget);
});
}

// This widget throws during its regular build and then again when the
// ErrorWidget is constructed, which calls MyThrowingElement.debugFillProperties.
class MyDoubleThrowingWidget extends StatelessWidget {
const MyDoubleThrowingWidget({super.key});

@override
StatelessElement createElement() => MyThrowingElement(this);

@override
Widget build(BuildContext context) {
throw UnsupportedError('You cannot build me!');
}
}

class MyThrowingElement extends StatelessElement {
MyThrowingElement(super.widget);

static const String debugFillPropertiesErrorMessage = 'Crash during debugFillProperties';

@override
void debugFillProperties(DiagnosticPropertiesBuilder properties) {
super.debugFillProperties(properties);
throw UnsupportedError(debugFillPropertiesErrorMessage);
}
}

0 comments on commit dbc9306

Please sign in to comment.