@aaronshaf/ger 1.2.11 → 2.0.0

package/src/utils/git-commit.test.ts

@@ -0,0 +1,277 @@
+import { describe, test, expect, beforeEach, afterEach, spyOn } from 'bun:test'
+import { Effect } from 'effect'
+import {
+  extractChangeIdFromCommitMessage,
+  getLastCommitMessage,
+  getChangeIdFromHead,
+} from './git-commit'
+import * as childProcess from 'node:child_process'
+import { EventEmitter } from 'node:events'
+
+let spawnSpy: ReturnType<typeof spyOn>
+
+describe('git-commit utilities', () => {
+  describe('extractChangeIdFromCommitMessage', () => {
+    test('extracts Change-ID from typical commit message', () => {
+      const message = `feat: add new feature
+
+This is a longer description of the feature.
+
+Change-Id: If5a3ae8cb5a107e187447802358417f311d0c4b1`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(
+        'If5a3ae8cb5a107e187447802358417f311d0c4b1',
+      )
+    })
+
+    test('extracts Change-ID with extra whitespace', () => {
+      const message = `fix: bug fix
+
+Change-Id:   If5a3ae8cb5a107e187447802358417f311d0c4b1   `
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(
+        'If5a3ae8cb5a107e187447802358417f311d0c4b1',
+      )
+    })
+
+    test('extracts Change-ID from minimal commit', () => {
+      const message = `Change-Id: I0123456789abcdef0123456789abcdef01234567`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(
+        'I0123456789abcdef0123456789abcdef01234567',
+      )
+    })
+
+    test('extracts first Change-ID when multiple exist', () => {
+      const message = `feat: feature
+
+Change-Id: If5a3ae8cb5a107e187447802358417f311d0c4b1
+Change-Id: I1111111111111111111111111111111111111111`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(
+        'If5a3ae8cb5a107e187447802358417f311d0c4b1',
+      )
+    })
+
+    test('returns null when no Change-ID present', () => {
+      const message = `feat: add feature
+
+This commit has no Change-ID footer.`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(null)
+    })
+
+    test('returns null for empty message', () => {
+      expect(extractChangeIdFromCommitMessage('')).toBe(null)
+    })
+
+    test('ignores Change-ID in commit body (not footer)', () => {
+      const message = `feat: update
+
+This mentions Change-Id: If5a3ae8cb5a107e187447802358417f311d0c4b1 in body
+but it's not in the footer.
+
+Signed-off-by: User`
+
+      // Should not match because it's not at the start of a line (footer position)
+      expect(extractChangeIdFromCommitMessage(message)).toBe(null)
+    })
+
+    test('handles Change-ID with lowercase hex digits', () => {
+      const message = `Change-Id: Iabcdef0123456789abcdef0123456789abcdef01`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(
+        'Iabcdef0123456789abcdef0123456789abcdef01',
+      )
+    })
+
+    test('returns null for malformed Change-ID (too short)', () => {
+      const message = `Change-Id: If5a3ae8cb5a107e187447`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(null)
+    })
+
+    test('returns null for malformed Change-ID (too long)', () => {
+      const message = `Change-Id: If5a3ae8cb5a107e187447802358417f311d0c4b11111`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(null)
+    })
+
+    test('returns null for Change-ID not starting with I', () => {
+      const message = `Change-Id: Gf5a3ae8cb5a107e187447802358417f311d0c4b1`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(null)
+    })
+
+    test('handles CRLF line endings', () => {
+      const message = `feat: feature\r\n\r\nChange-Id: If5a3ae8cb5a107e187447802358417f311d0c4b1\r\n`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(
+        'If5a3ae8cb5a107e187447802358417f311d0c4b1',
+      )
+    })
+
+    test('is case-insensitive for "Change-Id" label', () => {
+      const message = `change-id: If5a3ae8cb5a107e187447802358417f311d0c4b1`
+
+      expect(extractChangeIdFromCommitMessage(message)).toBe(
+        'If5a3ae8cb5a107e187447802358417f311d0c4b1',
+      )
+    })
+  })
+
+  describe('getLastCommitMessage', () => {
+    let mockChildProcess: EventEmitter
+
+    beforeEach(() => {
+      mockChildProcess = new EventEmitter()
+      // @ts-ignore - adding missing properties for mock
+      mockChildProcess.stdout = new EventEmitter()
+      // @ts-ignore
+      mockChildProcess.stderr = new EventEmitter()
+
+      spawnSpy = spyOn(childProcess, 'spawn')
+      spawnSpy.mockReturnValue(mockChildProcess as any)
+    })
+
+    afterEach(() => {
+      spawnSpy.mockRestore()
+    })
+
+    test('returns commit message on success', async () => {
+      const commitMessage = `feat: add feature
+
+Change-Id: If5a3ae8cb5a107e187447802358417f311d0c4b1`
+
+      const effect = getLastCommitMessage()
+
+      const resultPromise = Effect.runPromise(effect)
+
+      // Simulate git command success
+      setImmediate(() => {
+        // @ts-ignore
+        mockChildProcess.stdout.emit('data', Buffer.from(commitMessage))
+        mockChildProcess.emit('close', 0)
+      })
+
+      const result = await resultPromise
+      expect(result).toBe(commitMessage)
+    })
+
+    test('throws GitError when not in git repository', async () => {
+      const effect = getLastCommitMessage()
+
+      const resultPromise = Effect.runPromise(effect)
+
+      setImmediate(() => {
+        // @ts-ignore
+        mockChildProcess.stderr.emit('data', Buffer.from('fatal: not a git repository'))
+        mockChildProcess.emit('close', 128)
+      })
+
+      try {
+        await resultPromise
+        expect(true).toBe(false) // Should not reach here
+      } catch (error: any) {
+        expect(error.message).toContain('fatal: not a git repository')
+      }
+    })
+
+    test('throws GitError on spawn error', async () => {
+      const effect = getLastCommitMessage()
+
+      const resultPromise = Effect.runPromise(effect)
+
+      setImmediate(() => {
+        mockChildProcess.emit('error', new Error('ENOENT: git not found'))
+      })
+
+      try {
+        await resultPromise
+        expect(true).toBe(false) // Should not reach here
+      } catch (error: any) {
+        expect(error.message).toContain('Failed to execute git command')
+      }
+    })
+  })
+
+  describe('getChangeIdFromHead', () => {
+    let mockChildProcess: EventEmitter
+
+    beforeEach(() => {
+      mockChildProcess = new EventEmitter()
+      // @ts-ignore
+      mockChildProcess.stdout = new EventEmitter()
+      // @ts-ignore
+      mockChildProcess.stderr = new EventEmitter()
+
+      spawnSpy = spyOn(childProcess, 'spawn')
+      spawnSpy.mockReturnValue(mockChildProcess as any)
+    })
+
+    afterEach(() => {
+      spawnSpy.mockRestore()
+    })
+
+    test('returns Change-ID from HEAD commit', async () => {
+      const commitMessage = `feat: add feature
+
+Change-Id: If5a3ae8cb5a107e187447802358417f311d0c4b1`
+
+      const effect = getChangeIdFromHead()
+
+      const resultPromise = Effect.runPromise(effect)
+
+      setImmediate(() => {
+        // @ts-ignore
+        mockChildProcess.stdout.emit('data', Buffer.from(commitMessage))
+        mockChildProcess.emit('close', 0)
+      })
+
+      const result = await resultPromise
+      expect(result).toBe('If5a3ae8cb5a107e187447802358417f311d0c4b1')
+    })
+
+    test('throws NoChangeIdError when commit has no Change-ID', async () => {
+      const commitMessage = `feat: add feature
+
+This commit has no Change-ID.`
+
+      const effect = getChangeIdFromHead()
+
+      const resultPromise = Effect.runPromise(effect)
+
+      setImmediate(() => {
+        // @ts-ignore
+        mockChildProcess.stdout.emit('data', Buffer.from(commitMessage))
+        mockChildProcess.emit('close', 0)
+      })
+
+      try {
+        await resultPromise
+        expect(true).toBe(false) // Should not reach here
+      } catch (error: any) {
+        expect(error.message).toContain('No Change-ID found in HEAD commit')
+      }
+    })
+
+    test('throws GitError when not in git repository', async () => {
+      const effect = getChangeIdFromHead()
+
+      const resultPromise = Effect.runPromise(effect)
+
+      setImmediate(() => {
+        // @ts-ignore
+        mockChildProcess.stderr.emit('data', Buffer.from('fatal: not a git repository'))
+        mockChildProcess.emit('close', 128)
+      })
+
+      try {
+        await resultPromise
+        expect(true).toBe(false) // Should not reach here
+      } catch (error: any) {
+        expect(error.message).toContain('fatal: not a git repository')
+      }
+    })
+  })
+})

