Added comments to routes.ts. Reverted previous change saveNew in masterState that is no longer relevant. Made accompanying changes in linkFiber and backendTypes.

Co-authored-by: Chris LeBrett <[email protected]>
Co-authored-by: Robby Tipton <[email protected]>
Co-authored-by: Joseph Park <[email protected]>
Co-authored-by: David Kim <[email protected]>
Co-authored-by: Kevin HoEun Lee <[email protected]>

Author: 5 people

src/backend/linkFiber.ts

@@ -359,7 +359,6 @@ function createTree(
     componentData.index = componentActionsRecord.saveNew(
       stateNode.state,
       stateNode,
-      currentFiber.elementType.name,
     );
     newState = stateNode.state;
     componentFound = true;
@@ -415,7 +414,6 @@ function createTree(
         hooksIndex = componentActionsRecord.saveNew(
           state.state,
           state.component,
-          currentFiber.elementType.name,
         );
         componentData.hooksIndex = hooksIndex;
         if (!newState) {

src/backend/masterState.ts

@@ -24,8 +24,8 @@ export default {
     index = 0;
   },
   // adds new component to ComponentActionsRecord
-  saveNew: (state, component, name): number => {
-    componentActionsRecord[index] = { state, component, name };
+  saveNew: (state, component): number => {
+    componentActionsRecord[index] = { state, component };
     index++;
 
     return index - 1;

src/backend/routes.ts

@@ -1,5 +1,9 @@
 /* eslint-disable max-classes-per-file */
+/* eslint-disable max-len */
 
+/**
+ * @class Route instances are created by the addRoute method on Routes. A Route instance has two properties: the url of the route and a unique id.
+ */
 class Route {
   url: string;
 
@@ -11,13 +15,34 @@ class Route {
   }
 }
 
+/**
+ * @class An instance of this class is the default export from routes.ts. It includes the logic that allows Reactime to work with target applications built with React Router. The addRoute method is invoked in linkFiber.ts within the sendSnapshot function. The navigate method is invoked in timeJump.ts immediately before invoking jump.
+ */
+
 class Routes {
+  /**
+   * @property A stack of visited routes that matches the browser history stack.
+   */
   values: Route[] = [new Route(null, null)];
 
+  /**
+   * @property Used to assign unique ids to routes in the values stack in case the same route is added to the stack more than once.
+   */
   id = 0;
 
+  /**
+   * @property The index of the current route in the values stack.
+   */
   current: number | null = 0;
 
+  /**
+   * @method addRoute
+   * @param url - A url string.
+   * @returns Either the current route if the user has not navigated away from it or a new instance of a route constructed from the url.
+   *
+   * Ensures that the values stack always matches the browser history stack.
+   */
+
   addRoute(url: string): Route {
     let route: Route = this.values[this.current];
 
@@ -35,7 +60,13 @@ class Routes {
     return route;
   }
 
-  rebuildHistory(url: string): void {
+  /**
+   * @method rebuildHistory
+   * @param url - A url string.
+   *
+   * Rebuilds the browser history stack using the copy of the stack maintained in the values stack. https://developer.mozilla.org/en-US/docs/Web/API/History/replaceState, https://developer.mozilla.org/en-US/docs/Web/API/History/pushState
+   */
+  private rebuildHistory(url: string): void {
     window.history.replaceState('', '', this.values[this.current + 1].url);
 
     for (let i = this.current + 2; i < this.values.length; i += 1) {
@@ -45,6 +76,13 @@ class Routes {
     window.history.pushState('', '', url);
   }
 
+  /**
+   * @method navigate
+   * @param route - The target route in the values stack that is being navigated to.
+   * @returns A boolean indicating whether or not a new route was navigated to.
+   *
+   * Invokes history.go passing in the delta between the current route and the target route. https://developer.mozilla.org/en-US/docs/Web/API/History/go
+   */
   navigate(route: Route): boolean {
     let targetIndex: number | null = null;
 

src/backend/types/backendTypes.ts

@@ -41,7 +41,6 @@ export interface ComponentData {
 export interface HookStateItem {
   state: any;
   component: any;
-  name?: string;
 }
 
 export type HookStates = Array<HookStateItem>;