/** * Copyright 2018-present Facebook. * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. * @format */ import {getInstance as getLogger} from '../fb-stubs/Logger'; import type {Store, MiddlewareAPI} from '../reducers.tsx'; import type {DeviceExport} from '../devices/BaseDevice'; import type {State as PluginStates} from '../reducers/pluginStates.tsx'; import type {PluginNotification} from '../reducers/notifications.tsx'; import type {ClientExport} from '../Client.tsx'; import type {State as PluginStatesState} from '../reducers/pluginStates.tsx'; import {pluginKey} from '../reducers/pluginStates.tsx'; import {FlipperDevicePlugin, FlipperPlugin, callClient} from '../plugin.js'; import {default as BaseDevice} from '../devices/BaseDevice'; import {default as ArchivedDevice} from '../devices/ArchivedDevice'; import {default as Client} from '../Client.tsx'; import fs from 'fs'; import uuid from 'uuid'; import {remote} from 'electron'; import {serialize, deserialize} from './serialization'; import {readCurrentRevision} from './packageMetadata.js'; import {tryCatchReportPlatformFailures} from './metrics'; import {promisify} from 'util'; import promiseTimeout from './promiseTimeout'; import {Idler} from './Idler'; export const IMPORT_FLIPPER_TRACE_EVENT = 'import-flipper-trace'; export const EXPORT_FLIPPER_TRACE_EVENT = 'export-flipper-trace'; export type ExportType = {| fileVersion: string, flipperReleaseRevision: ?string, clients: Array, device: ?DeviceExport, store: { pluginStates: PluginStates, activeNotifications: Array, }, |}; type ProcessPluginStatesOptions = {| clients: Array, serial: string, allPluginStates: PluginStatesState, devicePlugins: Map>>, selectedPlugins: Array, statusUpdate?: (msg: string) => void, |}; type ProcessNotificationStatesOptions = { clients: Array, serial: string, allActiveNotifications: Array, devicePlugins: Map>>, statusUpdate?: (msg: string) => void, }; type AddSaltToDeviceSerialOptions = { salt: string, device: BaseDevice, clients: Array, pluginStates: PluginStatesState, pluginNotification: Array, selectedPlugins: Array, statusUpdate?: (msg: string) => void, }; export function processClients( clients: Array, serial: string, statusUpdate?: (msg: string) => void, ): Array { statusUpdate && statusUpdate(`Filtering Clients for the device id ${serial}...`); const filteredClients = clients.filter( client => client.query.device_id === serial, ); return filteredClients; } export function pluginsClassMap( plugins: PluginStates, ): Map | FlipperPlugin<>>> { const pluginsMap: Map< string, Class | FlipperPlugin<>>, > = new Map([]); plugins.clientPlugins.forEach((val, key) => { pluginsMap.set(key, val); }); plugins.devicePlugins.forEach((val, key) => { pluginsMap.set(key, val); }); return pluginsMap; } export function processPluginStates( options: ProcessPluginStatesOptions, ): PluginStatesState { const { clients, serial, allPluginStates, devicePlugins, selectedPlugins, statusUpdate, } = options; let pluginStates = {}; statusUpdate && statusUpdate('Filtering the plugin states for the filtered Clients...'); for (const key in allPluginStates) { const keyArray = key.split('#'); const pluginName = keyArray.pop(); if (selectedPlugins.length > 0 && !selectedPlugins.includes(pluginName)) { continue; } const filteredClients = clients.filter(client => { // Remove the last entry related to plugin return client.id.includes(keyArray.join('#')); }); if ( filteredClients.length > 0 || (devicePlugins.has(pluginName) && serial === keyArray[0]) ) { // There need not be any client for device Plugins pluginStates = {...pluginStates, [key]: allPluginStates[key]}; } } return pluginStates; } export function processNotificationStates( options: ProcessNotificationStatesOptions, ): Array { const { clients, serial, allActiveNotifications, devicePlugins, statusUpdate, } = options; statusUpdate && statusUpdate('Filtering the notifications for the filtered Clients...'); const activeNotifications = allActiveNotifications.filter(notif => { const filteredClients = clients.filter(client => notif.client ? client.id.includes(notif.client) : false, ); return ( filteredClients.length > 0 || (devicePlugins.has(notif.pluginId) && serial === notif.client) ); // There need not be any client for device Plugins }); return activeNotifications; } const addSaltToDeviceSerial = async ( options: AddSaltToDeviceSerialOptions, ): Promise => { const { salt, device, clients, pluginStates, pluginNotification, statusUpdate, selectedPlugins, } = options; const {serial} = device; const newSerial = salt + '-' + serial; const newDevice = new ArchivedDevice( newSerial, device.deviceType, device.title, device.os, selectedPlugins.includes('DeviceLogs') ? device.getLogs() : [], ); statusUpdate && statusUpdate('Adding salt to the selected device id in the client data...'); const updatedClients = clients.map((client: ClientExport) => { return { ...client, id: client.id.replace(serial, newSerial), query: {...client.query, device_id: newSerial}, }; }); statusUpdate && statusUpdate( 'Adding salt to the selected device id in the plugin states...', ); const updatedPluginStates: PluginStatesState = {}; for (let key in pluginStates) { if (!key.includes(serial)) { throw new Error( `Error while exporting, plugin state (${key}) does not have ${serial} in its key`, ); } const pluginData = pluginStates[key]; key = key.replace(serial, newSerial); updatedPluginStates[key] = pluginData; } statusUpdate && statusUpdate( 'Adding salt to the selected device id in the notification data...', ); const updatedPluginNotifications = pluginNotification.map(notif => { if (!notif.client || !notif.client.includes(serial)) { throw new Error( `Error while exporting, plugin state (${ notif.pluginId }) does not have ${serial} in it`, ); } return {...notif, client: notif.client.replace(serial, newSerial)}; }); const revision: ?string = await readCurrentRevision(); return { fileVersion: remote.app.getVersion(), flipperReleaseRevision: revision, clients: updatedClients, device: newDevice.toJSON(), store: { pluginStates: updatedPluginStates, activeNotifications: updatedPluginNotifications, }, }; }; type ProcessStoreOptions = {| activeNotifications: Array, device: ?BaseDevice, pluginStates: PluginStatesState, clients: Array, devicePlugins: Map>>, salt: string, selectedPlugins: Array, statusUpdate?: (msg: string) => void, |}; export const processStore = async ( options: ProcessStoreOptions, ): Promise => { const { activeNotifications, device, pluginStates, clients, devicePlugins, salt, selectedPlugins, statusUpdate, } = options; if (device) { const {serial} = device; const processedClients = processClients(clients, serial, statusUpdate); const processedPluginStates = processPluginStates({ clients: processedClients, serial, allPluginStates: pluginStates, devicePlugins, selectedPlugins, statusUpdate, }); const processedActiveNotifications = processNotificationStates({ clients: processedClients, serial, allActiveNotifications: activeNotifications, devicePlugins, statusUpdate, }); // Adding salt to the device id, so that the device_id in the device list is unique. const exportFlipperData = await addSaltToDeviceSerial({ salt, device, clients: processedClients, pluginStates: processedPluginStates, pluginNotification: processedActiveNotifications, statusUpdate, selectedPlugins, }); return exportFlipperData; } return null; }; export async function fetchMetadata( pluginStates: PluginStatesState, pluginsMap: Map | FlipperPlugin<>>>, store: MiddlewareAPI, statusUpdate?: (msg: string) => void, ): Promise<{pluginStates: PluginStatesState, errorArray: Array}> { const newPluginState = {...pluginStates}; const errorArray: Array = []; const clients = store.getState().connections.clients; const selectedDevice = store.getState().connections.selectedDevice; for (const client of clients) { if ( !selectedDevice || selectedDevice.isArchived || !client.id.includes(selectedDevice.serial) ) { continue; } const selectedPlugins = store.getState().plugins.selectedPlugins; const selectedFilteredPlugins = selectedPlugins.length > 0 ? client.plugins.filter(plugin => selectedPlugins.includes(plugin)) : client.plugins; for (const plugin of selectedFilteredPlugins) { const pluginClass: ?Class< FlipperDevicePlugin<> | FlipperPlugin<>, > = plugin ? pluginsMap.get(plugin) : null; const exportState = pluginClass ? pluginClass.exportPersistedState : null; if (exportState) { const key = pluginKey(client.id, plugin); try { statusUpdate && statusUpdate(`Fetching metadata for plugin ${plugin}...`); const data = await promiseTimeout( 120000, // Timeout in 2 mins exportState(callClient(client, plugin), newPluginState[key], store), `Timed out while collecting data for ${plugin}`, ); newPluginState[key] = data; } catch (e) { errorArray.push(e); continue; } } } } return {pluginStates: newPluginState, errorArray}; } export async function getStoreExport( store: MiddlewareAPI, statusUpdate?: (msg: string) => void, ): Promise<{exportData: ?ExportType, errorArray: Array}> { const state = store.getState(); const {clients} = state.connections; const {pluginStates} = state; const {plugins} = state; const {selectedDevice} = store.getState().connections; if (!selectedDevice) { throw new Error('Please select a device before exporting data.'); } // TODO: T39612653 Make Client mockable. Currently rsocket logic is tightly coupled. // Not passing the entire state as currently Client is not mockable. const pluginsMap: Map< string, Class | FlipperPlugin<>>, > = new Map([]); plugins.clientPlugins.forEach((val, key) => { pluginsMap.set(key, val); }); plugins.devicePlugins.forEach((val, key) => { pluginsMap.set(key, val); }); statusUpdate && statusUpdate('Preparing to fetch metadata from client...'); const metadata = await fetchMetadata( pluginStates, pluginsMap, store, statusUpdate, ); const {errorArray} = metadata; const newPluginState = metadata.pluginStates; const {activeNotifications} = store.getState().notifications; const {devicePlugins} = store.getState().plugins; const exportData = await processStore({ activeNotifications, device: selectedDevice, pluginStates: newPluginState, clients: clients.map(client => client.toJSON()), devicePlugins, salt: uuid.v4(), selectedPlugins: store.getState().plugins.selectedPlugins, statusUpdate, }); return {exportData, errorArray}; } export function exportStore( store: MiddlewareAPI, idler?: Idler, statusUpdate?: (msg: string) => void, ): Promise<{serializedString: string, errorArray: Array}> { getLogger().track('usage', EXPORT_FLIPPER_TRACE_EVENT); return new Promise(async (resolve, reject) => { try { statusUpdate && statusUpdate('Preparing to export Flipper data...'); const {exportData, errorArray} = await getStoreExport( store, statusUpdate, ); if (!exportData) { console.error('Make sure a device is connected'); reject(new Error('No device is selected')); } try { statusUpdate && statusUpdate('Serializing Flipper data...'); const serializedString = await serialize( exportData, idler, statusUpdate, ); if (serializedString.length <= 0) { reject(new Error('Serialize function returned empty string')); } resolve({serializedString, errorArray}); } catch (e) { reject(e); } } catch (e) { reject(e); } }); } export const exportStoreToFile = ( exportFilePath: string, store: Store, idler?: Idler, statusUpdate?: (msg: string) => void, ): Promise<{errorArray: Array}> => { return exportStore(store, idler, statusUpdate).then( ({serializedString, errorArray}) => { return promisify(fs.writeFile)(exportFilePath, serializedString).then( () => { return {errorArray}; }, ); }, ); }; export function importDataToStore(data: string, store: Store) { getLogger().track('usage', IMPORT_FLIPPER_TRACE_EVENT); const json = deserialize(data); const {device, clients} = json; const {serial, deviceType, title, os, logs} = device; const archivedDevice = new ArchivedDevice( serial, deviceType, title, os, logs ? logs : [], ); const devices = store.getState().connections.devices; const matchedDevices = devices.filter( availableDevice => availableDevice.serial === serial, ); if (matchedDevices.length > 0) { store.dispatch({ type: 'SELECT_DEVICE', payload: matchedDevices[0], }); return; } store.dispatch({ type: 'REGISTER_DEVICE', payload: archivedDevice, }); store.dispatch({ type: 'SELECT_DEVICE', payload: archivedDevice, }); const {pluginStates} = json.store; const keys = Object.keys(pluginStates); keys.forEach(key => { store.dispatch({ type: 'SET_PLUGIN_STATE', payload: { pluginKey: key, state: pluginStates[key], }, }); }); clients.forEach(client => { const clientPlugins = keys .filter(key => { const arr = key.split('#'); arr.pop(); const clientPlugin = arr.join('#'); return client.id === clientPlugin; }) .map(client => client.split('#').pop()); store.dispatch({ type: 'NEW_CLIENT', payload: new Client( client.id, client.query, null, getLogger(), store, clientPlugins, ), }); }); } export const importFileToStore = (file: string, store: Store) => { fs.readFile(file, 'utf8', (err, data) => { if (err) { console.error(err); return; } importDataToStore(data, store); }); }; export function showOpenDialog(store: Store) { remote.dialog.showOpenDialog( { properties: ['openFile'], }, (files: Array) => { if (files !== undefined && files.length > 0) { tryCatchReportPlatformFailures(() => { importFileToStore(files[0], store); }, `${IMPORT_FLIPPER_TRACE_EVENT}:UI`); } }, ); }