Firebase-tools: 関数のJSONファイルを受け入れる：config：set

@jpreynatに同意します。構成変数を設定するのを忘れた日がconfig：setをカスタムデプロイスクリプトに関連付けると、追加された機能を確認できます。
現在、設定に配管するなどの回避策はありますか？

プロジェクト間で構成を複製しようとしているようです。 firebase functions:config:cloneはあなたのために働きますか？

コンテキストを与えるために、ファイルベースの構成から意図的に離れました。これは、悪い習慣を助長すると考えているためです（つまり、ファイルをコードとともに保存された秘密でいっぱいに保ち、場合によってはソースリポジトリにチェックインすることさえあります）。

「必須」の構成変数を宣言するための何らかの方法（力学未定）についてどう思いますか？現在のプロジェクトで必要な構成なしでデプロイしようとすると、何かが変更される前にエラーが発生します。 それはあなたの主な懸念を解決しますか？ そうでない場合、なぜファイルが特に役立つのですか？

@mbleighそれはまさに私が望んでいたことを私が知らなかったものです。 良いアイデア！
おそらく「MechanicsTBD」によって与えられた/意味したことですが、他のすべてのようにgit / PRレビュープロセスを通過するように、リモートではなくプロジェクト内のいくつかのファイルでキー/構成構造を定義します。
@jpreynatハイジャックの問題でごめんなさい

@laurenzlongアドバイスをありがとうございますが、構成を複製しようとはしていません。
私たちの主な関心事は、展開段階に応じてさまざまなプロジェクト構成を更新することです。
つまり、基本的に、環境（dev、staging、prod）ごとに構成ファイルがあり、Firebase構成をそれぞれ設定します（PRの場合は、マスターとタグをプッシュします）。

@mbleigh情報をありがとう。
ただし、構成ファイルを使用する以外の方法でこれらすべての環境を保存する方法は正確にはわかりません。
現在、読みやすくするためにJSONとしてフォーマットされていますが、キーと値のペアとしてフォーマットして、 functions:config:setコマンドに直接渡すことを検討しています。
これはJSONファイルを渡すことほど安全ではないことに同意します。
ファイルを使用する以外のさまざまな段階で環境変数を保存する方法について、何か推奨事項はありますか？

@ahaverty心配ありません。ここで議論できることをうれしく思います。

@jpreynat functions:config:setを実行すると、現在のプロジェクトに保存されます。 firebase useを使用してプロジェクトを切り替える場合、構成は永続的です。 したがって、プロジェクトごとに1回setを実行すると、常にそこに表示されます。 これで「環境ごとに異なる構成」の問題が解決するはずなので、本当の問題を理解していないのではないでしょうか。

@jpreynatとりあえずこの号を閉じますが、マイケルと私があなたのリクエストを誤解した場合は、

@ laurenzlong @ mbleighこのスレッドですぐに回答できなかったことを
今のところ、この問題の回避策を見つけましたが、私の要求を明確にするためのコンテキストを次に示します。

Travisを使用してアプリをデプロイしています（これは、どのCIでも、ローカルでも優れていることに注意してください）。 ブランチとタグに応じてアプリをさまざまなステージにデプロイするため、環境に基づいてさまざまなJSONファイルを使用できると便利です。
たとえば、これにより、この条件に応じてfirebase config:set -f staging.jsonまたはfirebase config:set -f prod.jsonいずれかを実行できます。
回避策はノードモジュールとしてfirebaseを使用すること

ねえ@jpreynat私はまだあなたの答えに少し混乱しています。 設定を一度設定すると、firebase Functions：config ：unsetを実行して設定値を明示的に設定解除しない限り、デプロイ間でも常に設定が維持されます。 したがって、CIプロセスの一部としてこれを行う必要はありません。

誰かがこれを再開できますか？ ％） @ jpreynat @ mbleighそれは本当に欠けているものの1つです。 Atm私は15近くの構成変数（そしてもっと来る）を持っています、そしてそれはfunctions:config:setが何らかの方法でJSONを受け入れることができれば非常に便利です。

「「必須」の構成変数を宣言する-そして、現在のプロジェクトで必要な構成なしでデプロイしようとすると、何かが変更される前にエラーが発生する」という@mbleighの提案に賛成票を投じました。
私たちにとっても問題点になりますが、それは私たちのすべての問題を解決し、バージョン管理/レビュープロセスにうまく適合します👍

