Save all open editors before running Save As

[msujew]

Motivation

Closes #896

Change description

Invokes the saveAll operation of the ApplicationShell before saving the sketch to a new location.

Other information

This saves any unsaved changes to the current sketch as well. Is this alright with the usability concept? Or should the new changes exclusively be saved to the new sketch? (this would be a bit more involved)

Reviewer checklist

• PR addresses a single concern.
• The PR has no duplicates (please search among the Pull Requests before creating one)
• PR title and description are properly filled.
• Docs have been added / updated (for bug fixes / features)

[AlbyIanna]

@msujew Works for me. I have just one doubt: why do we need a timeout? Since saveAll() returns a Promise, I would expect not to need any timeout after that.

[msujew]

@AlbyIanna Yeah, sadly the internal Theia 1.22 code for saveAll looks like this

Promise.all(widgets, widget => {
  if (Saveable.is(widget)) {
    Saveable.save(widget); // Note the missing "await" here
  }
});

Which is why we need to wait. But you're right, overriding the saveAll method of the Applicationshell to locally fix this would probably the better idea than waiting. I'll address this.

Note that the saving functionality has been moved into its own service which correctly uses await in version 1.23 and onward. We should probably update soon anyway.

Perhaps we should try to update to 1.24 soon?

[AlbyIanna]

Thanks @msujew!

Perhaps we should try to update to 1.24 soon?

Yes, I think we should.
cc: @fstasi

[ubidefeo]

If I create a new Sketch and try to close it, it triggers a "Save sketch folder as..." (should be "Save Sketch as...") but no matter how many times I click on "Save" it won't happen and the dialog will keep popping up.
Clicking "Cancel" will continue the operation and the Sketch will be reloaded, proving that it has been indeed saved

[AlbyIanna]

@ubidefeo oh right that happens to me too with new sketches.
If I follow instructions in #896 👇

1. Select File > Preferences from the Arduino IDE menus.
2. Uncheck the box next to "☐ Auto save"
3. Click the OK button.
4. Select File > New from the Arduino IDE menus.
   ℹ️ The bug is not limited to new sketches. It also occurs with sketches that have been previously saved to a permanent location on the disk.
5. Make some change to the sketch.
6. ❗ Do not save.
7. Select File > Save As... from the Arduino IDE menus.
8. Click the Save button.

I get the same buggy behaviour @ubidefeo is describing. 🐛

[msujew]

@AlbyIanna @ubidefeo the weird behavior when closing app is related to this code, and will likely be addressed by #893. It's independent of this change.

[per1234]

UPDATE: fixed by https://github.com/arduino/arduino-ide/compare/51af711f7b70f6310787360a25294193ddefb280..2543d1b0c81f437e3f8c6dbc60f064bcdb425236

>This saves any unsaved changes to the current sketch as well. Is this alright with the usability concept? Or should the new changes exclusively be saved to the new sketch?

They must be saved exclusively to the new sketch, just as "Save as" works in every other application ever made.

[AlbyIanna]

We are going to merge this PR only when #893 will be approved because we want to solve all the major saving issues together.

[AlbyIanna]

As @per1234 suggested – we should save the new changes exclusively in the new sketch.

[msujew]

@per1234 @AlbyIanna Thanks for the feedback, I've changed the code to only save the changes to the new sketch. Mind retesting?

[per1234]

UPDATE: Fixed by https://github.com/arduino/arduino-ide/compare/2543d1b0c81f437e3f8c6dbc60f064bcdb425236..6299e87015c745f7e1588e4b438df893d2c300de

### Describe the problem

When using the build from this PR, performing a "Save As..." operation when the sketch has unsaved changes produces an unexpected dialog about quitting:

To reproduce

1. Select File > Preferences from the Arduino IDE menus.
2. Uncheck the box next to "☐ Auto save"
3. Click the OK button.
4. Make some change to the sketch (I will refer to this as "Sketch A" from here on).
   ❗ Do not save.
5. Select File > Save As... from the Arduino IDE menus.
6. Click the Save button.
   (I will refer to this as "Sketch B" from here on)

🐛 An unexpected and confusing dialog appears:

Are you sure you want to quit?

Any unsaved changes will not be saved.

Expected behavior

No quit confirmation dialog on "Save As...".

The IDE must be smart enough to understand that, even though it is true that the unsaved changes are not saved to "Sketch A", they are saved to "Sketch B" and it is standard and expected by the user that changes would not be saved to "Sketch A".

The IDE must be smart enough to understand that the closure of "Sketch A" when saving as "Sketch B" is different from a normal close of a window. The replacement of "Sketch A" by "Sketch B" in the application after a "Save As..." operation is simply standard and expected behavior of any application and the user should not be consulted about it or exposed to whatever specific mechanism the IDE is using to accomplish that replacement.

Arduino IDE version

2.0.0-rc6-snapshot-7ef629a

(the tester build for 2543d1b)

Operating system

Windows 10

[msujew]

@per1234 Sorry, small oversight, should be fixed now. That was the underlying Theia onWillStop check that popped up.

[per1234]

This solves #896 for me.
Thanks @msujew!

done