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.

8.9 KB
Raw Blame
import { describe, expect, test } from 'bun:test';

import {
  classifyDocsProduct,
  DEFAULT_DOCS_PRODUCT,
  DOCS_PRODUCTS,
  docsProductDestination,
  parseDocsProduct,
  resolveDocsProduct,
  serializeDocsProductCookie,
  shouldAnimateDocsProductSwitch,
} from '../../lib/home-navigation';
import { buildProductPageTree, pageTreeUrls } from '../../lib/product-page-tree';
import { referenceSource, source } from '../../lib/source';

describe('Docs product navigation', () => {
  test('defines the product labels, descriptions, landings, and themes once', () => {
    expect(DEFAULT_DOCS_PRODUCT).toBe('platform');
    expect(DOCS_PRODUCTS['for-you']).toMatchObject({
      product: 'For You',
      switcherDescription: 'Connect your apps to AI clients.',
      landingRoute: '/docs/agent-plugins',
      theme: 'light',
      themeColor: '#ffffff',
    });
    expect(DOCS_PRODUCTS.platform).toMatchObject({
      product: 'Platform',
      switcherDescription: 'Build agents with the Composio SDK.',
      landingRoute: '/docs/quickstart',
      theme: 'dark',
      themeColor: '#131211',
    });
  });

  test('classifies audience routes while leaving shared routes unclassified', () => {
    expect(classifyDocsProduct('/docs/agent-plugins')).toBe('for-you');
    expect(classifyDocsProduct('/docs/composio-connect')).toBe('for-you');
    expect(classifyDocsProduct('/docs/providers/openai')).toBe('platform');
    expect(classifyDocsProduct('/docs/authentication/controlling-scopes')).toBe('platform');
    expect(classifyDocsProduct('/docs')).toBeNull();
    expect(classifyDocsProduct('/docs/security/overview')).toBeNull();
    expect(classifyDocsProduct('/docs/security/data-retention')).toBe('platform');
  });

  test('uses route inference before persistence and the documented default last', () => {
    expect(resolveDocsProduct('/docs/quickstart', 'for-you')).toBe('platform');
    expect(resolveDocsProduct('/docs/security/overview', 'for-you')).toBe('for-you');
    expect(resolveDocsProduct('/docs/security/overview', 'platform')).toBe('platform');
    expect(resolveDocsProduct('/docs', 'invalid')).toBe('platform');
    expect(parseDocsProduct('for-you')).toBe('for-you');
    expect(parseDocsProduct('anything-else')).toBeNull();
    expect(serializeDocsProductCookie('for-you')).toContain(
      'composio-docs-product=for-you',
    );
    expect(serializeDocsProductCookie('for-you')).toContain('SameSite=Lax');
  });

  test('uses meaningful counterparts and otherwise falls back to product landings', () => {
    expect(docsProductDestination('/docs/quickstart', 'for-you')).toBe(
      '/docs/agent-plugins',
    );
    expect(docsProductDestination('/docs/agent-plugins', 'platform')).toBe(
      '/docs/quickstart',
    );
    expect(docsProductDestination('/docs/sessions-via-mcp', 'for-you')).toBe(
      '/docs/composio-connect',
    );
    expect(docsProductDestination('/docs/composio-connect', 'platform')).toBe(
      '/docs/sessions-via-mcp',
    );
    expect(docsProductDestination('/docs/authentication', 'for-you')).toBe(
      '/docs/agent-plugins',
    );
    expect(docsProductDestination('/docs/cli', 'platform')).toBe('/docs/quickstart');
    expect(docsProductDestination('/docs/security/overview', 'for-you')).toBe(
      '/docs/security/overview',
    );
    expect(docsProductDestination('/docs/security/data-retention', 'platform')).toBe(
      '/docs/security/data-retention',
    );
    expect(docsProductDestination('/docs/security/data-retention', 'for-you')).toBe(
      '/docs/agent-plugins',
    );
  });

  test('animates only when view transitions are available and motion is allowed', () => {
    expect(shouldAnimateDocsProductSwitch(true, false)).toBe(true);
    expect(shouldAnimateDocsProductSwitch(false, false)).toBe(false);
    expect(shouldAnimateDocsProductSwitch(true, true)).toBe(false);
  });

  test('fades the outgoing product snapshot while revealing the incoming product', async () => {
    const globalCss = await Bun.file(
      new URL('../../app/global.css', import.meta.url),
    ).text();
    const outgoingSnapshotRule = globalCss.match(
      /::view-transition-old\(docs-product-shell\)\s*\{(?<rule>[^}]*)\}/,
    );

    expect(outgoingSnapshotRule?.groups?.rule).toContain('docs-product-fade-out');
    expect(outgoingSnapshotRule?.groups?.rule).not.toContain('animation: none');
    expect(globalCss).toContain('@keyframes docs-product-fade-out');
  });

  test('builds audience-specific trees and keeps shared resources in both', () => {
    const forYouTree = buildProductPageTree(source.pageTree, 'for-you');
    const platformTree = buildProductPageTree(source.pageTree, 'platform');
    const forYouUrls = pageTreeUrls(forYouTree);
    const platformUrls = pageTreeUrls(platformTree);

    expect(forYouTree.$id).not.toBe(platformTree.$id);

    expect(forYouUrls).toContain('/docs/agent-plugins');
    expect(forYouUrls).toContain('/docs/cli');
    expect(forYouUrls).toContain('/docs/composio-connect');
    expect(forYouUrls).not.toContain('/docs/quickstart');

    for (const url of [
      '/docs/quickstart',
      '/docs/providers',
      '/docs/how-composio-works',
      '/docs/authentication',
      '/docs/skills',
      '/docs/triggers',
    ]) {
      expect(platformUrls).toContain(url);
    }
    expect(platformUrls).not.toContain('/docs/agent-plugins');

    expect(forYouUrls).not.toContain('/docs');
    expect(platformUrls).not.toContain('/docs');

    for (const sharedUrl of ['/docs/security/overview']) {
      expect(forYouUrls).toContain(sharedUrl);
      expect(platformUrls).toContain(sharedUrl);
    }

    const readiness = platformTree.children.flatMap(node =>
      node.type === 'folder' ? [node, ...node.children] : [node],
    ).find(node => node.type === 'folder' && node.name === 'Production readiness');
    expect(readiness?.type).toBe('folder');
    if (readiness?.type !== 'folder') throw new Error('Production readiness folder missing');
    const readinessUrls = readiness.children.flatMap(node => node.type === 'page' ? [node.url] : []);
    expect(readinessUrls).toEqual([
      '/docs/authentication/custom-app-vs-managed-app',
      '/reference/rate-limits',
      '/docs/security/data-retention',
      '/docs/poc-to-prod/stream-logs-to-a-siem',
    ]);
    for (const url of readinessUrls) {
      expect(platformUrls.filter(candidate => candidate === url)).toHaveLength(1);
      expect(forYouUrls).not.toContain(url);
    }
    expect(pageTreeUrls(referenceSource.pageTree)).not.toContain('/reference/rate-limits');
    expect(referenceSource.getPage(['rate-limits'])?.url).toBe('/reference/rate-limits');

    const coveredUrls = new Set([...forYouUrls, ...platformUrls]);
    const excludedUrls = new Set(['/docs']);
    const omittedUrls = pageTreeUrls(source.pageTree).filter(
      url => !coveredUrls.has(url) && !excludedUrls.has(url),
    );
    expect(omittedUrls).toEqual([]);
  });

  test('keeps accessibility-critical switcher semantics and visible focus styles', async () => {
    const switcherSource = await Bun.file(
      new URL('../../components/product-switcher.tsx', import.meta.url),
    ).text();
    const sharedLayoutSource = await Bun.file(
      new URL('../../lib/layout.shared.tsx', import.meta.url),
    ).text();
    const contextSource = await Bun.file(
      new URL('../../components/docs-product-context.tsx', import.meta.url),
    ).text();
    const rootLayoutSource = await Bun.file(
      new URL('../../app/layout.tsx', import.meta.url),
    ).text();

    expect(switcherSource).toContain('aria-label={`Switch Composio product. Current product:');
    expect(switcherSource).toContain('ProductSelectionLink');
    expect(switcherSource).not.toContain('role="radiogroup"');
    expect(switcherSource).not.toContain('role="radio"');
    expect(switcherSource).not.toContain('aria-checked={isCurrent}');
    expect(switcherSource).toContain("aria-current={isCurrent ? 'page' : undefined}");
    expect(switcherSource).toContain('focus-visible:outline-2');
    expect(switcherSource).toContain('aria-label="Composio home"');
    expect(switcherSource).toContain('href="/"');
    expect(sharedLayoutSource).toContain('slots: { navTitle: ProductNavTitle }');
    expect(sharedLayoutSource).toContain('themeSwitch: { enabled: false }');
    expect(contextSource).toContain('applyProductTheme(product)');
    expect(contextSource).toContain('.querySelector(\'meta[name="theme-color"]\')');
    expect(contextSource).toContain("?.setAttribute('content', themeColor)");
    expect(contextSource).toContain('window.setTimeout(finish, 1500)');
    expect(rootLayoutSource).toContain('forcedTheme: initialTheme');
    expect(rootLayoutSource).toContain("storageKey: 'composio-docs-theme'");
    expect(rootLayoutSource).toContain(
      'content={DOCS_PRODUCTS[initialProduct].themeColor}',
    );
    expect(contextSource).not.toContain("localStorage.setItem('theme'");
    expect(rootLayoutSource).not.toContain("localStorage.setItem('theme'");
    expect(rootLayoutSource).toContain('hotKey: false');
  });
});