debug.dart 16.2 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'dart:collection';
6
import 'dart:developer' show Timeline; // to disambiguate reference in dartdocs below
7

8 9
import 'package:flutter/foundation.dart';

10
import 'basic.dart';
11
import 'framework.dart';
12
import 'localizations.dart';
13
import 'media_query.dart';
14
import 'overlay.dart';
15
import 'table.dart';
16

17 18 19
// Any changes to this file should be reflected in the debugAssertAllWidgetVarsUnset()
// function below.

20
/// Log the dirty widgets that are built each frame.
21 22 23 24
///
/// Combined with [debugPrintBuildScope] or [debugPrintBeginFrameBanner], this
/// allows you to distinguish builds triggered by the initial mounting of a
/// widget tree (e.g. in a call to [runApp]) from the regular builds triggered
25
/// by the pipeline.
26 27 28
///
/// Combined with [debugPrintScheduleBuildForStacks], this lets you watch a
/// widget's dirty/clean lifecycle.
29
///
30 31 32 33
/// To get similar information but showing it on the timeline available from the
/// Observatory rather than getting it in the console (where it can be
/// overwhelming), consider [debugProfileBuildsEnabled].
///
34 35 36 37
/// See also:
///
///  * [WidgetsBinding.drawFrame], which pumps the build and rendering pipeline
///    to generate a frame.
38 39
bool debugPrintRebuildDirtyWidgets = false;

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
/// Signature for [debugOnRebuildDirtyWidget] implementations.
typedef RebuildDirtyWidgetCallback = void Function(Element e, bool builtOnce);

/// Callback invoked for every dirty widget built each frame.
///
/// This callback is only invoked in debug builds.
///
/// See also:
///
///  * [debugPrintRebuildDirtyWidgets], which does something similar but logs
///    to the console instead of invoking a callback.
///  * [debugOnProfilePaint], which does something similar for [RenderObject]
///    painting.
///  * [WidgetInspectorService], which uses the [debugOnRebuildDirtyWidget]
///    callback to generate aggregate profile statistics describing which widget
///    rebuilds occurred when the
///    `ext.flutter.inspector.trackRebuildDirtyWidgets` service extension is
///    enabled.
58
RebuildDirtyWidgetCallback? debugOnRebuildDirtyWidget;
59

60 61 62 63 64 65 66 67
/// Log all calls to [BuildOwner.buildScope].
///
/// Combined with [debugPrintScheduleBuildForStacks], this allows you to track
/// when a [State.setState] call gets serviced.
///
/// Combined with [debugPrintRebuildDirtyWidgets] or
/// [debugPrintBeginFrameBanner], this allows you to distinguish builds
/// triggered by the initial mounting of a widget tree (e.g. in a call to
68 69
/// [runApp]) from the regular builds triggered by the pipeline.
///
70 71 72 73
/// See also:
///
///  * [WidgetsBinding.drawFrame], which pumps the build and rendering pipeline
///    to generate a frame.
74 75 76 77 78 79 80 81 82 83
bool debugPrintBuildScope = false;

/// Log the call stacks that mark widgets as needing to be rebuilt.
///
/// This is called whenever [BuildOwner.scheduleBuildFor] adds an element to the
/// dirty list. Typically this is as a result of [Element.markNeedsBuild] being
/// called, which itself is usually a result of [State.setState] being called.
///
/// To see when a widget is rebuilt, see [debugPrintRebuildDirtyWidgets].
///
84
/// To see when the dirty list is flushed, see [debugPrintBuildScope].
85 86
///
/// To see when a frame is scheduled, see [debugPrintScheduleFrameStacks].
87 88
bool debugPrintScheduleBuildForStacks = false;

89 90 91 92 93 94
/// Log when widgets with global keys are deactivated and log when they are
/// reactivated (retaken).
///
/// This can help track down framework bugs relating to the [GlobalKey] logic.
bool debugPrintGlobalKeyedWidgetLifecycle = false;

95 96 97
/// Adds [Timeline] events for every Widget built.
///
/// For details on how to use [Timeline] events in the Dart Observatory to
98
/// optimize your app, see https://flutter.dev/docs/testing/debugging#tracing-any-dart-code-performance
99
/// and https://fuchsia.googlesource.com/topaz/+/master/shell/docs/performance.md
100
///
101 102
/// See also:
///
103 104 105 106 107
///  * [debugPrintRebuildDirtyWidgets], which does something similar but
///    reporting the builds to the console.
///  * [debugProfileLayoutsEnabled], which does something similar for layout,
///    and [debugPrintLayouts], its console equivalent.
///  * [debugProfilePaintsEnabled], which does something similar for painting.
108 109
bool debugProfileBuildsEnabled = false;

