mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-11-18 07:50:13 +00:00
fix(cli): transcribe names why whisper is missing and the one line that fixes it (#7366)
* fix(cli): transcribe names why whisper is missing and the one line that fixes it * fix(cli): a Windows box gets a runnable install line and finds the whisper it just built
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
import { mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
|
||||
import { tmpdir } from "node:os";
|
||||
import { join } from "node:path";
|
||||
import { dirname, join } from "node:path";
|
||||
import { afterEach, expect, it, vi } from "vitest";
|
||||
import { ensureWhisper, findWhisper, WhisperUnavailableError } from "./manager.js";
|
||||
const calls = vi.hoisted(() => ({ exec: vi.fn() }));
|
||||
@@ -63,3 +63,50 @@ it("clones whisper.cpp inside its build dir, with no cache path on the command l
|
||||
rmSync(cache, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
it("names the missing build tool when whisper.cpp cannot be built", async () => {
|
||||
vi.stubEnv("HYPERFRAMES_CACHE_DIR", mkdtempSync(join(tmpdir(), "hf-whisper-cache-")));
|
||||
vi.resetModules();
|
||||
const { ensureWhisper: ensure } = await import("./manager.js");
|
||||
calls.exec.mockImplementation((command: string, args: string[]) => {
|
||||
if ((command === "which" || command === "where") && args[0] !== "git")
|
||||
throw new Error("not available");
|
||||
return `/bin/${args[0]}\n`;
|
||||
});
|
||||
await expect(ensure()).rejects.toThrow(/cannot build whisper\.cpp: cmake not found on PATH/);
|
||||
});
|
||||
|
||||
it("gives a Linux user one runnable line to get a working engine", async () => {
|
||||
vi.resetModules();
|
||||
vi.doMock("node:os", async (original) => ({
|
||||
...(await original<typeof import("node:os")>()),
|
||||
platform: () => "linux",
|
||||
}));
|
||||
const { getInstallInstructions } = await import("./manager.js");
|
||||
expect(getInstallInstructions()).toContain("sudo apt-get install -y git cmake build-essential");
|
||||
vi.doUnmock("node:os");
|
||||
});
|
||||
|
||||
it("gives a Windows user one runnable winget line, and finds a Release-built whisper-cli.exe", async () => {
|
||||
const cache = mkdtempSync(join(tmpdir(), "hf-whisper-cache-"));
|
||||
vi.stubEnv("HYPERFRAMES_CACHE_DIR", cache);
|
||||
vi.resetModules();
|
||||
vi.doMock("node:os", async (original) => ({
|
||||
...(await original<typeof import("node:os")>()),
|
||||
platform: () => "win32",
|
||||
}));
|
||||
try {
|
||||
const { getInstallInstructions, findWhisper } = await import("./manager.js");
|
||||
expect(getInstallInstructions()).toContain("winget install -e --id Kitware.CMake");
|
||||
calls.exec.mockImplementation(() => {
|
||||
throw new Error("not available");
|
||||
});
|
||||
const exe = join(cache, "whisper", "whisper.cpp", "build", "bin", "Release", "whisper-cli.exe");
|
||||
mkdirSync(dirname(exe), { recursive: true });
|
||||
writeFileSync(exe, "binary");
|
||||
expect(findWhisper()?.executablePath).toBe(exe);
|
||||
} finally {
|
||||
vi.doUnmock("node:os");
|
||||
rmSync(cache, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
@@ -149,9 +149,12 @@ const BUILD_DIR = hyperframesCacheDir("whisper", "whisper.cpp");
|
||||
const WHISPER_REPO = "https://github.com/ggml-org/whisper.cpp.git";
|
||||
|
||||
function findBuiltBinary(): WhisperResult | undefined {
|
||||
// Windows (Visual Studio generator) writes bin/Release/whisper-cli.exe, not bin/whisper-cli.
|
||||
const exe = platform() === "win32" ? ".exe" : "";
|
||||
for (const p of [
|
||||
join(BUILD_DIR, "build", "bin", "whisper-cli"),
|
||||
join(BUILD_DIR, "build", "whisper-cli"),
|
||||
join(BUILD_DIR, "build", "bin", "Release", `whisper-cli${exe}`),
|
||||
join(BUILD_DIR, "build", "bin", `whisper-cli${exe}`),
|
||||
join(BUILD_DIR, "build", `whisper-cli${exe}`),
|
||||
]) {
|
||||
if (existsSync(p)) return { executablePath: p, source: "build" };
|
||||
}
|
||||
@@ -233,10 +236,10 @@ export function getInstallInstructions(): string {
|
||||
return "brew install whisper-cpp";
|
||||
}
|
||||
if (platform() === "linux") {
|
||||
return "Build from source: https://github.com/ggml-org/whisper.cpp#building (requires cmake and a C compiler)";
|
||||
return "sudo apt-get install -y git cmake build-essential (Debian/Ubuntu; other distros: git, cmake and a C compiler, see https://github.com/ggml-org/whisper.cpp#building), then re-run";
|
||||
}
|
||||
if (platform() === "win32") {
|
||||
return "Build with cmake: https://github.com/ggml-org/whisper.cpp#building";
|
||||
return 'winget install -e --id Git.Git && winget install -e --id Kitware.CMake && winget install -e --id Microsoft.VisualStudio.2022.BuildTools --override "--passive --add Microsoft.VisualStudio.Workload.VCTools", then re-run in a new terminal (or set HYPERFRAMES_WHISPER_PATH to the whisper-cli.exe in whisper-bin-x64.zip from https://github.com/ggml-org/whisper.cpp/releases)';
|
||||
}
|
||||
return "See https://github.com/ggml-org/whisper.cpp#building";
|
||||
}
|
||||
@@ -269,6 +272,10 @@ export async function ensureWhisper(options?: {
|
||||
);
|
||||
}
|
||||
|
||||
// What each attempt hit, so the final error names the real cause instead of a bare install hint.
|
||||
const causes: string[] = [];
|
||||
const why = (err: unknown) => (err instanceof Error ? err.message : String(err)).trim();
|
||||
|
||||
// 2. Try brew (macOS, fastest — pre-built bottle)
|
||||
if (platform() === "darwin" && hasBrew()) {
|
||||
options?.onProgress?.("Installing whisper-cpp via Homebrew...");
|
||||
@@ -280,8 +287,8 @@ export async function ensureWhisper(options?: {
|
||||
});
|
||||
const installed = findFromSystem();
|
||||
if (installed) return { ...installed, source: "brew" };
|
||||
} catch {
|
||||
// brew failed — fall through
|
||||
} catch (err) {
|
||||
causes.push(`brew install whisper-cpp failed: ${why(err)}`);
|
||||
}
|
||||
signal?.throwIfAborted();
|
||||
}
|
||||
@@ -290,14 +297,19 @@ export async function ensureWhisper(options?: {
|
||||
if (hasGit() && hasCmake()) {
|
||||
try {
|
||||
return await buildFromSource(options?.onProgress, signal);
|
||||
} catch {
|
||||
// build failed — fall through
|
||||
} catch (err) {
|
||||
causes.push(why(err));
|
||||
}
|
||||
signal?.throwIfAborted();
|
||||
} else {
|
||||
const missing = [!hasGit() && "git", !hasCmake() && "cmake"].filter(Boolean).join(" and ");
|
||||
causes.push(`cannot build whisper.cpp: ${missing} not found on PATH`);
|
||||
}
|
||||
|
||||
// 4. Give up — tell the user how
|
||||
throw new WhisperUnavailableError(`whisper-cpp not found. Install: ${getInstallInstructions()}`);
|
||||
// 4. Give up — tell the user why and how
|
||||
throw new WhisperUnavailableError(
|
||||
`whisper-cpp not found (${causes.join("; ")}). Install: ${getInstallInstructions()}`,
|
||||
);
|
||||
}
|
||||
|
||||
export async function ensureModel(
|
||||
|
||||
Reference in New Issue
Block a user