Remember history when replacing window

6 files changed, 69 insertions, 11 deletions

diff --git a/gui/src/main/index.ts b/gui/src/main/index.ts
index c39ccdbc5c..0950db76a5 100644
--- a/gui/src/main/index.ts
+++ b/gui/src/main/index.ts
@@ -43,7 +43,7 @@ import {
 import { messages, relayLocations } from '../shared/gettext';
 import { SYSTEM_PREFERRED_LOCALE_KEY } from '../shared/gui-settings-state';
 import { ITranslations, MacOsScrollbarVisibility } from '../shared/ipc-schema';
-import { IChangelog, ICurrentAppVersionInfo } from '../shared/ipc-types';
+import { IChangelog, ICurrentAppVersionInfo, IHistoryObject } from '../shared/ipc-types';
 import log, { ConsoleOutput, Logger } from '../shared/logging';
 import { LogLevel } from '../shared/logging-types';
 import {
@@ -252,6 +252,8 @@ class ApplicationMain {
 
   private changelog?: IChangelog;
 
+  private navigationHistory?: IHistoryObject;
+
   public run() {
     // Remove window animations to combat window flickering when opening window. Can be removed when
     // this issue has been resolved: https://github.com/electron/electron/issues/12130
@@ -1273,6 +1275,7 @@ class ApplicationMain {
       windowsSplitTunnelingApplications: this.windowsSplitTunnelingApplications,
       macOsScrollbarVisibility: this.macOsScrollbarVisibility,
       changelog: this.changelog ?? [],
+      navigationHistory: this.navigationHistory,
     }));
 
     IpcMainEventChannel.settings.handleSetAllowLan((allowLan: boolean) =>
@@ -1486,6 +1489,10 @@ class ApplicationMain {
       this.guiSettings.changelogDisplayedForVersion = this.currentVersion.gui;
     });
 
+    IpcMainEventChannel.navigation.handleSetHistory((history) => {
+      this.navigationHistory = history;
+    });
+
     if (windowsSplitTunneling) {
       this.guiSettings.browsedForSplitTunnelingApplications.forEach(
         windowsSplitTunneling.addApplicationPathToCache,
diff --git a/gui/src/renderer/app.tsx b/gui/src/renderer/app.tsx
index a0fb5f3266..0d9221c51f 100644
--- a/gui/src/renderer/app.tsx
+++ b/gui/src/renderer/app.tsx
@@ -25,7 +25,7 @@ import {
 import { messages, relayLocations } from '../shared/gettext';
 import { IGuiSettingsState, SYSTEM_PREFERRED_LOCALE_KEY } from '../shared/gui-settings-state';
 import { IRelayListPair, LaunchApplicationResult } from '../shared/ipc-schema';
-import { IChangelog, ICurrentAppVersionInfo } from '../shared/ipc-types';
+import { IChangelog, ICurrentAppVersionInfo, IHistoryObject } from '../shared/ipc-types';
 import log, { ConsoleOutput } from '../shared/logging';
 import { LogLevel } from '../shared/logging-types';
 import { Scheduler } from '../shared/scheduler';
@@ -208,7 +208,11 @@ export default class AppRenderer {
     this.setAccountExpiry(initialState.accountData?.expiry);
     this.setSettings(initialState.settings);
     this.setIsPerformingPostUpgrade(initialState.isPerformingPostUpgrade);
-    this.handleAccountChange({ deviceConfig: initialState.deviceConfig }, undefined);
+    this.handleAccountChange(
+      { deviceConfig: initialState.deviceConfig },
+      undefined,
+      initialState.navigationHistory !== undefined,
+    );
     this.hasReceivedDeviceConfig = initialState.hasReceivedDeviceConfig;
     this.setAccountHistory(initialState.accountHistory);
     this.setTunnelState(initialState.tunnelState);
@@ -244,8 +248,12 @@ export default class AppRenderer {
 
     void this.updateLocation();
 
-    const navigationBase = this.getNavigationBase();
-    this.history = new History(navigationBase);
+    if (initialState.navigationHistory) {
+      this.history = History.fromSavedHistory(initialState.navigationHistory);
+    } else {
+      const navigationBase = this.getNavigationBase();
+      this.history = new History(navigationBase);
+    }
   }
 
   public renderView() {
@@ -555,6 +563,10 @@ export default class AppRenderer {
     IpcRendererEventChannel.currentVersion.displayedChangelog();
   };
 
+  public setNavigationHistory(history: IHistoryObject) {
+    IpcRendererEventChannel.navigation.setHistory(history);
+  }
+
   // Make sure that the content height is correct and log if it isn't. This is mostly for debugging
   // purposes since there's a bug in Electron that causes the app height to be another value than
   // the one we have set.
@@ -804,7 +816,11 @@ export default class AppRenderer {
     }
   }
 
-  private handleAccountChange(newDeviceEvent: IDeviceEvent, oldAccount?: string) {
+  private handleAccountChange(
+    newDeviceEvent: IDeviceEvent,
+    oldAccount?: string,
+    preventRedirectToConnect?: boolean,
+  ) {
     const reduxAccount = this.reduxActions.account;
 
     this.deviceConfig = newDeviceEvent.deviceConfig;
@@ -828,7 +844,7 @@ export default class AppRenderer {
 
           if (this.previousLoginState === 'too many devices') {
             this.resetNavigation();
-          } else {
+          } else if (!preventRedirectToConnect) {
             this.redirectToConnect();
           }
           break;
diff --git a/gui/src/renderer/components/AppRouter.tsx b/gui/src/renderer/components/AppRouter.tsx
index d061c7b9d5..18a8b51063 100644
--- a/gui/src/renderer/components/AppRouter.tsx
+++ b/gui/src/renderer/components/AppRouter.tsx
@@ -12,6 +12,7 @@ import SelectLocationPage from '../containers/SelectLocationPage';
 import SettingsPage from '../containers/SettingsPage';
 import SupportPage from '../containers/SupportPage';
 import WireguardSettingsPage from '../containers/WireguardSettingsPage';
+import withAppContext, { IAppContext } from '../context';
 import { IHistoryProps, ITransitionSpecification, transitions, withHistory } from '../lib/history';
 import { RoutePath } from '../lib/routes';
 import { DeviceRevokedView } from './DeviceRevokedView';
@@ -36,12 +37,12 @@ interface IAppRoutesState {
   action?: Action;
 }
 
-class AppRouter extends React.Component<IHistoryProps, IAppRoutesState> {
+class AppRouter extends React.Component<IHistoryProps & IAppContext, IAppRoutesState> {
   private unobserveHistory?: () => void;
 
   private focusRef = React.createRef<IFocusHandle>();
 
-  constructor(props: IHistoryProps) {
+  constructor(props: IHistoryProps & IAppContext) {
     super(props);
 
     this.state = {
@@ -54,6 +55,7 @@ class AppRouter extends React.Component<IHistoryProps, IAppRoutesState> {
     // React throttles updates, so it's impossible to capture the intermediate navigation without
     // listening to the history directly.
     this.unobserveHistory = this.props.history.listen((location, action, transition) => {
+      this.props.app.setNavigationHistory(this.props.history.asObject);
       this.setState({
         currentLocation: location,
         transition,
@@ -114,6 +116,6 @@ class AppRouter extends React.Component<IHistoryProps, IAppRoutesState> {
   };
 }
 
-const AppRoutesWithRouter = withHistory(AppRouter);
+const AppRoutesWithRouter = withAppContext(withHistory(AppRouter));
 
 export default AppRoutesWithRouter;
diff --git a/gui/src/renderer/lib/history.tsx b/gui/src/renderer/lib/history.tsx
index 2eb08d001d..9a0205b382 100644
--- a/gui/src/renderer/lib/history.tsx
+++ b/gui/src/renderer/lib/history.tsx
@@ -2,6 +2,7 @@ import { Action, History as OriginalHistory, Location, LocationDescriptorObject
 import React from 'react';
 import { RouteComponentProps, useHistory as useReactRouterHistory, withRouter } from 'react-router';
 
+import { IHistoryObject } from '../../shared/ipc-types';
 import { GeneratedRoutePath, RoutePath } from './routes';
 
 export interface ITransitionSpecification {
@@ -61,6 +62,15 @@ export default class History {
     this.entries = [this.createLocation(location, state)];
   }
 
+  public static fromSavedHistory(savedHistory: IHistoryObject): History {
+    const history = new History(RoutePath.launch);
+    history.entries = savedHistory.entries;
+    history.index = savedHistory.index;
+    history.lastAction = savedHistory.lastAction;
+
+    return history;
+  }
+
   public get location(): Location<S> {
     return this.entries[this.index];
   }
@@ -126,6 +136,14 @@ export default class History {
     return this as OriginalHistory;
   }
 
+  public get asObject(): IHistoryObject {
+    return {
+      entries: this.entries,
+      index: this.index,
+      lastAction: this.lastAction,
+    };
+  }
+
   public block(): never {
     throw Error('Not implemented');
   }
diff --git a/gui/src/shared/ipc-schema.ts b/gui/src/shared/ipc-schema.ts
index ce517c8f21..3d08b34f48 100644
--- a/gui/src/shared/ipc-schema.ts
+++ b/gui/src/shared/ipc-schema.ts
@@ -27,7 +27,12 @@ interface ILogEntry {
   message: string;
 }
 import { invoke, invokeSync, notifyRenderer, send } from './ipc-helpers';
-import { IChangelog, ICurrentAppVersionInfo, IWindowShapeParameters } from './ipc-types';
+import {
+  IChangelog,
+  ICurrentAppVersionInfo,
+  IHistoryObject,
+  IWindowShapeParameters,
+} from './ipc-types';
 
 export interface ITranslations {
   locale: string;
@@ -66,6 +71,7 @@ export interface IAppStateSnapshot {
   windowsSplitTunnelingApplications?: IWindowsApplication[];
   macOsScrollbarVisibility?: MacOsScrollbarVisibility;
   changelog: IChangelog;
+  navigationHistory?: IHistoryObject;
 }
 
 // The different types of requests are:
@@ -118,6 +124,7 @@ export const ipcSchema = {
   },
   navigation: {
     reset: notifyRenderer<void>(),
+    setHistory: send<IHistoryObject>(),
   },
   daemon: {
     isPerformingPostUpgrade: notifyRenderer<boolean>(),
diff --git a/gui/src/shared/ipc-types.ts b/gui/src/shared/ipc-types.ts
index 0624ac95cd..27a80fda93 100644
--- a/gui/src/shared/ipc-types.ts
+++ b/gui/src/shared/ipc-types.ts
@@ -1,3 +1,5 @@
+import { Action, Location } from 'history';
+
 export interface ICurrentAppVersionInfo {
   gui: string;
   daemon?: string;
@@ -10,3 +12,9 @@ export interface IWindowShapeParameters {
 }
 
 export type IChangelog = Array<string>;
+
+export interface IHistoryObject {
+  entries: Location<unknown>[];
+  index: number;
+  lastAction: Action;
+}