feat: Grab compare SHA for GH pre-merge commits #147

nicholas-codecov · 2024-07-04T12:56:58Z

Description

This PR updates the GitHubAction provider to grab the correct "compare SHA" for GH PRs and send it along to the API. This value has also been added to the upload override options so the user can override the value in their bundler config if they wish to do so.

Notable Changes

Add compareSha to normalizeOptions
Update types
Update GitHubActions provider utils
Update examples to have debug set to true
Small fixes to CI action versions

codecov

Overall, the largest issue is the consistent usage of debug mode throughout the code. Additionally, the use of the compareSHA is unclear and potentially not working as expected. Testing coverage for the added functional code appears robust.

examples/next-js/next.config.js

examples/nuxt/nuxt.config.ts

examples/remix/vite.config.ts

examples/rollup/rollup.config.js

examples/sveltekit/vite.config.ts

examples/vite/vite.config.ts

examples/webpack/webpack.config.js

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

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

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

codecov-notifications · 2024-07-04T13:11:28Z

Codecov Report

Attention: Patch coverage is 93.02326% with 3 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files	Patch %	Lines
...r-plugin-core/src/utils/providers/GitHubActions.ts	92.10%	3 Missing ⚠️

Components	Coverage Δ
Plugin core	`97.28% <93.02%> (-0.06%)`	⬇️
Rollup plugin	`10.81% <ø> (ø)`
Vite plugin	`11.02% <ø> (ø)`
Webpack plugin	`25.14% <ø> (ø)`

📢 Thoughts on this report? Let us know!

codecov · 2024-07-04T13:12:15Z

Codecov Report

Attention: Patch coverage is 93.02326% with 3 lines in your changes missing coverage. Please review.

Project coverage is 76.73%. Comparing base (2df4d02) to head (5869b73).

✅ All tests successful. No failed tests found.

Files	Patch %	Lines
...r-plugin-core/src/utils/providers/GitHubActions.ts	92.10%	3 Missing ⚠️

Additional details and impacted files

