在 Firebase 中动态导出函数

Question

我遇到了云功能中冷启动时间的典型（根据许多帖子）问题。一个似乎承诺的解决方案建议只导入/导出实际正在执行的函数，如下所示：

https://github.com/firebase/functions-samples/issues/170#issuecomment-323375462

if (!process.env.FUNCTION_NAME || process.env.FUNCTION_NAME === 'sendFollowerNotification') {
  exports.sendFollowerNotification = require('./sendFollowerNotification');
}

这是一个 Javascript 示例，但我使用的是打字稿。我尝试了许多变体，虽然有一些构建，但最后我总是卡在我的函数没有被导出并部署警告我要删除现有函数。

这是众多尝试之一：

if (!process.env.FUNCTION_NAME || process.env.FUNCTION_NAME === 'generateInviteURL') {
  import ('./invite_functions').then ((mod) => { console.log ("mod follows" ); console.log (mod);  exports.generateInviteURL = functions.https.onRequest( mod.generateInviteURL ); } )
  .catch ((err) => {console.log ("Trying to import/export generateInviteURL ", err);}) ;
}

如上所述，在部署时发生的情况是我收到有关该功能被删除的警告。

我能够通过以下方式“避免”该消息：

console.log ("Function name: ", process.env.FUNCTION_NAME);

function dummy_generateInviteURL (req, res) { ; }
exports.generateInviteURL = functions.https.onRequest( dummy_generateInviteURL );

if (!process.env.FUNCTION_NAME || process.env.FUNCTION_NAME === 'generateInviteURL') {
console.log ("Doing the good import");
import ('./invite_functions').then ((mod) => { console.log ("mod follows" ); console.log (mod);  exports.generateInviteURL = functions.https.onRequest( mod.generateInviteURL ); } )
  .catch ((err) => {console.log ("Trying to import/export generateInviteURL ", err);}) ;
}

console.log ("Exported");
console.log (exports.generateInviteURL);

当然，空函数总是会被导出，但如果是被调用的函数，就会被真实的函数替换。

在这种情况下，日志如下所示：

generateInviteURL Function name:  generateInviteURL generateInviteURL  
generateInviteURL Exported generateInviteURL
{ [Function: cloudFunction] __trigger: { httpsTrigger: {} } }

所以第一部分看起来很有希望（定义了环境变量），然后导入做了一些事情（进入 then 块，从不捕获），但导出的变量没有被替换。

我不确定这是 TypeScript 问题、firebase 问题还是开发人员问题 - 可能我只是遗漏了一些明显的东西。

那么问题 - 我如何避免导入/导出每个特定功能不需要的任何东西？

Answer 1

您可以坚持使用原始 index.js，只需稍作改动。我已经尝试了几次并提出了解决方案。我包括一个示例目录结构和两个打字稿文件（index.ts 和另一个用于您的自定义函数）。有了这个，您将永远不必更改 index.ts 来修改或添加功能。

目录结构

+ functions
|
 -- + src
|   |
|    -- index.ts
|   |
|    -- + get
|       |
|        -- status.f.ts
 -- package.json (auto generated)
|
 -- package-lock.json (auto generated)
|
 -- tsconfig.json (auto generated)
|
 -- tslint.json (auto generated)
|
 -- + lib (auto generated)
|
 -- + node_modules (auto generated)

src/index.ts

import * as glob from "glob";
import * as camelCase from "camelcase";
const files = glob.sync('./**/*.f.js', { cwd: __dirname, ignore: './node_modules/**'});
for(let f=0,fl=files.length; f<fl; f++){
  const file = files[f];
  const functionName = camelCase(file.slice(0, -5).split('/').join('_')); // Strip off '.f.js'
  if (!process.env.FUNCTION_NAME || process.env.FUNCTION_NAME === functionName) {
    exports[functionName] = require(file);
  }
}

src/get/status.f.ts

import * as functions from 'firebase-functions';

exports = module.exports = functions.https.onRequest((req, res) => {
    res.status(200).json({'status':'OK'})
})

创建上述文件后，安装 npm 包 'glob' 和 'camelcase'， 然后尝试部署 firebase 功能

Firebase 将部署一个名为“getStatus”的函数

注意函数名是驼峰版的文件夹名和函数所在的文件名，所以你只能每个.f.ts文件导出一个函数

编辑

我已经更新了目录结构。请注意，index.ts 和所有后续文件和文件夹都位于父文件夹“src”中

Answer 2

我一直有类似的问题，我写了一个非常酷的解决方案，对我有用。

我决定将它作为一个开源包发布 - 我以前从未这样做过，所以如果有人可以查看、贡献或提供反馈，那就太好了。

包名为better-firebase-functions - https://www.npmjs.com/package/better-firebase-functions

您所要做的就是导入并运行它。两条线。几乎所有其他事情都是自动化的。

它将获取您目录中所有函数文件的默认导出并将它们部署为正确命名的函数。 这是一个例子：

import { exportFunctions } from 'better-firebase-functions';

exportFunctions({
   __filename,                         // standard node var (leave as is).
   exports,                            // standard node var (leave as is).
   functionDirectoryPath: './myFuncs', // define root functions folder
                                       // relative to this file.
   searchGlob: '**/*.js'               // file search glob pattern.
});

您唯一需要做的另一件事是将您的function.http.onRequest()... 导出为每个包含您要部署的云功能的文件的默认导出。所以：

export default functions.http.onRequest()...
/// OR
const func1 = functions.http.onRequest()...
export default func1;

就是这样！ 更新：已编辑答案以反映更新版本的软件包。