Feat/stagingBuildTimes

src/constants/featureFlags.ts

@@ -1,4 +1,5 @@
 export const FEATURE_FLAGS = {
   IS_BUILD_TIMES_REDUCTION_ENABLED: "is_build_times_reduction_enabled",
   IS_GGS_ENABLED: "is_ggs_enabled",
+  IS_SHOW_STAGING_BUILD_STATUS_ENABLED: "is_show_staging_build_status_enabled",
 } as const

src/routes/v2/authenticated/sites.ts

@@ -17,6 +17,7 @@ import { ProdPermalink, StagingPermalink } from "@root/types/pages"
 import { PreviewInfo } from "@root/types/previewInfo"
 import { RepositoryData } from "@root/types/repoInfo"
 import { SiteInfo, SiteLaunchDto } from "@root/types/siteInfo"
+import { StagingBuildStatus } from "@root/types/stagingBuildStatus"
 import type SitesService from "@services/identity/SitesService"
 
 type SitesRouterProps = {
@@ -169,6 +170,23 @@ export class SitesRouter {
       .getSitesPreview(req.body.sites, res.locals.userSessionData)
       .then((previews) => res.status(200).json(previews))
 
+  getUserStagingSiteBuildStatus: RequestHandler<
+    { siteName: string },
+    StagingBuildStatus | ResponseErrorBody,
+    never,
+    never,
+    { userWithSiteSessionData: UserWithSiteSessionData }
+  > = async (req, res) => {
+    const { userWithSiteSessionData } = res.locals
+    const result = await this.sitesService.getUserStagingSiteBuildStatus(
+      userWithSiteSessionData
+    )
+    if (result.isOk()) {
+      return res.status(200).json(result.value)
+    }
+    return res.status(404).json({ message: "Unable to get staging status" })
+  }
+
   getRouter() {
     const router = express.Router({ mergeParams: true })
 
@@ -210,6 +228,12 @@ export class SitesRouter {
       this.authorizationMiddleware.verifySiteAdmin,
       attachReadRouteHandlerWrapper(this.launchSite)
     )
+    router.get(
+      "/:siteName/getStagingBuildStatus",
+      attachSiteHandler,
+      this.authorizationMiddleware.verifySiteMember,
+      attachReadRouteHandlerWrapper(this.getUserStagingSiteBuildStatus)
+    )
 
     // The /sites/preview is a POST endpoint as the frontend sends
     // a list of sites to obtain previews for. This is to support

src/services/identity/DeploymentClient.ts

@@ -10,8 +10,11 @@ import {
   UpdateBranchCommand,
   UpdateBranchCommandOutput,
   UpdateBranchCommandInput,
+  ListJobsCommand,
+  ListJobsCommandOutput,
+  JobSummary,
 } from "@aws-sdk/client-amplify"
-import { ResultAsync } from "neverthrow"
+import { ResultAsync, errAsync, fromPromise, okAsync } from "neverthrow"
 
 import { config } from "@config/config"
 
@@ -69,6 +72,11 @@ class DeploymentClient {
       this.amplifyClient.send(new UpdateBranchCommand(options))
     ) as ResultAsync<UpdateBranchCommandOutput, AmplifyError>
 
+  sendListJobsApp = (appId: string, branchName: string) =>
+    wrap(
+      this.amplifyClient.send(new ListJobsCommand({ appId, branchName }))
+    ) as ResultAsync<ListJobsCommandOutput, AmplifyError>
+
   generateCreateAppInput = (
     repoName: string,
     repoUrl: string
@@ -113,6 +121,23 @@ class DeploymentClient {
     enableBasicAuth: true,
     basicAuthCredentials: Buffer.from(`user:${password}`).toString("base64"),
   })
+
+  getJobSummaries = (
+    appId: string,
+    branchName: string
+  ): ResultAsync<JobSummary[], AmplifyError> =>
+    fromPromise(
+      this.sendListJobsApp(appId, branchName),
+      (err) => new AmplifyError(`${err}`)
+    ).andThen((resp) => {
+      if (resp.isErr()) {
+        return errAsync(resp.error)
+      }
+      if (!resp.value.jobSummaries) {
+        return errAsync(new AmplifyError("No job summaries"))
+      }
+      return okAsync(resp.value.jobSummaries)
+    })
 }
 
 export default DeploymentClient

src/services/identity/DeploymentsService.ts

@@ -1,13 +1,16 @@
-import { Result, errAsync, okAsync } from "neverthrow"
+import { JobStatus } from "@aws-sdk/client-amplify"
+import { Result, ResultAsync, errAsync, fromPromise, okAsync } from "neverthrow"
 import { ModelStatic } from "sequelize"
 
 import { config } from "@config/config"
 
 import logger from "@logger/logger"
 
 import { Deployment, Repo, Site } from "@database/models"
+import { STAGING_BRANCH, STAGING_LITE_BRANCH } from "@root/constants"
 import { NotFoundError } from "@root/errors/NotFoundError"
 import { AmplifyError, AmplifyInfo } from "@root/types/index"
+import { BuildStatus, StatusStates } from "@root/types/stagingBuildStatus"
 import { Brand } from "@root/types/util"
 import { decryptPassword, encryptPassword } from "@root/utils/crypto-utils"
 import DeploymentClient from "@services/identity/DeploymentClient"
@@ -259,6 +262,63 @@ class DeploymentsService {
     )
     return okAsync(deploymentInfo)
   }
+
+  getStagingSiteBuildStatus = (
+    siteId: string,
+    isRepoWhiteListedForBuildRed: boolean
+  ): ResultAsync<BuildStatus, NotFoundError | AmplifyError> =>
+    fromPromise(
+      this.deploymentsRepository.findOne({
+        where: {
+          siteId,
+        },
+      }),
+      () => new NotFoundError("Site has not been deployed!")
+    )
+      .andThen((deploymentInfo) => {
+        if (!deploymentInfo) {
+          return errAsync(new NotFoundError("Site has not been deployed!"))
+        }
+        return okAsync(deploymentInfo)
+      })
+      .andThen((deploymentInfo) => {
+        let userStagingApp: string
+        const { hostingId, stagingLiteHostingId } = deploymentInfo
+        if (isRepoWhiteListedForBuildRed) {
+          userStagingApp = stagingLiteHostingId
+        } else {
+          userStagingApp = hostingId
+        }
+
+        if (!userStagingApp) {
+          return errAsync(
+            new NotFoundError("Staging site has not been deployed!")
+          )
+        }
+        return okAsync(userStagingApp)
+      })
+      .andThen((userStagingApp) => {
+        const branchName = isRepoWhiteListedForBuildRed
+          ? STAGING_LITE_BRANCH
+          : STAGING_BRANCH
+        return this.deploymentClient.getJobSummaries(userStagingApp, branchName)
+      })
+      .andThen((jobSummaries) => {
+        if (jobSummaries.length === 0) {
+          return okAsync(StatusStates.pending)
+        }
+
+        const jobSummary = jobSummaries[0]
+
+        switch (jobSummary.status) {
+          case JobStatus.SUCCEED:
+            return okAsync(StatusStates.ready)
+          case JobStatus.FAILED:
+            return okAsync(StatusStates.error)
+          default:
+            return okAsync(StatusStates.pending)
+        }
+      })
 }
 
 export default DeploymentsService

