Merge pull request #46 from codecov/show-prompt

show prompt for past commit report

Author: anukul

src/content/github/common/fetchers.ts

@@ -7,11 +7,16 @@ import {
 
 export async function getMetadata(url: string): Promise<FileMetadata> {
   const response = await fetch(url).then((response) => response.json());
+  let branch = undefined;
+  if (response.payload.refInfo.refType === "branch") {
+    branch = response.payload.refInfo.name;
+  }
   return {
     owner: response.payload.repo.ownerLogin,
     repo: response.payload.repo.name,
     path: response.payload.path,
     commit: response.payload.refInfo.currentOid,
+    branch: branch,
   };
 }
 
@@ -75,6 +80,26 @@ export async function getCommitReport(
   return response.data;
 }
 
+export async function getBranchReport(
+  metadata: FileMetadata
+): Promise<FileCoverageReportResponse> {
+  const payload = {
+    service: "github",
+    owner: metadata.owner,
+    repo: metadata.repo,
+    path: metadata.path,
+    branch: metadata.branch,
+  };
+
+  const response = await browser.runtime.sendMessage({
+    type: MessageType.FETCH_COMMIT_REPORT,
+    payload,
+    referrer: window.location.href,
+  });
+
+  return response.data;
+}
+
 export async function getPRReport(url: any) {
   const payload = {
     service: "github",

src/content/github/file/main.tsx

@@ -31,6 +31,7 @@ import {
   getComponents,
   getCommitReport,
   getFlags,
+  getBranchReport,
 } from "../common/fetchers";
 import { print } from "src/utils";
 
@@ -41,6 +42,7 @@ const globals: {
   flagsDrop?: Drop;
   componentsButton?: HTMLElement;
   componentsDrop?: Drop;
+  prompt?: HTMLElement;
 } = {};
 
 init().catch((e) => print("unexpected error", e));
@@ -221,6 +223,8 @@ async function process(metadata: FileMetadata): Promise<void> {
 
   if (_.isEmpty(coverageReport)) {
     updateButton(`Coverage: N/A`);
+    globals.coverageReport = {};
+    await promptPastReport(metadata);
     return;
   }
 
@@ -231,6 +235,42 @@ async function process(metadata: FileMetadata): Promise<void> {
   animateAndAnnotateLines(lineSelector, annotateLine);
 }
 
+async function promptPastReport(metadata: FileMetadata): Promise<void> {
+  if (!metadata.branch) {
+    return;
+  }
+  const response = await getBranchReport(metadata);
+  const regexp = /app.codecov.io\/github\/.*\/.*\/commit\/(?<commit>.*)\/blob/;
+  const matches = regexp.exec(response.commit_file_url);
+  const commit = matches?.groups?.commit;
+  if (!commit) {
+    print("could not parse commit hash from response for past coverage report");
+    return;
+  }
+  const link = document.URL.replace(
+    `blob/${metadata.branch}`,
+    `blob/${commit}`
+  );
+  globals.prompt = createPrompt(
+    <span>
+      Coverage report not available for branch HEAD (
+      {metadata.commit.substr(0, 7)}), most recent coverage report for this
+      branch available at commit <a href={link}>{commit.substr(0, 7)}</a>
+    </span>
+  );
+}
+
+function createPrompt(child: any) {
+  const ref = document.querySelector('[data-testid="latest-commit"]')
+    ?.parentElement?.parentElement;
+  if (!ref) {
+    print("could not find reference element to render prompt");
+    return;
+  }
+  const prompt = <div className="codecov-mb2 codecov-mx1">{child}</div>;
+  return ref.insertAdjacentElement("afterend", prompt) as HTMLElement;
+}
+
 function createCoverageButton() {
   const rawButton = document.querySelector('[data-testid="raw-button"]');
   if (!rawButton) {
@@ -309,12 +349,13 @@ function annotateLine(line: HTMLElement) {
   }
 }
 
-function clearButtons() {
+function clearElements() {
   globals.coverageButton?.remove();
   globals.flagsButton?.remove();
   globals.flagsDrop?.remove();
   globals.componentsButton?.remove();
   globals.componentsDrop?.remove();
+  globals.prompt?.remove();
 }
 
 function clearAnimationAndAnnotations() {
@@ -325,6 +366,6 @@ function clearAnimationAndAnnotations() {
 }
 
 function clear() {
-  clearButtons();
+  clearElements();
   clearAnimationAndAnnotations();
 }

src/types.ts

@@ -3,6 +3,7 @@ export type FileMetadata = {
   repo: string;
   path: string;
   commit: string;
+  branch: string | undefined;
 };
 
 export enum CoverageStatus {
@@ -15,6 +16,7 @@ export type FileCoverageReportResponse = {
   files?: Array<{
     line_coverage: Array<[number, CoverageStatus]>;
   }>;
+  commit_file_url: string;
 };
 
 export type FileCoverageReport = {