@mojaloop/sdk-scheme-adapter 11.18.8

package/test/unit/lib/model/common/PersistentStateMachine.test.js

@@ -0,0 +1,179 @@
+/**************************************************************************
+ *  (C) Copyright ModusBox Inc. 2020 - All rights reserved.               *
+ *                                                                        *
+ *  This file is made available under the terms of the license agreement  *
+ *  specified in the corresponding source code repository.                *
+ *                                                                        *
+ *  ORIGINAL AUTHOR:                                                      *
+ *       Paweł Marzec - pawel.marzec@modusbox.com                         *
+ **************************************************************************/
+
+'use strict';
+
+const Cache = jest.createMockFromModule('../../../../../lib/cache');
+
+const PSM = require('../../../../../lib/model').PersistentStateMachine;
+const mockLogger = require('../../../mockLogger');
+describe('PersistentStateMachine', () => {
+    let cache;
+    let data;
+    let smSpec;
+    const key = 'cache-key';
+    
+    const logger = mockLogger({app: 'persistent-state-machine-test'});
+
+    function checkPSMLayout(psm, optData) {
+        expect(psm).toBeTruthy();
+        
+        expect(psm.state).toEqual((optData && optData.currentState) || smSpec.init || 'none');
+
+        expect(psm.context).toEqual({
+            // allow passing optional data, elsewhere use default
+            data: optData || data,
+            cache,
+            key,
+            logger
+        });
+
+        expect(typeof psm.onAfterTransition).toEqual('function');
+        expect(typeof psm.onPendingTransition).toEqual('function');
+        expect(typeof psm.saveToCache).toEqual('function');
+        expect(typeof psm.init).toEqual('function');
+        expect(typeof psm.gogo).toEqual('function');
+        expect(typeof psm.error).toEqual('function');
+    }
+
+    function shouldNotBeExecuted() {
+        throw new Error('test failure enforced: this code should never be executed');
+    }
+
+    beforeEach(async () => {
+        smSpec = {
+            // init: 'start',
+            transitions: [
+                { name: 'init', from: 'none', to: 'start'},
+                { name: 'gogo', from: 'start', to: 'end' },
+                { name: 'error', from: '*', to: 'errored' }
+            ], 
+            methods: {
+                onGogo: async () => {
+                    return new Promise( (resolved) => {
+                        setTimeout((() => resolved(true)), 100);
+                    } );
+                },
+                onError: () => {
+                    // eslint-disable-next-line no-console
+                    console.error('onError');
+                }
+            }
+        };
+
+        // test data
+        data = { the: 'data' };
+        
+        cache = new Cache({
+            host: 'dummycachehost',
+            port: 1234,
+            logger,
+        });
+        // mock cache set & get
+        cache.get = jest.fn(async () => data);
+        cache.set = jest.fn(async () => 'cache set replies');
+
+        await cache.connect();
+    });
+
+    afterEach(async () => {
+        await cache.disconnect();
+    });
+
+    test('module layout', () => {
+        expect(typeof PSM.create).toEqual('function');
+        expect(typeof PSM.loadFromCache).toEqual('function');
+    });
+
+    test('create', async () => {
+        const psm = await PSM.create(data, cache, key, logger, smSpec);
+        checkPSMLayout(psm);
+        expect(psm.state).toEqual('none');
+        await psm.init();
+        expect(psm.state).toEqual('start');
+    });
+
+    describe('onPendingTransition', () => {        
+        it('should throw error if not `error` transition', async () => {
+            const psm = await PSM.create(data, cache, key, logger, smSpec);
+            checkPSMLayout(psm);
+
+            psm.init();
+            expect(() => psm.gogo()).toThrowError('Transition \'gogo\' requested while another transition is in progress');
+            
+        });
+
+        it('should not throw error if `error` transition called when `gogo` is pending', (done) => {
+            PSM.create(data, cache, key, logger, smSpec).then((psm) => {
+                checkPSMLayout(psm);
+    
+                psm.init()
+                    .then(() => {
+                        expect(psm.state).toEqual('start');
+                        psm.gogo();
+                        expect(psm.state).toEqual('end');
+                        return Promise.resolve();
+                    })
+                    .then(() => psm.error())
+                    .then(done)
+                    .catch(shouldNotBeExecuted);
+            });
+        }); 
+    });
+
+    describe('loadFromCache', () => {
+        it('should properly call cache.get, get expected data in `context.data` and setup state of machine', async () => {
+            const dataFromCache = { this_is: 'data from cache', currentState: 'end'};
+            cache.get = jest.fn( async () => dataFromCache);
+            const psm = await PSM.loadFromCache(cache, key, logger, smSpec);
+            checkPSMLayout(psm, dataFromCache);
+
+            // to get value from cache proper key should be used
+            expect(cache.get).toHaveBeenCalledWith(key);
+
+            // check what has been stored in `context.data`
+            expect(psm.context.data).toEqual(dataFromCache);
+
+        });
+
+        it('should throw when received invalid data from `cache.get`', async () => {
+            cache.get = jest.fn( async () => null);
+            try {
+                await PSM.loadFromCache(cache, key, logger, smSpec);
+                shouldNotBeExecuted();
+            } catch (error) {
+                expect(error.message).toEqual(`No cached data found for: ${key}`);
+            }
+        });
+
+        it('should propagate error received from `cache.get`', async () => {
+            cache.get = jest.fn( async () => { throw new Error('error from cache.get'); });
+            expect(() => PSM.loadFromCache(cache, key, logger, smSpec))
+                .rejects.toEqual(new Error('error from cache.get'));
+        });
+    });
+
+    describe('saveToCache', () => {
+
+        it('should rethrow error from cache.set', async () => {
+            
+            // mock to simulate throwing error
+            cache.set = jest.fn(() => { throw new Error('error from cache.set'); });
+            
+            const psm = await PSM.create(data, cache, key, logger, smSpec);
+            checkPSMLayout(psm);
+            await psm.init();
+
+            expect(() => psm.saveToCache())
+                .rejects.toEqual(new Error('error from cache.set'));
+        });
+    });
+
+});

