Firebase第二代函数基于参数化配置的条件部署问题

问题背景 #

第一代Firebase Functions中，我们可以通过functions.config()在顶层判断环境，仅导出生产环境需要的函数，以此控制部署范围：

const functions = require('firebase-functions')

exports.onlyUseThisInProduction = functions.config().someValue === 'production' &&
 functions.pubsub
    .schedule('* * * * *')
    // ... 函数逻辑

但切换到第二代函数并使用官方参数化配置后，调整后的代码无法正常部署目标函数onlyUseThisInProduction，其他函数不受影响：

const { defineString } = require('firebase-functions/params')
const { onSchedule } = require('firebase-functions/v2/scheduler')
const someValue = defineString('SOME_VALUE').value()

exports.onlyUseThisInProduction = someValue === 'production' && onSchedule({ schedule: '* * * * *' }, () => {
  // ... 函数逻辑
})

我们需要通过代码逻辑自动跳过非目标环境的函数部署，而非通过CLI指定部署的函数。

原因分析 #

第二代Firebase Functions的参数化配置中，defineString().value()在部署阶段（Firebase CLI扫描代码时）无法获取云端的实际环境变量值：

• 本地执行代码时，若未配置对应环境变量，someValue会返回undefined或参数默认值，导致someValue === 'production'判断为false
• 此时exports.onlyUseThisInProduction的值为false，并非有效的函数定义对象，Firebase CLI会忽略该导出项，因此无论环境如何，函数都不会被部署

解决方案 #

通过条件导出函数的方式，结合process.env读取环境变量（第二代函数会将参数化配置的变量注入到process.env中），实现仅在目标环境导出函数：

代码示例 #

const { onSchedule } = require('firebase-functions/v2/scheduler')

// 直接读取环境变量判断当前环境
const isProduction = process.env.SOME_VALUE === 'production'

// 仅在生产环境下导出该函数
if (isProduction) {
  exports.onlyUseThisInProduction = onSchedule({ schedule: '* * * * *' }, (event) => {
    // 函数业务逻辑
    console.log('Running production-only scheduled function')
  })
}

配置说明 #

• 本地开发/部署时，可通过项目根目录的.env文件设置环境变量：

  SOME_VALUE=production
  

• 云端部署时，可通过Firebase控制台的函数配置页面设置SOME_VALUE变量，或使用CLI命令配置：

  firebase functions:config:set some_value=production
  

这种方式通过顶层条件判断控制函数是否导出，Firebase CLI只会识别有效的函数定义对象，从而实现自动跳过非目标环境的函数部署。

内容的提问来源于stack exchange，提问作者chevin99