Save as command correctly creates a new file before saving

[msujew]

What it does

Fixes #8373
Fixes #8504
Closes #8514

When using the "save as" command, a new file will be created with the new changes, and the old file will be unchanged. The text editor will then close the old file and open the new one.

How to test

• Open a file and make some changes
• Use "Save as" command
• The text editor will now open the new file created with the changes. The old file will be closed.
• The old file will be unchanged.

Review checklist

• as an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

• as a reviewer, I agree to behave in accordance with the review guidelines

[vince-fugnitto]

@Darkgaja thank you for taking care of the issue, the changes look very good already.
We should possibly change the enabled of the command to be available only when an editor is opened. With these changes, if a file node is selected in the explorer, the command is available, prompts the user to choose a name but does not perform an actual save (given that sourceWidget is undefined).

Else, we may not want to show the dialog at all when no editor is opened (similarly to vscode).

[msujew]

@vince-fugnitto sure, I'll look into this as well

[paul-marechal]

The change seems to work, but I don't know what to think about a new tab being opened and the old one closing? Is there a way to not do that?

[vince-fugnitto]

The change seems to work, but I don't know what to think about a new tab being opened and the old one closing? Is there a way to not do that?

@marechal-p I believe that is the intended behavior (similarly to vscode), when save as... is performed, the original editor is closed while the new one is opened. I believe vscode handles it more gracefully (without the UI change) by replacing the editor if that's what you're referring to.

[paul-marechal]

by replacing the editor if that's what you're referring to.

This is what I meant. It is weird how it works right now, but if that's all we can do I'm fine.

[DucNgn]

1. Open 2 editors: ./a.ts and ./folder/b.ts
2. Make changes in a.ts and call Save as ... in the file, overwrite ./folder/b.ts
3. A dialog displays upon saving:

Do you know if we can bypass this dialog?
The PR looks good to me otherwise

[msujew]

@dukengn I noticed that the dialog comes up because of the fileSystem.copy call. Checking whether the file exists beforehand eliminates the dialog.

[vince-fugnitto]

@Darkgaja do you mind squashing your changes to a single commit with a nice commit message? I'll perform a review in the meantime.

[vince-fugnitto]

Do you know if we can bypass this dialog?

@dukengn the dialog is presented when we attempt to overwrite a file (it should ask for confirmation first).
The same behavior is present in other applications, like vscode for instance under the same use-case.

[msujew]

@vince-fugnitto Actually, this is a different dialog. The confirmation dialog correctly pops up while selecting a file. The dialog @dukengn mentioned pops up because the fileSystem.copy call modifies a file that is opened within a dirty editor. In this case a competely unrelated event triggers and asks the user whether they want to overwrite the dirty editor state with the changes made on the filesystem. This additional dialog doesn't trigger in vscode.

Nevertheless, I will squash my commits.

[vince-fugnitto]

@Darkgaja do you mind rebasing and resolving conflicts?

[msujew]

@vince-fugnitto done.

[paul-marechal]

LGTM, thanks!

[vince-fugnitto]

The changes look good 👍 I did encounter a minor bug that can likely be handled:

1. open a file, and perform some dirty changes (ex: 'readme.md')
2. execute the command Save As...
3. save the file with the original name ('readme.md')
4. a confirmation box will appear asking if you want to overwrite the original file
5. the file is saved and immediately closed

save-as-bug.mp4

[msujew]

@vince-fugnitto When encountering the same URI as the source widget, my changes will now only execute the normal SAVE command.

[vince-fugnitto]

@vince-fugnitto When encountering the same URI as the source widget, my changes will now only execute the normal SAVE command.

@Darkgaja I'll verify the new behavior, vscode behaves the following way:

1. document is dirty.
2. save as is performed with the same URI.
3. the confirmation dialog appears.
4. the save occurs, but the file is not closed.

[msujew]

Thanks. Right, I also took vscodes behavior as a sort of template. It should behave as you've laid out.

[vince-fugnitto]

I confirmed that the changes work well 👍

[DucNgn]

The PR looks good to me 👍
I confirmed it aligns our save as behaviour with vscode.