feat: enable consent dialog for only firefox (#137)

Enables the consent dialog (again) for only firefox. Wanted to get this
working with .env files, but couldn't get it working cleanly. Open to
ideas, but this is also fine and a probably simpler imo.

---------

Co-authored-by: Elio Di Nino <[email protected]>

Author: spalmurray

package.json

@@ -5,13 +5,12 @@
   "main": "index.js",
   "scripts": {
     "dev": "webpack --config webpack/webpack.dev.js",
-    "watch": "npm run dev -- --watch",
     "firefox-manifest": "mv dist/manifest.firefox.json dist/manifest.json",
     "set-version": "jq --arg v \"${VERSION:-$(git describe --tags --abbrev=0)}\" '.version = $v' dist/manifest.json > dist/manifest.tmp.json && mv dist/manifest.tmp.json dist/manifest.json",
     "build": "webpack --config webpack/webpack.prod.js && npm run set-version",
-    "build:firefox": "npm run build && npm run firefox-manifest && npm run set-version",
+    "build:firefox": "IS_FIREFOX=1 npm run build && npm run firefox-manifest && npm run set-version",
     "start:chrome": "npm run dev && web-ext run -s dist -t chromium --start-url https://github.com",
-    "start:firefox": "npm run dev && npm run firefox-manifest && web-ext run -s dist -t firefox-desktop --start-url https://github.com",
+    "start:firefox": "IS_FIREFOX=1 npm run dev && npm run firefox-manifest && web-ext run -s dist -t firefox-desktop --start-url https://github.com",
     "lint": "prettier --write \"src/**/*.{ts,tsx}\"",
     "archive": "tar -czvf ../codecov-browser-extension.tar.gz --exclude node_modules --exclude dist . && mv ../codecov-browser-extension.tar.gz ./codecov-browser-extension-${VERSION:-$(git describe --tags --abbrev=0)}.tar.gz"
   },

src/content/github/common/consent.ts

@@ -4,6 +4,12 @@ import { consentStorageKey, consentDialogCopy } from "./constants";
 export async function ensureConsent(
   { checkOnly }: { checkOnly: boolean } = { checkOnly: false }
 ): Promise<boolean> {
+  // We only need to get consent for firefox
+  // @ts-ignore IS_FIREFOX is populated by Webpack at build time
+  if (!IS_FIREFOX) {
+    return true;
+  }
+
   let consent: boolean = await chrome.storage.local
     .get(consentStorageKey)
     .then((res) => res[consentStorageKey]);

src/content/github/common/constants.ts

@@ -2,7 +2,7 @@
 // We must update the key's version to re-request consent whenever the data we collect changes.
 export const consentStorageKey = "codecov-consent-0.5.9";
 export const consentDialogCopy =
-  "By clicking OK, you are authorizing the Codecov browser extension to collect your IP address and the URLs you visit on domains you've given the extension access to. Declining this will prevent the extension from working. For more information see the Privacy Policy in the Codecov extension store listing.";
+  "By clicking OK, you agree to the Codecov browser extension's privacy policy (https://addons.mozilla.org/en-US/firefox/addon/codecov/privacy/). This message will reappear if you click Cancel. If you do not wish to agree, please uninstall the extension.";
 
 export const animationName = "codecov-gh-observer";
 

src/content/github/file/main.tsx

@@ -32,6 +32,7 @@ import {
 } from "../common/fetchers";
 import { print } from "src/utils";
 import Sentry from "../../common/sentry";
+import { ensureConsent } from "../common/consent";
 
 const globals: {
   coverageReport?: FileCoverageReport;
@@ -59,6 +60,11 @@ function init(): Promise<void> {
 
 async function main(): Promise<void> {
   try {
+    const consent = await ensureConsent();
+    if (!consent) {
+      return;
+    }
+
     const urlMetadata = getMetadataFromURL();
     if (!urlMetadata) {
       print("file not detected at current URL");

src/content/github/pr/main.tsx

@@ -15,13 +15,19 @@ import { print } from "src/utils";
 import { getPRReport } from "../common/fetchers";
 import { isPrUrl } from "../common/utils";
 import Sentry from "src/content/common/sentry";
+import { ensureConsent } from "../common/consent";
 
 const globals: {
   coverageReport?: PullCoverageReport;
 } = {};
 
 async function main() {
   try {
+    const consent = await ensureConsent({ checkOnly: true });
+    if (!consent) {
+      return;
+    }
+
     document.addEventListener("soft-nav:end", execute);
     await execute();
   } catch (e) {

webpack/webpack.common.js

@@ -42,6 +42,9 @@ module.exports = {
     extensions: [".ts", ".tsx", ".js"],
   },
   plugins: [
+    new DefinePlugin({
+      IS_FIREFOX: process.env.IS_FIREFOX ? true : false,
+    }),
     new CopyPlugin({
       patterns: [{ from: ".", to: "../", context: "public" }],
       options: {},