flipper/desktop/flipper-ui-core/src/reducers/plugins.tsx

/**
 * Copyright (c) Meta Platforms, Inc. and 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 type {
  DevicePluginMap,
  ClientPluginMap,
  PluginDefinition,
} from '../plugin';
import type {
  DownloadablePluginDetails,
  ActivatablePluginDetails,
  BundledPluginDetails,
  InstalledPluginDetails,
} from 'flipper-common';
import type {Actions} from '.';
import produce from 'immer';
import {isDevicePluginDefinition} from '../utils/pluginUtils';
import semver from 'semver';

export interface MarketplacePluginDetails extends DownloadablePluginDetails {
  availableVersions?: DownloadablePluginDetails[];
}

export type State = StateV1;

type StateV1 = {
  devicePlugins: DevicePluginMap;
  clientPlugins: ClientPluginMap;
  loadedPlugins: Map<string, ActivatablePluginDetails>;
  bundledPlugins: Map<string, BundledPluginDetails>;
  gatekeepedPlugins: Array<ActivatablePluginDetails>;
  disabledPlugins: Array<ActivatablePluginDetails>;
  failedPlugins: Array<[ActivatablePluginDetails, string]>;
  selectedPlugins: Array<string>;
  marketplacePlugins: Array<MarketplacePluginDetails>;
  uninstalledPluginNames: Set<string>;
  installedPlugins: Map<string, InstalledPluginDetails>;
  initialized: boolean;
};

type StateV0 = Omit<StateV1, 'uninstalledPluginNames'> & {
  uninstalledPlugins: Set<string>;
};

export const persistVersion = 1;
export const persistMigrations = {
  1: (state: any) => {
    const stateV0 = state as StateV0;
    const stateV1: StateV1 = {
      ...stateV0,
      uninstalledPluginNames: new Set(stateV0.uninstalledPlugins),
    };
    return stateV1 as any;
  },
};

export type RegisterPluginAction = {
  type: 'REGISTER_PLUGINS';
  payload: PluginDefinition[];
};

export type Action =
  | RegisterPluginAction
  | {
      type: 'GATEKEEPED_PLUGINS';
      payload: Array<ActivatablePluginDetails>;
    }
  | {
      type: 'DISABLED_PLUGINS';
      payload: Array<ActivatablePluginDetails>;
    }
  | {
      type: 'FAILED_PLUGINS';
      payload: Array<[ActivatablePluginDetails, string]>;
    }
  | {
      type: 'SELECTED_PLUGINS';
      payload: Array<string>;
    }
  | {
      type: 'MARKETPLACE_PLUGINS';
      payload: Array<DownloadablePluginDetails>;
    }
  | {
      type: 'REGISTER_LOADED_PLUGINS';
      payload: Array<ActivatablePluginDetails>;
    }
  | {
      type: 'REGISTER_BUNDLED_PLUGINS';
      payload: Array<BundledPluginDetails>;
    }
  | {
      type: 'REGISTER_INSTALLED_PLUGINS';
      payload: InstalledPluginDetails[];
    }
  | {
      type: 'PLUGIN_INSTALLED';
      payload: InstalledPluginDetails;
    }
  | {
      type: 'PLUGIN_UNINSTALLED';
      payload: ActivatablePluginDetails;
    }
  | {
      type: 'PLUGIN_LOADED';
      payload: PluginDefinition;
    }
  | {
      type: 'PLUGINS_INITIALIZED';
    };

const INITIAL_STATE: State = {
  devicePlugins: new Map(),
  clientPlugins: new Map(),
  loadedPlugins: new Map(),
  bundledPlugins: new Map(),
  gatekeepedPlugins: [],
  disabledPlugins: [],
  failedPlugins: [],
  selectedPlugins: [],
  marketplacePlugins: [],
  uninstalledPluginNames: new Set(),
  installedPlugins: new Map(),
  initialized: false,
};

export default function reducer(
  state: State | undefined = INITIAL_STATE,
  action: Actions,
): State {
  if (action.type === 'REGISTER_PLUGINS') {
    return produce(state, (draft) => {
      const {devicePlugins, clientPlugins} = draft;
      action.payload.forEach((p) => {
        if (devicePlugins.has(p.id) || clientPlugins.has(p.id)) {
          return;
        }
        if (isDevicePluginDefinition(p)) {
          devicePlugins.set(p.id, p);
        } else {
          clientPlugins.set(p.id, p);
        }
      });
    });
  } else if (action.type === 'GATEKEEPED_PLUGINS') {
    return {
      ...state,
      gatekeepedPlugins: state.gatekeepedPlugins.concat(action.payload),
    };
  } else if (action.type === 'DISABLED_PLUGINS') {
    return {
      ...state,
      disabledPlugins: state.disabledPlugins.concat(action.payload),
    };
  } else if (action.type === 'FAILED_PLUGINS') {
    return {
      ...state,
      failedPlugins: state.failedPlugins.concat(action.payload),
    };
  } else if (action.type === 'SELECTED_PLUGINS') {
    return {
      ...state,
      selectedPlugins: action.payload,
    };
  } else if (action.type === 'MARKETPLACE_PLUGINS') {
    return {
      ...state,
      marketplacePlugins: action.payload,
    };
  } else if (action.type === 'REGISTER_LOADED_PLUGINS') {
    return {
      ...state,
      loadedPlugins: new Map(action.payload.map((p) => [p.id, p])),
    };
  } else if (action.type === 'REGISTER_BUNDLED_PLUGINS') {
    return {
      ...state,
      bundledPlugins: new Map(action.payload.map((p) => [p.id, p])),
    };
  } else if (action.type === 'REGISTER_INSTALLED_PLUGINS') {
    return produce(state, (draft) => {
      draft.installedPlugins.clear();
      action.payload.forEach((p) => {
        if (!draft.uninstalledPluginNames.has(p.name)) {
          draft.installedPlugins.set(p.id, p);
        }
      });
    });
  } else if (action.type === 'PLUGIN_INSTALLED') {
    const plugin = action.payload;
    return produce(state, (draft) => {
      const existing = draft.installedPlugins.get(plugin.name);
      if (!existing || semver.gt(plugin.version, existing.version)) {
        draft.installedPlugins.set(plugin.name, plugin);
      }
    });
  } else if (action.type === 'PLUGIN_UNINSTALLED') {
    const plugin = action.payload;
    return produce(state, (draft) => {
      draft.clientPlugins.delete(plugin.id);
      draft.devicePlugins.delete(plugin.id);
      draft.loadedPlugins.delete(plugin.id);
      draft.uninstalledPluginNames.add(plugin.name);
    });
  } else if (action.type === 'PLUGIN_LOADED') {
    const plugin = action.payload;
    return produce(state, (draft) => {
      if (isDevicePluginDefinition(plugin)) {
        draft.devicePlugins.set(plugin.id, plugin);
      } else {
        draft.clientPlugins.set(plugin.id, plugin);
      }
      draft.uninstalledPluginNames.delete(plugin.details.name);
      draft.loadedPlugins.set(plugin.id, plugin.details);
    });
  } else if (action.type === 'PLUGINS_INITIALIZED') {
    return produce(state, (draft) => {
      draft.initialized = true;
    });
  } else {
    return state;
  }
}

export const selectedPlugins = (payload: Array<string>): Action => ({
  type: 'SELECTED_PLUGINS',
  payload,
});

export const registerPlugins = (payload: PluginDefinition[]): Action => ({
  type: 'REGISTER_PLUGINS',
  payload,
});

export const addGatekeepedPlugins = (
  payload: Array<ActivatablePluginDetails>,
): Action => ({
  type: 'GATEKEEPED_PLUGINS',
  payload,
});

export const addDisabledPlugins = (
  payload: Array<ActivatablePluginDetails>,
): Action => ({
  type: 'DISABLED_PLUGINS',
  payload,
});

export const addFailedPlugins = (
  payload: Array<[ActivatablePluginDetails, string]>,
): Action => ({
  type: 'FAILED_PLUGINS',
  payload,
});

export const registerMarketplacePlugins = (
  payload: Array<DownloadablePluginDetails>,
): Action => ({
  type: 'MARKETPLACE_PLUGINS',
  payload,
});

export const registerLoadedPlugins = (
  payload: Array<ActivatablePluginDetails>,
): Action => ({
  type: 'REGISTER_LOADED_PLUGINS',
  payload,
});

export const registerBundledPlugins = (
  payload: Array<BundledPluginDetails>,
): Action => ({
  type: 'REGISTER_BUNDLED_PLUGINS',
  payload,
});

export const registerInstalledPlugins = (
  payload: InstalledPluginDetails[],
): Action => ({
  type: 'REGISTER_INSTALLED_PLUGINS',
  payload,
});

export const pluginInstalled = (payload: InstalledPluginDetails): Action => ({
  type: 'PLUGIN_INSTALLED',
  payload,
});

export const pluginUninstalled = (
  payload: ActivatablePluginDetails,
): Action => ({
  type: 'PLUGIN_UNINSTALLED',
  payload,
});

export const pluginLoaded = (payload: PluginDefinition): Action => ({
  type: 'PLUGIN_LOADED',
  payload,
});

export const pluginsInitialized = (): Action => ({
  type: 'PLUGINS_INITIALIZED',
});