Merge remote-tracking branch 'gitea/develop' into feat/page-templates

# Conflicts:
#	apps/server/src/integrations/throttle/throttle.module.ts
#	apps/server/src/integrations/throttle/throttler-names.ts
This commit is contained in:
claude_code
2026-06-20 20:18:42 +03:00
130 changed files with 9951 additions and 3095 deletions

View File

@@ -32,6 +32,7 @@ import { AiChatRepo } from '@docmost/db/repos/ai-chat/ai-chat.repo';
import { AiChatMessageRepo } from '@docmost/db/repos/ai-chat/ai-chat-message.repo';
import { AiProviderCredentialsRepo } from '@docmost/db/repos/ai-chat/ai-provider-credentials.repo';
import { AiMcpServerRepo } from '@docmost/db/repos/ai-chat/ai-mcp-server.repo';
import { AiAgentRoleRepo } from '@docmost/db/repos/ai-agent-roles/ai-agent-roles.repo';
import { PageEmbeddingRepo } from '@docmost/db/repos/ai-chat/page-embedding.repo';
import { PageListener } from '@docmost/db/listeners/page.listener';
import { PostgresJSDialect } from 'kysely-postgres-js';
@@ -103,6 +104,7 @@ import { normalizePostgresUrl } from '../common/helpers';
AiChatMessageRepo,
AiProviderCredentialsRepo,
AiMcpServerRepo,
AiAgentRoleRepo,
PageEmbeddingRepo,
PageListener,
],
@@ -134,6 +136,7 @@ import { normalizePostgresUrl } from '../common/helpers';
AiChatMessageRepo,
AiProviderCredentialsRepo,
AiMcpServerRepo,
AiAgentRoleRepo,
PageEmbeddingRepo,
],
})

View File

@@ -6,9 +6,46 @@ import { QueueJob, QueueName } from '../../integrations/queue/constants';
import { Queue } from 'bullmq';
import { EnvironmentService } from '../../integrations/environment/environment.service';
/**
* Thin snapshot of a page node carried inside domain events so the WebSocket
* tree listener can broadcast a tree update WITHOUT reading the DB. This is
* "variant A" of the realtime-tree design: enriching the event avoids the
* in-transaction visibility race where a separate SELECT in the listener could
* run before the emitting `trx` has committed and therefore not see the row.
*/
export interface TreeNodeSnapshot {
id: string;
slugId: string;
title: string | null;
icon: string | null;
position: string;
spaceId: string;
parentPageId: string | null;
}
export class PageEvent {
pageIds: string[];
workspaceId: string;
// Optional tree snapshots so the WS listener can broadcast without a DB read
// (avoids the in-transaction visibility race on PAGE_CREATED /
// PAGE_SOFT_DELETED / PAGE_DELETED). The existing search/AI listeners ignore
// this field — they only enqueue work keyed by pageIds.
pages?: TreeNodeSnapshot[];
// Set on PAGE_RESTORED so the WS listener can scope a refetchRootTreeNodeEvent
// to the affected space (restore can re-attach a whole subtree).
spaceId?: string;
}
/**
* Emitted by `PageService.movePage` after a successful re-parent / reorder.
* Carries both the old and new parent plus the new position so the WS listener
* can build a `moveTreeNode` broadcast without a DB read.
*/
export class PageMovedEvent {
workspaceId: string;
oldParentId: string | null;
node: TreeNodeSnapshot;
hasChildren: boolean;
}
@Injectable()

View File