package/src/utils/git-commit.ts

@@ -0,0 +1,122 @@
+import { Effect } from 'effect'
+import { spawn } from 'node:child_process'
+
+/**
+ * Error thrown when git operations fail
+ */
+export class GitError extends Error {
+  constructor(
+    message: string,
+    public readonly cause?: unknown,
+  ) {
+    super(message)
+    this.name = 'GitError'
+  }
+}
+
+/**
+ * Error thrown when no Change-ID is found in commit message
+ */
+export class NoChangeIdError extends Error {
+  constructor(message: string) {
+    super(message)
+    this.name = 'NoChangeIdError'
+  }
+}
+
+/**
+ * Extracts the Change-ID from a git commit message.
+ * Gerrit adds Change-ID as a footer line in the format: "Change-Id: I<40-char-hash>"
+ *
+ * @param message - The full commit message
+ * @returns The Change-ID if found, null otherwise
+ *
+ * @example
+ * ```ts
+ * const msg = "feat: add feature\n\nChange-Id: If5a3ae8cb5a107e187447802358417f311d0c4b1"
+ * extractChangeIdFromCommitMessage(msg) // "If5a3ae8cb5a107e187447802358417f311d0c4b1"
+ * ```
+ */
+export function extractChangeIdFromCommitMessage(message: string): string | null {
+  // Match "Change-Id: I<40-hex-chars>" in commit footer
+  // Case-insensitive, allows whitespace, multiline mode
+  const changeIdRegex = /^Change-Id:\s*(I[0-9a-f]{40})\s*$/im
+
+  const match = message.match(changeIdRegex)
+  return match ? match[1] : null
+}
+
+/**
+ * Runs a git command and returns the output
+ */
+const runGitCommand = (args: readonly string[]): Effect.Effect<string, GitError> =>
+  Effect.async<string, GitError>((resume) => {
+    const child = spawn('git', [...args], {
+      stdio: ['ignore', 'pipe', 'pipe'],
+    })
+
+    let stdout = ''
+    let stderr = ''
+
+    child.stdout.on('data', (data: Buffer) => {
+      stdout += data.toString()
+    })
+
+    child.stderr.on('data', (data: Buffer) => {
+      stderr += data.toString()
+    })
+
+    child.on('error', (error: Error) => {
+      resume(Effect.fail(new GitError('Failed to execute git command', error)))
+    })
+
+    child.on('close', (code: number | null) => {
+      if (code === 0) {
+        resume(Effect.succeed(stdout.trim()))
+      } else {
+        const errorMessage =
+          stderr.trim() || `Git command failed with exit code ${code ?? 'unknown'}`
+        resume(Effect.fail(new GitError(errorMessage)))
+      }
+    })
+  })
+
+/**
+ * Gets the commit message of the HEAD commit
+ *
+ * @returns Effect that resolves to the commit message
+ * @throws GitError if not in a git repository or git command fails
+ */
+export const getLastCommitMessage = (): Effect.Effect<string, GitError> =>
+  runGitCommand(['log', '-1', '--pretty=format:%B'])
+
+/**
+ * Extracts the Change-ID from the HEAD commit message
+ *
+ * @returns Effect that resolves to the Change-ID
+ * @throws GitError if not in a git repository or git command fails
+ * @throws NoChangeIdError if no Change-ID is found in the commit message
+ *
+ * @example
+ * ```ts
+ * const effect = getChangeIdFromHead()
+ * const changeId = await Effect.runPromise(effect)
+ * console.log(changeId) // "If5a3ae8cb5a107e187447802358417f311d0c4b1"
+ * ```
+ */
+export const getChangeIdFromHead = (): Effect.Effect<string, GitError | NoChangeIdError> =>
+  Effect.gen(function* () {
+    const message = yield* getLastCommitMessage()
+
+    const changeId = extractChangeIdFromCommitMessage(message)
+
+    if (!changeId) {
+      return yield* Effect.fail(
+        new NoChangeIdError(
+          'No Change-ID found in HEAD commit. Please provide a change number or Change-ID explicitly.',
+        ),
+      )
+    }
+
+    return changeId
+  })

