From adc7ac7dbf209744ae74b04c870f6c5acbbcc5b6 Mon Sep 17 00:00:00 2001
From: Eric Maciel <elm2178@columbia.edu>
Date: Thu, 4 Mar 2021 15:54:39 -0500
Subject: [PATCH] chore: code commenting

---
 packages/backend/src/utils/getActiveConnections.ts | 3 +++
 packages/client/src/client.spec.ts                 | 7 +++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/packages/backend/src/utils/getActiveConnections.ts b/packages/backend/src/utils/getActiveConnections.ts
index bc85d45..366eecd 100644
--- a/packages/backend/src/utils/getActiveConnections.ts
+++ b/packages/backend/src/utils/getActiveConnections.ts
@@ -1,5 +1,8 @@
 import AutomergeBackend from '../AutomergeBackend'
 
+/**
+ * Get the number of active connections for the specified docId
+ */
 const getActiveConnections = (backend: AutomergeBackend, docId: string) => {
   const automergeDocument = backend.documentSetMap[docId]
 
diff --git a/packages/client/src/client.spec.ts b/packages/client/src/client.spec.ts
index 53d04cf..69237b5 100644
--- a/packages/client/src/client.spec.ts
+++ b/packages/client/src/client.spec.ts
@@ -75,10 +75,14 @@ describe('automerge editor client tests', () => {
 
   let collabEditors: (Editor & WithSocketIOEditor & AutomergeEditor)[] = []
   afterEach(done => {
+    // Clear our operation traces after each test
     operationTraces = []
+
+    // Destroy any created collab editors after each test
     collabEditors.forEach(editor => editor.destroy())
     collabEditors = []
 
+    // Ensure that the collab document has been cleaned up on the backend
     waitForCondition(() => !collabBackend.backend.getDocument(docId)).then(done)
   })
 
@@ -276,7 +280,7 @@ describe('automerge editor client tests', () => {
 
   it('should reconnect with no opCount', async () => {
     const editor1 = await createCollabEditor({ resetOnReconnect: true })
-    console.log('----\neditor1 disconnect\n-----')
+
     await waitForCondition(() => {
       return getActiveConnections(collabBackend.backend, docId) === 1
     })
@@ -287,7 +291,6 @@ describe('automerge editor client tests', () => {
       () => getActiveConnections(collabBackend.backend, docId) === 0
     )
 
-    console.log('----\neditor1 reconnect\n-----')
     editor1.connect()
 
     await waitForCondition(