Support executing debug in the browser #10748

thegecko · 2022-02-14T11:46:20Z

Signed-off-by: robmor01 [email protected]

What it does

Moved a lot of the debug files into common areas as they aren't node-specific
Support execution of debug in the frontend by splitting the executable resolver/starter into frontend and backend
The frontend version only supports creating an inline debug adapter

How to test

I've created a modified vscode.mock-debug which only runs as a web extension. Download here:

https://github.com/thegecko/vscode-mock-debug/releases/tag/web-1.0.0

Drop it into the plugins folder and run Theia...

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

msujew

The changes are looking quite good to me. Please document the moved files and everything else in the breaking changes section for this release.

Debugging in the browser using the provided extension works correctly
Normal debug providers continue to work as expected (Tested with JS debugger for Node.js)

msujew · 2022-02-22T12:18:52Z

packages/plugin-ext/src/plugin/debug/debug-ext.ts

     * @param contributions available debuggers contributions
     */
-    registerDebuggersContributions(pluginFolder: string, contributions: PluginPackageDebuggersContribution[]): void {
+    registerDebuggersContributions(pluginFolder: string, pluginType: theia.PluginType, contributions: PluginPackageDebuggersContribution[]): void {


Needs a breaking change in the CHANGELOG.md

tsmaeder · 2022-02-22T16:32:31Z

I could use a bit more description what the idea of this change is. Are you enabling front end plugins to contribute debug adapters?

thegecko · 2022-02-22T17:24:03Z

I could use a bit more description what the idea of this change is. Are you enabling front end plugins to contribute debug adapters?

Yes, see the example debug extension linked above

thegecko · 2022-02-28T16:07:06Z

@msujew Added changes to the CHANGELOG.md as requested

thegecko · 2022-03-17T13:23:30Z

@msujew @tsmaeder Is there anything more required to help you test this PR or satisfy your comments?

tsmaeder · 2022-03-17T13:38:35Z

Never mind me, won't have time to do a real review on this one.

msujew

I'm fine with the changes performed here.

Just one more minor comment: Do you mind reinstating the moved files and simply let them re-export the exports from the common folder. That way, it doesn't have to be a breaking change. Additionally, you can add a @deprecated comment so that users switch to the implementation exported from common.

thegecko · 2022-03-17T13:46:47Z

From our side, the only thing I'm keen to add is to bring a lot of the debug management into the frontend so other extensions play nicely (e.g. viewers which tie into readMemory/writeMemory requests). As it currently stands, implementing #10841 wouldn't work for frontend debuggers.

However, I'd like to make this change in a separate PR

thegecko · 2022-03-17T13:54:36Z

Do you mind reinstating the moved files and simply let them re-export the exports

Hmm, happy to, but:

Does every class and public property need this indirection? Which parts of the debug stack are the API?
We would need to remember to remove this later, does it make the code messy in the interim and require a further ticket?
What happens if/when this is refactored to bring the main functionality into the browser (as mentioned in my last comment), double-hop exports?
Is a deprecated warning enough? With these kept in place, developers could still get into a pickle adding node dependencies in the browser, perhaps?

Not against this change, just interested in your thoughts on the above @msujew

msujew · 2022-03-17T14:23:45Z

Does every class and public property need this indirection? Which parts of the debug stack are the API?

I believe so, since someone might depend on anything that's somehow exported.

We would need to remember to remove this later, does it make the code messy in the interim and require a further ticket?

Ideally, the the export code should just look like this:

/**
 * @deprecated since 1.24.0. - Moved to `common`. Import from there, instead.
 */
export * from '../common/...';

Not really messy, and can easily be removed a few versions down the line.

What happens if/when this is refactored to bring the main functionality into the browser (as mentioned in my last comment), double-hop exports?

Well, that won't work. But that wouldn't require moving existing parts from common to browser anyway, would it?

Is a deprecated warning enough? With these kept in place, developers could still get into a pickle adding node dependencies in the browser, perhaps?

Well these exports are just there to prevent us from instantly breaking existing backend debuggers, so that devs have a larger buffer to update their code base. They are completely justified in using node dependencies in that case.

Perhaps I don't understand you correctly. Do you plan to lift the whole debugging lifecycle into the browser frontend in the future?

thegecko · 2022-06-17T16:26:36Z

This PR is ready for re-review.

It has been rebased on the good work from @colin-grant-work and all conflicts resolved. Functionality re-tested.

@msujew , apologies it has taken so long to address your comments. All moved functions/exports/classes now have export sin their original locations with deprecation notices to maintain the API

Keen to see this merged!

colin-grant-work · 2022-06-17T17:07:42Z

I'll take a look later today or Monday.

colin-grant-work · 2022-06-20T14:29:11Z

packages/plugin-ext/src/plugin/node/debug/debug.ts

 /**
- * It is supposed to work at node only.
+ * @deprecated since 1.27.0. - Moved to `debug`. Import from there, instead.


Should note the change of filename to debug-ext.

colin-grant-work · 2022-06-20T15:04:52Z

Just one more minor comment: Do you mind reinstating the moved files and simply let them re-export the exports from the common folder. That way, it doesn't have to be a breaking change. Additionally, you can add a @deprecated comment so that users switch to the implementation exported from common.

@msujew, I'd be inclined to remove the reexports for several reasons. (1) Since we're going to start doing stable releases later this year, any deprecations now may be longer-lived than they might otherwise be, so it may be better to break now before we commit to some kind of stability. (2) The architecture of the plugin system isn't very conducive to overrides, so it's relatively less likely that downstream apps interact with these classes very much. (3) Deprecations of this kind don't show up very well in IDE's (/** @deprecated */ export * from '...' doesn't show a deprecation decoration in VSCode if you import from the old location, e.g.), so unless downstream apps are conscientious about scanning for new @deprecation markers or we mention the deprecation in the changelog, downstream apps are unlikely to notice until we break and delete these, anyway. (4) Breaking and renaming rather than renaming and reexporting is easier to see in git history, since then git can identify the renaming as such (coincidentally, that would also be easier to review ;-)), so anyone looking through the history that way would have a better chance of identifying what happened and why.

On the other hand, it does produce a fair bit of breakage, so there's certainly still some argument for the reexports. What do you think? One alternative would be no reexports in the plugin system, but reexports in debug, since debug follows our normal DI patterns more closely and is more likely to be extended / modified downstream?

msujew · 2022-06-20T15:13:08Z

These are some good arguments @colin-grant-work! I wouldn't insist on the reexports, so I'd be fine with simply removing them 👍

thegecko · 2022-06-20T15:23:15Z

Shall I remove the re-exports, then? @colin-grant-work ?

colin-grant-work · 2022-06-20T15:27:24Z

@thegecko, yes please. Sorry for the back and forth on the question! Ping me when you're done, and I'll run through one last time and approve.

Signed-off-by: thegecko <[email protected]>

thegecko · 2022-06-20T16:24:10Z

@thegecko, yes please. Sorry for the back and forth on the question! Ping me when you're done, and I'll run through one last time and approve.

No probs, latest push has removed the original files

colin-grant-work

The new browser adapters are working well, and the old functionality is intact. 👍

vince-fugnitto added debug issues that related to debug functionality vscode issues related to VSCode compatibility labels Feb 14, 2022

thegecko force-pushed the support-browser-debug branch 4 times, most recently from 6e92ea1 to 7ef5794 Compare February 18, 2022 11:04

msujew reviewed Feb 22, 2022

View reviewed changes

thegecko force-pushed the support-browser-debug branch 2 times, most recently from 1e3a0e9 to e58a2a7 Compare February 28, 2022 16:06

thegecko force-pushed the support-browser-debug branch from e58a2a7 to 98d7ced Compare February 28, 2022 17:55

msujew reviewed Mar 17, 2022

View reviewed changes

JonasHelming assigned thegecko May 29, 2022

thegecko mentioned this pull request Jun 16, 2022

Reuse same DebugSessionWidget for all debug sessions. #11277

Merged

2 tasks

thegecko force-pushed the support-browser-debug branch from 98d7ced to 7e889c7 Compare June 17, 2022 16:23

thegecko requested review from msujew and colin-grant-work June 17, 2022 16:24

thegecko force-pushed the support-browser-debug branch from 7e889c7 to d7dbd8b Compare June 17, 2022 16:27

thegecko force-pushed the support-browser-debug branch from d7dbd8b to 377232e Compare June 17, 2022 23:27

colin-grant-work reviewed Jun 20, 2022

View reviewed changes

Support browser debug

bf3863a

Signed-off-by: thegecko <[email protected]>

thegecko force-pushed the support-browser-debug branch from 377232e to bf3863a Compare June 20, 2022 16:23

colin-grant-work approved these changes Jun 21, 2022

View reviewed changes

thegecko merged commit b337a32 into eclipse-theia:master Jun 21, 2022

thegecko deleted the support-browser-debug branch June 21, 2022 06:25

vince-fugnitto added this to the 1.27.0 milestone Jun 30, 2022

thegecko mentioned this pull request Oct 4, 2022

debug: refactor DebugService into DebugServer #11121

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support executing debug in the browser #10748

Support executing debug in the browser #10748

thegecko commented Feb 14, 2022 •

edited

Loading

msujew left a comment

msujew Feb 22, 2022

tsmaeder commented Feb 22, 2022

thegecko commented Feb 22, 2022 •

edited

Loading

thegecko commented Feb 28, 2022

thegecko commented Mar 17, 2022

tsmaeder commented Mar 17, 2022

msujew left a comment

thegecko commented Mar 17, 2022

thegecko commented Mar 17, 2022

msujew commented Mar 17, 2022

thegecko commented Jun 17, 2022

colin-grant-work commented Jun 17, 2022

colin-grant-work Jun 20, 2022

colin-grant-work commented Jun 20, 2022 •

edited

Loading

msujew commented Jun 20, 2022

thegecko commented Jun 20, 2022 •

edited

Loading

colin-grant-work commented Jun 20, 2022

thegecko commented Jun 20, 2022

colin-grant-work left a comment

Support executing debug in the browser #10748

Support executing debug in the browser #10748

Conversation

thegecko commented Feb 14, 2022 • edited Loading

What it does

How to test

Review checklist

Reminder for reviewers

msujew left a comment

Choose a reason for hiding this comment

msujew Feb 22, 2022

Choose a reason for hiding this comment

tsmaeder commented Feb 22, 2022

thegecko commented Feb 22, 2022 • edited Loading

thegecko commented Feb 28, 2022

thegecko commented Mar 17, 2022

tsmaeder commented Mar 17, 2022

msujew left a comment

Choose a reason for hiding this comment

thegecko commented Mar 17, 2022

thegecko commented Mar 17, 2022

msujew commented Mar 17, 2022

thegecko commented Jun 17, 2022

colin-grant-work commented Jun 17, 2022

colin-grant-work Jun 20, 2022

Choose a reason for hiding this comment

colin-grant-work commented Jun 20, 2022 • edited Loading

msujew commented Jun 20, 2022

thegecko commented Jun 20, 2022 • edited Loading

colin-grant-work commented Jun 20, 2022

thegecko commented Jun 20, 2022

colin-grant-work left a comment

Choose a reason for hiding this comment

thegecko commented Feb 14, 2022 •

edited

Loading

thegecko commented Feb 22, 2022 •

edited

Loading

colin-grant-work commented Jun 20, 2022 •

edited

Loading

thegecko commented Jun 20, 2022 •

edited

Loading