https://medium.com/@AllanHasegawa/setting -config-for-firebase-cloud-functions-with-json-136f455e7c69

ちょっと@yaronyosefFirebaseのfunctions：config ：setコマンドにJSONを直接提供できます。プラットフォームに適した方法でフォーマットする必要があるだけです。 Linuxの場合、以下が機能するはずです。

firebase functions:config:set foo='{"bar":"something","faz":"other"}'

共有していただきありがとうございます！ @laurenzlong
ファイルからインポートしたかったので、このようなコマンドを使用しました。

firebase functions:config:set service_account="$(cat service-account.json)"

Firebase Admin SDKのユーザー管理APIを使用したかったので、サービスアカウントのjsonファイルをFirebase CloudFunctionsにインポートしました。

クールなユースケース！ 共有してくれてありがとう！

また、Gitを介して非シークレット構成を追跡することをお勧めします。この場合、コミットされたJSONランタイム構成ファイル（複数の環境用）が信頼でき、CI環境は特定の環境に対応するファイルからfunctions:config:setを適用します（および各環境は個別のFirebaseプロジェクトに対応しています）。

構成をgitに保持している場合、それらを関数ランタイムに読み込むのは簡単です。 それらをconfigs/<project_id>.json置くだけで、次のようになります。

let config = {};
try {
  config = require(`./configs/${process.env.GCLOUD_PROJECT}.json`);
} catch (e) {
  console.log('No config found for project', process.env.GCLOUD_PROJECT);
}

Firebaseで使用されるランタイム設定は、設定がgitにチェックインされないように特別に設計されています。これは、（特にシークレットの場合）解決するよりも多くの問題を引き起こすパターンであることがわかったためです。

それは本当ですが、その場合、この目的のためにConfigAPIをまったく使用しなくなります。 機密性の高い値を保存するためにConfigAPIを実行し（Firebaseドキュメントに基づくと、適切なユースケースのようです）、ソース制御値と追跡されていない値の両方をまったく同じ方法で（つまり、 config()介して）ロードすることが有益な場合がありますfirebase-functionsによって提供されます）。

とりあえず、次のワンライナーを使用して、 .runtimeconfig全体をfunctions:config:setにフィードします。

firebase functions:config:set $(jq -r 'to_entries[] | [.key, (.value | tojson)] | join("=")' < .runtimeconfig/${FIREBASE_ENV}.json)

ここで、 FIREBASE_ENVは、デプロイメントで使用される環境の名前です（例： dev ）。 これをさらに短縮できると便利です。

firebase functions:config:set -f .runtimeconfig/${FIREBASE_ENV}.json

ただし、最終的には、Config APIですべての変更の使いやすい監査証跡が有効になっている場合は、それは必要ない場合があります（すでに当てはまる場合は、修正してください。調査したいと思います）。

では、これはどのように起こっているのでしょうか？ 😄

@mbleighの提案がまだ実装されているのを見たいです！ 開発者以外のターゲットに設定を設定するのを忘れるという問題が常に発生しています

スレッドバンプをありがとう。 まだ報告することはありませんが、計画会議でこれを再度取り上げて、進展が見られるかどうかを確認します。

JSONスキーマファイルを使用して構成を検証し、期待するすべての値が含まれていることを確認します。 この検証は私のCIパイプラインの一部であり、失敗した場合の展開を防ぎます。 私のようにTypeScriptを使用して関数を作成する場合は、型からJSONスキーマを生成できます。

関数configは文字列のみを受け入れるという制限があるため、スキーマはconfig値が数値であることを検証できません。 ブール値の場合、有効な値として"true"と"false"のみの列挙型を使用できるため、問題ありません。

私のCircleCI設定とこのブログ投稿を参照してください。

@hgwood共有してくれてありがとう！ これは間違いなくCIにも追加します。

この「問題」に対する私の解決策と、議論についての私の考えを残したかっただけです。

