Fix broken file coverage due to unexpected HTML response from GitHub

Author: spalmurray-codecov

src/content/github/common/fetchers.ts

@@ -6,7 +6,11 @@ import {
 } from "src/types";
 
 export async function getMetadata(url: string): Promise<FileMetadata> {
-  const response = await fetch(url).then((response) => response.json());
+  const response = await fetch(url, {
+    headers: {
+      "Accept": "application/json",
+    },
+  }).then((response) => response.json());
   let branch = undefined;
   if (response.payload.refInfo.refType === "branch") {
     branch = response.payload.refInfo.name;

src/content/github/common/utils.ts

@@ -0,0 +1,18 @@
+// Note that we're guaranteed to be on a github page due to manifest.json,
+// so these checks don't need to include that.
+
+// This one matches PR files pages. Something like:
+// /codecov/gazebo/pull/2435/files
+const prUrlRegex = /\/[^\/]+\/[^\/]+\/pull\/\d+\/files.*/
+
+// And this one matches file view pages - which look like:
+// /codecov/gazebo/blob/main/src/App.jsx
+const fileUrlRegex = /\/[^\/]+\/[^\/]+\/blob\/[^\/]+\/.*/
+
+export function isFileUrl(url: string): boolean {
+  return fileUrlRegex.test(url);
+}
+
+export function isPrUrl(url: string): boolean {
+  return prUrlRegex.test(url);
+}

src/content/github/file/main.tsx

@@ -12,7 +12,6 @@ import {
   FileCoverageReport,
   FileCoverageReportResponse,
   FileMetadata,
-  MessageType,
 } from "src/types";
 import {
   componentsStorageKey,
@@ -34,6 +33,7 @@ import {
   getBranchReport,
 } from "../common/fetchers";
 import { print } from "src/utils";
+import { isFileUrl } from "../common/utils";
 
 const globals: {
   coverageReport?: FileCoverageReport;
@@ -60,15 +60,14 @@ function init(): Promise<void> {
 }
 
 async function main(): Promise<void> {
-  let metadata: FileMetadata;
-
-  try {
-    metadata = await getMetadata(document.URL);
-  } catch (e) {
+  if (!isFileUrl(document.URL)) {
     print("file not detected at current URL");
     return;
   }
 
+  let metadata: FileMetadata;
+  metadata = await getMetadata(document.URL);
+
   globals.coverageButton = createCoverageButton();
 
   process(metadata).catch((e) => {

src/content/github/pr/main.tsx

@@ -4,7 +4,7 @@ import _ from "lodash";
 
 import "src/basscss.css";
 import { displayChange } from "src/utils";
-import { CoverageStatus, MessageType, PullCoverageReport } from "src/types";
+import { CoverageStatus, PullCoverageReport } from "src/types";
 import {
   animateAndAnnotateLines,
   clearAnimation,
@@ -14,6 +14,7 @@ import { lineSelector } from "./constants";
 import { colors } from "../common/constants";
 import { print } from "src/utils";
 import { getPRReport } from "../common/fetchers";
+import { isPrUrl } from "../common/utils";
 
 const globals: {
   coverageReport?: PullCoverageReport;
@@ -26,7 +27,13 @@ async function main() {
 }
 
 async function execute() {
+  if (!isPrUrl(document.URL)) {
+    print("PR not detected at current URL");
+    return;
+  }
+
   const urlMetadata = getMetadataFromURL();
+
   if (!urlMetadata) {
     print("PR not detected at current URL");
     return;