*この記事はA JavaScript user’s First AWS Lambda functionからの一部転用です。
TL;DR
npm pruneコマンドでdevDependenciesを一旦削除したらいいよね。
はじめに
Wataruです。カナダのバンクーバーというところでCivic Tech関連の小さな会社でソフトウェアデベロッパーとして働いています。なぜカナダで働いているか、もし興味があったらnote書きましたので読んで頂けると嬉しいです。
仕事の半分以上はフロントエンドを担当しています。Firebaseを触って以来、サーバレスアーキテクチャに興味があり、AWSの勉強を始めました。日本で購入したAWSによるサーバーレスアーキテクチャを参考に学習を進めています。
本題
上記の書籍の第3章にて、node.jsアプリケーションのAWS Lambdaへのデプロイについて触れられています。デプロイするアプリケーションのpackage.json(一部)は以下の通りです。
// package.json
{
...
"scripts": {
...
"deploy": "aws lambda update-function-code --function-name arn:aws:lambda:us-east-1:000000000000:function:transcode-video --zip-file fileb://Lambda-Deployment.zip",
"predeploy": "zip -r Lambda-Deployment.zip * -x *.zip *.log"
}
...
}
デプロイは以下のnpmコマンドで行なっています。
$ npm run deploy
コマンドが実行されると、package.jsonに書かれたpredeployが実行され、deployが実行される、という流れになっています。
-
predeploy: 作業ディレクトリの全てを"Lambda-Deployment.zip"という名前で圧縮。 -
deploy: AWSサーバーに圧縮したzipファイルをアップロード。
書籍で紹介されているサンプルプログラム程度ならこのままでいいのですが、unit testを書いたりESLintやprettierなんかを入れたりしていると、devDependenciesが増えてしまい、zipファイルのサイズが大きくなってしまいます。大きくなればなるほど、アップロードに時間もかかってしまいますね。devDependenciesはアップロードする必要が無いので、いっそのこと消してしまいましょう。
npm prune
npm pruneはnpmのCLIコマンドの一つです。ドキュメントを引用すると：
This command removes “extraneous” packages. If a package name is provided, then only packages matching one of the supplied names are removed.
Extraneous packages are packages that are not listed on the parent package’s dependencies list.
翻訳してみます。
このコマンドは"余計な"パッケージを削除します。パッケージ名がコマンド実行時に与えられていたら、その名前に一致したものだけが削除されます。
余計なパッケージとは、そのパッケージを使っているpackage.json内のdependenciesの一覧にないパッケージのことです。
npm pruneには--productionフラグというものがあります。このフラグをつけてコマンドを実行すると、devDependenciesで指定された全てのファイルが消去されます。
devDependenciesを削除できればzipファイルを軽量化できそうですね。しかし、このコマンドで削除したパッケージは開発には必要なものばかりです。削除した後でまたダウンロードするのも時間がかかりそうですよね。
npm install --offline
npm installにはドキュメントには記載されていない、おそらく非公式の--offlineというフラグがあります。npm CLIのデベロッパー@zkatがそのフラグについてnpmのissueの中で言及しています。以下、部分的に引用します。
npm@5will automatically install from cache if it doesn't detect network, or if your router lacks external access. So if you want to use npm on a plane, you can just use it. You don't need--offline. It'll Just Work™.--offlinewill ONLY be useful when you want to guarantee that no network access is done, and you want npm to crash when it doesn't have something in cache (this does not include git dependencies right now). So, this is what you use if you've hit your data cap and want to make damn sure npm doesn't suck up more data. Or, like, if you're temporarily tethering off your phone.
翻訳してみます。
npm@5はネットワークが検知されなかったら自動的にキャッシュからインストールします。飛行機などwifiがない環境でnpmを使いたかったら普通に使うことができます。--offlineフラグを使う必要はありません。--offlineフラグは、あなたがどうしてもネットワーク接続なしでnpmを使いたい時"だけ"便利です。キャッシュにパッケージがなかったらnpmコマンドはクラッシュするでしょう(git dependenciesは2017年9月時点でキャッシュサポートされていません)。あなたがインターネットのデータ使用量を超過してしまった時や、電話を使ってテザリングしているときなどに使えます。
--offlineフラグを使って明示的にキャッシュからインストールするようにすれば、削除したdevDependenciesの再ダウンロードの時間を抑えることができそうです。
これらのnpmコマンドを使ったpackage.jsonに書き換えてみます。
// package.json
{
...
"scripts": {
...
"deploy": "aws lambda update-function-code --function-name arn:aws:lambda:us-east-1:000000000000:function:transcode-video --zip-file fileb://Lambda-Deployment.zip",
"predeploy": "rm Lambda-Deployment.zip > /dev/null && npm prune --production && zip -r Lambda-Deployment.zip * -x *.zip *.log",
"postdeploy": "npm install --offline"
}
...
}
先程と少し異なり、postdeployを追加しました。
-
predeploy:- 今ある"Lambda-Deployment.zip"を削除。
-
npm prune --productionでdevDependenciesを削除。 - 作業ディレクトリの全てを"Lambda-Deployment.zip"という名前で圧縮。
-
deploy: AWSサーバーに圧縮したzipファイルをアップロード。 -
postdeploy: キャッシュから全てのパッケージをインストール。
結果
devDependenciesを削除することで、私の場合はアップロードするzipファイルのサイズを26.3 MBから5.6 MBまで抑えることに成功しました。
おわりに
削除したり再インストールしたりするのでもしかしたら余計に時間がかかるかも、と思っていましたが、意外と時間をかけることなくデプロイすることができました。このあたりはdependenciesの量で変わったりするかもしれません。
元の記事では ESLint + prettier や husky + lint-staged + jest についても触れています。Qiitaではたくさんの方が書いているようですので省略しましたが、もし興味があれば教えてください。学び始めたばかりですが、共有できることもあるかと思います。
読んでいただきありがとうございました。