typescript on firebase cloudfunctionsにおいて非同期処理内の処理結果を返却する良い方法を教えて頂きたいです

Question

前提・実現したいこと

firebase cloud functions上でtypescriptを用いて開発しています。
どちらも不慣れな為に下記処理をどう実装すれば分からず質問します。

cloud functions上でfirestoreを捜査し、documentを見つけたらupdateしてtrueを返す、見つからなかったら何もせずfalseを返す事を想定しています。しかしresult変数のスコープがfirestoreの捜査処理内に及ばない為に必ずfalseが返る状態です。

該当のソースコード

function updateByTime(): boolean {
    const targetTime = new Date()
    targetTime.setMinutes(targetTime.getMinutes() - 10)

    const refs = fireStore.collection('users')
        .where('createAt', '>=', targetTime)

    let result = false
    refs.get().then(docs => {
        docs.forEach(doc => {
            doc.ref.update({
                updateAt: admin.firestore.FieldValue.serverTimestamp()
            })
            result = true
        })
    }).catch(docs => {
        console.log(`update error [${docs}]`)
    })
    return result
}

試したこと

Promiseのユースケースなどを読んでいるのですが元々が同期脳すぎてイマイチ理解できず・・・ズバリ回答を頂けるのもありがたいですが、この辺りの知識を増やすための書籍なども教えて頂けたらとてもありがたいです！

Comments

[hoshi-takanori]

refs.get() は非同期処理なので、その結果を updateByTime から返すことはできません。
Promise（や async/await）は単に非同期処理を楽に書けるようにするためのツールに過ぎませんから、非同期処理そのものを理解していなければ Promise も理解できないと思います。
書籍はわかりませんが、とりあえずこの記事はいかがでしょうか？
https://engineer.recruit-lifestyle.co.jp/techblog/2019-12-13-node-async-io/

Answer 1

まず以下のようにすれば同期処理になるので期待通り動くか確認してもらってもよろしいですか。

async function updateByTime(): Promise<boolean> {
 // 中略
    let result = false
    await refs.get().then(docs => {
        docs.forEach(doc => {
            doc.ref.update({
                updateAt: admin.firestore.FieldValue.serverTimestamp()
            })
            result = true
        })
    }).catch(docs => {
        console.log(`update error [${docs}]`)
    })
    return result
}

async/awaitを使ってget()の処理が終わる（Promiseが返るのを待つ）まで待った後、次の行に進むようにしました。
javascriptでは処理が終わるのを待つ必要がある場合は明示的に指定する必要があります。実は今回使われているthenもgetの処理を待った後、戻り値が変数docsに入って次のupdate処理をしているのでここも明示的に同期処理しています。

知識としてはjavascript、async/await、Promise、非同期処理あたりのキーワードで探せば記事がたくさんあるので参考になるのは間違いないですが、動かしながら覚えるのが手っ取り早いとも思っています。