Cloud Functions for Firebaseを構造化して、複数のファイルから複数の関数をデプロイするにはどうすればよいですか？

複数のCloud Functions for Firebaseを作成し、1つのプロジェクトからすべてを同時にデプロイしたいと考えています。また、各機能を個別のファイルに分けたいと思います。現在、次のようなindex.jsに両方を配置すると、複数の関数を作成できます。

exports.foo = functions.database.ref('/foo').onWrite(event => {
    ...
});

exports.bar = functions.database.ref('/bar').onWrite(event => {
    ...
});

しかし、fooとbarを別々のファイルに入れたいと思います。私はこれを試しました：

/functions
|--index.js (blank)
|--foo.js
|--bar.js
|--package.json

foo.jsは

exports.foo = functions.database.ref('/foo').onWrite(event => {
    ...
});

そしてbar.jsは

exports.bar = functions.database.ref('/bar').onWrite(event => {
    ...
});

すべての関数をindex.jsに配置せずにこれを実現する方法はありますか？

ああ、Cloud Functions for Firebaseは通常、ノードモジュールをロードするため、これは機能します

構造：

/functions
|--index.js
|--foo.js
|--bar.js
|--package.json

index.js：

const functions = require('firebase-functions');
const fooModule = require('./foo');
const barModule = require('./bar');

exports.foo = functions.database.ref('/foo').onWrite(fooModule.handler);
exports.bar = functions.database.ref('/bar').onWrite(barModule.handler);

foo.js：

exports.handler = (event) => {
    ...
};

bar.js：

exports.handler = (event) => {
    ...
};

@jasonsirotaの回答は非常に役に立ちました。しかし、特にHTTPでトリガーされる関数の場合は、より詳細なコードを確認すると役立つ場合があります。

@jasonsirotaの回答と同じ構造を使用して、2つの異なるファイルに2つの別々のHTTPトリガー関数を配置したいとします。

