Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

fix(heatmaps): ignore stale unsaved-change guards (#113824)

Jordan Mryyana9b0df248018
diff --git a/products/web_analytics/frontend/heatmaps/scenes/heatmap/heatmapLogic.test.ts b/products/web_analytics/frontend/heatmaps/scenes/heatmap/heatmapLogic.test.ts
index c06957456858..40dee34c7314 100644
--- a/products/web_analytics/frontend/heatmaps/scenes/heatmap/heatmapLogic.test.ts
+++ b/products/web_analytics/frontend/heatmaps/scenes/heatmap/heatmapLogic.test.ts
@@ -1,6 +1,7 @@
import { MOCK_DEFAULT_USER } from 'lib/api.mock'
import { router } from 'kea-router'
+import { getRouterContext } from 'kea-router/lib/router'
import { expectLogic } from 'kea-test-utils'
import api from 'lib/api'
@@ -14,6 +15,7 @@ import * as heatmapApi from 'products/web_analytics/frontend/generated/api'
import type { HeatmapScreenshotResponseApi } from 'products/web_analytics/frontend/generated/api.schemas'
import { heatmapsSceneLogic } from '../heatmaps/heatmapsSceneLogic'
+import { heatmapCreationLogic } from './heatmapCreationLogic'
import { computeLockedWidth, heatmapLogic, resolveHeatmapExportUrl } from './heatmapLogic'
function createDeferred<T>(): { promise: Promise<T>; resolve: (value: T) => void } {
@@ -164,6 +166,56 @@ describe('heatmapLogic', () => {
expect(logic.values.hasUnsavedChanges).toBe(false)
})
+ it.each(['new', 'hm_test'])('disables stale navigation guards after leaving heatmap %s', async (id) => {
+ logic.unmount()
+ const interceptors = getRouterContext().beforeUnloadInterceptors
+ const previousInterceptors = new Set(interceptors)
+ logic = heatmapLogic({ id })
+ logic.mount()
+ await expectLogic(logic).toFinishAllListeners()
+ logic.actions.setName('Edited heatmap')
+ const added = [...interceptors].filter((interceptor) => !previousInterceptors.has(interceptor))
+ expect(added).toHaveLength(1)
+ const guard = added[0]
+ expect(guard.enabled()).toBe(id !== 'new')
+
+ logic.unmount()
+ expect(interceptors.has(guard)).toBe(false)
+ const unload = new Event('beforeunload', { cancelable: true })
+ window.dispatchEvent(unload)
+ expect(unload.defaultPrevented).toBe(false)
+ const confirm = jest.spyOn(window, 'confirm').mockReturnValue(false)
+ router.actions.push('/heatmaps')
+ expect(confirm).not.toHaveBeenCalled()
+
+ logic = heatmapLogic({ id })
+ logic.mount()
+ await expectLogic(logic).toFinishAllListeners()
+ logic.actions.setName('A new edit')
+ const remountedUnload = new Event('beforeunload', { cancelable: true })
+ window.dispatchEvent(remountedUnload)
+ expect(remountedUnload.defaultPrevented).toBe(id !== 'new')
+ })
+
+ it('navigates past a guard left behind by a stale creation logic connection', () => {
+ const interceptors = getRouterContext().beforeUnloadInterceptors
+ const interceptorCount = interceptors.size
+ heatmapCreationLogic.build()
+ heatmapLogic({ id: 'new' }).mount()()
+ const unmountCreation = heatmapCreationLogic.mount()
+ const unmountNew = heatmapLogic({ id: 'new' }).mount()
+ unmountCreation()
+ unmountNew()
+ expect(heatmapLogic.isMounted({ id: 'new' })).toBe(false)
+ expect(interceptors.size).toBe(interceptorCount + 1)
+
+ const initialPath = router.values.location.pathname
+ const confirm = jest.spyOn(window, 'confirm').mockReturnValue(false)
+ expect(() => router.actions.push('/heatmaps')).not.toThrow()
+ expect(confirm).not.toHaveBeenCalled()
+ expect(router.values.location.pathname).not.toBe(initialPath)
+ })
+
it.each([true, false])('saves a rename without regenerating a screenshot (ready: %s)', async (ready) => {
if (!ready) {
logic.actions.setScreenshotUrl(null)
diff --git a/products/web_analytics/frontend/heatmaps/scenes/heatmap/heatmapLogic.ts b/products/web_analytics/frontend/heatmaps/scenes/heatmap/heatmapLogic.ts
index 72981363d0e6..7ed488916818 100644
--- a/products/web_analytics/frontend/heatmaps/scenes/heatmap/heatmapLogic.ts
+++ b/products/web_analytics/frontend/heatmaps/scenes/heatmap/heatmapLogic.ts
@@ -1034,11 +1034,13 @@ export const heatmapLogic = kea<heatmapLogicType>([
},
],
})),
- beforeUnload(({ values, actions }) => ({
- enabled: (newLocation?: CombinedLocation) =>
- values.hasUnsavedChanges && (!newLocation || newLocation.pathname !== router.values.location.pathname),
+ beforeUnload((logic) => ({
+ enabled: (newLocation?: CombinedLocation): boolean =>
+ heatmapLogic.findMounted(logic.props) === logic &&
+ logic.values.hasUnsavedChanges &&
+ (!newLocation || newLocation.pathname !== router.values.location.pathname),
message: 'Leave this heatmap? Changes you made will be discarded.',
- onConfirm: () => actions.discardChanges(),
+ onConfirm: () => logic.actions.discardChanges(),
})),
afterMount(({ actions }) => {
actions.load()