Files
logos-protocol/cpp/logos_api_client.h
T
Dario Lipicar 9de4165ab6 Qt split + module authoring groundwork: LogosProviderPlugin + the common module-impl C ABI (#3)
* Extract the Logos protocol layer from logos-cpp-sdk

Transports (plain TCP/TLS, qt_local, qt_remote/QRO, mock), token manager,
consumer core (LogosAPIClient/LogosAPIConsumer incl. the capability
auto-requestModule flow), ModuleProxy, the abstract LogosProviderObject
interface, and the canonical QVariant<->JSON conversion — now behind the
language-neutral lp_* C ABI (logos_protocol.h) carrying the protocol
semver (LOGOS_PROTOCOL_VERSION_*, lp_protocol_version()).

Bytes crossing the ABI use the lossless {"_bytes": base64url} tagging
(NUL-safe), matching the plain wire encoding.

Provider lp_* surface is compiled groundwork; serving lands with module
authoring.

* Move LogosProviderPlugin into logos_provider_interface.h

Plugin-loading tools (logos-cpp-generator's introspection mode, lm, the
hosts) need only qobject_cast<LogosProviderPlugin*>() + the abstract
LogosProviderObject — both framework-internal. Hosting the detection
interface here keeps those tools off the developer-facing logos-qt-sdk
layer. Same iid (org.logos.LogosProviderPlugin); header-only, ABI-neutral.

* Define the common module-impl C ABI (logos_module_impl.h)

ONE cdylib contract for module implementations in every language:
dispatch / get_methods / set_context / set_emit_callback / accept_token
/ get_protocol_version / string_free. The C++ and Rust SDKs emit these
exports around their respective impls; the uniform generated Qt glue
(and later a no-Qt host) talks to the cdylib only through this ABI.
JSON data model and tagged bytes form match the lp_* consumer ABI; the
protocol-version handshake complements the build-time metadata stamp.

* json convert: integers stay integers across the C ABI

QJsonValue::fromVariant degrades every numeric to double, so Int/UInt/
LongLong/ULongLong QVariants serialized as 5.0 — and a strict consumer on
the other side of the C ABI (a generated dispatch reading an int param)
rejects or zeroes them. Surfaced by the first cdylib-authored module
whose inbound args cross qvariantToNlohmann; the dlopen smoke harness
fed hand-written int JSON and never exercised this edge.

* call-error channel: surface {code,message,origin} for unacquirable targets

invokeRemoteMethod could not distinguish a failed call from a void/null
result — lp_invoke returned LP_OK with a null JSON result even when the
target module was never reached, and generated typed wrappers silently
defaulted (0 / empty string). Additive err-out overloads on
LogosAPIConsumer/LogosAPIClient fill a std-only logos::CallError
(logos_call_error.h, new LogosCallError exception for the generated
wrappers to throw); lp_invoke now honors its documented contract for
this class of failure: LP_ERR_UNAVAILABLE + canonical error JSON.
First detectable code: object_unavailable (requestObject failure) —
the struct is the extension point for transport-level statuses.

* call-error: drop the exception type — the error channel is the out-param

Per review, generated wrappers expose CallError as an optional trailing
out-parameter instead of throwing; the struct is the whole contract.

* ci: build + run the protocol test suite

On every pull request (unfiltered — stacked PRs included), master pushes,
and manual dispatch. The repo shipped without CI; its 111-test suite only
ran locally and through the workspace gate.

* consumer: typed requestModule for the capability flow

Port of logos-cpp-sdk master f5a127dd ('use updated capability module',
cpp-sdk#85, Iuri Matias) — the touched files (logos_api_client.cpp,
logos_api_consumer.{h,cpp}) moved into this repo in the P1 extraction.
The capability auto-requestModule path now calls a typed std::string
helper on the consumer (which acquires the capability object directly)
instead of a stringly invokeRemoteMethod round-trip. 111/111 tests.

* ci: DeterminateSystems nix installer (macOS runners)

cachix/install-nix-action fails on the macOS runners with
eDSRecordAlreadyExists (pre-existing nix build users); the org's
macOS-bearing workflows use the DeterminateSystems installer.
2026-06-12 19:39:57 -03:00

288 lines
15 KiB
C++

#ifndef LOGOS_API_CLIENT_H
#define LOGOS_API_CLIENT_H
#include <QObject>
#include <QString>
#include <QVariant>
#include <QVariantList>
#include <QMap>
#include <functional>
#include <string>
#include "logos_call_error.h"
#include "logos_mode.h"
#include "logos_transport_config.h"
#include <nlohmann/json.hpp>
class LogosAPI;
class LogosAPIConsumer;
class LogosObject;
class TokenManager;
/**
* @brief LogosAPIClient provides a high-level interface for remote method calls
*
* This class serves as a facade over LogosAPIConsumer, providing a clean interface
* for applications that need to call remote methods and handle events.
*/
class LogosAPIClient : public QObject
{
Q_OBJECT
public:
/**
* @brief Construct a client with explicit transports for both the
* target module *and* `capability_module`.
*
* Two transports because the SDK's auto-`requestModule` flow inside
* invokeRemoteMethod{,Async} dials `capability_module` to fetch a
* per-target token. When the daemon advertises capability_module on
* a different transport from the target (e.g. CLI on host →
* core_service over TCP, but capability_module also over TCP on a
* sibling port), the auto-dial must use the right one. Pre-building
* the consumer once in the constructor (see m_capability_consumer)
* keeps the hot path free of per-call lookups.
*/
LogosAPIClient(const QString& module_to_talk_to,
const QString& origin_module,
TokenManager* token_manager,
const LogosTransportConfig& target_transport,
const LogosTransportConfig& capability_transport,
QObject *parent = nullptr);
/**
* @brief No-transport constructor — both target and
* capability_module use the process-global default
* (LocalSocket) via LogosTransportConfigGlobal::getDefault().
*/
explicit LogosAPIClient(const QString& module_to_talk_to,
const QString& origin_module,
TokenManager* token_manager,
QObject *parent = nullptr);
~LogosAPIClient();
/**
* @brief Request a LogosObject handle by name
* @return LogosObject* handle, or nullptr if failed
*/
LogosObject* requestObject(const QString& objectName, Timeout timeout = Timeout());
bool isConnected() const;
QString registryUrl() const;
bool reconnect();
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
const QVariantList& args = QVariantList(), Timeout timeout = Timeout());
/**
* @brief invokeRemoteMethod with an explicit error out-channel.
*
* Fills *err with the canonical {code, message, origin} call error when
* the failure is detectable (today: "object_unavailable" when the target
* object cannot be acquired); cleared on success. Generated typed client
* wrappers call this overload and throw logos::LogosCallError so callers
* can distinguish a failed call from a legitimately default-valued
* result.
*/
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
const QVariantList& args, Timeout timeout, logos::CallError* err);
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
const QVariant& arg, Timeout timeout = Timeout());
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
const QVariant& arg1, const QVariant& arg2, Timeout timeout = Timeout());
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3, Timeout timeout = Timeout());
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
const QVariant& arg4, Timeout timeout = Timeout());
QVariant invokeRemoteMethod(const QString& objectName, const QString& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
const QVariant& arg4, const QVariant& arg5, Timeout timeout = Timeout());
// const char* overloads — resolve ambiguity for string literals
QVariant invokeRemoteMethod(const char* objectName, const char* methodName,
const QVariantList& args = QVariantList(), Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString(objectName), QString(methodName), args, timeout); }
QVariant invokeRemoteMethod(const char* objectName, const char* methodName,
const QVariant& arg, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString(objectName), QString(methodName), arg, timeout); }
QVariant invokeRemoteMethod(const char* objectName, const char* methodName,
const QVariant& arg1, const QVariant& arg2, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString(objectName), QString(methodName), arg1, arg2, timeout); }
QVariant invokeRemoteMethod(const char* objectName, const char* methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString(objectName), QString(methodName), arg1, arg2, arg3, timeout); }
QVariant invokeRemoteMethod(const char* objectName, const char* methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
const QVariant& arg4, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString(objectName), QString(methodName), arg1, arg2, arg3, arg4, timeout); }
QVariant invokeRemoteMethod(const char* objectName, const char* methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
const QVariant& arg4, const QVariant& arg5, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString(objectName), QString(methodName), arg1, arg2, arg3, arg4, arg5, timeout); }
// std::string overloads — thin wrappers that convert internally
QVariant invokeRemoteMethod(const std::string& objectName, const std::string& methodName,
const QVariantList& args = QVariantList(), Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString::fromStdString(objectName), QString::fromStdString(methodName), args, timeout); }
QVariant invokeRemoteMethod(const std::string& objectName, const std::string& methodName,
const QVariant& arg, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString::fromStdString(objectName), QString::fromStdString(methodName), arg, timeout); }
QVariant invokeRemoteMethod(const std::string& objectName, const std::string& methodName,
const QVariant& arg1, const QVariant& arg2, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString::fromStdString(objectName), QString::fromStdString(methodName), arg1, arg2, timeout); }
QVariant invokeRemoteMethod(const std::string& objectName, const std::string& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString::fromStdString(objectName), QString::fromStdString(methodName), arg1, arg2, arg3, timeout); }
QVariant invokeRemoteMethod(const std::string& objectName, const std::string& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
const QVariant& arg4, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString::fromStdString(objectName), QString::fromStdString(methodName), arg1, arg2, arg3, arg4, timeout); }
QVariant invokeRemoteMethod(const std::string& objectName, const std::string& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
const QVariant& arg4, const QVariant& arg5, Timeout timeout = Timeout())
{ return invokeRemoteMethod(QString::fromStdString(objectName), QString::fromStdString(methodName), arg1, arg2, arg3, arg4, arg5, timeout); }
// const char* onEvent overload
void onEvent(LogosObject* originObject, const char* eventName,
std::function<void(const QString&, const QVariantList&)> callback)
{ onEvent(originObject, QString(eventName), callback); }
// std::string onEvent overloads
void onEvent(LogosObject* originObject, const std::string& eventName,
std::function<void(const QString&, const QVariantList&)> callback)
{ onEvent(originObject, QString::fromStdString(eventName), callback); }
void onEvent(LogosObject* originObject, const std::string& eventName,
std::function<void(const std::string&, const QVariantList&)> callback)
{
onEvent(originObject, QString::fromStdString(eventName),
[cb = std::move(callback)](const QString& name, const QVariantList& args) {
cb(name.toStdString(), args);
});
}
void onEvent(LogosObject* originObject, const char* eventName,
std::function<void(const std::string&, const QVariantList&)> callback)
{
onEvent(originObject, QString(eventName),
[cb = std::move(callback)](const QString& name, const QVariantList& args) {
cb(name.toStdString(), args);
});
}
using AsyncResultCallback = std::function<void(QVariant)>;
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
const QVariantList& args, AsyncResultCallback callback,
Timeout timeout = Timeout());
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
const QVariant& arg, AsyncResultCallback callback,
Timeout timeout = Timeout());
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
const QVariant& arg1, const QVariant& arg2,
AsyncResultCallback callback, Timeout timeout = Timeout());
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
AsyncResultCallback callback, Timeout timeout = Timeout());
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
const QVariant& arg4, AsyncResultCallback callback,
Timeout timeout = Timeout());
void invokeRemoteMethodAsync(const QString& objectName, const QString& methodName,
const QVariant& arg1, const QVariant& arg2, const QVariant& arg3,
const QVariant& arg4, const QVariant& arg5,
AsyncResultCallback callback, Timeout timeout = Timeout());
/**
* @brief Register an event listener via LogosObject's callback mechanism
* @param originObject The LogosObject that will emit the event
* @param eventName The name of the event to listen for
* @param callback Function to call when the event is triggered
*/
void onEvent(LogosObject* originObject, const QString& eventName,
std::function<void(const QString&, const QVariantList&)> callback);
/**
* @brief Emit an event on a LogosObject (for plugins that act as event sources)
* @param object The LogosObject to emit the event on
* @param eventName The name of the event
* @param data The event data
*/
void onEventResponse(LogosObject* object, const QString& eventName, const QVariantList& data);
/**
* @brief Backward-compatible overload for QObject-based plugins.
*
* Old-API plugins call onEventResponse(this, ...) where `this` is a QObject*.
* This overload invokes the eventResponse signal on the QObject via QMetaObject.
*/
void onEventResponse(QObject* object, const QString& eventName, const QVariantList& data);
bool informModuleToken(const QString& authToken, const QString& moduleName, const QString& token);
bool informModuleToken(const char* authToken, const char* moduleName, const char* token)
{ return informModuleToken(QString(authToken), QString(moduleName), QString(token)); }
bool informModuleToken(const std::string& authToken, const std::string& moduleName, const std::string& token);
bool informModuleToken_module(const QString& authToken, const QString& originModule, const QString& moduleName, const QString& token);
TokenManager* getTokenManager() const;
QString getToken(const QString& module_name);
// nlohmann::json overloads — args is a JSON array, result is a JSON value.
// These convert between nlohmann::json and QVariant internally so callers
// never need to touch Qt JSON types.
nlohmann::json invokeRemoteMethod(const std::string& objectName,
const std::string& methodName,
const nlohmann::json& args,
Timeout timeout = Timeout());
// nlohmann::json event callback overload — data arrives as a json array.
void onEvent(LogosObject* originObject, const std::string& eventName,
std::function<void(const std::string&, const nlohmann::json&)> callback);
private:
// ABI note: this private layout is consumed by every plugin that
// statically links libsdk. Adding a new field in the middle of
// this section shifts the offsets of subsequent fields and
// SILENTLY breaks any plugin compiled before the change — it
// reads m_token_manager at the wrong offset and segfaults on
// the first cross-process call. New private members MUST be
// appended to the end. (Long-term cure: pimpl this class so
// sizeof / offsets become opaque to consumers.)
LogosAPIConsumer* m_consumer;
QMap<QString, QString> m_tokens;
TokenManager* m_token_manager;
QString m_origin_module;
// Pre-built consumer for the auto-`requestModule` token-fetch path
// in invokeRemoteMethod{,Async}. Constructed once with the right
// transport (see the two-transport ctor) so the hot path doesn't
// chase a back-pointer to LogosAPI just to look up the transport
// registry. Null only when `m_consumer` itself is for
// capability_module (no recursion). In-class default to nullptr
// so any old constructor that doesn't list this field still
// leaves a defined value.
LogosAPIConsumer* m_capability_consumer = nullptr;
};
#endif // LOGOS_API_CLIENT_H