Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions js/app/packages/block-md/component/MarkdownEditor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@ import {
type NodekeyOffset,
SearchHighlight,
} from '@core/component/LexicalMarkdown/plugins/find-and-replace';
import {
createHoverTooltipStore,
HoverTooltip,
hoverTooltipPlugin,
} from '@core/component/LexicalMarkdown/plugins/hover-tooltip';
import { iosCursorScrollPlugin } from '@core/component/LexicalMarkdown/plugins/ios-cursor-scroll';
import {
GO_TO_LOCATION_COMMAND,
Expand Down Expand Up @@ -923,6 +928,9 @@ export function MarkdownEditor(props: {
},
});

const [hoverTooltipStore, setHoverTooltipStore] = createHoverTooltipStore();
plugins.use(hoverTooltipPlugin({ setState: (s) => setHoverTooltipStore(s) }));

const [wordcountStats, setWordcountStats] = createWordcountStatsStore();
plugins.use(
wordcountPlugin({ setStore: setWordcountStats, debounceTime: 200 })
Expand Down Expand Up @@ -996,6 +1004,7 @@ export function MarkdownEditor(props: {
{getBlankMarkdownPlaceholder(canEdit())}
</div>
</Show>
<HoverTooltip state={hoverTooltipStore} documentId={blockId} />
<DecoratorRenderer editor={editor} />
<NodeAccessoryRenderer editor={editor} store={accessoryStore} />

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
import { UserIcon } from '@core/component/UserIcon';
import { macroIdToEmail, tryMacroId, useDisplayNameParts } from '@core/user';
import { formatRelativeTimestamp } from '@entity';
import { syncServiceClient } from '@service-sync/client';
import { debounce } from '@solid-primitives/scheduled';
import {
createEffect,
createResource,
createSignal,
onCleanup,
Show,
untrack,
} from 'solid-js';
import type { Store } from 'solid-js/store';
import type { HoverTooltipState } from './hoverTooltipPlugin';

const FETCH_DELAY_MS = 400;
const SHOW_DELAY_MS = 500;

function UserLine(props: { userId: string; editedAt: Date }) {
const macroId = tryMacroId(props.userId);
const { firstName } = useDisplayNameParts(macroId);
const name = () =>
firstName() || (macroId ? macroIdToEmail(macroId) : props.userId);

return (
<span class="inline-flex items-center gap-1">
<UserIcon id={props.userId} size="sm" suppressClick showTooltip={false} />
{name()}, {formatRelativeTimestamp(props.editedAt)}
</span>
);
}

export function HoverTooltip(props: {
state: Store<HoverTooltipState>;
documentId: string;
}) {
const [visible, setVisible] = createSignal(false);
// The nodeId we've actually committed to fetching for. Debounced from the
// raw hovered nodeId so we don't fire a request the instant the cursor
// crosses a text node.
const [armedNodeId, setArmedNodeId] = createSignal<string | null>(null);
let shownAtX = 0;
let shownAtY = 0;
let showTimer: ReturnType<typeof setTimeout> | null = null;

const debouncedArm = debounce((nodeId: string | null) => {
setArmedNodeId(nodeId);
}, FETCH_DELAY_MS);

const hide = () => {
debouncedArm.clear();
if (showTimer) clearTimeout(showTimer);
showTimer = null;
setArmedNodeId(null);
setVisible(false);
};

const [blame] = createResource(armedNodeId, async (nodeId) => {
const res = await syncServiceClient.getNodeBlame({
documentId: props.documentId,
nodeId,
});
return res.isOk() ? res.value : null;
});

// Drive the fetch — debounced on nodeId only, ignores cursor x/y.
createEffect(() => {
const nodeId = props.state.hovering ? props.state.nodeId : null;
if (nodeId === null) {
debouncedArm.clear();
setArmedNodeId(null);
} else {
debouncedArm(nodeId);
}
});

// Drive the visibility — based on cursor stillness (x/y).
createEffect(() => {
const { hovering, x, y } = props.state;

if (!hovering) return hide();

// After shown: any pointer move dismisses.
if (untrack(visible)) {
if (x !== shownAtX || y !== shownAtY) hide();
return;
}

// Pre-show: each move restarts the show timer.
if (showTimer) clearTimeout(showTimer);
showTimer = setTimeout(() => {
shownAtX = x;
shownAtY = y;
setVisible(true);
}, SHOW_DELAY_MS);
});

onCleanup(hide);

return (
<Show when={visible() && blame()?.userId ? blame() : null}>
{(b) => (
<div
class="fixed z-50 text-xs text-ink-secondary/70 pointer-events-none"
style={{
left: `${props.state.x + 12}px`,
top: `${props.state.y + 12}px`,
}}
>
<UserLine userId={b().userId!} editedAt={b().editedAt} />
</div>
)}
</Show>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
import { isTouchDevice } from '@core/mobile/isTouchDevice';
import { mergeRegister } from '@lexical/utils';
import { $getId } from '@lexical-core';
import {
$getNearestNodeFromDOMNode,
$isTextNode,
type LexicalEditor,
type LexicalNode,
} from 'lexical';
import { createStore } from 'solid-js/store';

export type HoverTooltipState = {
hovering: boolean;
x: number;
y: number;
nodeId: string | null;
};

export function createHoverTooltipStore() {
return createStore<HoverTooltipState>({
hovering: false,
x: 0,
y: 0,
nodeId: null,
});
}

type HoverTooltipPluginProps = {
setState: (state: Partial<HoverTooltipState>) => void;
};

/**
* Given a DOM element under the cursor, find the stable Lexical id of the
* nearest ancestor text-bearing node. Must be called inside `editor.read()`
* so the Lexical state is readable.
*
* Returns null when the cursor isn't over a text node, or when no ancestor
* has been assigned a stable id yet (typically transient nodes).
*/
function $resolveHoveredNodeId(target: HTMLElement): string | null {
const node = $getNearestNodeFromDOMNode(target);
if (!node || !$isTextNode(node)) return null;

let cursor: LexicalNode | null = node;
while (cursor) {
const id = $getId(cursor);
if (id) return id;
cursor = cursor.getParent();
}
return null;
}

function registerHoverTooltipPlugin(
editor: LexicalEditor,
props: HoverTooltipPluginProps
) {
const handlePointerMove = (e: MouseEvent) => {
if (isTouchDevice()) return;
const target = e.target;
if (!(target instanceof HTMLElement)) {
props.setState({ hovering: false, nodeId: null });
return;
}

// Suppress while the user has a text selection — that's when the
// formatting popup shows and the tooltip would compete with it.
const sel = window.getSelection();
if (sel && !sel.isCollapsed && sel.toString().length > 0) {
props.setState({ hovering: false, nodeId: null });
return;
}

const nodeId = editor.read(() => $resolveHoveredNodeId(target));
if (nodeId === null) {
props.setState({ hovering: false, nodeId: null });
return;
}
props.setState({
hovering: true,
x: e.clientX,
y: e.clientY,
nodeId,
});
};

const dismiss = () => {
props.setState({ hovering: false, nodeId: null });
};

return mergeRegister(
editor.registerRootListener((root, prevRoot) => {
if (root) {
root.addEventListener('pointermove', handlePointerMove);
root.addEventListener('pointerleave', dismiss);
root.addEventListener('pointerdown', dismiss);
}
if (prevRoot) {
prevRoot.removeEventListener('pointermove', handlePointerMove);
prevRoot.removeEventListener('pointerleave', dismiss);
prevRoot.removeEventListener('pointerdown', dismiss);
}
})
);
}

export function hoverTooltipPlugin(props: HoverTooltipPluginProps) {
return (editor: LexicalEditor) => registerHoverTooltipPlugin(editor, props);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export * from './HoverTooltip';
export * from './hoverTooltipPlugin';
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ export * from './file-paste';
export * from './find-and-replace';
export * from './generate';
export * from './horizontal-rules';
export * from './hover-tooltip';
export * from './insert-text';
export * from './ios-cursor-scroll';
export * from './katex';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { checklistPlugin } from './checklist/';
import { customDeletePlugin } from './custom-delete';
import { markdownShortcutsPlugin } from './markdown-shortcuts';

type PluginFunction = (editor: LexicalEditor) => () => void;
export type PluginFunction = (editor: LexicalEditor) => () => void;

/**
* Create a binding between a LexicalEditor and the ability to register plugins
Expand Down
30 changes: 30 additions & 0 deletions js/app/packages/service-clients/service-sync/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,36 @@ export const syncServiceClient = {

return ok(response.value as MetadataResponse);
},
/**
* Look up who last edited a given Lexical node and when. `user_id` is a
* MacroId resolved server-side; `null` if the peer has no recorded user
* (anonymous edits or legacy data not yet mirrored locally).
*/
async getNodeBlame(args: { documentId: string; nodeId: string }) {
const token = await getPermissionToken('document', args.documentId);

const response = await syncFetch<{
peer_id: string;
user_id: string | null;
timestamp_ms: number;
}>(`/document/${args.documentId}/blame/${args.nodeId}`, {
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${token}`,
},
method: 'GET',
});

if (response.isErr()) {
return err(response.error);
}
const { peer_id, user_id, timestamp_ms } = response.value;
return ok({
peerId: peer_id,
userId: user_id,
editedAt: new Date(timestamp_ms),
});
},
async getSnapshot(args: { documentId: string }) {
const token = await getPermissionToken('document', args.documentId);
const response = await platformFetch(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
CREATE TABLE blame (
document_id TEXT NOT NULL,
node_id TEXT NOT NULL,
peer_id TEXT NOT NULL,
timestamp_ms INTEGER NOT NULL,
PRIMARY KEY (document_id, node_id)
);
Comment on lines +1 to +7

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Migration is not idempotent.

The CREATE TABLE lacks IF NOT EXISTS, so re-running this migration will fail. Per the SQL coding guidelines, migrations should be idempotent where possible.

🔄 Suggested fix
-CREATE TABLE blame (
+CREATE TABLE IF NOT EXISTS blame (
     document_id  TEXT NOT NULL,
     node_id      TEXT NOT NULL,
     peer_id      TEXT NOT NULL,
     timestamp_ms INTEGER NOT NULL,
     PRIMARY KEY (document_id, node_id)
 );
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
CREATE TABLE blame (
document_id TEXT NOT NULL,
node_id TEXT NOT NULL,
peer_id TEXT NOT NULL,
timestamp_ms INTEGER NOT NULL,
PRIMARY KEY (document_id, node_id)
);
CREATE TABLE IF NOT EXISTS blame (
document_id TEXT NOT NULL,
node_id TEXT NOT NULL,
peer_id TEXT NOT NULL,
timestamp_ms INTEGER NOT NULL,
PRIMARY KEY (document_id, node_id)
);
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@rust/sync-service/database/user-peer-mapping/migrations/0002_add_blame.sql`
around lines 1 - 7, The migration creates the "blame" table but is not
idempotent; update the CREATE TABLE statement in 0002_add_blame.sql to be
idempotent by using CREATE TABLE IF NOT EXISTS for the blame table so re-running
the migration will not fail, keeping the same columns (document_id, node_id,
peer_id, timestamp_ms) and the PRIMARY KEY (document_id, node_id).

Source: Coding guidelines


CREATE INDEX idx_blame_document_id ON blame (document_id);
Loading
Loading