Node.js での依存関係の指定

関数では、ローカルデータだけでなく、外部の Node.js モジュールも使用できます。Node.js における依存関係は、npm で管理され、package.json というメタデータファイルで表現されます。Cloud Functions の Node.js ランタイムは通常、npm または yarn を使用したインストールをサポートしています。

関数の依存関係を指定するには、package.json ファイルにその依存関係を追加します。

この例では、依存関係は package.json ファイルにリストされています。

{
  "dependencies": {
    "escape-html": "^1.0.3"
  }
}

依存関係は関数にインポートされます。

functions/helloworld/helloworldHttp/index.js

GitHub で表示

const functions = require('@google-cloud/functions-framework');
const escapeHtml = require('escape-html');

/**
 * Responds to an HTTP request using data from the request body parsed according
 * to the "content-type" header.
 *
 * @param {Object} req Cloud Function request context.
 * @param {Object} res Cloud Function response context.
 */
functions.http('helloHttp', (req, res) => {
  res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
});

`npm` を使用してローカルで Node.js モジュールをインストールする

ローカルで Node.js モジュールをインストールする特に簡単な方法は、Cloud Functions のあるフォルダで npm install コマンドを使用することです。たとえば、次のコマンドは uuid モジュールを追加します。

npm install uuid

これは、次の 2 つのステップを組み合わせたものです。

package.json ファイルで、モジュールの最新バージョンを依存関係としてマークします。これは非常に重要です。Cloud Functions は、package.json ファイルで宣言されたモジュールのみをインストールします。
モジュールを node_modules ディレクトリにダウンロードします。これにより、モジュールをローカルでの開発に使用できます。

マシンに npm がインストールされていない場合は、npm を入手します。

デプロイの依存関係の構成

npm による本番環境の依存関係のインストール

関数をデプロイする際、Cloud Functions は npm install コマンドを使用して、package.json ファイル内で宣言されている依存関係をインストールします。

npm install --production

Node.js 8 以降のランタイムでは、yarn.lock ファイルが存在する場合は、Cloud Functions では代わりに yarn install コマンドが使用されます。

yarn install --production

デプロイ時にカスタムビルドステップを実行する

デプロイした後、package.json ファイルに gcp-build スクリプトを追加すると、関数のビルドプロセス中にカスタムビルドステップを実行できます。

このスクリプトの実行時には、package.json ファイルの dependencies フィールドと devDependencies フィールドの依存関係を利用できます。カスタムビルドステップが実行された後、Cloud Functions は package.json ファイルの dependencies フィールドで宣言されている本番環境の依存関係のみをインストールし、node_modules フォルダを削除して生成し直します。

package.json に gcp-build スクリプトがない場合、Cloud Functions は本番環境の依存関係をインストールするだけです。

システムパッケージの使用

Node.js ランタイムでは、実行環境に多数のシステムパッケージが含まれています。リストされていないパッケージが必要な依存関係が関数で使用されている場合は、パッケージをリクエストできます。

ローカル Node.js モジュールを含める

関数の一部としてローカルの Node.js モジュールを含めることもできます。そのためには、file: 接頭辞を使用してモジュールを package.json で宣言します。次の例では、mymodule はモジュール名を指し、mymoduledir はモジュールを含むディレクトリを指します。

{
  "dependencies": {
    "mymodule": "file:mymoduledir"
  }
}

このローカルモジュールのコードは、関数のルートディレクトリ内にある node_modules フォルダ以外の場所に保存する必要があります。

Node.js モジュールを読み込む

インストールされている任意の Node.js モジュールを読み込むには、Node.js の require() 関数を使用します。require() 関数を使用して、関数とともにデプロイするローカルファイルをインポートすることもできます。

非公開モジュールの使用

非公開の npm モジュールを使用するには、関数のディレクトリにある .npmrc ファイルに、レジストリに対して認証するための設定を記述します。

Artifact Registry の非公開モジュール

Artifact Registry Node.js パッケージリポジトリは、関数の非公開モジュールをホストできます。Cloud Functions にデプロイすると、ビルドプロセスによって、Cloud Build サービスアカウント用の Artifact Registry 認証情報が自動的に生成されます。必要な操作は、.npmrc に Artifact Registry リポジトリのリストを記述するだけです。追加の認証情報を生成する必要はありません。次に例を示します。

@SCOPE:registry=https://REGION_ID-npm.pkg.dev/PROJECT_ID/REPOSITORY_NAME
//REGION_ID-npm.pkg.dev/PROJECT_ID/REPOSITORY_NAME:always-auth=true

他のリポジトリの非公開モジュール

npm のドキュメントでは、カスタムの読み取り専用アクセストークンを作成する方法について説明しています。.npmrc ファイルには読み取り / 書き込みトークンが含まれているため、ホームディレクトリにこのファイルを作成して使用することは避けてください。デプロイ時に書き込み権限は必要なく、セキュリティ上のリスクが発生する可能性があります。

非公開リポジトリを使用していない場合は .npmrc ファイルを追加しないでください。追加すると、関数のデプロイ時間が長くなる可能性があります。

ファイル形式

.npmrc ファイルを使用してカスタム認証トークンを設定する場合は、以下の行を含める必要があります。<YOUR_AUTH_TOKEN> は、npm 提供の認証トークンに置き換えます。

//registry.npmjs.org/:_authToken=<YOUR_AUTH_TOKEN>