chore(zero): Statically disable mutation recovery (#3519)

This allows dead code elimination to remove the mutation recovery code.

Author: arv

packages/replicache/src/replicache-impl.ts

@@ -124,6 +124,12 @@ import {
 
 declare const TESTING: boolean;
 
+declare const process: {
+  env: {
+    ['DISABLE_MUTATION_RECOVERY']?: string | undefined;
+  };
+};
+
 /**
  * The maximum number of time to call out to getAuth before giving up
  * and throwing an error.
@@ -202,7 +208,7 @@ export class ReplicacheImpl<MD extends MutatorDefs = {}> {
   readonly name: string;
 
   readonly #subscriptions: SubscriptionsManager;
-  readonly #mutationRecovery: MutationRecovery;
+  readonly #mutationRecovery: MutationRecovery | undefined;
 
   /**
    * Client groups gets disabled when the server does not know about it.
@@ -475,16 +481,18 @@ export class ReplicacheImpl<MD extends MutatorDefs = {}> {
     const clientGroupIDResolver = resolver<string>();
     this.#clientGroupIDPromise = clientGroupIDResolver.promise;
 
-    this.#mutationRecovery = new MutationRecovery({
-      delegate: this,
-      lc: this.#lc,
-      enableMutationRecovery,
-      wrapInOnlineCheck: this.#wrapInOnlineCheck.bind(this),
-      wrapInReauthRetries: this.#wrapInReauthRetries.bind(this),
-      isPullDisabled: this.#isPullDisabled.bind(this),
-      isPushDisabled: this.#isPushDisabled.bind(this),
-      clientGroupIDPromise: this.#clientGroupIDPromise,
-    });
+    if (!process.env.DISABLE_MUTATION_RECOVERY) {
+      this.#mutationRecovery = new MutationRecovery({
+        delegate: this,
+        lc: this.#lc,
+        enableMutationRecovery,
+        wrapInOnlineCheck: this.#wrapInOnlineCheck.bind(this),
+        wrapInReauthRetries: this.#wrapInReauthRetries.bind(this),
+        isPullDisabled: this.#isPullDisabled.bind(this),
+        isPushDisabled: this.#isPushDisabled.bind(this),
+        clientGroupIDPromise: this.#clientGroupIDPromise,
+      });
+    }
 
     this.#onPersist = initOnPersistChannel(
       this.name,
@@ -1498,18 +1506,20 @@ export class ReplicacheImpl<MD extends MutatorDefs = {}> {
     return ex;
   }
 
-  recoverMutations(): Promise<boolean> {
-    const result = this.#mutationRecovery.recoverMutations(
-      this.#ready,
-      this.perdag,
-      this.#idbDatabase,
-      this.#idbDatabases,
-      this.#kvStoreProvider.create,
-    );
-    if (TESTING) {
-      void this.onRecoverMutations(result);
+  recoverMutations(): Promise<boolean> | void {
+    if (!process.env.DISABLE_MUTATION_RECOVERY) {
+      const result = this.#mutationRecovery!.recoverMutations(
+        this.#ready,
+        this.perdag,
+        this.#idbDatabase,
+        this.#idbDatabases,
+        this.#kvStoreProvider.create,
+      );
+      if (TESTING) {
+        void this.onRecoverMutations(result);
+      }
+      return result;
     }
-    return result;
   }
 
   /**

packages/replicache/src/test-util.ts

@@ -74,7 +74,7 @@ export class ReplicacheTest<
   }
 
   recoverMutations(): Promise<boolean> {
-    return this.#impl.recoverMutations();
+    return this.#impl.recoverMutations() as Promise<boolean>;
   }
 
   get perdag() {

packages/shared/src/build.js

@@ -59,6 +59,7 @@ export function makeDefine(mode = 'unknown') {
       getVersion('replicache'),
     ),
     ['process.env.ZERO_VERSION']: JSON.stringify(getVersion('zero')),
+    ['process.env.DISABLE_MUTATION_RECOVERY']: 'false',
     ['TESTING']: 'false',
   };
   if (mode === 'unknown') {

packages/zero/tool/build.js

@@ -101,6 +101,8 @@ async function verifyDependencies(external) {
 
 async function buildZeroClient() {
   const define = makeDefine('unknown');
+  define['process.env.DISABLE_MUTATION_RECOVERY'] = 'true';
+
   const entryPoints = forBundleSizeDashboard
     ? {zero: basePath('src/zero.ts')}
     : {