valaxy-addon-git-log/test/node/gitLog.test.ts

Integrates git logs into your page of Valaxy site.

import path from 'node:path'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'

// Mock simple-git before importing modules that depend on it
vi.mock('simple-git', () => {
  const mockGit = {
    raw: vi.fn(),
    revparse: vi.fn(),
  }
  return { default: () => mockGit }
})

// Mock fs-extra
vi.mock('fs-extra', () => ({
  default: {
    pathExists: vi.fn().mockResolvedValue(false),
    readFile: vi.fn(),
    writeFile: vi.fn(),
    mkdir: vi.fn(),
  },
}))

// Mock consola
vi.mock('consola', () => ({
  default: {
    warn: vi.fn(),
    error: vi.fn(),
  },
}))

// Mock gravatar
vi.mock('gravatar', () => ({
  default: {
    url: (email: string) => `https://gravatar.com/${email}`,
  },
}))

// Mock md5
vi.mock('md5', () => ({
  default: (str: string) => `md5-${str}`,
}))

const FIELD_SEP = '\x1F'

describe('gitLog batch parsing', () => {
  beforeEach(() => {
    vi.resetModules()
  })

  afterEach(() => {
    vi.restoreAllMocks()
  })

  it('should parse contributor data from git log output', async () => {
    const { git } = await import('../../node/index')
    const rawMock = vi.mocked(git.raw)

    // The pages-dir guard in handleGitLogInfo requires the route's filePath
    // to live under <cwd>/pages, and batchGetContributors resolves the
    // pretty-format file paths against the git root. Use real cwd so both
    // gates pass and the absolute paths line up.
    const cwd = process.cwd()
    const pagesPath = path.join(cwd, 'pages', 'index.md')

    // Simulate contributor git log output using \x1F separator.
    // pages/index.md is touched by 2 commits from Alice (count=2) and 1
    // commit from Bob (count=1). pages/about.md is touched by 1 Alice commit
    // and is included to verify the per-file grouping doesn't leak across.
    const contributorOutput = [
      `---COMMIT_SEP---Alice${FIELD_SEP}alice@example.com`,
      'pages/index.md',
      `---COMMIT_SEP---Bob${FIELD_SEP}bob@example.com`,
      'pages/index.md',
      `---COMMIT_SEP---Alice${FIELD_SEP}alice@example.com`,
      'pages/index.md',
      'pages/about.md',
    ].join('\n')

    // Simulate changelog git log output (no matching messages → empty)
    const changelogOutput = ''

    rawMock
      .mockResolvedValueOnce(contributorOutput) // batchGetContributors
      .mockResolvedValueOnce(changelogOutput) // batchGetChangelog

    const gitLogModule = await import('../../node/gitLog')
    gitLogModule.setBasePath(cwd)

    const mockRoute = {
      components: new Map([['default', pagesPath]]),
      meta: { frontmatter: {} },
    }

    const options = { contributor: { strategy: 'build-time' as const } }
    await gitLogModule.handleGitLogInfo(options, mockRoute as any)
    // Parsing actually happens in flushGitLogBatch — without this call the
    // mocked git.raw output is never consumed.
    await gitLogModule.flushGitLogBatch(options)

    const fm = mockRoute.meta.frontmatter as any
    expect(fm.git_log).toBeDefined()
    expect(fm.git_log.path).toBe('pages/index.md')

    // Assert contributors were parsed with the \x1F separator and grouped per-file
    expect(fm.git_log.contributors).toHaveLength(2)
    expect(fm.git_log.contributors[0]).toMatchObject({ name: 'Alice', email: 'alice@example.com', count: 2 })
    expect(fm.git_log.contributors[1]).toMatchObject({ name: 'Bob', email: 'bob@example.com', count: 1 })
  })

  it('should parse contributor names containing pipe characters', async () => {
    const { git } = await import('../../node/index')
    const rawMock = vi.mocked(git.raw)

    const cwd = process.cwd()
    const pagesPath = path.join(cwd, 'pages', 'index.md')

    // Author name containing | should NOT break parsing with \x1F separator
    const contributorOutput = [
      `---COMMIT_SEP---Alice|Bob${FIELD_SEP}alice@example.com`,
      'pages/index.md',
    ].join('\n')

    const changelogOutput = ''

    rawMock
      .mockResolvedValueOnce(contributorOutput)
      .mockResolvedValueOnce(changelogOutput)

    const gitLogModule = await import('../../node/gitLog')
    gitLogModule.setBasePath(cwd)

    const mockRoute = {
      components: new Map([['default', pagesPath]]),
      meta: { frontmatter: {} },
    }

    const options = { contributor: { strategy: 'build-time' as const } }
    await gitLogModule.handleGitLogInfo(options, mockRoute as any)
    await gitLogModule.flushGitLogBatch(options)

    const fm = mockRoute.meta.frontmatter as any
    expect(fm.git_log.path).toBe('pages/index.md')
    // Pipe in author name is preserved verbatim — \x1F separator avoids the
    // collision the old `|` delimiter had.
    expect(fm.git_log.contributors).toHaveLength(1)
    expect(fm.git_log.contributors[0]).toMatchObject({
      name: 'Alice|Bob',
      email: 'alice@example.com',
    })
  })

  it('should skip routes without default component', async () => {
    const gitLogModule = await import('../../node/gitLog')
    gitLogModule.setBasePath('/test/repo')

    const mockRoute = {
      components: new Map<string, string>(),
      meta: { frontmatter: {} },
    }

    await gitLogModule.handleGitLogInfo(
      { contributor: { strategy: 'build-time' } },
      mockRoute as any,
    )

    const fm = mockRoute.meta.frontmatter as any
    expect(fm.git_log).toBeUndefined()
  })

  it('should handle runtime strategy by setting path only', async () => {
    const gitLogModule = await import('../../node/gitLog')
    gitLogModule.setBasePath('/test/repo')

    const mockRoute = {
      components: new Map([['default', '/test/repo/pages/index.md']]),
      meta: { frontmatter: {} },
    }

    await gitLogModule.handleGitLogInfo(
      { contributor: { strategy: 'runtime' } },
      mockRoute as any,
    )

    const fm = mockRoute.meta.frontmatter as any
    expect(fm.git_log.path).toBe('pages/index.md')
  })

  it('should flush empty pending routes without error', async () => {
    const gitLogModule = await import('../../node/gitLog')
    // Should not throw
    await gitLogModule.flushGitLogBatch({ contributor: { strategy: 'prebuilt' } })
  })
})

