WordPress/gutenberg

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

Open

#17,273 opened on 2019年8月30日

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

Repository metrics

Stars
 (9,607 stars)
PR merge metrics
 (平均マージ 12d 18h) (30d で 509 merged PRs)

説明

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.

コントリビューターガイド

調査方針
問題に参照されているコメント（#17165）を理解してください。DOM がない Node.js 環境をセットアップし、@wordpress/compose（または指定されたパッケージ）をインポートして、window の参照によってクラッシュしないことを確認してください。パッケージをインポートしてエラーがないことをアサートするテストを書いてください。リポジトリ内の既存の統合テストパターンを参照してください。
技術スタック
javascript
領域
testing
Issue 種別
テスト
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Node.jsnpm
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70