@testdriverai/agent 7.8.0-canary.10

package/lib/github-comment.mjs

@@ -0,0 +1,452 @@
+/**
+ * GitHub Comment Generator for TestDriver Test Results
+ * 
+ * Creates beautifully formatted GitHub comments with:
+ * - Test results summary
+ * - Dashcam GIF replays
+ * - Exception details
+ * - Links to test runs
+ */
+
+import { Octokit } from '@octokit/rest';
+
+/**
+ * Format test duration in human-readable format
+ * @param {number} ms - Duration in milliseconds
+ * @returns {string} Formatted duration
+ */
+function formatDuration(ms) {
+  if (ms < 1000) return `${ms}ms`;
+  if (ms < 60000) return `${(ms / 1000).toFixed(2)}s`;
+  return `${Math.floor(ms / 60000)}m ${Math.floor((ms % 60000) / 1000)}s`;
+}
+
+/**
+ * Get status emoji for test result
+ * @param {string} status - Test status (passed, failed, skipped)
+ * @returns {string} Emoji
+ */
+function getStatusEmoji(status) {
+  switch (status) {
+    case 'passed': return '✅';
+    case 'failed': return '❌';
+    case 'skipped': return '⏭️';
+    case 'cancelled': return '🚫';
+    default: return '❓';
+  }
+}
+
+/**
+ * Generate markdown for test results table
+ * @param {Array} testCases - Array of test case objects
+ * @param {string} testRunUrl - Base URL for test run
+ * @returns {string} Markdown table
+ */
+function generateTestResultsTable(testCases, testRunUrl) {
+  if (!testCases || testCases.length === 0) {
+    return '_No test cases recorded_';
+  }
+
+  // Filter out skipped tests
+  const nonSkippedTests = testCases.filter(test => test.status !== 'skipped');
+
+  if (nonSkippedTests.length === 0) {
+    return '_No test cases to display (all tests were skipped)_';
+  }
+
+  let table = '| Status | Test | File | Duration | Replay |\n';
+  table += '|--------|------|------|----------|--------|\n';
+
+  for (const test of nonSkippedTests) {
+    const status = getStatusEmoji(test.status);
+    const name = test.testName || 'Unknown';
+    const file = test.testFile || 'unknown';
+    const duration = formatDuration(test.duration || 0);
+
+    // Use test run context URL instead of direct replay URL
+    let replay = '-';
+    if (test.replayUrl) {
+      const linkUrl = (test.id && testRunUrl) ? `${testRunUrl}/${test.id}` : test.replayUrl;
+
+      // Extract replay ID and generate GIF URL
+      const replayId = extractReplayId(test.replayUrl);
+      if (replayId) {
+        const gifUrl = getReplayGifUrl(test.replayUrl, replayId);
+        // Embed GIF with link using HTML for height control
+        replay = `<a href="${linkUrl}"><img src="${gifUrl}" height="100" alt="Test replay" /></a>`;
+      } else {
+        // Fallback to text link if no GIF available
+        replay = `[🎥 View](${linkUrl})`;
+      }
+    } else if (test.id && testRunUrl) {
+      // Link without replay URL
+      replay = `[🎥 View](${testRunUrl}/${test.id})`;
+    }
+
+    table += `| ${status} | ${name} | \`${file}\` | ${duration} | ${replay} |\n`;
+  }
+
+  return table;
+}
+
+/**
+ * Generate markdown for exceptions/errors
+ * @param {Array} testCases - Array of test case objects with errors
+ * @param {string} testRunUrl - Base URL for test run
+ * @returns {string} Markdown with error details
+ */
+function generateExceptionsSection(testCases, testRunUrl) {
+  const failedTests = testCases.filter(t => t.status === 'failed' && t.errorMessage);
+
+  if (failedTests.length === 0) {
+    return '';
+  }
+
+  let section = '\n## 🔴 Failures\n\n';
+
+  for (const test of failedTests) {
+    section += `### ${test.testName}\n\n`;
+    section += `**File:** \`${test.testFile}\`\n\n`;
+
+    // Use test run context URL instead of direct replay URL
+    if (test.id && testRunUrl) {
+      section += `**📹 [Watch Replay](${testRunUrl}/${test.id})**\n\n`;
+    } else if (test.replayUrl) {
+      section += `**📹 [Watch Replay](${test.replayUrl})**\n\n`;
+    }
+
+    section += '```\n';
+    section += test.errorMessage || 'Unknown error';
+    section += '\n```\n\n';
+
+    if (test.errorStack) {
+      section += '<details>\n';
+      section += '<summary>Stack Trace</summary>\n\n';
+      section += '```\n';
+      section += test.errorStack;
+      section += '\n```\n';
+      section += '</details>\n\n';
+    }
+  }
+
+  return section;
+}
+
+/**
+ * Generate markdown for dashcam replays section
+ * @param {Array} testCases - Array of test case objects
+ * @param {string} testRunUrl - Base URL for test run
+ * @returns {string} Markdown with replay embeds
+ */
+function generateReplaySection(testCases, testRunUrl) {
+  const testsWithReplays = testCases.filter(t => t.replayUrl);
+
+  if (testsWithReplays.length === 0) {
+    return '';
+  }
+
+  let section = '\n## 🎥 Dashcam Replays\n\n';
+
+  for (const test of testsWithReplays) {
+    section += `### ${test.testName}\n\n`;
+
+    // Determine the link URL - prefer test run context
+    let linkUrl = test.replayUrl;
+    if (test.id && testRunUrl) {
+      linkUrl = `${testRunUrl}/${test.id}`;
+    }
+
+    // Extract replay ID from URL for GIF embed
+    const replayId = extractReplayId(test.replayUrl);
+    if (replayId) {
+      const gifUrl = getReplayGifUrl(test.replayUrl, replayId);
+      section += `[![${test.testName}](${gifUrl})](${linkUrl})\n\n`;
+      section += `[🎬 View Full Replay](${linkUrl})\n\n`;
+    } else {
+      section += `[🎬 View Replay](${linkUrl})\n\n`;
+    }
+  }
+
+  return section;
+}
+
+/**
+ * Extract replay ID from dashcam URL
+ * @param {string} url - Dashcam replay URL
+ * @returns {string|null} Replay ID or null
+ */
+function extractReplayId(url) {
+  if (!url) return null;
+
+  // Match pattern: /replay/{id} or /replay/{id}?params
+  const match = url.match(/\/replay\/([^?/#]+)/);
+  return match ? match[1] : null;
+}
+
+/**
+ * Extract share key from dashcam URL
+ * @param {string} url - Dashcam replay URL
+ * @returns {string|null} Share key or null
+ */
+function extractShareKey(url) {
+  if (!url) return null;
+
+  // Match pattern: ?share=KEY or &share=KEY
+  const match = url.match(/[?&]share=([^&#]+)/);
+  return match ? match[1] : null;
+}
+
+/**
+ * Get GIF URL for replay
+ * @param {string} replayUrl - Full replay URL
+ * @param {string} replayId - Replay ID
+ * @returns {string} GIF URL
+ */
+function getReplayGifUrl(replayUrl, replayId) {
+  // Determine the API base URL based on the replay URL
+  // Replay URLs use console domains; GIF endpoints live on the corresponding API domain
+  let apiBaseUrl;
+
+  if (replayUrl.includes('app.dashcam.io')) {
+    // Production dashcam uses Heroku API
+    apiBaseUrl = 'https://testdriverai-v6-c96fc597be11.herokuapp.com';
+  } else if (replayUrl.includes('localhost')) {
+    // Local development
+    apiBaseUrl = 'http://localhost:1337';
+  } else {
+    // Map console URLs → API URLs for all environments
+    // console-test.testdriver.ai → api-test.testdriver.ai
+    // console-canary.testdriver.ai → api-canary.testdriver.ai
+    // console.testdriver.ai → api.testdriver.ai
+    const consoleEnvMatch = replayUrl.match(/https:\/\/console-(test|canary)\.testdriver\.ai/);
+    if (consoleEnvMatch) {
+      apiBaseUrl = `https://api-${consoleEnvMatch[1]}.testdriver.ai`;
+    } else if (replayUrl.includes('console.testdriver.ai')) {
+      apiBaseUrl = 'https://api.testdriver.ai';
+    }
+    // Fly.io: map web app → API app
+    // pr-123-web.fly.dev → pr-123-api.fly.dev
+    // td-test-web.fly.dev → td-test-api.fly.dev
+    else {
+      const flyWebMatch = replayUrl.match(/https:\/\/([\w-]+)-web\.fly\.dev/);
+      if (flyWebMatch) {
+        apiBaseUrl = `https://${flyWebMatch[1]}-api.fly.dev`;
+      } else {
+        // Fallback: extract base URL from replay URL as-is
+        const urlObj = new URL(replayUrl);
+        apiBaseUrl = `${urlObj.protocol}//${urlObj.host}`;
+      }
+    }
+  }
+
+  // Extract share key if present
+  const shareKey = extractShareKey(replayUrl);
+
+  // Build GIF URL with shareKey parameter
+  let gifUrl = `${apiBaseUrl}/replay/${replayId}/gif`;
+  if (shareKey) {
+    gifUrl += `?shareKey=${shareKey}`;
+  }
+
+  return gifUrl;
+}
+
+/**
+ * Generate complete GitHub comment markdown
+ * @param {Object} testRunData - Test run data
+ * @param {Array} testCases - Array of test case objects
+ * @returns {string} Complete markdown comment
+ */
+export function generateGitHubComment(testRunData, testCases = []) {
+  const {
+    runId,
+    status,
+    totalTests = 0,
+    passedTests = 0,
+    failedTests = 0,
+    skippedTests = 0,
+    duration = 0,
+    testRunUrl,
+    platform = 'unknown',
+    branch = 'unknown',
+    commit = 'unknown',
+  } = testRunData;
+
+  // Header with overall status
+  const statusEmoji = getStatusEmoji(status);
+  const statusColor = status === 'passed' ? '🟢' : status === 'failed' ? '🔴' : '🟡';
+
+  let comment = `# ${statusColor} TestDriver Test Results\n\n`;
+
+  // Compact summary line
+  comment += `**Status:** ${statusEmoji} ${status.toUpperCase()}`;
+  comment += ` • **Duration:** ${formatDuration(duration)}`;
+  comment += ` • ${passedTests} passed`;
+  if (failedTests > 0) comment += `, ${failedTests} failed`;
+  // Only show skipped count if there are no passed or failed tests
+  if (skippedTests > 0 && passedTests === 0 && failedTests === 0) {
+    comment += `, ${skippedTests} skipped`;
+  }
+  comment += `\n\n`;
+
+  // Exceptions section (only if there are failures) - show first
+  comment += generateExceptionsSection(testCases, testRunUrl);
+
+  // Test results table (now includes embedded GIFs)
+  comment += '## 📝 Test Results\n\n';
+  comment += generateTestResultsTable(testCases, testRunUrl);
+
+  // Link to full test run (below table)
+  if (testRunUrl) {
+    comment += `\n[📋 View Full Test Run](${testRunUrl})\n`;
+  }
+
+  // Footer
+  comment += '\n---\n';
+  comment += `<sub>Generated by [TestDriver](https://testdriver.ai) • Run ID: \`${runId}\`</sub>\n`;
+
+  return comment;
+}
+
+/**
+ * Post comment to GitHub PR or commit
+ * @param {Object} options - Options
+ * @param {string} options.token - GitHub token
+ * @param {string} options.owner - Repository owner
+ * @param {string} options.repo - Repository name
+ * @param {number} [options.prNumber] - Pull request number (if commenting on PR)
+ * @param {string} [options.commitSha] - Commit SHA (if commenting on commit)
+ * @param {string} options.body - Comment body (markdown)
+ * @returns {Promise<Object>} GitHub API response
+ */
+export async function postGitHubComment(options) {
+  const { token, owner, repo, prNumber, commitSha, body } = options;
+
+  if (!token) {
+    throw new Error('GitHub token is required');
+  }
+
+  if (!owner || !repo) {
+    throw new Error('Repository owner and name are required');
+  }
+
+  if (!prNumber && !commitSha) {
+    throw new Error('Either prNumber or commitSha must be provided');
+  }
+
+  const octokit = new Octokit({ auth: token });
+
+  if (prNumber) {
+    // Comment on PR
+    const response = await octokit.rest.issues.createComment({
+      owner,
+      repo,
+      issue_number: prNumber,
+      body,
+    });
+    return response.data;
+  } else if (commitSha) {
+    // Comment on commit
+    const response = await octokit.rest.repos.createCommitComment({
+      owner,
+      repo,
+      commit_sha: commitSha,
+      body,
+    });
+    return response.data;
+  }
+}
+
+/**
+ * Update existing GitHub comment
+ * @param {Object} options - Options
+ * @param {string} options.token - GitHub token
+ * @param {string} options.owner - Repository owner
+ * @param {string} options.repo - Repository name
+ * @param {number} options.commentId - Comment ID to update
+ * @param {string} options.body - Updated comment body (markdown)
+ * @returns {Promise<Object>} GitHub API response
+ */
+export async function updateGitHubComment(options) {
+  const { token, owner, repo, commentId, body } = options;
+
+  if (!token || !owner || !repo || !commentId) {
+    throw new Error('Token, owner, repo, and commentId are required');
+  }
+
+  const octokit = new Octokit({ auth: token });
+
+  const response = await octokit.rest.issues.updateComment({
+    owner,
+    repo,
+    comment_id: commentId,
+    body,
+  });
+
+  return response.data;
+}
+
+/**
+ * Find existing TestDriver comment on PR
+ * @param {Object} options - Options
+ * @param {string} options.token - GitHub token
+ * @param {string} options.owner - Repository owner
+ * @param {string} options.repo - Repository name
+ * @param {number} options.prNumber - Pull request number
+ * @returns {Promise<Object|null>} Existing comment or null
+ */
+export async function findExistingComment(options) {
+  const { token, owner, repo, prNumber } = options;
+
+  if (!token || !owner || !repo || !prNumber) {
+    return null;
+  }
+
+  const octokit = new Octokit({ auth: token });
+
+  const comments = await octokit.rest.issues.listComments({
+    owner,
+    repo,
+    issue_number: prNumber,
+  });
+
+  // Find comment with TestDriver signature
+  const existingComment = comments.data.find(comment =>
+    comment.body && comment.body.includes('Generated by [TestDriver]')
+  );
+
+  return existingComment || null;
+}
+
+/**
+ * Post or update GitHub comment with test results
+ * Always keeps the comment at the end of the thread by deleting and recreating
+ * @param {Object} testRunData - Test run data
+ * @param {Array} testCases - Array of test case objects
+ * @param {Object} githubOptions - GitHub API options
+ * @returns {Promise<Object>} GitHub API response
+ */
+export async function postOrUpdateTestResults(testRunData, testCases, githubOptions) {
+  const commentBody = generateGitHubComment(testRunData, testCases);
+
+  // Try to find and delete existing comment to keep it at the end
+  if (githubOptions.prNumber) {
+    const existingComment = await findExistingComment(githubOptions);
+
+    if (existingComment) {
+      // Delete the old comment
+      const octokit = new Octokit({ auth: githubOptions.token });
+      await octokit.rest.issues.deleteComment({
+        owner: githubOptions.owner,
+        repo: githubOptions.repo,
+        comment_id: existingComment.id,
+      });
+    }
+  }
+
+  // Always create a new comment (will be at the end of the thread)
+  return await postGitHubComment({
+    ...githubOptions,
+    body: commentBody,
+  });
+}