Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 04:45 UTC
| 1 | import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; |
| 2 | import { getToolkitVersionsFromEnv } from '../../src/utils/sdk'; |
| 3 | import { getToolkitVersion } from '../../src/utils/toolkitVersion'; |
| 4 | import { getEnvsWithPrefix } from '../../src/utils/env'; |
| 5 | import { ToolkitVersions } from '../../src/types/tool.types'; |
| 6 | |
| 7 | describe('Version Management', () => { |
| 8 | const originalEnv = process.env; |
| 9 | |
| 10 | beforeEach(() => { |
| 11 | // Reset environment variables before each test |
| 12 | vi.resetModules(); |
| 13 | process.env = { ...originalEnv }; |
| 14 | }); |
| 15 | |
| 16 | afterEach(() => { |
| 17 | // Restore original environment |
| 18 | process.env = originalEnv; |
| 19 | vi.clearAllMocks(); |
| 20 | }); |
| 21 | |
| 22 | describe('getEnvsWithPrefix', () => { |
| 23 | it('should return environment variables with the specified prefix', () => { |
| 24 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250902_00'; |
| 25 | process.env.COMPOSIO_TOOLKIT_VERSION_SLACK = 'latest'; |
| 26 | process.env.COMPOSIO_TOOLKIT_VERSION_GMAIL = '20250901_01'; |
| 27 | process.env.OTHER_ENV_VAR = 'should_not_be_included'; |
| 28 | |
| 29 | const result = getEnvsWithPrefix('COMPOSIO_TOOLKIT_VERSION_'); |
| 30 | |
| 31 | expect(result).toEqual({ |
| 32 | COMPOSIO_TOOLKIT_VERSION_GITHUB: '20250902_00', |
| 33 | COMPOSIO_TOOLKIT_VERSION_SLACK: 'latest', |
| 34 | COMPOSIO_TOOLKIT_VERSION_GMAIL: '20250901_01', |
| 35 | }); |
| 36 | expect(result).not.toHaveProperty('OTHER_ENV_VAR'); |
| 37 | }); |
| 38 | |
| 39 | it('should return empty object when no matching environment variables exist', () => { |
| 40 | process.env.SOME_OTHER_VAR = 'value'; |
| 41 | |
| 42 | const result = getEnvsWithPrefix('COMPOSIO_TOOLKIT_VERSION_'); |
| 43 | |
| 44 | expect(result).toEqual({}); |
| 45 | }); |
| 46 | |
| 47 | it('should return empty object when prefix is empty', () => { |
| 48 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250902_00'; |
| 49 | |
| 50 | const result = getEnvsWithPrefix(''); |
| 51 | |
| 52 | // Should return all env vars when prefix is empty |
| 53 | expect(Object.keys(result).length).toBeGreaterThan(0); |
| 54 | expect(result).toHaveProperty('COMPOSIO_TOOLKIT_VERSION_GITHUB'); |
| 55 | }); |
| 56 | |
| 57 | it('should handle process.env being undefined gracefully', () => { |
| 58 | const originalProcess = process; |
| 59 | // @ts-expect-error: Intentionally testing edge case |
| 60 | global.process = undefined; |
| 61 | |
| 62 | const result = getEnvsWithPrefix('COMPOSIO_TOOLKIT_VERSION_'); |
| 63 | |
| 64 | expect(result).toEqual({}); |
| 65 | |
| 66 | // Restore process |
| 67 | global.process = originalProcess; |
| 68 | }); |
| 69 | |
| 70 | it('should handle errors gracefully', () => { |
| 71 | // Mock process.env to throw an error |
| 72 | const mockProcess = { |
| 73 | env: new Proxy( |
| 74 | {}, |
| 75 | { |
| 76 | get() { |
| 77 | throw new Error('Test error'); |
| 78 | }, |
| 79 | } |
| 80 | ), |
| 81 | }; |
| 82 | |
| 83 | vi.stubGlobal('process', mockProcess); |
| 84 | |
| 85 | const result = getEnvsWithPrefix('COMPOSIO_TOOLKIT_VERSION_'); |
| 86 | |
| 87 | expect(result).toEqual({}); |
| 88 | |
| 89 | vi.unstubAllGlobals(); |
| 90 | }); |
| 91 | }); |
| 92 | |
| 93 | describe('getToolkitVersionsFromEnv', () => { |
| 94 | describe('when user provides string version (global version)', () => { |
| 95 | it('should return the string version as-is when user provides "latest"', () => { |
| 96 | const result = getToolkitVersionsFromEnv('latest'); |
| 97 | expect(result).toBe('latest'); |
| 98 | }); |
| 99 | |
| 100 | it('should return the string version as-is when user provides specific version', () => { |
| 101 | const result = getToolkitVersionsFromEnv('20250902_00' as unknown); |
| 102 | expect(result).toBe('20250902_00'); |
| 103 | }); |
| 104 | |
| 105 | it('should ignore environment variables when user provides string version', () => { |
| 106 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250901_01'; |
| 107 | process.env.COMPOSIO_TOOLKIT_VERSION_SLACK = 'latest'; |
| 108 | |
| 109 | const result = getToolkitVersionsFromEnv('20250902_00' as unknown); |
| 110 | expect(result).toBe('20250902_00'); |
| 111 | }); |
| 112 | }); |
| 113 | |
| 114 | describe('when user provides object version mapping', () => { |
| 115 | it('should normalize toolkit names to lowercase', () => { |
| 116 | const userVersions = { |
| 117 | GITHUB: '20250902_00', |
| 118 | Slack: 'latest', |
| 119 | gmail: '20250901_01', |
| 120 | }; |
| 121 | |
| 122 | const result = getToolkitVersionsFromEnv(userVersions) as ToolkitVersions; |
| 123 | |
| 124 | expect(result).toEqual({ |
| 125 | github: '20250902_00', |
| 126 | slack: 'latest', |
| 127 | gmail: '20250901_01', |
| 128 | }); |
| 129 | }); |
| 130 | |
| 131 | it('should merge environment variables with user-provided versions', () => { |
| 132 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250901_00'; |
| 133 | process.env.COMPOSIO_TOOLKIT_VERSION_NOTION = 'latest'; |
| 134 | |
| 135 | const userVersions = { |
| 136 | slack: '20250902_00', |
| 137 | gmail: 'latest', |
| 138 | }; |
| 139 | |
| 140 | const result = getToolkitVersionsFromEnv(userVersions) as ToolkitVersions; |
| 141 | |
| 142 | expect(result).toEqual({ |
| 143 | github: '20250901_00', // from env |
| 144 | notion: 'latest', // from env |
| 145 | slack: '20250902_00', // from user |
| 146 | gmail: 'latest', // from user |
| 147 | }); |
| 148 | }); |
| 149 | |
| 150 | it('should prioritize user-provided versions over environment variables', () => { |
| 151 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250901_00'; |
| 152 | process.env.COMPOSIO_TOOLKIT_VERSION_SLACK = '20250901_01'; |
| 153 | |
| 154 | const userVersions = { |
| 155 | github: '20250902_00', // should override env |
| 156 | slack: 'latest', // should override env |
| 157 | gmail: '20250902_01', // new toolkit |
| 158 | }; |
| 159 | |
| 160 | const result = getToolkitVersionsFromEnv(userVersions) as ToolkitVersions; |
| 161 | |
| 162 | expect(result).toEqual({ |
| 163 | github: '20250902_00', // user version takes precedence |
| 164 | slack: 'latest', // user version takes precedence |
| 165 | gmail: '20250902_01', // from user |
| 166 | }); |
| 167 | }); |
| 168 | |
| 169 | it('should handle mixed case environment variables correctly', () => { |
| 170 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250901_00'; |
| 171 | process.env.COMPOSIO_TOOLKIT_VERSION_SLACK = 'latest'; |
| 172 | |
| 173 | const result = getToolkitVersionsFromEnv({}) as ToolkitVersions; |
| 174 | |
| 175 | expect(result).toEqual({ |
| 176 | github: '20250901_00', // normalized to lowercase |
| 177 | slack: 'latest', // normalized to lowercase |
| 178 | }); |
| 179 | }); |
| 180 | }); |
| 181 | |
| 182 | describe('when no user versions provided', () => { |
| 183 | it('should return environment variables only', () => { |
| 184 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250901_00'; |
| 185 | process.env.COMPOSIO_TOOLKIT_VERSION_SLACK = 'latest'; |
| 186 | |
| 187 | const result = getToolkitVersionsFromEnv() as ToolkitVersions; |
| 188 | |
| 189 | expect(result).toEqual({ |
| 190 | github: '20250901_00', |
| 191 | slack: 'latest', |
| 192 | }); |
| 193 | }); |
| 194 | |
| 195 | it('should return "latest" when no environment variables or user versions exist', () => { |
| 196 | const result = getToolkitVersionsFromEnv(); |
| 197 | expect(result).toBe('latest'); |
| 198 | }); |
| 199 | |
| 200 | it('should return "latest" when empty object is provided and no env vars exist', () => { |
| 201 | const result = getToolkitVersionsFromEnv({}); |
| 202 | expect(result).toBe('latest'); |
| 203 | }); |
| 204 | |
| 205 | it('should handle undefined input correctly', () => { |
| 206 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250901_00'; |
| 207 | |
| 208 | const result = getToolkitVersionsFromEnv(undefined) as ToolkitVersions; |
| 209 | |
| 210 | expect(result).toEqual({ |
| 211 | github: '20250901_00', |
| 212 | }); |
| 213 | }); |
| 214 | }); |
| 215 | |
| 216 | describe('environment variable parsing', () => { |
| 217 | it('should extract toolkit names correctly from environment variables', () => { |
| 218 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB_ENTERPRISE = '20250901_00'; |
| 219 | process.env.COMPOSIO_TOOLKIT_VERSION_GOOGLE_WORKSPACE = 'latest'; |
| 220 | process.env.COMPOSIO_TOOLKIT_VERSION_MS_TEAMS = '20250902_00'; |
| 221 | |
| 222 | const result = getToolkitVersionsFromEnv() as ToolkitVersions; |
| 223 | |
| 224 | expect(result).toEqual({ |
| 225 | github_enterprise: '20250901_00', |
| 226 | google_workspace: 'latest', |
| 227 | ms_teams: '20250902_00', |
| 228 | }); |
| 229 | }); |
| 230 | |
| 231 | it('should handle environment variables with special characters', () => { |
| 232 | process.env['COMPOSIO_TOOLKIT_VERSION_MY-TOOLKIT'] = '20250901_00'; |
| 233 | process.env['COMPOSIO_TOOLKIT_VERSION_ANOTHER_TOOLKIT'] = 'latest'; |
| 234 | |
| 235 | const result = getToolkitVersionsFromEnv() as ToolkitVersions; |
| 236 | |
| 237 | expect(result).toEqual({ |
| 238 | 'my-toolkit': '20250901_00', |
| 239 | another_toolkit: 'latest', |
| 240 | }); |
| 241 | }); |
| 242 | }); |
| 243 | }); |
| 244 | |
| 245 | describe('getToolkitVersion', () => { |
| 246 | describe('when toolkitVersions is a string (global version)', () => { |
| 247 | it('should return the global version for any toolkit', () => { |
| 248 | const result1 = getToolkitVersion('github', 'latest'); |
| 249 | const result2 = getToolkitVersion('slack', 'latest'); |
| 250 | const result3 = getToolkitVersion('gmail', 'latest'); |
| 251 | |
| 252 | expect(result1).toBe('latest'); |
| 253 | expect(result2).toBe('latest'); |
| 254 | expect(result3).toBe('latest'); |
| 255 | }); |
| 256 | }); |
| 257 | |
| 258 | describe('when toolkitVersions is an object mapping', () => { |
| 259 | it('should return specific version for toolkit when available', () => { |
| 260 | const toolkitVersions = { |
| 261 | github: '20250902_00', |
| 262 | slack: 'latest', |
| 263 | gmail: '20250901_01', |
| 264 | }; |
| 265 | |
| 266 | expect(getToolkitVersion('github', toolkitVersions)).toBe('20250902_00'); |
| 267 | expect(getToolkitVersion('slack', toolkitVersions)).toBe('latest'); |
| 268 | expect(getToolkitVersion('gmail', toolkitVersions)).toBe('20250901_01'); |
| 269 | }); |
| 270 | |
| 271 | it('should return "latest" for toolkit not in the mapping', () => { |
| 272 | const toolkitVersions = { |
| 273 | github: '20250902_00', |
| 274 | slack: 'latest', |
| 275 | }; |
| 276 | |
| 277 | const result = getToolkitVersion('notion', toolkitVersions); |
| 278 | expect(result).toBe('latest'); |
| 279 | }); |
| 280 | |
| 281 | it('should handle empty object mapping', () => { |
| 282 | const result = getToolkitVersion('github', {}); |
| 283 | expect(result).toBe('latest'); |
| 284 | }); |
| 285 | |
| 286 | it('should resolve the lookup slug case-insensitively', () => { |
| 287 | // Version maps are keyed by normalized (lowercase) slugs (write side |
| 288 | // covered by 'should normalize toolkit names to lowercase'), so the read |
| 289 | // side must resolve any casing instead of falling back to 'latest'. |
| 290 | const toolkitVersions = { |
| 291 | github: '20250902_00', |
| 292 | }; |
| 293 | |
| 294 | expect(getToolkitVersion('github', toolkitVersions)).toBe('20250902_00'); |
| 295 | expect(getToolkitVersion('GITHUB', toolkitVersions)).toBe('20250902_00'); |
| 296 | expect(getToolkitVersion('GitHub', toolkitVersions)).toBe('20250902_00'); |
| 297 | }); |
| 298 | }); |
| 299 | |
| 300 | describe('when toolkitVersions is undefined or null', () => { |
| 301 | it('should return "latest" when toolkitVersions is undefined', () => { |
| 302 | const result = getToolkitVersion('github', undefined); |
| 303 | expect(result).toBe('latest'); |
| 304 | }); |
| 305 | |
| 306 | it('should return "latest" when toolkitVersions is null', () => { |
| 307 | const result = getToolkitVersion('github', null as unknown); |
| 308 | expect(result).toBe('latest'); |
| 309 | }); |
| 310 | }); |
| 311 | |
| 312 | describe('edge cases', () => { |
| 313 | it('should handle empty toolkit slug', () => { |
| 314 | const toolkitVersions = { |
| 315 | '': '20250902_00', |
| 316 | github: 'latest', |
| 317 | }; |
| 318 | |
| 319 | expect(getToolkitVersion('', toolkitVersions)).toBe('20250902_00'); |
| 320 | expect(getToolkitVersion('github', toolkitVersions)).toBe('latest'); |
| 321 | }); |
| 322 | |
| 323 | it('should handle toolkit slug with special characters', () => { |
| 324 | const toolkitVersions = { |
| 325 | 'my-toolkit': '20250902_00', |
| 326 | another_toolkit: 'latest', |
| 327 | 'toolkit.with.dots': '20250901_00', |
| 328 | }; |
| 329 | |
| 330 | expect(getToolkitVersion('my-toolkit', toolkitVersions)).toBe('20250902_00'); |
| 331 | expect(getToolkitVersion('another_toolkit', toolkitVersions)).toBe('latest'); |
| 332 | expect(getToolkitVersion('toolkit.with.dots', toolkitVersions)).toBe('20250901_00'); |
| 333 | }); |
| 334 | |
| 335 | it('should handle version values that are not strings', () => { |
| 336 | const toolkitVersions = { |
| 337 | github: '20250902_00', |
| 338 | slack: 'latest', |
| 339 | } as unknown; |
| 340 | |
| 341 | expect(getToolkitVersion('github', toolkitVersions)).toBe('20250902_00'); |
| 342 | expect(getToolkitVersion('slack', toolkitVersions)).toBe('latest'); |
| 343 | }); |
| 344 | }); |
| 345 | }); |
| 346 | |
| 347 | describe('Integration tests', () => { |
| 348 | it('should work together: getToolkitVersionsFromEnv + getToolkitVersion', () => { |
| 349 | // Set up environment |
| 350 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250901_00'; |
| 351 | process.env.COMPOSIO_TOOLKIT_VERSION_SLACK = 'latest'; |
| 352 | |
| 353 | // User provides additional versions |
| 354 | const userVersions = { |
| 355 | GMAIL: '20250902_00', // will be normalized to lowercase |
| 356 | notion: 'latest', |
| 357 | }; |
| 358 | |
| 359 | // Get toolkit versions configuration |
| 360 | const toolkitVersions = getToolkitVersionsFromEnv(userVersions) as ToolkitVersions; |
| 361 | |
| 362 | // Test individual toolkit version retrieval |
| 363 | expect(getToolkitVersion('github', toolkitVersions)).toBe('20250901_00'); // from env |
| 364 | expect(getToolkitVersion('slack', toolkitVersions)).toBe('latest'); // from env |
| 365 | expect(getToolkitVersion('gmail', toolkitVersions)).toBe('20250902_00'); // from user |
| 366 | expect(getToolkitVersion('notion', toolkitVersions)).toBe('latest'); // from user |
| 367 | expect(getToolkitVersion('unknown', toolkitVersions)).toBe('latest'); // fallback |
| 368 | }); |
| 369 | |
| 370 | it('should handle global version override correctly', () => { |
| 371 | // Set up environment (should be ignored) |
| 372 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = '20250901_00'; |
| 373 | process.env.COMPOSIO_TOOLKIT_VERSION_SLACK = 'latest'; |
| 374 | |
| 375 | // User provides global version |
| 376 | const toolkitVersions = getToolkitVersionsFromEnv('20250902_00' as unknown); |
| 377 | |
| 378 | // All toolkits should get the global version |
| 379 | expect(getToolkitVersion('github', toolkitVersions)).toBe('20250902_00'); |
| 380 | expect(getToolkitVersion('slack', toolkitVersions)).toBe('20250902_00'); |
| 381 | expect(getToolkitVersion('gmail', toolkitVersions)).toBe('20250902_00'); |
| 382 | expect(getToolkitVersion('any-toolkit', toolkitVersions)).toBe('20250902_00'); |
| 383 | }); |
| 384 | |
| 385 | it('should fall back to "latest" when no configuration is provided', () => { |
| 386 | // No environment variables, no user input |
| 387 | const toolkitVersions = getToolkitVersionsFromEnv(); |
| 388 | |
| 389 | expect(toolkitVersions).toBe('latest'); |
| 390 | expect(getToolkitVersion('github', toolkitVersions)).toBe('latest'); |
| 391 | expect(getToolkitVersion('slack', toolkitVersions)).toBe('latest'); |
| 392 | expect(getToolkitVersion('any-toolkit', toolkitVersions)).toBe('latest'); |
| 393 | }); |
| 394 | |
| 395 | it('should demonstrate priority order: user object > env vars > fallback', () => { |
| 396 | // Environment variables |
| 397 | process.env.COMPOSIO_TOOLKIT_VERSION_GITHUB = 'env_version'; |
| 398 | process.env.COMPOSIO_TOOLKIT_VERSION_SLACK = 'env_slack_version'; |
| 399 | |
| 400 | // User provides partial override |
| 401 | const userVersions = { |
| 402 | github: 'user_version', // overrides env |
| 403 | gmail: 'user_gmail_version', // new toolkit |
| 404 | // slack not specified, should use env |
| 405 | }; |
| 406 | |
| 407 | const toolkitVersions = getToolkitVersionsFromEnv(userVersions) as ToolkitVersions; |
| 408 | |
| 409 | expect(getToolkitVersion('github', toolkitVersions)).toBe('user_version'); // user wins |
| 410 | expect(getToolkitVersion('slack', toolkitVersions)).toBe('env_slack_version'); // from env |
| 411 | expect(getToolkitVersion('gmail', toolkitVersions)).toBe('user_gmail_version'); // from user |
| 412 | expect(getToolkitVersion('notion', toolkitVersions)).toBe('latest'); // fallback |
| 413 | }); |
| 414 | }); |
| 415 | }); |