WordPress/gutenberg

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

Open

#17.273 aperta il 30 ago 2019

Vedi su GitHub
 (9 commenti) (1 reazione) (0 assegnatari)JavaScript (3893 fork)batch import
Good First IssueNeeds Dev[Status] In Progress[Type] Automated Testing[Type] Enhancementnpm Packages

Metriche repository

Star
 (9607 star)
Metriche merge PR
 (Merge medio 12g 18h) (509 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Comprendi il commento citato nel problema (#17165). Configura un ambiente Node.js senza DOM. Importa @wordpress/compose (o il pacchetto specificato) e verifica che non si blocchi a causa del riferimento a window. Scrivi un test che importi il pacchetto e affermi che non ci siano errori. Fai riferimento ai modelli di test di integrazione esistenti nel repository.
Tech stack
javascript
Dominio
testing
Tipo issue
Test
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Node.jsnpm
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70