Merge remote-tracking branch 'origin' into ARC-adding-modals-for-back…

…fill-page

etc/poco/bundle/extras-prod-test.json

@@ -41,7 +41,7 @@
 			"allowed": true
 		},
 		{
-			"name": "Allow Prod Basic Check Critical Pollinator Test to call Get Audit Log endpoints",
+			"name": "Allow Prod Basic Check Critical Pollinator Test to call Get Audit Log endpoints for cloud",
 			"path": "/api/audit-log/subscription/255625",
 			"method": "GET",
 			"mechanism": "asap",
@@ -50,6 +50,16 @@
 			],
 			"allowed": true
 		},
+		{
+			"name": "Allow Prod Basic Check Critical Pollinator Test to call Get Audit Log endpoints for ghe",
+			"path": "/api/audit-log/subscription/256125",
+			"method": "GET",
+			"mechanism": "asap",
+			"principals": [
+				"pollinator-check/d4f03d07-12fe-4a69-9d68-c1841066772e"
+			],
+			"allowed": true
+		},
     {
       "name": "Allow pollinator test to call Delete Installation endpoints",
       "path": "/api/deleteInstallation/21266506/https%3A%2F%2Ffusion-arc-pollinator-staging-app.atlassian.net",

etc/poco/bundle/extras-prod.json

@@ -36,7 +36,8 @@
 					"issuers": [
 						"pollinator-check/f24ec1a9-d03d-45c7-bbd8-f2094543eaba",
 						"pollinator-check/8692803e-287a-48e3-bad1-49a60a7a4f9d",
-						"pollinator-check/d4f03d07-12fe-4a69-9d68-c1841066772e"
+						"pollinator-check/d4f03d07-12fe-4a69-9d68-c1841066772e",
+						"pollinator-check/42166522-a00b-4c93-858c-bda16bbf7aba"
 					]
 				}
 			}

spa/src/api/subscriptions/index.ts

@@ -1,5 +1,7 @@
-import { axiosRest } from "../axiosInstance";
+import { axiosRest, axiosRestWithGitHubToken } from "../axiosInstance";
 
 export default {
-	getSubscriptions: () => axiosRest.get("/rest/subscriptions")
+	getSubscriptions: () => axiosRest.get("/rest/subscriptions"),
+	deleteSubscription: (subscriptionId: number) =>
+		axiosRestWithGitHubToken.delete("/rest/app/cloud/subscription/:subscriptionId", { params: { subscriptionId } })
 };

src/github/client/github-client-errors.test.ts

@@ -1,4 +1,4 @@
-import { GithubClientBlockedIpError } from "./github-client-errors";
+import { GithubClientBlockedIpError, GithubClientError } from "./github-client-errors";
 
 describe("GitHubClientError", () => {
 
@@ -19,4 +19,19 @@ describe("GitHubClientError", () => {
 		expect(error.stack).toContain("existing stack trace line 2");
 		expect(error.stack).toContain("existing stack trace line 3");
 	});
+
+	it("extract the error response body (empty)", async () => {
+		const error = new GithubClientError("test", { } as any);
+		expect(error.resBody).toEqual(undefined);
+	});
+
+	it("extract the error response body (str)", async () => {
+		const error = new GithubClientError("test", { response: { data: "test resp body" } } as any);
+		expect(error.resBody).toEqual("test resp body");
+	});
+
+	it("extract the error response body (object)", async () => {
+		const error = new GithubClientError("test", { response: { data: { hello: "error" } } } as any);
+		expect(error.resBody).toEqual(`{"hello":"error"}`);
+	});
 });

src/github/client/github-client-errors.ts

@@ -1,19 +1,33 @@
 import { AxiosError, AxiosResponse } from "axios";
 import { ErrorCode } from "rest-interfaces";
