Rework sort to handle multiples tables

This commit is contained in:
Zoe Roux 2025-03-10 00:16:35 +01:00
parent 039880d812
commit 46833ac06f
No known key found for this signature in database
8 changed files with 165 additions and 125 deletions

View File

@ -67,25 +67,32 @@ const unknownFilters: FilterDef = {
}; };
const entrySort = Sort( const entrySort = Sort(
[ {
"order", order: entries.order,
"seasonNumber", seasonNumber: entries.seasonNumber,
"episodeNumber", episodeNumber: entries.episodeNumber,
"number", number: entries.episodeNumber,
"airDate", airDate: entries.airDate,
"nextRefresh", nextRefresh: entries.nextRefresh,
], },
{ {
default: ["order"], default: ["order"],
remap: { tablePk: entries.pk,
number: "episodeNumber",
},
}, },
); );
const extraSort = Sort(["slug", "name", "runtime", "createdAt"], { const extraSort = Sort(
default: ["slug"], {
}); slug: entries.slug,
name: entryTranslations.name,
runtime: entries.runtime,
createdAt: entries.createdAt,
},
{
default: ["slug"],
tablePk: entries.pk,
},
);
async function getEntries({ async function getEntries({
after, after,
@ -166,13 +173,13 @@ async function getEntries({
and( and(
filter, filter,
query ? sql`${transQ.name} %> ${query}::text` : undefined, query ? sql`${transQ.name} %> ${query}::text` : undefined,
keysetPaginate({ table: entries, after, sort }), keysetPaginate({ after, sort }),
), ),
) )
.orderBy( .orderBy(
...(query ...(query
? [sql`word_similarity(${query}::text, ${transQ.name})`] ? [sql`word_similarity(${query}::text, ${transQ.name})`]
: sortToSql(sort, entries)), : sortToSql(sort)),
entries.pk, entries.pk,
) )
.limit(limit); .limit(limit);

View File

@ -26,6 +26,19 @@ const seasonFilters: FilterDef = {
endAir: { column: seasons.endAir, type: "date" }, endAir: { column: seasons.endAir, type: "date" },
}; };
const seasonSort = Sort(
{
seasonNumber: seasons.seasonNumber,
startAir: seasons.startAir,
endAir: seasons.endAir,
nextRefresh: seasons.nextRefresh,
},
{
default: ["seasonNumber"],
tablePk: seasons.pk,
},
);
export const seasonsH = new Elysia({ tags: ["series"] }) export const seasonsH = new Elysia({ tags: ["series"] })
.model({ .model({
season: Season, season: Season,
@ -82,13 +95,13 @@ export const seasonsH = new Elysia({ tags: ["series"] })
eq(seasons.showPk, serie.pk), eq(seasons.showPk, serie.pk),
filter, filter,
query ? sql`${transQ.name} %> ${query}::text` : undefined, query ? sql`${transQ.name} %> ${query}::text` : undefined,
keysetPaginate({ table: seasons, after, sort }), keysetPaginate({ after, sort }),
), ),
) )
.orderBy( .orderBy(
...(query ...(query
? [sql`word_similarity(${query}::text, ${transQ.name})`] ? [sql`word_similarity(${query}::text, ${transQ.name})`]
: sortToSql(sort, seasons)), : sortToSql(sort)),
seasons.pk, seasons.pk,
) )
.limit(limit); .limit(limit);
@ -104,9 +117,7 @@ export const seasonsH = new Elysia({ tags: ["series"] })
}), }),
}), }),
query: t.Object({ query: t.Object({
sort: Sort(["seasonNumber", "startAir", "endAir", "nextRefresh"], { sort: seasonSort,
default: ["seasonNumber"],
}),
filter: t.Optional(Filter({ def: seasonFilters })), filter: t.Optional(Filter({ def: seasonFilters })),
query: t.Optional(t.String({ description: desc.query })), query: t.Optional(t.String({ description: desc.query })),
limit: t.Integer({ limit: t.Integer({

View File

@ -57,18 +57,18 @@ export const showFilters: FilterDef = {
}, },
}; };
export const showSort = Sort( export const showSort = Sort(
[
"slug",
"rating",
"airDate",
"startAir",
"endAir",
"createdAt",
"nextRefresh",
],
{ {
remap: { airDate: "startAir" }, slug: shows.slug,
rating: shows.rating,
airDate: shows.startAir,
startAir: shows.startAir,
endAir: shows.endAir,
createdAt: shows.createdAt,
nextRefresh: shows.nextRefresh,
},
{
default: ["slug"], default: ["slug"],
tablePk: shows.pk,
}, },
); );
@ -209,13 +209,13 @@ export async function getShows({
and( and(
filter, filter,
query ? sql`${transQ.name} %> ${query}::text` : undefined, query ? sql`${transQ.name} %> ${query}::text` : undefined,
keysetPaginate({ table: shows, after, sort }), keysetPaginate({ after, sort }),
), ),
) )
.orderBy( .orderBy(
...(query ...(query
? [sql`word_similarity(${query}::text, ${transQ.name})`] ? [sql`word_similarity(${query}::text, ${transQ.name})`]
: sortToSql(sort, shows)), : sortToSql(sort)),
shows.pk, shows.pk,
) )
.limit(limit); .limit(limit);

View File

@ -23,18 +23,36 @@ import {
import { desc } from "~/models/utils/descriptions"; import { desc } from "~/models/utils/descriptions";
import { showFilters, showSort } from "./shows/logic"; import { showFilters, showSort } from "./shows/logic";
const staffSort = Sort(["slug", "name", "latinName"], { default: ["slug"] }); const staffSort = Sort(
{
slug: staff.slug,
name: staff.name,
latinName: staff.latinName,
},
{
default: ["slug"],
tablePk: staff.pk,
},
);
const staffRoleSort = Sort( const staffRoleSort = Sort(
[ {
"order", order: roles.order,
// "slug", slug: { sql: staff.slug, accessor: (x) => x.staff.slug },
// "name", name: { sql: staff.name, accessor: (x) => x.staff.name },
// "latinName", latinName: { sql: staff.latinName, accessor: (x) => x.staff.latinName },
// "characterName", "characterLatinName" characterName: {
], sql: sql`${roles.character}->'name'`,
accessor: (x) => x.character.name,
},
characterLatinName: {
sql: sql`${roles.character}->'latinName'`,
accessor: (x) => x.character.latinName,
},
},
{ {
default: ["order"], default: ["order"],
tablePk: staff.pk,
}, },
); );
@ -75,13 +93,13 @@ async function getStaffRoles({
and( and(
filter, filter,
query ? sql`${staff.name} %> ${query}::text` : undefined, query ? sql`${staff.name} %> ${query}::text` : undefined,
keysetPaginate({ table: roles, sort, after }), keysetPaginate({ sort, after }),
), ),
) )
.orderBy( .orderBy(
...(query ...(query
? [sql`word_similarity(${query}::text, ${staff.name})`] ? [sql`word_similarity(${query}::text, ${staff.name})`]
: sortToSql(sort, roles)), : sortToSql(sort)),
shows.pk, shows.pk,
) )
.limit(limit); .limit(limit);
@ -217,13 +235,13 @@ export const staffH = new Elysia({ tags: ["staff"] })
eq(roles.staffPk, member.pk), eq(roles.staffPk, member.pk),
filter, filter,
query ? sql`${transQ.name} %> ${query}::text` : undefined, query ? sql`${transQ.name} %> ${query}::text` : undefined,
keysetPaginate({ table: shows, after, sort }), keysetPaginate({ after, sort }),
), ),
) )
.orderBy( .orderBy(
...(query ...(query
? [sql`word_similarity(${query}::text, ${transQ.name})`] ? [sql`word_similarity(${query}::text, ${transQ.name})`]
: sortToSql(sort, shows)), : sortToSql(sort)),
roles.showPk, roles.showPk,
) )
.limit(limit); .limit(limit);
@ -275,13 +293,13 @@ export const staffH = new Elysia({ tags: ["staff"] })
.where( .where(
and( and(
query ? sql`${staff.name} %> ${query}::text` : undefined, query ? sql`${staff.name} %> ${query}::text` : undefined,
keysetPaginate({ table: staff, after, sort }), keysetPaginate({ after, sort }),
), ),
) )
.orderBy( .orderBy(
...(query ...(query
? [sql`word_similarity(${query}::text, ${staff.name})`] ? [sql`word_similarity(${query}::text, ${staff.name})`]
: sortToSql(sort, staff)), : sortToSql(sort)),
staff.pk, staff.pk,
) )
.limit(limit); .limit(limit);

View File

@ -34,7 +34,16 @@ import {
import { desc } from "~/models/utils/descriptions"; import { desc } from "~/models/utils/descriptions";
import { getShows, showFilters, showSort } from "./shows/logic"; import { getShows, showFilters, showSort } from "./shows/logic";
const studioSort = Sort(["slug", "createdAt"], { default: ["slug"] }); const studioSort = Sort(
{
slug: studios.slug,
createdAt: studios.createdAt,
},
{
default: ["slug"],
tablePk: studios.pk,
},
);
const studioRelations = { const studioRelations = {
translations: () => { translations: () => {
@ -101,13 +110,13 @@ export async function getStudios({
and( and(
filter, filter,
query ? sql`${transQ.name} %> ${query}::text` : undefined, query ? sql`${transQ.name} %> ${query}::text` : undefined,
keysetPaginate({ table: studios, after, sort }), keysetPaginate({ after, sort }),
), ),
) )
.orderBy( .orderBy(
...(query ...(query
? [sql`word_similarity(${query}::text, ${transQ.name})`] ? [sql`word_similarity(${query}::text, ${transQ.name})`]
: sortToSql(sort, studios)), : sortToSql(sort)),
studios.pk, studios.pk,
) )
.limit(limit); .limit(limit);

View File

@ -1,7 +1,5 @@
import { type Column, and, eq, gt, isNull, lt, or, sql } from "drizzle-orm"; import { and, eq, gt, isNull, lt, or, sql } from "drizzle-orm";
import type { NonEmptyArray, Sort } from "./sort"; import type { Sort } from "./sort";
type Table<Name extends string> = Record<Name, Column>;
type After = (string | number | boolean | undefined)[]; type After = (string | number | boolean | undefined)[];
@ -16,37 +14,37 @@ type After = (string | number | boolean | undefined)[];
// (x > a) OR // (x > a) OR
// (x = a AND y < b) OR // (x = a AND y < b) OR
// (x = a AND y = b AND z > c) OR... // (x = a AND y = b AND z > c) OR...
export const keysetPaginate = < export const keysetPaginate = ({
const T extends NonEmptyArray<string>,
const Remap extends Partial<Record<T[number], string>>,
>({
table,
sort, sort,
after, after,
}: { }: {
table: Table<"pk" | Sort<T, Remap>["sort"][number]["key"]>; sort: Sort | undefined;
after: string | undefined; after: string | undefined;
sort: Sort<T, Remap> | undefined;
}) => { }) => {
if (!after || !sort) return undefined; if (!after || !sort) return undefined;
const cursor: After = JSON.parse( const cursor: After = JSON.parse(
Buffer.from(after, "base64").toString("utf-8"), Buffer.from(after, "base64").toString("utf-8"),
); );
const pkSort = { key: "pk" as const, desc: false }; const pkSort = {
sql: sort.tablePk,
isNullable: false,
accessor: (x: any) => x.pk,
desc: false,
};
if (sort.random) { if (sort.random) {
return or( return or(
gt( gt(
sql`md5(${sort.random.seed} || ${table[pkSort.key]})`, sql`md5(${sort.random.seed} || ${sort.tablePk})`,
sql`md5(${sort.random.seed} || ${cursor[0]})`, sql`md5(${sort.random.seed} || ${cursor[0]})`,
), ),
and( and(
eq( eq(
sql`md5(${sort.random.seed} || ${table[pkSort.key]})`, sql`md5(${sort.random.seed} || ${sort.tablePk})`,
sql`md5(${sort.random.seed} || ${cursor[0]})`, sql`md5(${sort.random.seed} || ${cursor[0]})`,
), ),
gt(table[pkSort.key], cursor[0]), gt(sort.tablePk, cursor[0]),
), ),
); );
} }
@ -62,31 +60,19 @@ export const keysetPaginate = <
where, where,
and( and(
previous, previous,
or( or(cmp(by.sql, cursor[i]), by.isNullable ? isNull(by.sql) : undefined),
cmp(table[by.key], cursor[i]),
!table[by.key].notNull ? isNull(table[by.key]) : undefined,
),
), ),
); );
previous = and( previous = and(
previous, previous,
cursor[i] === null ? isNull(table[by.key]) : eq(table[by.key], cursor[i]), cursor[i] === null ? isNull(by.sql) : eq(by.sql, cursor[i]),
); );
} }
return where; return where;
}; };
export const generateAfter = < export const generateAfter = (cursor: any, sort: Sort) => {
const ST extends NonEmptyArray<string>, const ret = [...sort.sort.map((by) => by.accessor(cursor)), cursor.pk];
const Remap extends Partial<Record<ST[number], string>> = never,
>(
cursor: any,
sort: Sort<ST, Remap>,
) => {
const ret = [
...sort.sort.map((by) => cursor[by.remmapedKey ?? by.key]),
cursor.pk,
];
return Buffer.from(JSON.stringify(ret), "utf-8").toString("base64url"); return Buffer.from(JSON.stringify(ret), "utf-8").toString("base64url");
}; };

View File

@ -1,7 +1,7 @@
import type { ObjectOptions } from "@sinclair/typebox"; import type { ObjectOptions } from "@sinclair/typebox";
import { type TSchema, t } from "elysia"; import { type TSchema, t } from "elysia";
import { generateAfter } from "./keyset-paginate"; import { generateAfter } from "./keyset-paginate";
import type { NonEmptyArray, Sort } from "./sort"; import type { Sort } from "./sort";
export const Page = <T extends TSchema>(schema: T, options?: ObjectOptions) => export const Page = <T extends TSchema>(schema: T, options?: ObjectOptions) =>
t.Object( t.Object(
@ -16,13 +16,9 @@ export const Page = <T extends TSchema>(schema: T, options?: ObjectOptions) =>
}, },
); );
export const createPage = < export const createPage = <T>(
T,
const ST extends NonEmptyArray<string>,
const Remap extends Partial<Record<ST[number], string>> = never,
>(
items: T[], items: T[],
{ url, sort, limit }: { url: string; sort: Sort<ST, Remap>; limit: number }, { url, sort, limit }: { url: string; sort: Sort; limit: number },
) => { ) => {
let next: string | null = null; let next: string | null = null;
const uri = new URL(url); const uri = new URL(url);

View File

@ -1,34 +1,40 @@
import { sql } from "drizzle-orm"; import { type SQL, type SQLWrapper, sql } from "drizzle-orm";
import type { PgColumn } from "drizzle-orm/pg-core"; import type { PgColumn } from "drizzle-orm/pg-core";
import { t } from "elysia"; import { t } from "elysia";
export type Sort< export type Sort = {
T extends string[], tablePk: SQLWrapper;
Remap extends Partial<Record<T[number], string>>,
> = {
sort: { sort: {
key: Exclude<T[number], keyof Remap> | NonNullable<Remap[keyof Remap]>; sql: SQLWrapper;
remmapedKey?: keyof Remap; isNullable: boolean;
accessor: (cursor: any) => unknown;
desc: boolean; desc: boolean;
}[]; }[];
random?: { seed: number }; random?: { seed: number };
}; };
export type NonEmptyArray<T> = [T, ...T[]]; export const Sort = (
values: Record<
export const Sort = < string,
const T extends NonEmptyArray<string>, | PgColumn
const Remap extends Partial<Record<T[number], string>> = never, | {
>( sql: PgColumn;
values: T, accessor: (cursor: any) => unknown;
}
| {
sql: SQLWrapper;
isNullable: boolean;
accessor: (cursor: any) => unknown;
}
>,
{ {
description = "How to sort the query", description = "How to sort the query",
default: def, default: def,
remap, tablePk,
}: { }: {
default?: T[number][]; default?: (keyof typeof values)[];
tablePk: SQLWrapper;
description?: string; description?: string;
remap?: Remap;
}, },
) => ) =>
t t
@ -36,10 +42,10 @@ export const Sort = <
t.Array( t.Array(
t.Union([ t.Union([
t.UnionEnum([ t.UnionEnum([
...values, ...Object.keys(values),
...values.map((x: T[number]) => `-${x}` as const), ...Object.keys(values).map((x) => `-${x}`),
"random", "random",
]), ] as any),
t.TemplateLiteral("random:${number}"), t.TemplateLiteral("random:${number}"),
]), ]),
{ {
@ -48,21 +54,36 @@ export const Sort = <
}, },
), ),
) )
.Decode((sort): Sort<T, Remap> => { .Decode((sort: string[]): Sort => {
const random = sort.find((x) => x.startsWith("random")); const random = sort.find((x) => x.startsWith("random"));
if (random) { if (random) {
const seed = random.includes(":") const seed = random.includes(":")
? Number.parseInt(random.substring("random:".length)) ? Number.parseInt(random.substring("random:".length))
: Math.floor(Math.random() * Number.MAX_SAFE_INTEGER); : Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
return { random: { seed }, sort: [] }; return { tablePk, random: { seed }, sort: [] };
} }
return { return {
tablePk,
sort: sort.map((x) => { sort: sort.map((x) => {
const desc = x[0] === "-"; const desc = x[0] === "-";
const key = (desc ? x.substring(1) : x) as T[number]; const key = desc ? x.substring(1) : x;
if (remap && key in remap) if ("getSQL" in values[key]) {
return { key: remap[key]!, remmapedKey: key, desc }; return {
return { key: key as Exclude<typeof key, keyof Remap>, desc }; sql: values[key],
isNullable: !values[key].notNull,
accessor: (x) => x[key],
desc,
};
}
return {
sql: values[key].sql,
isNullable:
"isNullable" in values[key]
? values[key].isNullable
: !values[key].sql.notNull,
accessor: values[key].accessor,
desc,
};
}), }),
}; };
}) })
@ -70,20 +91,12 @@ export const Sort = <
throw new Error("Encode not supported for sort"); throw new Error("Encode not supported for sort");
}); });
type Table<Name extends string> = Record<Name, PgColumn>; export const sortToSql = (sort: Sort | undefined) => {
export const sortToSql = <
T extends string[],
Remap extends Partial<Record<T[number], string>>,
>(
sort: Sort<T, Remap> | undefined,
table: Table<Sort<T, Remap>["sort"][number]["key"] | "pk">,
) => {
if (!sort) return []; if (!sort) return [];
if (sort.random) { if (sort.random) {
return [sql`md5(${sort.random.seed} || ${table.pk})`]; return [sql`md5(${sort.random.seed} || ${sort.tablePk})`];
} }
return sort.sort.map((x) => return sort.sort.map((x) =>
x.desc ? sql`${table[x.key]} desc nulls last` : table[x.key], x.desc ? sql`${x.sql} desc nulls last` : (x.sql as SQL),
); );
}; };