feat(rr): blob diffs

src/routes/v2/authenticated/review.ts

@@ -24,6 +24,7 @@ import {
   EditedItemDto,
   UpdateReviewRequestDto,
   ReviewRequestDto,
+  BlobDiffDto,
 } from "@root/types/dto/review"
 import ReviewRequestService from "@services/review/ReviewRequestService"
 // eslint-disable-next-line import/prefer-default-export
@@ -947,7 +948,8 @@ export class ReviewsRouter {
 
     if (!isReviewer) {
       logger.error({
-        message: "",
+        message:
+          "User with insufficient permissions attempted to delete approval",
         method: "deleteReviewRequestApproval",
         meta: {
           userId: userWithSiteSessionData.isomerUserId,
@@ -967,6 +969,101 @@ export class ReviewsRouter {
     return res.status(200).send()
   }
 
+  getBlob: RequestHandler<
+    { siteName: string; requestId: number },
+    BlobDiffDto | ResponseErrorBody,
+    unknown,
+    { path: string },
+    { userWithSiteSessionData: UserWithSiteSessionData }
+  > = async (req, res) => {
+    // Step 1: Check that the site exists
+    const { siteName, requestId } = req.params
+    const { path } = req.query
+    const { userWithSiteSessionData } = res.locals
+    const site = await this.sitesService.getBySiteName(siteName)
+
+    if (!site) {
+      logger.error({
+        message: "Invalid site requested",
+        method: "getBlob",
+        meta: {
+          userId: userWithSiteSessionData.isomerUserId,
+          email: userWithSiteSessionData.email,
+          siteName,
+        },
+      })
+      return res.status(404).send({
+        message: "Please ensure that the site exists!",
+      })
+    }
+
+    // Step 2: Retrieve review request
+    const possibleReviewRequest = await this.reviewRequestService.getReviewRequest(
+      site,
+      requestId
+    )
+
+    if (isIsomerError(possibleReviewRequest)) {
+      logger.error({
+        message: "Invalid review request requested",
+        method: "getBlob",
+        meta: {
+          userId: userWithSiteSessionData.isomerUserId,
+          email: userWithSiteSessionData.email,
+          siteName,
+          requestId,
+          file: path,
+        },
+      })
+      return res.status(404).send({
+        message: "Please ensure that the site exists!",
+      })
+    }
+
+    // Step 3: Check if the user is a contributor of the site
+    const role = await this.collaboratorsService.getRole(
+      siteName,
+      userWithSiteSessionData.isomerUserId
+    )
+
+    if (!role) {
+      logger.error({
+        message:
+          "User with insufficient permissions attempted to retrieve blob diff",
+        method: "getBlob",
+        meta: {
+          userId: userWithSiteSessionData.isomerUserId,
+          email: userWithSiteSessionData.email,
+          siteName,
+        },
+      })
+      return res.status(404).send({
+        message: "Please ensure that the site exists!",
+      })
+    }
+
+    // NOTE: Currently, Isomer only allows comparisons between staging and production.
+    // This might change in the future and in that case, the `getBlob` method call below
+    // should have the corresponding ref (`master` or `staging`) changed.
+    const prodPromise = await this.reviewRequestService.getBlob(
+      siteName,
+      path,
+      "master"
+    )
+    const stagingPromise = await this.reviewRequestService.getBlob(
+      siteName,
+      path,
+      "staging"
+    )
+
+    const data = await Promise.all([prodPromise, stagingPromise])
+
+    return res.status(200).json({
+      old: data[0],
+      new: data[1],
+    })
+  }
+
   getRouter() {
     const router = express.Router({ mergeParams: true })
 
@@ -1020,7 +1117,7 @@ export class ReviewsRouter {
       "/:requestId",
       attachReadRouteHandlerWrapper(this.closeReviewRequest)
     )
-
+    router.get("/:requestId/blob", attachReadRouteHandlerWrapper(this.getBlob))
     return router
   }
 }

src/services/db/GitHubService.js

@@ -30,6 +30,10 @@ class GitHubService {
     return ReviewApi.getPullRequest(siteName, pullRequestNumber)
   }
 
+  getBlob(repo, path, ref) {
+    return ReviewApi.getBlob(repo, path, ref)
+  }
+
   updatePullRequest(siteName, pullRequestNumber, title, description) {
     return ReviewApi.updatePullRequest(
       siteName,

src/services/db/review.ts

@@ -129,3 +129,16 @@ export const createComment = async (
     { body: stringifiedMessage }
   )
 }
+
+export const getBlob = async (
+  repo: string,
+  path: string,
+  ref: string
+): Promise<string> =>
+  axiosInstance
+    .get<string>(`${repo}/contents/${path}?ref=${ref}`, {
+      headers: {
+        Accept: "application/vnd.github.VERSION.raw",
+      },
+    })
+    .then(({ data }) => data)

src/services/review/ReviewRequestService.ts

@@ -620,4 +620,7 @@ export default class ReviewRequestService {
 
     return this.computeCommentData(comments, viewedTime)
   }
+
+  getBlob = async (repo: string, path: string, ref: string): Promise<string> =>
+    this.apiService.getBlob(repo, path, ref)
 }

src/types/dto/review.ts

@@ -58,3 +58,8 @@ export interface GithubCommentData {
   message: string
   createdAt: string
 }
+
+export interface BlobDiffDto {
+  old: string
+  new: string
+}