ディレクトリ構造：

    /functions
       |--index.js
       |--foo.js
       |--bar.js
       |--package.json`

index.js：

'use strict';
const fooFunction = require('./foo');
const barFunction = require('./bar');

// Note do below initialization tasks in index.js and
// NOT in child functions:
const functions = require('firebase-functions');
const admin = require('firebase-admin');
admin.initializeApp(functions.config().firebase); 
const database = admin.database();

// Pass database to child functions so they have access to it
exports.fooFunction = functions.https.onRequest((req, res) => {
    fooFunction.handler(req, res, database);
});
exports.barFunction = functions.https.onRequest((req, res) => {
    barFunction.handler(req, res, database);
});

foo.js：

 exports.handler = function(req, res, database) {
      // Use database to declare databaseRefs:
      usersRef = database.ref('users');
          ...
      res.send('foo ran successfully'); 
   }

bar.js：

exports.handler = function(req, res, database) {
  // Use database to declare databaseRefs:
  usersRef = database.ref('users');
      ...
  res.send('bar ran successfully'); 
}

更新：このドキュメントは役に立ちます。私の答えはこのドキュメントよりも古いものです。

これが私が個人的にtypescriptでそれをした方法です：

/functions
   |--src
      |--index.ts
      |--http-functions.ts
      |--main.js
      |--db.ts
   |--package.json
   |--tsconfig.json

これを機能させるために2つの警告を与えることによってこれを序文にさせてください：

2. index.tsでのインポート/エクスポートの問題の順序
3. dbは別のファイルでなければなりません

ポイント2の理由はわかりません。Secundoは、私のインデックス、メイン、データベースの構成を正確に尊重する必要があります（少なくとも試してみてください）。

index.ts：エクスポートを扱います。index.tsでエクスポートを処理する方がきれいだと思います。

// main must be before functions
export * from './main';
export * from "./http-functions";

main.ts：初期化を扱います。

import { config } from 'firebase-functions';
import { initializeApp } from 'firebase-admin';

initializeApp(config().firebase);
export * from "firebase-functions";

db.ts：dbを再エクスポートするだけなので、その名前はdatabase()

import { database } from "firebase-admin";

export const db = database();

http-functions.ts

// db must be imported like this
import { db } from './db';
// you can now import everything from index. 
import { https } from './index';  
// or (both work)
// import { https } from 'firebase-functions';

export let newComment = https.onRequest(createComment);

export async function createComment(req: any, res: any){
    db.ref('comments').push(req.body.comment);
    res.send(req.body.comment);
}

Cloud 8 / Firebase関数でNode 8 LTSが利用できるようになったことで、スプレッドオペレーターで次のことが可能になります。

/package.json

"engines": {
  "node": "8"
},

/index.js

const functions = require("firebase-functions");
const admin = require("firebase-admin");
admin.initializeApp();

module.exports = {
  ...require("./lib/foo.js"),
  // ...require("./lib/bar.js") // add as many as you like
};

/lib/foo.js

const functions = require("firebase-functions");
const admin = require("firebase-admin");

exports.fooHandler = functions.database
  .ref("/food/{id}")
  .onCreate((snap, context) => {
    let id = context.params["id"];

    return admin
      .database()
      .ref(`/bar/${id}`)
      .set(true);
  });

簡単にするために（ただし、作業は行います）、私はこのように自分のコードを個人的に構造化しました。

レイアウト

├── /src/                      
│   ├── index.ts               
│   ├── foo.ts           
│   ├── bar.ts
|   ├── db.ts           
└── package.json  

foo.ts

import * as functions from 'firebase-functions';
export const fooFunction = functions.database()......... {
    //do your function.
}

export const someOtherFunction = functions.database().......... {
    // do the thing.
}

bar.ts

import * as functions from 'firebase-functions';
export const barFunction = functions.database()......... {
    //do your function.
}

export const anotherFunction = functions.database().......... {
    // do the thing.
}

db.ts

import * as admin from 'firebase-admin';
import * as functions from 'firebase-functions';

export const firestore = admin.firestore();
export const realtimeDb = admin.database();

index.ts

import * as admin from 'firebase-admin';
import * as functions from 'firebase-functions';

admin.initializeApp(functions.config().firebase);
// above codes only needed if you use firebase admin

export * from './foo';
export * from './bar';

ネストされたレベルのディレクトリで機能します。ディレクトリ内のパターンにも従ってください。

@zaidfazilの回答へのクレジット

Babel / Flowの場合、次のようになります。

ディレクトリのレイアウト

.
├── /build/                     # Compiled output for Node.js 6.x
├── /src/                       # Application source files
│   ├── db.js                   # Cloud SQL client for Postgres
│   ├── index.js                # Main export(s)
│   ├── someFuncA.js            # Function A
│   ├── someFuncA.test.js       # Function A unit tests
│   ├── someFuncB.js            # Function B
│   ├── someFuncB.test.js       # Function B unit tests
│   └── store.js                # Firebase Firestore client
├── .babelrc                    # Babel configuration
├── firebase.json               # Firebase configuration
└── package.json                # List of project dependencies and NPM scripts

src/index.js -主な輸出品

export * from './someFuncA.js';
export * from './someFuncB.js';

src/db.js -Postgres用Cloud SQLクライアント

import { Pool } from 'pg';
import { config } from 'firebase-functions';

export default new Pool({
  max: 1,
  user: '<username>',
  database: '<database>',
  password: config().db.password,
  host: `/cloudsql/${process.env.GCP_PROJECT}:<region>:<instance>`,
});

src/store.js -Firebase Firestoreクライアント

import firebase from 'firebase-admin';
import { config } from 'firebase-functions';

firebase.initializeApp(config().firebase);

export default firebase.firestore();

src/someFuncA.js -機能A

import { https } from 'firebase-functions';
import db from './db';

export const someFuncA = https.onRequest(async (req, res) => {
  const { rows: regions } = await db.query(`
    SELECT * FROM regions WHERE country_code = $1
  `, ['US']);
  res.send(regions);
});

src/someFuncB.js -機能B

import { https } from 'firebase-functions';
import store from './store';

export const someFuncB = https.onRequest(async (req, res) => {
  const { docs: regions } = await store
    .collection('regions')
    .where('countryCode', '==', 'US')
    .get();
  res.send(regions);
});

.babelrc

{
  "presets": [["env", { "targets": { "node": "6.11" } }]],
}

firebase.json

{
  "functions": {
    "source": ".",
    "ignore": [
      "**/node_modules/**"
    ]
  }
}

package.json

{
  "name": "functions",
  "verson": "0.0.0",
  "private": true,
  "main": "build/index.js",
  "dependencies": {
    "firebase-admin": "^5.9.0",
    "firebase-functions": "^0.8.1",
    "pg": "^7.4.1"
  },
  "devDependencies": {
    "babel-cli": "^6.26.0",
    "babel-core": "^6.26.0",
    "babel-jest": "^22.2.2",
    "babel-preset-env": "^1.6.1",
    "jest": "^22.2.2"
  },
  "scripts": {
    "test": "jest --env=node",
    "predeploy": "rm -rf ./build && babel --out-dir ./build src",
    "deploy": "firebase deploy --only functions"
  }
}

$ yarn install                  # Install project dependencies
$ yarn test                     # Run unit tests
$ yarn deploy                   # Deploy to Firebase

bigcodenerd.orgアウトラインは、メソッドをさまざまなファイルに分割し、index.jsファイル内の1行にエクスポートするための、より単純なアーキテクチャパターンです。

このサンプルのプロジェクトのアーキテクチャは次のとおりです。

projectDirectory

• index.js
• podcast.js
• profile.js

index.js

const admin = require('firebase-admin');
const podcast = require('./podcast');
const profile = require('./profile');
admin.initializeApp();

exports.getPodcast = podcast.getPodcast();
exports.removeProfile = profile.removeProfile();

podcast.js

const functions = require('firebase-functions');

exports.getPodcast = () => functions.https.onCall(async (data, context) => {
      ...
      return { ... }
  });

プロファイルファイルのremoveProfileメソッドにも同じパターンが使用されます。

簡単にするために（ただし、作業は行います）、私はこのように自分のコードを個人的に構造化しました。

レイアウト

├── /src/                      
│   ├── index.ts               
│   ├── foo.ts           
│   ├── bar.ts           
└── package.json  

foo.ts

export const fooFunction = functions.database()......... {
    //do your function.
}

export const someOtherFunction = functions.database().......... {
    // do the thing.
}

bar.ts

export const barFunction = functions.database()......... {
    //do your function.
}

export const anotherFunction = functions.database().......... {
    // do the thing.
}

index.ts

import * as fooFunctions from './foo';
import * as barFunctions from './bar';

module.exports = {
    ...fooFunctions,
    ...barFunctions,
};

ネストされたレベルのディレクトリで機能します。ディレクトリ内のパターンにも従ってください。

この形式により、エントリポイントで追加の関数ファイルを検索し、各ファイル内の各関数を自動的にエクスポートできます。

メインエントリポイントスクリプト

functionsフォルダー内のすべての.jsファイルを検索し、各ファイルからエクスポートされた各関数をエクスポートします。

const fs = require('fs');
const path = require('path');

// Folder where all your individual Cloud Functions files are located.
const FUNCTIONS_FOLDER = './scFunctions';

fs.readdirSync(path.resolve(__dirname, FUNCTIONS_FOLDER)).forEach(file => { // list files in the folder.
  if(file.endsWith('.js')) {
    const fileBaseName = file.slice(0, -3); // Remove the '.js' extension
    const thisFunction = require(`${FUNCTIONS_FOLDER}/${fileBaseName}`);
    for(var i in thisFunction) {
        exports[i] = thisFunction[i];
    }
  }
});

1つのファイルからの複数の関数のエクスポートの例

const functions = require('firebase-functions');

const query = functions.https.onRequest((req, res) => {
    let query = req.query.q;

    res.send({
        "You Searched For": query
    });
});

const searchTest = functions.https.onRequest((req, res) => {
    res.send({
        "searchTest": "Hi There!"
    });
});

module.exports = {
    query,
    searchTest
}

httpアクセス可能なエンドポイントは適切に名前が付けられます

✔ functions: query: http://localhost:5001/PROJECT-NAME/us-central1/query
✔ functions: helloWorlds: http://localhost:5001/PROJECT-NAME/us-central1/helloWorlds
✔ functions: searchTest: http://localhost:5001/PROJECT-NAME/us-central1/searchTest

1つのファイル

いくつかの追加ファイル（例、1つだけ）がある場合は、以下を使用できます。

const your_functions = require('./path_to_your_functions');

for (var i in your_functions) {
  exports[i] = your_functions[i];
}

したがって、私はこのプロジェクトにバックグラウンド関数とhttp関数があります。単体テストのテストもあります。CI / CDは、クラウド機能をデプロイするときにあなたの人生をはるかに簡単にします

フォルダー構造

|-- package.json
|-- cloudbuild.yaml
|-- functions
    |-- index.js
    |-- background
    |   |-- onCreate
    |       |-- index.js
            |-- create.js
    |
    |-- http
    |   |-- stripe
    |       |-- index.js
    |       |-- payment.js
    |-- utils
        |-- firebaseHelpers.js
    |-- test
        |-- ...
    |-- package.json

注： utils/フォルダーは関数間でコードを共有するためのものです

functions / index.js

ここでは、必要なすべての関数をインポートして宣言することができます。ここにロジックは必要ありません。それは私の意見ではそれをよりきれいにします。

require('module-alias/register');
const functions = require('firebase-functions');

const onCreate = require('@background/onCreate');
const onDelete = require('@background/onDelete');
const onUpdate = require('@background/onUpdate');

const tours  = require('@http/tours');
const stripe = require('@http/stripe');

const docPath = 'tours/{tourId}';

module.exports.onCreate = functions.firestore.document(docPath).onCreate(onCreate);
module.exports.onDelete = functions.firestore.document(docPath).onDelete(onDelete);
module.exports.onUpdate = functions.firestore.document(docPath).onUpdate(onUpdate);

module.exports.tours  = functions.https.onRequest(tours);
module.exports.stripe = functions.https.onRequest(stripe);

CI / CD

リポジトリに変更をプッシュするたびに、継続的な統合と展開を行うのはどうですか？あなたはグーグルグーグルクラウドビルドを使用してそれを持つことができます。特定の時点まで無料です:)このリンクを確認してください。

./cloudbuild.yaml

steps:
  - name: "gcr.io/cloud-builders/npm"
    args: ["run", "install:functions"]
  - name: "gcr.io/cloud-builders/npm"
    args: ["test"]
  - name: "gcr.io/${PROJECT_ID}/firebase"
    args:
      [
        "deploy",
        "--only",
        "functions",
        "-P",
        "${PROJECT_ID}",
        "--token",
        "${_FIREBASE_TOKEN}"
      ]

substitutions:
    _FIREBASE_TOKEN: nothing

すべてのクラウド機能を長期的に整理するには、かなり良い方法があります。私は最近これをしました、そしてそれは完璧に働いています。

私がしたことは、トリガーのエンドポイントに基づいて、各クラウド機能を別々のフォルダーに整理することでした。すべてのクラウド関数のファイル名はで終わります*.f.js。あなたが持っていた場合たとえば、onCreateとonUpdate上のトリガuser/{userId}/document/{documentId}、その後は2つのファイルを作成onCreate.f.jsし、onUpdate.f.jsディレクトリにfunctions/user/document/し、あなたの関数という名前になりますuserDocumentOnCreateとuserDocumentOnUpdate、それぞれ。（1）

次に、ディレクトリ構造のサンプルを示します。

functions/
|----package.json
|----index.js
/----user/
|-------onCreate.f.js
|-------onWrite.f.js
/-------document/
|------------onCreate.f.js
|------------onUpdate.f.js
/----books/
|-------onCreate.f.js
|-------onUpdate.f.js
|-------onDelete.f.js

サンプル関数

const functions = require('firebase-functions');
const admin = require('firebase-admin');
const db = admin.database();
const documentsOnCreate = functions.database
    .ref('user/{userId}/document/{documentId}')
    .onCreate((snap, context) => {
        // your code goes here
    });
exports = module.exports = documentsOnCreate;

Index.js

const glob = require("glob");
const camelCase = require('camelcase');
const admin = require('firebase-admin');
const serviceAccount = require('./path/to/ServiceAccountKey.json');
try {
    admin.initializeApp({ credential: admin.credential.cert(serviceAccount),
    databaseURL: "Your database URL" });
} catch (e) {
    console.log(e);
}

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

（1）：任意の名前を使用できます。私にとって、onCreate.f.js、onUpdate.f.jsなどは、それらがどのようなトリガーであるかにもっと関連しているように見えます。

私はバニラJSブートローダーを使用して、使用したいすべての機能を自動インクルードしています。

├── /functions
│   ├── /test/
│   │   ├── testA.js
│   │   └── testB.js
│   ├── index.js
│   └── package.json

index.js（ブートローダー）

/**
 * The bootloader reads all directories (single level, NOT recursively)
 * to include all known functions.
 */
const functions = require('firebase-functions');
const fs = require('fs')
const path = require('path')

fs.readdirSync(process.cwd()).forEach(location => {
  if (!location.startsWith('.')) {
    location = path.resolve(location)

    if (fs.statSync(location).isDirectory() && path.dirname(location).toLowerCase() !== 'node_modules') {
      fs.readdirSync(location).forEach(filepath => {
        filepath = path.join(location, filepath)

        if (fs.statSync(filepath).isFile() && path.extname(filepath).toLowerCase() === '.js') {
          Object.assign(exports, require(filepath))
        }
      })
    }
  }
})

この例のindex.jsファイルは、ルート内のディレクトリのみを自動インクルードします。ディレクトリをウォークしたり、.gitignoreを尊重したりするために拡張できます。ただし、これで十分でした。

インデックスファイルを配置すると、新しい関数を追加するのは簡単です。

/test/testA.js

const functions = require('firebase-functions');

exports.helloWorld = functions.https.onRequest((request, response) => {
 response.send("Hello from Firebase!");
});

/test/testB.js

const functions = require('firebase-functions');

exports.helloWorld2 = functions.https.onRequest((request, response) => {
 response.send("Hello again, from Firebase!");
});

npm run serve 収量：

λ ~/Workspace/Ventures/Author.io/Firebase/functions/ npm run serve

> functions@ serve /Users/cbutler/Workspace/Ventures/Author.io/Firebase/functions
> firebase serve --only functions


=== Serving from '/Users/cbutler/Workspace/Ventures/Author.io/Firebase'...

i  functions: Preparing to emulate functions.
Warning: You're using Node.js v9.3.0 but Google Cloud Functions only supports v6.11.5.
✔  functions: helloWorld: http://localhost:5000/authorio-ecorventures/us-central1/helloWorld
✔  functions: helloWorld2: http://localhost:5000/authorio-ecorventures/us-central1/helloWorld2

このワークフローはほとんど「書き込みと実行」であり、新しい関数/ファイルが追加/変更/削除されるたびにindex.jsファイルを変更する必要はありません。

typescriptを使用してクラウド関数を作成する場合の簡単な答えは次のとおりです。

/functions
|--index.ts
|--foo.ts

上部にある通常のインポートのほとんどすべてから、すべての関数をエクスポートしfoo.tsます。

export * from './foo';

私は同じものを探すために多くの時間を費やしました、そしてそれを達成するための最良の方法であると私が思うものがあります（私はfirebase@7.3.0を使用しています）：

https://codeburst.io/organizing-your-firebase-cloud-functions-67dc17b3b0da

汗かいていない ;）