func pack requirs local.settings.json

[runegulbrandsen]

Version

4.6.0

Description

I was trying to create a CI build for my Nodejs Azure Function, but got errors all the time when running func pack --no-build command with the following error:

'local.settings.json' found in root directory (/<projectpath>).
'local.settings.json' found in root directory (/<projectpath>).
The value cannot be an empty string. (Parameter 'path')

I changed the command to func pack . --no-build, then the error changed to (since GitHub CoPilot advised this) and then the error switched to:

'local.settings.json' found in root directory (/<projectpath>).
'local.settings.json' found in root directory (/<projectpath>).
Unsupported runtime: None

I diffed the files locally and on the CI build and the only difference was that the local.settings.json was the difference. I added this and then suddenly everything worked.

The project was created using func new and the exclusion of local.settings.json is done by the default creation, so the question is: Is the problem that func new excludes files that are required, or is the problem that func pack depends on file that it shouldn't?

Steps to reproduce

1. Create a project using func new, use Node and Typescript.
2. Commit the project into a git repo.
3. Install node packages with npm install
4. Build the project running npm run build
5. Trim packages using npm ci --omit=dev
6. Clone the git repo into a new folder and try tu run func pack --no-build and func pack . --no-build.You will get the errors as described above.

[liliankasem]

The func pack command (along with most other Azure Functions Core Tools CLI commands) requires the FUNCTIONS_WORKER_RUNTIME setting from local.settings.json

You can get around the need for the .json file by providing that setting via environment variable instead.

export FUNCTIONS_WORKER_RUNTIME=node

Full example with before and after:

> func pack --no-build
'local.settings.json' found in root directory (/Users/likasem/Desktop/repros/func-pack-local-settings-json/test-func-pack).
'local.settings.json' found in root directory (/Users/likasem/Desktop/repros/func-pack-local-settings-json/test-func-pack).
The value cannot be an empty string. (Parameter 'path')

> export FUNCTIONS_WORKER_RUNTIME=node

> func pack --no-build
Resolving worker runtime to 'node'.
Resolving worker runtime to 'node'.

Validating project...

  Validate host.json: PASSED
  Validate Folder Structure: PASSED

Deleting the old package /Users/likasem/Desktop/repros/func-pack-local-settings-json/test-func-pack/test-func-pack.zip
Skipping build event for functions project (--no-build).
Creating a new package /Users/likasem/Desktop/repros/func-pack-local-settings-json/test-func-pack/test-func-pack.zip

[runegulbrandsen]

Ok, I would call that a workaround, but yes it works for me.

But there is still something that maybe should be fixed here then:

1. The error message we get when the file ('local.settings.json') doesn't exist claims it exists. ('local.settings.json' found in root directory (/Users/likasem/Desktop/repros/func-pack-local-settings-json/test-func-pack).)
2. The message The value cannot be an empty string. (Parameter 'path') isn't explaining what's the problem is. The error should rather state Missing required configuration FUNCTIONS_WORKER_RUNTIME (or something like that)...

[liliankasem]

Yeah I agree, I'll add this to the backlog to address those points

[MO2k4]

@liliankasem - I’d like to work on this, is a community PR welcome?

[liliankasem]

@MO2k4 you're welcome to