import { readEnvCredentials } from "@alchemy.run/github/AuthProvider";
import {
gitHubBaseUrlChanged,
githubHostname,
normalizeGitHubBaseUrl,
resolveGitHubBaseUrlFromEnv,
withBaseUrl,
} from "@alchemy.run/github/BaseUrl";
import { Credentials, fromToken } from "@alchemy.run/github/Credentials";
import { describe, expect, test } from "@alchemy.run/test";
import * as ConfigProvider from "effect/ConfigProvider";
import * as Effect from "effect/Effect";
import * as Result from "effect/Result";
const normalize = (input: string) => Effect.runSync(normalizeGitHubBaseUrl(input));
describe("normalizeGitHubBaseUrl", { tags: ["unit", "provider:github", "local"] }, () => {
test("github.com hosts normalize to undefined (the github.com default)", () => {
expect(normalize("github.com")).toBeUndefined();
expect(normalize("https://github.com")).toBeUndefined();
expect(normalize("https://www.github.com/")).toBeUndefined();
expect(normalize("https://api.github.com")).toBeUndefined();
});
test("GitHub Enterprise Server hosts get /api/v3 appended", () => {
expect(normalize("github.example.com")).toBe("https://github.example.com/api/v3");
expect(normalize("https://github.example.com")).toBe("https://github.example.com/api/v3");
expect(normalize("https://github.example.com/")).toBe("https://github.example.com/api/v3");
});
test("an explicit API path is honored as-is", () => {
expect(normalize("https://github.example.com/api/v3")).toBe(
"https://github.example.com/api/v3",
);
expect(normalize("https://github.example.com/api/v3/")).toBe(
"https://github.example.com/api/v3",
);
});
test("non-default ports and http protocol are preserved", () => {
expect(normalize("http://github.example.com:8080")).toBe(
"http://github.example.com:8080/api/v3",
);
});
test("data-residency ghe.com hosts get the api. prefix", () => {
expect(normalize("acme.ghe.com")).toBe("https://api.acme.ghe.com");
expect(normalize("https://acme.ghe.com")).toBe("https://api.acme.ghe.com");
expect(normalize("https://api.acme.ghe.com")).toBe("https://api.acme.ghe.com");
});
test("invalid input fails with AuthError", () => {
const result = Effect.runSync(Effect.result(normalizeGitHubBaseUrl("https://")));
expect(Result.isFailure(result)).toBe(true);
});
});
describe("githubHostname", { tags: ["unit", "provider:github", "local"] }, () => {
test("GHES base URL yields the plain host", () => {
expect(githubHostname("https://github.example.com/api/v3")).toBe("github.example.com");
});
test("data-residency base URL drops the api. prefix", () => {
expect(githubHostname("https://api.acme.ghe.com")).toBe("acme.ghe.com");
});
});
describe("resolveGitHubBaseUrlFromEnv", { tags: ["unit", "provider:github", "local"] }, () => {
// The default ConfigProvider snapshots process.env, so tests inject their
// environment via a ConfigProvider layer instead of mutating process.env.
const resolveWith = (env: Record<string, string>) =>
Effect.runSync(
resolveGitHubBaseUrlFromEnv.pipe(
Effect.provideService(ConfigProvider.ConfigProvider, ConfigProvider.fromEnv({ env })),
),
);
test("GITHUB_BASE_URL wins over GITHUB_API_URL", () => {
expect(
resolveWith({
GITHUB_BASE_URL: "https://github.example.com",
GITHUB_API_URL: "https://api.github.com",
}),
).toBe("https://github.example.com/api/v3");
});
test("GITHUB_API_URL pointing at github.com resolves to undefined", () => {
expect(resolveWith({ GITHUB_API_URL: "https://api.github.com" })).toBeUndefined();
});
test("GH_HOST resolves as a bare hostname", () => {
expect(resolveWith({ GH_HOST: "github.example.com" })).toBe(
"https://github.example.com/api/v3",
);
});
test("resolves to undefined when nothing is set", () => {
expect(resolveWith({})).toBeUndefined();
});
});
describe("readEnvCredentials", { tags: ["unit", "provider:github", "local"] }, () => {
const readWith = (env: Record<string, string>, configBaseUrl?: string) =>
Effect.runSync(
readEnvCredentials(configBaseUrl).pipe(
Effect.provideService(ConfigProvider.ConfigProvider, ConfigProvider.fromEnv({ env })),
),
);
test("enterprise token variables win on an enterprise host", () => {
const creds = readWith({
GITHUB_BASE_URL: "https://github.example.com",
GH_ENTERPRISE_TOKEN: "enterprise-token",
GITHUB_TOKEN: "standard-token",
});
expect(creds.baseUrl).toBe("https://github.example.com/api/v3");
expect(creds.source.details).toBe("GH_ENTERPRISE_TOKEN");
});
test("enterprise token variables are ignored on github.com", () => {
const creds = readWith({
GH_ENTERPRISE_TOKEN: "enterprise-token",
GITHUB_TOKEN: "standard-token",
});
expect(creds.baseUrl).toBeUndefined();
expect(creds.source.details).toBe("GITHUB_TOKEN");
});
test("an explicit config baseUrl wins over the environment", () => {
const creds = readWith(
{ GITHUB_BASE_URL: "https://other.example.com", GITHUB_ACCESS_TOKEN: "token" },
"https://github.example.com/api/v3",
);
expect(creds.baseUrl).toBe("https://github.example.com/api/v3");
expect(creds.source.details).toBe("GITHUB_ACCESS_TOKEN");
});
test("fails with AuthError when no token variable is set", () => {
const result = Effect.runSync(
Effect.result(
readEnvCredentials().pipe(
Effect.provideService(ConfigProvider.ConfigProvider, ConfigProvider.fromEnv({ env: {} })),
),
),
);
expect(Result.isFailure(result)).toBe(true);
});
});
describe("gitHubBaseUrlChanged", { tags: ["unit", "provider:github", "local"] }, () => {
// The comparison resolves each side through the full fallback chain, so it
// needs the ambient credentials host — `undefined` in props means "use the
// credentials' host", not "github.com".
const changed = (a: string | undefined, b: string | undefined, credsBaseUrl?: string) =>
Effect.runSync(
gitHubBaseUrlChanged({ baseUrl: a }, { baseUrl: b }).pipe(
Effect.provide(
fromToken(
"test-token",
credsBaseUrl !== undefined ? { baseUrl: credsBaseUrl } : undefined,
),
),
),
);
test("cosmetic rewrites of the same host do not count as a change", () => {
expect(changed("github.example.com", "https://github.example.com/api/v3")).toBe(false);
expect(changed(undefined, "github.com")).toBe(false);
expect(changed("acme.ghe.com", "https://api.acme.ghe.com")).toBe(false);
});
test("moving between hosts counts as a change", () => {
expect(changed(undefined, "github.example.com")).toBe(true);
expect(changed("github.example.com", undefined)).toBe(true);
expect(changed("github.example.com", "other.example.com")).toBe(true);
});
test("making the ambient enterprise host explicit is not a change", () => {
// providers({ baseUrl: "github.example.com" }): prop undefined and prop
// "github.example.com" resolve to the same effective host.
expect(changed(undefined, "github.example.com", "github.example.com")).toBe(false);
expect(changed("github.example.com", undefined, "github.example.com")).toBe(false);
expect(changed(undefined, "https://github.example.com/api/v3", "github.example.com")).toBe(
false,
);
});
test("explicit github.com under an ambient enterprise host IS a change", () => {
// prop undefined resolves to the enterprise host; prop "github.com"
// pins the resource back to github.com — different physical instance.
expect(changed(undefined, "github.com", "github.example.com")).toBe(true);
expect(changed("github.com", undefined, "github.example.com")).toBe(true);
});
test("undefined on both sides is never a change", () => {
expect(changed(undefined, undefined)).toBe(false);
expect(changed(undefined, undefined, "github.example.com")).toBe(false);
});
});
describe("withBaseUrl", { tags: ["unit", "provider:github", "local"] }, () => {
const apiBaseUrlOf = (credsBaseUrl: string | undefined, resourceBaseUrl: string | undefined) =>
Effect.runSync(
Effect.gen(function* () {
return (yield* yield* Credentials).apiBaseUrl;
}).pipe(
withBaseUrl(resourceBaseUrl),
Effect.provide(
fromToken(
"test-token",
credsBaseUrl !== undefined ? { baseUrl: credsBaseUrl } : undefined,
),
),
),
);
test("falls back to the credentials' host when no override is given", () => {
expect(apiBaseUrlOf("github.example.com", undefined)).toBe("https://github.example.com/api/v3");
});
test("a per-resource baseUrl overrides the credentials' host", () => {
expect(apiBaseUrlOf("github.example.com", "other.example.com")).toBe(
"https://other.example.com/api/v3",
);
});
test("an explicit github.com override wins over an enterprise credential host", () => {
expect(apiBaseUrlOf("github.example.com", "github.com")).toBe("https://api.github.com");
});
test("defaults to api.github.com", () => {
expect(apiBaseUrlOf(undefined, undefined)).toBe("https://api.github.com");
});
});