@app-connect/core 1.7.25 → 1.7.26

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 (137) hide show
  1. package/.env.test +5 -5
  2. package/README.md +441 -441
  3. package/connector/developerPortal.js +31 -31
  4. package/connector/mock.js +84 -77
  5. package/connector/proxy/engine.js +164 -164
  6. package/connector/proxy/index.js +500 -500
  7. package/connector/registry.js +252 -252
  8. package/docs/README.md +50 -50
  9. package/docs/architecture.md +93 -93
  10. package/docs/connectors.md +116 -116
  11. package/docs/handlers.md +125 -125
  12. package/docs/libraries.md +101 -101
  13. package/docs/models.md +144 -144
  14. package/docs/routes.md +115 -115
  15. package/docs/tests.md +73 -73
  16. package/handlers/admin.js +523 -523
  17. package/handlers/appointment.js +193 -0
  18. package/handlers/auth.js +296 -296
  19. package/handlers/calldown.js +99 -99
  20. package/handlers/contact.js +280 -280
  21. package/handlers/disposition.js +82 -80
  22. package/handlers/log.js +984 -973
  23. package/handlers/managedAuth.js +446 -446
  24. package/handlers/plugin.js +208 -208
  25. package/handlers/user.js +142 -142
  26. package/index.js +3140 -2652
  27. package/jest.config.js +56 -56
  28. package/lib/analytics.js +54 -54
  29. package/lib/authSession.js +109 -109
  30. package/lib/cacheCleanup.js +21 -0
  31. package/lib/callLogComposer.js +898 -898
  32. package/lib/callLogLookup.js +34 -0
  33. package/lib/constants.js +8 -8
  34. package/lib/debugTracer.js +177 -177
  35. package/lib/encode.js +30 -30
  36. package/lib/errorHandler.js +218 -206
  37. package/lib/generalErrorMessage.js +41 -41
  38. package/lib/jwt.js +18 -18
  39. package/lib/logger.js +190 -190
  40. package/lib/migrateCallLogsSchema.js +116 -0
  41. package/lib/ringcentral.js +266 -266
  42. package/lib/s3ErrorLogReport.js +65 -65
  43. package/lib/sharedSMSComposer.js +471 -471
  44. package/lib/util.js +67 -67
  45. package/mcp/README.md +412 -395
  46. package/mcp/lib/validator.js +91 -91
  47. package/mcp/mcpHandler.js +425 -425
  48. package/mcp/tools/cancelAppointment.js +101 -0
  49. package/mcp/tools/checkAuthStatus.js +105 -105
  50. package/mcp/tools/confirmAppointment.js +101 -0
  51. package/mcp/tools/createAppointment.js +157 -0
  52. package/mcp/tools/createCallLog.js +327 -316
  53. package/mcp/tools/createContact.js +117 -117
  54. package/mcp/tools/createMessageLog.js +287 -287
  55. package/mcp/tools/doAuth.js +60 -60
  56. package/mcp/tools/findContactByName.js +93 -93
  57. package/mcp/tools/findContactByPhone.js +101 -101
  58. package/mcp/tools/getCallLog.js +111 -102
  59. package/mcp/tools/getGoogleFilePicker.js +99 -99
  60. package/mcp/tools/getHelp.js +43 -43
  61. package/mcp/tools/getPublicConnectors.js +94 -94
  62. package/mcp/tools/getSessionInfo.js +90 -90
  63. package/mcp/tools/index.js +51 -41
  64. package/mcp/tools/listAppointments.js +163 -0
  65. package/mcp/tools/logout.js +96 -96
  66. package/mcp/tools/rcGetCallLogs.js +65 -65
  67. package/mcp/tools/updateAppointment.js +154 -0
  68. package/mcp/tools/updateCallLog.js +130 -126
  69. package/mcp/ui/App/App.tsx +358 -358
  70. package/mcp/ui/App/components/AuthInfoForm.tsx +113 -113
  71. package/mcp/ui/App/components/AuthSuccess.tsx +22 -22
  72. package/mcp/ui/App/components/ConnectorList.tsx +82 -82
  73. package/mcp/ui/App/components/DebugPanel.tsx +43 -43
  74. package/mcp/ui/App/components/OAuthConnect.tsx +270 -270
  75. package/mcp/ui/App/lib/callTool.ts +130 -130
  76. package/mcp/ui/App/lib/debugLog.ts +41 -41
  77. package/mcp/ui/App/lib/developerPortal.ts +111 -111
  78. package/mcp/ui/App/main.css +5 -5
  79. package/mcp/ui/App/root.tsx +13 -13
  80. package/mcp/ui/index.html +13 -13
  81. package/mcp/ui/package-lock.json +6356 -6356
  82. package/mcp/ui/package.json +25 -25
  83. package/mcp/ui/tsconfig.json +26 -26
  84. package/mcp/ui/vite.config.ts +16 -16
  85. package/models/accountDataModel.js +33 -33
  86. package/models/adminConfigModel.js +35 -35
  87. package/models/cacheModel.js +30 -26
  88. package/models/callDownListModel.js +34 -34
  89. package/models/callLogModel.js +33 -27
  90. package/models/dynamo/connectorSchema.js +146 -146
  91. package/models/dynamo/lockSchema.js +24 -24
  92. package/models/dynamo/noteCacheSchema.js +29 -29
  93. package/models/llmSessionModel.js +17 -17
  94. package/models/messageLogModel.js +25 -25
  95. package/models/sequelize.js +16 -16
  96. package/models/userModel.js +45 -45
  97. package/package.json +1 -1
  98. package/releaseNotes.json +1093 -1081
  99. package/test/connector/proxy/engine.test.js +126 -126
  100. package/test/connector/proxy/index.test.js +279 -279
  101. package/test/connector/proxy/sample.json +161 -161
  102. package/test/connector/registry.test.js +415 -415
  103. package/test/handlers/admin.test.js +616 -616
  104. package/test/handlers/auth.test.js +1018 -1018
  105. package/test/handlers/contact.test.js +1014 -1014
  106. package/test/handlers/log.test.js +1298 -1160
  107. package/test/handlers/managedAuth.test.js +457 -457
  108. package/test/handlers/plugin.test.js +380 -380
  109. package/test/index.test.js +105 -105
  110. package/test/lib/cacheCleanup.test.js +42 -0
  111. package/test/lib/callLogComposer.test.js +1231 -1231
  112. package/test/lib/debugTracer.test.js +328 -328
  113. package/test/lib/jwt.test.js +176 -176
  114. package/test/lib/logger.test.js +206 -206
  115. package/test/lib/oauth.test.js +359 -359
  116. package/test/lib/ringcentral.test.js +467 -467
  117. package/test/lib/sharedSMSComposer.test.js +1084 -1084
  118. package/test/lib/util.test.js +329 -329
  119. package/test/mcp/tools/checkAuthStatus.test.js +83 -83
  120. package/test/mcp/tools/createCallLog.test.js +436 -436
  121. package/test/mcp/tools/createContact.test.js +58 -58
  122. package/test/mcp/tools/createMessageLog.test.js +595 -595
  123. package/test/mcp/tools/doAuth.test.js +113 -113
  124. package/test/mcp/tools/findContactByName.test.js +275 -275
  125. package/test/mcp/tools/findContactByPhone.test.js +296 -296
  126. package/test/mcp/tools/getCallLog.test.js +298 -298
  127. package/test/mcp/tools/getGoogleFilePicker.test.js +281 -281
  128. package/test/mcp/tools/getPublicConnectors.test.js +107 -107
  129. package/test/mcp/tools/getSessionInfo.test.js +127 -127
  130. package/test/mcp/tools/logout.test.js +233 -233
  131. package/test/mcp/tools/rcGetCallLogs.test.js +56 -56
  132. package/test/mcp/tools/updateCallLog.test.js +360 -360
  133. package/test/models/accountDataModel.test.js +98 -98
  134. package/test/models/dynamo/connectorSchema.test.js +189 -189
  135. package/test/models/models.test.js +568 -539
  136. package/test/routes/managedAuthRoutes.test.js +104 -104
  137. package/test/setup.js +178 -178
