feat(ref-imp): #319 - Added ability to turn on or off Observer and Ba…

…tch Writer

* feat(ref-imp): #319 - Added ability to turn on or off Observer and Batch Writer
* chore(ref-imp): many ESlint error fixes

lib/common/MongoDbTransactionStore.ts

@@ -1,6 +1,6 @@
+import { Collection, Cursor, Db, Long, MongoClient } from 'mongodb';
 import ITransactionStore from '../core/interfaces/ITransactionStore';
 import TransactionModel from './models/TransactionModel';
-import { Collection, Cursor, Db, Long, MongoClient } from 'mongodb';
 
 /**
  * Implementation of ITransactionStore that stores the transaction data in a MongoDB database.
@@ -153,7 +153,7 @@ export default class MongoDbTransactionStore implements ITransactionStore {
    * @param transactionTimeHash the transaction time hash which the transactions should be removed for
    */
   public async removeTransactionByTransactionTimeHash (transactionTimeHash: string) {
-    await this.transactionCollection!.deleteMany({ transactionTimeHash: { $eq:  transactionTimeHash } });
+    await this.transactionCollection!.deleteMany({ transactionTimeHash: { $eq: transactionTimeHash } });
   }
 
   /**

lib/common/ReadableStream.ts

@@ -1,5 +1,5 @@
-import SidetreeError from './SidetreeError';
 import ErrorCode from '../common/SharedErrorCode';
+import SidetreeError from './SidetreeError';
 
 /**
  * ReadableStream utilities

lib/core/BatchScheduler.ts

@@ -1,6 +1,6 @@
+import * as timeSpan from 'time-span';
 import IBlockchain from './interfaces/IBlockchain';
 import IVersionManager from './interfaces/IVersionManager';
-import timeSpan = require('time-span');
 
 /**
  * Class that performs periodic writing of batches of Sidetree operations to CAS and blockchain.

lib/core/Blockchain.ts

@@ -3,14 +3,14 @@ import BlockchainTimeModel from './models/BlockchainTimeModel';
 import CoreErrorCode from './ErrorCode';
 import IBlockchain from './interfaces/IBlockchain';
 import JsonAsync from './versions/latest/util/JsonAsync';
-import nodeFetch from 'node-fetch';
 import ReadableStream from '../common/ReadableStream';
 import ServiceVersionFetcher from './ServiceVersionFetcher';
 import ServiceVersionModel from '../common/models/ServiceVersionModel';
 import SharedErrorCode from '../common/SharedErrorCode';
 import SidetreeError from '../common/SidetreeError';
 import TransactionModel from '../common/models/TransactionModel';
 import ValueTimeLockModel from '../common/models/ValueTimeLockModel';
+import nodeFetch from 'node-fetch';
 
 /**
  * Class that communicates with the underlying blockchain using REST API defined by the protocol document.

lib/core/Core.ts

@@ -3,6 +3,7 @@ import Blockchain from './Blockchain';
 import Config from './models/Config';
 import DownloadManager from './DownloadManager';
 import ICas from './interfaces/ICas';
+import LogColor from '../common/LogColor';
 import MongoDbOperationStore from './MongoDbOperationStore';
 import MongoDbTransactionStore from '../common/MongoDbTransactionStore';
 import MongoDbUnresolvableTransactionStore from './MongoDbUnresolvableTransactionStore';
@@ -32,16 +33,18 @@ export default class Core {
   /**
    * Core constructor.
    */
