Remove page's prev & weird reverse handling

This commit is contained in:
Zoe Roux 2025-01-09 22:34:32 +01:00
parent 371d9148f4
commit 6e293efc2b
No known key found for this signature in database
4 changed files with 42 additions and 45 deletions

View File

@ -3,7 +3,7 @@ import { eq, or, type Column, and, gt, lt } from "drizzle-orm";
type Table<Name extends string> = Record<Name, Column>; type Table<Name extends string> = Record<Name, Column>;
type After = [boolean, ...[string | number | boolean | undefined]]; type After = (string | number | boolean | undefined)[];
// Create a filter (where) expression on the query to skip everything before/after the referenceID. // Create a filter (where) expression on the query to skip everything before/after the referenceID.
// The generalized expression for this in pseudocode is: // The generalized expression for this in pseudocode is:
@ -29,7 +29,7 @@ export const keysetPaginate = <
sort: Sort<T, Remap>; sort: Sort<T, Remap>;
}) => { }) => {
if (!after) return undefined; if (!after) return undefined;
const [reverse, ...cursor]: After = JSON.parse( const cursor: After = JSON.parse(
Buffer.from(after, "base64").toString("utf-8"), Buffer.from(after, "base64").toString("utf-8"),
); );
@ -40,7 +40,7 @@ export const keysetPaginate = <
let where = undefined; let where = undefined;
let previous = undefined; let previous = undefined;
for (const [i, by] of [...sort, pkSort].entries()) { for (const [i, by] of [...sort, pkSort].entries()) {
const cmp = by.desc !== reverse ? lt : gt; const cmp = by.desc ? lt : gt;
where = or(where, and(previous, cmp(table[by.key], cursor[i]))); where = or(where, and(previous, cmp(table[by.key], cursor[i])));
previous = and(previous, eq(table[by.key], cursor[i])); previous = and(previous, eq(table[by.key], cursor[i]));
} }
@ -48,18 +48,7 @@ export const keysetPaginate = <
return where; return where;
}; };
export const generateAfter = ( export const generateAfter = (cursor: any, sort: Sort<any, any>) => {
cursor: any, const ret = [...sort.map((by) => cursor[by.key]), cursor.pk];
sort: Sort<any, any>,
reverse?: boolean,
) => {
const ret = [
reverse ?? false,
...sort.map((by) => cursor[by.key]),
cursor.pk,
];
return Buffer.from(JSON.stringify(ret), "utf-8").toString("base64url"); return Buffer.from(JSON.stringify(ret), "utf-8").toString("base64url");
}; };
const reverseStart = Buffer.from("[true,", "utf-8").toString("base64url");
export const isReverse = (x: string) => x.startsWith(reverseStart);

View File

