log listener

Summary:
The logs plugin opened a new log connection every time it was activated and never closed the connection.

This is now changed. Once a device is connected, a log connection is opened. The logs plugin subscribes and unsubscribes to this connection. This allows the logs plugin it even access the logs from when it was not activated and ensures to only open on connection to read the logs. Logs are persisted when switching away from the plugin.

Also removes the spinner from the logs plugin, as it loads much faster now.

Reviewed By: jknoxville

Differential Revision: D9613054

fbshipit-source-id: e37ea56c563450e7fc4e3c85a015292be1f2dbfc

src/PluginContainer.js

@@ -8,6 +8,7 @@ import type {SonarPlugin, SonarBasePlugin} from './plugin.js';
 import type LogManager from './fb-stubs/Logger';
 import type Client from './Client.js';
 import type BaseDevice from './devices/BaseDevice.js';
+import type {Props as PluginProps} from './plugin';
 
 import {SonarDevicePlugin} from './plugin.js';
 import {
@@ -43,7 +44,9 @@ type Props = {
   selectedDevice: BaseDevice,
   selectedPlugin: ?string,
   selectedApp: ?string,
-  pluginStates: Object,
+  pluginStates: {
+    [pluginKey: string]: Object,
+  },
   clients: Array<Client>,
   setPluginState: (payload: {
     pluginKey: string,
@@ -128,6 +131,15 @@ class PluginContainer extends Component<Props, State> {
       return null;
     }
 
+    const props: PluginProps<Object> = {
+      key: pluginKey,
+      logger: this.props.logger,
+      persistedState: pluginStates[pluginKey] || {},
+      setPersistedState: state => setPluginState({pluginKey, state}),
+      target,
+      ref: this.refChanged,
+    };
+
     return (
       <React.Fragment>
         <Container key="plugin">
@@ -136,14 +148,7 @@ class PluginContainer extends Component<Props, State> {
               activePlugin.title
             }" encountered an error during render`}
             logger={this.props.logger}>
-            {React.createElement(activePlugin, {
-              key: pluginKey,
-              logger: this.props.logger,
-              persistedState: pluginStates[pluginKey] || {},
-              setPersistedState: state => setPluginState({pluginKey, state}),
-              target,
-              ref: this.refChanged,
-            })}
+            {React.createElement(activePlugin, props)}
           </ErrorBoundary>
         </Container>
         <SidebarContainer id="sonarSidebar" />

src/device-plugins/logs/index.js

@@ -13,14 +13,13 @@ import type {
 } from 'sonar';
 import type {Counter} from './LogWatcher.js';
 import type {DeviceLogEntry} from '../../devices/BaseDevice.js';
+import type {Props as PluginProps} from '../../plugin';
 
 import {
   Text,
   ManagedTable,
   Button,
   colors,
-  FlexCenter,
-  LoadingIndicator,
   ContextMenu,
   FlexColumn,
   Glyph,
@@ -39,8 +38,7 @@ type Entries = Array<{
   entry: DeviceLogEntry,
 }>;
 
-type LogsState = {|
-  initialising: boolean,
+type State = {|
   rows: Array<TableBodyRow>,
   entries: Entries,
   key2entry: {[key: string]: DeviceLogEntry},
@@ -48,6 +46,10 @@ type LogsState = {|
   counters: Array<Counter>,
 |};
 
+type Actions = {||};
+
+type PersistedState = {||};
+
 const Icon = styled(Glyph)({
   marginTop: 5,
 });
@@ -234,7 +236,11 @@ function pad(chunk: mixed, len: number): string {
   return str;
 }
 
-export default class LogTable extends SonarDevicePlugin<LogsState> {
+export default class LogTable extends SonarDevicePlugin<
+  State,
+  Actions,
+  PersistedState,
+> {
   static id = 'DeviceLogs';
   static title = 'Logs';
   static icon = 'arrow-right';
@@ -267,7 +273,6 @@ export default class LogTable extends SonarDevicePlugin<LogsState> {
     rows: [],
     entries: [],
     key2entry: {},
-    initialising: true,
     highlightedRows: [],
     counters: this.restoreSavedCounters(),
   };
@@ -276,20 +281,24 @@ export default class LogTable extends SonarDevicePlugin<LogsState> {
   columns: TableColumns;
   columnSizes: TableColumnSizes;
   columnOrder: TableColumnOrder;
+  logListener: ?Symbol;
 
-  init() {
-    let batch: Entries = [];
-    let queued = false;
-    let counter = 0;
+  batch: Entries = [];
+  queued: boolean = false;
+  counter: number = 0;
 
+  constructor(props: PluginProps<PersistedState>) {
+    super(props);
     const supportedColumns = this.device.supportedColumns();
     this.columns = keepKeys(COLUMNS, supportedColumns);
     this.columnSizes = keepKeys(COLUMN_SIZE, supportedColumns);
     this.columnOrder = INITIAL_COLUMN_ORDER.filter(obj =>
       supportedColumns.includes(obj.key),
     );
+    this.logListener = this.device.addLogListener(this.processEntry);
+  }
 
-    this.device.addLogListener((entry: DeviceLogEntry) => {
+  processEntry = (entry: DeviceLogEntry) => {
     const {icon, style} = LOG_TYPES[(entry.type: string)] || LOG_TYPES.debug;
 
     // clean message
@@ -338,9 +347,7 @@ export default class LogTable extends SonarDevicePlugin<LogsState> {
             value: <HiddenScrollText code={true}>{message}</HiddenScrollText>,
           },
           tag: {
-              value: (
-                <HiddenScrollText code={true}>{entry.tag}</HiddenScrollText>
-              ),
+            value: <HiddenScrollText code={true}>{entry.tag}</HiddenScrollText>,
             isFilterable: true,
           },
           pid: {
@@ -360,9 +367,7 @@ export default class LogTable extends SonarDevicePlugin<LogsState> {
             isFilterable: true,
           },
           app: {
-              value: (
-                <HiddenScrollText code={true}>{entry.app}</HiddenScrollText>
-              ),
+            value: <HiddenScrollText code={true}>{entry.app}</HiddenScrollText>,
             isFilterable: true,
           },
         },
@@ -370,22 +375,22 @@ export default class LogTable extends SonarDevicePlugin<LogsState> {
         style,
         type: entry.type,
         filterValue: entry.message,
-          key: String(counter++),
+        key: String(this.counter++),
       },
     };
 
     // batch up logs to be processed every 250ms, if we have lots of log
     // messages coming in, then calling an setState 200+ times is actually
     // pretty expensive
-      batch.push(item);
+    this.batch.push(item);
 
-      if (!queued) {
-        queued = true;
+    if (!this.queued) {
+      this.queued = true;
 
       this.batchTimer = setTimeout(() => {
-          const thisBatch = batch;
-          batch = [];
-          queued = false;
+        const thisBatch = this.batch;
+        this.batch = [];
+        this.queued = false;
 
         // update rows/entries
         this.setState(state => {
@@ -417,22 +422,16 @@ export default class LogTable extends SonarDevicePlugin<LogsState> {
         });
       }, 100);
     }
-    });
-
-    this.initTimer = setTimeout(() => {
-      this.setState({
-        initialising: false,
-      });
-    }, 2000);
-  }
+  };
 
   componentWillUnmount() {
-    if (this.initTimer) {
-      clearTimeout(this.initTimer);
-    }
     if (this.batchTimer) {
       clearTimeout(this.batchTimer);
     }
+
+    if (this.logListener) {
+      this.device.removeLogListener(this.logListener);
+    }
   }
 
   addRowIfNeeded(
@@ -536,7 +535,7 @@ export default class LogTable extends SonarDevicePlugin<LogsState> {
   });
 
   render() {
-    const {initialising, rows} = this.state;
+    const {rows} = this.state;
 
     const contextMenuItems = [
       {
@@ -547,11 +546,7 @@ export default class LogTable extends SonarDevicePlugin<LogsState> {
         click: this.clearLogs,
       },
     ];
-    return initialising ? (
-      <FlexCenter fill={true}>
-        <LoadingIndicator />
-      </FlexCenter>
-    ) : (
+    return (
       <LogTable.ContextMenu items={contextMenuItems} component={FlexColumn}>
         <SearchableTable
           innerRef={this.setTableRef}

src/devices/AndroidDevice.js

@@ -5,7 +5,7 @@
  * @format
  */
 
-import type {DeviceType, DeviceShell, DeviceLogListener} from './BaseDevice.js';
+import type {DeviceType, DeviceShell} from './BaseDevice.js';
 
 import {Priority} from 'adbkit-logcat-fb';
 import child_process from 'child_process';
@@ -25,27 +25,10 @@ export default class AndroidDevice extends BaseDevice {
     if (deviceType == 'physical') {
       this.supportedPlugins.push('DeviceCPU');
     }
-  }
 
-  supportedPlugins = [
-    'DeviceLogs',
-    'DeviceShell',
-    'DeviceFiles',
-    'DeviceScreen',
-  ];
-  icon = 'icons/android.svg';
-  os = 'Android';
-  adb: ADBClient;
-  pidAppMapping: {[key: number]: string} = {};
-  logReader: any;
-
-  supportedColumns(): Array<string> {
-    return ['date', 'pid', 'tid', 'tag', 'message', 'type', 'time'];
-  }
-
-  addLogListener(callback: DeviceLogListener) {
     this.adb.openLogcat(this.serial).then(reader => {
-      reader.on('entry', async entry => {
+      reader.on('entry', entry => {
+        if (this.logListeners.size > 0) {
           let type = 'unknown';
           if (entry.priority === Priority.VERBOSE) {
             type = 'verbose';
@@ -66,7 +49,7 @@ export default class AndroidDevice extends BaseDevice {
             type = 'fatal';
           }
 
-        callback({
+          this.notifyLogListeners({
             tag: entry.tag,
             pid: entry.pid,
             tid: entry.tid,
@@ -74,10 +57,27 @@ export default class AndroidDevice extends BaseDevice {
             date: entry.date,
             type,
           });
+        }
       });
     });
   }
 
+  supportedPlugins = [
+    'DeviceLogs',
+    'DeviceShell',
+    'DeviceFiles',
+    'DeviceScreen',
+  ];
+  icon = 'icons/android.svg';
+  os = 'Android';
+  adb: ADBClient;
+  pidAppMapping: {[key: number]: string} = {};
+  logReader: any;
+
+  supportedColumns(): Array<string> {
+    return ['date', 'pid', 'tid', 'tag', 'message', 'type', 'time'];
+  }
+
   reverse(): Promise<void> {
     if (this.deviceType === 'physical') {
       return this.adb

src/devices/BaseDevice.js

@@ -62,6 +62,9 @@ export default class BaseDevice {
   // possible src of icon to display next to the device title
   icon: ?string;
 
+  logListeners: Map<Symbol, DeviceLogListener> = new Map();
+  logEntries: Array<DeviceLogEntry> = [];
+
   supportsOS(os: string) {
     return os.toLowerCase() === this.os.toLowerCase();
   }
@@ -80,8 +83,22 @@ export default class BaseDevice {
     throw new Error('unimplemented');
   }
 
-  addLogListener(listener: DeviceLogListener) {
-    throw new Error('unimplemented');
+  addLogListener(callback: DeviceLogListener): Symbol {
+    const id = Symbol();
+    this.logListeners.set(id, callback);
+    this.logEntries.map(callback);
+    return id;
+  }
+
+  notifyLogListeners(entry: DeviceLogEntry) {
+    this.logEntries.push(entry);
+    if (this.logListeners.size > 0) {
+      this.logListeners.forEach(listener => listener(entry));
+    }
+  }
+
+  removeLogListener(id: Symbol) {
+    this.logListeners.delete(id);
   }
 
   spawnShell(): DeviceShell {

src/devices/IOSDevice.js

@@ -5,12 +5,7 @@
  * @format
  */
 
-import type {
-  DeviceType,
-  LogLevel,
-  DeviceLogEntry,
-  DeviceLogListener,
-} from './BaseDevice.js';
+import type {DeviceType, LogLevel, DeviceLogEntry} from './BaseDevice.js';
 import child_process from 'child_process';
 import BaseDevice from './BaseDevice.js';
 import JSONStream from 'JSONStream';
@@ -47,7 +42,7 @@ export default class IOSDevice extends BaseDevice {
     super(serial, deviceType, title);
 
     this.buffer = '';
-    this.log = null;
+    this.log = this.startLogListener();
   }
 
   teardown() {
@@ -60,7 +55,7 @@ export default class IOSDevice extends BaseDevice {
     return ['date', 'pid', 'tid', 'tag', 'message', 'type', 'time'];
   }
 
-  addLogListener(callback: DeviceLogListener, retries: number = 3) {
+  startLogListener(retries: number = 3) {
     if (retries === 0) {
       console.error('Attaching iOS log listener continuously failed.');
       return;
@@ -102,14 +97,15 @@ export default class IOSDevice extends BaseDevice {
         .pipe(new StripLogPrefix())
         .pipe(JSONStream.parse('*'))
         .on('data', (data: RawLogEntry) => {
-          callback(IOSDevice.parseLogEntry(data));
+          const entry = IOSDevice.parseLogEntry(data);
+          this.notifyLogListeners(entry);
         });
     } catch (e) {
       console.error('Could not parse iOS log stream.', e);
       // restart log stream
       this.log.kill();
       this.log = null;
-      this.addLogListener(callback, retries - 1);
+      this.startLogListener(retries - 1);
     }
   }
 

src/devices/OculusDevice.js

@@ -5,11 +5,7 @@
  * @format
  */
 
-import type {
-  DeviceType,
-  DeviceLogEntry,
-  DeviceLogListener,
-} from './BaseDevice.js';
+import type {DeviceType, DeviceLogEntry} from './BaseDevice.js';
 
 import fs from 'fs-extra';
 import os from 'os';
@@ -40,6 +36,8 @@ export default class OculusDevice extends BaseDevice {
 
     this.watcher = null;
     this.processedFileMap = {};
+
+    this.setupListener();
   }
 
   teardown() {
@@ -69,63 +67,63 @@ export default class OculusDevice extends BaseDevice {
     }
   }
 
-  processText(text: Buffer, callback: DeviceLogListener) {
+  processText(text: Buffer) {
     text
       .toString()
       .split('\r\n')
       .forEach(line => {
         const regex = /(.*){(\S+)}\s*\[([\w :.\\]+)\](.*)/;
         const match = regex.exec(line);
+        let entry;
         if (match && match.length === 5) {
-          callback({
+          entry = {
             tid: 0,
             pid: 0,
             date: new Date(Date.parse(match[1])),
             type: this.mapLogLevel(match[2]),
             tag: match[3],
             message: match[4],
-          });
+          };
         } else if (line.trim() === '') {
           // skip
         } else {
-          callback({
+          entry = {
             tid: 0,
             pid: 0,
             date: new Date(),
             type: 'verbose',
             tag: 'failed-parse',
             message: line,
-          });
-        }
-      });
-  }
-
-  addLogListener = (callback: DeviceLogListener) => {
-    this.setupListener(callback);
           };
+        }
+        if (entry) {
+          this.notifyLogListeners(entry);
+        }
+      });
+  }
 
-  async setupListener(callback: DeviceLogListener) {
+  async setupListener() {
     const files = await fs.readdir(getLogsPath());
     this.watchedFile = files
       .filter(file => file.startsWith('Service_'))
       .sort()
       .pop();
-    this.watch(callback);
-    this.timer = setTimeout(() => this.checkForNewLog(callback), 5000);
+    this.watch();
+    this.timer = setTimeout(() => this.checkForNewLog(), 5000);
   }
 
-  watch(callback: DeviceLogListener) {
+  watch() {
     const filePath = getLogsPath(this.watchedFile);
     fs.watchFile(filePath, async (current, previous) => {
       const readLen = current.size - previous.size;
       const buffer = new Buffer(readLen);
       const fd = await fs.open(filePath, 'r');
       await fs.read(fd, buffer, 0, readLen, previous.size);
-      this.processText(buffer, callback);
+      this.processText(buffer);
     });
   }
 
-  async checkForNewLog(callback: DeviceLogListener) {
+  async checkForNewLog() {
     const files = await fs.readdir(getLogsPath());
     const latestLog = files
       .filter(file => file.startsWith('Service_'))
@@ -135,8 +133,8 @@ export default class OculusDevice extends BaseDevice {
       const oldFilePath = getLogsPath(this.watchedFile);
       fs.unwatchFile(oldFilePath);
       this.watchedFile = latestLog;
-      this.watch(callback);
+      this.watch();
     }
-    this.timer = setTimeout(() => this.checkForNewLog(callback), 5000);
+    this.timer = setTimeout(() => this.checkForNewLog(), 5000);
   }
 }

src/devices/WindowsDevice.js

@@ -5,7 +5,6 @@
  * @format
  */
 
-import type {DeviceLogListener} from './BaseDevice.js';
 import BaseDevice from './BaseDevice.js';
 
 export default class WindowsDevice extends BaseDevice {
@@ -22,6 +21,4 @@ export default class WindowsDevice extends BaseDevice {
   supportedColumns(): Array<string> {
     return [];
   }
-
-  addLogListener(_callback: DeviceLogListener) {}
 }