@@ -1,359 +1,359 @@
1
- const moment = require('moment');
2
-
3
- // Mock dependencies before requiring the module
4
- jest.mock('client-oauth2');
5
- jest.mock('../../models/userModel');
6
- jest.mock('../../connector/registry');
7
- jest.mock('../../models/dynamo/lockSchema', () => ({
8
- Lock: {
9
- create: jest.fn(),
10
- get: jest.fn()
11
- }
12
- }));
13
-
14
- const ClientOAuth2 = require('client-oauth2');
15
- const { UserModel } = require('../../models/userModel');
16
- const connectorRegistry = require('../../connector/registry');
17
- const { getOAuthApp, checkAndRefreshAccessToken } = require('../../lib/oauth');
18
-
19
- describe('oauth', () => {
20
- beforeEach(() => {
21
- jest.clearAllMocks();
22
- jest.spyOn(console, 'log').mockImplementation(() => {});
23
- delete process.env.USE_TOKEN_REFRESH_LOCK_PLATFORMS;
24
- });
25
-
26
- afterEach(() => {
27
- jest.restoreAllMocks();
28
- });
29
-
30
- describe('getOAuthApp', () => {
31
- test('should create OAuth app with provided configuration', () => {
32
- const config = {
33
- clientId: 'test-client-id',
34
- clientSecret: 'test-client-secret',
35
- accessTokenUri: 'https://api.example.com/oauth/token',
36
- authorizationUri: 'https://api.example.com/oauth/authorize',
37
- redirectUri: 'https://app.example.com/callback',
38
- scopes: ['read', 'write']
39
- };
40
-
41
- const mockOAuthApp = { code: { getToken: jest.fn() } };
42
- ClientOAuth2.mockReturnValue(mockOAuthApp);
43
-
44
- const result = getOAuthApp(config);
45
-
46
- expect(ClientOAuth2).toHaveBeenCalledWith({
47
- clientId: config.clientId,
48
- clientSecret: config.clientSecret,
49
- accessTokenUri: config.accessTokenUri,
50
- authorizationUri: config.authorizationUri,
51
- redirectUri: config.redirectUri,
52
- scopes: config.scopes
53
- });
54
- expect(result).toBe(mockOAuthApp);
55
- });
56
-
57
- test('should handle missing optional parameters', () => {
58
- const config = {
59
- clientId: 'client-id',
60
- clientSecret: 'client-secret'
61
- };
62
-
63
- ClientOAuth2.mockReturnValue({});
64
-
65
- getOAuthApp(config);
66
-
67
- expect(ClientOAuth2).toHaveBeenCalledWith({
68
- clientId: 'client-id',
69
- clientSecret: 'client-secret',
70
- accessTokenUri: undefined,
71
- authorizationUri: undefined,
72
- redirectUri: undefined,
73
- scopes: undefined
74
- });
75
- });
76
- });
77
-
78
- describe('checkAndRefreshAccessToken', () => {
79
- const mockOAuthApp = {
80
- createToken: jest.fn()
81
- };
82
-
83
- const createMockUser = (overrides = {}) => ({
84
- id: 'user-123',
85
- platform: 'testPlatform',
86
- accessToken: 'old-access-token',
87
- refreshToken: 'old-refresh-token',
88
- tokenExpiry: moment().subtract(1, 'minute').toDate(), // Expired
89
- save: jest.fn().mockResolvedValue(true),
90
- ...overrides
91
- });
92
-
93
- test('should return user unchanged if token is not expired', async () => {
94
- const user = createMockUser({
95
- tokenExpiry: moment().add(10, 'minutes').toDate() // Not expired
96
- });
97
-
98
- connectorRegistry.getConnector.mockReturnValue({});
99
-
100
- const result = await checkAndRefreshAccessToken(mockOAuthApp, user);
101
-
102
- expect(result).toBe(user);
103
- expect(mockOAuthApp.createToken).not.toHaveBeenCalled();
104
- });
105
-
106
- test('should refresh token when expired', async () => {
107
- const user = createMockUser();
108
- const newExpiry = moment().add(1, 'hour').toDate();
109
-
110
- connectorRegistry.getConnector.mockReturnValue({});
111
-
112
- const mockToken = {
113
- refresh: jest.fn().mockResolvedValue({
114
- accessToken: 'new-access-token',
115
- refreshToken: 'new-refresh-token',
116
- expires: newExpiry
117
- })
118
- };
119
- mockOAuthApp.createToken.mockReturnValue(mockToken);
120
-
121
- const result = await checkAndRefreshAccessToken(mockOAuthApp, user);
122
-
123
- expect(mockOAuthApp.createToken).toHaveBeenCalledWith(
124
- 'old-access-token',
125
- 'old-refresh-token'
126
- );
127
- expect(mockToken.refresh).toHaveBeenCalled();
128
- expect(user.accessToken).toBe('new-access-token');
129
- expect(user.refreshToken).toBe('new-refresh-token');
130
- expect(user.save).toHaveBeenCalled();
131
- });
132
-
133
- test('should delegate to platform-specific refresh if available', async () => {
134
- const user = createMockUser({
135
- platform: 'bullhorn'
136
- });
137
- const platformRefreshedUser = { ...user, accessToken: 'bullhorn-token' };
138
-
139
- connectorRegistry.getConnector.mockReturnValue({
140
- checkAndRefreshAccessToken: jest.fn().mockResolvedValue(platformRefreshedUser)
141
- });
142
-
143
- const result = await checkAndRefreshAccessToken(mockOAuthApp, user);
144
-
145
- expect(result).toBe(platformRefreshedUser);
146
- expect(mockOAuthApp.createToken).not.toHaveBeenCalled();
147
- });
148
-
149
- test('should refresh token even if within buffer time (2 minutes)', async () => {
150
- const user = createMockUser({
151
- tokenExpiry: moment().add(1.5, 'minutes').toDate() // Within buffer
152
- });
153
-
154
- connectorRegistry.getConnector.mockReturnValue({});
155
-
156
- const mockToken = {
157
- refresh: jest.fn().mockResolvedValue({
158
- accessToken: 'new-token',
159
- refreshToken: 'new-refresh',
160
- expires: moment().add(1, 'hour').toDate()
161
- })
162
- };
163
- mockOAuthApp.createToken.mockReturnValue(mockToken);
164
-
165
- await checkAndRefreshAccessToken(mockOAuthApp, user);
166
-
167
- expect(mockToken.refresh).toHaveBeenCalled();
168
- });
169
-
170
- test('should not refresh if missing required tokens', async () => {
171
- const user = createMockUser({
172
- accessToken: null,
173
- refreshToken: null,
174
- tokenExpiry: moment().subtract(1, 'minute').toDate()
175
- });
176
-
177
- connectorRegistry.getConnector.mockReturnValue({});
178
-
179
- const result = await checkAndRefreshAccessToken(mockOAuthApp, user);
180
-
181
- expect(result).toBe(user);
182
- expect(mockOAuthApp.createToken).not.toHaveBeenCalled();
183
- });
184
-
185
- describe('with token refresh lock', () => {
186
- beforeEach(() => {
187
- process.env.USE_TOKEN_REFRESH_LOCK_PLATFORMS = 'testPlatform,otherPlatform';
188
- });
189
-
190
- test('should create lock and refresh token successfully', async () => {
191
- const { Lock } = require('../../models/dynamo/lockSchema');
192
- const user = createMockUser();
193
- const newExpiry = moment().add(1, 'hour').toDate();
194
-
195
- const mockLock = { delete: jest.fn().mockResolvedValue(true) };
196
- Lock.create.mockResolvedValue(mockLock);
197
-
198
- connectorRegistry.getConnector.mockReturnValue({});
199
-
200
- const mockToken = {
201
- refresh: jest.fn().mockResolvedValue({
202
- accessToken: 'new-token',
203
- refreshToken: 'new-refresh',
204
- expires: newExpiry
205
- })
206
- };
207
- mockOAuthApp.createToken.mockReturnValue(mockToken);
208
-
209
- await checkAndRefreshAccessToken(mockOAuthApp, user);
210
-
211
- expect(Lock.create).toHaveBeenCalledWith(
212
- expect.objectContaining({
213
- userId: 'user-123',
214
- ttl: expect.any(Number)
215
- }),
216
- { overwrite: false }
217
- );
218
- expect(mockToken.refresh).toHaveBeenCalled();
219
- expect(mockLock.delete).toHaveBeenCalled();
220
- });
221
-
222
- test('should wait for existing lock and fetch user from DB after lock released', async () => {
223
- jest.resetModules();
224
- const { Lock } = require('../../models/dynamo/lockSchema');
225
- const user = createMockUser();
226
-
227
- // Simulate lock already exists
228
- const conditionalError = new Error('Lock exists');
229
- conditionalError.name = 'ConditionalCheckFailedException';
230
- Lock.create.mockReset();
231
- Lock.get.mockReset();
232
- Lock.create.mockRejectedValue(conditionalError);
233
-
234
- // Lock exists but not expired (ttl > now), then gets released
235
- const existingLock = {
236
- ttl: moment().add(30, 'seconds').unix(),
237
- delete: jest.fn().mockResolvedValue(true)
238
- };
239
- Lock.get.mockResolvedValueOnce(existingLock)
240
- .mockResolvedValueOnce(null); // Lock released
241
-
242
- const refreshedUser = { ...user, accessToken: 'refreshed-by-other-process' };
243
- UserModel.findByPk.mockResolvedValue(refreshedUser);
244
-
245
- connectorRegistry.getConnector.mockReturnValue({});
246
-
247
- const result = await checkAndRefreshAccessToken(mockOAuthApp, user, 5);
248
-
249
- // Verify the lock polling was performed
250
- expect(Lock.get).toHaveBeenCalled();
251
- // The result should have the user data (refreshed by another process)
252
- expect(result).toBeDefined();
253
- expect(result.id).toBe(user.id);
254
- });
255
-
256
- test('should handle expired lock by deleting and creating new one', async () => {
257
- const { Lock } = require('../../models/dynamo/lockSchema');
258
- const user = createMockUser();
259
- const newExpiry = moment().add(1, 'hour').toDate();
260
-
261
- // First create fails with conditional exception
262
- const conditionalError = new Error('Lock exists');
263
- conditionalError.name = 'ConditionalCheckFailedException';
264
-
265
- // Existing lock is expired (ttl < now)
266
- const expiredLock = {
267
- ttl: moment().subtract(10, 'seconds').unix(),
268
- delete: jest.fn().mockResolvedValue(true)
269
- };
270
-
271
- // Second create succeeds after deleting expired lock
272
- const newLock = { delete: jest.fn().mockResolvedValue(true) };
273
-
274
- Lock.create
275
- .mockRejectedValueOnce(conditionalError)
276
- .mockResolvedValueOnce(newLock);
277
- Lock.get.mockResolvedValue(expiredLock);
278
-
279
- connectorRegistry.getConnector.mockReturnValue({});
280
-
281
- const mockToken = {
282
- refresh: jest.fn().mockResolvedValue({
283
- accessToken: 'new-token',
284
- refreshToken: 'new-refresh',
285
- expires: newExpiry
286
- })
287
- };
288
- mockOAuthApp.createToken.mockReturnValue(mockToken);
289
-
290
- await checkAndRefreshAccessToken(mockOAuthApp, user);
291
-
292
- expect(expiredLock.delete).toHaveBeenCalled();
293
- expect(newLock.delete).toHaveBeenCalled();
294
- });
295
-
296
- test('should delete lock if refresh fails', async () => {
297
- jest.resetModules();
298
- const { Lock } = require('../../models/dynamo/lockSchema');
299
- const user = createMockUser();
300
-
301
- const mockLock = { delete: jest.fn().mockResolvedValue(true) };
302
- Lock.create.mockReset();
303
- Lock.get.mockReset();
304
- Lock.create.mockResolvedValue(mockLock);
305
-
306
- connectorRegistry.getConnector.mockReturnValue({});
307
-
308
- const mockToken = {
309
- refresh: jest.fn().mockRejectedValue(new Error('Refresh failed'))
310
- };
311
- mockOAuthApp.createToken.mockReturnValue(mockToken);
312
-
313
- await checkAndRefreshAccessToken(mockOAuthApp, user);
314
-
315
- expect(mockLock.delete).toHaveBeenCalled();
316
- });
317
-
318
- test('should throw on lock timeout', async () => {
319
- jest.resetModules();
320
- const { Lock } = require('../../models/dynamo/lockSchema');
321
- const user = createMockUser();
322
-
323
- const conditionalError = new Error('Lock exists');
324
- conditionalError.name = 'ConditionalCheckFailedException';
325
- Lock.create.mockReset();
326
- Lock.get.mockReset();
327
- Lock.create.mockRejectedValue(conditionalError);
328
-
329
- // Lock never gets released (ttl is in the future, not expired)
330
- const permanentLock = {
331
- ttl: moment().add(1, 'hour').unix(),
332
- delete: jest.fn().mockResolvedValue(true)
333
- };
334
- Lock.get.mockResolvedValue(permanentLock);
335
-
336
- connectorRegistry.getConnector.mockReturnValue({});
337
-
338
- await expect(
339
- checkAndRefreshAccessToken(mockOAuthApp, user, 1) // 1 second timeout
340
- ).rejects.toThrow('Token lock timeout');
341
- }, 10000);
342
-
343
- test('should rethrow non-conditional errors', async () => {
344
- const { Lock } = require('../../models/dynamo/lockSchema');
345
- const user = createMockUser();
346
-
347
- const randomError = new Error('Database connection failed');
348
- Lock.create.mockRejectedValue(randomError);
349
-
350
- connectorRegistry.getConnector.mockReturnValue({});
351
-
352
- await expect(
353
- checkAndRefreshAccessToken(mockOAuthApp, user)
354
- ).rejects.toThrow('Database connection failed');
355
- });
356
- });
357
- });
358
- });
359
-
1
+ const moment = require('moment');
2
+
3
+ // Mock dependencies before requiring the module
4
+ jest.mock('client-oauth2');
5
+ jest.mock('../../models/userModel');
6
+ jest.mock('../../connector/registry');
7
+ jest.mock('../../models/dynamo/lockSchema', () => ({
8
+ Lock: {
9
+ create: jest.fn(),
10
+ get: jest.fn()
11
+ }
12
+ }));
13
+
14
+ const ClientOAuth2 = require('client-oauth2');
15
+ const { UserModel } = require('../../models/userModel');
16
+ const connectorRegistry = require('../../connector/registry');
17
+ const { getOAuthApp, checkAndRefreshAccessToken } = require('../../lib/oauth');
18
+
19
+ describe('oauth', () => {
20
+ beforeEach(() => {
21
+ jest.clearAllMocks();
22
+ jest.spyOn(console, 'log').mockImplementation(() => {});
23
+ delete process.env.USE_TOKEN_REFRESH_LOCK_PLATFORMS;
24
+ });
25
+
26
+ afterEach(() => {
27
+ jest.restoreAllMocks();
28
+ });
29
+
30
+ describe('getOAuthApp', () => {
31
+ test('should create OAuth app with provided configuration', () => {
32
+ const config = {
33
+ clientId: 'test-client-id',
34
+ clientSecret: 'test-client-secret',
35
+ accessTokenUri: 'https://api.example.com/oauth/token',
36
+ authorizationUri: 'https://api.example.com/oauth/authorize',
37
+ redirectUri: 'https://app.example.com/callback',
38
+ scopes: ['read', 'write']
39
+ };
40
+
41
+ const mockOAuthApp = { code: { getToken: jest.fn() } };
42
+ ClientOAuth2.mockReturnValue(mockOAuthApp);
43
+
44
+ const result = getOAuthApp(config);
45
+
46
+ expect(ClientOAuth2).toHaveBeenCalledWith({
47
+ clientId: config.clientId,
48
+ clientSecret: config.clientSecret,
49
+ accessTokenUri: config.accessTokenUri,
50
+ authorizationUri: config.authorizationUri,
51
+ redirectUri: config.redirectUri,
52
+ scopes: config.scopes
53
+ });
54
+ expect(result).toBe(mockOAuthApp);
55
+ });
56
+
57
+ test('should handle missing optional parameters', () => {
58
+ const config = {
59
+ clientId: 'client-id',
60
+ clientSecret: 'client-secret'
61
+ };
62
+
63
+ ClientOAuth2.mockReturnValue({});
64
+
65
+ getOAuthApp(config);
66
+
67
+ expect(ClientOAuth2).toHaveBeenCalledWith({
68
+ clientId: 'client-id',
69
+ clientSecret: 'client-secret',
70
+ accessTokenUri: undefined,
71
+ authorizationUri: undefined,
72
+ redirectUri: undefined,
73
+ scopes: undefined
74
+ });
75
+ });
76
+ });
77
+
78
+ describe('checkAndRefreshAccessToken', () => {
79
+ const mockOAuthApp = {
80
+ createToken: jest.fn()
81
+ };
82
+
83
+ const createMockUser = (overrides = {}) => ({
84
+ id: 'user-123',
85
+ platform: 'testPlatform',
86
+ accessToken: 'old-access-token',
87
+ refreshToken: 'old-refresh-token',
88
+ tokenExpiry: moment().subtract(1, 'minute').toDate(), // Expired
89
+ save: jest.fn().mockResolvedValue(true),
90
+ ...overrides
91
+ });
92
+
93
+ test('should return user unchanged if token is not expired', async () => {
94
+ const user = createMockUser({
95
+ tokenExpiry: moment().add(10, 'minutes').toDate() // Not expired
96
+ });
97
+
98
+ connectorRegistry.getConnector.mockReturnValue({});
99
+
100
+ const result = await checkAndRefreshAccessToken(mockOAuthApp, user);
101
+
102
+ expect(result).toBe(user);
103
+ expect(mockOAuthApp.createToken).not.toHaveBeenCalled();
104
+ });
105
+
106
+ test('should refresh token when expired', async () => {
107
+ const user = createMockUser();
108
+ const newExpiry = moment().add(1, 'hour').toDate();
109
+
110
+ connectorRegistry.getConnector.mockReturnValue({});
111
+
112
+ const mockToken = {
113
+ refresh: jest.fn().mockResolvedValue({
114
+ accessToken: 'new-access-token',
115
+ refreshToken: 'new-refresh-token',
116
+ expires: newExpiry
117
+ })
118
+ };
119
+ mockOAuthApp.createToken.mockReturnValue(mockToken);
120
+
121
+ const result = await checkAndRefreshAccessToken(mockOAuthApp, user);
122
+
123
+ expect(mockOAuthApp.createToken).toHaveBeenCalledWith(
124
+ 'old-access-token',
125
+ 'old-refresh-token'
126
+ );
127
+ expect(mockToken.refresh).toHaveBeenCalled();
128
+ expect(user.accessToken).toBe('new-access-token');
129
+ expect(user.refreshToken).toBe('new-refresh-token');
130
+ expect(user.save).toHaveBeenCalled();
131
+ });
132
+
133
+ test('should delegate to platform-specific refresh if available', async () => {
134
+ const user = createMockUser({
135
+ platform: 'bullhorn'
136
+ });
137
+ const platformRefreshedUser = { ...user, accessToken: 'bullhorn-token' };
138
+
139
+ connectorRegistry.getConnector.mockReturnValue({
140
+ checkAndRefreshAccessToken: jest.fn().mockResolvedValue(platformRefreshedUser)
141
+ });
142
+
143
+ const result = await checkAndRefreshAccessToken(mockOAuthApp, user);
144
+
145
+ expect(result).toBe(platformRefreshedUser);
146
+ expect(mockOAuthApp.createToken).not.toHaveBeenCalled();
147
+ });
148
+
149
+ test('should refresh token even if within buffer time (2 minutes)', async () => {
150
+ const user = createMockUser({
151
+ tokenExpiry: moment().add(1.5, 'minutes').toDate() // Within buffer
152
+ });
153
+
154
+ connectorRegistry.getConnector.mockReturnValue({});
155
+
156
+ const mockToken = {
157
+ refresh: jest.fn().mockResolvedValue({
158
+ accessToken: 'new-token',
159
+ refreshToken: 'new-refresh',
160
+ expires: moment().add(1, 'hour').toDate()
161
+ })
162
+ };
163
+ mockOAuthApp.createToken.mockReturnValue(mockToken);
164
+
165
+ await checkAndRefreshAccessToken(mockOAuthApp, user);
166
+
167
+ expect(mockToken.refresh).toHaveBeenCalled();
168
+ });
169
+
170
+ test('should not refresh if missing required tokens', async () => {
171
+ const user = createMockUser({
172
+ accessToken: null,
173
+ refreshToken: null,
174
+ tokenExpiry: moment().subtract(1, 'minute').toDate()
175
+ });
176
+
177
+ connectorRegistry.getConnector.mockReturnValue({});
178
+
179
+ const result = await checkAndRefreshAccessToken(mockOAuthApp, user);
180
+
181
+ expect(result).toBe(user);
182
+ expect(mockOAuthApp.createToken).not.toHaveBeenCalled();
183
+ });
184
+
185
+ describe('with token refresh lock', () => {
186
+ beforeEach(() => {
187
+ process.env.USE_TOKEN_REFRESH_LOCK_PLATFORMS = 'testPlatform,otherPlatform';
188
+ });
189
+
190
+ test('should create lock and refresh token successfully', async () => {
191
+ const { Lock } = require('../../models/dynamo/lockSchema');
192
+ const user = createMockUser();
193
+ const newExpiry = moment().add(1, 'hour').toDate();
194
+
195
+ const mockLock = { delete: jest.fn().mockResolvedValue(true) };
196
+ Lock.create.mockResolvedValue(mockLock);
197
+
198
+ connectorRegistry.getConnector.mockReturnValue({});
199
+
200
+ const mockToken = {
201
+ refresh: jest.fn().mockResolvedValue({
202
+ accessToken: 'new-token',
203
+ refreshToken: 'new-refresh',
204
+ expires: newExpiry
205
+ })
206
+ };
207
+ mockOAuthApp.createToken.mockReturnValue(mockToken);
208
+
209
+ await checkAndRefreshAccessToken(mockOAuthApp, user);
210
+
211
+ expect(Lock.create).toHaveBeenCalledWith(
212
+ expect.objectContaining({
213
+ userId: 'user-123',
214
+ ttl: expect.any(Number)
215
+ }),
216
+ { overwrite: false }
217
+ );
218
+ expect(mockToken.refresh).toHaveBeenCalled();
219
+ expect(mockLock.delete).toHaveBeenCalled();
220
+ });
221
+
222
+ test('should wait for existing lock and fetch user from DB after lock released', async () => {
223
+ jest.resetModules();
224
+ const { Lock } = require('../../models/dynamo/lockSchema');
225
+ const user = createMockUser();
226
+
227
+ // Simulate lock already exists
228
+ const conditionalError = new Error('Lock exists');
229
+ conditionalError.name = 'ConditionalCheckFailedException';
230
+ Lock.create.mockReset();
231
+ Lock.get.mockReset();
232
+ Lock.create.mockRejectedValue(conditionalError);
233
+
234
+ // Lock exists but not expired (ttl > now), then gets released
235
+ const existingLock = {
236
+ ttl: moment().add(30, 'seconds').unix(),
237
+ delete: jest.fn().mockResolvedValue(true)
238
+ };
239
+ Lock.get.mockResolvedValueOnce(existingLock)
240
+ .mockResolvedValueOnce(null); // Lock released
241
+
242
+ const refreshedUser = { ...user, accessToken: 'refreshed-by-other-process' };
243
+ UserModel.findByPk.mockResolvedValue(refreshedUser);
244
+
245
+ connectorRegistry.getConnector.mockReturnValue({});
246
+
247
+ const result = await checkAndRefreshAccessToken(mockOAuthApp, user, 5);
248
+
249
+ // Verify the lock polling was performed
250
+ expect(Lock.get).toHaveBeenCalled();
251
+ // The result should have the user data (refreshed by another process)
252
+ expect(result).toBeDefined();
253
+ expect(result.id).toBe(user.id);
254
+ });
255
+
256
+ test('should handle expired lock by deleting and creating new one', async () => {
257
+ const { Lock } = require('../../models/dynamo/lockSchema');
258
+ const user = createMockUser();
259
+ const newExpiry = moment().add(1, 'hour').toDate();
260
+
261
+ // First create fails with conditional exception
262
+ const conditionalError = new Error('Lock exists');
263
+ conditionalError.name = 'ConditionalCheckFailedException';
264
+
265
+ // Existing lock is expired (ttl < now)
266
+ const expiredLock = {
267
+ ttl: moment().subtract(10, 'seconds').unix(),
268
+ delete: jest.fn().mockResolvedValue(true)
269
+ };
270
+
271
+ // Second create succeeds after deleting expired lock
272
+ const newLock = { delete: jest.fn().mockResolvedValue(true) };
273
+
274
+ Lock.create
275
+ .mockRejectedValueOnce(conditionalError)
276
+ .mockResolvedValueOnce(newLock);
277
+ Lock.get.mockResolvedValue(expiredLock);
278
+
279
+ connectorRegistry.getConnector.mockReturnValue({});
280
+
281
+ const mockToken = {
282
+ refresh: jest.fn().mockResolvedValue({
283
+ accessToken: 'new-token',
284
+ refreshToken: 'new-refresh',
285
+ expires: newExpiry
286
+ })
287
+ };
288
+ mockOAuthApp.createToken.mockReturnValue(mockToken);
289
+
290
+ await checkAndRefreshAccessToken(mockOAuthApp, user);
291
+
292
+ expect(expiredLock.delete).toHaveBeenCalled();
293
+ expect(newLock.delete).toHaveBeenCalled();
294
+ });
295
+
296
+ test('should delete lock if refresh fails', async () => {
297
+ jest.resetModules();
298
+ const { Lock } = require('../../models/dynamo/lockSchema');
299
+ const user = createMockUser();
300
+
301
+ const mockLock = { delete: jest.fn().mockResolvedValue(true) };
302
+ Lock.create.mockReset();
303
+ Lock.get.mockReset();
304
+ Lock.create.mockResolvedValue(mockLock);
305
+
306
+ connectorRegistry.getConnector.mockReturnValue({});
307
+
308
+ const mockToken = {
309
+ refresh: jest.fn().mockRejectedValue(new Error('Refresh failed'))
310
+ };
311
+ mockOAuthApp.createToken.mockReturnValue(mockToken);
312
+
313
+ await checkAndRefreshAccessToken(mockOAuthApp, user);
314
+
315
+ expect(mockLock.delete).toHaveBeenCalled();
316
+ });
317
+
318
+ test('should throw on lock timeout', async () => {
319
+ jest.resetModules();
320
+ const { Lock } = require('../../models/dynamo/lockSchema');
321
+ const user = createMockUser();
322
+
323
+ const conditionalError = new Error('Lock exists');
324
+ conditionalError.name = 'ConditionalCheckFailedException';
325
+ Lock.create.mockReset();
326
+ Lock.get.mockReset();
327
+ Lock.create.mockRejectedValue(conditionalError);
328
+
329
+ // Lock never gets released (ttl is in the future, not expired)
330
+ const permanentLock = {
331
+ ttl: moment().add(1, 'hour').unix(),
332
+ delete: jest.fn().mockResolvedValue(true)
333
+ };
334
+ Lock.get.mockResolvedValue(permanentLock);
335
+
336
+ connectorRegistry.getConnector.mockReturnValue({});
337
+
338
+ await expect(
339
+ checkAndRefreshAccessToken(mockOAuthApp, user, 1) // 1 second timeout
340
+ ).rejects.toThrow('Token lock timeout');
341
+ }, 10000);
342
+
343
+ test('should rethrow non-conditional errors', async () => {
344
+ const { Lock } = require('../../models/dynamo/lockSchema');
345
+ const user = createMockUser();
346
+
347
+ const randomError = new Error('Database connection failed');
348
+ Lock.create.mockRejectedValue(randomError);
349
+
350
+ connectorRegistry.getConnector.mockReturnValue({});
351
+
352
+ await expect(
353
+ checkAndRefreshAccessToken(mockOAuthApp, user)
354
+ ).rejects.toThrow('Database connection failed');
355
+ });
356
+ });
357
+ });
358
+ });
359
+