Support handling deeplinks in plugins

Summary:
This adds support for handling incoming deeplinks in a Sandy plugin, which can be done by using a `client.onDeepLink(deepLink => { } )` listener

Also generalized deeplinks to not just support strings, but also richer objects, which is beneficial to plugin to plugin linking.

Reviewed By: jknoxville

Differential Revision: D22524749

fbshipit-source-id: 2cbe8d52f6eac91a1c1c8c8494706952920b9181

desktop/flipper-plugin/src/__tests__/test-utils.node.tsx

@@ -10,6 +10,7 @@
 import * as TestUtils from '../test-utils/test-utils';
 import * as testPlugin from './TestPlugin';
 import {createState} from '../state/atom';
+import {FlipperClient} from '../plugin/Plugin';
 
 test('it can start a plugin and lifecycle events', () => {
   const {instance, ...p} = TestUtils.startPlugin(testPlugin);
@@ -193,3 +194,24 @@ test('plugins cannot use a persist key twice', async () => {
     `"Some other state is already persisting with key \\"test\\""`,
   );
 });
+
+test('plugins can receive deeplinks', async () => {
+  const plugin = TestUtils.startPlugin({
+    plugin(client: FlipperClient) {
+      client.onDeepLink((deepLink) => {
+        if (typeof deepLink === 'string') {
+          field1.set(deepLink);
+        }
+      });
+      const field1 = createState('', {persist: 'test'});
+      return {field1};
+    },
+    Component() {
+      return null;
+    },
+  });
+
+  expect(plugin.instance.field1.get()).toBe('');
+  plugin.triggerDeepLink('test');
+  expect(plugin.instance.field1.get()).toBe('test');
+});

desktop/flipper-plugin/src/plugin/Plugin.tsx

@@ -46,6 +46,11 @@ export interface FlipperClient<
    */
   onDisconnect(cb: () => void): void;
 
+  /**
+   * Triggered when this plugin is opened through a deeplink
+   */
+  onDeepLink(cb: (deepLink: unknown) => void): void;
+
   /**
    * Send a message to the connected client
    */
@@ -113,6 +118,8 @@ export class SandyPluginInstance {
   initialStates?: Record<string, any>;
   // all the atoms that should be serialized when making an export / import
   rootStates: Record<string, Atom<any>> = {};
+  // last seen deeplink
+  lastDeeplink?: any;
 
   constructor(
     realClient: RealFlipperClient,
@@ -143,6 +150,9 @@ export class SandyPluginInstance {
       onMessage: (event, callback) => {
         this.events.on('event-' + event, callback);
       },
+      onDeepLink: (callback) => {
+        this.events.on('deeplink', callback);
+      },
     };
     currentPluginInstance = this;
     this.initialStates = initialStates;
@@ -165,6 +175,7 @@ export class SandyPluginInstance {
 
   // the plugin is deselected in the UI
   deactivate() {
+    this.lastDeeplink = undefined;
     if (this.destroyed) {
       // this can happen if the plugin is disabled while active in the UI.
       // In that case deinit & destroy is already triggered from the STAR_PLUGIN action
@@ -211,6 +222,14 @@ export class SandyPluginInstance {
     return '[SandyPluginInstance]';
   }
 
+  triggerDeepLink(deepLink: unknown) {
+    this.assertNotDestroyed();
+    if (deepLink !== this.lastDeeplink) {
+      this.lastDeeplink = deepLink;
+      this.events.emit('deeplink', deepLink);
+    }
+  }
+
   exportState() {
     return Object.fromEntries(
       Object.entries(this.rootStates).map(([key, atom]) => [key, atom.get()]),

desktop/flipper-plugin/src/test-utils/test-utils.tsx

@@ -100,6 +100,8 @@ interface StartPluginResult<Module extends FlipperPluginModule<any>> {
     }[],
   ): void;
 
+  triggerDeepLink(deeplink: unknown): void;
+
   exportState(): any;
 }
 
@@ -164,6 +166,9 @@ export function startPlugin<Module extends FlipperPluginModule<any>>(
       });
     },
     exportState: () => pluginInstance.exportState(),
+    triggerDeepLink: (deepLink: unknown) => {
+      pluginInstance.triggerDeepLink(deepLink);
+    },
   };
   // @ts-ignore
   res._backingInstance = pluginInstance;