WordPress/gutenberg

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

Open

#17,273 建立於 2019年8月30日

在 GitHub 查看
 (9 留言) (1 反應) (0 負責人)JavaScript (9,607 star) (3,893 fork)batch import
Good First IssueNeeds Dev[Status] In Progress[Type] Automated Testing[Type] Enhancementnpm Packages

描述

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.

貢獻者指南

技術棧
javascriptnodejs
領域
testingbackend
議題類型
test
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic JavaScriptNode.js environmentnpm
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Review the linked PR #17165 and the comment from @jsnajdr for context on the `window` reference issue. Examine the `@wordpress/compose` package to identify top level `window` usage. Create a Node.js integration test that imports the package without a DOM environment to ensure no crashes. Consider adding the test to the existing test suite for npm packages.