feat(mojaloop/#3053): add support for subscenarios to backend, outbou…

…d and ilp (#430) * feat(mojaloop/#3053): add support for subscenarios to backend, outbound and ilp * blop * dep * dep * audit * chore: change * chore: cleanup * chore: config * chore: fix * chore: version * chore: bump ml tkk and add tests * chore: bump * change * dep * chore(snapshot): 21.6.0-snapshot.0 * chore: dep * chore(snapshot): 21.6.0-snapshot.1 * chore: fix ci * chore: audit * chore(snapshot): 21.6.0-snapshot.2 * audit * dep
mojaloop · Jan 19, 2023 · f6c739a · f6c739a
1 parent 933a6c3
commit f6c739a
Show file tree

Hide file tree

Showing 60 changed files with 9,675 additions and 14,495 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -63,9 +63,8 @@ defaults_configure_nvm: &defaults_configure_nvm
     nvm use $(cat .nvmrc)
 
 defaults_environment: &defaults_environment
-  ## TODO: Update this to master/main once its merged into working branch
   # env var for nx to set main branch
-  MAIN_BRANCH_NAME: mvp/bulk-sdk
+  MAIN_BRANCH_NAME: master
 
 ##
 # Executors

diff --git a/audit-ci.jsonc b/audit-ci.jsonc
@@ -17,6 +17,15 @@
         "GHSA-8qr4-xgw6-wmr3",
         "GHSA-f772-66g8-q5h3",
         "GHSA-cph5-m8f7-6c5x",
-        "GHSA-hrpp-h998-j3pp"
+        "GHSA-hrpp-h998-j3pp",
+        "GHSA-8cf7-32gw-wr33",
+        // Vulnerabilities for jsonwebtoken in
+        // sdk-standard-components
+        // central-services-error-handling
+        // central-services-shared
+        "GHSA-27h2-hvpr-p74q",
+        "GHSA-hjrf-2m68-5959",
+        "GHSA-qwph-4952-7xr6",
+        "GHSA-9c47-m6qq-7p4h"
     ]
 }