@ -1,14 +1,13 @@
import type { ObjectOptions } from "@sinclair/typebox"; import type { ObjectOptions } from "@sinclair/typebox";
import { t, type TSchema } from "elysia"; import { t, type TSchema } from "elysia";
import type { Sort } from "./sort"; import type { Sort } from "./sort";
import { generateAfter, isReverse } from "./keyset-paginate"; import { generateAfter } from "./keyset-paginate";
export const Page = <T extends TSchema>(schema: T, options?: ObjectOptions) => export const Page = <T extends TSchema>(schema: T, options?: ObjectOptions) =>
t.Object( t.Object(
{ {
items: t.Array(schema), items: t.Array(schema),
this: t.String({ format: "uri" }), this: t.String({ format: "uri" }),
prev: t.Nullable(t.String({ format: "uri" })),
next: t.Nullable(t.String({ format: "uri" })), next: t.Nullable(t.String({ format: "uri" })),
}, },
options, options,
@ -18,27 +17,12 @@ export const createPage = <T>(
items: T[], items: T[],
{ url, sort, limit }: { url: string; sort: Sort<any, any>; limit: number }, { url, sort, limit }: { url: string; sort: Sort<any, any>; limit: number },
) => { ) => {
let prev: string | null = null;
let next: string | null = null; let next: string | null = null;
const uri = new URL(url); if (items.length === limit && limit > 0) {
const after = uri.searchParams.get("after"); const uri = new URL(url);
const reverse = after && isReverse(after) ? 1 : 0;
const has = [
// prev
items.length > 0 && after,
// next
items.length === limit && limit > 0,
];
if (has[0 + reverse]) {
uri.searchParams.set("after", generateAfter(items[0], sort, true));
prev = uri.toString();
}
if (has[1 - reverse]) {
uri.searchParams.set("after", generateAfter(items[items.length - 1], sort)); uri.searchParams.set("after", generateAfter(items[items.length - 1], sort));
next = uri.toString(); next = uri.toString();
} }
return { items, this: url, prev, next }; return { items, this: url, next };
}; };

View File

@ -78,23 +78,47 @@ describe("Get all movies", () => {
expectStatus(resp, body).toBe(422); expectStatus(resp, body).toBe(422);
expect(body).toMatchObject({ expect(body).toMatchObject({
details: expect.objectContaining( { details: expect.anything(),
in: "slug eq gt bubble",
}),
message: "Invalid filter: slug eq gt bubble.", message: "Invalid filter: slug eq gt bubble.",
status: 422, status: 422,
}); });
}); });
it("Limit 1, default sort", async () => { it("Limit 2, default sort", async () => {
const [resp, body] = await getMovies({ const [resp, body] = await getMovies({
limit: 1, limit: 2,
langs: "en", langs: "en",
}); });
expectStatus(resp, body).toBe(200); expectStatus(resp, body).toBe(200);
expect(body).toMatchObject({ expect(body).toMatchObject({
items: [bubble], items: [
this: "", expect.objectContaining({ slug: bubble.slug }),
expect.objectContaining({ slug: dune.slug }),
],
this: "http://localhost/movies?limit=2",
// we can't have the exact after since it contains the pk that changes with every tests.
next: expect.stringContaining(
"http://localhost/movies?limit=2&after=WyJkdW5lIiw0",
),
});
});
it("Limit 2, default sort, page 2", async () => {
let [resp, body] = await getMovies({
limit: 2,
langs: "en",
});
expectStatus(resp, body).toBe(200);
resp = await app.handle(new Request(body.next));
body = await resp.json();
expectStatus(resp, body).toBe(200);
expect(body).toMatchObject({
items: [expect.objectContaining({ slug: dune1984.slug })],
this: expect.stringContaining(
"http://localhost/movies?limit=2&after=WyJkdW5lIiw0",
),
next: null,
}); });
}); });
}); });

View File

@ -110,7 +110,7 @@ describe("Movie seeding", () => {
expect(existing).toMatchObject({ slug: dune.slug, startAir: dune.airDate }); expect(existing).toMatchObject({ slug: dune.slug, startAir: dune.airDate });
const [resp, body] = await createMovie({ ...dune, airDate: "2158-12-13" }); const [resp, body] = await createMovie({ ...dune, airDate: "2158-12-13" });
expectStatus(resp, body).toBe(200); expectStatus(resp, body).toBe(201);
expect(body.id).toBeString(); expect(body.id).toBeString();
expect(body.slug).toBe("dune-2158"); expect(body.slug).toBe("dune-2158");
}); });
@ -224,7 +224,7 @@ describe("Movie seeding", () => {
}); });
const cleanup = async () => { const cleanup = async () => {
await db.delete(shows).where(inArray(shows.slug, [dune.slug])); await db.delete(shows).where(inArray(shows.slug, [dune.slug, "dune-2158"]));
await db.delete(videos).where(inArray(videos.id, [duneVideo.id])); await db.delete(videos).where(inArray(videos.id, [duneVideo.id]));
}; };
// cleanup db beforehand to unsure tests are consistent // cleanup db beforehand to unsure tests are consistent