test: handle new provider options

xmtp · Aug 22, 2023 · f49c839 · f49c839
1 parent d1ff3eb
commit f49c839
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 28 deletions.
diff --git a/test/keystore/providers/KeyGeneratorKeystoreProvider.test.ts b/test/keystore/providers/KeyGeneratorKeystoreProvider.test.ts
@@ -18,7 +18,7 @@ describe('KeyGeneratorKeystoreProvider', () => {
   it('creates a key when wallet supplied', async () => {
     const provider = new KeyGeneratorKeystoreProvider()
     const keystore = await provider.newKeystore(
-      testProviderOptions(),
+      testProviderOptions({}),
       apiClient,
       wallet
     )
@@ -28,7 +28,7 @@ describe('KeyGeneratorKeystoreProvider', () => {
   it('throws KeystoreProviderUnavailableError when no wallet supplied', async () => {
     const provider = new KeyGeneratorKeystoreProvider()
     const prom = provider.newKeystore(
-      testProviderOptions(),
+      testProviderOptions({}),
       apiClient,
       undefined
     )
@@ -39,7 +39,7 @@ describe('KeyGeneratorKeystoreProvider', () => {
     const provider = new KeyGeneratorKeystoreProvider()
     const preCreateIdentityCallback = jest.fn()
     const keystore = await provider.newKeystore(
-      { ...testProviderOptions(), preCreateIdentityCallback },
+      { ...testProviderOptions({}), preCreateIdentityCallback },
       apiClient,
       wallet
     )
@@ -51,7 +51,7 @@ describe('KeyGeneratorKeystoreProvider', () => {
     const provider = new KeyGeneratorKeystoreProvider()
     const preEnableIdentityCallback = jest.fn()
     const keystore = await provider.newKeystore(
-      { ...testProviderOptions(), preEnableIdentityCallback },
+      { ...testProviderOptions({}), preEnableIdentityCallback },
       apiClient,
       wallet
     )

diff --git a/test/keystore/providers/NetworkKeyManager.test.ts b/test/keystore/providers/NetworkKeyManager.test.ts
@@ -6,6 +6,7 @@ import { buildPersistenceFromOptions } from '../../../src/keystore/providers/hel
 import NetworkKeyManager from '../../../src/keystore/providers/NetworkKeyManager'
 import { Signer } from '../../../src/types/Signer'
 import { newWallet, pollFor, sleep, wrapAsLedgerWallet } from '../../helpers'
+import { testProviderOptions } from './helpers'
 
 describe('NetworkKeyManager', () => {
   let wallet: Signer
@@ -100,13 +101,13 @@ describe('NetworkKeyManager', () => {
   it('respects the options provided', async () => {
     const bundle = await PrivateKeyBundleV1.generate(wallet)
     const shouldBeUndefined = await buildPersistenceFromOptions(
-      { persistConversations: false, env: 'local' },
+      testProviderOptions({ persistConversations: false }),
       bundle
     )
     expect(shouldBeUndefined).toBeUndefined()
 
     const shouldBeDefined = await buildPersistenceFromOptions(
-      { persistConversations: true, env: 'local' },
+      testProviderOptions({ persistConversations: true }),
       bundle
     )
     expect(shouldBeDefined).toBeInstanceOf(PrefixedPersistence)

diff --git a/test/keystore/providers/NetworkKeystoreProvider.test.ts b/test/keystore/providers/NetworkKeystoreProvider.test.ts
@@ -28,7 +28,7 @@ describe('NetworkKeystoreProvider', () => {
   it('fails gracefully when no keys are found', async () => {
     const provider = new NetworkKeystoreProvider()
     expect(
-      provider.newKeystore(testProviderOptions(), apiClient, wallet)
+      provider.newKeystore(testProviderOptions({}), apiClient, wallet)
     ).rejects.toThrow(KeystoreProviderUnavailableError)
   })
 
@@ -41,7 +41,7 @@ describe('NetworkKeystoreProvider', () => {
 
     const provider = new NetworkKeystoreProvider()
     const keystore = await provider.newKeystore(
-      testProviderOptions(),
+      testProviderOptions({}),
       apiClient,
       wallet
     )
@@ -74,7 +74,7 @@ describe('NetworkKeystoreProvider', () => {
     // Now try and load it
     const provider = new NetworkKeystoreProvider()
     const keystore = await provider.newKeystore(
-      testProviderOptions(),
+      testProviderOptions({}),
       apiClient,
       wallet
     )
@@ -91,7 +91,7 @@ describe('NetworkKeystoreProvider', () => {
     const provider = new NetworkKeystoreProvider()
     const mockNotifier = jest.fn()
     await provider.newKeystore(
-      { ...testProviderOptions(), preEnableIdentityCallback: mockNotifier },
+      { ...testProviderOptions({}), preEnableIdentityCallback: mockNotifier },
       apiClient,
       wallet
     )

diff --git a/test/keystore/providers/StaticKeystoreProvider.test.ts b/test/keystore/providers/StaticKeystoreProvider.test.ts
@@ -1,6 +1,7 @@
 import { privateKey } from '@xmtp/proto'
 import { PrivateKeyBundleV1 } from '../../../src/crypto'
 import { newWallet } from '../../helpers'
+import { testProviderOptions } from './helpers'
 import StaticKeystoreProvider from '../../../src/keystore/providers/StaticKeystoreProvider'
 import { KeystoreProviderUnavailableError } from '../../../src/keystore/providers/errors'
 
@@ -14,31 +15,37 @@ describe('StaticKeystoreProvider', () => {
       v2: undefined,
     }).finish()
     const provider = new StaticKeystoreProvider()
-    const keystore = await provider.newKeystore({
-      privateKeyOverride: keyBytes,
-      env: ENV,
-      persistConversations: false,
-    })
+    const keystore = await provider.newKeystore(
+      testProviderOptions({
+        privateKeyOverride: keyBytes,
+        env: ENV,
+        persistConversations: false,
+      })
+    )
 
     expect(keystore).not.toBeNull()
   })
 
   it('throws with an unset key', async () => {
     expect(
-      new StaticKeystoreProvider().newKeystore({
-        env: ENV,
-        persistConversations: false,
-      })
+      new StaticKeystoreProvider().newKeystore(
+        testProviderOptions({
+          env: ENV,
+          persistConversations: false,
+        })
+      )
     ).rejects.toThrow(KeystoreProviderUnavailableError)
   })
 
   it('fails with an invalid key', async () => {
     expect(
-      new StaticKeystoreProvider().newKeystore({
-        privateKeyOverride: Uint8Array.from([1, 2, 3]),
-        env: ENV,
-        persistConversations: false,
-      })
+      new StaticKeystoreProvider().newKeystore(
+        testProviderOptions({
+          privateKeyOverride: Uint8Array.from([1, 2, 3]),
+          env: ENV,
+          persistConversations: false,
+        })
+      )
     ).rejects.toThrow()
   })
 })
diff --git a/test/keystore/providers/helpers.ts b/test/keystore/providers/helpers.ts
@@ -1,11 +1,13 @@
 import { LocalStoragePersistence } from '../../../src'
+import { KeystoreProviderOptions } from '../../../src/keystore/providers'
 
-export const testProviderOptions = (
+export const testProviderOptions = ({
   privateKeyOverride = undefined,
   persistConversations = false,
-  basePersistence = new LocalStoragePersistence()
-) => ({
-  env: 'local' as const,
+  basePersistence = new LocalStoragePersistence(),
+  env = 'local' as const,
+}: Partial<KeystoreProviderOptions>) => ({
+  env,
   persistConversations,
   privateKeyOverride,
   basePersistence,