-  public constructor (config: Config, versionModels: VersionModel[], private cas: ICas) {
+  public constructor (private config: Config, versionModels: VersionModel[], private cas: ICas) {
     // Component dependency construction & injection.
-    this.versionManager = new VersionManager(config, versionModels); // `VersionManager` is first constructed component.
+    this.versionManager = new VersionManager(config, versionModels); // `VersionManager` is first constructed component as multiple components depend on it.
+    this.serviceInfo = new ServiceInfo('core');
     this.operationStore = new MongoDbOperationStore(config.mongoDbConnectionString, config.databaseName);
     this.blockchain = new Blockchain(config.blockchainServiceUri);
     this.downloadManager = new DownloadManager(config.maxConcurrentDownloads, this.cas);
     this.resolver = new Resolver(this.versionManager, this.operationStore);
-    this.batchScheduler = new BatchScheduler(this.versionManager, this.blockchain, config.batchingIntervalInSeconds);
     this.transactionStore = new MongoDbTransactionStore(config.mongoDbConnectionString, config.databaseName);
     this.unresolvableTransactionStore = new MongoDbUnresolvableTransactionStore(config.mongoDbConnectionString, config.databaseName);
+
+    this.batchScheduler = new BatchScheduler(this.versionManager, this.blockchain, config.batchingIntervalInSeconds);
     this.observer = new Observer(
       this.versionManager,
       this.blockchain,
@@ -51,8 +54,6 @@ export default class Core {
       this.unresolvableTransactionStore,
       config.observingIntervalInSeconds
     );
-
-    this.serviceInfo = new ServiceInfo('core');
   }
 
   /**
@@ -71,11 +72,20 @@ export default class Core {
       this.operationStore,
       this.resolver,
       this.transactionStore
-    ); // `VersionManager` is last initialized component.
+    ); // `VersionManager` is last initialized component as it needs many shared/common components to be ready first.
+
+    if (this.config.observingIntervalInSeconds > 0) {
+      await this.observer.startPeriodicProcessing();
+    } else {
+      console.warn(LogColor.yellow(`Transaction observer is disabled.`));
+    }
 
-    await this.observer.startPeriodicProcessing();
+    if (this.config.batchingIntervalInSeconds > 0) {
+      this.batchScheduler.startPeriodicBatchWriting();
+    } else {
+      console.warn(LogColor.yellow(`Batch writing is disabled.`));
+    }
 
-    this.batchScheduler.startPeriodicBatchWriting();
     this.blockchain.startPeriodicCachedBlockchainTimeRefresh();
     this.downloadManager.start();
   }
@@ -114,8 +124,8 @@ export default class Core {
     ];
 
     return {
-      status :  ResponseStatus.Succeeded,
-      body : JSON.stringify(responses)
+      status: ResponseStatus.Succeeded,
+      body: JSON.stringify(responses)
     };
   }
 }

lib/core/MongoDbOperationStore.ts

@@ -1,7 +1,7 @@
+import { Binary, Collection, Long, MongoClient } from 'mongodb';
 import AnchoredOperationModel from './models/AnchoredOperationModel';
 import IOperationStore from './interfaces/IOperationStore';
 import OperationType from './enums/OperationType';
-import { Binary, Collection, Long, MongoClient } from 'mongodb';
 
 /**
  * Sidetree operation stored in MongoDb.

lib/core/MongoDbUnresolvableTransactionStore.ts

@@ -1,6 +1,6 @@
+import { Collection, Db, Long, MongoClient } from 'mongodb';
 import IUnresolvableTransactionStore from './interfaces/IUnresolvableTransactionStore';
 import TransactionModel from '../common/models/TransactionModel';
-import { Collection, Db, Long, MongoClient } from 'mongodb';
 
 interface IUnresolvableTransaction extends TransactionModel {
   firstFetchTime: number;

lib/core/Observer.ts

@@ -1,3 +1,5 @@
+import * as timeSpan from 'time-span';
+import TransactionUnderProcessingModel, { TransactionProcessingStatus } from './models/TransactionUnderProcessingModel';
 import IBlockchain from './interfaces/IBlockchain';
 import IOperationStore from './interfaces/IOperationStore';
 import ITransactionProcessor from './interfaces/ITransactionProcessor';
@@ -6,10 +8,8 @@ import IUnresolvableTransactionStore from './interfaces/IUnresolvableTransaction
 import IVersionManager from './interfaces/IVersionManager';
 import SharedErrorCode from '../common/SharedErrorCode';
 import SidetreeError from '../common/SidetreeError';
-import timeSpan = require('time-span');
 import ThroughputLimiter from './ThroughputLimiter';
 import TransactionModel from '../common/models/TransactionModel';
-import TransactionUnderProcessingModel, { TransactionProcessingStatus } from './models/TransactionUnderProcessingModel';
 
 /**
  * Class that performs periodic processing of batches of Sidetree operations anchored to the blockchain.

lib/core/ServiceVersionFetcher.ts

@@ -1,6 +1,6 @@
-import nodeFetch from 'node-fetch';
 import ReadableStream from '../common/ReadableStream';
 import ServiceVersionModel from '../common/models/ServiceVersionModel';
+import nodeFetch from 'node-fetch';
 
 /**
  * Encapsulates the functionality of getting the version information from the dependent services.

lib/core/ThroughputLimiter.ts

@@ -15,7 +15,7 @@ export default class ThroughputLimiter {
    * @param transactions array of transactions to filter for
    */
   public async getQualifiedTransactions (transactions: TransactionModel[]) {
-    let currentTransactionTime: number | undefined = undefined;
+    let currentTransactionTime: number | undefined;
     const transactionsGroupedByTransactionTime: TransactionModel[][] = [];
 
     for (const transaction of transactions) {

lib/core/models/Config.ts

@@ -4,9 +4,9 @@
 export default interface Config {
   batchingIntervalInSeconds: number;
   blockchainServiceUri: string;
+  databaseName: string | undefined;
   didMethodName: string;
   maxConcurrentDownloads: number;
-  observingIntervalInSeconds: number;
   mongoDbConnectionString: string;
-  databaseName: string | undefined;
+  observingIntervalInSeconds: number;
 }

lib/core/versions/latest/BatchWriter.ts

@@ -1,13 +1,13 @@
+import AnchorFile from './AnchorFile';
 import AnchoredData from './models/AnchoredData';
 import AnchoredDataSerializer from './AnchoredDataSerializer';
-import AnchorFile from './AnchorFile';
 import ChunkFile from './ChunkFile';
 import CreateOperation from './CreateOperation';
 import DeactivateOperation from './DeactivateOperation';
 import FeeManager from './FeeManager';
-import ICas from '../../interfaces/ICas';
 import IBatchWriter from '../../interfaces/IBatchWriter';
 import IBlockchain from '../../interfaces/IBlockchain';
+import ICas from '../../interfaces/ICas';
 import IOperationQueue from './interfaces/IOperationQueue';
 import IVersionMetadataFetcher from '../../interfaces/IVersionMetadataFetcher';
 import LogColor from '../../../common/LogColor';

lib/core/versions/latest/ChunkFile.ts

@@ -1,3 +1,4 @@
+import * as timeSpan from 'time-span';
 import ChunkFileModel from './models/ChunkFileModel';
 import Compressor from './util/Compressor';
 import CreateOperation from './CreateOperation';
@@ -7,7 +8,6 @@ import JsonAsync from './util/JsonAsync';
 import ProtocolParameters from './ProtocolParameters';
 import RecoverOperation from './RecoverOperation';
 import SidetreeError from '../../../common/SidetreeError';
-import timeSpan = require('time-span');
 import UpdateOperation from './UpdateOperation';
 
 /**

lib/core/versions/latest/Encoder.ts

@@ -1,6 +1,6 @@
-import base64url from 'base64url';
 import ErrorCode from './ErrorCode';
 import SidetreeError from '../../../common/SidetreeError';
+import base64url from 'base64url';
 
 /**
  * Class that encodes binary blobs into strings.

lib/core/versions/latest/MongoDbOperationQueue.ts

@@ -1,8 +1,8 @@
+import { Binary, Collection, Db, MongoClient } from 'mongodb';
 import ErrorCode from './ErrorCode';
 import IOperationQueue from './interfaces/IOperationQueue';
-import SidetreeError from '../../../common/SidetreeError';
-import { Binary, Collection, Db, MongoClient } from 'mongodb';
 import QueuedOperationModel from './models/QueuedOperationModel';
+import SidetreeError from '../../../common/SidetreeError';
 
 /**
  * Sidetree operation stored in MongoDb.
@@ -70,7 +70,7 @@ export default class MongoDbOperationQueue implements IOperationQueue {
       return [];
     }
 
-    const queuedOperations = await this.collection!.find().sort({ _id : 1 }).limit(count).toArray();
+    const queuedOperations = await this.collection!.find().sort({ _id: 1 }).limit(count).toArray();
     const lastOperation = queuedOperations[queuedOperations.length - 1];
     await this.collection!.deleteMany({ _id: { $lte: lastOperation._id } });
 
@@ -83,7 +83,7 @@ export default class MongoDbOperationQueue implements IOperationQueue {
     }
 
     // NOTE: `_id` is the default index that is sorted based by create time.
-    const queuedOperations = await this.collection!.find().sort({ _id : 1 }).limit(count).toArray();
+    const queuedOperations = await this.collection!.find().sort({ _id: 1 }).limit(count).toArray();
 
     return queuedOperations.map((operation) => MongoDbOperationQueue.convertToQueuedOperationModel(operation));
   }

lib/core/versions/latest/OperationProcessor.ts

@@ -1,8 +1,8 @@
 import AnchoredOperationModel from '../../models/AnchoredOperationModel';
 import CreateOperation from './CreateOperation';
 import DeactivateOperation from './DeactivateOperation';
-import DocumentComposer from './DocumentComposer';
 import DidState from '../../models/DidState';
+import DocumentComposer from './DocumentComposer';
 import ErrorCode from './ErrorCode';
 import IOperationProcessor from '../../interfaces/IOperationProcessor';
 import JsonCanonicalizer from './util/JsonCanonicalizer';

lib/core/versions/latest/TransactionProcessor.ts

@@ -1,6 +1,6 @@
+import AnchorFile from './AnchorFile';
 import AnchoredDataSerializer from './AnchoredDataSerializer';
 import AnchoredOperationModel from '../../models/AnchoredOperationModel';
-import AnchorFile from './AnchorFile';
 import ArrayMethods from './util/ArrayMethods';
 import ChunkFile from './ChunkFile';
 import ChunkFileModel from './models/ChunkFileModel';

lib/core/versions/latest/util/Jwk.ts

@@ -1,7 +1,7 @@
 import ErrorCode from '../ErrorCode';
+import { JWK } from 'jose';
 import JwkEs256k from '../../../models/JwkEs256k';
 import SidetreeError from '../../../../common/SidetreeError';
-import { JWK } from 'jose';
 
 /**
  * Class containing reusable JWK operations.

lib/core/versions/latest/util/Jws.ts

@@ -1,9 +1,9 @@
 import Encoder from '../Encoder';
 import ErrorCode from '../ErrorCode';
+import { JWS } from 'jose';
 import JwkEs256k from '../../../models/JwkEs256k';
 import JwsModel from '../models/JwsModel';
 import SidetreeError from '../../../../common/SidetreeError';
-import { JWS } from 'jose';
 
 /**
  * Class containing reusable JWS operations.

lib/index.ts

@@ -1,13 +1,16 @@
 // NOTE: Aliases to classes and interfaces are used for external consumption.
 
-// Core service exports.
+import ISidetreeBitcoinConfig from './bitcoin/IBitcoinConfig';
+import ISidetreeBitcoinWallet from './bitcoin/interfaces/IBitcoinWallet';
 import ISidetreeCas from './core/interfaces/ICas';
-import SidetreeCore from './core/Core';
+import SidetreeBitcoinProcessor from './bitcoin/BitcoinProcessor';
 import SidetreeConfig from './core/models/Config';
+import SidetreeCore from './core/Core';
 import SidetreeResponse from './common/Response';
 import SidetreeResponseModel from './common/models/ResponseModel';
 import SidetreeVersionModel from './common/models/VersionModel';
 
+// Core service exports.
 export {
   ISidetreeCas,
   SidetreeConfig,
@@ -18,10 +21,6 @@ export {
 };
 
 // Blockchain service exports.
-import SidetreeBitcoinProcessor from './bitcoin/BitcoinProcessor';
-import ISidetreeBitcoinConfig from './bitcoin/IBitcoinConfig';
-import ISidetreeBitcoinWallet from './bitcoin/interfaces/IBitcoinWallet';
-
 export {
   ISidetreeBitcoinConfig,
   ISidetreeBitcoinWallet,

lib/ipfs/Ipfs.ts

@@ -1,16 +1,16 @@
-import * as crypto from 'crypto';
 import * as HttpStatus from 'http-status';
+import * as crypto from 'crypto';
 import * as url from 'url';
-import base64url from 'base64url';
 import FetchResult from '../common/models/FetchResult';
 import FetchResultCode from '../common/enums/FetchResultCode';
 import ICas from '../core/interfaces/ICas';
 import IpfsErrorCode from '../ipfs/IpfsErrorCode';
-import nodeFetch from 'node-fetch';
 import ReadableStream from '../common/ReadableStream';
 import SharedErrorCode from '../common/SharedErrorCode';
 import SidetreeError from '../common/SidetreeError';
 import Timeout from './Util/Timeout';
+import base64url from 'base64url';
+import nodeFetch from 'node-fetch';
 
 const multihashes = require('multihashes');
 

tests/bitcoin/MongoDbBlockMetadataStore.spec.ts

@@ -15,7 +15,7 @@ async function createBlockMetadataStore (storeUri: string, databaseName: string)
 }
 
 describe('MongoDbBlockMetadataStore', async () => {
-  const config: Config = require('../json/bitcoin-config-test.json');
+  const config: Config = require('../json/config-test.json');
   const databaseName = 'sidetree-test';
 
   let mongoServiceAvailable = false;

tests/bitcoin/MongoDbServiceStateStore.spec.ts

@@ -14,7 +14,7 @@ async function createStore (storeUri: string, databaseName: string): Promise<Mon
 
 describe('MongoDbSeviceStateStore', async () => {
 
-  const config: Config = require('../json/bitcoin-config-test.json');
+  const config: Config = require('../json/config-test.json');
   const databaseName = 'sidetree-test';
 
   let mongoServiceAvailable = false;

tests/core/Blockchain.spec.ts

@@ -4,8 +4,8 @@ import ErrorCode from '../../lib/bitcoin/ErrorCode';
 import JasmineSidetreeErrorValidator from '../JasmineSidetreeErrorValidator';
 import ReadableStream from '../../lib/common/ReadableStream';
 import ServiceVersionModel from '../../lib/common/models/ServiceVersionModel';
-import SidetreeError from '../../lib/common/SidetreeError';
 import SharedErrorCode from '../../lib/common/SharedErrorCode';
+import SidetreeError from '../../lib/common/SidetreeError';
 import TransactionModel from '../../lib/common/models/TransactionModel';
 import ValueTimeLockModel from '../../lib/common/models/ValueTimeLockModel';
 

tests/core/ChunkFile.spec.ts

@@ -1,10 +1,10 @@
 import * as crypto from 'crypto';
 import ChunkFile from '../../lib/core/versions/latest/ChunkFile';
+import Compressor from '../../lib/core/versions/latest/util/Compressor';
 import Encoder from '../../lib/core/versions/latest/Encoder';
 import ErrorCode from '../../lib/core/versions/latest/ErrorCode';
 import JasmineSidetreeErrorValidator from '../JasmineSidetreeErrorValidator';
 import Jwk from '../../lib/core/versions/latest/util/Jwk';
-import Compressor from '../../lib/core/versions/latest/util/Compressor';
 import OperationGenerator from '../generators/OperationGenerator';
 
 describe('ChunkFile', async () => {