Merge branch 'export-logs' of git://github.com/wbobeirne/lightning-app into wbobeirne-export-logs

Author: tanx

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';
@@ -47,7 +48,7 @@ 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 log = new LogAction(store, ipc, false);
+export const log = new LogAction(store, ipc, false, RNFS, Share);
 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);

src/action/log.js

@@ -10,6 +10,8 @@ import { MAX_LOG_LENGTH } from '../config';
 let _store;
 let _ipc;
 let _printErrObj;
+let _FS;
+let _Share;
 
 /**
  * Log an info event e.g. when something relevant but non-critical happens.
@@ -49,6 +51,49 @@ export function error(...args) {
   _ipc && _ipc.send('log-error', null, args);
 }
 
+/**
+ * Gets the location of the LND log file as a string.
+ * @param {string} network The network the user's on
+ * @return {string}
+ */
+export function getLogPath(network) {
+  if (!_FS) {
+    throw new Error('Cannot get log path with no FS in action/log.js');
+  }
+  const lndDir = _FS.DocumentDirectoryPath;
+  return `${lndDir}/logs/bitcoin/${network}/lnd.log`;
+}
+
+/**
+ * Retrieves the entire LND log file as a string.
+ * @return {Promise<string>}
+ */
+export async function getLogs() {
+  if (!_FS) {
+    throw new Error('Cannot get logs with no FS in action/log.js');
+  }
+  return _FS.readFile(getLogPath(_store.network), 'utf8');
+}
+
+/**
+ * Shares the log file using whatever native share function we have.
+ * @return {Promise}
+ */
+export async function shareLogs() {
+  try {
+    if (!_Share) {
+      throw new Error('Cannot share logs with no Share in action/log.js');
+    }
+    const logs = await getLogs();
+    return _Share.share({
+      title: 'Lightning App logs',
+      message: logs,
+    });
+  } catch (err) {
+    error(err.message);
+  }
+}
+
 function pushLogs(message) {
   if (!_store) return;
   _store.logs += '\n' + message.replace(/\s+$/, '');
@@ -59,10 +104,12 @@ function pushLogs(message) {
 }
 
 class LogAction {
-  constructor(store, ipc, printErrObj = true) {
+  constructor(store, ipc, printErrObj = true, FS, Share) {
     _store = store;
     _ipc = ipc;
     _printErrObj = printErrObj;
+    _FS = FS;
+    _Share = Share;
     _ipc.listen('logs', (event, message) => pushLogs(message));
     _ipc.send('logs-ready', null, true);
   }

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={22} width={16} />
+  </Button>
+);
+
+ShareButton.propTypes = {
+  onPress: PropTypes.func,
+  disabled: PropTypes.bool,
+  style: ViewPropTypes.style,
+};
+
 export default Button;

src/component/button.js

@@ -1,13 +1,14 @@
 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';
+import { shareLogs } from '../action/log';
 
 //
 // CLI View
@@ -24,7 +25,11 @@ const CLIView = ({ store, nav }) => (
     <Header separator style={styles.header}>
       <BackButton onPress={() => nav.goSettings()} />
       <Title title="Logs" />
-      <Button disabled onPress={() => {}} />
+      {Platform.OS === 'web' ? (
+        <Button onPress={() => {}} />
+      ) : (
+        <ShareButton onPress={() => shareLogs()} />
+      )}
     </Header>
     <LogOutput logs={store.logs} />
   </SplitBackground>

src/view/cli.js

@@ -9,13 +9,22 @@ describe('Action Logs Unit Tests', () => {
   let sandbox;
   let ipc;
   let ipcRenderer;
+  let RNFS;
+  let Share;
 
   beforeEach(() => {
     sandbox = sinon.createSandbox({});
     ipcRenderer = {
       send: sinon.stub(),
       on: sinon.stub().yields('some-event', 'some-arg'),
     };
+    RNFS = {
+      DocumentDirectoryPath: '/foo/bar',
+      readFile: sinon.stub().resolves('logs'),
+    };
+    Share = {
+      share: sinon.stub().resolves(true),
+    };
   });
 
   afterEach(() => {
@@ -115,5 +124,41 @@ describe('Action Logs Unit Tests', () => {
         expect(store.logs.length, 'to equal', 56);
       });
     });
+
+    describe('getLogPath()', () => {
+      it('should throw without a FS constructor argument', () => {
+        expect(() => log.getLogPath(), 'to throw');
+      });
+
+      it('should return a log path with FS constructor argument', () => {
+        new LogAction(store, ipc, false, RNFS);
+        expect(log.getLogPath(), 'to be a string');
+      });
+    });
+
+    describe('getLogs()', () => {
+      it('should throw without a FS constructor argument', async () => {
+        await expect(log.getLogs(), 'to be rejected');
+      });
+
+      it('should return logs with an FS constructor argument', async () => {
+        new LogAction(store, ipc, false, RNFS);
+        expect(await log.getLogs(), 'to be a string');
+        expect(RNFS.readFile.called, 'to be true');
+      });
+    });
+
+    describe('shareLogs()', () => {
+      it('should resolve false-y without Share or FS constructor arguments', async () => {
+        expect(await log.shareLogs(), 'not to be ok');
+      });
+
+      it('should share the logs with a Share and FS constructor argument', async () => {
+        new LogAction(store, ipc, false, RNFS, Share);
+        expect(await log.shareLogs(), 'to be ok');
+        expect(RNFS.readFile.called, 'to be true');
+        expect(Share.share.called, 'to be true');
+      });
+    });
   });
 });