refactor(suite): inject suite sync migration wrapper factory

Refs #28176

Author: peter-sanderson

packages/suite/src/support/extraDependencies.ts

@@ -7,9 +7,15 @@ import { lockDevice } from '@suite/locks';
 import {
     metadataActions,
     metadataLabelingActions,
+    selectHasLegacyLabelsMigrated,
+    selectIsMetadataEnabled,
     selectLabelingDataForAccount,
+    selectSelectedProviderForLabels,
 } from '@suite/metadata';
-import { createMetadataMigrationCompositionRoot } from '@suite/metadata-migration';
+import {
+    createEnsureWalletSuiteSyncOnWithMigration,
+    createMetadataMigrationCompositionRoot,
+} from '@suite/metadata-migration';
 import type { MetadataMigrationDep } from '@suite/metadata-migration';
 import { closeModal, openModal } from '@suite/modal';
 import {
@@ -42,6 +48,7 @@ import {
     selectIsSuiteSyncEnabled,
     selectSuiteSyncWalletLabel,
 } from '@suite-common/suite-sync';
+import { type SuiteSync } from '@suite-common/suite-sync-types';
 import {
     type TokenDefinitionsState,
     buildTokenDefinitionsFromStorage,
@@ -108,7 +115,22 @@ export const createSuiteServicesCompositionRoot = (deps: SuiteAppDeps): SuiteSer
 
     const analytics = createAnalytics();
 
-    const suiteSync = createSuiteSyncDesktopCompositionRoot({
+    const getCurrentAccountLabels = toGetter(deps.getState, selectAllLabelsForAccount);
+    const getAccountsByDeviceState = toGetter(deps.getState, selectAccountsByDeviceState);
+    const migrateLegacyLabelsToSuiteSyncRef: {
+        current: MetadataMigrationDep['migrateLegacyLabelsToSuiteSync'] | undefined;
+    } = { current: undefined };
+
+    const createDecoratedEnsureWalletSuiteSyncOn = createEnsureWalletSuiteSyncOnWithMigration({
+        dispatch: deps.dispatch,
+        getMigrateLegacyLabelsToSuiteSync: () => migrateLegacyLabelsToSuiteSyncRef.current,
+        getIsMetadataEnabled: toGetter(deps.getState, selectIsMetadataEnabled),
+        getSelectedProviderForLabels: toGetter(deps.getState, selectSelectedProviderForLabels),
+        getHasLegacyLabelsMigrated: toGetter(deps.getState, selectHasLegacyLabelsMigrated),
+        getDeviceByStaticSessionId: toGetter(deps.getState, selectDeviceByStaticSessionId),
+    });
+
+    const suiteSync: SuiteSync = createSuiteSyncDesktopCompositionRoot({
         dispatch: deps.dispatch,
         getState: deps.getState,
         platformEncryption: deps.platformEncryption,
@@ -122,9 +144,18 @@ export const createSuiteServicesCompositionRoot = (deps: SuiteAppDeps): SuiteSer
                 dispatch: deps.dispatch,
                 deviceStaticSessionId: device?.state?.staticSessionId ?? null,
             }),
+        createDecoratedEnsureWalletSuiteSyncOn,
     });
 
-    const getCurrentAccountLabels = toGetter(deps.getState, selectAllLabelsForAccount);
+    const { migrateLegacyLabelsToSuiteSync } = createMetadataMigrationCompositionRoot({
+        getState: deps.getState,
+        getAccountsByDeviceState,
+        getCurrentWalletLabel: toGetter(deps.getState, selectSuiteSyncWalletLabel),
+        getCurrentAccountLabels,
+        labeling: suiteSync.labeling,
+    });
+
+    migrateLegacyLabelsToSuiteSyncRef.current = migrateLegacyLabelsToSuiteSync;
 
     const { bip329 } = createBip329CompositionRoot({
         getIsSuiteSyncEnabled: toGetter(deps.getState, selectIsSuiteSyncEnabled),
@@ -134,27 +165,8 @@ export const createSuiteServicesCompositionRoot = (deps: SuiteAppDeps): SuiteSer
         updateOutputLabel: suiteSync.labeling.updateOutputLabel,
     });
 
-    const getAccountsByDeviceState = toGetter(deps.getState, selectAccountsByDeviceState);
-
-    const {
-        ensureWalletSuiteSyncOn: ensureWalletSuiteSyncOnWithMigration,
-        migrateLegacyLabelsToSuiteSync,
-    } = createMetadataMigrationCompositionRoot({
-        dispatch: deps.dispatch,
-        getState: deps.getState,
-        ensureWalletSuiteSyncOn: suiteSync.ensureWalletSuiteSyncOn,
-        getAccountsByDeviceState,
-        getCurrentWalletLabel: toGetter(deps.getState, selectSuiteSyncWalletLabel),
-        getCurrentAccountLabels,
-        getDeviceByStaticSessionId: toGetter(deps.getState, selectDeviceByStaticSessionId),
-        labeling: suiteSync.labeling,
-    });
-
     return {
-        suiteSync: {
-            ...suiteSync,
-            ensureWalletSuiteSyncOn: ensureWalletSuiteSyncOnWithMigration,
-        },
+        suiteSync,
         bip329,
         migrateLegacyLabelsToSuiteSync,
         ensureDelegatedIdentityKey,
@@ -216,6 +228,7 @@ export const extraDependencies: ExtraDependenciesStatic = {
         storageLoadBlockchain: (state: BlockchainState, { payload }: StorageLoadAction) => {
             payload.backendSettings.forEach(backend => {
                 const blockchain = state[backend.key];
+
                 if (blockchain) {
                     blockchain.backends = backend.value;
                 }
@@ -238,9 +251,11 @@ export const extraDependencies: ExtraDependenciesStatic = {
                     networkSymbol: item.tx.symbol,
                     deviceStaticSessionId: item.tx.deviceState,
                 });
+
                 if (!state.transactions[k]) {
                     state.transactions[k] = [];
                 }
+
                 state.transactions[k][item.order] = item.tx;
             });
 

suite-common/suite-sync-types/src/index.ts

@@ -57,6 +57,8 @@ export {
     selectTurnOffSuiteSyncForWalletDep,
 } from './storage/turnOffSuiteSyncForWallet';
 export {
+    type CreateDecoratedEnsureWalletSuiteSyncOn,
+    type CreateDecoratedEnsureWalletSuiteSyncOnDep,
     type EnsureWalletSuiteSyncOnAsync,
     type EnsureWalletSuiteSyncOnAsyncDep,
     type EnsureWalletSuiteSyncOn,

suite-common/suite-sync-types/src/storage/ensureWalletSuiteSyncOn.ts

@@ -35,6 +35,14 @@ export type EnsureWalletSuiteSyncOn = (
     params: EnsureWalletSuiteSyncOnParams,
 ) => Promise<Result<SuiteSyncStorage, EnsureWalletSuiteSyncOnErrors>>;
 
+export type CreateDecoratedEnsureWalletSuiteSyncOn = (
+    ensureWalletSuiteSyncOn: EnsureWalletSuiteSyncOn,
+) => EnsureWalletSuiteSyncOn;
+
+export type CreateDecoratedEnsureWalletSuiteSyncOnDep = {
+    createDecoratedEnsureWalletSuiteSyncOn: CreateDecoratedEnsureWalletSuiteSyncOn;
+};
+
 export type EnsureWalletSuiteSyncOnDep = { ensureWalletSuiteSyncOn: EnsureWalletSuiteSyncOn };
 
 export const selectEnsureWalletSuiteSyncOnDep = (services: any): EnsureWalletSuiteSyncOnDep => ({

suite-common/suite-sync/src/createSuiteSyncCompositionRoot.ts

@@ -19,7 +19,11 @@ import {
     type CreateSuiteStorageDep,
     type CreateSuiteSyncOwnerDep,
 } from '@suite-common/suite-sync-storage';
-import { type SuiteSync, type SuiteSyncInternalErrorHandler } from '@suite-common/suite-sync-types';
+import {
+    type CreateDecoratedEnsureWalletSuiteSyncOnDep,
+    type SuiteSync,
+    type SuiteSyncInternalErrorHandler,
+} from '@suite-common/suite-sync-types';
 import { type AccountsRootState, selectAccounts } from '@suite-common/wallet-core';
 import { type Analytics } from '@trezor/analytics-uploader';
 import type TrezorConnect from '@trezor/connect';
@@ -92,7 +96,8 @@ type CreateSuiteSyncCompositionRootDeps = {
     CreateSuiteSyncOwnerDep &
     PlatformEncryptionDep &
     FetchDep &
-    SuiteSyncAsyncErrorHandlerDep;
+    SuiteSyncAsyncErrorHandlerDep &
+    CreateDecoratedEnsureWalletSuiteSyncOnDep;
 
 export const createSuiteSyncCompositionRoot = (
     deps: CreateSuiteSyncCompositionRootDeps,
@@ -171,12 +176,14 @@ export const createSuiteSyncCompositionRoot = (
 
     const ensureWalletSuiteSyncOn = createEnsureWalletSuiteSyncOnWithErrorHandler({
         dispatch: deps.dispatch,
-        ensureWalletSuiteSyncOn: createEnsureWalletSuiteSyncOn({
-            getState: deps.getState,
-            ensureSuiteSyncKeys,
-            ensureSubscribedStorage,
-            subscriptionStorage,
-        }),
+        ensureWalletSuiteSyncOn: deps.createDecoratedEnsureWalletSuiteSyncOn(
+            createEnsureWalletSuiteSyncOn({
+                getState: deps.getState,
+                ensureSuiteSyncKeys,
+                ensureSubscribedStorage,
+                subscriptionStorage,
+            }),
+        ),
     });
 
     const ensureWalletSuiteSyncOnAsync = createEnsureWalletSuiteSyncOnAsync({

suite-native/suite-sync/src/createSuiteSyncNativeCompositionRoot.ts

@@ -43,6 +43,7 @@ export const createSuiteSyncNativeCompositionRoot = (
 
     return createSuiteSyncCompositionRoot({
         ...deps,
+        createDecoratedEnsureWalletSuiteSyncOn: ensureWalletSuiteSyncOn => ensureWalletSuiteSyncOn,
         createSuiteStorage: createEvoluStorageFactory({
             createEvoluInstance: createEvoluInstanceFactory({ run }),
         }),

suite/metadata-migration/src/createEnsureWalletSuiteSyncOnWithMigration.ts

@@ -5,8 +5,8 @@ import { suiteSyncErrorHandler } from '@suite/suite-sync';
 import { isTrezorDeviceWithState } from '@suite-common/device';
 import { type MetadataProvider } from '@suite-common/metadata-types';
 import {
+    type CreateDecoratedEnsureWalletSuiteSyncOn,
     type EnsureWalletSuiteSyncOn,
-    type EnsureWalletSuiteSyncOnDep,
 } from '@suite-common/suite-sync-types';
 import { type TrezorDevice } from '@suite-common/suite-types';
 import { notificationsActions } from '@suite-common/toast-notifications';
@@ -18,23 +18,27 @@ import type { MigrateLegacyLabelsToSuiteSync } from './migrateLegacyLabelsToSuit
 
 type CreateEnsureWalletSuiteSyncOnWithMigrationDeps = {
     dispatch: Dispatch;
-    migrateLegacyLabelsToSuiteSync: MigrateLegacyLabelsToSuiteSync;
+    getMigrateLegacyLabelsToSuiteSync: () => MigrateLegacyLabelsToSuiteSync | undefined;
     getIsMetadataEnabled: () => boolean;
     getSelectedProviderForLabels: () => MetadataProvider | undefined;
     getHasLegacyLabelsMigrated: (walletDescriptor: WalletDescriptor) => boolean;
     getDeviceByStaticSessionId: (
         deviceStaticSessionId: Parameters<GetLegacyWalletLabels>[0],
     ) => TrezorDevice | undefined;
-} & EnsureWalletSuiteSyncOnDep;
+};
 
-export const createEnsureWalletSuiteSyncOnWithMigration =
-    (deps: CreateEnsureWalletSuiteSyncOnWithMigrationDeps): EnsureWalletSuiteSyncOn =>
-    async params => {
-        const result = await deps.ensureWalletSuiteSyncOn(params);
+export const createEnsureWalletSuiteSyncOnWithMigration = (
+    deps: CreateEnsureWalletSuiteSyncOnWithMigrationDeps,
+): CreateDecoratedEnsureWalletSuiteSyncOn => {
+    let isMigrating = false;
 
-        if (!result.success) {
+    return (ensureWalletSuiteSyncOn: EnsureWalletSuiteSyncOn) => async params => {
+        const result = await ensureWalletSuiteSyncOn(params);
+
+        if (!result.success || isMigrating) {
             return result;
         }
+
         const device = deps.getDeviceByStaticSessionId(params.deviceStaticSessionId);
 
         if (!isTrezorDeviceWithState(device)) {
@@ -51,7 +55,17 @@ export const createEnsureWalletSuiteSyncOnWithMigration =
             return result;
         }
 
-        const migrationResult = await deps.migrateLegacyLabelsToSuiteSync(device);
+        const migrateLegacyLabelsToSuiteSync = deps.getMigrateLegacyLabelsToSuiteSync();
+
+        if (migrateLegacyLabelsToSuiteSync === undefined) {
+            return result;
+        }
+
+        isMigrating = true;
+
+        const migrationResult = await migrateLegacyLabelsToSuiteSync(device);
+
+        isMigrating = false;
 
         if (!migrationResult.success) {
             suiteSyncErrorHandler({
@@ -77,3 +91,4 @@ export const createEnsureWalletSuiteSyncOnWithMigration =
 
         return result;
     };
+};

suite/metadata-migration/src/createMetadataMigrationCompositionRoot.ts

@@ -1,18 +1,11 @@
-import { type Dispatch } from '@reduxjs/toolkit';
-
 import {
     type MetadataRootState,
-    selectHasLegacyLabelsMigrated,
-    selectIsMetadataEnabled,
     selectLabelingDataForAccount,
     selectLabelingDataForWallet,
-    selectSelectedProviderForLabels,
 } from '@suite/metadata';
 import { toGetter } from '@suite-common/dependency-injection';
-import { type EnsureWalletSuiteSyncOnDep, type LabelingDep } from '@suite-common/suite-sync-types';
-import { type TrezorDevice } from '@suite-common/suite-types';
+import { type LabelingDep } from '@suite-common/suite-sync-types';
 
-import { createEnsureWalletSuiteSyncOnWithMigration } from './createEnsureWalletSuiteSyncOnWithMigration';
 import { createMigrateAccountLabels } from './entities/createMigrateAccountLabels';
 import { createMigrateAddressLabels } from './entities/createMigrateAddressLabels';
 import { createMigrateOutputLabels } from './entities/createMigrateOutputLabels';
@@ -21,7 +14,6 @@ import type {
     GetAccountsByDeviceState,
     GetCurrentAccountLabels,
     GetCurrentWalletLabel,
-    GetLegacyWalletLabels,
 } from './legacyLabelsMigration';
 import {
     type MigrateLegacyLabelsToSuiteSync,
@@ -37,26 +29,17 @@ export const selectMetadataMigrationDep = (services: any): MetadataMigrationDep
 });
 
 type CreateMetadataMigrationCompositionRootDeps = {
-    dispatch: Dispatch;
     getState: () => MetadataRootState;
     getAccountsByDeviceState: GetAccountsByDeviceState;
     getCurrentWalletLabel: GetCurrentWalletLabel;
     getCurrentAccountLabels: GetCurrentAccountLabels;
-    getDeviceByStaticSessionId: (
-        deviceStaticSessionId: Parameters<GetLegacyWalletLabels>[0],
-    ) => TrezorDevice | undefined;
-} & EnsureWalletSuiteSyncOnDep &
-    LabelingDep;
+} & LabelingDep;
 
-type MetadataMigrationCompositionRootResult = MetadataMigrationDep & EnsureWalletSuiteSyncOnDep;
+type MetadataMigrationCompositionRootResult = MetadataMigrationDep;
 
 export const createMetadataMigrationCompositionRoot = (
     deps: CreateMetadataMigrationCompositionRootDeps,
 ): MetadataMigrationCompositionRootResult => {
-    const getIsMetadataEnabled = toGetter(deps.getState, selectIsMetadataEnabled);
-    const getSelectedProviderForLabels = toGetter(deps.getState, selectSelectedProviderForLabels);
-    const getHasLegacyLabelsMigrated = toGetter(deps.getState, selectHasLegacyLabelsMigrated);
-
     const migrateLegacyLabelsToSuiteSync = createMigrateLegacyLabelsToSuiteSync({
         getAccountsByDeviceState: deps.getAccountsByDeviceState,
         getLegacyAccountLabels: toGetter(deps.getState, selectLabelingDataForAccount),
@@ -77,18 +60,7 @@ export const createMetadataMigrationCompositionRoot = (
         }),
     });
 
-    const ensureWalletSuiteSyncOn = createEnsureWalletSuiteSyncOnWithMigration({
-        dispatch: deps.dispatch,
-        ensureWalletSuiteSyncOn: deps.ensureWalletSuiteSyncOn,
-        migrateLegacyLabelsToSuiteSync,
-        getIsMetadataEnabled,
-        getSelectedProviderForLabels,
-        getHasLegacyLabelsMigrated,
-        getDeviceByStaticSessionId: deps.getDeviceByStaticSessionId,
-    });
-
     return {
-        ensureWalletSuiteSyncOn,
         migrateLegacyLabelsToSuiteSync,
     };
 };

suite/metadata-migration/src/index.ts

@@ -3,6 +3,7 @@ export {
     type MetadataMigrationDep,
     selectMetadataMigrationDep,
 } from './createMetadataMigrationCompositionRoot';
+export { createEnsureWalletSuiteSyncOnWithMigration } from './createEnsureWalletSuiteSyncOnWithMigration';
 export {
     LegacyLabelingMigration,
     type LegacyLabelingMigrationProps,

suite/suite-sync/src/createSuiteSyncDesktopCompositionRoot.ts

@@ -16,7 +16,10 @@ import {
     evoluCreateSuiteSyncOwner,
 } from '@suite-common/suite-sync-evolu';
 import { type FetchDep } from '@suite-common/suite-sync-quota-manager';
-import { type SuiteSync } from '@suite-common/suite-sync-types';
+import {
+    type CreateDecoratedEnsureWalletSuiteSyncOnDep,
+    type SuiteSync,
+} from '@suite-common/suite-sync-types';
 import { type TrezorConnect } from '@trezor/connect';
 
 import { createOnSharedWorkerUnsupported } from './createOnSharedWorkerUnsupported';
@@ -30,7 +33,8 @@ type SuiteSyncDesktopCompositionRootDeps = {
     EnsureDelegatedIdentityKeyDep &
     DesktopAnalyticsDep &
     FetchDep &
-    SuiteSyncAsyncErrorHandlerDep;
+    SuiteSyncAsyncErrorHandlerDep &
+    CreateDecoratedEnsureWalletSuiteSyncOnDep;
 
 export const createSuiteSyncDesktopCompositionRoot = (
     deps: SuiteSyncDesktopCompositionRootDeps,