account-lookup-service 15.5.0-iso.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (209) hide show
  1. package/.circleci/config.yml +11 -0
  2. package/.ncurc.yaml +6 -0
  3. package/.nvmrc +1 -0
  4. package/.nycrc.yml +20 -0
  5. package/.versionrc +15 -0
  6. package/CHANGELOG.md +330 -0
  7. package/CODEOWNERS +38 -0
  8. package/Dockerfile +45 -0
  9. package/LICENSE.md +10 -0
  10. package/README.md +252 -0
  11. package/audit-ci.jsonc +32 -0
  12. package/audit-resolve.json +161 -0
  13. package/config/default.json +109 -0
  14. package/config/knexfile.js +21 -0
  15. package/docker/account-lookup-service/default.json +106 -0
  16. package/docker/account-lookup-service/make-default-json.sh +5 -0
  17. package/docker/account-lookup-service/override.json +15 -0
  18. package/docker/central-ledger/default.json +458 -0
  19. package/docker/config-modifier/account-lookup-service.js +31 -0
  20. package/docker/kafka/consumer.properties +26 -0
  21. package/docker/kafka/producer.properties +45 -0
  22. package/docker/kafka/server.properties +143 -0
  23. package/docker/kafka/tools-log4j.properties +21 -0
  24. package/docker/mock-proxy/Dockerfile +15 -0
  25. package/docker/mock-proxy/package-lock.json +4986 -0
  26. package/docker/mock-proxy/package.json +24 -0
  27. package/docker/mock-proxy/src/config.ts +14 -0
  28. package/docker/mock-proxy/src/server.ts +94 -0
  29. package/docker/mock-proxy/src/utils.ts +29 -0
  30. package/docker/mock-proxy/tsconfig.json +24 -0
  31. package/docker/sql-init/01_permissions.sql +2 -0
  32. package/docker/sql-init-central-ledger/01_permissions.sql +2 -0
  33. package/docker/wait-for/wait-for-account-lookup-service.sh +10 -0
  34. package/docker/wait-for/wait-for-central-ledger.sh +11 -0
  35. package/docker/wait-for/wait-for-kafka.sh +7 -0
  36. package/docker/wait-for/wait-for-ml-api-adapter.sh +9 -0
  37. package/docker/wait-for/wait-for-mockserver.sh +20 -0
  38. package/docker/wait-for/wait-for-mysql-als.sh +14 -0
  39. package/docker/wait-for/wait-for-mysql-central-ledger.sh +11 -0
  40. package/docker/wait-for/wait-for-mysql.sh +11 -0
  41. package/docker/wait-for/wait-for-objstore.sh +12 -0
  42. package/docker/wait-for/wait-for.env +18 -0
  43. package/docker/wait-for/wait-for.sh +81 -0
  44. package/docker-compose.integration.yml +29 -0
  45. package/docker-compose.yml +243 -0
  46. package/jest-int.config.js +8 -0
  47. package/jest.config.js +16 -0
  48. package/jsdoc.json +38 -0
  49. package/migrations/01_currency.js +42 -0
  50. package/migrations/02_endpointType.js +43 -0
  51. package/migrations/03_endpointType-indexes.js +37 -0
  52. package/migrations/04_partyIdType.js +43 -0
  53. package/migrations/05_partyIdType-indexes.js +38 -0
  54. package/migrations/08_oracleEndpoint.js +51 -0
  55. package/migrations/09_oracleEndpoint-indexes.js +41 -0
  56. package/migrations/10_oracleEndpoint-remove-constraints.js +38 -0
  57. package/package.json +180 -0
  58. package/scripts/_wait4_all.js +143 -0
  59. package/scripts/test-functional.sh +76 -0
  60. package/secrets/jwsSigningKey.key +27 -0
  61. package/seeds/currency.js +765 -0
  62. package/seeds/endpointType.js +65 -0
  63. package/seeds/partyIdType.js +79 -0
  64. package/src/api/endpointcache.js +67 -0
  65. package/src/api/health.js +66 -0
  66. package/src/api/index.js +85 -0
  67. package/src/api/oracles/{ID}.js +100 -0
  68. package/src/api/oracles.js +96 -0
  69. package/src/api/participants/{ID}/error.js +44 -0
  70. package/src/api/participants/{ID}.js +44 -0
  71. package/src/api/participants/{Type}/{ID}/error.js +74 -0
  72. package/src/api/participants/{Type}/{ID}/{SubId}/error.js +68 -0
  73. package/src/api/participants/{Type}/{ID}/{SubId}.js +113 -0
  74. package/src/api/participants/{Type}/{ID}.js +133 -0
  75. package/src/api/participants.js +63 -0
  76. package/src/api/parties/{Type}/{ID}/error.js +66 -0
  77. package/src/api/parties/{Type}/{ID}/{SubId}/error.js +56 -0
  78. package/src/api/parties/{Type}/{ID}/{SubId}.js +77 -0
  79. package/src/api/parties/{Type}/{ID}.js +98 -0
  80. package/src/api/routes.js +294 -0
  81. package/src/constants.js +16 -0
  82. package/src/domain/oracle/index.js +33 -0
  83. package/src/domain/oracle/oracle.js +234 -0
  84. package/src/domain/participants/index.js +35 -0
  85. package/src/domain/participants/participants.js +560 -0
  86. package/src/domain/parties/getPartiesByTypeAndID.js +239 -0
  87. package/src/domain/parties/index.js +32 -0
  88. package/src/domain/parties/parties.js +215 -0
  89. package/src/domain/parties/utils.js +84 -0
  90. package/src/domain/timeout/dto.js +48 -0
  91. package/src/domain/timeout/index.js +104 -0
  92. package/src/handlers/TimeoutHandler.js +94 -0
  93. package/src/handlers/index.js +70 -0
  94. package/src/handlers/monitoring/index.js +51 -0
  95. package/src/handlers/monitoring/plugins/health.js +61 -0
  96. package/src/handlers/monitoring/plugins/metrics.js +48 -0
  97. package/src/handlers/register.js +102 -0
  98. package/src/index.js +66 -0
  99. package/src/interface/admin-swagger.yaml +804 -0
  100. package/src/interface/admin_swagger.json +959 -0
  101. package/src/interface/api-swagger-iso20022-parties.yaml +1734 -0
  102. package/src/interface/api-swagger.yaml +1733 -0
  103. package/src/interface/api_swagger.json +3046 -0
  104. package/src/interface/fspiop-rest-v2.0-ISO20022_parties.yaml +2256 -0
  105. package/src/interface/thirdparty/admin-swagger.yaml +808 -0
  106. package/src/interface/thirdparty/admin_swagger.json +961 -0
  107. package/src/interface/thirdparty/api-swagger.yaml +1739 -0
  108. package/src/interface/thirdparty/api_swagger.json +3142 -0
  109. package/src/lib/argv.js +39 -0
  110. package/src/lib/cache.js +126 -0
  111. package/src/lib/config.js +183 -0
  112. package/src/lib/db.js +26 -0
  113. package/src/lib/headers.js +53 -0
  114. package/src/lib/healthCheck/subServiceHealth.js +84 -0
  115. package/src/lib/index.js +11 -0
  116. package/src/lib/migrator.js +17 -0
  117. package/src/lib/requestLogger.js +54 -0
  118. package/src/lib/util.js +66 -0
  119. package/src/metrics/handler.js +33 -0
  120. package/src/metrics/plugin.js +52 -0
  121. package/src/metrics/routes.js +43 -0
  122. package/src/models/currency/currency.js +48 -0
  123. package/src/models/currency/index.js +32 -0
  124. package/src/models/endpointType/endpointType.js +48 -0
  125. package/src/models/endpointType/index.js +32 -0
  126. package/src/models/misc/migrationLock.js +49 -0
  127. package/src/models/oracle/facade.js +341 -0
  128. package/src/models/oracle/index.js +41 -0
  129. package/src/models/oracle/oracleEndpoint.js +192 -0
  130. package/src/models/oracle/oracleEndpointCached.js +108 -0
  131. package/src/models/participantEndpoint/facade.js +238 -0
  132. package/src/models/partyIdType/index.js +32 -0
  133. package/src/models/partyIdType/partyIdType.js +41 -0
  134. package/src/plugins.js +139 -0
  135. package/src/server.js +199 -0
  136. package/test/fixtures/index.js +131 -0
  137. package/test/fixtures/iso.js +110 -0
  138. package/test/integration/.env +8 -0
  139. package/test/integration/api/parties.test.js +137 -0
  140. package/test/integration/constants.js +20 -0
  141. package/test/integration/domain/oracle/index.test.js +324 -0
  142. package/test/integration/domain/timeout/index.test.js +75 -0
  143. package/test/integration/env.sh +15 -0
  144. package/test/integration/example.test.js +12 -0
  145. package/test/integration/models/currency/currency.test.js +68 -0
  146. package/test/integration/plugins.test.js +62 -0
  147. package/test/integration/prepareTestParticipants.js +30 -0
  148. package/test/integration/setup.js +5 -0
  149. package/test/integration-config.json +81 -0
  150. package/test/integration-runner.sh +108 -0
  151. package/test/unit/api/health.test.js +142 -0
  152. package/test/unit/api/oracles/{ID}.test.js +264 -0
  153. package/test/unit/api/oracles.test.js +173 -0
  154. package/test/unit/api/participants/participants.test.js +117 -0
  155. package/test/unit/api/participants/{Type}/{ID}/error.test.js +155 -0
  156. package/test/unit/api/participants/{Type}/{ID}/{SubId}/error.test.js +131 -0
  157. package/test/unit/api/participants/{Type}/{ID}/{SubId}.test.js +377 -0
  158. package/test/unit/api/participants/{Type}/{ID}.test.js +383 -0
  159. package/test/unit/api/participants.test.js +108 -0
  160. package/test/unit/api/parties/endpointcache.test.js +83 -0
  161. package/test/unit/api/parties/parties.test.js +102 -0
  162. package/test/unit/api/parties/{Type}/{ID}/error.test.js +145 -0
  163. package/test/unit/api/parties/{Type}/{ID}/{SubId}/error.test.js +141 -0
  164. package/test/unit/api/parties/{Type}/{ID}/{SubId}.test.js +241 -0
  165. package/test/unit/api/parties/{Type}/{ID}.test.js +240 -0
  166. package/test/unit/domain/oracle/oracle.test.js +505 -0
  167. package/test/unit/domain/participants/participants.test.js +1724 -0
  168. package/test/unit/domain/parties/parties.test.js +940 -0
  169. package/test/unit/domain/timeout/dto.test.js +28 -0
  170. package/test/unit/domain/timeout/index.test.js +81 -0
  171. package/test/unit/handlers/TimeoutHandler.test.js +125 -0
  172. package/test/unit/handlers/index.test.js +56 -0
  173. package/test/unit/handlers/register.test.js +90 -0
  174. package/test/unit/index.test.js +139 -0
  175. package/test/unit/iso20022/partiesValidation.test.js +129 -0
  176. package/test/unit/lib/TransformFacades.test.js +18 -0
  177. package/test/unit/lib/argv.test.js +40 -0
  178. package/test/unit/lib/cache.test.js +172 -0
  179. package/test/unit/lib/config.test.js +108 -0
  180. package/test/unit/lib/healthCheck/subServiceHealth.test.js +89 -0
  181. package/test/unit/lib/migrator.test.js +52 -0
  182. package/test/unit/lib/requestLogger.test.js +115 -0
  183. package/test/unit/lib/util.test.js +68 -0
  184. package/test/unit/mocks.js +66 -0
  185. package/test/unit/models/currency/currency.test.js +91 -0
  186. package/test/unit/models/endpointType/endpointType.test.js +69 -0
  187. package/test/unit/models/misc/migrationLock.test.js +96 -0
  188. package/test/unit/models/oracle/facade.test.js +546 -0
  189. package/test/unit/models/oracle/oracleEndpoint.test.js +409 -0
  190. package/test/unit/models/oracle/oracleEndpointCached.test.js +153 -0
  191. package/test/unit/models/participantEndpoint/facade.test.js +295 -0
  192. package/test/unit/models/partyIdType/partyIdType.test.js +88 -0
  193. package/test/unit/plugins.test.js +89 -0
  194. package/test/unit/setup.js +7 -0
  195. package/test/util/apiClients/AlsApiClient.js +44 -0
  196. package/test/util/apiClients/BasicApiClient.js +34 -0
  197. package/test/util/apiClients/ProxyApiClient.js +25 -0
  198. package/test/util/apiClients/index.js +7 -0
  199. package/test/util/helper.js +332 -0
  200. package/test/util/index.js +11 -0
  201. package/test/util/mockgen.js +43 -0
  202. package/test/util/onboarding.js +132 -0
  203. package/test/util/scripts/addAlsDb.sh +33 -0
  204. package/test/util/scripts/configureMockServer.sh +35 -0
  205. package/test/util/scripts/env.sh +19 -0
  206. package/test/util/scripts/populateTestData.sh +62 -0
  207. package/test/util/scripts/startMockCentralServer.sh +45 -0
  208. package/test/util/scripts/startMockOracleServer.sh +45 -0
  209. package/test/util/testConfig.js +44 -0