+import safeJsonStringify from "safe-json-stringify";
+
+const safeParseResponseBody = (data: unknown): string | undefined => {
+	if (data === undefined) return undefined;
+	if ((typeof data) === "string") {
+		return data as string;
+	}
+	if ((typeof data) === "object") {
+		return safeJsonStringify(data as object);
+	}
+	return String(data);
+};
 
 export class GithubClientError extends Error {
 	cause: AxiosError;
 	isRetryable = true;
 
 	status?: number;
 	code?: string;
+	resBody?: string;
 	uiErrorCode: ErrorCode;
 
 	constructor(message: string, cause: AxiosError) {
 		super(message);
 
 		this.status = cause.response?.status;
 		this.code = cause.code;
+		this.resBody = safeParseResponseBody(cause.response?.data);
 		this.uiErrorCode = "UNKNOWN";
 
 		this.cause = { ...cause };

src/rest/rest-router.ts

@@ -46,6 +46,8 @@ subRouter.use("/installation", GitHubAppsRoute);
 
 subRouter.use("/jira/cloudid", JiraCloudIDRouter);
 
+subRouter.use("/subscriptions/:subscriptionId", SubscriptionsRouter);
+
 subRouter.use(GitHubTokenHandler);
 
 subRouter.use("/org", GitHubOrgsRouter);

src/rest/routes/subscriptions/index.test.ts

@@ -0,0 +1,97 @@
+import { Installation } from "models/installation";
+import { Subscription } from "models/subscription";
+import { encodeSymmetric } from "atlassian-jwt";
+import { getFrontendApp } from "~/src/app";
+import supertest from "supertest";
+import { envVars } from "config/env";
+
+describe("Subscription", () => {
+	const testSharedSecret = "test-secret";
+	const gitHubInstallationId = 15;
+	const getToken = ({
+		secret = testSharedSecret,
+		iss = "jira-client-key",
+		exp = Date.now() / 1000 + 10000,
+		qsh = "context-qsh" } = {}): string => encodeSymmetric({
+		qsh,
+		iss,
+		exp
+	}, secret);
+	let app, subscription;
+	beforeEach(async () => {
+		app = getFrontendApp();
+		await Installation.install({
+			clientKey: "jira-client-key",
+			host: jiraHost,
+			sharedSecret: testSharedSecret
+		});
+		subscription = await Subscription.create({
+			gitHubInstallationId,
+			jiraHost
+		});
+	});
+
+	it("Should return 400 for invalid delete subscription route", async () => {
+		const resp = await supertest(app)
+			.delete("/rest/subscriptions/" + gitHubInstallationId)
+			.set("authorization", `${getToken()}`);
+
+		expect(resp.status).toBe(404);
+	});
+
+	it("Should return 401 for valid delete subscription route when missing githubToken", async () => {
+		const resp = await supertest(app)
+			.delete("/rest/app/cloud/subscriptions/" + gitHubInstallationId);
+
+		expect(resp.status).toBe(401);
+		expect(await Subscription.count()).toEqual(1);
+	});
+
+	it("Should return 404 for valid delete subscription route  when no valid subscriptionId is passed", async () => {
+		const resp = await supertest(app)
+			.delete("/rest/app/cloud/subscriptions/random-installation-id")
+			.set("authorization", `${getToken()}`);
+
+		expect(resp.status).toBe(404);
+		expect(await Subscription.count()).toEqual(1);
+	});
+
+	it("Should return 404 for valid delete subscription route  when a different subscriptionId is passed", async () => {
+		const resp = await supertest(app)
+			.delete("/rest/app/cloud/subscriptions/12")
+			.set("authorization", `${getToken()}`);
+
+		expect(resp.status).toBe(404);
+		expect(await Subscription.count()).toEqual(1);
+	});
+
+	it("Should return 204 for valid delete subscription route when subscription is deleted", async () => {
+		jiraNock
+			.delete("/rest/devinfo/0.10/bulkByProperties")
+			.query({ installationId: subscription.gitHubInstallationId })
+			.reply(200, "OK");
+
+		jiraNock
+			.delete("/rest/builds/0.1/bulkByProperties")
+			.query({ gitHubInstallationId: subscription.gitHubInstallationId })
+			.reply(200, "OK");
+
+		jiraNock
+			.delete("/rest/deployments/0.1/bulkByProperties")
+			.query({ gitHubInstallationId: subscription.gitHubInstallationId })
+			.reply(200, "OK");
+
+		jiraNock
+			.put(`/rest/atlassian-connect/latest/addons/${envVars.APP_KEY}/properties/is-configured`, {
+				isConfigured: false
+			})
+			.reply(200);
+
+		const resp = await supertest(app)
+			.delete("/rest/app/cloud/subscriptions/" + subscription.id)
+			.set("authorization", `${getToken()}`);
+
+		expect(resp.status).toBe(204);
+		expect(await Subscription.count()).toEqual(0);
+	});
+});

src/rest/routes/subscriptions/index.ts

@@ -0,0 +1,40 @@
+import { Router, Request, Response } from "express";
+import { errorWrapper } from "../../helper";
+import { getAllSubscriptions } from "./service";
+import { Installation } from "models/installation";
+import { removeSubscription } from "utils/jira-utils";
+import { GitHubServerApp } from "models/github-server-app";
+import { InvalidArgumentError } from "config/errors";
+
+export const SubscriptionsRouter = Router({ mergeParams: true  });
+
+SubscriptionsRouter.get("/", errorWrapper("SubscriptionsGet", async (req: Request, res: Response) => {
+	const { jiraHost, installation } = res.locals;
+	const { ghCloudSubscriptions, ghEnterpriseServers } = await getAllSubscriptions(jiraHost as string, (installation as Installation).id, req);
+
+	res.status(200).json({
+		ghCloudSubscriptions,
+		ghEnterpriseServers
+	});
+}));
+
+/**
+ * This delete endpoint only handles Github cloud subscriptions
+ */
+SubscriptionsRouter.delete("/", errorWrapper("SubscriptionDelete", async (req: Request, res: Response) => {
+	const subscriptionId: number = Number(req.params.subscriptionId);
+	const { installation } = res.locals as { installation: Installation; };
+
+	const cloudOrUUID = req.params.cloudOrUUID;
+	if (!cloudOrUUID) {
+		throw new InvalidArgumentError("Invalid route, couldn't determine if its cloud or enterprise!");
+	}
+
+	// TODO: Check and add test cases for GHE later
+	const gitHubAppId = cloudOrUUID === "cloud" ? undefined :
+		(await GitHubServerApp.getForUuidAndInstallationId(cloudOrUUID, installation.id))?.appId; //TODO: validate the uuid regex
+
+	await removeSubscription(installation, undefined, gitHubAppId, req.log, subscriptionId);
+
+	res.sendStatus(204);
+}));

src/routes/jira/jira-delete.test.ts

@@ -19,7 +19,7 @@ describe("DELETE /jira/configuration", () => {
 
 	beforeEach(async () => {
 		subscription = {
-			githubInstallationId: 15,
+			gitHubInstallationId: 15,
 			jiraHost,
 			destroy: jest.fn().mockResolvedValue(undefined)
 		};
@@ -41,17 +41,17 @@ describe("DELETE /jira/configuration", () => {
 	it("Delete Jira Configuration", async () => {
 		jiraNock
 			.delete("/rest/devinfo/0.10/bulkByProperties")
-			.query({ installationId: subscription.githubInstallationId })
+			.query({ installationId: subscription.gitHubInstallationId })
 			.reply(200, "OK");
 
 		jiraNock
 			.delete("/rest/builds/0.1/bulkByProperties")
-			.query({ gitHubInstallationId: subscription.githubInstallationId })
+			.query({ gitHubInstallationId: subscription.gitHubInstallationId })
 			.reply(200, "OK");
 
 		jiraNock
 			.delete("/rest/deployments/0.1/bulkByProperties")
-			.query({ gitHubInstallationId: subscription.githubInstallationId })
+			.query({ gitHubInstallationId: subscription.gitHubInstallationId })
 			.reply(200, "OK");
 
 		jiraNock
@@ -67,7 +67,7 @@ describe("DELETE /jira/configuration", () => {
 				jiraHost: subscription.jiraHost
 			},
 			params: {
-				installationId: subscription.githubInstallationId
+				installationId: subscription.gitHubInstallationId
 			}
 		};
 
@@ -81,17 +81,17 @@ describe("DELETE /jira/configuration", () => {
 		when(booleanFlag).calledWith(BooleanFlags.ENABLE_GITHUB_SECURITY_IN_JIRA, expect.anything()).mockResolvedValue(true);
 		jiraNock
 			.delete("/rest/devinfo/0.10/bulkByProperties")
-			.query({ installationId: subscription.githubInstallationId })
+			.query({ installationId: subscription.gitHubInstallationId })
 			.reply(200, "OK");
 
 		jiraNock
 			.delete("/rest/builds/0.1/bulkByProperties")
-			.query({ gitHubInstallationId: subscription.githubInstallationId })
+			.query({ gitHubInstallationId: subscription.gitHubInstallationId })
 			.reply(200, "OK");
 
 		jiraNock
 			.delete("/rest/deployments/0.1/bulkByProperties")
-			.query({ gitHubInstallationId: subscription.githubInstallationId })
+			.query({ gitHubInstallationId: subscription.gitHubInstallationId })
 			.reply(200, "OK");
 
 		jiraNock
@@ -115,7 +115,7 @@ describe("DELETE /jira/configuration", () => {
 				jiraHost: subscription.jiraHost
 			},
 			params: {
-				installationId: subscription.githubInstallationId
+				installationId: subscription.gitHubInstallationId
 			}
 		};
 
@@ -132,7 +132,7 @@ describe("DELETE /jira/configuration", () => {
 				jiraHost: subscription.jiraHost
 			},
 			params: {
-				installationId: subscription.githubInstallationId
+				installationId: subscription.gitHubInstallationId
 			}
 		};