はじめに
この章では以下の内容について説明します。
- ローカルマシンで Cloud Run functions を動かす方法
- ES module で Function Frameworkを動かす方法
結論
基本は以下のドキュメントの「ローカルでの開発 / 概要〜ローカル関数を呼び出す」の章を参考にしたらできます。
...ではこの記事の意味がないので、実際にローカルPCで動かせるようにするまでを解説します。
余談
GCPの公式ドキュメントは場所によって違うことを書いていたり情報が散らかっていたりしてみづらいので、できるだけ文献もセットで提示していくようにします。
ローカルで Cloud Run functionsを実行する方法
2通りあります。
- Functions Frameworkを利用する
- Functions エミュレータを利用する
本記事では Functions Framework を利用したやり方を中心に紹介します。
後者のFunctions エミュレータは、ローカルにCloud Run functionsインスタンスをデプロイするやり方です。
Functions Frameworkとは？
GCPから提供されている、Cloud Run functions上で動く関数をローカルで起動できるライブラリです。
ランタイムごとに（Node.jsだったりPython, Goだったり）ライブラリは提供されており、今回はNode.js用のFunctions Frameworkを使用します。
Functions Framework を使ってNode.js関数を実行する方法
Functions Framework で実行した関数は以下の方法でトリガーすることができます。
- HTTP（curlやブラウザのアドレスバーなど）
- バックグラウンドで動かして、Cloud StorageやPub/Subなどのイベントを受ける
- GCP上でのイベントを元に起動
本記事では、Functions Framework を使って関数をHTTPで待ち受けるように起動させ、それを curl で呼び出す方法を解説します（というよりCloud Run functionsのユースケースってほぼこれでは？）。
ES module × Functions Frameworkの環境構築
package.jsonの作成
まずは npm init でpackage.jsonを作成しましよう。
基本Enterの連打でOKです。
$ npm init
---
This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.
See `npm help init` for definitive documentation on these fields
and exactly what they do.
Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.
Press ^C at any time to quit.
### 以下、Enter連打
package name: (advent-calendar-2024)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
About to write to /Users/xxx/advent-calendar-2024/package.json:
すると以下のようなpackage.jsonが作成されます。
{
"name": "advent-calendar-2024",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
ES moduleを使えるようにする
import構文を使えるように、package.json に以下を追記します。
"type": "module"
追記後は以下のようになります。
{
"name": "advent-calendar-2024",
"version": "1.0.0",
"description": "",
"main": "index.js",
"type": "module", // <--------------- 追記する
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC"
}
参考
Functions Framework ライブラリをインストール
npm install @google-cloud/functions-framework
--save-dev はつけないでください。 後の章でお話しするビルドのプロセスの際にエラーが起こります。
ここでnode_modulesも生成されるので、.gitignoreを作成してGit管理下から外しておく。
node_modules
余談: npm, yarn, pnpm, bunとか色々あるけど結局どれを使えばいいの？
結論: npm 使っとけば問題ない。 わかんないなら尚更npm以外手を出す必要なし。一応やり方は公式ドキュメントには書いてある。
package.json の start スクリプトに Functions Frameworkの実行コマンドを書く
function-frameworkを実行するコマンドを追記します。
"scripts": {
"start": "functions-framework --target=helloGET"
}
これでpackage.jsonは（一旦）完成です。
{
"name": "advent-calendar-2024",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"start": "functions-framework --target=helloGET",
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "",
"license": "ISC",
"dependencies": {
"@google-cloud/functions-framework": "^3.4.2"
}
}
Node.js関数の実行
以下のような構成で考えます。
.
├── .gitignore
├── index.js
└── package.json
関数の作成
超簡単に関数を作ります。
import functions from '@google-cloud/functions-framework'
export const helloGET = (req, res) => {
res.send('Hello World!');
});
そして先ほど作成したコマンドを実行します。
npm run start
すると以下のような標準出力が出て、関数の起動が完了します。
$ npm run start
> advent-calendar-2024@1.0.0 start
> functions-framework --target=helloGET
Serving function...
Function: helloGET
Signature type: http
URL: http://localhost:8080/
curlで呼ぶと「Hello, World!」と標準出力に表示されます。
$ curl http://localhost:8080/
Hello World!%
ブラウザでアクセスしても表示されます。
ちなみに直接起動は以下のコマンドでできます。
npx functions-framework --target=helloGET
終了する
上記で起動した関数はプロセスとしてずっと動き続けています。
$ ps -ax | grep "functions"
---
29025 ttys025 0:00.18 node /Users/xxx/advent-calendar-2024/node_modules/.bin/functions-framework --target=helloGET
終了するには Ctrl + C を入力しましょう。
おわりに
これで超基本的なCloud Run functionsのローカル実行環境を構築することができました。
次回はこれをTypeScriptで実行できるようにしていきます。