Node.js で Cloud Run functions の HTTP 関数を作成してデプロイする（第 1 世代）

注: この内容は、第 1 世代の Cloud Run functions（以前の Cloud Functions 第 1 世代）を対象としています。

このドキュメントの Cloud Run functions 向けバージョンについては、Node.js で Cloud Run functions の HTTP 関数を作成してデプロイするをご覧ください。

このガイドでは、Node.js ランタイムを使用して Cloud Run 関数を作成するプロセスを説明します。Cloud Run functions には次の 2 つのタイプがあります。

• HTTP 関数。標準的な HTTP リクエストから呼び出します。
• イベント ドリブン関数。Pub/Sub トピックのメッセージや Cloud Storage バケットの変更など、Cloud インフラストラクチャのイベントを処理するために使用します。

次のサンプルでは、簡単な HTTP 関数を作成しています。

詳細: 詳細については、HTTP 関数とイベント ドリブン関数をご覧ください。

始める前に

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Functions and Cloud Build APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Cloud Functions and Cloud Build APIs.

   Enable the APIs

8. gcloud CLI をインストールして初期化します。
9. gcloud コンポーネントを更新してインストールします。

   gcloud components update

注: コマンド プロンプトが必要な場合は、Cloud Shell を使用できます。Cloud Shell コマンドライン環境には Google Cloud CLI がすでに含まれているので、インストールする必要はありません。Google Cloud CLI は、Google Compute Engine の仮想マシンにもプリインストールされています。
10. 開発環境を準備します。

    Node.js 設定ガイドに移動

関数を作成する

1. 関数コードで使用するため、ローカル システムにディレクトリを作成します。

   Linux / Mac OS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. helloworld ディレクトリに、次の内容の index.js ファイルを作成します。

   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')}!`);
   });

   このサンプル関数は HTTP リクエストで指定された名前を使用します。名前が指定されていない場合は、「Hello World!」という挨拶を返します。

   注: Cloud Run functions は、デフォルトで index.js にデプロイ可能な関数を探します。gcloud を介して関数をデプロイし、index.js ファイルを含む別のディレクトリを指定する場合は、--source フラグを使用します。

依存関係を指定する

Node.js における依存関係は、package.json というファイルに保存されます。このファイルは手動で、または npm コマンドを使用して作成できます。

• npm を使用して package.json 依存関係ファイルを作成するには、次のコマンドを実行します。

  npm init
  npm install c8 gaxios mocha sinon supertest wait-port --save-dev
  npm install @google-cloud/functions-framework escape-html
  

• package.json ファイルを手動でビルドする場合は、package.json ファイルを次の内容で helloworld ディレクトリに作成します。

  {
    "name": "nodejs-docs-samples-functions-hello-world-http",
    "version": "0.0.1",
    "private": true,
    "license": "Apache-2.0",
    "author": "Google Inc.",
    "repository": {
      "type": "git",
      "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
    },
    "engines": {
      "node": ">=16.0.0"
    },
    "scripts": {
      "unit-test": "c8 mocha -p -j 2 test/index.test.js test/*unit*test.js test/*integration*test.js --timeout=6000 --exit",
      "system-test": "c8 mocha -p -j 2 test/*system*test.js --timeout=600000 --exit",
      "all-test": "npm run unit-test && npm run system-test",
      "test": "npm -- run unit-test"
    },
    "dependencies": {
      "@google-cloud/functions-framework": "^3.1.0",
      "escape-html": "^1.0.3"
    },
    "devDependencies": {
      "c8": "^10.0.0",
      "gaxios": "^6.0.0",
      "mocha": "^10.0.0",
      "sinon": "^18.0.0",
      "supertest": "^7.0.0",
      "wait-port": "^1.0.4"
    }
  }
  

  注: Node.js クライアント ライブラリは、さまざまな Google Cloud プロダクトで使用でき、依存関係としてインストールできます。こちらのリストをご覧ください。

詳細: 詳細については、依存関係の指定をご覧ください。

関数をデプロイする

HTTP トリガーを使用して関数をデプロイするには、helloworld ディレクトリで次のコマンドを実行します。

gcloud functions deploy helloHttp --no-gen2 --runtime nodejs20 --trigger-http --allow-unauthenticated

--allow-unauthenticated フラグを使用すると、認証なしで関数にアクセスできます。認証を要求するには、フラグを省略します。

詳細: 詳細については、Cloud Run functions のデプロイをご覧ください。

関数をテストする

1. 関数がデプロイされたら、httpsTrigger.url プロパティをメモするか、次のコマンドを使用して検索します。

   gcloud functions describe helloHttp
   

   次のようになります。

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp

2. ブラウザで、この URL にアクセスします。「Hello World!」というメッセージが表示されます。

   たとえば、次の URL を使用して HTTP リクエストで名前を渡します。

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp?name=NAME

   「Hello NAME!」というメッセージが表示されます。

ログを表示する

Cloud Run functions のログは、Google Cloud CLI を使用して、また Cloud Logging UI で表示できます。

コマンドライン ツールを使用する

gcloud CLI を使用して関数のログを表示するには、logs read コマンドの後に関数の名前を続けます。

gcloud functions logs read helloHttp

出力は次のようになります。

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

注: 通常、ログエントリが作成されてから Cloud Logging に表示されるまでに若干時間がかかります。

Logging ダッシュボードを使用する

Google Cloud コンソールから Cloud Run functions のログを表示することもできます。

詳細: 詳細については、ログの作成、表示、応答をご覧ください。