Merge pull request #1270 from lightninglabs/dev/wbobeirne-export-logs

Dev/wbobeirne export logs

Author: tanx

src/action/file-mobile.js

@@ -0,0 +1,63 @@
+/**
+ * @fileOverview actions wrapping file I/O operations on mobile.
+ */
+
+import * as log from './log';
+
+class FileAction {
+  constructor(store, FS, Share) {
+    this._store = store;
+    this._FS = FS;
+    this._Share = Share;
+  }
+
+  /**
+   * Gets the path of the lnd directory where `logs` and `data` are stored.
+   * @return {string}
+   */
+  getLndDir() {
+    return this._FS.DocumentDirectoryPath;
+  }
+
+  /**
+   * Retrieves the entire lnd log file contents as a string.
+   * @return {Promise<string>}
+   */
+  async readLogs() {
+    const { network } = this._store;
+    const path = `${this.getLndDir()}/logs/bitcoin/${network}/lnd.log`;
+    return this._FS.readFile(path, 'utf8');
+  }
+
+  /**
+   * Shares the log file using whatever native share function we have.
+   * @return {Promise}
+   */
+  async shareLogs() {
+    try {
+      const logs = await this.readLogs();
+      await this._Share.share({
+        title: 'Lightning App logs',
+        message: logs,
+      });
+    } catch (err) {
+      log.error('Exporting logs failed', err);
+    }
+  }
+
+  /**
+   * Delete the wallet.db file. This allows the user to restore their wallet
+   * (including channel state) from the seed if they've forgotten the pin.
+   * @return {Promise<undefined>}
+   */
+  async deleteWalletDB(network) {
+    const path = `${this.getLndDir()}/data/chain/bitcoin/${network}/wallet.db`;
+    try {
+      await this._FS.unlink(path);
+    } catch (err) {
+      log.info(`No ${network} wallet to delete.`);
+    }
+  }
+}
+
+export default FileAction;

src/action/index-mobile.js

@@ -14,6 +14,7 @@ import {
   NativeModules,
   ActionSheetIOS,
   NativeEventEmitter,
+  Share,
 } from 'react-native';
 import * as Random from 'expo-random';
 import * as LocalAuthentication from 'expo-local-authentication';
@@ -28,6 +29,7 @@ import GrpcAction from './grpc-mobile';
 import NavAction from './nav-mobile';
 import WalletAction from './wallet';
 import LogAction from './log';
+import FileAction from './file-mobile';
 import InfoAction from './info';
 import NotificationAction from './notification';
 import ChannelAction from './channel';
@@ -47,10 +49,11 @@ store.init(); // initialize computed values
 export const db = new AppStorage(store, AsyncStorage);
 export const grpc = new GrpcAction(store, NativeModules, NativeEventEmitter);
 export const ipc = new IpcAction(grpc);
+export const file = new FileAction(store, RNFS, Share);
 export const log = new LogAction(store, ipc, false);
 export const nav = new NavAction(store, NavigationActions, StackActions);
 export const notify = new NotificationAction(store, nav);
-export const wallet = new WalletAction(store, grpc, db, nav, notify, RNFS);
+export const wallet = new WalletAction(store, grpc, db, nav, notify, file);
 export const info = new InfoAction(store, grpc, nav, notify);
 export const transaction = new TransactionAction(store, grpc, nav, notify);
 export const channel = new ChannelAction(store, grpc, nav, notify);

src/action/wallet.js

