feat(service): add logger

lib/Logger.ts

@@ -33,6 +33,7 @@ export enum Context {
   Swaps = 'SWAPS',
   Http = 'HTTP',
   Backup = 'BACKUP',
+  Service = 'SERVICE',
 }
 
 type Loggers = {
@@ -46,6 +47,7 @@ type Loggers = {
   connext: Logger,
   swaps: Logger,
   http: Logger,
+  service: Logger,
 };
 
 class Logger {
@@ -121,6 +123,7 @@ class Logger {
       connext: new Logger({ ...object, context: Context.Connext }),
       swaps: new Logger({ ...object, context: Context.Swaps }),
       http: new Logger({ ...object, context: Context.Http }),
+      service: new Logger({ ...object, context: Context.Service }),
     };
   }
 

lib/Xud.ts

@@ -203,6 +203,7 @@ class Xud extends EventEmitter {
         swapClientManager: this.swapClientManager,
         pool: this.pool,
         swaps: this.swaps,
+        logger: loggers.service,
         shutdown: this.beginShutdown,
       });
 

lib/service/Service.ts

@@ -1,6 +1,7 @@
 import { ProvidePreimageEvent, TransferReceivedEvent } from '../connextclient/types';
 import { OrderSide, Owner, SwapClientType, SwapRole } from '../constants/enums';
 import { OrderAttributes, TradeInstance } from '../db/types';
+import Logger from '../Logger';
 import OrderBook from '../orderbook/OrderBook';
 import { Currency, isOwnOrder, Order, OrderPortion, OwnLimitOrder, OwnMarketOrder, PlaceOrderEvent } from '../orderbook/types';
 import Pool from '../p2p/Pool';
@@ -57,6 +58,7 @@ class Service {
   private pool: Pool;
   private version: string;
   private swaps: Swaps;
+  private logger: Logger;
 
   /** Create an instance of available RPC methods and bind all exposed functions. */
   constructor(components: ServiceComponents) {
@@ -65,6 +67,7 @@ class Service {
     this.swapClientManager = components.swapClientManager;
     this.pool = components.pool;
     this.swaps = components.swaps;
+    this.logger = components.logger;
 
     this.version = components.version;
   }
@@ -678,6 +681,7 @@ class Service {
    */
   public subscribeSwapFailures = async (args: { includeTaker: boolean }, callback: (swapFailure: SwapFailure) => void) => {
     this.swaps.on('swap.failed', (deal) => {
+      this.logger.trace(`notifying SwapFailure subscription for ${deal.rHash} with role ${SwapRole[deal.role]}`);
       // always alert client for maker matches, taker matches only when specified
       if (deal.role === SwapRole.Maker || args.includeTaker) {
         callback(deal as SwapFailure);

lib/service/types.ts

@@ -7,6 +7,7 @@ import Pool from '../p2p/Pool';
 import { RaidenInfo } from '../raidenclient/types';
 import SwapClientManager from '../swaps/SwapClientManager';
 import Swaps from '../swaps/Swaps';
+import Logger from 'lib/Logger';
 
 /**
  * The components required by the API service layer.
@@ -15,10 +16,11 @@ export type ServiceComponents = {
   orderBook: OrderBook;
   swapClientManager: SwapClientManager;
   pool: Pool;
-    /** The version of the local xud instance. */
+  /** The version of the local xud instance. */
   version: string;
   swaps: Swaps;
-    /** The function to be called to shutdown the parent process */
+  logger: Logger;
+  /** The function to be called to shutdown the parent process */
   shutdown: () => void;
 };
 

lib/swaps/Swaps.ts

@@ -1095,6 +1095,8 @@ class Swaps extends EventEmitter {
     }) => {
     assert(deal.state !== SwapState.Completed, 'Can not fail a completed deal.');
 
+    this.logger.trace(`failing deal ${deal.rHash} in state ${SwapState[deal.state]} & phase ${SwapPhase[deal.phase]} due to ${SwapFailureReason[failureReason]}`);
+
     // If we are already in error state and got another error report we
     // aggregate all error reasons by concatenation
     if (deal.state === SwapState.Error) {
@@ -1168,6 +1170,7 @@ class Swaps extends EventEmitter {
       swapClient.removeInvoice(deal.rHash).catch(this.logger.error); // we don't need to await the remove invoice call
     }
 
+    this.logger.trace(`emitting swap.failed event for ${deal.rHash}`);
     this.emit('swap.failed', deal);
 
     if (peer) {

test/jest/Orderbook.spec.ts

@@ -105,6 +105,7 @@ const loggers = {
   connext: logger,
   swaps: logger,
   http: logger,
+  service: logger,
 };
 
 const localId = '97945230-8144-11e9-beb7-49ba94e5bd74';

test/jest/Service.spec.ts

@@ -1,4 +1,5 @@
 import { Owner } from '../../lib/constants/enums';
+import Logger from '../../lib/Logger';
 import Orderbook from '../../lib/orderbook/OrderBook';
 import Peer from '../../lib/p2p/Peer';
 import Pool from '../../lib/p2p/Pool';
@@ -20,6 +21,8 @@ jest.mock('../../lib/p2p/Pool');
 const mockedPool = <jest.Mock<Pool>><any>Pool;
 jest.mock('../../lib/p2p/Peer');
 const mockedPeer = <jest.Mock<Peer>><any>Peer;
+jest.mock('../../lib/Logger');
+const mockedLogger = <jest.Mock<Logger>><any>Logger;
 
 const getArgs = () => {
   return {
@@ -41,6 +44,7 @@ describe('Service', () => {
       swaps: new mockedSwaps(),
       version: '1.0.0',
       shutdown: jest.fn(),
+      logger: new mockedLogger(),
     };
     peer = new mockedPeer();
     components.pool.getPeer = jest.fn().mockReturnValue(peer);

test/jest/SwapClientManager.spec.ts

@@ -81,6 +81,7 @@ const loggers = {
   connext: logger,
   swaps: logger,
   http: logger,
+  service: logger,
 };
 jest.mock('../../lib/p2p/Peer');
 const mockedPeer = <jest.Mock<Peer>><any>Peer;

test/jest/integration/Swaps.spec.ts

@@ -76,6 +76,7 @@ describe('Swaps Integration', () => {
     logger = new mockedLogger();
     logger.debug = jest.fn();
     logger.error = jest.fn();
+    logger.trace = jest.fn();
     db = new mockedDB();
     pool = new mockedPool();
     swapClientManager = new mockedSwapClientManager();