fix(overlays): getTop now returns the top-most presented overlay

[sean-perkins]

Pull request checklist

Please check if your PR fulfills the following requirements:

• Tests for the changes have been added (for bug fixes / features)
• Docs have been reviewed and added / updated if needed (for bug fixes / features)
• Build (npm run build) was run locally and any changes were pushed
• Lint (npm run lint) has passed locally and any fixes were made for failures

Pull request type

Please check the type of change your PR introduces:

• Bugfix
• Feature
• Code style update (formatting, renaming)
• Refactoring (no functional changes, no api changes)
• Build related changes
• Documentation content changes
• Other (please describe):

What is the current behavior?

The logic for getTop does not take into consideration hidden overlays. With usages of an inline modal within a modal instance using a controller; you are unable to dismiss the modal using dismiss or getTop without an id.

Issue Number: #19111, #24545

What is the new behavior?

Only visible overlays are returned in getOverlay, used by the getTop logic.

Does this introduce a breaking change?

• Yes
• No

Other information

Reproduction app: https://github.com/sean-perkins/gh-24545-modal-top

• Install dev build:

npm i @ionic/[email protected]
npm i @ionic/[email protected]

• Run app
• Open modal with the button
• Dismiss modal with the button

[liamdebeasi]

This is off to a great start 🚀 ! The angular test comment is not blocking, though it seems like we could simplify that by making it a test in core rather than angular.

[liamdebeasi]

Great job! One idea for the commit subject could be fix(overlays): getTop now returns the top-most presented overlay or something like that. getOverlay return visible overlay likely does not mean much to a dev since getOverlay is internal.