describe('github login cache', () => {
  beforeEach(() => {
    vi.resetModules()
  })

  afterEach(() => {
    vi.restoreAllMocks()
  })

  it('serializeLoginCache sorts keys and ends with a newline', async () => {
    const { serializeLoginCache } = await import('../../node/gitLog')
    const out = serializeLoginCache({ 'b@example.com': 'bob', 'a@example.com': 'alice' })
    expect(out).toBe('{\n  "a@example.com": "alice",\n  "b@example.com": "bob"\n}\n')
  })

  it('seeds resolution from the cache and writes it back', async () => {
    const { git } = await import('../../node/index')
    const rawMock = vi.mocked(git.raw)
    const fs = (await import('fs-extra')).default

    const cwd = process.cwd()
    const pagesPath = path.join(cwd, 'pages', 'index.md')

    // alice@example.com is a non-noreply email → github null until resolved.
    const contributorOutput = [
      `---COMMIT_SEP---Alice${FIELD_SEP}alice@example.com`,
      'pages/index.md',
    ].join('\n')

    rawMock
      .mockResolvedValueOnce(contributorOutput) // batchGetContributors
      .mockResolvedValueOnce('') // batchGetChangelog

    // The committed cache already knows alice → no GitHub API call is needed
    // (the unmocked @octokit/rest is never imported because nothing is unresolved).
    vi.mocked(fs.pathExists).mockResolvedValueOnce(true as any)
    vi.mocked(fs.readFile).mockResolvedValueOnce('{"alice@example.com":"alice"}' as any)
    vi.mocked(fs.writeFile).mockClear()

    const gitLogModule = await import('../../node/gitLog')
    gitLogModule.setBasePath(cwd)

    const mockRoute = {
      components: new Map([['default', pagesPath]]),
      meta: { frontmatter: {} },
    }

    const options = {
      repositoryUrl: 'https://github.com/owner/repo',
      contributor: {
        strategy: 'build-time' as const,
        githubCache: '.valaxy/git-log-contributors.json',
      },
    }
    await gitLogModule.handleGitLogInfo(options, mockRoute as any)
    await gitLogModule.flushGitLogBatch(options)

    // Seeded from cache: alice resolved to a GitHub profile without the API.
    const fm = mockRoute.meta.frontmatter as any
    expect(fm.git_log.contributors[0]).toMatchObject({
      email: 'alice@example.com',
      github: 'https://github.com/alice',
    })

    // Cache written back to the configured path with stable serialization.
    const cacheWrite = vi.mocked(fs.writeFile).mock.calls.find(
      ([p]) => String(p).endsWith(path.join('.valaxy', 'git-log-contributors.json')),
    )
    expect(cacheWrite).toBeTruthy()
    expect(cacheWrite![1]).toBe('{\n  "alice@example.com": "alice"\n}\n')
  })
})

