mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-05 00:56:23 +00:00
* chore(cli): regenerate cloud client for createAssetUpload + completeAssetUpload
Regenerated from experiment-framework `master` at commit `e74815f7af` (the
merge of EF#41085, which added `/v3/assets/direct-uploads` +
`/v3/assets/{asset_id}/complete` to the `TARGET_ENDPOINTS` allowlist in
`scripts/generate_hyperframes_cli_client.py`).
The `sync-hyperframes-codegen.yml` workflow that normally auto-opens this
PR failed with a `gh: Not Found (HTTP 404)` on the PR-creation step (run
28556975483); regenerated manually with:
cd experiment-framework
PYTHONPATH=. python3 scripts/generate_hyperframes_cli_client.py \\
--out /path/to/hyperframes-oss
This commit is codegen-only — no hand edits. The direct-upload wire-up
that consumes the new `createAssetUpload` + `completeAssetUpload` methods
lands in the follow-up commit.
— Jerrai
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
* feat(cli): migrate cloud-render upload to /v3/assets/direct-uploads (200MB)
Replaces the legacy `client.uploadAsset(...)` multipart POST to
`/v3/assets` (32 MB in-memory proxy path) with the three-step direct-to-
S3 flow that lifts the practical per-project ceiling to 200 MB:
1. `POST /v3/assets/direct-uploads` — declares filename, content-type,
size, and SHA256 checksum; returns `asset_id`, presigned
`upload_url`, and required `upload_headers`.
2. Raw `PUT` to `upload_url` with the zip bytes + `upload_headers`
verbatim. No CLI auth attached — the presigned URL signature carries
authorization, and any extra headers would break the signature.
3. `POST /v3/assets/{asset_id}/complete` — finalizes into a reusable
asset. Retried up to 5x on 409 ("Uploaded object not found yet"), a
documented race between S3 write consistency and the finalize check.
The returned `asset_id` is the same namespace the legacy path produced
(both write into `movio_asset`), so the downstream render submission at
`createRender({project: {type: "asset_id", asset_id}})` is unchanged.
Server-side context (EF#41085): the direct-upload endpoint now accepts
`application/zip` via a scoped `_ZIP_MIME_TO_EXT` map — the shared media/
PDF allowlist stays zip-free. The exact-MIME cross-check at the sniff
step guards against zip<->PDF confusion under the shared 'document'
category. Canonical S3 key layout matches the legacy proxy path
(`document/{asset_id}/original.zip`), so the render-side head_object
gate is transparent to which upload path produced the asset.
The prior codegen commit added the generated createAssetUpload +
completeAssetUpload methods this commit consumes.
— Jerrai
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
235 lines
7.7 KiB
TypeScript
235 lines
7.7 KiB
TypeScript
import { describe, it, expect, vi } from "vitest";
|
|
import { createHash } from "node:crypto";
|
|
import { HyperframesApiError } from "./_gen/client.js";
|
|
import type { HyperframesCloudClient } from "./_gen/client.js";
|
|
import { uploadZipViaDirectUpload } from "./upload.js";
|
|
|
|
function sha256Hex(bytes: Uint8Array): string {
|
|
return createHash("sha256").update(bytes).digest("hex");
|
|
}
|
|
|
|
function makeClient(overrides: Partial<HyperframesCloudClient> = {}): HyperframesCloudClient {
|
|
return {
|
|
createAssetUpload: vi.fn(async () => ({
|
|
asset_id: "asset_xyz",
|
|
upload_url: "https://s3.example/asset_xyz?sig=abc",
|
|
upload_headers: { "x-amz-checksum-sha256-b64": "..." },
|
|
expires_in_seconds: 3600,
|
|
max_bytes: 200 * 1024 * 1024,
|
|
status: "pending_upload" as const,
|
|
})),
|
|
completeAssetUpload: vi.fn(async () => ({
|
|
asset_id: "asset_xyz",
|
|
url: "https://files.heygen.com/document/asset_xyz/original.zip",
|
|
mime_type: "application/zip",
|
|
size_bytes: 42,
|
|
status: "processing" as const,
|
|
})),
|
|
...overrides,
|
|
} as unknown as HyperframesCloudClient;
|
|
}
|
|
|
|
function makeFetchOk(): typeof fetch {
|
|
return vi.fn(async () => new Response("", { status: 200 })) as unknown as typeof fetch;
|
|
}
|
|
|
|
describe("uploadZipViaDirectUpload", () => {
|
|
it("sends the correct filename, content_type, size_bytes, and SHA256 to createAssetUpload", async () => {
|
|
const bytes = new TextEncoder().encode("hello-hyperframes-zip");
|
|
const expectedSha = sha256Hex(bytes);
|
|
const client = makeClient();
|
|
const fetchImpl = makeFetchOk();
|
|
|
|
await uploadZipViaDirectUpload({
|
|
client,
|
|
bytes,
|
|
filename: "my-comp.zip",
|
|
fetchImpl,
|
|
});
|
|
|
|
expect(client.createAssetUpload).toHaveBeenCalledOnce();
|
|
const arg = (client.createAssetUpload as ReturnType<typeof vi.fn>).mock.calls[0]![0];
|
|
expect(arg.body).toEqual({
|
|
filename: "my-comp.zip",
|
|
content_type: "application/zip",
|
|
size_bytes: bytes.byteLength,
|
|
checksum_sha256: expectedSha,
|
|
});
|
|
});
|
|
|
|
it("PUTs to the returned upload_url with the returned upload_headers verbatim + content-type", async () => {
|
|
const bytes = new Uint8Array([1, 2, 3, 4]);
|
|
const client = makeClient({
|
|
createAssetUpload: vi.fn(async () => ({
|
|
asset_id: "asset_xyz",
|
|
upload_url: "https://s3.example/target?sig=xxx",
|
|
upload_headers: { "x-signed-header": "signed-value", "x-other": "other-value" },
|
|
expires_in_seconds: 3600,
|
|
max_bytes: 200 * 1024 * 1024,
|
|
status: "pending_upload" as const,
|
|
})) as HyperframesCloudClient["createAssetUpload"],
|
|
});
|
|
const fetchImpl = makeFetchOk();
|
|
|
|
await uploadZipViaDirectUpload({ client, bytes, filename: "x.zip", fetchImpl });
|
|
|
|
expect(fetchImpl).toHaveBeenCalledOnce();
|
|
const [url, init] = (fetchImpl as ReturnType<typeof vi.fn>).mock.calls[0]!;
|
|
expect(url).toBe("https://s3.example/target?sig=xxx");
|
|
expect(init.method).toBe("PUT");
|
|
expect(init.body).toBe(bytes);
|
|
expect(init.headers).toEqual({
|
|
"content-type": "application/zip",
|
|
"x-signed-header": "signed-value",
|
|
"x-other": "other-value",
|
|
});
|
|
});
|
|
|
|
it("does NOT attach CLI auth headers to the S3 PUT — presigned URL carries auth", async () => {
|
|
const client = makeClient();
|
|
const fetchImpl = makeFetchOk();
|
|
|
|
await uploadZipViaDirectUpload({
|
|
client,
|
|
bytes: new Uint8Array([0]),
|
|
filename: "x.zip",
|
|
fetchImpl,
|
|
});
|
|
|
|
const init = (fetchImpl as ReturnType<typeof vi.fn>).mock.calls[0]![1];
|
|
// No Authorization / x-api-key / Bearer header should be present.
|
|
const headerKeys = Object.keys(init.headers as Record<string, string>).map((k) =>
|
|
k.toLowerCase(),
|
|
);
|
|
expect(headerKeys).not.toContain("authorization");
|
|
expect(headerKeys).not.toContain("x-api-key");
|
|
});
|
|
|
|
it("calls completeAssetUpload with the initialize's asset_id + same checksum", async () => {
|
|
const bytes = new TextEncoder().encode("determinism");
|
|
const expectedSha = sha256Hex(bytes);
|
|
const client = makeClient();
|
|
const fetchImpl = makeFetchOk();
|
|
|
|
const result = await uploadZipViaDirectUpload({
|
|
client,
|
|
bytes,
|
|
filename: "x.zip",
|
|
fetchImpl,
|
|
});
|
|
|
|
expect(client.completeAssetUpload).toHaveBeenCalledOnce();
|
|
const completeArg = (client.completeAssetUpload as ReturnType<typeof vi.fn>).mock.calls[0]![0];
|
|
expect(completeArg.asset_id).toBe("asset_xyz");
|
|
expect(completeArg.body).toEqual({ checksum_sha256: expectedSha });
|
|
expect(result.asset_id).toBe("asset_xyz");
|
|
expect(result.size_bytes).toBe(bytes.byteLength);
|
|
});
|
|
|
|
it("retries completeAssetUpload on 409 and succeeds on a later attempt", async () => {
|
|
let completeCalls = 0;
|
|
const completeAssetUpload = vi.fn(async () => {
|
|
completeCalls++;
|
|
if (completeCalls < 3) {
|
|
throw new HyperframesApiError({
|
|
status: 409,
|
|
message: "Uploaded object not found yet. Retry after upload PUT returns 200.",
|
|
code: "conflict",
|
|
});
|
|
}
|
|
return {
|
|
asset_id: "asset_xyz",
|
|
url: "u",
|
|
mime_type: "application/zip",
|
|
size_bytes: 1,
|
|
status: "processing" as const,
|
|
};
|
|
});
|
|
const client = makeClient({
|
|
completeAssetUpload:
|
|
completeAssetUpload as unknown as HyperframesCloudClient["completeAssetUpload"],
|
|
});
|
|
|
|
const result = await uploadZipViaDirectUpload({
|
|
client,
|
|
bytes: new Uint8Array([0]),
|
|
filename: "x.zip",
|
|
fetchImpl: makeFetchOk(),
|
|
});
|
|
|
|
expect(completeCalls).toBe(3);
|
|
expect(result.asset_id).toBe("asset_xyz");
|
|
});
|
|
|
|
it("surfaces non-409 errors from complete without retrying", async () => {
|
|
let completeCalls = 0;
|
|
const completeAssetUpload = vi.fn(async () => {
|
|
completeCalls++;
|
|
throw new HyperframesApiError({
|
|
status: 400,
|
|
message: "invalid checksum",
|
|
code: "invalid_parameter",
|
|
});
|
|
});
|
|
const client = makeClient({
|
|
completeAssetUpload:
|
|
completeAssetUpload as unknown as HyperframesCloudClient["completeAssetUpload"],
|
|
});
|
|
|
|
await expect(
|
|
uploadZipViaDirectUpload({
|
|
client,
|
|
bytes: new Uint8Array([0]),
|
|
filename: "x.zip",
|
|
fetchImpl: makeFetchOk(),
|
|
}),
|
|
).rejects.toThrow(/invalid checksum/);
|
|
expect(completeCalls).toBe(1);
|
|
});
|
|
|
|
it("surfaces PUT failures with response body detail", async () => {
|
|
const client = makeClient();
|
|
const fetchImpl = vi.fn(
|
|
async () =>
|
|
new Response("SignatureDoesNotMatch: request signature we calculated does not match", {
|
|
status: 403,
|
|
}),
|
|
) as unknown as typeof fetch;
|
|
|
|
await expect(
|
|
uploadZipViaDirectUpload({
|
|
client,
|
|
bytes: new Uint8Array([0]),
|
|
filename: "x.zip",
|
|
fetchImpl,
|
|
}),
|
|
).rejects.toThrow(/Direct upload PUT failed: 403.*SignatureDoesNotMatch/);
|
|
});
|
|
|
|
it("passes idempotencyKey through to createAssetUpload", async () => {
|
|
const client = makeClient();
|
|
await uploadZipViaDirectUpload({
|
|
client,
|
|
bytes: new Uint8Array([0]),
|
|
filename: "x.zip",
|
|
idempotencyKey: "test-key-123",
|
|
fetchImpl: makeFetchOk(),
|
|
});
|
|
const arg = (client.createAssetUpload as ReturnType<typeof vi.fn>).mock.calls[0]![0];
|
|
expect(arg.idempotencyKey).toBe("test-key-123");
|
|
});
|
|
|
|
it("emits progress events in order", async () => {
|
|
const client = makeClient();
|
|
const events: Array<{ phase: string }> = [];
|
|
await uploadZipViaDirectUpload({
|
|
client,
|
|
bytes: new Uint8Array([0]),
|
|
filename: "x.zip",
|
|
fetchImpl: makeFetchOk(),
|
|
onProgress: (e) => events.push({ phase: e.phase }),
|
|
});
|
|
expect(events.map((e) => e.phase)).toEqual(["initialize", "upload", "upload", "complete"]);
|
|
});
|
|
});
|