Unable to pass parameterized config value to functions.storage.bucket(<param>).object().onFinalize

[indicava]

Related issues

[REQUIRED] Version info

node: v16.19.1

firebase-functions: 4.4.0

firebase-tools: 12.3.0

firebase-admin: 11.9.0

[REQUIRED] Test case

create an .env file with these contents:

DEFAULT_STORAGEBUCKET=img.mydomain.com

Then create an index.js file with this function definition:

import functions from "firebase-functions"
import { defineString } from "firebase-functions/params"
const defaultBucket = defineString("DEFAULT_STORAGEBUCKET")

export const resizeImages = functions.storage.bucket(defaultBucket).object().onFinalize(async (object) => {
functions.logger.info(`defaultBucket.value() = ${defaultBucket.value()}`)
})

[REQUIRED] Steps to reproduce

run "firebase emulators:start" or "firebase deploy"

[REQUIRED] Expected behavior

Expected behavior is Storage triggered cloud function for the bucket named "img.mydomain.com"

[REQUIRED] Actual behavior

Actual behavior is I am getting this error message:

functions: Failed to load function definition from source: FirebaseError: Failed to load function definition from source: Failed to generate manifest from function source: Error: Invalid bucket name params.DEFAULT_STORAGEBUCKET

Were you able to successfully deploy your functions?

No I was unable to deploy

[taeold]

Hi @indicava. Thanks for raising the issue.

We don't support parametrizing storage buckets using params yet. Params only work on configuration options like timeouts and memory for now. Sorry for the confusion!

[indicava]

Hi @indicava. Thanks for raising the issue.

We don't support parametrizing storage buckets using params yet. Params only work on configuration options like timeouts and memory for now. Sorry for the confusion!

Thanks for the update.

So do you have any suggestion on how to approach this issue when I am managing several environments with different bucket names using the same codebase?

[zallesov]

Came across the same problem.
I do not see a solution here. How could I subscribe to different buckets for dev and prd environments? There seem to be no way to provide deployment time params?

[raf-a]

Hi
I encountered the same problem. I found a solution using the environment variable process.env.GCLOUD_PROJECT.

[indicava]

Hi

I encountered the same problem. I found a solution using the environment variable process.env.GCLOUD_PROJECT.

Hi,

Could you elaborate a little more on how you use that environment variable to parameterize bucket names?

Maybe post/link some sample code?

Thanks!

[markglibres]

@taeold any update on this feature?

[amankr]

I am also looking for this feature. It seems very important for managing buckets in multiple environment.
currently I have to change names manually while deploying to different environments, which is very inconvenient.
I hope this is picked up soon .
issue also mentioned here -> #1369

[nickesk]

This is a bug IMO. We cannot use firebase function params as the documentation instructs us to if these basic top-level methods don't work with Params, and there is no published workaround. Will the Firebase team please prioritize this?

[otri]

Still biting developers in the butt. Good grief. Please update your documentation.

[Padreco-lbr]

Have you provided any solution so far? Hard coding the target buckets is a terrible approach when dealing with multiple projects.

[Padreco-lbr]

Here goes a workaround while Google doesn't come up with something.
The project id's provided by process.env.GCLOUD_PROJECT are the same from your firebase projects.

src/environment.ts:

export const setupEnvironmentVariables = () => {
  console.log("Using project:", process.env.GCLOUD_PROJECT);
  // Firebase Functions Emulator currently not loading .env files properly:
  // https://github.com/firebase/firebase-functions/issues/1094
  // Also a workaround for deploying when trigger fun parameters depend on environment:
  // https://github.com/firebase/firebase-functions/issues/1413
  switch (process.env.GCLOUD_PROJECT) {
    case 'project-1-id':
      dotenv.config({ path: `${__dirname}/../.env.project-1-env-file` });
      break;
    case 'project-2-id':
      dotenv.config({ path: `${__dirname}/../.env.project-2-env-file` });
      break;
      .
      .
      .
    default: // Used by other devs on my team with their own projects
      dotenv.config({ path: `${__dirname}/../.env.emu` });
  }
};

src/index.ts

import { setupEnvironmentVariables } from './environment';
// At the very beginning of your entry point.
setupEnvironmentVariables();

path/to/your/triggers.ts:

// Some env-dependant trigger:
export const onEnvDependantTrigger = functions
  .storage.bucket(process.env.MY_TARGET_BUCKET) // defined on each of your .env files

[mlpanaxeo]

You can also use v2 triggers and there the bucket name can be used as a parameter:

import { defineString } from "firebase-functions/params"
import { onObjectFinalized, StorageObjectData } from "firebase-functions/v2/storage"

const pdf_bucket_name = defineString('PDF_BUCKET_NAME')

export const onLeafletPdfFileUpload = onObjectFinalized({ bucket: pdf_bucket_name }, async (event) => {
    await handlePdfUpload(event.data)
})