Plugin Marketplace state refresh and cache

Summary:
Separate dispatcher for periodic refreshing available plugins data from the Marketplace backend and caching it locally.

The plugin auto update downloader subscribes to these state refreshes and automatically schedules plugin update downloads when required.

Reviewed By: passy

Differential Revision: D25360897

fbshipit-source-id: 5b6d95b63ff47b8ae9ad8b12e2480d1fed524ca5

desktop/app/src/__tests__/__snapshots__/createMockFlipperWithPlugin.node.tsx.snap

@@ -56,6 +56,7 @@ Object {
   "disabledPlugins": Array [],
   "failedPlugins": Array [],
   "gatekeepedPlugins": Array [],
+  "marketplacePlugins": Array [],
   "selectedPlugins": Array [],
 }
 `;

desktop/app/src/dispatcher/fb-stubs/pluginMarketplace.tsx

@@ -0,0 +1,12 @@
+/**
+ * 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
+ */
+
+export default () => {
+  // Marketplace is not implemented in public version of Flipper
+};

desktop/app/src/dispatcher/index.tsx

@@ -21,6 +21,7 @@ import user from './user';
 import pluginManager from './pluginManager';
 import reactNative from './reactNative';
 import pluginAutoUpdate from './fb-stubs/pluginAutoUpdate';
+import pluginMarketplace from './fb-stubs/pluginMarketplace';
 
 import {Logger} from '../fb-interfaces/Logger';
 import {Store} from '../reducers/index';
@@ -33,7 +34,6 @@ export default function (store: Store, logger: Logger): () => Promise<void> {
   if (process.env.NODE_ENV === 'development') {
     remote.globalShortcut.unregisterAll();
   }
-
   const dispatchers: Array<Dispatcher> = [
     application,
     store.getState().settingsState.enableAndroid ? androidDevice : null,
@@ -48,6 +48,7 @@ export default function (store: Store, logger: Logger): () => Promise<void> {
     pluginManager,
     reactNative,
     pluginAutoUpdate,
+    pluginMarketplace,
   ].filter(notNull);
   const globalCleanup = dispatchers
     .map((dispatcher) => dispatcher(store, logger))

desktop/app/src/reducers/__tests__/plugins.node.tsx

@@ -35,6 +35,7 @@ test('add clientPlugin', () => {
       failedPlugins: [],
       disabledPlugins: [],
       selectedPlugins: [],
+      marketplacePlugins: [],
     },
     registerPlugins([testPlugin]),
   );
@@ -50,6 +51,7 @@ test('add devicePlugin', () => {
       failedPlugins: [],
       disabledPlugins: [],
       selectedPlugins: [],
+      marketplacePlugins: [],
     },
     registerPlugins([testDevicePlugin]),
   );
@@ -65,6 +67,7 @@ test('do not add plugin twice', () => {
       failedPlugins: [],
       disabledPlugins: [],
       selectedPlugins: [],
+      marketplacePlugins: [],
     },
     registerPlugins([testPlugin, testPlugin]),
   );
@@ -95,6 +98,7 @@ test('add gatekeeped plugin', () => {
       failedPlugins: [],
       disabledPlugins: [],
       selectedPlugins: [],
+      marketplacePlugins: [],
     },
     addGatekeepedPlugins(gatekeepedPlugins),
   );

desktop/app/src/reducers/index.tsx

@@ -91,7 +91,7 @@ export type State = {
   pluginStates: PluginStatesState;
   pluginMessageQueue: PluginMessageQueueState;
   notifications: NotificationsState & PersistPartial;
-  plugins: PluginsState;
+  plugins: PluginsState & PersistPartial;
   user: UserState & PersistPartial;
   settingsState: SettingsState & PersistPartial;
   launcherSettingsState: LauncherSettingsState & PersistPartial;
@@ -141,7 +141,14 @@ export default combineReducers<State, Actions>({
     },
     notifications,
   ),
+  plugins: persistReducer<PluginsState, Actions>(
+    {
+      key: 'plugins',
+      storage,
+      whitelist: ['marketplacePlugins'],
+    },
     plugins,
+  ),
   supportForm,
   pluginManager,
   user: persistReducer(

desktop/app/src/reducers/plugins.tsx

@@ -8,7 +8,7 @@
  */
 
 import {DevicePluginMap, ClientPluginMap, PluginDefinition} from '../plugin';
-import {PluginDetails} from 'flipper-plugin-lib';
+import {PluginDetails, DownloadablePluginDetails} from 'flipper-plugin-lib';
 import {Actions} from '.';
 import produce from 'immer';
 import {isDevicePluginDefinition} from '../utils/pluginUtils';
@@ -20,6 +20,7 @@ export type State = {
   disabledPlugins: Array<PluginDetails>;
   failedPlugins: Array<[PluginDetails, string]>;
   selectedPlugins: Array<string>;
+  marketplacePlugins: Array<DownloadablePluginDetails>;
 };
 
 export type RegisterPluginAction = {
@@ -44,6 +45,10 @@ export type Action =
   | {
       type: 'SELECTED_PLUGINS';
       payload: Array<string>;
+    }
+  | {
+      type: 'MARKETPLACE_PLUGINS';
+      payload: Array<DownloadablePluginDetails>;
     };
 
 const INITIAL_STATE: State = {
@@ -53,6 +58,7 @@ const INITIAL_STATE: State = {
   disabledPlugins: [],
   failedPlugins: [],
   selectedPlugins: [],
+  marketplacePlugins: [],
 };
 
 export default function reducer(
@@ -94,6 +100,11 @@ export default function reducer(
       ...state,
       selectedPlugins: action.payload,
     };
+  } else if (action.type === 'MARKETPLACE_PLUGINS') {
+    return {
+      ...state,
+      marketplacePlugins: action.payload,
+    };
   } else {
     return state;
   }
@@ -127,3 +138,10 @@ export const addFailedPlugins = (
   type: 'FAILED_PLUGINS',
   payload,
 });
+
+export const registerMarketplacePlugins = (
+  payload: Array<DownloadablePluginDetails>,
+): Action => ({
+  type: 'MARKETPLACE_PLUGINS',
+  payload,
+});

desktop/app/src/utils/__tests__/exportData.node.tsx

@@ -766,6 +766,7 @@ test('test determinePluginsToProcess for mutilple clients having plugins present
     disabledPlugins: [],
     failedPlugins: [],
     selectedPlugins: ['TestPlugin'],
+    marketplacePlugins: [],
   };
   const op = determinePluginsToProcess(
     [client1, client2, client3],
@@ -831,6 +832,7 @@ test('test determinePluginsToProcess for no selected plugin present in any clien
     disabledPlugins: [],
     failedPlugins: [],
     selectedPlugins: ['RandomPlugin'],
+    marketplacePlugins: [],
   };
   const op = determinePluginsToProcess([client1, client2], device1, plugins);
   expect(op).toBeDefined();
@@ -874,6 +876,7 @@ test('test determinePluginsToProcess for multiple clients on same device', async
     disabledPlugins: [],
     failedPlugins: [],
     selectedPlugins: ['TestPlugin'],
+    marketplacePlugins: [],
   };
   const op = determinePluginsToProcess([client1, client2], device1, plugins);
   expect(op).toBeDefined();
@@ -955,6 +958,7 @@ test('test determinePluginsToProcess for multiple clients on different device',
     disabledPlugins: [],
     failedPlugins: [],
     selectedPlugins: ['TestPlugin'],
+    marketplacePlugins: [],
   };
   const op = determinePluginsToProcess(
     [client1Device1, client2Device1, client1Device2, client2Device2],
@@ -1033,6 +1037,7 @@ test('test determinePluginsToProcess to ignore archived clients', async () => {
     disabledPlugins: [],
     failedPlugins: [],
     selectedPlugins: ['TestPlugin'],
+    marketplacePlugins: [],
   };
   const op = determinePluginsToProcess(
     [client, archivedClient],

desktop/app/src/utils/loadDynamicPlugins.tsx

@@ -56,7 +56,11 @@ export default async function loadDynamicPlugins(): Promise<PluginDetails[]> {
   const compiledDynamicPlugins = (await compilations).filter(
     (c) => c !== null,
   ) as PluginDetails[];
-  console.log('✅  Loaded all plugins.');
+  console.log(
+    `✅  Loaded ${dynamicPlugins.length} dynamic plugins: ${dynamicPlugins
+      .map((x) => x.title)
+      .join(', ')}.`,
+  );
   return compiledDynamicPlugins;
 }
 async function loadPlugin(

desktop/scripts/start-dev-server.ts

@@ -104,8 +104,12 @@ if (argv['fast-refresh'] === true) {
 }
 
 // By default plugin auto-update is disabled in dev mode,
-// but it is possible to enable it using this command line argument.
+// but it is possible to enable it using this command line
-if (argv['plugin-auto-update'] === true) {
+// argument or env var.
+if (
+  argv['plugin-auto-update'] === true ||
+  process.env.FLIPPER_PLUGIN_AUTO_UPDATE
+) {
   delete process.env.FLIPPER_DISABLE_PLUGIN_AUTO_UPDATE;
 } else {
   process.env.FLIPPER_DISABLE_PLUGIN_AUTO_UPDATE = 'true';