feat: Create Astro integration #216

nicholas-codecov · 2024-11-27T14:36:34Z

Description

This PR introduces a new package, that adds in an Astro integration, bringing BA support to Astro applications. For this integration (plugin), we followed the same pattern as we did with the Nuxt module utilizing Astro's integration system so users have an easier time integrating BA into their projects.

Closes #93

Code Example

Installation:

pnpm astro add @codecov/astro-integration

Will generate something like the following, however the user will have to configure the options such as enabling BA, the bundle name, the upload token, and other options depending on their setup.

import { defineConfig } from "astro/config";
import { codecovAstroIntegration } from "@codecov/astro-integration";

// https://astro.build/config
export default defineConfig({
  // other config settings
  integrations: [
    // place this after all other integrations
    codecovAstroIntegration({
      enableBundleAnalysis: true,
      bundleName: "example-astro-bundle",
      uploadToken: process.env.CODECOV_TOKEN,
    }),
  ],
});

Notable Changes

Add in @codecov/astro-integration package
Add in example Astro app
Add in integration tests

codecov-notifications · 2024-11-27T14:42:11Z

Codecov Report

Attention: Patch coverage is 28.04878% with 118 lines in your changes missing coverage. Please review.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
packages/astro-plugin/src/index.ts	0.00%	94 Missing and 1 partial ⚠️
...astro-bundle-analysis/astroBundleAnalysisPlugin.ts	59.61%	21 Missing ⚠️
packages/bundler-plugin-core/src/index.ts	0.00%	2 Missing ⚠️

Components	Coverage Δ
Plugin core	`96.98% <0.00%> (-0.05%)`	⬇️
Rollup plugin	`10.76% <ø> (ø)`
Vite plugin	`10.93% <ø> (ø)`
Webpack plugin	`52.09% <ø> (ø)`

📢 Thoughts on this report? Let us know!

codecov · 2024-11-27T14:42:19Z

Codecov Report

Attention: Patch coverage is 28.04878% with 118 lines in your changes missing coverage. Please review.

Project coverage is 77.81%. Comparing base (6f2bebc) to head (1260bda).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
packages/astro-plugin/src/index.ts	0.00%	94 Missing and 1 partial ⚠️
...astro-bundle-analysis/astroBundleAnalysisPlugin.ts	59.61%	21 Missing ⚠️
packages/bundler-plugin-core/src/index.ts	0.00%	2 Missing ⚠️

Additional details and impacted files

Components	Coverage Δ
Plugin core	`96.98% <0.00%> (-0.05%)`	⬇️
Rollup plugin	`10.76% <ø> (ø)`
Vite plugin	`10.93% <ø> (ø)`
Webpack plugin	`52.09% <ø> (ø)`

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

codecov-staging · 2024-11-27T14:48:13Z

Bundle Report

