npm Shrinkwrap再考:Package-LockとYarn.Lockでnpm依存関係を固定する
Assaf Hefetz
2018年1月10日
12 分で読めます201
この
ShrinkWrapはもう不要:Nodeの依存関係をスマートに固定する方法
依存関係を
Node.jsでは、
最近、
その前に、
依存関係をロック(ピン留め)するメリットとデメリット
多くの
破壊的変更 - 依存関係の
新しい バージョンには、 コードで サポートされていない 変更や、 特定の 実装と 互換性の ない 変更が 含まれる 場合が あります。 バグや
問題 - 新しい バージョンで、 パッケージ開発者が 見落とした 問題が 発生する ことがあります。 アップグレードの たびに コード内の すべての 依存関係を テストする ことは できないため、 まずは 自分の 環境で 動作確認済みの バージョンを 使うのが 得策です。 予測
可能性 - アジャイル開発と 継続的デリバリーは、 予測可能な 方法で ソフトウェアを 自動デプロイできる ことを 前提と しています。 一貫性の ない 動作や 予測できない 動作を 引き起こす 可能性の ある パッケージの アップグレードは、 この 予測 可能性に 反します。
一方、
セキュリティ - Snykは
オープンソースの 脆弱性を スキャンする ツールを 提供している ため、 依存関係に 潜む 危険性を よく 認識しています。 データに よると、 少なくとも Node.jsコミュニティでは、 プロジェクトの 76%が 既知の 脆弱性を 含む パッケージを 使用しています。 依存関係を ロック/ピン留めすると、 脆弱性も 一緒に 固定されます。 セキュリティ上の 問題が 発見され、 パッケージの 作成者が 修正を 公開しても、 古く 脆弱な バージョンを 使い続けることになります。 サードパーティモジュール - 他の
プロジェクトの 依存関係と なる サードパーティモジュールの 作成者である 場合、 依存関係を ピン留めすると、 ユーザーは 同じ バージョンを 使い続けることになります。 たとえば Pythonの パッケージングに 関する ドキュメントでは、 これは 制限が 厳しすぎる ため、 適切な 方法とは 見なされていません。 この 点を 指摘してくれたDustin Ingramに 感謝します。
セキュリティ上の
セキュリティテストと
package-lockで依存関係をロックする
package-lock.jsonは
npm 5は
package-lockを
コミットすると、 セキュリティレイヤーを もう 1つ 追加できます。 SHA整合性値を 使って、 インストールする ものが 想定どおりである ことを 確認できます。 package-lockを
コミットすると、 npmが インストール済みパッケージの メタデータを 解決する 必要が なくなる ため、 インストールが 速くなります。
package-lock.jsonの
package-lock.jsonファイルに
name - package-lock.jsonでは
特定の パッケージの ロックを 定義します。 ここで パッケージ名を 指定します。 version - 固定する
バージョンです。 lockfileVersion - package-lockファイルの
バージョン。 初期値は 1です。 packageIntegrity - package.jsonから
生成される 整合性値です。 ssriなどの モジュールで 生成できます。 preserveSymlinks - 環境変数NODE_PRESERVE_SYMLINKSを
指定して インストールしたかどうかを 示します。 dependencies - パッケージ名と
依存関係 オブジェクトの 対応付けです。 依存関係 オブジェクトには 次の プロパティが あります。 version - この
パッケージを 取得する 際に 使用できる、 一意の 識別子です。 パッケージソースごとのバージョンの 指定方法に ついては、 package-lockの ドキュメントを 参照してください。 bundled - 依存関係が
バンドルされているかどうかを 示します。 バンドルされている 場合は、 個別の 依存関係と して インストールするのではなく、 親モジュールから 抽出するかどうかを 示します。 dev -
この 依存関係が 開発用の 依存関係、 または その 推移的依存関係かどうかを 示します。 その
他の プロパティには、integrity、resolved、optional、dependencies(この 依存関係の 下位依存関係)が あります。
詳しくはpackage-lock.jsonの
yarn.lockで依存関係をロックする
Yarnには
Yarnは
ファイルの
依存関係を
詳しくはyarn.lockの
まとめ
依存関係は
現在、
私たちからの


