Firebase Functions の関数をTypeScriptで開発する際、デフォルトではコードベース自体を1つのパッケージに含め、libディレクトリにtscでトランスパイルしたうえでデプロイする方式となっています。しかし、この方法では以下のような問題があります。
- モノリポジトリ構成などでワークスペースを使用している場合、ワークスペース ルートにあるロックファイルがデプロイ時に反映されない
- tscは基本的に型を外すだけでコードの中身には手を加えないので、インポートの方法によってはローカルでは動くのにデプロイに失敗するような事態が起こりうる
そこで、今回はBunを使って1つのファイルにソースをバンドルしつつ、isolate-packageを使ってワークスペースにおけるfunctionsのパッケージを独立化してデプロイする設定方法を解説します。
Table of Contents
- isolate-package をインストールする
- package.json と .gitignore を編集する
- tsconfig.json を編集する
- isolate.config.ts を作成する
- firebase.json を編集する
- 完了!
isolate-package をインストールする
まずはFunctionsのワークスペースで isolate-package をインストールします。
bun add -D isolate-package
package.json と .gitignore を編集する
まず、package.jsonに version フィールドがないと怒られるので、適当なバージョンで追加します。
{
"name": "functions",
+ "version": "0.0.0",
...
次に、デプロイするファイルを files に追加します。今回はバンドル後のJSコードを dist/index.js に生成しますので、distを追加します。また、エントリーポイントである main のパスもそれに合わせて書き換えます。
...
+ "files": [
+ "dist"
+ ],
- "main": "lib/index.js",
+ "main": "dist/index.js",
"engines": {
"node": "24"
},
...
次に、よく使うコマンドを scripts に追加します。
| コマンド | 説明 |
|---|---|
| typecheck | 型検査をします。 bun check はBun v1.4.3以降で利用できます。型検査にBunを使いたくない場合は tsc を入れておきます。 |
| build | bun buildを使ってソースをバンドルします。--sourcemap=linked はソースマップを生成するオプションですので、不要な場合は外して構いません。--checkを付けることで型検査も行ってくれるようになりますが、Bun v1.4.3以降でなければ使えませんので注意。Bunの型検査機能を使いたくない場合は、buildの前に typecheck を実行してください。 |
| build:watch | 開発用。ソースファイルの変更を検出して再ビルドします。Firebase emulatorが立ち上がっていれば自動で再読込されます。 |
| isolate | isolate-package のコマンド。アイソレートされたパッケージを生成します。それと同時に、ソースマップを有効化するためのオプションを吐き出しますが、ソースマップが不要な場合は外して構いません。 |
...
"scripts": {
"lint": "eslint .",
- "build": "tsc",
+ "typecheck": "bun check",
+ "build": "bun build --check --outdir=./dist --target=node --sourcemap=linked --packages=external ./src/index.ts",
+ "build:watch": "bun run build --watch",
+ "isolate": "isolate && echo 'NODE_OPTIONS=--enable-source-maps' >> isolate/.env",
"serve": "firebase emulators:start --only functions",
...
次に、.gitignore に dist と isolate が含まれていることを確認しておいてください。
...
+ dist
+ isolate
tsconfig.json を編集する
以下のように編集すると、tsc実行時にファイルが生成されず、型検査のみになります。
{
"compilerOptions": {
...
- "outDir": "lib",
- "sourceMap": true,
+ "noEmit": true,
...
}
}
isolate.config.ts を作成する
isolate-packageには、bun.lock から現在のワークスペースに関連する推移依存を切り出して生成してくれる機能がありますが、バグがあり、rootワークスペースで依存しているパッケージが依存する推移依存のバージョンが誤って選択されてしまうことがあります。そのため、forceNpm を指定して生成後のpackage.jsonで新しくpackage-lock.jsonを生成します。rootワークスペースで何にも依存していない場合は指定しなくても問題ないはずです。
副作用として、プロジェクトのロックファイルは無視されるためバージョンは新たに選択されます。
import { defineConfig } from "isolate-package"
export default defineConfig({
buildDirName: "dist",
forceNpm: true, // 必要な場合
})
firebase.json を編集する
Bun v1.4.4現在、オプション解析にバグがあり、run の前に --cwd <dir> を置くと正しく認識されない問題があるため、必ず run の後に置きます。また、Firebaseが内部でshell-envを使っている関係で、コマンドに「=」は使用できない(エスケープすれば使用できるが、警告が出る)ため、--cwd=<dir> の指定方法は使えません。
{
"functions": [
{
- "source": "functions/lib"
+ "source": "functions/isolate"
...
"predeploy": [
+ "bun run --cwd \"$RESOURCE_DIR/..\" typecheck",
+ "bun run --cwd \"$RESOURCE_DIR/..\" lint",
+ "bun run --cwd \"$RESOURCE_DIR/..\" build",
+ "bun run --cwd \"$RESOURCE_DIR/..\" isolate"
]
}
]
}
完了!
あとは、いつも通り firebase deploy --only functions を行うだけでデプロイできます。