#1089: IDE falls back to new sketch if opening failed

[kittaakos]

Motivation

IDE must automatically open a new sketch (in the temp folder) if the sketch was deleted between the IDE stop/start cycle.

Requirements:

• At least three valid sketches in the sketchbook folder. My bare minimum setup is the following:

a.kitta@Akoss-MacBook-Pro Arduino % ls -al
total 16
drwxr-xr-x  6 a.kitta  staff   192 Jul 14 15:03 .
drwx------+ 5 a.kitta  staff   160 Jul  6 15:46 ..
-rw-r--r--@ 1 a.kitta  staff  6148 Jul 14 15:03 .DS_Store
drwxr-xr-x  3 a.kitta  staff    96 Jul  7 16:42 sketch_1
drwxr-xr-x  3 a.kitta  staff    96 Jul  7 16:43 sketch_2
drwxr-xr-x  3 a.kitta  staff    96 Jul  7 16:43 sketch_3
a.kitta@Akoss-MacBook-Pro Arduino % cat sketch_1/sketch_1.ino 
void setup() {}
void loop() {}

(sketch_2 and sketch_3 have the same content as sketch_1).

Preconditions:

• Open IDE, if sketch_1 is not loaded, open sketch_1,
• Close any other opened sketches
• When sketch_1 is the only opened sketch in IDE the verification can start.

1: Opening deleted sketch from File > Sketchbook

• Note: the file-system watcher might miss file deletion events and cannot update the Sketchbook submenu content.
• Check File > Sketchbook, sketch_3 is there,
• Delete sketch_3 outside from IDE,
• Open File > Sketchbook > sketch_3,
• See error notification that it's missing.
• Check File > Sketchbook, sketch_3 is not there.

open_deleted_from_menu.mp4

---

2. Delete the sketch folder when IDE is stopped:

• Open sketch_1 in IDE,
• Close IDE,
• Delete sketch_1 from the sketchbook,
• Start IDE,
• Without any error notifications, IDE opens a new fallback sketch

restore_deleted_sketch_on_start.mp4

---

3. Delete the main sketch file when IDE is stopped:

• Open sketch_2 in IDE,
• Close IDE,
• Delete the main sketch file sketch_2/sketch_2.ino,
• Start the IDE,
• IDE loads, expect a reload,
• New sketck is created and opened but no error notification is shown by IDE.

restotre_invalid_sketch_on_start.mp4

Change description

Other information

Closes #1089

Breaking: Optimize for Debugging now has its preference: arduino.compile.optimizeForDebug. The default value is false. If you had Optimize for Debugging enabled before this IDE version, you must click on Optimized for Debugging again.

Breaking: Changed arduino.cloud.sketchSyncEnpoint to arduino.cloud.sketchSyncEndpoint (#1067). If you had a custom sketch sync endpoint defined, you must redefine it again with the version of the IDE.

IDE uses the default spinner from Theia:

default_theia_spinner.mp4

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)

[kittaakos]

If IDE has the changes from arduino/arduino-cli#1805, then the error message will be the same for all three use-cases this PR covers:

Please let me know if we need arduino/arduino-cli#1805 as-is for this PR.

[per1234]

There are two distinct reasons the IDE might attempt to open a sketch:

• Explicit action by user (e.g., selecting a sketch from File > Sketchbook)
• Restore state from previous session (Restore open sketches on startup #780)

The IDE must gracefully handle a failure of either operation (#1089). However, I feel the need to communicate about the failure to the user differs between them.

If an operation triggered explicitly by the user fails, it is important to communicate this to the user. So I think showing a notification when the sketch opening fails is necessary in this case.

The situation is different when it comes to automatically opening sketches from the previous IDE session. This is only a convenience feature. If it is able to open the sketches, great. But if it is not able to open the sketches, I don't want to hear about it. I might have intentionally deleted that sketch. It might have been a new sketch that was staged in a temporary folder the OS cleaned up. In the latter case, the temporary path makes the error message especially cryptic:

So I suggest that no error notification be shown when the sketch opening fails during the restore operation (logging it is fine of course).

[kittaakos]

Thank you for the review!

So I suggest that no error notification be shown when the sketch opening fails during the restore operation (logging it is fine of course).

Sure 👍

IDE2 (and the CLI) might fail to load the sketch due to two reasons:

• the sketch folder was deleted,
• the sketch is not valid (the main file was deleted, does not match the folder name, .etc)

As a user, do you expect that IDE2 will omit the error notification in both cases?

[per1234]

do you expect that IDE will omit the error notification in both cases?

In the case of a "restore" operation, yes.

[kittaakos]

I have updated the PR not to show the error notification when restoring the previously opened sketch has failed (due to a missing or invalid sketch). I updated the screencasts too to show the expected IDE behavior. Please review.

[per1234]

It works perfectly. Excellent work Akos!

[AlbyIanna]

LGTM.

I left some comments, but nothing important.

[AlbyIanna]

Since you're doing some clean-up, what do you think about making this class extend Contribution so that we can get rid of some injected services (ILogger, MessageService, CommandService, FrontendApplicationStateService) and make use of the onReady method?

[kittaakos]

Good idea, but I do not want to introduce a hard dependency between contributions. Also, this service does not contribute any commands, menu items, .etc.