@editframe/cli 0.26.3-beta.0 → 0.30.0-beta.13

package/src/operations/syncAssetsDirectory/SubAssetSync.ts

@@ -1,45 +0,0 @@
-import debug from "debug";
-import { SyncCaption } from "./SyncCaption.js";
-import { SyncFragmentIndex } from "./SyncFragmentIndex.js";
-import { SyncImage } from "./SyncImage.js";
-import type { SyncStatus } from "./SyncStatus.js";
-import { SyncTrack } from "./SyncTrack.js";
-
-export interface SubAssetSync<CreationType> {
-  icon: string;
-  label: string;
-  path: string;
-  md5: string;
-  prepare: () => Promise<void>;
-  validate: () => Promise<void>;
-  create: () => Promise<void>;
-  upload: () => Promise<void>;
-  syncStatus: SyncStatus;
-  isComplete: () => boolean;
-  markSynced: () => Promise<void>;
-  created: CreationType | null;
-}
-
-const trackMatch = /\.track-[\d]+.mp4$/i;
-const fragmentIndexMatch = /\.tracks.json$/i;
-const captionsMatch = /\.captions.json$/i;
-const imageMatch = /\.(png|jpe?g|gif|webp)$/i;
-
-const log = debug("ef:SubAssetSync");
-
-export const getAssetSync = (subAssetPath: string, md5: string) => {
-  log("getAssetSync", { subAssetPath, md5 });
-  if (imageMatch.test(subAssetPath)) {
-    return new SyncImage(subAssetPath, md5);
-  }
-  if (trackMatch.test(subAssetPath)) {
-    return new SyncTrack(subAssetPath, md5);
-  }
-  if (fragmentIndexMatch.test(subAssetPath)) {
-    return new SyncFragmentIndex(subAssetPath, md5);
-  }
-  if (captionsMatch.test(subAssetPath)) {
-    return new SyncCaption(subAssetPath, md5);
-  }
-  throw new Error(`Unrecognized sub-asset type: ${subAssetPath}`);
-};

package/src/operations/syncAssetsDirectory/SyncCaption.test.ts

