@rebasepro/server-postgres 0.17.3 → 0.18.0

package/src/collections/PostgresCollectionRegistry.ts

@@ -1,108 +0,0 @@
-import { CollectionRegistry, resolveCollectionRelations } from "@rebasepro/common";
-import { type CollectionConfig } from "@rebasepro/types";
-import { PgEnum, PgTable } from "drizzle-orm/pg-core";
-import { Relations } from "drizzle-orm";
-import { CollectionRegistryInterface } from "../interfaces";
-import { getTableName } from "@rebasepro/common";
-
-/**
- * PostgreSQL-specific collection registry.
- * Extends the base CollectionRegistry with support for Drizzle ORM tables, enums, and relations.
- *
- * Satisfies CollectionRegistryInterface through inheritance from CollectionRegistry.
- */
-export class PostgresCollectionRegistry extends CollectionRegistry implements CollectionRegistryInterface {
-
-    private tables = new Map<string, PgTable>();
-    private enums = new Map<string, PgEnum<[string, ...string[]]>>();
-    private relations = new Map<string, Relations>();
-
-    registerTable(table: PgTable, tableName: string) {
-        this.tables.set(tableName, table);
-    }
-
-    getTable(tableName: string): PgTable | undefined {
-        return this.tables.get(tableName);
-    }
-
-    /**
-     * Checks if a specific collection has a registered table
-     */
-    hasTableForCollection(tableName: string): boolean {
-        return this.tables.has(tableName);
-    }
-
-    /**
-     * Returns all registered table names.
-     */
-    getTableNames(): string[] {
-        return Array.from(this.tables.keys());
-    }
-
-    /**
-     * Finds collections assigned to a specific data source that do not have a registered table.
-     */
-    getCollectionsWithoutTables(dataSourceKey = "(default)"): CollectionConfig[] {
-        const collections = this.getCollections().filter(
-            c => c.dataSource === dataSourceKey || (!c.dataSource && dataSourceKey === "(default)")
-        );
-        return collections.filter(c => !this.tables.has(getTableName(c)));
-    }
-
-    registerEnums(enums: Record<string, PgEnum<[string, ...string[]]>>) {
-        Object.entries(enums).forEach(([name, value]) => this.enums.set(name, value));
-    }
-
-    registerRelations(relations: Record<string, Relations>) {
-        Object.entries(relations).forEach(([name, value]) => this.relations.set(name, value));
-    }
-
-    getEnum(name: string): PgEnum<[string, ...string[]]> | undefined {
-        return this.enums.get(name);
-    }
-
-    getRelation(name: string): Relations | undefined {
-        return this.relations.get(name);
-    }
-
-    getAllEnums(): Record<string, PgEnum<[string, ...string[]]>> {
-        return Object.fromEntries(this.enums.entries());
-    }
-
-    getAllRelations(): Record<string, Relations> {
-        return Object.fromEntries(this.relations.entries());
-    }
-
-    /**
-     * Get the merged schema object (tables + relations) for use with Drizzle's
-     * relational query API (`db.query`).
-     */
-    getMergedSchema(): Record<string, unknown> {
-        const result: Record<string, unknown> = {};
-        for (const [name, table] of this.tables.entries()) {
-            result[name] = table;
-        }
-        for (const [name, relation] of this.relations.entries()) {
-            result[name] = relation;
-        }
-        return result;
-    }
-
-    /**
-     * Get the available Drizzle relation keys for a given collection path.
-     * Maps from the collection's relation property names to the Drizzle relation names
-     * defined in the schema.
-     */
-    getRelationKeysForCollection(collectionPath: string): string[] {
-        const collection = this.getCollectionByPath(collectionPath);
-        if (!collection) return [];
-        // Resolved, not authored. `relationName` is optional at the authoring
-        // surface and defaults to the property key or the target's slug, so
-        // reading the raw field dropped every relation that relied on the
-        // default — and never saw relations declared inline on a property at
-        // all, since those are not in the `relations` array.
-        return Object.keys(resolveCollectionRelations(collection));
-    }
-
-}
-

