@dashevo/dapi-client 0.25.0-dev.31 → 0.25.0-dev.33

package/lib/DAPIClient.js

@@ -14,6 +14,8 @@ const createJsonTransportError = require('./transport/JsonRpcTransport/createJso
 const BlockHeadersProvider = require('./BlockHeadersProvider/BlockHeadersProvider');
 const createBlockHeadersProviderFromOptions = require('./BlockHeadersProvider/createBlockHeadersProviderFromOptions');
 
+const logger = require('./logger');
+
 const EVENTS = {
   ERROR: 'error',
 };
@@ -30,6 +32,9 @@ class DAPIClient extends EventEmitter {
       timeout: 10000,
       retries: 5,
       blockHeadersProviderOptions: BlockHeadersProvider.defaultOptions,
+      loggerOptions: {
+        identifier: '',
+      },
       ...options,
     };
 
@@ -52,6 +57,7 @@ class DAPIClient extends EventEmitter {
 
     this.core = new CoreMethodsFacade(jsonRpcTransport, grpcTransport);
     this.platform = new PlatformMethodsFacade(grpcTransport);
+    this.logger = logger.getForId(this.options.loggerOptions.identifier);
 
     this.initBlockHeadersProvider();
   }
@@ -81,6 +87,8 @@ DAPIClient.EVENTS = EVENTS;
  * @property {number} [retries=3]
  * @property {number} [baseBanTime=60000]
  * @property {boolean} [throwDeadlineExceeded]
+ * @property {object} [loggerOptions]
+ * @property {string} [loggerOptions.identifier]
  * @property {BlockHeadersProvider} [blockHeadersProvider]
  * @property {BlockHeadersProviderOptions} [blockHeadersProviderOptions]
  */

package/lib/logger/index.js

@@ -0,0 +1,76 @@
+const util = require('util');
+const winston = require('winston');
+
+const LOG_LEVEL = process.env.LOG_LEVEL || 'info';
+const LOG_TO_FILE = process.env.LOG_WALLET_TO_FILE || 'false';
+
+// Log levels:
+//   error    0
+//   warn     1
+//   info     2  (default)
+//   verbose  3
+//   debug    4
+//   silly    5
+
+const loggers = {};
+
+const createLogger = (formats = [], id = '') => {
+  const format = winston.format.combine(
+    {
+      transform: (info) => {
+        const args = info[Symbol.for('splat')];
+        const result = { ...info };
+        if (args) {
+          result.message = util.format(info.message, ...args);
+        }
+        return result;
+      },
+    },
+    ...formats,
+    winston.format.colorize(),
+    winston.format.printf(({
+      level, message,
+    }) => `${level}: ${message}`),
+  );
+
+  const transports = [
+    new winston.transports.Console({
+      format,
+    }),
+  ];
+
+  if (LOG_TO_FILE === 'true' && typeof window === 'undefined') {
+    transports.push(
+      new winston.transports.File({
+        filename: `wallet${id !== '' ? `_${id}` : ''}`,
+        format,
+      }),
+    );
+  }
+
+  return winston.createLogger({
+    level: LOG_LEVEL,
+    transports,
+  });
+};
+
+const logger = createLogger();
+
+logger.getForId = (id) => {
+  if (!loggers[id]) {
+    const format = {
+      transform: (info) => {
+        const message = `[DAPIClient: ${id}] ${info.message}`;
+        return { ...info, message };
+      },
+    };
+
+    loggers[id] = createLogger([format], id);
+  }
+
+  return loggers[id];
+};
+
+logger.verbose(`Logger uses "${LOG_LEVEL}" level`, { level: LOG_LEVEL });
+
+module.exports = logger;

package/lib/test/bootstrap.js

@@ -1,4 +1,5 @@
 require('../../polyfills/fetch-polyfill');
+require('setimmediate');
 
 const { expect, use } = require('chai');
 const sinon = require('sinon');

package/lib/transport/GrpcTransport/GrpcTransport.js

@@ -1,3 +1,5 @@
+const logger = require('../../logger');
+
 const MaxRetriesReachedError = require('../errors/response/MaxRetriesReachedError');
 const NoAvailableAddressesForRetryError = require('../errors/response/NoAvailableAddressesForRetryError');
 const NoAvailableAddressesError = require('../errors/NoAvailableAddressesError');
@@ -27,6 +29,7 @@ class GrpcTransport {
     this.globalOptions = globalOptions;
 
     this.lastUsedAddress = null;
+    this.logger = logger.getForId(globalOptions.loggerOptions.identifier);
   }
 
   /**
@@ -67,6 +70,8 @@ class GrpcTransport {
       );
     }
 
+    this.logger.debug(`GRPC Request ${method} to ${address.toString()}`, { options });
+
     try {
       const result = await client[method](requestMessage, {}, requestOptions);
 
@@ -78,6 +83,8 @@ class GrpcTransport {
     } catch (error) {
       this.lastUsedAddress = address;
 
+      this.logger.error(`GRPC Request ${method} to ${address.toString()} failed with error: ${error.message}`);
+
       // for unknown errors
       if (error.code === undefined) {
         throw error;

package/lib/transport/JsonRpcTransport/JsonRpcTransport.js

@@ -1,3 +1,5 @@
+const logger = require('../../logger');
+
 const MaxRetriesReachedError = require('../errors/response/MaxRetriesReachedError');
 const NoAvailableAddressesForRetryError = require('../errors/response/NoAvailableAddressesForRetryError');
 const NoAvailableAddressesError = require('../errors/NoAvailableAddressesError');
@@ -29,6 +31,8 @@ class JsonRpcTransport {
 
     this.createJsonTransportError = createJsonTransportError;
 
+    this.logger = logger.getForId(globalOptions.loggerOptions.identifier);
+
     this.lastUsedAddress = null;
   }
 
@@ -63,6 +67,8 @@ class JsonRpcTransport {
       requestOptions.timeout = options.timeout;
     }
 
+    this.logger.debug(`JSON-RPC Request ${method} to ${address.toString()}`, { options });
+
     try {
       const result = await this.requestJsonRpc(
         address.getProtocol(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-client",
-  "version": "0.25.0-dev.31",
+  "version": "0.25.0-dev.33",
   "description": "Client library used to access Dash DAPI endpoints",
   "main": "lib/index.js",
   "contributors": [
@@ -26,24 +26,26 @@
     }
   ],
   "dependencies": {
-    "@dashevo/dapi-grpc": "0.25.0-dev.31",
-    "@dashevo/dash-spv": "0.25.0-dev.31",
+    "@dashevo/dapi-grpc": "0.25.0-dev.33",
+    "@dashevo/dash-spv": "0.25.0-dev.33",
     "@dashevo/dashcore-lib": "~0.20.9",
-    "@dashevo/dpp": "0.25.0-dev.31",
-    "@dashevo/grpc-common": "0.25.0-dev.31",
-    "@dashevo/wasm-dpp": "0.25.0-dev.31",
+    "@dashevo/dpp": "0.25.0-dev.33",
+    "@dashevo/grpc-common": "0.25.0-dev.33",
+    "@dashevo/wasm-dpp": "0.25.0-dev.33",
     "bs58": "^4.0.1",
     "cbor": "^8.0.0",
     "google-protobuf": "^3.12.2",
     "lodash": "^4.17.21",
     "node-fetch": "^2.6.7",
     "node-inspect-extracted": "^1.0.8",
-    "wasm-x11-hash": "~0.0.2"
+    "wasm-x11-hash": "~0.0.2",
+    "winston": "^3.2.1"
   },
   "devDependencies": {
     "@babel/core": "^7.15.5",
     "assert-browserify": "^2.0.0",
     "babel-loader": "^8.2.2",
+    "browserify-zlib": "^0.2.0",
     "buffer": "^6.0.3",
     "chai": "^4.3.9",
     "chai-as-promised": "^7.1.1",
@@ -65,8 +67,10 @@
     "karma-webpack": "^5.0.0",
     "mocha": "^9.1.2",
     "nyc": "^15.1.0",
+    "os-browserify": "^0.3.0",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
+    "setimmediate": "^1.0.5",
     "sinon": "^11.1.2",
     "sinon-chai": "^3.7.0",
     "stream-browserify": "^3.0.0",