Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

feat(sheets): spreadsheet comments on the shared message store (#7171)

gbirman19bce476bdd9
diff --git a/.sqlx/query-5c5df79936ec65c532c5f0e0aa90a39a772fc7809d4cb52c4e9483771a1922c6.json b/.sqlx/query-5c5df79936ec65c532c5f0e0aa90a39a772fc7809d4cb52c4e9483771a1922c6.json
new file mode 100644
index 0000000000..71963f04c6
--- /dev/null
+++ b/.sqlx/query-5c5df79936ec65c532c5f0e0aa90a39a772fc7809d4cb52c4e9483771a1922c6.json
@@ -0,0 +1,22 @@
+{
+ "db_name": "PostgreSQL",
+ "query": "SELECT \"fileType\" FROM \"Document\" WHERE id = $1 AND \"deletedAt\" IS NULL",
+ "describe": {
+ "columns": [
+ {
+ "ordinal": 0,
+ "name": "fileType",
+ "type_info": "Text"
+ }
+ ],
+ "parameters": {
+ "Left": [
+ "Text"
+ ]
+ },
+ "nullable": [
+ true
+ ]
+ },
+ "hash": "5c5df79936ec65c532c5f0e0aa90a39a772fc7809d4cb52c4e9483771a1922c6"
+}
diff --git a/.sqlx/query-e27d39c398b1710d5ccc81e7e17c23418e701af3fb3eaa1c2faf53d0d51af889.json b/.sqlx/query-e27d39c398b1710d5ccc81e7e17c23418e701af3fb3eaa1c2faf53d0d51af889.json
new file mode 100644
index 0000000000..4a38c85d69
--- /dev/null
+++ b/.sqlx/query-e27d39c398b1710d5ccc81e7e17c23418e701af3fb3eaa1c2faf53d0d51af889.json
@@ -0,0 +1,12 @@
+{
+ "db_name": "PostgreSQL",
+ "query": "UPDATE \"Document\" SET \"fileType\" = 'spreadsheet' WHERE id = 'message-doc-a'",
+ "describe": {
+ "columns": [],
+ "parameters": {
+ "Left": []
+ },
+ "nullable": []
+ },
+ "hash": "e27d39c398b1710d5ccc81e7e17c23418e701af3fb3eaa1c2faf53d0d51af889"
+}
diff --git a/apps/web/src/components/app/split-layout/tests/app-route-search.test.ts b/apps/web/src/components/app/split-layout/tests/app-route-search.test.ts
index b6c37b8208..ad183d92bd 100644
--- a/apps/web/src/components/app/split-layout/tests/app-route-search.test.ts
+++ b/apps/web/src/components/app/split-layout/tests/app-route-search.test.ts
@@ -35,6 +35,16 @@ function roundTrip(pathname: string, search: string, committed: boolean) {
}
describe('application route search ownership', () => {
+ it.each([
+ '/drive/spreadsheet/sheet-1',
+ '/drive/folder/folder-1/spreadsheet/sheet-1',
+ '/drive/recent/spreadsheet/sheet-1',
+ ])('preserves spreadsheet comment targets on %s', (pathname) => {
+ expect(roundTrip(pathname, 'comment_id=message-1', false)).toContain(
+ 'comment_id=message-1'
+ );
+ });
+
it.each([
['/agents/session-1', 'the agents workspace'],
['/coders/session-1', 'a coding session'],
@@ -66,6 +76,18 @@ const projectId = '019507e8-14a3-7bc1-8610-419f16bd03a9';
const resolveMention = createMacroMentionLinkResolver(routes);
describe('application route mentions', () => {
+ it('preserves spreadsheet comment targets in Drive links', () => {
+ expect(
+ resolveMention(
+ `https://dev.macro.com/app/drive/spreadsheet/${mentionId}?comment_id=message-1`
+ )
+ ).toEqual({
+ id: mentionId,
+ block: 'spreadsheet',
+ params: { comment_id: 'message-1' },
+ });
+ });
+
it('preserves task comment targets in both task contexts', () => {
for (const path of [
`tasks/${mentionId}`,
diff --git a/apps/web/src/features/block-md/component/DocumentDiscussion.test.tsx b/apps/web/src/features/block-md/component/DocumentDiscussion.test.tsx
index f920000b32..cd095234ab 100644
--- a/apps/web/src/features/block-md/component/DocumentDiscussion.test.tsx
+++ b/apps/web/src/features/block-md/component/DocumentDiscussion.test.tsx
@@ -22,6 +22,10 @@ vi.mock('@core/signal/permissions', () => ({
vi.mock('@core/component/ParamsProvider', () => ({
useUrlParams: () => ({ commentId: () => null }),
}));
+vi.mock('@queries/messages/document-messages', () => ({
+ useMessageLink: vi.fn(),
+ useMessageRootsQuery: vi.fn(),
+}));
vi.mock('../comments/documentDiscussionSource', () => ({
createDocumentDiscussionSource: () => ({
canEdit: () => true,
diff --git a/apps/web/src/features/block-md/component/DocumentDiscussion.tsx b/apps/web/src/features/block-md/component/DocumentDiscussion.tsx
index eed09ca87b..29bccde406 100644
--- a/apps/web/src/features/block-md/component/DocumentDiscussion.tsx
+++ b/apps/web/src/features/block-md/component/DocumentDiscussion.tsx
@@ -6,13 +6,19 @@ import {
DiscussionProvider,
} from '@core/comments/discussion';
import { StaticMarkdownContext } from '@core/component/LexicalMarkdown/component/core/StaticMarkdown';
+import { useUrlParams } from '@core/component/ParamsProvider';
import {
enableUnifiedDocumentDiscussions,
isFeatureEnabled,
} from '@core/constant/featureFlags';
+import { COMMENT_LINK_PARAM } from '@core/messages/comment-link';
import { EntityDiscussion } from '@core/messages/EntityDiscussion';
import { isTouchDevice } from '@core/mobile/isTouchDevice';
import { virtualKeyboardVisible } from '@core/mobile/virtualKeyboard';
+import {
+ useMessageLink,
+ useMessageRootsQuery,
+} from '@queries/messages/document-messages';
import { Show } from 'solid-js';
import { createDocumentDiscussionSource } from '../comments/documentDiscussionSource';
import { useMarkdownDocument } from '../context/markdown-document-context';
@@ -44,9 +50,20 @@ export function MessageDocumentDiscussion(props: {
const id = documentId();
const documentKind = kind();
const blockName = documentKind === 'document' ? 'md' : documentKind;
+ const parent = () => ({ type: 'document' as const, id });
+ const params = useUrlParams({ commentId: COMMENT_LINK_PARAM });
+ const target = useMessageLink(parent, params.commentId);
+ const roots = useMessageRootsQuery(parent);
+ const discussionTarget = () =>
+ roots.isSuccess &&
+ roots.data.find((thread) => thread.id === target.rootId())?.state.anchor ===
+ null
+ ? target.messageId()
+ : null;
return (
<EntityDiscussion
- parent={{ type: 'document', id }}
+ parent={parent()}
+ targetId={discussionTarget()}
canWrite={permissions.canComment()}
link={{ type: blockName, id }}
label={props.label}
diff --git a/apps/web/src/features/block-md/component/MessageDocumentDiscussion.test.tsx b/apps/web/src/features/block-md/component/MessageDocumentDiscussion.test.tsx
index 4eacff2ec0..197292663b 100644
--- a/apps/web/src/features/block-md/component/MessageDocumentDiscussion.test.tsx
+++ b/apps/web/src/features/block-md/component/MessageDocumentDiscussion.test.tsx
@@ -1,6 +1,7 @@
import { FloatRegion } from '@components/app/mobile/float-regions/FloatRegion';
import { FloatRegions } from '@components/app/mobile/float-regions/float-region-state';
import { setVirtualKeyboardVisible } from '@core/mobile/virtualKeyboard';
+import type { MessageListItem } from '@service-storage/messages';
import { cleanup, render, screen } from '@solidjs/testing-library';
import {
batch,
@@ -19,6 +20,7 @@ const mocks = vi.hoisted(() => ({
commentId: (): string | null => null,
navigationCount: (): number => 0,
renderedMessageIds: (): string[] => [],
+ anchor: null as MessageListItem['state']['anchor'],
}));
vi.mock('@core/constant/featureFlags', async (importOriginal) => ({
@@ -46,6 +48,7 @@ vi.mock('@core/messages/EntityConversation', () => ({
buildLink: (message: { id: string }) => string;
hideComposer?: boolean;
hideWhenEmpty?: boolean;
+ targetId?: string | null;
targetCleared?: boolean;
onClearTarget?: () => void;
}) => {
@@ -66,6 +69,16 @@ vi.mock('@core/component/ParamsProvider', () => ({
useUrlParams: () => ({ commentId: () => mocks.commentId() }),
useParamNavigationCount: () => () => mocks.navigationCount(),
}));
+vi.mock('@queries/messages/document-messages', () => ({
+ useMessageLink: (_parent: unknown, target: () => string | null) => ({
+ messageId: target,
+ rootId: () => (target() ? 'root' : null),
+ }),
+ useMessageRootsQuery: () => ({
+ isSuccess: true,
+ data: [{ id: 'root', state: { anchor: mocks.anchor } }],
+ }),
+}));
vi.mock('@channel/Input/ChannelInputContainer', () => ({
ChannelInputContainer: (props: ParentProps) => props.children,
}));
@@ -91,6 +104,7 @@ afterEach(() => {
cleanup();
setVirtualKeyboardVisible(false);
vi.clearAllMocks();
+ mocks.anchor = null;
});
function setup() {
@@ -194,6 +208,27 @@ describe('scrolling to a linked Discussion message', () => {
expect(scrolledIds()).toEqual(['m2']);
});
+ it('leaves margin comment links to the margin without targeting Discussion', async () => {
+ mocks.anchor = { type: 'markdown', mark_id: 'mark' };
+ setCommentId('margin-reply');
+ setRenderedMessageIds(['margin-reply']);
+ setup();
+ await flushMutations();
+ expect(mocks.conversation).toHaveBeenCalledWith(
+ expect.objectContaining({ targetId: null })
+ );
+ expect(scrolledIds()).toEqual([]);
+ expect(commentId()).toBe('margin-reply');
+ });
+
+ it('passes unanchored links to Discussion after resolving their root', () => {
+ setCommentId('discussion-reply');
+ setup();
+ expect(mocks.conversation).toHaveBeenCalledWith(
+ expect.objectContaining({ targetId: 'discussion-reply' })
+ );
+ });
+
it('scrolls again when a later navigation targets another message', async () => {
setRenderedMessageIds(['m1', 'm2']);
setup();
diff --git a/apps/web/src/features/block-spreadsheet/SpreadsheetBlock.tsx b/apps/web/src/features/block-spreadsheet/SpreadsheetBlock.tsx
index 3c33712bc9..2ea9664eb6 100644
--- a/apps/web/src/features/block-spreadsheet/SpreadsheetBlock.tsx
+++ b/apps/web/src/features/block-spreadsheet/SpreadsheetBlock.tsx
@@ -12,6 +12,10 @@ import { BlockItemSplitLabel } from '@components/app/split-layout/components/Spl
import { useBlockId } from '@core/block';
import { DocumentBlockContainer } from '@core/component/DocumentBlockContainer';
import { BlockLiveIndicators } from '@core/component/LiveIndicators';
+import {
+ createParamsState,
+ ParamsProvider,
+} from '@core/component/ParamsProvider';
import {
getShareDrawerRecipientInput,
ShareTrigger,
@@ -20,7 +24,8 @@ import { useShareModal } from '@core/component/TopBar/shareModal';
import { useUserId } from '@core/context/user';
import { blockDataSignal } from '@core/internal/BlockLoader';
import { isMobile } from '@core/mobile/isMobile';
-import { blockMetadataSignal } from '@core/signal/load';
+import { createMethodRegistration } from '@core/orchestrator';
+import { blockHandleSignal, blockMetadataSignal } from '@core/signal/load';
import { useCanEdit, useGetPermissions } from '@core/signal/permissions';
import { getDisplayName, tryMacroId } from '@core/user';
import { useBlockDocumentName } from '@core/util/currentBlockDocumentName';
@@ -39,17 +44,23 @@ import { SpreadsheetEditor } from './views/SpreadsheetEditor';
export default function SpreadsheetBlock(props: { share?: string }) {
const enabled = useSpreadsheetAccess();
+ const params = createParamsState();
+ createMethodRegistration(blockHandleSignal.get, {
+ goToLocationFromParams: params.navigate,
+ });
return (
- <Show
- when={enabled()}
- fallback={
- <div class="p-6 text-ink-muted">
- Spreadsheets are not enabled for this account.
- </div>
- }
- >
- <SpreadsheetBlockContent share={props.share} />
- </Show>
+ <ParamsProvider state={params}>
+ <Show
+ when={enabled()}
+ fallback={
+ <div class="p-6 text-ink-muted">
+ Spreadsheets are not enabled for this account.
+ </div>
+ }
+ >
+ <SpreadsheetBlockContent share={props.share} />
+ </Show>
+ </ParamsProvider>
);
}
diff --git a/apps/web/src/features/block-spreadsheet/SpreadsheetComments.test.tsx b/apps/web/src/features/block-spreadsheet/SpreadsheetComments.test.tsx
index 8915f46885..766b9425f5 100644
--- a/apps/web/src/features/block-spreadsheet/SpreadsheetComments.test.tsx
+++ b/apps/web/src/features/block-spreadsheet/SpreadsheetComments.test.tsx
@@ -1,4 +1,9 @@
-import type { CommentThread } from '@service-storage/generated/schemas/commentThread';
+import type { InputHandle, InputSnapshot } from '@channel/Input';
+import {
+ createParamsState,
+ ParamsProvider,
+} from '@core/component/ParamsProvider';
+import type { MessageListItem } from '@service-storage/messages';
import {
cleanup,
fireEvent,
@@ -6,17 +11,20 @@ import {
screen,
waitFor,
} from '@solidjs/testing-library';
-import { createSignal, For, type JSX, type ParentProps } from 'solid-js';
+import { createSignal, type JSX, type ParentProps } from 'solid-js';
import { afterEach, beforeEach, expect, it, vi } from 'vitest';
import type { SpreadsheetCommentsCapability } from './context/spreadsheet-comments';
import type { SpreadsheetStore } from './primitives/create-spreadsheet-store';
const mocks = vi.hoisted(() => ({
- api: { create: vi.fn(), edit: vi.fn(), delete: vi.fn() },
- refresh: vi.fn(async () => {}),
- data: [] as CommentThread[],
+ send: vi.fn(),
+ patch: vi.fn(),
+ discussion: vi.fn(),
+ data: [] as MessageListItem[],
+ rootId: undefined as string | undefined,
target: undefined as string | undefined,
canComment: true,
+ scroll: vi.fn(() => () => {}),
}));
vi.mock('@components/app/split-layout/components/SplitHeader', () => ({
SplitHeaderRight: (p: ParentProps) => p.children,
@@ -31,8 +39,14 @@ vi.mock(
'@core/component/LexicalMarkdown/component/core/StaticMarkdown',
() => ({ StaticMarkdownContext: (p: ParentProps) => p.children })
);
-vi.mock('@core/component/ParamsProvider', () => ({
- useUrlParams: () => ({ commentId: () => mocks.target }),
+vi.mock('@solidjs/router', () => ({
+ useSearchParams: () => [
+ {
+ get comment_id() {
+ return mocks.target;
+ },
+ },
+ ],
}));
vi.mock('@core/context/user', () => ({ useUserId: () => () => 'me' }));
vi.mock('@core/signal/permissions', () => ({
@@ -42,64 +56,98 @@ vi.mock('@core/util/url', () => ({ buildSimpleEntityUrl: () => 'link' }));
vi.mock('@ui/components/Button', () => ({
Button: (p: JSX.ButtonHTMLAttributes<HTMLButtonElement>) => <button {...p} />,
}));
-vi.mock('./queries/spreadsheet-comments', () => ({
- useSpreadsheetComments: () => ({
- query: { isSuccess: true, data: mocks.data },
- api: mocks.api,
- refresh: mocks.refresh,
+vi.mock('@queries/messages/document-messages', () => ({
+ useMessageRootsQuery: () => ({ isSuccess: true, data: mocks.data }),
+ useMessageLink: (_parent: unknown, target: () => string | undefined) => ({
+ rootId: () => (target() ? mocks.rootId : undefined),
+ messageId: target,
}),
}));
-vi.mock('@core/comments/discussion', async () => {
- const { DiscussionProvider, useDiscussion } = await import(
- '@core/comments/discussion/context'
- );
- return {
- DiscussionProvider,
- Discussion: () => <div>Thread list</div>,
- DiscussionComposer: () => {
- const source = useDiscussion();
- const [text, setText] = createSignal('');
- return (
- <>
- <input
- aria-label="Comment draft"
- value={text()}
- onInput={(e) => setText(e.currentTarget.value)}
- />
- <button onClick={() => source.createThread(text(), [])}>Post</button>
- </>
- );
- },
- DiscussionThreadView: (p: {
- thread: { id: string; comments: { text: string }[] };
- }) => {
- const source = useDiscussion();
- return (
- <>
- <For each={p.thread.comments}>{(c) => <p>{c.text}</p>}</For>
- <button
- onClick={() =>
- source.createReply(p.thread.id, 'Reply from card', [])
+vi.mock('@queries/messages/mutations', () => ({
+ newMessageId: () => 'new-id',
+ useSendMessageMutation: () => ({ mutateAsync: mocks.send }),
+ usePatchThreadMutation: () => ({ mutate: mocks.patch }),
+}));
+vi.mock('@core/messages/scroll-to-rendered-target', () => ({
+ scrollToRenderedTarget: mocks.scroll,
+}));
+vi.mock('@core/messages/EntityDiscussion', () => ({
+ EntityDiscussion: (props: {
+ parent: unknown;
+ canWrite: boolean;
+ targetId: string | null;
+ label: string;
+ }) => {
+ mocks.discussion(props);
+ return <section>{props.label}</section>;
+ },
+}));
+vi.mock('@channel/Input', () => ({
+ ChannelInput: (props: {
+ onSend: (snapshot: InputSnapshot) => Promise<void>;
+ onReady: (handle: Pick<InputHandle, 'clear'>) => void;
+ }) => {
+ const [text, setText] = createSignal('');
+ const [error, setError] = createSignal('');
+ props.onReady({
+ clear: () => {
+ setText('');
+ },
+ });
+ return (
+ <>
+ <input
+ aria-label="Comment draft"
+ value={text()}
+ onInput={(e) => setText(e.currentTarget.value)}
+ />
+ <button
+ onClick={async () => {
+ try {
+ await props.onSend({
+ value: text(),
+ attachments: [],
+ mentions: [],
+ });
+ } catch {
+ setError('Failed to post');
}
- >
- Reply
- </button>
- </>
- );
- },
- };
-});
+ }}
+ >
+ Post
+ </button>
+ <span>{error()}</span>
+ </>
+ );
+ },
+}));
+vi.mock('@channel/Input/message-payload', () => ({
+ buildPostMessageSendPayload: ({ snapshot }: { snapshot: InputSnapshot }) => ({
+ message: { content: snapshot.value, mentions: [], attachments: [] },
+ optimisticAttachments: [],
+ }),
+}));
+vi.mock('@core/messages/MessageThread', () => ({
+ MessageThread: (props: {
+ data: MessageListItem;
+ targetId: string | null;
+ }) => <article data-target={props.targetId}>{props.data.content}</article>,
+}));
import { SpreadsheetComments } from './SpreadsheetComments';
const anchor = { sheetId: 'sheet1', sheetName: 'Budget', range: 'B4:C5' };
let cap: SpreadsheetCommentsCapability;
let active!: (id: string) => void;
+let navigateAgain!: () => void;
let selection = { anchor: 'B4', focus: 'C5' };
function mount() {
return render(() => {
const [id, setId] = createSignal('sheet1');
active = setId;
+ const params = createParamsState();
+ navigateAgain = () =>
+ params.navigate(mocks.target ? { comment_id: mocks.target } : {});
const sheets = [
{ id: 'sheet1', name: 'Budget', layout: { rowCount: 200 }, cells: {} },
];
@@ -111,44 +159,55 @@ function mount() {
selection: () => selection,
} as unknown as SpreadsheetStore;
return (
- <SpreadsheetComments documentId="doc" store={store}>
- {(location, comments) => {
- cap = comments;
- let cell!: HTMLButtonElement;
- return (
- <>
- <button
- ref={cell}
- onMouseEnter={() => comments.enter('B4', cell)}
- onMouseLeave={comments.leave}
- >
- B4
- </button>
- <button onClick={() => comments.add(cell)}>Comment</button>
- <output>{location()?.range}</output>
- </>
- );
- }}
- </SpreadsheetComments>
+ <ParamsProvider state={params}>
+ <SpreadsheetComments documentId="doc" store={store}>
+ {(location, comments) => {
+ cap = comments;
+ let cell!: HTMLButtonElement;
+ return (
+ <>
+ <button
+ ref={cell}
+ onMouseEnter={() => comments.enter('B4', cell)}
+ onMouseLeave={comments.leave}
+ >
+ B4
+ </button>
+ <button onClick={() => comments.add(cell)}>Comment</button>
+ <output>{location()?.range}</output>
+ </>
+ );
+ }}
+ </SpreadsheetComments>
+ </ParamsProvider>
);
});
}
beforeEach(() => {
mocks.data = [
{
- thread: {
- threadId: 7,
- documentId: 'doc',
- owner: 'me',
+ id: 'root-id',
+ parent: { type: 'document', id: 'doc' },
+ sender_id: 'me',
+ content: 'Check assumptions',
+ mentions: [],
+ attachments: [],
+ reactions: [],
+ created_at: '',
+ updated_at: '',
+ state: {
+ root_id: 'root-id',
+ user_id: 'me',
resolved: false,
- metadata: { spreadsheet: anchor },
+ anchor: { type: 'spreadsheet', ...anchor },
+ created_at: '',
+ updated_at: '',
},
- comments: [
- { commentId: 42, threadId: 7, owner: 'me', text: 'Check assumptions' },
- ],
+ thread: { reply_count: 0, preview: [], latest_reply_at: null },
},
];
- mocks.api.create.mockResolvedValue({ thread: { threadId: 8 }, comments: [] });
+ mocks.send.mockResolvedValue({ id: 'new-id' });
+ mocks.rootId = 'root-id';
mocks.target = undefined;
mocks.canComment = true;
selection = { anchor: 'B4', focus: 'C5' };
@@ -170,14 +229,17 @@ it('offers a cell-anchored composer and freezes the range even if the grid selec
});
fireEvent.click(screen.getByRole('button', { name: 'Post' }));
await waitFor(() =>
- expect(mocks.api.create).toHaveBeenCalledWith(
+ expect(mocks.send).toHaveBeenCalledWith(
expect.objectContaining({
- threadMetadata: expect.objectContaining({ spreadsheet: anchor }),
+ parent: { type: 'document', id: 'doc' },
+ message: expect.objectContaining({
+ anchor: { type: 'spreadsheet', ...anchor },
+ }),
})
)
);
});
-it('shows existing comments on hover, replies in place, and pins the card when interacted with', async () => {
+it('shows shared threads on hover, resolves them, and pins the card when interacted with', async () => {
mount();
expect(cap.hasComment('B4')).toBe(true);
expect(cap.hasComment('C5')).toBe(false);
@@ -189,14 +251,12 @@ it('shows existing comments on hover, replies in place, and pins the card when i
fireEvent.mouseLeave(screen.getByRole('button', { name: 'B4' }));
await new Promise((resolve) => setTimeout(resolve, 400));
expect(screen.getByRole('dialog')).toBeTruthy();
- fireEvent.click(screen.getByRole('button', { name: 'Reply' }));
- await waitFor(() =>
- expect(mocks.api.create).toHaveBeenCalledWith({
- text: 'Reply from card',
- threadId: 7,
- mentions: undefined,
- })
- );
+ fireEvent.click(screen.getByRole('button', { name: 'Resolve' }));
+ expect(mocks.patch).toHaveBeenCalledWith({
+ parent: { type: 'document', id: 'doc' },
+ rootId: 'root-id',
+ patch: { resolved: true },
+ });
expect(screen.queryByRole('complementary')).toBeNull();
active('sheet2');
await waitFor(() => expect(screen.queryByRole('dialog')).toBeNull());
@@ -214,15 +274,17 @@ it('dismisses unpinned previews and supports clicking a marker for touch/keyboar
expect(screen.queryByRole('dialog')).toBeNull();
});
it('opens notification targets at the linked range and keeps deleted-sheet threads accessible', async () => {
- mocks.target = '42';
+ mocks.target = 'reply-id';
mount();
expect(
screen.getByRole('complementary', { name: 'Spreadsheet comments' })
).toBeTruthy();
expect(screen.getByRole('status').textContent).toBe('B4:C5');
cleanup();
- mocks.data[0].thread.metadata = {
- spreadsheet: { ...anchor, sheetId: 'deleted' },
+ mocks.data[0].state.anchor = {
+ type: 'spreadsheet',
+ ...anchor,
+ sheetId: 'deleted',
};
mount();
expect(
@@ -245,10 +307,12 @@ it('keeps sidebar and floating composer attachments independent', async () => {
)!
);
await waitFor(() =>
- expect(mocks.api.create).toHaveBeenCalledWith(
+ expect(mocks.send).toHaveBeenCalledWith(
expect.objectContaining({
- text: 'Sidebar draft',
- threadMetadata: expect.objectContaining({ spreadsheet: anchor }),
+ parent: { type: 'document', id: 'doc' },
+ message: expect.objectContaining({
+ anchor: { type: 'spreadsheet', ...anchor },
+ }),
})
)
);
@@ -257,3 +321,181 @@ it('keeps sidebar and floating composer attachments independent', async () => {
);
expect(screen.getByRole('dialog').querySelector('input')).toBeTruthy();
});
+
+it('mounts a workbook discussion on the document parent without legacy comment links', () => {
+ mount();
+ fireEvent.click(screen.getByRole('button', { name: 'Comments' }));
+ expect(mocks.discussion).toHaveBeenCalledWith(
+ expect.objectContaining({
+ parent: { type: 'document', id: 'doc' },
+ canWrite: true,
+ targetId: null,
+ })
+ );
+ expect(screen.getByText('Workbook discussion')).toBeTruthy();
+});
+
+it.each(['root-id', 'reply-id'])(
+ 'keeps a range link (%s) out of the workbook discussion',
+ (target) => {
+ mocks.target = target;
+ mount();
+ expect(mocks.discussion).toHaveBeenCalledWith(
+ expect.objectContaining({ targetId: null })
+ );
+ expect(screen.getByRole('status').textContent).toBe('B4:C5');
+ expect(document.querySelector(`[data-target="${target}"]`)).toBeTruthy();
+ }
+);
+
+it.each(['root-id', 'reply-id'])(
+ 'passes a workbook link (%s) to the workbook discussion',
+ (target) => {
+ mocks.target = target;
+ mocks.data[0].state.anchor = null;
+ mount();
+ expect(mocks.discussion).toHaveBeenCalledWith(
+ expect.objectContaining({ targetId: target })
+ );
+ expect(screen.getByRole('status').textContent).toBe('');
+ }
+);
+
+it('clears a previous range highlight for a workbook link and preserves the draft range', async () => {
+ mocks.data.push({
+ ...mocks.data[0],
+ id: 'workbook-root',
+ state: { ...mocks.data[0].state, root_id: 'workbook-root', anchor: null },
+ });
+ mocks.target = 'reply-id';
+ mount();
+ const input = screen.getByRole('textbox') as HTMLInputElement;
+ fireEvent.input(input, { target: { value: 'Range draft' } });
+ selection = { anchor: 'D9', focus: 'D9' };
+
+ mocks.target = 'workbook-reply';
+ mocks.rootId = 'workbook-root';
+ navigateAgain();
+
+ expect(screen.getByRole('status').textContent).toBe('');
+ expect(mocks.discussion).toHaveBeenCalledWith(
+ expect.objectContaining({ targetId: 'workbook-reply' })
+ );
+ expect(screen.getByRole('textbox')).toBe(input);
+ expect(input.value).toBe('Range draft');
+ fireEvent.click(screen.getByRole('button', { name: 'Post' }));
+ await waitFor(() =>
+ expect(mocks.send).toHaveBeenCalledWith(
+ expect.objectContaining({
+ message: expect.objectContaining({
+ content: 'Range draft',
+ anchor: { type: 'spreadsheet', ...anchor },
+ }),
+ })
+ )
+ );
+});
+
+it('clears a previous range navigation error when opening a workbook link', () => {
+ mocks.data.push({
+ ...mocks.data[0],
+ id: 'workbook-root',
+ state: { ...mocks.data[0].state, root_id: 'workbook-root', anchor: null },
+ });
+ mocks.data[0].state.anchor = {
+ type: 'spreadsheet',
+ ...anchor,
+ sheetId: 'deleted',
+ };
+ mocks.target = 'reply-id';
+ mount();
+ expect(
+ screen.getByText('This comment refers to a sheet that has been deleted.')
+ ).toBeTruthy();
+
+ mocks.target = 'workbook-reply';
+ mocks.rootId = 'workbook-root';
+ navigateAgain();
+
+ expect(
+ screen.queryByText('This comment refers to a sheet that has been deleted.')
+ ).toBeNull();
+ expect(mocks.discussion).toHaveBeenCalledWith(
+ expect.objectContaining({ targetId: 'workbook-reply' })
+ );
+});
+
+it('leaves the workbook discussion untargeted until the root anchor is known', () => {
+ mocks.target = 'reply-id';
+ mocks.data[0].state.anchor = undefined;
+ mount();
+ expect(mocks.discussion).toHaveBeenCalledWith(
+ expect.objectContaining({ targetId: null })
+ );
+});
+
+it('keeps failed range drafts and hides posting controls from viewers', async () => {
+ mocks.send.mockRejectedValueOnce(new Error('offline'));
+ mount();
+ fireEvent.click(screen.getByRole('button', { name: 'Comment' }));
+ const input = screen.getByRole('textbox') as HTMLInputElement;
+ fireEvent.input(input, { target: { value: 'Keep this draft' } });
+ fireEvent.click(screen.getByRole('button', { name: 'Post' }));
+ await waitFor(() => expect(screen.getByText('Failed to post')).toBeTruthy());
+ expect(input.value).toBe('Keep this draft');
+ cleanup();
+ mocks.canComment = false;
+ mount();
+ fireEvent.click(screen.getByRole('button', { name: 'Comments' }));
+ expect(screen.queryByRole('textbox')).toBeNull();
+ expect(screen.queryByRole('button', { name: 'Resolve' })).toBeNull();
+ expect(mocks.discussion).toHaveBeenLastCalledWith(
+ expect.objectContaining({ canWrite: false })
+ );
+});
+
+it('does not navigate to legacy numeric comments or mark deleted threads', () => {
+ mocks.target = '42';
+ mocks.data[0].state.deleted_at = '2026-09-28T00:00:00Z';
+ mount();
+ expect(screen.queryByRole('complementary')).toBeNull();
+ expect(cap.hasComment('B4')).toBe(false);
+ fireEvent.click(screen.getByRole('button', { name: 'Comments' }));
+ expect(mocks.discussion).toHaveBeenCalledWith(
+ expect.objectContaining({ targetId: null })
+ );
+});
+
+it('scrolls and highlights a linked reply again when the notification is reopened', async () => {
+ mocks.target = 'reply-id';
+ mount();
+ await waitFor(() =>
+ expect(mocks.scroll).toHaveBeenCalledWith(
+ expect.any(HTMLElement),
+ 'reply-id'
+ )
+ );
+ const calls = mocks.scroll.mock.calls.length;
+ navigateAgain();
+ await waitFor(() =>
+ expect(mocks.scroll.mock.calls.length).toBeGreaterThan(calls)
+ );
+ expect(document.querySelector('[data-target="reply-id"]')).toBeTruthy();
+});
+
+it('keeps out-of-grid range threads readable without rendering an invalid marker', () => {
+ mocks.target = 'reply-id';
+ mocks.data[0].state.anchor = {
+ type: 'spreadsheet',
+ ...anchor,
+ range: 'AA1:AB2',
+ };
+ mount();
+ expect(screen.getByText('Check assumptions')).toBeTruthy();
+ expect(
+ screen.getByText(
+ 'The cells referenced by this comment are no longer available.'
+ )
+ ).toBeTruthy();
+ expect(cap.hasComment('A1')).toBe(false);
+});
diff --git a/apps/web/src/features/block-spreadsheet/SpreadsheetComments.tsx b/apps/web/src/features/block-spreadsheet/SpreadsheetComments.tsx
index 6e1c068e79..cda087fb5a 100644
--- a/apps/web/src/features/block-spreadsheet/SpreadsheetComments.tsx
+++ b/apps/web/src/features/block-spreadsheet/SpreadsheetComments.tsx
@@ -1,25 +1,39 @@
+import type { InputSnapshot } from '@channel/Input';
+import { buildPostMessageSendPayload } from '@channel/Input/message-payload';
import { SplitHeaderRight } from '@components/app/split-layout/components/SplitHeader';
-import {
- Discussion,
- DiscussionComposer,
- DiscussionProvider,
-} from '@core/comments/discussion';
import { StaticMarkdownContext } from '@core/component/LexicalMarkdown/component/core/StaticMarkdown';
-import { useUrlParams } from '@core/component/ParamsProvider';
+import {
+ useParamNavigationCount,
+ useUrlParams,
+} from '@core/component/ParamsProvider';
import { useUserId } from '@core/context/user';
+import { EntityDiscussion } from '@core/messages/EntityDiscussion';
+import { scrollToRenderedTarget } from '@core/messages/scroll-to-rendered-target';
import { useCanComment } from '@core/signal/permissions';
import { buildSimpleEntityUrl } from '@core/util/url';
import ChatIcon from '@phosphor/chat-circle.svg';
import XIcon from '@phosphor/x.svg';
+import {
+ useMessageLink,
+ useMessageRootsQuery,
+} from '@queries/messages/document-messages';
+import {
+ newMessageId,
+ usePatchThreadMutation,
+ useSendMessageMutation,
+} from '@queries/messages/mutations';
+import type { MessageListItem } from '@service-storage/messages';
import { Button } from '@ui/components/Button';
import {
createEffect,
createMemo,
createSignal,
+ For,
type JSX,
on,
onCleanup,
Show,
+ Suspense,
} from 'solid-js';
import { SpreadsheetCommentCard } from './components/SpreadsheetCommentCard';
import type { SpreadsheetCommentsCapability } from './context/spreadsheet-comments';
@@ -34,11 +48,11 @@ import {
type SpreadsheetCommentAnchor,
spreadsheetCommentAnchor,
} from './core/spreadsheet-comments';
-import { createSpreadsheetDiscussion } from './primitives/create-spreadsheet-discussion';
import type { SpreadsheetStore } from './primitives/create-spreadsheet-store';
-import { useSpreadsheetComments } from './queries/spreadsheet-comments';
+import { SpreadsheetCommentComposer } from './views/SpreadsheetCommentComposer';
+import { SpreadsheetCommentThread } from './views/SpreadsheetCommentThread';
-/** Production wiring: shared discussions + the document annotation service. */
+/** Production wiring for spreadsheet discussions on the shared message store. */
export function SpreadsheetComments(props: {
documentId: string;
store: SpreadsheetStore;
@@ -50,16 +64,30 @@ export function SpreadsheetComments(props: {
const userId = useUserId();
const canComment = useCanComment();
const params = useUrlParams(SPREADSHEET_COMMENT_PARAMS);
- const { query, api, refresh } = useSpreadsheetComments(props.documentId);
+ const parent = () => ({ type: 'document' as const, id: props.documentId });
+ const query = useMessageRootsQuery(parent);
+ const send = useSendMessageMutation();
+ const patchThread = usePatchThreadMutation();
+ const linkedMessageId = () =>
+ /^\d+$/.test(params.commentId() ?? '') ? undefined : params.commentId();
+ const target = useMessageLink(parent, linkedMessageId);
+ const navigationCount = useParamNavigationCount('comment_id');
const [open, setOpen] = createSignal(false);
const [anchor, setAnchor] = createSignal<SpreadsheetCommentAnchor>();
const [location, setLocation] = createSignal<SpreadsheetCommentAnchor>();
const [error, setError] = createSignal('');
const threads = () => (query.isSuccess ? query.data : []);
- const request = createMemo(() => ({ id: params.commentId() }), undefined, {
- equals: false,
- });
- const target = () => request().id ?? null;
+ const discussionTarget = () =>
+ threads().find((thread) => thread.id === target.rootId())?.state.anchor ===
+ null
+ ? target.messageId()
+ : null;
+ const request = createMemo(() => ({
+ id: linkedMessageId(),
+ revision: navigationCount(),
+ }));
+ const [clearedTarget, setClearedTarget] =
+ createSignal<ReturnType<typeof request>>();
const [card, setCard] = createSignal<{
element: HTMLElement;
anchor: SpreadsheetCommentAnchor;
@@ -77,49 +105,58 @@ export function SpreadsheetComments(props: {
setCard(undefined);
};
onCleanup(clearHover);
- const makeSource = (
- getAnchor: () => SpreadsheetCommentAnchor | undefined,
- operations = api
- ) =>
- createSpreadsheetDiscussion({
- threads,
- canComment,
- userId,
- anchor: getAnchor,
- targetCommentId: target,
- targetRevision: request,
- api: operations,
- refresh,
- buildLink: (id) =>
- buildSimpleEntityUrl(
- { type: 'spreadsheet', id: props.documentId },
- { comment_id: id }
- ),
+ const post = async (
+ value: SpreadsheetCommentAnchor,
+ snapshot: InputSnapshot
+ ) => {
+ const senderId = userId();
+ if (!senderId || !canComment())
+ throw new Error('Sign in with comment access to post');
+ const payload = buildPostMessageSendPayload({ snapshot });
+ return send.mutateAsync({
+ parent: parent(),
+ senderId,
+ optimisticId: newMessageId(),
+ ...payload,
+ message: {
+ ...payload.message,
+ anchor: { type: 'spreadsheet', ...value },
+ },
});
- const source = makeSource(anchor);
- const cardSource = makeSource(() => card()?.anchor, {
- ...api,
- create: async (body) => {
- const postingCard = card();
- const result = await api.create(body);
- if (!body.threadId && postingCard?.creating && card() === postingCard) {
- setCard({
- ...postingCard,
- creating: false,
- threadIds: [String(result.thread.threadId)],
- });
- }
- return result;
- },
- });
+ };
const count = () =>
- source
- .threads()
+ threads()
+ .filter((thread) => !thread.state.deleted_at)
.reduce(
(sum, thread) =>
- sum + thread.comments.filter((comment) => !comment.deletedAt).length,
+ sum + (thread.deleted_at ? 0 : 1) + thread.thread.reply_count,
0
);
+ const renderThread = (thread: () => MessageListItem) => (
+ <SpreadsheetCommentThread
+ data={thread()}
+ canWrite={canComment()}
+ targetId={
+ target.rootId() === thread().id && clearedTarget() !== request()
+ ? target.messageId()
+ : null
+ }
+ onClearTarget={() => setClearedTarget(request())}
+ buildLink={(message) =>
+ buildSimpleEntityUrl(
+ { type: 'spreadsheet', id: props.documentId },
+ { comment_id: message.id }
+ )
+ }
+ onResolve={(resolved) =>
+ patchThread.mutate({
+ parent: parent(),
+ rootId: thread().id,
+ patch: { resolved },
+ })
+ }
+ />
+ );
const navigate = (value: SpreadsheetCommentAnchor) => {
const sheet = props.store
.workbook()
@@ -128,8 +165,15 @@ export function SpreadsheetComments(props: {
setError('This comment refers to a sheet that has been deleted.');
return;
}
- const last = positionFromAddress(value.range.split(':').at(-1)!);
- if (!last || last.row >= sheet.layout.rowCount) {
+ const [start, end = start] = value.range.split(':');
+ const first = positionFromAddress(start);
+ const last = positionFromAddress(end);
+ if (
+ !first ||
+ !last ||
+ first.row >= sheet.layout.rowCount ||
+ last.row >= sheet.layout.rowCount
+ ) {
setError('The cells referenced by this comment are no longer available.');
return;
}
@@ -155,19 +199,20 @@ export function SpreadsheetComments(props: {
};
const anchoredThreads = createMemo(() =>
threads().flatMap((thread) => {
- const value = spreadsheetCommentAnchor(thread.thread.metadata);
+ const value = spreadsheetCommentAnchor(thread.state.anchor);
if (
!value ||
- thread.thread.deletedAt ||
- !thread.comments.some((comment) => !comment.deletedAt) ||
+ thread.state.deleted_at ||
+ (thread.deleted_at && thread.thread.reply_count === 0) ||
value.sheetId !== props.store.activeSheetId()
)
return [];
const [start, end = start] = value.range.split(':');
- const first = positionFromAddress(start)!;
- const last = positionFromAddress(end)!;
+ const first = positionFromAddress(start);
+ const last = positionFromAddress(end);
+ if (!first || !last) return [];
const bounds = selectionBounds({ anchor: first, focus: last });
- return [{ id: String(thread.thread.threadId), anchor: value, bounds }];
+ return [{ id: thread.id, anchor: value, bounds }];
})
);
const markers = createMemo(
@@ -237,27 +282,54 @@ export function SpreadsheetComments(props: {
};
// Tab changes invalidate the floating DOM anchor.
createEffect(on(props.store.activeSheetId, closeCard, { defer: true }));
+ let panel: HTMLElement | undefined;
+ createEffect(
+ on([request, open, target.messageId], ([value, visible, messageId]) => {
+ if (value.id && visible && messageId && panel) {
+ onCleanup(scrollToRenderedTarget(panel, messageId));
+ }
+ })
+ );
+ let openedRequest: ReturnType<typeof request> | undefined;
+ let navigatedRequest: ReturnType<typeof request> | undefined;
// URL navigation is an external event, including repeated inbox opens of the same comment.
createEffect(
on(
- [request, () => query.isSuccess, props.store.ready],
+ [
+ request,
+ () => query.isSuccess,
+ props.store.ready,
+ target.rootId,
+ threads,
+ ],
([value, loaded, ready]) => {
- if (!value.id) return;
- closeCard();
- setOpen(true);
- if (!loaded || !ready) return;
- const thread = threads().find((thread) =>
- thread.comments.some(
- (comment) => String(comment.commentId) === value.id
- )
+ if (!value.id || navigatedRequest === value) return;
+ if (openedRequest !== value) {
+ openedRequest = value;
+ closeCard();
+ setLocation(undefined);
+ setError('');
+ if (!open()) setAnchor(ready ? currentAnchor() : undefined);
+ setOpen(true);
+ }
+ if (!ready) return;
+ if (!anchor()) setAnchor(currentAnchor());
+ if (!loaded) return;
+ const thread = threads().find(
+ (thread) => thread.id === target.rootId()
);
- const linked = spreadsheetCommentAnchor(thread?.thread.metadata);
- if (linked) navigate(linked);
+ if (!thread) return;
+ navigatedRequest = value;
+ const linked = spreadsheetCommentAnchor(thread.state.anchor);
+ if (linked) {
+ setAnchor(linked);
+ navigate(linked);
+ }
}
)
);
return (
- <DiscussionProvider source={source}>
+ <StaticMarkdownContext>
<SplitHeaderRight>
<Button
size="sm"
@@ -279,6 +351,7 @@ export function SpreadsheetComments(props: {
</div>
<Show when={open()}>
<aside
+ ref={panel}
aria-label="Spreadsheet comments"
class="absolute inset-0 z-30 flex flex-col bg-panel border-l border-edge-muted sm:static sm:w-96 sm:shrink-0"
>
@@ -318,39 +391,55 @@ export function SpreadsheetComments(props: {
No comments yet. Start a discussion about the selected cells.
</p>
</Show>
- <Discussion
- hideComposer
- threadHeader={(thread) => {
- const linked = () =>
- spreadsheetCommentAnchor(
- threads().find(
- (item) => String(item.thread.threadId) === thread.id
- )?.thread.metadata
+ <Suspense
+ fallback={
+ <p class="text-sm text-ink-muted">Loading comments…</p>
+ }
+ >
+ <For
+ each={threads()
+ .filter(
+ (thread) =>
+ !thread.state.deleted_at &&
+ spreadsheetCommentAnchor(thread.state.anchor)
+ )
+ .map((thread) => thread.id)}
+ >
+ {(id) => {
+ const thread = () =>
+ threads().find((item) => item.id === id)!;
+ const linked = () =>
+ spreadsheetCommentAnchor(thread().state.anchor)!;
+ const label = () => {
+ const value = linked();
+ const sheet = props.store
+ .workbook()
+ .find((sheet) => sheet.id === value.sheetId);
+ return `${sheet?.name ?? value.sheetName} · ${value.range}${sheet ? '' : ' (deleted sheet)'}`;
+ };
+ return (
+ <>
+ <button
+ class="mt-3 mb-1 rounded px-2 py-1 text-xs text-accent hover:bg-hover"
+ onClick={() => navigate(linked())}
+ >
+ {label()}
+ </button>
+ {renderThread(thread)}
+ </>
);
- const label = () => {
- const value = linked();
- if (!value) return 'Workbook';
- const sheet = props.store
- .workbook()
- .find((sheet) => sheet.id === value.sheetId);
- return `${sheet?.name ?? value.sheetName} · ${value.range}${sheet ? '' : ' (deleted sheet)'}`;
- };
- return (
- <button
- class="mt-3 mb-1 rounded px-2 py-1 text-xs text-accent hover:bg-hover"
- disabled={!linked()}
- onClick={() => {
- const value = linked();
- if (value) navigate(value);
- }}
- >
- {label()}
- </button>
- );
- }}
- />
+ }}
+ </For>
+ <EntityDiscussion
+ parent={parent()}
+ canWrite={canComment()}
+ link={{ type: 'spreadsheet', id: props.documentId }}
+ targetId={discussionTarget()}
+ label="Workbook discussion"
+ />
+ </Suspense>
</div>
- <Show when={canComment()}>
+ <Show when={canComment() && anchor()}>
<div class="shrink-0 border-t border-edge-muted p-3">
<div class="mb-2 flex items-center justify-between gap-2 text-xs text-ink-muted">
<span>
@@ -363,7 +452,16 @@ export function SpreadsheetComments(props: {
</button>
</div>
<StaticMarkdownContext>
- <DiscussionComposer />
+ <Suspense>
+ <SpreadsheetCommentComposer
+ parent={parent()}
+ onSend={async (snapshot) => {
+ const value = anchor();
+ if (!value) throw new Error('Select cells to comment');
+ await post(value, snapshot);
+ }}
+ />
+ </Suspense>
</StaticMarkdownContext>
</div>
</Show>
@@ -372,14 +470,10 @@ export function SpreadsheetComments(props: {
</div>
<Show when={card()}>
{(value) => (
- <DiscussionProvider source={cardSource}>
+ <Suspense>
<SpreadsheetCommentCard
element={value().element}
label={`${props.store.workbook().find((sheet) => sheet.id === value().anchor.sheetId)?.name ?? value().anchor.sheetName} · ${value().anchor.range}`}
- creating={value().creating}
- threads={source
- .threads()
- .filter((thread) => value().threadIds.includes(thread.id))}
onEnter={clearHover}
onLeave={comments.leave}
onInteract={() => {
@@ -390,10 +484,43 @@ export function SpreadsheetComments(props: {
);
}}
onClose={closeCard}
- />
- </DiscussionProvider>
+ >
+ <For
+ each={threads()
+ .filter(
+ (thread) =>
+ !thread.state.deleted_at &&
+ value().threadIds.includes(thread.id)
+ )
+ .map((thread) => thread.id)}
+ >
+ {(id) =>
+ renderThread(
+ () => threads().find((thread) => thread.id === id)!
+ )
+ }
+ </For>
+ <Show when={value().creating && canComment()}>
+ <SpreadsheetCommentComposer
+ parent={parent()}
+ autofocus
+ onSend={async (snapshot) => {
+ const postingCard = card();
+ if (!postingCard) return;
+ const message = await post(postingCard.anchor, snapshot);
+ if (card() === postingCard)
+ setCard({
+ ...postingCard,
+ creating: false,
+ threadIds: [message.id],
+ });
+ }}
+ />
+ </Show>
+ </SpreadsheetCommentCard>
+ </Suspense>
)}
</Show>
- </DiscussionProvider>
+ </StaticMarkdownContext>
);
}
diff --git a/apps/web/src/features/block-spreadsheet/components/SpreadsheetCommentCard.tsx b/apps/web/src/features/block-spreadsheet/components/SpreadsheetCommentCard.tsx
index c91b079824..b75a40520b 100644
--- a/apps/web/src/features/block-spreadsheet/components/SpreadsheetCommentCard.tsx
+++ b/apps/web/src/features/block-spreadsheet/components/SpreadsheetCommentCard.tsx
@@ -1,14 +1,9 @@
-import {
- DiscussionComposer,
- type DiscussionThread,
- DiscussionThreadView,
-} from '@core/comments/discussion';
import { StaticMarkdownContext } from '@core/component/LexicalMarkdown/component/core/StaticMarkdown';
import { floatWithElement } from '@core/component/LexicalMarkdown/directive/floatWithElement';
import { ScopedPortal } from '@core/component/ScopedPortal';
import XIcon from '@phosphor/x.svg';
import { Button } from '@ui/components/Button';
-import { For, Show } from 'solid-js';
+import type { JSX } from 'solid-js';
false && floatWithElement;
@@ -16,8 +11,7 @@ false && floatWithElement;
export function SpreadsheetCommentCard(props: {
element: HTMLElement;
label: string;
- creating: boolean;
- threads: DiscussionThread[];
+ children: JSX.Element;
onEnter: () => void;
onLeave: () => void;
onInteract: () => void;
@@ -58,16 +52,7 @@ export function SpreadsheetCommentCard(props: {
</Button>
</div>
<div class="max-h-[min(28rem,65dvh)] overflow-y-auto p-3 text-xs">
- <StaticMarkdownContext>
- <For each={props.threads}>
- {(thread) => (
- <DiscussionThreadView showReplyAction thread={thread} />
- )}
- </For>
- <Show when={props.creating}>
- <DiscussionComposer autofocus />
- </Show>
- </StaticMarkdownContext>
+ <StaticMarkdownContext>{props.children}</StaticMarkdownContext>
</div>
</div>
</ScopedPortal>
diff --git a/apps/web/src/features/block-spreadsheet/core/spreadsheet-comments.test.ts b/apps/web/src/features/block-spreadsheet/core/spreadsheet-comments.test.ts
new file mode 100644
index 0000000000..b91e896e6a
--- /dev/null
+++ b/apps/web/src/features/block-spreadsheet/core/spreadsheet-comments.test.ts
@@ -0,0 +1,18 @@
+import { expect, it } from 'vitest';
+import { spreadsheetCommentAnchor } from './spreadsheet-comments';
+
+it('reads only typed spreadsheet message anchors', () => {
+ const anchor = { sheetId: 'sheet-1', sheetName: 'Budget', range: 'B4:C9' };
+ expect(spreadsheetCommentAnchor({ type: 'spreadsheet', ...anchor })).toEqual(
+ anchor
+ );
+ for (const value of [
+ null,
+ { spreadsheet: anchor },
+ { type: 'markdown' },
+ { type: 'spreadsheet', ...anchor, range: 'A0' },
+ { type: 'spreadsheet', ...anchor, range: 'A1:B2:C3' },
+ ]) {
+ expect(spreadsheetCommentAnchor(value)).toBeUndefined();
+ }
+});
diff --git a/apps/web/src/features/block-spreadsheet/core/spreadsheet-comments.ts b/apps/web/src/features/block-spreadsheet/core/spreadsheet-comments.ts
index 1781cad164..f6534dfd9e 100644
--- a/apps/web/src/features/block-spreadsheet/core/spreadsheet-comments.ts
+++ b/apps/web/src/features/block-spreadsheet/core/spreadsheet-comments.ts
@@ -1,5 +1,3 @@
-import { positionFromAddress } from './grid-selection';
-
export const SPREADSHEET_COMMENT_PARAMS = { commentId: 'comment_id' } as const;
export type SpreadsheetCommentAnchor = {
@@ -8,16 +6,14 @@ export type SpreadsheetCommentAnchor = {
range: string;
};
-/** Stored on the existing document annotation thread, never in cell contents. */
export function spreadsheetCommentAnchor(
- metadata: unknown
+ value: unknown
): SpreadsheetCommentAnchor | undefined {
- if (!metadata || typeof metadata !== 'object' || !('spreadsheet' in metadata))
- return;
- const value = metadata.spreadsheet;
if (
!value ||
typeof value !== 'object' ||
+ !('type' in value) ||
+ value.type !== 'spreadsheet' ||
!('sheetId' in value) ||
!('sheetName' in value) ||
!('range' in value)
@@ -33,10 +29,7 @@ export function spreadsheetCommentAnchor(
const addresses = value.range.split(':');
if (
addresses.length > 2 ||
- !addresses.every(
- (address) =>
- /^[A-Z]+[1-9]\d*$/.test(address) && positionFromAddress(address)
- )
+ !addresses.every((address) => /^[A-Z]+[1-9]\d*$/.test(address))
)
return;
return {
diff --git a/apps/web/src/features/block-spreadsheet/primitives/create-spreadsheet-discussion.test.ts b/apps/web/src/features/block-spreadsheet/primitives/create-spreadsheet-discussion.test.ts
deleted file mode 100644
index 63d5858b51..0000000000
--- a/apps/web/src/features/block-spreadsheet/primitives/create-spreadsheet-discussion.test.ts
+++ /dev/null
@@ -1,186 +0,0 @@
-import type { ItemMention } from '@core/component/LexicalMarkdown/plugins';
-import type { CommentThread } from '@service-storage/generated/schemas/commentThread';
-import { createRoot, createSignal } from 'solid-js';
-import { describe, expect, it, vi } from 'vitest';
-import { spreadsheetCommentAnchor } from '../core/spreadsheet-comments';
-import {
- createSpreadsheetDiscussion,
- spreadsheetDiscussionThread,
-} from './create-spreadsheet-discussion';
-
-const anchor = { sheetId: 'sheet-1', sheetName: 'Budget', range: 'B4:C9' };
-const comment = {
- id: '42',
- threadId: '7',
- authorId: 'me',
- text: 'Budget?',
- createdAt: '',
- updatedAt: '',
- deletedAt: null,
-};
-const server: CommentThread = {
- thread: {
- threadId: 7,
- documentId: 'doc',
- owner: 'me',
- resolved: false,
- metadata: { spreadsheet: anchor },
- },
- comments: [
- { commentId: 42, threadId: 7, owner: 'me', text: 'Budget?', order: 0 },
- ],
-};
-function setup() {
- const [canComment, setCanComment] = createSignal(true);
- const [threads, setThreads] = createSignal([server]);
- const [target, setTarget] = createSignal<string | null>(null);
- const api = {
- create: vi.fn(async () => ({})),
- edit: vi.fn(async () => ({})),
- delete: vi.fn(async () => ({})),
- };
- const refresh = vi.fn(async () => {});
- const source = createSpreadsheetDiscussion({
- threads,
- canComment,
- userId: () => 'me',
- anchor: () => anchor,
- targetCommentId: target,
- targetRevision: target,
- api,
- refresh,
- buildLink: (id) => `https://macro.com/app/spreadsheet/doc?comment_id=${id}`,
- });
- return { source, api, refresh, setCanComment, setThreads, setTarget };
-}
-
-describe('spreadsheet document discussions', () => {
- it('posts range metadata and unique user mentions through the existing document API', async () => {
- await createRoot(async (dispose) => {
- const { source, api, refresh } = setup();
- const mentions = [
- { itemType: 'user', itemId: 'alice' },
- { itemType: 'user', itemId: 'alice' },
- { itemType: 'document', itemId: 'other-doc' },
- ] as ItemMention[];
- await source.createThread('Please check this range', mentions);
- expect(api.create).toHaveBeenCalledWith({
- text: 'Please check this range',
- threadMetadata: {
- markId: expect.stringMatching(/^DISCUSSION:/),
- spreadsheet: anchor,
- },
- mentions: { mentionId: expect.any(String), users: ['alice'] },
- });
- expect(refresh).toHaveBeenCalledOnce();
- await source.createReply('7', 'Looks right', []);
- expect(api.create).toHaveBeenLastCalledWith({
- threadId: 7,
- text: 'Looks right',
- mentions: undefined,
- });
- expect(source.buildCommentLink?.(comment)).toContain('comment_id=42');
- dispose();
- });
- });
- it('allows commenters without requiring edit permission, and blocks revoked permissions and other authors', async () => {
- await createRoot(async (dispose) => {
- const { source, api, setCanComment } = setup();
- await source.editComment(comment, 'Updated');
- expect(api.edit).toHaveBeenCalledWith(42, 7, 'Updated');
- expect(() =>
- source.deleteComment({ ...comment, authorId: 'other' })
- ).toThrow(/own comments/);
- setCanComment(false);
- await expect(source.createThread('no', [])).rejects.toThrow(/permission/);
- await expect(source.createReply('7', 'no', [])).rejects.toThrow(
- /permission/
- );
- await expect(source.editComment(comment, 'no')).rejects.toThrow(
- /permission/
- );
- await expect(source.deleteComment(comment)).rejects.toThrow(/permission/);
- expect(api.create).not.toHaveBeenCalled();
- expect(api.delete).not.toHaveBeenCalled();
- dispose();
- });
- });
- it('propagates write failures so drafts survive and does not retry a successful post after a read failure', async () => {
- await createRoot(async (dispose) => {
- const { source, api, refresh } = setup();
- api.create.mockRejectedValueOnce(new Error('offline'));
- await expect(source.createThread('Keep my draft', [])).rejects.toThrow(
- 'offline'
- );
- expect(refresh).not.toHaveBeenCalled();
- refresh.mockRejectedValueOnce(new Error('read failed'));
- await expect(
- source.createThread('Sent once', [])
- ).resolves.toBeUndefined();
- expect(api.create).toHaveBeenCalledTimes(2);
- dispose();
- });
- });
- it('updates live threads without remounting reply composers; deleted threads disappear', () =>
- createRoot((dispose) => {
- const { source, setThreads, setTarget } = setup();
- const first = source.threads()[0];
- setThreads([
- {
- ...server,
- comments: [
- ...server.comments,
- {
- commentId: 43,
- threadId: 7,
- owner: 'other',
- sender: 'sender',
- text: 'Reply',
- order: 1,
- },
- ],
- },
- ]);
- expect(source.threads()[0]).toBe(first);
- expect(first.comments.map((c) => c.authorId)).toEqual(['me', 'sender']);
- setTarget('43');
- expect(source.targetCommentId()).toBe('43');
- setThreads([
- { ...server, thread: { ...server.thread, deletedAt: 'today' } },
- ]);
- expect(source.threads()).toEqual([]);
- dispose();
- }));
- it('sorts roots before replies and preserves deletion and sender information', () => {
- const thread = spreadsheetDiscussionThread({
- ...server,
- comments: [
- {
- commentId: 43,
- threadId: 7,
- owner: 'owner',
- sender: 'sender',
- text: '',
- order: 1,
- deletedAt: 'today',
- },
- ...server.comments,
- ],
- });
- expect(thread.comments.map((c) => c.id)).toEqual(['42', '43']);
- expect(thread.comments[1].deletedAt).toBe('today');
- });
- it('accepts validated range anchors and ignores foreign/malformed annotation metadata', () => {
- expect(spreadsheetCommentAnchor({ spreadsheet: anchor })).toEqual(anchor);
- for (const metadata of [
- null,
- {},
- { markId: 'DISCUSSION:old' },
- { spreadsheet: { ...anchor, range: 'A0' } },
- { spreadsheet: { ...anchor, range: 'A1:B2:C3' } },
- { spreadsheet: { ...anchor, range: '=NOW()' } },
- { spreadsheet: { ...anchor, sheetId: 10 } },
- ])
- expect(spreadsheetCommentAnchor(metadata)).toBeUndefined();
- });
-});
diff --git a/apps/web/src/features/block-spreadsheet/primitives/create-spreadsheet-discussion.ts b/apps/web/src/features/block-spreadsheet/primitives/create-spreadsheet-discussion.ts
deleted file mode 100644
index a8965f7965..0000000000
--- a/apps/web/src/features/block-spreadsheet/primitives/create-spreadsheet-discussion.ts
+++ /dev/null
@@ -1,148 +0,0 @@
-import type {
- DiscussionSource,
- DiscussionThread,
-} from '@core/comments/discussion/types';
-import type { ItemMention } from '@core/component/LexicalMarkdown/plugins';
-import type { CommentThread } from '@service-storage/generated/schemas/commentThread';
-import type { CreateCommentRequest } from '@service-storage/generated/schemas/createCommentRequest';
-import { type Accessor, createMemo } from 'solid-js';
-import type { SpreadsheetCommentAnchor } from '../core/spreadsheet-comments';
-
-export function createSpreadsheetDiscussion(options: {
- threads: Accessor<CommentThread[]>;
- canComment: Accessor<boolean>;
- userId: Accessor<string | undefined>;
- anchor: Accessor<SpreadsheetCommentAnchor | undefined>;
- targetCommentId: Accessor<string | null>;
- targetRevision: Accessor<unknown>;
- api: {
- create(body: CreateCommentRequest): Promise<unknown>;
- edit(commentId: number, threadId: number, text: string): Promise<unknown>;
- delete(commentId: number): Promise<unknown>;
- };
- refresh(): Promise<unknown>;
- buildLink(commentId: string): string;
-}): DiscussionSource {
- // Keep each thread's UI mounted when a live reply arrives while composing.
- const adapters = new Map<
- string,
- ReturnType<typeof spreadsheetDiscussionThread>
- >();
- const mapped = createMemo(
- () =>
- new Map(
- options
- .threads()
- .filter((value) => !value.thread.deletedAt)
- .map((value) => [
- String(value.thread.threadId),
- spreadsheetDiscussionThread(value),
- ])
- )
- );
- const threads = createMemo(() =>
- [...mapped().keys()].map((id) => {
- let adapter = adapters.get(id);
- if (!adapter) {
- adapter = {
- id,
- get resolved() {
- return mapped().get(id)?.resolved ?? false;
- },
- get comments() {
- return mapped().get(id)?.comments ?? [];
- },
- };
- adapters.set(id, adapter);
- }
- return adapter;
- })
- );
- async function write(operation: () => Promise<unknown>) {
- if (!options.canComment() || !options.userId())
- throw new Error('You do not have permission to comment.');
- await operation();
- // Posting succeeded even if refreshing later fails. Never invite duplicate sends.
- void options.refresh().catch(() => {});
- }
- function assertOwner(authorId: string) {
- if (authorId !== options.userId())
- throw new Error('You can only change your own comments.');
- }
- return {
- threads,
- canEdit: options.canComment,
- currentUserId: options.userId,
- targetCommentId: options.targetCommentId,
- targetRevision: options.targetRevision,
- createThread: (text, mentions) => {
- const anchor = options.anchor();
- return write(() =>
- options.api.create({
- text,
- threadMetadata: {
- markId: `DISCUSSION:${crypto.randomUUID()}`,
- ...(anchor ? { spreadsheet: anchor } : {}),
- },
- mentions: spreadsheetCommentMentions(mentions),
- })
- );
- },
- createReply: (threadId, text, mentions) =>
- write(() =>
- options.api.create({
- text,
- threadId: Number(threadId),
- mentions: spreadsheetCommentMentions(mentions),
- })
- ),
- editComment: (comment, text) => {
- assertOwner(comment.authorId);
- return write(() =>
- options.api.edit(Number(comment.id), Number(comment.threadId), text)
- );
- },
- deleteComment: (comment) => {
- assertOwner(comment.authorId);
- return write(() => options.api.delete(Number(comment.id)));
- },
- buildCommentLink: (comment) => options.buildLink(comment.id),
- };
-}
-
-export function spreadsheetCommentMentions(mentions: ItemMention[]) {
- const users = [
- ...new Set(
- mentions
- .filter((item) => item.itemType === 'user')
- .map((item) => item.itemId)
- ),
- ];
- return users.length ? { mentionId: crypto.randomUUID(), users } : undefined;
-}
-
-export function spreadsheetDiscussionThread(
- value: CommentThread
-): DiscussionThread {
- return {
- id: String(value.thread.threadId),
- resolved: value.thread.resolved,
- comments: [...value.comments]
- .sort(
- (a, b) =>
- (a.order ?? Number.MAX_SAFE_INTEGER) -
- (b.order ?? Number.MAX_SAFE_INTEGER) ||
- (a.createdAt ?? '').localeCompare(b.createdAt ?? '') ||
- a.commentId - b.commentId
- )
- .map((comment) => ({
- id: String(comment.commentId),
- threadId: String(comment.threadId),
- authorId: comment.sender ?? comment.owner,
- text: comment.text,
- createdAt: comment.createdAt ?? '',
- updatedAt: comment.updatedAt ?? comment.createdAt ?? '',
- deletedAt: comment.deletedAt ?? null,
- })),
- };
-}
diff --git a/apps/web/src/features/block-spreadsheet/queries/keys.ts b/apps/web/src/features/block-spreadsheet/queries/keys.ts
index f4c407c40c..90e4d77699 100644
--- a/apps/web/src/features/block-spreadsheet/queries/keys.ts
+++ b/apps/web/src/features/block-spreadsheet/queries/keys.ts
@@ -5,7 +5,3 @@ export const uploadedWorkbookKeys = createQueryKeys('uploadedWorkbook', {
queryKey: [id, version, fileType],
}),
});
-
-export const spreadsheetCommentKeys = createQueryKeys('spreadsheetComments', {
- document: (id: string) => [id],
-});
diff --git a/apps/web/src/features/block-spreadsheet/queries/spreadsheet-comments.test.tsx b/apps/web/src/features/block-spreadsheet/queries/spreadsheet-comments.test.tsx
deleted file mode 100644
index cc71c9f68f..0000000000
--- a/apps/web/src/features/block-spreadsheet/queries/spreadsheet-comments.test.tsx
+++ /dev/null
@@ -1,110 +0,0 @@
-import { cleanup, render, waitFor } from '@solidjs/testing-library';
-import { QueryClient, QueryClientProvider } from '@tanstack/solid-query';
-import { err, ok } from 'neverthrow';
-import { afterEach, expect, it, vi } from 'vitest';
-
-const mocks = vi.hoisted(() => ({
- annotations: {
- getComments: vi.fn(),
- createComment: vi.fn(),
- editComment: vi.fn(),
- deleteComment: vi.fn(),
- },
- event: undefined as
- | undefined
- | ((event: { type: string; data: string }) => void),
-}));
-vi.mock('@service-storage/client', () => ({
- storageServiceClient: { annotations: mocks.annotations },
-}));
-vi.mock('@service-connection/websocket', () => ({
- state: () => 1,
- createConnectionWebsocketEffect: (fn: typeof mocks.event) => {
- mocks.event = fn;
- },
-}));
-
-import {
- spreadsheetCommentsApi,
- useSpreadsheetComments,
-} from './spreadsheet-comments';
-
-afterEach(() => {
- cleanup();
- vi.resetAllMocks();
-});
-it('uses the existing comment API for list, create, edit, and delete', async () => {
- const api = spreadsheetCommentsApi('sheet-document');
- mocks.annotations.getComments.mockResolvedValue(ok({ data: [] }));
- mocks.annotations.createComment.mockResolvedValue(
- ok({ thread: { threadId: 8 }, comments: [] })
- );
- mocks.annotations.editComment.mockResolvedValue(ok({ commentId: 42 }));
- mocks.annotations.deleteComment.mockResolvedValue(ok({ commentId: 42 }));
- expect(await api.list()).toEqual([]);
- const body = { text: 'Hello', threadId: 8 };
- await api.create(body);
- await api.edit(42, 8, 'Updated');
- await api.delete(42);
- expect(mocks.annotations.getComments).toHaveBeenCalledWith({
- documentId: 'sheet-document',
- });
- expect(mocks.annotations.createComment).toHaveBeenCalledWith({
- documentId: 'sheet-document',
- body,
- });
- expect(mocks.annotations.editComment).toHaveBeenCalledWith({
- commentId: 42,
- body: { text: 'Updated', threadId: 8 },
- });
- expect(mocks.annotations.deleteComment).toHaveBeenCalledWith({
- commentId: 42,
- body: {},
- });
-});
-it('surfaces API errors instead of treating them as successful writes', async () => {
- const api = spreadsheetCommentsApi('sheet');
- for (const mock of Object.values(mocks.annotations))
- mock.mockResolvedValue(err('denied'));
- await expect(api.list()).rejects.toThrow('load comments');
- await expect(api.create({ text: 'draft' })).rejects.toThrow(
- 'draft has been kept'
- );
- await expect(api.edit(1, 2, 'draft')).rejects.toThrow('draft has been kept');
- await expect(api.delete(1)).rejects.toThrow('delete comment');
-});
-it('refreshes live changes only for this document and tolerates malformed events', async () => {
- mocks.annotations.getComments.mockResolvedValue(ok({ data: [] }));
- const client = new QueryClient({
- defaultOptions: { queries: { retry: false } },
- });
- let state!: ReturnType<typeof useSpreadsheetComments>;
- function Probe() {
- state = useSpreadsheetComments('sheet');
- return null;
- }
- render(() => (
- <QueryClientProvider client={client}>
- <Probe />
- </QueryClientProvider>
- ));
- await waitFor(() => expect(state.query.isSuccess).toBe(true));
- const send = (documentId: string) =>
- mocks.event?.({
- type: 'comment',
- data: JSON.stringify({
- updateType: 'create-comment',
- payload: { documentId },
- }),
- });
- send('other');
- mocks.event?.({ type: 'comment', data: 'not json' });
- expect(mocks.annotations.getComments).toHaveBeenCalledTimes(1);
- mocks.annotations.getComments.mockResolvedValue(
- ok({ data: [{ thread: { threadId: 8 }, comments: [] }] })
- );
- send('sheet');
- await waitFor(() => expect(state.query.data?.[0]?.thread.threadId).toBe(8));
- expect(mocks.annotations.getComments).toHaveBeenCalledTimes(2);
- client.clear();
-});
diff --git a/apps/web/src/features/block-spreadsheet/queries/spreadsheet-comments.ts b/apps/web/src/features/block-spreadsheet/queries/spreadsheet-comments.ts
deleted file mode 100644
index 53fb62afde..0000000000
--- a/apps/web/src/features/block-spreadsheet/queries/spreadsheet-comments.ts
+++ /dev/null
@@ -1,82 +0,0 @@
-import { WebsocketConnectionState } from '@macro-inc/collaboration/websocket';
-import {
- state as connectionState,
- createConnectionWebsocketEffect,
-} from '@service-connection/websocket';
-import { storageServiceClient } from '@service-storage/client';
-import type { CreateCommentRequest } from '@service-storage/generated/schemas/createCommentRequest';
-import { useQuery, useQueryClient } from '@tanstack/solid-query';
-import { createEffect, on } from 'solid-js';
-import { spreadsheetCommentKeys } from './keys';
-
-/** Uses the document annotation routes: ownership, mentions, inbox and live events
- * are handled by the same backend as document/task discussions. */
-export function spreadsheetCommentsApi(documentId: string) {
- return {
- async list() {
- const result = await storageServiceClient.annotations.getComments({
- documentId,
- });
- if (result.isErr()) throw new Error('Unable to load comments.');
- return result.value.data;
- },
- async create(body: CreateCommentRequest) {
- const result = await storageServiceClient.annotations.createComment({
- documentId,
- body,
- });
- if (result.isErr())
- throw new Error('Unable to post comment. Your draft has been kept.');
- return result.value;
- },
- async edit(commentId: number, threadId: number, text: string) {
- const result = await storageServiceClient.annotations.editComment({
- commentId,
- body: { threadId, text },
- });
- if (result.isErr())
- throw new Error('Unable to edit comment. Your draft has been kept.');
- return result.value;
- },
- async delete(commentId: number) {
- const result = await storageServiceClient.annotations.deleteComment({
- commentId,
- body: {},
- });
- if (result.isErr()) throw new Error('Unable to delete comment.');
- return result.value;
- },
- };
-}
-
-export function useSpreadsheetComments(documentId: string) {
- const api = spreadsheetCommentsApi(documentId);
- const client = useQueryClient();
- const queryKey = spreadsheetCommentKeys.document(documentId).queryKey;
- const query = useQuery(() => ({
- queryKey,
- queryFn: api.list,
- staleTime: 30_000,
- }));
- const refresh = () => client.invalidateQueries({ queryKey });
- // Recover comments missed while the connection gateway was disconnected.
- createEffect(
- on(
- connectionState,
- (state) => {
- if (state === WebsocketConnectionState.Open) void refresh();
- },
- { defer: true }
- )
- );
- createConnectionWebsocketEffect((message) => {
- if (message.type !== 'comment') return;
- try {
- const event = JSON.parse(message.data);
- if (event?.payload?.documentId === documentId) void refresh();
- } catch {
- /* Ignore malformed connection events. */
- }
- });
- return { query, api, refresh };
-}
diff --git a/apps/web/src/features/block-spreadsheet/views/SpreadsheetCommentComposer.tsx b/apps/web/src/features/block-spreadsheet/views/SpreadsheetCommentComposer.tsx
new file mode 100644
index 0000000000..d3169a97e5
--- /dev/null
+++ b/apps/web/src/features/block-spreadsheet/views/SpreadsheetCommentComposer.tsx
@@ -0,0 +1,27 @@
+import {
+ ChannelInput,
+ type InputHandle,
+ type InputSnapshot,
+} from '@channel/Input';
+import type { MessageParent } from '@service-storage/messages';
+
+export function SpreadsheetCommentComposer(props: {
+ parent: MessageParent;
+ onSend: (snapshot: InputSnapshot) => Promise<void>;
+ autofocus?: boolean;
+}) {
+ let input: InputHandle | undefined;
+ return (
+ <ChannelInput
+ parent={props.parent}
+ flat
+ autofocus={props.autofocus ?? false}
+ input={{ mode: 'reply', placeholder: 'Leave a comment...' }}
+ onReady={(handle) => (input = handle)}
+ onSend={async (snapshot) => {
+ await props.onSend(snapshot);
+ input?.clear();
+ }}
+ />
+ );
+}
diff --git a/apps/web/src/features/block-spreadsheet/views/SpreadsheetCommentThread.tsx b/apps/web/src/features/block-spreadsheet/views/SpreadsheetCommentThread.tsx
new file mode 100644
index 0000000000..6dd015fead
--- /dev/null
+++ b/apps/web/src/features/block-spreadsheet/views/SpreadsheetCommentThread.tsx
@@ -0,0 +1,42 @@
+import { MessageThread } from '@core/messages/MessageThread';
+import type { MessageData } from '@core/messages/types';
+import type { MessageListItem } from '@service-storage/messages';
+import { Button } from '@ui/components/Button';
+import { Show } from 'solid-js';
+
+export function SpreadsheetCommentThread(props: {
+ data: MessageListItem;
+ canWrite: boolean;
+ targetId: string | null;
+ onClearTarget: () => void;
+ buildLink: (message: MessageData) => string;
+ onResolve: (resolved: boolean) => void;
+}) {
+ return (
+ <div class="mb-3">
+ <MessageThread
+ data={props.data}
+ canWrite={props.canWrite}
+ targetId={props.targetId}
+ onClearTarget={props.onClearTarget}
+ buildLink={props.buildLink}
+ expanded
+ monorail
+ />
+ <div class="mt-1 flex items-center justify-end gap-2 text-xs">
+ <Show when={props.data.state.resolved}>
+ <span class="text-success">Resolved</span>
+ </Show>
+ <Show when={props.canWrite}>
+ <Button
+ size="xs"
+ variant="ghost"
+ onClick={() => props.onResolve(!props.data.state.resolved)}
+ >
+ {props.data.state.resolved ? 'Reopen' : 'Resolve'}
+ </Button>
+ </Show>
+ </div>
+ </div>
+ );
+}
diff --git a/apps/web/src/features/drive-view/route.tsx b/apps/web/src/features/drive-view/route.tsx
index b158f42ed5..4e8f18d124 100644
--- a/apps/web/src/features/drive-view/route.tsx
+++ b/apps/web/src/features/drive-view/route.tsx
@@ -1,3 +1,4 @@
+import { SPREADSHEET_COMMENT_PARAMS } from '@app/features/block-spreadsheet/core/spreadsheet-comments';
import {
createSearchParams,
defineRoute,
@@ -226,6 +227,8 @@ export const driveSplitRoute = defineRoute({
return Object.values(MARKDOWN_URL_PARAMS);
}
if (type === 'pdf') return Object.values(PDF_URL_PARAMS);
+ if (type === 'spreadsheet')
+ return Object.values(SPREADSHEET_COMMENT_PARAMS);
if (
typeof routeParams<{ callId?: string }>(entry.location.route).callId ===
'string'
diff --git a/apps/web/src/features/notifications/tests/spreadsheet-comment-navigation.test.ts b/apps/web/src/features/notifications/tests/spreadsheet-comment-navigation.test.ts
index a11e421563..73c1898c03 100644
--- a/apps/web/src/features/notifications/tests/spreadsheet-comment-navigation.test.ts
+++ b/apps/web/src/features/notifications/tests/spreadsheet-comment-navigation.test.ts
@@ -58,6 +58,8 @@ it.each([
] as const)(
'opens %s at the spreadsheet comment, including an already open sheet',
async (tag) => {
+ const commentId = '019f862a-84b6-7f00-8000-000000000042';
+ const threadId = '019f862a-84b6-7f00-8000-000000000007';
const navigate = vi.fn();
const open = vi.fn();
const activate = vi.fn();
@@ -72,7 +74,7 @@ it.each([
entity_id: 'sheet-doc',
notification_metadata: {
tag,
- content: { fileType: 'spreadsheet', commentId: 42, threadId: 7 },
+ content: { fileType: 'spreadsheet', commentId, threadId },
},
} as UnifiedNotification;
const result = await openNotification(
@@ -81,7 +83,7 @@ it.each([
);
expect(result.isOk()).toBe(true);
await vi.waitFor(() =>
- expect(navigate).toHaveBeenCalledWith({ comment_id: '42' })
+ expect(navigate).toHaveBeenCalledWith({ comment_id: commentId })
);
expect(open).toHaveBeenCalledWith(
{ type: 'spreadsheet', id: 'sheet-doc' },
@@ -92,7 +94,7 @@ it.each([
navigate.mockClear();
await openNotification(notification, layout as unknown as SplitManager);
await vi.waitFor(() =>
- expect(navigate).toHaveBeenCalledWith({ comment_id: '42' })
+ expect(navigate).toHaveBeenCalledWith({ comment_id: commentId })
);
expect(activate).toHaveBeenCalledOnce();
expect(open).not.toHaveBeenCalled();
diff --git a/apps/web/src/lib/core/messages/EntityConversation.test.tsx b/apps/web/src/lib/core/messages/EntityConversation.test.tsx
index e4af16708e..d4fef253e6 100644
--- a/apps/web/src/lib/core/messages/EntityConversation.test.tsx
+++ b/apps/web/src/lib/core/messages/EntityConversation.test.tsx
@@ -4,6 +4,7 @@ import { cleanup, fireEvent, render } from '@solidjs/testing-library';
import { type Accessor, createSignal, For, type ParentProps } from 'solid-js';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { EntityConversation } from './EntityConversation';
+import { EntityDiscussion } from './EntityDiscussion';
const mocks = vi.hoisted(() => ({
timeline: vi.fn(),
@@ -11,6 +12,17 @@ const mocks = vi.hoisted(() => ({
capturedParent: undefined as { type: string; id: string } | undefined,
linkError: null as unknown,
refetchLink: vi.fn(),
+ urlTarget: undefined as string | undefined,
+ scroll: vi.fn(() => () => {}),
+}));
+
+vi.mock('@core/component/ParamsProvider', () => ({
+ useUrlParams: () => ({ commentId: () => mocks.urlTarget }),
+ useParamNavigationCount: () => () => 0,
+}));
+vi.mock('@core/mobile/isTouchDevice', () => ({ isTouchDevice: () => false }));
+vi.mock('./scroll-to-rendered-target', () => ({
+ scrollToRenderedTarget: mocks.scroll,
}));
vi.mock('@channel/Input', () => ({
@@ -41,7 +53,7 @@ vi.mock('@queries/messages/document-messages', () => ({
const id = target();
return id ? `root-of-${id}` : null;
},
- resolved: () => mocks.linkResolved,
+ resolved: () => !target() || mocks.linkResolved,
error: () => mocks.linkError,
refetch: mocks.refetchLink,
}),
@@ -74,6 +86,8 @@ afterEach(() => {
mocks.linkResolved = true;
mocks.capturedParent = undefined;
mocks.linkError = null;
+ mocks.urlTarget = undefined;
+ mocks.scroll.mockClear();
cleanup();
});
@@ -105,6 +119,60 @@ function thread(
const anchor = { type: 'markdown', mark_id: 'mark' } as const;
+describe('EntityDiscussion target ownership', () => {
+ it('keeps the latest timeline and disclosure state when the host rejects a URL target', () => {
+ mocks.urlTarget = 'range-reply';
+ mocks.linkResolved = false;
+ mocks.timeline.mockReturnValue({
+ isSuccess: true,
+ data: { pages: [{ items: [thread('Latest workbook topic', null)] }] },
+ });
+ const view = render(() => (
+ <EntityDiscussion
+ parent={{ type: 'document', id: 'document' }}
+ canWrite={false}
+ link={{ type: 'spreadsheet', id: 'document' }}
+ targetId={null}
+ />
+ ));
+ const [, around, enabled] = mocks.timeline.mock.calls.at(-1)!;
+ expect(around()).toBeNull();
+ expect(enabled()).toBe(true);
+ expect(view.getByText('Latest workbook topic')).toBeTruthy();
+ expect(view.queryByText('Loading comments...')).toBeNull();
+ expect(mocks.scroll).not.toHaveBeenCalled();
+ fireEvent.click(view.getByRole('button', { name: 'Discussion' }));
+ expect(view.queryByText('Latest workbook topic')).toBeNull();
+ });
+
+ it.each([undefined, 'workbook-reply'])(
+ 'windows and highlights an owned workbook link (override: %s)',
+ (targetId) => {
+ mocks.urlTarget = 'workbook-reply';
+ mocks.timeline.mockReturnValue({
+ isSuccess: true,
+ data: { pages: [{ items: [thread('root-of-workbook-reply', null)] }] },
+ });
+ const view = render(() => (
+ <EntityDiscussion
+ parent={{ type: 'document', id: 'document' }}
+ canWrite={false}
+ link={{ type: 'spreadsheet', id: 'document' }}
+ targetId={targetId}
+ />
+ ));
+ const [, around, enabled] = mocks.timeline.mock.calls.at(-1)!;
+ expect(around()).toBe('root-of-workbook-reply');
+ expect(enabled()).toBe(true);
+ expect(view.getByRole('article').dataset.target).toBe('workbook-reply');
+ expect(mocks.scroll).toHaveBeenCalledWith(
+ expect.any(HTMLElement),
+ 'workbook-reply'
+ );
+ }
+ );
+});
+
function discussion(
initialPages: MessageListItem[][],
targetId?: string,
@@ -136,6 +204,28 @@ function discussion(
}
describe('EntityConversation placement', () => {
+ it('keeps spreadsheet range threads out of the workbook discussion', () => {
+ const view = discussion(
+ [
+ [
+ thread('Workbook topic', null),
+ thread('Range topic', {
+ type: 'spreadsheet',
+ sheetId: 'sheet-1',
+ sheetName: 'Budget',
+ range: 'B4:C9',
+ }),
+ ],
+ ],
+ undefined,
+ { canWrite: true }
+ );
+ expect(view.getByText('Workbook topic')).toBeTruthy();
+ expect(view.queryByText('Range topic')).toBeNull();
+ expect(mocks.capturedParent).toEqual({ type: 'document', id: 'document' });
+ expect(view.getByRole('textbox')).toBeTruthy();
+ });
+
it('renders the Discussion disclosure as an icon instead of a text glyph', () => {
const view = discussion([[]]);
const button = view.getByRole('button', { name: 'Discussion' });
diff --git a/apps/web/src/lib/core/messages/EntityDiscussion.tsx b/apps/web/src/lib/core/messages/EntityDiscussion.tsx
index 92e6a9a2aa..42a90bb80b 100644
--- a/apps/web/src/lib/core/messages/EntityDiscussion.tsx
+++ b/apps/web/src/lib/core/messages/EntityDiscussion.tsx
@@ -52,6 +52,8 @@ export function EntityDiscussion(props: {
/** Where copied message links open: the entity's block and id. */
link: { type: string; id: string };
label?: string;
+ /** Override the URL target; null leaves this discussion untargeted. */
+ targetId?: string | null;
/**
* On touch devices, move the composer to the floating accessory region and
* show the conversation only once it has roots, as the editor page does.
@@ -60,6 +62,8 @@ export function EntityDiscussion(props: {
editorHasFocus?: boolean;
}) {
const params = useUrlParams({ commentId: COMMENT_LINK_PARAM });
+ const commentId = () =>
+ props.targetId === undefined ? params.commentId() : props.targetId;
const floating = () =>
props.floatingComposerOnTouch === true && isTouchDevice();
let container: HTMLDivElement | undefined;
@@ -70,12 +74,12 @@ export function EntityDiscussion(props: {
const commentNavigationCount = useParamNavigationCount(COMMENT_LINK_PARAM);
const scrollRequest = createMemo(
() => {
- const commentId = params.commentId();
- if (!commentId) return undefined;
+ const target = commentId();
+ if (!target) return undefined;
const count = commentNavigationCount();
return {
- commentId,
- key: count === 0 ? `url:${commentId}` : `navigation:${count}`,
+ commentId: target,
+ key: count === 0 ? `url:${target}` : `navigation:${count}`,
};
},
undefined,
@@ -102,7 +106,7 @@ export function EntityDiscussion(props: {
<EntityConversation
parent={props.parent}
canWrite={props.canWrite}
- targetId={params.commentId()}
+ targetId={commentId()}
targetCleared={targetCleared()}
onClearTarget={() => setClearedKey(scrollRequest()?.key)}
label={props.label}
diff --git a/apps/web/src/lib/queries/messages/tests/mutations.test.tsx b/apps/web/src/lib/queries/messages/tests/mutations.test.tsx
index 37c7e193fb..9f3993f91c 100644
--- a/apps/web/src/lib/queries/messages/tests/mutations.test.tsx
+++ b/apps/web/src/lib/queries/messages/tests/mutations.test.tsx
@@ -463,7 +463,15 @@ describe('thread resolution', () => {
});
describe('sending', () => {
- it('posts the optimistic id as the message id, so it never changes', async () => {
+ it.each([
+ undefined,
+ {
+ type: 'spreadsheet' as const,
+ sheetId: 'sheet-1',
+ sheetName: 'Budget',
+ range: 'B4:C9',
+ },
+ ])('keeps root identity and anchor across posting (%j)', async (anchor) => {
const parent: MessageParent = { type: 'document', id: 'doc' };
const timelineKey = getMessageTimelineQueryKey(parent);
testQueryClient.setQueryData<MessageTimelineData>(timelineKey, {
@@ -496,7 +504,7 @@ describe('sending', () => {
expect(id).toMatch(/^[0-9a-f]{8}-[0-9a-f]{4}-7/);
const pending = mutation.mutateAsync({
parent,
- message: { content: '2+2=?' },
+ message: { content: '2+2=?', anchor },
senderId: 'macro|[email protected]',
optimisticId: id,
});
@@ -508,6 +516,10 @@ describe('sending', () => {
respond();
await pending;
expect(rootIds()).toEqual([[id, id]]);
+ expect(
+ testQueryClient.getQueryData<MessageTimelineData>(timelineKey)!.pages[0]
+ .items[0].state.anchor
+ ).toEqual(anchor ?? null);
});
it('adopts the server id when the server ignores the client id', async () => {
diff --git a/apps/web/src/lib/service-clients/service-cognition/generated/tools/schemas.ts b/apps/web/src/lib/service-clients/service-cognition/generated/tools/schemas.ts
index 1507012f9d..dad88e192c 100644
--- a/apps/web/src/lib/service-clients/service-cognition/generated/tools/schemas.ts
+++ b/apps/web/src/lib/service-clients/service-cognition/generated/tools/schemas.ts
@@ -4943,6 +4943,12 @@ export const ReadContentResponse = z.object({
resolved: z.boolean(),
anchor: z.any().superRefine((x, ctx) => {
const schemas = [
+ z.object({
+ sheetId: z.string(),
+ sheetName: z.string(),
+ range: z.string(),
+ type: z.literal('spreadsheet'),
+ }),
z.object({ type: z.literal('document') }),
z.object({
markId: z.string().uuid(),
diff --git a/apps/web/src/lib/service-clients/service-cognition/generated/tools/types.ts b/apps/web/src/lib/service-clients/service-cognition/generated/tools/types.ts
index f23642f72d..f74c09ae3c 100644
--- a/apps/web/src/lib/service-clients/service-cognition/generated/tools/types.ts
+++ b/apps/web/src/lib/service-clients/service-cognition/generated/tools/types.ts
@@ -970,6 +970,21 @@ export type CommentThreadKind = 'inline' | 'discussion';
* Where a discussion sits in its document.
*/
export type CommentAnchor =
+ | {
+ /**
+ * Stable sheet identity within the workbook.
+ */
+ sheetId: string;
+ /**
+ * Sheet name when the discussion was created.
+ */
+ sheetName: string;
+ /**
+ * A1 cell or range, such as B4 or B4:C9.
+ */
+ range: string;
+ type: 'spreadsheet';
+ }
| {
type: 'document';
}
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/index.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/index.ts
index f18801f941..99059ec772 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/index.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/index.ts
@@ -1001,6 +1001,8 @@ export * from './newChannelAttachmentHeight';
export * from './newChannelAttachmentWidth';
export * from './newThreadAnchor';
export * from './newThreadAnchorOneOf';
+export * from './newThreadAnchorOneOfEight';
+export * from './newThreadAnchorOneOfEightType';
export * from './newThreadAnchorOneOfFour';
export * from './newThreadAnchorOneOfFourType';
export * from './newThreadAnchorOneOfMarkedText';
@@ -1470,6 +1472,8 @@ export * from './threadAnchorOneOfFour';
export * from './threadAnchorOneOfFourMarkedText';
export * from './threadAnchorOneOfFourType';
export * from './threadAnchorOneOfMarkedText';
+export * from './threadAnchorOneOfNine';
+export * from './threadAnchorOneOfNineType';
export * from './threadAnchorOneOfSeven';
export * from './threadAnchorOneOfSevenType';
export * from './threadAnchorOneOfType';
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchor.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchor.ts
index 21f8a68e1c..5b95531791 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchor.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchor.ts
@@ -5,6 +5,7 @@
* OpenAPI spec version: 0.1.0
*/
import type { NewThreadAnchorOneOf } from './newThreadAnchorOneOf';
+import type { NewThreadAnchorOneOfEight } from './newThreadAnchorOneOfEight';
import type { NewThreadAnchorOneOfFour } from './newThreadAnchorOneOfFour';
import type { NewThreadAnchorOneOfSix } from './newThreadAnchorOneOfSix';
@@ -14,4 +15,5 @@ import type { NewThreadAnchorOneOfSix } from './newThreadAnchorOneOfSix';
export type NewThreadAnchor =
| NewThreadAnchorOneOf
| NewThreadAnchorOneOfFour
- | NewThreadAnchorOneOfSix;
+ | NewThreadAnchorOneOfSix
+ | NewThreadAnchorOneOfEight;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchorOneOfEight.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchorOneOfEight.ts
new file mode 100644
index 0000000000..f7f90bb804
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchorOneOfEight.ts
@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+import type { NewThreadAnchorOneOfEightType } from './newThreadAnchorOneOfEightType';
+
+/**
+ * A cell or rectangular range in a native spreadsheet.
+ */
+export type NewThreadAnchorOneOfEight = {
+ /** A1 cell or range, such as B4 or B4:C9. */
+ range: string;
+ /** Stable sheet identity within the workbook. */
+ sheetId: string;
+ /** Sheet name when the discussion was created. */
+ sheetName: string;
+ type: NewThreadAnchorOneOfEightType;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchorOneOfEightType.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchorOneOfEightType.ts
new file mode 100644
index 0000000000..eb74477f53
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/newThreadAnchorOneOfEightType.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type NewThreadAnchorOneOfEightType =
+ (typeof NewThreadAnchorOneOfEightType)[keyof typeof NewThreadAnchorOneOfEightType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const NewThreadAnchorOneOfEightType = {
+ spreadsheet: 'spreadsheet',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchor.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchor.ts
index 9295730729..4ddbc6d887 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchor.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchor.ts
@@ -6,12 +6,14 @@
*/
import type { ThreadAnchorOneOf } from './threadAnchorOneOf';
import type { ThreadAnchorOneOfFour } from './threadAnchorOneOfFour';
+import type { ThreadAnchorOneOfNine } from './threadAnchorOneOfNine';
import type { ThreadAnchorOneOfSeven } from './threadAnchorOneOfSeven';
/**
- * A thread's location within its document. Geometry remains annotation-owned.
+ * A thread's location within its document. PDF geometry remains annotation-owned.
*/
export type ThreadAnchor =
| ThreadAnchorOneOf
| ThreadAnchorOneOfFour
- | ThreadAnchorOneOfSeven;
+ | ThreadAnchorOneOfSeven
+ | ThreadAnchorOneOfNine;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchorOneOfNine.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchorOneOfNine.ts
new file mode 100644
index 0000000000..71d04d2f85
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchorOneOfNine.ts
@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+import type { ThreadAnchorOneOfNineType } from './threadAnchorOneOfNineType';
+
+/**
+ * A cell or rectangular range in a native spreadsheet.
+ */
+export type ThreadAnchorOneOfNine = {
+ /** A1 cell or range, such as B4 or B4:C9. */
+ range: string;
+ /** Stable sheet identity within the workbook. */
+ sheetId: string;
+ /** Sheet name when the discussion was created. */
+ sheetName: string;
+ type: ThreadAnchorOneOfNineType;
+};
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchorOneOfNineType.ts b/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchorOneOfNineType.ts
new file mode 100644
index 0000000000..42405c72b4
--- /dev/null
+++ b/apps/web/src/lib/service-clients/service-storage/generated/schemas/threadAnchorOneOfNineType.ts
@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * document_storage_service
+ * OpenAPI spec version: 0.1.0
+ */
+
+export type ThreadAnchorOneOfNineType =
+ (typeof ThreadAnchorOneOfNineType)[keyof typeof ThreadAnchorOneOfNineType];
+
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ThreadAnchorOneOfNineType = {
+ spreadsheet: 'spreadsheet',
+} as const;
diff --git a/apps/web/src/lib/service-clients/service-storage/generated/zod.ts b/apps/web/src/lib/service-clients/service-storage/generated/zod.ts
index a36cd8c5ab..c7c1c56679 100644
--- a/apps/web/src/lib/service-clients/service-storage/generated/zod.ts
+++ b/apps/web/src/lib/service-clients/service-storage/generated/zod.ts
@@ -30799,9 +30799,31 @@ export const messageTimelineResponse = zod
.describe(
'A comment-only placeable PDF annotation. It marks a point on a page,\nnot a span of text, so it has no marked text.'
),
+ zod
+ .object({
+ range: zod
+ .string()
+ .describe(
+ 'A1 cell or range, such as B4 or B4:C9.'
+ ),
+ sheetId: zod
+ .string()
+ .describe(
+ 'Stable sheet identity within the workbook.'
+ ),
+ sheetName: zod
+ .string()
+ .describe(
+ 'Sheet name when the discussion was created.'
+ ),
+ type: zod.enum(['spreadsheet']),
+ })
+ .describe(
+ 'A cell or rectangular range in a native spreadsheet.'
+ ),
])
.describe(
- "A thread's location within its document. Geometry remains annotation-owned."
+ "A thread's location within its document. PDF geometry remains annotation-owned."
),
])
.optional(),
@@ -31146,6 +31168,20 @@ export const entityMessageCreateBody = zod
.describe(
'Atomically create a placeable annotation with the root message.'
),
+ zod
+ .object({
+ range: zod
+ .string()
+ .describe('A1 cell or range, such as B4 or B4:C9.'),
+ sheetId: zod
+ .string()
+ .describe('Stable sheet identity within the workbook.'),
+ sheetName: zod
+ .string()
+ .describe('Sheet name when the discussion was created.'),
+ type: zod.enum(['spreadsheet']),
+ })
+ .describe('A cell or rectangular range in a native spreadsheet.'),
])
.describe('Location supplied when creating a document discussion.'),
])
@@ -32564,9 +32600,25 @@ export const entityMessageGetThreadResponse = zod
.describe(
'A comment-only placeable PDF annotation. It marks a point on a page,\nnot a span of text, so it has no marked text.'
),
+ zod
+ .object({
+ range: zod
+ .string()
+ .describe('A1 cell or range, such as B4 or B4:C9.'),
+ sheetId: zod
+ .string()
+ .describe('Stable sheet identity within the workbook.'),
+ sheetName: zod
+ .string()
+ .describe('Sheet name when the discussion was created.'),
+ type: zod.enum(['spreadsheet']),
+ })
+ .describe(
+ 'A cell or rectangular range in a native spreadsheet.'
+ ),
])
.describe(
- "A thread's location within its document. Geometry remains annotation-owned."
+ "A thread's location within its document. PDF geometry remains annotation-owned."
),
])
.optional(),
@@ -32656,9 +32708,23 @@ export const entityMessageDeleteThreadResponse = zod
.describe(
'A comment-only placeable PDF annotation. It marks a point on a page,\nnot a span of text, so it has no marked text.'
),
+ zod
+ .object({
+ range: zod
+ .string()
+ .describe('A1 cell or range, such as B4 or B4:C9.'),
+ sheetId: zod
+ .string()
+ .describe('Stable sheet identity within the workbook.'),
+ sheetName: zod
+ .string()
+ .describe('Sheet name when the discussion was created.'),
+ type: zod.enum(['spreadsheet']),
+ })
+ .describe('A cell or rectangular range in a native spreadsheet.'),
])
.describe(
- "A thread's location within its document. Geometry remains annotation-owned."
+ "A thread's location within its document. PDF geometry remains annotation-owned."
),
])
.optional(),
@@ -32761,9 +32827,23 @@ export const entityMessagePatchThreadResponse = zod
.describe(
'A comment-only placeable PDF annotation. It marks a point on a page,\nnot a span of text, so it has no marked text.'
),
+ zod
+ .object({
+ range: zod
+ .string()
+ .describe('A1 cell or range, such as B4 or B4:C9.'),
+ sheetId: zod
+ .string()
+ .describe('Stable sheet identity within the workbook.'),
+ sheetName: zod
+ .string()
+ .describe('Sheet name when the discussion was created.'),
+ type: zod.enum(['spreadsheet']),
+ })
+ .describe('A cell or rectangular range in a native spreadsheet.'),
])
.describe(
- "A thread's location within its document. Geometry remains annotation-owned."
+ "A thread's location within its document. PDF geometry remains annotation-owned."
),
])
.optional(),
diff --git a/apps/web/src/lib/service-clients/service-storage/openapi.json b/apps/web/src/lib/service-clients/service-storage/openapi.json
index 1e31b2ce3a..7e9f51abaa 100644
--- a/apps/web/src/lib/service-clients/service-storage/openapi.json
+++ b/apps/web/src/lib/service-clients/service-storage/openapi.json
@@ -26938,6 +26938,29 @@
"description": "Vertical position as a fraction of the page height."
}
}
+ },
+ {
+ "type": "object",
+ "description": "A cell or rectangular range in a native spreadsheet.",
+ "required": ["sheetId", "sheetName", "range", "type"],
+ "properties": {
+ "range": {
+ "type": "string",
+ "description": "A1 cell or range, such as B4 or B4:C9."
+ },
+ "sheetId": {
+ "type": "string",
+ "description": "Stable sheet identity within the workbook."
+ },
+ "sheetName": {
+ "type": "string",
+ "description": "Sheet name when the discussion was created."
+ },
+ "type": {
+ "type": "string",
+ "enum": ["spreadsheet"]
+ }
+ }
}
],
"description": "Location supplied when creating a document discussion."
@@ -31644,9 +31667,32 @@
"enum": ["pdf_placeable"]
}
}
+ },
+ {
+ "type": "object",
+ "description": "A cell or rectangular range in a native spreadsheet.",
+ "required": ["sheetId", "sheetName", "range", "type"],
+ "properties": {
+ "range": {
+ "type": "string",
+ "description": "A1 cell or range, such as B4 or B4:C9."
+ },
+ "sheetId": {
+ "type": "string",
+ "description": "Stable sheet identity within the workbook."
+ },
+ "sheetName": {
+ "type": "string",
+ "description": "Sheet name when the discussion was created."
+ },
+ "type": {
+ "type": "string",
+ "enum": ["spreadsheet"]
+ }
+ }
}
],
- "description": "A thread's location within its document. Geometry remains annotation-owned."
+ "description": "A thread's location within its document. PDF geometry remains annotation-owned."
},
"ThreadOrigin": {
"type": "object",
diff --git a/crates/agent_harness/src/domain/model.rs b/crates/agent_harness/src/domain/model.rs
index ec49bd8b35..e55804bc2a 100644
--- a/crates/agent_harness/src/domain/model.rs
+++ b/crates/agent_harness/src/domain/model.rs
@@ -415,6 +415,16 @@ pub enum ReplyTarget {
/// with the id.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CommentAnchor {
+ /// A cell or rectangular range in a native spreadsheet.
+ Spreadsheet {
+ /// Stable sheet identity within the workbook.
+ sheet_id: String,
+ /// Sheet name when the discussion was created.
+ sheet_name: String,
+ /// A1 cell or range, such as B4 or B4:C9.
+ range: String,
+ },
+
/// A comment mark in a markdown document.
Mark {
/// Lexical mark the thread is attached to.
diff --git a/crates/agent_harness/src/outbound/agent_prompt_composer.rs b/crates/agent_harness/src/outbound/agent_prompt_composer.rs
index 8dc842ae1a..9746bbd3d3 100644
--- a/crates/agent_harness/src/outbound/agent_prompt_composer.rs
+++ b/crates/agent_harness/src/outbound/agent_prompt_composer.rs
@@ -49,6 +49,15 @@ impl AgentPromptComposer for LexicalAgentPromptComposer {
fn anchor(anchor: &CommentAnchor) -> AgentContextAnchor<'_> {
match anchor {
+ CommentAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ } => AgentContextAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ },
CommentAnchor::Mark {
mark_id,
marked_text,
diff --git a/crates/agent_harness/src/outbound/agent_prompt_composer/test.rs b/crates/agent_harness/src/outbound/agent_prompt_composer/test.rs
index 2917a15a1a..1745003480 100644
--- a/crates/agent_harness/src/outbound/agent_prompt_composer/test.rs
+++ b/crates/agent_harness/src/outbound/agent_prompt_composer/test.rs
@@ -153,6 +153,15 @@ async fn the_comment_anchor_reaches_the_lexical_service_beside_the_history() {
.await,
serde_json::json!({ "type": "pdfPin", "anchorId": "pin-1" })
);
+ assert_eq!(
+ sent(CommentAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget".into(),
+ range: "B4:C9".into(),
+ })
+ .await,
+ serde_json::json!({"type": "spreadsheet", "sheetId": "sheet-1", "sheetName": "Budget", "range": "B4:C9"})
+ );
server.abort();
}
diff --git a/crates/agent_harness/src/outbound/channel_prompt_context.rs b/crates/agent_harness/src/outbound/channel_prompt_context.rs
index 8a8cea5950..f0ef05e199 100644
--- a/crates/agent_harness/src/outbound/channel_prompt_context.rs
+++ b/crates/agent_harness/src/outbound/channel_prompt_context.rs
@@ -260,6 +260,17 @@ async fn anchor(
anchor: Option<ThreadAnchor>,
) -> Option<CommentAnchor> {
let (mark_id, marked_text) = match anchor? {
+ ThreadAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ } => {
+ return Some(CommentAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ });
+ }
ThreadAnchor::PdfHighlight {
anchor_id,
marked_text,
diff --git a/crates/agent_harness/src/outbound/channel_prompt_context/test.rs b/crates/agent_harness/src/outbound/channel_prompt_context/test.rs
index e4bb7eee7f..34d7508154 100644
--- a/crates/agent_harness/src/outbound/channel_prompt_context/test.rs
+++ b/crates/agent_harness/src/outbound/channel_prompt_context/test.rs
@@ -834,3 +834,25 @@ async fn a_pdf_pin_discussion_names_its_pin() {
})
);
}
+
+#[tokio::test]
+async fn spreadsheet_discussions_carry_the_range_without_resolving_a_mark() {
+ let context = context_from(
+ reader(Some(ThreadAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget".into(),
+ range: "B4:C9".into(),
+ })),
+ Lexical::mark(Err("never asked")),
+ &origin(),
+ )
+ .await;
+ assert_eq!(
+ context.anchor,
+ Some(CommentAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget".into(),
+ range: "B4:C9".into()
+ })
+ );
+}
diff --git a/crates/channel_bots/src/domain/service.rs b/crates/channel_bots/src/domain/service.rs
index 3931918cb5..a67d872566 100644
--- a/crates/channel_bots/src/domain/service.rs
+++ b/crates/channel_bots/src/domain/service.rs
@@ -72,6 +72,11 @@ struct ThreadContext {
/// What an inline document discussion is attached to.
enum DiscussionAnchor {
+ Spreadsheet {
+ sheet_id: String,
+ sheet_name: String,
+ range: String,
+ },
Mark(MarkAnchor),
/// A PDF highlight and the text it covers, read from the highlight.
PdfHighlight {
@@ -151,12 +156,27 @@ fn append_anchor(prompt: &mut String, anchor: &MarkAnchor, current: Option<&Mark
}
}
-/// Write the block naming what a PDF discussion is attached to. A highlight
+/// Write the block naming what a non-Markdown discussion is attached to. A highlight
/// carries its own text; a pin or a highlight without text says so, so the
/// agent is not left to infer the words from the page.
-fn append_pdf_anchor(prompt: &mut String, anchor: &DiscussionAnchor) {
+fn append_document_anchor(prompt: &mut String, anchor: &DiscussionAnchor) {
let _ = match anchor {
DiscussionAnchor::Mark(_) => return,
+ DiscussionAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ } => {
+ let location =
+ serde_json::json!({ "sheetId": sheet_id, "sheetName": sheet_name, "range": range })
+ .to_string()
+ .replace('<', "\\u003c")
+ .replace('>', "\\u003e");
+ write!(
+ prompt,
+ "\n<anchor type=\"spreadsheet\">\nUse ReadSpreadsheet to read the live cells in this range.\n{location}\n</anchor>\n"
+ )
+ }
DiscussionAnchor::PdfHighlight {
anchor_id,
marked_text: Some(text),
@@ -302,6 +322,15 @@ where
) -> anyhow::Result<ThreadContext> {
let thread = self.messages.get_thread(access, root_id).await?;
let anchor = thread.state.anchor.map(|anchor| match anchor {
+ ThreadAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ } => DiscussionAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ },
ThreadAnchor::Markdown {
mark_id,
marked_text,
@@ -430,7 +459,7 @@ where
let current = self.current_mark(parent, mark.mark_id).await;
append_anchor(&mut prompt, mark, current.as_ref());
}
- Some(pdf) => append_pdf_anchor(&mut prompt, pdf),
+ Some(anchor) => append_document_anchor(&mut prompt, anchor),
None => {}
}
append_block(&mut prompt, "thread", thread_instruction, marker, &thread);
diff --git a/crates/channel_bots/src/domain/service/tests.rs b/crates/channel_bots/src/domain/service/tests.rs
index e71a886711..de9618576e 100644
--- a/crates/channel_bots/src/domain/service/tests.rs
+++ b/crates/channel_bots/src/domain/service/tests.rs
@@ -531,3 +531,16 @@ fn current_time_block_falls_back_to_utc_for_missing_or_bad_zones() {
interpreted)\n</current_time>\n"
);
}
+
+#[tokio::test]
+async fn spreadsheet_discussions_name_the_range_without_inventing_cell_contents() {
+ let prompt = prompt_on(ThreadAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget </anchor>".into(),
+ range: "B4:C9".into(),
+ })
+ .await;
+ assert!(prompt.contains("Use ReadSpreadsheet to read the live cells in this range."));
+ assert!(prompt.contains(r#""range":"B4:C9""#));
+ assert!(prompt.contains(r#"Budget \u003c/anchor\u003e"#));
+}
diff --git a/crates/documents/src/domain/comments.rs b/crates/documents/src/domain/comments.rs
index e010a16286..87801fbe6c 100644
--- a/crates/documents/src/domain/comments.rs
+++ b/crates/documents/src/domain/comments.rs
@@ -44,6 +44,17 @@ pub trait CommentMarks: Send + Sync + 'static {
#[cfg_attr(feature = "ai_tools", derive(schemars::JsonSchema))]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum CommentAnchor {
+ /// A cell or rectangular range in a native spreadsheet.
+ #[serde(rename_all = "camelCase")]
+ Spreadsheet {
+ /// Stable sheet identity within the workbook.
+ sheet_id: String,
+ /// Sheet name when the discussion was created.
+ sheet_name: String,
+ /// A1 cell or range, such as B4 or B4:C9.
+ range: String,
+ },
+
/// A Discussion comment on the document as a whole.
Document,
/// An inline comment on a passage of a markdown document.
@@ -107,7 +118,7 @@ pub struct DocumentComment {
#[cfg_attr(feature = "ai_tools", derive(schemars::JsonSchema))]
#[serde(rename_all = "camelCase")]
pub enum CommentThreadKind {
- /// An inline comment on a passage, PDF highlight or PDF pin.
+ /// An inline comment on a passage, PDF highlight, PDF pin or spreadsheet range.
Inline,
/// A comment in the document's Discussion panel.
Discussion,
@@ -317,6 +328,15 @@ fn comment_anchor(
) -> CommentAnchor {
match anchor {
None => CommentAnchor::Document,
+ Some(ThreadAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ }) => CommentAnchor::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ },
Some(ThreadAnchor::Markdown {
mark_id,
marked_text: snapshot,
diff --git a/crates/documents/src/domain/comments/test.rs b/crates/documents/src/domain/comments/test.rs
index 5c7ec1c672..39dd175166 100644
--- a/crates/documents/src/domain/comments/test.rs
+++ b/crates/documents/src/domain/comments/test.rs
@@ -564,3 +564,40 @@ async fn deleted_threads_do_not_count_toward_the_cap() {
vec![id(1)]
);
}
+
+#[tokio::test]
+async fn spreadsheet_ranges_are_inline_and_workbook_comments_are_discussions() {
+ let mut messages = MockMessageReader::new();
+ messages.expect_timeline().returning(|_, _| {
+ Ok(page(
+ vec![
+ item(message(2, None, "Workbook comment"), None, vec![]),
+ item(
+ message(1, None, "Range comment"),
+ Some(ThreadAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget".into(),
+ range: "B4:C9".into(),
+ }),
+ vec![],
+ ),
+ ],
+ None,
+ ))
+ });
+ let discussions = reader(messages, no_marks())
+ .discussions(receipt())
+ .await
+ .unwrap();
+ assert_eq!(discussions[0].kind, CommentThreadKind::Inline);
+ assert_eq!(
+ discussions[0].anchor,
+ CommentAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget".into(),
+ range: "B4:C9".into()
+ }
+ );
+ assert_eq!(discussions[1].kind, CommentThreadKind::Discussion);
+ assert_eq!(discussions[1].anchor, CommentAnchor::Document);
+}
diff --git a/crates/lexical_client/src/parse_markdown.rs b/crates/lexical_client/src/parse_markdown.rs
index 7db2f0cc0e..ae111e3818 100644
--- a/crates/lexical_client/src/parse_markdown.rs
+++ b/crates/lexical_client/src/parse_markdown.rs
@@ -326,6 +326,16 @@ pub struct AgentContext<'a> {
rename_all_fields = "camelCase"
)]
pub enum AgentContextAnchor<'a> {
+ /// A cell or rectangular range in a native spreadsheet.
+ Spreadsheet {
+ /// Stable sheet identity within the workbook.
+ sheet_id: &'a str,
+ /// Sheet name when the discussion was created.
+ sheet_name: &'a str,
+ /// A1 cell or range, such as B4 or B4:C9.
+ range: &'a str,
+ },
+
/// A comment mark in a markdown document.
Markdown {
/// Lexical mark the comment is attached to.
diff --git a/crates/macro_db_client/migrations/20260928220456_spreadsheet_message_anchors.sql b/crates/macro_db_client/migrations/20260928220456_spreadsheet_message_anchors.sql
new file mode 100644
index 0000000000..0c6e3f4863
--- /dev/null
+++ b/crates/macro_db_client/migrations/20260928220456_spreadsheet_message_anchors.sql
@@ -0,0 +1,10 @@
+SET LOCAL lock_timeout = '5s';
+
+ALTER TABLE comms_message_threads
+ DROP CONSTRAINT comms_message_threads_anchor_check,
+ ADD CONSTRAINT comms_message_threads_anchor_check CHECK (
+ anchor IS NULL OR (
+ jsonb_typeof(anchor) = 'object'
+ AND anchor->>'type' IN ('markdown', 'pdf_highlight', 'pdf_placeable', 'spreadsheet')
+ )
+ ) NOT VALID;
diff --git a/crates/macro_db_client/migrations/20260928220559_validate_spreadsheet_message_anchors.sql b/crates/macro_db_client/migrations/20260928220559_validate_spreadsheet_message_anchors.sql
new file mode 100644
index 0000000000..db17597fae
--- /dev/null
+++ b/crates/macro_db_client/migrations/20260928220559_validate_spreadsheet_message_anchors.sql
@@ -0,0 +1,4 @@
+SET LOCAL lock_timeout = '5s';
+
+ALTER TABLE comms_message_threads
+ VALIDATE CONSTRAINT comms_message_threads_anchor_check;
diff --git a/crates/messages/src/domain/models.rs b/crates/messages/src/domain/models.rs
index ae8ee97239..41daf64436 100644
--- a/crates/messages/src/domain/models.rs
+++ b/crates/messages/src/domain/models.rs
@@ -112,7 +112,7 @@ impl MessageParent {
}
}
-/// A thread's location within its document. Geometry remains annotation-owned.
+/// A thread's location within its document. PDF geometry remains annotation-owned.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case", deny_unknown_fields)]
#[cfg_attr(feature = "schema", derive(utoipa::ToSchema))]
@@ -146,6 +146,16 @@ pub enum ThreadAnchor {
/// Placeable annotation UUID.
anchor_id: Uuid,
},
+ /// A cell or rectangular range in a native spreadsheet.
+ #[serde(rename_all = "camelCase")]
+ Spreadsheet {
+ /// Stable sheet identity within the workbook.
+ sheet_id: String,
+ /// Sheet name when the discussion was created.
+ sheet_name: String,
+ /// A1 cell or range, such as B4 or B4:C9.
+ range: String,
+ },
}
/// Location supplied when creating a document discussion.
@@ -184,6 +194,16 @@ pub enum NewThreadAnchor {
/// Height as a fraction of the page height.
height_pct: f64,
},
+ /// A cell or rectangular range in a native spreadsheet.
+ #[serde(rename_all = "camelCase")]
+ Spreadsheet {
+ /// Stable sheet identity within the workbook.
+ sheet_id: String,
+ /// Sheet name when the discussion was created.
+ sheet_name: String,
+ /// A1 cell or range, such as B4 or B4:C9.
+ range: String,
+ },
}
/// Longest marked-text snapshot kept with a discussion. A comment marks a
@@ -211,6 +231,15 @@ impl NewThreadAnchor {
/// Thread-owned reference after annotation geometry has been persisted.
pub fn reference(&self) -> ThreadAnchor {
match self {
+ Self::Spreadsheet {
+ sheet_id,
+ sheet_name,
+ range,
+ } => ThreadAnchor::Spreadsheet {
+ sheet_id: sheet_id.clone(),
+ sheet_name: sheet_name.clone(),
+ range: range.clone(),
+ },
Self::Markdown {
mark_id,
marked_text,
diff --git a/crates/messages/src/domain/models/test.rs b/crates/messages/src/domain/models/test.rs
index 0e99d81aae..e8a1605e53 100644
--- a/crates/messages/src/domain/models/test.rs
+++ b/crates/messages/src/domain/models/test.rs
@@ -137,3 +137,18 @@ fn a_stored_anchor_without_a_snapshot_still_reads() {
}
);
}
+
+#[test]
+fn spreadsheet_anchor_round_trips_without_legacy_metadata() {
+ let value = serde_json::json!({"type": "spreadsheet", "sheetId": "sheet-1", "sheetName": "Budget", "range": "B4:C9"});
+ let input: NewThreadAnchor = serde_json::from_value(value.clone()).unwrap();
+ let stored: ThreadAnchor = serde_json::from_value(value.clone()).unwrap();
+ assert_eq!(input.reference(), stored);
+ assert_eq!(serde_json::to_value(stored).unwrap(), value);
+ assert!(
+ serde_json::from_value::<NewThreadAnchor>(
+ serde_json::json!({"type": "spreadsheet", "sheetId": "sheet-1", "range": "B4:C9"})
+ )
+ .is_err()
+ );
+}
diff --git a/crates/messages/src/domain/ports.rs b/crates/messages/src/domain/ports.rs
index f413dd20ec..200c483081 100644
--- a/crates/messages/src/domain/ports.rs
+++ b/crates/messages/src/domain/ports.rs
@@ -238,6 +238,11 @@ pub trait MessageRepository: Send + Sync + 'static {
&self,
parent: &MessageParent,
) -> impl Future<Output = Result<bool, MessageError>> + Send;
+ /// File type of a live document, for document-specific anchor validation.
+ fn document_file_type(
+ &self,
+ document_id: &str,
+ ) -> impl Future<Output = Result<Option<String>, MessageError>> + Send;
/// Read a message belonging to the specified parent, including root tombstones.
fn get(
&self,
diff --git a/crates/messages/src/domain/service.rs b/crates/messages/src/domain/service.rs
index d8aa0c05a9..9276a8fa6c 100644
--- a/crates/messages/src/domain/service.rs
+++ b/crates/messages/src/domain/service.rs
@@ -191,6 +191,18 @@ impl<R: MessageRepository, E: MessageEventPublisher> MessageService<R, E> {
input.mentions = self.mentions.extract(&input.content).await?;
}
validate_post(&parent, &input)?;
+ if matches!(input.anchor, Some(NewThreadAnchor::Spreadsheet { .. }))
+ && self
+ .repo
+ .document_file_type(&parent.entity_id())
+ .await?
+ .as_deref()
+ != Some("spreadsheet")
+ {
+ return Err(MessageError::Invalid(
+ "spreadsheet anchors require a native spreadsheet",
+ ));
+ }
self.validate_references(&access, &input.mentions, &input.attachments)
.await?;
if let Some(root) = input.thread_id {
@@ -756,6 +768,13 @@ fn validate_post(parent: &MessageParent, input: &PostMessage) -> Result<(), Mess
"only root document messages may have anchors",
));
}
+ if let Some(NewThreadAnchor::Spreadsheet {
+ sheet_id, range, ..
+ }) = &input.anchor
+ && (sheet_id.trim().is_empty() || !valid_spreadsheet_range(range))
+ {
+ return Err(MessageError::Invalid("invalid spreadsheet comment range"));
+ }
if let Some(NewThreadAnchor::PdfPlaceable {
page,
x_pct,
@@ -779,6 +798,27 @@ fn validate_post(parent: &MessageParent, input: &PostMessage) -> Result<(), Mess
Ok(())
}
+fn valid_spreadsheet_range(range: &str) -> bool {
+ let cells: Vec<_> = range.split(':').collect();
+ (1..=2).contains(&cells.len())
+ && cells.iter().all(|cell| {
+ let column_len = cell.bytes().take_while(u8::is_ascii_uppercase).count();
+ let (column, row) = cell.split_at(column_len);
+ !column.is_empty()
+ && !row.starts_with('0')
+ && row.bytes().all(|byte| byte.is_ascii_digit())
+ && row.parse::<u32>().is_ok_and(|value| value > 0)
+ && column
+ .bytes()
+ .try_fold(0_u32, |value, byte| {
+ value
+ .checked_mul(26)?
+ .checked_add(u32::from(byte - b'A') + 1)
+ })
+ .is_some()
+ })
+}
+
/// How far a client-minted id's timestamp may drift from the server clock.
/// Ordering uses the server's `created_at`, so this only needs to catch forged
/// ids; it is wide so a device with a wrong clock can still post.
diff --git a/crates/messages/src/domain/service/test.rs b/crates/messages/src/domain/service/test.rs
index e32d6cb4a0..3c25a12212 100644
--- a/crates/messages/src/domain/service/test.rs
+++ b/crates/messages/src/domain/service/test.rs
@@ -15,6 +15,7 @@ struct Repo {
creates: Arc<Mutex<Vec<CreateMessage>>>,
edits: Arc<Mutex<Vec<EditMessage>>>,
reaction_changed: bool,
+ file_type: Option<String>,
}
impl Repo {
@@ -26,6 +27,10 @@ impl Repo {
}
impl MessageRepository for Repo {
+ async fn document_file_type(&self, _: &str) -> Result<Option<String>, MessageError> {
+ Ok(self.file_type.clone())
+ }
+
async fn preceding(
&self,
_: &MessageParent,
@@ -237,6 +242,7 @@ fn fixture() -> Repo {
creates: Arc::default(),
edits: Arc::default(),
reaction_changed: true,
+ file_type: Some("md".into()),
}
}
@@ -328,26 +334,35 @@ async fn commenters_can_resolve_but_cannot_detach_document_text() {
}
#[tokio::test]
-async fn thread_patch_cannot_detach_pdf_annotations() {
- let mut repo = fixture();
- repo.state.anchor = Some(ThreadAnchor::PdfHighlight {
- anchor_id: Uuid::from_u128(3),
- marked_text: None,
- });
- let events = Events::default();
- let service = MessageService::new(repo.clone(), events.clone());
- let result = service
- .patch_thread(
- access("macro|[email protected]", "doc", AccessLevel::Edit),
- repo.state.root_id,
- ThreadPatch {
- detach_anchor: true,
- ..Default::default()
- },
- )
- .await;
- assert!(matches!(result, Err(MessageError::Invalid(_))));
- assert!(events.0.lock().unwrap().is_empty());
+async fn thread_patch_cannot_detach_non_markdown_anchors() {
+ for anchor in [
+ ThreadAnchor::PdfHighlight {
+ anchor_id: Uuid::from_u128(3),
+ marked_text: None,
+ },
+ ThreadAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget".into(),
+ range: "B4:C9".into(),
+ },
+ ] {
+ let mut repo = fixture();
+ repo.state.anchor = Some(anchor);
+ let events = Events::default();
+ let service = MessageService::new(repo.clone(), events.clone());
+ let result = service
+ .patch_thread(
+ access("macro|[email protected]", "doc", AccessLevel::Edit),
+ repo.state.root_id,
+ ThreadPatch {
+ detach_anchor: true,
+ ..Default::default()
+ },
+ )
+ .await;
+ assert!(matches!(result, Err(MessageError::Invalid(_))));
+ assert!(events.0.lock().unwrap().is_empty());
+ }
}
#[tokio::test]
@@ -1071,6 +1086,10 @@ struct StrictRepo {
}
impl MessageRepository for StrictRepo {
+ async fn document_file_type(&self, id: &str) -> Result<Option<String>, MessageError> {
+ self.inner.document_file_type(id).await
+ }
+
async fn preceding(
&self,
parent: &MessageParent,
@@ -1409,3 +1428,74 @@ async fn reaction_retries_return_the_message_without_publishing_another_change()
}
}
}
+
+#[tokio::test]
+async fn spreadsheet_anchors_require_a_spreadsheet_root_and_valid_range() {
+ for file_type in [
+ None,
+ Some("md"),
+ Some("pdf"),
+ Some("xlsx"),
+ Some("spreadsheet"),
+ ] {
+ let mut repo = fixture();
+ repo.file_type = file_type.map(str::to_owned);
+ let creates = repo.creates.clone();
+ let service = MessageService::new(repo, Events::default());
+ let mut input = post_input();
+ input.anchor = Some(NewThreadAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget".into(),
+ range: "B4:C9".into(),
+ });
+ let result = service
+ .post(
+ access("macro|[email protected]", "doc", AccessLevel::Comment),
+ input.clone(),
+ )
+ .await;
+ assert_eq!(result.is_ok(), file_type == Some("spreadsheet"));
+ assert_eq!(
+ creates.lock().unwrap().len(),
+ usize::from(file_type == Some("spreadsheet"))
+ );
+ input.thread_id = Some(Uuid::from_u128(1));
+ assert!(
+ service
+ .post(
+ access("macro|[email protected]", "doc", AccessLevel::Comment),
+ input.clone()
+ )
+ .await
+ .is_err()
+ );
+ input.thread_id = None;
+ assert!(validate_post(&MessageParent::Channel(Uuid::from_u128(2)), &input).is_err());
+ }
+ for range in ["A1", "B4:C9", "Z100:AA101"] {
+ assert!(valid_spreadsheet_range(range));
+ }
+ for range in [
+ "",
+ "A0",
+ "A01",
+ "a1",
+ "1",
+ "A",
+ "A1:",
+ "A1:B2:C3",
+ "Sheet!A1",
+ "A-1",
+ "A4294967296",
+ "ZZZZZZZZZZ1",
+ ] {
+ assert!(!valid_spreadsheet_range(range), "{range}");
+ }
+ let mut input = post_input();
+ input.anchor = Some(NewThreadAnchor::Spreadsheet {
+ sheet_id: " ".into(),
+ sheet_name: "Budget".into(),
+ range: "A1".into(),
+ });
+ assert!(validate_post(&MessageParent::parse("document", "doc").unwrap(), &input).is_err());
+}
diff --git a/crates/messages/src/outbound/pg_message_repo.rs b/crates/messages/src/outbound/pg_message_repo.rs
index cac3234ad4..3f99e1487b 100644
--- a/crates/messages/src/outbound/pg_message_repo.rs
+++ b/crates/messages/src/outbound/pg_message_repo.rs
@@ -450,7 +450,8 @@ impl PgMessageRepository {
anchor_id, command.parent.entity_id(), command.actor.as_ref(), root_id, page,
x_pct, y_pct, width_pct, height_pct).execute(&mut **tx).await.map_err(database_error)?;
}
- Some(NewThreadAnchor::Markdown { .. }) | None => {}
+ Some(NewThreadAnchor::Markdown { .. } | NewThreadAnchor::Spreadsheet { .. }) | None => {
+ }
}
Ok(())
}
@@ -551,6 +552,17 @@ impl MessageRepository for PgMessageRepository {
self.hydrate(rows).await
}
+ async fn document_file_type(&self, document_id: &str) -> Result<Option<String>, MessageError> {
+ sqlx::query_scalar!(
+ r#"SELECT "fileType" FROM "Document" WHERE id = $1 AND "deletedAt" IS NULL"#,
+ document_id
+ )
+ .fetch_optional(&self.pool)
+ .await
+ .map(Option::flatten)
+ .map_err(database_error)
+ }
+
async fn parent_exists(&self, parent: &MessageParent) -> Result<bool, MessageError> {
let exists = match parent {
MessageParent::Initiative(id) => {
diff --git a/crates/messages/src/outbound/pg_message_repo/test.rs b/crates/messages/src/outbound/pg_message_repo/test.rs
index 9b4c65594f..fa06be9a1e 100644
--- a/crates/messages/src/outbound/pg_message_repo/test.rs
+++ b/crates/messages/src/outbound/pg_message_repo/test.rs
@@ -1289,3 +1289,68 @@ async fn parent_of_names_only_a_live_message_parent(pool: PgPool) {
assert_eq!(repo.parent_of(reply.id).await.unwrap(), None);
assert_eq!(repo.parent_of(Uuid::now_v7()).await.unwrap(), None);
}
+
+#[sqlx::test(migrator = "MACRO_DB_MIGRATIONS")]
+async fn spreadsheet_threads_round_trip_resolve_and_delete(pool: PgPool) {
+ setup(&pool).await;
+ sqlx::query!(r#"UPDATE "Document" SET "fileType" = 'spreadsheet' WHERE id = 'message-doc-a'"#)
+ .execute(&pool)
+ .await
+ .unwrap();
+ let repo = PgMessageRepository::new(pool);
+ assert_eq!(
+ repo.document_file_type("message-doc-a")
+ .await
+ .unwrap()
+ .as_deref(),
+ Some("spreadsheet")
+ );
+ let mut create = command("message-doc-a", None, "Check the budget");
+ create.input.anchor = Some(NewThreadAnchor::Spreadsheet {
+ sheet_id: "sheet-1".into(),
+ sheet_name: "Budget".into(),
+ range: "B4:C9".into(),
+ });
+ let expected = create.input.anchor.as_ref().unwrap().reference();
+ let root = repo.create(create).await.unwrap();
+ let state = repo.thread(&root.parent, root.id).await.unwrap().unwrap();
+ assert_eq!(state.anchor, Some(expected.clone()));
+ repo.create(command("message-doc-a", Some(root.id), "Looks good"))
+ .await
+ .unwrap();
+ let page = repo
+ .timeline(
+ &root.parent,
+ MessageTimelineQuery {
+ anchored: Some(true),
+ ..Default::default()
+ },
+ )
+ .await
+ .unwrap();
+ assert_eq!(page.items.len(), 1);
+ assert_eq!(page.items[0].state.anchor, Some(expected.clone()));
+ assert_eq!(page.items[0].thread.reply_count, 1);
+ let state = repo
+ .patch_thread(
+ &root.parent,
+ root.id,
+ ThreadPatch {
+ resolved: Some(true),
+ ..Default::default()
+ },
+ )
+ .await
+ .unwrap();
+ assert!(state.resolved);
+ assert_eq!(state.anchor, Some(expected));
+ let state = repo.delete_thread(&root.parent, root.id).await.unwrap();
+ assert!(state.deleted_at.is_some());
+ assert!(
+ repo.timeline(&root.parent, MessageTimelineQuery::default())
+ .await
+ .unwrap()
+ .items
+ .is_empty()
+ );
+}
diff --git a/docs/AGENT_GUIDE/documents.md b/docs/AGENT_GUIDE/documents.md
index 39f0ddacab..12ca6983a6 100644
--- a/docs/AGENT_GUIDE/documents.md
+++ b/docs/AGENT_GUIDE/documents.md
@@ -255,9 +255,16 @@ open until dismissed so a reply is not lost when moving the pointer.
**Comments** in the document header opens all workbook threads. Range labels
navigate to the corresponding sheet and cells; deleted-sheet threads remain
-readable. These are the same document annotation comments used by docs/tasks:
-mentions and replies use the existing inbox notifications and comment links.
+readable. **Workbook discussion** contains comments about the whole workbook,
+with its own composer. The pinned composer at the bottom posts on the displayed
+range; **Use selection** changes that range. Both surfaces use the shared message
+controls for replies, edits, deletion, reactions, and attachments. Range threads
+also offer **Resolve** and **Reopen**. Mentions and replies use inbox notifications
+and message links. Older spreadsheet annotation comments are not displayed.
Opening an inbox notification opens the sidebar and targets its comment/range.
+Range links leave Workbook discussion on its normal timeline; workbook links
+open that discussion at the linked message, clear the previous range highlight
+or navigation error, and preserve an open range draft's attachment.
Comment-only access can post/reply; view-only access can read. Edit/delete applies
to the author's own comments, and failures retain the input draft. Draft demos
must be saved before persistent comments are available.
@@ -559,8 +566,10 @@ and edits while updating the surrounding thread.
Select text and choose the comment action to create an anchored comment. These
threads appear beside their text in the margin (or in the active thread drawer
on phones) and never in the bottom Discussion, including after live updates or
-reloads. Existing highlights locate threads by their stable mark IDs. Replies,
-attachments, reactions, and editing use the same message controls as channels.
+reloads. Links to these threads open the margin without changing the bottom
+Discussion's timeline or expanding it. Existing highlights locate threads by
+their stable mark IDs. Replies, attachments, reactions, and editing use the same
+message controls as channels.
Removing the last marked text moves its retained conversation to Discussion,
where it remains after reload. Removing only part of a marked range keeps the
conversation anchored to the remaining text. On phones, the active Markdown
diff --git a/packages/lexical-core/tests/agent-context.test.ts b/packages/lexical-core/tests/agent-context.test.ts
index f6fc6b048e..2f6006ee59 100644
--- a/packages/lexical-core/tests/agent-context.test.ts
+++ b/packages/lexical-core/tests/agent-context.test.ts
@@ -483,6 +483,24 @@ describe('composeAgentContextPrompt', () => {
);
});
+ it('names spreadsheet ranges and directs the agent to live cells', () => {
+ const context = composedContext({
+ promptMarkdown: 'check these totals',
+ anchor: {
+ type: 'spreadsheet',
+ sheetId: 'sheet-1',
+ sheetName: 'Budget & Forecast',
+ range: 'B4:C9',
+ },
+ });
+ expect(context).toContain(
+ '<anchor type="spreadsheet" sheetId="sheet-1" sheetName="Budget &amp; Forecast" range="B4:C9">'
+ );
+ expect(context).toContain(
+ 'Use ReadSpreadsheet to read the live cells in this range.'
+ );
+ });
+
it('says a PDF pin covers no words', () => {
expect(
composedContext({
diff --git a/packages/lexical-core/utils/agent-context.ts b/packages/lexical-core/utils/agent-context.ts
index 169cb7c8dd..2313ca97df 100644
--- a/packages/lexical-core/utils/agent-context.ts
+++ b/packages/lexical-core/utils/agent-context.ts
@@ -79,7 +79,8 @@ export type PdfPinCommentAnchor = {
export type AgentContextAnchor =
| MarkdownCommentAnchor
| PdfHighlightCommentAnchor
- | PdfPinCommentAnchor;
+ | PdfPinCommentAnchor
+ | { type: 'spreadsheet'; sheetId: string; sheetName: string; range: string };
/** Input used to compose an agent prompt with private conversation context. */
export type AgentContextPrompt = {
@@ -251,6 +252,13 @@ function markChildren(mark: MarkdownCommentAnchor): FxpNode[] {
*/
function anchorNode(anchor: AgentContextAnchor): FxpNode {
return match(anchor)
+ .with({ type: 'spreadsheet' }, ({ sheetId, sheetName, range }) =>
+ el(
+ 'anchor',
+ [note('Use ReadSpreadsheet to read the live cells in this range.')],
+ { type: 'spreadsheet', sheetId, sheetName, range }
+ )
+ )
.with({ type: 'pdfPin' }, ({ anchorId }) =>
el(
'anchor',
diff --git a/packages/sdk/generated/storage/types.gen.ts b/packages/sdk/generated/storage/types.gen.ts
index 1058f174c9..955185f94e 100644
--- a/packages/sdk/generated/storage/types.gen.ts
+++ b/packages/sdk/generated/storage/types.gen.ts
@@ -7478,6 +7478,20 @@ export type NewThreadAnchor = {
* Vertical position as a fraction of the page height.
*/
y_pct: number;
+} | {
+ /**
+ * A1 cell or range, such as B4 or B4:C9.
+ */
+ range: string;
+ /**
+ * Stable sheet identity within the workbook.
+ */
+ sheetId: string;
+ /**
+ * Sheet name when the discussion was created.
+ */
+ sheetName: string;
+ type: 'spreadsheet';
};
/**
@@ -10328,7 +10342,7 @@ export type Thread = {
};
/**
- * A thread's location within its document. Geometry remains annotation-owned.
+ * A thread's location within its document. PDF geometry remains annotation-owned.
*/
export type ThreadAnchor = {
/**
@@ -10362,6 +10376,20 @@ export type ThreadAnchor = {
*/
anchor_id: string;
type: 'pdf_placeable';
+} | {
+ /**
+ * A1 cell or range, such as B4 or B4:C9.
+ */
+ range: string;
+ /**
+ * Stable sheet identity within the workbook.
+ */
+ sheetId: string;
+ /**
+ * Sheet name when the discussion was created.
+ */
+ sheetName: string;
+ type: 'spreadsheet';
};
/**
diff --git a/packages/sdk/specs/storage.json b/packages/sdk/specs/storage.json
index 1e31b2ce3a..7e9f51abaa 100644
--- a/packages/sdk/specs/storage.json
+++ b/packages/sdk/specs/storage.json
@@ -26938,6 +26938,29 @@
"description": "Vertical position as a fraction of the page height."
}
}
+ },
+ {
+ "type": "object",
+ "description": "A cell or rectangular range in a native spreadsheet.",
+ "required": ["sheetId", "sheetName", "range", "type"],
+ "properties": {
+ "range": {
+ "type": "string",
+ "description": "A1 cell or range, such as B4 or B4:C9."
+ },
+ "sheetId": {
+ "type": "string",
+ "description": "Stable sheet identity within the workbook."
+ },
+ "sheetName": {
+ "type": "string",
+ "description": "Sheet name when the discussion was created."
+ },
+ "type": {
+ "type": "string",
+ "enum": ["spreadsheet"]
+ }
+ }
}
],
"description": "Location supplied when creating a document discussion."
@@ -31644,9 +31667,32 @@
"enum": ["pdf_placeable"]
}
}
+ },
+ {
+ "type": "object",
+ "description": "A cell or rectangular range in a native spreadsheet.",
+ "required": ["sheetId", "sheetName", "range", "type"],
+ "properties": {
+ "range": {
+ "type": "string",
+ "description": "A1 cell or range, such as B4 or B4:C9."
+ },
+ "sheetId": {
+ "type": "string",
+ "description": "Stable sheet identity within the workbook."
+ },
+ "sheetName": {
+ "type": "string",
+ "description": "Sheet name when the discussion was created."
+ },
+ "type": {
+ "type": "string",
+ "enum": ["spreadsheet"]
+ }
+ }
}
],
- "description": "A thread's location within its document. Geometry remains annotation-owned."
+ "description": "A thread's location within its document. PDF geometry remains annotation-owned."
},
"ThreadOrigin": {
"type": "object",
diff --git a/services/lexical-service/src/endpoints/agent-context.ts b/services/lexical-service/src/endpoints/agent-context.ts
index 16ef869db1..14e5a22f0b 100644
--- a/services/lexical-service/src/endpoints/agent-context.ts
+++ b/services/lexical-service/src/endpoints/agent-context.ts
@@ -17,6 +17,12 @@ const messageParent = z.object({
});
const commentAnchor = z.union([
+ z.object({
+ type: z.literal('spreadsheet'),
+ sheetId: z.string().min(1),
+ sheetName: z.string(),
+ range: z.string().min(1),
+ }),
z.object({
type: z.literal('markdown').optional(),
markId: z.string().min(1),