bsky-social-app/src/state/persisted/legacy.ts

import AsyncStorage from '@react-native-async-storage/async-storage'

import {logger} from '#/logger'
import {defaults, Schema, schema} from '#/state/persisted/schema'
import {write, read} from '#/state/persisted/store'

/**
 * The shape of the serialized data from our legacy Mobx store.
 */
export type LegacySchema = {
  shell: {
    colorMode: 'system' | 'light' | 'dark'
  }
  session: {
    data: {
      service: string
      did: `did:plc:${string}`
    } | null
    accounts: {
      service: string
      did: `did:plc:${string}`
      refreshJwt: string
      accessJwt: string
      handle: string
      email: string
      displayName: string
      aviUrl: string
      emailConfirmed: boolean
    }[]
  }
  me: {
    did: `did:plc:${string}`
    handle: string
    displayName: string
    description: string
    avatar: string
  }
  onboarding: {
    step: string
  }
  preferences: {
    primaryLanguage: string
    contentLanguages: string[]
    postLanguage: string
    postLanguageHistory: string[]
    contentLabels: {
      nsfw: string
      nudity: string
      suggestive: string
      gore: string
      hate: string
      spam: string
      impersonation: string
    }
    savedFeeds: string[]
    pinnedFeeds: string[]
    requireAltTextEnabled: boolean
  }
  invitedUsers: {
    seenDids: string[]
    copiedInvites: string[]
  }
  mutedThreads: {uris: string[]}
  reminders: {lastEmailConfirm?: string}
}

const DEPRECATED_ROOT_STATE_STORAGE_KEY = 'root'

export function transform(legacy: Partial<LegacySchema>): Schema {
  return {
    colorMode: legacy.shell?.colorMode || defaults.colorMode,
    session: {
      accounts: legacy.session?.accounts || defaults.session.accounts,
      currentAccount:
        legacy.session?.accounts?.find(
          a => a.did === legacy.session?.data?.did,
        ) || defaults.session.currentAccount,
    },
    reminders: {
      lastEmailConfirm:
        legacy.reminders?.lastEmailConfirm ||
        defaults.reminders.lastEmailConfirm,
    },
    languagePrefs: {
      primaryLanguage:
        legacy.preferences?.primaryLanguage ||
        defaults.languagePrefs.primaryLanguage,
      contentLanguages:
        legacy.preferences?.contentLanguages ||
        defaults.languagePrefs.contentLanguages,
      postLanguage:
        legacy.preferences?.postLanguage || defaults.languagePrefs.postLanguage,
      postLanguageHistory:
        legacy.preferences?.postLanguageHistory ||
        defaults.languagePrefs.postLanguageHistory,
      appLanguage:
        legacy.preferences?.primaryLanguage ||
        defaults.languagePrefs.appLanguage,
    },
    requireAltTextEnabled:
      legacy.preferences?.requireAltTextEnabled ||
      defaults.requireAltTextEnabled,
    mutedThreads: legacy.mutedThreads?.uris || defaults.mutedThreads,
    invites: {
      copiedInvites:
        legacy.invitedUsers?.copiedInvites || defaults.invites.copiedInvites,
    },
    onboarding: {
      step: legacy.onboarding?.step || defaults.onboarding.step,
    },
    hiddenPosts: defaults.hiddenPosts,
    externalEmbeds: defaults.externalEmbeds,
  }
}

/**
 * Migrates legacy persisted state to new store if new store doesn't exist in
 * local storage AND old storage exists.
 */
export async function migrate() {
  logger.info('persisted state: check need to migrate')

  try {
    const rawLegacyData = await AsyncStorage.getItem(
      DEPRECATED_ROOT_STATE_STORAGE_KEY,
    )
    const newData = await read()
    const alreadyMigrated = Boolean(newData)

    /* TODO BEGIN DEBUG — remove this eventually */
    try {
      if (rawLegacyData) {
        const legacy = JSON.parse(rawLegacyData) as Partial<LegacySchema>
        logger.info(`persisted state: debug legacy data`, {
          hasExistingLoggedInAccount: Boolean(legacy?.session?.data),
          numberOfExistingAccounts: legacy?.session?.accounts?.length,
          foundExistingCurrentAccount: Boolean(
            legacy.session?.accounts?.find(
              a => a.did === legacy.session?.data?.did,
            ),
          ),
        })
        logger.info(`persisted state: debug new data`, {
          hasNewData: Boolean(newData),
          hasExistingLoggedInAccount: Boolean(newData?.session?.currentAccount),
          numberOfExistingAccounts: newData?.session?.accounts?.length,
          existingAccountMatchesLegacy: Boolean(
            newData?.session?.currentAccount?.did ===
              legacy?.session?.data?.did,
          ),
        })
      }
    } catch (e: any) {
      logger.error(e, {message: `persisted state: legacy debugging failed`})
    }
    /* TODO END DEBUG */

    if (!alreadyMigrated && rawLegacyData) {
      logger.info('persisted state: migrating legacy storage')

      const legacyData = JSON.parse(rawLegacyData)
      const newData = transform(legacyData)
      const validate = schema.safeParse(newData)

      if (validate.success) {
        await write(newData)
        logger.log('persisted state: migrated legacy storage')
      } else {
        logger.error('persisted state: legacy data failed validation', {
          error: validate.error,
        })
      }
    } else {
      logger.log('persisted state: no migration needed')
    }
  } catch (e: any) {
    logger.error(e, {
      message: 'persisted state: error migrating legacy storage',
    })
  }
}

export async function clearLegacyStorage() {
  try {
    await AsyncStorage.removeItem(DEPRECATED_ROOT_STATE_STORAGE_KEY)
  } catch (e: any) {
    logger.error(`persisted legacy store: failed to clear`, {
      error: e.toString(),
    })
  }
}