mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-08 10:46:06 +00:00
* fix(media-use): tag HeyGen TTS generation with attribution header
Centralizes the X-HeyGen-Client-Source header into HEYGEN_CLIENT_SOURCE_ARGV
in heygen-cli.mjs and reuses it in heygen-search.mjs (dropping the duplicated
inline literal) so voice-provider's `voice speech create` call carries it too.
The generation call was previously untagged, making media-use TTS usage
invisible in HeyGen's billing/analytics warehouse; the read-only `voice list`
discovery call intentionally stays untagged.
* feat(media-use): add local LTX video generate provider
* feat(media-use): add HeyGen avatar-video generate provider
* feat(media-use): register video as a real provider type
* docs(media-use): document the wired video type and full HeyGen tagging coverage
resolve --type video is now the default path (HeyGen avatar video first,
local LTX fallback, sign-in nudge on auth failure) instead of a manual
recipe; correct the claim that only search requests are tagged now that
TTS and avatar-video generation carry the attribution header too.
* fix(media-use): wire --avatar-id/--voice-id CLI flags and close video-provider auth/cache gaps
- resolve.mjs never implemented the --avatar-id/--voice-id override that
operations.md documented, so following the docs crashed with
ERR_PARSE_ARGS_UNKNOWN_OPTION; wire the flags through to ctx.
- defaultAvatarId/defaultStarfishVoiceId cached a failed discovery lookup
as a permanent null, disabling heygen.video after one transient miss;
cache only a truthy id, matching the same fix in voice-provider.mjs's
defaultVoiceId.
- the avatar-video onboarding nudge only fired on a video-create failure,
never when avatar/voice discovery itself was unauthenticated (the
common unauthenticated case) -- propagate the discovery failure reason
so onboarding fires either way.
- dedupe the CLI-shelling JSON helper (heygen-cli.mjs's new runHeygenJson)
and the local-model argv-template builder (local-models.mjs's new
buildArgv) instead of leaving byte-identical copies in each provider.
* fix(media-use): address avatar-video PR review feedback
- heygenVideoGenerate short-circuits after the first discovery-call
failure instead of always attempting both avatar list and voice list,
so an unauthenticated caller gets one onboarding message and one
provider-error telemetry ping instead of a double-fire.
- runHeygenJson logs a diagnostic when a CLI call succeeds but returns
unparseable JSON, instead of silently returning null.
- dedupe the "avatar video is free" onboarding string into one constant
(was duplicated across three call sites).
* fix(media-use): match review-requested naming and message conventions
- export AVATAR_VIDEO_SIGNIN_MESSAGE from heygen-video-provider.mjs so
the test imports the canonical string instead of redeclaring it.
- runHeygenJson's non-JSON diagnostic now matches heygen-search.mjs's
existing wording ("returned non-JSON output").
50 lines
1.8 KiB
JavaScript
50 lines
1.8 KiB
JavaScript
import { strict as assert } from "node:assert";
|
|
import { chmodSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import { join } from "node:path";
|
|
import { test } from "node:test";
|
|
import { HEYGEN_CLIENT_SOURCE_HEADERS } from "../../audio/scripts/lib/heygen.mjs";
|
|
import { HEYGEN_CLIENT_SOURCE_ARGV } from "./heygen-cli.mjs";
|
|
import { heygenSearch } from "./heygen-search.mjs";
|
|
|
|
test("tags HeyGen searches with the shared media-use client source", () => {
|
|
const dir = mkdtempSync(join(tmpdir(), "media-use-heygen-search-"));
|
|
const capturePath = join(dir, "argv.log");
|
|
const heygenPath = join(dir, "heygen");
|
|
const previousPath = process.env.PATH;
|
|
const previousCapturePath = process.env.HEYGEN_CAPTURE_PATH;
|
|
|
|
writeFileSync(
|
|
heygenPath,
|
|
`#!/bin/sh
|
|
printf '%s\\n' "$*" >> "$HEYGEN_CAPTURE_PATH"
|
|
printf '%s\\n' '{"data":[{"id":"x"}]}'
|
|
`,
|
|
);
|
|
chmodSync(heygenPath, 0o755);
|
|
process.env.PATH = `${dir}:${previousPath ?? ""}`;
|
|
process.env.HEYGEN_CAPTURE_PATH = capturePath;
|
|
|
|
try {
|
|
const result = heygenSearch("audio sounds list", "ocean", { limit: 1 });
|
|
const argv = readFileSync(capturePath, "utf8").trim();
|
|
|
|
assert.deepEqual(result, [{ id: "x" }]);
|
|
assert.match(argv, /X-HeyGen-Client-Source: media-use/);
|
|
} finally {
|
|
if (previousPath === undefined) delete process.env.PATH;
|
|
else process.env.PATH = previousPath;
|
|
if (previousCapturePath === undefined) delete process.env.HEYGEN_CAPTURE_PATH;
|
|
else process.env.HEYGEN_CAPTURE_PATH = previousCapturePath;
|
|
rmSync(dir, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
test("keeps CLI and REST media-use client source headers in lockstep", () => {
|
|
const [entry] = Object.entries(HEYGEN_CLIENT_SOURCE_HEADERS);
|
|
assert.ok(entry);
|
|
const [key, value] = entry;
|
|
|
|
assert.equal(HEYGEN_CLIENT_SOURCE_ARGV[1], `${key}: ${value}`);
|
|
});
|