Repository navigation
Open
Labels
P3Issues that are less important to the Flutter projectIssues that are less important to the Flutter projecta: error messageError messages from the Flutter frameworkError messages from the Flutter frameworkfound in release: 3.19Found to occur in 3.19Found to occur in 3.19found in release: 3.22Found to occur in 3.22Found to occur in 3.22frameworkflutter/packages/flutter repository. See also f: labels.flutter/packages/flutter repository. See also f: labels.has reproducible stepsThe issue has been confirmed reproducible and is ready to work onThe issue has been confirmed reproducible and is ready to work onteam-frameworkOwned by Framework teamOwned by Framework teamtriaged-frameworkTriaged by Framework teamTriaged by Framework team
Description
Steps to reproduce
I have attached a sample code to reproduce the bug. Click the "crash me!" button twice. This issue seems to disappear when the layout builder is removed.
Expected results
The counter should increment without any crashes.
Actual results
A crash occurs.
Code sample
Code sample
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:go_router/go_router.dart';
final GlobalKey<NavigatorState> _rootNavigatorKey =
GlobalKey<NavigatorState>(debugLabel: 'root');
final GlobalKey<NavigatorState> _sectionANavigatorKey =
GlobalKey<NavigatorState>(debugLabel: 'sectionANav');
class BlocState {
final int counter;
BlocState(this.counter);
}
class BlocEvent {
final int counter;
BlocEvent(this.counter);
}
class BlocCounter extends Bloc<BlocEvent, BlocState> {
BlocCounter() : super(BlocState(0)) {
on<BlocEvent>(_changeCounter);
}
_changeCounter(BlocEvent event, Emitter<BlocState> emit) {
emit(BlocState(event.counter));
}
}
final blocInstance = BlocCounter();
void main() {
runApp(NestedTabNavigationExampleApp());
}
/// An example demonstrating how to use nested navigators
class NestedTabNavigationExampleApp extends StatelessWidget {
/// Creates a NestedTabNavigationExampleApp
NestedTabNavigationExampleApp({super.key});
final GoRouter _router = GoRouter(
navigatorKey: _rootNavigatorKey,
initialLocation: '/a/details',
routes: <RouteBase>[
StatefulShellRoute.indexedStack(
builder: (BuildContext context, GoRouterState state,
StatefulNavigationShell navigationShell) {
// Return the widget that implements the custom shell (in this case
// using a BottomNavigationBar). The StatefulNavigationShell is passed
// to be able access the state of the shell and to navigate to other
// branches in a stateful way.
return ScaffoldWithNavBar(navigationShell: navigationShell);
},
branches: <StatefulShellBranch>[
// The route branch for the first tab of the bottom navigation bar.
StatefulShellBranch(
navigatorKey: _sectionANavigatorKey,
routes: <RouteBase>[
GoRoute(
// The screen to display as the root in the first tab of the
// bottom navigation bar.
path: '/a',
builder: (BuildContext context, GoRouterState state) =>
const RootScreen(label: 'A', detailsPath: '/a/details'),
routes: <RouteBase>[
// The details screen to display stacked on navigator of the
// first tab. This will cover screen A but not the application
// shell (bottom navigation bar).
GoRoute(
path: 'details',
builder: (BuildContext context, GoRouterState state) =>
const DetailsScreen(label: 'A'),
),
],
),
],
),
// The route branch for the second tab of the bottom navigation bar.
StatefulShellBranch(
// It's not necessary to provide a navigatorKey if it isn't also
// needed elsewhere. If not provided, a default key will be used.
routes: <RouteBase>[
GoRoute(
// The screen to display as the root in the second tab of the
// bottom navigation bar.
path: '/b',
builder: (BuildContext context, GoRouterState state) =>
const RootScreen(
label: 'B',
detailsPath: '/b/details/1',
secondDetailsPath: '/b/details/2',
),
routes: <RouteBase>[
GoRoute(
path: 'details/:param',
builder: (BuildContext context, GoRouterState state) =>
DetailsScreen(
label: 'B',
param: state.pathParameters['param'],
),
),
],
),
],
),
// The route branch for the third tab of the bottom navigation bar.
StatefulShellBranch(
routes: <RouteBase>[
GoRoute(
// The screen to display as the root in the third tab of the
// bottom navigation bar.
path: '/c',
builder: (BuildContext context, GoRouterState state) =>
const RootScreen(
label: 'C',
detailsPath: '/c/details',
),
routes: <RouteBase>[
GoRoute(
path: 'details',
builder: (BuildContext context, GoRouterState state) =>
DetailsScreen(
label: 'C',
extra: state.extra,
),
),
],
),
],
),
],
),
],
);
@override
Widget build(BuildContext context) {
return BlocProvider(
create: (context) => blocInstance,
child: MaterialApp.router(
title: 'Flutter Demo',
theme: ThemeData(
primarySwatch: Colors.blue,
),
routerConfig: _router,
),
);
}
}
/// Builds the "shell" for the app by building a Scaffold with a
/// BottomNavigationBar, where [child] is placed in the body of the Scaffold.
class ScaffoldWithNavBar extends StatelessWidget {
/// Constructs an [ScaffoldWithNavBar].
const ScaffoldWithNavBar({
required this.navigationShell,
Key? key,
}) : super(key: key ?? const ValueKey<String>('ScaffoldWithNavBar'));
/// The navigation shell and container for the branch Navigators.
final StatefulNavigationShell navigationShell;
@override
Widget build(BuildContext context) {
final counterState = context.watch<BlocCounter>().state;
return LayoutBuilder(
builder: (BuildContext context, BoxConstraints constraint) {
double width = constraint.maxWidth;
final Widget narrowContent = ConstrainedBox(
constraints: BoxConstraints(
minHeight: MediaQuery.of(context).size.height,
),
child: navigationShell,
);
late final Widget body;
if (counterState.counter.isEven) {
body = Stack(children: [
Positioned.fill(child: narrowContent),
]);
} else {
body = Column(children: [Expanded(child: narrowContent)]);
}
final Widget rightArea = SafeArea(
// key: const Key('right_area'),
child: Align(
alignment: Alignment.center,
child: ConstrainedBox(
constraints: const BoxConstraints(
maxWidth: 800,
),
child: body,
),
),
);
return Scaffold(
body: rightArea,
bottomNavigationBar: BottomNavigationBar(
// Here, the items of BottomNavigationBar are hard coded. In a real
// world scenario, the items would most likely be generated from the
// branches of the shell route, which can be fetched using
// `navigationShell.route.branches`.
items: const <BottomNavigationBarItem>[
BottomNavigationBarItem(
icon: Icon(Icons.home), label: 'Section A'),
BottomNavigationBarItem(
icon: Icon(Icons.work), label: 'Section B'),
BottomNavigationBarItem(
icon: Icon(Icons.tab), label: 'Section C'),
],
currentIndex: navigationShell.currentIndex,
onTap: (int index) => _onTap(context, index),
),
);
},
);
}
/// Navigate to the current location of the branch at the provided index when
/// tapping an item in the BottomNavigationBar.
void _onTap(BuildContext context, int index) {
// When navigating to a new branch, it's recommended to use the goBranch
// method, as doing so makes sure the last navigation state of the
// Navigator for the branch is restored.
navigationShell.goBranch(
index,
// A common pattern when using bottom navigation bars is to support
// navigating to the initial location when tapping the item that is
// already active. This example demonstrates how to support this behavior,
// using the initialLocation parameter of goBranch.
initialLocation: index == navigationShell.currentIndex,
);
}
}
/// Widget for the root/initial pages in the bottom navigation bar.
class RootScreen extends StatelessWidget {
/// Creates a RootScreen
const RootScreen({
required this.label,
required this.detailsPath,
this.secondDetailsPath,
super.key,
});
/// The label
final String label;
/// The path to the detail page
final String detailsPath;
/// The path to another detail page
final String? secondDetailsPath;
@override
Widget build(BuildContext context) {
final counterState = context.watch<BlocCounter>().state;
if (counterState.counter.isEven) {
return Scaffold(body: const CircularProgressIndicator());
} else {
return Text('Screen $label',
style: Theme.of(context).textTheme.titleLarge);
}
}
}
/// The details screen for either the A or B screen.
class DetailsScreen extends StatefulWidget {
/// Constructs a [DetailsScreen].
const DetailsScreen({
required this.label,
this.param,
this.extra,
this.withScaffold = true,
super.key,
});
/// The label to display in the center of the screen.
final String label;
/// Optional param
final String? param;
/// Optional extra object
final Object? extra;
/// Wrap in scaffold
final bool withScaffold;
@override
State<StatefulWidget> createState() => DetailsScreenState();
}
/// The state for DetailsScreen
class DetailsScreenState extends State<DetailsScreen> {
int _counter = 0;
@override
Widget build(BuildContext context) {
if (widget.withScaffold) {
return Scaffold(
appBar: AppBar(
title: Text('Details Screen - ${widget.label}'),
),
body: _build(context),
);
} else {
return ColoredBox(
color: Theme.of(context).scaffoldBackgroundColor,
child: _build(context),
);
}
}
Widget _build(BuildContext context) {
final counterState = context.watch<BlocCounter>().state;
return Center(
child: Column(
mainAxisSize: MainAxisSize.min,
children: <Widget>[
Text('Details for ${widget.label} - Counter: ${counterState.counter}',
style: Theme.of(context).textTheme.titleLarge),
const Padding(padding: EdgeInsets.all(4)),
TextButton(
onPressed: () {
setState(() {
blocInstance.add(BlocEvent(blocInstance.state.counter + 1));
});
},
child: const Text('Crash me!'),
),
const Padding(padding: EdgeInsets.all(8)),
if (widget.param != null)
Text('Parameter: ${widget.param!}',
style: Theme.of(context).textTheme.titleMedium),
const Padding(padding: EdgeInsets.all(8)),
if (widget.extra != null)
Text('Extra: ${widget.extra!}',
style: Theme.of(context).textTheme.titleMedium),
if (!widget.withScaffold) ...<Widget>[
const Padding(padding: EdgeInsets.all(16)),
TextButton(
onPressed: () {
GoRouter.of(context).pop();
},
child: const Text('< Back',
style: TextStyle(fontWeight: FontWeight.bold, fontSize: 18)),
),
]
],
),
);
}
}Pubspec
name: go_router_bug
description: "A new Flutter project."
# Prevent accidental publishing to pub.dev.
publish_to: 'none'
version: 1.0.0+1
environment:
sdk: '>=3.3.4 <4.0.0'
dependencies:
go_router: ^14.0.0
flutter_bloc: ^8.1.5
flutter:
sdk: flutter
flutter_localizations:
sdk: flutter
dev_dependencies:
flutter_test:
sdk: flutter
flutter_lints: ^3.0.0
flutter:
uses-material-design: true
# Enable generation of localized Strings from arb files.
generate: true
assets:
# Add assets from the images directory to the application.
- assets/images/Screenshots or Video
Screenshots / Video demonstration
[Upload media here]
Logs
Logs
======== Exception caught by widgets library =======================================================
The following assertion was thrown building RootScreen(dependencies: [_InheritedProviderScope<BlocCounter?>, _InheritedTheme, _LocalizationsScope-[GlobalKey#10e8b]]):
'package:flutter/src/rendering/object.dart': Failed assertion: line 2283 pos 14: '_debugSubtreeRelayoutRootAlreadyMarkedNeedsLayout()': is not true.
Either the assertion indicates an error in the framework itself, or we should provide substantially more information in this error message to help you determine and fix the underlying cause.
In either case, please report this assertion by filing a bug on GitHub:
https://github.com/flutter/flutter/issues/new?template=2_bug.yml
The relevant error-causing widget was:
RootScreen RootScreen:file:///Users/shady/Projects/go_router_bug/lib/main.dart:66:27
When the exception was thrown, this was the stack:
#2 RenderObject.markNeedsLayout (package:flutter/src/rendering/object.dart:2283:14)
#3 RenderBox.markNeedsLayout (package:flutter/src/rendering/box.dart:2379:11)
#4 RenderObject.dropChild (package:flutter/src/rendering/object.dart:1863:5)
#5 RenderObjectWithChildMixin.child= (package:flutter/src/rendering/object.dart:4051:7)
#6 SingleChildRenderObjectElement.removeRenderObjectChild (package:flutter/src/widgets/framework.dart:6787:18)
#7 RenderObjectElement.detachRenderObject (package:flutter/src/widgets/framework.dart:6601:37)
#8 Element.detachRenderObject.<anonymous closure> (package:flutter/src/widgets/framework.dart:4202:13)
#9 ComponentElement.visitChildren (package:flutter/src/widgets/framework.dart:5532:14)
#10 Element.detachRenderObject (package:flutter/src/widgets/framework.dart:4201:5)
#11 Element.deactivateChild (package:flutter/src/widgets/framework.dart:4376:11)
#12 Element.updateChild (package:flutter/src/widgets/framework.dart:3835:9)
#13 ComponentElement.performRebuild (package:flutter/src/widgets/framework.dart:5505:16)
#14 Element.rebuild (package:flutter/src/widgets/framework.dart:5196:7)
#15 BuildOwner.buildScope (package:flutter/src/widgets/framework.dart:2904:19)
#16 WidgetsBinding.drawFrame (package:flutter/src/widgets/binding.dart:989:21)
#17 RendererBinding._handlePersistentFrameCallback (package:flutter/src/rendering/binding.dart:448:5)
#18 SchedulerBinding._invokeFrameCallback (package:flutter/src/scheduler/binding.dart:1386:15)
#19 SchedulerBinding.handleDrawFrame (package:flutter/src/scheduler/binding.dart:1311:9)
#20 SchedulerBinding._handleDrawFrame (package:flutter/src/scheduler/binding.dart:1169:5)
#21 _invoke (dart:ui/hooks.dart:312:13)
#22 PlatformDispatcher._drawFrame (dart:ui/platform_dispatcher.dart:399:5)
#23 _drawFrame (dart:ui/hooks.dart:283:31)
(elided 2 frames from class _AssertionError)
====================================================================================================
Flutter Doctor output
Doctor output
flutter doctor -v
[✓] Flutter (Channel stable, 3.19.6, on macOS 14.4.1 23E224 darwin-x64, locale en-AU)
• Flutter version 3.19.6 on channel stable at /Applications/flutter
• Upstream repository https://github.com/flutter/flutter.git
• Framework revision 54e66469a9 (9 days ago), 2024-04-17 13:08:03 -0700
• Engine revision c4cd48e186
• Dart version 3.3.4
• DevTools version 2.31.1
[✓] Android toolchain - develop for Android devices (Android SDK version 32.1.0-rc1)
• Android SDK at /Users/shady/Library/Android/sdk
• Platform android-33, build-tools 32.1.0-rc1
• Java binary at: /Applications/Android Studio.app/Contents/jre/Contents/Home/bin/java
• Java version OpenJDK Runtime Environment (build 11.0.11+0-b60-7590822)
• All Android licenses accepted.
[✓] Xcode - develop for iOS and macOS (Xcode 15.2)
• Xcode at /Applications/Xcode.app/Contents/Developer
• Build 15C500b
• CocoaPods version 1.15.2
[✓] Chrome - develop for the web
• Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome
[✓] Android Studio (version 2021.1)
• Android Studio at /Applications/Android Studio.app/Contents
• Flutter plugin can be installed from:
🔨 https://plugins.jetbrains.com/plugin/9212-flutter
• Dart plugin can be installed from:
🔨 https://plugins.jetbrains.com/plugin/6351-dart
• Java version OpenJDK Runtime Environment (build 11.0.11+0-b60-7590822)
[✓] IntelliJ IDEA Ultimate Edition (version 2024.1)
• IntelliJ at /Users/shady/Applications/IntelliJ IDEA Ultimate.app
• Flutter plugin version 79.0.3
• Dart plugin version 241.15845
[✓] VS Code (version 1.88.1)
• VS Code at /Applications/Visual Studio Code.app/Contents
• Flutter extension can be installed from:
🔨 https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter
[✓] VS Code (version 1.86.0-insider)
• VS Code at /Applications/Visual Studio Code - Insiders.app/Contents
• Flutter extension can be installed from:
🔨 https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter
[✓] Connected device (4 available)
• Shady’s Shenanigans (mobile) • 00008110-001129523C09801E • ios • iOS 17.4.1 21E236
• iPad Pro (12.9-inch) (6th generation) (mobile) • 71A2390D-33E0-40A6-965A-17475C5A5527 • ios • com.apple.CoreSimulator.SimRuntime.iOS-17-2 (simulator)
• macOS (desktop) • macos • darwin-x64 • macOS 14.4.1 23E224 darwin-x64
• Chrome (web) • chrome • web-javascript • Google Chrome 124.0.6367.91
[✓] Network resources
• All expected network resources are available.
• No issues found!Reacted by Balázs Némedi, Momo, Guilherme Brisida, Orkun Duman, August and Jannis Rosenbaum
Metadata
Metadata
Assignees
Labels
P3Issues that are less important to the Flutter projectIssues that are less important to the Flutter projecta: error messageError messages from the Flutter frameworkError messages from the Flutter frameworkfound in release: 3.19Found to occur in 3.19Found to occur in 3.19found in release: 3.22Found to occur in 3.22Found to occur in 3.22frameworkflutter/packages/flutter repository. See also f: labels.flutter/packages/flutter repository. See also f: labels.has reproducible stepsThe issue has been confirmed reproducible and is ready to work onThe issue has been confirmed reproducible and is ready to work onteam-frameworkOwned by Framework teamOwned by Framework teamtriaged-frameworkTriaged by Framework teamTriaged by Framework team
Activity
darshankawar commentedon Apr 29, 2024
@premiumbiscuit You are using
flutter_blocwhich is community package. In order to properly address the issue, please narrow down the code sample to minimal but complete and without community package implementation, that still triggers the reported exception.premiumbiscuit commentedon May 4, 2024
Thanks @darshankawar for looking into this. I have replaced
flutter_blocwith a StreamController, please see the code below. Ultimately, anything that causes re-rendering will produce the bug for some reason.Code sample
darshankawar commentedon May 6, 2024
Thanks for the update. Using above code sample, it throws below error log in the console:
error log
stable, master flutter doctor -v
goderbauer commentedon May 7, 2024
Thank you for the report. To debug this it would help if you could reduce the test case more, see https://github.com/flutter/flutter/wiki/Issue-hygiene#provide-reduced-test-cases
11 remaining items
Waxo commentedon Oct 15, 2024
Any updates ?
xortuna commentedon Oct 15, 2024
Seems like many packages adopted into flutter get abandoned.
It’s shocking that this issue is unaddressed despite being the de-facto standard in creating tabbed iOS apps.
If a widget is off stage it should not care if it’s asked to relayout multiple times, raising an assertion in this state does not make sense.
For now I’ve mostly avoided using layout builder and rewrote widgets in house that use it. The issue does not appear in release mode, but that’s simply due to the fact there’s no debugger raising the assertion.
Gustl22 commentedon Nov 11, 2024
I get a similar error (tried on web) with the following example (on the current master 3.27.x):
Logs
Flutter Doctor
fix: Ignore non laid out renderboxes in InkFeature (contributes to fl…
fix: Ignore non laid out renderboxes in InkFeature (contributes to fl…
fix: Ignore non laid out renderboxes in InkFeature (contributes to fl…
orkun1675 commentedon Dec 18, 2024
Is there a workaround for this problem?
Gustl22 commentedon Dec 18, 2024
@orkun1675 you can return an empty Container, if the current route is NOT the top route in the
StatefulShellRoute.builderStatefulShellBranch.GoRoute.pageBuilder. So underlaying widgets are not in the widget tree, which then won't need to be rendered without layout phase.xortuna commentedon Dec 18, 2024
Do you have a code example on how to check for this?
I'm guessing I could then create a widget that does this check and place between the StatefulShellRoute and the page to prevent the entire visual tree being processed 👍
Gustl22 commentedon Dec 18, 2024
orkun1675 commentedon Dec 20, 2024
Thank for sharing @Gustl22 , unfortunately this approach breaks the statefulness of the shell branch: the page state is not retained when navigating away.
Gustl22 commentedon Mar 30, 2025
For now it should be solvable by wrapping the inner shell Routes builder with a
Materialclass. This avoids registering theInkDecoration(which is used in many widgets) at the outer Scaffold (which is aMaterial).Code
LongCatIsLooong commentedon Jun 3, 2025
I think that assert is for catching framework errors, and it unfortunately has false positives (meaning, it should be perfectly fine to ignore it, or go to
object.dartto comment out the assert).Details
The assert itself is a bit problematic because it tries to verify a RenderObject that's already marked as dirty is reachable via treewalk, but there are render objects which deliberately skip laying out its children such as `_RenderTheater` or `RenderMultiSliverAdaptor`. It should be perfectly legal for these render objects to have offstage children that are dirty (and are not relayout boundaries), when the render objects themselves are clean.fix: Ignore non laid out renderboxes in InkFeature (contributes to fl…
fix: Ignore non laid out renderboxes in InkFeature (contributes to fl…