1. シークレット/機密値をリポジトリに保存してはならないことを理解しています。 私の解決策は、非秘密の値のみです。 シークレット値は手動で設定されますが、必要に応じて構成値をマークする方法は、これらのシークレット値にとって素晴らしいことです。
2. これは、一部の人が考えているよりも重要だと思います。 さまざまな展開環境プロジェクトの個々の構成値を手動で設定する必要があり、それらを同時に簡単に表示/比較できないのはPITAです。 ファイルで構成を定義すると、プロセスの手間が大幅に軽減されます。
3. 関数構成エディターをWebコンソールに追加すると、これが大幅に改善されると思いますが、複数のプロジェクトの構成を同時に表示する方法があれば、さまざまなデプロイメント環境の構成を簡単に比較できると便利です。
4. Firebaseでは、単一のプロジェクト内で環境を定義できるようにする必要があるため、デプロイ環境として使用するために複数のプロジェクトを使用する必要はありません。 これが存在する場合、単一のプロジェクト内の複数の環境の構成を同時に表示することは非常に簡単です。
5. 私の解決策にはおそらく問題があり、コードを逐語的に信頼しないでください、しかし私は一般的な概念が好きです。

私の解決策

カスケードyaml構成ファイルを使用します。これは、デフォルト値と、デプロイメント環境に関係なくすべての構成に適用される値に役立ちます。

./config/default.yml

app:
  name: My App
featureFlags:
  someFeature:
    enabled: false

./config/dev.yml （他のデプロイメント環境用の同様の構成ファイル）

imports:
  - {resource: default.yml}
app:
  environmentName: Development
services:
  someOtherService:
    baseUrl: https://dev.someotherservice.com/api
featureFlags:
  someFeature:
    enabled: true

次に、解決された構成をロードし、key = valペアのスペース区切りのリストを返す小さなノードスクリプトを作成しました

yaml_to_keyval.ts

import * as configYaml from "config-yaml"
import * as flat from "flat"


const yamlFile = process.argv[2]
const config = configYaml(yamlFile)
const flatConfig = flat(config)

const key_val_list = Object.keys(flatConfig).map(function(key){
    return `${key}=${flatConfig[key]}`
})

console.log(key_val_list.join(' '))

CIのデプロイ中に、このbashシェルスクリプトを使用してkey = valペアを取得し、 functions：config ：setで設定し

# env is set to the desired deployment environment (eg "dev"), which is passed as an argument to the CI script command
config_in="$(readlink -f ./config/$env.yml)"
key_vals="$(ts-node ./scripts/node/yaml_to_keyval.ts $config_in)"
firebase functions:config:set $key_vals

@kanemotos catソリューションが好きですが、証明書ファイルをアップロードしようとしたときにPrecondition check failedエラーが発生しませんでしたか？

これらの理由により、DeploymentManagerを使用することになりました。

DMの「configYaml」を使用してすべての構成を設定します。 次に、DMは適切なランタイム構成と変数を作成し、 firebase deployは、 firebase config:setをまったく使用せずに、デプロイ時にそれらの値を取得して設定します。 これにより、他のリソース（バケットとそのアクセス制御など）をセットアップし、テンプレートの外部に提供しなくても、RCでそれらの値を設定することもできます。 さらに、これにより、 camelCase名と変数名を使用できます。

DMは値を安全に暗号化できないため、外部で値を設定するのは、ランタイム構成を介して（暗号化された）サービスアカウントキーを渡す必要がある場合のみです。 ただし、前者はKMSからのstdoutを受け入れるため、 firebase config:setではなくgcloud beta runtime-config configs variables setを使用します（DM展開後およびfirebase deploy ）。

追加したかったのですが、これを読むと、混乱を招く重要なポイントを見逃している人がいるようです。 これがドキュメンテーションでも明らかにされていれば、それは本当に役に立ちます。

基本的に、 functions.config()は_deployments_の間で存続しますが、異なるFirebaseプロジェクト間で個別に設定することもできます。

つまり、開発環境、ステージング環境、本番環境では、（マルチサイトホスティングを使用したり、同じプロジェクトにデプロイしたりするのではなく）複数の同一のFirebaseプロジェクトを設定する必要があります。 。

エイリアスを設定したら（またはfirebase useプロジェクトを切り替えたら）、同じリポジトリを複数の個別のFirebaseプロジェクトにデプロイできます。 これは、開発環境、ステージング、本番環境を個別のFirebaseプロジェクトとして設定する方法です。

次に、次のように、それぞれに個別の環境構成を設定できます。
firebase -P dev config:set -開発環境の変数を設定します
firebase -P prod config:set -本番環境の変数を設定します...

次に、次のように、同じリポジトリを2回デプロイできます。
firebase deploy -P dev
firebase deploy -P prod
また、両方ともそれぞれのFirebaseプロジェクトにデプロイされ、デプロイ間で保持される独自の個別の環境構成が含まれます。

