@app-connect/core 1.7.34 → 1.7.36

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 (49) hide show
  1. package/connector/mock.js +9 -4
  2. package/connector/proxy/engine.js +3 -2
  3. package/connector/proxy/index.js +2 -2
  4. package/docs/architecture.md +1 -0
  5. package/docs/handlers.md +1 -1
  6. package/docs/models.md +2 -0
  7. package/docs/routes.md +1 -1
  8. package/handlers/disposition.js +3 -2
  9. package/handlers/log.js +18 -6
  10. package/handlers/plugin.js +13 -6
  11. package/index.js +22 -11
  12. package/lib/callLogLookup.js +82 -9
  13. package/lib/migrateCallLogsSchema.js +128 -7
  14. package/models/callLogModel.js +6 -0
  15. package/package.json +1 -1
  16. package/releaseNotes.json +44 -0
  17. package/test/connector/developerPortal.test.js +166 -0
  18. package/test/connector/mock.test.js +131 -0
  19. package/test/connector/proxy/engine.test.js +85 -0
  20. package/test/connector/proxy/index.test.js +246 -0
  21. package/test/connector/proxy/sample.json +1 -0
  22. package/test/handlers/admin.test.js +344 -0
  23. package/test/handlers/appointment.test.js +260 -0
  24. package/test/handlers/auth.test.js +6 -2
  25. package/test/handlers/calldown.test.js +310 -0
  26. package/test/handlers/disposition.test.js +396 -0
  27. package/test/handlers/log.test.js +327 -3
  28. package/test/handlers/managedOAuth.test.js +262 -0
  29. package/test/handlers/plugin.test.js +305 -0
  30. package/test/handlers/user.test.js +381 -0
  31. package/test/index.test.js +166 -1
  32. package/test/lib/analytics.test.js +146 -0
  33. package/test/lib/authSession.test.js +173 -0
  34. package/test/lib/encode.test.js +59 -0
  35. package/test/lib/errorHandler.test.js +246 -0
  36. package/test/lib/generalErrorMessage.test.js +82 -0
  37. package/test/lib/s3ErrorLogReport.test.js +187 -0
  38. package/test/mcp/mcpHandlerMore.test.js +384 -0
  39. package/test/mcp/tools/appointmentTools.test.js +362 -0
  40. package/test/models/callDownListModel.test.js +125 -0
  41. package/test/models/dynamo/lockSchema.test.js +37 -0
  42. package/test/models/dynamo/noteCacheSchema.test.js +45 -0
  43. package/test/models/llmSessionModel.test.js +91 -0
  44. package/test/models/models.test.js +92 -0
  45. package/test/routes/calldownRoutes.test.js +224 -0
  46. package/test/routes/coreRouterBroadRoutes.test.js +855 -0
  47. package/test/routes/dispositionRoutes.test.js +192 -0
  48. package/test/routes/managedAuthRoutes.test.js +151 -0
  49. package/test/routes/pluginRoutes.test.js +262 -0
