src/fixtures/tests/translations.ts

import { describe, expect, test } from 'vitest'
import cheerio from 'cheerio'

import { TRANSLATIONS_FIXTURE_ROOT } from '@/frame/lib/constants'
import { getDOM, head } from '@/tests/helpers/e2etest'

if (!TRANSLATIONS_FIXTURE_ROOT) {
  let msg = 'You have to set TRANSLATIONS_FIXTURE_ROOT to run this test.'
  msg += ' Add TRANSLATIONS_FIXTURE_ROOT=src/fixtures/fixtures/translations'
  throw new Error(msg)
}

describe('translations', () => {
  test('home page', async () => {
    const $: cheerio.Root = await getDOM('/ja')
    const h1 = $('h1').text()
    // You gotta know your src/fixtures/fixtures/translations/ja-jp/data/ui.yml
    expect(h1).toBe('日本 GitHub Docs')

    const links = $('[data-testid=product] a[href]')
    const hrefs = links
      .filter((i: number, link: any) => {
        const href = $(link).attr('href')
        return href !== undefined && href.startsWith('/')
      })
      .map((i: number, link: any) => $(link))
      .get()
    const linkTexts = Object.fromEntries(
      hrefs.map(($link: any) => [$link.attr('href'), $link.text()]),
    )
    expect(linkTexts['/ja/get-started']).toBe('はじめに')
  })

  test('hello world', async () => {
    const $: cheerio.Root = await getDOM('/ja/get-started/start-your-journey/hello-world')
    const h1 = $('h1').text()
    expect(h1).toBe('こんにちは World')
  })

  test('internal links get prefixed with /ja', async () => {
    const $: cheerio.Root = await getDOM('/ja/get-started/start-your-journey/link-rewriting')
    const links = $('#article-contents a[href]')
    const jaLinks = links.filter((i: number, element: any) => {
      const href = $(element).attr('href')
      return href !== undefined && href.startsWith('/ja')
    })
    const enLinks = links.filter((i: number, element: any) => {
      const href = $(element).attr('href')
      return href !== undefined && href.startsWith('/en')
    })
    expect(jaLinks.length).toBe(2)
    expect(enLinks.length).toBe(0)
  })

  test('internal links with AUTOTITLE resolves', async () => {
    const $: cheerio.Root = await getDOM('/ja/get-started/foo/autotitling')
    const links = $('#article-contents a[href]')
    links.each((i: number, element: any) => {
      if ($(element).attr('href')?.includes('/ja/get-started/start-your-journey/hello-world')) {
        expect($(element).text()).toBe('こんにちは World')
      }
    })
    // There are 4 links on the `autotitling.md` content.
    expect.assertions(4)
  })

  test('correction of linebreaks in translations', async () => {
    // free-pro-team
    {
      const $: cheerio.Root = await getDOM('/ja/get-started/foo/table-with-ifversions')

      const paragraph = $('#article-contents p').text()
      expect(paragraph).toMatch('mention of HubGit in Liquid')

      const tds = $('#article-contents td')
        .map((i: number, element: any) => $(element).text())
        .get()
      expect(tds.length).toBe(2)
      expect(tds[1]).toBe('Not')
    }
    // enterprise-server
    {
      const $: cheerio.Root = await getDOM(
        '/ja/enterprise-server@latest/get-started/foo/table-with-ifversions',
      )

      const paragraph = $('#article-contents p').text()
      expect(paragraph).toMatch('mention of HubGit Enterprise Server in Liquid')

      const tds = $('#article-contents td')
        .map((i: number, element: any) => $(element).text())
        .get()
      expect(tds.length).toBe(2)
      expect(tds[1]).toBe('Present')
    }
  })

  test('automatic correction of bad AUTOTITLE in reusables', async () => {
    const $: cheerio.Root = await getDOM('/ja/get-started/start-your-journey/hello-world')
    const links = $('#article-contents a[href]')
    const texts = links.map((i: number, element: any) => $(element).text()).get()
    // That Japanese page uses AUTOTITLE links. Both in the main `.md` file
    // but also inside a reusable.
    // E.g. `["AUTOTITLE](/get-started/start-your-journey/hello-world)."`
    // If we didn't do the necessary string corrections on translations'
    // content and reusables what *would* remain is a HTML link that
    // would look like this:
    //
    //    <a href="/ja/get-started/start-your-journey/hello-world">&quot;AUTOTITLE</a>
    //
    // This test makes sure no such string is left in any of the article
    // content links.
    // Note that, in English, it's not acceptable to have such a piece of
    // Markdown. It would not be let into `main` by our CI checks. But
    // by their nature, translations are not checked by CI in the same way.
    // Its "flaws" have to be corrected at runtime.
    const stillAutotitle = texts.filter((text: string) => /autotitle/i.test(text))
    expect(stillAutotitle.length).toBe(0)
  })

  test('markdown link looking constructs inside links', async () => {
    // On this page, the translators had written:
    //
    //   [[Bar](バー)](/get-started/foo/bar)
    //
    // which needs to become:
    //
    //   <a href="/ja/get-started/foo/bar">[Bar](バー)</a>
    const $: cheerio.Root = await getDOM('/ja/get-started/start-your-journey/hello-world')
    const links = $('#article-contents a[href]')
    const texts = links
      .filter((i: number, element: any) => {
        const href = $(element).attr('href')
        return href !== undefined && href.includes('get-started/foo/bar')
      })
      .map((i: number, element: any) => $(element).text())
      .get()
    // Check that the text contains the essential parts rather than exact spacing
    const foundBarLink = texts.find(
      (text: string) => text.includes('[Bar]') && text.includes('(バー)'),
    )
    expect(foundBarLink).toBeDefined()
  })

  describe('localized category versioning', () => {
    test('category page works in all children versions', async () => {
      {
        // for translated content, we expect this to be OK
        const res = await head('/ja/get-started')
        expect(res.statusCode).toBe(200)
      }
      {
        // The actual versioning for get-started/empty-categories
        // does not specify ghes, so it should 404.
        const res = await head('/ja/enterprise-server@latest/get-started/empty-categories')
        expect(res.statusCode).toBe(404)
      }
      {
        // Yet this nested page shoudl work.
        const res = await head('/ja/enterprise-cloud@latest/get-started/empty-categories/only-ghec')
        expect(res.statusCode).toBe(200)
      }
    })
  })
})