@@ -1,180 +0,0 @@
-import { setupServer } from "msw/node";
-import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
-import { fixture, withFixtures } from "../../../test-fixtures/fixture.js";
-import {
-  mockCreateCaptionFile,
-  mockLookupCaptionFileByMd5,
-  mockLookupCaptionFileByMd5NotFound,
-  mockUploadCaptionFile,
-} from "../../../test-fixtures/network.js";
-import { SyncCaption } from "./SyncCaption.js";
-
-const server = setupServer();
-
-describe("SyncCaption", async () => {
-  beforeAll(() => {
-    server.listen();
-    process.env.EF_TOKEN = "ef_SECRET_TOKEN";
-    process.env.EF_HOST = "http://localhost:3000";
-  });
-  afterAll(() => server.close());
-  afterEach(() => server.resetHandlers());
-  await withFixtures(
-    [fixture("test.mp4", "test.mp4")],
-    async ({ files: [video], generateCaptions }) => {
-      test("Reads byte size", async () => {
-        const syncCaption = new SyncCaption(
-          await generateCaptions(video!),
-          video!.md5,
-        );
-        await expect(syncCaption.byteSize()).resolves.toEqual(35);
-      });
-
-      test("prepare() is noop", async () => {
-        const syncCaption = new SyncCaption(
-          await generateCaptions(video!),
-          video!.md5,
-        );
-        await expect(syncCaption.prepare()).resolves.toBeUndefined();
-      });
-
-      test("validate() is noop", async () => {
-        const syncCaption = new SyncCaption(
-          await generateCaptions(video!),
-          video!.md5,
-        );
-        await expect(syncCaption.validate()).resolves.toBeUndefined();
-      });
-
-      describe(".create()", () => {
-        test("uses matching data when file matches md5", async () => {
-          server.use(
-            mockLookupCaptionFileByMd5({
-              md5: video!.md5,
-              fixture: video!,
-            }),
-          );
-          const syncCaption = new SyncCaption(
-            await generateCaptions(video!),
-            video!.md5,
-          );
-          await syncCaption.create();
-          expect(syncCaption.isComplete()).toBe(true);
-        });
-        test("isComplete() returns false when not created", async () => {
-          server.use(
-            mockLookupCaptionFileByMd5NotFound({
-              md5: video!.md5,
-            }),
-            mockCreateCaptionFile({
-              complete: false,
-              id: "123",
-              filename: "test.mp4",
-              fixture: video!,
-            }),
-          );
-          const syncCaption = new SyncCaption(
-            await generateCaptions(video!),
-            video!.md5,
-          );
-          await syncCaption.create();
-          expect(syncCaption.isComplete()).toBe(false);
-        });
-
-        test("isComplete() returns true when created", async () => {
-          server.use(
-            mockLookupCaptionFileByMd5NotFound({
-              md5: video!.md5,
-            }),
-            mockCreateCaptionFile({
-              complete: true,
-              id: "123",
-              filename: "test.mp4",
-              fixture: video!,
-            }),
-          );
-          const syncCaption = new SyncCaption(
-            await generateCaptions(video!),
-            video!.md5,
-          );
-          await syncCaption.create();
-          expect(syncCaption.isComplete()).toBe(true);
-        });
-      });
-
-      describe(".upload()", () => {
-        test("throws when not created", async () => {
-          const syncCaption = new SyncCaption(
-            await generateCaptions(video!),
-            video!.md5,
-          );
-          await expect(syncCaption.upload()).rejects.toThrow();
-        });
-
-        test("uploads caption", async () => {
-          server.use(
-            mockLookupCaptionFileByMd5NotFound({
-              md5: video!.md5,
-            }),
-            mockCreateCaptionFile({
-              complete: true,
-              id: "123",
-              filename: "test.mp4",
-              fixture: video!,
-            }),
-            mockUploadCaptionFile({
-              id: "123",
-              filename: "test.mp4",
-              fixture: video!,
-            }),
-          );
-          const syncCaption = new SyncCaption(
-            await generateCaptions(video!),
-            video!.md5,
-          );
-          await syncCaption.create();
-          await expect(syncCaption.upload()).resolves.toBeUndefined();
-        });
-      });
-
-      describe(".markSynced()", () => {
-        test("throws when not created", async () => {
-          const syncCaption = new SyncCaption(
-            await generateCaptions(video!),
-            video!.md5,
-          );
-          await expect(syncCaption.markSynced()).rejects.toThrow();
-        });
-
-        test("marks synced", async () => {
-          server.use(
-            mockLookupCaptionFileByMd5NotFound({
-              md5: video!.md5,
-            }),
-            mockCreateCaptionFile({
-              complete: true,
-              id: "123",
-              filename: "test.mp4",
-              fixture: video!,
-            }),
-          );
-          const syncCaption = new SyncCaption(
-            await generateCaptions(video!),
-            video!.md5,
-          );
-          await syncCaption.create();
-          await syncCaption.markSynced();
-
-          await expect(syncCaption.syncStatus.isSynced()).resolves.toBe(true);
-          await expect(syncCaption.syncStatus.readInfo()).resolves.toEqual({
-            version: "1",
-            complete: true,
-            id: "123",
-            md5: video!.md5,
-            byte_size: 35,
-          });
-        });
-      });
-    },
-  );
-});

package/src/operations/syncAssetsDirectory/SyncCaption.ts

