Fix debugNeedsPaint/Layout/CompositedLayerUpdate crashing in release mode

[realmeylisdev]

Summary

• debugNeedsPaint, debugNeedsLayout, and debugNeedsCompositedLayerUpdate use a late variable inside an assert() closure, which means the variable is never initialized in release mode — causing a LateInitializationError crash when accessed
• Replace the late + assert pattern with an explicit kReleaseMode check that returns false in release builds, matching the documented intent

Changes

• packages/flutter/lib/src/rendering/object.dart: Updated all 3 debug getters to use kReleaseMode guard instead of late+assert pattern
• Updated doc comments to say "Always returns false in release builds" instead of "In release builds, this throws"

Fixes #183696

[flutter-dashboard]

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

[gemini-code-assist]

Code Review

This pull request modifies RenderObject to return false for debugNeedsLayout, debugNeedsPaint, and debugNeedsCompositedLayerUpdate in release builds, replacing the previous behavior that would throw when asserts were disabled. The review feedback recommends using !kDebugMode instead of kReleaseMode to ensure consistent behavior in both profile and release modes and suggests updating the documentation to reflect that these properties return false in all non-debug builds.

[gemini-code-assist]

Using kReleaseMode only handles the release build case. However, since assert blocks are also disabled in profile mode, the original implementation would have crashed there as well. To ensure consistent behavior across all non-debug builds (Profile and Release) and to follow the convention for debug* properties, consider using !kDebugMode instead. This ensures the property returns false in both profile and release modes, and the documentation should be updated to reflect this.

  /// out and painted. Always returns false in non-debug builds.
  ///
  /// It is intended to be used by tests and asserts.
  bool get debugNeedsLayout {
    if (!kDebugMode) {
      return false;
    }
    return _needsLayout;

References

1. Code should follow the guidance and principles described in the Flutter contribution guide, which includes doing things right for all build modes. ^(link)

[gemini-code-assist]

If the implementation is changed to use !kDebugMode, the documentation should be updated to reflect that it returns false in all non-debug builds (including profile mode).

  /// out and painted. Always returns false in non-debug builds.

[gemini-code-assist]

Consider using !kDebugMode instead of kReleaseMode to ensure consistent behavior in both Profile and Release modes, as assert statements are disabled in both. This also aligns with the naming convention for debug* properties.

    if (!kDebugMode) {
      return false;
    }
    return _needsPaint;

[gemini-code-assist]

Similar to the other debug properties, using !kDebugMode is preferred over kReleaseMode to provide consistent behavior across all non-debug builds (Profile and Release) and to match the updated documentation.

  /// out and painted. Always returns false in non-debug builds.
  ///
  /// It is intended to be used by tests and asserts.
  bool get debugNeedsCompositedLayerUpdate {
    if (!kDebugMode) {
      return false;
    }
    return _needsCompositedLayerUpdate;

[Piinks]

These are not meant to be called in release mode. I wonder if the fix is in the other direction, fixing the places where this pattern is not honored. I need to look into the other cases where tis has been allowed.

[futpib]

Check this out, I tried a similar PR, landed an a linter instead #183697

[Piinks]

Touching base with @chunhtai about this, I see the issue references how debugNeedsSemanticsUpdate works, which was introduced in https://github.com/flutter/flutter/pull/151688/files

[Piinks]

Caught up with @chunhtai on this, we both agree that debug method is ok to be called outside of debug mode, but they won't return meaningful result. I think this LGTM as it aligns with debugNeedsSemanticsUpdate, and we are looking into comprehensive lint coverage in #185091
Thanks for you patience while I double checked this.

[Piinks]

LGTM

[chunhtai]

LGTM

[auto-submit]

autosubmit label was removed for flutter/flutter/184627, because - The status or check suite Windows framework_tests_libraries has failed. Please fix the issues identified (or deflake) before re-applying this label.