Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
ts 324 lines 12.2 KB
Raw
1 import { describe, it, expect, vi, afterEach } from '@effect/vitest';
2 import { ConfigProvider, Effect } from 'effect';
3 import { liveEnvConfigProvider } from 'test/__utils__';
4 import {
5 getToolkitVersionOverrides,
6 buildToolkitVersionSpecs,
7 groupByVersion,
8 sanitizeVersionString,
9 buildVersionMapFromSpecs,
10 type ToolkitVersionOverrides,
11 type ToolkitVersionSpec,
12 } from 'src/effects/toolkit-version-overrides';
13
14 describe('toolkit-version-overrides', () => {
15 afterEach(() => {
16 // Clean up env vars after each test
17 vi.unstubAllEnvs();
18 });
19
20 describe('getToolkitVersionOverrides', () => {
21 it.effect('should return empty map when no env vars set', () =>
22 Effect.gen(function* () {
23 const result = yield* getToolkitVersionOverrides.pipe(
24 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
25 );
26 expect(result.size).toBe(0);
27 })
28 );
29
30 it.effect('should parse single env var with COMPOSIO_ prefix', () =>
31 Effect.gen(function* () {
32 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00');
33 const result = yield* getToolkitVersionOverrides.pipe(
34 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
35 );
36 expect(result.get('gmail')).toBe('20250901_00');
37 expect(result.size).toBe(1);
38 })
39 );
40
41 it.effect('should parse multiple env vars', () =>
42 Effect.gen(function* () {
43 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00');
44 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_SLACK', '20250815_00');
45 const result = yield* getToolkitVersionOverrides.pipe(
46 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
47 );
48 expect(result.get('gmail')).toBe('20250901_00');
49 expect(result.get('slack')).toBe('20250815_00');
50 expect(result.size).toBe(2);
51 })
52 );
53
54 it.effect('should lowercase toolkit name from env var', () =>
55 Effect.gen(function* () {
56 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00');
57 const result = yield* getToolkitVersionOverrides.pipe(
58 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
59 );
60 expect(result.has('gmail')).toBe(true);
61 // Cast to bypass type check - we're testing runtime behavior that uppercase keys are not stored
62 expect(result.has('GMAIL' as Lowercase<string>)).toBe(false);
63 })
64 );
65
66 it.effect('should ignore "latest" as explicit value', () =>
67 Effect.gen(function* () {
68 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', 'latest');
69 const result = yield* getToolkitVersionOverrides.pipe(
70 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
71 );
72 expect(result.size).toBe(0);
73 })
74 );
75
76 it.effect('should ignore empty string values', () =>
77 Effect.gen(function* () {
78 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '');
79 const result = yield* getToolkitVersionOverrides.pipe(
80 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
81 );
82 expect(result.size).toBe(0);
83 })
84 );
85
86 it.effect('should not read env vars without COMPOSIO_ prefix', () =>
87 Effect.gen(function* () {
88 vi.stubEnv('TOOLKIT_VERSION_GMAIL', '20250901_00');
89 const result = yield* getToolkitVersionOverrides.pipe(
90 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
91 );
92 expect(result.size).toBe(0);
93 })
94 );
95
96 it.effect('should handle mixed valid and invalid entries', () =>
97 Effect.gen(function* () {
98 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00');
99 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_SLACK', 'latest'); // Should be ignored
100 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GITHUB', ''); // Should be ignored
101 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_NOTION', '20250815_00');
102 const result = yield* getToolkitVersionOverrides.pipe(
103 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
104 );
105 expect(result.size).toBe(2);
106 expect(result.get('gmail')).toBe('20250901_00');
107 expect(result.get('notion')).toBe('20250815_00');
108 })
109 );
110 });
111
112 describe('buildToolkitVersionSpecs', () => {
113 it('should apply overrides to matching toolkits', () => {
114 const overrides: ToolkitVersionOverrides = new Map([['gmail', '20250901_00']]);
115 const specs = buildToolkitVersionSpecs(['gmail', 'slack'], overrides);
116
117 expect(specs).toEqual([
118 { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
119 { toolkitSlug: 'slack', toolkitVersion: 'latest' },
120 ]);
121 });
122
123 it('should handle case-insensitive matching', () => {
124 const overrides: ToolkitVersionOverrides = new Map([['gmail', '20250901_00']]);
125 const specs = buildToolkitVersionSpecs(['GMAIL', 'Slack'], overrides);
126
127 expect(specs).toEqual([
128 { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
129 { toolkitSlug: 'slack', toolkitVersion: 'latest' },
130 ]);
131 });
132
133 it('should return all latest when no overrides', () => {
134 const overrides: ToolkitVersionOverrides = new Map();
135 const specs = buildToolkitVersionSpecs(['gmail', 'slack', 'github'], overrides);
136
137 expect(specs).toEqual([
138 { toolkitSlug: 'gmail', toolkitVersion: 'latest' },
139 { toolkitSlug: 'slack', toolkitVersion: 'latest' },
140 { toolkitSlug: 'github', toolkitVersion: 'latest' },
141 ]);
142 });
143
144 it('should handle multiple overrides', () => {
145 const overrides: ToolkitVersionOverrides = new Map([
146 ['gmail', '20250901_00'],
147 ['slack', '20250815_00'],
148 ]);
149 const specs = buildToolkitVersionSpecs(['gmail', 'slack', 'github'], overrides);
150
151 expect(specs).toEqual([
152 { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
153 { toolkitSlug: 'slack', toolkitVersion: '20250815_00' },
154 { toolkitSlug: 'github', toolkitVersion: 'latest' },
155 ]);
156 });
157
158 it('should handle empty slug array', () => {
159 const overrides: ToolkitVersionOverrides = new Map([['gmail', '20250901_00']]);
160 const specs = buildToolkitVersionSpecs([], overrides);
161
162 expect(specs).toEqual([]);
163 });
164 });
165
166 describe('groupByVersion', () => {
167 it('should group toolkits by version', () => {
168 const specs: ToolkitVersionSpec[] = [
169 { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
170 { toolkitSlug: 'slack', toolkitVersion: 'latest' },
171 { toolkitSlug: 'github', toolkitVersion: '20250901_00' },
172 ];
173 const grouped = groupByVersion(specs);
174
175 expect(grouped.get('20250901_00')).toEqual(['gmail', 'github']);
176 expect(grouped.get('latest')).toEqual(['slack']);
177 expect(grouped.size).toBe(2);
178 });
179
180 it('should handle all same version', () => {
181 const specs: ToolkitVersionSpec[] = [
182 { toolkitSlug: 'gmail', toolkitVersion: 'latest' },
183 { toolkitSlug: 'slack', toolkitVersion: 'latest' },
184 ];
185 const grouped = groupByVersion(specs);
186
187 expect(grouped.size).toBe(1);
188 expect(grouped.get('latest')).toEqual(['gmail', 'slack']);
189 });
190
191 it('should handle all different versions', () => {
192 const specs: ToolkitVersionSpec[] = [
193 { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
194 { toolkitSlug: 'slack', toolkitVersion: '20250815_00' },
195 { toolkitSlug: 'github', toolkitVersion: '20250710_00' },
196 ];
197 const grouped = groupByVersion(specs);
198
199 expect(grouped.size).toBe(3);
200 expect(grouped.get('20250901_00')).toEqual(['gmail']);
201 expect(grouped.get('20250815_00')).toEqual(['slack']);
202 expect(grouped.get('20250710_00')).toEqual(['github']);
203 });
204
205 it('should handle empty specs array', () => {
206 const specs: ToolkitVersionSpec[] = [];
207 const grouped = groupByVersion(specs);
208
209 expect(grouped.size).toBe(0);
210 });
211
212 it('should preserve order within version groups', () => {
213 const specs: ToolkitVersionSpec[] = [
214 { toolkitSlug: 'gmail', toolkitVersion: 'latest' },
215 { toolkitSlug: 'slack', toolkitVersion: 'latest' },
216 { toolkitSlug: 'github', toolkitVersion: 'latest' },
217 { toolkitSlug: 'notion', toolkitVersion: 'latest' },
218 ];
219 const grouped = groupByVersion(specs);
220
221 expect(grouped.get('latest')).toEqual(['gmail', 'slack', 'github', 'notion']);
222 });
223 });
224
225 describe('sanitizeVersionString', () => {
226 it('should return valid version strings unchanged', () => {
227 expect(sanitizeVersionString('20250901_00')).toBe('20250901_00');
228 expect(sanitizeVersionString('v1.2.3')).toBe('v1.2.3');
229 expect(sanitizeVersionString('latest')).toBe('latest');
230 expect(sanitizeVersionString('1.0.0-beta.1')).toBe('1.0.0-beta.1');
231 });
232
233 it('should remove invalid characters', () => {
234 expect(sanitizeVersionString('20250901_00!')).toBe('20250901_00');
235 expect(sanitizeVersionString('version@123')).toBe('version123');
236 expect(sanitizeVersionString('v1.2.3#tag')).toBe('v1.2.3tag');
237 });
238
239 it('should handle unicode and special characters', () => {
240 expect(sanitizeVersionString('版本1.0')).toBe('1.0');
241 expect(sanitizeVersionString('v1.0\n\t')).toBe('v1.0');
242 expect(sanitizeVersionString('$version$')).toBe('version');
243 });
244
245 it('should return null for empty or all-invalid strings', () => {
246 expect(sanitizeVersionString('')).toBe(null);
247 expect(sanitizeVersionString('$$$')).toBe(null);
248 expect(sanitizeVersionString(' ')).toBe(null);
249 });
250
251 it('should allow alphanumeric, hyphens, underscores, and dots', () => {
252 expect(sanitizeVersionString('abc-123_456.789')).toBe('abc-123_456.789');
253 expect(sanitizeVersionString('ABC-XYZ_000.999')).toBe('ABC-XYZ_000.999');
254 });
255 });
256
257 describe('buildVersionMapFromSpecs', () => {
258 it('should build version map excluding latest versions', () => {
259 const specs: ToolkitVersionSpec[] = [
260 { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
261 { toolkitSlug: 'slack', toolkitVersion: 'latest' },
262 { toolkitSlug: 'github', toolkitVersion: '20250815_00' },
263 ];
264 const versionMap = buildVersionMapFromSpecs(specs);
265
266 expect(versionMap.size).toBe(2);
267 expect(versionMap.get('gmail')).toBe('20250901_00');
268 expect(versionMap.get('github')).toBe('20250815_00');
269 expect(versionMap.has('slack')).toBe(false);
270 });
271
272 it('should return empty map when all versions are latest', () => {
273 const specs: ToolkitVersionSpec[] = [
274 { toolkitSlug: 'gmail', toolkitVersion: 'latest' },
275 { toolkitSlug: 'slack', toolkitVersion: 'latest' },
276 ];
277 const versionMap = buildVersionMapFromSpecs(specs);
278
279 expect(versionMap.size).toBe(0);
280 });
281
282 it('should return empty map for empty specs', () => {
283 const versionMap = buildVersionMapFromSpecs([]);
284 expect(versionMap.size).toBe(0);
285 });
286
287 it('should include all non-latest versions', () => {
288 const specs: ToolkitVersionSpec[] = [
289 { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
290 { toolkitSlug: 'slack', toolkitVersion: '20250815_00' },
291 { toolkitSlug: 'github', toolkitVersion: '20250710_00' },
292 ];
293 const versionMap = buildVersionMapFromSpecs(specs);
294
295 expect(versionMap.size).toBe(3);
296 expect(versionMap.get('gmail')).toBe('20250901_00');
297 expect(versionMap.get('slack')).toBe('20250815_00');
298 expect(versionMap.get('github')).toBe('20250710_00');
299 });
300 });
301
302 describe('getToolkitVersionOverrides with sanitization', () => {
303 it.effect('should sanitize version strings with invalid characters', () =>
304 Effect.gen(function* () {
305 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00!@#');
306 const result = yield* getToolkitVersionOverrides.pipe(
307 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
308 );
309 expect(result.get('gmail')).toBe('20250901_00');
310 expect(result.size).toBe(1);
311 })
312 );
313
314 it.effect('should ignore version strings that become empty after sanitization', () =>
315 Effect.gen(function* () {
316 vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '$$$');
317 const result = yield* getToolkitVersionOverrides.pipe(
318 Effect.provide(ConfigProvider.layer(liveEnvConfigProvider))
319 );
320 expect(result.size).toBe(0);
321 })
322 );
323 });
324 });