propro-utils 1.5.30 → 1.5.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/middlewares/access_token.js +3 -2
  2. package/middlewares/account_info.js +50 -10
  3. package/package.json +1 -1
  4. package/src/index.js +9 -2
  5. package/src/server/index.js +8 -6
  6. package/utils/serviceManager.js +49 -0
  7. package/coverage/clover.xml +0 -212
  8. package/coverage/coverage-final.json +0 -8
  9. package/coverage/lcov-report/base.css +0 -224
  10. package/coverage/lcov-report/block-navigation.js +0 -87
  11. package/coverage/lcov-report/favicon.png +0 -0
  12. package/coverage/lcov-report/index.html +0 -161
  13. package/coverage/lcov-report/middlewares/access_token.js.html +0 -343
  14. package/coverage/lcov-report/middlewares/account_info.js.html +0 -334
  15. package/coverage/lcov-report/middlewares/index.html +0 -131
  16. package/coverage/lcov-report/prettify.css +0 -1
  17. package/coverage/lcov-report/prettify.js +0 -2
  18. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  19. package/coverage/lcov-report/sorter.js +0 -196
  20. package/coverage/lcov-report/src/server/index.html +0 -116
  21. package/coverage/lcov-report/src/server/index.js.html +0 -664
  22. package/coverage/lcov-report/src/server/middleware/index.html +0 -131
  23. package/coverage/lcov-report/src/server/middleware/validateEnv.js.html +0 -139
  24. package/coverage/lcov-report/src/server/middleware/verifyToken.js.html +0 -604
  25. package/coverage/lcov-report/utils/index.html +0 -131
  26. package/coverage/lcov-report/utils/redis.js.html +0 -133
  27. package/coverage/lcov-report/utils/testUtils.js.html +0 -172
  28. package/coverage/lcov-report/verifyToken.js.html +0 -589
  29. package/coverage/lcov.info +0 -361