@@ -0,0 +1,85 @@
import { type Kysely, sql } from 'kysely';
export async function up(db: Kysely<any>): Promise<void> {
// Reusable, workspace-scoped agent roles (admin-owned). A role REPLACES the
// persona layer of the system prompt (instructions) and may optionally
// override the chat model. The non-removable SAFETY_FRAMEWORK is always still
// appended downstream — a role only shapes the persona, never the safety rules.
await db.schema
.createTable('ai_agent_roles')
.ifNotExists()
.addColumn('id', 'uuid', (col) =>
col.primaryKey().defaultTo(sql`gen_uuid_v7()`),
)
.addColumn('workspace_id', 'uuid', (col) =>
col.references('workspaces.id').onDelete('cascade').notNull(),
)
// Who created the role (audit). The role is shared and outlives its author,
// so SET NULL on user deletion (unlike ai_chats.creator_id which is NOT NULL).
.addColumn('creator_id', 'uuid', (col) =>
col.references('users.id').onDelete('set null'),
)
// Display name, e.g. 'Proofreader'.
.addColumn('name', 'varchar', (col) => col.notNull())
// Optional presentation emoji for the role badge.
.addColumn('emoji', 'varchar', (col) => col)
// Optional short description shown in the management UI.
.addColumn('description', 'text', (col) => col)
// The persona fragment injected into the system prompt (replaces the admin
// persona / DEFAULT_PROMPT). Required.
.addColumn('instructions', 'text', (col) => col.notNull())
// Optional model override: { chatModel } or { driver, chatModel }. NULL =>
// use the workspace default model. Driver creds come from the matching
// provider in ai_provider_credentials (no per-role creds).
.addColumn('model_config', 'jsonb', (col) => col)
.addColumn('enabled', 'boolean', (col) => col.notNull().defaultTo(true))
.addColumn('created_at', 'timestamptz', (col) =>
col.notNull().defaultTo(sql`now()`),
)
.addColumn('updated_at', 'timestamptz', (col) =>
col.notNull().defaultTo(sql`now()`),
)
// Soft delete (consistent with ai_chats): the role disappears from the
// picker but lookups can still resolve it for already-bound chats.
.addColumn('deleted_at', 'timestamptz', (col) => col)
.execute();
// Scoped lookups (listByWorkspace) hit workspace_id first.
await db.schema
.createIndex('idx_ai_agent_roles_workspace_id')
.ifNotExists()
.on('ai_agent_roles')
.column('workspace_id')
.execute();
// A role name is unique per workspace. Partial (WHERE deleted_at IS NULL) so a
// soft-deleted role does not block re-creating a role with the same name.
await db.schema
.createIndex('ai_agent_roles_workspace_id_name_unique')
.ifNotExists()
.on('ai_agent_roles')
.columns(['workspace_id', 'name'])
.unique()
.where(sql.ref('deleted_at'), 'is', null)
.execute();
// Bind a chat to a role. ON DELETE SET NULL: a hard-deleted role degrades the
// chat to the universal assistant instead of breaking it. The role is read
// from this column on every turn — the client only sends roleId on chat
// creation (first message).
await db.schema
.alterTable('ai_chats')
.addColumn('role_id', 'uuid', (col) =>
col.references('ai_agent_roles.id').onDelete('set null'),
)
.execute();
}
export async function down(db: Kysely<any>): Promise<void> {
await db.schema.alterTable('ai_chats').dropColumn('role_id').execute();
await db.schema
.dropIndex('ai_agent_roles_workspace_id_name_unique')
.ifExists()
.execute();
await db.schema.dropTable('ai_agent_roles').execute();
}

View File

