String replacement using environment variable

[Bartheleway]

Summary

As I cannot reopen #5948, I am creating a new issue. Check #5948

Steps To Reproduce:

Check #5948

Expected result

Ask for a file containing env var definition or ask for each env var value which are not defined ?

Actual result

Command fails

Additional information

Salesforce Extension Version in VS Code: 64.13.1
Salesforce CLI Version: 2.105.6
OS and version: Windows 11 Pro 23H2
VS Code version: 1.104.0
Most recent version of the extensions where this was working: N/A

[svc-idee-bot]

Thank you for filing this issue. We appreciate your feedback and will review the issue as soon as possible. Remember, however, that GitHub isn't a mechanism for receiving support under any agreement or SLA. If you require immediate assistance, contact Salesforce Customer Support.

[svc-idee-bot]

Hello @Bartheleway 👋 It looks like you didn't provide all the required basic info in your issue.

If you haven't already, please provide the following info:
Salesforce Extension Version in VS Code:
Salesforce CLI Version:
OS and version:
VS Code version:
Most recent version of the extensions where this was working:

Here's an example of a set of required info that will pass the validation:
Salesforce Extension Version in VS Code: 60.13.0
Salesforce CLI Version: @salesforce/cli/2.42.6 darwin-arm64 node-v18.18.2
OS and version: MacOS Sonoma 14.5
VS Code version: 1.89.1
Most recent version of the extensions where this was working: 60.11.0

A few more things to check:

• Make sure you've provided detailed steps to reproduce your issue, as well as all error messages that you see.
  • A repository that clearly demonstrates the bug is ideal.
  • Error messages can be found in the Problems Tab, Output Tab, and from running Developer: Toggle Developer Tools in the command palette.
• Make sure you've installed the latest version of the Salesforce Extension Pack for VSCode. (docs)
• Search GitHub for existing related issues.

Thank you!

[Bartheleway]

Information have been provided

[mshanemc]

that's a feature request (having vscode ask for missing envs). It's pretty deep in the CLI's SDR library and not something the extensions can easily do interactively.

but it's weird that you'd even want that because it's supposed to throw an error when there's missing envs. Do you have the allowUnsetEnvVariable:true property set in your replacements configuration?

A more useful bug report would include some sample of your sfdx-project.json replacements configuration (obv hide anything secret, but the structure is useful).

[github-actions]

This issue has not received a response in 3 days. It will auto-close in 2 days unless a response is posted.

[Bartheleway]

Hi, here is an example sfdx-project.json

{
	"packageDirectories": [
		{
			"path": "force-app",
			"default": true
		}
	],
	"namespace": "",
	"sfdcLoginUrl": "https://login.salesforce.com",
	"sourceApiVersion": "64.0",
	"replacements": [
		{
			"glob": "force-app/main/default/authproviders/*.authprovider-meta.xml",
			"stringToReplace": "#AUTH_EXECUTION_USER#",
			"replaceWithEnv": "ENV_AUTH_EXECUTION_USER",
		},
		{
			"filename": "force-app/main/default/authproviders/SomeAuthProvider.authprovider-meta.xml",
			"stringToReplace": "#AUTH_CLIENT_ID#",
			"replaceWithEnv": "ENV_AUTH_CLIENT_ID",
		}
	]
}

Indeed having VS Code to ask for environment variable when missing is a feature request. VS Code extension not loading the latest environment vars state is I think a bug.

You might find that awkward but I assure you this is a real use case. Unfortunately in some precise spot Salesforce use hardcoded ids (or other not stable values) in metadata which oblige us to us replacement strings to correctly handle the different values we have based on the environment. When in dev sandbox, we use VS Code extensions to push changes. As it is development we might want to use a specific value to make a specific test. Also some of replacement values are secret and store on a remote vault that cannot be accessed on dev computer and therefore we provide dummy values (but respecting format) for them, they cannot be blank.

[peternhale]

@Bartheleway I have added the details you provided to discussion #6557.

[Bartheleway]

Thanks for sharing the details between the two open thread. Please note that they are related as they both speak about "string replacement" but they are 2 different subject.

Feature request is about to watch for sfdx-project.json changes in the extension.
This bug report is about extension not reloading env variables when the changes. One suggestion being to ask for env variable value when not found (this part could be a feature request as well).