gamma-debug-bundle

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Gamma Debug Bundle

Gamma 调试工具包

Overview

概述

Comprehensive debugging toolkit for systematic troubleshooting of Gamma integration issues.

用于系统化排查Gamma集成问题的综合调试工具包。

Prerequisites

前置要求

Active Gamma integration with issues
Node.js 18+ for debug tools
Access to application logs

存在异常的活跃Gamma集成
调试工具需依赖Node.js 18及以上版本
具备应用日志的访问权限

Instructions

使用说明

Step 1: Create Debug Client

步骤1：创建调试客户端

typescript

// debug/gamma-debug.ts
import { GammaClient } from '@gamma/sdk';

interface DebugLog {
  timestamp: string;
  method: string;
  path: string;
  requestBody?: object;
  responseBody?: object;
  duration: number;
  status: number;
  error?: string;
}

const logs: DebugLog[] = [];

export function createDebugClient() {
  const gamma = new GammaClient({
    apiKey: process.env.GAMMA_API_KEY,
    interceptors: {
      request: (config) => {
        config._startTime = Date.now();
        config._id = crypto.randomUUID();
        console.log(`[${config._id}] -> ${config.method} ${config.path}`);
        return config;
      },
      response: (response, config) => {
        const duration = Date.now() - config._startTime;
        console.log(`[${config._id}] <- ${response.status} (${duration}ms)`);

        logs.push({
          timestamp: new Date().toISOString(),
          method: config.method,
          path: config.path,
          requestBody: config.body,
          responseBody: response.data,
          duration,
          status: response.status,
        });

        return response;
      },
      error: (error, config) => {
        const duration = Date.now() - config._startTime;
        console.error(`[${config._id}] !! ${error.message} (${duration}ms)`);

        logs.push({
          timestamp: new Date().toISOString(),
          method: config.method,
          path: config.path,
          requestBody: config.body,
          duration,
          status: error.status || 0,
          error: error.message,
        });

        throw error;
      },
    },
  });

  return { gamma, getLogs: () => [...logs], clearLogs: () => logs.length = 0 };
}

typescript

// debug/gamma-debug.ts
import { GammaClient } from '@gamma/sdk';

interface DebugLog {
  timestamp: string;
  method: string;
  path: string;
  requestBody?: object;
  responseBody?: object;
  duration: number;
  status: number;
  error?: string;
}

const logs: DebugLog[] = [];

export function createDebugClient() {
  const gamma = new GammaClient({
    apiKey: process.env.GAMMA_API_KEY,
    interceptors: {
      request: (config) => {
        config._startTime = Date.now();
        config._id = crypto.randomUUID();
        console.log(`[${config._id}] -> ${config.method} ${config.path}`);
        return config;
      },
      response: (response, config) => {
        const duration = Date.now() - config._startTime;
        console.log(`[${config._id}] <- ${response.status} (${duration}ms)`);

        logs.push({
          timestamp: new Date().toISOString(),
          method: config.method,
          path: config.path,
          requestBody: config.body,
          responseBody: response.data,
          duration,
          status: response.status,
        });

        return response;
      },
      error: (error, config) => {
        const duration = Date.now() - config._startTime;
        console.error(`[${config._id}] !! ${error.message} (${duration}ms)`);

        logs.push({
          timestamp: new Date().toISOString(),
          method: config.method,
          path: config.path,
          requestBody: config.body,
          duration,
          status: error.status || 0,
          error: error.message,
        });

        throw error;
      },
    },
  });

  return { gamma, getLogs: () => [...logs], clearLogs: () => logs.length = 0 };
}

Step 2: Diagnostic Script

步骤2：运行诊断脚本

typescript

// debug/diagnose.ts
import { createDebugClient } from './gamma-debug';

async function diagnose() {
  const { gamma, getLogs } = createDebugClient();

  console.log('=== Gamma Diagnostic Report ===\n');

  // Test 1: Authentication
  console.log('1. Testing Authentication...');
  try {
    await gamma.ping();
    console.log('   OK - Authentication working\n');
  } catch (err) {
    console.log(`   FAIL - ${err.message}\n`);
    return;
  }

  // Test 2: API Access
  console.log('2. Testing API Access...');
  try {
    const presentations = await gamma.presentations.list({ limit: 1 });
    console.log(`   OK - Can list presentations (${presentations.length} found)\n`);
  } catch (err) {
    console.log(`   FAIL - ${err.message}\n`);
  }

  // Test 3: Generation Capability
  console.log('3. Testing Generation...');
  try {
    const test = await gamma.presentations.create({
      title: 'Debug Test',
      prompt: 'Single test slide',
      slideCount: 1,
      dryRun: true,
    });
    console.log('   OK - Generation endpoint working\n');
  } catch (err) {
    console.log(`   FAIL - ${err.message}\n`);
  }

  // Test 4: Rate Limits
  console.log('4. Checking Rate Limits...');
  const status = await gamma.rateLimit.status();
  console.log(`   Remaining: ${status.remaining}/${status.limit}`);
  console.log(`   Resets: ${new Date(status.reset * 1000).toISOString()}\n`);

  // Summary
  console.log('=== Request Log ===');
  for (const log of getLogs()) {
    console.log(`${log.method} ${log.path} - ${log.status} (${log.duration}ms)`);
  }
}