diff --git a/modules/api-svc/package.json b/modules/api-svc/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@mojaloop/sdk-scheme-adapter-api-svc",
-  "version": "20.5.2",
+  "version": "20.6.0-snapshot.2",
   "description": "An adapter for connecting to Mojaloop API enabled switches.",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -61,16 +61,16 @@
   },
   "dependencies": {
     "@koa/cors": "^4.0.0",
-    "@mojaloop/api-snippets": "17.0.0",
+    "@mojaloop/api-snippets": "17.0.3",
     "@mojaloop/central-services-error-handling": "^12.0.5",
     "@mojaloop/central-services-logger": "^11.2.0",
     "@mojaloop/central-services-metrics": "^12.0.5",
-    "@mojaloop/central-services-shared": "17.3.1",
+    "@mojaloop/central-services-shared": "17.5.0",
     "@mojaloop/event-sdk": "^11.0.2",
     "@mojaloop/sdk-scheme-adapter-private-shared-lib": "workspace:^",
     "@mojaloop/sdk-standard-components": "^17.1.1",
-    "ajv": "8.11.2",
-    "axios": "^1.2.1",
+    "ajv": "8.12.0",
+    "axios": "^1.2.3",
     "co-body": "^6.1.0",
     "dotenv": "^16.0.3",
     "env-var": "^7.3.0",
@@ -85,27 +85,27 @@
     "module-alias": "^2.2.2",
     "oauth2-server": "^4.0.0-dev.2",
     "openapi-jsonschema-parameters": "^12.1.0",
-    "prom-client": "^14.1.0",
+    "prom-client": "^14.1.1",
     "promise-timeout": "^1.3.0",
     "random-word-slugs": "^0.1.6",
     "redis": "^4.5.1",
     "uuidv4": "^6.2.13",
-    "ws": "^8.11.0"
+    "ws": "^8.12.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.20.5",
+    "@babel/core": "^7.20.12",
     "@babel/preset-env": "^7.20.2",
     "@redocly/openapi-cli": "^1.0.0-beta.94",
-    "@types/jest": "^29.2.4",
+    "@types/jest": "^29.2.5",
     "babel-jest": "^29.3.1",
-    "eslint": "^8.29.0",
+    "eslint": "^8.32.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^27.1.7",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
     "jest": "^29.3.1",
     "jest-junit": "^15.0.0",
-    "nock": "^13.2.9",
-    "npm-check-updates": "^16.6.0",
+    "nock": "^13.3.0",
+    "npm-check-updates": "^16.6.2",
     "openapi-response-validator": "^12.1.0",
     "openapi-typescript": "^6.1.0",
     "redis-mock": "^0.56.3",

diff --git a/modules/api-svc/src/lib/model/InboundTransfersModel.js b/modules/api-svc/src/lib/model/InboundTransfersModel.js
@@ -203,7 +203,6 @@ class InboundTransfersModel {
 
             // make a call to the backend to ask for a quote response
             const response = await this._backendRequests.postQuoteRequests(internalForm);
-
             if(!response) {
                 // make an error callback to the source fsp
                 return 'No response from backend';
@@ -258,7 +257,7 @@ class InboundTransfersModel {
      */
     async getQuoteRequest(quoteId, sourceFspId) {
         try {
-            // Get the quoteRespnse data for the quoteId from the cache to be sent as a response to GET /quotes/{ID}
+            // Get the quoteResponse data for the quoteId from the cache to be sent as a response to GET /quotes/{ID}
             const quoteResponse = await this._cache.get(`quoteResponse_${quoteId}`);
 
             // If no quoteResponse is found in the cache, make an error callback to the source fsp
@@ -441,6 +440,7 @@ class InboundTransfersModel {
                 currency: response.currency,
                 amount: response.amount,
                 transactionType: response.transactionType,
+                subScenario: response.subScenario,
                 note: response.note,
             };
 
@@ -513,6 +513,7 @@ class InboundTransfersModel {
                         payee: quote.payee,
                         payer: bulkQuoteRequest.payer,
                         transactionType: quote.transactionType,
+                        subScenario: quote.subScenario,
                     };
 
                     const quoteResponse = {
@@ -718,6 +719,7 @@ class InboundTransfersModel {
                     currency: transfer.currency,
                     amount: transfer.amount,
                     transactionType: transfer.transactionType,
+                    subScenario: transfer.subScenario,
                     note: transfer.note,
                 };
                 let fulfilment;

diff --git a/modules/api-svc/src/lib/model/OutboundBulkQuotesModel.js b/modules/api-svc/src/lib/model/OutboundBulkQuotesModel.js
@@ -257,6 +257,7 @@ class OutboundBulkQuotesModel {
                 },
                 transactionType: {
                     scenario: individualQuote.transactionType,
+                    subScenario: individualQuote.subScenario,
                     // TODO: support payee initiated txns?
                     initiator: 'PAYER',
                     // TODO: defaulting to CONSUMER initiator type should

diff --git a/modules/api-svc/src/lib/model/OutboundRequestToPayModel.js b/modules/api-svc/src/lib/model/OutboundRequestToPayModel.js
@@ -368,6 +368,7 @@ class OutboundRequestToPayModel {
             },
             transactionType: {
                 scenario: this.data.scenario,
+                subScenario: this.data.subScenario,
                 initiator: this.data.initiator,
                 initiatorType: this.data.initiatorType
             }

diff --git a/modules/api-svc/src/lib/model/OutboundRequestToPayTransferModel.js b/modules/api-svc/src/lib/model/OutboundRequestToPayTransferModel.js
@@ -563,6 +563,7 @@ class OutboundRequestToPayTransferModel {
 
         quote.transactionType = {
             scenario: this.data.scenario,
+            subScenario: this.data.subScenario,
             initiator: this.data.initiator,
             initiatorType: this.data.initiatorType
         };

diff --git a/modules/api-svc/src/lib/model/OutboundTransfersModel.js b/modules/api-svc/src/lib/model/OutboundTransfersModel.js
@@ -599,6 +599,7 @@ class OutboundTransfersModel {
 
         quote.transactionType = {
             scenario: this.data.transactionType,
+            subScenario: this.data.subScenario,
             // TODO: support payee initiated txns?
             initiator: 'PAYER',
             // TODO: defaulting to CONSUMER initiator type should

diff --git a/modules/api-svc/src/lib/model/lib/shared.js b/modules/api-svc/src/lib/model/lib/shared.js
@@ -133,6 +133,7 @@ const mojaloopQuoteRequestToInternal = (external) => {
         amount: external.amount.amount,
         currency: external.amount.currency,
         transactionType: external.transactionType.scenario,
+        subScenario: external.transactionType.subScenario,
         initiator: external.transactionType.initiator,
         initiatorType: external.transactionType.initiatorType
     };
@@ -253,6 +254,7 @@ const mojaloopPrepareToInternalTransfer = (external, quote, ilp) => {
             currency: quote.request.amount.currency,
             amount: quote.request.amount.amount,
             transactionType: quote.request.transactionType.scenario,
+            subScenario: quote.request.transactionType.subScenario,
             ilpPacket: {
                 data: ilp.getTransactionObject(external.ilpPacket),
             },
@@ -286,6 +288,7 @@ const mojaloopTransactionRequestToInternal = (external) => {
         amount: external.amount.amount,
         currency: external.amount.currency,
         transactionType: external.transactionType.scenario,
+        subScenario: external.transactionType.subScenario,
         initiator: external.transactionType.initiator,
         initiatorType: external.transactionType.initiatorType
     };
@@ -325,6 +328,7 @@ const mojaloopBulkQuotesRequestToInternal = (external) => {
             amount: quote.amount.amount,
             currency: quote.amount.currency,
             transactionType: quote.transactionType.scenario,
+            subScenario: quote.transactionType.subScenario,
             initiator: quote.transactionType.initiator,
             initiatorType: quote.transactionType.initiatorType
         };
@@ -600,6 +604,7 @@ const mojaloopBulkPrepareToInternalBulkTransfer = (external, bulkQuotes, ilp) =>
                 to: internalQuote.to,
                 amountType: internalQuote.amountType,
                 transactionType: internalQuote.transactionType,
+                subScenario: internalQuote.subScenario,
                 note: internalQuote.note
             };
         });

diff --git a/modules/api-svc/test/integration/lib/Outbound/data/quotesPostRequest.json b/modules/api-svc/test/integration/lib/Outbound/data/quotesPostRequest.json
@@ -46,6 +46,7 @@
   "transactionType": {
     "scenario": "TRANSFER",
     "initiator": "PAYEE",
-    "initiatorType": "CONSUMER"
+    "initiatorType": "CONSUMER",
+    "subScenario": "SUBSCENARIO"
   }
-}
+}
diff --git a/modules/api-svc/test/unit/FSPIOPEventHandler.test.js b/modules/api-svc/test/unit/FSPIOPEventHandler.test.js
@@ -222,6 +222,7 @@ describe('FSPIOPEventHandler', () => {
                     currency: 'USD',
                     amount: '10',
                     transactionType: 'TRANSFER',
+                    subScenario: 'SUBSCENARIO',
                     note: 'test'
                 }
             ]

diff --git a/modules/api-svc/test/unit/api/transfers/data/postQuotesBody.json b/modules/api-svc/test/unit/api/transfers/data/postQuotesBody.json
@@ -47,6 +47,7 @@
   "transactionType": {
     "initiator": "PAYER",
     "initiatorType": "CONSUMER",
-    "scenario": "TRANSFER"
+    "scenario": "TRANSFER",
+    "subScenario": "SUBSCENARIO"
   }
 }
diff --git a/modules/api-svc/test/unit/api/transfers/data/postTransfersBadBody.json b/modules/api-svc/test/unit/api/transfers/data/postTransfersBadBody.json
@@ -12,6 +12,7 @@
   "currency": "USD",
   "amount": "100",
   "transactionType": "TRANSFER",
+  "subScenario": "SUBSCENARIO",
   "note": "test payment",
   "homeTransactionId": "123ABC"
 }
diff --git a/modules/api-svc/test/unit/api/transfers/data/postTransfersErrorMojaloopResponse.json b/modules/api-svc/test/unit/api/transfers/data/postTransfersErrorMojaloopResponse.json
@@ -47,6 +47,7 @@
       "idValue": "987654321"
     },
     "transactionType": "TRANSFER",
+    "subScenario": "SUBSCENARIO",
     "transferId": "00000000-0000-1000-8000-000000000001",
     "transferRequestExtensions": [
       {

diff --git a/modules/api-svc/test/unit/api/transfers/data/postTransfersErrorTimeoutResponse.json b/modules/api-svc/test/unit/api/transfers/data/postTransfersErrorTimeoutResponse.json
@@ -33,6 +33,7 @@
       "idValue": "987654321"
     },
     "transactionType": "TRANSFER",
+    "subScenario": "SUBSCENARIO",
     "transferId": "00000000-0000-1000-8000-000000000001",
     "transferRequestExtensions": [
       {

diff --git a/modules/api-svc/test/unit/api/transfers/data/postTransfersSimpleBody.json b/modules/api-svc/test/unit/api/transfers/data/postTransfersSimpleBody.json
@@ -13,6 +13,7 @@
   "currency": "USD",
   "amount": "100",
   "transactionType": "TRANSFER",
+  "subScenario": "SUBSCENARIO",
   "note": "test payment",
   "homeTransactionId": "123ABC",
   "quoteRequestExtensions": [

diff --git a/modules/api-svc/test/unit/api/transfers/data/postTransfersSuccessResponse.json b/modules/api-svc/test/unit/api/transfers/data/postTransfersSuccessResponse.json
@@ -114,6 +114,7 @@
     "middleName": "Someone"
   },
   "transactionType": "TRANSFER",
+  "subScenario": "SUBSCENARIO",
   "transferId": "00000000-0000-1000-8000-000000000001",
   "transferRequestExtensions": [
     {

diff --git a/modules/api-svc/test/unit/data/postQuotesBody.json b/modules/api-svc/test/unit/data/postQuotesBody.json
@@ -47,6 +47,7 @@
   "transactionType": {
     "initiator": "PAYER",
     "initiatorType": "CONSUMER",
-    "scenario": "TRANSFER"
+    "scenario": "TRANSFER",
+    "subScenario": "SUBSCENARIO"
   }
 }
diff --git a/modules/api-svc/test/unit/inboundApi/data/mockArguments.json b/modules/api-svc/test/unit/inboundApi/data/mockArguments.json
@@ -71,7 +71,8 @@
         "transactionType": {
           "scenario": "TRANSFER",
           "initiator": "PAYER",
-          "initiatorType": "CONSUMER"
+          "initiatorType": "CONSUMER",
+          "subScenario": "SUBSCENARIO"
         }
       }
     ],
@@ -114,4 +115,4 @@
       }
     ]
   }
-}
+}
diff --git a/modules/api-svc/test/unit/lib/model/data/bulkQuoteRequest.json b/modules/api-svc/test/unit/lib/model/data/bulkQuoteRequest.json
@@ -16,6 +16,7 @@
       "currency": "USD",
       "amount": "100",
       "transactionType": "TRANSFER",
+      "subScenario": "SUBSCENARIO",
       "note": "test payment"
     }
   ],