package/src/collections/buildRegistry.ts

@@ -1,68 +0,0 @@
-import { isTable, getTableName, Relations } from "drizzle-orm";
-import { PgEnum, PgTable } from "drizzle-orm/pg-core";
-import { CollectionConfig } from "@rebasepro/types";
-import { logger } from "@rebasepro/server";
-import { PostgresCollectionRegistry } from "./PostgresCollectionRegistry";
-import { warnOnKeysTheAdminCannotResolve } from "../services/collection-helpers";
-import { assertRelationsResolve } from "./validate-relations";
-
-/**
- * Everything a registry is built from: the collections, and the drizzle schema
- * they are backed by. In BaaS mode all of it is introspected from the live
- * database; when collections are declared it comes from the config and the generated schema.
- */
-export interface RegistrySchema {
-    collections?: CollectionConfig[];
-    tables?: Record<string, unknown>;
-    enums?: Record<string, PgEnum<[string, ...string[]]>>;
-    relations?: Record<string, Relations>;
-}
-
-/**
- * Build the collection registry for a driver.
- *
- * The order matters and is the reason this is one function rather than a run of
- * statements in the bootstrapper. Keys are resolved from the drizzle schema, so
- * anything that inspects them has to run *after* the tables are registered —
- * and `warnOnKeysTheAdminCannotResolve` fails open if it does not, because a
- * collection whose table it cannot look up is one it has nothing to say about.
- * Warned too early, it would skip every collection and report nothing, which
- * reads exactly like having nothing to report.
- */
-export function buildCollectionRegistry(schema: RegistrySchema): PostgresCollectionRegistry {
-    const registry = new PostgresCollectionRegistry();
-
-    if (schema.collections) {
-        registry.registerMultiple(schema.collections);
-        // `Auto-discovered collections` already reports the count and the
-        // directory they came from; this is the same fact with the names.
-        logger.debug(
-            `📋 [PostgresRegistry] Registered ${registry.getCollections().length} collections: ` +
-            `[${registry.getCollections().map(c => c.slug).join(", ")}]`
-        );
-    }
-
-    if (schema.tables) {
-        Object.values(schema.tables).forEach((table) => {
-            if (isTable(table)) {
-                registry.registerTable(table as PgTable, getTableName(table));
-            }
-        });
-    }
-
-    if (schema.enums) registry.registerEnums(schema.enums);
-    if (schema.relations) registry.registerRelations(schema.relations);
-
-    // Now that the keys resolve: say which of them the admin cannot see. It
-    // compiles the same collection files into its bundle but never the drizzle
-    // schema, and nothing serves it one, so only an edit to the config fixes it.
-    warnOnKeysTheAdminCannotResolve(registry.getCollections(), registry);
-
-    // And now that the tables resolve: refuse to start on a relation whose
-    // names do not exist. The union checks a relation's shape at compile time;
-    // only here is there a schema to check its *names* against. Every one of
-    // these used to surface as an empty result at query time and nothing else.
-    assertRelationsResolve(registry.getCollections(), registry);
-
-    return registry;
-}

package/src/collections/validate-relations.ts

