mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-27 02:44:50 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI-agent companies. > - The control plane coordinates issues, workspaces, documents, routines, and board review flows across company-scoped data. > - The local source branch contained related schema, service, and UI changes for workspace issue scoping and document/routine annotations. > - These changes need to move together because db schema, shared types, server services, and UI consumers form one contract. > - This pull request extracts the migration-bearing control-plane work from the source branch onto `origin/master`. > - The benefit is a standalone branch with deterministic migration order and focused review for the highest-risk part of the split. ## Linked Issues or Issue Description No GitHub issue exists for this branch split. Internal source task: [PAP-11234](/PAP/issues/PAP-11234). Problem/motivation: - Workspace operations need explicit issue scoping so readiness and blocker handling can be derived correctly. - Document annotations need reliable live updates, save failure surfacing, normalized activity keys, and better comment panel behavior. - Routine descriptions need the same annotation contract as issue documents so operators can discuss and edit routine text without special-case infrastructure. Proposed solution: - Add the workspace-operation `issueId` migration and readiness scoping. - Add routine document/annotation schema, shared types, services, routes, and UI editing support. - Keep the related migrations in one PR so the renumbered `0106` and `0107` migrations land in a deterministic order after current `master`. Alternatives considered: - Split migrations into separate PRs, rejected because that would create migration-numbering conflicts and make each branch less standalone. - Merge this with UI polish, rejected because this branch needs deeper server/db review. Roadmap alignment: - Checked `ROADMAP.md`; the roadmap mentions future recurring routine capabilities generally, but no duplicate implementation PR for these annotation/workspace changes was found. ## What Changed - Added `0106_workspace_operations_issue_id.sql` and `0107_routine_description_annotations.sql`, plus schema exports. - Scoped workspace readiness to blocker issues and attached workspace operation issue ids. - Scoped issue-thread interaction accept finalization to the source run. - Added routine document annotation contracts across db/shared/server/UI. - Improved document annotation live updates, activity-key normalization, save failure surfacing, and comment panel behavior. - Added issue workspace property controls and compact blocked-by/quick-control UI updates. - Added focused server and UI regression tests for the new contracts. ## Verification - `CI=true NODE_ENV=development pnpm install --frozen-lockfile --prefer-offline` - `NODE_ENV=test pnpm exec vitest server/src/__tests__/document-annotation-routes.test.ts server/src/__tests__/issue-thread-interactions-service.test.ts server/src/__tests__/issues-service.test.ts server/src/__tests__/routine-document-annotation-routes.test.ts server/src/__tests__/routines-routes.test.ts server/src/__tests__/workspace-runtime.test.ts ui/src/components/IssueDocumentAnnotations.test.tsx ui/src/components/IssueProperties.test.tsx ui/src/components/WorkspaceRuntimeControls.test.tsx ui/src/context/LiveUpdatesProvider.test.ts --run` — 10 files, 273 tests passed. - `NODE_ENV=test pnpm -r --filter @paperclipai/db --filter @paperclipai/shared --filter @paperclipai/server --filter @paperclipai/ui typecheck` — passed, including db migration numbering check. ## Risks - Migration-bearing PR; merge this branch before any later PR that adds migrations with higher numbers. - Cross-layer contract risk across db/shared/server/ui, mitigated with targeted tests and affected-package typecheck. - Review should pay special attention to company scoping in new routine/document annotation paths. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used OpenAI GPT-5 Codex via Paperclip `codex_local` / CodexCoder, GPT-5-class coding model with tool use and shell execution. Exact runtime snapshot and context-window setting were not exposed by the Paperclip run context. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details available from the run context) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots (N/A per source task: do not add screenshots/images unless specifically part of the work) - [x] I have updated relevant documentation to reflect my changes (N/A; no public docs changed) - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
83 lines
3.9 KiB
TypeScript
83 lines
3.9 KiB
TypeScript
import type {
|
|
DocumentAnnotationAnchorConfidence,
|
|
DocumentAnnotationAnchorSelector,
|
|
DocumentAnnotationAnchorState,
|
|
DocumentAnnotationThreadStatus,
|
|
} from "@paperclipai/shared";
|
|
import { sql } from "drizzle-orm";
|
|
import { check, index, integer, jsonb, pgTable, text, timestamp, uuid } from "drizzle-orm/pg-core";
|
|
import { agents } from "./agents.js";
|
|
import { companies } from "./companies.js";
|
|
import { documentRevisions } from "./document_revisions.js";
|
|
import { documents } from "./documents.js";
|
|
import { issues } from "./issues.js";
|
|
import { routines } from "./routines.js";
|
|
|
|
export const documentAnnotationThreads = pgTable(
|
|
"document_annotation_threads",
|
|
{
|
|
id: uuid("id").primaryKey().defaultRandom(),
|
|
companyId: uuid("company_id").notNull().references(() => companies.id),
|
|
issueId: uuid("issue_id").references(() => issues.id, { onDelete: "cascade" }),
|
|
routineId: uuid("routine_id").references(() => routines.id, { onDelete: "cascade" }),
|
|
documentId: uuid("document_id").notNull().references(() => documents.id, { onDelete: "cascade" }),
|
|
documentKey: text("document_key").notNull(),
|
|
status: text("status").$type<DocumentAnnotationThreadStatus>().notNull().default("open"),
|
|
anchorState: text("anchor_state").$type<DocumentAnnotationAnchorState>().notNull().default("active"),
|
|
originalRevisionId: uuid("original_revision_id").references(() => documentRevisions.id, { onDelete: "set null" }),
|
|
originalRevisionNumber: integer("original_revision_number").notNull(),
|
|
currentRevisionId: uuid("current_revision_id").references(() => documentRevisions.id, { onDelete: "set null" }),
|
|
currentRevisionNumber: integer("current_revision_number").notNull(),
|
|
selectedText: text("selected_text").notNull(),
|
|
prefixText: text("prefix_text").notNull().default(""),
|
|
suffixText: text("suffix_text").notNull().default(""),
|
|
normalizedStart: integer("normalized_start").notNull(),
|
|
normalizedEnd: integer("normalized_end").notNull(),
|
|
markdownStart: integer("markdown_start").notNull(),
|
|
markdownEnd: integer("markdown_end").notNull(),
|
|
anchorConfidence: text("anchor_confidence")
|
|
.$type<DocumentAnnotationAnchorConfidence>()
|
|
.notNull()
|
|
.default("exact"),
|
|
anchorSelector: jsonb("anchor_selector").$type<DocumentAnnotationAnchorSelector>().notNull(),
|
|
createdByAgentId: uuid("created_by_agent_id").references(() => agents.id, { onDelete: "set null" }),
|
|
createdByUserId: text("created_by_user_id"),
|
|
resolvedByAgentId: uuid("resolved_by_agent_id").references(() => agents.id, { onDelete: "set null" }),
|
|
resolvedByUserId: text("resolved_by_user_id"),
|
|
resolvedAt: timestamp("resolved_at", { withTimezone: true }),
|
|
createdAt: timestamp("created_at", { withTimezone: true }).notNull().defaultNow(),
|
|
updatedAt: timestamp("updated_at", { withTimezone: true }).notNull().defaultNow(),
|
|
},
|
|
(table) => ({
|
|
companyDocumentStatusIdx: index("document_annotation_threads_company_document_status_idx").on(
|
|
table.companyId,
|
|
table.documentId,
|
|
table.status,
|
|
),
|
|
companyIssueStatusIdx: index("document_annotation_threads_company_issue_status_idx").on(
|
|
table.companyId,
|
|
table.issueId,
|
|
table.status,
|
|
),
|
|
companyRoutineStatusIdx: index("document_annotation_threads_company_routine_status_idx").on(
|
|
table.companyId,
|
|
table.routineId,
|
|
table.status,
|
|
),
|
|
companyCurrentRevisionOpenIdx: index("document_annotation_threads_company_current_revision_open_idx").on(
|
|
table.companyId,
|
|
table.documentId,
|
|
table.currentRevisionId,
|
|
table.status,
|
|
),
|
|
companyAnchorStateIdx: index("document_annotation_threads_company_anchor_state_idx").on(
|
|
table.companyId,
|
|
table.anchorState,
|
|
),
|
|
exactlyOneOwnerChk: check(
|
|
"document_annotation_threads_exactly_one_owner_chk",
|
|
sql`num_nonnulls(${table.issueId}, ${table.routineId}) = 1`,
|
|
),
|
|
}),
|
|
);
|