describe('path utilities', () => {
  it('destDir should resolve to public directory', async () => {
    const { destDir } = await import('../../node/gitLog')
    expect(destDir).toBe(path.resolve(process.cwd(), './public'))
  })

  it('currentWorkingDirectory should resolve to pages directory', async () => {
    const { currentWorkingDirectory } = await import('../../node/gitLog')
    expect(currentWorkingDirectory).toBe(path.join(process.cwd(), 'pages'))
  })

  it('getBasePath should return undefined initially', async () => {
    vi.resetModules()
    const { getBasePath } = await import('../../node/gitLog')
    expect(getBasePath()).toBeUndefined()
  })

  it('setBasePath + getBasePath roundtrip', async () => {
    vi.resetModules()
    const { setBasePath, getBasePath } = await import('../../node/gitLog')
    setBasePath('/custom/path')
    expect(getBasePath()).toBe('/custom/path')
  })
})

describe('shouldIncludeCommit', () => {
  it('should include feat commits by default', async () => {
    const { shouldIncludeCommit } = await import('../../types')
    expect(shouldIncludeCommit('feat: add new feature')).toBe(true)
    expect(shouldIncludeCommit('feat(scope): something')).toBe(true)
  })

  it('should include fix commits by default', async () => {
    const { shouldIncludeCommit } = await import('../../types')
    expect(shouldIncludeCommit('fix: resolve issue')).toBe(true)
  })

  it('should include breaking changes by default', async () => {
    const { shouldIncludeCommit } = await import('../../types')
    expect(shouldIncludeCommit('refactor!: breaking change')).toBe(true)
  })

  it('should include chore: release', async () => {
    const { shouldIncludeCommit } = await import('../../types')
    expect(shouldIncludeCommit('chore: release v1.0.0')).toBe(true)
  })

  it('should exclude unmatched commits', async () => {
    const { shouldIncludeCommit } = await import('../../types')
    expect(shouldIncludeCommit('chore: update deps')).toBe(false)
    expect(shouldIncludeCommit('docs: update readme')).toBe(false)
    expect(shouldIncludeCommit('style: formatting')).toBe(false)
  })

  it('should respect custom includeTypes', async () => {
    const { shouldIncludeCommit } = await import('../../types')
    const options = { includeTypes: ['feat', 'fix', 'docs', 'perf'] }
    expect(shouldIncludeCommit('docs: update readme', options)).toBe(true)
    expect(shouldIncludeCommit('perf: optimize query', options)).toBe(true)
    expect(shouldIncludeCommit('style: formatting', options)).toBe(false)
  })

  it('should respect includeBreaking: false', async () => {
    const { shouldIncludeCommit } = await import('../../types')
    const options = { includeBreaking: false }
    // Non-included type with breaking marker
    expect(shouldIncludeCommit('refactor!: breaking', options)).toBe(false)
    // Included types with breaking marker — must also be excluded
    expect(shouldIncludeCommit('feat!: breaking feature', options)).toBe(false)
    expect(shouldIncludeCommit('feat(scope)!: breaking', options)).toBe(false)
    expect(shouldIncludeCommit('fix!: breaking fix', options)).toBe(false)
    // Non-breaking commits of included types still pass through
    expect(shouldIncludeCommit('feat: regular feature', options)).toBe(true)
    expect(shouldIncludeCommit('fix(scope): bug', options)).toBe(true)
  })
})