diff --git a/modules/api-svc/test/unit/lib/model/data/bulkTransferRequest.json b/modules/api-svc/test/unit/lib/model/data/bulkTransferRequest.json
@@ -19,6 +19,7 @@
       "currency": "USD",
       "amount": "100",
       "transactionType": "TRANSFER",
+      "subScenario": "SUBSCENARIO",
       "note": "test payment"
     }
   ],

diff --git a/modules/api-svc/test/unit/lib/model/data/getBulkTransfersBackendResponse.json b/modules/api-svc/test/unit/lib/model/data/getBulkTransfersBackendResponse.json
@@ -21,7 +21,8 @@
         "transactionType": {
           "initiator": "PAYER",
           "initiatorType": "CONSUMER",
-          "scenario": "TRANSFER"
+          "scenario": "TRANSFER",
+          "subScenario": "SUBSCENARIO"
         }
       }
     ]

diff --git a/modules/api-svc/test/unit/lib/model/data/getTransfersBackendResponse.json b/modules/api-svc/test/unit/lib/model/data/getTransfersBackendResponse.json
@@ -27,7 +27,8 @@
   "transactionType": {
     "initiator": "PAYER",
     "initiatorType": "CONSUMER",
-    "scenario": "TRANSFER"
+    "scenario": "TRANSFER",
+    "subScenario": "SUBSCENARIO"
   },
   "transferState": "COMMITTED",
   "timestamp": "2019-11-15T14:16:09.663"

