最終更新日 2024年05月15日(水)

すべての新しいプロジェクトを npm の init で開始する

npm の init​ コマンドは、プロジェクトの有効な package.json を足場にして、作業用ディレクトリから共通のプロパティを推測します。

$ mkdir example-app
$ cd example-app
$ npm init --yes

--yes​ フラグを指定してこのコマンドを実行してから、package.json​ を開いて変更を加えます。まず、ノードのバージョン (node -v​) を使用して engines​ キーを指定します。

"engines": {
  "node": "20.x"
}

小文字の使用

一部の言語では、MyClass​ や ‘MyClass.js’ のように、クラス名に一致するファイル名を推奨しています。Node.js では小文字のファイル名を使用します。

let MyClass = require('my-class');

Node.js は、高度なクロスプラットフォームサポートを備えた Linux 中心のツールの希少な例です。OSX と Windows では myclass.js​ と MyClass.js​ は同じ扱いですが、Linux では違います。プラットフォーム間の移植性が高いコードを記述するには、大文字小文字の使い分けを含めて​ require​ ステートメントを完全に一致させます。

簡単な方法は、あらゆる要素のファイル名に関して小文字の使用を徹底することです。たとえば、my-class.js​ とします。

アプリのクラスタリング

Node ランタイムには、CPU コアが 1 つ、メモリが 1.5 GB 以下という制限があるため、Node アプリをクラスタリングせずに大規模サーバーにデプロイするとリソースの浪費になります。

複数のコアと 1.5 GB を超えるメモリを利用するには、クラスターのサポート​をアプリに追加します。今は小規模ハードウェアで単一プロセスを実行しているだけであっても、クラスタリングが提供する柔軟性によって将来の対応が容易になります。

アプリのクラスタリングプロセスの理想的な数を決定する最良の方法はテストですが、使用するプラットフォームで提示された妥当なデフォルト値​から始めることをお勧めします。そのためには、次のような単純なフォールバックを使用します。次に例を示します。

const CONCURRENCY = process.env.WEB_CONCURRENCY || 1;

クラスター抽象化​を選択して、プロセス管理の再構築を避けます。メインファイルとワーカーファイルを分けたい場合は、Forky​ を試してみてください。単一のエントリポイントファイルと関数を使用する場合は、Throng​ を検討してください。Throng についての詳細は、「Optimizing Node.js Concurrency​」(Node.js の並列性の最適化) を参照してください。

環境への配慮

プロジェクトで環境固有の設定ファイルを多用しないでください。代わりに、環境変数を利用します。

ローカル開発環境を提供するには、.gitignore を付けた .env​ ファイルを作成します。このファイルは heroku local​ によって読み込まれます。

DATABASE_URL='postgres://localhost/foobar'
HTTP_TIMEOUT=10000

heroku local​ でアプリを起動します。これらの環境変数が process.env.DATABASE_URL​ および process.env.HTTP_TIMEOUT​ の配下で自動的にアプリに読み込まれます。プロジェクトをデプロイすると、プロジェクトはその新しいホスト上の変数に自動的に適応​します。

これは、config/abby-dev.js​、config/brian-dev.js​、config/qa1.js​、config/qa2.js​、config/prod.js​ などよりもシンプルで柔軟性があります。

ガーベジの回避

Node (V8) では、低速で強力なガーベジコレクターを使用します。そのデフォルトの制限は約 1.5 GB のため、未使用メモリの再利用がどうしても必要になるまで待機する場合があります。メモリ使用量が増加している場合、リークではなく、Node の通常の低速な動作​である可能性があります。

アプリのガーベジコレクターの制御を強化するために、Procfile​ で V8 にフラグを指定できます。

web: node --optimize_for_size --max_old_space_size=920 --gc_interval=100 server.js

この制御は、使用可能なメモリが 1.5 GB に満たない環境でアプリを実行する場合に特に重要です。たとえば、Node を 512 MB のコンテナに合わせる場合は、次を試してみてください。

web: node --optimize_for_size --max_old_space_size=460 --gc_interval=100 server.js

フックの利用

ライフサイクルスクリプト​は、自動化のための優れたフックです。Heroku では、依存関係をインストールする前または後にカスタムコマンドを実行できるよう、カスタムフック​を提供しています。アプリをビルドする前に何かを実行するために、heroku-prebuild​ スクリプトを使用できます。grunt​、gulp​、browserify​、または webpack​ でアセットをビルドする必要がある場合は、build​ スクリプトで行います。

package.json​ では、次のようになります。

"scripts": {
  "build": "bower install && grunt build",
  "start": "nf start"
}

環境変数を使用してこれらのスクリプトを制御することもできます。

"build": "if [ $BUILD_ASSETS ]; then npm run build-assets; fi",
"build-assets": "bower install && grunt build"

スクリプトの制御が難しくなり始めたら、スクリプトをファイルに移動します。

"build": "scripts/build.sh"

package.json​ のスクリプトでは、bower​ や webpack​ などのバイナリを直接実行できるよう、./node_modules/.bin​ がスクリプトの PATH​ に自動的に追加されます。

重要なものだけを Git で管理する

ほとんどのアプリは、必要なファイルと生成されたファイルで構成されています。Git などのソース管理システムを使用するときは、生成されたものを何でも追跡することは避けてください。

たとえば、Node アプリにはおそらく依存関係用の node_modules​ ディレクトリがありますが、これを Git での管理に含めないようにします。これらのファイルとディレクトリを .gitignore​ に追加します。

個々の依存関係が package.json​ で定義されている限り、npm install​ を実行することによって、誰でもアプリ (node_modules​ を含む) の作業用ローカルコピーを作成できます。

生成されたファイルを追跡すると、Git の履歴に不必要なノイズが混ざったり、履歴が肥大化したりする場合があります。さらに悪いことに、一部の依存関係はネイティブであり、コンパイルする必要があります。そのため、それらをチェックインすると、単一アーキテクチャの、また場合によっては正しくないアーキテクチャのビルドが提供されることになり、アプリの移植性が低下します。

同じ理由で、bower_components​ や、grunt​ ビルドからコンパイルしたアセットをチェックインしないでください。

以前に誤って node_modules​ をチェックインした場合、それは問題ありません。これは削除することができます。

$ echo 'node_modules' >> .gitignore
$ git rm -r --cached node_modules
$ git commit -am 'ignore node_modules'

また、コードが乱雑にならないよう、npm​ のログを無視します。

$ echo 'npm-debug.log' >> .gitignore
$ git commit -am 'ignore npm-debug'

これらの不必要なファイルを無視すると、リポジトリが小さくなり、コミットがより簡単になり、生成されたディレクトリでのマージの競合が回避されます。