package/test/unit/lib/model/data/authorizationsResponse.json

@@ -0,0 +1,13 @@
+{
+    "type": "otpResponse",
+    "data": {
+        "authenticationInfo": {
+            "authentication": "OTP",
+            "authenticationValue": "12334567"
+        },
+        "responseType": "ENTERED"
+    },
+    "headers": {
+      "fspiop-source": "foo"
+    }
+}

package/test/unit/lib/model/data/bulkQuoteRequest.json

@@ -0,0 +1,27 @@
+{
+  "from": {
+    "displayName": "Steven Oderayi",
+    "idType": "MSISDN",
+    "idValue": "234567890"
+  },
+  "individualQuotes": [
+    {
+      "to": {
+        "fspId": "fake-fsp-id",
+        "idType": "PERSONAL_ID",
+        "idValue": "123456789",
+        "idSubValue": "PASSPORT"
+      },
+      "amountType": "SEND",
+      "currency": "USD",
+      "amount": "100",
+      "transactionType": "TRANSFER",
+      "note": "test payment"
+    }
+  ],
+  "homeTransactionId": "123ABC",
+  "extensions": [
+    { "key": "qkey1", "value": "qvalue1" },
+    { "key": "qkey2", "value": "qvalue2" }
+  ]
+}

package/test/unit/lib/model/data/bulkQuoteResponse.json