@@ -1,402 +0,0 @@
-import { getTableColumns } from "drizzle-orm";
-import { PgTable } from "drizzle-orm/pg-core";
-import { CollectionConfig, ResolvedRelation } from "@rebasepro/types";
-import { getTableName, resolveCollectionRelations } from "@rebasepro/common";
-import { generateForeignKeyName, legacyForeignKeyName } from "@rebasepro/utils";
-
-import { PostgresCollectionRegistry } from "./PostgresCollectionRegistry";
-
-/**
- * Check every relation against the schema it actually runs on, at boot.
- *
- * The tagged union made the *shape* of a relation impossible to get wrong: a
- * `manyToMany` cannot carry a `foreignKeyOnTarget`, a to-many cannot carry a
- * `localKey`. What it cannot know is whether any of the names are real —
- * whether `posts_tags` is a table, whether `author_id` is a column, whether a
- * `joinPath` connects the tables it claims to. Those are facts about the
- * database, and the type system never sees them.
- *
- * Until now nothing checked them until a query ran, and the failures were the
- * quiet kind. A missing junction table logged a warning and returned no rows,
- * so `posts/1/tags` answered `[]` — indistinguishable from a post with no tags.
- * The relation looked configured, the admin drew the tab, the tab was empty,
- * and nothing anywhere said why.
- *
- * The junction default is the sharp edge this exists for. `through.table`
- * defaults to the two table names sorted and joined, so renaming a table
- * silently re-points the relation at a name that was never created. It is the
- * one default whose output changes when you edit something that looks
- * unrelated.
- */
-export interface RelationDefect {
-    /** Slug of the collection declaring the relation. */
-    collection: string;
-    relationName: string;
-    kind: ResolvedRelation["kind"];
-    /** What is wrong, in terms of the schema. */
-    problem: string;
-    /** The edit that fixes it. */
-    fix: string;
-}
-
-/**
- * Every name a column answers to: the key in the drizzle schema and the real
- * column name in Postgres. A relation may legitimately be written with either,
- * and reporting a working relation as broken is worse than not checking.
- */
-function columnNames(table: PgTable): Set<string> {
-    const names = new Set<string>();
-    for (const [key, col] of Object.entries(getTableColumns(table))) {
-        names.add(key);
-        const dbName = (col as { name?: string })?.name;
-        if (dbName) names.add(dbName);
-    }
-    return names;
-}
-
-const quote = (xs: Iterable<string>) => Array.from(xs).map(s => `\`${s}\``).join(", ");
-
-/** `on.from` / `on.to` accept a single column or a composite tuple. */
-const asColumns = (value: string | string[]): string[] => Array.isArray(value) ? value : [value];
-
-/**
- * Distinguish "this column name is wrong" from "the generated schema is old".
- *
- * They present identically here — a relation asks for a column the registered
- * table does not have — but they are opposite problems with opposite fixes, and
- * getting them the wrong way round is how the 0.12 → 0.13 upgrade bricked
- * projects.
- *
- * The registered table is not the database. It comes from the project's
- * checked-in `backend/src/schema.generated.ts`, and 0.13 changed the rule that
- * derives foreign-key names: `categories` yields `category_id` where it used to
- * yield `categorie_id`. Boot-ensure renames the database column to match, so by
- * the time this runs the *database* is correct and the *generated module* is the
- * stale one. Reporting "not a column" then points at the wrong artifact, and the
- * generic fix — "set `through.targetColumn` to one of: …", listing the legacy
- * name because that is what the stale module still has — talks the reader into
- * pinning a column that no longer exists.
- *
- * So when the wanted name is what the current rule derives, and the table
- * carries what the *previous* rule would have derived from the same source, say
- * that instead.
- *
- * @param wanted   the column the relation asks for
- * @param available every column the registered table has
- * @param sources  names the default could have been derived from (a slug, a
- *                 relation name) — checking against these rather than guessing
- *                 backwards from `wanted` keeps the match exact
- */
-function staleCodegenRename(
-    wanted: string,
-    available: Set<string>,
-    sources: string[]
-): { legacy: string; current: string } | null {
-    for (const source of sources) {
-        if (!source) continue;
-        const current = generateForeignKeyName(source);
-        const legacy = legacyForeignKeyName(source);
-        // Only a name that actually moved, and only when the table still has the
-        // old spelling and not the new one.
-        if (current !== wanted || legacy === current) continue;
-        if (available.has(legacy) && !available.has(current)) return { legacy, current };
-    }
-    return null;
-}
-
-/** The shared explanation, so every relation kind reports it identically. */
-function staleCodegenDefect(
-    table: string,
-    { legacy, current }: { legacy: string; current: string }
-): Pick<RelationDefect, "problem" | "fix"> {
-    return {
-        problem:
-            `the generated Drizzle schema still declares \`${legacy}\` on \`${table}\`, but this ` +
-            `release derives \`${current}\` — the generated schema predates the foreign-key ` +
-            "naming fix and no longer describes the database",
-        fix:
-            "regenerate it with `rebase schema generate` (or `pnpm run schema:generate`). The " +
-            "database column has already been renamed for you at boot, so nothing else is needed. " +
-            `To keep \`${legacy}\` instead, name it explicitly on the relation and regenerate.`
-    };
-}
-
-/**
- * Relations whose names do not resolve against the registered schema.
- *
- * Fails open wherever it cannot see enough to be sure — an unregistered source
- * table, a target belonging to another backend — because a false alarm here
- * costs more than a missed one: it would block boot on a working app.
- */
-export function findRelationDefects(
-    collections: CollectionConfig[],
-    registry: PostgresCollectionRegistry
-): RelationDefect[] {
-    const defects: RelationDefect[] = [];
-    const registeredSlugs = new Set(registry.getCollections().map(c => c.slug));
-
-    for (const collection of collections) {
-        const sourceTableName = getTableName(collection);
-        const sourceTable = registry.getTable(sourceTableName);
-        // Nothing to check against. Another boot warning already covers this.
-        if (!sourceTable) continue;
-
-        const sourceColumns = columnNames(sourceTable);
-        const relations = resolveCollectionRelations(collection);
-
-        for (const relation of Object.values(relations)) {
-            const at = { collection: collection.slug,
-relationName: relation.relationName,
-kind: relation.kind };
-
-            let targetCollection: CollectionConfig;
-            try {
-                targetCollection = relation.target();
-            } catch (e) {
-                defects.push({
-                    ...at,
-                    problem: `its \`target()\` threw: ${e instanceof Error ? e.message : String(e)}`,
-                    fix: "a target thunk usually throws because of a circular import — make sure it is `() => otherCollection` and not evaluated at module load"
-                });
-                continue;
-            }
-
-            // A target this registry has never heard of belongs to another
-            // backend; its tables are not ours to check.
-            if (!registeredSlugs.has(targetCollection.slug)) continue;
-
-            const targetTableName = getTableName(targetCollection);
-            const targetTable = registry.getTable(targetTableName);
-            if (!targetTable) {
-                defects.push({
-                    ...at,
-                    problem: `it points at collection \`${targetCollection.slug}\`, which has no table \`${targetTableName}\` in the schema`,
-                    fix: `create the \`${targetTableName}\` table, or correct \`table\` on the \`${targetCollection.slug}\` collection`
-                });
-                continue;
-            }
-            const targetColumns = columnNames(targetTable);
-
-            switch (relation.kind) {
-                case "belongsTo": {
-                    if (!sourceColumns.has(relation.localKey)) {
-                        // `localKey` defaults to the relation name run through
-                        // the foreign-key rule, so it moves with that rule.
-                        const stale = staleCodegenRename(
-                            relation.localKey,
-                            sourceColumns,
-                            [relation.relationName, targetCollection.slug]
-                        );
-                        defects.push(stale
-                            ? { ...at, ...staleCodegenDefect(sourceTableName, stale) }
-                            : {
-                                ...at,
-                                problem: `\`localKey: "${relation.localKey}"\` is not a column on \`${sourceTableName}\``,
-                                fix: `add the column, or set \`localKey\` to one of: ${quote(sourceColumns)}`
-                            });
-                    }
-                    break;
-                }
-
-                case "hasOne":
-                case "hasMany": {
-                    if (!targetColumns.has(relation.foreignKeyOnTarget)) {
-                        // The default is derived from *this* collection's slug —
-                        // the column on the target that points back here.
-                        const stale = staleCodegenRename(
-                            relation.foreignKeyOnTarget,
-                            targetColumns,
-                            [collection.slug]
-                        );
-                        defects.push(stale
-                            ? { ...at, ...staleCodegenDefect(targetTableName, stale) }
-                            : {
-                                ...at,
-                                problem: `\`foreignKeyOnTarget: "${relation.foreignKeyOnTarget}"\` is not a column on the target table \`${targetTableName}\``,
-                                fix: `add the column, or set \`foreignKeyOnTarget\` to one of: ${quote(targetColumns)}`
-                            });
-                    }
-                    // `sourceKey` is the easiest of the two to put on the wrong
-                    // side — it is the only column in a `hasMany` that lives
-                    // here rather than on the target, and naming a target column
-                    // reads perfectly well right next to `foreignKeyOnTarget`.
-                    if (relation.sourceKey && !sourceColumns.has(relation.sourceKey)) {
-                        defects.push({
-                            ...at,
-                            problem: `\`sourceKey: "${relation.sourceKey}"\` is not a column on \`${sourceTableName}\``,
-                            fix: targetColumns.has(relation.sourceKey)
-                                ? `it is a column on the *target* table \`${targetTableName}\` — \`sourceKey\` names ` +
-                                  "the column on this collection that the target's foreign key points at, so it " +
-                                  `must be one of: ${quote(sourceColumns)}`
-                                : `add the column, or set \`sourceKey\` to one of: ${quote(sourceColumns)}`
-                        });
-                    }
-                    break;
-                }
-
-                case "manyToMany": {
-                    const { table, sourceColumn, targetColumn } = relation.through;
-                    const junction = registry.getTable(table);
-                    if (!junction) {
-                        defects.push({
-                            ...at,
-                            problem: `its junction table \`${table}\` does not exist`,
-                            fix: `create \`${table}\`, or name the real one with \`through: { table: "..." }\`. ` +
-                                "Note that an omitted `through.table` is derived from the two table names sorted " +
-                                "and joined, so renaming a table changes it"
-                        });
-                        break;
-                    }
-                    const junctionColumns = columnNames(junction);
-                    // Junction columns are the ones that actually moved in 0.13:
-                    // each defaults to its endpoint collection's *slug* run
-                    // through the foreign-key rule, and slugs are plural.
-                    const derivedFrom = {
-                        sourceColumn: [collection.slug],
-                        targetColumn: [targetCollection.slug]
-                    } as const;
-                    for (const [label, column] of [["sourceColumn", sourceColumn], ["targetColumn", targetColumn]] as const) {
-                        if (!junctionColumns.has(column)) {
-                            const stale = staleCodegenRename(column, junctionColumns, [...derivedFrom[label]]);
-                            defects.push(stale
-                                ? { ...at, ...staleCodegenDefect(table, stale) }
-                                : {
-                                    ...at,
-                                    problem: `\`through.${label}: "${column}"\` is not a column on the junction table \`${table}\``,
-                                    fix: `set \`through.${label}\` to one of: ${quote(junctionColumns)}` +
-                                        (label === "sourceColumn" ? " — it is the column naming *this* collection" : "")
-                                });
-                        }
-                    }
-                    break;
-                }
-
-                case "via": {
-                    if (relation.joinPath.length === 0) {
-                        defects.push({
-                            ...at,
-                            problem: "its `joinPath` is empty, so it joins nothing",
-                            fix: "add at least one step, ending at the target's table"
-                        });
-                        break;
-                    }
-
-                    // Walk the chain: each step's `from` names columns on the
-                    // previous table, its `to` names columns on its own.
-                    let prevName = sourceTableName;
-                    let prevColumns = sourceColumns;
-                    let broken = false;
-
-                    for (const [i, step] of relation.joinPath.entries()) {
-                        const stepTable = registry.getTable(step.table);
-                        if (!stepTable) {
-                            defects.push({
-                                ...at,
-                                problem: `step ${i + 1} of its \`joinPath\` joins \`${step.table}\`, which is not a table in the schema`,
-                                fix: `correct \`joinPath[${i}].table\``
-                            });
-                            broken = true;
-                            break;
-                        }
-                        const stepColumns = columnNames(stepTable);
-
-                        for (const column of asColumns(step.on.from)) {
-                            if (!prevColumns.has(column)) {
-                                defects.push({
-                                    ...at,
-                                    problem: `step ${i + 1} joins \`${prevName}.${column}\` → \`${step.table}\`, but \`${column}\` is not a column on \`${prevName}\``,
-                                    fix: `\`joinPath[${i}].on.from\` names columns on ${i === 0 ? "this collection's table" : `the previous step's table (\`${prevName}\`)`}: ${quote(prevColumns)}`
-                                });
-                            }
-                        }
-                        for (const column of asColumns(step.on.to)) {
-                            if (!stepColumns.has(column)) {
-                                defects.push({
-                                    ...at,
-                                    problem: `step ${i + 1} joins into \`${step.table}.${column}\`, but \`${column}\` is not a column on \`${step.table}\``,
-                                    fix: `\`joinPath[${i}].on.to\` names columns on \`${step.table}\`: ${quote(stepColumns)}`
-                                });
-                            }
-                        }
-
-                        if (asColumns(step.on.from).length !== asColumns(step.on.to).length) {
-                            defects.push({
-                                ...at,
-                                problem: `step ${i + 1} compares ${asColumns(step.on.from).length} column(s) against ${asColumns(step.on.to).length}`,
-                                fix: `\`from\` and \`to\` must name the same number of columns in \`joinPath[${i}]\``
-                            });
-                        }
-
-                        prevName = step.table;
-                        prevColumns = stepColumns;
-                    }
-
-                    // The chain has to end where the relation says it points,
-                    // or the rows it returns are not the target's rows.
-                    if (!broken && prevName !== targetTableName) {
-                        defects.push({
-                            ...at,
-                            problem: `its \`joinPath\` ends at \`${prevName}\`, but it targets \`${targetCollection.slug}\` (table \`${targetTableName}\`)`,
-                            fix: `make the last step join \`${targetTableName}\`, or point \`target\` at the collection backed by \`${prevName}\``
-                        });
-                    }
-                    break;
-                }
-
-                default: {
-                    const exhaustive: never = relation;
-                    throw new Error(`Unhandled relation kind: ${JSON.stringify(exhaustive)}`);
-                }
-            }
-        }
-    }
-
-    return defects;
-}
-
-/**
- * Fail boot on any relation that cannot resolve, listing all of them at once.
- *
- * Deliberately fatal rather than a warning. Every one of these produces an
- * empty result at query time and nothing else — an empty tab, an empty
- * `include`, a subcollection that looks like it has no rows. A server that
- * refuses to start is recoverable in a minute; a relation that quietly answers
- * "nothing" is the kind of bug found in production, weeks later, by a user
- * asking where their data went.
- */
-export function assertRelationsResolve(
-    collections: CollectionConfig[],
-    registry: PostgresCollectionRegistry
-): void {
-    const defects = findRelationDefects(collections, registry);
-    if (defects.length === 0) return;
-
-    const lines = defects.map(d =>
-        `  • ${d.collection}.${d.relationName} (${d.kind})\n` +
-        `      ${d.problem}\n` +
-        `      fix: ${d.fix}`
-    );
-
-    throw new Error(
-        `${defects.length} relation${defects.length === 1 ? "" : "s"} cannot resolve against ` +
-        "`backend/src/schema.generated.ts`.\n\n" +
-        "Each of these would return no rows at query time rather than reporting an error, " +
-        "so they are fatal at boot instead.\n\n" +
-        // This reads the *generated file*, not the database, and the difference
-        // is the whole diagnosis after an upgrade. Boot-ensure renames columns
-        // in the database — a 0.12 → 0.13 upgrade singularises a junction key,
-        // `categorie_id` → `category_id` — and the checked-in file still
-        // declares the old name. The config is then correct and the file is
-        // stale, so the per-defect advice below, which lists the columns this
-        // file has, names a column that no longer exists in the database.
-        // Following it turns a recoverable state into a broken config.
-        //
-        // Hence the ordering: regenerate first, and only then consider that the
-        // collection might be the thing that is wrong.
-        "If the database was migrated recently — an upgrade, a `db push`, a restore — this file is\n" +
-        "probably older than the schema it describes. Regenerate it before changing anything else:\n\n" +
-        "    rebase schema generate\n\n" +
-        "If it is already current, then the collection is what disagrees with it:\n\n" +
-        lines.join("\n\n") + "\n"
-    );
-}