[CB] Improve undo/redo behavior for Data Editor #4060

sergeyteleshev · 2026-01-15T22:33:17Z

closes dbeaver/pro#7614

…s bugs)

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditAction.ts

Wroud · 2026-01-16T10:11:18Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditAction.ts

+    if (isSameKey) {
+      this.history.update(lastIndex, {
+        data: {
+          key,
+          value,
+          prevValue,
+        },
+      });
+
+      return;
+    }


not sure about this, because you might change same cell few times with a delay and when you will revert it you will expect that it will revert to previous edit

Now I compress everything to 1 history item unless we are currently editing the cell. If we're editing the cell right now, it remembers each typed letter. Then, if we type something in another cell, it compresses all of the history for previous cells to 1 item by cell

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryAction.ts

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditAction.ts

Copilot

Pull request overview

This pull request implements comprehensive undo/redo functionality for the Data Editor in CloudBeaver. The implementation introduces a history tracking system that records all editing operations (cell edits, row additions/deletions, duplications, reverts, and cancellations) and allows users to undo and redo these operations using keyboard shortcuts (Ctrl+Z for undo, Ctrl+Shift+Z or Ctrl+Y for redo).

Changes:

Introduced a new history management system with GridHistoryAction, GridHistoryTypes, GridHistoryHandlers, and GridEditHistoryManager classes
Integrated history tracking into GridEditAction and ResultSetEditAction to record all editing operations
Added keyboard bindings and UI integration for undo/redo actions in the data viewer

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
webapp/packages/plugin-help/src/Shortcuts/SHORTCUTS_DATA.ts	Added undo/redo shortcuts to the help documentation
webapp/packages/plugin-data-viewer/src/module.ts	Registered GridHistoryAction in the dependency injection container
webapp/packages/plugin-data-viewer/src/TableViewer/TableFooter/TableFooterMenu/TableFooterMenuService.ts	Added undo/redo key bindings, action handlers, and menu integration
webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/ResultSet/ResultSetEditAction.ts	Integrated GridHistoryAction into ResultSetEditAction constructor
webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryTypes.ts	Defined type structures for different history entry types and type guard functions
webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryHandlers.ts	Implemented undo/redo handlers for each operation type
webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryAction.ts	Core history action class with undo/redo stack management and compression support
webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditHistoryManager.ts	Manager class that coordinates history recording with editor operations
webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditAction.ts	Integrated history tracking into all editing operations and added internal methods for undo/redo
webapp/packages/plugin-data-viewer/src/DATA_VIEWER_KEY_BINDINGS.ts	Defined key binding configurations for data viewer undo/redo
webapp/packages/core-utils/src/isNumber.ts	Improved type guard to enable proper type narrowing

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

...ges/plugin-data-viewer/src/TableViewer/TableFooter/TableFooterMenu/TableFooterMenuService.ts

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryAction.ts

…editor-2

Wroud · 2026-01-22T09:29:26Z