Changes will increase total bundle size by 1.99kB (0.07%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
@codecov/bundler-plugin-core-esm	12.43kB	113 bytes (0.92%) ⬆️
@codecov/webpack-plugin-cjs	4.64kB	57 bytes (-1.21%) ⬇️
@codecov/sveltekit-plugin-esm	891 bytes	198 bytes (-18.18%) ⬇️
@codecov/remix-vite-plugin-esm	1.09kB	133 bytes (13.9%) ⬆️
@codecov/webpack-plugin-esm	3.39kB	209 bytes (-5.81%) ⬇️
@codecov/astro-plugin-cjs	1.35kB	1.35kB (100%) ⬆️
@codecov/astro-plugin-esm	862 bytes	862 bytes (100%) ⬆️

codecov · 2024-11-27T14:48:34Z

Bundle Report

Changes will increase total bundle size by 189.04kB (3.28%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
@codecov/vite-plugin-esm	2.37kB	1.13kB (91.04%) ⬆️
@codecov/bundler-plugin-core-esm	53.15kB	40.83kB (331.35%) ⬆️
@codecov/nuxt-plugin-esm	830 bytes	397 bytes (-32.36%) ⬇️
@codecov/sveltekit-plugin-esm	1.09kB	198 bytes (22.22%) ⬆️
@codecov/webpack-plugin-cjs	4.64kB	57 bytes (-1.21%) ⬇️
@codecov/webpack-plugin-esm	3.6kB	209 bytes (6.17%) ⬆️
@codecov/example-sveltekit-app-client-esm	715.09kB	2 bytes (-0.0%) ⬇️
@codecov/example-sveltekit-app-server-esm	974.29kB	1 bytes (-0.0%) ⬇️
@codecov/bundle-analyzer-esm	3.45kB	347 bytes (11.17%) ⬆️
@codecov/example-astro-app-client-esm	144.27kB	144.27kB (100%) ⬆️
@codecov/astro-plugin-esm	1.17kB	1.17kB (100%) ⬆️
@codecov/astro-plugin-cjs	1.35kB	1.35kB (100%) ⬆️

suejung-sentry

Approved this - thanks for all the work!

As an aside, do we have a good place we document the quirks of each of these technologies as a launching point for those unfamiliar. Like "astro is a layer on top of vite so we use our internal vite plugin for all except assigning the bundle name". Or "astro may support other tools like svelte (here) which means it uses the svelte compiler before being bundled by vite". (btw I probably fudged some of the above, based on my short reading).
Just any peculiarities uncovered during development.

.changeset/nine-boxes-help.md

suejung-sentry · 2024-12-02T18:55:26Z

.changeset/nine-boxes-help.md

@@ -0,0 +1,15 @@
+---
+"@codecov/bundler-plugin-core": minor
+"@codecov/astro-integration": minor


Are we using new naming convention of <technology>-integration instead of -plugin in certain circumstances?

Edit - Oh I see that astro calls it "integration" instead of "plugin". My personal preference is to keep the terminology consistent in this repo, with "plugin" being a generic term for "custom behavior during the build." Could go either way on that though.

Yea that makes sense, i'll make the change

...ion/src/astro-bundle-analysis/__tests__/__snapshots__/astroBundleAnalysisPlugin.test.ts.snap

packages/astro-integration/src/index.ts

packages/astro-integration/package.json

integration-tests/fixtures/generate-bundle-stats/astro/astro-integration.test.ts

suejung-sentry · 2024-12-02T21:22:04Z

packages/astro-integration/src/astro-bundle-analysis/astroBundleAnalysisPlugin.ts

+  version: output.version,
+  name: PLUGIN_NAME,
+  pluginVersion: PLUGIN_VERSION,
+  vite: {


We can cross this bridge if/when it comes, but will we end up with any tricky dependency issues where we expect a certain version of vite to be used with astro? I guess that is more just up to astro to maintain that compatibility

integration-tests/fixtures/generate-bundle-stats/astro/astro-integration.test.ts

suejung-sentry

Nice, looks amazing! 🚀

suejung-sentry · 2024-12-04T16:23:02Z

packages/nuxt-plugin/vitest.config.ts

@@ -18,6 +18,5 @@ export default defineProject({
      }),
      enforce: "pre",
    },
-    ...plugins,


I see we remove these ...plugins in the vitest.config.ts files now - what's the impact/purpose of that just for my understanding?

There was only one plugin being used ts config path, which i removed because it was causing issues with the example apps while trying to run the test runners. The only impact is that we import things in the core tests slightly differently with relative imports rather than a @ for the test utils.

suejung-sentry approved these changes Dec 2, 2024

View reviewed changes

nicholas-codecov force-pushed the gh-cjbp-93-create-astro-integration branch from 6d6a5e8 to 3e9c979 Compare December 3, 2024 11:40

suejung-sentry approved these changes Dec 4, 2024

View reviewed changes

nicholas-codecov force-pushed the gh-cjbp-93-create-astro-integration branch from fac13e8 to b4e0035 Compare December 4, 2024 17:09

nicholas-codecov added 22 commits December 4, 2024 13:24

export plugin return type from plugin core

49dbc0f

add in astro integration

1c08113

add in example astro app

acd54a4

add in astro integration tests

c6b745a

update CI to upload astro example app and astro integration stats

fe1a0ce

update lockfile

531f85b

be a bit more specific about keywords in the package.json

860780c

fix test not testing name being passed

248ef94

bump versions in astro package json

603313b

fix up jsdoc typo

a7d3138

remove leftover comment

3618d73

remove a copy pasted comment

4832be0

rename from astro-integration to astro-plugin

a50566c

add ts expect errors to build config

08e90e5

cast type to plugin option array to make things happy

c5f09b1

ignore types in vitest

d541782

resolve all of the unit test issues

513c244

bump version number in astro snapshots

9131130

remove vite-tsconf-path as it's not needed

6df545b

final few type fixes

cca84a2

bump version numbers

f326bfb

correct changeset for dynamic imports

5ca57d5

fix snapshots

1260bda

nicholas-codecov force-pushed the gh-cjbp-93-create-astro-integration branch from aed77bb to 1260bda Compare December 4, 2024 17:41

nicholas-codecov merged commit 90901a5 into main Dec 4, 2024
62 of 66 checks passed

nicholas-codecov deleted the gh-cjbp-93-create-astro-integration branch December 4, 2024 17:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Create Astro integration #216

feat: Create Astro integration #216

nicholas-codecov commented Nov 27, 2024

codecov-notifications bot commented Nov 27, 2024 •

edited

Loading

codecov bot commented Nov 27, 2024 •

edited

Loading

codecov-staging bot commented Nov 27, 2024 •

edited

Loading

codecov bot commented Nov 27, 2024 •

edited

Loading

suejung-sentry left a comment

suejung-sentry Dec 2, 2024

nicholas-codecov Dec 3, 2024 •

edited

Loading

suejung-sentry Dec 2, 2024

suejung-sentry left a comment

suejung-sentry Dec 4, 2024

nicholas-codecov Dec 4, 2024

feat: Create Astro integration #216

feat: Create Astro integration #216

Conversation

nicholas-codecov commented Nov 27, 2024

Description

Code Example

Notable Changes

codecov-notifications bot commented Nov 27, 2024 • edited Loading

Codecov Report

codecov bot commented Nov 27, 2024 • edited Loading

Codecov Report

codecov-staging bot commented Nov 27, 2024 • edited Loading

Bundle Report

codecov bot commented Nov 27, 2024 • edited Loading

Bundle Report

suejung-sentry left a comment

Choose a reason for hiding this comment

suejung-sentry Dec 2, 2024

Choose a reason for hiding this comment

nicholas-codecov Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

suejung-sentry Dec 2, 2024

Choose a reason for hiding this comment

suejung-sentry left a comment

Choose a reason for hiding this comment

suejung-sentry Dec 4, 2024

Choose a reason for hiding this comment

nicholas-codecov Dec 4, 2024

Choose a reason for hiding this comment

codecov-notifications bot commented Nov 27, 2024 •

edited

Loading

codecov bot commented Nov 27, 2024 •

edited

Loading

codecov-staging bot commented Nov 27, 2024 •

edited

Loading

codecov bot commented Nov 27, 2024 •

edited

Loading

nicholas-codecov Dec 3, 2024 •

edited

Loading