VSC Compare function, not working with Favorites from Zowe Explorer

[SanthoshiBoyina]

Proposed changes

The feature of Visual Studio Code to compare 2 files, if the file on the mainframe has changed in the meantime, doesn't work if you open a Member under Favorites. It overrides the file automatically. In this bug fix, we are able to trigger Compare function when ETAGs are mismatched.

Release Notes

Milestone:

Changelog:

Types of changes

What types of changes does your code introduce to Zowe Explorer?
Put an x in the boxes that apply

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Updates to Documentation or Tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer

• I have read the CONTRIBUTOR GUIDANCE wiki
• PR title follows Conventional Commits Guidelines
• PR Description is included
• gif or screenshot is included if visual changes are made
• yarn workspace vscode-extension-for-zowe vscode:prepublish has been executed
• All checks have passed (DCO, Jenkins and Code Coverage)
• I have added unit test and it is passing
• I have added integration test and it is passing
• There is coverage for the code that I have added
• I have tested it manually and there are no regressions found
• I have added necessary documentation (if appropriate)
• Any PR dependencies have been merged and published (if appropriate)

Further comments

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!.

[rudyflores]

Is this for 2.12.0? @JillieBeanSim @SanthoshiBoyina

[JillieBeanSim]

Is this for 2.12.0? @JillieBeanSim @SanthoshiBoyina

I am not opposed to it being included if the tests are fixed and the coverage is good in time, not seeing the coverage report yet with failing tests

[JillieBeanSim]

I am seeing the diff editor open then when trying to save that I get the pop up to compare, I would assume one or the other happen but not both and the second right behind the first encounter.

[traeok]

Thanks for working on this bug fix @SanthoshiBoyina!

I'm running into the same situation as @JillieBeanSim - the side-by-side diff appears, but the dialog with Compare/Overwrite does not. However, this occurs for non-favorited nodes as well. I think this is because calls to willForceUpload (in src/shared/utils.ts) were removed with a previous PR, and this function was responsible for showing the dialog:

Gui.infoMessage(localize("saveFile.info.confirmUpload", "Would you like to overwrite the remote file?"), {
        items: [localize("saveFile.overwriteConfirmation.yes", "Yes"), localize("saveFile.overwriteConfirmation.no", "No")],
    })

(lines 284-286 in the mentioned file)

I'm wondering if we still want to use this willForceUpload function somewhere? As a quick solution, if we add a similar dialog to the compareFileContent function in src/shared/utils.ts, or if we show a dialog before calling compareFileContent, it should fix the issue.

[JillieBeanSim]

I don't think we should be forceUploading anything unless the decision came from user.

[traeok]

I don't think we should be forceUploading anything unless the decision came from user.

@JillieBeanSim I agree. My comment was mostly to bring awareness that the "conflict prompt" (showed before the diff) is no longer there. We used to call this willForceUpload function (mentioned above) that contained a similar dialog, but this call was removed at some point in the past and now we do not show a dialog at all when a conflict occurs. This is a regression introduced with a previous release, since we used to show a dialog, but it is not a result of the work on this PR. This could always be added to the repo as a separate issue for a future PR to solve.

Update: this dialog is the dialog I was referring to, sorry for the confusion. It was removed sometime between 2.8 and 2.9.

[JillieBeanSim]

ok, if we had a regression maybe the popup can be added/moved to the shared.utils.compareFileContent() method. this will cut down on introducing duplicate code to bring it back in other cases and fix the duplication here in this PR

[SanthoshiBoyina]

I am seeing the diff editor open then when trying to save that I get the pop up to compare, I would assume one or the other happen but not both and the second right behind the first encounter.

VS Code has a built-in mechanism to show a notification when you try to save a dirty file that has been changed outside of VS Code or by another program

In order not to make this built-in vs code notification pop up, In the setting we need to configure files.saveConflictResolution to overwriteFileOnDisk option from the default askUser option.

[traeok]

I am seeing the diff editor open then when trying to save that I get the pop up to compare, I would assume one or the other happen but not both and the second right behind the first encounter.

VS Code has a built-in mechanism to show a notification when you try to save a dirty file that has been changed outside of VS Code or by another program In order not to make this built-in vs code notification pop up, In the setting we need to configure files.saveConflictResolution to overwriteFileOnDisk option from the default askUser option.

@SanthoshiBoyina

I'm not sure if we should override this option during that process, as it might interfere with other local files that the user is editing within VS Code. Unfortunately, we are unable to use VS Code's built-in conflict management directly with a remote system such as an LPAR.

Currently, data sets and USS file contents are written to temp. files, so VS Code has no way of checking whether the document has a different e-tag than the mainframe. It calculates an e-tag for the temp. file on disk, but it's different from the one that the mainframe generates, so we have to handle the remote save separately from the temp. file. Until we switch to something like a FileSystemProvider (#2207), we can only check to see if conflict resolution is needed after saving the temp file. If there is a conflict, we un-save the temp. file and then present a similar dialog to VS Code's.

[rudyflores]

Seems like the issue here with the compare editor not showing is because the node being passed into compareFileContent is a directory, can see that the error that shows in the debug console when trying to click on Compare mentions that a directory was entered too, this happens right when node.getUSSDocumentFilePath() is called in line 377 of utils.ts

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
8.8% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint