Vous ouvrez la console, et avant que quoi que ce soit du vôtre ne s’exécute, il y a quatre lignes rouges à propos de source maps qui n’ont pas pu être chargées. L’instinct est d’aller regarder votre configuration de build, parce que les mots nomment une chose que votre build produit.

C’est généralement le mauvais endroit, et il vaut la peine de savoir pourquoi : il ne faut qu’une dizaine de secondes pour déterminer à qui le problème appartient, et la plupart des gens n’apprennent jamais l’astuce.

Ce qui est réellement demandé

Un fichier minifié peut porter un pointeur vers une source map qui la traduit en source à partir de laquelle il a été construit. Il y a deux façons d’en joindre une.

La façon courante est un commentaire à la fin du fichier : //# sourceMappingURL=bundle.js.map. L’autre est un en-tête HTTP, et MDN est précis sur lequel prévaut : l’en-tête SourceMap « a la priorité sur une annotation source (sourceMappingURL=path-to-map-js.map), et si les deux sont présents, l’URL d’en-tête est utilisée pour résoudre le fichier source map ». Il existe aussi un en-tête X-SourceMap plus ancien, qui est déprécié.

À quoi sert la source map est également précis. Selon MDN : « Les outils de développement utilisent la source map pour reconstruire la source d’origine à partir du JavaScript optimisé renvoyé en réponse, permettant aux développeurs de déboguer le code d’origine plutôt que le format optimisé pour la transmission ».

Qui fait la requête, ce qui est le premier fait utile

La documentation propre de Chrome répond à cela en une phrase : « Lorsque vous ouvrez DevTools, elle tente de charger les source maps, si elles existent. »

La requête est donc faite par vos outils de développement, sur votre machine, parce que vous les avez ouverts. Un visiteur avec la console fermée ne récupère pas ces fichiers et ne voit pas ces lignes. Quel qu’en soit le coût pour vous, cela ne coûte rien à vos visiteurs.

Cela seul écarte la plupart de la panique. Une page n’est pas brisée à cause de cela, rien n’est plus lent pour personne, et aucun comportement visible pour l’utilisateur ne dépend de cela.

Pourquoi ce n’est généralement pas la vôtre

Voici la partie qui vous sauve l’après-midi.

Le pointeur vit à l’intérieur du fichier qui a été livré. Si ce fichier sort de votre propre build, le pointeur est le vôtre et la source map manquante aussi. Mais une grande part de ces lignes provient d’un code que vous n’avez pas écrit : un paquet publié sur npm avec le commentaire sourceMappingURL laissé en place et le fichier .map laissé de côté, parce que l’éditeur l’a exclu du paquet pour garder le téléchargement petit.

Votre bundler a copié ce commentaire fidèlement, parce que c’est un commentaire dans un fichier qu’on lui a demandé d’inclure. Il n’y a rien dans votre configuration qui l’a produit et rien là qui peut le corriger.

Donc, lisez l’URL dans le message d’erreur avant de changer quoi que ce soit. Si le chemin pointe vers votre propre sortie de build, c’est la vôtre. S’il pointe vers un chunk vendor, un chemin node_modules, ou un CDN que vous ne contrôlez pas, c’est une décision d’empaquetage de quelqu’un d’autre et vos options sont de l’ignorer ou d’arrêter de le charger.

Les trois choses qui la causent réellement

La source map n’a jamais été publiée. Le cas le plus courant, et celui ci-dessus. Rien à corriger.

La source map existe mais la requête ne passe pas. Chrome note que les requêtes de source map « peuvent être traitées comme cross-origin et ne pas réussir à passer », ce qui vaut de le savoir parce que cela ressemble au cas précédent dans la console et n’est pas un fichier manquant du tout. Une source map sur une autre origine sans en-têtes permissifs échoue de la même manière qu’une qui n’a jamais été téléchargée.

La source map n’a volontairement pas été déployée. Beaucoup d’équipes construisent les source maps mais les gardent exprès hors du répertoire public, afin que la source d’origine ne soit pas téléchargeable par quiconque ouvre les outils de développement. C’est un choix défendable, et la ligne de console en est le coût.

Arrêtez de deviner et lisez la liste

Chrome a un panneau qui répond à cela par fichier au lieu de vous laisser associer les lignes de console aux bundles. Developer Resources affiche une colonne Status pour voir si le chargement a réussi ou échoué, et une colonne Error avec le message pour chacun. Il vous permet aussi de charger une source map à la main, ce qui vous permet de vérifier qu’une source map que vous avez gardée privée est correcte.

Cette liste est la différence entre « la console est pleine d’erreurs source map » et « trois d’entre elles viennent d’une dépendance et l’une d’entre elles est la nôtre ».

Quoi faire, dans l’ordre

Si elle appartient à une dépendance : rien. C’est du bruit généré par votre propre tooling à propos de l’empaquetage de quelqu’un d’autre. Aucun utilisateur n’est affecté et aucun changement de build ne l’enlèvera.

Si c’est la vôtre et que vous voulez que les source maps marchent, livrez le fichier .map à côté du bundle, ou gardez-le privé et téléchargez-le plutôt vers votre error tracker, c’est là qu’il rapporte le plus et expose le moins. Une trace contre du code minifié est presque inutile, et c’est ce fichier qui la rend utile.

Si vous voulez juste que la console soit silencieuse, le paramètre est dans DevTools plutôt que dans votre projet : Settings, puis Preferences, puis Sources, où la documentation de Chrome vous pointe vers la case JavaScript source maps. La décocher arrête les requêtes et les lignes avec.

Le coût que personne ne compte

Une console avec une douzaine d’avertissements permanents à l’intérieur n’est pas gratuite, et le coût ne vient pas de la performance.

C’est que tout le monde apprend à survoler. Lorsque la console est toujours rougeoyante, le rouge cesse d’être un signal, et l’unique ligne qui compte arrive au milieu de onze qui ne comptent pas. L’erreur à propos d’une propriété indéfinie qui explique pourquoi le paiement est cassé est assise quatre lignes sous un avertissement source map qui est là depuis mars.

Cela compte encore plus quand quelqu’un d’autre regarde. Une capture d’écran de console d’un utilisateur, ou un journal capturé joint à un rapport de bug, arrive avec tout cela, et la personne qui le lit doit savoir quelles lignes font partie des meubles avant qu’elle puisse voir ce qui est nouveau.

Session Replay

Extension Chrome gratuite. Un clic sur la page qui pose problème capture l'écran, la console et le journal réseau, et vous fournit un lien à coller dans le ticket.

Obtenir l'extension

Savoir quelles lignes étaient déjà là est l’essentiel de ce qui rend une console capturée lisible.

La version courte

  • La requête est faite par vos outils de développement lorsque vous les ouvrez, pas par la page. Aucun visiteur ne voit cela et rien n’est plus lent pour eux.
  • Lisez l’URL du message en premier. Un chemin node_modules ou vendor signifie que c’est l’empaquetage d’une dépendance, et il n’y a rien dans votre build à changer.
  • Une source map cross-origin échoue d’une manière qui ressemble exactement à une source map manquante.
  • Developer Resources répertorie le statut et l’erreur par fichier, ce qui vaut mieux que de lire les lignes de console.
  • La case à cocher qui la fait taire est une préférence DevTools, pas un paramètre de projet.
  • Le vrai coût est une console que personne ne relit attentivement, y compris celui à qui vous l’avez envoyée.