flipper/desktop/app/src/reducers/index.tsx

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @format
 */

import {combineReducers, Dispatch} from 'redux';
import application, {
  State as ApplicationState,
  Action as ApplicationAction,
} from './application';
import connections, {
  State as DevicesState,
  Action as DevicesAction,
  persistMigrations as devicesPersistMigrations,
  persistVersion as devicesPersistVersion,
} from './connections';
import pluginStates, {
  State as PluginStatesState,
  Action as PluginStatesAction,
} from './pluginStates';
import pluginMessageQueue, {
  State as PluginMessageQueueState,
  Action as PluginMessageQueueAction,
} from './pluginMessageQueue';
import notifications, {
  State as NotificationsState,
  Action as NotificationsAction,
} from './notifications';
import plugins, {
  State as PluginsState,
  Action as PluginsAction,
  persistMigrations as pluginsPersistMigrations,
  persistVersion as pluginsPersistVersion,
} from './plugins';
import supportForm, {
  State as SupportFormState,
  Action as SupportFormAction,
} from './supportForm';
import settings, {
  Settings as SettingsState,
  Action as SettingsAction,
} from './settings';
import launcherSettings, {
  LauncherSettings as LauncherSettingsState,
  Action as LauncherSettingsAction,
} from './launcherSettings';
import pluginManager, {
  State as PluginManagerState,
  Action as PluginManagerAction,
} from './pluginManager';
import healthchecks, {
  Action as HealthcheckAction,
  State as HealthcheckState,
} from './healthchecks';
import pluginDownloads, {
  State as PluginDownloadsState,
  Action as PluginDownloadsAction,
} from './pluginDownloads';
import usageTracking, {
  Action as TrackingAction,
  State as TrackingState,
} from './usageTracking';
import pluginLists, {
  State as PluginListsState,
  Action as PluginListsAction,
} from './pluginLists';
import user, {State as UserState, Action as UserAction} from './user';
import JsonFileStorage from '../utils/jsonFileReduxPersistStorage';
import LauncherSettingsStorage from '../utils/launcherSettingsStorage';
import {launcherConfigDir} from '../utils/launcher';
import os from 'os';
import {resolve} from 'path';
import xdg from 'xdg-basedir';
import {createMigrate, createTransform, persistReducer} from 'redux-persist';
import {PersistPartial} from 'redux-persist/es/persistReducer';

import {Store as ReduxStore, MiddlewareAPI as ReduxMiddlewareAPI} from 'redux';
import storage from 'redux-persist/lib/storage';
import {TransformConfig} from 'redux-persist/es/createTransform';

export type Actions =
  | ApplicationAction
  | DevicesAction
  | PluginStatesAction
  | PluginMessageQueueAction
  | NotificationsAction
  | PluginsAction
  | UserAction
  | SettingsAction
  | LauncherSettingsAction
  | SupportFormAction
  | PluginManagerAction
  | HealthcheckAction
  | TrackingAction
  | PluginDownloadsAction
  | PluginListsAction
  | {type: 'INIT'};

export type State = {
  application: ApplicationState;
  connections: DevicesState & PersistPartial;
  pluginStates: PluginStatesState;
  pluginMessageQueue: PluginMessageQueueState;
  notifications: NotificationsState & PersistPartial;
  plugins: PluginsState & PersistPartial;
  user: UserState & PersistPartial;
  settingsState: SettingsState & PersistPartial;
  launcherSettingsState: LauncherSettingsState & PersistPartial;
  supportForm: SupportFormState;
  pluginManager: PluginManagerState;
  healthchecks: HealthcheckState & PersistPartial;
  usageTracking: TrackingState;
  pluginDownloads: PluginDownloadsState;
  pluginLists: PluginListsState;
};

export type Store = ReduxStore<State, Actions>;
export type MiddlewareAPI = ReduxMiddlewareAPI<Dispatch<Actions>, State>;

const settingsStorage = new JsonFileStorage(
  resolve(
    ...(xdg.config ? [xdg.config] : [os.homedir(), '.config']),
    'flipper',
    'settings.json',
  ),
);

const setTransformer = (config: TransformConfig) =>
  createTransform(
    (set: Set<string>) => Array.from(set),
    (arrayString: string[]) => new Set(arrayString),
    config,
  );

const launcherSettingsStorage = new LauncherSettingsStorage(
  resolve(launcherConfigDir(), 'flipper-launcher.toml'),
);

export default combineReducers<State, Actions>({
  application,
  connections: persistReducer<DevicesState, Actions>(
    {
      key: 'connections',
      storage,
      whitelist: [
        'userPreferredDevice',
        'userPreferredPlugin',
        'userPreferredApp',
        'enabledPlugins',
        'enabledDevicePlugins',
      ],
      transforms: [
        setTransformer({
          whitelist: ['enabledDevicePlugins', 'userStarredDevicePlugins'],
        }),
      ],
      version: devicesPersistVersion,
      migrate: createMigrate(devicesPersistMigrations),
    },
    connections,
  ),
  pluginStates,
  pluginMessageQueue: pluginMessageQueue as any,
  notifications: persistReducer(
    {
      key: 'notifications',
      storage,
      whitelist: ['blacklistedPlugins', 'blacklistedCategories'],
    },
    notifications,
  ),
  plugins: persistReducer<PluginsState, Actions>(
    {
      key: 'plugins',
      storage,
      whitelist: ['marketplacePlugins', 'uninstalledPluginNames'],
      transforms: [setTransformer({whitelist: ['uninstalledPluginNames']})],
      version: pluginsPersistVersion,
      migrate: createMigrate(pluginsPersistMigrations),
    },
    plugins,
  ),
  supportForm,
  pluginManager,
  user: persistReducer(
    {
      key: 'user',
      storage,
    },
    user,
  ),
  settingsState: persistReducer(
    {key: 'settings', storage: settingsStorage},
    settings,
  ),
  launcherSettingsState: persistReducer(
    {
      key: 'launcherSettings',
      storage: launcherSettingsStorage,
      serialize: false,
      // @ts-ignore: property is erroneously missing in redux-persist type definitions
      deserialize: false,
    },
    launcherSettings,
  ),
  healthchecks: persistReducer<HealthcheckState, Actions>(
    {
      key: 'healthchecks',
      storage,
      whitelist: ['acknowledgedProblems'],
    },
    healthchecks,
  ),
  usageTracking,
  pluginDownloads,
  pluginLists,
});