@@ -0,0 +1,35 @@
+{
+  "type": "bulkQuoteResponse",
+  "data": {
+    "individualQuoteResults": [
+      {
+        "transferAmount": {
+          "amount": "500",
+          "currency": "USD"
+        },
+        "payeeReceiveAmount": {
+          "amount": "490",
+          "currency": "USD"
+        },
+        "payeeFspFee": {
+          "amount": "5",
+          "currency": "USD"
+        },
+        "payeeFspCommission": {
+          "amount": "5",
+          "currency": "USD"
+        }
+      }
+    ],
+    "geoCode": {
+      "latitude": "53.295971",
+      "longitude": "-0.038500"
+    },
+    "expiration": "2017-11-15T14:17:09.663+01:00",
+    "ilpPacket": "AQAAAAAAACasIWcuc2UubW9iaWxlbW9uZXkubXNpc2RuLjEyMzQ1Njc4OYIEIXsNCiAgICAidHJhbnNhY3Rpb25JZCI6ICI4NWZlYWMyZi0zOWIyLTQ5MWItODE3ZS00YTAzMjAzZDRmMTQiLA0KICAgICJxdW90ZUlkIjogIjdjMjNlODBjLWQwNzgtNDA3Ny04MjYzLTJjMDQ3ODc2ZmNmNiIsDQogICAgInBheWVlIjogew0KICAgICAgICAicGFydHlJZEluZm8iOiB7DQogICAgICAgICAgICAicGFydHlJZFR5cGUiOiAiTVNJU0ROIiwNCiAgICAgICAgICAgICJwYXJ0eUlkZW50aWZpZXIiOiAiMTIzNDU2Nzg5IiwNCiAgICAgICAgICAgICJmc3BJZCI6ICJNb2JpbGVNb25leSINCiAgICAgICAgfSwNCiAgICAgICAgInBlcnNvbmFsSW5mbyI6IHsNCiAgICAgICAgICAgICJjb21wbGV4TmFtZSI6IHsNCiAgICAgICAgICAgICAgICAiZmlyc3ROYW1lIjogIkhlbnJpayIsDQogICAgICAgICAgICAgICAgImxhc3ROYW1lIjogIkthcmxzc29uIg0KICAgICAgICAgICAgfQ0KICAgICAgICB9DQogICAgfSwNCiAgICAicGF5ZXIiOiB7DQogICAgICAgICJwZXJzb25hbEluZm8iOiB7DQogICAgICAgICAgICAiY29tcGxleE5hbWUiOiB7DQogICAgICAgICAgICAgICAgImZpcnN0TmFtZSI6ICJNYXRzIiwNCiAgICAgICAgICAgICAgICAibGFzdE5hbWUiOiAiSGFnbWFuIg0KICAgICAgICAgICAgfQ0KICAgICAgICB9LA0KICAgICAgICAicGFydHlJZEluZm8iOiB7DQogICAgICAgICAgICAicGFydHlJZFR5cGUiOiAiSUJBTiIsDQogICAgICAgICAgICAicGFydHlJZGVudGlmaWVyIjogIlNFNDU1MDAwMDAwMDA1ODM5ODI1NzQ2NiIsDQogICAgICAgICAgICAiZnNwSWQiOiAiQmFua05yT25lIg0KICAgICAgICB9DQogICAgfSwNCiAgICAiYW1vdW50Ijogew0KICAgICAgICAiYW1vdW50IjogIjEwMCIsDQogICAgICAgICJjdXJyZW5jeSI6ICJVU0QiDQogICAgfSwNCiAgICAidHJhbnNhY3Rpb25UeXBlIjogew0KICAgICAgICAic2NlbmFyaW8iOiAiVFJBTlNGRVIiLA0KICAgICAgICAiaW5pdGlhdG9yIjogIlBBWUVSIiwNCiAgICAgICAgImluaXRpYXRvclR5cGUiOiAiQ09OU1VNRVIiDQogICAgfSwNCiAgICAibm90ZSI6ICJGcm9tIE1hdHMiDQp9DQo\u003d\u003d",
+    "condition": "fH9pAYDQbmoZLPbvv3CSW2RfjU4jvM4ApG_fqGnR7Xs"
+  },
+  "headers": {
+    "fspiop-source": "foo"
+  }
+}

package/test/unit/lib/model/data/bulkTransferFulfil.json

@@ -0,0 +1,13 @@
+{
+  "type": "bulkTransferFulfil",
+  "data": {
+    "individualTransferResults": [
+      {
+        "transferId": "fake-transfer-id",
+        "fulfilment": "87mm1-reS3SAi8oIWXgBkLmgWc1MkZ_yLbFDX5XAdo5o"
+      }
+    ],
+    "completedTimestamp": "2017-11-15T14:16:09.663+01:00",
+    "bulkTransferState": "COMMITTED"
+  }
+}

package/test/unit/lib/model/data/bulkTransferRequest.json

@@ -0,0 +1,29 @@
+{
+  "from": {
+    "displayName": "James Bush",
+    "idType": "MSISDN",
+    "idValue": "447710066017"
+  },
+  "payeeFsp": {
+    "fspId": "fake-payeefsp-id"
+  },
+  "homeTransactionId": "123ABC",
+  "individualTransfers": [
+    {
+      "to": {
+        "idType": "PERSONAL_ID",
+        "idValue": "123456789",
+        "idSubValue": "PASSPORT"
+      },
+      "amountType": "SEND",
+      "currency": "USD",
+      "amount": "100",
+      "transactionType": "TRANSFER",
+      "note": "test payment"
+    }
+  ],
+  "extensions": [
+    { "key": "tkey1", "value": "tvalue1" },
+    { "key": "tkey2", "value": "tvalue2" }
+  ]
+}

package/test/unit/lib/model/data/defaultConfig.json

