Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions __tests__/bundle/githubApiPreload.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Preloaded into the bundle child with `NODE_OPTIONS=--require` by the GITHUB_API_URL fallback e2e test.
// Rewrites requests for the public api.github.com origin to the fake GitHub named by FAKE_GITHUB_URL and
// leaves every other fetch (and every option: headers, method, body, signal) untouched.
// Fails closed: without FAKE_GITHUB_URL an api.github.com request throws instead of leaving the test.
'use strict'

const githubApiOrigin = 'https://api.github.com'
const fakeUrl = process.env.FAKE_GITHUB_URL
const realFetch = globalThis.fetch

globalThis.fetch = (input, init) => {
const url = typeof input === 'string' ? input : input instanceof URL ? input.href : input.url
if (url.startsWith(githubApiOrigin)) {
if (!fakeUrl)
throw new Error(`githubApiPreload: FAKE_GITHUB_URL is unset, refusing to call ${url}`)
return realFetch(fakeUrl + url.slice(githubApiOrigin.length), init)
}
return realFetch(input, init)
}
55 changes: 55 additions & 0 deletions __tests__/bundle/githubApiUrlDefault.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import type { FakeGithub } from './fakeGithub'
import path from 'node:path'
import { afterAll, afterEach, beforeAll, describe, expect, it, vi } from 'vitest'

import { start } from './fakeGithub'
import { comment, configReads, helpersFor, repo, token } from './helpers'
import { runBundle } from './runBundle'

vi.setConfig({ testTimeout: 30_000 })

const preload = path.resolve(__dirname, 'githubApiPreload.cjs')
const issueRead = `GET ${repo}/issues/1`

// newOctokit (src/utils/octokit.ts) falls back to https://api.github.com when the runner leaves GITHUB_API_URL
// unset or empty. Every other bundle test points GITHUB_API_URL at the fake, so the fallback arm only runs here:
// the child gets an empty GITHUB_API_URL and a preload that redirects the public origin to the fake server.
describe('dist/index.js with an empty GITHUB_API_URL', () => {
let gh: FakeGithub
const { expectRequests } = helpersFor(() => gh)

beforeAll(async () => {
gh = await start()
})
afterEach(() => gh.reset())
afterAll(() => gh.close())

function run(apiUrl: string, extraEnv: Record<string, string> = {}) {
return runBundle({
eventName: 'issue_comment',
payload: comment('/remove-help'),
inputs: { ...token, 'prow-commands': '/help' },
apiUrl: gh.url,
env: { GITHUB_API_URL: apiUrl, ...extraEnv },
})
}

it('talks to api.github.com, so /remove-help reaches the API through the fallback base URL', async () => {
gh.route('GET', `${repo}/issues/1`, { status: 200, body: { labels: [{ name: 'help wanted' }] } })
gh.route('DELETE', `${repo}/issues/1/labels/help%20wanted`, { status: 200, body: [] })

const result = await run('', { NODE_OPTIONS: `--require "${preload}"`, FAKE_GITHUB_URL: gh.url })

expect(result.status, result.stdout).toBe(0)
expect(result.errors).toEqual([])
expectRequests(configReads(), [issueRead, `DELETE ${repo}/issues/1/labels/help%20wanted`])
})

it('fails the run before any request when the preload has no fake to redirect to', async () => {
const result = await run('', { NODE_OPTIONS: `--require "${preload}"` })

expect(result.status, result.stdout).toBe(1)
expect(result.errors.some(e => e.includes('FAKE_GITHUB_URL is unset'))).toBe(true)
expect(gh.requests).toEqual([])
})
})
Loading