Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 14 additions & 2 deletions java/org/cef/callback/CefQueryCallback_N.java
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,20 @@
package org.cef.callback;

class CefQueryCallback_N extends CefNativeAdapter implements CefQueryCallback {
// Set once via setPersistent() by MessageRouterHandler::OnQuery() (native
// side), before onQuery() is invoked on the Java handler. See
// Thrameos/java-cef#13: success() must not release the native callback
// after the first call when the originating query was persistent, since
// CEF's message router allows a persistent query's callback to be used
// repeatedly.
private boolean persistent_ = false;

CefQueryCallback_N() {}

void setPersistent(boolean persistent) {
persistent_ = persistent;
}

@Override
protected void finalize() throws Throwable {
failure(-1, "Unexpected call to CefQueryCallback_N::finalize()");
Expand All @@ -16,7 +28,7 @@ protected void finalize() throws Throwable {
@Override
public void success(String response) {
try {
N_Success(getNativeRef(null), response);
N_Success(getNativeRef(null), response, persistent_);
} catch (UnsatisfiedLinkError ule) {
ule.printStackTrace();
}
Expand All @@ -31,6 +43,6 @@ public void failure(int error_code, String error_message) {
}
}

private final native void N_Success(long self, String response);
private final native void N_Success(long self, String response, boolean persistent);
private final native void N_Failure(long self, int error_code, String error_message);
}
107 changes: 107 additions & 0 deletions java/tests/junittests/UpstreamIssue398Test.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
// Copyright (c) 2026 The Chromium Embedded Framework Authors. All rights
// reserved. Use of this source code is governed by a BSD-style license that
// can be found in the LICENSE file.

package tests.junittests;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.cef.browser.CefBrowser;
import org.cef.browser.CefFrame;
import org.cef.browser.CefMessageRouter;
import org.cef.callback.CefQueryCallback;
import org.cef.handler.CefDisplayHandlerAdapter;
import org.cef.handler.CefMessageRouterHandlerAdapter;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;

// Regression test for upstream chromiumembedded/java-cef#398 (and this fork's
// Thrameos/java-cef#13): the CEF message router's "subscription" style query
// workflow (JS sets persistent:true) is documented to allow
// CefQueryCallback.success() to be called repeatedly, with each call invoking
// the JS onSuccess handler again. native/CefQueryCallback_N.cpp's N_Success
// used to unconditionally call ClearSelf() after the first call regardless
// of |persistent|, so the native reference was torn down and a second
// success() call silently did nothing. Fixed by threading |persistent|
// through to N_Success (set on the Java-side callback object by
// MessageRouterHandler::OnQuery() before onQuery() is invoked) and only
// clearing the native ref when the query is not persistent.
@ExtendWith(TestSetupExtension.class)
class UpstreamIssue398Test {
private static final String TEST_URL = "http://test.com/upstream_issue_398.html";
private static final String CONTENT = "<html><body><script>"
+ "window.responseCount = 0;"
+ "window.cefQuery({request: 'subscribe', persistent: true,"
+ " onSuccess: function(response) {"
+ " window.responseCount++;"
+ " document.title = 'response' + window.responseCount;"
+ " },"
+ " onFailure: function(code, msg) { document.title = 'FAIL:' + code; }});"
+ "</script></body></html>";

@Test
void persistentQuerySuccessCanBeCalledMoreThanOnce() {
CefQueryCallback[] savedCallback = {null};
boolean[] gotFirstResponse = {false};
String[] finalTitle = {null};
boolean[] wasPersistent = {false};

TestFrame frame = new TestFrame() {
CefMessageRouter router;

@Override
protected void setupTest() {
router = CefMessageRouter.create();
router.addHandler(new CefMessageRouterHandlerAdapter() {
@Override
public boolean onQuery(CefBrowser browser, CefFrame frame, long queryId,
String request, boolean persistent, CefQueryCallback callback) {
if ("subscribe".equals(request)) {
wasPersistent[0] = persistent;
savedCallback[0] = callback;
callback.success("first");
return true;
}
return false;
}
}, true);
client_.addMessageRouter(router);

client_.addDisplayHandler(new CefDisplayHandlerAdapter() {
@Override
public void onTitleChange(CefBrowser browser, String newTitle) {
if ("response1".equals(newTitle) && !gotFirstResponse[0]) {
gotFirstResponse[0] = true;
// Per the documented "subscription" workflow, this
// second call should invoke the JS onSuccess
// handler again.
savedCallback[0].success("second");
} else if ("response2".equals(newTitle)) {
finalTitle[0] = newTitle;
terminateTest();
}
}
});

addResource(TEST_URL, CONTENT, "text/html");
createBrowser(TEST_URL, true /* useOSR */);
super.setupTest();
}

@Override
protected void cleanupTest() {
router.dispose();
super.cleanupTest();
}
};

frame.awaitCompletion();

assertTrue(wasPersistent[0], "Query should have been sent with persistent:true");
assertTrue(gotFirstResponse[0], "First success() call's response never arrived");
assertEquals("response2", finalTitle[0],
"Second success() call on a persistent query's callback never invoked the "
+ "JS onSuccess handler again");
}
}
9 changes: 7 additions & 2 deletions native/CefQueryCallback_N.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,17 @@ JNIEXPORT void JNICALL
Java_org_cef_callback_CefQueryCallback_1N_N_1Success(JNIEnv* env,
jobject obj,
jlong self,
jstring response) {
jstring response,
jboolean persistent) {
CefRefPtr<CefQueryCallback> callback = GetSelf(self);
if (!callback)
return;
callback->Success(GetJNIString(env, response));
ClearSelf(env, obj);
// A persistent query's callback may be used repeatedly -- only release the
// native reference once the query is done (see N_Failure, which always
// ends the query). See Thrameos/java-cef#13.
if (!persistent)
ClearSelf(env, obj);
}

JNIEXPORT void JNICALL
Expand Down
5 changes: 3 additions & 2 deletions native/CefQueryCallback_N.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions native/message_router_handler.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ bool MessageRouterHandler::OnQuery(
ScopedJNIString jrequest(env, request);
ScopedJNIQueryCallback jcallback(env, callback);

// Record whether this query is persistent so CefQueryCallback_N::success()
// knows not to release its native reference after the first call. See
// Thrameos/java-cef#13.
JNI_CALL_VOID_METHOD(env, jcallback.get(), "setPersistent", "(Z)V",
persistent ? JNI_TRUE : JNI_FALSE);

jboolean jresult = JNI_FALSE;

JNI_CALL_METHOD(env, handle_, "onQuery",
Expand Down
Loading