WordPress/gutenberg

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

Open

#17.273 aberto em 30 de ago. de 2019

Ver no GitHub
 (9 comments) (1 reaction) (0 assignees)JavaScript (3.893 forks)batch import
Good First IssueNeeds Dev[Status] In Progress[Type] Automated Testing[Type] Enhancementnpm Packages

Métricas do repositório

Stars
 (9.607 stars)
Métricas de merge de PR
 (Mesclagem média 12d 18h) (509 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Entenda o comentário referenciado na issue (#17165). Configure um ambiente Node.js sem DOM. Importe @wordpress/compose (ou o pacote especificado) e verifique se ele não falha devido à referência a window. Escreva um teste que importe o pacote e afirme que não há erro. Consulte os padrões de teste de integração existentes no repositório.
Pilha de tecnologia
javascript
Domain
testing
Tipo Issue
Teste
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Node.jsnpm
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70