@mojaloop/central-ledger 17.7.8 → 17.8.0-orb.1

package/src/models/fxTransfer/fxTransferTimeout.js

@@ -0,0 +1,68 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Vijaya Kumar Guthi <vijaya.guthi@infitx.com>
+ --------------
+ ******/
+
+'use strict'
+
+const Db = require('../../lib/db')
+const Logger = require('@mojaloop/central-services-logger')
+const Enum = require('@mojaloop/central-services-shared').Enum
+const TS = Enum.Transfers.TransferInternalState
+
+const cleanup = async () => {
+  Logger.isDebugEnabled && Logger.debug('cleanup fxTransferTimeout')
+  try {
+    const knex = await Db.getKnex()
+
+    const ttIdList = await Db.from('fxTransferTimeout').query(async (builder) => {
+      const b = await builder
+        .whereIn('tsc.transferStateId', [`${TS.RECEIVED_FULFIL}`, `${TS.COMMITTED}`, `${TS.FAILED}`, `${TS.RESERVED_TIMEOUT}`,
+          `${TS.RECEIVED_REJECT}`, `${TS.EXPIRED_PREPARED}`, `${TS.EXPIRED_RESERVED}`, `${TS.ABORTED_REJECTED}`, `${TS.ABORTED_ERROR}`])
+        .innerJoin(
+          knex('fxTransferTimeout AS tt1')
+            .select('tsc1.commitRequestId')
+            .max('tsc1.fxTransferStateChangeId AS maxFxTransferStateChangeId')
+            .innerJoin('fxTransferStateChange AS tsc1', 'tsc1.commitRequestId', 'tt1.commitRequestId')
+            .groupBy('tsc1.commitRequestId').as('ts'), 'ts.commitRequestId', 'fxTransferTimeout.commitRequestId'
+        )
+        .innerJoin('fxTransferStateChange AS tsc', 'tsc.fxTransferStateChangeId', 'ts.maxFxTransferStateChangeId')
+        .select('fxTransferTimeout.fxTransferTimeoutId')
+      return b
+    })
+
+    await Db.from('fxTransferTimeout').query(async (builder) => {
+      const b = await builder
+        .whereIn('fxTransferTimeoutId', ttIdList.map(elem => elem.fxTransferTimeoutId))
+        .del()
+      return b
+    })
+    return ttIdList
+  } catch (err) {
+    Logger.isErrorEnabled && Logger.error(err)
+    throw err
+  }
+}
+
+module.exports = {
+  cleanup
+}

package/src/models/fxTransfer/index.js

@@ -0,0 +1,15 @@
+const duplicateCheck = require('./duplicateCheck')
+const fxTransfer = require('./fxTransfer')
+const stateChange = require('./stateChange')
+const watchList = require('./watchList')
+const fxTransferTimeout = require('./fxTransferTimeout')
+const fxTransferError = require('./fxTransferError')
+
+module.exports = {
+  duplicateCheck,
+  fxTransfer,
+  stateChange,
+  watchList,
+  fxTransferTimeout,
+  fxTransferError
+}

package/src/models/fxTransfer/stateChange.js