package/coverage/lcov-report/middlewares/access_token.js.html DELETED
@@ -1,343 +0,0 @@
1
-
2
- <!doctype html>
3
- <html lang="en">
4
-
5
- <head>
6
- <title>Code coverage report for middlewares/access_token.js</title>
7
- <meta charset="utf-8" />
8
- <link rel="stylesheet" href="../prettify.css" />
9
- <link rel="stylesheet" href="../base.css" />
10
- <link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
11
- <meta name="viewport" content="width=device-width, initial-scale=1" />
12
- <style type='text/css'>
13
- .coverage-summary .sorter {
14
- background-image: url(../sort-arrow-sprite.png);
15
- }
16
- </style>
17
- </head>
18
-
19
- <body>
20
- <div class='wrapper'>
21
- <div class='pad1'>
22
- <h1><a href="../index.html">All files</a> / <a href="index.html">middlewares</a> access_token.js</h1>
23
- <div class='clearfix'>
24
-
25
- <div class='fl pad1y space-right2'>
26
- <span class="strong">22.22% </span>
27
- <span class="quiet">Statements</span>
28
- <span class='fraction'>6/27</span>
29
- </div>
30
-
31
-
32
- <div class='fl pad1y space-right2'>
33
- <span class="strong">0% </span>
34
- <span class="quiet">Branches</span>
35
- <span class='fraction'>0/13</span>
36
- </div>
37
-
38
-
39
- <div class='fl pad1y space-right2'>
40
- <span class="strong">0% </span>
41
- <span class="quiet">Functions</span>
42
- <span class='fraction'>0/3</span>
43
- </div>
44
-
45
-
46
- <div class='fl pad1y space-right2'>
47
- <span class="strong">22.22% </span>
48
- <span class="quiet">Lines</span>
49
- <span class='fraction'>6/27</span>
50
- </div>
51
-
52
-
53
- </div>
54
- <p class="quiet">
55
- Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
- </p>
57
- <template id="filterTemplate">
58
- <div class="quiet">
59
- Filter:
60
- <input type="search" id="fileSearch">
61
- </div>
62
- </template>
63
- </div>
64
- <div class='status-line low'></div>
65
- <pre><table class="coverage">
66
- <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
- <a name='L2'></a><a href='#L2'>2</a>
68
- <a name='L3'></a><a href='#L3'>3</a>
69
- <a name='L4'></a><a href='#L4'>4</a>
70
- <a name='L5'></a><a href='#L5'>5</a>
71
- <a name='L6'></a><a href='#L6'>6</a>
72
- <a name='L7'></a><a href='#L7'>7</a>
73
- <a name='L8'></a><a href='#L8'>8</a>
74
- <a name='L9'></a><a href='#L9'>9</a>
75
- <a name='L10'></a><a href='#L10'>10</a>
76
- <a name='L11'></a><a href='#L11'>11</a>
77
- <a name='L12'></a><a href='#L12'>12</a>
78
- <a name='L13'></a><a href='#L13'>13</a>
79
- <a name='L14'></a><a href='#L14'>14</a>
80
- <a name='L15'></a><a href='#L15'>15</a>
81
- <a name='L16'></a><a href='#L16'>16</a>
82
- <a name='L17'></a><a href='#L17'>17</a>
83
- <a name='L18'></a><a href='#L18'>18</a>
84
- <a name='L19'></a><a href='#L19'>19</a>
85
- <a name='L20'></a><a href='#L20'>20</a>
86
- <a name='L21'></a><a href='#L21'>21</a>
87
- <a name='L22'></a><a href='#L22'>22</a>
88
- <a name='L23'></a><a href='#L23'>23</a>
89
- <a name='L24'></a><a href='#L24'>24</a>
90
- <a name='L25'></a><a href='#L25'>25</a>
91
- <a name='L26'></a><a href='#L26'>26</a>
92
- <a name='L27'></a><a href='#L27'>27</a>
93
- <a name='L28'></a><a href='#L28'>28</a>
94
- <a name='L29'></a><a href='#L29'>29</a>
95
- <a name='L30'></a><a href='#L30'>30</a>
96
- <a name='L31'></a><a href='#L31'>31</a>
97
- <a name='L32'></a><a href='#L32'>32</a>
98
- <a name='L33'></a><a href='#L33'>33</a>
99
- <a name='L34'></a><a href='#L34'>34</a>
100
- <a name='L35'></a><a href='#L35'>35</a>
101
- <a name='L36'></a><a href='#L36'>36</a>
102
- <a name='L37'></a><a href='#L37'>37</a>
103
- <a name='L38'></a><a href='#L38'>38</a>
104
- <a name='L39'></a><a href='#L39'>39</a>
105
- <a name='L40'></a><a href='#L40'>40</a>
106
- <a name='L41'></a><a href='#L41'>41</a>
107
- <a name='L42'></a><a href='#L42'>42</a>
108
- <a name='L43'></a><a href='#L43'>43</a>
109
- <a name='L44'></a><a href='#L44'>44</a>
110
- <a name='L45'></a><a href='#L45'>45</a>
111
- <a name='L46'></a><a href='#L46'>46</a>
112
- <a name='L47'></a><a href='#L47'>47</a>
113
- <a name='L48'></a><a href='#L48'>48</a>
114
- <a name='L49'></a><a href='#L49'>49</a>
115
- <a name='L50'></a><a href='#L50'>50</a>
116
- <a name='L51'></a><a href='#L51'>51</a>
117
- <a name='L52'></a><a href='#L52'>52</a>
118
- <a name='L53'></a><a href='#L53'>53</a>
119
- <a name='L54'></a><a href='#L54'>54</a>
120
- <a name='L55'></a><a href='#L55'>55</a>
121
- <a name='L56'></a><a href='#L56'>56</a>
122
- <a name='L57'></a><a href='#L57'>57</a>
123
- <a name='L58'></a><a href='#L58'>58</a>
124
- <a name='L59'></a><a href='#L59'>59</a>
125
- <a name='L60'></a><a href='#L60'>60</a>
126
- <a name='L61'></a><a href='#L61'>61</a>
127
- <a name='L62'></a><a href='#L62'>62</a>
128
- <a name='L63'></a><a href='#L63'>63</a>
129
- <a name='L64'></a><a href='#L64'>64</a>
130
- <a name='L65'></a><a href='#L65'>65</a>
131
- <a name='L66'></a><a href='#L66'>66</a>
132
- <a name='L67'></a><a href='#L67'>67</a>
133
- <a name='L68'></a><a href='#L68'>68</a>
134
- <a name='L69'></a><a href='#L69'>69</a>
135
- <a name='L70'></a><a href='#L70'>70</a>
136
- <a name='L71'></a><a href='#L71'>71</a>
137
- <a name='L72'></a><a href='#L72'>72</a>
138
- <a name='L73'></a><a href='#L73'>73</a>
139
- <a name='L74'></a><a href='#L74'>74</a>
140
- <a name='L75'></a><a href='#L75'>75</a>
141
- <a name='L76'></a><a href='#L76'>76</a>
142
- <a name='L77'></a><a href='#L77'>77</a>
143
- <a name='L78'></a><a href='#L78'>78</a>
144
- <a name='L79'></a><a href='#L79'>79</a>
145
- <a name='L80'></a><a href='#L80'>80</a>
146
- <a name='L81'></a><a href='#L81'>81</a>
147
- <a name='L82'></a><a href='#L82'>82</a>
148
- <a name='L83'></a><a href='#L83'>83</a>
149
- <a name='L84'></a><a href='#L84'>84</a>
150
- <a name='L85'></a><a href='#L85'>85</a>
151
- <a name='L86'></a><a href='#L86'>86</a>
152
- <a name='L87'></a><a href='#L87'>87</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
153
- <span class="cline-any cline-yes">1x</span>
154
- <span class="cline-any cline-yes">1x</span>
155
- <span class="cline-any cline-yes">1x</span>
156
- <span class="cline-any cline-neutral">&nbsp;</span>
157
- <span class="cline-any cline-neutral">&nbsp;</span>
158
- <span class="cline-any cline-neutral">&nbsp;</span>
159
- <span class="cline-any cline-neutral">&nbsp;</span>
160
- <span class="cline-any cline-neutral">&nbsp;</span>
161
- <span class="cline-any cline-neutral">&nbsp;</span>
162
- <span class="cline-any cline-neutral">&nbsp;</span>
163
- <span class="cline-any cline-neutral">&nbsp;</span>
164
- <span class="cline-any cline-neutral">&nbsp;</span>
165
- <span class="cline-any cline-neutral">&nbsp;</span>
166
- <span class="cline-any cline-neutral">&nbsp;</span>
167
- <span class="cline-any cline-neutral">&nbsp;</span>
168
- <span class="cline-any cline-neutral">&nbsp;</span>
169
- <span class="cline-any cline-neutral">&nbsp;</span>
170
- <span class="cline-any cline-neutral">&nbsp;</span>
171
- <span class="cline-any cline-neutral">&nbsp;</span>
172
- <span class="cline-any cline-neutral">&nbsp;</span>
173
- <span class="cline-any cline-neutral">&nbsp;</span>
174
- <span class="cline-any cline-neutral">&nbsp;</span>
175
- <span class="cline-any cline-neutral">&nbsp;</span>
176
- <span class="cline-any cline-neutral">&nbsp;</span>
177
- <span class="cline-any cline-neutral">&nbsp;</span>
178
- <span class="cline-any cline-neutral">&nbsp;</span>
179
- <span class="cline-any cline-neutral">&nbsp;</span>
180
- <span class="cline-any cline-neutral">&nbsp;</span>
181
- <span class="cline-any cline-neutral">&nbsp;</span>
182
- <span class="cline-any cline-neutral">&nbsp;</span>
183
- <span class="cline-any cline-neutral">&nbsp;</span>
184
- <span class="cline-any cline-neutral">&nbsp;</span>
185
- <span class="cline-any cline-neutral">&nbsp;</span>
186
- <span class="cline-any cline-neutral">&nbsp;</span>
187
- <span class="cline-any cline-yes">1x</span>
188
- <span class="cline-any cline-no">&nbsp;</span>
189
- <span class="cline-any cline-no">&nbsp;</span>
190
- <span class="cline-any cline-neutral">&nbsp;</span>
191
- <span class="cline-any cline-no">&nbsp;</span>
192
- <span class="cline-any cline-neutral">&nbsp;</span>
193
- <span class="cline-any cline-neutral">&nbsp;</span>
194
- <span class="cline-any cline-no">&nbsp;</span>
195
- <span class="cline-any cline-no">&nbsp;</span>
196
- <span class="cline-any cline-neutral">&nbsp;</span>
197
- <span class="cline-any cline-neutral">&nbsp;</span>
198
- <span class="cline-any cline-no">&nbsp;</span>
199
- <span class="cline-any cline-no">&nbsp;</span>
200
- <span class="cline-any cline-neutral">&nbsp;</span>
201
- <span class="cline-any cline-neutral">&nbsp;</span>
202
- <span class="cline-any cline-neutral">&nbsp;</span>
203
- <span class="cline-any cline-neutral">&nbsp;</span>
204
- <span class="cline-any cline-neutral">&nbsp;</span>
205
- <span class="cline-any cline-neutral">&nbsp;</span>
206
- <span class="cline-any cline-no">&nbsp;</span>
207
- <span class="cline-any cline-neutral">&nbsp;</span>
208
- <span class="cline-any cline-no">&nbsp;</span>
209
- <span class="cline-any cline-no">&nbsp;</span>
210
- <span class="cline-any cline-neutral">&nbsp;</span>
211
- <span class="cline-any cline-neutral">&nbsp;</span>
212
- <span class="cline-any cline-neutral">&nbsp;</span>
213
- <span class="cline-any cline-neutral">&nbsp;</span>
214
- <span class="cline-any cline-neutral">&nbsp;</span>
215
- <span class="cline-any cline-neutral">&nbsp;</span>
216
- <span class="cline-any cline-no">&nbsp;</span>
217
- <span class="cline-any cline-no">&nbsp;</span>
218
- <span class="cline-any cline-neutral">&nbsp;</span>
219
- <span class="cline-any cline-neutral">&nbsp;</span>
220
- <span class="cline-any cline-no">&nbsp;</span>
221
- <span class="cline-any cline-neutral">&nbsp;</span>
222
- <span class="cline-any cline-no">&nbsp;</span>
223
- <span class="cline-any cline-no">&nbsp;</span>
224
- <span class="cline-any cline-no">&nbsp;</span>
225
- <span class="cline-any cline-neutral">&nbsp;</span>
226
- <span class="cline-any cline-no">&nbsp;</span>
227
- <span class="cline-any cline-no">&nbsp;</span>
228
- <span class="cline-any cline-neutral">&nbsp;</span>
229
- <span class="cline-any cline-no">&nbsp;</span>
230
- <span class="cline-any cline-no">&nbsp;</span>
231
- <span class="cline-any cline-neutral">&nbsp;</span>
232
- <span class="cline-any cline-no">&nbsp;</span>
233
- <span class="cline-any cline-neutral">&nbsp;</span>
234
- <span class="cline-any cline-neutral">&nbsp;</span>
235
- <span class="cline-any cline-neutral">&nbsp;</span>
236
- <span class="cline-any cline-neutral">&nbsp;</span>
237
- <span class="cline-any cline-yes">1x</span>
238
- <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">require('dotenv').config();
239
- const axios = require('axios');
240
- const {getOrSetCache} = require('../utils/redis');
241
- const {checkIfUserExists} = require('./account_info');
242
- &nbsp;
243
- /**
244
- * Middleware for authenticating and authorizing API requests.
245
- * It validates an access token and checks for required permissions using both a Redis cache
246
- * and propro authentication service.
247
- *
248
- * @param {object} redisClient - The Redis client used for caching permission data.
249
- * @param {Schema} userSchema - The user schema/model object.
250
- * @param {string[]} [requiredPermissions=[]] - An array of permissions required to access the endpoint.
251
- * This function first attempts to retrieve the account's permissions from the cache.
252
- * If the cache is empty or expired, it fetches permissions from propro authentication service
253
- * and updates the cache. If the access token is invalid or does not grant the required permissions,
254
- * the request is rejected.
255
- *
256
- * @returns {function} A middleware function that takes Express.js request (req), response (res),
257
- * and next function parameters. The middleware validates the access token and permissions.
258
- * If validation is successful, it adds the account ID and req.user to the request object (req.account) and
259
- * calls `next()` to pass control to the next middleware. If validation fails, it responds with
260
- * an error message and a 403 status code.
261
- *
262
- * Usage of the middleware requires an environment variable `AUTH_URL` to be set, pointing to the
263
- * authentication service's URL. The function leverages async/await for asynchronous operations
264
- * and tries to handle errors gracefully, reporting them through the next middleware in the chain.
265
- *
266
- * @example
267
- * // Applying authValidation middleware
268
- * const redisClient = require('./redisClient');
269
- * app.use('/api/protected-route', authValidation(redisClient, ['admin', 'user']), (req, res) =&gt; {
270
- * res.json({ message: 'You have access to protected data' });
271
- * });
272
- */
273
- const authValidation = <span class="fstat-no" title="function not covered" >(r</span>edisClient, userSchema, requiredPermissions = <span class="branch-0 cbranch-no" title="branch not covered" >[])</span> =&gt; {
274
- <span class="cstat-no" title="statement not covered" > return <span class="fstat-no" title="function not covered" >as</span>ync (req, res, next) =&gt; {</span>
275
- <span class="cstat-no" title="statement not covered" > try {</span>
276
- const accessToken =
277
- <span class="cstat-no" title="statement not covered" > req.cookies['x-access-token'] ||</span>
278
- req.headers.authorization?.split(' ')[1];
279
- &nbsp;
280
- <span class="cstat-no" title="statement not covered" > if (!accessToken) {</span>
281
- <span class="cstat-no" title="statement not covered" > return res.status(403).json({error: 'Access token is required'});</span>
282
- }
283
- &nbsp;
284
- const fetchPermission = <span class="cstat-no" title="statement not covered" ><span class="fstat-no" title="function not covered" >as</span>ync () =&gt; {</span>
285
- const response = <span class="cstat-no" title="statement not covered" >await axios.post(</span>
286
- `${process.env.AUTH_URL}/api/v1/auth/validateToken`,
287
- {
288
- accessToken: accessToken,
289
- requiredPermissions: requiredPermissions,
290
- }
291
- );
292
- <span class="cstat-no" title="statement not covered" > return response.data;</span>
293
- };
294
- const cacheKey = <span class="cstat-no" title="statement not covered" >`account:permissions:${accessToken}`;</span>
295
- const {accountId, validPermissions} = <span class="cstat-no" title="statement not covered" >await getOrSetCache(</span>
296
- redisClient,
297
- cacheKey,
298
- fetchPermission,
299
- 1800
300
- );
301
- &nbsp;
302
- <span class="cstat-no" title="statement not covered" > if (!validPermissions) {</span>
303
- <span class="cstat-no" title="statement not covered" > return res.status(403).json({error: 'Invalid permissions'});</span>
304
- }
305
- &nbsp;
306
- <span class="cstat-no" title="statement not covered" > req.account = accountId;</span>
307
- &nbsp;
308
- const user = <span class="cstat-no" title="statement not covered" >await checkIfUserExists(userSchema, accountId);</span>
309
- <span class="cstat-no" title="statement not covered" > if (!user) {</span>
310
- <span class="cstat-no" title="statement not covered" > return res.status(403).json({error: 'User not found'});</span>
311
- }
312
- <span class="cstat-no" title="statement not covered" > req.user = user.id;</span>
313
- <span class="cstat-no" title="statement not covered" > next();</span>
314
- } catch (error) {
315
- <span class="cstat-no" title="statement not covered" > if (error.response &amp;&amp; error.response.status) {</span>
316
- <span class="cstat-no" title="statement not covered" > next(new Error(error.response.data.message));</span>
317
- }
318
- <span class="cstat-no" title="statement not covered" > next(new Error('Error validating token'));</span>
319
- }
320
- };
321
- };
322
- &nbsp;
323
- module.exports = authValidation;
324
- &nbsp;</pre></td></tr></table></pre>
325
-
326
- <div class='push'></div><!-- for sticky footer -->
327
- </div><!-- /wrapper -->
328
- <div class='footer quiet pad2 space-top1 center small'>
329
- Code coverage generated by
330
- <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
331
- at 2024-03-01T12:35:02.022Z
332
- </div>
333
- <script src="../prettify.js"></script>
334
- <script>
335
- window.onload = function () {
336
- prettyPrint();
337
- };
338
- </script>
339
- <script src="../sorter.js"></script>
340
- <script src="../block-navigation.js"></script>
341
- </body>
342
- </html>
343
-