diagnose().catch(console.error);

typescript

// debug/diagnose.ts
import { createDebugClient } from './gamma-debug';

async function diagnose() {
  const { gamma, getLogs } = createDebugClient();

  console.log('=== Gamma Diagnostic Report ===\n');

  // Test 1: Authentication
  console.log('1. 测试身份认证...');
  try {
    await gamma.ping();
    console.log('   正常 - 身份认证功能可用\n');
  } catch (err) {
    console.log(`   失败 - ${err.message}\n`);
    return;
  }

  // Test 2: API Access
  console.log('2. 测试API访问...');
  try {
    const presentations = await gamma.presentations.list({ limit: 1 });
    console.log(`   正常 - 可获取演示文稿列表（共找到${presentations.length}个）\n`);
  } catch (err) {
    console.log(`   失败 - ${err.message}\n`);
  }

  // Test 3: Generation Capability
  console.log('3. 测试生成能力...');
  try {
    const test = await gamma.presentations.create({
      title: 'Debug Test',
      prompt: 'Single test slide',
      slideCount: 1,
      dryRun: true,
    });
    console.log('   正常 - 生成接口可用\n');
  } catch (err) {
    console.log(`   失败 - ${err.message}\n`);
  }

  // Test 4: Rate Limits
  console.log('4. 检查限流情况...');
  const status = await gamma.rateLimit.status();
  console.log(`   剩余配额: ${status.remaining}/${status.limit}`);
  console.log(`   重置时间: ${new Date(status.reset * 1000).toISOString()}\n`);

  // Summary
  console.log('=== 请求日志 ===');
  for (const log of getLogs()) {
    console.log(`${log.method} ${log.path} - ${log.status} (${log.duration}ms)`);
  }
}

diagnose().catch(console.error);

Step 3: Environment Checker

步骤3：环境检查

typescript

// debug/check-env.ts
function checkEnvironment() {
  const checks = [
    { name: 'GAMMA_API_KEY', value: process.env.GAMMA_API_KEY },
    { name: 'NODE_ENV', value: process.env.NODE_ENV },
    { name: 'Node Version', value: process.version },
  ];

  console.log('=== Environment Check ===\n');

  for (const check of checks) {
    const status = check.value ? 'SET' : 'MISSING';
    const display = check.value
      ? check.value.substring(0, 8) + '...'
      : 'NOT SET';
    console.log(`${check.name}: ${status} (${display})`);
  }
}

checkEnvironment();

typescript

// debug/check-env.ts
function checkEnvironment() {
  const checks = [
    { name: 'GAMMA_API_KEY', value: process.env.GAMMA_API_KEY },
    { name: 'NODE_ENV', value: process.env.NODE_ENV },
    { name: 'Node Version', value: process.version },
  ];

  console.log('=== 环境检查 ===\n');

  for (const check of checks) {
    const status = check.value ? '已配置' : '缺失';
    const display = check.value
      ? check.value.substring(0, 8) + '...'
      : '未配置';
    console.log(`${check.name}: ${status} (${display})`);
  }
}

checkEnvironment();

Step 4: Export Debug Bundle

步骤4：导出调试包

typescript

// debug/export-bundle.ts
async function exportDebugBundle() {
  const bundle = {
    timestamp: new Date().toISOString(),
    environment: {
      nodeVersion: process.version,
      platform: process.platform,
      env: process.env.NODE_ENV,
    },
    logs: getLogs(),
    config: {
      apiKeySet: !!process.env.GAMMA_API_KEY,
      timeout: 30000,
    },
  };

  await fs.writeFile(
    'gamma-debug-bundle.json',
    JSON.stringify(bundle, null, 2)
  );

  console.log('Debug bundle exported to gamma-debug-bundle.json');
}

typescript

// debug/export-bundle.ts
async function exportDebugBundle() {
  const bundle = {
    timestamp: new Date().toISOString(),
    environment: {
      nodeVersion: process.version,
      platform: process.platform,
      env: process.env.NODE_ENV,
    },
    logs: getLogs(),
    config: {
      apiKeySet: !!process.env.GAMMA_API_KEY,
      timeout: 30000,
    },
  };

  await fs.writeFile(
    'gamma-debug-bundle.json',
    JSON.stringify(bundle, null, 2)
  );

  console.log('调试包已导出至 gamma-debug-bundle.json');
}

Output

产出内容

Debug client with request tracing
Diagnostic script output
Environment check report
Exportable debug bundle

具备请求追踪能力的调试客户端
诊断脚本执行输出
环境检查报告
可导出的调试数据包

Resources

参考资源

Next Steps

后续步骤

Proceed to

gamma-rate-limits

for rate limit management.

可跳转至

gamma-rate-limits

功能进行限流管理。