added unit tests for serialization on Tree class

Author: Zachary Freeman

src/backend/__tests__/tree.test.ts

@@ -1,19 +1,56 @@
 import Tree from '../tree';
 import { serializeState, scrubUnserializableMembers } from '../tree';
 
-/**
- * Created new tree under sibling and copy and clean tree describe block --
- * Reason is because other tests are adding properties to tree and affecting the child block,
- * so this was a quick way to test the trees getting reset to initial state
- *
- * Possible fix if more time allowed: Making use of beforeEach or afterEach --
- */
-
 describe('Serialize state unit test', () => {
-  const dummyState = { counter: 1, playerOne: 'X' };
+  const dummyState = {
+    counter: 1,
+    playerOne: 'X',
+    board: [
+      ['', 'O', 'X'],
+      ['', 'O', 'X'],
+      ['O', 'X', ''],
+    ],
+  };
+
+  const circularState: { [key: string]: any } = {};
+  circularState.circ = circularState;
+
+  const serializedState = serializeState(dummyState);
+  const serializedCircularState = serializeState(circularState);
+
+  it('should create a deep copy of state', () => {
+    expect(dummyState).toEqual(serializedState);
+    expect(dummyState).not.toBe(serializedState);
+  });
+
+  it('should detect circular state', () => {
+    expect(serializedCircularState).toEqual('circularState');
+  });
 });
 
-describe('Tree unit test', () => {
+describe('Scrub unserialized members unit test', () => {
+  const dummyState = {
+    counter: 1,
+    playerOne: 'X',
+    board: [
+      ['', 'O', 'X'],
+      ['', 'O', 'X'],
+      ['O', 'X', ''],
+    ],
+    increment: function () {
+      this.counter++;
+    },
+  };
+  const newTree = new Tree(dummyState);
+  const scrubbedTree = scrubUnserializableMembers(newTree);
+  // make sure return type is tree
+  it('should be instance of tree', () => {
+    expect(newTree).toBeInstanceOf(Tree);
+  });
+  // make sure function is scrubbed
+});
+
+xdescribe('Tree unit test', () => {
   const newTree = new Tree({});
   describe('Constructor', () => {
     it('should be able to create a newTree', () => {
@@ -35,20 +72,6 @@ describe('Tree unit test', () => {
     });
   });
 
-  /**
-   *
-   * making sure to adhere to ts practices when goign through tests
-   *
-   * ^^
-   * the tree should have initial values of state,
-   * name, etc to be default as per newly created tree
-   * update the add child and add sibling tests
-   *
-   * update the clean tree copy test to make it test for deep equaltiy? (note:
-   * this test may always fail if we make it so because there is no way to have deep equalituy
-   * with some shit that isn't allowed)
-   */
-
   describe('Adding children', () => {
     const returnChild = newTree.addChild('stateful', 'child', {}, null);
 

src/backend/tree.ts

@@ -7,21 +7,21 @@
 /* eslint-disable no-param-reassign */
 
 let copyInstances = 0; // Tells you if we have already made a copy of current tree??
-const circularComponentTable = new Set<Tree>(); // Keeps track of the nodes added to the tree and allows you make sure there isnt circular state
+const circularComponentTable = new Set<Tree>(); // Keeps track of the nodes added to the tree
 let componentNames = {}; // {componentName: frequency of use} => component name as a key and it's frequency of use as its value
 
 // Functions dont serialize properly so we need to scrub for that
-function scrubUnserializableMembers(tree: Tree): Tree {
+export function scrubUnserializableMembers(tree: Tree): Tree {
   Object.entries(tree.state).forEach((keyValuePair) => {
     if (typeof keyValuePair[1] === 'function') tree.state[keyValuePair[0]] = 'function';
   });
   return tree;
 }
 
 // Making a deep clone of state becuase we want to make a copy
-function serializeState(state) {
+export function serializeState(state) {
   try {
-    // makes a deep clone, but this way can be very slow
+    // makes a deep clone
     return JSON.parse(JSON.stringify(state));
   } catch (e) {
     // if there is an error, that means there is circular state i.e state that depends on itself