webapp/packages/core-view/src/Action/Actions/ACTION_REDO.ts


 export const ACTION_REDO = createAction('redo', {
  label: 'ui_redo',
+  tooltip: 'ui_redo',


i thought that we decided to not duplicate same text in the tooltip?

Wroud · 2026-01-22T09:29:35Z

webapp/packages/core-view/src/Action/Actions/ACTION_UNDO.ts


 export const ACTION_UNDO = createAction('undo', {
  label: 'ui_undo',
+  tooltip: 'ui_undo',


Wroud · 2026-01-22T09:38:28Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditHistoryManager.ts

+export interface IEditorDataAccess<TCell> {
+  getUpdate(row: IGridRowKey): { update: TCell[] } | undefined;
+  getRowValue(row: IGridRowKey): TCell[] | undefined;
+}


Why not pass the required data via arguments?

Wroud · 2026-01-22T09:44:13Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditHistoryManager.ts

+  private getPrevCellValue(key: TKey, editorAccess: IEditorDataAccess<TCell>): TCell {
+    const update = editorAccess.getUpdate(key.row);
+    const currentHistoryEntry = this.history.getCurrentEntry();
+    const isEditingSameCell =
+      currentHistoryEntry &&
+      isGridHistoryEditCellData<TKey, TCell>(currentHistoryEntry) &&
+      GridDataKeysUtils.isElementsKeyEqual(currentHistoryEntry.data.key, key);
+    const initialValue = (update as any)?.source?.[key.column.index] as TCell;
+    const latestHistoryEntry = this.history
+      .getState()
+      .findLast(entry => isGridHistoryEditCellData<TKey, TCell>(entry) && GridDataKeysUtils.isElementsKeyEqual(entry.data.key, key));
+
+    if (isEditingSameCell && currentHistoryEntry && isGridHistoryEditCellData<TKey, TCell>(currentHistoryEntry)) {
+      return currentHistoryEntry.data.value;
+    }
+
+    if (latestHistoryEntry && isGridHistoryEditCellData<TKey, TCell>(latestHistoryEntry)) {
+      return latestHistoryEntry.data.value;
+    }
+
+    return initialValue;
+  }


this is very complicated it will be better if source of event will pass prev value because it's easier to extract it there

Also, getting the previous value based on the history is a bad idea, because history can be shrunk

Wroud · 2026-01-22T09:55:08Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryHandlers.ts

+      if (isGridHistoryDeleteRowData<TKey, TCell>(entry)) {
+        ops.revert([entry.data.key]);
+      }


try to add row, change something somewhere, delete this added row
revert changes

Wroud · 2026-01-22T09:57:07Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryHandlers.ts

+export function handleUndo<TKey extends IGridDataKey, TCell>(entry: IHistoryEntry<unknown>, operations: IGridEditOperations<TKey, TCell>): void {
+  const handlers = createUndoHandlers<TKey, TCell>();
+  handlers[entry.source]?.(entry, operations);
+}
+
+export function handleRedo<TKey extends IGridDataKey, TCell>(entry: IHistoryEntry<unknown>, operations: IGridEditOperations<TKey, TCell>): void {


Please use more specific naming for these functions to avoid wrong suggestions in the IDE

Wroud · 2026-01-22T09:59:25Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryHandlers.ts

+    [GRID_HISTORY_SOURCE.DUPLICATE_ROW]: (entry, ops) => {
+      if (isGridHistoryDuplicateRowData<TKey, TCell>(entry)) {
+        for (const { key } of entry.data.keys) {
+          ops.deleteRow(key.row, key.column);
+        }
+      }
+    },


i think this is probably same as and add event but with batch of rows, please use single add event that support batching data, and probably same for delete

Wroud · 2026-01-22T10:04:15Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryTypes.ts

+export interface IGridHistoryRevertData<TKey extends IGridDataKey = IGridDataKey, TCell = unknown> {
+  updates: Array<{ key: TKey; prevValue: TCell; value: TCell }>;
+  deletions: Array<{ key: TKey; value?: TCell[] }>;
+  additions: Array<{ key: TKey; rowValue?: TCell[] }>;
+}
+
+export interface IGridHistoryCancelData<TKey extends IGridDataKey = IGridDataKey, TCell = unknown> {
+  updates: Array<{ key: TKey; prevValue: TCell[]; value: TCell[] }>;
+  deletions: Array<{ key: TKey; value?: TCell[] }>;
+  additions: Array<{ key: TKey; rowValue?: TCell[] }>;
+}


This seems to be batched (or grouped) history items rather than history items themselves. Consider making it possible to perform "batch" undo/redo

…editor-2

…tory

…this history" This reverts commit 5f1799f.

…th deleting added row

devnaumov · 2026-01-23T15:03:14Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditAction.ts

-      applyPartialUpdate: action,
+    this.historyManager = new GridEditHistoryManager<TKey, TCell>(history as GridHistoryAction<IGridHistoryData<TKey, TCell>, TResult>);
+
+    makeObservable<this, 'editorData' | 'setCellsInternal' | 'setRowsInternal' | 'addRowsInternal' | 'deleteRowsInternal' | 'removeEditsInternal'>(


Probably better to remove internal suffix. Its already private and cant be accessed outside of the class

devnaumov · 2026-01-23T15:16:24Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditHistoryManager.ts

+      entry => isGridHistoryEditCellData<TKey, TCell>(entry) && GridDataKeysUtils.isElementsKeyEqual(entry.data.key, key),
+      entries => {
+        const firstEntry = entries[0]!;
+        const lastEntry = entries[entries.length - 1]!;


Please check for undefined, because we dont check length in this method and cant be sure

it is garantted by hisory.compress
this callback is called only if we have >= 2 items for compression

devnaumov · 2026-01-23T15:25:13Z

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridHistoryAction.ts

+  }
+
+  private mergeEntries(matchingIndices: number[], createCompressedEntry: CompressedEntryFactory<TData>, compressedEntityIndex?: number): void {
+    let targetIndex = compressedEntityIndex ?? matchingIndices[matchingIndices.length - 1]!;


Is it guaranteed? When we get data from some other place and not in the function itself, its better to always check for undefined as someone might change method that executes this fn and it will throw.

We can do it when we are using data from the same fn

for example

function example() { this.set('me', 'happy'); return this.get('me')!; }

it is also garanteed but added check just in case

dbeaver/pro#7614 adds first implementation of grid history action (ha…

52c4672

…s bugs)

sergeyteleshev self-assigned this Jan 15, 2026

sergeyteleshev requested review from SychevAndrey, Wroud and devnaumov January 15, 2026 22:33

Wroud reviewed Jan 16, 2026

View reviewed changes

sergeyteleshev added 2 commits January 16, 2026 12:43

some pr fixes

e0263bc

replace last instead of update method

e7bc673

Wroud reviewed Jan 19, 2026

View reviewed changes

webapp/packages/plugin-data-viewer/src/DatabaseDataModel/Actions/Grid/GridEditAction.ts Outdated Show resolved Hide resolved

sergeyteleshev added 7 commits January 20, 2026 14:30

adds history compression to cell edit

e852db5

add add row history for undo/redo

d152782

adds history for delete row

b2c39df

adds duplicate row undo/redo

38d7b3b

adds history for revert action

bc53787

clears history inside edit clear action

ff4d63d

refactors the undo/redo history to have more clean structure

fabdd2e

sergeyteleshev requested a review from Copilot January 20, 2026 22:28

Copilot started reviewing on behalf of sergeyteleshev January 20, 2026 22:29 View session

Copilot AI reviewed Jan 20, 2026

View reviewed changes

sergeyteleshev added 6 commits January 20, 2026 23:35

Merge branch 'devel' into 7614-cb-improve-undoredo-behavior-for-data-…

80c158a

…editor-2

cleanup

8bab8b0

adds limits to history

2a0ea99

uses data viewer undo/redo actions

de237bf

Merge branch 'devel' into 7614-cb-improve-undoredo-behavior-for-data-…

efbe97d

…editor-2

cleanup for undo/redo actions + adds to the top of table icons

4331a0e

sergeyteleshev marked this pull request as ready for review January 21, 2026 17:47

Wroud requested changes Jan 22, 2026

View reviewed changes

sergeyteleshev added 3 commits January 22, 2026 16:09

Merge branch 'devel' into 7614-cb-improve-undoredo-behavior-for-data-…

a43635c

…editor-2

applies tooltips for the header table only

71cb84d

removes createEditorDataAccess (refactor)

929c692

sergeyteleshev added 8 commits January 22, 2026 17:14

removes getPrevCellValue (refactor)

f8ab436

bug fix: add row, change something, delete row, undo/redo in this his…

5f1799f

…tory

adds more specific function naming

200cc96

Revert "bug fix: add row, change something, delete row, undo/redo in …

68b73f6

…this history" This reverts commit 5f1799f.

adds batching history to the adding/deleting operations

112ed66

refactors GridHistoryHandlers & GridEditAction API + fixes the bug wi…

71422b8

…th deleting added row

handling edge cases

848d0d3

cleanup

6ebbba7

sergeyteleshev requested a review from Wroud January 23, 2026 14:18

devnaumov reviewed Jan 23, 2026

View reviewed changes

pr fixes

e6e831b

[CB] Improve undo/redo behavior for Data Editor #4060

Are you sure you want to change the base?

[CB] Improve undo/redo behavior for Data Editor #4060

Uh oh!

Conversation

sergeyteleshev commented Jan 15, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants