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.

20.4 KB
Raw Blame
import { describe, it, expect, vi, beforeEach, afterEach, Mock } from 'vitest';
import * as path from 'node:path';
import * as fs from 'node:fs';
import { getFileDataAfterUploadingToS3, downloadFileFromS3 } from '../../src/utils/fileUtils.node';
import ComposioClient from '@composio/client';
import { ComposioSensitiveFilePathBlockedError } from '../../src/errors/FileModifierErrors';

// Mock the uuid module
vi.mock('../../src/utils/uuid', () => ({
  getRandomShortId: vi.fn(() => 'abc12345'),
  getRandomUUID: vi.fn(() => '12345678-1234-1234-1234-123456789012'),
}));

// Mock fs module
vi.mock('fs', () => ({
  default: {
    readFileSync: vi.fn(),
    writeFileSync: vi.fn(),
    existsSync: vi.fn(() => true),
    mkdirSync: vi.fn(),
  },
  readFileSync: vi.fn(),
  writeFileSync: vi.fn(),
  existsSync: vi.fn(() => true),
  mkdirSync: vi.fn(),
}));

// Mock os module
vi.mock('os', () => ({
  default: {
    homedir: vi.fn(() => '/home/test'),
  },
  homedir: vi.fn(() => '/home/test'),
}));

// Mock path module (keep resolve/join for sensitive path checks; basename stays mocked for fileUtils)
vi.mock('path', async importOriginal => {
  const actual = await importOriginal<typeof import('node:path')>();
  return {
    ...actual,
    default: actual,
    basename: vi.fn((p: string) => p.split('/').pop() ?? p),
  };
});

// Mock DNS resolution so the SSRF guard treats test hosts as public without
// hitting the network. (URL uploads route through ssrfSafeFetch, which resolves
// the host and rejects private/internal addresses.)
vi.mock('node:dns/promises', () => ({
  lookup: vi.fn().mockResolvedValue([{ address: '93.184.216.34', family: 4 }]),
}));

// eslint-disable-next-line no-restricted-imports
import { lookup } from 'node:dns/promises';
import { ComposioBlockedInternalUrlError } from '../../src/errors';

const mockLookup = vi.mocked(lookup);

// Mock global fetch
const mockFetch = vi.fn();
global.fetch = mockFetch;

const fetchedFileResponse = (contentType: string = 'application/pdf') =>
  new Response(new Uint8Array(10), {
    status: 200,
    headers: { 'content-type': contentType },
  });

/** A small, well-formed S3 download response (no `content-length` header). */
const downloadedFileResponse = (body: Uint8Array = new Uint8Array(10)) =>
  new Response(body, { status: 200 });

