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.

fix(editor): save titles on close and release connect-time editor state (#8570)

Peter Chinman986c1791d271
diff --git a/.agents/rules/web/solid.md b/.agents/rules/web/solid.md
index d08a3055e9..52f640462d 100644
--- a/.agents/rules/web/solid.md
+++ b/.agents/rules/web/solid.md
@@ -87,3 +87,11 @@ State ownership, reactivity, and async error handling.
`create-calendar-event-form-controller.ts`): without both, the control's
answer edits the state that produced it and the loop only ends in a stack
overflow that takes the app down.
+- **FE-59** Browser callbacks (observers, timers, listeners) run without a
+ Solid owner: `onCleanup` there never runs, and computations created there,
+ including the memo behind a `cond && value` prop read, are never disposed.
+ Wait for an element to enter the document with `onElementConnect` from
+ `@core/util/onElementConnect`, which runs the callback under the caller's
+ owner, and register cleanup for setup-time resources (plugins, debounced
+ saves) at setup, not in that callback. Enforced by ast-grep
+ `ts-/tsx-no-ownerless-element-connect`, CI error.
diff --git a/apps/web/src/features/block-md/comments/MessageCommentsProvider.tsx b/apps/web/src/features/block-md/comments/MessageCommentsProvider.tsx
index 95059ced4e..f97932ce83 100644
--- a/apps/web/src/features/block-md/comments/MessageCommentsProvider.tsx
+++ b/apps/web/src/features/block-md/comments/MessageCommentsProvider.tsx
@@ -20,6 +20,7 @@ import {
} from '@core/component/LexicalMarkdown/plugins/comments/commentPlugin';
import { useParamNavigationCount } from '@core/component/ParamsProvider';
import { useUserId } from '@core/context/user';
+import { onElementConnect } from '@core/util/onElementConnect';
import type { LoroManager } from '@macro-inc/collaboration/collab/manager';
import type { CommentNode } from '@macro-inc/lexical-core';
import {
@@ -29,7 +30,6 @@ import {
import { usePatchThreadMutation } from '@queries/messages/mutations';
import { onThreadStateUpdated } from '@queries/messages/sync';
import type { MessageThread } from '@service-storage/messages';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import {
$getNodeByKey,
COMMAND_PRIORITY_LOW,
diff --git a/apps/web/src/features/block-md/component/ComposeSkill.tsx b/apps/web/src/features/block-md/component/ComposeSkill.tsx
index eeb764298e..b1ee70a41b 100644
--- a/apps/web/src/features/block-md/component/ComposeSkill.tsx
+++ b/apps/web/src/features/block-md/component/ComposeSkill.tsx
@@ -13,12 +13,12 @@ import {
forceSetTextContent,
initializeEditorEmpty,
isRectFlushWith,
- trimWhitespace,
} from '@core/component/LexicalMarkdown/utils';
import type { PortalScope } from '@core/component/ScopedPortal';
import { toast } from '@core/component/Toast/Toast';
import { registerHotkey, useHotkeyDOMScope } from '@core/hotkey/hotkeys';
import { createSkill } from '@core/util/create';
+import { onElementConnect } from '@core/util/onElementConnect';
import { buildSimpleEntityUrl } from '@core/util/url';
import { mergeRegister } from '@lexical/utils';
import { Telemetry } from '@macro-inc/observability';
@@ -26,7 +26,6 @@ import ArrowSquareOutIcon from '@phosphor/arrow-square-out.svg';
import ArrowsOutIcon from '@phosphor/arrows-out.svg';
import SplitIcon from '@phosphor/square-half.svg';
import XIcon from '@phosphor/x.svg';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import { Button, Hotkey, Scroll } from '@ui';
import {
$getRoot,
@@ -105,6 +104,7 @@ function ComposeSkillTitleEditor(props: {
type: 'title',
isInteractable: () => !props.disabled(),
});
+ onCleanup(cleanup);
initializeEditorEmpty(editor);
forceSetTextContent(editor, props.value());
@@ -162,10 +162,6 @@ function ComposeSkillTitleEditor(props: {
const onConnect = (el: HTMLDivElement) => {
editor.setRootElement(el);
setRootConnected(true);
- onCleanup(() => {
- trimWhitespace(editor, { trailing: true });
- cleanup();
- });
};
return (
diff --git a/apps/web/src/features/block-md/component/ComposeTask.tsx b/apps/web/src/features/block-md/component/ComposeTask.tsx
index 1ea352eb00..12e78ef900 100644
--- a/apps/web/src/features/block-md/component/ComposeTask.tsx
+++ b/apps/web/src/features/block-md/component/ComposeTask.tsx
@@ -21,13 +21,13 @@ import {
forceSetTextContent,
initializeEditorEmpty,
isRectFlushWith,
- trimWhitespace,
} from '@core/component/LexicalMarkdown/utils';
import type { PortalScope } from '@core/component/ScopedPortal';
import { toast } from '@core/component/Toast/Toast';
import { useUserId } from '@core/context/user';
import { registerHotkey, useHotkeyDOMScope } from '@core/hotkey/hotkeys';
import { fireAndForget } from '@core/util/fireAndForget';
+import { onElementConnect } from '@core/util/onElementConnect';
import { buildSimpleEntityUrl } from '@core/util/url';
import { mergeRegister } from '@lexical/utils';
import { Telemetry } from '@macro-inc/observability';
@@ -44,7 +44,6 @@ import type { PropertyApiValues } from '@property/types';
import { queryReadyGate } from '@queries/gate';
import { useUpsertToHistoryMutation } from '@queries/history/history';
import { useUserTeamsQuery } from '@queries/team/teams';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import { debounce } from '@solid-primitives/scheduled';
import { Button, EntityComposer, Scroll, ToggleSwitch, Tooltip } from '@ui';
import {
@@ -211,6 +210,7 @@ export function ComposeTaskTitleEditor(props: {
type: 'title',
isInteractable: () => !props.disabled(),
});
+ onCleanup(cleanup);
const emojiMenuOperations = createMenuOperations();
const tagMenuOperations = createMenuOperations();
@@ -294,10 +294,6 @@ export function ComposeTaskTitleEditor(props: {
const onConnect = (el: HTMLDivElement) => {
editor.setRootElement(el);
setRootConnected(true);
- onCleanup(() => {
- trimWhitespace(editor, { trailing: true });
- cleanup();
- });
};
return (
diff --git a/apps/web/src/features/block-md/component/InstructionsEditor.tsx b/apps/web/src/features/block-md/component/InstructionsEditor.tsx
index 06ad69d90d..7cec248b07 100644
--- a/apps/web/src/features/block-md/component/InstructionsEditor.tsx
+++ b/apps/web/src/features/block-md/component/InstructionsEditor.tsx
@@ -37,6 +37,7 @@ import {
setEditorStateFromMarkdown,
} from '@core/component/LexicalMarkdown/utils';
import { ENABLE_MARKDOWN_LIVE_COLLABORATION } from '@core/constant/featureFlags';
+import { onElementConnect } from '@core/util/onElementConnect';
import { bufToString } from '@core/util/string';
import type { LoroManager } from '@macro-inc/collaboration/collab/manager';
import {
@@ -48,7 +49,6 @@ import {
peerIdPlugin,
} from '@macro-inc/lexical-core';
import { Telemetry } from '@macro-inc/observability';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import { debounce } from '@solid-primitives/scheduled';
import type { EditorState } from 'lexical';
import {
diff --git a/apps/web/src/features/block-md/component/MarkdownEditor.tsx b/apps/web/src/features/block-md/component/MarkdownEditor.tsx
index 44f0c74065..2d58fe0b89 100644
--- a/apps/web/src/features/block-md/component/MarkdownEditor.tsx
+++ b/apps/web/src/features/block-md/component/MarkdownEditor.tsx
@@ -83,6 +83,7 @@ import { useIsAuthenticated } from '@core/context/user';
import { fileFolderDrop } from '@core/directive/fileFolderDrop';
import { isNativeMobilePlatform } from '@core/mobile/isNativeMobilePlatform';
import { fireAndForget } from '@core/util/fireAndForget';
+import { onElementConnect } from '@core/util/onElementConnect';
import { bufToString } from '@core/util/string';
import type { LoroManager } from '@macro-inc/collaboration/collab/manager';
import {
@@ -93,7 +94,6 @@ import {
import { Telemetry } from '@macro-inc/observability';
import { useDocTags } from '@property/tags';
import { EntityType } from '@service-properties/generated/schemas/entityType';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import { isIOS } from '@solid-primitives/platform';
import { createCallback } from '@solid-primitives/rootless';
import { debounce } from '@solid-primitives/scheduled';
diff --git a/apps/web/src/features/block-md/component/TitleEditor.test.tsx b/apps/web/src/features/block-md/component/TitleEditor.test.tsx
new file mode 100644
index 0000000000..674cffcfd1
--- /dev/null
+++ b/apps/web/src/features/block-md/component/TitleEditor.test.tsx
@@ -0,0 +1,77 @@
+import { render } from '@solidjs/testing-library';
+import { $createParagraphNode, $createTextNode, $getRoot } from 'lexical';
+import { afterEach, expect, it, vi } from 'vitest';
+import { MarkdownDocumentProvider } from '../context/markdown-document-context';
+import { createMarkdownDocumentState } from '../context/markdown-document-state';
+import { MarkdownNameProvider } from './MarkdownNameProvider';
+import { TitleEditor } from './TitleEditor';
+
+const rename = vi.hoisted(() => vi.fn());
+vi.mock('@entity', () => ({
+ createRenameDssEntityMutation: () => ({ mutate: rename }),
+}));
+vi.mock('@property/tags', () => ({ useDocTags: () => ({}) }));
+vi.mock('@core/component/LexicalMarkdown/component/menu/EmojiMenu', () => ({
+ EmojiMenu: () => null,
+}));
+vi.mock('@core/component/LexicalMarkdown/component/menu/TagsMenu', () => ({
+ TagsMenu: () => null,
+}));
+
+afterEach(() => {
+ vi.unstubAllGlobals();
+});
+
+it('saves a title edited just before the document closes', () => {
+ // The title connects from a ResizeObserver callback, as in the browser.
+ const observers: Array<() => void> = [];
+ vi.stubGlobal(
+ 'ResizeObserver',
+ class {
+ constructor(callback: () => void) {
+ observers.push(callback);
+ }
+ observe() {}
+ disconnect() {}
+ }
+ );
+ const state = createMarkdownDocumentState();
+ const { unmount } = render(() => (
+ <MarkdownDocumentProvider
+ context={{
+ documentId: () => 'document-1',
+ kind: () => 'document',
+ documentSource: () => ({ type: 'loading' }),
+ permissions: {
+ canComment: () => true,
+ canEdit: () => true,
+ isOwner: () => true,
+ },
+ persistedName: () => 'Old title',
+ fallbackName: () => 'New Document',
+ state,
+ element: () => undefined,
+ }}
+ >
+ <MarkdownNameProvider>
+ <TitleEditor />
+ </MarkdownNameProvider>
+ </MarkdownDocumentProvider>
+ ));
+ for (const connect of observers) connect();
+
+ state.editor.md.titleEditor?.update(
+ () => {
+ $getRoot()
+ .clear()
+ .append($createParagraphNode().append($createTextNode('New title')));
+ },
+ { discrete: true }
+ );
+ unmount();
+
+ expect(rename).toHaveBeenCalledWith({
+ entity: { type: 'document', id: 'document-1', name: 'Old title' },
+ newName: 'New title',
+ });
+});
diff --git a/apps/web/src/features/block-md/component/TitleEditor.tsx b/apps/web/src/features/block-md/component/TitleEditor.tsx
index 923fa0c8d8..6724b9ad30 100644
--- a/apps/web/src/features/block-md/component/TitleEditor.tsx
+++ b/apps/web/src/features/block-md/component/TitleEditor.tsx
@@ -18,11 +18,11 @@ import {
} from '@core/component/LexicalMarkdown/utils';
import { blockNameToDefaultFile } from '@core/constant/allBlocks';
import { fireAndForget } from '@core/util/fireAndForget';
+import { onElementConnect } from '@core/util/onElementConnect';
import { createRenameDssEntityMutation } from '@entity';
import { mergeRegister } from '@lexical/utils';
import { useDocTags } from '@property/tags';
import { EntityType } from '@service-properties/generated/schemas/entityType';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import { debounce } from '@solid-primitives/scheduled';
import {
$createParagraphNode,
@@ -206,6 +206,8 @@ export function TitleEditor(props: { autoFocusOnMount?: boolean } = {}) {
};
const debouncedFlushRename = debounce(flushPendingRename, 400);
+ // Unmount cancels the debounce timer, so save a pending rename now.
+ onCleanup(flushPendingRename);
const [state, setState] = createSignal('');
const [initialized, setInitialized] = createSignal(false);
@@ -217,6 +219,7 @@ export function TitleEditor(props: { autoFocusOnMount?: boolean } = {}) {
return canEdit() ?? false;
}),
});
+ onCleanup(cleanup);
initializeEditorEmpty(editor);
@@ -282,9 +285,6 @@ export function TitleEditor(props: { autoFocusOnMount?: boolean } = {}) {
el.addEventListener('blur', onBlur);
setRootConnected(true);
onCleanup(() => {
- debouncedFlushRename.clear();
- flushPendingRename();
- cleanup();
el.removeEventListener('focus', onFocus);
el.removeEventListener('blur', onBlur);
});
diff --git a/apps/web/src/lib/core/collab-surface/CollabMarkdownEditor.tsx b/apps/web/src/lib/core/collab-surface/CollabMarkdownEditor.tsx
index 71cacbde24..244ead5ba6 100644
--- a/apps/web/src/lib/core/collab-surface/CollabMarkdownEditor.tsx
+++ b/apps/web/src/lib/core/collab-surface/CollabMarkdownEditor.tsx
@@ -20,8 +20,8 @@ import {
initializeEditorEmpty,
} from '@core/component/LexicalMarkdown/utils';
import { fileFolderDrop } from '@core/directive/fileFolderDrop';
+import { onElementConnect } from '@core/util/onElementConnect';
import { createPeerIdValidator } from '@macro-inc/lexical-core';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import type { LexicalEditor } from 'lexical';
import {
type Accessor,
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/builder/MarkdownShell.tsx b/apps/web/src/lib/core/component/LexicalMarkdown/builder/MarkdownShell.tsx
index 399c60a687..691b140ea3 100644
--- a/apps/web/src/lib/core/component/LexicalMarkdown/builder/MarkdownShell.tsx
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/builder/MarkdownShell.tsx
@@ -1,8 +1,8 @@
import { fileFolderDrop } from '@core/directive/fileFolderDrop';
import { isMobile } from '@core/mobile/isMobile';
+import { onElementConnect } from '@core/util/onElementConnect';
import { handleFileFolderDrop } from '@core/util/upload';
import { Telemetry } from '@macro-inc/observability';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import { cn } from '@ui';
import {
COMMAND_PRIORITY_CRITICAL,
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/MarkdownTextarea.tsx b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/MarkdownTextarea.tsx
index 9901c4e19e..4e3a2013b4 100644
--- a/apps/web/src/lib/core/component/LexicalMarkdown/component/core/MarkdownTextarea.tsx
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/component/core/MarkdownTextarea.tsx
@@ -1,9 +1,9 @@
import type { PortalScope } from '@core/component/ScopedPortal';
import { isNativeMobilePlatform } from '@core/mobile/isNativeMobilePlatform';
import type { ChannelWithParticipants } from '@core/user';
+import { onElementConnect } from '@core/util/onElementConnect';
import type { EditorType } from '@macro-inc/lexical-core';
import type { HistoryItem } from '@queries/history/types';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import { isIOS } from '@solid-primitives/platform';
import { cn } from '@ui';
import {
diff --git a/apps/web/src/lib/core/component/LexicalMarkdown/component/decorator/browser-test/pr-mention.tsx b/apps/web/src/lib/core/component/LexicalMarkdown/component/decorator/browser-test/pr-mention.tsx
index a090eed2fc..c80c7d9161 100644
--- a/apps/web/src/lib/core/component/LexicalMarkdown/component/decorator/browser-test/pr-mention.tsx
+++ b/apps/web/src/lib/core/component/LexicalMarkdown/component/decorator/browser-test/pr-mention.tsx
@@ -1,11 +1,11 @@
import '@app/index.css';
import { AnalyticsContextProvider } from '@app/lib/analytics/analytics-context';
import { PosthogProvider } from '@app/lib/analytics/posthog';
+import { onElementConnect } from '@core/util/onElementConnect';
import { PullRequestMentionNode } from '@macro-inc/lexical-core';
import { setDecorator } from '@macro-inc/lexical-core/decoratorRegistry';
import { pullRequestMentionKeys } from '@queries/storage/keys';
import type { ForeignEntity } from '@service-storage/generated/schemas';
-import { onElementConnect } from '@solid-primitives/lifecycle';
import { QueryClient, QueryClientProvider } from '@tanstack/solid-query';
import { createSignal, For, onCleanup } from 'solid-js';
import { render } from 'solid-js/web';
diff --git a/apps/web/src/lib/core/util/onElementConnect.test.tsx b/apps/web/src/lib/core/util/onElementConnect.test.tsx
new file mode 100644
index 0000000000..372026f60b
--- /dev/null
+++ b/apps/web/src/lib/core/util/onElementConnect.test.tsx
@@ -0,0 +1,45 @@
+import { render } from '@solidjs/testing-library';
+import { createMemo, createSignal, onCleanup } from 'solid-js';
+import { afterEach, expect, it, vi } from 'vitest';
+import { onElementConnect } from './onElementConnect';
+
+afterEach(() => {
+ vi.unstubAllGlobals();
+});
+
+it('releases cleanups and computations made once the element connects', () => {
+ // A ref runs before its element is attached, so the connection arrives
+ // from a ResizeObserver callback, outside any Solid owner.
+ const observers: Array<() => void> = [];
+ vi.stubGlobal(
+ 'ResizeObserver',
+ class {
+ constructor(callback: () => void) {
+ observers.push(callback);
+ }
+ observe() {}
+ disconnect() {}
+ }
+ );
+ const [value, setValue] = createSignal(0);
+ const reads: number[] = [];
+ let cleanups = 0;
+ const { unmount } = render(() => (
+ <div
+ ref={(element) =>
+ onElementConnect(element, () => {
+ createMemo(() => reads.push(value()));
+ onCleanup(() => {
+ cleanups += 1;
+ });
+ })
+ }
+ />
+ ));
+ for (const connect of observers) connect();
+
+ unmount();
+ setValue(1);
+
+ expect({ cleanups, reads }).toEqual({ cleanups: 1, reads: [0] });
+});
diff --git a/apps/web/src/lib/core/util/onElementConnect.ts b/apps/web/src/lib/core/util/onElementConnect.ts
new file mode 100644
index 0000000000..8a0171c981
--- /dev/null
+++ b/apps/web/src/lib/core/util/onElementConnect.ts
@@ -0,0 +1,13 @@
+import * as lifecycle from '@solid-primitives/lifecycle';
+import { createCallback } from '@solid-primitives/rootless';
+
+/**
+ * Calls `callback` once `element` is in the document, under the caller's
+ * Solid owner. A ref runs before its element is attached, so the
+ * solid-primitives version almost always calls back from a ResizeObserver
+ * with no owner: `onCleanup` there never runs, and computations created
+ * there (including reads of `cond && value` props) are never disposed.
+ */
+export function onElementConnect(element: Element, callback: () => void) {
+ lifecycle.onElementConnect(element, createCallback(callback));
+}
diff --git a/rules/ast-grep/ts-no-ownerless-element-connect.yml b/rules/ast-grep/ts-no-ownerless-element-connect.yml
new file mode 100644
index 0000000000..6bf825747f
--- /dev/null
+++ b/rules/ast-grep/ts-no-ownerless-element-connect.yml
@@ -0,0 +1,26 @@
+id: ts-no-ownerless-element-connect
+language: typescript
+# Twin of tsx-no-ownerless-element-connect — ast-grep rules are
+# single-language, and `typescript` only scans .ts files.
+severity: error
+message: Import onElementConnect from @core/util/onElementConnect, which runs the callback under the caller's Solid owner.
+note: |-
+ Rule FE-59 in .agents/rules/web/solid.md. A ref runs before its element is
+ attached, so the @solid-primitives/lifecycle version almost always calls back
+ from a ResizeObserver with no owner: onCleanup there never runs, and
+ computations created there are never disposed.
+files:
+ - apps/web/src/**
+ignores:
+ - apps/web/src/lib/core/util/onElementConnect.ts
+rule:
+ kind: import_specifier
+ has:
+ field: name
+ regex: ^onElementConnect$
+ inside:
+ kind: import_statement
+ stopBy: end
+ has:
+ field: source
+ regex: ^['"]@solid-primitives/lifecycle['"]$
diff --git a/rules/ast-grep/tsx-no-ownerless-element-connect.yml b/rules/ast-grep/tsx-no-ownerless-element-connect.yml
new file mode 100644
index 0000000000..ed6635c586
--- /dev/null
+++ b/rules/ast-grep/tsx-no-ownerless-element-connect.yml
@@ -0,0 +1,26 @@
+id: tsx-no-ownerless-element-connect
+language: tsx
+# Twin of ts-no-ownerless-element-connect — ast-grep rules are
+# single-language, and `tsx` only scans .tsx files.
+severity: error
+message: Import onElementConnect from @core/util/onElementConnect, which runs the callback under the caller's Solid owner.
+note: |-
+ Rule FE-59 in .agents/rules/web/solid.md. A ref runs before its element is
+ attached, so the @solid-primitives/lifecycle version almost always calls back
+ from a ResizeObserver with no owner: onCleanup there never runs, and
+ computations created there are never disposed.
+files:
+ - apps/web/src/**
+ignores:
+ - apps/web/src/lib/core/util/onElementConnect.ts
+rule:
+ kind: import_specifier
+ has:
+ field: name
+ regex: ^onElementConnect$
+ inside:
+ kind: import_statement
+ stopBy: end
+ has:
+ field: source
+ regex: ^['"]@solid-primitives/lifecycle['"]$