@@ -0,0 +1,240 @@
1
+ /*****
2
+ License
3
+ --------------
4
+ Copyright © 2017 Bill & Melinda Gates Foundation
5
+ 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
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+ 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.
8
+ Contributors
9
+ --------------
10
+ This is the official list of the Mojaloop project contributors for this file.
11
+ Names of the original copyright holders (individuals or organizations)
12
+ should be listed with a '*' in the first column. People who have
13
+ contributed from an organization can be listed under the organization
14
+ that actually holds the copyright for their contributions (see the
15
+ Gates Foundation organization for an example). Those individuals should have
16
+ their names indented and be marked with a '-'. Email address can be added
17
+ optionally within square brackets <email>.
18
+ * Gates Foundation
19
+ - Name Surname <name.surname@gatesfoundation.com>
20
+
21
+ * ModusBox
22
+ - Rajiv Mothilal <rajiv.mothilal@modusbox.com>
23
+
24
+ * Crosslake
25
+ - Lewis Daly <lewisd@crosslaketech.com>
26
+
27
+ --------------
28
+ ******/
29
+
30
+ 'use strict'
31
+
32
+ const Sinon = require('sinon')
33
+ const initServer = require('../../../../../src/server').initializeApi
34
+ const Db = require('../../../../../src/lib/db')
35
+ const parties = require('../../../../../src/domain/parties')
36
+ const participant = require('../../../../../src/models/participantEndpoint/facade')
37
+ const getPort = require('get-port')
38
+ const Helper = require('../../../../util/helper')
39
+ const ErrorHandler = require('@mojaloop/central-services-error-handling')
40
+ const requestUtil = require('@mojaloop/central-services-shared').Util.Request
41
+ const Enums = require('@mojaloop/central-services-shared').Enum
42
+ const oracleEndpointCached = require('../../../../../src/models/oracle/oracleEndpointCached')
43
+ const Logger = require('@mojaloop/central-services-logger')
44
+ const Config = require('../../../../../src/lib/config')
45
+
46
+ Logger.isDebugEnabled = jest.fn(() => true)
47
+ Logger.isErrorEnabled = jest.fn(() => true)
48
+ Logger.isInfoEnabled = jest.fn(() => true)
49
+ let server
50
+ let sandbox
51
+
52
+ describe('/parties', () => {
53
+ beforeAll(async () => {
54
+ sandbox = Sinon.createSandbox()
55
+ sandbox.stub(Db, 'connect').returns(Promise.resolve({}))
56
+ Config.API_PORT = await getPort()
57
+ server = await initServer(Config)
58
+ })
59
+
60
+ afterEach(async () => {
61
+ sandbox.restore()
62
+ })
63
+
64
+ afterAll(async () => {
65
+ await server.stop()
66
+ })
67
+
68
+ it('getPartiesByTypeAndID success', async () => {
69
+ // Arrange
70
+ const mock = await Helper.generateMockRequest('/parties/{Type}/{ID}', 'get')
71
+ const options = {
72
+ method: 'get',
73
+ url: mock.request.path,
74
+ headers: Helper.defaultStandardHeaders('parties')
75
+ }
76
+ sandbox.stub(parties, 'getPartiesByTypeAndID').resolves({})
77
+
78
+ // Act
79
+ const response = await server.inject(options)
80
+
81
+ // Assert
82
+ expect(response.statusCode).toBe(202)
83
+ expect(parties.getPartiesByTypeAndID.callCount).toBe(1)
84
+ expect(parties.getPartiesByTypeAndID.getCall(0).returnValue).resolves.toStrictEqual({})
85
+
86
+ // Cleanup
87
+ parties.getPartiesByTypeAndID.restore()
88
+ })
89
+
90
+ it('getPartiesByTypeAndID failure', async () => {
91
+ // Arrange
92
+ const mock = await Helper.generateMockRequest('/parties/{Type}/{ID}', 'get')
93
+ const options = {
94
+ method: 'get',
95
+ url: mock.request.path,
96
+ headers: Helper.defaultStandardHeaders('parties')
97
+ }
98
+ const throwError = new Error('Unknown error')
99
+ sandbox.stub(parties, 'getPartiesByTypeAndID').rejects(throwError)
100
+
101
+ // Act
102
+ const response = await server.inject(options)
103
+
104
+ // Assert
105
+ expect(response.statusCode).toBe(202)
106
+ expect(parties.getPartiesByTypeAndID.callCount).toBe(1)
107
+ expect(parties.getPartiesByTypeAndID.getCall(0).returnValue).rejects.toStrictEqual(throwError)
108
+
109
+ // Cleanup
110
+ parties.getPartiesByTypeAndID.restore()
111
+ })
112
+
113
+ it('getPartiesByTypeAndID endpoint sends async 3204 to /error for invalid party ID on response with status 400', async () => {
114
+ // Arrange
115
+ const mock = await Helper.generateMockRequest('/parties/{Type}/{ID}', 'get')
116
+
117
+ const headers = Helper.defaultStandardHeaders('parties')
118
+ delete headers['fspiop-destination']
119
+
120
+ const options = {
121
+ method: 'get',
122
+ url: mock.request.path,
123
+ headers
124
+ }
125
+
126
+ const badRequestError = ErrorHandler.Factory.createFSPIOPError(
127
+ ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_COMMUNICATION_ERROR,
128
+ 'Failed to send HTTP request to host',
129
+ {},
130
+ {},
131
+ [{ key: 'status', value: 400 }]
132
+ )
133
+ const stubs = [
134
+ sandbox.stub(participant, 'sendErrorToParticipant').resolves({}),
135
+ sandbox.stub(participant, 'validateParticipant').resolves(true),
136
+ sandbox.stub(oracleEndpointCached, 'getOracleEndpointByType').resolves(['whatever']),
137
+ sandbox.stub(oracleEndpointCached, 'getOracleEndpointByTypeAndCurrency').resolves(['whatever']),
138
+ sandbox.stub(oracleEndpointCached, 'getOracleEndpointByCurrency').resolves(['whatever']),
139
+ sandbox.stub(requestUtil, 'sendRequest').rejects(badRequestError)
140
+ ]
141
+
142
+ // Act
143
+ const response = await server.inject(options)
144
+
145
+ // Assert
146
+ const errorCallStub = stubs[0]
147
+ console.log(errorCallStub.args[0][2].errorInformation)
148
+ expect(errorCallStub.args[0][2].errorInformation.errorCode).toBe('3204')
149
+ expect(errorCallStub.args[0][1]).toBe(Enums.EndPoints.FspEndpointTypes.FSPIOP_CALLBACK_URL_PARTIES_PUT_ERROR)
150
+ expect(response.statusCode).toBe(202)
151
+
152
+ // Cleanup
153
+ stubs.forEach(s => s.restore())
154
+ })
155
+
156
+ // Added error 404 to cover a special case of the Mowali implementation
157
+ // which uses mojaloop/als-oracle-pathfinder and currently returns 404.
158
+ it('getPartiesByTypeAndID endpoint sends async 3201 to /error for invalid party ID on response with status 404', async () => {
159
+ // Arrange
160
+ const mock = await Helper.generateMockRequest('/parties/{Type}/{ID}', 'get')
161
+
162
+ const headers = Helper.defaultStandardHeaders('parties')
163
+ delete headers['fspiop-destination']
164
+
165
+ const options = {
166
+ method: 'get',
167
+ url: mock.request.path,
168
+ headers
169
+ }
170
+
171
+ const badRequestError = ErrorHandler.Factory.createFSPIOPError(
172
+ ErrorHandler.Enums.FSPIOPErrorCodes.DESTINATION_COMMUNICATION_ERROR,
173
+ 'Failed to send HTTP request to host',
174
+ {},
175
+ {},
176
+ [{ key: 'status', value: 404 }]
177
+ )
178
+ const stubs = [
179
+ sandbox.stub(participant, 'sendErrorToParticipant').resolves({}),
180
+ sandbox.stub(participant, 'validateParticipant').resolves(true),
181
+ sandbox.stub(oracleEndpointCached, 'getOracleEndpointByType').resolves(['whatever']),
182
+ sandbox.stub(requestUtil, 'sendRequest').rejects(badRequestError)
183
+ ]
184
+
185
+ // Act
186
+ const response = await server.inject(options)
187
+
188
+ // Assert
189
+ const errorCallStub = stubs[0]
190
+ expect(errorCallStub.args[0][2].errorInformation.errorCode).toBe('3201')
191
+ expect(errorCallStub.args[0][1]).toBe(Enums.EndPoints.FspEndpointTypes.FSPIOP_CALLBACK_URL_PARTIES_PUT_ERROR)
192
+ expect(response.statusCode).toBe(202)
193
+
194
+ // Cleanup
195
+ stubs.forEach(s => s.restore())
196
+ })
197
+
198
+ it('putPartiesByTypeAndID endpoint', async () => {
199
+ // Arrange
200
+ const mock = await Helper.generateMockRequest('/parties/{Type}/{ID}', 'put')
201
+ const options = {
202
+ method: 'put',
203
+ url: mock.request.path,
204
+ headers: Helper.defaultStandardHeaders('parties'),
205
+ payload: mock.request.body
206
+ }
207
+ options.payload.party.personalInfo.complexName.firstName = 'Justin'
208
+ options.payload.party.personalInfo.complexName.middleName = 'middle'
209
+ options.payload.party.personalInfo.complexName.lastName = 'résumé'
210
+ sandbox.stub(parties, 'putPartiesByTypeAndID').resolves({})
211
+
212
+ // Act
213
+ const response = await server.inject(options)
214
+
215
+ // Assert
216
+ expect(response.statusCode).toBe(200)
217
+ })
218
+
219
+ it('putPartiesByTypeAndID endpoint with additional asian (Myanmar) unicode characters', async () => {
220
+ // Arrange
221
+ const mock = await Helper.generateMockRequest('/parties/{Type}/{ID}', 'put')
222
+ const options = {
223
+ method: 'put',
224
+ url: mock.request.path,
225
+ headers: Helper.defaultStandardHeaders('parties'),
226
+ payload: mock.request.body
227
+ }
228
+ options.payload.party.personalInfo.complexName.firstName = 'ကောင်းထက်စံ'
229
+ options.payload.party.personalInfo.complexName.middleName = 'စုရီဒေါ်သန္တာထွန်အောင်စုရီ'
230
+ options.payload.party.personalInfo.complexName.lastName = 'ဒေါ်အိမ့်ဧကရီငြိမ်းချမ်းအောင်'
231
+
232
+ sandbox.stub(parties, 'putPartiesByTypeAndID').resolves({})
233
+
234
+ // Act
235
+ const response = await server.inject(options)
236
+
237
+ // Assert
238
+ expect(response.statusCode).toBe(200)
239
+ })
240
+ })