Files
flipper/desktop/flipper-ui-core/src/deeplinkTracking.tsx
Michel Weststrate 7e50c0466a Move app/src (mostly) to flipper-ui-core/src
Summary:
This diff moves all UI code from app/src to app/flipper-ui-core. That is now slightly too much (e.g. node deps are not removed yet), but from here it should be easier to move things out again, as I don't want this diff to be open for too long to avoid too much merge conflicts.

* But at least flipper-ui-core is Electron free :)
* Killed all cross module imports as well, as they where now even more in the way
* Some unit test needed some changes, most not too big (but emotion hashes got renumbered in the snapshots, feel free to ignore that)
* Found some files that were actually meaningless (tsconfig in plugins, WatchTools files, that start generating compile errors, removed those

Follow up work:
* make flipper-ui-core configurable, and wire up flipper-server-core in Electron instead of here
* remove node deps (aigoncharov)
* figure out correct place to load GKs, plugins, make intern requests etc., and move to the correct module
* clean up deps

Reviewed By: aigoncharov

Differential Revision: D32427722

fbshipit-source-id: 14fe92e1ceb15b9dcf7bece367c8ab92df927a70
2021-11-16 05:29:21 -08:00

54 lines
1.7 KiB
TypeScript

/**
* 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 {Logger} from 'flipper-common';
export type OpenPluginParams = {
pluginId: string;
client: string | undefined;
devices: string[];
payload: string | undefined;
};
export type DeeplinkInteractionState =
| 'INIT' // Sent every time a user enters a deeplink flow
| 'ERROR' // Something went wrong (parsing, etc.) comes with more metadata attached
| 'PLUGIN_LIGHTHOUSE_BAIL' // User did not connect to VPN/Lighthouse when asked
| 'PLUGIN_STATUS_BAIL' // User did not install the plugin (has `extra` attribute with more information)
| 'PLUGIN_DEVICE_BAIL' // User did not launch a new device
| 'PLUGIN_CLIENT_BAIL' // User did not launch a supported app
| 'PLUGIN_DEVICE_SELECTION_BAIL' // User closed dialogue asking to select one of many devices
| 'PLUGIN_CLIENT_SELECTION_BAIL' // User closed dialogue asking to select one of many apps
| 'PLUGIN_DEVICE_UNSUPPORTED' // The device did not match the requirements specified in the deeplink URL
| 'PLUGIN_CLIENT_UNSUPPORTED' // The already opened app did not match the requirements specified in the deeplink URL
| 'PLUGIN_OPEN_SUCCESS'; // Everything is awesome
export type DeeplinkInteraction = {
state: DeeplinkInteractionState;
errorMessage?: string;
plugin?: OpenPluginParams;
extra?: object;
};
export function track(
logger: Logger,
query: string,
interaction: DeeplinkInteraction,
) {
logger.track(
'usage',
'deeplink',
{
...interaction,
query,
},
interaction.plugin?.pluginId,
);
}