Files
logos-protocol/tests/protocol/test_json_convert_bytes.cpp
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

137 lines
4.7 KiB
C++

#include <gtest/gtest.h>
#include "logos_json_convert.h"
#include "logos_types.h"
#include <QByteArray>
#include <QMetaType>
#include <QVariant>
#include <QVariantList>
// The canonical C-ABI bytes encoding: QByteArray ⇄ {"_bytes":"<base64url>"}
// (single-key object, unpadded base64url — same as the plain wire's
// json_mapping.cpp). These tests pin the encoding and the round-trip,
// including the historical loss case: bytes with embedded NUL.
using logos::qvariantToNlohmann;
using logos::nlohmannToQVariant;
using logos::nlohmannArgsToQVariantList;
TEST(JsonConvertBytes, ByteArrayEncodesAsTaggedObject)
{
const QByteArray bytes("\x00\x01\xfe", 3);
nlohmann::json j = qvariantToNlohmann(QVariant(bytes));
ASSERT_TRUE(j.is_object());
ASSERT_EQ(j.size(), 1u);
ASSERT_TRUE(j.contains("_bytes"));
// 0x00 0x01 0xFE → base64 "AAH+" → base64url "AAH-" (no padding needed).
EXPECT_EQ(j["_bytes"].get<std::string>(), "AAH-");
}
TEST(JsonConvertBytes, NulByteRoundTripPreservesSize)
{
// The regression this encoding exists to prevent: embedded NUL used to
// be truncated/mangled by the string fallback.
const QByteArray original("a\0b\0c", 5);
ASSERT_EQ(original.size(), 5);
nlohmann::json j = qvariantToNlohmann(QVariant(original));
QVariant back = nlohmannToQVariant(j);
ASSERT_EQ(back.userType(), QMetaType::QByteArray);
const QByteArray bytes = back.toByteArray();
EXPECT_EQ(bytes.size(), 5); // explicit byteArraySize assertion
EXPECT_EQ(bytes, original);
}
TEST(JsonConvertBytes, AllByteValuesRoundTrip)
{
QByteArray original;
for (int i = 0; i < 256; ++i)
original.append(static_cast<char>(i));
QVariant back = nlohmannToQVariant(qvariantToNlohmann(QVariant(original)));
ASSERT_EQ(back.userType(), QMetaType::QByteArray);
EXPECT_EQ(back.toByteArray(), original);
}
TEST(JsonConvertBytes, EmptyByteArrayRoundTrips)
{
QVariant back = nlohmannToQVariant(qvariantToNlohmann(QVariant(QByteArray())));
ASSERT_EQ(back.userType(), QMetaType::QByteArray);
EXPECT_TRUE(back.toByteArray().isEmpty());
}
TEST(JsonConvertBytes, ArgsListDecodesTaggedBytes)
{
nlohmann::json args = nlohmann::json::array();
args.push_back("plain string");
args.push_back(qvariantToNlohmann(QVariant(QByteArray("x\0y", 3))));
QVariantList list = nlohmannArgsToQVariantList(args);
ASSERT_EQ(list.size(), 2);
EXPECT_EQ(list[0].toString(), "plain string");
ASSERT_EQ(list[1].userType(), QMetaType::QByteArray);
EXPECT_EQ(list[1].toByteArray(), QByteArray("x\0y", 3));
}
TEST(JsonConvertBytes, LogosResultValueBytesAreTagged)
{
qRegisterMetaType<LogosResult>("LogosResult");
LogosResult lr;
lr.success = true;
lr.value = QVariant(QByteArray("p\0q", 3));
nlohmann::json j = qvariantToNlohmann(QVariant::fromValue(lr));
ASSERT_TRUE(j.is_object());
EXPECT_TRUE(j["success"].get<bool>());
ASSERT_TRUE(j["value"].is_object());
ASSERT_TRUE(j["value"].contains("_bytes"));
QVariant back = nlohmannToQVariant(j["value"]);
ASSERT_EQ(back.userType(), QMetaType::QByteArray);
EXPECT_EQ(back.toByteArray(), QByteArray("p\0q", 3));
}
TEST(JsonConvertBytes, OrdinaryObjectsAreNotMistakenForBytes)
{
// Two keys → a real map, even though one key is "_bytes".
nlohmann::json twoKeys = {{"_bytes", "AAA"}, {"other", 1}};
QVariant v1 = nlohmannToQVariant(twoKeys);
EXPECT_NE(v1.userType(), QMetaType::QByteArray);
// "_bytes" with a non-string value → a real map.
nlohmann::json nonString = {{"_bytes", 42}};
QVariant v2 = nlohmannToQVariant(nonString);
EXPECT_NE(v2.userType(), QMetaType::QByteArray);
// A plain object stays an object.
nlohmann::json plain = {{"a", 1}, {"b", 2}};
QVariant v3 = nlohmannToQVariant(plain);
EXPECT_NE(v3.userType(), QMetaType::QByteArray);
}
TEST(JsonConvertBytes, IntegersStayIntegersNotDoubles)
{
// QJsonValue::fromVariant degrades every numeric to double; the canonical
// C-ABI converter must not — a strict consumer (e.g. a generated dispatch
// reading an int param) rejects 5.0 where it expects 5.
nlohmann::json a = qvariantToNlohmann(QVariant(static_cast<qulonglong>(5)));
EXPECT_TRUE(a.is_number_integer() || a.is_number_unsigned());
EXPECT_EQ(a.get<int64_t>(), 5);
nlohmann::json b = qvariantToNlohmann(QVariant(static_cast<qlonglong>(-7)));
EXPECT_TRUE(b.is_number_integer());
EXPECT_EQ(b.get<int64_t>(), -7);
nlohmann::json c = qvariantToNlohmann(QVariant(42));
EXPECT_TRUE(c.is_number_integer());
EXPECT_EQ(c.get<int64_t>(), 42);
// Doubles stay doubles.
nlohmann::json d = qvariantToNlohmann(QVariant(3.5));
EXPECT_TRUE(d.is_number_float());
}