Skip to content

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

11.3 KB
Raw Blame
import { describe, it, expect, vi, afterEach } from '@effect/vitest';
import { Effect } from 'effect';
import {
  getToolkitVersionOverrides,
  buildToolkitVersionSpecs,
  groupByVersion,
  sanitizeVersionString,
  buildVersionMapFromSpecs,
  type ToolkitVersionOverrides,
  type ToolkitVersionSpec,
} from 'src/effects/toolkit-version-overrides';

describe('toolkit-version-overrides', () => {
  afterEach(() => {
    // Clean up env vars after each test
    vi.unstubAllEnvs();
  });

  describe('getToolkitVersionOverrides', () => {
    it.effect('should return empty map when no env vars set', () =>
      Effect.gen(function* () {
        const result = yield* getToolkitVersionOverrides;
        expect(result.size).toBe(0);
      })
    );

    it.effect('should parse single env var with COMPOSIO_ prefix', () =>
      Effect.gen(function* () {
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00');
        const result = yield* getToolkitVersionOverrides;
        expect(result.get('gmail')).toBe('20250901_00');
        expect(result.size).toBe(1);
      })
    );

    it.effect('should parse multiple env vars', () =>
      Effect.gen(function* () {
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00');
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_SLACK', '20250815_00');
        const result = yield* getToolkitVersionOverrides;
        expect(result.get('gmail')).toBe('20250901_00');
        expect(result.get('slack')).toBe('20250815_00');
        expect(result.size).toBe(2);
      })
    );

    it.effect('should lowercase toolkit name from env var', () =>
      Effect.gen(function* () {
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00');
        const result = yield* getToolkitVersionOverrides;
        expect(result.has('gmail')).toBe(true);
        // Cast to bypass type check - we're testing runtime behavior that uppercase keys are not stored
        expect(result.has('GMAIL' as Lowercase<string>)).toBe(false);
      })
    );

    it.effect('should ignore "latest" as explicit value', () =>
      Effect.gen(function* () {
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', 'latest');
        const result = yield* getToolkitVersionOverrides;
        expect(result.size).toBe(0);
      })
    );

    it.effect('should ignore empty string values', () =>
      Effect.gen(function* () {
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '');
        const result = yield* getToolkitVersionOverrides;
        expect(result.size).toBe(0);
      })
    );

    it.effect('should not read env vars without COMPOSIO_ prefix', () =>
      Effect.gen(function* () {
        vi.stubEnv('TOOLKIT_VERSION_GMAIL', '20250901_00');
        const result = yield* getToolkitVersionOverrides;
        expect(result.size).toBe(0);
      })
    );

    it.effect('should handle mixed valid and invalid entries', () =>
      Effect.gen(function* () {
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00');
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_SLACK', 'latest'); // Should be ignored
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GITHUB', ''); // Should be ignored
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_NOTION', '20250815_00');
        const result = yield* getToolkitVersionOverrides;
        expect(result.size).toBe(2);
        expect(result.get('gmail')).toBe('20250901_00');
        expect(result.get('notion')).toBe('20250815_00');
      })
    );
  });

  describe('buildToolkitVersionSpecs', () => {
    it('should apply overrides to matching toolkits', () => {
      const overrides: ToolkitVersionOverrides = new Map([['gmail', '20250901_00']]);
      const specs = buildToolkitVersionSpecs(['gmail', 'slack'], overrides);

      expect(specs).toEqual([
        { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
        { toolkitSlug: 'slack', toolkitVersion: 'latest' },
      ]);
    });

    it('should handle case-insensitive matching', () => {
      const overrides: ToolkitVersionOverrides = new Map([['gmail', '20250901_00']]);
      const specs = buildToolkitVersionSpecs(['GMAIL', 'Slack'], overrides);

      expect(specs).toEqual([
        { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
        { toolkitSlug: 'slack', toolkitVersion: 'latest' },
      ]);
    });

    it('should return all latest when no overrides', () => {
      const overrides: ToolkitVersionOverrides = new Map();
      const specs = buildToolkitVersionSpecs(['gmail', 'slack', 'github'], overrides);

      expect(specs).toEqual([
        { toolkitSlug: 'gmail', toolkitVersion: 'latest' },
        { toolkitSlug: 'slack', toolkitVersion: 'latest' },
        { toolkitSlug: 'github', toolkitVersion: 'latest' },
      ]);
    });

    it('should handle multiple overrides', () => {
      const overrides: ToolkitVersionOverrides = new Map([
        ['gmail', '20250901_00'],
        ['slack', '20250815_00'],
      ]);
      const specs = buildToolkitVersionSpecs(['gmail', 'slack', 'github'], overrides);

      expect(specs).toEqual([
        { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
        { toolkitSlug: 'slack', toolkitVersion: '20250815_00' },
        { toolkitSlug: 'github', toolkitVersion: 'latest' },
      ]);
    });

    it('should handle empty slug array', () => {
      const overrides: ToolkitVersionOverrides = new Map([['gmail', '20250901_00']]);
      const specs = buildToolkitVersionSpecs([], overrides);

      expect(specs).toEqual([]);
    });
  });

  describe('groupByVersion', () => {
    it('should group toolkits by version', () => {
      const specs: ToolkitVersionSpec[] = [
        { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
        { toolkitSlug: 'slack', toolkitVersion: 'latest' },
        { toolkitSlug: 'github', toolkitVersion: '20250901_00' },
      ];
      const grouped = groupByVersion(specs);

      expect(grouped.get('20250901_00')).toEqual(['gmail', 'github']);
      expect(grouped.get('latest')).toEqual(['slack']);
      expect(grouped.size).toBe(2);
    });

    it('should handle all same version', () => {
      const specs: ToolkitVersionSpec[] = [
        { toolkitSlug: 'gmail', toolkitVersion: 'latest' },
        { toolkitSlug: 'slack', toolkitVersion: 'latest' },
      ];
      const grouped = groupByVersion(specs);

      expect(grouped.size).toBe(1);
      expect(grouped.get('latest')).toEqual(['gmail', 'slack']);
    });

    it('should handle all different versions', () => {
      const specs: ToolkitVersionSpec[] = [
        { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
        { toolkitSlug: 'slack', toolkitVersion: '20250815_00' },
        { toolkitSlug: 'github', toolkitVersion: '20250710_00' },
      ];
      const grouped = groupByVersion(specs);

      expect(grouped.size).toBe(3);
      expect(grouped.get('20250901_00')).toEqual(['gmail']);
      expect(grouped.get('20250815_00')).toEqual(['slack']);
      expect(grouped.get('20250710_00')).toEqual(['github']);
    });

    it('should handle empty specs array', () => {
      const specs: ToolkitVersionSpec[] = [];
      const grouped = groupByVersion(specs);

      expect(grouped.size).toBe(0);
    });

    it('should preserve order within version groups', () => {
      const specs: ToolkitVersionSpec[] = [
        { toolkitSlug: 'gmail', toolkitVersion: 'latest' },
        { toolkitSlug: 'slack', toolkitVersion: 'latest' },
        { toolkitSlug: 'github', toolkitVersion: 'latest' },
        { toolkitSlug: 'notion', toolkitVersion: 'latest' },
      ];
      const grouped = groupByVersion(specs);

      expect(grouped.get('latest')).toEqual(['gmail', 'slack', 'github', 'notion']);
    });
  });

  describe('sanitizeVersionString', () => {
    it('should return valid version strings unchanged', () => {
      expect(sanitizeVersionString('20250901_00')).toBe('20250901_00');
      expect(sanitizeVersionString('v1.2.3')).toBe('v1.2.3');
      expect(sanitizeVersionString('latest')).toBe('latest');
      expect(sanitizeVersionString('1.0.0-beta.1')).toBe('1.0.0-beta.1');
    });

    it('should remove invalid characters', () => {
      expect(sanitizeVersionString('20250901_00!')).toBe('20250901_00');
      expect(sanitizeVersionString('version@123')).toBe('version123');
      expect(sanitizeVersionString('v1.2.3#tag')).toBe('v1.2.3tag');
    });

    it('should handle unicode and special characters', () => {
      expect(sanitizeVersionString('版本1.0')).toBe('1.0');
      expect(sanitizeVersionString('v1.0\n\t')).toBe('v1.0');
      expect(sanitizeVersionString('$version$')).toBe('version');
    });

    it('should return null for empty or all-invalid strings', () => {
      expect(sanitizeVersionString('')).toBe(null);
      expect(sanitizeVersionString('$$$')).toBe(null);
      expect(sanitizeVersionString('   ')).toBe(null);
    });

    it('should allow alphanumeric, hyphens, underscores, and dots', () => {
      expect(sanitizeVersionString('abc-123_456.789')).toBe('abc-123_456.789');
      expect(sanitizeVersionString('ABC-XYZ_000.999')).toBe('ABC-XYZ_000.999');
    });
  });

  describe('buildVersionMapFromSpecs', () => {
    it('should build version map excluding latest versions', () => {
      const specs: ToolkitVersionSpec[] = [
        { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
        { toolkitSlug: 'slack', toolkitVersion: 'latest' },
        { toolkitSlug: 'github', toolkitVersion: '20250815_00' },
      ];
      const versionMap = buildVersionMapFromSpecs(specs);

      expect(versionMap.size).toBe(2);
      expect(versionMap.get('gmail')).toBe('20250901_00');
      expect(versionMap.get('github')).toBe('20250815_00');
      expect(versionMap.has('slack')).toBe(false);
    });

    it('should return empty map when all versions are latest', () => {
      const specs: ToolkitVersionSpec[] = [
        { toolkitSlug: 'gmail', toolkitVersion: 'latest' },
        { toolkitSlug: 'slack', toolkitVersion: 'latest' },
      ];
      const versionMap = buildVersionMapFromSpecs(specs);

      expect(versionMap.size).toBe(0);
    });

    it('should return empty map for empty specs', () => {
      const versionMap = buildVersionMapFromSpecs([]);
      expect(versionMap.size).toBe(0);
    });

    it('should include all non-latest versions', () => {
      const specs: ToolkitVersionSpec[] = [
        { toolkitSlug: 'gmail', toolkitVersion: '20250901_00' },
        { toolkitSlug: 'slack', toolkitVersion: '20250815_00' },
        { toolkitSlug: 'github', toolkitVersion: '20250710_00' },
      ];
      const versionMap = buildVersionMapFromSpecs(specs);

      expect(versionMap.size).toBe(3);
      expect(versionMap.get('gmail')).toBe('20250901_00');
      expect(versionMap.get('slack')).toBe('20250815_00');
      expect(versionMap.get('github')).toBe('20250710_00');
    });
  });

  describe('getToolkitVersionOverrides with sanitization', () => {
    it.effect('should sanitize version strings with invalid characters', () =>
      Effect.gen(function* () {
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '20250901_00!@#');
        const result = yield* getToolkitVersionOverrides;
        expect(result.get('gmail')).toBe('20250901_00');
        expect(result.size).toBe(1);
      })
    );

    it.effect('should ignore version strings that become empty after sanitization', () =>
      Effect.gen(function* () {
        vi.stubEnv('COMPOSIO_TOOLKIT_VERSION_GMAIL', '$$$');
        const result = yield* getToolkitVersionOverrides;
        expect(result.size).toBe(0);
      })
    );
  });
});