110 111 112
/// Show banners for deprecated widgets.
bool debugHighlightDeprecatedWidgets = false;

113
Key? _firstNonUniqueKey(Iterable<Widget> widgets) {
114
  final Set<Key> keySet = HashSet<Key>();
115
  for (final Widget widget in widgets) {
116 117 118
    assert(widget != null);
    if (widget.key == null)
      continue;
119
    if (!keySet.add(widget.key!))
120 121 122 123 124
      return widget.key;
  }
  return null;
}

125 126 127 128 129 130 131 132 133 134 135 136 137 138
/// Asserts if the given child list contains any duplicate non-null keys.
///
/// To invoke this function, use the following pattern, typically in the
/// relevant Widget's constructor:
///
/// ```dart
/// assert(!debugChildrenHaveDuplicateKeys(this, children));
/// ```
///
/// For a version of this function that can be used in contexts where
/// the list of items does not have a particular parent, see
/// [debugItemsHaveDuplicateKeys].
///
/// Does nothing if asserts are disabled. Always returns true.
139
bool debugChildrenHaveDuplicateKeys(Widget parent, Iterable<Widget> children) {
140
  assert(() {
141
    final Key? nonUniqueKey = _firstNonUniqueKey(children);
142
    if (nonUniqueKey != null) {
143 144 145
      throw FlutterError(
        'Duplicate keys found.\n'
        'If multiple keyed nodes exist as children of another node, they must have unique keys.\n'
146
        '$parent has multiple children with key $nonUniqueKey.',
147
      );
148 149
    }
    return true;
150
  }());
151 152
  return false;
}
153

154 155 156 157 158 159 160 161 162 163 164 165
/// Asserts if the given list of items contains any duplicate non-null keys.
///
/// To invoke this function, use the following pattern:
///
/// ```dart
/// assert(!debugItemsHaveDuplicateKeys(items));
/// ```
///
/// For a version of this function specifically intended for parents
/// checking their children lists, see [debugChildrenHaveDuplicateKeys].
///
/// Does nothing if asserts are disabled. Always returns true.
166 167
bool debugItemsHaveDuplicateKeys(Iterable<Widget> items) {
  assert(() {
168
    final Key? nonUniqueKey = _firstNonUniqueKey(items);
169
    if (nonUniqueKey != null)
170
      throw FlutterError('Duplicate key found: $nonUniqueKey.');
171
    return true;
172
  }());
173 174
  return false;
}
175 176 177

/// Asserts that the given context has a [Table] ancestor.
///
178
/// Used by [TableRowInkWell] to make sure that it is only used in an appropriate context.
179 180
///
/// To invoke this function, use the following pattern, typically in the
181
/// relevant Widget's build method:
182 183 184 185 186
///
/// ```dart
/// assert(debugCheckHasTable(context));
/// ```
///
187 188
/// This method can be expensive (it walks the element tree).
///
189 190 191
/// Does nothing if asserts are disabled. Always returns true.
bool debugCheckHasTable(BuildContext context) {
  assert(() {
192
    if (context.widget is! Table && context.findAncestorWidgetOfExactType<Table>() == null) {
193 194 195 196 197 198
      throw FlutterError.fromParts(<DiagnosticsNode>[
        ErrorSummary('No Table widget found.'),
        ErrorDescription('${context.widget.runtimeType} widgets require a Table widget ancestor.'),
        context.describeWidget('The specific widget that could not find a Table ancestor was'),
        context.describeOwnershipChain('The ownership chain for the affected widget is'),
      ]);
199 200
    }
    return true;
201
  }());
202 203
  return true;
}
204

