BREAKING: Rewrite functions:config:export command

[taeold]

Target the new defineJsonSecret API as migration target for functions.config() usage. The new API is a simpler migration target for existing functions.config() use cases.

Example flow:

$ firebase functions:config:export
i  This command retrieves your Runtime Config values (accessed via functions.config()) and exports them as a Secret Manager secret.

i  Fetching your existing functions.config() from danielylee-90... ✔  Fetched your existing functions.config().

i  Configuration to be exported:
⚠  This may contain sensitive data. Do not share this output.

{
   <CONFIG>
}

✔ What would you like to name the new secret for your configuration? RUNTIME_CONFIG

✔  Created new secret version projects/XXX/secrets/RUNTIME_CONFIG/versions/1

i  To complete the migration, update your code:

  // Before:
  const functions = require('firebase-functions');

  exports.myFunction = functions.https.onRequest((req, res) => {
    const apiKey = functions.config().service.key;
    // ...
  });

  // After:
  const functions = require('firebase-functions');
  const { defineJsonSecret } = require('firebase-functions/params');

  const config = defineJsonSecret("RUNTIME_CONFIG");

  exports.myFunction = functions
    .runWith({ secrets: [config] })  // Bind secret here
    .https.onRequest((req, res) => {
      const apiKey = config.value().service.key;
      // ...
    });

i  Note: defineJsonSecret requires firebase-functions v6.6.0 or later. Update your package.json if needed. i  Then deploy your functions:
  firebase deploy --only functions

[gemini-code-assist]

Summary of Changes

Hello @taeold, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a significant update to the functions:config:export command, transforming its functionality from local .env file generation to secure secret management via Google Cloud Secret Manager. The change aims to streamline the migration path for Firebase Functions users from the legacy functions.config() system to the more robust and integrated defineJsonSecret API, enhancing security and manageability of sensitive configurations.

Highlights

• Command Rewrite: The functions:config:export command has been completely rewritten to migrate existing functions.config() usage to the new defineJsonSecret API, leveraging Google Cloud Secret Manager for configuration storage.
• Secret Manager Integration: Instead of exporting runtime configuration to local .env files, the command now exports the configuration as a JSON secret directly to Google Cloud Secret Manager.
• Migration Guidance: The command provides interactive prompts to name the new secret and offers clear 'Before' and 'After' code examples to guide users on updating their Firebase Functions to consume the newly created JSON secret.
• Permission Updates: The command now requires additional permissions for Secret Manager operations (secretmanager.secrets.create, secretmanager.secrets.get, secretmanager.secrets.update, secretmanager.versions.add) in addition to existing runtime config permissions.
• Size Limit Enforcement: A check has been added to ensure the exported JSON configuration does not exceed the 64KB size limit for Secret Manager secrets, throwing an error if it does.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request is a great initiative to modernize the functions:config:export command by integrating with Secret Manager. The implementation looks solid, and the interactive prompts and migration guide are very helpful for users.

However, a significant concern is the removal of existing tests (src/functions/runtimeConfigExport.spec.ts) without the addition of new tests for the rewritten functionality. For a breaking change of this magnitude, comprehensive test coverage is crucial to ensure correctness, handle edge cases, and prevent future regressions. I strongly recommend adding unit and/or integration tests for the new command logic before merging.

[jhuleatt]

This is a really cool idea!

[jhuleatt]

maybe FUNCTIONS_DOT_CONFIG_EXPORT? too long?

[taeold]

trying out FUNCTIONS_CONFIG_EXPORT