-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(rules)!:separate rules handler from cgs handler (#346)
* WIP: 2056 * WIP: 2056 * unit tests: 2056 * unit tests: 2056
- Loading branch information
Showing
25 changed files
with
25,000 additions
and
6,217 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| /***** | ||
| 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 <[email protected]> | ||
| * ModusBox | ||
| - Shashikant Hirugade <[email protected]> | ||
| -------------- | ||
| ******/ | ||
|
|
||
| const ErrorHandler = require('@mojaloop/central-services-error-handling') | ||
| const TransferSettlementModel = require('../../models/transferSettlement') | ||
| const Logger = require('@mojaloop/central-services-logger') | ||
|
|
||
| module.exports = { | ||
| insertLedgerEntries: async function insertLedgerEntries (ledgerEntries, transferEventId, trx) { | ||
| Logger.debug(`rules::insertLedgerEntries - ledgerEntries=${JSON.stringify(ledgerEntries)}`) | ||
|
|
||
| try { | ||
| await TransferSettlementModel.insertLedgerEntries(ledgerEntries, transferEventId, trx) | ||
| return true | ||
| } catch (err) { | ||
| throw ErrorHandler.Factory.reformatFSPIOPError(err) | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /***** | ||
| 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 <[email protected]> | ||
| * ModusBox | ||
| - Shashikant Hirugade <[email protected]> | ||
| -------------- | ||
| ******/ | ||
| 'use strict' | ||
|
|
||
| /** | ||
| * @module src/handlers/transfers | ||
| */ | ||
| const Config = require('../../lib/config') | ||
| const Consumer = require('@mojaloop/central-services-stream').Util.Consumer | ||
| const Enum = require('@mojaloop/central-services-shared').Enum | ||
| const ErrorHandling = require('@mojaloop/central-services-error-handling') | ||
| const ErrorHandler = require('@mojaloop/central-services-error-handling') | ||
| const Kafka = require('@mojaloop/central-services-shared').Util.Kafka | ||
| const Logger = require('@mojaloop/central-services-logger') | ||
| const Producer = require('@mojaloop/central-services-stream').Util.Producer | ||
| const RulesService = require('../../domain/rules') | ||
| const scriptsLoader = require('../../lib/scriptsLoader') | ||
| const Utility = require('@mojaloop/central-services-shared').Util | ||
| const Db = require('../../lib/db') | ||
| const LOG_LOCATION = { module: 'RulesHandler', method: '', path: '' } // var object used as pointer | ||
| const CONSUMER_COMMIT = true | ||
| const FROM_SWITCH = true | ||
|
|
||
| const SCRIPTS_FOLDER = Config.HANDLERS.SETTINGS.SCRIPTS_FOLDER | ||
| let INJECTED_SCRIPTS = {} | ||
|
|
||
| async function processRules (error, messages) { | ||
| if (error) { | ||
| Logger.error(error) | ||
| throw ErrorHandling.Factory.reformatFSPIOPError(error) | ||
| } | ||
| Logger.info(Utility.breadcrumb(LOG_LOCATION, messages)) | ||
| let message = {} | ||
| try { | ||
| Logger.info(Utility.breadcrumb(LOG_LOCATION, { method: 'processRules' })) | ||
| if (Array.isArray(messages)) { | ||
| message = messages[0] | ||
| } else { | ||
| message = messages | ||
| } | ||
| const payload = message.value.content.payload | ||
| const kafkaTopic = message.topic | ||
| const params = { message, kafkaTopic, decodedPayload: payload, consumer: Consumer, producer: Producer } | ||
|
|
||
| const transferEventId = message.value.id | ||
| const transferEventType = message.value.metadata.event.type | ||
| const transferEventAction = message.value.metadata.event.action | ||
| const transferEventStateStatus = message.value.metadata.event.state.status | ||
| const actionLetter = transferEventAction === Enum.Events.Event.Action.COMMIT | ||
| ? Enum.Events.ActionLetter.commit | ||
| : Enum.Events.ActionLetter.unknown | ||
|
|
||
| if (!payload) { | ||
| Logger.info(Utility.breadcrumb(LOG_LOCATION, `missingPayload--${actionLetter}1`)) | ||
| const fspiopError = ErrorHandling.Factory.createInternalServerFSPIOPError('Rules handler missing payload') | ||
| const eventDetail = { functionality: Enum.Events.Event.Type.NOTIFICATION, action: Enum.Events.Event.Action.SETTLEMENT_WINDOW } | ||
| await Kafka.proceed(Config.KAFKA_CONFIG, params, { CONSUMER_COMMIT, fspiopError: fspiopError.toApiErrorObject(Config.ERROR_HANDLING), eventDetail, FROM_SWITCH }) | ||
| throw fspiopError | ||
| } | ||
| Logger.info(Utility.breadcrumb(LOG_LOCATION, 'validationPassed')) | ||
|
|
||
| // execute the rule | ||
| Logger.info(Utility.breadcrumb(LOG_LOCATION, 'executing the scripts')) | ||
| const scriptResults = await scriptsLoader.executeScripts(INJECTED_SCRIPTS, transferEventType, transferEventAction, transferEventStateStatus, message.value) | ||
| Logger.debug(`Rules Handler - scriptResults: ${JSON.stringify(scriptResults)}`) | ||
|
|
||
| const ledgerEntries = scriptResults.ledgerEntries ? scriptResults.ledgerEntries : [] | ||
| if (ledgerEntries.length > 0) { | ||
| const knex = Db.getKnex() | ||
| await knex.transaction(async trx => { | ||
| try { | ||
| await RulesService.insertLedgerEntries(ledgerEntries, transferEventId, trx) | ||
| await trx.commit | ||
| } catch (err) { | ||
| await trx.rollback | ||
| throw ErrorHandler.Factory.reformatFSPIOPError(err) | ||
| } | ||
| }) | ||
| } | ||
| Logger.info(Utility.breadcrumb(LOG_LOCATION, `done--${actionLetter}2`)) | ||
| return true | ||
| } catch (err) { | ||
| Logger.error(`${Utility.breadcrumb(LOG_LOCATION)}::${err.message}--0`, err) | ||
| return true | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @function registerRules | ||
| * | ||
| * @async | ||
| * @description Registers RulesHandler for processing settlement rules. Gets Kafka config from default.json | ||
| * Calls createHandler to register the handler against the Stream Processing API | ||
| * @returns {boolean} - Returns a boolean: true if successful, or throws and error if failed | ||
| */ | ||
| async function registerRules () { | ||
| try { | ||
| if (SCRIPTS_FOLDER == null) { | ||
| throw new Error('No SCRIPTS_FOLDER configured for running the rules handler') | ||
| } | ||
| INJECTED_SCRIPTS = scriptsLoader.loadScripts(SCRIPTS_FOLDER) | ||
| const registerRulesHandler = { | ||
| command: processRules, | ||
| topicName: Kafka.transformGeneralTopicName(Config.KAFKA_CONFIG.TOPIC_TEMPLATES.GENERAL_TOPIC_TEMPLATE.TEMPLATE, Enum.Events.Event.Type.NOTIFICATION, Enum.Events.Event.Action.EVENT), | ||
| config: Kafka.getKafkaConfig(Config.KAFKA_CONFIG, Enum.Kafka.Config.CONSUMER, Enum.Events.Event.Type.NOTIFICATION.toUpperCase(), Enum.Events.Event.Action.EVENT.toUpperCase()) | ||
| } | ||
| registerRulesHandler.config.rdkafkaConf['client.id'] = registerRulesHandler.topicName | ||
| await Consumer.createHandler(registerRulesHandler.topicName, registerRulesHandler.config, registerRulesHandler.command) | ||
| return true | ||
| } catch (err) { | ||
| Logger.error(err) | ||
| throw ErrorHandling.Factory.reformatFSPIOPError(err) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @function RegisterAllHandlers | ||
| * | ||
| * @async | ||
| * @description Registers all handlers | ||
| * | ||
| * @returns {boolean} - Returns a boolean: true if successful, or throws and error if failed | ||
| */ | ||
| async function registerAllHandlers () { | ||
| try { | ||
| await registerRules() | ||
| return true | ||
| } catch (err) { | ||
| throw ErrorHandling.Factory.reformatFSPIOPError(err) | ||
| } | ||
| } | ||
|
|
||
| module.exports = { | ||
| processRules, | ||
| registerAllHandlers, | ||
| registerRules | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.