205 206 207 208 209 210
/// Asserts that the given context has a [MediaQuery] ancestor.
///
/// Used by various widgets to make sure that they are only used in an
/// appropriate context.
///
/// To invoke this function, use the following pattern, typically in the
211
/// relevant Widget's build method:
212 213 214 215 216 217 218 219
///
/// ```dart
/// assert(debugCheckHasMediaQuery(context));
/// ```
///
/// Does nothing if asserts are disabled. Always returns true.
bool debugCheckHasMediaQuery(BuildContext context) {
  assert(() {
220
    if (context.widget is! MediaQuery && context.getElementForInheritedWidgetOfExactType<MediaQuery>() == null) {
221
      throw FlutterError.fromParts(<DiagnosticsNode>[
222
        ErrorSummary('No MediaQuery widget ancestor found.'),
223 224 225 226
        ErrorDescription('${context.widget.runtimeType} widgets require a MediaQuery widget ancestor.'),
        context.describeWidget('The specific widget that could not find a MediaQuery ancestor was'),
        context.describeOwnershipChain('The ownership chain for the affected widget is'),
        ErrorHint(
227 228 229 230
          'No MediaQuery ancestor could be found starting from the context '
          'that was passed to MediaQuery.of(). This can happen because you '
          'have not added a WidgetsApp, CupertinoApp, or MaterialApp widget '
          '(those widgets introduce a MediaQuery), or it can happen if the '
231
          'context you use comes from a widget above those widgets.',
232 233
        ),
      ]);
234 235
    }
    return true;
236
  }());
237 238 239
  return true;
}

240 241 242 243 244 245 246 247 248 249 250 251
/// Asserts that the given context has a [Directionality] ancestor.
///
/// Used by various widgets to make sure that they are only used in an
/// appropriate context.
///
/// To invoke this function, use the following pattern, typically in the
/// relevant Widget's build method:
///
/// ```dart
/// assert(debugCheckHasDirectionality(context));
/// ```
///
252 253 254 255 256 257
/// To improve the error messages you can add some extra color using the
/// named arguments.
///
///  * why: explain why the direction is needed, for example "to resolve
///    the 'alignment' argument". Should be an adverb phrase describing why.
///  * hint: explain why this might be happening, for example "The default
258
///    value of the 'alignment' argument of the $runtimeType widget is an
259 260 261 262
///    AlignmentDirectional value.". Should be a fully punctuated sentence.
///  * alternative: provide additional advice specific to the situation,
///    especially an alternative to providing a Directionality ancestor.
///    For example, "Alternatively, consider specifying the 'textDirection'
263
///    argument.". Should be a fully punctuated sentence.
264 265 266 267 268
///
/// Each one can be null, in which case it is skipped (this is the default).
/// If they are non-null, they are included in the order above, interspersed
/// with the more generic advice regarding [Directionality].
///
269
/// Does nothing if asserts are disabled. Always returns true.
270
bool debugCheckHasDirectionality(BuildContext context, { String? why, String? hint, String? alternative }) {
271
  assert(() {
272
    if (context.widget is! Directionality && context.getElementForInheritedWidgetOfExactType<Directionality>() == null) {
273
      why = why == null ? '' : ' $why';
274 275
      throw FlutterError.fromParts(<DiagnosticsNode>[
        ErrorSummary('No Directionality widget found.'),
276 277 278
        ErrorDescription('${context.widget.runtimeType} widgets require a Directionality widget ancestor$why.\n'),
        if (hint != null)
          ErrorHint(hint),
279 280 281 282 283 284 285 286
        context.describeWidget('The specific widget that could not find a Directionality ancestor was'),
        context.describeOwnershipChain('The ownership chain for the affected widget is'),
        ErrorHint(
          'Typically, the Directionality widget is introduced by the MaterialApp '
          'or WidgetsApp widget at the top of your application widget tree. It '
          'determines the ambient reading direction and is used, for example, to '
          'determine how to lay out text, how to interpret "start" and "end" '
          'values, and to resolve EdgeInsetsDirectional, '
287
          'AlignmentDirectional, and other *Directional objects.',
288
        ),
289 290
        if (alternative != null)
          ErrorHint(alternative),
291
      ]);
292 293 294 295 296 297
    }
    return true;
  }());
  return true;
}

