fix: added flushFilePath()

[jeffb-sfdc]

What does this PR do?

There's a bug in VS Code, which Microsoft refuses to fix (see microsoft/vscode#152993). After a file has been renamed, if only the casing has changes (eg no characters added or removed) VS Code passes the stale path to commands. This PR adds flushFilePath() and flushFilePaths() to fix this issue.

What issues does this PR fix or reference?

##3575, @W-10273785@

Functionality Before

1. Rename an Apex class's file name (only changing the case of the filename), and rename it's metadata file
2. Open the file and change the name of the class to match
3. With the file open, right-click in the editor and select "SFDX : Deploy This Source to Org"
4. This results in an error in the output: "File name mismatch with class name"

Functionality After

1-3: the same
4. This deployment succeeds

[klewis-sfdc]

What do you think about either adding a comment here as to why this is no longer applicable or removing entirely?

[jeffb-sfdc]

I'll remove them. This was there and was adding noise to the output. salesforcedx-vscode-core has a lot of noise in it when the untegration tests run. When the tests run (either locally, or in CI) there are lots of errors reported, and it's at the point where it's hard to tell when a failure is a failure or not. This is just a "drop in the ocean" and I hope to focus on this at some point and clean up the build.

[klewis-sfdc]

In QA so far, I can confirm that renaming by changing the casing only and then deploying now works correctly. Nice!

Looking at the changes in the PR, are there delete or retrieve actions that should also be tested here?

[jeffb-sfdc]

Looking at the changes in the PR, are there delete or retrieve actions that should also be tested here?

Yes, this fix was also added to forceSourceDelete.ts and LibraryPathsGatherer.ts

And LibraryPathsGatherer is used in fourceSourceDeploySourcePath and fourceSourceRerrieveSourcePath.

[klewis-sfdc]

Looks good to me! Thanks @jeffb-sfdc !

• SFDX: Deploy Source to Org works after renaming locally by only making changes to the casing in the file/class name
• SFDX: Deploy Source to Org works when deploying multiple files after renaming one locally by only making changes to the casing in the file/class name
• SFDX: Retrieve Source from Org works as before
  • Note: If you rename locally, you still need to deploy the class first so that it is renamed on the server before executing a “Retrieve” operation
• SFDX: Delete from Project and Org works as before
  • Note: Similarly, if you rename the component/class locally, you need to deploy it so that the name is aligned on the server before running a delete operation

[jeffb-sfdc]

In QA so far, I can confirm that renaming by changing the casing only and then deploying now works correctly. Nice!

Thanks @klewis-sfdc . Just a heads up - I updated the existing tests and they pass. I'm now adding tests for flushFilePath().

[klewis-sfdc]

Also tested "SFDX: Launch Apex Replay Debugger with Current File" - working as before - looks good! ✅