Skip to content

armgit / Cap

Public Imported from GitHub
0

Open source Loom alternative. Beautiful, shareable screen recordings.

fix: answer the first Loom preview request with the rendered GIF

Richie McIlroy7e21e2b46bba
diff --git a/apps/web/__tests__/unit/loom-preview-gif.test.ts b/apps/web/__tests__/unit/loom-preview-gif.test.ts
index 08f63581c..384800926 100644
--- a/apps/web/__tests__/unit/loom-preview-gif.test.ts
+++ b/apps/web/__tests__/unit/loom-preview-gif.test.ts
@@ -1,4 +1,4 @@
-import { Option } from "effect";
+import { Effect, Option } from "effect";
import { beforeEach, describe, expect, it, vi } from "vitest";
const mocks = vi.hoisted(() => ({
@@ -28,8 +28,16 @@ vi.mock("@cap/database/schema", () => ({
videos: { id: "v.id", metadata: "v.metadata" },
}));
vi.mock("@cap/env", () => ({ serverEnv: () => mocks.env }));
+vi.mock("@/lib/server", async () => {
+ const { Effect } = await import("effect");
+ return {
+ runPromise: (effect: Parameters<typeof Effect.runPromise>[0]) =>
+ Effect.runPromise(effect),
+ };
+});
import {
+ ensureLoomPreviewGif,
isLoomPreviewDue,
LOOM_PREVIEW_RETRY_MS,
startLoomPreviewGif,
@@ -116,6 +124,12 @@ describe("startLoomPreviewGif", () => {
expect(mocks.fetch).not.toHaveBeenCalled();
});
+ it("lets the next view retry when the importer is busy", async () => {
+ mocks.fetch.mockResolvedValue(new Response("busy", { status: 503 }));
+ await expect(run()).resolves.toBe("busy");
+ expect(mocks.updates).toHaveLength(2);
+ });
+
it("waits before retrying a failed preview", async () => {
mocks.fetch.mockResolvedValue(new Response("busy", { status: 502 }));
await expect(run()).resolves.toBe("failed");
@@ -132,3 +146,70 @@ describe("startLoomPreviewGif", () => {
expect(mocks.fetch).not.toHaveBeenCalled();
});
});
+
+describe("ensureLoomPreviewGif", () => {
+ const bucket = (exists: () => boolean) =>
+ ({
+ getInternalSignedObjectUrl: (key: string) =>
+ Effect.succeed(`https://storage.example.com/${key}`),
+ getInternalPresignedPutUrl: (key: string) =>
+ Effect.succeed(`https://storage.example.com/${key}?put`),
+ headObject: () =>
+ exists() ? Effect.succeed({}) : Effect.fail(new Error("missing")),
+ }) as never;
+
+ it("returns straight away for videos without a pending Loom preview", async () => {
+ await expect(
+ Effect.runPromise(
+ ensureLoomPreviewGif(
+ { ...video, metadata: Option.none() } as never,
+ bucket(() => true),
+ "key",
+ ),
+ ),
+ ).resolves.toBe(false);
+ expect(mocks.fetch).not.toHaveBeenCalled();
+ });
+
+ it("renders the first pending preview before answering", async () => {
+ await expect(
+ Effect.runPromise(
+ ensureLoomPreviewGif(
+ {
+ ...video,
+ metadata: Option.some({ loomPreviewGif: { status: "pending" } }),
+ } as never,
+ bucket(() => false),
+ "key",
+ ),
+ ),
+ ).resolves.toBe(true);
+ expect(mocks.fetch).toHaveBeenCalledOnce();
+ });
+
+ it("waits for a preview another view is rendering", async () => {
+ vi.useFakeTimers();
+ let ready = false;
+ const pending = Effect.runPromise(
+ ensureLoomPreviewGif(
+ {
+ ...video,
+ metadata: Option.some({
+ loomPreviewGif: {
+ status: "started",
+ startedAt: new Date().toISOString(),
+ },
+ }),
+ } as never,
+ bucket(() => ready),
+ "key",
+ ),
+ );
+ await vi.advanceTimersByTimeAsync(4_000);
+ ready = true;
+ await vi.advanceTimersByTimeAsync(2_000);
+ await expect(pending).resolves.toBe(true);
+ expect(mocks.fetch).not.toHaveBeenCalled();
+ vi.useRealTimers();
+ });
+});
diff --git a/apps/web/app/api/video/preview/route.ts b/apps/web/app/api/video/preview/route.ts
index 17b39fe82..0ede7f221 100644
--- a/apps/web/app/api/video/preview/route.ts
+++ b/apps/web/app/api/video/preview/route.ts
@@ -1,11 +1,12 @@
import { provideOptionalAuth, Storage, Videos } from "@cap/web-backend";
import { Video } from "@cap/web-domain";
import { Effect, Option } from "effect";
-import { after, type NextRequest, NextResponse } from "next/server";
-import { isLoomPreviewDue, startLoomPreviewGif } from "@/lib/loom-preview-gif";
+import { type NextRequest, NextResponse } from "next/server";
+import { ensureLoomPreviewGif } from "@/lib/loom-preview-gif";
import { runPromise } from "@/lib/server";
export const dynamic = "force-dynamic";
+export const maxDuration = 120;
const PREVIEW_GIF_EXPIRES_SECONDS = 60 * 60;
@@ -47,35 +48,14 @@ export async function GET(request: NextRequest) {
Effect.catchAll(() => Effect.succeed(false)),
);
- if (!hasPreview) {
- if (isLoomPreviewDue(Option.getOrNull(video.metadata)))
- after(() =>
- startLoomPreviewGif({
- video,
- getVideoUrl: (key, expiresIn) =>
- runPromise(
- bucket.getInternalSignedObjectUrl(key, { expiresIn }),
- ),
- getPreviewPutUrl: (key, expiresIn) =>
- runPromise(
- bucket.getInternalPresignedPutUrl(
- key,
- {
- ContentType: "image/gif",
- CacheControl: "public, max-age=31536000, immutable",
- },
- { expiresIn },
- ),
- ),
- }).catch((error) => {
- console.warn(
- "[video/preview] Failed to create Loom preview GIF:",
- error,
- );
- }),
- );
+ if (
+ !hasPreview &&
+ !(
+ request.nextUrl.searchParams.get("fallback") !== "og" &&
+ (yield* ensureLoomPreviewGif(video, bucket, previewKey))
+ )
+ )
return null;
- }
return yield* bucket.getSignedObjectUrl(previewKey, {
expiresIn: PREVIEW_GIF_EXPIRES_SECONDS,
diff --git a/apps/web/lib/loom-preview-gif.ts b/apps/web/lib/loom-preview-gif.ts
index d6f42ae3d..f59f2d1ef 100644
--- a/apps/web/lib/loom-preview-gif.ts
+++ b/apps/web/lib/loom-preview-gif.ts
@@ -3,11 +3,19 @@ import "server-only";
import { db } from "@cap/database";
import { videos } from "@cap/database/schema";
import { serverEnv } from "@cap/env";
+import type { Storage } from "@cap/web-backend";
import type { Video } from "@cap/web-domain";
import { and, eq, sql } from "drizzle-orm";
-import { Option } from "effect";
+import { Effect, Option } from "effect";
+import { runPromise } from "@/lib/server";
export const LOOM_PREVIEW_RETRY_MS = 10 * 60 * 1000;
+const PREVIEW_WAIT_MS = 45_000;
+const PREVIEW_POLL_MS = 2_000;
+
+type PreviewBucket = Effect.Effect.Success<
+ ReturnType<Storage["getAccessForVideo"]>
+>[0];
const PREVIEW_URL_EXPIRES_SECONDS = 15 * 60;
export function isLoomPreviewDue(
@@ -86,6 +94,20 @@ export async function startLoomPreviewGif({
signal: AbortSignal.timeout(150_000),
});
await response.body?.cancel();
+ if (response.status === 503) {
+ await db()
+ .update(videos)
+ .set({
+ metadata: sql`JSON_SET(${videos.metadata}, '$.loomPreviewGif', JSON_OBJECT('status', 'pending'))`,
+ })
+ .where(
+ and(
+ eq(videos.id, video.id),
+ sql`JSON_UNQUOTE(JSON_EXTRACT(${videos.metadata}, '$.loomPreviewGif.startedAt')) = ${startedAt}`,
+ ),
+ );
+ return "busy" as const;
+ }
if (!response.ok) return "failed" as const;
await db()
.update(videos)
@@ -100,3 +122,65 @@ export async function startLoomPreviewGif({
);
return "complete" as const;
}
+
+function isLoomPreviewRendering(
+ metadata: Record<string, unknown> | null | undefined,
+ now = Date.now(),
+) {
+ const preview = metadata?.loomPreviewGif as
+ | { status?: string; startedAt?: string }
+ | undefined;
+ const startedAt = Date.parse(preview?.startedAt ?? "");
+ return (
+ preview?.status === "started" &&
+ Number.isFinite(startedAt) &&
+ now - startedAt <= LOOM_PREVIEW_RETRY_MS
+ );
+}
+
+export function ensureLoomPreviewGif(
+ video: Video.Video,
+ bucket: PreviewBucket,
+ previewKey: string,
+) {
+ return Effect.promise(async () => {
+ const metadata = Option.getOrNull(video.metadata);
+ if (isLoomPreviewDue(metadata)) {
+ const result = await startLoomPreviewGif({
+ video,
+ getVideoUrl: (key, expiresIn) =>
+ runPromise(bucket.getInternalSignedObjectUrl(key, { expiresIn })),
+ getPreviewPutUrl: (key, expiresIn) =>
+ runPromise(
+ bucket.getInternalPresignedPutUrl(
+ key,
+ {
+ ContentType: "image/gif",
+ CacheControl: "public, max-age=31536000, immutable",
+ },
+ { expiresIn },
+ ),
+ ),
+ }).catch((error) => {
+ console.warn("[loom-preview-gif] Preview GIF failed", error);
+ return "failed" as const;
+ });
+ if (result === "complete") return true;
+ if (result !== "already-started") return false;
+ } else if (!isLoomPreviewRendering(metadata)) {
+ return false;
+ }
+ const deadline = Date.now() + PREVIEW_WAIT_MS;
+ while (Date.now() < deadline) {
+ await new Promise((resolve) => setTimeout(resolve, PREVIEW_POLL_MS));
+ const exists = await runPromise(
+ bucket.headObject(previewKey).pipe(
+ Effect.as(true),
+ Effect.catchAll(() => Effect.succeed(false)),
+ ),
+ );
+ if (exists) return true;
+ }
+ return false;
+ });
+}