Addresses review on PR #227. - setAlias confirmed-reassign branch: DELETE the target page's existing alias row(s) BEFORE retargeting `byName` onto the page, instead of after. The new partial unique index `(workspace_id, page_id)` is non-deferrable and checked at each statement, so retargeting first momentarily left two rows for the page -> immediate 23505 -> rolled-back tx surfaced as a misleading "Alias already taken" (regressing a previously-working swap onto a page that already had its own alias). The reordered branch needs no trailing self-heal. JSDoc updated to describe the real ordering. - catch block: the postgres@3.x driver exposes the violated index as `err.constraint_name` (with `.constraint` as a fallback). Map `share_aliases_workspace_id_alias_unique` -> "Alias already taken" and the new `share_aliases_workspace_id_page_id_unique` -> a distinct ALIAS_PAGE_RACE outcome (a concurrent same-page write, not a name clash). Always log the constraint name on any 23505 so the race is diagnosable. - migration 20260627T120000: document that the dedup DELETE is intended, irreversible data loss (old duplicate `/l/<old>` links start 404ing after upgrade; `down()` cannot restore the rows). Same note added to CHANGELOG [Unreleased] Fixed. Tests: - integration: confirmed reassign onto a page that ALREADY has its own alias (RED before the reorder); migration up() dedup scoping across pages and a second workspace; mid-transaction error -> BadRequest with clean rollback. - unit: constraint_name distinguishing (alias index, page_id index, fallback `.constraint`, no-info default) and non-unique error -> BadRequest; retarget test now asserts delete-before-update order. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
345 lines
12 KiB
TypeScript
345 lines
12 KiB
TypeScript
import { Kysely, sql } from 'kysely';
|
|
import { randomUUID } from 'node:crypto';
|
|
import { BadRequestException, ConflictException } from '@nestjs/common';
|
|
import { ShareAliasRepo } from '@docmost/db/repos/share-alias/share-alias.repo';
|
|
import { ShareAliasService } from 'src/core/share/share-alias.service';
|
|
import * as onePerPageMigration from 'src/database/migrations/20260627T120000-share-aliases-one-per-page';
|
|
import {
|
|
getTestDb,
|
|
destroyTestDb,
|
|
createWorkspace,
|
|
createSpace,
|
|
createPage,
|
|
} from './db';
|
|
|
|
/**
|
|
* Issue #226 (regression of #205): "a page has EXACTLY ONE custom address".
|
|
* Exercises against real Postgres:
|
|
* - the partial unique index `(workspace_id, page_id) WHERE page_id IS NOT NULL`
|
|
* (migration 20260627T120000) — one alias per page, but dangling aliases
|
|
* (page_id NULL) may coexist;
|
|
* - the migration's dedup DELETE keeps the NEWEST row per page;
|
|
* - ShareAliasService.setAlias renames in place (te -> ted) instead of
|
|
* spawning a second row, and self-heals the page down to one alias.
|
|
*/
|
|
describe('share_aliases one-per-page invariant [integration]', () => {
|
|
let db: Kysely<any>;
|
|
let repo: ShareAliasRepo;
|
|
let service: ShareAliasService;
|
|
let wsId: string;
|
|
let spaceId: string;
|
|
|
|
// setAlias only consults pageRepo on the unconfirmed-reassign (409) path.
|
|
const pageRepo = {
|
|
findById: async (id: string) => ({ id, title: `title-${id}` }),
|
|
};
|
|
|
|
beforeAll(async () => {
|
|
db = getTestDb();
|
|
repo = new ShareAliasRepo(db as any);
|
|
service = new ShareAliasService(
|
|
repo as any,
|
|
pageRepo as any,
|
|
{} as any, // shareService — unused by setAlias
|
|
db as any,
|
|
);
|
|
wsId = (await createWorkspace(db)).id;
|
|
spaceId = (await createSpace(db, wsId)).id;
|
|
});
|
|
|
|
afterAll(async () => {
|
|
await destroyTestDb();
|
|
});
|
|
|
|
const newPage = async (): Promise<string> =>
|
|
(await createPage(db, { workspaceId: wsId, spaceId })).id;
|
|
|
|
const aliasRowsForWs = (pageId: string, workspaceId: string) =>
|
|
db
|
|
.selectFrom('shareAliases')
|
|
.select(['id', 'alias'])
|
|
.where('pageId', '=', pageId)
|
|
.where('workspaceId', '=', workspaceId)
|
|
.orderBy('alias')
|
|
.execute();
|
|
|
|
const aliasRowsFor = (pageId: string) => aliasRowsForWs(pageId, wsId);
|
|
|
|
it('partial unique index rejects a second alias for the same page (23505)', async () => {
|
|
const pageId = await newPage();
|
|
await repo.insert({ workspaceId: wsId, alias: 'first', pageId });
|
|
|
|
let code: string | undefined;
|
|
try {
|
|
await repo.insert({ workspaceId: wsId, alias: 'second', pageId });
|
|
} catch (err: any) {
|
|
code = err?.code ?? err?.cause?.code;
|
|
}
|
|
expect(code).toBe('23505');
|
|
});
|
|
|
|
it('allows multiple DANGLING aliases (page_id NULL) — partial index excludes them', async () => {
|
|
const a = await repo.insert({
|
|
workspaceId: wsId,
|
|
alias: `dangling-${randomUUID().slice(0, 8)}`,
|
|
pageId: null as any,
|
|
});
|
|
const b = await repo.insert({
|
|
workspaceId: wsId,
|
|
alias: `dangling-${randomUUID().slice(0, 8)}`,
|
|
pageId: null as any,
|
|
});
|
|
expect(a.id).toBeDefined();
|
|
expect(b.id).toBeDefined();
|
|
expect(a.id).not.toBe(b.id);
|
|
});
|
|
|
|
it("migration dedup DELETE keeps the page's NEWEST alias row", async () => {
|
|
const pageId = await newPage();
|
|
// Temporarily drop the guard so we can seed the legacy duplicate shape.
|
|
await sql`DROP INDEX share_aliases_workspace_id_page_id_unique`.execute(db);
|
|
try {
|
|
const mk = async (alias: string, createdAt: string): Promise<string> => {
|
|
const id = randomUUID();
|
|
await db
|
|
.insertInto('shareAliases')
|
|
.values({ id, workspaceId: wsId, alias, pageId, createdAt })
|
|
.execute();
|
|
return id;
|
|
};
|
|
await mk('oldest', '2026-01-01T00:00:00Z');
|
|
await mk('middle', '2026-02-01T00:00:00Z');
|
|
const newest = await mk('newest', '2026-03-01T00:00:00Z');
|
|
|
|
// Exact dedup statement from the migration.
|
|
await sql`
|
|
DELETE FROM share_aliases sa
|
|
USING share_aliases keep
|
|
WHERE sa.page_id IS NOT NULL
|
|
AND sa.workspace_id = keep.workspace_id
|
|
AND sa.page_id = keep.page_id
|
|
AND (keep.created_at, keep.id) > (sa.created_at, sa.id)
|
|
`.execute(db);
|
|
|
|
const rows = await aliasRowsFor(pageId);
|
|
expect(rows).toHaveLength(1);
|
|
expect(rows[0]).toMatchObject({ id: newest, alias: 'newest' });
|
|
} finally {
|
|
await sql`
|
|
CREATE UNIQUE INDEX share_aliases_workspace_id_page_id_unique
|
|
ON share_aliases (workspace_id, page_id)
|
|
WHERE page_id IS NOT NULL
|
|
`.execute(db);
|
|
}
|
|
});
|
|
|
|
it('migration up() dedups per page and leaves OTHER pages and workspaces untouched', async () => {
|
|
// Seed legacy duplicates for two pages in this workspace AND a page in a
|
|
// SECOND workspace, then run the real migration up() (not an inlined copy of
|
|
// its SQL) and assert it scopes the DELETE to (workspace_id, page_id).
|
|
const ws2 = (await createWorkspace(db)).id;
|
|
const space2 = (await createSpace(db, ws2)).id;
|
|
const pageA = await newPage();
|
|
const pageB = await newPage();
|
|
const pageC = (await createPage(db, { workspaceId: ws2, spaceId: space2 }))
|
|
.id;
|
|
|
|
// Drop the guard so we can seed the pre-invariant duplicate shape.
|
|
await sql`DROP INDEX share_aliases_workspace_id_page_id_unique`.execute(db);
|
|
const seed = async (
|
|
workspaceId: string,
|
|
pageId: string,
|
|
alias: string,
|
|
createdAt: string,
|
|
): Promise<string> => {
|
|
const id = randomUUID();
|
|
await db
|
|
.insertInto('shareAliases')
|
|
.values({ id, workspaceId, alias, pageId, createdAt })
|
|
.execute();
|
|
return id;
|
|
};
|
|
await seed(wsId, pageA, 'a-old', '2026-01-01T00:00:00Z');
|
|
const aNew = await seed(wsId, pageA, 'a-new', '2026-03-01T00:00:00Z');
|
|
await seed(wsId, pageB, 'b-old', '2026-01-01T00:00:00Z');
|
|
const bNew = await seed(wsId, pageB, 'b-new', '2026-03-01T00:00:00Z');
|
|
await seed(ws2, pageC, 'c-old', '2026-01-01T00:00:00Z');
|
|
const cNew = await seed(ws2, pageC, 'c-new', '2026-03-01T00:00:00Z');
|
|
|
|
// Run the migration. It dedups AND recreates the unique index.
|
|
await onePerPageMigration.up(db as any);
|
|
|
|
const aliasesOf = async (pageId: string) =>
|
|
(await aliasRowsForWs(pageId, wsId)).map((r) => r.alias);
|
|
const aRows = await aliasRowsForWs(pageA, wsId);
|
|
expect(aRows).toEqual([{ id: aNew, alias: 'a-new' }]);
|
|
const bRows = await aliasRowsForWs(pageB, wsId);
|
|
expect(bRows).toEqual([{ id: bNew, alias: 'b-new' }]);
|
|
// The other workspace's page keeps only ITS newest row, untouched by wsId.
|
|
const cRows = await aliasRowsForWs(pageC, ws2);
|
|
expect(cRows).toEqual([{ id: cNew, alias: 'c-new' }]);
|
|
expect(await aliasesOf(pageA)).toEqual(['a-new']);
|
|
});
|
|
|
|
it('setAlias renames te -> ted in place: page ends with ONE row named ted', async () => {
|
|
const pageId = await newPage();
|
|
const creatorId = null as any;
|
|
const first = await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId,
|
|
creatorId,
|
|
alias: 'te',
|
|
});
|
|
expect(first.alias).toBe('te');
|
|
|
|
const renamed = await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId,
|
|
creatorId,
|
|
alias: 'ted',
|
|
});
|
|
// Same row id — a RENAME, not a new insert.
|
|
expect(renamed.id).toBe(first.id);
|
|
expect(renamed.alias).toBe('ted');
|
|
|
|
const rows = await aliasRowsFor(pageId);
|
|
expect(rows).toHaveLength(1);
|
|
expect(rows[0].alias).toBe('ted'); // the stale `te` row is gone
|
|
|
|
// The modal read resolves the current (only) row deterministically.
|
|
const shown = await service.getAliasForPage(pageId, wsId);
|
|
expect(shown?.alias).toBe('ted');
|
|
});
|
|
|
|
it('setAlias inserts the first alias, then is a no-op for the same name', async () => {
|
|
const pageId = await newPage();
|
|
const inserted = await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId,
|
|
creatorId: null as any,
|
|
alias: 'hello',
|
|
});
|
|
const again = await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId,
|
|
creatorId: null as any,
|
|
alias: 'hello',
|
|
});
|
|
expect(again.id).toBe(inserted.id);
|
|
expect(await aliasRowsFor(pageId)).toHaveLength(1);
|
|
});
|
|
|
|
it('a mid-transaction error becomes BadRequestException and rolls back cleanly', async () => {
|
|
// A non-23505 failure inside the tx must surface as BadRequest AND leave NO
|
|
// partial alias state behind (the whole executeTx unit rolls back).
|
|
const pageId = await newPage();
|
|
const boom = new Error('disk on fire'); // not a unique-violation
|
|
// Wrap the real repo so the INSERT succeeds but the trailing self-heal
|
|
// throws — the row inserted earlier in the tx must not survive.
|
|
const flakyRepo = Object.create(repo);
|
|
flakyRepo.deleteOthersForPage = async () => {
|
|
throw boom;
|
|
};
|
|
const flakyService = new ShareAliasService(
|
|
flakyRepo as any,
|
|
pageRepo as any,
|
|
{} as any,
|
|
db as any,
|
|
);
|
|
|
|
await expect(
|
|
flakyService.setAlias({
|
|
workspaceId: wsId,
|
|
pageId,
|
|
creatorId: null as any,
|
|
alias: 'rollback-me',
|
|
}),
|
|
).rejects.toBeInstanceOf(BadRequestException);
|
|
|
|
// Rolled back: neither the page nor the name has any row.
|
|
expect(await aliasRowsFor(pageId)).toHaveLength(0);
|
|
expect(
|
|
await db
|
|
.selectFrom('shareAliases')
|
|
.select('id')
|
|
.where('alias', '=', 'rollback-me')
|
|
.where('workspaceId', '=', wsId)
|
|
.execute(),
|
|
).toHaveLength(0);
|
|
});
|
|
|
|
it('cross-page collision throws 409, and confirmReassign moves the single row', async () => {
|
|
const pageA = await newPage();
|
|
const pageB = await newPage();
|
|
await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId: pageA,
|
|
creatorId: null as any,
|
|
alias: 'shared',
|
|
});
|
|
|
|
await expect(
|
|
service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId: pageB,
|
|
creatorId: null as any,
|
|
alias: 'shared',
|
|
}),
|
|
).rejects.toBeInstanceOf(ConflictException);
|
|
|
|
const moved = await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId: pageB,
|
|
creatorId: null as any,
|
|
alias: 'shared',
|
|
confirmReassign: true,
|
|
});
|
|
expect(moved.alias).toBe('shared');
|
|
|
|
// The name now belongs to pageB only; pageA has no alias.
|
|
expect(await aliasRowsFor(pageA)).toHaveLength(0);
|
|
const bRows = await aliasRowsFor(pageB);
|
|
expect(bRows).toHaveLength(1);
|
|
expect(bRows[0].alias).toBe('shared');
|
|
});
|
|
|
|
it('confirmReassign onto a page that ALREADY has its own alias: target ends with ONE row', async () => {
|
|
// Regression guard for the operation-order bug: A has `shared`, B has its
|
|
// OWN alias `bee`. Moving `shared` onto B must FIRST drop B's `bee` row,
|
|
// THEN retarget, or the NON-deferrable (workspace_id, page_id) index fires a
|
|
// 23505 mid-transaction (two rows momentarily carry page_id = B) and the tx
|
|
// rolls back into a misleading "Alias already taken".
|
|
// Distinct names: the workspace is shared across tests, so reuse of an
|
|
// earlier test's `shared` would trip the 409 guard before we get here.
|
|
const pageA = await newPage();
|
|
const pageB = await newPage();
|
|
await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId: pageA,
|
|
creatorId: null as any,
|
|
alias: 'shared-target',
|
|
});
|
|
await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId: pageB,
|
|
creatorId: null as any,
|
|
alias: 'bee',
|
|
});
|
|
|
|
const moved = await service.setAlias({
|
|
workspaceId: wsId,
|
|
pageId: pageB,
|
|
creatorId: null as any,
|
|
alias: 'shared-target',
|
|
confirmReassign: true,
|
|
});
|
|
expect(moved.alias).toBe('shared-target');
|
|
|
|
// B now carries exactly `shared-target` (its old `bee` is gone); A has none.
|
|
const bRows = await aliasRowsFor(pageB);
|
|
expect(bRows).toHaveLength(1);
|
|
expect(bRows[0].alias).toBe('shared-target');
|
|
expect(await aliasRowsFor(pageA)).toHaveLength(0);
|
|
});
|
|
});
|