Firebase Parameterized configuration does not work well with Typescript

[service-paradis]

Related issues

Kind of related: #5277
Related StackOverflow question: https://stackoverflow.com/q/74744707/2774496

[REQUIRED] Version info

node: v18.13.0

firebase-functions: 4.1.1

firebase-tools: 11.20.0

firebase-admin: 11.5.0

[REQUIRED] Test case

import { Options } from '@mikro-orm/core';
import { defineString } from 'firebase-functions/params';

const config = {
  ...
  dbName: defineString('DB_NAME').value(),
  ...
} as Options;
export default config;

[REQUIRED] Steps to reproduce

• Use the above code and start the emulator
• See the following warning in console:

{"severity":"WARNING","message":"params.DB_NAME.value() invoked during function deployment, instead of during runtime."}
{"severity":"WARNING","message":"This is usually a mistake. In configs, use Params directly without calling .value()."}
{"severity":"WARNING","message":"example: { memory: memoryParam } not { memory: memoryParam.value() }"}

If I remove .value to keep config as:

const config = {
  ...
  dbName: defineString('DB_NAME'),
  ...
} as Options;

I get the following Typescript error:

Types of property 'dbName' are incompatible.
Type 'StringParam' is not comparable to type 'string'.

[REQUIRED] Expected behavior

If using .value() is not supported during functions development, we should be able to use the variable without .value() without any errors from Typescript.

If using .value() is working anyway during function development, no warning should be displayed.

[REQUIRED] Actual behavior

To be able to serve functions using Typescript, we need to use .value() with parameterized configurations. Unfortunately, it logs a lot of unnecessary warning to the console. But without .value(), we have Typescript errors preventing serving the app.

Were you able to successfully deploy your functions?

[google-oss-bot]

I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.

[markglibres]

I had a similar issue.. can't get environment values for deployment

export const test = onObjectFinalized({
  bucket: defineString('BUCKET_NAME').value(),
}, async (event) => {
  return {success: true};
});

and deployment wasn't getting the right environment variable.. value is empty..

[taeold]

@markglibres Can you try replacing:

export const test = onObjectFinalized({
+  bucket: defineString('BUCKET_NAME'),
-  bucket: defineString('BUCKET_NAME').value(),
}, async (event) => {
  return {success: true};
});

[taeold]

@service-paradis I think this is working as intended. The specific error message is meant to warn users precisely about wrong usage of params as seen in #1342 (comment).

I see that you are using params for setting options outside of Functions SDK. This is totally fine, but I think we would like to still keep the warnings. Unfortunately, I can't think of a way for our code to know whether it's being used inside a function configuration or not (without writing a special compiler that is).

As you noticed, calling .value() is okay.

[service-paradis]

Thank you for your response, @taeold.

Unfortunately, I still find the current situation less than ideal. If I have an environment variable that needs to be used both in a function configuration and inside a function, I am forced to use two different ways to access the value.

If I choose to use params for both, I receive a warning, which is not desirable. On the other hand, if I use process.env for both, the function configuration will be incorrect since the environment variable will be undefined at build time or during deployment.

To ensure everything works as expected, I have to use params for function configuration and process.env inside the function to access the same variable. This can be quite confusing to me and adds unnecessary complexity.

Do you have any suggestions for how we could simplify this process and avoid the need for multiple methods of accessing environment variables?

[service-paradis]

@markglibres Can you try replacing:

export const test = onObjectFinalized({
+  bucket: defineString('BUCKET_NAME'),
-  bucket: defineString('BUCKET_NAME').value(),
}, async (event) => {
  return {success: true};
});

@taeold Your suggestion does not work unfortunately. It looks like we cannot use Parameterized configuration for bucket name right now. If we use your suggestion, Typescript is complaining with the following error:

Type 'StringParam' is not assignable to type 'string'.ts(2769)
storage.d.ts(162, 5): The expected type comes from property 'bucket' which is declared here on type 'StorageOptions'

If we use defineString('BUCKET_NAME') as any to remove the error and we try to build the app, we get the following error in console:

!! 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.BUCKET_NAME

I think StorageOptions in storage.d.ts would need to have bucket?: string | Expression<string> | ResetValue; instead of bucket?: string; in order to work as expected.

[markglibres]

@markglibres Can you try replacing:

export const test = onObjectFinalized({
+  bucket: defineString('BUCKET_NAME'),
-  bucket: defineString('BUCKET_NAME').value(),
}, async (event) => {
  return {success: true};
});

@taeold it didn't worked with the latest version of firebase... any ideas how to make this work with storage?

[tagomorisatoshi]

I have same thing.