うん、それが僕たちのやり方でもある。 dev / test / prod用の個別のプロジェクト。

どのプラットフォーム（Windows、MacOS、Linux）で開発するかに関して機能する私のバニラJSソリューションを共有するだけです：

dev / test / prodに別々のプロジェクトを使用する。

/.firebaserc

{
  "projects": {
    "dev": "my-project-name-dev",
    "test": "my-project-name-test",
    "prod": "my-project-name-prod"
  }
}

設定ファイル

/functions/configフォルダー内のJSONファイル：

/functions/config/config.dev.json 
/functions/config/config.test.json 
/functions/config/config.prod.json 
/functions/config/config.SAMPLE.json <-- only file tracked in git

Example content:
{
    "google": {
        "key": "my-api-key",
        "storage_bucket": "firebase-storage-bucket"
    },
    "another_vendor": {
        "my_prop": "my value"
    },
    ...
}

/functions/set-config.js

const fs = require('fs');
const env = process.argv[2];

const configPath = `./config/config.${env}.json`;

if (!(configPath && fs.existsSync(configPath))) {
    return;
}

const collectConfigLines = (o, propPath, configLines) => {
    propPath = propPath || '';
    configLines = configLines || [];
    for (const key of Object.keys(o)) {
        const newPropPath = propPath + key;
        if (typeof o[key] === 'object') {
            collectConfigLines(o[key], newPropPath + '.', configLines);
        } else if (o[key] != null && o[key] !== '') {
            configLines.push(`${newPropPath}=${JSON.stringify(o[key])}`);
        }
    }
}

const config = require(configPath);
const configLines = [];
collectConfigLines(config, '', configLines);

const cp = require('child_process');
cp.execSync(`firebase -P ${env} functions:config:set ${configLines.join(' ')}`);

/functions/package.json

...
"scripts": {
    "config:set:dev": "node set-config dev",
    "config:set:test": "node set-config test",
    "config:set:prod": "node set-config prod",
    ...
},
...

誰かがまだ探しているなら、この中程度の記事https://medium.com/indielayer/deploying-environment-variables-with-firebase-cloud-functions-680779413484で使用されている方法があり

私が個人的に欠けているのは、デプロイを行わずに構成変数を設定する機能です。 さまざまな環境にデプロイするCICDパイプラインがあり、開発者がコードをローカルでビルドして、特に本番環境にデプロイすることは望ましくありません。 それが物事が壊れる方法です。

また、いくつかの機能が開発されている状態で既存の変数を後で変更したい場合は、現在、最後にリリースされたタグをチェックアウトし、ビルドし、デプロイし、機能ブランチにチェックアウトして続行します。 それは本当にこれを使用不可能にします。

基本的に、クラウド機能のリモート構成が必要になります

@bezysoftware （環境構成の代わりに）環境変数を使用する必要があると思います。https：//cloud.google.com/functions/docs/env-を確認してください。 var

共有していただきありがとうございます！ @laurenzlong
ファイルからインポートしたかったので、このようなコマンドを使用しました。

firebase functions:config:set service_account="$(cat service-account.json)"

Firebase Admin SDKのユーザー管理APIを使用したかったので、サービスアカウントのjsonファイルをFirebase CloudFunctionsにインポートしました。

うまくいきませんでした

@ Md-アブドゥル-ハリム-ラフィ

Firebase Functions：config ：set service_account = "$（cat service-account.json）"

私のために働いた、私はfirebase functions:config:get設定変数を見ることができます。
プロジェクトフォルダになく、設定変数を設定するFirebaseプロジェクトを選択しなかったため、最初は機能しませんでした。Firebaseプロジェクトを選択するには、 firebase use --addを使用します。CLIでプロンプトが表示されます。 Firebaseコンソール上のプロジェクトのリスト（CLIにfirebase loginログインしていると仮定）

@dnhyde

Firebase Functions：config ：set service_account = "$（cat service-account.json）"

jsonファイルで文字列以外の他の値タイプ（ブール値や数値など）を使用している間は、これは機能しないようです。

{
   "test": {
        "hmm": true
    }
}

失敗する：

Error: HTTP Error: 400, Invalid value at 'variable.text' (TYPE_STRING), true

私には次のことができるはずだと私には合理的に思えます。

