WordPress/gutenberg

Testing: Add integration test which ensures that npm packages can be used with Node

Open

#17 273 ouverte le 30 août 2019

Voir sur GitHub
 (9 commentaires) (1 réaction) (0 assignés)JavaScript (3 893 forks)batch import
Good First IssueNeeds Dev[Status] In Progress[Type] Automated Testing[Type] Enhancementnpm Packages

Métriques du dépôt

Stars
 (9 607 stars)
Métriques de merge PR
 (Merge moyen 12j 18h) (509 PRs mergées en 30 j)

Description

This should prevent bugs like #17165 where a naked reference to window will crash if used in a SSR context where there's no window.

See more details in the comment from @jsnajdr https://github.com/WordPress/gutenberg/pull/17165#issuecomment-525193133:

In this case, the easiest TDD-style test would be to simply import @wordpress/compose in a Node.js environment without DOM. And it would fail.

Neither compose nor components packages use the sideEffects: false flag (although they would be a good fit IMO), so using anything from compose bundles the whole library.

And the window check is a top-level statement in the module. We don't need to use or instantiate the useReducedMotion hook at all to get a broken build.

Guide contributeur

Direction de recherche
Comprenez le commentaire référencé dans le problème (#17165). Configurez un environnement Node.js sans DOM. Importez @wordpress/compose (ou le package spécifié) et vérifiez qu'il ne plante pas en raison de la référence à window. Écrivez un test qui importe le package et affirme qu'il n'y a pas d'erreur. Référez vous aux modèles de test d'intégration existants dans le dépôt.
Stack technique
javascript
Domaine
testing
Type d'issue
Test
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Node.jsnpm
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70