debug.dart 18.8 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
/// Adds [Timeline] events for every Widget built.
///
Ian Hickson's avatar
Ian Hickson committed
97 98 99 100 101 102 103 104 105 106 107 108
/// The timing information this flag exposes is not representative of the actual
/// cost of building, because the overhead of adding timeline events is
/// significant relative to the time each object takes to build. However, it can
/// expose unexpected widget behavior in the timeline.
///
/// In debug builds, additional information is included in the trace (such as
/// the properties of widgets being built). Collecting this data is
/// expensive and further makes these traces non-representative of actual
/// performance. This data is omitted in profile builds.
///
/// For more information about performance debugging in Flutter, see
/// <https://flutter.dev/docs/perf/rendering>.
109
///
110 111
/// See also:
///
112 113 114 115 116
///  * [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.
117 118
///  * [debugProfileBuildsEnabledUserWidgets], which adds events for user-created
///    [Widget] build times and incurs less overhead.
119 120
///  * [debugEnhanceBuildTimelineArguments], which enhances the trace with
///    debugging information related to [Widget] builds.
121 122
bool debugProfileBuildsEnabled = false;

123 124 125 126 127 128 129 130 131 132 133 134
/// Adds [Timeline] events for every user-created [Widget] built.
///
/// A user-created [Widget] is any [Widget] that is constructed in the root
/// library. Often [Widget]s contain child [Widget]s that are constructed in
/// libraries (for example, a [TextButton] having a [RichText] child). Timeline
/// events for those children will be omitted with this flag. This works for any
/// [Widget] not just ones declared in the root library.
///
/// See also:
///
///  * [debugProfileBuildsEnabled], which functions similarly but shows events
///    for every widget and has a higher overhead cost.
135 136
///  * [debugEnhanceBuildTimelineArguments], which enhances the trace with
///    debugging information related to [Widget] builds.
137 138
bool debugProfileBuildsEnabledUserWidgets = false;

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
/// Adds debugging information to [Timeline] events related to [Widget] builds.
///
/// This flag will only add [Timeline] event arguments for debug builds.
/// Additional arguments will be added for the "BUILD" [Timeline] event and for
/// all [Widget] build [Timeline] events, which are the [Timeline] events that
/// are added when either of [debugProfileBuildsEnabled] and
/// [debugProfileBuildsEnabledUserWidgets] are true. The debugging information
/// that will be added in trace arguments includes stats around [Widget] dirty
/// states and [Widget] diagnostic information (i.e. [Widget] properties).
///
/// See also:
///
///  * [debugProfileBuildsEnabled], which adds [Timeline] events for every
///    [Widget] built.
///  * [debugProfileBuildsEnabledUserWidgets], which adds [Timeline] events for
///    every user-created [Widget] built.
///  * [debugEnhanceLayoutTimelineArguments], which does something similar for
///    events related to [RenderObject] layouts.
///  * [debugEnhancePaintTimelineArguments], which does something similar for
///    events related to [RenderObject] paints.
bool debugEnhanceBuildTimelineArguments = false;

161 162 163
/// Show banners for deprecated widgets.
bool debugHighlightDeprecatedWidgets = false;

164
Key? _firstNonUniqueKey(Iterable<Widget> widgets) {
165
  final Set<Key> keySet = HashSet<Key>();
166
  for (final Widget widget in widgets) {
167 168 169
    assert(widget != null);
    if (widget.key == null)
      continue;
170
    if (!keySet.add(widget.key!))
171 172 173 174 175
      return widget.key;
  }
  return null;
}

176 177 178 179 180 181 182 183 184 185 186 187 188 189
/// 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.
190
bool debugChildrenHaveDuplicateKeys(Widget parent, Iterable<Widget> children) {
191
  assert(() {
192
    final Key? nonUniqueKey = _firstNonUniqueKey(children);
193
    if (nonUniqueKey != null) {
194 195 196
      throw FlutterError(
        'Duplicate keys found.\n'
        'If multiple keyed nodes exist as children of another node, they must have unique keys.\n'
197
        '$parent has multiple children with key $nonUniqueKey.',
198
      );
199 200
    }
    return true;
201
  }());
202 203
  return false;
}
204

205 206 207 208 209 210 211 212 213 214 215 216
/// 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.
217 218
bool debugItemsHaveDuplicateKeys(Iterable<Widget> items) {
  assert(() {
219
    final Key? nonUniqueKey = _firstNonUniqueKey(items);
220
    if (nonUniqueKey != null)
221
      throw FlutterError('Duplicate key found: $nonUniqueKey.');
222
    return true;
223
  }());
224 225
  return false;
}
226 227 228

