chore: add new endpoint for backfill

spa/src/api/subscriptions/index.ts

@@ -1,5 +1,11 @@
 import { axiosRest } from "../axiosInstance";
 
 export default {
-	getSubscriptions: () => axiosRest.get("/rest/subscriptions")
+	getSubscriptions: () => axiosRest.get("/rest/subscriptions"),
+	syncSubscriptions: (data: {
+		installationId: number;
+		commitsFromDate: string;
+		source: string;
+		syncType: string;
+	}) => axiosRest.post(`/rest/app/cloud/sync`, data),
 };

src/rest/rest-router.ts

@@ -1,5 +1,6 @@
 import { Router } from "express";
 import { JwtHandler } from "./middleware/jwt/jwt-handler";
+import { body } from "express-validator";
 import { OAuthRouter } from "./routes/oauth";
 import { OAuthCallbackHandler, OrgsInstalledHandler, OrgsInstallRequestedHandler } from "./routes/github-callback";
 import { GitHubOrgsRouter } from "./routes/github-orgs";
@@ -10,6 +11,7 @@ import { RestErrorHandler } from "./middleware/error";
 import { JiraAdminEnforceMiddleware } from "./middleware/jira-admin/jira-admin-check";
 import { AnalyticsProxyHandler } from "./routes/analytics-proxy";
 import { SubscriptionsRouter } from "./routes/subscriptions";
+import { SyncRouterHandler } from "./routes/sync";
 import { DeferredRouter } from "./routes/deferred";
 
 export const RestRouter = Router({ mergeParams: true });