Components	Coverage Δ
Plugin core	`97.28% <93.02%> (-0.06%)`	⬇️
Rollup plugin	`10.81% <ø> (ø)`
Vite plugin	`11.02% <ø> (ø)`
Webpack plugin	`25.14% <ø> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

codecov

CodecovAI submitted a new review for c5d9902

codecov · 2024-07-04T13:13:34Z

.github/workflows/ci.yml

@@ -22,12 +22,12 @@ jobs:
          fetch-depth: 0

      - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4


The node setup action version was upgraded from v3 to v4. Compatibility for all related plugins and actions with the newer version should be ensured.

codecov · 2024-07-04T13:13:34Z

.github/workflows/ci.yml

        with:
          node-version: 20

      - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4


pnpm setup action version was upgraded from v2 to v4. Make sure this plugin's functionalities are unbroken by this change.

codecov · 2024-07-04T13:13:34Z

.github/workflows/ci.yml

        with:
          node-version: 20

      - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
        with:
          version: 9


HEAD_SHA and BASE_SHA were added as environment variables. Make sure they are being declared and correctly manipulated in the context.

codecov · 2024-07-04T13:13:34Z

examples/rollup/rollup.config.js

@@ -22,6 +22,11 @@ export default defineConfig({
      bundleName: "@codecov/example-rollup-app",
      apiUrl: process.env.ROLLUP_API_URL,
      uploadToken: process.env.ROLLUP_UPLOAD_TOKEN,
+      debug: true,
+      uploadOverrides: {
+        sha: process.env.HEAD_SHA,


Adding an uploadOverrides object with 'sha'/'compareSha' properties. Make sure this doesn't overlap or cause conflicts with existing functionality, and that the values are being correctly provided from the environment.

codecov · 2024-07-04T13:13:35Z

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

@@ -10,6 +10,11 @@
      body[key] = encodeSlug(value);
    }

+    // temporary removal for testing
+    if (key === "compareSha") {


The 'compareSha' key is being temporarily removed for testing. If this code is intended for production, this deletion should not occur here.

codecov · 2024-07-04T13:13:35Z

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

@@ -158,6 +158,43 @@
  return commit ?? "";
 }

+function _getCompareSHA(inputs: ProviderUtilInputs, output: Output): string {
+  const { args } = inputs;


_getCompareSHA function is added. The complexity of the function could potentially be a point of failure, ensure it is adequately tested and performs as expected in various scenarios.

codecov-staging · 2024-07-04T13:15:47Z

Bundle Report

Changes will increase total bundle size by 533.98kB ⬆️

Bundle name	Size	Change
@codecov/nuxt-plugin-cjs	1.41kB	0 bytes
@codecov/webpack-plugin-esm	1.44kB	0 bytes
@codecov/sveltekit-plugin-cjs	1.33kB	0 bytes
@codecov/bundler-plugin-core-esm	8.2kB	30.02kB ⬇️
@codecov/sveltekit-plugin-esm	1.1kB	188 bytes ⬆️
@codecov/remix-vite-plugin-esm	975 bytes	0 bytes
@codecov/rollup-plugin-cjs	2.82kB	0 bytes
@codecov/rollup-plugin-esm	1.32kB	1.01kB ⬇️
@codecov/example-webpack-app-array-push	71.19kB	0 bytes
@codecov/example-next-app-edge-server-array-push	354 bytes	0 bytes
@codecov/example-next-app-client-array-push	907.85kB	907.85kB ⬆️
@codecov/nuxt-plugin-esm	855 bytes	0 bytes
@codecov/vite-plugin-cjs	2.8kB	0 bytes
@codecov/vite-plugin-esm	1.26kB	0 bytes
@codecov/webpack-plugin-cjs	3.77kB	0 bytes
@codecov/bundler-plugin-core-cjs	43.32kB	611 bytes ⬆️
@codecov/example-rollup-app-iife	95.46kB	0 bytes
@codecov/example-vite-app-esm	150.61kB	0 bytes
@codecov/remix-vite-plugin-cjs	(removed)	1.32kB ⬇️
@codecov/example-next-app-server-cjs	(removed)	342.32kB ⬇️

codecov · 2024-07-04T13:15:56Z

Bundle Report

Changes will increase total bundle size by 968.29kB ⬆️

Bundle name	Size	Change
@codecov/nuxt-plugin-cjs	1.41kB	1.41kB ⬆️
@codecov/nuxt-plugin-esm	855 bytes	0 bytes
@codecov/remix-vite-plugin-cjs	1.32kB	1.32kB ⬆️
@codecov/remix-vite-plugin-esm	975 bytes	0 bytes
@codecov/example-remix-app-client-esm	252.12kB	252.12kB ⬆️
@codecov/example-remix-app-server-esm	12.55kB	0 bytes
@codecov/vite-plugin-cjs	2.8kB	2.8kB ⬆️
@codecov/vite-plugin-esm	1.26kB	1.26kB ⬆️
@codecov/webpack-plugin-cjs	3.77kB	0 bytes
@codecov/rollup-plugin-cjs	2.82kB	0 bytes
@codecov/webpack-plugin-esm	1.44kB	1.62kB ⬇️
@codecov/rollup-plugin-esm	1.32kB	1.01kB ⬇️
@codecov/sveltekit-plugin-cjs	1.33kB	0 bytes
@codecov/sveltekit-plugin-esm	909 bytes	909 bytes ⬆️
@codecov/example-rollup-app-iife	95.46kB	95.46kB ⬆️
@codecov/bundler-plugin-core-cjs	43.32kB	43.32kB ⬆️
@codecov/bundler-plugin-core-esm	8.2kB	8.2kB ⬆️
@codecov/example-sveltekit-app-client-esm	714.6kB	2 bytes ⬇️
@codecov/example-sveltekit-app-server-esm	974.58kB	1 bytes ⬇️
@codecov/example-vite-app-esm	150.61kB	150.61kB ⬆️
@codecov/example-webpack-app-array-push	71.19kB	71.19kB ⬆️
@codecov/example-nuxt-app-client-esm	237.66kB	0 bytes
@codecov/example-nuxt-app-server-esm	347.95kB	0 bytes
@codecov/example-next-app-server-cjs	342.32kB	342.32kB ⬆️
@codecov/example-next-app-edge-server-array-push	354 bytes	0 bytes
@codecov/example-next-app-client-array-push	907.85kB	0 bytes

AbhiPrasad · 2024-07-16T13:53:46Z

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

+
+  debug(`Using compareSha: ${compareSha ?? ""}`, { enabled: output.debug });
+
+  return compareSha ?? "";


shouldn't we return null or undefined if compareSha is not set?

This is a left-over style from the original Codecov Node uploader, tho we should probably adjust this. We do have a guard in the preProcessBody that does handle this for us. Tho we should probably update this overall to just return null.

nicholas-codecov added 7 commits July 4, 2024 09:44

turn on debug mode for example apps

ed67122

add in compareSha to types

75e1bfc

update normalizeOptions to accept compareSha override

6f1ee34

update GitHubActions to grab compare sha for pre-merge commits

f900b7e

remove compareSha from being sent

e68b43b

pass gh action event data

9e0809b

update rollup example to grab from gh action context

4ebe7d7

codecov bot reviewed Jul 4, 2024

View reviewed changes

update node and pnpm action versions

c5d9902

codecov bot reviewed Jul 4, 2024

View reviewed changes

nicholas-codecov added 3 commits July 9, 2024 11:18

update version of the cache action

8448dbc

Merge branch 'main' into feat-grab-compare-sha-for-pre-merge-commits

319e880

remove temp removal

5869b73

nicholas-codecov marked this pull request as ready for review July 16, 2024 13:45

nicholas-codecov assigned nicholas-codecov and unassigned nicholas-codecov Jul 16, 2024

nicholas-codecov requested a review from AbhiPrasad July 16, 2024 13:46

AbhiPrasad approved these changes Jul 16, 2024

View reviewed changes

nicholas-codecov merged commit 42bf08e into main Jul 19, 2024
41 checks passed

nicholas-codecov deleted the feat-grab-compare-sha-for-pre-merge-commits branch July 19, 2024 16:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Grab compare SHA for GH pre-merge commits #147

feat: Grab compare SHA for GH pre-merge commits #147

nicholas-codecov commented Jul 4, 2024 •

edited

Loading

codecov bot left a comment

codecov-notifications bot commented Jul 4, 2024 •

edited

Loading

codecov bot commented Jul 4, 2024 •

edited

Loading

codecov bot left a comment

codecov bot Jul 4, 2024

codecov bot Jul 4, 2024

codecov bot Jul 4, 2024

codecov bot Jul 4, 2024

codecov bot Jul 4, 2024

codecov bot Jul 4, 2024

codecov-staging bot commented Jul 4, 2024 •

edited

Loading

codecov bot commented Jul 4, 2024 •

edited

Loading

AbhiPrasad Jul 16, 2024

nicholas-codecov Jul 16, 2024


		debug(`Using compareSha: ${compareSha ?? ""}`, { enabled: output.debug });

		return compareSha ?? "";

feat: Grab compare SHA for GH pre-merge commits #147

feat: Grab compare SHA for GH pre-merge commits #147

Conversation

nicholas-codecov commented Jul 4, 2024 • edited Loading

Description

Notable Changes

codecov bot left a comment

Choose a reason for hiding this comment

codecov-notifications bot commented Jul 4, 2024 • edited Loading

Codecov Report

codecov bot commented Jul 4, 2024 • edited Loading

Codecov Report

codecov bot left a comment

Choose a reason for hiding this comment

codecov bot Jul 4, 2024

Choose a reason for hiding this comment

codecov bot Jul 4, 2024

Choose a reason for hiding this comment

codecov bot Jul 4, 2024

Choose a reason for hiding this comment

codecov bot Jul 4, 2024

Choose a reason for hiding this comment

codecov bot Jul 4, 2024

Choose a reason for hiding this comment

codecov bot Jul 4, 2024

Choose a reason for hiding this comment

codecov-staging bot commented Jul 4, 2024 • edited Loading

Bundle Report

codecov bot commented Jul 4, 2024 • edited Loading

Bundle Report

AbhiPrasad Jul 16, 2024

Choose a reason for hiding this comment

nicholas-codecov Jul 16, 2024

Choose a reason for hiding this comment

nicholas-codecov commented Jul 4, 2024 •

edited

Loading

codecov-notifications bot commented Jul 4, 2024 •

edited

Loading

codecov bot commented Jul 4, 2024 •

edited

Loading

codecov-staging bot commented Jul 4, 2024 •

edited

Loading

codecov bot commented Jul 4, 2024 •

edited

Loading