package/src/utils/index.ts

@@ -0,0 +1,55 @@
+/**
+ * Utility functions for working with Gerrit
+ * @module utils
+ */
+
+// Change ID utilities
+export {
+  normalizeChangeIdentifier,
+  isChangeId,
+  isChangeNumber,
+  isValidChangeIdentifier,
+  getIdentifierType,
+} from './change-id'
+
+// Git commit utilities
+export {
+  extractChangeIdFromCommitMessage,
+  getLastCommitMessage,
+  getChangeIdFromHead,
+  GitError,
+  NoChangeIdError,
+} from './git-commit'
+
+// URL parsing
+export {
+  extractChangeNumber,
+  normalizeGerritHost,
+  isValidChangeId,
+} from './url-parser'
+
+// Message filtering
+export { filterMeaningfulMessages, sortMessagesByDate } from './message-filters'
+
+// Shell safety
+export { sanitizeCDATA } from './shell-safety'
+
+// Formatters
+export {
+  formatDate,
+  getStatusIndicator,
+  colors,
+} from './formatters'
+
+export {
+  formatCommentsPretty,
+  formatCommentsXml,
+  type CommentWithContext,
+} from './comment-formatters'
+
+export {
+  formatDiffPretty,
+  formatDiffSummary,
+  formatFilesList,
+  extractDiffStats,
+} from './diff-formatters'