@@ -1,87 +0,0 @@
-import fs from "node:fs/promises";
-import { basename } from "node:path";
-
-import { Readable } from "node:stream";
-import {
-  type CreateCaptionFileResult,
-  createCaptionFile,
-  type LookupCaptionFileByMd5Result,
-  lookupCaptionFileByMd5,
-  uploadCaptionFile,
-} from "@editframe/api";
-import { createReadableStreamFromReadable } from "../../utils/createReadableStreamFromReadable.js";
-import { getClient } from "../../utils/index.js";
-import type { SubAssetSync } from "./SubAssetSync.js";
-import { SyncStatus } from "./SyncStatus.js";
-export class SyncCaption implements SubAssetSync<CreateCaptionFileResult> {
-  icon = "📝";
-  label = "captions";
-  syncStatus: SyncStatus = new SyncStatus(this.path);
-  created: CreateCaptionFileResult | LookupCaptionFileByMd5Result | null = null;
-  constructor(
-    public path: string,
-    public md5: string,
-  ) {}
-
-  async byteSize() {
-    return (await fs.stat(this.path)).size;
-  }
-
-  async prepare() {}
-
-  async validate() {}
-
-  async create() {
-    const maybeCaptionFile = await lookupCaptionFileByMd5(
-      getClient(),
-      this.md5,
-    );
-    if (maybeCaptionFile) {
-      this.created = maybeCaptionFile;
-    } else {
-      this.created = await createCaptionFile(getClient(), {
-        md5: this.md5,
-        filename: basename(this.path).replace(/\.captions.json$/, ""),
-        byte_size: await this.byteSize(),
-      });
-    }
-  }
-
-  isComplete() {
-    return !!this.created?.complete;
-  }
-
-  async upload() {
-    if (!this.created) {
-      throw new Error(
-        "Caption not created. Should have been prevented by .isComplete()",
-      );
-    }
-    await uploadCaptionFile(
-      getClient(),
-      this.created.id,
-      // It's not clear why we need to use Readable.from here, but it seems
-      // to fix an issue where the request is closed early in tests
-      createReadableStreamFromReadable(
-        Readable.from(await fs.readFile(this.path)),
-      ),
-      await this.byteSize(),
-    );
-  }
-
-  async markSynced() {
-    if (!this.created) {
-      throw new Error(
-        "Caption not created. Should have been prevented by .isComplete()",
-      );
-    }
-    const byteSize = await this.byteSize();
-    await this.syncStatus.markSynced({
-      version: "1",
-      complete: true,
-      id: this.created.id,
-      md5: this.md5,
-      byte_size: byteSize,
-    });
-  }
-}

package/src/operations/syncAssetsDirectory/SyncFragmentIndex.test.ts

