shadowdaoandClaude Sonnet 5
bf33966a4e
Implements the two read-key-scoped calls in apps/server/src/obs/plugin.routes.ts: GET /api/obs/:slug/slots and POST /api/obs/:slug/token. Three pieces, all in core/ with no OBS dependency: - stplugin::json -- a small, strict JSON reader. Hand-rolled rather than vendoring nlohmann because the only JSON this plugin ever sees is two fixed-shape responses from its own server, and the parser has to build on three platforms with no package-manager step in CI. It never throws, bounds its recursion (kMaxDepth=32) so a hostile response cannot overflow the stack inside OBS, rejects trailing garbage, and returns the caller's fallback for wrong-typed access instead of aborting. - stplugin::HttpClient -- a two-method injectable interface, with libcurl behind it on Linux/macOS and WinHTTP on Windows. WinHTTP rather than curl on Windows because it ships with the OS and does TLS through SChannel: the self-hosted winvm-builder runner has no package manager, and per the scaffold README does not even have cmake preinstalled. Both backends cap the response body at 4 MiB, keep TLS verification on (the read key is a credential), and honour a whole-request timeout. - stplugin::ApiClient -- maps the responses onto an ApiStatus enum that distinguishes NotFound (404), Unavailable (503), NetworkError, MalformedResponse and InvalidConfig. It deliberately does not claim to know whether a 404 was a wrong key or an unknown slug, because the server deliberately does not say. Server URLs are normalised the way an operator actually pastes them, defaulting to https so the read key is never sent in the clear by accident, and redactedUrl() exists so a URL can be logged without the key. Tests (279 checks across two new suites) run at two levels: a fake HttpClient covering every response and error branch, and a real loopback HTTP server on 127.0.0.1 driving the actual platform backend -- so libcurl on Linux/macOS and WinHTTP on Windows are each exercised in CI rather than assumed. The loopback cases deliberately include the ones that must not hang OBS: a truncated JSON body, a connection accepted and closed without a reply, non-HTTP garbage, a dead port, and a stalled server that has to be cut off by the client's own timeout. Verified locally on Ubuntu 24.04: ctest --test-dir build --output-on-failure -> 4/4 passed test_json: 158 checks passed test_api_client: 121 checks passed Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RL8abRmgFXkVASHkkqiJbE
79 lines
2.6 KiB
C++
79 lines
2.6 KiB
C++
/*
|
|
streamer-tools OBS Camera Plugin - HTTP client interface
|
|
Copyright (C) 2026 CyberCoveLLC <jknapp85@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License along
|
|
with this program. If not, see <https://www.gnu.org/licenses/>
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
// A two-method HTTP interface, injectable so ApiClient can be unit-tested
|
|
// without a network (mirroring the streamer-tools repo's injectable-deps
|
|
// convention, per the design doc's Testing section).
|
|
//
|
|
// Backends, chosen per platform so no third-party HTTP dependency has to be
|
|
// built on any of the three CI runners:
|
|
// - Linux/macOS: libcurl. Already present on both (client-sdk-cpp's own
|
|
// liblivekit links libcurl on Linux, and macOS ships libcurl in the SDK).
|
|
// - Windows: WinHTTP, which ships with the OS and handles TLS through
|
|
// SChannel -- avoiding an OpenSSL or curl build on the Windows runner.
|
|
|
|
#include <map>
|
|
#include <string>
|
|
|
|
namespace stplugin {
|
|
|
|
struct HttpResponse {
|
|
/// HTTP status code, or 0 when the request never completed (DNS failure,
|
|
/// TLS failure, timeout, ...). Callers must check `network_error` first.
|
|
long status = 0;
|
|
|
|
/// Response body. May be empty, may be arbitrary bytes: never assume it
|
|
/// parses as JSON.
|
|
std::string body;
|
|
|
|
/// Empty on success. Non-empty means the request did not complete and
|
|
/// `status`/`body` are meaningless.
|
|
std::string network_error;
|
|
|
|
bool ok() const { return network_error.empty(); }
|
|
};
|
|
|
|
struct HttpRequest {
|
|
std::string method = "GET";
|
|
std::string url;
|
|
std::string body;
|
|
std::string content_type;
|
|
|
|
/// Whole-request timeout. Kept short: this runs on OBS's UI thread when
|
|
/// the properties dropdown is refreshed, and on the source's own worker
|
|
/// thread when a token is minted.
|
|
int timeout_ms = 10000;
|
|
};
|
|
|
|
class HttpClient {
|
|
public:
|
|
virtual ~HttpClient() = default;
|
|
virtual HttpResponse send(const HttpRequest &request) = 0;
|
|
};
|
|
|
|
/// Percent-encode a string for use in a URL query value.
|
|
std::string urlEncode(const std::string &value);
|
|
|
|
/// Construct the platform's real HTTP client. Returns nullptr if no backend
|
|
/// was compiled in.
|
|
HttpClient *createPlatformHttpClient();
|
|
|
|
} // namespace stplugin
|