src/services/identity/SitesService.ts

@@ -16,14 +16,19 @@ import {
   getAllRepoData,
   SitesCacheService,
 } from "@root/services/identity/SitesCacheService"
+import { AmplifyError } from "@root/types"
 import { GitHubCommitData } from "@root/types/commitData"
 import { ConfigYmlData } from "@root/types/configYml"
 import { ProdPermalink, StagingPermalink } from "@root/types/pages"
 import { PreviewInfo } from "@root/types/previewInfo"
 import type { RepositoryData, SiteUrls } from "@root/types/repoInfo"
 import { SiteInfo } from "@root/types/siteInfo"
+import { StagingBuildStatus } from "@root/types/stagingBuildStatus"
 import { Brand } from "@root/types/util"
-import { isReduceBuildTimesWhitelistedRepo } from "@root/utils/growthbook-utils"
+import {
+  isReduceBuildTimesWhitelistedRepo,
+  isShowStagingBuildStatusWhitelistedRepo,
+} from "@root/utils/growthbook-utils"
 import { safeJsonParse } from "@root/utils/json"
 import RepoService from "@services/db/RepoService"
 import { ConfigYmlService } from "@services/fileServices/YmlFileServices/ConfigYmlService"
@@ -536,6 +541,26 @@ class SitesService {
       })
     )
   }
+
+  getUserStagingSiteBuildStatus(
+    userSessionData: UserWithSiteSessionData
+  ): ResultAsync<
+    StagingBuildStatus,
+    NotFoundError | MissingSiteError | AmplifyError
+  > {
+    const { siteName, growthbook } = userSessionData
+    if (!isShowStagingBuildStatusWhitelistedRepo(growthbook)) {
+      return errAsync(new NotFoundError())
+    }
+    return this.getBySiteName(siteName)
+      .andThen((site) =>
+        this.deploymentsService.getStagingSiteBuildStatus(
+          site.id.toString(),
+          isReduceBuildTimesWhitelistedRepo(growthbook)
+        )
+      )
+      .map((status) => ({ status }))
+  }
 }
 
 export default SitesService

src/types/featureFlags.ts

@@ -4,6 +4,7 @@
 export interface FeatureFlags {
   is_build_times_reduction_enabled: boolean
   is_ggs_enabled: boolean
+  is_show_staging_build_status_enabled: boolean
 }
 
 // List of attributes we set in GrowthBook Instance in auth middleware

src/types/stagingBuildStatus.ts

@@ -0,0 +1,10 @@
+export const StatusStates = {
+  pending: "PENDING",
+  ready: "READY",
+  error: "ERROR",
+} as const
+export type BuildStatus = typeof StatusStates[keyof typeof StatusStates]
+
+export interface StagingBuildStatus {
+  status: BuildStatus
+}

src/utils/growthbook-utils.ts

@@ -34,3 +34,14 @@ export const isReduceBuildTimesWhitelistedRepo = (
 
   return isWhitelistedRedBuildTimesRepo
 }
+
+export const isShowStagingBuildStatusWhitelistedRepo = (
+  growthbook: GrowthBook<FeatureFlags> | undefined
+): boolean => {
+  if (!growthbook) return false
+
+  return growthbook.getFeatureValue(
+    FEATURE_FLAGS.IS_SHOW_STAGING_BUILD_STATUS_ENABLED,
+    false
+  )
+}