diff --git a/modules/api-svc/test/unit/lib/model/data/mockArguments.json b/modules/api-svc/test/unit/lib/model/data/mockArguments.json
@@ -45,7 +45,8 @@
       "transactionType": {
         "scenario": "TRANSFER",
         "initiator": "PAYER",
-        "initiatorType": "CONSUMER"
+        "initiatorType": "CONSUMER",
+        "subScenario": "SUBSCENARIO"
       },
       "extensionList": {
         "extension": [{
@@ -84,6 +85,7 @@
     "amount": 10,
     "currency": "XOF",
     "transactionType": "TRANSFER",
+    "subScenario": "SUBSCENARIO",
     "initiator": "PAYER",
     "initiatorType": "CONSUMER",
     "expiration": "2019-06-04T04:02:10.378Z",
@@ -165,6 +167,7 @@
         },
         "transactionType": {
           "scenario": "TRANSFER",
+          "subScenario": "SUBSCENARIO",
           "initiator": "PAYER",
           "initiatorType": "CONSUMER"
         }

diff --git a/modules/api-svc/test/unit/lib/model/data/mockTxnRequestsArguments.json b/modules/api-svc/test/unit/lib/model/data/mockTxnRequestsArguments.json
@@ -44,7 +44,8 @@
     "transactionType": {
       "scenario": "TRANSFER",
       "initiator": "PAYER",
-      "initiatorType": "CONSUMER"
+      "initiatorType": "CONSUMER",
+      "subScenario": "SUBSCENARIO"
     }
   },
   "internalTransactionRequestResponse": {

diff --git a/modules/api-svc/test/unit/lib/model/data/transferRequest.json b/modules/api-svc/test/unit/lib/model/data/transferRequest.json
@@ -13,6 +13,7 @@
   "currency": "USD",
   "amount": "100",
   "transactionType": "TRANSFER",
+  "subScenario": "SUBSCENARIO",
   "note": "test payment",
   "homeTransactionId": "123ABC",
   "quoteRequestExtensions": [

diff --git a/modules/api-svc/test/unit/outboundApi/data/bulkQuoteRequest.json b/modules/api-svc/test/unit/outboundApi/data/bulkQuoteRequest.json
@@ -22,7 +22,8 @@
       "currency": "USD",
       "amount": "100",
       "transactionType": "TRANSFER",
+      "subScenario": "SUBSCENARIO",
       "note": "test payment"
     }
   ]
-}
+}