@@ -0,0 +1,384 @@
1
+ const axios = require('axios');
2
+ const fs = require('fs');
3
+ const toolsModule = require('../../mcp/tools');
4
+ const { LlmSessionModel } = require('../../models/llmSessionModel');
5
+ const { CacheModel } = require('../../models/cacheModel');
6
+ const { UserModel } = require('../../models/userModel');
7
+ const { getHashValue } = require('../../lib/util');
8
+ const jwt = require('../../lib/jwt');
9
+ const { handleMcpRequest, handleWidgetToolCall } = require('../../mcp/mcpHandler');
10
+
11
+ jest.mock('axios', () => ({ get: jest.fn() }));
12
+
13
+ jest.mock('../../mcp/tools', () => ({
14
+ tools: [
15
+ {
16
+ definition: { name: 'getPublicConnectors', _meta: { existing: true } },
17
+ execute: jest.fn(),
18
+ },
19
+ {
20
+ definition: { name: 'simpleTool', outputSchema: { type: 'object' } },
21
+ execute: jest.fn(),
22
+ },
23
+ {
24
+ definition: { name: 'falseTool', outputSchema: { type: 'object' } },
25
+ execute: jest.fn(),
26
+ },
27
+ {
28
+ definition: { name: 'throwTool' },
29
+ execute: jest.fn(),
30
+ },
31
+ ],
32
+ widgetTools: [
33
+ {
34
+ definition: { name: 'widgetOnly' },
35
+ execute: jest.fn(),
36
+ },
37
+ ],
38
+ }));
39
+
40
+ jest.mock('../../models/llmSessionModel', () => ({
41
+ LlmSessionModel: {
42
+ findByPk: jest.fn(),
43
+ destroy: jest.fn(),
44
+ upsert: jest.fn(),
45
+ },
46
+ }));
47
+
48
+ jest.mock('../../models/cacheModel', () => ({
49
+ CacheModel: {
50
+ findByPk: jest.fn(),
51
+ upsert: jest.fn(),
52
+ },
53
+ }));
54
+
55
+ jest.mock('../../models/userModel', () => ({
56
+ UserModel: {
57
+ findByPk: jest.fn(),
58
+ findOne: jest.fn(),
59
+ },
60
+ }));
61
+
62
+ jest.mock('../../lib/util', () => ({
63
+ getHashValue: jest.fn(),
64
+ }));
65
+
66
+ jest.mock('../../lib/jwt', () => ({
67
+ decodeJwt: jest.fn(),
68
+ generateJwt: jest.fn(),
69
+ }));
70
+
71
+ jest.mock('../../lib/logger', () => ({
72
+ info: jest.fn(),
73
+ warn: jest.fn(),
74
+ error: jest.fn(),
75
+ }));
76
+
77
+ function mockResponse() {
78
+ return {
79
+ status: jest.fn().mockReturnThis(),
80
+ json: jest.fn(),
81
+ end: jest.fn(),
82
+ };
83
+ }
84
+
85
+ function makeRequest(method, params = {}, extra = {}) {
86
+ return {
87
+ body: {
88
+ jsonrpc: '2.0',
89
+ id: extra.id ?? 1,
90
+ method,
91
+ params,
92
+ },
93
+ headers: extra.headers || {},
94
+ };
95
+ }
96
+
97
+ function getTool(name) {
98
+ return [...toolsModule.tools, ...toolsModule.widgetTools]
99
+ .find(tool => tool.definition.name === name);
100
+ }
101
+
102
+ describe('MCP Handler additional protocol coverage', () => {
103
+ const originalAppServer = process.env.APP_SERVER;
104
+ const originalHashKey = process.env.HASH_KEY;
105
+
106
+ beforeEach(() => {
107
+ jest.clearAllMocks();
108
+ process.env.APP_SERVER = 'https://app.example.test';
109
+ process.env.HASH_KEY = 'test-hash-key';
110
+
111
+ getTool('getPublicConnectors').execute.mockResolvedValue({ success: true });
112
+ getTool('simpleTool').execute.mockResolvedValue({
113
+ structuredContent: { success: true, data: { ok: true } },
114
+ content: [{ type: 'text', text: 'custom content' }],
115
+ });
116
+ getTool('falseTool').execute.mockResolvedValue({ success: false, error: 'blocked' });
117
+ getTool('throwTool').execute.mockRejectedValue(new Error('boom'));
118
+ getTool('widgetOnly').execute.mockResolvedValue({ success: true, data: { widget: true } });
119
+
120
+ axios.get.mockResolvedValue({ data: { id: 'rc-ext-1' } });
121
+ CacheModel.findByPk.mockResolvedValue(null);
122
+ CacheModel.upsert.mockResolvedValue([{}, true]);
123
+ LlmSessionModel.findByPk.mockResolvedValue(null);
124
+ LlmSessionModel.destroy.mockResolvedValue(1);
125
+ LlmSessionModel.upsert.mockResolvedValue([{}, true]);
126
+ UserModel.findByPk.mockResolvedValue({ id: 'user-1', accessToken: 'crm-token' });
127
+ UserModel.findOne.mockResolvedValue(null);
128
+ getHashValue.mockReturnValue('hashed-rc-ext-1');
129
+ jwt.decodeJwt.mockReturnValue({ id: 'user-1' });
130
+ jwt.generateJwt.mockReturnValue('generated-jwt');
131
+ });
132
+
133
+ afterAll(() => {
134
+ process.env.APP_SERVER = originalAppServer;
135
+ process.env.HASH_KEY = originalHashKey;
136
+ });
137
+
138
+ test('handles initialize, resources/list, ping, notifications, and unknown methods', async () => {
139
+ const initializeRes = mockResponse();
140
+ await handleMcpRequest(makeRequest('initialize'), initializeRes);
141
+ expect(initializeRes.json.mock.calls[0][0].result.serverInfo.name)
142
+ .toBe('rc-unified-crm-extension');
143
+
144
+ const listRes = mockResponse();
145
+ await handleMcpRequest(makeRequest('resources/list'), listRes);
146
+ expect(listRes.json.mock.calls[0][0].result.resources[0]).toEqual(expect.objectContaining({
147
+ name: 'connector-list-widget',
148
+ mimeType: 'text/html+skybridge',
149
+ }));
150
+
151
+ const pingRes = mockResponse();
152
+ await handleMcpRequest(makeRequest('ping'), pingRes);
153
+ expect(pingRes.json.mock.calls[0][0].result).toEqual({});
154
+
155
+ const notificationRes = mockResponse();
156
+ await handleMcpRequest(makeRequest('notifications/initialized'), notificationRes);
157
+ expect(notificationRes.status).toHaveBeenCalledWith(200);
158
+ expect(notificationRes.end).toHaveBeenCalled();
159
+ expect(notificationRes.json).not.toHaveBeenCalled();
160
+
161
+ const unknownRes = mockResponse();
162
+ await handleMcpRequest(makeRequest('no/such-method'), unknownRes);
163
+ expect(unknownRes.json.mock.calls[0][0].error).toEqual(expect.objectContaining({
164
+ code: -32601,
165
+ message: 'Method not found: no/such-method',
166
+ }));
167
+ });
168
+
169
+ test('decorates tools/list metadata and schemas', async () => {
170
+ const res = mockResponse();
171
+ await handleMcpRequest(makeRequest('tools/list'), res);
172
+
173
+ const response = res.json.mock.calls[0][0];
174
+ const publicConnectors = response.result.tools.find(tool => tool.name === 'getPublicConnectors');
175
+ expect(publicConnectors._meta).toEqual(expect.objectContaining({
176
+ existing: true,
177
+ 'openai/outputTemplate': expect.stringMatching(/^ui:\/\/widget\/ConnectorList-v\d+\.html$/),
178
+ }));
179
+ expect(publicConnectors.outputSchema.properties).toHaveProperty('serverUrl');
180
+ });
181
+
182
+ test('reads widget resources and falls back from dist html to dev html', async () => {
183
+ const invalidRes = mockResponse();
184
+ await handleMcpRequest(makeRequest('resources/read', { uri: 'file://bad.html' }), invalidRes);
185
+ expect(invalidRes.json.mock.calls[0][0].error).toEqual(expect.objectContaining({
186
+ code: -32602,
187
+ message: 'Unknown resource: file://bad.html',
188
+ }));
189
+
190
+ const readFileSpy = jest.spyOn(fs, 'readFileSync')
191
+ .mockImplementationOnce(() => { throw new Error('missing dist'); })
192
+ .mockReturnValueOnce('<html>widget</html>');
193
+
194
+ const res = mockResponse();
195
+ await handleMcpRequest(makeRequest('resources/read', { uri: 'ui://widget/ConnectorList-v10.html' }), res);
196
+
197
+ const content = res.json.mock.calls[0][0].result.contents[0];
198
+ expect(content.text).toBe('<html>widget</html>');
199
+ expect(content._meta['openai/widgetDomain']).toBe('https://app.example.test');
200
+ expect(readFileSpy).toHaveBeenCalledTimes(2);
201
+ readFileSpy.mockRestore();
202
+ });
203
+
204
+ test('injects cached rc extension and valid CRM jwt into tool calls', async () => {
205
+ CacheModel.findByPk.mockResolvedValue({
206
+ data: { rcExtensionId: 'rc-ext-cached' },
207
+ expiry: new Date(Date.now() + 60000),
208
+ });
209
+ LlmSessionModel.findByPk.mockResolvedValue({
210
+ jwtToken: 'cached-jwt',
211
+ expiry: new Date(Date.now() + 60000),
212
+ });
213
+
214
+ const res = mockResponse();
215
+ await handleMcpRequest(makeRequest(
216
+ 'tools/call',
217
+ {
218
+ name: 'simpleTool',
219
+ arguments: { value: 1 },
220
+ _meta: { 'openai/session': 'openai-session-1' },
221
+ },
222
+ { headers: { authorization: 'Bearer rc-access-token' } }
223
+ ), res);
224
+
225
+ expect(axios.get).not.toHaveBeenCalled();
226
+ expect(getTool('simpleTool').execute).toHaveBeenCalledWith(expect.objectContaining({
227
+ value: 1,
228
+ rcAccessToken: 'rc-access-token',
229
+ openaiSessionId: 'openai-session-1',
230
+ rcExtensionId: 'rc-ext-cached',
231
+ jwtToken: 'cached-jwt',
232
+ }));
233
+ expect(res.json.mock.calls[0][0].result).toEqual(expect.objectContaining({
234
+ content: [{ type: 'text', text: 'custom content' }],
235
+ structuredContent: { success: true, data: { ok: true } },
236
+ }));
237
+ });
238
+
239
+ test('refreshes rc extension, removes expired sessions, and reuses fallback session jwt', async () => {
240
+ LlmSessionModel.findByPk
241
+ .mockResolvedValueOnce({
242
+ jwtToken: 'expired-jwt',
243
+ expiry: new Date(Date.now() - 60000),
244
+ })
245
+ .mockResolvedValueOnce({
246
+ jwtToken: 'fallback-jwt',
247
+ expiry: new Date(Date.now() + 60000),
248
+ });
249
+
250
+ const res = mockResponse();
251
+ await handleMcpRequest(makeRequest(
252
+ 'tools/call',
253
+ {
254
+ name: 'simpleTool',
255
+ arguments: {},
256
+ _meta: { 'openai/session': 'openai-session-2' },
257
+ },
258
+ { headers: { authorization: 'Bearer live-rc-token' } }
259
+ ), res);
260
+
261
+ expect(axios.get).toHaveBeenCalledWith(
262
+ 'https://platform.ringcentral.com/restapi/v1.0/account/~/extension/~',
263
+ { headers: { Authorization: 'Bearer live-rc-token' } }
264
+ );
265
+ expect(CacheModel.upsert).toHaveBeenCalledWith(expect.objectContaining({
266
+ id: 'openai-session-2-rcExtensionId',
267
+ data: { rcExtensionId: 'rc-ext-1' },
268
+ status: 'resolved',
269
+ }));
270
+ expect(LlmSessionModel.destroy).toHaveBeenCalledWith({ where: { id: 'rc-ext-1' } });
271
+ expect(LlmSessionModel.upsert).toHaveBeenCalledWith(expect.objectContaining({
272
+ id: 'rc-ext-1',
273
+ jwtToken: 'fallback-jwt',
274
+ }));
275
+ expect(getTool('simpleTool').execute).toHaveBeenCalledWith(expect.objectContaining({
276
+ rcExtensionId: 'rc-ext-1',
277
+ jwtToken: 'fallback-jwt',
278
+ }));
279
+ });
280
+
281
+ test('creates a new llm session from the latest CRM user when no session exists', async () => {
282
+ LlmSessionModel.findByPk
283
+ .mockResolvedValueOnce(null)
284
+ .mockResolvedValueOnce(null)
285
+ .mockResolvedValueOnce({ jwtToken: 'generated-jwt' });
286
+ UserModel.findOne.mockResolvedValue({
287
+ id: 'user-2',
288
+ platform: 'salesforce',
289
+ accessToken: 'crm-token',
290
+ });
291
+
292
+ const res = mockResponse();
293
+ await handleMcpRequest(makeRequest(
294
+ 'tools/call',
295
+ {
296
+ name: 'falseTool',
297
+ arguments: {},
298
+ _meta: { 'openai/session': 'openai-session-3' },
299
+ },
300
+ { headers: { authorization: 'Bearer rc-token' } }
301
+ ), res);
302
+
303
+ expect(getHashValue).toHaveBeenCalledWith('rc-ext-1', 'test-hash-key');
304
+ expect(UserModel.findOne).toHaveBeenCalledWith(expect.objectContaining({
305
+ where: expect.objectContaining({ hashedRcExtensionId: 'hashed-rc-ext-1' }),
306
+ order: [['updatedAt', 'DESC']],
307
+ }));
308
+ expect(jwt.generateJwt).toHaveBeenCalledWith({ id: 'user-2', platform: 'salesforce' });
309
+ expect(res.json.mock.calls[0][0].result).toEqual(expect.objectContaining({
310
+ structuredContent: { success: false, error: 'blocked' },
311
+ isError: true,
312
+ }));
313
+ });
314
+
315
+ test('returns JSON-RPC errors for unknown or failed tools and handles request failures', async () => {
316
+ const missingRes = mockResponse();
317
+ await handleMcpRequest(makeRequest('tools/call', { name: 'missingTool', arguments: {} }), missingRes);
318
+ expect(missingRes.json.mock.calls[0][0].error).toEqual(expect.objectContaining({
319
+ code: -32603,
320
+ message: 'Tool execution failed: Tool not found: missingTool',
321
+ }));
322
+
323
+ const throwRes = mockResponse();
324
+ await handleMcpRequest(makeRequest('tools/call', { name: 'throwTool', arguments: {} }), throwRes);
325
+ expect(throwRes.json.mock.calls[0][0].error).toEqual(expect.objectContaining({
326
+ code: -32603,
327
+ message: 'Tool execution failed: boom',
328
+ }));
329
+
330
+ const malformedRes = mockResponse();
331
+ await handleMcpRequest({ headers: {} }, malformedRes);
332
+ expect(malformedRes.json.mock.calls[0][0]).toEqual(expect.objectContaining({
333
+ id: null,
334
+ error: expect.objectContaining({
335
+ code: -32603,
336
+ message: 'Internal server error',
337
+ }),
338
+ }));
339
+ });
340
+
341
+ test('continues tool calls when RC extension resolution fails', async () => {
342
+ axios.get.mockRejectedValue(new Error('invalid rc token'));
343
+
344
+ const res = mockResponse();
345
+ await handleMcpRequest(makeRequest(
346
+ 'tools/call',
347
+ {
348
+ name: 'simpleTool',
349
+ arguments: {},
350
+ _meta: { 'openai/session': 'openai-session-4' },
351
+ },
352
+ { headers: { authorization: 'Bearer bad-token' } }
353
+ ), res);
354
+
355
+ expect(getTool('simpleTool').execute).toHaveBeenCalledWith(expect.objectContaining({
356
+ rcAccessToken: 'bad-token',
357
+ openaiSessionId: 'openai-session-4',
358
+ }));
359
+ expect(getTool('simpleTool').execute.mock.calls[0][0]).not.toHaveProperty('rcExtensionId');
360
+ });
361
+
362
+ test('handles widget tool call validation, success, and execution errors', async () => {
363
+ const missingRes = mockResponse();
364
+ await handleWidgetToolCall({ body: {} }, missingRes);
365
+ expect(missingRes.status).toHaveBeenCalledWith(400);
366
+ expect(missingRes.json).toHaveBeenCalledWith({ success: false, error: 'Missing tool name' });
367
+
368
+ const unknownRes = mockResponse();
369
+ await handleWidgetToolCall({ body: { tool: 'notRegistered' } }, unknownRes);
370
+ expect(unknownRes.status).toHaveBeenCalledWith(404);
371
+ expect(unknownRes.json).toHaveBeenCalledWith({ success: false, error: 'Unknown tool: notRegistered' });
372
+
373
+ const successRes = mockResponse();
374
+ await handleWidgetToolCall({ body: { tool: 'widgetOnly', toolArgs: { sessionId: 's1' } } }, successRes);
375
+ expect(getTool('widgetOnly').execute).toHaveBeenCalledWith({ sessionId: 's1' });
376
+ expect(successRes.json).toHaveBeenCalledWith({ success: true, data: { widget: true } });
377
+
378
+ getTool('widgetOnly').execute.mockRejectedValueOnce(new Error('widget failed'));
379
+ const failRes = mockResponse();
380
+ await handleWidgetToolCall({ body: { tool: 'widgetOnly' } }, failRes);
381
+ expect(failRes.status).toHaveBeenCalledWith(500);
382
+ expect(failRes.json).toHaveBeenCalledWith({ success: false, error: 'widget failed' });
383
+ });
384
+ });