@@ -0,0 +1,47 @@
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const TransferError = require('../../models/transfer/transferError')
+const Db = require('../../lib/db')
+const { TABLE_NAMES } = require('../../shared/constants')
+const { logger } = require('../../shared/logger')
+
+const table = TABLE_NAMES.fxTransferStateChange
+
+const getByCommitRequestId = async (id) => {
+  return await Db.from(table).query(async (builder) => {
+    return builder
+      .where({ 'fxTransferStateChange.commitRequestId': id })
+      .select('fxTransferStateChange.*')
+      .orderBy('fxTransferStateChangeId', 'desc')
+      .first()
+  })
+}
+
+const logTransferError = async (id, errorCode, errorDescription) => {
+  try {
+    const stateChange = await getByCommitRequestId(id)
+    // todo: check if stateChange is not null
+    return TransferError.insert(id, stateChange.fxTransferStateChangeId, errorCode, errorDescription)
+  } catch (err) {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getLatest = async () => {
+  try {
+    return await Db.from('fxTransferStateChange').query(async (builder) => {
+      return builder
+        .select('fxTransferStateChangeId')
+        .orderBy('fxTransferStateChangeId', 'desc')
+        .first()
+    })
+  } catch (err) {
+    logger.error('getLatest::fxTransferStateChange', err)
+    throw err
+  }
+}
+
+module.exports = {
+  getByCommitRequestId,
+  logTransferError,
+  getLatest
+}

package/src/models/fxTransfer/watchList.js

@@ -0,0 +1,49 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+ * Vijay Kumar Guthi <vijaya.guthi@infitx.com>
+ --------------
+ ******/
+
+'use strict'
+
+const Db = require('../../lib/db')
+const { TABLE_NAMES } = require('../../shared/constants')
+const { logger } = require('../../shared/logger')
+
+const getItemInWatchListByCommitRequestId = async (commitRequestId) => {
+  logger.debug(`get item in watch list (commitRequestId=${commitRequestId})`)
+  return Db.from(TABLE_NAMES.fxWatchList).findOne({ commitRequestId })
+}
+
+const getItemsInWatchListByDeterminingTransferId = async (determiningTransferId) => {
+  logger.debug(`get item in watch list (determiningTransferId=${determiningTransferId})`)
+  return Db.from(TABLE_NAMES.fxWatchList).find({ determiningTransferId })
+}
+
+const addToWatchList = async (record) => {
+  logger.debug('add to fx watch list', record)
+  return Db.from(TABLE_NAMES.fxWatchList).insert(record)
+}
+
+module.exports = {
+  getItemInWatchListByCommitRequestId,
+  getItemsInWatchListByDeterminingTransferId,
+  addToWatchList
+}

package/src/models/ledgerAccountType/ledgerAccountType.js

@@ -35,25 +35,19 @@ const ErrorHandler = require('@mojaloop/central-services-error-handling')
 exports.getLedgerAccountByName = async (name, trx = null) => {
   try {
     const knex = Db.getKnex()
-    const trxFunction = async (trx, doCommit = true) => {
+    const trxFunction = async (trx) => {
       try {
         const ledgerAccountType = await knex('ledgerAccountType')
           .select()
           .where('name', name)
           .transacting(trx)
-        if (doCommit) {
-          await trx.commit
-        }
         return ledgerAccountType.length > 0 ? ledgerAccountType[0] : null
       } catch (err) {
-        if (doCommit) {
-          await trx.rollback
-        }
         throw ErrorHandler.Factory.reformatFSPIOPError(err)
       }
     }
     if (trx) {
-      return trxFunction(trx, false)
+      return trxFunction(trx)
     } else {
       return knex.transaction(trxFunction)
     }
@@ -66,25 +60,19 @@ exports.getLedgerAccountByName = async (name, trx = null) => {
 exports.getLedgerAccountsByName = async (names, trx = null) => {
   try {
     const knex = Db.getKnex()
-    const trxFunction = async (trx, doCommit = true) => {
+    const trxFunction = async (trx) => {
       try {
         const ledgerAccountTypes = await knex('ledgerAccountType')
           .select('name')
           .whereIn('name', names)
           .transacting(trx)
-        if (doCommit) {
-          await trx.commit
-        }
         return ledgerAccountTypes
       } catch (err) {
-        if (doCommit) {
-          await trx.rollback
-        }
         throw ErrorHandler.Factory.reformatFSPIOPError(err)
       }
     }
     if (trx) {
-      return trxFunction(trx, false)
+      return trxFunction(trx)
     } else {
       return knex.transaction(trxFunction)
     }
@@ -97,7 +85,7 @@ exports.getLedgerAccountsByName = async (names, trx = null) => {
 exports.bulkInsert = async (records, trx = null) => {
   try {
     const knex = Db.getKnex()
-    const trxFunction = async (trx, doCommit = true) => {
+    const trxFunction = async (trx) => {
       try {
         await knex('ledgerAccountType')
           .insert(records)
@@ -107,19 +95,13 @@ exports.bulkInsert = async (records, trx = null) => {
           .from('ledgerAccountType')
           .whereIn('name', recordsNames)
           .transacting(trx)
-        if (doCommit) {
-          await trx.commit
-        }
         return createdIds.map(record => record.ledgerAccountTypeId)
       } catch (err) {
-        if (doCommit) {
-          await trx.rollback
-        }
         throw ErrorHandler.Factory.reformatFSPIOPError(err)
       }
     }
     if (trx) {
-      return trxFunction(trx, false)
+      return trxFunction(trx)
     } else {
       return knex.transaction(trxFunction)
     }
@@ -131,7 +113,7 @@ exports.bulkInsert = async (records, trx = null) => {
 exports.create = async (name, description, isActive, isSettleable, trx = null) => {
   try {
     const knex = Db.getKnex()
-    const trxFunction = async (trx, doCommit = true) => {
+    const trxFunction = async (trx) => {
       try {
         await knex('ledgerAccountType')
           .insert({
@@ -145,19 +127,13 @@ exports.create = async (name, description, isActive, isSettleable, trx = null) =
           .from('ledgerAccountType')
           .where('name', name)
           .transacting(trx)
-        if (doCommit) {
-          await trx.commit
-        }
         return createdId[0].ledgerAccountTypeId
       } catch (err) {
-        if (doCommit) {
-          await trx.rollback()
-        }
         throw ErrorHandler.Factory.reformatFSPIOPError(err)
       }
     }
     if (trx) {
-      return trxFunction(trx, false)
+      return trxFunction(trx)
     } else {
       return knex.transaction(trxFunction)
     }

package/src/models/misc/segment.js

@@ -26,7 +26,6 @@
 
 const Db = require('../../lib/db')
 const ErrorHandler = require('@mojaloop/central-services-error-handling')
-// const Logger = require('@mojaloop/central-services-logger')
 
 const getByParams = async (params) => {
   try {

package/src/models/participant/externalParticipant.js

@@ -0,0 +1,96 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Eugen Klymniuk <eugen.klymniuk@infitx.com>
+ --------------
+ **********/
+
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Db = require('../../lib/db')
+const { logger } = require('../../shared/logger')
+const { TABLE_NAMES, DB_ERROR_CODES } = require('../../shared/constants')
+
+const TABLE = TABLE_NAMES.externalParticipant
+const ID_FIELD = 'externalParticipantId'
+
+const log = logger.child(`DB#${TABLE}`)
+
+const create = async ({ name, proxyId }) => {
+  try {
+    const result = await Db.from(TABLE).insert({ name, proxyId })
+    log.debug('create result:', { result })
+    return result
+  } catch (err) {
+    if (err.code === DB_ERROR_CODES.duplicateEntry) {
+      log.warn('duplicate entry for externalParticipant. Skip inserting', { name, proxyId })
+      return null
+    }
+    log.error('error in create', err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getAll = async (options = {}) => {
+  try {
+    const result = await Db.from(TABLE).find({}, options)
+    log.debug('getAll result:', { result })
+    return result
+  } catch (err) /* istanbul ignore next */ {
+    log.error('error in getAll:', err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getOneBy = async (criteria, options) => {
+  try {
+    const result = await Db.from(TABLE).findOne(criteria, options)
+    log.debug('getOneBy result:', { criteria, result })
+    return result
+  } catch (err) /* istanbul ignore next */ {
+    log.error('error in getOneBy:', err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+const getById = async (id, options = {}) => getOneBy({ [ID_FIELD]: id }, options)
+const getByName = async (name, options = {}) => getOneBy({ name }, options)
+
+const destroyBy = async (criteria) => {
+  try {
+    const result = await Db.from(TABLE).destroy(criteria)
+    log.debug('destroyBy result:', { criteria, result })
+    return result
+  } catch (err) /* istanbul ignore next */ {
+    log.error('error in destroyBy', err)
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+const destroyById = async (id) => destroyBy({ [ID_FIELD]: id })
+const destroyByName = async (name) => destroyBy({ name })
+
+// todo: think, if we need update method
+module.exports = {
+  create,
+  getAll,
+  getById,
+  getByName,
+  destroyById,
+  destroyByName
+}

package/src/models/participant/externalParticipantCached.js

@@ -0,0 +1,148 @@
+/*****
+ License
+ --------------
+ Copyright © 2017 Bill & Melinda Gates Foundation
+ The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+ Contributors
+ --------------
+ This is the official list of the Mojaloop project contributors for this file.
+ Names of the original copyright holders (individuals or organizations)
+ should be listed with a '*' in the first column. People who have
+ contributed from an organization can be listed under the organization
+ that actually holds the copyright for their contributions (see the
+ Gates Foundation organization for an example). Those individuals should have
+ their names indented and be marked with a '-'. Email address can be added
+ optionally within square brackets <email>.
+ * Gates Foundation
+ - Name Surname <name.surname@gatesfoundation.com>
+
+ * Eugen Klymniuk <eugen.klymniuk@infitx.com>
+ --------------
+ **********/
+
+const ErrorHandler = require('@mojaloop/central-services-error-handling')
+const Metrics = require('@mojaloop/central-services-metrics')
+const cache = require('../../lib/cache')
+const externalParticipantModel = require('./externalParticipant')
+
+let cacheClient
+let epAllCacheKey
+
+const buildUnifiedCachedData = (allExternalParticipants) => {
+  // build indexes  - optimization for byId and byName access
+  const indexById = {}
+  const indexByName = {}
+
+  allExternalParticipants.forEach(({ createdDate, ...ep }) => {
+    indexById[ep.externalParticipantId] = ep
+    indexByName[ep.name] = ep
+  })
+
+  // build unified structure - indexes + data
+  return {
+    indexById,
+    indexByName,
+    allExternalParticipants
+  }
+}
+
+const getExternalParticipantsCached = async () => {
+  const queryName = 'model_getExternalParticipantsCached'
+  const histTimer = Metrics.getHistogram(
+    'model_externalParticipant',
+    `${queryName} - Metrics for externalParticipant model`,
+    ['success', 'queryName', 'hit']
+  ).startTimer()
+
+  let cachedParticipants = cacheClient.get(epAllCacheKey)
+  const hit = !!cachedParticipants
+
+  if (!cachedParticipants) {
+    const allParticipants = await externalParticipantModel.getAll()
+    cachedParticipants = buildUnifiedCachedData(allParticipants)
+    cacheClient.set(epAllCacheKey, cachedParticipants)
+  } else {
+    // unwrap participants list from catbox structure
+    cachedParticipants = cachedParticipants.item
+  }
+  histTimer({ success: true, queryName, hit })
+
+  return cachedParticipants
+}
+
+/*
+  Public API
+*/
+const initialize = () => {
+  /* Register as cache client */
+  const cacheClientMeta = {
+    id: 'externalParticipants',
+    preloadCache: getExternalParticipantsCached
+  }
+
+  cacheClient = cache.registerCacheClient(cacheClientMeta)
+  epAllCacheKey = cacheClient.createKey('all')
+}
+
+const invalidateCache = async () => {
+  cacheClient.drop(epAllCacheKey)
+}
+
+const getById = async (id) => {
+  try {
+    const cachedParticipants = await getExternalParticipantsCached()
+    return cachedParticipants.indexById[id]
+  } catch (err) /* istanbul ignore next */ {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getByName = async (name) => {
+  try {
+    const cachedParticipants = await getExternalParticipantsCached()
+    return cachedParticipants.indexByName[name]
+  } catch (err) /* istanbul ignore next */ {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const getAll = async () => {
+  try {
+    const cachedParticipants = await getExternalParticipantsCached()
+    return cachedParticipants.allExternalParticipants
+  } catch (err) /* istanbul ignore next */ {
+    throw ErrorHandler.Factory.reformatFSPIOPError(err)
+  }
+}
+
+const withInvalidate = (theFunctionName) => {
+  return async (...args) => {
+    try {
+      const result = await externalParticipantModel[theFunctionName](...args)
+      await invalidateCache()
+      return result
+    } catch (err) /* istanbul ignore next */ {
+      throw ErrorHandler.Factory.reformatFSPIOPError(err)
+    }
+  }
+}
+
+const create = withInvalidate('create')
+const destroyById = withInvalidate('destroyById')
+const destroyByName = withInvalidate('destroyByName')
+
+module.exports = {
+  initialize,
+  invalidateCache,
+
+  getAll,
+  getById,
+  getByName,
+
+  create,
+  destroyById,
+  destroyByName
+}