reasampler/tests/test_bake_wire.cpp

// Standalone tests for reasampler::wire::bake_wire — no VST3, no REAPER, no framework.
// Same fast assert loop as the sibling wire tests.
//
// Covers: the exact bytes each record encodes to (the two artifacts ship independently, so
// a field reorder or an inserted field must fail here rather than pass a round-trip and
// break a mixed-version pair); request + outcome round-trips including bytes that would
// break a delimiter-based format; the refusals every house wire record shares (wrong tag,
// truncation, trailing garbage, a swapped record kind); an unrecognized status integer
// degrading to Failed rather than to Ok; the action lookup name's leading underscore and
// its channel fork; and the two key classifiers each end reads the shared key through.

#include "../src/core/wire/bake_wire.h"

#include "../src/core/version/app_version.h"

#include <cstdint>
#include <cstdio>
#include <optional>
#include <string>

using namespace reasampler::wire;

static int g_fail = 0;
#define CHECK(cond) do { if(!(cond)) { \
    std::printf("FAIL line %d: %s\n", __LINE__, #cond); ++g_fail; } } while(0)

int main() {
    // --- The exact bytes on the wire -------------------------------------------------
    // A round-trip alone would pass a reordered or inserted field; the tags exist to guard
    // the LAYOUT, so the layout is what is pinned. Changing either literal below means an
    // already-shipped pair of artifacts can no longer talk — bump the tag, don't edit it.
    {
        BakeRequest req;
        req.instanceGuid = "abcd";
        req.stagedFilePath = "T/b.wav";
        req.sourceSampleId = "cap-1";
        req.sourceRelativePath = "bank/k.wav";
        req.sourceDisplayName = "Kick";
        req.ownUsageKey = "rsusage_abcd";
        req.rootNote = 36;
        req.generation = 1893456000;
        CHECK(encodeBakeRequest(req) ==
              "rsbakereq1"
              "4:abcd"
              "7:T/b.wav"
              "5:cap-1"
              "10:bank/k.wav"
              "4:Kick"
              "12:rsusage_abcd"
              "2:36"
              "10:1893456000");

        BakeOutcome out;
        out.status = BakeStatus::Ok;
        out.sampleId = "bake-1";
        out.relativePath = "bank/k2.wav";
        out.displayName = "Kick r2";
        out.rootNote = 36;
        out.channelCount = 2;
        out.replaced = true;
        out.message = "replaced";
        out.generation = 1893456000;
        CHECK(encodeBakeOutcome(out) ==
              "rsbakeout1"
              "1:0"
              "6:bake-1"
              "11:bank/k2.wav"
              "7:Kick r2"
              "2:36"
              "1:2"
              "1:1"
              "8:replaced"
              "10:1893456000");
    }

    // --- Request round-trip, with hostile field content -----------------------------
    {
        BakeRequest req;
        req.instanceGuid = "0123abcd";
        req.stagedFilePath = "C:/Temp/re:sampler 9000/bake 12:34.wav";  // colons + spaces
        req.sourceSampleId = "cap-1";
        req.sourceRelativePath = "reasampler_bank/kick.wav";
        req.sourceDisplayName = "Kick r2";
        req.ownUsageKey = "rsusage_0123abcd";
        req.rootNote = 36;
        req.generation = 1893456000;

        const std::string encoded = encodeBakeRequest(req);
        const auto decoded = decodeBakeRequest(encoded);
        CHECK(decoded.has_value());
        CHECK(*decoded == req);

        // Empty strings and a zero generation survive too (a first, un-named source).
        BakeRequest bare;
        CHECK(decodeBakeRequest(encodeBakeRequest(bare)) == bare);
    }

    // --- Outcome round-trip -----------------------------------------------------------
    {
        BakeOutcome out;
        out.status = BakeStatus::Ok;
        out.sampleId = "bake-1893456000-kick_1893456000.wav";
        out.relativePath = "reasampler_bank/kick_1893456000.wav";
        out.displayName = "Kick r3";
        out.rootNote = 36;
        out.channelCount = 2;
        out.replaced = true;
        out.message = "replaced the bank entry";
        out.generation = 1893456000;

        const auto decoded = decodeBakeOutcome(encodeBakeOutcome(out));
        CHECK(decoded.has_value());
        CHECK(*decoded == out);
        CHECK(decoded->replaced);

        out.replaced = false;
        CHECK(decodeBakeOutcome(encodeBakeOutcome(out))->replaced == false);
    }

    // --- Malformed input is refused, never half-parsed ---------------------------------
    {
        BakeRequest req;
        req.instanceGuid = "abc";
        req.rootNote = 60;
        const std::string good = encodeBakeRequest(req);

        CHECK(!decodeBakeRequest("").has_value());
        CHECK(!decodeBakeRequest("rsbakereq0" + good.substr(10)).has_value());  // wrong tag
        CHECK(!decodeBakeRequest(good.substr(0, good.size() - 3)).has_value()); // truncated
        CHECK(!decodeBakeRequest(good + "junk").has_value());                   // trailing
        // The two records share a key; each must refuse the other's bytes outright.
        CHECK(!decodeBakeOutcome(good).has_value());
        CHECK(!decodeBakeRequest(encodeBakeOutcome(BakeOutcome{})).has_value());
    }

    // --- A status integer this build does not know reads as a FAILURE ------------------
    {
        // Hand-built with a future status value; every other field is well-formed, so only
        // the vocabulary gap is under test.
        BakeOutcome out;
        out.status = BakeStatus::Ok;
        out.generation = 7;
        std::string wire = encodeBakeOutcome(out);
        // The status field is the first after the tag: "<len>':'<digits>".
        const std::string okField = "1:0";
        const std::size_t at = wire.find(okField);
        CHECK(at != std::string::npos);
        wire.replace(at, okField.size(), "2:99");

        const auto decoded = decodeBakeOutcome(wire);
        CHECK(decoded.has_value());
        CHECK(decoded->status == BakeStatus::Failed);  // never Ok
        CHECK(decoded->generation == 7);

        // Every status this build DOES know survives its own round trip — including the
        // most recently appended one, which an older reader will see as Failed.
        for (const BakeStatus s :
             {BakeStatus::Ok, BakeStatus::Failed, BakeStatus::NoProject,
              BakeStatus::StagedMissing, BakeStatus::NoSource, BakeStatus::IndexRejected,
              BakeStatus::WrongProject}) {
            BakeOutcome one;
            one.status = s;
            const auto back = decodeBakeOutcome(encodeBakeOutcome(one));
            CHECK(back.has_value() && back->status == s);
        }
    }

    // --- The lookup name carries the underscore the registration string does not -------
    // The load-bearing half is the REGISTRATION string: main.cpp registers that spelling
    // verbatim, and NamedCommandLookup needs exactly one underscore in front of it. If
    // channelCommandId ever grew one of its own, the lookup would carry two and resolve to
    // nothing.
    {
        const std::string registered =
            reasampler::version::channelCommandId(kBakeActionSuffix);
        const std::string lookup = bakeActionLookupName();
        const std::size_t suffixLen = std::string(kBakeActionSuffix).size();
        CHECK(!registered.empty());
        CHECK(registered.front() != '_');
        CHECK(lookup.size() == registered.size() + 1);
        CHECK(lookup.front() == '_' && lookup[1] != '_');
        CHECK(lookup.compare(1, std::string::npos, registered) == 0);
        // The suffix is the TAIL of the id — the channel prefix goes in front of it, and a
        // suffix that drifted into the middle would name a different action.
        CHECK(lookup.size() > suffixLen);
        CHECK(lookup.compare(lookup.size() - suffixLen, suffixLen, kBakeActionSuffix) == 0);
    }

    // --- The action id and the ext-state namespace fork on the SAME channel bit ---------
    // Both frozen families are spelled out, so this holds whichever channel the test binary
    // was built for. Consequence for a cross-channel pair (stable VST + beta extension or
    // the reverse): NamedCommandLookup resolves nothing, bakeAvailable paints the affordance
    // Disabled, and the click cannot reach the no-answer path at all.
    {
        const std::string suffix = kBakeActionSuffix;
        const std::string stableLookup = "_CEREBELLUM_REASAMPLER_" + suffix;
        const std::string betaLookup = "_CEREBELLUM_REASAMPLER_BETA_" + suffix;
        const bool beta = reasampler::version::isBeta();

        CHECK(stableLookup != betaLookup);
        CHECK(bakeActionLookupName() == (beta ? betaLookup : stableLookup));
        CHECK(bakeActionLookupName() != (beta ? stableLookup : betaLookup));
        CHECK(reasampler::version::extStateNamespace() ==
              (beta ? "reasampler_beta" : "reasampler"));
    }

    // --- What the instrument finds under its own key, after the action returned ---------
    {
        BakeRequest sent;
        sent.instanceGuid = "0123abcd";
        sent.stagedFilePath = "C:/Temp/reasampler_bake_0123abcd_1893456000.wav";
        sent.sourceSampleId = "cap-1";
        sent.sourceRelativePath = "reasampler_bank/kick.wav";
        sent.sourceDisplayName = "Kick";
        sent.ownUsageKey = "rsusage_0123abcd";
        sent.rootNote = 36;
        sent.generation = 1893456000;

        BakeOutcome answered;
        answered.status = BakeStatus::Ok;
        answered.sampleId = "bake-1";
        answered.message = "added as a distinct capture";
        answered.generation = sent.generation;

        const BakeAnswer ok =
            classifyBakeAnswer(std::optional<std::string>(encodeBakeOutcome(answered)), sent);
        CHECK(ok.kind == BakeAnswerKind::Answered);
        CHECK(ok.outcome.has_value() && ok.outcome->sampleId == "bake-1");

        // A refusal is an ANSWER — it must never fold into a no-answer kind, or the user is
        // sent to reinstall a binary that in fact answered them.
        BakeOutcome refused;
        refused.status = BakeStatus::WrongProject;
        refused.message = "this bake's project tab is not the one the extension has loaded";
        refused.generation = sent.generation;
        const BakeAnswer refusal =
            classifyBakeAnswer(std::optional<std::string>(encodeBakeOutcome(refused)), sent);
        CHECK(refusal.kind == BakeAnswerKind::Answered);
        CHECK(refusal.outcome.has_value() &&
              refusal.outcome->status == BakeStatus::WrongProject);

        BakeOutcome older = answered;
        older.generation = sent.generation - 1;
        const BakeAnswer foreignOut =
            classifyBakeAnswer(std::optional<std::string>(encodeBakeOutcome(older)), sent);
        CHECK(foreignOut.kind == BakeAnswerKind::ForeignOutcome);
        CHECK(foreignOut.outcome.has_value());

        // Nothing on the extension side read the key: the request is still sitting there
        // byte-for-byte. THE diagnostic that separates a stale/absent landing from a refusal.
        CHECK(classifyBakeAnswer(std::optional<std::string>(encodeBakeRequest(sent)), sent)
                  .kind == BakeAnswerKind::Unanswered);

        // A request that is not ours: two instances copied from one another share a
        // persisted instanceGuid, so they name one key.
        BakeRequest sibling = sent;
        sibling.sourceSampleId = "cap-2";
        sibling.generation = sent.generation + 1;
        CHECK(classifyBakeAnswer(std::optional<std::string>(encodeBakeRequest(sibling)), sent)
                  .kind == BakeAnswerKind::ForeignRequest);

        // Cleared folds two genuinely different bridge outcomes -- key absent, and key
        // present but empty -- into ONE kind, because the bridge cannot label which
        // occurred. Both must land on the identical kind: a caller's message may claim
        // no more than what the fold actually preserves.
        const BakeAnswer clearedFromAbsent = classifyBakeAnswer(std::nullopt, sent);
        const BakeAnswer clearedFromEmpty =
            classifyBakeAnswer(std::optional<std::string>(""), sent);
        CHECK(clearedFromAbsent.kind == BakeAnswerKind::Cleared);
        CHECK(clearedFromEmpty.kind == BakeAnswerKind::Cleared);
        CHECK(clearedFromAbsent.kind == clearedFromEmpty.kind);
        CHECK(classifyBakeAnswer(std::optional<std::string>("rsbakeout9 whatever"), sent)
                  .kind == BakeAnswerKind::Undecodable);

        // No non-Answered kind may carry an outcome the caller could read as a landing.
        CHECK(!classifyBakeAnswer(std::nullopt, sent).outcome.has_value());
        CHECK(!classifyBakeAnswer(std::optional<std::string>(encodeBakeRequest(sent)), sent)
                   .outcome.has_value());
        CHECK(!classifyBakeAnswer(std::optional<std::string>("garbage"), sent)
                   .outcome.has_value());
    }

    // --- answeredOutcome: the guarded read, not switch exhaustiveness alone -------------
    {
        BakeRequest sent;
        sent.instanceGuid = "abcd";
        sent.generation = 42;

        BakeOutcome landed;
        landed.status = BakeStatus::Ok;
        landed.sampleId = "bake-1";
        landed.generation = sent.generation;

        // The one state that may yield a non-null pointer, and it points at the SAME
        // outcome classifyBakeAnswer decoded.
        const BakeAnswer answered =
            classifyBakeAnswer(std::optional<std::string>(encodeBakeOutcome(landed)), sent);
        const BakeOutcome* ptr = answeredOutcome(answered);
        CHECK(ptr != nullptr);
        CHECK(ptr->sampleId == "bake-1");

        // Every other real classification nulls out.
        CHECK(answeredOutcome(classifyBakeAnswer(std::nullopt, sent)) == nullptr);
        CHECK(answeredOutcome(classifyBakeAnswer(
                  std::optional<std::string>(encodeBakeRequest(sent)), sent)) == nullptr);
        CHECK(answeredOutcome(classifyBakeAnswer(std::optional<std::string>("garbage"), sent))
                  == nullptr);
        BakeOutcome foreign = landed;
        foreign.generation = sent.generation + 1;
        CHECK(answeredOutcome(classifyBakeAnswer(
                  std::optional<std::string>(encodeBakeOutcome(foreign)), sent)) == nullptr);

        // The defensive arm: a hand-built Answered with no outcome set (what a future
        // BakeAnswerKind enumerator falling through an un-updated switch would look like
        // to this accessor) fails closed rather than being dereferenced.
        BakeAnswer malformed;
        malformed.kind = BakeAnswerKind::Answered;
        CHECK(!malformed.outcome.has_value());
        CHECK(answeredOutcome(malformed) == nullptr);
    }

    // --- kMaxRequestAgeSeconds: a regression pin on the bound itself --------------------
    // The bound's meaning depends on the instrument stamping `generation` immediately
    // before publishing (AFTER staging the WAV) -- a shell-side ordering fix this pure
    // suite cannot observe directly. Pinning the literal at least catches a silent
    // widen/narrow of the budget itself.
    CHECK(kMaxRequestAgeSeconds == 30);

    // --- The extension's per-key verdict over the open tabs -----------------------------
    {
        const std::int64_t now = 1893456000;
        // The session has polled a project and that project is REAPER's active tab — the
        // steady state a project opened from disk reaches on the next timer tick.
        const BakeScanContext loadedAndActive{true};

        BakeScanKey own{true, true, now, true};
        CHECK(classifyBakeScan(loadedAndActive, own, now) == BakeScanVerdict::Land);

        // A request found in a tab the extension has NOT loaded — the multi-tab case. It is
        // REFUSED, which is an answer the asking instance can read; it is never landed into
        // the loaded tab's bank, and never dropped silently.
        BakeScanKey otherTab{true, true, now, false};
        CHECK(classifyBakeScan(loadedAndActive, otherTab, now) ==
              BakeScanVerdict::RefuseWrongProject);

        // The loaded tab is no longer the active one, so a persist would write elsewhere:
        // even the loaded tab's own request is refused rather than half-landed.
        CHECK(classifyBakeScan(BakeScanContext{false}, own, now) ==
              BakeScanVerdict::RefuseWrongProject);
        // The window before any project is loaded: matchesLoadedProject cannot be true for
        // ANY key here — a key can only match a project that is loaded — so this is the
        // shell-reachable stand-in for "no book yet", not `own` (which the shell could
        // never actually pair with an unloaded session).
        CHECK(classifyBakeScan(BakeScanContext{false}, BakeScanKey{true, true, now, false},
                               now) == BakeScanVerdict::RefuseWrongProject);

        // Stale in EITHER direction (a clock that moved backwards counts too).
        BakeScanKey old{true, true, now - kMaxRequestAgeSeconds - 1, true};
        BakeScanKey future{true, true, now + kMaxRequestAgeSeconds + 1, true};
        CHECK(classifyBakeScan(loadedAndActive, old, now) == BakeScanVerdict::ClearStale);
        CHECK(classifyBakeScan(loadedAndActive, future, now) == BakeScanVerdict::ClearStale);
        // Exactly at the bound is still landable — the ceiling is inclusive.
        BakeScanKey atBound{true, true, now - kMaxRequestAgeSeconds, true};
        CHECK(classifyBakeScan(loadedAndActive, atBound, now) == BakeScanVerdict::Land);
        // Staleness outranks the project check: a request nobody can read is cleared, not
        // answered, wherever it sits.
        BakeScanKey oldElsewhere{true, true, now - kMaxRequestAgeSeconds - 1, false};
        CHECK(classifyBakeScan(loadedAndActive, oldElsewhere, now) ==
              BakeScanVerdict::ClearStale);

        // A value that is not a request (an outcome the writer has not collected) is left
        // alone — answering it would clobber an answer in flight.
        BakeScanKey notARequest{true, false, 0, true};
        CHECK(classifyBakeScan(loadedAndActive, notARequest, now) ==
              BakeScanVerdict::IgnoreNotARequest);
        CHECK(classifyBakeScan(BakeScanContext{false}, notARequest, now) ==
              BakeScanVerdict::IgnoreNotARequest);

        // A key the enumerator listed but the reader could not return whole is its OWN
        // verdict, not folded into the one above: the extension failing to read a request
        // that may well be there is a different fault from a key holding something else,
        // and neither is visible from the instrument's end.
        BakeScanKey unreadable{false, false, 0, true};
        CHECK(classifyBakeScan(loadedAndActive, unreadable, now) ==
              BakeScanVerdict::IgnoreUnreadable);
        CHECK(classifyBakeScan(BakeScanContext{false}, unreadable, now) ==
              BakeScanVerdict::IgnoreUnreadable);
        // Unreadable outranks even staleness — an age read off a request that was never
        // decoded would be a made-up number.
        BakeScanKey unreadableOld{false, false, now - kMaxRequestAgeSeconds - 1, true};
        CHECK(classifyBakeScan(loadedAndActive, unreadableOld, now) ==
              BakeScanVerdict::IgnoreUnreadable);
    }

    // --- The scan report: what the action tells a user it actually saw ------------------
    // The report exists because every non-answering verdict leaves the asking instance
    // with the identical evidence (its own untouched request), so only these counts
    // discriminate them. It must therefore SAY the count that fired, and must stay silent
    // whenever an answer was written.
    {
        BakeScanTally answeredOne;
        answeredOne.tabsScanned = 1;
        answeredOne.keysFound = 1;
        answeredOne.activeTabKeys = 1;
        answeredOne.answered = 1;
        answeredOne.landed = 1;
        CHECK(describeBakeScan(answeredOne).empty());
        // A refusal is still an answer, so it silences the report the same way a landing
        // does — the refusal's own sentence has already been printed.
        BakeScanTally refusedOne = answeredOne;
        refusedOne.landed = 0;
        CHECK(describeBakeScan(refusedOne).empty());

        // Nothing found at all: the state Daniel's repro produces if the request key never
        // becomes visible to the extension.
        BakeScanTally nothing;
        nothing.tabsScanned = 2;
        const std::string none = describeBakeScan(nothing);
        CHECK(!none.empty());
        CHECK(none.find("2 project tabs") != std::string::npos);
        CHECK(none.find("No pending bake request was visible") != std::string::npos);
        CHECK(none.back() == '\n');

        // One tab is singular, not "1 project tabs".
        BakeScanTally oneTab;
        oneTab.tabsScanned = 1;
        CHECK(describeBakeScan(oneTab).find("1 project tab,") != std::string::npos);

        // Found but unreadable — the fact the old scan discarded.
        BakeScanTally unreadable;
        unreadable.tabsScanned = 1;
        unreadable.keysFound = 1;
        unreadable.activeTabKeys = 1;
        unreadable.unreadable = 1;
        const std::string unread = describeBakeScan(unreadable);
        CHECK(unread.find("1 pending request key") != std::string::npos);
        CHECK(unread.find("1 could not be read back") != std::string::npos);
        CHECK(unread.find("held something other than a request") == std::string::npos);

        // Found, readable, but not a request.
        BakeScanTally foreign;
        foreign.tabsScanned = 1;
        foreign.keysFound = 1;
        foreign.activeTabKeys = 1;
        foreign.notARequest = 1;
        const std::string other = describeBakeScan(foreign);
        CHECK(other.find("1 held something other than a request") != std::string::npos);
        CHECK(other.find("could not be read back") == std::string::npos);

        // Cleared as stale: an answer was never written, so this too must report.
        BakeScanTally stale;
        stale.tabsScanned = 1;
        stale.keysFound = 1;
        stale.activeTabKeys = 1;
        stale.staleCleared = 1;
        const std::string aged = describeBakeScan(stale);
        CHECK(aged.find("past the age bound") != std::string::npos);

        // Keys exist, but none in the tab the bake was fired against — the multi-tab
        // mis-target, called out explicitly rather than left to be inferred from "0 of them".
        BakeScanTally elsewhere;
        elsewhere.tabsScanned = 2;
        elsewhere.keysFound = 1;
        elsewhere.activeTabKeys = 0;
        elsewhere.notARequest = 1;
        const std::string away = describeBakeScan(elsewhere);
        CHECK(away.find("0 of them in the active tab") != std::string::npos);
        CHECK(away.find("fired against held none of them") != std::string::npos);
    }

    // --- Every outcome bake_land actually emits survives the key round trip -------------
    // The landing writes these and the instrument reads them back; a field the encoder and
    // the decoder disagreed about would strand exactly the bake that produced it.
    {
        BakeOutcome added;
        added.status = BakeStatus::Ok;
        added.sampleId = "bake-1893456000-a1b2c3d4-kick_1893456000.wav";
        added.relativePath = "reasampler_bank/kick_1893456000-a1b2c3d4.wav";
        added.displayName = "Kick 2";
        added.rootNote = 36;
        added.channelCount = 2;
        added.replaced = false;
        added.message = "added as a distinct capture";
        added.generation = 1893456000;

        BakeOutcome replaced = added;
        replaced.replaced = true;
        replaced.displayName = "Kick";
        replaced.message = "replaced the bank entry";

        BakeOutcome deduped = added;
        deduped.message = "identical to an existing capture -- pointed at it";

        BakeOutcome noProject;
        noProject.status = BakeStatus::NoProject;
        noProject.message = "no saved project, so the bank has no location";
        noProject.generation = added.generation;

        BakeOutcome stagedMissing = noProject;
        stagedMissing.status = BakeStatus::StagedMissing;
        stagedMissing.message = "the staged render is not a usable WAV";

        BakeOutcome noSource = noProject;
        noSource.status = BakeStatus::NoSource;
        noSource.message = "the resampled capture is not in any bank";

        BakeOutcome indexRejected = noProject;
        indexRejected.status = BakeStatus::IndexRejected;
        indexRejected.message = "the bank refused the new capture";

        BakeOutcome wrongProject = noProject;
        wrongProject.status = BakeStatus::WrongProject;
        wrongProject.message =
            "this bake's project tab is not the one the extension has "
            "loaded -- focus that tab and try again";

        BakeOutcome writeFailed = noProject;
        writeFailed.status = BakeStatus::Failed;
        writeFailed.message = "could not write the bake into the bank folder";

        for (const BakeOutcome& emitted :
             {added, replaced, deduped, noProject, stagedMissing, noSource, indexRejected,
              wrongProject, writeFailed}) {
            const auto back = decodeBakeOutcome(encodeBakeOutcome(emitted));
            CHECK(back.has_value());
            CHECK(back.has_value() && *back == emitted);
            // Field for field as well: operator== is hand-written, so a field missing from
            // BOTH the codec and the comparison would pass the aggregate check above.
            CHECK(back.has_value() && back->status == emitted.status &&
                  back->sampleId == emitted.sampleId &&
                  back->relativePath == emitted.relativePath &&
                  back->displayName == emitted.displayName &&
                  back->rootNote == emitted.rootNote &&
                  back->channelCount == emitted.channelCount &&
                  back->replaced == emitted.replaced &&
                  back->message == emitted.message &&
                  back->generation == emitted.generation);
        }
    }

    if (g_fail == 0) std::printf("bake_wire: all tests passed\n");
    return g_fail ? 1 : 0;
}