codecov / codecov/codecov-javascript-bundler-plugins

SvelteKit plugin is broken (treats every build as a new app)

Aperta
#252 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
TypeScript
Stelle
9
Fork
10
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

It seems like the version number/hash it added to the bundle name, causing every build to be treated as a different app. For example, this is how the bundle report looks like for any one of my PRs, regardless of the changes:

Bundle name Previous size New size Change
todo-boards-__sveltekit_1uzgg2h.app-client-esm 0B 3.26MB +3.26MB
todo-boards-__sveltekit_1uzgg2h.app-server-esm 0B 2.85MB +2.85MB
todo-boards-__sveltekit_rjtutb.app-client-esm 3.25MB 3.25MB 0B
todo-boards-__sveltekit_rjtutb.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_md9ml7.app-client-esm 3.25MB 3.25MB 0B
todo-boards-__sveltekit_md9ml7.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_rw61bm.app-client-esm 3.25MB 3.25MB 0B
todo-boards-__sveltekit_rw61bm.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_oc9q2g.app-client-esm 3.25MB 3.25MB 0B
todo-boards-__sveltekit_oc9q2g.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_pd0dha.app-client-esm 3.25MB 3.25MB 0B
todo-boards-__sveltekit_pd0dha.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_9048ew.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_9048ew.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_jb7hj3.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_jb7hj3.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_15434l3.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_15434l3.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_wbgdw4.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_wbgdw4.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_1ul4wew.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_3mgeqa.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_3mgeqa.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_10ypcbc.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_10ypcbc.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_1xcvy2i.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_1xcvy2i.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_v9cwmu.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_v9cwmu.app-server-esm 2.85MB 2.85MB 0B
todo-boards-__sveltekit_znjpv5.app-client-esm 3.26MB 3.26MB 0B
todo-boards-__sveltekit_znjpv5.app-server-esm 2.85MB 2.85MB 0B

This then gets incorrectly reported as a large change, even though it isn't:

Image

It seems like this is the code at fault:

https://github.com/codecov/codecov-javascript-bundler-plugins/blob/af1b7a9dadd9d2ceba9dba9d28e165d1f5a71a89/packages/sveltekit-plugin/src/sveltekit-bundle-analysis/sveltekitBundleAnalysisPlugin.ts#L24-L29

here, options.name is __sveltekit_1uzgg2h.app, changing on every build.

Workaround

Patch (can be applied for example using yarn patch):

diff --git a/dist/index.mjs b/dist/index.mjs
index af4d577bb316858597a9f420574129e0e799684f..6dfaaedd4fddf5a4edd5e2fbc49bb1485913943f 100644
--- a/dist/index.mjs
+++ b/dist/index.mjs
@@ -31,7 +31,6 @@ const sveltekitBundleAnalysisPlugin = ({
         output.originalBundleName,
         options.dir,
         options.format,
-        options.name
       );
       output.unlockBundleName();
       output.setBundleName(name);

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da packages/sveltekit-plugin/src/sveltekit-bundle-analysis/sveltekitBundleAnalysisPlugin.ts, in particolare dalle righe 24-29 collegate nel report, e analizza come viene assemblato il nome del bundle. Confronta il comportamento con il workaround fornito e verifica che build ripetute producano nomi di bundle stabili senza duplicare falsi cambiamenti di dimensione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
performance, tooling
Tipo di issue
Bug
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.