firebase functions:config:get > config.json

そして後で：

firebase functions:config:set < config.json

これらの2つのコマンドを補完することは理にかなっています。

ファイルに構成を含めることで、バージョン管理を行い、時間の経過とともにどのように変化したかを確認できます。

残念ながら、これを今すぐ達成しなければならない唯一の方法（ env=$(cat config.json) ）でも、config.jsonを実際の値にする能力が損なわれます。これは、 { env: ... }ラップできないためです。

私自身への注意：これは、機能のプルリクエストを開始する必要がある場所です： https ：

どのプラットフォーム（Windows、MacOS、Linux）で開発するかに関して機能する私のバニラJSソリューションを共有するだけです：

dev / test / prodに別々のプロジェクトを使用する。

/.firebaserc

{
  "projects": {
    "dev": "my-project-name-dev",
    "test": "my-project-name-test",
    "prod": "my-project-name-prod"
  }
}

設定ファイル

/functions/configフォルダー内のJSONファイル：

/functions/config/config.dev.json 
/functions/config/config.test.json 
/functions/config/config.prod.json 
/functions/config/config.SAMPLE.json <-- only file tracked in git

Example content:
{
    "google": {
        "key": "my-api-key",
        "storage_bucket": "firebase-storage-bucket"
    },
    "another_vendor": {
        "my_prop": "my value"
    },
    ...
}

/functions/set-config.js

const fs = require('fs');
const env = process.argv[2];

const configPath = `./config/config.${env}.json`;

if (!(configPath && fs.existsSync(configPath))) {
    return;
}

const collectConfigLines = (o, propPath, configLines) => {
    propPath = propPath || '';
    configLines = configLines || [];
    for (const key of Object.keys(o)) {
        const newPropPath = propPath + key;
        if (typeof o[key] === 'object') {
            collectConfigLines(o[key], newPropPath + '.', configLines);
        } else if (o[key] != null && o[key] !== '') {
            configLines.push(`${newPropPath}=${JSON.stringify(o[key])}`);
        }
    }
}

const config = require(configPath);
const configLines = [];
collectConfigLines(config, '', configLines);

const cp = require('child_process');
cp.execSync(`firebase -P ${env} functions:config:set ${configLines.join(' ')}`);

/functions/package.json

...
"scripts": {
    "config:set:dev": "node set-config dev",
    "config:set:test": "node set-config test",
    "config:set:prod": "node set-config prod",
    ...
},
...

どのプラットフォーム（Windows、MacOS、Linux）で開発するかに関して機能する私のバニラJSソリューションを共有するだけです：

dev / test / prodに別々のプロジェクトを使用する。

/.firebaserc

{
  "projects": {
    "dev": "my-project-name-dev",
    "test": "my-project-name-test",
    "prod": "my-project-name-prod"
  }
}

設定ファイル

/functions/configフォルダー内のJSONファイル：

/functions/config/config.dev.json 
/functions/config/config.test.json 
/functions/config/config.prod.json 
/functions/config/config.SAMPLE.json <-- only file tracked in git

Example content:
{
    "google": {
        "key": "my-api-key",
        "storage_bucket": "firebase-storage-bucket"
    },
    "another_vendor": {
        "my_prop": "my value"
    },
    ...
}

/functions/set-config.js

const fs = require('fs');
const env = process.argv[2];

const configPath = `./config/config.${env}.json`;

if (!(configPath && fs.existsSync(configPath))) {
    return;
}

const collectConfigLines = (o, propPath, configLines) => {
    propPath = propPath || '';
    configLines = configLines || [];
    for (const key of Object.keys(o)) {
        const newPropPath = propPath + key;
        if (typeof o[key] === 'object') {
            collectConfigLines(o[key], newPropPath + '.', configLines);
        } else if (o[key] != null && o[key] !== '') {
            configLines.push(`${newPropPath}=${JSON.stringify(o[key])}`);
        }
    }
}

const config = require(configPath);
const configLines = [];
collectConfigLines(config, '', configLines);

const cp = require('child_process');
cp.execSync(`firebase -P ${env} functions:config:set ${configLines.join(' ')}`);

/functions/package.json

...
"scripts": {
    "config:set:dev": "node set-config dev",
    "config:set:test": "node set-config test",
    "config:set:prod": "node set-config prod",
    ...
},
...

申し訳ありませんが、スクリプト「 config：set ：dev」