chore: Add in debug logs for all upload params (#179)

Author: nsdeschenes

.changeset/serious-olives-add.md

@@ -0,0 +1,14 @@
+---
+"@codecov/bundler-plugin-core": minor
+"@codecov/bundle-analyzer": minor
+"@codecov/nextjs-webpack-plugin": minor
+"@codecov/nuxt-plugin": minor
+"@codecov/remix-vite-plugin": minor
+"@codecov/rollup-plugin": minor
+"@codecov/solidstart-plugin": minor
+"@codecov/sveltekit-plugin": minor
+"@codecov/vite-plugin": minor
+"@codecov/webpack-plugin": minor
+---
+
+Add in debug logs for each param for each provider for better debugging.

examples/bundle-analyzer-cli/package.json

@@ -18,7 +18,7 @@
   },
   "type": "module",
   "scripts": {
-    "build": "rollup -c && pnpm bundle-analyzer ./dist --bundle-name=@codecov/example-bundle-analyzer-cli --upload-token=$BUNDLE_ANALYZER_UPLOAD_TOKEN --config-file=./baconfig.json"
+    "build": "rollup -c && pnpm bundle-analyzer ./dist -v --bundle-name=@codecov/example-bundle-analyzer-cli --upload-token=$BUNDLE_ANALYZER_UPLOAD_TOKEN --api-url=$BUNDLE_ANALYZER_API_URL --config-file=./baconfig.json"
   },
   "devDependencies": {
     "@codecov/bundle-analyzer": "workspace:^",

examples/bundle-analyzer-lib-cjs/analyze.js

@@ -6,7 +6,7 @@ const coreOpts = {
   dryRun: false,
   uploadToken: process.env.BUNDLE_ANALYZER_UPLOAD_TOKEN,
   retryCount: 3,
-  apiUrl: "https://api.codecov.io",
+  apiUrl: process.env.BUNDLE_ANALYZER_API_URL,
   bundleName: "@codecov/example-bundle-analyzer-cjs",
   enableBundleAnalysis: true,
   debug: true,

examples/bundle-analyzer-lib-esm/analyze.ts

@@ -10,7 +10,7 @@ const coreOpts: Options = {
   dryRun: false,
   uploadToken: process.env.BUNDLE_ANALYZER_UPLOAD_TOKEN,
   retryCount: 3,
-  apiUrl: "https://api.codecov.io",
+  apiUrl: process.env.BUNDLE_ANALYZER_API_URL,
   bundleName: "@codecov/example-bundle-analyzer-esm",
   enableBundleAnalysis: true,
   debug: true,

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

@@ -22,6 +22,7 @@ export const fetchWithRetry = async ({
     try {
       debug(`Attempting to fetch ${name}, attempt: ${i + 1}`);
       await delay(DEFAULT_RETRY_DELAY * i);
+
       response = await fetch(url, requestData);
 
       if (!response.ok) {
@@ -33,7 +34,7 @@ export const fetchWithRetry = async ({
       const isLastAttempt = i + 1 === retryCount;
 
       if (isLastAttempt) {
-        red(`${name} failed after ${i} attempts`);
+        red(`${name} failed after ${i + 1} attempts`);
 
         if (!(err instanceof BadResponseError)) {
           throw err;

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

@@ -95,14 +95,15 @@ export const getPreSignedURL = async ({
 
   let response: Response;
   try {
+    const body = preProcessBody(requestBody);
     response = await fetchWithRetry({
       retryCount,
       url: `${apiUrl}${API_ENDPOINT}`,
       name: "`get-pre-signed-url`",
       requestData: {
         method: "POST",
         headers: headers,
-        body: JSON.stringify(preProcessBody(requestBody)),
+        body: JSON.stringify(body),
       },
     });
   } catch (e) {

packages/bundler-plugin-core/src/utils/providers/AppVeyorCI.ts

@@ -13,56 +13,87 @@ export function detect(envs: ProviderEnvs): boolean {
   );
 }
 
-function _getBuild(inputs: ProviderUtilInputs): ProviderServiceParams["build"] {
+function _getBuild(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["build"] {
   const { args, envs } = inputs;
   if (args?.build && args.build !== "") {
+    debug(`Using build: ${args.build}`, { enabled: output.debug });
     return args.build;
   }
-  return envs?.APPVEYOR_JOB_ID ?? null;
+
+  const build = envs?.APPVEYOR_BUILD_ID ?? null;
+  debug(`Using build: ${build}`, { enabled: output.debug });
+
+  return build;
 }
 
 function _getBuildURL(
   inputs: ProviderUtilInputs,
+  output: Output,
 ): ProviderServiceParams["buildURL"] {
   const { envs } = inputs;
+  let buildUrl: string | null = null;
+
   if (
     envs?.APPVEYOR_URL &&
     envs?.APPVEYOR_REPO_NAME &&
     envs?.APPVEYOR_BUILD_ID &&
     envs?.APPVEYOR_JOB_ID
   ) {
-    return `${envs?.APPVEYOR_URL}/project/${envs?.APPVEYOR_REPO_NAME}/builds/${envs?.APPVEYOR_BUILD_ID}/job/${envs?.APPVEYOR_JOB_ID}`;
+    buildUrl = `${envs?.APPVEYOR_URL}/project/${envs?.APPVEYOR_REPO_NAME}/builds/${envs?.APPVEYOR_BUILD_ID}/job/${envs?.APPVEYOR_JOB_ID}`;
   }
-  return null;
+
+  debug(`Using build URL: ${buildUrl}`, { enabled: output.debug });
+  return buildUrl;
 }
 
 function _getBranch(
   inputs: ProviderUtilInputs,
+  output: Output,
 ): ProviderServiceParams["branch"] {
   const { args, envs } = inputs;
   if (args?.branch && args.branch !== "") {
+    debug(`Using branch: ${args.branch}`, { enabled: output.debug });
     return args.branch;
   }
-  return envs?.APPVEYOR_REPO_BRANCH ?? null;
+  const branch = envs?.APPVEYOR_REPO_BRANCH ?? null;
+  debug(`Using branch: ${branch}`, { enabled: output.debug });
+  return branch;
 }
 
-function _getJob(envs: ProviderEnvs): ProviderServiceParams["job"] {
+function _getJob(
+  envs: ProviderEnvs,
+  output: Output,
+): ProviderServiceParams["job"] {
+  let job: string | null = null;
+
   if (
     envs?.APPVEYOR_ACCOUNT_NAME &&
     envs?.APPVEYOR_PROJECT_SLUG &&
     envs?.APPVEYOR_BUILD_VERSION
   ) {
-    return `${envs?.APPVEYOR_ACCOUNT_NAME}/${envs?.APPVEYOR_PROJECT_SLUG}/${envs?.APPVEYOR_BUILD_VERSION}`;
+    job = `${envs.APPVEYOR_ACCOUNT_NAME}/${envs.APPVEYOR_PROJECT_SLUG}/${envs.APPVEYOR_BUILD_VERSION}`;
   }
-  return null;
+
+  debug(`Using job: ${job}`, { enabled: output.debug });
+  return job;
 }
 
-function _getPR(inputs: ProviderUtilInputs): ProviderServiceParams["pr"] {
+function _getPR(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["pr"] {
   const { args, envs } = inputs;
   if (args?.pr && args.pr !== "") {
+    debug(`Using PR number: ${args.pr}`, { enabled: output.debug });
     return args.pr;
   }
-  return envs?.APPVEYOR_PULL_REQUEST_NUMBER ?? null;
+
+  const pr = envs?.APPVEYOR_PULL_REQUEST_NUMBER ?? null;
+  debug(`Using PR number: ${pr}`, { enabled: output.debug });
+  return pr;
 }
 
 function _getService(): ProviderServiceParams["service"] {
@@ -86,19 +117,24 @@ function _getSHA(
   const commitSha =
     envs?.APPVEYOR_PULL_REQUEST_HEAD_COMMIT ?? envs?.APPVEYOR_REPO_COMMIT;
 
-  debug(`Using commit: ${commitSha ?? ""}`, {
-    enabled: output.debug,
-  });
+  debug(`Using commit: ${commitSha}`, { enabled: output.debug });
 
   return commitSha ?? null;
 }
 
-function _getSlug(inputs: ProviderUtilInputs): ProviderServiceParams["slug"] {
+function _getSlug(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["slug"] {
   const { args, envs } = inputs;
   if (args?.slug && args.slug !== "") {
+    debug(`Using slug: ${args.slug}`, { enabled: output.debug });
     return args.slug;
   }
-  return envs?.APPVEYOR_REPO_NAME ?? null;
+
+  const slug = envs?.APPVEYOR_REPO_NAME ?? null;
+  debug(`Using slug: ${slug}`, { enabled: output.debug });
+  return slug;
 }
 
 // eslint-disable-next-line @typescript-eslint/require-await
@@ -107,14 +143,14 @@ export async function getServiceParams(
   output: Output,
 ): Promise<ProviderServiceParams> {
   return {
-    branch: _getBranch(inputs),
-    build: _getBuild(inputs),
-    buildURL: _getBuildURL(inputs),
+    branch: _getBranch(inputs, output),
+    build: _getBuild(inputs, output),
+    buildURL: _getBuildURL(inputs, output),
     commit: _getSHA(inputs, output),
-    job: _getJob(inputs.envs),
-    pr: _getPR(inputs),
+    job: _getJob(inputs.envs, output),
+    pr: _getPR(inputs, output),
     service: _getService(),
-    slug: _getSlug(inputs),
+    slug: _getSlug(inputs, output),
   };
 }
 

packages/bundler-plugin-core/src/utils/providers/AzurePipelines.ts

@@ -12,54 +12,78 @@ export function detect(envs: ProviderEnvs): boolean {
   return Boolean(envs?.SYSTEM_TEAMFOUNDATIONSERVERURI);
 }
 
-function _getBuild(inputs: ProviderUtilInputs): ProviderServiceParams["build"] {
+function _getBuild(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["build"] {
   const { args, envs } = inputs;
   if (args?.build && args.build !== "") {
+    debug(`Using build: ${args.build}`, { enabled: output.debug });
     return args.build;
   }
-  return envs?.BUILD_BUILDNUMBER ?? null;
+
+  const build = envs?.BUILD_BUILDNUMBER ?? null;
+  debug(`Using build: ${build}`, { enabled: output.debug });
+  return build;
 }
 
 function _getBuildURL(
   inputs: ProviderUtilInputs,
+  output: Output,
 ): ProviderServiceParams["buildURL"] {
   const { envs } = inputs;
+  let buildURL: string | null = null;
   if (envs?.SYSTEM_TEAMPROJECT && envs?.BUILD_BUILDID) {
-    return `${envs?.SYSTEM_TEAMFOUNDATIONSERVERURI}${envs?.SYSTEM_TEAMPROJECT}/_build/results?buildId=${envs?.BUILD_BUILDID}`;
+    buildURL = `${envs?.SYSTEM_TEAMFOUNDATIONSERVERURI}${envs?.SYSTEM_TEAMPROJECT}/_build/results?buildId=${envs?.BUILD_BUILDID}`;
   }
-  return null;
+  debug(`Using build URL: ${buildURL}`, { enabled: output.debug });
+  return buildURL;
 }
 
 function _getBranch(
   inputs: ProviderUtilInputs,
+  output: Output,
 ): ProviderServiceParams["branch"] {
   const { args, envs } = inputs;
   if (args?.branch && args.branch !== "") {
+    debug(`Using branch: ${args.branch}`, { enabled: output.debug });
     return args.branch;
   }
 
+  let branch: string | null = null;
   if (envs?.BUILD_SOURCEBRANCH) {
-    return envs?.BUILD_SOURCEBRANCH.toString().replace("refs/heads/", "");
+    branch = envs?.BUILD_SOURCEBRANCH.toString().replace("refs/heads/", "");
   }
 
-  return null;
+  debug(`Using branch: ${branch}`, { enabled: output.debug });
+  return branch;
 }
 
-function _getJob(envs: ProviderEnvs): ProviderServiceParams["job"] {
-  return envs?.BUILD_BUILDID ?? null;
+function _getJob(
+  envs: ProviderEnvs,
+  output: Output,
+): ProviderServiceParams["job"] {
+  const job = envs?.BUILD_BUILDID ?? null;
+  debug(`Using job: ${job}`, { enabled: output.debug });
+  return job;
 }
 
-function _getPR(inputs: ProviderUtilInputs): ProviderServiceParams["pr"] {
+function _getPR(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["pr"] {
   const { args, envs } = inputs;
   if (args?.pr && args.pr !== "") {
+    debug(`Using PR: ${args.pr}`, { enabled: output.debug });
     return args.pr;
   }
 
-  return (
+  const pr =
     envs?.SYSTEM_PULLREQUEST_PULLREQUESTNUMBER ??
     envs?.SYSTEM_PULLREQUEST_PULLREQUESTID ??
-    null
-  );
+    null;
+  debug(`Using PR: ${pr}`, { enabled: output.debug });
+  return pr;
 }
 
 function _getService(): ProviderServiceParams["service"] {
@@ -84,7 +108,7 @@ function _getSHA(
 
   let commit = envs?.BUILD_SOURCEVERSION ?? null;
 
-  if (_getPR(inputs)) {
+  if (_getPR(inputs, output)) {
     const mergeCommitRegex = /^[a-z0-9]{40} [a-z0-9]{40}$/;
     const mergeCommitMessage = childProcess
       .execFileSync("git", ["show", "--no-patch", "--format=%P"])
@@ -105,20 +129,24 @@ function _getSHA(
     }
   }
 
-  debug(`Using commit: ${commit}`, {
-    enabled: output.debug,
-  });
-
+  debug(`Using commit: ${commit}`, { enabled: output.debug });
   return commit;
 }
 
-function _getSlug(inputs: ProviderUtilInputs): ProviderServiceParams["slug"] {
+function _getSlug(
+  inputs: ProviderUtilInputs,
+  output: Output,
+): ProviderServiceParams["slug"] {
   const { args, envs } = inputs;
   if (args?.slug && args.slug !== "") {
+    debug(`Using slug: ${args.slug}`, { enabled: output.debug });
     return args.slug;
   }
 
-  return envs?.BUILD_REPOSITORY_NAME ?? parseSlugFromRemoteAddr("") ?? null;
+  const slug =
+    envs?.BUILD_REPOSITORY_NAME ?? parseSlugFromRemoteAddr("") ?? null;
+  debug(`Using slug: ${slug}`, { enabled: output.debug });
+  return slug;
 }
 
 // eslint-disable-next-line @typescript-eslint/require-await
@@ -127,14 +155,14 @@ export async function getServiceParams(
   output: Output,
 ): Promise<ProviderServiceParams> {
   return {
-    branch: _getBranch(inputs),
-    build: _getBuild(inputs),
-    buildURL: _getBuildURL(inputs),
+    branch: _getBranch(inputs, output),
+    build: _getBuild(inputs, output),
+    buildURL: _getBuildURL(inputs, output),
     commit: _getSHA(inputs, output),
-    job: _getJob(inputs.envs),
-    pr: _getPR(inputs),
+    job: _getJob(inputs.envs, output),
+    pr: _getPR(inputs, output),
     service: _getService(),
-    slug: _getSlug(inputs),
+    slug: _getSlug(inputs, output),
   };
 }