@aaronshaf/ger 0.1.11 → 0.2.1

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/review-prompt-builder.ts

@@ -1,6 +1,5 @@
 import { Effect } from 'effect'
 import { type ApiError, GerritApiService } from '@/api/gerrit'
-import type { CommentInfo, MessageInfo } from '@/schemas/gerrit'
 import { flattenComments } from '@/utils/review-formatters'
 
 export const buildEnhancedPrompt = (

package/src/utils/url-parser.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from 'bun:test'
-import { extractChangeNumber, isValidChangeId } from './url-parser'
+import { extractChangeNumber, isValidChangeId, normalizeGerritHost } from './url-parser'
 
 describe('extractChangeNumber', () => {
   test('extracts change number from standard Gerrit URL', () => {
@@ -121,3 +121,151 @@ describe('isValidChangeId', () => {
     expect(isValidChangeId('-abc')).toBe(false)
   })
 })
+
+describe('normalizeGerritHost', () => {
+  describe('adding protocol', () => {
+    test('adds https:// when no protocol is provided', () => {
+      expect(normalizeGerritHost('gerrit.example.com')).toBe('https://gerrit.example.com')
+    })
+
+    test('adds https:// to hostname with port', () => {
+      expect(normalizeGerritHost('gerrit.example.com:8080')).toBe('https://gerrit.example.com:8080')
+    })
+
+    test('adds https:// to localhost', () => {
+      expect(normalizeGerritHost('localhost:8080')).toBe('https://localhost:8080')
+    })
+
+    test('adds https:// to IP address', () => {
+      expect(normalizeGerritHost('192.168.1.100')).toBe('https://192.168.1.100')
+    })
+
+    test('adds https:// to IP address with port', () => {
+      expect(normalizeGerritHost('192.168.1.100:8080')).toBe('https://192.168.1.100:8080')
+    })
+  })
+
+  describe('preserving existing protocol', () => {
+    test('preserves https:// when already present', () => {
+      expect(normalizeGerritHost('https://gerrit.example.com')).toBe('https://gerrit.example.com')
+    })
+
+    test('preserves http:// when explicitly provided', () => {
+      expect(normalizeGerritHost('http://gerrit.example.com')).toBe('http://gerrit.example.com')
+    })
+
+    test('preserves https:// with port', () => {
+      expect(normalizeGerritHost('https://gerrit.example.com:8080')).toBe(
+        'https://gerrit.example.com:8080',
+      )
+    })
+
+    test('preserves http:// with port', () => {
+      expect(normalizeGerritHost('http://gerrit.example.com:8080')).toBe(
+        'http://gerrit.example.com:8080',
+      )
+    })
+  })
+
+  describe('removing trailing slashes', () => {
+    test('removes single trailing slash', () => {
+      expect(normalizeGerritHost('https://gerrit.example.com/')).toBe('https://gerrit.example.com')
+    })
+
+    test('removes trailing slash from URL without protocol', () => {
+      expect(normalizeGerritHost('gerrit.example.com/')).toBe('https://gerrit.example.com')
+    })
+
+    test('removes trailing slash from URL with port', () => {
+      expect(normalizeGerritHost('https://gerrit.example.com:8080/')).toBe(
+        'https://gerrit.example.com:8080',
+      )
+    })
+
+    test('handles URL without trailing slash', () => {
+      expect(normalizeGerritHost('https://gerrit.example.com')).toBe('https://gerrit.example.com')
+    })
+
+    test('does not remove slash from path', () => {
+      expect(normalizeGerritHost('https://gerrit.example.com/gerrit')).toBe(
+        'https://gerrit.example.com/gerrit',
+      )
+    })
+
+    test('removes trailing slash from path', () => {
+      expect(normalizeGerritHost('https://gerrit.example.com/gerrit/')).toBe(
+        'https://gerrit.example.com/gerrit',
+      )
+    })
+  })
+
+  describe('whitespace handling', () => {
+    test('trims leading whitespace', () => {
+      expect(normalizeGerritHost('  gerrit.example.com')).toBe('https://gerrit.example.com')
+    })
+
+    test('trims trailing whitespace', () => {
+      expect(normalizeGerritHost('gerrit.example.com  ')).toBe('https://gerrit.example.com')
+    })
+
+    test('trims whitespace from URL with protocol', () => {
+      expect(normalizeGerritHost('  https://gerrit.example.com  ')).toBe(
+        'https://gerrit.example.com',
+      )
+    })
+
+    test('trims whitespace and removes trailing slash', () => {
+      expect(normalizeGerritHost('  gerrit.example.com/  ')).toBe('https://gerrit.example.com')
+    })
+  })
+
+  describe('combined scenarios', () => {
+    test('adds protocol and removes trailing slash', () => {
+      expect(normalizeGerritHost('gerrit.example.com/')).toBe('https://gerrit.example.com')
+    })
+
+    test('trims, adds protocol, and removes trailing slash', () => {
+      expect(normalizeGerritHost('  gerrit.example.com/  ')).toBe('https://gerrit.example.com')
+    })
+
+    test('handles subdomain with port', () => {
+      expect(normalizeGerritHost('review.git.example.com:8443')).toBe(
+        'https://review.git.example.com:8443',
+      )
+    })
+
+    test('handles complex URL with path', () => {
+      expect(normalizeGerritHost('gerrit.example.com/gerrit')).toBe(
+        'https://gerrit.example.com/gerrit',
+      )
+    })
+
+    test('normalizes complete real-world example', () => {
+      expect(normalizeGerritHost('gerrit-review.example.org')).toBe(
+        'https://gerrit-review.example.org',
+      )
+    })
+  })
+
+  describe('edge cases', () => {
+    test('handles empty string', () => {
+      // Empty string becomes 'https:/' after normalization (protocol added, then trailing slash removed)
+      expect(normalizeGerritHost('')).toBe('https:/')
+    })
+
+    test('handles whitespace-only string', () => {
+      // Whitespace-only string becomes 'https:/' after normalization
+      expect(normalizeGerritHost('   ')).toBe('https:/')
+    })
+
+    test('handles just a slash', () => {
+      // Just a slash becomes 'https://' (protocol added to '/', then trailing slash removed leaving '//')
+      expect(normalizeGerritHost('/')).toBe('https://')
+    })
+
+    test('handles protocol only', () => {
+      // Protocol only becomes 'https:/' (trailing slash removed)
+      expect(normalizeGerritHost('https://')).toBe('https:/')
+    })
+  })
+})

package/src/utils/url-parser.ts

@@ -53,6 +53,33 @@ export const extractChangeNumber = (input: string): string => {
   }
 }
 
+/**
+ * Normalizes a Gerrit host URL by adding https:// if no protocol is provided
+ * and removing trailing slashes
+ *
+ * @param host - The host URL to normalize (e.g., "gerrit.example.com" or "https://gerrit.example.com")
+ * @returns The normalized URL with protocol and without trailing slash
+ *
+ * @example
+ * normalizeGerritHost("gerrit.example.com") // returns "https://gerrit.example.com"
+ * normalizeGerritHost("gerrit.example.com:8080") // returns "https://gerrit.example.com:8080"
+ * normalizeGerritHost("http://gerrit.example.com") // returns "http://gerrit.example.com"
+ * normalizeGerritHost("https://gerrit.example.com/") // returns "https://gerrit.example.com"
+ */
+export const normalizeGerritHost = (host: string): string => {
+  let normalized = host.trim()
+
+  // Add https:// if no protocol provided
+  if (!normalized.startsWith('http://') && !normalized.startsWith('https://')) {
+    normalized = `https://${normalized}`
+  }
+
+  // Remove trailing slash
+  normalized = normalized.replace(/\/$/, '')
+
+  return normalized
+}
+
 /**
  * Validates if a string is a valid Gerrit change identifier
  *

package/tests/change-id-formats.test.ts

@@ -0,0 +1,268 @@
+import { describe, test, expect, beforeAll, afterAll, afterEach, mock } from 'bun:test'
+import { setupServer } from 'msw/node'
+import { http, HttpResponse } from 'msw'
+import { Effect, Layer } from 'effect'
+import { showCommand } from '@/cli/commands/show'
+import { commentCommand } from '@/cli/commands/comment'
+import { diffCommand } from '@/cli/commands/diff'
+import { GerritApiServiceLive } from '@/api/gerrit'
+import { ConfigService } from '@/services/config'
+import { generateMockChange } from '@/test-utils/mock-generator'
+import { createMockConfigService } from './helpers/config-mock'
+
+/**
+ * Integration tests to verify that commands accept both change number and Change-ID formats
+ */
+
+const CHANGE_NUMBER = '392385'
+const CHANGE_ID = 'If5a3ae8cb5a107e187447802358417f311d0c4b1'
+
+const mockChange = generateMockChange({
+  _number: 392385,
+  change_id: CHANGE_ID,
+  subject: 'WIP: test',
+  status: 'NEW',
+  project: 'canvas-lms',
+  branch: 'master',
+  created: '2024-01-15 10:00:00.000000000',
+  updated: '2024-01-15 12:00:00.000000000',
+  owner: {
+    _account_id: 1001,
+    name: 'Test User',
+    email: 'test@example.com',
+  },
+})
+
+const mockDiff = `--- a/test.txt
++++ b/test.txt
+@@ -1,1 +1,2 @@
+ original line
++new line`
+
+const server = setupServer(
+  http.get('*/a/accounts/self', () => {
+    return HttpResponse.json({
+      _account_id: 1000,
+      name: 'Test User',
+      email: 'test@example.com',
+    })
+  }),
+
+  // Handler that matches both change number and Change-ID
+  http.get('*/a/changes/:changeId', ({ params }) => {
+    const { changeId } = params
+    // Accept both formats
+    if (changeId === CHANGE_NUMBER || changeId === CHANGE_ID) {
+      return HttpResponse.text(`)]}'
+${JSON.stringify(mockChange)}`)
+    }
+    return HttpResponse.text('Not Found', { status: 404 })
+  }),
+
+  http.get('*/a/changes/:changeId/revisions/current/patch', ({ params }) => {
+    const { changeId } = params
+    if (changeId === CHANGE_NUMBER || changeId === CHANGE_ID) {
+      return HttpResponse.text(btoa(mockDiff))
+    }
+    return HttpResponse.text('Not Found', { status: 404 })
+  }),
+
+  http.get('*/a/changes/:changeId/revisions/current/comments', ({ params }) => {
+    const { changeId } = params
+    if (changeId === CHANGE_NUMBER || changeId === CHANGE_ID) {
+      return HttpResponse.text(`)]}'
+{}`)
+    }
+    return HttpResponse.text('Not Found', { status: 404 })
+  }),
+
+  http.post('*/a/changes/:changeId/revisions/current/review', async ({ params }) => {
+    const { changeId } = params
+    if (changeId === CHANGE_NUMBER || changeId === CHANGE_ID) {
+      return HttpResponse.text(`)]}'
+{}`)
+    }
+    return HttpResponse.text('Not Found', { status: 404 })
+  }),
+)
+
+let capturedLogs: string[] = []
+let capturedErrors: string[] = []
+
+const mockConsoleLog = mock((...args: any[]) => {
+  capturedLogs.push(args.join(' '))
+})
+const mockConsoleError = mock((...args: any[]) => {
+  capturedErrors.push(args.join(' '))
+})
+
+const originalConsoleLog = console.log
+const originalConsoleError = console.error
+
+beforeAll(() => {
+  server.listen({ onUnhandledRequest: 'bypass' })
+  // @ts-ignore
+  console.log = mockConsoleLog
+  // @ts-ignore
+  console.error = mockConsoleError
+})
+
+afterAll(() => {
+  server.close()
+  console.log = originalConsoleLog
+  console.error = originalConsoleError
+})
+
+afterEach(() => {
+  server.resetHandlers()
+  mockConsoleLog.mockClear()
+  mockConsoleError.mockClear()
+  capturedLogs = []
+  capturedErrors = []
+})
+
+const createMockConfigLayer = (): Layer.Layer<ConfigService, never, never> =>
+  Layer.succeed(ConfigService, createMockConfigService())
+
+describe('Change ID format support', () => {
+  describe('show command', () => {
+    test('accepts numeric change number', async () => {
+      const effect = showCommand(CHANGE_NUMBER, {}).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedLogs.join('\n')
+      expect(output).toContain('Change 392385')
+      expect(output).toContain('WIP: test')
+      expect(capturedErrors.length).toBe(0)
+    })
+
+    test('accepts Change-ID format', async () => {
+      const effect = showCommand(CHANGE_ID, {}).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedLogs.join('\n')
+      expect(output).toContain('Change 392385')
+      expect(output).toContain('WIP: test')
+      expect(capturedErrors.length).toBe(0)
+    })
+
+    test('rejects invalid change identifier', async () => {
+      const effect = showCommand('invalid-id', {}).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedErrors.join('\n')
+      expect(output).toContain('Invalid change identifier')
+    })
+  })
+
+  describe('diff command', () => {
+    test('accepts numeric change number', async () => {
+      const effect = diffCommand(CHANGE_NUMBER, {}).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedLogs.join('\n')
+      expect(output).toContain('--- a/test.txt')
+      expect(output).toContain('+++ b/test.txt')
+      expect(capturedErrors.length).toBe(0)
+    })
+
+    test('accepts Change-ID format', async () => {
+      const effect = diffCommand(CHANGE_ID, {}).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedLogs.join('\n')
+      expect(output).toContain('--- a/test.txt')
+      expect(output).toContain('+++ b/test.txt')
+      expect(capturedErrors.length).toBe(0)
+    })
+  })
+
+  describe('comment command', () => {
+    test('accepts numeric change number', async () => {
+      const effect = commentCommand(CHANGE_NUMBER, { message: 'LGTM' }).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedLogs.join('\n')
+      expect(output).toContain('Comment posted successfully')
+      expect(capturedErrors.length).toBe(0)
+    })
+
+    test('accepts Change-ID format', async () => {
+      const effect = commentCommand(CHANGE_ID, { message: 'LGTM' }).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedLogs.join('\n')
+      expect(output).toContain('Comment posted successfully')
+      expect(capturedErrors.length).toBe(0)
+    })
+  })
+
+  describe('edge cases', () => {
+    test('trims whitespace from change identifiers', async () => {
+      const effect = showCommand(`  ${CHANGE_NUMBER}  `, {}).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedLogs.join('\n')
+      expect(output).toContain('Change 392385')
+      expect(capturedErrors.length).toBe(0)
+    })
+
+    test('validates Change-ID format strictly (uppercase I)', async () => {
+      const lowercaseChangeId = 'if5a3ae8cb5a107e187447802358417f311d0c4b1'
+      const effect = showCommand(lowercaseChangeId, {}).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedErrors.join('\n')
+      expect(output).toContain('Invalid change identifier')
+    })
+
+    test('rejects Change-ID with incorrect length', async () => {
+      const shortChangeId = 'If5a3ae8cb5a107e18744780235841'
+      const effect = showCommand(shortChangeId, {}).pipe(
+        Effect.provide(GerritApiServiceLive),
+        Effect.provide(createMockConfigLayer()),
+      )
+
+      await Effect.runPromise(effect)
+
+      const output = capturedErrors.join('\n')
+      expect(output).toContain('Invalid change identifier')
+    })
+  })
+})