
Si apre la console, e prima ancora che qualcosa del proprio codice sia stato eseguito, ci sono quattro righe rosse riguardanti source map che non si è riusciti a caricare. L’istinto è andare a controllare la configurazione della build, perché le parole descrivono una cosa che la build produce.
Di solito è il posto sbagliato, e vale la pena saperne il motivo, perché ci vogliono circa dieci secondi per capire di chi è il problema, e la maggior parte delle persone non conosce mai il trucco.
Cosa viene effettivamente richiesto
Un file minificato può contenere un puntatore a una map che lo traduce di nuovo nel source da cui è stato costruito. Ci sono due modi per allegarne una.
Il modo comune è un commento alla fine del file, //# sourceMappingURL=bundle.js.map. L’altro
è un header HTTP, e MDN è precisa su quale prevale: l’header SourceMap “ha precedenza su una
annotazione nel sorgente (sourceMappingURL=path-to-map-js.map), e se entrambi sono presenti,
l’URL dell’header viene utilizzato per risolvere il file della source map.” C’è anche un header
X-SourceMap più vecchio, che è deprecato.
Quello che la map serve a fare è altrettanto specifico. Secondo MDN, “gli strumenti per sviluppatori utilizzano la source map per ricostruire il sorgente originale dal JavaScript ottimizzato restituito nella risposta, consentendo agli sviluppatori di eseguire il debug del codice originale piuttosto che del formato che è stato ottimizzato per l’invio.”
Chi effettua la richiesta, che è il primo fatto utile
La documentazione stessa di Chrome lo spiega in una sola frase: “Quando si apre DevTools, tenta di caricare le source map, se presenti.”
Quindi la richiesta viene effettuata dagli strumenti per sviluppatori sulla propria macchina, perché li si è aperti. Un visitatore con la console chiusa non scarica questi file e non vede queste righe. Qualunque cosa stia costando, non sta costando nulla a loro.
Questo da solo esclude la maggior parte del panico. Una pagina non è rotta per questo motivo, nulla è più lento per nessuno, e nessun comportamento rivolto all’utente dipende da esso.
Perché di solito non è della propria build
Ecco la parte che fa risparmiare il pomeriggio.
Il puntatore vive dentro il file che è stato spedito. Se quel file proviene dalla propria
build, il puntatore è della propria build e così è la map mancante. Ma una buona parte di
queste righe proviene da codice che non è stato scritto: un pacchetto che è stato pubblicato su
npm con il commento sourceMappingURL lasciato dentro e il file .map lasciato fuori, perché
l’editore lo ha escluso dal pacchetto per mantenere il download piccolo.
Il proprio bundler ha copiato quel commento fedelmente, perché è un commento in un file che è stato chiesto di includere. Non c’è nulla nella propria configurazione che lo ha prodotto e nulla lì che possa risolverlo.
Quindi leggere l’URL nell’errore prima di cambiare qualcosa. Se il percorso punta alla
propria output di build, è della propria build. Se punta dentro un chunk vendor, un percorso
node_modules, o una CDN che non si controlla, è una scelta di packaging di qualcun altro e
le opzioni sono ignorarla o smettere di caricarla.
Le tre cose che effettivamente lo causano
La map non è mai stata pubblicata. Il caso più comune, e quello sopra. Nulla da sistemare.
La map esiste ma la richiesta non passa. Chrome nota che le richieste di source map “possono essere trattate come cross-origin e potrebbero non passare”, che è il caso che vale la pena sapere perché sembra identico nella console e non è affatto un file mancante. Una map su un’origine diversa senza header permissivi fallisce allo stesso modo di una che non è mai stata caricata.
La map è stata deliberatamente non distribuita. Molti team costruiscono le map e le mantengono fuori dalla directory pubblica di proposito, in modo che il sorgente originale non sia scaricabile da chiunque apra gli strumenti per sviluppatori. È una scelta difendibile, e la riga della console è il suo costo.
Smettila di indovinare e leggi l’elenco
Chrome ha un pannello che risponde a questa domanda per ogni file anziché farsi abbinare le righe della console ai bundle. Developer Resources mostra una colonna Status, per vedere se il caricamento è riuscito o fallito, e una colonna Error con il messaggio per ciascuno. Ti permette anche di caricare una map manualmente, che è come si verifica che una map che si è mantenuta privata sia per il resto corretta.
Quell’elenco è la differenza tra “la console è piena di errori di source map” e “tre di questi provengono da una sola dipendenza e uno è della propria build”.
Cosa fare, nell’ordine
Se appartiene a una dipendenza: niente. È rumore generato dalla propria tooling riguardante il packaging di qualcun altro. Nessun utente è colpito e nessuna modifica della build la rimuoverà.
Se è della propria build e si vogliono map che funzionino, spedire il file .map insieme al
bundle, oppure mantenerlo privato e caricarlo nel proprio error tracker, che è dove guadagna di
più e espone di meno. Uno
stack trace su codice minificato
è quasi inutile, e questo è il file che lo risolve.
Se si vuole soltanto che la console sia silenziosa, l’impostazione è negli strumenti per sviluppatori piuttosto che nel proprio progetto: Settings, quindi Preferences, quindi Sources, dove la documentazione di Chrome ti indica la casella JavaScript source maps. Disattivarla interrompe le richieste e le righe con esse.
Il costo che nessuno conta
Una console con una dozzina di avvertimenti permanenti non è gratis, e il prezzo non è performance.
È che tutti imparano a scorrere rapidamente. Quando la console ha sempre rosso, il rosso smette di essere un segnale, e la riga che conta arriva nel mezzo di undici che non lo fanno. L’errore su una proprietà undefined che spiega il checkout rotto si trova quattro righe sotto un avvertimento di source map che è lì sin da marzo.
Importa ancora di più quando è qualcun altro a guardare. Uno screenshot di una console da un utente, o un log acquisito allegato a una segnalazione di bug, arriva con tutto ciò dentro, e la persona che lo legge deve sapere quali righe sono arredi permanenti prima di poter vedere cosa è nuovo.
Session Replay
Estensione Chrome gratuita. Un clic sulla pagina che si comporta male cattura lo screenshot, la console e il log di rete, e fornisce un link da incollare nel ticket.
Sapere quale di quelle righe era sempre lì è la maggior parte di ciò che rende una console acquisita leggibile.
La versione breve
- La richiesta viene effettuata dagli strumenti per sviluppatori quando si aprono, non dalla pagina. Nessun visitatore vede questo e nulla è più lento per loro.
- Leggi l’URL nel messaggio per primo. Un percorso
node_moduleso vendor significa che è il packaging di una dipendenza, e non c’è nulla nella propria build da cambiare. - Una map cross-origin fallisce in un modo che sembra esattamente come una mancante.
- Developer Resources elenca lo stato e l’errore per ogni file, che batte leggere le righe della console.
- La casella che la silenzia è una preferenza di DevTools, non un’impostazione del progetto.
- Il vero costo è una console che nessuno legge attentamente più, inclusa la persona cui l’hai mandata.