Skip to content

Conversation

@LongCatIsLooong
Copy link
Contributor

I was debugging an Overlay issue and felt I could have identified the problem faster if the existing assertions provided more information about the current state of the OverlayEntry and Overlay.

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I signed the CLA.
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@LongCatIsLooong LongCatIsLooong requested a review from chunhtai June 22, 2023 17:49
@github-actions github-actions bot added the framework flutter/packages/flutter repository. See also f: labels. label Jun 22, 2023
Copy link
Contributor

@chunhtai chunhtai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

}

bool _debugCanInsertEntry(OverlayEntry entry) {
final List<DiagnosticsNode> operandsInformation = <DiagnosticsNode>[
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

probably wrap the whose thing in assert as well, _debug prefix should be noop if call directly in debug mode. Not sure if there is a style guide for this, but that is what other _debug method behavior else where in the framework.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like dart-lang/sdk#28113 ? I think I can try adding an annotation (e.g., @debugAssert) and prevent it from being called outside of an assert in analyze.dart?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is new to me, if it works, i fine with it


@override
String toString() => '${describeIdentity(this)}(opaque: $opaque; maintainState: $maintainState)';
String toString() => '${describeIdentity(this)}(opaque: $opaque; maintainState: $maintainState)${_disposedByOwner ? "(DISPOSED)" : ""}';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be a bit confused. I think it is possible that it is waiting to be disposed?

Copy link
Contributor Author

@LongCatIsLooong LongCatIsLooong Jun 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

_disposedByOwner invalidates the OverlayEntry immediately. I think the only operation allowed on a disposed OverlayEntry is removeListener (same as ChangeNotifier).
The owner of the OverlayEntry is supposed to call OverlayEntry.dispose(), and it can't be called before OverlayEntry.remove().

@goderbauer
Copy link
Member

(Triage): @LongCatIsLooong is this ready to be merged?

@LongCatIsLooong
Copy link
Contributor Author

I'd like to merge the @debugAssert PR first so I can mark the new methods as debug-only.

@goderbauer
Copy link
Member

@LongCatIsLooong Should we just submit this for now? Since the methods are all private, I am not too worried about the missing annotation.

@LongCatIsLooong LongCatIsLooong added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 8, 2023
@auto-submit
Copy link
Contributor

auto-submit bot commented Aug 8, 2023

auto label is removed for flutter/flutter/129363, due to - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Aug 8, 2023
@LongCatIsLooong LongCatIsLooong added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 9, 2023
@auto-submit auto-submit bot merged commit 5de6684 into flutter:master Aug 9, 2023
@LongCatIsLooong LongCatIsLooong deleted the shameless-plug branch August 9, 2023 00:55
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 9, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 9, 2023
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Aug 9, 2023
flutter/flutter@436df69...f4c25bb

2023-08-09 zanderso@users.noreply.github.com Revert "Handle breaking changes in leak_tracker." (flutter/flutter#132223)
2023-08-09 engine-flutter-autoroll@skia.org Roll Flutter Engine from 8ec575168d44 to 3d3fb4faed02 (3 revisions) (flutter/flutter#132193)
2023-08-09 31859944+LongCatIsLooong@users.noreply.github.com Use pattern matching to avoid strange type annotations (flutter/flutter#131964)
2023-08-09 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6839b88283b6 to 8ec575168d44 (1 revision) (flutter/flutter#132182)
2023-08-09 engine-flutter-autoroll@skia.org Roll Flutter Engine from 29b117aa4192 to 6839b88283b6 (1 revision) (flutter/flutter#132181)
2023-08-09 engine-flutter-autoroll@skia.org Roll Flutter Engine from 82292b8390cb to 29b117aa4192 (5 revisions) (flutter/flutter#132179)
2023-08-09 31859944+LongCatIsLooong@users.noreply.github.com Add more info to `OverlayState.insert` error messages (flutter/flutter#129363)
2023-08-08 36861262+QuncCccccc@users.noreply.github.com Add `textCapitalization` property for `SearchBar` and `SearchAnchor` (flutter/flutter#131459)
2023-08-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 934ebb005d02 to 82292b8390cb (3 revisions) (flutter/flutter#132166)
2023-08-08 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 2.21.2 to 2.21.3 (flutter/flutter#132165)
2023-08-08 jesus_sguerrero@hotmail.com Revert of #120385 (flutter/flutter#132167)
2023-08-08 tessertaha@gmail.com Add `PopupMenuButton.iconColor`, `PopupMenuTheme.iconSize` and fix button icon using unexpected color propert (flutter/flutter#132054)
2023-08-08 ian@hixie.ch More PageStorage clarity in the documentation (flutter/flutter#131954)
2023-08-08 ian@hixie.ch Document that missed_frame_build_budget_count is misleading (flutter/flutter#132137)
2023-08-08 chingjun@google.com Locate the template directory using a TemplatePathProvider. (flutter/flutter#132156)
2023-08-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from dd03fae51d38 to 934ebb005d02 (4 revisions) (flutter/flutter#132159)
2023-08-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 22bd35a19352 to dd03fae51d38 (3 revisions) (flutter/flutter#132149)
2023-08-08 tessertaha@gmail.com Fix `TabBarTheme.indicatorColor` not applied in Material 2 (flutter/flutter#132123)
2023-08-08 76067278+aakash-pamnani@users.noreply.github.com Paginated Data Table : Fixed Row number at footer in last page  (flutter/flutter#130389)
2023-08-08 mdebbar@google.com [web] Use benchmark callback from `dart:ui_web` (flutter/flutter#132087)
2023-08-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 99fdac88f3c6 to 22bd35a19352 (3 revisions) (flutter/flutter#132141)
2023-08-08 louisehsu@google.com [framework] Add Search Web to selection controls for iOS (flutter/flutter#131898)
2023-08-08 jmccandless@google.com Remove Iterator from _History (flutter/flutter#132101)
2023-08-08 ian@hixie.ch Update dartdoc driver to match current behaviour (flutter/flutter#132078)
2023-08-08 ian@hixie.ch More documentation about warm-up frames (flutter/flutter#132085)
2023-08-08 engine-flutter-autoroll@skia.org Roll Flutter Engine from 146c4c9487fc to 99fdac88f3c6 (3 revisions) (flutter/flutter#132135)
2023-08-08 engine-flutter-autoroll@skia.org Roll Packages from d7ee75a to ac41376 (8 revisions) (flutter/flutter#132133)
2023-08-08 polinach@google.com Handle breaking changes in leak_tracker. (flutter/flutter#131998)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC rmistry@google.com,stuartmorgan@google.com,tarrinneal@google.com on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants