Cloud Functions for Firebase の関数をスケジューラから定期的に呼び出す #TypeScript

Firebase、、イイですね。。とくに Cloud Functions for Firebase とてもよいです。AWS Lambdaにくらべてシンプルですし。。

さて今回は、Firebaseに登録した関数を定期的に呼び出してみます。
FirebaseとGoogle Cloud Platform をさわれる環境を構築するで作った環境をつかって、Cloud Functions for Firebaseに登録した関数を、Cloud Scheduler ~~ベータ版~~ というGCPのスケジューラから定期的に呼び出してみます。

--2019/09/21追記--
今日時点、もうスケジューラはベータ版ではなく正式版のようで、以下の記事から「ベータ」の記述を削除しました。コマンドのbetaをとったくらいで、基本は同じです。
--2019/09/21追記以上--

Cloud Functions for Firebase を呼び出すには Cloud Functions for Firebase でジョブをスケジューリング（cron）するにある「App EngineのCron機能を使う」ってBest Practice?があるみたいなのですが、今回はCloud Scheduler ってのでやります。

具体的には「testTopic」というGCP上のTopicへのPublishに反応する関数を作成し、そこで実行したいロジックを呼び出します。そして、Cloud SchedulerからそのTopicへのPublishを定期的に行うことで、関数の定期実行を実現します。

環境

FirebaseとGoogle Cloud Platform をさわれる環境を構築するで環境を作るとこんな感じになってるとおもいます。

$ tree -a
.
├── .firebaserc
├── .gitignore
├── README.md
├── firebase.json
└── functions
    ├── .eslintrc.json
    ├── .gitignore
    ├── package.json
    ├── src
    │   └── index.ts
    └── tsconfig.json

もしくはGithubにコードをあげてあるので、そちらからコード取得してください。環境構築は以下の通り:

$ git clone --branch pub_sub_trigger https://github.com/masatomix/fb_function_samples.git
$ cd fb_function_samples/functions/
$ npm install
$ cd ../

やってみる

呼び出したい関数を作成してデプロイする

まずは実行したいロジックを作成します。

src/logic.ts

export function want_to_execute() {
  console.log('実行したいロジック!')
}

つづいて index.tsにPub/Subトリガーの関数を定義して、そこで上記ロジックを呼び出します。

src/index.ts

import * as functions from 'firebase-functions'

// // Start writing Firebase Functions
// // https://firebase.google.com/docs/functions/typescript
//
// export const helloWorld = functions.https.onRequest((request, response) => {
//  response.send("Hello from Firebase!");
// });

import * as logic from './logic'

export const helloPubSub = functions.pubsub
  .topic('testTopic').onPublish(message => {
    logic.want_to_execute()
  })

いつものコマンドでFirebaseへ関数をデプロイします。

$ firebase deploy --only functions

✔  functions: functions folder uploaded successfully
i  functions: updating Node.js 8 function helloPubSub(us-central1)...
✔  functions[helloPubSub(us-central1)]: Successful update operation.

✔  Deploy complete!
Please note that it can take up to 30 seconds for your updated functions to propagate.

スケジューラを設定する

つづいてスケジューラにスケジュールを登録します。もちろん画面からも登録できるのですが、今回はコマンドラインからやってみましょう。。
あ、そのまえにgcloudコマンドが、Firebaseで使用しているのと同じプロジェクトに向いているかを確認します。

$ gcloud config list
[core]
account = xx@ki-no.org
disable_usage_reporting = False
project = xxxxx-xxxxxxx  '←ココとか'

Your active configuration is: [default]
$

向いてない場合は、Cloud SDK の初期化などを参考に設定を行ってください。

gcloud scheduler jobs create pubsub を参考にコマンドを打ってみます。

$ gcloud scheduler jobs list
ID         LOCATION     SCHEDULE (TZ)           TARGET_TYPE  STATE
test       us-central1  * * * * * (Asia/Tokyo)  HTTP         ENABLED  <- 前に追加していたヤツ 
topicTest  us-central1  * * * * * (Asia/Tokyo)  Pub/Sub      ENABLED  <- 前に追加していたヤツ 
$


$ gcloud scheduler jobs create pubsub testJob \
  --topic testTopic \
  --message-body='test' \
  --schedule '* * * * *' \
  --time-zone='Asia/Tokyo'

name: projects/xxxxx-xxxxxxx/locations/us-central1/jobs/testJob
pubsubTarget:
  data: dGVzdA==
  topicName: projects/xxxxx-xxxxxxx/topics/testTopic
retryConfig:
  maxBackoffDuration: 3600s
  maxDoublings: 16
  maxRetryDuration: 0s
  minBackoffDuration: 5s
schedule: '* * * * *'
state: ENABLED
timeZone: Asia/Tokyo
userUpdateTime: '2019-02-03T15:55:14Z'


$ gcloud scheduler jobs list
ID         LOCATION     SCHEDULE (TZ)           TARGET_TYPE  STATE
test       us-central1  * * * * * (Asia/Tokyo)  HTTP         ENABLED
topicTest  us-central1  * * * * * (Asia/Tokyo)  Pub/Sub      ENABLED
testJob    us-central1  * * * * * (Asia/Tokyo)  Pub/Sub      ENABLED ←追加された!
$