Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

9.1 KB
Raw Blame
/**
 * One-off script to test all /manage/ API endpoints
 *
 * Usage:
 *   pnpm test:manage
 *   or
 *   pnpm jiti scripts/test-manage-api.ts
 *
 * Set API_URL environment variable to test against a different server:
 *   API_URL=http://localhost:3000 pnpm test:manage
 */

const CLIENT_ID = process.env.CLIENT_ID!;
const CLIENT_SECRET = process.env.CLIENT_SECRET!;
const API_BASE_URL = process.env.API_URL || 'http://localhost:3333';

if (!(CLIENT_ID && CLIENT_SECRET)) {
  console.error('CLIENT_ID and CLIENT_SECRET must be set');
  process.exit(1);
}

interface TestResult {
  name: string;
  method: string;
  url: string;
  status: number;
  success: boolean;
  error?: string;
  data?: any;
}

const results: TestResult[] = [];

async function makeRequest(
  method: string,
  path: string,
  body?: any
): Promise<TestResult> {
  const url = `${API_BASE_URL}${path}`;
  const headers: Record<string, string> = {
    'openpanel-client-id': CLIENT_ID,
    'openpanel-client-secret': CLIENT_SECRET,
  };

  // Only set Content-Type if there's a body
  if (body) {
    headers['Content-Type'] = 'application/json';
  }

  try {
    const response = await fetch(url, {
      method,
      headers,
      body: body ? JSON.stringify(body) : undefined,
    });

    const data = await response.json().catch(() => ({}));

    return {
      name: `${method} ${path}`,
      method,
      url,
      status: response.status,
      success: response.ok,
      error: response.ok ? undefined : data.message || 'Request failed',
      data: response.ok ? data : undefined,
    };
  } catch (error) {
    return {
      name: `${method} ${path}`,
      method,
      url,
      status: 0,
      success: false,
      error: error instanceof Error ? error.message : 'Unknown error',
    };
  }
}

async function testProjects() {
  console.log('\nπŸ“ Testing Projects endpoints...\n');

  const createResult = await makeRequest('POST', '/manage/projects', {
    name: `Test Project ${Date.now()}`,
    domain: 'https://example.com',
    cors: ['https://example.com', 'https://www.example.com'],
    crossDomain: false,
    types: ['website'],
  });
  results.push(createResult);
  console.log(
    `βœ“ POST /manage/projects: ${createResult.success ? 'βœ…' : '❌'} ${createResult.status}`
  );
  if (createResult.error) {
    console.log(`  Error: ${createResult.error}`);
  }

  const projectId = createResult.data?.data?.id;
  const clientId = createResult.data?.data?.client?.id;
  const clientSecret = createResult.data?.data?.client?.secret;

  if (projectId) {
    console.log(`  Created project: ${projectId}`);
    if (clientId) {
      console.log(`  Created client: ${clientId}`);
    }
    if (clientSecret) {
      console.log(`  Client secret: ${clientSecret}`);
    }
  }

  const listResult = await makeRequest('GET', '/manage/projects');
  results.push(listResult);
  console.log(
    `βœ“ GET /manage/projects: ${listResult.success ? 'βœ…' : '❌'} ${listResult.status}`
  );
  if (listResult.data?.data?.length) {
    console.log(`  Found ${listResult.data.data.length} projects`);
  }

  if (projectId) {
    const getResult = await makeRequest('GET', `/manage/projects/${projectId}`);
    results.push(getResult);
    console.log(
      `βœ“ GET /manage/projects/:id: ${getResult.success ? 'βœ…' : '❌'} ${getResult.status}`
    );

    const updateResult = await makeRequest(
      'PATCH',
      `/manage/projects/${projectId}`,
      {
        name: 'Updated Test Project',
        crossDomain: true,
      }
    );
    results.push(updateResult);
    console.log(
      `βœ“ PATCH /manage/projects/:id: ${updateResult.success ? 'βœ…' : '❌'} ${updateResult.status}`
    );

    // Delete project (soft delete)
    const deleteResult = await makeRequest(
      'DELETE',
      `/manage/projects/${projectId}`
    );
    results.push(deleteResult);
    console.log(
      `βœ“ DELETE /manage/projects/:id: ${deleteResult.success ? 'βœ…' : '❌'} ${deleteResult.status}`
    );
  }

  return { projectId, clientId };
}

