@hot-updater/server 0.29.4 → 0.29.6

package/src/handler.spec.ts

@@ -179,7 +179,7 @@ describe("createHandler", () => {
 
     const response = await handler(
       new Request(
-        "http://localhost/hot-updater/api/bundles?channel=production&platform=ios&limit=2&offset=10",
+        "http://localhost/hot-updater/api/bundles?channel=production&platform=ios&limit=2",
       ),
     );
 
@@ -202,12 +202,162 @@ describe("createHandler", () => {
           platform: "ios",
         },
         limit: 2,
-        offset: 10,
+        page: undefined,
       },
       undefined,
     );
   });
 
+  it("passes cursor pagination params through to getBundles", async () => {
+    const api = createApi();
+    api.getBundles.mockResolvedValue({
+      data: [testBundle],
+      pagination: {
+        total: 51,
+        hasNextPage: true,
+        hasPreviousPage: true,
+        currentPage: 2,
+        totalPages: 26,
+        nextCursor: "bundle-1",
+        previousCursor: "bundle-9",
+      },
+    });
+    const handler = createHandler(api, { basePath: "/hot-updater" });
+
+    const response = await handler(
+      new Request(
+        "http://localhost/hot-updater/api/bundles?channel=production&limit=20&after=bundle-20",
+      ),
+    );
+
+    expect(response.status).toBe(200);
+    expect(api.getBundles).toHaveBeenCalledWith(
+      {
+        where: {
+          channel: "production",
+        },
+        limit: 20,
+        page: undefined,
+        cursor: {
+          after: "bundle-20",
+          before: undefined,
+        },
+      },
+      undefined,
+    );
+  });
+
+  it("supports cursor pagination without a legacy offset query param", async () => {
+    const api = createApi();
+    api.getBundles.mockResolvedValue({
+      data: [testBundle],
+      pagination: {
+        total: 1,
+        hasNextPage: false,
+        hasPreviousPage: false,
+        currentPage: 1,
+        totalPages: 1,
+        nextCursor: null,
+        previousCursor: null,
+      },
+    });
+    const handler = createHandler(api, { basePath: "/hot-updater" });
+
+    const response = await handler(
+      new Request(
+        "http://localhost/hot-updater/api/bundles?channel=production&limit=20&after=bundle-20",
+      ),
+    );
+
+    expect(response.status).toBe(200);
+    expect(api.getBundles).toHaveBeenCalledWith(
+      {
+        where: {
+          channel: "production",
+        },
+        limit: 20,
+        page: undefined,
+        cursor: {
+          after: "bundle-20",
+          before: undefined,
+        },
+      },
+      undefined,
+    );
+  });
+
+  it("returns 400 when bundle list requests still send offset pagination", async () => {
+    const api = createApi();
+    const handler = createHandler(api, { basePath: "/hot-updater" });
+
+    const response = await handler(
+      new Request(
+        "http://localhost/hot-updater/api/bundles?limit=20&offset=40",
+      ),
+    );
+
+    expect(response.status).toBe(400);
+    await expect(response.json()).resolves.toEqual({
+      error:
+        "The 'offset' query parameter has been removed. Use 'after' or 'before' cursor pagination instead.",
+    });
+    expect(api.getBundles).not.toHaveBeenCalled();
+  });
+
+  it("passes page-aligned pagination params through to getBundles", async () => {
+    const api = createApi();
+    api.getBundles.mockResolvedValue({
+      data: [testBundle],
+      pagination: {
+        total: 121,
+        hasNextPage: true,
+        hasPreviousPage: true,
+        currentPage: 2,
+        totalPages: 7,
+        nextCursor: "bundle-1",
+        previousCursor: "bundle-9",
+      },
+    });
+    const handler = createHandler(api, { basePath: "/hot-updater" });
+
+    const response = await handler(
+      new Request(
+        "http://localhost/hot-updater/api/bundles?channel=production&limit=20&page=2&after=bundle-20",
+      ),
+    );
+
+    expect(response.status).toBe(200);
+    expect(api.getBundles).toHaveBeenCalledWith(
+      {
+        where: {
+          channel: "production",
+        },
+        limit: 20,
+        page: 2,
+        cursor: {
+          after: "bundle-20",
+          before: undefined,
+        },
+      },
+      undefined,
+    );
+  });
+
+  it("returns 400 when bundle list requests send an invalid page", async () => {
+    const api = createApi();
+    const handler = createHandler(api, { basePath: "/hot-updater" });
+
+    const response = await handler(
+      new Request("http://localhost/hot-updater/api/bundles?limit=20&page=0"),
+    );
+
+    expect(response.status).toBe(400);
+    await expect(response.json()).resolves.toEqual({
+      error: "The 'page' query parameter must be a positive integer.",
+    });
+    expect(api.getBundles).not.toHaveBeenCalled();
+  });
+
   it("returns 400 when the platform route parameter is invalid", async () => {
     const api = createApi();
     const handler = createHandler(api, { basePath: "/hot-updater" });

package/src/handler.ts

@@ -243,7 +243,28 @@ const handleGetBundles: RouteHandler = async (
   const channel = url.searchParams.get("channel") ?? undefined;
   const platform = url.searchParams.get("platform");
   const limit = Number(url.searchParams.get("limit")) || 50;
-  const offset = Number(url.searchParams.get("offset")) || 0;
+  const pageParam = url.searchParams.get("page");
+  const offset = url.searchParams.get("offset");
+  const after = url.searchParams.get("after") ?? undefined;
+  const before = url.searchParams.get("before") ?? undefined;
+  const page =
+    pageParam === null
+      ? undefined
+      : Number.isInteger(Number(pageParam)) && Number(pageParam) > 0
+        ? Number(pageParam)
+        : null;
+
+  if (offset !== null) {
+    throw new HandlerBadRequestError(
+      "The 'offset' query parameter has been removed. Use 'after' or 'before' cursor pagination instead.",
+    );
+  }
+
+  if (page === null) {
+    throw new HandlerBadRequestError(
+      "The 'page' query parameter must be a positive integer.",
+    );
+  }
 
   if (platform !== null && !isPlatform(platform)) {
     throw new HandlerBadRequestError(
@@ -258,7 +279,14 @@ const handleGetBundles: RouteHandler = async (
         ...(platform && { platform }),
       },
       limit,
-      offset,
+      page,
+      cursor:
+        after || before
+          ? {
+              after,
+              before,
+            }
+          : undefined,
     },
     context,
   );

package/src/runtime.spec.ts

@@ -31,6 +31,111 @@ type TestEnv = {
 type TestContext = RequestEnvContext<TestEnv>;
 
 describe("runtime createHotUpdater", () => {
+  it("resolves storage URLs with handler context when database fast-path is used", async () => {
+    const request = new Request(
+      "https://updates.example.com/api/check-update/app-version/ios/1.0.0/production/" +
+        `${NIL_UUID}/${NIL_UUID}`,
+    );
+    const getBundles = vi.fn<DatabasePlugin<TestContext>["getBundles"]>();
+    const getUpdateInfo = vi.fn<
+      NonNullable<DatabasePlugin<TestContext>["getUpdateInfo"]>
+    >(async () => ({
+      fileHash: bundle.fileHash,
+      id: bundle.id,
+      message: bundle.message,
+      shouldForceUpdate: bundle.shouldForceUpdate,
+      status: "UPDATE",
+      storageUri: bundle.storageUri,
+    }));
+    const getDownloadUrl = vi.fn<StoragePlugin<TestContext>["getDownloadUrl"]>(
+      async (_storageUri, context) => {
+        return {
+          fileUrl: new URL("/bundle.zip", context?.env?.assetHost).toString(),
+        };
+      },
+    );
+
+    const database: DatabasePlugin<TestContext> = {
+      name: "testDatabase",
+      async appendBundle() {},
+      async commitBundle() {},
+      async deleteBundle() {},
+      async getBundleById(id) {
+        return id === bundle.id ? bundle : null;
+      },
+      getBundles,
+      getUpdateInfo,
+      async getChannels() {
+        return ["production"];
+      },
+      async onUnmount() {},
+      async updateBundle() {},
+    };
+    const storage: StoragePlugin<TestContext> = {
+      name: "testStorage",
+      supportedProtocol: "s3",
+      async upload(key) {
+        return { storageUri: `s3://test-bucket/${key}` };
+      },
+      async delete() {},
+      getDownloadUrl,
+    };
+
+    const hotUpdater = createHotUpdater({
+      database,
+      storages: [storage],
+      basePath: "/api/check-update",
+      routes: {
+        updateCheck: true,
+        bundles: false,
+      },
+    });
+
+    const response = await hotUpdater.handler(request, {
+      env: {
+        assetHost: "https://assets.example.com",
+      },
+      request,
+    });
+
+    expect(response.status).toBe(200);
+    await expect(response.json()).resolves.toEqual({
+      fileHash: "hash123",
+      fileUrl: "https://assets.example.com/bundle.zip",
+      id: "00000000-0000-0000-0000-000000000001",
+      message: "Test bundle",
+      shouldForceUpdate: false,
+      status: "UPDATE",
+    });
+    expect(getUpdateInfo).toHaveBeenCalledWith(
+      {
+        _updateStrategy: "appVersion",
+        appVersion: "1.0.0",
+        bundleId: NIL_UUID,
+        channel: "production",
+        cohort: undefined,
+        minBundleId: NIL_UUID,
+        platform: "ios",
+      },
+      expect.objectContaining({
+        env: {
+          assetHost: "https://assets.example.com",
+        },
+        request: expect.any(Request),
+      }),
+    );
+    expect(getBundles).not.toHaveBeenCalled();
+    expect(getDownloadUrl).toHaveBeenCalledWith(
+      "s3://test-bucket/bundles/bundle.zip",
+      expect.objectContaining({
+        env: {
+          assetHost: "https://assets.example.com",
+        },
+        request: expect.any(Request),
+      }),
+    );
+  });
+
   it("passes the handler context to database and storage resolution", async () => {
     const request = new Request(
       "https://updates.example.com/api/check-update/app-version/ios/1.0.0/production/" +

package/src/types/index.ts

@@ -9,6 +9,8 @@ export interface PaginationInfo {
   hasPreviousPage: boolean;
   currentPage: number;
   totalPages: number;
+  nextCursor?: string | null;
+  previousCursor?: string | null;
 }
 
 export interface PaginationOptions {