package/src/utils/message-filters.ts

@@ -0,0 +1,26 @@
+import type { MessageInfo } from '@/schemas/gerrit'
+
+/**
+ * Filters out automated messages and empty messages, keeping meaningful review activity
+ */
+export const filterMeaningfulMessages = (messages: readonly MessageInfo[]): MessageInfo[] => {
+  return messages.filter((msg) => {
+    // Keep messages that have content beyond automated tags
+    if (!msg.message || msg.message.trim().length === 0) return false
+
+    // Skip some automated messages but keep build/review status messages
+    if (msg.tag === 'autogenerated:gerrit:newPatchSet') return false
+    if (msg.tag === 'autogenerated:gerrit:merged') return false
+
+    return true
+  })
+}
+
+/**
+ * Sorts messages by date with newest first
+ */
+export const sortMessagesByDate = (messages: readonly MessageInfo[]): MessageInfo[] => {
+  return [...messages].sort((a, b) => {
+    return new Date(b.date).getTime() - new Date(a.date).getTime()
+  })
+}

package/src/utils/review-formatters.ts

@@ -0,0 +1,89 @@
+import type { ChangeInfo, CommentInfo, MessageInfo } from '@/schemas/gerrit'
+import { sanitizeCDATA, escapeXML } from '@/utils/shell-safety'
+
+export const formatChangeAsXML = (change: ChangeInfo): string[] => {
+  const lines: string[] = []
+  lines.push(`  <change>`)
+  lines.push(`    <id>${escapeXML(change.change_id)}</id>`)
+  lines.push(`    <number>${change._number}</number>`)
+  lines.push(`    <subject><![CDATA[${sanitizeCDATA(change.subject)}]]></subject>`)
+  lines.push(`    <status>${escapeXML(change.status)}</status>`)
+  lines.push(`    <project>${escapeXML(change.project)}</project>`)
+  lines.push(`    <branch>${escapeXML(change.branch)}</branch>`)
+  lines.push(`    <owner>`)
+  if (change.owner?.name) {
+    lines.push(`      <name><![CDATA[${sanitizeCDATA(change.owner.name)}]]></name>`)
+  }
+  if (change.owner?.email) {
+    lines.push(`      <email>${escapeXML(change.owner.email)}</email>`)
+  }
+  lines.push(`    </owner>`)
+  lines.push(`    <created>${escapeXML(change.created || '')}</created>`)
+  lines.push(`    <updated>${escapeXML(change.updated || '')}</updated>`)
+  lines.push(`  </change>`)
+  return lines
+}
+
+export const formatCommentsAsXML = (comments: readonly CommentInfo[]): string[] => {
+  const lines: string[] = []
+  lines.push(`  <comments>`)
+  lines.push(`    <count>${comments.length}</count>`)
+  for (const comment of comments) {
+    lines.push(`    <comment>`)
+    if (comment.id) lines.push(`      <id>${escapeXML(comment.id)}</id>`)
+    if (comment.path) {
+      lines.push(`      <path><![CDATA[${sanitizeCDATA(comment.path)}]]></path>`)
+    }
+    if (comment.line) lines.push(`      <line>${comment.line}</line>`)
+    if (comment.author?.name) {
+      lines.push(`      <author><![CDATA[${sanitizeCDATA(comment.author.name)}]]></author>`)
+    }
+    if (comment.updated) lines.push(`      <updated>${escapeXML(comment.updated)}</updated>`)
+    if (comment.message) {
+      lines.push(`      <message><![CDATA[${sanitizeCDATA(comment.message)}]]></message>`)
+    }
+    if (comment.unresolved) lines.push(`      <unresolved>true</unresolved>`)
+    lines.push(`    </comment>`)
+  }
+  lines.push(`  </comments>`)
+  return lines
+}
+
+export const formatMessagesAsXML = (messages: readonly MessageInfo[]): string[] => {
+  const lines: string[] = []
+  lines.push(`  <messages>`)
+  lines.push(`    <count>${messages.length}</count>`)
+  for (const message of messages) {
+    lines.push(`    <message>`)
+    lines.push(`      <id>${escapeXML(message.id)}</id>`)
+    if (message.author?.name) {
+      lines.push(`      <author><![CDATA[${sanitizeCDATA(message.author.name)}]]></author>`)
+    }
+    if (message.author?._account_id) {
+      lines.push(`      <author_id>${message.author._account_id}</author_id>`)
+    }
+    lines.push(`      <date>${escapeXML(message.date)}</date>`)
+    if (message._revision_number) {
+      lines.push(`      <revision>${message._revision_number}</revision>`)
+    }
+    if (message.tag) {
+      lines.push(`      <tag>${escapeXML(message.tag)}</tag>`)
+    }
+    lines.push(`      <message><![CDATA[${sanitizeCDATA(message.message)}]]></message>`)
+    lines.push(`    </message>`)
+  }
+  lines.push(`  </messages>`)
+  return lines
+}
+
+export const flattenComments = (
+  commentsMap: Record<string, readonly CommentInfo[]>,
+): CommentInfo[] => {
+  const comments: CommentInfo[] = []
+  for (const [path, fileComments] of Object.entries(commentsMap)) {
+    for (const comment of fileComments) {
+      comments.push({ ...comment, path })
+    }
+  }
+  return comments
+}

