Firebase Functions：如何在顶层正确初始化带参数配置的自定义类？

问题场景 #

想在云函数顶层用参数化配置初始化自定义类实例，使用defineString()、defineInt()等Firebase工具时，调用.value()会收到警告，提示应该直接使用Param对象而非调用.value()。当前代码如下：

import {defineString, projectID} from "firebase-functions/params";

const cloudTasksUtil = new CloudTasksUtil(
    defineString("TASKS_QUEUE_NAME").value(),
    defineString("MY_TASKS_LOCATION").value(),
    defineString("G_SERVICE_ACCOUNT_EMAIL").value(),
    projectID.value(),
);

运行firebase functions:shell时收到的警告：

✔  functions: 使用主机的node@18版本。
i  functions: 已从.env、.env.local加载环境变量。
{"severity":"WARNING","message":"params.TASKS_QUEUE_NAME.value()在函数部署期间被调用，而非运行时。"}
{"severity":"WARNING","message":"这通常是错误操作。在配置中，请直接使用Params，不要调用.value()。"}
{"severity":"WARNING","message":"示例：{ memory: memoryParam } 而非 { memory: memoryParam.value() }"}
{"severity":"WARNING","message":"params.MY_TASKS_LOCATION.value()在函数部署期间被调用，而非运行时。"}
{"severity":"WARNING","message":"这通常是错误操作。在配置中，请直接使用Params，不要调用.value()。"}
{"severity":"WARNING","message":"示例：{ memory: memoryParam } 而非 { memory: memoryParam.value() }"}
{"severity":"WARNING","message":"params.G_SERVICE_ACCOUNT_EMAIL.value()在函数部署期间被调用，而非运行时。"}
{"severity":"WARNING","message":"这通常是错误操作。在配置中，请直接使用Params，不要调用.value()。"}
{"severity":"WARNING","message":"示例：{ memory: memoryParam } 而非 { memory: memoryParam.value() }"}
{"severity":"WARNING","message":"params.PROJECT_ID.value()在函数部署期间被调用，而非运行时。"}
{"severity":"WARNING","message":"这通常是错误操作。在配置中，请直接使用Params，不要调用.value()。"}
{"severity":"WARNING","message":"示例：{ memory: memoryParam } 而非 { memory: memoryParam.value() }"}
i  functions: 已加载函数：helloWorld、reserveSeat、startTimer、countSeatChange
i  functions: 已连接到运行中的firestore模拟器（地址：127.0.0.1:8080），调用该服务会影响模拟器
i  functions: 已连接到运行中的database模拟器（地址：127.0.0.1:9000），调用该服务会影响模拟器
⚠  functions: 以下模拟器未运行，调用这些服务会影响生产环境：pubsub、storage、eventarc
firebase >

解决方案 #

方案1：修改自定义类，直接接收Param对象 #

不要在顶层调用.value()，直接把Param对象传给自定义类，在类内部需要使用实际值的地方再调用.value()。

修改后的顶层代码：

import {defineString, projectID} from "firebase-functions/params";

// 直接传递Param对象，不调用.value()
const cloudTasksUtil = new CloudTasksUtil(
    defineString("TASKS_QUEUE_NAME"),
    defineString("MY_TASKS_LOCATION"),
    defineString("G_SERVICE_ACCOUNT_EMAIL"),
    projectID,
);

修改CloudTasksUtil类的构造函数及内部逻辑：

class CloudTasksUtil {
  constructor(queueNameParam, locationParam, serviceAccountEmailParam, projectIdParam) {
    // 保存Param对象，而不是立即取值
    this.queueNameParam = queueNameParam;
    this.locationParam = locationParam;
    this.serviceAccountEmailParam = serviceAccountEmailParam;
    this.projectIdParam = projectIdParam;
  }

  // 在实际使用的方法中调用.value()获取当前值
  async createTask(taskData) {
    const queueName = this.queueNameParam.value();
    const location = this.locationParam.value();
    // 后续使用这些值执行任务逻辑...
  }
}

方案2：延迟类实例化到函数运行时内部 #

如果自定义类必须在初始化时就拿到实际的字符串/数值，无法接收Param对象，那就不要在顶层初始化实例，而是在每个云函数的内部创建实例：

import {defineString, projectID} from "firebase-functions/params";
import {onRequest} from "firebase-functions/v2/https";

// 只在顶层定义参数，不初始化类
const queueNameParam = defineString("TASKS_QUEUE_NAME");
const locationParam = defineString("MY_TASKS_LOCATION");
const serviceAccountEmailParam = defineString("G_SERVICE_ACCOUNT_EMAIL");

export const myFunction = onRequest(async (req, res) => {
  // 在函数运行时内部初始化类，此时调用.value()是安全的
  const cloudTasksUtil = new CloudTasksUtil(
    queueNameParam.value(),
    locationParam.value(),
    serviceAccountEmailParam.value(),
    projectID.value(),
  );
  
  // 使用实例执行操作
  await cloudTasksUtil.createTask(req.body);
  res.send("Task created");
});

关键原因 #

Firebase的Param对象设计为在部署阶段传递配置元数据，而.value()方法只能在函数运行时调用。顶层代码会在部署期间执行，此时调用.value()无法正确获取运行时的环境变量值，所以会触发警告。

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