gristlabs_grist-core/app/common/ActionGroup.ts
Paul Fitzpatrick 876a0298a2 (core) do not look at content of recent actions when loading documents
Summary:
This removes the need for any information drawn from the content of recent actions when loading a document.

The undo/redo system does need some facts about recent actions up front. But that system has an important restriction: only actions a particular client is known to have generated can be undone by that client.

So in this diff, as we store which client has performed an action, we also store the few pieces of metadata about that action that the undo/redo system needs: `linkId`, `otherId`, `rowIdHint`, `isUndo` fields. These are all small integers (or in one case a boolean).

An existing limitation is that information about which client has performed which action is stored in memory in the worker, and not persisted anywhere. This diff does not change that limitation, meaning that undos continue to not survive a worker transition. A reasonable way to deal with that would be to back the store with redis.

Test Plan: existing tests pass

Reviewers: dsagal

Reviewed By: dsagal

Differential Revision: https://phab.getgrist.com/D3044
2021-09-29 11:27:02 -04:00

29 lines
957 B
TypeScript

import {ActionSummary} from 'app/common/ActionSummary';
/**
* This is the action representation the client works with, for the purposes of undos/redos.
*/
export interface MinimalActionGroup {
actionNum: number;
actionHash: string;
fromSelf: boolean;
linkId: number;
otherId: number;
rowIdHint: number; // If non-zero, this is a rowId that would be a good place to put
// the cursor after an undo.
isUndo: boolean; // True if the first user action is ApplyUndoActions.
}
/**
* This is the action representation the client works with, for the purposes of document
* history and undos/redos.
*/
export interface ActionGroup extends MinimalActionGroup {
desc?: string;
actionSummary: ActionSummary;
time: number;
user: string;
primaryAction: string; // The name of the first user action in the ActionGroup.
internal: boolean; // True if it is inappropriate to log/undo the action.
}