describe('fileUtils', () => {
  let mockClient: ComposioClient;

  beforeEach(() => {
    mockClient = {
      files: {
        createPresignedURL: vi.fn(),
      },
    } as unknown as ComposioClient;

    vi.clearAllMocks();

    // Mock Date.now to return a consistent timestamp
    vi.spyOn(Date, 'now').mockReturnValue(1640995200000); // 2022-01-01 00:00:00
  });

  afterEach(() => {
    vi.restoreAllMocks();
  });

  describe('URL filename generation with query parameters', () => {
    beforeEach(() => {
      // Mock successful fetch response
      mockFetch.mockResolvedValue(fetchedFileResponse());

      // Mock successful S3 upload
      (mockClient.files.createPresignedURL as unknown as Mock).mockResolvedValue({
        key: 'test-key',
        type: 'new',
        new_presigned_url: 'https://s3.example.com/upload',
      });

      // Mock successful PUT to S3
      mockFetch.mockImplementation((url, options) => {
        if (options?.method === 'PUT') {
          return Promise.resolve({ ok: true });
        }
        // For the initial file fetch
        return Promise.resolve(fetchedFileResponse());
      });
    });

    it('should handle URLs with query parameters correctly', async () => {
      const urlWithQuery =
        'https://example.com/document.pdf?param1=value1&param2=value2&token=abc123';

      const result = await getFileDataAfterUploadingToS3(urlWithQuery, {
        toolSlug: 'test-tool',
        toolkitSlug: 'test-toolkit',
        client: mockClient,
      });

      expect(result.name).toBe('document.pdf');
      expect(mockFetch).toHaveBeenCalledWith(
        urlWithQuery,
        // Plus a `dispatcher` pinned to the address the guard validated.
        expect.objectContaining({ signal: undefined, redirect: 'manual' })
      );
    });

    it('should generate filename when URL has no filename', async () => {
      const urlWithoutFilename = 'https://example.com/?download=true&format=pdf';

      const result = await getFileDataAfterUploadingToS3(urlWithoutFilename, {
        toolSlug: 'test-tool',
        toolkitSlug: 'test-toolkit',
        client: mockClient,
      });

      expect(result.name).toBe('file_ts1640995200000abc12345.pdf');
    });

    it('should generate filename when URL path ends with slash', async () => {
      const urlEndingWithSlash = 'https://example.com/folder/?type=document';

      const result = await getFileDataAfterUploadingToS3(urlEndingWithSlash, {
        toolSlug: 'test-tool',
        toolkitSlug: 'test-toolkit',
        client: mockClient,
      });

      expect(result.name).toBe('file_ts1640995200000abc12345.pdf');
    });

    it('should add extension to filename without extension based on MIME type', async () => {
      const urlWithoutExtension = 'https://example.com/document?format=pdf';

      const result = await getFileDataAfterUploadingToS3(urlWithoutExtension, {
        toolSlug: 'test-tool',
        toolkitSlug: 'test-toolkit',
        client: mockClient,
      });

      expect(result.name).toBe('file_ts1640995200000abc12345.pdf');
    });

    it('should reject an oversized URL response before requesting an upload URL', async () => {
      mockFetch.mockReset();
      mockFetch.mockResolvedValueOnce(
        new Response('small body', {
          status: 200,
          headers: {
            'content-type': 'application/pdf',
            'content-length': String(100 * 1024 * 1024 + 1),
          },
        })
      );

      await expect(
        getFileDataAfterUploadingToS3('https://example.com/oversized.pdf', {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        })
      ).rejects.toThrow('exceeds maximum allowed size');

      expect(mockClient.files.createPresignedURL).not.toHaveBeenCalled();
    });
  });

  describe('MIME type extension handling', () => {
    it('should handle structured MIME types with + correctly', async () => {
      const testCases = [
        { mimeType: 'application/vnd.api+json', expectedExt: 'json' },
        { mimeType: 'application/ld+json', expectedExt: 'json' },
        { mimeType: 'image/svg+xml', expectedExt: 'svg' },
        { mimeType: 'application/atom+xml', expectedExt: 'atom' },
        { mimeType: 'application/rss+xml', expectedExt: 'rss' },
        { mimeType: 'application/hal+json', expectedExt: 'json' },
        { mimeType: 'application/vnd.collection+json', expectedExt: 'json' },
        { mimeType: 'application/vnd.custom+zip', expectedExt: 'zip' },
      ];

      for (const { mimeType, expectedExt } of testCases) {
        // Reset mocks for each iteration
        vi.clearAllMocks();

        // Mock successful fetch response
        mockFetch.mockResolvedValueOnce(fetchedFileResponse(mimeType));

        // Mock successful S3 upload
        (mockClient.files.createPresignedURL as unknown as Mock).mockResolvedValueOnce({
          key: 'test-key',
          type: 'new',
          new_presigned_url: 'https://s3.example.com/upload',
        });

        // Mock successful PUT to S3
        mockFetch.mockResolvedValueOnce({ ok: true });

        const result = await getFileDataAfterUploadingToS3('https://example.com/file', {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        });

        expect(result.name).toBe(`file_ts1640995200000abc12345.${expectedExt}`);
      }
    });

    it('should handle MIME types with parameters', async () => {
      // Reset mocks
      vi.clearAllMocks();

      mockFetch.mockResolvedValueOnce(fetchedFileResponse('text/plain; charset=utf-8'));

      // Mock successful S3 upload
      (mockClient.files.createPresignedURL as unknown as Mock).mockResolvedValueOnce({
        key: 'test-key',
        type: 'new',
        new_presigned_url: 'https://s3.example.com/upload',
      });

      // Mock successful PUT to S3
      mockFetch.mockResolvedValueOnce({ ok: true });

      const result = await getFileDataAfterUploadingToS3('https://example.com/file', {
        toolSlug: 'test-tool',
        toolkitSlug: 'test-toolkit',
        client: mockClient,
      });

      expect(result.name).toBe('file_ts1640995200000abc12345.txt');
    });

    it('should handle common MIME types', async () => {
      const testCases = [
        { mimeType: 'application/pdf', expectedExt: 'pdf' },
        { mimeType: 'image/jpeg', expectedExt: 'jpg' },
        { mimeType: 'image/png', expectedExt: 'png' },
        { mimeType: 'text/html', expectedExt: 'html' },
        { mimeType: 'application/json', expectedExt: 'json' },
        { mimeType: 'video/mp4', expectedExt: 'mp4' },
      ];

      for (const { mimeType, expectedExt } of testCases) {
        // Reset mocks for each iteration
        vi.clearAllMocks();

        mockFetch.mockResolvedValueOnce(fetchedFileResponse(mimeType));

        // Mock successful S3 upload
        (mockClient.files.createPresignedURL as unknown as Mock).mockResolvedValueOnce({
          key: 'test-key',
          type: 'new',
          new_presigned_url: 'https://s3.example.com/upload',
        });

        // Mock successful PUT to S3
        mockFetch.mockResolvedValueOnce({ ok: true });

        const result = await getFileDataAfterUploadingToS3('https://example.com/file', {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        });

        expect(result.name).toBe(`file_ts1640995200000abc12345.${expectedExt}`);
      }
    });

    it('should fallback to generic extraction for unknown MIME types', async () => {
      // Reset mocks
      vi.clearAllMocks();

      mockFetch.mockResolvedValueOnce(fetchedFileResponse('application/custom-format'));

      // Mock successful S3 upload
      (mockClient.files.createPresignedURL as unknown as Mock).mockResolvedValueOnce({
        key: 'test-key',
        type: 'new',
        new_presigned_url: 'https://s3.example.com/upload',
      });

      // Mock successful PUT to S3
      mockFetch.mockResolvedValueOnce({ ok: true });

      const result = await getFileDataAfterUploadingToS3('https://example.com/file', {
        toolSlug: 'test-tool',
        toolkitSlug: 'test-toolkit',
        client: mockClient,
      });

      expect(result.name).toBe('file_ts1640995200000abc12345.custom-format');
    });
  });

  describe('downloadFileFromS3', () => {
    it('should generate filename with tool slug prefix', async () => {
      mockFetch.mockResolvedValue(downloadedFileResponse());

      const result = await downloadFileFromS3({
        toolSlug: 'github',
        s3Url: 'https://s3.example.com/file.txt',
        mimeType: 'text/plain',
      });

      expect(result.name).toBe('github_1640995200000abc12345.txt');
    });

    it('should handle MIME types with + in downloadFileFromS3', async () => {
      mockFetch.mockResolvedValue(downloadedFileResponse());

      const result = await downloadFileFromS3({
        toolSlug: 'api-tool',
        s3Url: 'https://s3.example.com/data.json',
        mimeType: 'application/vnd.api+json',
      });

      expect(result.name).toBe('api-tool_1640995200000abc12345.json');
    });

    it('should handle download failure', async () => {
      mockFetch.mockResolvedValue({
        ok: false,
        statusText: 'Not Found',
      });

      await expect(
        downloadFileFromS3({
          toolSlug: 'test-tool',
          s3Url: 'https://s3.example.com/nonexistent.txt',
          mimeType: 'text/plain',
        })
      ).rejects.toThrow('Failed to download file: Not Found');
    });

    it('synthesizes the filename server-side and ignores the s3Url path', async () => {
      // Regression: lock the invariant that the saved filename comes from
      // (toolSlug, mimeType, timestamp, random id) — never from the s3Url.
      // If a future change started reflecting the s3Url path or query into
      // the local filename, an attacker-controlled CDN response could write
      // outside the download dir or stomp on existing files.
      mockFetch.mockResolvedValue(downloadedFileResponse());

      const result = await downloadFileFromS3({
        toolSlug: 'github',
        // The URL path contains traversal-looking segments and a totally
        // different "filename"; none of this should leak into result.name.
        s3Url:
          'https://s3.example.com/../../../etc/passwd?response-content-disposition=attachment%3Bfilename%3Devil.sh',
        mimeType: 'text/plain',
      });

      expect(result.name).toBe('github_1640995200000abc12345.txt');
      expect(result.name).not.toContain('..');
      expect(result.name).not.toContain('/');
      expect(result.name).not.toContain('passwd');
      expect(result.name).not.toContain('evil');
    });

    it('strips path components from a path-laden toolSlug before saving', async () => {
      // Regression: the prefix is `${toolSlug}_`, so a slug containing `/`
      // could in theory smuggle path components into the saved filename.
      // `saveFile` defends against that by running the assembled filename
      // through `path.basename` before joining with the download dir.
      mockFetch.mockResolvedValue(downloadedFileResponse());

      const result = await downloadFileFromS3({
        toolSlug: 'AAA/../etc/passwd',
        s3Url: 'https://s3.example.com/file.bin',
        mimeType: 'text/plain',
      });

      // `result.name` is the pre-basename string (raw composed name); the
      // actual on-disk path goes through `path.basename`. We assert that
      // the on-disk path stays under the download dir by checking the
      // returned filePath.
      expect(result.filePath).toBeDefined();
      expect(path.dirname(result.filePath as string)).not.toContain('etc');
      expect(path.basename(result.filePath as string)).toBe('passwd_1640995200000abc12345.txt');
    });

    it('rejects a stream that exceeds the download limit and writes nothing', async () => {
      // `s3Url` is an API-response field, so the body behind it is untrusted:
      // without a cap, a dishonest (or absent) Content-Length lets the server
      // stream unbounded bytes into the host process's heap and onto disk.
      mockFetch.mockResolvedValue(downloadedFileResponse(new Uint8Array(2048)));

      await expect(
        downloadFileFromS3({
          toolSlug: 'github',
          s3Url: 'https://s3.example.com/huge.bin',
          mimeType: 'text/plain',
          maxDownloadBytes: 1024,
        })
      ).rejects.toThrow(/exceeds maximum allowed size/);

      expect(fs.writeFileSync).not.toHaveBeenCalled();
    });

    it('downloads a body within the limit', async () => {
      const body = new Uint8Array(512).fill(7);
      mockFetch.mockResolvedValue(downloadedFileResponse(body));

      const result = await downloadFileFromS3({
        toolSlug: 'github',
        s3Url: 'https://s3.example.com/small.bin',
        mimeType: 'text/plain',
        maxDownloadBytes: 1024,
      });

      expect(result.filePath).toBeDefined();
      expect(fs.writeFileSync).toHaveBeenCalledWith(result.filePath, body);
    });
  });

  describe('File object handling', () => {
    it('should handle File objects correctly', async () => {
      // Reset mocks
      vi.clearAllMocks();

      // Mock successful S3 upload
      (mockClient.files.createPresignedURL as unknown as Mock).mockResolvedValueOnce({
        key: 'test-key',
        type: 'new',
        new_presigned_url: 'https://s3.example.com/upload',
      });

      // Mock successful PUT to S3
      mockFetch.mockResolvedValueOnce({ ok: true });

      const fileContent = 'test file content';
      const file = new File([fileContent], 'test.txt', { type: 'text/plain' });

      const result = await getFileDataAfterUploadingToS3(file, {
        toolSlug: 'test-tool',
        toolkitSlug: 'test-toolkit',
        client: mockClient,
      });

      expect(result.name).toBe('test.txt');
      expect(result.mimetype).toBe('text/plain');
    });
  });

  // Note: Local file handling tests are covered in the existing fileModifiers.test.ts

  describe('Error handling', () => {
    it('refuses sensitive local paths before read or S3 (built-in denylist)', async () => {
      await expect(
        getFileDataAfterUploadingToS3(path.join('/home/test', '.aws', 'creds'), {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        })
      ).rejects.toThrow(ComposioSensitiveFilePathBlockedError);
    });

    it('treats a local path that merely starts with "http" as a path, not a URL', async () => {
      // Regression test: a naive `.startsWith('http')` check would misclassify
      // this as a URL and skip the local-path denylist entirely.
      await expect(
        getFileDataAfterUploadingToS3(path.join('http_export', '.aws', 'creds'), {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        })
      ).rejects.toThrow(ComposioSensitiveFilePathBlockedError);

      // It must not have been routed through the URL-fetch branch.
      expect(mockFetch).not.toHaveBeenCalled();
    });

    it('should handle fetch errors for URLs', async () => {
      const cancel = vi.fn();
      const response = new Response(new ReadableStream({ cancel }), {
        status: 500,
        statusText: 'Internal Server Error',
      });
      mockFetch.mockResolvedValue(response);

      await expect(
        getFileDataAfterUploadingToS3('https://example.com/file.pdf', {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        })
      ).rejects.toThrow('Failed to fetch file: Internal Server Error');

      expect(cancel).toHaveBeenCalledOnce();
      expect(response.bodyUsed).toBe(true);
    });

    it('should handle S3 upload errors', async () => {
      mockFetch.mockResolvedValueOnce(fetchedFileResponse());

      (mockClient.files.createPresignedURL as unknown as Mock).mockResolvedValue({
        key: 'test-key',
        type: 'new',
        new_presigned_url: 'https://s3.example.com/upload',
      });

      // Mock failed S3 upload
      mockFetch.mockResolvedValueOnce({
        ok: false,
        statusText: 'Upload Failed',
      });

      await expect(
        getFileDataAfterUploadingToS3('https://example.com/file.pdf', {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        })
      ).rejects.toThrow('Failed to upload file to S3: Upload Failed');
    });

    it('should handle invalid file types', async () => {
      await expect(
        getFileDataAfterUploadingToS3(123 as unknown as string, {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        })
      ).rejects.toThrow('Invalid file type');
    });
  });
  describe('SSRF guard on response-supplied URLs', () => {
    // The S3 URLs below are API response fields, not caller input. The SDK
    // treats a response as untrusted, so both directions are validated: a
    // download would otherwise fetch an internal address and write the bytes
    // to disk, and an upload would PUT the user's file to one.
    it('should block a download whose s3Url resolves internally', async () => {
      mockLookup.mockResolvedValueOnce([{ address: '169.254.169.254', family: 4 }] as never);

      await expect(
        downloadFileFromS3({
          toolSlug: 'github',
          s3Url: 'http://metadata.example/latest/meta-data/',
          mimeType: 'text/plain',
        })
      ).rejects.toBeInstanceOf(ComposioBlockedInternalUrlError);

      expect(mockFetch).not.toHaveBeenCalled();
    });

    it('should block an upload whose presigned URL resolves internally', async () => {
      vi.mocked(mockClient.files.createPresignedURL).mockResolvedValue({
        key: 'test-key',
        type: 'new',
        new_presigned_url: 'http://127.0.0.1:9000/upload',
      } as never);
      // The file content is read first, then the presigned URL is validated.
      mockLookup.mockResolvedValueOnce([{ address: '127.0.0.1', family: 4 }] as never);

      await expect(
        getFileDataAfterUploadingToS3(new File(['data'], 'report.txt', { type: 'text/plain' }), {
          toolSlug: 'test-tool',
          toolkitSlug: 'test-toolkit',
          client: mockClient,
        })
      ).rejects.toBeInstanceOf(ComposioBlockedInternalUrlError);

      expect(mockFetch).not.toHaveBeenCalled();
    });
  });
});