Skip to content

Edge: Improve handling of LocationListener#changed() #1451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2024
Merged

Edge: Improve handling of LocationListener#changed() #1451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 33 additions & 21 deletions bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Edge.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -666,9 +666,10 @@ int handleNavigationStarting(long pView, long pArgs, boolean top) {
listener.changing(event);
if (browser.isDisposed()) return COM.S_OK;
}
// Save location and top for all events that use navigationId.
// will be eventually cleared again in handleNavigationCompleted().
navigations.put(pNavId[0], event);
if (event.doit) {
// Save location and top for all events that use navigationId.
navigations.put(pNavId[0], event);
jsEnabled = jsEnabledOnNextPage;
settings.put_IsScriptEnabled(jsEnabled);
// Register browser functions in the new document.
Expand All @@ -690,23 +691,13 @@ int handleSourceChanged(long pView, long pArgs) {
// to an empty string. Navigations with NavigateToString set the Source
// to about:blank. Initial Source is about:blank. If Source value
// is the same between navigations, SourceChanged isn't fired.
// TODO: emit missing location changed events
long[] ppsz = new long[1];
int hr = webView.get_Source(ppsz);
if (hr != COM.S_OK) return hr;
String url = getExposedUrl(wstrToString(ppsz[0], true));
browser.getDisplay().asyncExec(() -> {
if (browser.isDisposed()) return;
LocationEvent event = new LocationEvent(browser);
event.display = browser.getDisplay();
event.widget = browser;
event.location = url;
event.top = true;
for (LocationListener listener : locationListeners) {
listener.changed(event);
if (browser.isDisposed()) return;
}
});
// Calling LocationListener#changed() was moved to
// handleNavigationCompleted() to have consistent/symmetric
// LocationListener.changing() -> LocationListener.changed() behavior.
// TODO: #fragment navigation inside a page does not result in
// NavigationStarted / NavigationCompleted events from WebView2.
// so for now we cannot send consistent changing() + changed() events
// for those scenarios.
return COM.S_OK;
}

Expand Down Expand Up @@ -795,11 +786,32 @@ int handleNavigationCompleted(long pView, long pArgs, boolean top) {
long[] pNavId = new long[1];
args.get_NavigationId(pNavId);
LocationEvent startEvent = navigations.remove(pNavId[0]);
if (webView_2 == null && startEvent != null && startEvent.top) {
// If DOMContentLoaded isn't available, fire
if (startEvent == null) {
// handleNavigationStarted() always stores the event, so this should never happen
return COM.S_OK;
}
if (webView_2 == null && startEvent.top) {
// If DOMContentLoaded (part of ICoreWebView2_2 interface) isn't available, fire
// ProgressListener.completed from here.
sendProgressCompleted();
}
int[] pIsSuccess = new int[1];
args.get_IsSuccess(pIsSuccess);
if (pIsSuccess[0] != 0) {
browser.getDisplay().asyncExec(() -> {
if (browser.isDisposed()) return;
LocationEvent event = new LocationEvent(browser);
event.display = browser.getDisplay();
event.widget = browser;
event.location = startEvent.location;
event.top = startEvent.top;
for (LocationListener listener : locationListeners) {
listener.changed(event);
if (browser.isDisposed()) return;
}
});
}

return COM.S_OK;
}

Expand Down
13 changes: 13 additions & 0 deletions ...t.tests/JUnit Tests/org/eclipse/swt/tests/junit/Test_org_eclipse_swt_browser_Browser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -606,6 +606,19 @@ public void test_LocationListener_changed() {
boolean passed = waitForPassCondition(changedFired::get);
assertTrue("LocationListener.changed() event was never fired", passed);
}
@Test
public void test_LocationListener_changed_twoSetTextCycles() {
AtomicInteger changedCount = new AtomicInteger();
browser.addLocationListener(changedAdapter(e -> changedCount.incrementAndGet()));
shell.open();
browser.setText("Hello world");
boolean passed = waitForPassCondition(() -> changedCount.get() == 1);
assertTrue("LocationListener.changed() event was never fired", passed);
browser.setText("2nd text");
passed = waitForPassCondition(() -> changedCount.get() == 2);
assertTrue("LocationListener.changed() event was not fired for the 2nd text change", passed);
}

@Test
public void test_LocationListener_changingAndOnlyThenChanged() {
// Test proper order of events.
Expand Down