Sketchbook sidebar state #1102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

AlbyIanna merged 13 commits into main from sketchbook-sidebar-state

Jul 4, 2022

Merged

Sketchbook sidebar state #1102

AlbyIanna merged 13 commits into main from sketchbook-sidebar-state

Jul 4, 2022

Conversation

AlbyIanna

Copy link

Contributor

@AlbyIanna AlbyIanna commented Jun 23, 2022

Motivation

When opening a sketch from the sketchbook sidebar, the new IDE window should open with the sketchbook sidebar open. This should also happen when opening a sketch from the Remote Sketchbook (and of course in this case the Remote Sketchbook will be automatically open).

Expected Behavior

Local Sketchbook:

launch IDE
expand the Sketchbook sidebar
select the Local Sketchbook
double-click a Sketch that is not open
😄 it will open to another window and the Local Sketchbook sidebar will be open

Remote Sketchbook:

launch IDE
expand the Sketchbook sidebar
select the Remote Sketchbook (sign in if necessary)
double-click a Sketch that is not open
😄 it will open to another window and the Remote Sketchbook sidebar will be open

Change description

Added two commands to open the local and the remote sketchbook respectively.
Added a way to pass an array of commands to the WorkspaceService when opening a new sketch. Those commands will be subsequently run when the front-end is ready.

Other information

Fixes #442

Replaces #912

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)

Alberto Iannaccone added 3 commits

June 23, 2022 09:34


 add commands to open sketchbook widgets

f5a1ae4

add commands to show sketchbook widgets


 enable sending commands via query params

7d17dd5


 opening sketch in new window will open sketchbook

e1ef5e2

@AlbyIanna AlbyIanna requested review from kittaakos and per1234

June 23, 2022 07:37

@AlbyIanna AlbyIanna mentioned this pull request

Jun 23, 2022

Open the sketchbook sidebar at the right location #912

Closed

4 tasks

@per1234 per1234 added type: enhancement topic: code labels

Jun 23, 2022

kittaakos

kittaakos reviewed

Jun 23, 2022

View reviewed changes

arduino-ide-extension/src/browser/theia/workspace/workspace-service.ts Outdated Show resolved Hide resolved

arduino-ide-extension/src/browser/theia/workspace/workspace-service.ts Show resolved Hide resolved

arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-widget.ts Outdated Show resolved Hide resolved

arduino-ide-extension/src/browser/widgets/sketchbook/sketchbook-widget-contribution.ts Outdated Show resolved Hide resolved

Alberto Iannaccone added 3 commits

June 23, 2022 12:28


 requested changes

a6d762a


 add specific method WorkspaceService to open sketch with commands

1b06314


 add encoded commands contribution

9630eb2

@AlbyIanna AlbyIanna requested a review from kittaakos

June 23, 2022 15:51

kittaakos

kittaakos reviewed

Jun 29, 2022

View reviewed changes

Copy link

Contributor

@kittaakos kittaakos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The logic is looking good. Thank you! I added one remark.

arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-contributions.ts Outdated Show resolved Hide resolved

per1234

per1234 requested changes

Jun 30, 2022

View reviewed changes

arduino-ide-extension/src/browser/widgets/cloud-sketchbook/cloud-sketchbook-contributions.ts Outdated Show resolved Hide resolved

arduino-ide-extension/src/browser/widgets/sketchbook/sketchbook-commands.ts Outdated Show resolved Hide resolved

Alberto Iannaccone and others added 5 commits

June 30, 2022 12:34


 try merge show sketchbook commands

50e0233


 pair session changes.

49f2e5c

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>


 i18n fixup.

bd62680

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>


 minimized scope of hacky code.

6b4e00d

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>


 clean up OPEN_NEW_WINDOW command

309b137

kittaakos

kittaakos reviewed

Jun 30, 2022

View reviewed changes

arduino-ide-extension/src/browser/theia/workspace/workspace-service.ts Outdated Show resolved Hide resolved


 add comment on workspace-service.ts

ebc63e8

@AlbyIanna

Copy link

Contributor Author

AlbyIanna commented Jun 30, 2022

@per1234 thanks for the suggestions! We improved that logic using a single command (REVEAL_SKETCH_NODE), and then we realized that such a command isn't really useful for the users, so we removed it from the command palette (and removed the label property accordingly).

@AlbyIanna AlbyIanna requested a review from per1234

June 30, 2022 11:22

ubidefeo

ubidefeo reviewed

Jun 30, 2022

View reviewed changes

Copy link

@ubidefeo ubidefeo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have tested the behaviour and it works, but there's a caveat.

If I select the Sketchbook and open another Sketch, the sidebar in the new window is correctly showing the current Sketch as highlighted.
If I then select the previously opened Sketch from this new window and double-click, the window at the back goes into focus but the Sidebar state is not changed

CleanShot 2022年06月30日 at 15 18 08@2x

CleanShot 2022年06月30日 at 15 18 32@2x

per1234

per1234 requested changes

Jun 30, 2022

View reviewed changes

Copy link

Contributor

@per1234 per1234 left a comment •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Describe the problem

🐛 When a sketch in a subfolder of the sketchbook is opened via the "Sketchbook" view, the tree structure is not expanded to show the sketch in the "Sketchbook" view of the opened sketch's window.

To reproduce

Download the sketch from this link: SomeParent.zip
i Feel free to create your own sketch if you like. I had produced this ZIP previously while preparing a since abandoned issue report where it was more beneficial to provide a premade one.

Extract the downloaded ZIP file in your sketchbook:

Arduino/
└── SomeParent/
 └── SomeSketch/
 └── SomeSketch.ino

Open the "SomeSketch" sketch via the "Sketchbook" view.

🐛 The tree structure is not expanded to show the sketch in the "Sketchbook" view of the new window:

image

i Please disregard the version shown in the screenshots. I produced these while preparing a since abandoned issue report for a previous build. The screenshot is still valid even though the issue applies to another version of the IDE.

Expected behavior

Tree structure is expanded to show the sketch in the "Sketchbook" view when a sketch is opened via the "Sketchbook" view:

image

Arduino IDE version

2.0.0-rc8-snapshot-529f811 (tester build for ebc63e8)

Operating system

Windows, Linux

Operating system version

Windows 10
Ubuntu 20.04

Additional context

This was working fine with 2.0.0-rc8-snapshot-7ac80b8 (tester build for 9630eb2), with one minor exception:

The first time a given sketch was opened on the user's machine (using that build, it worked as expected on all subsequent openings of the sketch).

The problem is the same for sketches from the "Remote Sketchbook".

It is not too serious of a problem, but I do think having the tree expanded to reveal the sketch is a better UX.

The fact that it was working before the most recent changes to this PR made me think it might be an easy fix.

@91volt

Copy link

91volt commented Jul 1, 2022 •

edited

Loading

I have tested the behaviour and it works, but there's a caveat.

If I select the Sketchbook and open another Sketch, the sidebar in the new window is correctly showing the current Sketch as highlighted. If I then select the previously opened Sketch from this new window and double-click, the window at the back goes into focus but the Sidebar state is not changed

@ubidefeo I think that this behavior regarding already opened workspaces is right - and in any case I believe this nuance of the experience isn't really impactful for the user.

The already opened workspace shouldn't get the sketchbook on focus since the user might have interrupted a task that he needs to complete. I think is not ideal to change the sidebar state in an already opened window, without the user being aware of that.