mirror of
https://github.com/outline/outline.git
synced 2026-11-21 21:44:30 +03:00
fix: Crash when a remote edit arrives during a column resize (#13452)
Every remote change is applied as a full document replacement, which invalidates the column resize handle while the drag is still active. Releasing the pointer then resolved position -1 and threw. Cancel the drag when the handle no longer points at a cell. Fixes OUTLINE-CLOUD-B3R
This commit is contained in:
1 parent
628615f9bc
commit
cdc10b4564
3 files changed
+102
No files matched your search
@@ -43,6 +43,7 @@ import {
|
||||
} from "../commands/table";
|
||||
import type { MarkdownSerializerState } from "../lib/markdown/serializer";
|
||||
import { FixTablesPlugin } from "../plugins/FixTablesPlugin";
|
||||
import { TableColumnResizePlugin } from "../plugins/TableColumnResizePlugin";
|
||||
import { TableLayoutPlugin } from "../plugins/TableLayoutPlugin";
|
||||
import tablesRule from "../rules/tables";
|
||||
import { EditorStyleHelper } from "../styles/EditorStyleHelper";
|
||||
@@ -168,6 +169,7 @@ export default class Table extends Node {
|
||||
defaultCellMinWidth: 25,
|
||||
}),
|
||||
tableEditing(),
|
||||
new TableColumnResizePlugin(),
|
||||
new FixTablesPlugin(),
|
||||
new TableLayoutPlugin(),
|
||||
];
|
||||
|
||||
@@ -0,0 +1,66 @@
|
||||
import { Fragment, Slice } from "prosemirror-model";
|
||||
import type { EditorState } from "prosemirror-state";
|
||||
import { columnResizing, columnResizingPluginKey } from "prosemirror-tables";
|
||||
import {
|
||||
createEditorState,
|
||||
doc,
|
||||
p,
|
||||
schema,
|
||||
table,
|
||||
td,
|
||||
tr,
|
||||
} from "@shared/test/editor";
|
||||
import { TableColumnResizePlugin } from "./TableColumnResizePlugin";
|
||||
|
||||
/** Position of the first cell in a document that starts with a table. */
|
||||
const firstCellPos = 2;
|
||||
|
||||
function startResizing(state: EditorState, handle: number) {
|
||||
const withHandle = state.apply(
|
||||
state.tr.setMeta(columnResizingPluginKey, { setHandle: handle })
|
||||
);
|
||||
return withHandle.apply(
|
||||
withHandle.tr.setMeta(columnResizingPluginKey, {
|
||||
setDragging: { startX: 0, startWidth: 100 },
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
describe("TableColumnResizePlugin", () => {
|
||||
const createState = () =>
|
||||
createEditorState(doc(table([tr([td("A"), td("B")])])), [
|
||||
columnResizing(),
|
||||
new TableColumnResizePlugin(),
|
||||
]);
|
||||
|
||||
it("should cancel dragging when the document is replaced under the handle", () => {
|
||||
const state = startResizing(createState(), firstCellPos);
|
||||
expect(columnResizingPluginKey.getState(state)?.dragging).toBeTruthy();
|
||||
|
||||
// Mimic the whole document replacement that y-prosemirror dispatches when a
|
||||
// remote change arrives, which invalidates the drag handle.
|
||||
const newState = state.apply(
|
||||
state.tr.replace(
|
||||
0,
|
||||
state.doc.content.size,
|
||||
new Slice(Fragment.from(p("Replaced")), 0, 0)
|
||||
)
|
||||
);
|
||||
|
||||
const resizeState = columnResizingPluginKey.getState(newState);
|
||||
expect(resizeState?.activeHandle).toBe(-1);
|
||||
expect(resizeState?.dragging).toBe(null);
|
||||
});
|
||||
|
||||
it("should keep dragging when the handle survives the change", () => {
|
||||
const state = startResizing(createState(), firstCellPos);
|
||||
|
||||
const newState = state.apply(
|
||||
state.tr.insert(state.doc.content.size, schema.nodes.paragraph.create())
|
||||
);
|
||||
|
||||
const resizeState = columnResizingPluginKey.getState(newState);
|
||||
expect(resizeState?.activeHandle).toBe(firstCellPos);
|
||||
expect(resizeState?.dragging).toBeTruthy();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,34 @@
|
||||
import type { Transaction, EditorState } from "prosemirror-state";
|
||||
import { Plugin } from "prosemirror-state";
|
||||
import { columnResizingPluginKey } from "prosemirror-tables";
|
||||
|
||||
/**
|
||||
* A ProseMirror plugin that cancels an in-progress column resize once the drag
|
||||
* handle no longer points at a cell. The handle is invalidated whenever the
|
||||
* document is replaced under the pointer, such as by a collaborative edit from
|
||||
* another user, and resizing with an invalid handle throws.
|
||||
*/
|
||||
export class TableColumnResizePlugin extends Plugin {
|
||||
constructor() {
|
||||
super({
|
||||
appendTransaction: (
|
||||
transactions: readonly Transaction[],
|
||||
_oldState: EditorState,
|
||||
newState: EditorState
|
||||
) => {
|
||||
if (!transactions.some((transaction) => transaction.docChanged)) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const resizeState = columnResizingPluginKey.getState(newState);
|
||||
if (!resizeState?.dragging || resizeState.activeHandle > -1) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
return newState.tr.setMeta(columnResizingPluginKey, {
|
||||
setDragging: null,
|
||||
});
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user