Merge pull request #2 from interledgerjs/feat/factories

Use provider pattern

Author: DonChangfoot

package-lock.json

@@ -44,34 +44,33 @@
     "bignumber.js": "^8.0.1",
     "debug": "^3.1.0",
     "ilp-logger": "^1.1.2",
-    "ilp-packet": "^3.0.5",
+    "ilp-packet": "^3.0.6",
     "ilp-store": "^1.0.1",
-    "ilp-transport-grpc": "github:interledgerjs/ilp-transport-grpc",
     "prom-client": "^11.2.0"
   },
   "devDependencies": {
-    "@types/chai": "^4.0.10",
-    "@types/debug": "0.0.30",
-    "@types/long": "^3.0.32",
-    "@types/mocha": "^2.2.45",
+    "@types/chai": "^4.1.7",
+    "@types/debug": "^0.0.31",
+    "@types/long": "^4.0.0",
+    "@types/mocha": "^5.2.5",
     "@types/mock-require": "^2.0.0",
-    "@types/node": "^8.5.2",
-    "@types/sinon": "^4.1.2",
-    "chai": "^4.1.2",
-    "codecov": "^3.0.0",
-    "gh-pages": "^1.1.0",
-    "ilp-protocol-ildcp": "^1.0.0",
-    "json-schema-to-typescript": "^6.0.1",
-    "mocha": "^4.1.0",
-    "mocha-typescript": "^1.1.12",
-    "mock-require": "^2.0.2",
-    "nyc": "^11.4.1",
-    "sinon": "^4.1.3",
+    "@types/node": "^10.12.10",
+    "@types/sinon": "^5.0.7",
+    "chai": "^4.2.0",
+    "codecov": "^3.1.0",
+    "gh-pages": "^2.0.1",
+    "ilp-protocol-ildcp": "^2.0.0",
+    "json-schema-to-typescript": "^6.0.2",
+    "mocha": "^5.2.0",
+    "mocha-typescript": "^1.1.17",
+    "mock-require": "^3.0.2",
+    "nyc": "^13.1.0",
+    "sinon": "^7.1.1",
     "source-map-support": "^0.5.9",
-    "ts-node": "^4.1.0",
-    "tslint": "^5.8.0",
-    "tslint-config-standard": "^7.0.0",
-    "typescript": "^2.6.2"
+    "ts-node": "^7.0.1",
+    "tslint": "^5.11.0",
+    "tslint-config-standard": "^8.0.1",
+    "typescript": "^3.1.6"
   },
   "nyc": {
     "check-coverage": true,

package.json

@@ -1,7 +1,7 @@
 import PluginAccountService from './implementations/plugin'
-import { AccountInfo } from 'ilp-transport-grpc/dist/lib/account'
 import { PluginInstance } from './types/plugin'
 import { AccountService } from './types/account-service'
+import { AccountInfo } from './types/accounts'
 import { default as createLogger } from 'ilp-logger'
 const log = createLogger('app')
 

src/app.ts

@@ -3,16 +3,15 @@ import createLogger from 'ilp-logger'
 import MiddlewareManager from '../services/middleware-manager'
 import { AccountService } from '../types/account-service'
 import { MoneyHandler } from '../types/plugin'
-import { IlpPrepare, IlpPacketHander, IlpReply } from 'ilp-packet'
-import { UnreachableError } from 'ilp-packet/dist/src/errors'
+import { IlpPrepare, IlpPacketHander, IlpReply, Errors } from 'ilp-packet'
+import { EventEmitter } from 'events'
+const { UnreachableError } = Errors
 const log = createLogger('plugin-account-service')
 
-export class AccountServiceBase implements AccountService {
+export class AccountServiceBase extends EventEmitter implements AccountService {
 
   protected _id: string
   protected _info: AccountInfo
-  protected _connectHandler?: () => void
-  protected _disconnectHandler?: () => void
   protected _outgoingIlpPacketHandler?: IlpPacketHander
   protected _outgoingMoneyHandler?: MoneyHandler
   protected _incomingIlpPacketHandler: IlpPacketHander
@@ -21,6 +20,7 @@ export class AccountServiceBase implements AccountService {
   private _started: boolean = false
 
   constructor (accountId: string, accountInfo: AccountInfo, middlewares: string[]) {
+    super()
     this._id = accountId
     this._info = accountInfo
     if (middlewares.length > 0) {
@@ -39,7 +39,7 @@ export class AccountServiceBase implements AccountService {
     return this._id
   }
 
-  getInfo () {
+  public get info () {
     return this._info
   }
 
@@ -99,34 +99,6 @@ export class AccountServiceBase implements AccountService {
     throw new Error('isConnected must be implemented.')
   }
 
-  registerConnectHandler (handler: () => void) {
-    if (this._connectHandler) {
-      log.error('Connect handler already exists for account: ' + this._id)
-      throw new Error('Connect handler already exists for account: ' + this._id)
-    }
-    this._connectHandler = handler
-  }
-
-  deregisterConnectHandler () {
-    if (this._connectHandler) {
-      this._connectHandler = undefined
-    }
-  }
-
-  registerDisconnectHandler (handler: () => void) {
-    if (this._disconnectHandler) {
-      log.error('Disconnect handler already exists for account: ' + this._id)
-      throw new Error('Disconnect handler already exists for account: ' + this._id)
-    }
-    this._disconnectHandler = handler
-  }
-
-  deregisterDisconnectHandler () {
-    if (this._disconnectHandler) {
-      this._disconnectHandler = undefined
-    }
-  }
-
   registerIlpPacketHandler (handler: IlpPacketHander) {
     if (this._started) {
       log.error('Can\'t register handler after sertvice has started.')

src/implementations/base.ts

@@ -13,8 +13,8 @@ export default class PluginAccountService extends AccountServiceBase implements
   constructor (accountId: string, accountInfo: AccountInfo, plugin: PluginInstance, middlewares: string[]) {
     super(accountId, accountInfo, middlewares)
     this._plugin = plugin
-    this._plugin.on('connect', this._pluginConnect.bind(this))
-    this._plugin.on('disconnect', this._pluginDisconnect.bind(this))
+    this._plugin.on('connect', this.emit.bind(this, 'connect'))
+    this._plugin.on('disconnect', this.emit.bind(this, 'disconnect'))
 
     this._outgoingIlpPacketHandler = async (packet) => {
       return deserializeIlpPacket(await this._plugin.sendData(serializeIlpPrepare(packet))).data as IlpReply
@@ -53,14 +53,6 @@ export default class PluginAccountService extends AccountServiceBase implements
     return this._plugin.isConnected()
   }
 
-  protected async _pluginConnect () {
-    if (this._connectHandler) return this._connectHandler()
-  }
-
-  protected async _pluginDisconnect () {
-    if (this._disconnectHandler) return this._disconnectHandler()
-  }
-
   public getPlugin () {
     return this._plugin
   }

src/implementations/grpc-plugin-proxy.ts

@@ -1,14 +1,20 @@
 #!/usr/bin/env node
 
+export { AccountInfo, AccountEntry } from './types/accounts'
 export { AccountService } from './types/account-service'
 export { AccountServiceBase } from './implementations/base'
+export {
+  AccountServiceProvider,
+  AccountServiceProviderServices,
+  AccountServiceProviderDefinition } from './types/account-service-provider'
 export { default as PluginAccountService } from './implementations/plugin'
+export { default as PluginAccountServiceProvider } from './providers/plugin'
+
 import { default as createLogger } from 'ilp-logger'
 import { default as createStore } from 'ilp-store'
-import GrpcAccountService from './implementations/grpc'
-import { createConnection } from 'ilp-transport-grpc'
 import { AccountInfo } from './types/accounts'
 import createApp from './app'
+import { AccountService } from './types/account-service'
 const log = createLogger('ilp-account-service')
 require('source-map-support').install()
 
@@ -17,8 +23,8 @@ if (!module.parent) {
   const accountId = process.env.ACCOUNT_ID
   const accountInfo = JSON.parse(process.env.ACCOUNT_INFO || '{}') as AccountInfo
   const opts = Object.assign({}, accountInfo.options)
-  const Plugin = require(accountInfo.plugin || 'ilp-plugin-btp')
-  const plugin = new Plugin(opts, {
+  const pluginModule = accountInfo.plugin ? String(accountInfo.plugin) : 'ilp-plugin-btp'
+  const plugin = new (require(pluginModule))(opts, {
     log: createLogger('ilp-account-service[plugin]'),
     store: createStore()
   })
@@ -32,8 +38,11 @@ if (!module.parent) {
 
   const run = async () => {
 
-    const client = await createConnection(connectorUrl, { accountId, accountInfo })
-    const uplink = new GrpcAccountService(accountId, accountInfo, client)
+    // TODO - Provide a better default. We can build but this won't work
+    // const client = await createConnection(connectorUrl, { accountId, accountInfo })
+    // const uplink = new GrpcAccountService(accountId, accountInfo, client)
+
+    const uplink = {} as AccountService
     const middlewares = ['error-handler', 'rate-limit', 'throughput', 'balance', 'expire']
     const app = createApp(accountId, accountInfo, plugin, uplink, middlewares)
 
@@ -61,5 +70,5 @@ if (!module.parent) {
       }
     })
   }
-  run()
+  run().catch(e => console.error)
 }

src/implementations/grpc.ts

@@ -2,10 +2,6 @@ import { createHash, randomBytes, createHmac } from 'crypto'
 import { resolve } from 'path'
 import { MiddlewareMethod } from '../types/middleware'
 
-export const sha256 = (preimage: Buffer) => {
-  return createHash('sha256').update(preimage).digest()
-}
-
 export function moduleExists (path: string) {
   try {
     require.resolve(path)
@@ -81,17 +77,3 @@ export function composeMiddleware<T, U> (
     }
   }
 }
-
-export function uuid () {
-  const random = randomBytes(16)
-  random[6] = (random[6] & 0x0f) | 0x40
-  random[8] = (random[8] & 0x3f) | 0x80
-  return random.toString('hex')
-    .replace(/(.{8})(.{4})(.{4})(.{4})(.{12})/, '$1-$2-$3-$4-$5')
-}
-
-export function hmac (secret: Buffer, message: string | Buffer) {
-  const hmac = createHmac('sha256', secret)
-  hmac.update(message, 'utf8')
-  return hmac.digest()
-}