fix: navigation delegation loops

msmtamburro commented 1 year ago

note: works around, rather than addresses existing architectural issues (#1031) note: should be reviewed after merging this related PR https://github.com/apache/cordova-ios/pull/1050

Platforms affected

cordova-ios

Motivation and Context

This is related to https://github.com/apache/cordova-ios/pull/1031, in that I noticed the existing looping/reflection pattern in CDVWebViewEngine was copied, and I wanted to provide an example of how to allow consumers to explicitly be delegates, so that pattern, which crashes, does not make its way in to other pieces of code.

Description

The existing behavior, that CDVViewController can be a WKNavigationDelegate, was not obvious, so I documented it. While it would be more explicit to set the navigation delegate in the designated initializer (like is done with the WKWebViewConfiguration), I did not want to drastically change what's being done here. The existing behavior also loops through the plugins and uses reflection to see if any handle specific WKNavigationDelegate methods. The way this is done can crash (is crashing in my production app), as the list of plugins can change while this loop iterates.

What I did change:

When a consumer has bothered to extend CDVViewController to be a WKNavigationDelegate, I've disabled the looping
I cleaned up the looping to make it less likely to crash

Testing

I've tested the existing behavior:

Overriding does not disable looping
Looping does not appear to crash

I've tested the new behavior:

Looping is disabled when overriding (making CDVViewController a WKNavigationDelegate)

Checklist

[ ] I've run the tests to see all new and existing tests pass
[ ] I added automated test coverage as appropriate for this change
[ ] Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
[x] If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
[ ] I've updated the documentation if necessary

msmtamburro commented 1 year ago

Thanks for your patience; I've re-raised this PR now that I've gotten access at work again.

msmtamburro commented 1 year ago

Issue with the codecov.io setup? {'detail': ErrorDetail(string='Missing "owner" argument. Please upload with the Codecov repository upload token to resolve issue.', code='not_found')}

breautek commented 1 year ago

I'll rerun the test, I think that happens intermediately sometimes.

msmtamburro commented 4 months ago

Before I lose access again (through work), this one seems like it is good to go.

codecov-commenter commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 78.25%. Comparing base (6e93ee9) to head (e1d8a81). Report is 38 commits behind head on master.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #1272 +/- ## ========================================== - Coverage 78.26% 78.25% -0.02% ========================================== Files 15 15 Lines 1767 1789 +22 ========================================== + Hits 1383 1400 +17 - Misses 384 389 +5 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

apache / cordova-ios