Merge pull request #7 from oslabs-beta/chris-10-29

changes reflect additional support for context api and hooks

Author: prasmalla

package/linkFiber.js

@@ -31,7 +31,7 @@ module.exports = (snap, mode) => {
     const oldSetState = component.setState.bind(component);
     // replace component's setState so developer doesn't change syntax
     // component.setState = newSetState.bind(component);
-    component.setState = (state, callback = () => {}) => {
+    component.setState = (state, callback = () => { }) => {
       // don't do anything if state is locked
       // UNLESS we are currently jumping through time
       if (mode.locked && !mode.jumping) return;
@@ -102,8 +102,8 @@ module.exports = (snap, mode) => {
     }
     // Check if the component uses hooks
     if (
-      memoizedState &&
-      Object.hasOwnProperty.call(memoizedState, 'baseState')
+      memoizedState
+      && Object.hasOwnProperty.call(memoizedState, 'baseState')
     ) {
       // Traverse through the currentFiber and extract the getters/setters
       astHooks = astParser(elementType);

package/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "reactime",
-  "version": "2.0.4",
+  "version": "2.0.9",
   "description": "A library that helps debug React by memorizing the state of components with every render.",
   "main": "index.js",
   "repository": {
@@ -26,9 +26,13 @@
   "contributors": [
     "Andy Wong",
     "Bryan Lee",
+    "Chris Flannery",
     "David Chai",
     "Josh Kim",
-    "Ruthba Anam",
+    "Prasanna Malla",
+    "Rajeeb Banstola",
+    "Rocky Lin",
+    "Ruth Anam",
     "Ryan Dang",
     "Sierra Swaby",
     "Yujin Kang"
@@ -38,4 +42,4 @@
     "acorn": "^7.1.0",
     "acorn-jsx": "^5.0.2"
   }
-}
+}

package/package.json

@@ -1,29 +1,28 @@
 <p align="center">
-  <img src ="./assets/readme_logo.png" width="400"/>
+  <img src ="./assets/readme-logo-svg.svg" width="300"/>
 </p>
 
-# Reactime: A Time Travel Debugger for React
+<h1 align="center">State Debugger for React</h1>
 
 [![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)](https://github.com/oslabs-beta/reactime)
 [![Build Status](https://travis-ci.com/oslabs-beta/reactime.svg?branch=master)](https://travis-ci.com/oslabs-beta/reactime)
 [![npm version](https://badge.fury.io/js/reactime.svg)](http://badge.fury.io/js/reactime)
 [![Dependencies](https://david-dm.org/oslabs-beta/reactime.svg)](https://david-dm.org/oslabs-beta/reactime#info=dependencies)
 [![DevDependencies](https://david-dm.org/oslabs-beta/reactime/dev-status.svg)](https://david-dm.org/oslabs-beta/reactime?type=dev)
 [![Vulnerabilities](https://snyk.io/test/github/oslabs-beta/reactime/badge.svg)](https://snyk.io/test/github/oslabs-beta/reactime)
-
-[![NPM](https://nodei.co/npm/reactime.png)](https://nodei.co/npm/reactime/)
-
 <p align="center">
+<a href="https://nodei.co/npm/reactime/"><img src="https://nodei.co/npm/reactime.png"></a>
+
   <img src="demo.gif" alt="Demo of Reactime" style="width: 55%">
 </p>
 
-Reactime is a debugging tool for React developers. It records state whenever state is changed and allows user to jump to any previous recorded state.
+Reactime is a debugging tool for React developers. It records state whenever it is changed and allows the user to jump to any previously recorded state.
 
-One important thing to note. This devtool is for React apps using only stateful components and prop drilling. If you're using Redux, Hooks, Context, or functional components, this devtool will not function on your app. 
+This dev tool is for React apps using stateful components and prop drilling, and has beta support for Context API, conditional state routing, Hooks (useState & useEffect) and functional components. 
 
-Another thing is that this library does not work well when mixing React with direct DOM manipulation. Since DOM manipulation doesn't change any React state, this library cannot record or even detect that change. Of course, you should be avoiding mixing the two in the first place.
+One thing to note is that this library does not work well when mixing React with direct DOM manipulation.
 
-Two parts are needed for this tool to function. The <a href="https://chrome.google.com/webstore/detail/react-time-travel/cgibknllccemdnfhfpmjhffpjfeidjga">chrome extension</a> must be installed, and the NPM package must be installed and used in the React code.
+Two parts are needed for this tool to function. The <a href="https://chrome.google.com/webstore/detail/react-time-travel/cgibknllccemdnfhfpmjhffpjfeidjga"><strong>chrome extension</strong></a> must be installed, and the <a href="https://www.npmjs.com/package/reactime"><strong>NPM package</strong></a> must be installed and used in the React code.
 
 After successfully installing the chrome extension, you can test Reactime functionalities in the demo repositories below.
 
@@ -63,7 +62,7 @@ Then open up your Chrome DevTools. There'll be a new tab called Reactime.
 
 ### Recording
 
-Whenever state is changed (whenever setState is called), this extension will create a snapshot of the current state tree and record it. Each snapshot will be displayed in Chrome DevTools under the Reactime panel.
+Whenever state is changed (whenever setState or useState is called), this extension will create a snapshot of the current state tree and record it. Each snapshot will be displayed in Chrome DevTools under the Reactime panel.
 
 ### Viewing
 
@@ -73,14 +72,15 @@ You can click on a snapshot to view your app's state. State can be visualized in
 
 Jumping is the most important feature of all. It allows you to jump to any previous recorded snapshots. Hitting the jump button on any snapshot will change the DOM by setting their state.
 
-### Others
-
-Other handy features include:
+### And Much More
 
+- multiple tree graph branches depicting state changes
+- tree graph hover functionality to view state changes 
+- ability to pan and zoom tree graph
 - multiple tabs support
 - a slider to move through snapshots quickly
 - a play button to move through snapshots automatically
-- a pause which button stops recording each snapshot
+- a pause button, which stops recording each snapshot
 - a lock button to freeze the DOM in place. setState will lose all functionality while the extension is locked
 - a persist button to keep snapshots upon refresh (handy when changing code and debugging)
 - export/import the current snapshots in memory
@@ -91,6 +91,14 @@ Other handy features include:
 - **Bryan Lee** - [@mylee1995](https://github.com/mylee1995)
 - **Josh Kim** - [@joshua0308](https://github.com/joshua0308)
 - **Sierra Swaby** - [@starkspark](https://github.com/starkspark)
+- **Ruth Anam** - [@peachiecodes](https://github.com/peachiecodes)
+- **David Chai** - [@davidchaidev](https://github.com/davidchaidev)
+- **Yujin Kang** - [@yujinkay](https://github.com/yujinkay)
+- **Andy Wong** - [@andywongdev](https://github.com/andywongdev)
+- **Chris Flannery** - [@chriswillsflannery](https://github.com/chriswillsflannery)
+- **Rajeeb Banstola** - [@rajeebthegreat](https://github.com/rajeebthegreat)
+- **Prasanna Malla** - [@prasmalla](https://github.com/prasmalla)
+- **Rocky Lin** - [@rocky9413](https://github.com/rocky9413)
 
 ## License
 

package/readme.md

@@ -18,7 +18,7 @@
 
 Reactime is a debugging tool for React developers. It records state whenever it is changed and allows the user to jump to any previously recorded state.
 
-This dev tool is for React apps using stateful components and prop drilling, and has beta support for Context API, conditional state routing, Hooks (useState) and functional components. 
+This dev tool is for React apps using stateful components and prop drilling, and has beta support for Context API, conditional state routing, Hooks (useState, useEffect) and functional components. 
 
 One thing to note is that this library does not work well when mixing React with direct DOM manipulation.
 
@@ -95,6 +95,10 @@ Jumping is the most important feature of all. It allows you to jump to any previ
 - **David Chai** - [@davidchaidev](https://github.com/davidchaidev)
 - **Yujin Kang** - [@yujinkay](https://github.com/yujinkay)
 - **Andy Wong** - [@andywongdev](https://github.com/andywongdev)
+- **Chris Flannery** - [@chriswillsflannery](https://github.com/chriswillsflannery)
+- **Rajeeb Banstola** - [@rajeebthegreat](https://github.com/rajeebthegreat)
+- **Prasanna Malla** - [@prasmalla](https://github.com/prasmalla)
+- **Rocky Lin** - [@rocky9413](https://github.com/rocky9413)
 
 ## License
 

readme.md

@@ -8,7 +8,6 @@ const firstSnapshotReceived = {};
 // there will be the same number of objects in here as there are reactime tabs open for each user application being worked on
 const tabsObj = {};
 
-console.log('background scripts');
 
 function createTabObj(title) {
   // update tabsObj
@@ -147,9 +146,9 @@ chrome.runtime.onMessage.addListener((request, sender) => {
 
   // Filter out tabs that don't have reactime
   if (
-    action === 'tabReload' ||
-    action === 'recordSnap' ||
-    action === 'jumpToSnap'
+    action === 'tabReload'
+    || action === 'recordSnap'
+    || action === 'jumpToSnap'
   ) {
     isReactTimeTravel = true;
   } else return;
@@ -182,12 +181,10 @@ chrome.runtime.onMessage.addListener((request, sender) => {
         tabsObj[tabId].index = 1;
 
         // send a message to devtools
-        portsArr.forEach(bg =>
-          bg.postMessage({
-            action: 'initialConnectSnapshots',
-            payload: tabsObj,
-          })
-        );
+        portsArr.forEach(bg => bg.postMessage({
+          action: 'initialConnectSnapshots',
+          payload: tabsObj,
+        }));
       }
       reloaded[tabId] = true;
       break;
@@ -202,15 +199,13 @@ chrome.runtime.onMessage.addListener((request, sender) => {
         tabsObj[tabId].snapshots.push(request.payload);
         sendToHierarchy(
           tabsObj[tabId],
-          new Node(request.payload, tabsObj[tabId])
+          new Node(request.payload, tabsObj[tabId]),
         );
         if (portsArr.length > 0) {
-          portsArr.forEach(bg =>
-            bg.postMessage({
-              action: 'initialConnectSnapshots',
-              payload: tabsObj,
-            })
-          );
+          portsArr.forEach(bg => bg.postMessage({
+            action: 'initialConnectSnapshots',
+            payload: tabsObj,
+          }));
         }
         break;
       }
@@ -223,18 +218,16 @@ chrome.runtime.onMessage.addListener((request, sender) => {
         //! INVOKING buildHierarchy FIGURE OUT WHAT TO PASS IN!!!!
         sendToHierarchy(
           tabsObj[tabId],
-          new Node(request.payload, tabsObj[tabId])
+          new Node(request.payload, tabsObj[tabId]),
         );
       }
       // send message to devtools
       if (portsArr.length > 0) {
-        portsArr.forEach(bg =>
-          bg.postMessage({
-            action: 'sendSnapshots',
-            payload: tabsObj,
-            sourceTab,
-          })
-        );
+        portsArr.forEach(bg => bg.postMessage({
+          action: 'sendSnapshots',
+          payload: tabsObj,
+          sourceTab,
+        }));
       }
       break;
     }
@@ -247,12 +240,10 @@ chrome.runtime.onMessage.addListener((request, sender) => {
 chrome.tabs.onRemoved.addListener(tabId => {
   // tell devtools which tab to delete
   if (portsArr.length > 0) {
-    portsArr.forEach(bg =>
-      bg.postMessage({
-        action: 'deleteTab',
-        payload: tabId,
-      })
-    );
+    portsArr.forEach(bg => bg.postMessage({
+      action: 'deleteTab',
+      payload: tabId,
+    }));
   }
 
   // delete the tab from the tabsObj
@@ -274,7 +265,6 @@ chrome.runtime.onInstalled.addListener(() => {
 // when context menu is clicked, listen for the menuItemId,
 // if user clicked on reactime, open the devtools window
 chrome.contextMenus.onClicked.addListener(({ menuItemId }) => {
-  console.log('clicked menu');
   const options = {
     type: 'panel',
     left: 0,