mikebridge commented on code in PR #41551: URL: https://github.com/apache/superset/pull/41551#discussion_r3707408687
########## superset-frontend/src/features/versionHistory/sessionLogMiddleware.ts: ########## @@ -0,0 +1,155 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import type { Middleware } from 'redux'; +import { FeatureFlag, isFeatureEnabled } from '@superset-ui/core'; +import { t } from '@apache-superset/core/translation'; +import { appendVersionSessionLog, clearVersionSessionLog } from './reducer'; + +// Action types are inlined (rather than imported from the explore +// module) so this middleware does not pull explore code into every +// page's bundle; the store applies it globally. Exported so the test +// suite can assert they match the real explore constants — a rename +// there would otherwise silently kill the session log. +export const SET_FIELD_VALUE = 'SET_FIELD_VALUE'; +export const UPDATE_CHART_TITLE = 'UPDATE_CHART_TITLE'; +export const UPDATE_FORM_DATA_BY_DATASOURCE = 'UPDATE_FORM_DATA_BY_DATASOURCE'; +// Note the literal: explore names this constant SET_EXPLORE_CONTROLS but its +// value is 'UPDATE_EXPLORE_CONTROLS'. The pinning test guards the mismatch. +export const SET_EXPLORE_CONTROLS = 'UPDATE_EXPLORE_CONTROLS'; +export const HYDRATE_EXPLORE = 'HYDRATE_EXPLORE'; + +// The control whose label names a datasource change in the log. Both the +// swap and the Edit Dataset routes report under it, so the two entries +// collapse into one when a swap emits both. +const DATASOURCE_CONTROL_NAME = 'datasource'; +// Sentinel, not a real control: a history step rewrites the whole control +// map, so it belongs to no single control. Namespaced so it can never +// collapse into an adjacent genuine control entry. +const HISTORY_CONTROL_NAME = '__history__'; + +interface SessionLogState { + user?: { firstName?: string; lastName?: string }; + explore?: { + controls?: Record<string, { label?: unknown } | undefined>; + }; +} + +function controlLabel(state: SessionLogState, controlName: string): string { + const label = state.explore?.controls?.[controlName]?.label; + return typeof label === 'string' && label + ? label + : controlName.replace(/_/g, ' '); +} + +function userName(state: SessionLogState): string | null { + const name = [state.user?.firstName, state.user?.lastName] + .filter(Boolean) + .join(' '); + return name || null; +} + +/** + * Records unsaved explore control changes in the version history + * session log ("Current version" section) and resets the log whenever + * the explore page (re)hydrates — initial load, save, or restore. + */ +export const versionSessionLogMiddleware: Middleware = + store => next => action => { + const result = next(action); + if (!isFeatureEnabled(FeatureFlag.VersionHistory)) { + return result; + } + if (action.type === HYDRATE_EXPLORE) { + store.dispatch(clearVersionSessionLog()); + } else if (action.type === UPDATE_CHART_TITLE) { + // Renaming the chart is an unsaved change like any control edit, but it + // travels through its own action — without this branch the restore + // gate's dirty signal missed it and a restore silently discarded the + // rename. + const state = store.getState() as SessionLogState; + store.dispatch( + appendVersionSessionLog({ + label: t('Renamed chart'), + controlName: 'slice_name', + ts: Date.now(), + user: userName(state), + }), + ); + } else if (action.type === SET_EXPLORE_CONTROLS) { + // Explore pushes its chart state into history entries, so a browser + // back/forward between them is an undo/redo: it rebuilds the entire + // control map without emitting a single control change. Left + // unrecorded, a user who saved, stepped back to the pre-save controls + // and then restored a version had that step silently discarded — the + // restore gate saw an empty log while the form had moved. + // + // Recording it does mean stepping back to a state matching the saved + // chart still latches an entry, so restore is blocked where nothing + // actually differs. That is the append-only log's known failure + // direction, and it fails closed; the missing entry failed open. + // Baseline diffing replaces both. + const state = store.getState() as SessionLogState; + store.dispatch( + appendVersionSessionLog({ + label: t('Undid or redid a change'), + controlName: HISTORY_CONTROL_NAME, + ts: Date.now(), + user: userName(state), + }), + ); Review Comment: *Generated by Claude (AI) on behalf of @mikebridge.* Correct diagnosis, and it's a deliberate trade rather than an oversight — recorded in the commit that introduced it (`9197772542`) and worth restating here. Recording `UPDATE_EXPLORE_CONTROLS` closed a **fail-open** hole: explore's own history entries carry chart state, so a back/forward step rebuilds the entire control map without emitting a single control change. Before that commit the sequence *edit → save (clears the log) → Back to the pre-save controls → restore* saw an empty log against a form that had in fact moved, and the restore discarded the popped state silently. Not recording it loses data. Recording it blocks a restore where nothing differs — annoying, but recoverable, and visible to the user rather than silent. Fail-closed beats fail-open for a gate whose job is preventing data loss. Your prescription ("compare against the saved baseline") is exactly right, and it's the queued structural fix rather than a patch to this branch: replacing the append-only session log with baseline diffing via the existing `getChartFormDiffs` (`src/utils/getChartFormDiffs/`, already used by the header's unsaved-changes prompt). That closes *both* directions at once — it can't miss a writer and it can't latch a phantom entry — and it's tracked as [sc-115766](https://app.shortcut.com/preset/story/115766), proposed as a gate for enabling `VERSION_HISTORY` rather than for merging it dark. One caveat noted there: `getChartFormDiffs`' `noisyKeys` exclusions were tuned for a navigation prompt, where a false negative costs a dialog; for a restore gate it costs data, so the exclusion list needs re-auditing before reuse. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