async function testClients(projectId?: string) {
  console.log('\nπŸ”‘ Testing Clients endpoints...\n');

  const createResult = await makeRequest('POST', '/manage/clients', {
    name: `Test Client ${Date.now()}`,
    projectId: projectId || undefined,
    type: 'read',
  });
  results.push(createResult);
  console.log(
    `βœ“ POST /manage/clients: ${createResult.success ? 'βœ…' : '❌'} ${createResult.status}`
  );
  if (createResult.error) {
    console.log(`  Error: ${createResult.error}`);
  }

  const clientId = createResult.data?.data?.id;
  const clientSecret = createResult.data?.data?.secret;

  if (clientId) {
    console.log(`  Created client: ${clientId}`);
    if (clientSecret) {
      console.log(`  Client secret: ${clientSecret}`);
    }
  }

  const listResult = await makeRequest(
    'GET',
    projectId ? `/manage/clients?projectId=${projectId}` : '/manage/clients'
  );
  results.push(listResult);
  console.log(
    `βœ“ GET /manage/clients: ${listResult.success ? 'βœ…' : '❌'} ${listResult.status}`
  );
  if (listResult.data?.data?.length) {
    console.log(`  Found ${listResult.data.data.length} clients`);
  }

  if (clientId) {
    const getResult = await makeRequest('GET', `/manage/clients/${clientId}`);
    results.push(getResult);
    console.log(
      `βœ“ GET /manage/clients/:id: ${getResult.success ? 'βœ…' : '❌'} ${getResult.status}`
    );

    const updateResult = await makeRequest(
      'PATCH',
      `/manage/clients/${clientId}`,
      {
        name: 'Updated Test Client',
      }
    );
    results.push(updateResult);
    console.log(
      `βœ“ PATCH /manage/clients/:id: ${updateResult.success ? 'βœ…' : '❌'} ${updateResult.status}`
    );

    const deleteResult = await makeRequest(
      'DELETE',
      `/manage/clients/${clientId}`
    );
    results.push(deleteResult);
    console.log(
      `βœ“ DELETE /manage/clients/:id: ${deleteResult.success ? 'βœ…' : '❌'} ${deleteResult.status}`
    );
  }
}

async function testReferences(projectId?: string) {
  console.log('\nπŸ“š Testing References endpoints...\n');

  if (!projectId) {
    console.log('  ⚠️  Skipping references tests - no project ID available');
    return;
  }

  const createResult = await makeRequest('POST', '/manage/references', {
    projectId,
    title: `Test Reference ${Date.now()}`,
    description: 'This is a test reference',
    datetime: new Date().toISOString(),
  });
  results.push(createResult);
  console.log(
    `βœ“ POST /manage/references: ${createResult.success ? 'βœ…' : '❌'} ${createResult.status}`
  );
  if (createResult.error) {
    console.log(`  Error: ${createResult.error}`);
  }

  const referenceId = createResult.data?.data?.id;

  if (referenceId) {
    console.log(`  Created reference: ${referenceId}`);
  }

  const listResult = await makeRequest(
    'GET',
    `/manage/references?projectId=${projectId}`
  );
  results.push(listResult);
  console.log(
    `βœ“ GET /manage/references: ${listResult.success ? 'βœ…' : '❌'} ${listResult.status}`
  );
  if (listResult.data?.data?.length) {
    console.log(`  Found ${listResult.data.data.length} references`);
  }

  if (referenceId) {
    const getResult = await makeRequest(
      'GET',
      `/manage/references/${referenceId}`
    );
    results.push(getResult);
    console.log(
      `βœ“ GET /manage/references/:id: ${getResult.success ? 'βœ…' : '❌'} ${getResult.status}`
    );

    const updateResult = await makeRequest(
      'PATCH',
      `/manage/references/${referenceId}`,
      {
        title: 'Updated Test Reference',
        description: 'Updated description',
        datetime: new Date().toISOString(),
      }
    );
    results.push(updateResult);
    console.log(
      `βœ“ PATCH /manage/references/:id: ${updateResult.success ? 'βœ…' : '❌'} ${updateResult.status}`
    );

    const deleteResult = await makeRequest(
      'DELETE',
      `/manage/references/${referenceId}`
    );
    results.push(deleteResult);
    console.log(
      `βœ“ DELETE /manage/references/:id: ${deleteResult.success ? 'βœ…' : '❌'} ${deleteResult.status}`
    );
  }
}

async function main() {
  console.log('πŸš€ Testing Manage API Endpoints\n');
  console.log(`API Base URL: ${API_BASE_URL}`);
  console.log(`Client ID: ${CLIENT_ID}\n`);

  try {
    // Test projects first (creates a project we can use for other tests)
    const { projectId } = await testProjects();

    await testClients(projectId);

    // Test references (requires a project)
    await testReferences(projectId);

    console.log(`\n${'='.repeat(60)}`);
    console.log('πŸ“Š Test Summary\n');
    const successful = results.filter((r) => r.success).length;
    const failed = results.filter((r) => !r.success).length;

    console.log(`Total tests: ${results.length}`);
    console.log(`βœ… Successful: ${successful}`);
    console.log(`❌ Failed: ${failed}\n`);

    if (failed > 0) {
      console.log('Failed tests:');
      results
        .filter((r) => !r.success)
        .forEach((r) => {
          console.log(`  ❌ ${r.name} (${r.status})`);
          if (r.error) {
            console.log(`     Error: ${r.error}`);
          }
        });
    }
  } catch (error) {
    console.error('Fatal error:', error);
    process.exit(1);
  }
}

main().catch(console.error);