refactored clear button, which was keeping last state recorded without changing target app. Refactored clear button to keep only the current snapshot instead of only the last snapshot recorded

Author: Oliver-Cho

src/app/slices/mainSlice.ts

@@ -46,17 +46,31 @@ export const mainSlice = createSlice({
       tabs[currentTab].viewIndex = 0;
       tabs[currentTab].playing = false;
 
-      const lastSnapshot = tabs[currentTab].snapshots[tabs[currentTab].snapshots.length - 1]; // the most recent snapshot
-      const lastAxSnapshot = tabs[currentTab].axSnapshots[tabs[currentTab].axSnapshots.length - 1]; // the most recent snapshot
-
-      tabs[currentTab].hierarchy.stateSnapshot = { ...lastSnapshot }; // resets hierarchy to page last state recorded
-      tabs[currentTab].hierarchy.axSnapshot = lastAxSnapshot; // resets hierarchy to page last state recorded
+      // REFACTORED TO HAVE CLEAR BUTTON KEEP CURRENT STATE OF DEMO APP RATHER THAN JUST THE LAST STATE RECORDED
+      // PRIOR IMPLEMENTATION WAS FAILING TO RESET STATE OF DEMO APP UPON CLEAR
+      // IF CHANGING, CHANGE BACKGROUND.JS TOO
+
+      // const lastSnapshot = tabs[currentTab].snapshots[tabs[currentTab].snapshots.length - 1]; // the most recent snapshot
+      // const lastAxSnapshot = tabs[currentTab].axSnapshots[tabs[currentTab].axSnapshots.length - 1]; // the most recent snapshot
+      const currSnapshot = tabs[currentTab].snapshots[tabs[currentTab].currLocation.index]; // the most recent snapshot
+      const currAxSnapshot = tabs[currentTab].axSnapshots[tabs[currentTab].currLocation.index]; // the most recent snapshot
+
+      // tabs[currentTab].hierarchy.stateSnapshot = { ...lastSnapshot }; // resets hierarchy to page last state recorded
+      // // not sure why shallow deep copy
+      // tabs[currentTab].hierarchy.axSnapshot = lastAxSnapshot; // resets hierarchy to page last state recorded
+      // tabs[currentTab].hierarchy.children = []; // resets hierarchy
+      // tabs[currentTab].snapshots = [lastSnapshot]; // resets snapshots to page last state recorded
+      // tabs[currentTab].axSnapshots = [lastAxSnapshot]; // resets snapshots to page last state recorded
+
+      tabs[currentTab].hierarchy.stateSnapshot = { ...currSnapshot }; // resets hierarchy to page last state recorded
+      // not sure why shallow deep copy
+      tabs[currentTab].hierarchy.axSnapshot = currAxSnapshot; // resets hierarchy to page last state recorded
       tabs[currentTab].hierarchy.children = []; // resets hierarchy
-      tabs[currentTab].snapshots = [lastSnapshot]; // resets snapshots to page last state recorded
-      tabs[currentTab].axSnapshots = [lastAxSnapshot]; // resets snapshots to page last state recorded
+      tabs[currentTab].snapshots = [currSnapshot]; // resets snapshots to page last state recorded
+      tabs[currentTab].axSnapshots = [currAxSnapshot]; // resets snapshots to page last state recorded
 
       // resets currLocation to page last state recorded
-      tabs[currentTab].currLocation = tabs[currentTab].hierarchy;
+      // tabs[currentTab].currLocation = tabs[currentTab].hierarchy;
       tabs[currentTab].index = 1;
       tabs[currentTab].currParent = 0;
       tabs[currentTab].currBranch = 1;

src/extension/background.js

@@ -264,18 +264,21 @@ chrome.runtime.onConnect.addListener((port) => {
 
       // emptySnap actions comes through when the user uses the 'clear' button on the front end to clear the snapshot history and move slider back to 0 position
       case 'emptySnap':
-        tabsObj[tabId].snapshots = [tabsObj[tabId].snapshots[tabsObj[tabId].snapshots.length - 1]]; // reset snapshots to page last state recorded
+        // REFACTORED TO HAVE CLEAR BUTTON KEEP CURRENT STATE OF DEMO APP RATHER THAN JUST THE LAST STATE RECORDED
+        // PRIOR IMPLEMENTATION WAS FAILING TO RESET STATE OF DEMO APP UPON CLEAR
+        // IF CHANGING, CHANGE MAINSLICE.JS TOO
+        tabsObj[tabId].snapshots = [tabsObj[tabId].snapshots[tabsObj[tabId].currLocation.index]]; // reset snapshots to current page state
         tabsObj[tabId].hierarchy.children = []; // resets hierarchy
         tabsObj[tabId].hierarchy.stateSnapshot = {
-          // resets hierarchy to page last state recorded
+          // resets hierarchy to current page state
+          // not sure why they are doing a "shallow" deep copy
           ...tabsObj[tabId].snapshots[0],
         };
         tabsObj[tabId].axSnapshots = [
-          tabsObj[tabId].axSnapshots[tabsObj[tabId].axSnapshots.length - 1],
-        ]; // resets axSnapshots to page last recorded
-        tabsObj[tabId].hierarchy.axSnapshot = tabsObj[tabId].axSnapshots[0]; // resets hierarchy to page of last ax tree recorded
-        // SHOULDN'T HIERARCHY.AXSNAPSHOT AND HIERARCHY.SNAPSHOT BE RESET BASED ON CURRLOCATION, NOT LAST SNAP RECORDED BECAUSE WHAT IF JUMPING TO PREVIOUS SNAPSHOT AND THEN CLEAR. WOULDN'T THAT REQUIRE UPDATING THE DEMO APP TO THE LAST STATE RECORDED AS WELL?
-        tabsObj[tabId].currLocation = tabsObj[tabId].hierarchy; // resets currLocation to page last state recorded
+          tabsObj[tabId].axSnapshots[tabsObj[tabId].currLocation.index],
+        ]; // resets axSnapshots to current page state
+        tabsObj[tabId].hierarchy.axSnapshot = tabsObj[tabId].axSnapshots[0]; // resets hierarchy to ax tree of current page state
+        // tabsObj[tabId].currLocation = tabsObj[tabId].hierarchy; // resets currLocation to page last state recorded
         tabsObj[tabId].index = 1; //reset index
         tabsObj[tabId].currParent = 0; // reset currParent
         tabsObj[tabId].currBranch = 1; // reset currBranch