ref: Rename uploader overrides option (#47)

Rename overrides option, as well as remove the split between global upload token and repo tokens as they're sent in the same way with no differences.

Author: nsdeschenes

.changeset/new-chefs-fold.md

@@ -0,0 +1,8 @@
+---
+"@codecov/bundler-plugin-core": patch
+"@codecov/rollup-plugin": patch
+"@codecov/vite-plugin": patch
+"@codecov/webpack-plugin": patch
+---
+
+Rename uploaderOverrides to uploadOverrides, remove url from uploadOverrides, and removal of repoToken/globalUploadToken in favour of just uploadToken.

.github/workflows/ci.yml

@@ -244,7 +244,7 @@ jobs:
       - name: Build packages
         run: pnpm run build
 
-      - name: Run unit tests
+      - name: Run e2e tests
         run: pnpm run test:e2e --maxWorkers=2
 
 

packages/bundler-plugin-core/src/bundle-analysis/bundleAnalysisPluginFactory.ts

@@ -50,7 +50,7 @@ export const bundleAnalysisPluginFactory = ({
       // don't need to do anything if the bundle name is not present or empty
       if (!userOptions.bundleName || userOptions.bundleName === "") return;
 
-      const args: UploadOverrides = userOptions.uploaderOverrides ?? {};
+      const args: UploadOverrides = userOptions.uploadOverrides ?? {};
       const envs = process.env;
       const inputs: ProviderUtilInputs = { envs, args };
       const provider = await detectProvider(inputs);
@@ -59,8 +59,7 @@ export const bundleAnalysisPluginFactory = ({
       try {
         url = await getPreSignedURL({
           apiURL: userOptions?.apiUrl ?? "https://api.codecov.io",
-          globalUploadToken: userOptions?.globalUploadToken,
-          repoToken: userOptions?.repoToken,
+          uploadToken: userOptions?.uploadToken,
           serviceParams: provider,
           retryCount: userOptions?.retryCount,
         });

packages/bundler-plugin-core/src/types.ts

@@ -54,16 +54,11 @@ export interface Options {
   /**
    * The upload token to use for uploading the bundle analysis information.
    *
-   * `globalUploadToken` and `repoName` must be set if this is not set.
+   * This value can either be an global upload token or a repo token.
+   * - The global upload token can be found under the organization settings page.
+   * - The repo token can be found under the repo settings page under the general tab.
    */
-  globalUploadToken?: string;
-
-  /**
-   * The upload token to use for uploading the bundle analysis information.
-   *
-   * Mutually exclusive to using `globalUploadToken` and `repoName`.
-   */
-  repoToken?: string;
+  uploadToken?: string;
 
   /**
    * The api url used to fetch the upload url.
@@ -75,7 +70,7 @@ export interface Options {
   apiUrl?: string;
 
   /**
-   * The amount of times the upload function will retry.
+   * The amount of times the upload function will retry to upload bundle analysis information.
    *
    * Defaults to `3`
    */
@@ -85,7 +80,7 @@ export interface Options {
   enableBundleAnalysis?: boolean;
 
   /** Override values for passing custom information to API. */
-  uploaderOverrides?: UploadOverrides;
+  uploadOverrides?: UploadOverrides;
 
   /**
    * When enabled information will not be uploaded to Codecov.
@@ -122,15 +117,13 @@ export interface UploadOverrides {
   sha?: string;
   /** Specify the slug manually. */
   slug?: string;
-  /** Change the upload host (Enterprise use). */
-  url?: string;
 }
 
 export type ProviderEnvs = NodeJS.Dict<string>;
 
 export interface ProviderUtilInputs {
   envs: ProviderEnvs;
-  args: Options["uploaderOverrides"];
+  args: Options["uploadOverrides"];
 }
 
 export interface ProviderUtil {

packages/bundler-plugin-core/src/utils/__tests__/getPreSignedURL.test.ts

@@ -53,52 +53,15 @@ describe("getPreSignedURL", () => {
 
   describe("successful request", () => {
     describe("when the initial response is successful", () => {
-      describe('"globalUploadToken" is provided and "repoToken" is', () => {
+      describe('"uploadToken" is provided', () => {
         it("returns the pre-signed URL", async () => {
           setup({
             data: { url: "http://example.com" },
           });
 
           const url = await getPreSignedURL({
             apiURL: "http://localhost",
-            globalUploadToken: "super-cool-token",
-            repoToken: "super-repo-token",
-            serviceParams: {
-              commit: "123",
-            },
-          });
-
-          expect(url).toEqual("http://example.com");
-        });
-      });
-
-      describe('"globalUploadToken" is provided and "repoToken" is not', () => {
-        it("returns the pre-signed URL", async () => {
-          setup({
-            data: { url: "http://example.com" },
-          });
-
-          const url = await getPreSignedURL({
-            apiURL: "http://localhost",
-            globalUploadToken: "super-cool-token",
-            serviceParams: {
-              commit: "123",
-            },
-          });
-
-          expect(url).toEqual("http://example.com");
-        });
-      });
-
-      describe('"repoToken" is provided and "globalUploadToken" is not', () => {
-        it("returns the pre-signed URL", async () => {
-          setup({
-            data: { url: "http://example.com" },
-          });
-
-          const url = await getPreSignedURL({
-            apiURL: "http://localhost",
-            repoToken: "super-cool-token",
+            uploadToken: "super-cool-token",
             serviceParams: {
               commit: "123",
             },
@@ -149,7 +112,7 @@ describe("getPreSignedURL", () => {
         try {
           await getPreSignedURL({
             apiURL: "http://localhost",
-            globalUploadToken: "cool-upload-token",
+            uploadToken: "cool-upload-token",
             serviceParams: {
               commit: "123",
             },
@@ -174,7 +137,7 @@ describe("getPreSignedURL", () => {
         try {
           await getPreSignedURL({
             apiURL: "http://localhost",
-            globalUploadToken: "super-cool-token",
+            uploadToken: "super-cool-token",
             serviceParams: {
               commit: "123",
             },
@@ -209,7 +172,7 @@ describe("getPreSignedURL", () => {
         try {
           await getPreSignedURL({
             apiURL: "http://localhost",
-            globalUploadToken: "super-cool-token",
+            uploadToken: "super-cool-token",
             serviceParams: {
               commit: "123",
             },
@@ -234,7 +197,7 @@ describe("getPreSignedURL", () => {
         try {
           await getPreSignedURL({
             apiURL: "http://localhost",
-            globalUploadToken: "super-cool-token",
+            uploadToken: "super-cool-token",
             serviceParams: {
               commit: "123",
             },
@@ -269,7 +232,7 @@ describe("getPreSignedURL", () => {
         try {
           await getPreSignedURL({
             apiURL: "http://localhost",
-            globalUploadToken: "super-cool-token",
+            uploadToken: "super-cool-token",
             serviceParams: {
               commit: "123",
             },

packages/bundler-plugin-core/src/utils/getPreSignedURL.ts

@@ -6,13 +6,12 @@ import { UploadLimitReachedError } from "../errors/UploadLimitReachedError.ts";
 import { type ProviderServiceParams } from "../types.ts";
 import { DEFAULT_RETRY_COUNT } from "./constants.ts";
 import { fetchWithRetry } from "./fetchWithRetry.ts";
-import { green, red, yellow } from "./logging.ts";
+import { green, red } from "./logging.ts";
 import { preProcessBody } from "./preProcessBody.ts";
 
 interface GetPreSignedURLArgs {
   apiURL: string;
-  globalUploadToken?: string;
-  repoToken?: string;
+  uploadToken?: string;
   serviceParams: Partial<ProviderServiceParams>;
   retryCount?: number;
 }
@@ -23,13 +22,11 @@ const PreSignedURLSchema = z.object({
 
 export const getPreSignedURL = async ({
   apiURL,
-  globalUploadToken,
-  repoToken,
+  uploadToken,
   serviceParams,
   retryCount = DEFAULT_RETRY_COUNT,
 }: GetPreSignedURLArgs) => {
-  const token = getToken(globalUploadToken, repoToken);
-  if (!token) {
+  if (!uploadToken) {
     red("No upload token found");
     throw new NoUploadTokenError("No upload token found");
   }
@@ -46,7 +43,7 @@ export const getPreSignedURL = async ({
         method: "POST",
         headers: {
           "Content-Type": "application/json",
-          Authorization: `token ${token}`,
+          Authorization: `token ${uploadToken}`,
         },
         body: JSON.stringify(preProcessBody(serviceParams)),
       },
@@ -84,24 +81,3 @@ export const getPreSignedURL = async ({
   green(`Successfully pre-signed URL fetched`);
   return parsedData.data.url;
 };
-
-const getToken = (
-  globalUploadToken: string | undefined,
-  repoToken: string | undefined,
-) => {
-  if (globalUploadToken && repoToken) {
-    yellow(
-      "Both globalUploadToken and repoToken found, Using globalUploadToken",
-    );
-  }
-
-  if (globalUploadToken) {
-    return globalUploadToken;
-  }
-
-  if (repoToken) {
-    return repoToken;
-  }
-
-  return undefined;
-};

packages/bundler-plugin-core/src/utils/providers/__tests__/CircleCI.test.ts

@@ -104,7 +104,6 @@ describe("CircleCI Params", () => {
         pr: "1",
         sha: "cool-commit-sha",
         slug: "testOrg/testRepo",
-        url: "cool-url.com",
       },
       envs: {
         CI: "true",

packages/bundler-plugin-core/src/utils/providers/__tests__/CloudflarePages.test.ts

@@ -69,7 +69,6 @@ describe("CloudflarePages Params", () => {
         pr: "1",
         sha: "cool-commit-sha",
         slug: "testOrg/testRepo",
-        url: "cool-url.com",
       },
       envs: {
         NETLIFY: "true",

packages/bundler-plugin-core/src/utils/providers/__tests__/Netlify.test.ts

@@ -70,7 +70,6 @@ describe("Netlify Params", () => {
         pr: "1",
         sha: "cool-commit-sha",
         slug: "testOrg/testRepo",
-        url: "cool-url.com",
       },
       envs: {
         NETLIFY: "true",

packages/bundler-plugin-core/src/utils/providers/__tests__/Render.test.ts

@@ -70,7 +70,6 @@ describe("Render Params", () => {
         pr: "1",
         sha: "cool-commit-sha",
         slug: "testOrg/testRepo",
-        url: "cool-url.com",
       },
       envs: {
         RENDER: "true",