package/src/utils/review-prompt-builder.ts

@@ -0,0 +1,110 @@
+import { Effect } from 'effect'
+import { type ApiError, GerritApiService } from '@/api/gerrit'
+import { flattenComments } from '@/utils/review-formatters'
+
+export const buildEnhancedPrompt = (
+  userPrompt: string,
+  systemPrompt: string,
+  changeId: string,
+  changedFiles: string[],
+): Effect.Effect<string, ApiError, GerritApiService> =>
+  Effect.gen(function* () {
+    const gerritApi = yield* GerritApiService
+
+    const change = yield* gerritApi.getChange(changeId)
+    const commentsMap = yield* gerritApi.getComments(changeId)
+    const messages = yield* gerritApi.getMessages(changeId)
+
+    const comments = flattenComments(commentsMap)
+
+    const promptLines: string[] = []
+
+    // System prompt FIRST - critical for response format instructions
+    promptLines.push(systemPrompt.trim())
+    promptLines.push('')
+
+    // User custom prompt (if provided)
+    if (userPrompt.trim()) {
+      promptLines.push('ADDITIONAL INSTRUCTIONS FROM USER:')
+      promptLines.push('===================================')
+      promptLines.push(userPrompt.trim())
+      promptLines.push('')
+    }
+
+    // Change metadata section
+    promptLines.push('CHANGE INFORMATION')
+    promptLines.push('==================')
+    promptLines.push(`Change ID: ${change.change_id}`)
+    promptLines.push(`Number: ${change._number}`)
+    promptLines.push(`Subject: ${change.subject}`)
+    promptLines.push(`Project: ${change.project}`)
+    promptLines.push(`Branch: ${change.branch}`)
+    promptLines.push(`Status: ${change.status}`)
+    if (change.owner?.name) {
+      promptLines.push(`Author: ${change.owner.name}`)
+    }
+    promptLines.push('')
+
+    // Existing comments section
+    if (comments.length > 0) {
+      promptLines.push('EXISTING COMMENTS')
+      promptLines.push('=================')
+      for (const comment of comments) {
+        const author = comment.author?.name || 'Unknown'
+        const date = comment.updated || 'Unknown date'
+        const location = comment.path
+          ? `${comment.path}${comment.line ? `:${comment.line}` : ''}`
+          : 'General'
+        promptLines.push(`[${author}] on ${location} (${date}):`)
+        promptLines.push(`  ${comment.message}`)
+        if (comment.unresolved) {
+          promptLines.push('  ⚠️ UNRESOLVED')
+        }
+        promptLines.push('')
+      }
+    }
+
+    // Review messages section
+    if (messages.length > 0) {
+      promptLines.push('REVIEW ACTIVITY')
+      promptLines.push('===============')
+      for (const message of messages) {
+        const author = message.author?.name || 'Unknown'
+        const cleanMessage = message.message.trim()
+
+        // Skip very short automated messages
+        if (
+          cleanMessage.length >= 10 &&
+          !cleanMessage.includes('Build') &&
+          !cleanMessage.includes('Patch')
+        ) {
+          promptLines.push(`[${author}] ${message.date}:`)
+          promptLines.push(`  ${cleanMessage}`)
+          promptLines.push('')
+        }
+      }
+    }
+
+    // Changed files section
+    promptLines.push('CHANGED FILES')
+    promptLines.push('=============')
+    for (const file of changedFiles) {
+      promptLines.push(`- ${file}`)
+    }
+    promptLines.push('')
+
+    // Git capabilities section
+    promptLines.push('GIT CAPABILITIES')
+    promptLines.push('================')
+    promptLines.push('You are running in a git repository with full access to:')
+    promptLines.push('- git diff, git show, git log for understanding changes')
+    promptLines.push('- git blame for code ownership context')
+    promptLines.push('- All project files for architectural understanding')
+    promptLines.push('- Use these tools to provide comprehensive review')
+    promptLines.push('')
+
+    promptLines.push('Focus your review on the changed files listed above, but feel free to')
+    promptLines.push('examine related files, tests, and project structure as needed.')
+
+    return promptLines.join('\n')
+  })