@@ -0,0 +1,141 @@
import { Injectable } from '@nestjs/common';
import { InjectKysely } from 'nestjs-kysely';
import { sql } from 'kysely';
import { KyselyDB, KyselyTransaction } from '../../types/kysely.types';
import { dbOrTx } from '../../utils';
import { AiAgentRole } from '@docmost/db/types/entity.types';
/** The jsonb shape persisted in `model_config` (loosely typed for the column). */
type ModelConfigValue = Record<string, unknown> | null;
/**
* Repository for per-workspace agent roles (admin-owned presets). All lookups
* are workspace-scoped and soft-delete aware (`deleted_at IS NULL`). A role
* shapes only the system-prompt persona + optional model override; it never
* widens or narrows the toolset or CASL boundary.
*/
@Injectable()
export class AiAgentRoleRepo {
constructor(@InjectKysely() private readonly db: KyselyDB) {}
/** Single live (not soft-deleted) role scoped to the workspace. */
async findById(
id: string,
workspaceId: string,
): Promise<AiAgentRole | undefined> {
return this.db
.selectFrom('aiAgentRoles')
.selectAll('aiAgentRoles')
.where('id', '=', id)
.where('workspaceId', '=', workspaceId)
.where('deletedAt', 'is', null)
.executeTakeFirst();
}
/** All live roles for the workspace (management list + chat picker). */
async listByWorkspace(workspaceId: string): Promise<AiAgentRole[]> {
return this.db
.selectFrom('aiAgentRoles')
.selectAll('aiAgentRoles')
.where('workspaceId', '=', workspaceId)
.where('deletedAt', 'is', null)
.orderBy('createdAt', 'asc')
.execute();
}
async insert(
values: {
workspaceId: string;
creatorId?: string | null;
name: string;
emoji?: string | null;
description?: string | null;
instructions: string;
modelConfig?: ModelConfigValue;
enabled?: boolean;
},
trx?: KyselyTransaction,
): Promise<AiAgentRole> {
const db = dbOrTx(this.db, trx);
return db
.insertInto('aiAgentRoles')
.values({
workspaceId: values.workspaceId,
creatorId: values.creatorId ?? null,
name: values.name,
emoji: values.emoji ?? null,
description: values.description ?? null,
instructions: values.instructions,
modelConfig: jsonbObject(values.modelConfig),
enabled: values.enabled ?? true,
})
.returningAll()
.executeTakeFirst();
}
async update(
id: string,
workspaceId: string,
patch: {
name?: string;
// undefined => unchanged; null => clear; string => set.
emoji?: string | null;
description?: string | null;
instructions?: string;
// undefined => unchanged; null => clear; object => set.
modelConfig?: ModelConfigValue;
enabled?: boolean;
},
trx?: KyselyTransaction,
): Promise<void> {
const db = dbOrTx(this.db, trx);
const set: Record<string, unknown> = { updatedAt: new Date() };
if (patch.name !== undefined) set.name = patch.name;
if (patch.emoji !== undefined) set.emoji = patch.emoji;
if (patch.description !== undefined) set.description = patch.description;
if (patch.instructions !== undefined) set.instructions = patch.instructions;
if (patch.modelConfig !== undefined) {
set.modelConfig = jsonbObject(patch.modelConfig);
}
if (patch.enabled !== undefined) set.enabled = patch.enabled;
await db
.updateTable('aiAgentRoles')
.set(set)
.where('id', '=', id)
.where('workspaceId', '=', workspaceId)
.where('deletedAt', 'is', null)
.execute();
}
/** Soft delete (consistent with ai_chats). Bound chats keep their role_id; the
* stream resolves only live roles, so the chat degrades to universal. */
async softDelete(
id: string,
workspaceId: string,
trx?: KyselyTransaction,
): Promise<void> {
const db = dbOrTx(this.db, trx);
await db
.updateTable('aiAgentRoles')
.set({ deletedAt: new Date() })
.where('id', '=', id)
.where('workspaceId', '=', workspaceId)
.where('deletedAt', 'is', null)
.execute();
}
}
/**
* Encode an object as a jsonb bind for the `model_config` column. The postgres
* driver would otherwise need an explicit cast; bind the JSON text and cast it.
* Returns null for null/undefined/empty objects. Cast to `any` because the
* generated column type is the broad `JsonValue` union, which a concrete object
* type is not structurally assignable to.
*/
function jsonbObject(value: ModelConfigValue | undefined) {
if (value === null || value === undefined || Object.keys(value).length === 0) {
return null;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return sql`${JSON.stringify(value)}::jsonb` as any;
}

View File

@@ -29,20 +29,38 @@ export class AiChatRepo {
workspaceId: string,
pagination: PaginationOptions,
) {
// Left-join the bound role for the badge (emoji + name). Joined, not
// denormalized — the chat list is not a hot path. A soft-deleted role
// resolves to NULL so the badge disappears, matching the stream's behavior.
// A DISABLED role (enabled=false) is likewise excluded: resolveRoleForRequest
// downgrades such a chat to the universal assistant, so the badge must not
// advertise a role that is not actually applied.
const query = this.db
.selectFrom('aiChats')
.leftJoin('aiAgentRoles', (join) =>
join
.onRef('aiAgentRoles.id', '=', 'aiChats.roleId')
.on('aiAgentRoles.deletedAt', 'is', null)
.on('aiAgentRoles.enabled', '=', true),
)
.selectAll('aiChats')
.where('creatorId', '=', creatorId)
.where('workspaceId', '=', workspaceId)
.where('deletedAt', 'is', null);
.select([
'aiAgentRoles.name as roleName',
'aiAgentRoles.emoji as roleEmoji',
])
.where('aiChats.creatorId', '=', creatorId)
.where('aiChats.workspaceId', '=', workspaceId)
.where('aiChats.deletedAt', 'is', null);
return executeWithCursorPagination(query, {
perPage: pagination.limit,
cursor: pagination.cursor,
beforeCursor: pagination.beforeCursor,
fields: [
{ expression: 'createdAt', direction: 'desc' },
{ expression: 'id', direction: 'desc' },
// Qualify to aiChats — the join introduces an aiAgentRoles.createdAt/id
// that would otherwise make the ORDER BY / cursor comparison ambiguous.
{ expression: 'aiChats.createdAt', direction: 'desc' },
{ expression: 'aiChats.id', direction: 'desc' },
],
parseCursor: (cursor) => ({
createdAt: new Date(cursor.createdAt),

View File

@@ -0,0 +1,26 @@
import { PageEmbeddingRepo } from './page-embedding.repo';
import type { KyselyDB } from '../../types/kysely.types';
/**
* Unit test for the pure access-scoping branch of searchByEmbedding: when the
* caller has NO accessible spaces (`spaceIds` empty), the method must early-
* return [] WITHOUT touching the database. We inject a db whose query builder
* throws if invoked, so any DB access fails the test.
*
* NOTE: the dimension-mixing case (filter by model_dimensions) needs a live
* pgvector-enabled Postgres and is intentionally NOT covered here — it requires
* a real DB and is out of scope for this pure unit test.
*/
describe('PageEmbeddingRepo.searchByEmbedding', () => {
it('early-returns [] for empty spaceIds without any DB call', async () => {
const throwingDb = {
selectFrom: () => {
throw new Error('DB should not be queried for empty spaceIds');
},
} as unknown as KyselyDB;
const repo = new PageEmbeddingRepo(throwingDb);
const result = await repo.searchByEmbedding('ws-1', [0.1, 0.2, 0.3], [], 10);
expect(result).toEqual([]);
});
});

View File

@@ -176,9 +176,23 @@ export class PageRepo {
.returning(this.baseFields)
.executeTakeFirst();
// Enrich the event with a thin node snapshot (variant A) so the WS tree
// listener can broadcast `addTreeNode` without re-reading the DB. `result`
// already comes from `returning(this.baseFields)`, so no extra query.
this.eventEmitter.emit(EventName.PAGE_CREATED, {
pageIds: [result.id],
workspaceId: result.workspaceId,
pages: [
{
id: result.id,
slugId: result.slugId,
title: result.title,
icon: result.icon,
position: result.position,
spaceId: result.spaceId,
parentPageId: result.parentPageId,
},
],
});
return result;
@@ -269,6 +283,25 @@ export class PageRepo {
): Promise<void> {
const currentDate = new Date();
// Read the root snapshot up front so PAGE_SOFT_DELETED can carry it without
// a post-commit DB read (variant A). Only the root of the deleted subtree is
// needed for the tree broadcast — the client `treeModel.remove` drops all
// descendants, so we don't snapshot/broadcast every descendant.
const rootSnapshot = await this.db
.selectFrom('pages')
.select([
'id',
'slugId',
'title',
'icon',
'position',
'spaceId',
'parentPageId',
])
.where('id', '=', pageId)
.where('deletedAt', 'is', null)
.executeTakeFirst();
const descendants = await this.db
.withRecursive('page_descendants', (db) =>
db
@@ -308,6 +341,21 @@ export class PageRepo {
this.eventEmitter.emit(EventName.PAGE_SOFT_DELETED, {
pageIds: pageIds,
workspaceId,
// Root-only snapshot: one `deleteTreeNode` is enough, the client removes
// the whole subtree. Skip if the root vanished between the two reads.
pages: rootSnapshot
? [
{
id: rootSnapshot.id,
slugId: rootSnapshot.slugId,
title: rootSnapshot.title,
icon: rootSnapshot.icon,
position: rootSnapshot.position,
spaceId: rootSnapshot.spaceId,
parentPageId: rootSnapshot.parentPageId,
},
]
: [],
});
}
}
@@ -316,7 +364,7 @@ export class PageRepo {
// First, check if the page being restored has a deleted parent
const pageToRestore = await this.db
.selectFrom('pages')
.select(['id', 'parentPageId'])
.select(['id', 'parentPageId', 'spaceId'])
.where('id', '=', pageId)
.executeTakeFirst();
@@ -375,6 +423,10 @@ export class PageRepo {
this.eventEmitter.emit(EventName.PAGE_RESTORED, {
pageIds: pageIds,
workspaceId: workspaceId,
// spaceId lets the WS listener send a space-scoped refetchRootTreeNodeEvent.
// Restore can re-attach a whole subtree, so a root refetch is simpler and
// more robust than N pointwise addTreeNode events.
spaceId: pageToRestore.spaceId,
});
}
@@ -675,4 +727,58 @@ export class PageRepo {
.execute()
);
}
/**
* Whole space tree (all root pages and their descendants) in a single
* recursive query. Mirrors getPageAndDescendants but seeded by every root
* page of the space (parentPageId IS NULL) instead of a single parent.
*/
async getSpaceDescendants(
spaceId: string,
opts: { includeContent: boolean },
) {
return this.db
.withRecursive('page_hierarchy', (db) =>
db
.selectFrom('pages')
.select([
'id',
'slugId',
'title',
'icon',
'position',
'parentPageId',
'spaceId',
'workspaceId',
'createdAt',
'updatedAt',
])
.$if(opts?.includeContent, (qb) => qb.select('content'))
.where('spaceId', '=', spaceId)
.where('parentPageId', 'is', null)
.where('deletedAt', 'is', null)
.unionAll((exp) =>
exp
.selectFrom('pages as p')
.select([
'p.id',
'p.slugId',
'p.title',
'p.icon',
'p.position',
'p.parentPageId',
'p.spaceId',
'p.workspaceId',
'p.createdAt',
'p.updatedAt',
])
.$if(opts?.includeContent, (qb) => qb.select('p.content'))
.innerJoin('page_hierarchy as ph', 'p.parentPageId', 'ph.id')
.where('p.deletedAt', 'is', null),
),
)
.selectFrom('page_hierarchy')
.selectAll()
.execute();
}
}

View File

@@ -239,7 +239,7 @@ export class WorkspaceRepo {
// is a real jsonb object, never a double-encoded string. The CASE self-heals
// workspaces whose settings.ai.provider was previously corrupted into an
// array/string.
const ALLOWED = ['driver', 'chatModel', 'embeddingModel', 'baseUrl', 'embeddingBaseUrl', 'sttModel', 'sttBaseUrl', 'sttApiStyle', 'systemPrompt'];
const ALLOWED = ['driver', 'chatModel', 'embeddingModel', 'baseUrl', 'embeddingBaseUrl', 'sttModel', 'sttBaseUrl', 'sttApiStyle', 'systemPrompt', 'publicShareChatModel', 'publicShareAssistantRoleId'];
const entries = Object.entries(provider).filter(
([k, v]) => v !== undefined && ALLOWED.includes(k),
);

View File

@@ -570,6 +570,33 @@ export interface AiChats {
workspaceId: string;
creatorId: string;
title: string | null;
// The agent role this chat is bound to (set on creation, immutable). NULL =>
// universal assistant. ON DELETE SET NULL: a hard-deleted role degrades the
// chat to universal instead of breaking it. Resolved from this column on every
// turn — NOT from the request body.
roleId: string | null;
createdAt: Generated<Timestamp>;
updatedAt: Generated<Timestamp>;
deletedAt: Timestamp | null;
}
// Reusable, workspace-scoped agent roles (admin-owned). Mirrors migration
// 20260620T120000-ai-agent-roles.ts. A role REPLACES the persona layer of the
// system prompt (`instructions`) and may optionally override the chat model
// (`modelConfig`). The non-removable SAFETY_FRAMEWORK is always still appended
// downstream. Soft-deletable via `deletedAt`.
export interface AiAgentRoles {
id: Generated<string>;
workspaceId: string;
// Audit only; SET NULL on user deletion (the role outlives its author).
creatorId: string | null;
name: string;
emoji: string | null;
description: string | null;
instructions: string;
// { chatModel } | { driver, chatModel } | null. null => workspace default.
modelConfig: Json | null;
enabled: Generated<boolean>;
createdAt: Generated<Timestamp>;
updatedAt: Generated<Timestamp>;
deletedAt: Timestamp | null;
@@ -606,6 +633,7 @@ export interface UserSessions {
}
export interface DB {
aiAgentRoles: AiAgentRoles;
aiChats: AiChats;
aiChatMessages: AiChatMessages;
apiKeys: ApiKeys;

View File

@@ -1,5 +1,6 @@
import { Insertable, Selectable, Updateable } from 'kysely';
import {
AiAgentRoles,
AiChats,
AiChatMessages,
Attachments,
@@ -75,6 +76,13 @@ export type AiMcpServer = Selectable<AiMcpServersTable>;
export type InsertableAiMcpServer = Insertable<AiMcpServersTable>;
export type UpdatableAiMcpServer = Updateable<Omit<AiMcpServersTable, 'id'>>;
// AI Agent Roles (reusable, workspace-scoped, admin-owned agent presets).
// A role replaces the persona layer of the system prompt (instructions) and may
// optionally override the chat model (`modelConfig`). Soft-deletable.
export type AiAgentRole = Selectable<AiAgentRoles>;
export type InsertableAiAgentRole = Insertable<AiAgentRoles>;
export type UpdatableAiAgentRole = Updateable<Omit<AiAgentRoles, 'id'>>;
// Workspace
export type Workspace = Selectable<Workspaces>;
export type InsertableWorkspace = Insertable<Workspaces>;