@@ -1,185 +0,0 @@
-import { setupServer } from "msw/node";
-import { afterAll, afterEach, beforeAll, describe, expect, test } from "vitest";
-import { fixture, withFixtures } from "../../../test-fixtures/fixture.js";
-import {
-  mockCreateIsobmffFile,
-  mockLookupISOBMFFFileByMd5,
-  mockLookupISOBMFFFileByMd5NotFound,
-  mockUploadIsobmffFileIndex,
-} from "../../../test-fixtures/network.js";
-import { SyncFragmentIndex } from "./SyncFragmentIndex.js";
-
-const server = setupServer();
-
-describe("SyncFragmentIndex", async () => {
-  beforeAll(() => {
-    server.listen();
-    process.env.EF_TOKEN = "ef_SECRET_TOKEN";
-    process.env.EF_HOST = "http://localhost:3000";
-  });
-  afterAll(() => server.close());
-  afterEach(() => server.resetHandlers());
-  await withFixtures(
-    [fixture("test.mp4", "test.mp4")],
-    async ({ files: [video], generateTrackFragmentIndex }) => {
-      test("Reads byte size", async () => {
-        const syncFragmentIndex = new SyncFragmentIndex(
-          await generateTrackFragmentIndex(video!),
-          video!.md5,
-        );
-        await expect(syncFragmentIndex.byteSize()).resolves.toEqual(31);
-      });
-      test("prepare() is noop", async () => {
-        const syncFragmentIndex = new SyncFragmentIndex(
-          await generateTrackFragmentIndex(video!),
-          video!.md5,
-        );
-        await expect(syncFragmentIndex.prepare()).resolves.toBeUndefined();
-      });
-      test("validate() is noop", async () => {
-        const syncFragmentIndex = new SyncFragmentIndex(
-          await generateTrackFragmentIndex(video!),
-          video!.md5,
-        );
-        await expect(syncFragmentIndex.validate()).resolves.toBeUndefined();
-      });
-      describe(".create()", () => {
-        test("uses matching data when file matches md5", async () => {
-          server.use(
-            mockLookupISOBMFFFileByMd5({
-              md5: video!.md5,
-              fixture: video!,
-            }),
-          );
-          const syncFragmentIndex = new SyncFragmentIndex(
-            await generateTrackFragmentIndex(video!),
-            video!.md5,
-          );
-          await syncFragmentIndex.create();
-          expect(syncFragmentIndex.isComplete()).toBe(false);
-        });
-        test("isComplete() returns false when not created", async () => {
-          server.use(
-            mockLookupISOBMFFFileByMd5NotFound({
-              md5: video!.md5,
-            }),
-            mockCreateIsobmffFile({
-              complete: false,
-              id: "123",
-              filename: "test.mp4",
-              fixture: video!,
-            }),
-          );
-          const syncFragmentIndex = new SyncFragmentIndex(
-            await generateTrackFragmentIndex(video!),
-            video!.md5,
-          );
-          await syncFragmentIndex.create();
-          expect(syncFragmentIndex.isComplete()).toBe(false);
-        });
-        test("isComplete() returns true when created", async () => {
-          server.use(
-            mockLookupISOBMFFFileByMd5NotFound({
-              md5: video!.md5,
-            }),
-            mockCreateIsobmffFile({
-              complete: true,
-              id: "123",
-              filename: "test.mp4",
-              fixture: video!,
-            }),
-          );
-          const syncFragmentIndex = new SyncFragmentIndex(
-            await generateTrackFragmentIndex(video!),
-            video!.md5,
-          );
-          await syncFragmentIndex.create();
-          expect(syncFragmentIndex.isComplete()).toBe(true);
-        });
-      });
-      describe(".upload()", () => {
-        test("throws when not created", async () => {
-          const syncFragmentIndex = new SyncFragmentIndex(
-            await generateTrackFragmentIndex(video!),
-            video!.md5,
-          );
-          await expect(syncFragmentIndex.upload()).rejects.toThrow();
-        });
-        test("uploads index", async () => {
-          server.use(
-            mockLookupISOBMFFFileByMd5NotFound({
-              md5: video!.md5,
-            }),
-            mockCreateIsobmffFile({
-              complete: true,
-              id: "123",
-              filename: "test.mp4",
-              fixture: video!,
-            }),
-            mockUploadIsobmffFileIndex({
-              id: "123",
-            }),
-          );
-          const syncFragmentIndex = new SyncFragmentIndex(
-            await generateTrackFragmentIndex(video!),
-            video!.md5,
-          );
-          await syncFragmentIndex.create();
-          await expect(syncFragmentIndex.upload()).resolves.toBeUndefined();
-        });
-      });
-      describe(".markSynced()", () => {
-        test("throws when not created", async () => {
-          const syncFragmentIndex = new SyncFragmentIndex(
-            await generateTrackFragmentIndex(video!),
-            video!.md5,
-          );
-          await expect(syncFragmentIndex.markSynced()).rejects.toThrow();
-        });
-        test("marks synced", async () => {
-          server.use(
-            mockLookupISOBMFFFileByMd5NotFound({
-              md5: video!.md5,
-            }),
-            mockCreateIsobmffFile({
-              complete: true,
-              id: "123",
-              fixture: video!,
-            }),
-            mockUploadIsobmffFileIndex({
-              id: "123",
-            }),
-          );
-          const syncFragmentIndex = new SyncFragmentIndex(
-            await generateTrackFragmentIndex(video!),
-            video!.md5,
-          );
-          await syncFragmentIndex.create();
-          await syncFragmentIndex.markSynced();
-          await expect(syncFragmentIndex.syncStatus.isSynced()).resolves.toBe(
-            true,
-          );
-          await expect(
-            syncFragmentIndex.syncStatus.readInfo(),
-          ).resolves.toEqual({
-            version: "1",
-            complete: true,
-            id: "123",
-            md5: video!.md5,
-            byte_size: 31,
-          });
-
-          await expect(
-            syncFragmentIndex.fileSyncStatus.readInfo(),
-          ).resolves.toEqual({
-            version: "1",
-            complete: true,
-            id: "123",
-            md5: video!.md5,
-            byte_size: 31,
-          });
-        });
-      });
-    },
-  );
-});

