Files
outline/plugins/github/server/api/github.test.ts
T
Tom Moor 6d7cd455e9 chore: Decouple core plugins (#14340)
* chore: Move plugin-specific integration code into plugins

Core no longer imports from or names the settings of individual plugins.
Plugins now register mention providers, issue status icons, instance URLs,
settings keys, settings and import schemas, and OAuth clients through hooks.

* fix: Recompute embed instance URLs after plugins load and match legacy issue icons by URL

* fix: Skip logo upload jobs queued without a settings path

* chore: Choose issue status icons from the unfurl state
2026-11-02 19:42:48 -05:00

203 lines
6.3 KiB
TypeScript

import { IntegrationService, IntegrationType } from "@shared/types";
import { Integration } from "@server/models";
import {
buildAdmin,
buildGuestUser,
buildIntegration,
buildTeam,
buildUser,
buildViewer,
} from "@server/test/factories";
import { getTestServer } from "@server/test/support";
import { GitHub, InstallationAccess } from "../github";
import { SetupAction } from "./schema";
const server = getTestServer();
describe("#github.callback", () => {
afterEach(() => {
vi.restoreAllMocks();
});
it("should reject an installation the user cannot manage", async () => {
const user = await buildAdmin();
const state = JSON.stringify({ teamId: user.teamId, nonce: "nonce" });
const client = {
requestAppInstallations: async () => [
{ id: 1, permissions: { issues: "read" }, account: null },
],
} as unknown as Awaited<ReturnType<typeof GitHub.authenticateAsUser>>;
vi.spyOn(GitHub, "authenticateAsUser").mockResolvedValue(client);
const spy = vi
.spyOn(GitHub, "canManageInstallation")
.mockResolvedValue(InstallationAccess.Denied);
const res = await server.get(
`/api/github.callback?state=${encodeURIComponent(
state
)}&code=123&setup_action=${SetupAction.install}&installation_id=1`,
user,
{
redirect: "manual",
headers: { Cookie: "githubOAuthNonce=nonce" },
}
);
expect(res.status).toEqual(302);
expect(res.headers.get("location")).toContain("error=denied");
expect(spy).toHaveBeenCalledWith(
client,
expect.objectContaining({ id: 1 })
);
expect(
await Integration.count({
where: { teamId: user.teamId, service: IntegrationService.GitHub },
})
).toEqual(0);
});
it("should reject callback when state cookie is missing", async () => {
const user = await buildUser();
const state = JSON.stringify({
teamId: user.teamId,
nonce: "state-nonce",
});
const res = await server.get(
`/api/github.callback?state=${encodeURIComponent(
state
)}&code=123&setup_action=${SetupAction.install}&installation_id=1`,
user,
{ redirect: "manual" }
);
const body = await res.json();
expect(res.status).toEqual(400);
expect(body.error).toEqual("state_mismatch");
expect(body.message).toEqual("OAuth state cookie was missing");
});
it("should reject callback when state nonce does not match cookie", async () => {
const user = await buildUser();
const state = JSON.stringify({
teamId: user.teamId,
nonce: "attacker-nonce",
});
const res = await server.get(
`/api/github.callback?state=${encodeURIComponent(
state
)}&code=123&setup_action=${SetupAction.install}&installation_id=1`,
user,
{
redirect: "manual",
headers: { Cookie: "githubOAuthNonce=cookie-nonce" },
}
);
const body = await res.json();
expect(res.status).toEqual(400);
expect(body.error).toEqual("state_mismatch");
expect(body.message).toEqual("State returned in OAuth flow did not match");
});
it("should reject callback when nonce is missing from state", async () => {
const user = await buildUser();
const state = JSON.stringify({ teamId: user.teamId });
const res = await server.get(
`/api/github.callback?state=${encodeURIComponent(
state
)}&code=123&setup_action=${SetupAction.install}&installation_id=1`,
user,
{
redirect: "manual",
headers: { Cookie: "githubOAuthNonce=cookie-nonce" },
}
);
const body = await res.json();
expect(res.status).toEqual(400);
expect(body.error).toEqual("state_mismatch");
expect(body.message).toEqual("State returned in OAuth flow was missing");
});
it("should fail when state is not valid JSON", async () => {
const user = await buildUser();
const res = await server.get(
`/api/github.callback?state=bad&code=123&setup_action=${SetupAction.install}&installation_id=1`,
user,
{ redirect: "manual" }
);
expect(res.status).toEqual(400);
});
it.each([
["member", buildUser],
["viewer", buildViewer],
])("should not allow a %s to create an integration", async (_, build) => {
const user = await build();
const state = JSON.stringify({ teamId: user.teamId, nonce: "nonce" });
const res = await server.get(
`/api/github.callback?state=${encodeURIComponent(state)}&code=123&setup_action=${SetupAction.install}&installation_id=1`,
user,
{
redirect: "manual",
headers: { Cookie: "githubOAuthNonce=nonce" },
}
);
expect(res.status).toEqual(403);
});
});
describe("#integrations.list", () => {
it("should expose the github settings of the integration", async () => {
const team = await buildTeam();
const member = await buildUser({ teamId: team.id });
const installation = {
id: 1,
account: { id: 2, name: "outline", avatarUrl: "https://example.com" },
};
await buildIntegration({
userId: member.id,
teamId: team.id,
service: IntegrationService.GitHub,
type: IntegrationType.Embed,
settings: {
github: { installation },
url: "https://example.com",
},
});
const res = await server.post("/api/integrations.list", member);
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data[0].settings).toEqual({
url: "https://example.com",
github: { installation },
});
});
it("should not expose github settings to guests", async () => {
const team = await buildTeam();
const admin = await buildAdmin({ teamId: team.id });
const guest = await buildGuestUser({ teamId: team.id });
await buildIntegration({
userId: admin.id,
teamId: team.id,
service: IntegrationService.GitHub,
type: IntegrationType.Embed,
settings: {
url: "https://example.com",
github: {
installation: {
id: 123,
account: { id: 456, name: "acme", avatarUrl: "" },
},
},
},
});
const res = await server.post("/api/integrations.list", guest);
const body = await res.json();
expect(res.status).toEqual(200);
expect(body.data[0].settings).toEqual({ url: "https://example.com" });
});
});