在Firebase中动态导出功能

时间:2018-10-23 23:42:18

标签: node.js typescript firebase google-cloud-functions firebase-cli

我在云功能中遇到典型的(根据许多帖子)冷启动时间问题。似乎已承诺的解决方案建议仅导入/导出实际执行的功能,如此处所示:

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示例,但我使用的是Typescript。我尝试了多种变体,虽然进行了一些构建,但最终我始终无法导出函数,并部署了警告我要删除现有函数。

这是众多尝试之一:

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问题还是开发人员问题-可能我只是缺少明显的东西。

问题是-如何避免导入/导出每个特定功能不需要的东西?

2 个答案:

答案 0 :(得分:2)

您可以坚持原始的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文件只能导出一个函数< / strong>

编辑

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

答案 1 :(得分:0)

我遇到过类似的问题,并且我写了一个很酷的解决方案,对我有用。

我决定将其作为一个开源软件包发布-我从来没有做过这样的事情,因此,如果有人可以检查,贡献或提供反馈,那就太好了。

该程序包称为better-firebase-functions-https://www.npmjs.com/package/better-firebase-functions

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

它将选择目录中所有功能文件的默认导出,并将它们部署为正确命名的功能。 这是一个示例:

import exportCloudFunctions from 'better-firebase-functions';

exportCloudFunctions(
   __dirname,            // standard node var (leave as is)
   __filename,           // standard node var (leave as is)
   exports,              // standard node var (leave as is)
   './myFuncs',          /// define root funcs folder relative to this file (index.js)
   './**/*.cloudFunction.js' .   /// define glob pattern to choose files
);

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

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

就是这样!