@@ -0,0 +1,47 @@
+{
+  "tls": {
+    "enabled": false,
+    "creds": {
+      "ca": null,
+      "cert": null,
+      "key": null
+    }
+  },
+  "inboundServerPort": 4000,
+  "outboundServerPort": 4001,
+  "peerEndpoint": "172.17.0.2:3001",
+  "backendEndpoint": "172.17.0.2:3001",
+  "alsEndpoint": "127.0.0.1:6500",
+  "dfspId": "mojaloop-sdk",
+  "ilpSecret": "mojaloop-sdk",
+  "checkIlp": true,
+  "expirySeconds": 60,
+  "requestProcessingTimeoutSeconds": 3,
+  "autoAcceptQuotes": true,
+  "autoAcceptParty": true,
+  "useQuoteSourceFSPAsTransferPayeeFSP": false,
+  "validateInboundJws": true,
+  "validateInboundPutPartiesJws": false,
+  "jwsSign": true,
+  "jwsSignPutParties": false,
+  "jwsSigningKey": "/jwsSigningKey.key",
+  "jwsVerificationKeysDirectory": null,
+  "cacheConfig": {
+    "host": "localhost",
+    "port": 6379
+  },
+  "enableTestFeatures": false,
+  "oauthTestServer": {
+    "enabled": false,
+    "listenPort": 6000
+  },
+  "wso2": {
+      "auth": {
+        "refreshSeconds": 3600
+      }
+  },
+  "rejectExpiredQuoteResponses": false,
+  "rejectExpiredTransferFulfils": false,
+  "rejectTransfersOnExpiredQuotes": false,
+  "logIndent": 2
+}

package/test/unit/lib/model/data/getBulkTransfersBackendResponse.json

@@ -0,0 +1,42 @@
+{
+  "homeTransactionId": "home-tx-001",
+  "from": {
+    "displayName": "John Doe",
+    "idType": "MSISDN",
+    "idValue": "123456789"
+  },
+  "internalRequest": {
+    "individualTransfers": [
+      {
+        "transferId": "fake-transfer-id",
+        "to": {
+          "idType": "PERSONAL_ID",
+          "idValue": "987654321",
+          "idSubValue": "PASSPORT",
+          "fspId": "mojaloop-sdk"
+        },
+        "amount": "100",
+        "currency": "USD",
+        "amountType": "SEND",
+        "transactionType": {
+          "initiator": "PAYER",
+          "initiatorType": "CONSUMER",
+          "scenario": "TRANSFER"
+        }
+      }
+    ]
+  },
+  "bulkTransferState": "COMMITTED",
+  "timestamp": "2019-11-15T14:16:09.663",
+  "note": "test payment",
+  "extensions": [
+    {
+      "key": "treskey1",
+      "value": "tresvalue1"
+    },
+    {
+      "key": "treskey2",
+      "value": "tresvalue2"
+    }
+  ]
+}

package/test/unit/lib/model/data/getBulkTransfersMojaloopResponse.json

@@ -0,0 +1,22 @@
+{
+  "completedTimestamp": "2019-11-15T14:16:09.663",
+  "extensionList": {
+    "extension": [
+      {
+        "key": "treskey1",
+        "value": "tresvalue1"
+      },
+      {
+        "key": "treskey2",
+        "value": "tresvalue2"
+      }
+    ]
+  },
+  "bulkTransferState": "COMMITTED",
+  "individualTransferResults": [
+      {
+        "transferId": "fake-transfer-id",
+        "fulfilment": "mockGeneratedFulfilment"
+      }
+  ]
+}

package/test/unit/lib/model/data/getTransfersBackendResponse.json

@@ -0,0 +1,34 @@
+{
+  "homeTransactionId": "home-tx-001",
+  "amount": "100",
+  "currency": "USD",
+  "amountType": "SEND",
+  "extensions": [
+    {
+      "key": "treskey1",
+      "value": "tresvalue1"
+    },
+    {
+      "key": "treskey2",
+      "value": "tresvalue2"
+    }
+  ],
+  "note": "test payment",
+  "from": {
+    "displayName": "John Doe",
+    "idType": "MSISDN",
+    "idValue": "123456789"
+  },
+  "to": {
+    "idType": "PERSONAL_ID",
+    "idValue": "987654321",
+    "idSubValue": "PASSPORT"
+  },
+  "transactionType": {
+    "initiator": "PAYER",
+    "initiatorType": "CONSUMER",
+    "scenario": "TRANSFER"
+  },
+  "transferState": "COMMITTED",
+  "timestamp": "2019-11-15T14:16:09.663"
+}