package/src/operations/syncAssetsDirectory/SyncFragmentIndex.ts

@@ -1,101 +0,0 @@
-import fs from "node:fs/promises";
-import { basename, dirname, join } from "node:path";
-import { Readable } from "node:stream";
-
-import {
-  type CreateISOBMFFFileResult,
-  createISOBMFFFile,
-  type LookupISOBMFFFileByMd5Result,
-  lookupISOBMFFFileByMd5,
-  uploadFragmentIndex,
-} from "@editframe/api";
-
-import { createReadableStreamFromReadable } from "../../utils/createReadableStreamFromReadable.js";
-import { getClient } from "../../utils/index.js";
-import type { SubAssetSync } from "./SubAssetSync.js";
-import { SyncStatus } from "./SyncStatus.js";
-
-export class SyncFragmentIndex
-  implements SubAssetSync<CreateISOBMFFFileResult>
-{
-  icon = "📋";
-  label = "fragment index";
-  syncStatus = new SyncStatus(this.path);
-  fileSyncStatus = new SyncStatus(join(dirname(this.path), "isobmff"));
-  created: CreateISOBMFFFileResult | LookupISOBMFFFileByMd5Result | null = null;
-
-  constructor(
-    public path: string,
-    public md5: string,
-  ) {}
-
-  async byteSize() {
-    return (await fs.stat(this.path)).size;
-  }
-
-  async prepare() {}
-
-  async validate() {}
-
-  async create() {
-    const maybeISOBMFFFile = await lookupISOBMFFFileByMd5(
-      getClient(),
-      this.md5,
-    );
-    if (maybeISOBMFFFile) {
-      this.created = maybeISOBMFFFile;
-    } else {
-      this.created = await createISOBMFFFile(getClient(), {
-        md5: this.md5,
-        filename: basename(this.path).replace(/\.tracks.json$/, ""),
-      });
-    }
-  }
-
-  isComplete() {
-    return !!this.created?.fragment_index_complete;
-  }
-
-  async upload() {
-    if (!this.created) {
-      throw new Error(
-        "Fragment index not created. Should have been prevented by .isComplete()",
-      );
-    }
-    await uploadFragmentIndex(
-      getClient(),
-      this.created.id,
-      // It is unclear why we need to use Readable.from here
-      // Tests fail when using createReadStream
-      createReadableStreamFromReadable(
-        Readable.from(await fs.readFile(this.path)),
-      ),
-      await this.byteSize(),
-    );
-  }
-
-  async markSynced() {
-    if (!this.created) {
-      throw new Error(
-        "Fragment index not created. Should have been prevented by .isComplete()",
-      );
-    }
-    const byteSize = await this.byteSize();
-    await Promise.all([
-      this.syncStatus.markSynced({
-        version: "1",
-        complete: true,
-        id: this.created.id,
-        md5: this.md5,
-        byte_size: byteSize,
-      }),
-      this.fileSyncStatus.markSynced({
-        version: "1",
-        complete: true,
-        id: this.created.id,
-        md5: this.md5,
-        byte_size: byteSize,
-      }),
-    ]);
-  }
-}