Fix sending duplicate revisions

Author: CompuIves

packages/app/src/app/overmind/effects/live/clients.test.ts

@@ -0,0 +1,26 @@
+import { getTextOperation } from '@codesandbox/common/lib/utils/diff';
+import { CodeSandboxOTClient } from './clients';
+
+describe('OTClient', () => {
+  it("it doesn't acknowledge the same revision twice", async () => {
+    const client = new CodeSandboxOTClient(
+      0,
+      'test',
+      (revision, operation) => Promise.resolve(),
+      operation => {}
+    );
+
+    const op = getTextOperation('ab', 'a');
+
+    // The case we're trying to solve here:
+    // (1) applyClient -> (no ack received)
+    // -----
+    // serverReconnect
+    // (2) applyClient. Sent by serverReconnect
+    // (1) resolves. Resolved because of Phoenix
+    // (2) resolves. Resolved because of server reconnect
+
+    await client.sendOperation(0, op);
+    await client.sendOperation(0, op);
+  });
+});

packages/app/src/app/overmind/effects/live/clients.ts

@@ -11,7 +11,7 @@ export type SendOperation = (
 
 export type ApplyOperation = (moduleShortid: string, operation: any) => void;
 
-class CodeSandboxOTClient extends OTClient {
+export class CodeSandboxOTClient extends OTClient {
   /*
     We need to be able to wait for a client to go intro synchronized
     state. The reason is that we want to send a "save" event when the
@@ -34,6 +34,7 @@ class CodeSandboxOTClient extends OTClient {
     this.onApplyOperation = onApplyOperation;
   }
 
+  lastAcknowledgedRevision = null;
   sendOperation(revision, operation) {
     // Whenever we send an operation we enable the blocker
     // that lets us wait for its resolvment when moving back
@@ -42,7 +43,7 @@ class CodeSandboxOTClient extends OTClient {
       this.awaitSynchronized = blocker();
     }
 
-    this.onSendOperation(revision, operation)
+    return this.onSendOperation(revision, operation)
       .then(() => {
         logBreadcrumb({
           type: 'ot',
@@ -52,8 +53,10 @@ class CodeSandboxOTClient extends OTClient {
             operation,
           })}`,
         });
-        // We only acknowledge valig revisions
-        if (this.revision === revision) {
+
+        // We make sure to not acknowledge the same revision twice
+        if (this.lastAcknowledgedRevision < revision) {
+          this.lastAcknowledgedRevision = revision;
           this.serverAck();
         }
       })
@@ -64,6 +67,8 @@ class CodeSandboxOTClient extends OTClient {
         if (this.awaitSynchronized) {
           this.awaitSynchronized.reject(error);
         }
+
+        throw error;
       });
   }
 

packages/common/src/utils/analytics/index.ts

@@ -40,7 +40,7 @@ export async function identify(key: string, value: any) {
 }
 
 export async function setAnonymousId() {
-  if (!DO_NOT_TRACK_ENABLED) {
+  if (!DO_NOT_TRACK_ENABLED && typeof localStorage !== 'undefined') {
     let anonymousUid = localStorage.getItem(ANONYMOUS_UID_KEY);
 
     if (!anonymousUid) {

packages/common/src/utils/analytics/utils.ts

@@ -76,7 +76,8 @@ export const DO_NOT_TRACK_ENABLED =
       global.navigator.doNotTrack === '1' ||
       // @ts-ignore
       global.navigator.msDoNotTrack === '1' ||
-      localStorage.getItem('DO_NOT_TRACK_ENABLED') ||
+      (typeof localStorage !== 'undefined' &&
+        localStorage.getItem('DO_NOT_TRACK_ENABLED')) ||
       process.env.NODE_ENV === 'development' ||
       process.env.STAGING
   );