fix: update outbound interface and response oa3 defs (#316)

* fix: update outbound interface and response oa3 defs * chore: fix * chore: fix int tests
mojaloop · May 12, 2022 · 50d23d8 · 50d23d8
1 parent 56fa5c8
commit 50d23d8
Show file tree

Hide file tree

Showing 13 changed files with 185 additions and 95 deletions.
diff --git a/src/OutboundServer/api.yaml b/src/OutboundServer/api.yaml
@@ -2124,8 +2124,15 @@ components:
       description: 'GET /parties/{Type}/{ID} response object'
       properties:
         party:
-          $ref: '#/components/schemas/Party'
-          description: Information regarding the requested Party.
+          properties:
+            body:
+              $ref: '#/components/schemas/Party'
+              description: Information regarding the requested Party.
+            headers:
+              type: object
+          required:
+            - body
+            - headers
         currentState:
           $ref: '#/components/schemas/async2SyncCurrentState'
       required:
@@ -2235,33 +2242,41 @@ components:
           type: object
           description: 'The object sent in the PUT /quotes/{ID} callback.'
           properties:
-            transferAmount:
-              $ref: '#/components/schemas/Money'
-            payeeReceiveAmount:
-              $ref: '#/components/schemas/Money'
-            payeeFspFee:
-              $ref: '#/components/schemas/Money'
-            payeeFspCommission:
-              $ref: '#/components/schemas/Money'
-            expiration:
-              type: string
-              description: >-
-                Date and time until when the quotation is valid and can be
-                honored when used in the subsequent transaction.
-              example: '2016-05-24T08:38:08.699-04:00'
-            geoCode:
-              $ref: '#/components/schemas/GeoCode'
-            ilpPacket:
-              $ref: '#/components/schemas/IlpPacket'
-            condition:
-              $ref: '#/components/schemas/IlpCondition'
-            extensionList:
-              $ref: '#/components/schemas/ExtensionList'
+            body:
+              type: object
+              properties:
+                transferAmount:
+                  $ref: '#/components/schemas/Money'
+                payeeReceiveAmount:
+                  $ref: '#/components/schemas/Money'
+                payeeFspFee:
+                  $ref: '#/components/schemas/Money'
+                payeeFspCommission:
+                  $ref: '#/components/schemas/Money'
+                expiration:
+                  type: string
+                  description: >-
+                    Date and time until when the quotation is valid and can be
+                    honored when used in the subsequent transaction.
+                  example: '2016-05-24T08:38:08.699-04:00'
+                geoCode:
+                  $ref: '#/components/schemas/GeoCode'
+                ilpPacket:
+                  $ref: '#/components/schemas/IlpPacket'
+                condition:
+                  $ref: '#/components/schemas/IlpCondition'
+                extensionList:
+                  $ref: '#/components/schemas/ExtensionList'
+              required:
+                - transferAmount
+                - expiration
+                - ilpPacket
+                - condition
+            headers:
+              type: object
           required:
-            - transferAmount
-            - expiration
-            - ilpPacket
-            - condition
+            - body
+            - headers
         currentState:
           $ref: '#/components/schemas/async2SyncCurrentState'
       required:
@@ -2316,7 +2331,14 @@ components:
       type: object
       properties:
         transfer:
-          $ref: '#/components/schemas/TransfersIDPutResponse'
+          properties:
+            body:
+              $ref: '#/components/schemas/TransfersIDPutResponse'
+            headers:
+              type: object
+          required:
+            - body
+            - headers
         currentState:
           $ref: '#/components/schemas/async2SyncCurrentState'
       required:

diff --git a/src/OutboundServer/api_interfaces/openapi.d.ts b/src/OutboundServer/api_interfaces/openapi.d.ts
@@ -1070,8 +1070,11 @@ export interface components {
       | "ERROR_OCCURRED";
     /** GET /parties/{Type}/{ID} response object */
     partiesByIdResponse: {
-      /** Information regarding the requested Party. */
-      party: components["schemas"]["Party"];
+      party: {
+        /** Information regarding the requested Party. */
+        body: components["schemas"]["Party"];
+        headers: { [key: string]: unknown };
+      };
       currentState: components["schemas"]["async2SyncCurrentState"];
     };
     /** The object sent in the POST /quotes request. */
@@ -1110,16 +1113,19 @@ export interface components {
     quotesPostResponse: {
       /** The object sent in the PUT /quotes/{ID} callback. */
       quotes: {
-        transferAmount: components["schemas"]["Money"];
-        payeeReceiveAmount?: components["schemas"]["Money"];
-        payeeFspFee?: components["schemas"]["Money"];
-        payeeFspCommission?: components["schemas"]["Money"];
-        /** Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. */
-        expiration: string;
-        geoCode?: components["schemas"]["GeoCode"];
-        ilpPacket: components["schemas"]["IlpPacket"];
-        condition: components["schemas"]["IlpCondition"];
-        extensionList?: components["schemas"]["ExtensionList"];
+        body: {
+          transferAmount: components["schemas"]["Money"];
+          payeeReceiveAmount?: components["schemas"]["Money"];
+          payeeFspFee?: components["schemas"]["Money"];
+          payeeFspCommission?: components["schemas"]["Money"];
+          /** Date and time until when the quotation is valid and can be honored when used in the subsequent transaction. */
+          expiration: string;
+          geoCode?: components["schemas"]["GeoCode"];
+          ilpPacket: components["schemas"]["IlpPacket"];
+          condition: components["schemas"]["IlpCondition"];
+          extensionList?: components["schemas"]["ExtensionList"];
+        };
+        headers: { [key: string]: unknown };
       };
       currentState: components["schemas"]["async2SyncCurrentState"];
     };
@@ -1142,7 +1148,10 @@ export interface components {
       transfersPostRequest: components["schemas"]["TransfersPostRequest"];
     };
     simpleTransfersPostResponse: {
-      transfer: components["schemas"]["TransfersIDPutResponse"];
+      transfer: {
+        body: components["schemas"]["TransfersIDPutResponse"];
+        headers: { [key: string]: unknown };
+      };
       currentState: components["schemas"]["async2SyncCurrentState"];
     };
     errorSimpleTransfersResponse: components["schemas"]["errorResponse"] & {

diff --git a/src/OutboundServer/api_template/components/schemas/partiesByIdResponse.yaml b/src/OutboundServer/api_template/components/schemas/partiesByIdResponse.yaml
@@ -3,9 +3,16 @@
   description: 'GET /parties/{Type}/{ID} response object'
   properties:
     party:
-      $ref: >-
-        ../../../../../node_modules/@mojaloop/api-snippets/thirdparty/v1_0/openapi3/components/schemas/Party.yaml
-      description: Information regarding the requested Party.
+      properties:
+        body:
+          $ref: >-
+            ../../../../../node_modules/@mojaloop/api-snippets/thirdparty/v1_0/openapi3/components/schemas/Party.yaml
+          description: Information regarding the requested Party.
+        headers:
+          type: object
+      required:
+        - body
+        - headers
     currentState:
       $ref: ../schemas/async2SyncCurrentState.yaml
   required:

diff --git a/src/OutboundServer/api_template/components/schemas/quotesPostResponse.yaml b/src/OutboundServer/api_template/components/schemas/quotesPostResponse.yaml
@@ -6,41 +6,49 @@ properties:
     type: object
     description: 'The object sent in the PUT /quotes/{ID} callback.'
     properties:
-      transferAmount:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
-      payeeReceiveAmount:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
-      payeeFspFee:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
-      payeeFspCommission:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
-      expiration:
-        type: string
-        description: >-
-          Date and time until when the quotation is valid and can be honored when
-          used in the subsequent transaction.
-        example: '2016-05-24T08:38:08.699-04:00'
-      geoCode:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/GeoCode.yaml
-      ilpPacket:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpPacket.yaml
-      condition:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpCondition.yaml
-      extensionList:
-        $ref: >-
-          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml
+      body:
+        type: object
+        properties:
+          transferAmount:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
+          payeeReceiveAmount:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
+          payeeFspFee:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
+          payeeFspCommission:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/Money.yaml
+          expiration:
+            type: string
+            description: >-
+              Date and time until when the quotation is valid and can be honored when
+              used in the subsequent transaction.
+            example: '2016-05-24T08:38:08.699-04:00'
+          geoCode:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/GeoCode.yaml
+          ilpPacket:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpPacket.yaml
+          condition:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/IlpCondition.yaml
+          extensionList:
+            $ref: >-
+              ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/ExtensionList.yaml
+        required:
+          - transferAmount
+          - expiration
+          - ilpPacket
+          - condition
+      headers:
+        type: object
     required:
-      - transferAmount
-      - expiration
-      - ilpPacket
-      - condition
+    - body
+    - headers
   currentState:
     $ref: ../schemas/async2SyncCurrentState.yaml
 required:

diff --git a/src/OutboundServer/api_template/components/schemas/simpleTransfersPostResponse.yaml b/src/OutboundServer/api_template/components/schemas/simpleTransfersPostResponse.yaml
@@ -2,8 +2,15 @@ title: SimpleTransfersPostResponse
 type: object
 properties:
   transfer:
-    $ref: >-
-      ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransfersIDPutResponse.yaml
+    properties:
+      body:
+        $ref: >-
+          ../../../../../node_modules/@mojaloop/api-snippets/fspiop/v1_1/openapi3/components/schemas/TransfersIDPutResponse.yaml
+      headers:
+        type: object
+    required:
+      - body
+      - headers
   currentState:
     $ref: ../schemas/async2SyncCurrentState.yaml
 required:

diff --git a/src/lib/model/PartiesModel.js b/src/lib/model/PartiesModel.js
@@ -58,12 +58,25 @@ function argsValidation({ type, id, subId }) {
     }
 }
 
+/**
+ * @name reformatMessage
+ * @description reformats message received from PUB/SUB channel, it is optional method, if not specified identify function is used by default
+ * @param {object} message - message received
+ * @returns {object} - reformatted message
+ */
+function reformatMessage(message) {
+    return {
+        party: { ...message }
+    };
+}
+
 // generate model
 const PartiesModel = Async2SyncModel.generate({
     modelName: 'PartiesModel',
     channelNameMethod: channelName,
     requestActionMethod: requestAction,
-    argsValidationMethod: argsValidation
+    argsValidationMethod: argsValidation,
+    reformatMessageMethod: reformatMessage
 });
 
 module.exports = PartiesModel;

diff --git a/test/integration/lib/Outbound/parties.test.js b/test/integration/lib/Outbound/parties.test.js
@@ -13,7 +13,9 @@ describe('/parties', () => {
 
         expect(res.status).toEqual(200);
         expect(res.data.currentState).toEqual('COMPLETED');
-        expect(typeof res.data.body.party).toEqual('object');
+        expect(typeof res.data.party).toEqual('object');
+        expect(typeof res.data.party.body).toEqual('object');
+        expect(typeof res.data.party.headers).toEqual('object');
     });
 
     test('get - timeout', (done) => {

diff --git a/test/integration/lib/Outbound/quotes.test.js b/test/integration/lib/Outbound/quotes.test.js
@@ -30,6 +30,8 @@ describe('/quotes', () => {
         expect(res.status).toEqual(200);
         expect(res.data.currentState).toEqual('COMPLETED');
         expect(typeof res.data.quotes).toEqual('object');
+        expect(typeof res.data.quotes.body).toEqual('object');
+        expect(typeof res.data.quotes.headers).toEqual('object');
     });
 
     test('post - timeout', (done) => {

diff --git a/test/integration/lib/Outbound/simpleTransfers.test.js b/test/integration/lib/Outbound/simpleTransfers.test.js
@@ -39,6 +39,8 @@ describe('/simpleTransfers', () => {
         expect(res.status).toEqual(200);
         expect(res.data.currentState).toEqual('COMPLETED');
         expect(typeof res.data.transfer).toEqual('object');
+        expect(typeof res.data.transfer.body).toEqual('object');
+        expect(typeof res.data.transfer.headers).toEqual('object');
     });
 
     test('post - timeout', async () => {

diff --git a/test/unit/api/transfers/utils.js b/test/unit/api/transfers/utils.js
@@ -202,7 +202,7 @@ function createPostTransfersTester(
 
         const res = await reqOutbound.post('/transfers').send(postTransfersSimpleBody);
         const {body} = res;
-        console.log(body)
+
         expect(res.statusCode).toEqual(responseCode);
 
         // remove elements of the response we do not want/need to compare for correctness.

diff --git a/test/unit/lib/model/PartiesModel.test.js b/test/unit/lib/model/PartiesModel.test.js
@@ -155,9 +155,12 @@ describe('PartiesModel', () => {
             model.run = jest.fn(() => Promise.resolve());
 
             const message = {
-                party: {
-                    Iam: 'the-body'
-                }
+                body: {
+                    party: {
+                        Iam: 'the-body'
+                    }
+                },
+                headers: {}
             };
 
             const onRequestActionPromise = new Promise((resolve, reject) => {
@@ -175,7 +178,7 @@ describe('PartiesModel', () => {
 
                         // check that this.context.data is updated
                         expect(model.context.data).toEqual({
-                            ...message,
+                            party: { ...message },
                             // current state will be updated by onAfterTransition which isn't called
                             // when manual invocation of transition handler happens
                             currentState: 'start'
@@ -216,9 +219,12 @@ describe('PartiesModel', () => {
             model.run = jest.fn(() => Promise.resolve());
 
             const message = {
-                party: {
-                    Iam: 'the-body'
-                }
+                body: {
+                    party: {
+                        Iam: 'the-body'
+                    }
+                },
+                headers: {}
             };
 
             const onRequestActionPromise = new Promise((resolve, reject) => {