mirror of
https://github.com/logos-co/logos-cpp-sdk.git
synced 2026-08-31 17:51:07 +00:00
Dario LipicarandClaude Opus 4.8
40e7631402
* Marshal inter-module calls to the owner thread Logos inter-module calls go over Qt Remote Objects, whose replicas only work on the thread that created them (the module's main/event-loop thread). A module that makes calls from a worker thread — e.g. an embedded HTTP server serving /metrics — would otherwise hang on replica acquisition. Make LogosAPIClient transparently marshal to its owner thread when called off-thread (guarded so same-thread calls run directly with no overhead): - LogosAPI::getClient creates the client/consumer/replicas on the owner thread - LogosAPIClient::invokeRemoteMethod / requestObject / onEvent run there too New header logos_thread_marshal.h (runOnOwnerThread). No new data members — ABI-safe for statically-linked plugins. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Add regression test for worker-thread inter-module calls A provider records the thread its method runs on; a consumer calls it from a worker thread via LogosAPIClient::invokeRemoteMethod. The call must execute on the owner (main/event-loop) thread, not the worker thread. Fails without the marshaling change (the call runs on the worker thread — 0x..d80d0 vs owner 0x..c53e0, "executed on the worker thread instead of the owner thread"); passes with it (511/511). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Address review: async marshaling, helper constraints, test ownership - invokeRemoteMethodAsync now also marshals to the owner thread (non-blocking QueuedConnection) — the async path acquires a replica too, so calling it from a worker thread previously re-introduced the off-thread bug. - runOnOwnerThread: document the return-type constraints (void or default-constructible, non-reference) and static_assert against references. - test: declare the provider before its LogosAPI so the ModuleProxy (which holds a raw pointer to it) is torn down first — removes the leak and the inaccurate comment. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * doctest: call a module from a worker thread (HTTP server) Adds cpp-sdk-worker-thread-http.test.yaml: builds a sensor_module callee and an http_module caller that embeds a libmicrohttpd server, runs them in logoscore, starts the server, and curls it. The HTTP handler calls sensor_module.readTemperature() from the server's worker thread — which only works because the SDK marshals the cross-module call onto the module's owner thread. The module stays pure C++. Wired into doctests/run.sh and the doctests CI workflow. Validated locally (23/23 steps pass): `curl` returns `temperature 42`. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
97 lines
3.8 KiB
Bash
Executable File
97 lines
3.8 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# Execute the cpp-sdk doc-tests end-to-end and regenerate their Markdown.
|
|
#
|
|
# Specs run here:
|
|
# - cpp-sdk-module-runtime.test.yaml a real module (accounts) built and
|
|
# run through logoscore against this SDK
|
|
# - cpp-sdk-module-composition.test.yaml two modules built against this SDK,
|
|
# one calling the other over IPC
|
|
#
|
|
# The runner is the shared `doctest` CLI
|
|
# (https://github.com/logos-co/logos-doctest), invoked directly via its flake.
|
|
# `doctest run` executes every command in a temp directory and asserts on the
|
|
# output; `doctest generate` renders each spec to Markdown under outputs/;
|
|
# `doctest clean` strips build artifacts so only the generated docs remain.
|
|
#
|
|
# To run against a local logos-doctest checkout instead of the published flake,
|
|
# set DOCTEST, e.g.: DOCTEST="nix run path:../../logos-doctest --" ./run.sh
|
|
#
|
|
set -euo pipefail
|
|
|
|
# Run from this doctests/ directory regardless of where the script is invoked from.
|
|
cd "$(dirname "$0")"
|
|
|
|
# The doctest CLI. Override by exporting DOCTEST (space-separated command).
|
|
read -r -a DOCTEST <<< "${DOCTEST:-nix run github:logos-co/logos-doctest --}"
|
|
OUTPUT_DIR="./outputs"
|
|
SPECS=(
|
|
"cpp-sdk-module-runtime.test.yaml"
|
|
"cpp-sdk-module-composition.test.yaml"
|
|
"cpp-sdk-worker-thread-http.test.yaml"
|
|
)
|
|
|
|
# Build the doc-tests against THIS repo's current commit rather than the latest
|
|
# published flake. Each spec overrides `logos-cpp-sdk` with
|
|
# `github:logos-co/logos-cpp-sdk{release}`, and the pin below makes {release}
|
|
# expand to $COMMIT — so every layer is built against exactly what's checked out
|
|
# here. Override by exporting COMMIT (e.g. a tag), or set COMMIT="" to fall back
|
|
# to latest master.
|
|
#
|
|
# Note: nix fetches the commit from the GitHub remote, so $COMMIT must be pushed
|
|
# to logos-co/logos-cpp-sdk. A local-only / uncommitted HEAD won't resolve;
|
|
# export COMMIT="" (or push first) in that case.
|
|
COMMIT="${COMMIT-$(git rev-parse HEAD)}"
|
|
RELEASE_FOR=()
|
|
if [ -n "${COMMIT}" ]; then
|
|
RELEASE_FOR=(--release-for "logos-cpp-sdk=${COMMIT}")
|
|
echo "==> Pinning logos-cpp-sdk to ${COMMIT}"
|
|
else
|
|
echo "==> COMMIT empty; building against latest logos-cpp-sdk master"
|
|
fi
|
|
|
|
echo "==> Clearing previous ${OUTPUT_DIR}/"
|
|
# A prior run copies module artifacts out of the read-only nix store, so the
|
|
# directories land read-only (r-x) too. `rm -rf` can't delete files inside a
|
|
# directory it can't write to, so restore write permission first.
|
|
if [ -e "${OUTPUT_DIR}" ]; then
|
|
chmod -R u+w "${OUTPUT_DIR}" 2>/dev/null || true
|
|
fi
|
|
rm -rf "${OUTPUT_DIR}"
|
|
mkdir -p "${OUTPUT_DIR}"
|
|
|
|
for SPEC in "${SPECS[@]}"; do
|
|
name="$(basename "${SPEC%.test.yaml}")"
|
|
# Each spec runs in its OWN workdir under outputs/. They must not share one:
|
|
# a standalone spec uses --output-dir directly as its working tree, and the
|
|
# runtime spec leaves read-only nix-store copies under modules/ that a second
|
|
# spec's `cp` into the same tree could not overwrite. The rendered .md is
|
|
# still written flat into outputs/ (matching the .gitignore keep rule).
|
|
spec_out="${OUTPUT_DIR}/${name}"
|
|
mkdir -p "${spec_out}"
|
|
|
|
echo "==> Running ${SPEC} into ${spec_out}/"
|
|
# ${RELEASE_FOR[@]+...} guards the expansion so an empty array doesn't trip
|
|
# `set -u` on older bash (e.g. macOS's stock 3.2).
|
|
"${DOCTEST[@]}" run "${SPEC}" \
|
|
--verbose \
|
|
--continue-on-fail \
|
|
${RELEASE_FOR[@]+"${RELEASE_FOR[@]}"} \
|
|
--output-dir "${spec_out}/"
|
|
|
|
echo "==> Generating ${OUTPUT_DIR}/${name}.md"
|
|
"${DOCTEST[@]}" generate "${SPEC}" \
|
|
${RELEASE_FOR[@]+"${RELEASE_FOR[@]}"} \
|
|
-o "${OUTPUT_DIR}/${name}.md"
|
|
done
|
|
|
|
if [ ! -d "${OUTPUT_DIR}" ]; then
|
|
echo "==> No ${OUTPUT_DIR}/ produced; nothing to clean."
|
|
exit 0
|
|
fi
|
|
|
|
echo "==> Cleaning build artifacts from ${OUTPUT_DIR}/"
|
|
"${DOCTEST[@]}" clean "${OUTPUT_DIR}" --verbose
|
|
|
|
echo "==> Done. Rendered docs are in ${OUTPUT_DIR}/"
|