@@ -14,13 +14,13 @@ import { when } from 'mobx';
 import * as log from './log';
 
 class WalletAction {
-  constructor(store, grpc, db, nav, notification, FS) {
+  constructor(store, grpc, db, nav, notification, file) {
     this._store = store;
     this._grpc = grpc;
     this._db = db;
     this._nav = nav;
     this._notification = notification;
-    this._FS = FS;
+    this._file = file;
   }
 
   //
@@ -266,7 +266,7 @@ class WalletAction {
    */
   async initWallet({ walletPassword, seedMnemonic, recoveryWindow = 0 }) {
     try {
-      await Promise.all([this.deleteDB('testnet'), this.deleteDB('mainnet')]);
+      await this.deleteDB();
       await this._grpc.sendUnlockerCommand('InitWallet', {
         walletPassword: toBuffer(walletPassword),
         cipherSeedMnemonic: seedMnemonic,
@@ -293,20 +293,19 @@ class WalletAction {
   /**
    * Delete the wallet.db file. This allows the user to restore their wallet
    * (including channel state) from the seed if they've they've forgotten the
-   * wallet pin/password.
+   * wallet pin/password. We need to delete both mainnet and testnet wallet
+   * files since we haven't set `store.network` at this point in the app life
+   * cycle yet (which happens later when we query getInfo).
    * @return {Promise<undefined>}
    */
-  async deleteDB(network) {
-    if (!this._FS) {
+  async deleteDB() {
+    if (!this._file) {
       return;
     }
-    const lndDir = this._FS.DocumentDirectoryPath;
-    const dbPath = `${lndDir}/data/chain/bitcoin/${network}/wallet.db`;
-    try {
-      await this._FS.unlink(dbPath);
-    } catch (err) {
-      log.info(`No ${network} wallet to delete.`);
-    }
+    await Promise.all([
+      this._file.deleteWalletDB('testnet'),
+      this._file.deleteWalletDB('mainnet'),
+    ]);
   }
 
   /**

src/asset/icon/share.js

@@ -0,0 +1,14 @@
+import React from 'react';
+import Svg, { G, Path } from '../../component/svg';
+const Share = props => (
+  <Svg viewBox="0 0 44 47" width="1em" height="1em" {...props}>
+    <G fill="#FFFFFF" fillRule="nonzero">
+      <Path
+        d="M20.2823393,45.8089582 L8.6208326,33.9983559 C6.7386017,32.112201 9.561948,29.2839686 11.4431809,31.1701236 L19.3034582,39.0535264 C19.6891903,39.4403934 20.0040283,39.3079355 20.0040283,38.7550254 L20.0040283,17.0049295 C20.0040283,15.8957094 20.8976693,14.9999992 22.0000313,14.9999992 C23.1100789,14.9999992 23.9960344,15.8976371 23.9960344,17.0049295 L23.9960344,38.7550254 C23.9960344,39.3053352 24.3096903,39.4415789 24.6966045,39.0535264 L32.5568818,31.1701236 C34.4391127,29.2839686 37.261461,32.112201 35.3792301,33.9983559 L23.7942534,45.7949866 C22.8210143,46.7860065 21.2509472,46.7899499 20.2823393,45.8089582 Z M4,4.99702929 L4,11.9999992 C4,13.1045687 3.1045695,13.9999992 2,13.9999992 C0.8954305,13.9999992 -7.10542736e-15,13.1045687 -7.10542736e-15,11.9999992 L-7.10542736e-15,2.99539679 C-7.10542736e-15,1.33499009 1.3506856,-8.07948688e-07 3.0087752,-8.07948688e-07 L40.9912248,-8.07948688e-07 C42.6465785,-8.07948688e-07 44,1.34474899 44,2.99539679 L44,11.9999992 C44,13.1045687 43.1045695,13.9999992 42,13.9999992 C40.8954305,13.9999992 40,13.1045687 40,11.9999992 L40,4.99702929 C40,4.45303549 39.552097,3.99999919 38.9995806,3.99999919 L5.0004194,3.99999919 C4.455173,3.99999919 4,4.44638479 4,4.99702929 Z"
+        transform="translate(22.000000, 23.270746) rotate(180.000000) translate(-22.000000, -23.270746)"
+      />
+    </G>
+  </Svg>
+);
+
+export default Share;

src/asset/icon/share.svg

@@ -13,6 +13,7 @@ import BackIcon from '../asset/icon/back';
 import CancelIcon from '../asset/icon/cancel';
 import PlusIcon from '../asset/icon/plus';
 import QrIcon from '../asset/icon/qr';
+import ShareIcon from '../asset/icon/share';
 import { color, font } from './style';
 
 //
@@ -558,4 +559,20 @@ MaxButton.propTypes = {
   style: ViewPropTypes.style,
 };
 
+//
+// Share Button
+//
+
+export const ShareButton = ({ onPress, disabled, style }) => (
+  <Button onPress={onPress} disabled={disabled} style={style}>
+    <ShareIcon height={16} width={14.979} />
+  </Button>
+);
+
+ShareButton.propTypes = {
+  onPress: PropTypes.func,
+  disabled: PropTypes.bool,
+  style: ViewPropTypes.style,
+};
+
 export default Button;

src/component/button.js

@@ -1,11 +1,11 @@
 import React, { Component } from 'react';
-import { ScrollView, StyleSheet } from 'react-native';
+import { ScrollView, StyleSheet, Platform } from 'react-native';
 import { observer } from 'mobx-react';
 import PropTypes from 'prop-types';
 import { SplitBackground } from '../component/background';
 import { Header, Title } from '../component/header';
 import Text from '../component/text';
-import { Button, BackButton } from '../component/button';
+import { BackButton, ShareButton, Button } from '../component/button';
 import { createStyles, maxWidth } from '../component/media-query';
 import { color, font, breakWidth } from '../component/style';
 
@@ -19,12 +19,16 @@ const styles = StyleSheet.create({
   },
 });
 
-const CLIView = ({ store, nav }) => (
+const CLIView = ({ store, nav, file }) => (
   <SplitBackground color={color.blackDark} bottom={color.cliBackground}>
     <Header separator style={styles.header}>
       <BackButton onPress={() => nav.goSettings()} />
       <Title title="Logs" />
-      <Button disabled onPress={() => {}} />
+      {Platform.OS === 'web' ? (
+        <Button disabled onPress={() => {}} />
+      ) : (
+        <ShareButton onPress={() => file.shareLogs()} />
+      )}
     </Header>
     <LogOutput logs={store.logs} />
   </SplitBackground>
@@ -33,6 +37,7 @@ const CLIView = ({ store, nav }) => (
 CLIView.propTypes = {
   store: PropTypes.object.isRequired,
   nav: PropTypes.object.isRequired,
+  file: PropTypes.object,
 };
 
 //

src/view/cli.js

@@ -61,6 +61,7 @@ import {
   info,
   auth,
   autopilot,
+  file,
 } from '../action/index-mobile';
 
 import store from '../store';
@@ -137,7 +138,7 @@ const SettingsFiat = () => (
   <SettingFiatView store={store} nav={nav} setting={setting} />
 );
 
-const CLI = () => <CLIView store={store} nav={nav} />;
+const CLI = () => <CLIView store={store} nav={nav} file={file} />;
 
 const Notifications = () => <NotificationView store={store} nav={nav} />;
 

src/view/main-mobile.js

@@ -17,6 +17,7 @@ import PaymentAction from '../src/action/payment';
 import ChannelAction from '../src/action/channel';
 import TransactionAction from '../src/action/transaction';
 import AuthAction from '../src/action/auth-mobile';
+import FileAction from '../src/action/file-mobile';
 import AtplAction from '../src/action/autopilot';
 import Welcome from '../src/view/welcome';
 import Transaction from '../src/view/transaction';
@@ -90,6 +91,7 @@ import RestoreSeedMobile from '../src/view/restore-seed-mobile';
 
 const store = new Store();
 store.init();
+const file = sinon.createStubInstance(FileAction);
 const nav = sinon.createStubInstance(NavAction);
 const db = sinon.createStubInstance(AppStorage);
 const ipc = sinon.createStubInstance(IpcAction);
@@ -218,7 +220,7 @@ storiesOf('Screens', module)
   .add('Notifications (Mobile)', () => (
     <NotificationMobile store={store} nav={nav} />
   ))
-  .add('CLI', () => <CLI store={store} nav={nav} />)
+  .add('CLI', () => <CLI store={store} nav={nav} file={file} />)
   .add('Transactions', () => (
     <Transaction store={store} transaction={transaction} nav={nav} />
   ))

stories/screen-story.js

@@ -0,0 +1,89 @@
+import { Store } from '../../../src/store';
+import FileAction from '../../../src/action/file-mobile';
+import * as logger from '../../../src/action/log';
+
+describe('Action File Mobile Unit Tests', () => {
+  let store;
+  let sandbox;
+  let RNFS;
+  let Share;
+  let file;
+
+  beforeEach(() => {
+    sandbox = sinon.createSandbox({});
+    sandbox.stub(logger);
+    store = new Store();
+    RNFS = {
+      DocumentDirectoryPath: '/foo/bar',
+      readFile: sinon.stub().resolves('some-logs'),
+      unlink: sinon.stub().resolves(),
+    };
+    Share = {
+      share: sinon.stub().resolves(),
+    };
+    file = new FileAction(store, RNFS, Share);
+  });
+
+  afterEach(() => {
+    sandbox.restore();
+  });
+
+  describe('getLndDir()', () => {
+    it('should get lnd directory', () => {
+      const path = file.getLndDir();
+      expect(path, 'to equal', '/foo/bar');
+    });
+  });
+
+  describe('readLogs()', () => {
+    it('should read log file contents', async () => {
+      store.network = 'mainnet';
+      const logs = await file.readLogs();
+      expect(logs, 'to equal', 'some-logs');
+      expect(
+        RNFS.readFile,
+        'was called with',
+        '/foo/bar/logs/bitcoin/mainnet/lnd.log',
+        'utf8'
+      );
+    });
+  });
+
+  describe('shareLogs()', () => {
+    beforeEach(() => {
+      sandbox.stub(file, 'readLogs');
+    });
+
+    it('should invoke the native share api', async () => {
+      file.readLogs.resolves('some-logs');
+      await file.shareLogs();
+      expect(Share.share, 'was called with', {
+        title: 'Lightning App logs',
+        message: 'some-logs',
+      });
+    });
+
+    it('should log error if sharing fails', async () => {
+      file.readLogs.rejects(new Error('Boom!'));
+      await file.shareLogs();
+      expect(logger.error, 'was called once');
+    });
+  });
+
+  describe('deleteWalletDB()', () => {
+    it('should delete wallet db file', async () => {
+      await file.deleteWalletDB('mainnet');
+      expect(
+        RNFS.unlink,
+        'was called with',
+        '/foo/bar/data/chain/bitcoin/mainnet/wallet.db'
+      );
+    });
+
+    it('should log error if deleting fails', async () => {
+      RNFS.unlink.rejects(new Error('Boom!'));
+      await file.deleteWalletDB('mainnet');
+      expect(logger.info, 'was called once');
+    });
+  });
+});