Disable local and session storage at the end of each test

Author: shepmaster

tests/spec/spec_helper.rb

@@ -79,3 +79,15 @@
     "[data-test-id = '#{id_s}']"
   end
 end
+
+RSpec.configure do |config|
+  config.after(:example, :js) do
+    page.execute_script <<~JS
+      (() => {
+        if (window.rustPlayground) {
+           window.rustPlayground.disableSyncChangesToStorage();
+        }
+      })()
+    JS
+  end
+end

ui/frontend/actions.ts

@@ -62,6 +62,7 @@ const createAction = <T extends string, P extends {}>(type: T, props?: P) => (
 
 export enum ActionType {
   InitializeApplication = 'INITIALIZE_APPLICATION',
+  DisableSyncChangesToStorage = 'DISABLE_SYNC_CHANGES_TO_STORAGE',
   SetPage = 'SET_PAGE',
   ChangeEditor = 'CHANGE_EDITOR',
   ChangeKeybinding = 'CHANGE_KEYBINDING',
@@ -131,6 +132,8 @@ export enum ActionType {
 
 export const initializeApplication = () => createAction(ActionType.InitializeApplication);
 
+export const disableSyncChangesToStorage = () => createAction(ActionType.DisableSyncChangesToStorage);
+
 const setPage = (page: Page) =>
   createAction(ActionType.SetPage, { page });
 
@@ -897,6 +900,7 @@ export function showExample(code: string): ThunkAction {
 
 export type Action =
   | ReturnType<typeof initializeApplication>
+  | ReturnType<typeof disableSyncChangesToStorage>
   | ReturnType<typeof setPage>
   | ReturnType<typeof changePairCharacters>
   | ReturnType<typeof changeAssemblyFlavor>

ui/frontend/configureStore.ts

@@ -36,8 +36,18 @@ export default function configureStore(window: Window) {
 
   store.subscribe(() => {
     const state = store.getState();
-    localStorage.saveChanges(state);
-    sessionStorage.saveChanges(state);
+
+    // Some automated tests run fast enough that the following interleaving is possible:
+    //
+    // 1. RSpec test finishes, local/session storage cleared
+    // 2. WebSocket connects, the state updates, and the local/session storage is saved
+    // 3. Subsequent RSpec test starts and local/session storage has been preserved
+    //
+    // We allow the tests to stop saving to sidestep that.
+    if (state.globalConfiguration.syncChangesToStorage) {
+      localStorage.saveChanges(state);
+      sessionStorage.saveChanges(state);
+    }
   })
 
   return store;

ui/frontend/declarations.d.ts

@@ -20,6 +20,7 @@ interface Window {
   __REDUX_DEVTOOLS_EXTENSION_COMPOSE__: any;
   rustPlayground: {
     setCode(code: string): void;
+    disableSyncChangesToStorage(): void;
     webSocket: WebSocket | null;
   };
 }

ui/frontend/index.tsx

@@ -10,6 +10,7 @@ import { Provider } from 'react-redux';
 
 import {
   editCode,
+  disableSyncChangesToStorage,
   enableFeatureGate,
   gotoPosition,
   selectText,
@@ -53,6 +54,9 @@ window.rustPlayground = {
   setCode: code => {
     store.dispatch(editCode(code));
   },
+  disableSyncChangesToStorage: () => {
+    store.dispatch(disableSyncChangesToStorage());
+  },
   // Temporarily storing this as a global to prevent it from being
   // garbage collected (at least by Safari).
   webSocket: socket,

ui/frontend/reducers/globalConfiguration.ts

@@ -1,13 +1,21 @@
-import { Action } from '../actions';
+import { Action, ActionType } from '../actions';
 
 export interface State {
   baseUrl: string;
+  syncChangesToStorage: boolean;
 }
 
 const DEFAULT: State = {
   baseUrl: '',
+  syncChangesToStorage: true,
 };
 
-export default function globalConfiguration(state = DEFAULT, _action: Action): State {
-  return state;
+export default function globalConfiguration(state = DEFAULT, action: Action): State {
+  switch (action.type) {
+    case ActionType.DisableSyncChangesToStorage: {
+      return { ...state, syncChangesToStorage: false };
+    }
+    default:
+      return state;
+  }
 }