/// Asserts that the given context has a [Table] ancestor.
///
229
/// Used by [TableRowInkWell] to make sure that it is only used in an appropriate context.
230 231
///
/// To invoke this function, use the following pattern, typically in the
232
/// relevant Widget's build method:
233 234 235 236 237
///
/// ```dart
/// assert(debugCheckHasTable(context));
/// ```
///
238 239
/// This method can be expensive (it walks the element tree).
///
240 241 242
/// Does nothing if asserts are disabled. Always returns true.
bool debugCheckHasTable(BuildContext context) {
  assert(() {
243
    if (context.widget is! Table && context.findAncestorWidgetOfExactType<Table>() == null) {
244 245 246 247 248 249
      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'),
      ]);
250 251
    }
    return true;
252
  }());
253 254
  return true;
}
255

256 257 258 259 260 261
/// 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
262
/// relevant Widget's build method:
263 264 265 266 267 268 269 270
///
/// ```dart
/// assert(debugCheckHasMediaQuery(context));
/// ```
///
/// Does nothing if asserts are disabled. Always returns true.
bool debugCheckHasMediaQuery(BuildContext context) {
  assert(() {
271
    if (context.widget is! MediaQuery && context.getElementForInheritedWidgetOfExactType<MediaQuery>() == null) {
272
      throw FlutterError.fromParts(<DiagnosticsNode>[
273
        ErrorSummary('No MediaQuery widget ancestor found.'),
274 275 276 277
        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(
278 279 280 281
          '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 '
282
          'context you use comes from a widget above those widgets.',
283 284
        ),
      ]);
285 286
    }
    return true;
287
  }());
288 289 290
  return true;
}

291 292 293 294 295 296 297 298 299 300 301 302
/// 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));
/// ```
///
303 304 305 306 307 308
/// 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
309
///    value of the 'alignment' argument of the $runtimeType widget is an
310 311 312 313
///    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'
314
///    argument.". Should be a fully punctuated sentence.
315 316 317 318 319
///
/// 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].
///
320
/// Does nothing if asserts are disabled. Always returns true.
321
bool debugCheckHasDirectionality(BuildContext context, { String? why, String? hint, String? alternative }) {
322
  assert(() {
323
    if (context.widget is! Directionality && context.getElementForInheritedWidgetOfExactType<Directionality>() == null) {
324
      why = why == null ? '' : ' $why';
325 326
      throw FlutterError.fromParts(<DiagnosticsNode>[
        ErrorSummary('No Directionality widget found.'),
327 328 329
        ErrorDescription('${context.widget.runtimeType} widgets require a Directionality widget ancestor$why.\n'),
        if (hint != null)
          ErrorHint(hint),
330 331 332 333 334 335 336 337
        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, '
338
          'AlignmentDirectional, and other *Directional objects.',
339
        ),
340 341
        if (alternative != null)
          ErrorHint(alternative),
342
      ]);
343 344 345 346 347 348
    }
    return true;
  }());
  return true;
}

349 350 351 352 353 354
/// 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.
355
void debugWidgetBuilderValue(Widget widget, Widget? built) {
356 357
  assert(() {
    if (built == null) {
358 359 360 361 362 363
      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()". '
364
          'To return an empty space that takes as little room as possible, return "Container(width: 0.0, height: 0.0)".',
365 366
        ),
      ]);
367
    }
368
    if (widget == built) {
369 370 371 372 373
      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". '
374
          'Doing so introduces a loop in the widget tree that can cause the app to crash.',
375 376
        ),
      ]);
377
    }
378
    return true;
379
  }());
380
}
381

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
/// 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 '
400
          'to be provided by a Localizations widget ancestor.',
401 402 403
        ),
        ErrorDescription(
          'The widgets library uses Localizations to generate messages, '
404
          'labels, and abbreviations.',
405 406 407 408 409
        ),
        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 '
410
          'WidgetsLocalizations delegate.',
411
        ),
412
        ...context.describeMissingAncestor(expectedAncestorType: WidgetsLocalizations),
413 414 415 416 417 418 419
      ]);
    }
    return true;
  }());
  return true;
}

420 421 422 423 424 425 426 427 428
/// 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));
/// ```
///
429 430
/// This method can be expensive (it walks the element tree).
///
431 432 433 434 435 436 437 438 439
/// 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'
440
          'An overlay lets widgets float on top of other widget children.',
441 442 443 444 445 446
        ),
        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.',
        ),
447 448
        ...context.describeMissingAncestor(expectedAncestorType: Overlay),
      ]);
449 450 451 452 453 454
    }
    return true;
  }());
  return true;
}

455 456 457 458 459
/// 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.
///
460
/// See [the widgets library](widgets/widgets-library.html) for a complete list.
461 462 463 464 465 466
bool debugAssertAllWidgetVarsUnset(String reason) {
  assert(() {
    if (debugPrintRebuildDirtyWidgets ||
        debugPrintBuildScope ||
        debugPrintScheduleBuildForStacks ||
        debugPrintGlobalKeyedWidgetLifecycle ||
467
        debugProfileBuildsEnabled ||
468 469
        debugHighlightDeprecatedWidgets ||
        debugProfileBuildsEnabledUserWidgets) {
470
      throw FlutterError(reason);
471 472
    }
    return true;
473
  }());
474 475
  return true;
}