refactor(replicache): merge ReplicacheOptionsInternal into Replicache…

…ImplOptions (#1891)

packages/reflect-client/src/client/reflect.ts

@@ -359,14 +359,11 @@ export class Reflect<MD extends MutatorDefs> {
       licenseKey: 'reflect-client-static-key',
       kvStore,
     };
-    const replicacheInternalOptions = {
+    const replicacheImplOptions = {
       enableLicensing: false,
     };
 
-    this.#rep = new ReplicacheImpl({
-      ...replicacheOptions,
-      ...replicacheInternalOptions,
-    });
+    this.#rep = new ReplicacheImpl(replicacheOptions, replicacheImplOptions);
 
     this.#rep.getAuth = this.#getAuthToken;
     this.#onUpdateNeeded = this.#rep.onUpdateNeeded; // defaults to reload.

packages/replicache/perf/replicache.ts

@@ -12,7 +12,10 @@ import {
   TEST_LICENSE_KEY,
   WriteTransaction,
 } from '../src/mod.js';
-import {ReplicacheImpl as Replicache} from '../src/replicache-impl.js';
+import {
+  ReplicacheImpl as Replicache,
+  ReplicacheImpl,
+} from '../src/replicache-impl.js';
 import {uuid} from '../src/uuid.js';
 import {
   TestDataObject,
@@ -21,6 +24,7 @@ import {
   jsonObjectTestData,
 } from './data.js';
 import type {Bencher, Benchmark} from './perf.js';
+import {restoreMakeImplForTest, setMakeImplForTest} from '../src/replicache.js';
 
 const valSize = 1024;
 
@@ -322,14 +326,20 @@ export function benchmarkRebase(opts: {
 
 class ReplicachePerfTest<MD extends MutatorDefs> extends Replicache<MD> {
   constructor(options: Omit<ReplicacheOptions<MD>, 'licenseKey'>) {
+    setMakeImplForTest(
+      <M extends MutatorDefs>(ops: ReplicacheOptions<M>) =>
+        new ReplicacheImpl<M>(ops, {
+          enableLicensing: false,
+          enableMutationRecovery: false,
+          enableScheduledRefresh: false,
+          enableScheduledPersist: false,
+        }),
+    );
     super({
       ...options,
       licenseKey: TEST_LICENSE_KEY,
-      enableLicensing: false,
-      enableMutationRecovery: false,
-      enableScheduledRefresh: false,
-      enableScheduledPersist: false,
     });
+    restoreMakeImplForTest();
   }
 }
 

packages/replicache/src/replicache-collect-idb-databases.test.ts

@@ -37,9 +37,13 @@ test('collect IDB databases', async () => {
   await clock.tickAsync(ONE_WEEK);
 
   // Open one more database and keep it open long enough to trigger the collection.
-  const rep3 = await replicacheForTesting('collect-idb-databases-3', {
-    enableLicensing: false,
-  });
+  const rep3 = await replicacheForTesting(
+    'collect-idb-databases-3',
+    undefined,
+    {
+      enableLicensing: false,
+    },
+  );
   await clock.tickAsync(FIVE_MINUTES);
   await rep3.close();
 

packages/replicache/src/replicache-impl.ts

@@ -70,10 +70,7 @@ import {refresh} from './persist/refresh.js';
 import {ProcessScheduler} from './process-scheduler.js';
 import type {Puller} from './puller.js';
 import {Pusher, PushError} from './pusher.js';
-import type {
-  ReplicacheInternalOptions,
-  ReplicacheOptions,
-} from './replicache-options.js';
+import type {ReplicacheOptions} from './replicache-options.js';
 import {
   getKVStoreProvider,
   httpStatusUnauthorized,
@@ -166,6 +163,32 @@ const defaultMakeSubscriptionsManager: MakeSubscriptionsManager = (
 ) => new SubscriptionsManagerImpl(queryInternal, lc);
 
 export interface ReplicacheImplOptions {
+  /**
+   * Defaults to true.
+   * Does not use a symbol because it is used by reflect.
+   */
+  enableLicensing?: boolean | undefined;
+
+  /**
+   * Defaults to true.
+   */
+  enableMutationRecovery?: boolean | undefined;
+
+  /**
+   * Defaults to true.
+   */
+  enableScheduledPersist?: boolean | undefined;
+
+  /**
+   * Defaults to true.
+   */
+  enableScheduledRefresh?: boolean | undefined;
+
+  /**
+   * Defaults to true.
+   */
+  enablePullAndPushInOpen?: boolean | undefined;
+
   /**
    * Default is `defaultMakeSubscriptionsManager`.
    */
@@ -378,7 +401,7 @@ export class ReplicacheImpl<MD extends MutatorDefs = {}> {
   onRecoverMutations = (r: Promise<boolean>) => r;
 
   constructor(
-    options: ReplicacheOptions<MD> & ReplicacheInternalOptions,
+    options: ReplicacheOptions<MD>,
     implOptions: ReplicacheImplOptions = {},
   ) {
     const {
@@ -397,15 +420,13 @@ export class ReplicacheImpl<MD extends MutatorDefs = {}> {
       pusher,
       licenseKey,
       indexes = {},
+    } = options;
+    const {
       enableMutationRecovery = true,
       enableLicensing = true,
       enableScheduledPersist = true,
-
       enableScheduledRefresh = true,
-
       enablePullAndPushInOpen = true,
-    } = options;
-    const {
       makeSubscriptionsManager = defaultMakeSubscriptionsManager,
       enableClientGroupForking = true,
     } = implOptions;

packages/replicache/src/replicache-mutation-recovery-dd31.test.ts

@@ -1516,6 +1516,7 @@ suite('DD31', () => {
       {
         pullURL: 'https://diff.com/pull',
       },
+      undefined,
       {
         useDefaultURLs: false,
       },
@@ -1528,10 +1529,13 @@ suite('DD31', () => {
   });
 
   test('mutation recovery returns early when internal option enableMutationRecovery is false', async () => {
-    const rep = await replicacheForTesting('mutation-recovery-startup', {
-      pullURL: 'https://diff.com/pull',
-      ...disableAllBackgroundProcesses,
-    });
+    const rep = await replicacheForTesting(
+      'mutation-recovery-startup',
+      {
+        pullURL: 'https://diff.com/pull',
+      },
+      disableAllBackgroundProcesses,
+    );
     expect(rep.recoverMutationsFake.callCount).to.equal(1);
     expect(await rep.recoverMutationsFake.firstCall.returnValue).to.equal(
       false,
@@ -1574,9 +1578,13 @@ suite('DD31', () => {
   });
 
   test('mutation recovery is invoked on 5 minute interval', async () => {
-    const rep = await replicacheForTesting('mutation-recovery-startup-dd31-4', {
-      enableLicensing: false,
-    });
+    const rep = await replicacheForTesting(
+      'mutation-recovery-startup-dd31-4',
+      undefined,
+      {
+        enableLicensing: false,
+      },
+    );
     expect(rep.recoverMutationsFake.callCount).to.equal(1);
     await clock.tickAsync(5 * 60 * 1000);
     expect(rep.recoverMutationsFake.callCount).to.equal(2);

packages/replicache/src/replicache-mutation-recovery.test.ts

@@ -1068,6 +1068,7 @@ suite('SDD', () => {
       {
         pullURL: 'https://diff.com/pull',
       },
+      undefined,
       {useDefaultURLs: false},
     );
     expect(rep.recoverMutationsFake.callCount).to.equal(1);
@@ -1082,8 +1083,8 @@ suite('SDD', () => {
       'mutation-recovery-startup',
       {
         pullURL: 'https://diff.com/pull',
-        ...disableAllBackgroundProcesses,
       },
+      disableAllBackgroundProcesses,
       {useDefaultURLs: false},
     );
     expect(rep.recoverMutationsFake.callCount).to.equal(1);
@@ -1128,9 +1129,13 @@ suite('SDD', () => {
   });
 
   test('mutation recovery is invoked on 5 minute interval', async () => {
-    const rep = await replicacheForTesting('mutation-recovery-startup', {
-      enableLicensing: false,
-    });
+    const rep = await replicacheForTesting(
+      'mutation-recovery-startup',
+      undefined,
+      {
+        enableLicensing: false,
+      },
+    );
     expect(rep.recoverMutationsFake.callCount).to.equal(1);
     await clock.tickAsync(5 * 60 * 1000);
     expect(rep.recoverMutationsFake.callCount).to.equal(2);

packages/replicache/src/replicache-on-update-needed.test.ts

@@ -14,6 +14,7 @@ suite('onUpdateNeeded', () => {
       {
         mutators: {test1: () => undefined},
       },
+      undefined,
       {useUniqueName: false},
     );
     let onUpdateNeededReason;
@@ -26,6 +27,7 @@ suite('onUpdateNeeded', () => {
       {
         mutators: {test2: () => undefined},
       },
+      undefined,
       {useUniqueName: false},
     );
 
@@ -43,6 +45,7 @@ suite('onUpdateNeeded', () => {
         mutators: {test1: () => undefined},
         schemaVersion: '1',
       },
+      undefined,
       {useUniqueName: false},
     );
     let onUpdateNeededReason;
@@ -55,6 +58,7 @@ suite('onUpdateNeeded', () => {
         mutators: {test1: () => undefined},
         schemaVersion: '2',
       },
+      undefined,
       {useUniqueName: false},
     );
     expect(onUpdateNeededReason).to.deep.equal({

packages/replicache/src/replicache-options.ts

@@ -217,31 +217,3 @@ export interface ReplicacheOptions<MD extends MutatorDefs> {
    */
   readonly indexes?: IndexDefinitions | undefined;
 }
-
-export type ReplicacheInternalOptions = {
-  /**
-   * Defaults to true.
-   * Does not use a symbol because it is used by reflect.
-   */
-  enableLicensing?: boolean | undefined;
-
-  /**
-   * Defaults to true.
-   */
-  enableMutationRecovery?: boolean | undefined;
-
-  /**
-   * Defaults to true.
-   */
-  enableScheduledPersist?: boolean | undefined;
-
-  /**
-   * Defaults to true.
-   */
-  enableScheduledRefresh?: boolean | undefined;
-
-  /**
-   * Defaults to true.
-   */
-  enablePullAndPushInOpen?: boolean | undefined;
-};

packages/replicache/src/replicache-persist.test.ts

@@ -135,6 +135,7 @@ test('basic persist & load', async () => {
     {
       pullURL,
     },
+    undefined,
     {useUniqueName: false},
   );
   await rep2.query(async tx => {
@@ -182,10 +183,13 @@ suite('onClientStateNotFound', () => {
     const mutators = {
       addData,
     };
-    const rep = await replicacheForTesting(name, {
-      mutators,
-      ...disableAllBackgroundProcesses,
-    });
+    const rep = await replicacheForTesting(
+      name,
+      {
+        mutators,
+      },
+      disableAllBackgroundProcesses,
+    );
 
     await rep.mutate.addData({foo: 'bar'});
     await rep.persist();
@@ -202,10 +206,12 @@ suite('onClientStateNotFound', () => {
       rep.name,
       {
         mutators,
-        ...disableAllBackgroundProcesses,
+      },
+      {
         // To ensure query has to go to perdag, prevent pull from happening and
         // populating the lazy store cache.
         enablePullAndPushInOpen: false,
+        ...disableAllBackgroundProcesses,
       },
       // Use same idb and client group as above rep.
       {useUniqueName: false},
@@ -249,10 +255,13 @@ suite('onClientStateNotFound', () => {
       },
     };
 
-    const rep = await replicacheForTesting(name, {
-      mutators,
-      ...disableAllBackgroundProcesses,
-    });
+    const rep = await replicacheForTesting(
+      name,
+      {
+        mutators,
+      },
+      disableAllBackgroundProcesses,
+    );
 
     await rep.mutate.addData({foo: 'bar'});
     await rep.persist();
@@ -264,6 +273,8 @@ suite('onClientStateNotFound', () => {
       rep.name,
       {
         mutators,
+      },
+      {
         ...disableAllBackgroundProcesses,
         // To ensure mutate has to go to perdag, prevent pull from happening and
         // populating the lazy store cache.
@@ -306,8 +317,8 @@ test('Persist throws if idb dropped', async () => {
     'called-in-persist-dropped',
     {
       mutators: {addData},
-      ...disableAllBackgroundProcesses,
     },
+    disableAllBackgroundProcesses,
     {useUniqueName: false},
   );