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

Attention: 26 lines in your changes are missing coverage. Please review.

Files	Coverage Δ
packages/zowe-explorer/src/dataset/actions.ts	93.96% <94.73%> (-0.23%)	⬇️
packages/zowe-explorer/src/shared/utils.ts	86.52% <81.25%> (-10.79%)	⬇️
packages/zowe-explorer/src/uss/actions.ts	94.75% <86.95%> (+1.22%)	⬆️
packages/zowe-explorer/src/shared/actions.ts	77.64% <20.83%> (-9.52%)	⬇️

📢 Thoughts on this report? Let us know!

[traeok]

Hi @SanthoshiBoyina, thanks for working on resolving conflict management - looks great so far.

After a discussion w/ @t1m0thyj, I do have a concern regarding the Data Set tree. On line 523 in the openPS function (dataset/actions.ts), I noticed that we set the e-tag regardless of its value in the response:

const response = await responsePromise;
node.setEtag(response?.apiResponse?.etag);
statusMsg.dispose();

If a response does not return an e-tag, it will set the e-tag to null, which will cause the first save to bypass the e-tag mismatch on the mainframe.

To avoid this, we'll need to add a check to see if response?.apiResponse?.etag is a valid value before calling node.setEtag.

[t1m0thyj]

Agree with @traeok's comment, here are steps for how I reproduced the issue:

1. Open a data set in preview mode by single-clicking on it in the tree
2. Make changes to the data set on the mainframe
3. Make changes to the data set locally in ZE
   This will switch the editor from preview mode (title italicized) to edit mode 👍
   It will also reset the etag for the current node to null which we don't want 😢
4. Save the changes and notice that no conflict is detected

IMO we should fix this before 2.12.1 to avoid risk of data loss, potentially in this PR since its related to compare functionality? I also don't mind opening a separate PR to fix it if preferred 🙂

[t1m0thyj]

Based on discussion at standup, I'll open another PR against this one with the fix for etag being set to null 🙂

Edit: Opened #2551

[JillieBeanSim]

LGTM! thanks for the fix

[rudyflores]

Thanks @SanthoshiBoyina !

Only thing I see is some code coverage missing but not sure if this will be an issue since I know we want to get the release out?

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
22.3% Duplication

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

[t1m0thyj]

LGTM, thanks @SanthoshiBoyina and @JillieBeanSim!

[rudyflores]

Nice catch @t1m0thyj !