Update next_page_cursor to be tuple (#237)

* Update next_page_cursor to be tuple

* Use parse

* Remove PageCursorSchema

* Update url-search-params-serializer

Author: razor-x

package-lock.json

@@ -70,14 +70,14 @@
     "@seamapi/fake-devicedb": "^1.6.0",
     "@seamapi/logger": "^1.9.2",
     "@seamapi/types": "^1.200.0",
-    "@seamapi/url-search-params-serializer": "^1.1.0",
+    "@seamapi/url-search-params-serializer": "^1.2.0",
     "@tsconfig/next": "^1.0.5",
+    "@types/jsonwebtoken": "^9.0.6",
     "@types/lodash": "^4.14.202",
     "@types/luxon": "^3.4.2",
     "@types/node": "^20.8.10",
     "@types/react": "^18.0.35",
     "@types/react-dom": "^18.0.11",
-    "@types/jsonwebtoken": "^9.0.6",
     "ava": "^5.0.1",
     "bs58": "^5.0.0",
     "c8": "^8.0.0",

package.json

@@ -20,6 +20,7 @@ export const common_params = z.object({
   limit: z.coerce.number().int().positive().default(500),
   page_cursor: z
     .string()
+    .base64()
     .optional()
     .nullable()
     .transform((page_cursor) => {
@@ -30,11 +31,13 @@ export const common_params = z.object({
     }),
 })
 
-const page_cursor_schema = z.object({
-  created_at: z.coerce.date(),
-  device_id: z.string(),
-  query_hash: z.string(),
-})
+const page_cursor_schema = z.tuple([
+  z.string(),
+  z.object({
+    created_at: z.coerce.date(),
+    device_id: z.string(),
+  }),
+])
 
 export default withRouteSpec({
   auth: ["console_session_with_workspace", "client_session", "api_key"],
@@ -44,13 +47,24 @@ export default withRouteSpec({
     devices: z.array(device),
     pagination: z.object({
       has_next_page: z.boolean(),
-      next_page_cursor: z.string().nullable(),
+      next_page_cursor: z.string().base64().nullable(),
       next_page_url: z.string().url().nullable(),
     }),
   }),
 } as const)(async (req, res) => {
   const { page_cursor, ...params } = req.commonParams
 
+  const query_hash = getPageCursorQueryHash(params)
+  const page_cursor_query_hash = page_cursor?.[0]
+  const page_cursor_pointer = page_cursor?.[1]
+  if (page_cursor_query_hash != null && page_cursor_query_hash !== query_hash) {
+    throw new BadRequestException({
+      type: "mismatched_page_parameters",
+      message:
+        "When using next_page_cursor, the request must send parameters identical to the initial request.",
+    })
+  }
+
   const {
     device_ids,
     connected_account_id,
@@ -84,7 +98,7 @@ export default withRouteSpec({
 
   devices = sortBy(devices, ["created_at", "device_id"])
 
-  const device_id = page_cursor?.device_id
+  const device_id = page_cursor_pointer?.device_id
   const startIdx =
     device_id == null
       ? 0
@@ -95,29 +109,21 @@ export default withRouteSpec({
   const next_device = devices[endIdx]
   const has_next_page = next_device != null
 
-  const query_hash = getPageCursorQueryHash(params)
-  if (
-    page_cursor?.query_hash != null &&
-    page_cursor.query_hash !== query_hash
-  ) {
-    throw new BadRequestException({
-      type: "mismatched_page_parameters",
-      message:
-        "When using next_page_cursor, the request send parameters identical to the initial request.",
-    })
+  let next_page_cursor = null
+  if (has_next_page) {
+    const next_page_cursor_data = page_cursor_schema.parse([
+      query_hash,
+      {
+        device_id: next_device.device_id,
+        created_at: next_device.created_at,
+      },
+    ])
+    next_page_cursor = Buffer.from(
+      JSON.stringify(next_page_cursor_data),
+      "utf8",
+    ).toString("base64")
   }
 
-  const next_page_cursor = has_next_page
-    ? Buffer.from(
-        JSON.stringify({
-          device_id: next_device.device_id,
-          created_at: next_device.created_at,
-          query_hash,
-        }),
-        "utf8",
-      ).toString("base64")
-    : null
-
   const next_page_url = getNextPageUrl(next_page_cursor, { req })
 
   res.status(200).json({