298 299 300 301 302 303
/// Asserts that the `built` widget is not null.
///
/// Used when the given `widget` calls a builder function to check that the
/// function returned a non-null value, as typically required.
///
/// Does nothing when asserts are disabled.
304
void debugWidgetBuilderValue(Widget widget, Widget? built) {
305 306
  assert(() {
    if (built == null) {
307 308 309 310 311 312
      throw FlutterError.fromParts(<DiagnosticsNode>[
        ErrorSummary('A build function returned null.'),
        DiagnosticsProperty<Widget>('The offending widget is', widget, style: DiagnosticsTreeStyle.errorProperty),
        ErrorDescription('Build functions must never return null.'),
        ErrorHint(
          'To return an empty space that causes the building widget to fill available room, return "Container()". '
313
          'To return an empty space that takes as little room as possible, return "Container(width: 0.0, height: 0.0)".',
314 315
        ),
      ]);
316
    }
317
    if (widget == built) {
318 319 320 321 322
      throw FlutterError.fromParts(<DiagnosticsNode>[
        ErrorSummary('A build function returned context.widget.'),
        DiagnosticsProperty<Widget>('The offending widget is', widget, style: DiagnosticsTreeStyle.errorProperty),
        ErrorDescription(
          'Build functions must never return their BuildContext parameter\'s widget or a child that contains "context.widget". '
323
          'Doing so introduces a loop in the widget tree that can cause the app to crash.',
324 325
        ),
      ]);
326
    }
327
    return true;
328
  }());
329
}
330

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
/// Asserts that the given context has a [Localizations] ancestor that contains
/// a [WidgetsLocalizations] delegate.
///
/// To call this function, use the following pattern, typically in the
/// relevant Widget's build method:
///
/// ```dart
/// assert(debugCheckHasWidgetsLocalizations(context));
/// ```
///
/// Does nothing if asserts are disabled. Always returns true.
bool debugCheckHasWidgetsLocalizations(BuildContext context) {
  assert(() {
    if (Localizations.of<WidgetsLocalizations>(context, WidgetsLocalizations) == null) {
      throw FlutterError.fromParts(<DiagnosticsNode>[
        ErrorSummary('No WidgetsLocalizations found.'),
        ErrorDescription(
          '${context.widget.runtimeType} widgets require WidgetsLocalizations '
349
          'to be provided by a Localizations widget ancestor.',
350 351 352
        ),
        ErrorDescription(
          'The widgets library uses Localizations to generate messages, '
353
          'labels, and abbreviations.',
354 355 356 357 358
        ),
        ErrorHint(
          'To introduce a WidgetsLocalizations, either use a '
          'WidgetsApp at the root of your application to include them '
          'automatically, or add a Localization widget with a '
359
          'WidgetsLocalizations delegate.',
360
        ),
361
        ...context.describeMissingAncestor(expectedAncestorType: WidgetsLocalizations),
362 363 364 365 366 367 368
      ]);
    }
    return true;
  }());
  return true;
}

369 370 371 372 373 374 375 376 377
/// Asserts that the given context has an [Overlay] ancestor.
///
/// To call this function, use the following pattern, typically in the
/// relevant Widget's build method:
///
/// ```dart
/// assert(debugCheckHasOverlay(context));
/// ```
///
378 379
/// This method can be expensive (it walks the element tree).
///
380 381 382 383 384 385 386 387 388
/// Does nothing if asserts are disabled. Always returns true.
bool debugCheckHasOverlay(BuildContext context) {
  assert(() {
    if (context.widget is! Overlay && context.findAncestorWidgetOfExactType<Overlay>() == null) {
      throw FlutterError.fromParts(<DiagnosticsNode>[
        ErrorSummary('No Overlay widget found.'),
        ErrorDescription(
          '${context.widget.runtimeType} widgets require an Overlay '
          'widget ancestor.\n'
389
          'An overlay lets widgets float on top of other widget children.',
390 391 392 393 394 395
        ),
        ErrorHint(
          'To introduce an Overlay widget, you can either directly '
          'include one, or use a widget that contains an Overlay itself, '
          'such as a Navigator, WidgetApp, MaterialApp, or CupertinoApp.',
        ),
396 397
        ...context.describeMissingAncestor(expectedAncestorType: Overlay),
      ]);
398 399 400 401 402 403
    }
    return true;
  }());
  return true;
}

404 405 406 407 408
/// Returns true if none of the widget library debug variables have been changed.
///
/// This function is used by the test framework to ensure that debug variables
/// haven't been inadvertently changed.
///
409
/// See [the widgets library](widgets/widgets-library.html) for a complete list.
410 411 412 413 414 415
bool debugAssertAllWidgetVarsUnset(String reason) {
  assert(() {
    if (debugPrintRebuildDirtyWidgets ||
        debugPrintBuildScope ||
        debugPrintScheduleBuildForStacks ||
        debugPrintGlobalKeyedWidgetLifecycle ||
416 417
        debugProfileBuildsEnabled ||
        debugHighlightDeprecatedWidgets) {
418
      throw FlutterError(reason);
419 420
    }
    return true;
421
  }());
422 423
  return true;
}