@@ -27,6 +29,14 @@ RestRouter.use("/subscriptions", JwtHandler, JiraAdminEnforceMiddleware, Subscri
  */
 RestRouter.use("/app/:cloudOrUUID", subRouter);
 
+subRouter.post(
+	"/sync",
+	body("commitsFromDate").optional().isISO8601(),
+	JwtHandler,
+	JiraAdminEnforceMiddleware,
+	SyncRouterHandler
+);
+
 subRouter.get("/github-callback", OAuthCallbackHandler);
 subRouter.get("/github-installed", OrgsInstalledHandler);
 subRouter.get("/github-requested", OrgsInstallRequestedHandler);

src/rest/routes/sync/index.ts

@@ -0,0 +1,92 @@
+import { Request, Response, NextFunction } from "express";
+import { ParamsDictionary } from "express-serve-static-core";
+import { errorWrapper } from "../../helper";
+import { Subscription } from "models/subscription";
+import { booleanFlag, BooleanFlags } from "config/feature-flags";
+import { findOrStartSync } from "~/src/sync/sync-utils";
+import { determineSyncTypeAndTargetTasks } from "~/src/util/github-sync-helper";
+import { BaseLocals } from "..";
+import { InvalidArgumentError } from "~/src/config/errors";
+
+interface RequestBody {
+	installationId: number;
+	appId: number;
+	syncType: string;
+	source: string;
+	commitsFromDate: string;
+}
+
+const restSyncPost = async (
+	req: Request<ParamsDictionary, unknown, RequestBody>,
+	res: Response<unknown, BaseLocals>,
+	next: NextFunction
+) => {
+	//TODO: We are yet to handle enterprise backfill
+	// const cloudOrUUID = req.params.cloudOrUUID;
+	// const gheUUID = cloudOrUUID === "cloud" ? undefined : "some-ghe-uuid";
+
+	const {
+		installationId: gitHubInstallationId,
+		appId: gitHubAppId,
+		syncType: syncTypeFromReq,
+		source
+	} = req.body;
+	// A date to start fetching commit history(main and branch) from.
+	const commitsFromDate = req.body.commitsFromDate
+		? new Date(req.body.commitsFromDate)
+		: undefined;
+
+	const logAdditionalData = await booleanFlag(
+		BooleanFlags.VERBOSE_LOGGING,
+		res.locals.installation.jiraHost
+	);
+
+	logAdditionalData
+		? req.log.info(
+			{ gitHubInstallationId },
+			"verbose logging - Received sync request on rest route")
+		: req.log.info("Received sync request on rest route");
+
+	try {
+		const subscription = await Subscription.getSingleInstallation(
+			res.locals.installation.jiraHost,
+			gitHubInstallationId,
+			gitHubAppId
+		);
+		if (!subscription) {
+			req.log.info(
+				{
+					jiraHost: res.locals.installation.jiraHost,
+					installationId: gitHubInstallationId
+				},
+				"Subscription not found when retrying sync."
+			);
+			throw new InvalidArgumentError("Subscription not found, cannot resync.");
+		}
+
+		if (commitsFromDate && commitsFromDate.valueOf() > Date.now()) {
+			throw new InvalidArgumentError(
+				"Invalid date value, cannot select a future date!"
+			);
+		}
+
+		const { syncType, targetTasks } = determineSyncTypeAndTargetTasks(
+			syncTypeFromReq,
+			subscription
+		);
+		await findOrStartSync(
+			subscription,
+			req.log,
+			syncType,
+			commitsFromDate || subscription.backfillSince,
+			targetTasks,
+			{ source }
+		);
+
+		res.sendStatus(202);
+	} catch (error: unknown) {
+		next(new Error("Unauthorized"));
+	}
+};
+
+export const SyncRouterHandler = errorWrapper("AnalyticsProxyHandler",restSyncPost);

src/routes/jira/sync/jira-sync-post.ts

@@ -1,11 +1,11 @@
-import { Subscription, SyncStatus } from "models/subscription";
+import { Subscription } from "models/subscription";
 import * as Sentry from "@sentry/node";
 import { NextFunction, Request, Response } from "express";
 import { findOrStartSync } from "~/src/sync/sync-utils";
 import { sendAnalytics } from "utils/analytics-client";
 import { AnalyticsEventTypes, AnalyticsTrackEventsEnum, AnalyticsTrackSource } from "interfaces/common";
-import { TaskType, SyncType } from "~/src/sync/sync.types";
 import { booleanFlag, BooleanFlags } from "config/feature-flags";
+import { determineSyncTypeAndTargetTasks, getStartTimeInDaysAgo } from "../../../util/github-sync-helper";
 
 export const JiraSyncPost = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
 	const { installationId: gitHubInstallationId, appId: gitHubAppId, syncType: syncTypeFromReq, source } = req.body;
@@ -35,7 +35,7 @@ export const JiraSyncPost = async (req: Request, res: Response, next: NextFuncti
 			return;
 		}
 
-		const { syncType, targetTasks } = await determineSyncTypeAndTargetTasks(syncTypeFromReq, subscription);
+		const { syncType, targetTasks } = determineSyncTypeAndTargetTasks(syncTypeFromReq, subscription);
 		await findOrStartSync(subscription, req.log, syncType, commitsFromDate || subscription.backfillSince, targetTasks, { source });
 
 		await sendAnalytics(res.locals.jiraHost, AnalyticsEventTypes.TrackEvent, {
@@ -64,26 +64,3 @@ export const JiraSyncPost = async (req: Request, res: Response, next: NextFuncti
 		next(new Error("Unauthorized"));
 	}
 };
-
-const MILLISECONDS_IN_ONE_DAY = 24 * 60 * 60 * 1000;
-const getStartTimeInDaysAgo = (commitsFromDate: Date | undefined) => {
-	if (commitsFromDate === undefined) return undefined;
-	return Math.floor((Date.now() -  commitsFromDate?.getTime()) / MILLISECONDS_IN_ONE_DAY);
-};
-
-type SyncTypeAndTargetTasks = {
-	syncType: SyncType,
-	targetTasks: TaskType[] | undefined,
-};
-
-const determineSyncTypeAndTargetTasks = async (syncTypeFromReq: string, subscription: Subscription): Promise<SyncTypeAndTargetTasks> => {
-	if (syncTypeFromReq === "full") {
-		return { syncType: "full", targetTasks: undefined };
-	}
-
-	if (subscription.syncStatus === SyncStatus.FAILED) {
-		return { syncType: "full", targetTasks: undefined };
-	}
-
-	return { syncType: "partial", targetTasks: ["pull", "branch", "commit", "build", "deployment", "dependabotAlert", "secretScanningAlert", "codeScanningAlert"] };
-};

src/util/github-sync-helper.ts

@@ -0,0 +1,26 @@
+import { Subscription, SyncStatus } from "models/subscription";
+import { TaskType, SyncType } from "~/src/sync/sync.types";
+
+
+const MILLISECONDS_IN_ONE_DAY = 24 * 60 * 60 * 1000;
+export const getStartTimeInDaysAgo = (commitsFromDate: Date | undefined) => {
+	if (commitsFromDate === undefined) return undefined;
+	return Math.floor((Date.now() -  commitsFromDate.getTime()) / MILLISECONDS_IN_ONE_DAY);
+};
+
+type SyncTypeAndTargetTasks = {
+	syncType: SyncType,
+	targetTasks: TaskType[] | undefined,
+};
+
+export const determineSyncTypeAndTargetTasks = (syncTypeFromReq: string, subscription: Subscription): SyncTypeAndTargetTasks => {
+	if (syncTypeFromReq === "full") {
+		return { syncType: "full", targetTasks: undefined };
+	}
+
+	if (subscription.syncStatus === SyncStatus.FAILED) {
+		return { syncType: "full", targetTasks: undefined };
+	}
+
+	return { syncType: "partial", targetTasks: ["pull", "branch", "commit", "build", "deployment", "dependabotAlert", "secretScanningAlert", "codeScanningAlert"] };
+};

test/snapshots/app.test.ts.snap

@@ -15,6 +15,8 @@ exports[`app getFrontendApp please review routes and update snapshot when adding
 	query,expressInit,elapsedTimeMetrics,sentryRequestMiddleware,urlencodedParser,jsonParser,cookieParser,LogMiddleware,serveStatic
 :GET ^/?(?=/|$)^/rest/?(?=/|$)^/subscriptions/?(?=/|$)^/?$
 	query,expressInit,elapsedTimeMetrics,sentryRequestMiddleware,urlencodedParser,jsonParser,cookieParser,LogMiddleware,JwtHandler,jiraAdminEnforceMiddleware,SubscriptionsGet
+:POST ^/?(?=/|$)^/rest/?(?=/|$)^/app/(?:([^/]+?))/?(?=/|$)^/sync/?$
+	query,expressInit,elapsedTimeMetrics,sentryRequestMiddleware,urlencodedParser,jsonParser,cookieParser,LogMiddleware,middleware,JwtHandler,jiraAdminEnforceMiddleware,AnalyticsProxyHandler
 :GET ^/?(?=/|$)^/rest/?(?=/|$)^/app/(?:([^/]+?))/?(?=/|$)^/github-callback/?$
 	query,expressInit,elapsedTimeMetrics,sentryRequestMiddleware,urlencodedParser,jsonParser,cookieParser,LogMiddleware,OAuthCallbackHandler
 :GET ^/?(?=/|$)^/rest/?(?=/|$)^/app/(?:([^/]+?))/?(?=/|$)^/github-installed/?$