src/changelogs/tests/get-rss-feeds.ts

import fs from 'fs/promises'
import path from 'path'

import nock from 'nock'
import { afterAll, beforeAll, describe, expect, test } from 'vitest'

import { getChangelogItems } from '@/changelogs/lib/changelog'
import type { ChangelogItem } from '@/types'

describe('getChangelogItems module', () => {
  let changelog: ChangelogItem[] | undefined

  beforeAll(async () => {
    const rssFeedContent = await fs.readFile(
      path.join(process.cwd(), 'src/fixtures/fixtures/rss-feed.xml'),
      'utf8',
    )

    nock('https://github.blog').get('/changelog/label/packages/feed').reply(200, rssFeedContent)

    changelog = await getChangelogItems(
      'GitHub Actions:',
      'https://github.blog/changelog/label/packages',
      // This means: Don't use the cache even if it's present.
      // The reason we're doing this is because all other tests, the
      // cache is prepopulated from a file from the test fixtures. But
      // in this particular file, we really do want to execute that code
      // that executes on a cache miss. But this particular file special
      // because it explicitly uses nock() to mock the HTTP socket.
      // So even if we say "Don't use the cache" here, it still won't
      // depend on Internet access because we're using `nock` here.
      true,
    )
  })

  afterAll(() => nock.cleanAll())

  test('changelog contains 3 items', async () => {
    expect(changelog && changelog.length).toEqual(3)
  })

  test('each changelog item has expected title, date, and href', async () => {
    const expectedChangelogValues = [
      {
        title: 'Authentication token format updates are generally available',
        date: '2021-03-31T22:22:03.000Z',
        href: 'https://github.blog/changelog/2021-03-31-authentication-token-format-updates-are-generally-available',
      },
      {
        title: 'Compare REST API now supports pagination',
        date: '2021-03-23T02:49:54.000Z',
        href: 'https://github.blog/changelog/2021-03-22-compare-rest-api-now-supports-pagination',
      },
      {
        title: 'GitHub Discussions GraphQL API public beta',
        date: '2021-02-23T18:21:40.000Z',
        href: 'https://github.blog/changelog/2021-02-23-github-discussions-graphql-api-public-beta',
      },
    ]

    if (!changelog) throw new Error('changelog is undefined')
    for (let i = 0; i < 3; i++) {
      const changeLogEntry = changelog[i]
      const expectedEntry = expectedChangelogValues[i]
      expect(changeLogEntry.title).toBe(expectedEntry.title)
      expect(changeLogEntry.date).toBe(expectedEntry.date)
      expect(changeLogEntry.href).toBe(expectedEntry.href)
    }
  })
})