Files
logos-protocol/cpp/implementations/qt_remote/remote_transport.cpp
T
Dario LipicarandClaude Opus 4.8 4ea32a314a Per-module concurrent dispatch: async provider seam + transports (#5)
* feat: per-module concurrent dispatch (concurrency:"multi") — zero ABI change

A "multi" module serves calls concurrently behind the ORDINARY callMethod — no
new provider/host vtable method, so LogosProviderObject's ABI is byte-identical
to before and an old host/daemon loads and forwards a multi module unmodified.

Mechanism: a multi module's generated glue returns a pending sentinel
({"__logos_pending_call__": callId}) from callMethod and pushes the real result
back later as a __logos_call_complete__ event keyed by callId, over the existing
event channel. The consumer transport detects the sentinel and awaits the
completion transparently, so generated clients are unchanged.

- logos_async_dispatch.h: shared wire constants + the contract.
- remote_transport.cpp (QtRO) / plain_logos_object.{h,cpp} (plain): consumer
  sentinel detection + await keyed by callId. The host is a pure forwarder.
- logos_protocol.h + nix/default.nix: protocol 0.2.0 (additive minor; same MAJOR
  stays compatible, so an old host accepts a 0.2 "multi" module).
- rpc_server.cpp: fix a teardown self-deadlock (stop() held m_mu while invoking a
  per-connection error handler that re-locks m_mu) that the new in-process
  subscription path exposed.
- tests/protocol/test_concurrent_dispatch.cpp: proves a multi provider overlaps
  two concurrent calls (peak 2) while single serializes (peak 1), over the plain
  transport, with the host unchanged from master.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* fix: coalesce concurrent async requestModule handshakes (+ async fan-out test)

A driver that fans out N async calls to an un-tokened target before any
completes used to fire N separate requestModule handshakes. Each mints a
distinct capability token and informs the target, and the later inform
OVERWRITES the earlier token there (the target stores one token per caller),
so the already-dispatched calls carried a superseded token and the target
rejected them as unauthorized ("auth token not recognized"). The sync path
never hit this — it blocks per call, so handshakes never overlap.

Coalesce in LogosAPIClient::invokeRemoteMethodAsync: the first async call to
an un-tokened target starts ONE handshake; concurrent calls to the same
target queue behind it and all drain with the single minted token when it
resolves. m_pendingHandshakes is touched only on the owner thread, so no lock
(appended last per the class's ABI note). This is what lets a concurrency:
"multi" worker actually run a single-threaded driver's fan-out concurrently —
otherwise the fanned-out calls are rejected before reaching dispatch.

Also add MultiProviderOverlapsAsync / SingleProviderSerializesAsync to the
concurrent-dispatch gtest: they fire N concurrent callMethodAsync() calls (the
fan-out pattern over the async consumer path, which the sync tests don't
exercise) and assert peak overlap 4 for "multi", 1 for "single".

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-19 15:54:42 -03:00

456 lines
17 KiB
C++

#include "remote_transport.h"
#include "../../logos_async_dispatch.h"
#include <QRemoteObjectRegistryHost>
#include <QRemoteObjectNode>
#include <QRemoteObjectReplica>
#include <QRemoteObjectPendingCall>
#include <QRemoteObjectPendingCallWatcher>
#include <QTimer>
#include <QEventLoop>
#include <QDebug>
#include <QUrl>
#include <QMetaObject>
#include <QTime>
#include <QJsonArray>
#include <QVariantMap>
// ── RemoteLogosObject ────────────────────────────────────────────────────────
namespace {
class RemoteEventHelper : public QObject {
Q_OBJECT
public:
explicit RemoteEventHelper(QObject* parent = nullptr) : QObject(parent) {}
void addCallback(const QString& eventName, LogosObject::EventCallback cb) {
m_callbacks[eventName].append(std::move(cb));
}
public slots:
void onEventResponse(const QString& eventName, const QVariantList& data) {
// Dispatch to callbacks registered for this specific event name,
// plus any wildcard subscribers (callbacks registered with an
// empty event name, meaning "receive every event").
auto cbs = m_callbacks.value(eventName);
cbs.append(m_callbacks.value(QString()));
if (!cbs.isEmpty()) {
qDebug() << "[LogosObject] Remote EventHelper: dispatching event" << eventName << "to" << cbs.size() << "callback(s) (via IPC)";
}
for (const auto& cb : cbs) {
try { cb(eventName, data); } catch (...) {}
}
}
private:
QHash<QString, QList<LogosObject::EventCallback>> m_callbacks;
};
} // anonymous namespace
class RemoteLogosObject : public LogosObject {
public:
explicit RemoteLogosObject(QObject* replica)
: m_replica(replica), m_helper(nullptr)
{
qDebug() << "[LogosObject] Created RemoteLogosObject wrapping QRemoteObjectReplica" << reinterpret_cast<quintptr>(replica);
if (m_replica) {
// Eager event wiring — a deferred ("multi") call's result arrives as a
// completion event, so the channel must be live even when the caller
// never subscribes to a user event. onEvent() reuses this same helper.
m_helper = new RemoteEventHelper();
QObject::connect(m_replica, SIGNAL(eventResponse(QString,QVariantList)),
m_helper, SLOT(onEventResponse(QString,QVariantList)));
m_helper->addCallback(logos::callCompleteEvent(),
[this](const QString&, const QVariantList& data) {
if (data.size() != 2) return;
const QString id = data.at(0).toString();
const QVariant result = data.at(1);
m_completions.insert(id, result);
if (QEventLoop* loop = m_completionWaiters.value(id, nullptr))
loop->quit(); // wake a sync waiter
if (m_asyncCompletionCbs.contains(id)) { // fire an async waiter
auto cb = m_asyncCompletionCbs.take(id);
m_completions.remove(id);
if (cb) cb(result);
}
});
}
}
~RemoteLogosObject() override {
qDebug() << "[LogosObject] Destroying RemoteLogosObject" << reinterpret_cast<quintptr>(m_replica);
delete m_helper;
}
QVariant callMethod(const QString& authToken,
const QString& methodName,
const QVariantList& args,
int timeoutMs) override
{
if (!m_replica) {
qWarning() << "RemoteLogosObject: Cannot call method on null replica";
return QVariant();
}
qDebug() << "[LogosObject] RemoteLogosObject::callMethod" << methodName << "args:" << args.size();
QRemoteObjectPendingCall pendingCall;
bool success = QMetaObject::invokeMethod(
m_replica,
"callRemoteMethod",
Qt::DirectConnection,
Q_RETURN_ARG(QRemoteObjectPendingCall, pendingCall),
Q_ARG(QString, authToken),
Q_ARG(QString, methodName),
Q_ARG(QVariantList, args)
);
if (!success) {
qWarning() << "RemoteLogosObject: Failed to invoke callRemoteMethod on replica";
return QVariant();
}
pendingCall.waitForFinished(timeoutMs);
if (!pendingCall.isFinished() || pendingCall.error() != QRemoteObjectPendingCall::NoError) {
qWarning() << "RemoteLogosObject: callRemoteMethod failed or timed out:" << pendingCall.error();
return QVariant();
}
// A "multi" provider may have deferred the result (returned a pending
// sentinel); resolveDeferred waits for the completion event, or returns
// the value unchanged for an ordinary (synchronous) result.
return resolveDeferred(pendingCall.returnValue(), timeoutMs);
}
void callMethodAsync(const QString& authToken,
const QString& methodName,
const QVariantList& args,
int timeoutMs,
AsyncResultCallback callback) override
{
if (!callback) return;
if (!m_replica) {
QTimer::singleShot(0, [callback]() { callback(QVariant()); });
return;
}
qDebug() << "[LogosObject] RemoteLogosObject::callMethodAsync" << methodName << "args:" << args.size();
QRemoteObjectPendingCall pendingCall;
bool success = QMetaObject::invokeMethod(
m_replica,
"callRemoteMethod",
Qt::DirectConnection,
Q_RETURN_ARG(QRemoteObjectPendingCall, pendingCall),
Q_ARG(QString, authToken),
Q_ARG(QString, methodName),
Q_ARG(QVariantList, args)
);
if (!success) {
qWarning() << "RemoteLogosObject: Failed to invoke callRemoteMethod on replica (async)";
QTimer::singleShot(0, [callback]() { callback(QVariant()); });
return;
}
auto* watcher = new QRemoteObjectPendingCallWatcher(pendingCall);
// Timeout timer -- parented to the watcher so it is auto-deleted
// when the watcher is destroyed, preventing late timeout callbacks.
auto* timer = new QTimer(watcher);
timer->setSingleShot(true);
// Success handler -- delivers result on the consumer's thread
QObject::connect(watcher, &QRemoteObjectPendingCallWatcher::finished,
watcher, [this, callback, timer, timeoutMs](QRemoteObjectPendingCallWatcher* w) {
timer->stop(); // cancel timeout
QVariant result;
if (w->error() == QRemoteObjectPendingCall::NoError) {
result = w->returnValue();
} else {
qWarning() << "RemoteLogosObject: async callMethod error:" << w->error();
}
w->deleteLater();
// A "multi" provider may have deferred the result: wait for the
// completion event instead of delivering the pending sentinel.
if (result.typeId() == QMetaType::QVariantMap) {
const QVariantMap m = result.toMap();
if (m.contains(logos::pendingCallKey())) {
const QString callId = m.value(logos::pendingCallKey()).toString();
if (m_completions.contains(callId)) { callback(m_completions.take(callId)); return; }
m_asyncCompletionCbs.insert(callId, callback);
// Bound the wait: deliver an empty result once if it never lands.
QTimer::singleShot(timeoutMs, m_helper, [this, callId]() {
if (m_asyncCompletionCbs.contains(callId)) {
auto cb = m_asyncCompletionCbs.take(callId);
if (cb) cb(QVariant());
}
});
return;
}
}
callback(result);
}, Qt::QueuedConnection);
// Timeout handler -- stops the watcher and delivers empty result
QObject::connect(timer, &QTimer::timeout, watcher, [watcher, callback]() {
qWarning() << "RemoteLogosObject: async callMethod timed out";
callback(QVariant());
watcher->deleteLater(); // also destroys the timer (child)
});
timer->start(timeoutMs);
}
bool informModuleToken(const QString& authToken,
const QString& moduleName,
const QString& token,
int timeoutMs) override
{
if (!m_replica) {
qWarning() << "RemoteLogosObject: Cannot call informModuleToken on null replica";
return false;
}
QRemoteObjectPendingCall pendingCall;
bool success = QMetaObject::invokeMethod(
m_replica,
"informModuleToken",
Qt::DirectConnection,
Q_RETURN_ARG(QRemoteObjectPendingCall, pendingCall),
Q_ARG(QString, authToken),
Q_ARG(QString, moduleName),
Q_ARG(QString, token)
);
if (!success) {
qWarning() << "RemoteLogosObject: Failed to invoke informModuleToken on replica";
return false;
}
pendingCall.waitForFinished(timeoutMs);
if (!pendingCall.isFinished() || pendingCall.error() != QRemoteObjectPendingCall::NoError) {
qWarning() << "RemoteLogosObject: informModuleToken failed or timed out:" << pendingCall.error();
return false;
}
return pendingCall.returnValue().toBool();
}
void onEvent(const QString& eventName, EventCallback callback) override
{
if (!m_replica) return;
qDebug() << "[LogosObject] RemoteLogosObject::onEvent subscribing to event:" << eventName;
if (!m_helper) {
m_helper = new RemoteEventHelper();
QObject::connect(m_replica, SIGNAL(eventResponse(QString,QVariantList)),
m_helper, SLOT(onEventResponse(QString,QVariantList)));
qDebug() << "[LogosObject] RemoteLogosObject: connected EventHelper to QRemoteObjectReplica signals (IPC)";
}
m_helper->addCallback(eventName, std::move(callback));
}
void disconnectEvents() override
{
delete m_helper;
m_helper = nullptr;
}
void emitEvent(const QString& eventName, const QVariantList& data) override
{
if (!m_replica) return;
qDebug() << "[LogosObject] RemoteLogosObject::emitEvent" << eventName << "data:" << data.size() << "items (via IPC)";
QMetaObject::invokeMethod(m_replica, "eventResponse",
Qt::QueuedConnection,
Q_ARG(QString, eventName),
Q_ARG(QVariantList, data));
}
QJsonArray getMethods() override
{
// Remote introspection not implemented — callers should use
// the local module inspection tools (lm) instead.
return QJsonArray();
}
void release() override
{
disconnectEvents();
delete m_replica;
m_replica = nullptr;
delete this;
}
quintptr id() const override { return reinterpret_cast<quintptr>(m_replica); }
private:
// Resolve a possibly-deferred result. If `rv` is a pending sentinel from a
// "multi" provider, wait (up to timeoutMs) for the completion event keyed by
// callId, pumping the consumer event loop; otherwise return `rv` unchanged.
QVariant resolveDeferred(const QVariant& rv, int timeoutMs)
{
if (rv.typeId() != QMetaType::QVariantMap) return rv;
const QVariantMap m = rv.toMap();
if (!m.contains(logos::pendingCallKey())) return rv;
const QString callId = m.value(logos::pendingCallKey()).toString();
// The completion can arrive during the call's own waitForFinished above.
if (m_completions.contains(callId)) return m_completions.take(callId);
QEventLoop loop;
m_completionWaiters.insert(callId, &loop);
QTimer timer;
timer.setSingleShot(true);
QObject::connect(&timer, &QTimer::timeout, &loop, &QEventLoop::quit);
timer.start(timeoutMs > 0 ? timeoutMs : 30000);
loop.exec();
m_completionWaiters.remove(callId);
if (m_completions.contains(callId)) return m_completions.take(callId);
qWarning() << "RemoteLogosObject: deferred call" << callId << "timed out";
return QVariant();
}
QObject* m_replica;
RemoteEventHelper* m_helper;
// Deferred ("multi") completions delivered over the event channel, keyed by
// callId: buffered results + sync (QEventLoop) and async (callback) waiters.
// Touched only on the consumer event-loop thread.
QHash<QString, QVariant> m_completions;
QHash<QString, QEventLoop*> m_completionWaiters;
QHash<QString, AsyncResultCallback> m_asyncCompletionCbs;
};
// ── RemoteTransportHost ──────────────────────────────────────────────────────
RemoteTransportHost::RemoteTransportHost(const QString& registryUrl)
: m_registryHost(nullptr)
, m_registryUrl(registryUrl)
{
}
RemoteTransportHost::~RemoteTransportHost()
{
delete m_registryHost;
}
bool RemoteTransportHost::publishObject(const QString& name, QObject* object)
{
if (!m_registryHost) {
m_registryHost = new QRemoteObjectRegistryHost(QUrl(m_registryUrl));
if (!m_registryHost) {
qCritical() << "RemoteTransportHost: Failed to create registry host";
return false;
}
qDebug() << "RemoteTransportHost: Created registry host with URL:" << m_registryUrl;
}
bool success = m_registryHost->enableRemoting(object, name);
if (success) {
qDebug() << "RemoteTransportHost: Published object:" << name;
} else {
qCritical() << "RemoteTransportHost: Failed to publish object:" << name;
}
return success;
}
void RemoteTransportHost::unpublishObject(const QString& /*name*/)
{
}
// ── RemoteTransportConnection ────────────────────────────────────────────────
RemoteTransportConnection::RemoteTransportConnection(const QString& registryUrl)
: m_node(new QRemoteObjectNode())
, m_registryUrl(registryUrl)
, m_connected(false)
{
}
RemoteTransportConnection::~RemoteTransportConnection()
{
delete m_node;
}
bool RemoteTransportConnection::connectToHost()
{
return connectToRegistry();
}
bool RemoteTransportConnection::isConnected() const
{
return m_connected;
}
bool RemoteTransportConnection::reconnect()
{
qDebug() << "RemoteTransportConnection: Attempting to reconnect to registry:" << m_registryUrl;
if (m_connected) {
delete m_node;
m_node = new QRemoteObjectNode();
m_connected = false;
}
return connectToRegistry();
}
bool RemoteTransportConnection::connectToRegistry()
{
if (!m_node) {
qWarning() << "RemoteTransportConnection: Remote object node is null";
return false;
}
if (m_registryUrl.isEmpty()) {
qWarning() << "RemoteTransportConnection: Registry URL is empty";
return false;
}
qDebug() << "RemoteTransportConnection: Connecting to registry:" << m_registryUrl
<< "at" << QTime::currentTime().toString("hh:mm:ss.zzz");
QUrl url(m_registryUrl);
bool success = m_node->connectToNode(url);
if (success) {
m_connected = true;
qDebug() << "RemoteTransportConnection: Successfully connected to registry:" << m_registryUrl;
} else {
m_connected = false;
qWarning() << "RemoteTransportConnection: Failed to connect to registry:" << m_registryUrl;
}
qDebug() << "RemoteTransportConnection: Connected to registry at"
<< QTime::currentTime().toString("hh:mm:ss.zzz");
return m_connected;
}
LogosObject* RemoteTransportConnection::requestObject(const QString& objectName, int timeoutMs)
{
if (!m_connected) {
qWarning() << "RemoteTransportConnection: Not connected. Cannot request object:" << objectName;
return nullptr;
}
qDebug() << "RemoteTransportConnection: Requesting object:" << objectName
<< "at" << QTime::currentTime().toString("hh:mm:ss.zzz");
QRemoteObjectReplica* replica = m_node->acquireDynamic(objectName);
if (!replica) {
qWarning() << "RemoteTransportConnection: Failed to acquire replica for:" << objectName;
return nullptr;
}
if (!replica->waitForSource(timeoutMs)) {
qWarning() << "RemoteTransportConnection: Timeout waiting for replica:" << objectName;
delete replica;
return nullptr;
}
qDebug() << "[LogosObject] RemoteTransportConnection: returning RemoteLogosObject for:" << objectName;
return new RemoteLogosObject(replica);
}
#include "remote_transport.moc"