Skip to content

Commit 8e5a9a2

Browse files
author
Akos Kitta
committed
feat: patched the Theia debug functionality
Patch for: - eclipse-theia/theia#11871 - eclipse-theia/theia#11879 - eclipse-theia/theia#11880 - eclipse-theia/theia#11885 - eclipse-theia/theia#11886 - eclipse-theia/theia#11916 Closes #1582 Signed-off-by: Akos Kitta <[email protected]>
1 parent d1b2173 commit 8e5a9a2

15 files changed

+895
-2
lines changed

‎arduino-ide-extension/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@
6060
"@types/react-virtualized": "^9.21.21",
6161
"@types/temp": "^0.8.34",
6262
"@types/which": "^1.3.1",
63+
"@vscode/debugprotocol": "^1.51.0",
6364
"arduino-serial-plotter-webapp": "0.2.0",
6465
"async-mutex": "^0.3.0",
6566
"auth0-js": "^9.14.0",

‎arduino-ide-extension/src/browser/arduino-ide-frontend-module.ts

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import '../../src/browser/style/index.css';
2-
import { ContainerModule } from '@theia/core/shared/inversify';
2+
import { Container, ContainerModule } from '@theia/core/shared/inversify';
33
import { WidgetFactory } from '@theia/core/lib/browser/widget-manager';
44
import { CommandContribution } from '@theia/core/lib/common/command';
55
import { bindViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
@@ -331,6 +331,18 @@ import { TypeHierarchyServiceProvider } from './theia/typehierarchy/type-hierarc
331331
import { TypeHierarchyServiceProvider as TheiaTypeHierarchyServiceProvider } from '@theia/typehierarchy/lib/browser/typehierarchy-service';
332332
import { TypeHierarchyContribution } from './theia/typehierarchy/type-hierarchy-contribution';
333333
import { TypeHierarchyContribution as TheiaTypeHierarchyContribution } from '@theia/typehierarchy/lib/browser/typehierarchy-contribution';
334+
import { DefaultDebugSessionFactory } from './theia/debug/debug-session-contribution';
335+
import { DebugSessionFactory } from '@theia/debug/lib/browser/debug-session-contribution';
336+
import { DebugToolbar } from './theia/debug/debug-toolbar-widget';
337+
import { DebugToolBar as TheiaDebugToolbar } from '@theia/debug/lib/browser/view/debug-toolbar-widget';
338+
import { PluginMenuCommandAdapter } from './theia/plugin-ext/plugin-menu-command-adapter';
339+
import { PluginMenuCommandAdapter as TheiaPluginMenuCommandAdapter } from '@theia/plugin-ext/lib/main/browser/menus/plugin-menu-command-adapter';
340+
import { DebugSessionManager } from './theia/debug/debug-session-manager';
341+
import { DebugSessionManager as TheiaDebugSessionManager } from '@theia/debug/lib/browser/debug-session-manager';
342+
import { DebugWidget } from '@theia/debug/lib/browser/view/debug-widget';
343+
import { DebugViewModel } from '@theia/debug/lib/browser/view/debug-view-model';
344+
import { DebugSessionWidget } from '@theia/debug/lib/browser/view/debug-session-widget';
345+
import { DebugConfigurationWidget } from '@theia/debug/lib/browser/view/debug-configuration-widget';
334346

335347
export default new ContainerModule((bind, unbind, isBound, rebind) => {
336348
// Commands and toolbar items
@@ -960,4 +972,36 @@ export default new ContainerModule((bind, unbind, isBound, rebind) => {
960972
);
961973
bind(TypeHierarchyContribution).toSelf().inSingletonScope();
962974
rebind(TheiaTypeHierarchyContribution).toService(TypeHierarchyContribution);
975+
976+
// patched the debugger for `[email protected]`
977+
// https://github.com/eclipse-theia/theia/issues/11871
978+
// https://github.com/eclipse-theia/theia/issues/11879
979+
// https://github.com/eclipse-theia/theia/issues/11880
980+
// https://github.com/eclipse-theia/theia/issues/11885
981+
// https://github.com/eclipse-theia/theia/issues/11886
982+
// https://github.com/eclipse-theia/theia/issues/11916
983+
// based on: https://github.com/eclipse-theia/theia/compare/master...kittaakos:theia:%2311871
984+
bind(DefaultDebugSessionFactory).toSelf().inSingletonScope();
985+
rebind(DebugSessionFactory).toService(DefaultDebugSessionFactory);
986+
bind(DebugSessionManager).toSelf().inSingletonScope();
987+
rebind(TheiaDebugSessionManager).toService(DebugSessionManager);
988+
bind(DebugToolbar).toSelf().inSingletonScope();
989+
rebind(TheiaDebugToolbar).toService(DebugToolbar);
990+
bind(PluginMenuCommandAdapter).toSelf().inSingletonScope();
991+
rebind(TheiaPluginMenuCommandAdapter).toService(PluginMenuCommandAdapter);
992+
bind(WidgetFactory)
993+
.toDynamicValue(({ container }) => ({
994+
id: DebugWidget.ID,
995+
createWidget: () => {
996+
const child = new Container({ defaultScope: 'Singleton' });
997+
child.parent = container;
998+
child.bind(DebugViewModel).toSelf();
999+
child.bind(DebugToolbar).toSelf(); // patched toolbar
1000+
child.bind(DebugSessionWidget).toSelf();
1001+
child.bind(DebugConfigurationWidget).toSelf();
1002+
child.bind(DebugWidget).toSelf();
1003+
return child.get(DebugWidget);
1004+
},
1005+
}))
1006+
.inSingletonScope();
9631007
});

‎arduino-ide-extension/src/browser/style/index.css

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,3 +176,13 @@ button.theia-button.message-box-dialog-button {
176176
outline: 1px dashed var(--theia-focusBorder);
177177
outline-offset: -2px;
178178
}
179+
180+
.debug-toolbar .debug-action>div {
181+
font-family: var(--theia-ui-font-family);
182+
font-size: var(--theia-ui-font-size0);
183+
display: flex;
184+
align-items: center;
185+
align-self: center;
186+
justify-content: center;
187+
min-height: inherit;
188+
}

‎arduino-ide-extension/src/browser/theia/debug/debug-action.tsx

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import * as React from '@theia/core/shared/react';
2+
import { DebugAction as TheiaDebugAction } from '@theia/debug/lib/browser/view/debug-action';
3+
import {
4+
codiconArray,
5+
DISABLED_CLASS,
6+
} from '@theia/core/lib/browser/widgets/widget';
7+
8+
// customized debug action to show the contributed command's label when there is no icon
9+
export class DebugAction extends TheiaDebugAction {
10+
override render(): React.ReactNode {
11+
const { enabled, label, iconClass } = this.props;
12+
const classNames = ['debug-action', ...codiconArray(iconClass, true)];
13+
if (enabled === false) {
14+
classNames.push(DISABLED_CLASS);
15+
}
16+
return (
17+
<span
18+
tabIndex={0}
19+
className={classNames.join(' ')}
20+
title={label}
21+
onClick={this.props.run}
22+
ref={this.setRef}
23+
>
24+
{!iconClass ||
25+
(iconClass.match(/plugin-icon-\d+/) && <div>{label}</div>)}
26+
</span>
27+
);
28+
}
29+
}

‎arduino-ide-extension/src/browser/theia/debug/debug-session-contribution.ts

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
import { injectable } from '@theia/core/shared/inversify';
2+
import { DebugSessionConnection } from '@theia/debug/lib/browser/debug-session-connection';
3+
import { DefaultDebugSessionFactory as TheiaDefaultDebugSessionFactory } from '@theia/debug/lib/browser/debug-session-contribution';
4+
import { DebugConfigurationSessionOptions } from '@theia/debug/lib/browser/debug-session-options';
5+
import {
6+
DebugAdapterPath,
7+
DebugChannel,
8+
ForwardingDebugChannel,
9+
} from '@theia/debug/lib/common/debug-service';
10+
import { DebugSession } from './debug-session';
11+
12+
@injectable()
13+
export class DefaultDebugSessionFactory extends TheiaDefaultDebugSessionFactory {
14+
override get(
15+
sessionId: string,
16+
options: DebugConfigurationSessionOptions,
17+
parentSession?: DebugSession
18+
): DebugSession {
19+
const connection = new DebugSessionConnection(
20+
sessionId,
21+
() =>
22+
new Promise<DebugChannel>((resolve) =>
23+
this.connectionProvider.openChannel(
24+
`${DebugAdapterPath}/${sessionId}`,
25+
(wsChannel) => {
26+
resolve(new ForwardingDebugChannel(wsChannel));
27+
},
28+
{ reconnecting: false }
29+
)
30+
),
31+
this.getTraceOutputChannel()
32+
);
33+
// patched debug session
34+
return new DebugSession(
35+
sessionId,
36+
options,
37+
parentSession,
38+
connection,
39+
this.terminalService,
40+
this.editorManager,
41+
this.breakpoints,
42+
this.labelProvider,
43+
this.messages,
44+
this.fileService,
45+
this.debugContributionProvider,
46+
this.workspaceService
47+
);
48+
}
49+
}

‎arduino-ide-extension/src/browser/theia/debug/debug-session-manager.ts

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
import type { ContextKey } from '@theia/core/lib/browser/context-key-service';
2+
import { injectable, postConstruct } from '@theia/core/shared/inversify';
3+
import {
4+
DebugSession,
5+
DebugState,
6+
} from '@theia/debug/lib/browser/debug-session';
7+
import { DebugSessionManager as TheiaDebugSessionManager } from '@theia/debug/lib/browser/debug-session-manager';
8+
import type { DebugConfigurationSessionOptions } from '@theia/debug/lib/browser/debug-session-options';
9+
10+
function debugStateLabel(state: DebugState): string {
11+
switch (state) {
12+
case DebugState.Initializing:
13+
return 'initializing';
14+
case DebugState.Stopped:
15+
return 'stopped';
16+
case DebugState.Running:
17+
return 'running';
18+
default:
19+
return 'inactive';
20+
}
21+
}
22+
23+
@injectable()
24+
export class DebugSessionManager extends TheiaDebugSessionManager {
25+
protected debugStateKey: ContextKey<string>;
26+
27+
@postConstruct()
28+
protected override init(): void {
29+
this.debugStateKey = this.contextKeyService.createKey<string>(
30+
'debugState',
31+
debugStateLabel(this.state)
32+
);
33+
super.init();
34+
}
35+
36+
protected override fireDidChange(current: DebugSession | undefined): void {
37+
this.debugTypeKey.set(current?.configuration.type);
38+
this.inDebugModeKey.set(this.inDebugMode);
39+
this.debugStateKey.set(debugStateLabel(this.state));
40+
this.onDidChangeEmitter.fire(current);
41+
}
42+
43+
protected override async doStart(
44+
sessionId: string,
45+
options: DebugConfigurationSessionOptions
46+
): Promise<DebugSession> {
47+
const parentSession =
48+
options.configuration.parentSession &&
49+
this._sessions.get(options.configuration.parentSession.id);
50+
const contrib = this.sessionContributionRegistry.get(
51+
options.configuration.type
52+
);
53+
const sessionFactory = contrib
54+
? contrib.debugSessionFactory()
55+
: this.debugSessionFactory;
56+
const session = sessionFactory.get(sessionId, options, parentSession);
57+
this._sessions.set(sessionId, session);
58+
59+
this.debugTypeKey.set(session.configuration.type);
60+
// this.onDidCreateDebugSessionEmitter.fire(session); // defer the didCreate event after start https://github.com/eclipse-theia/theia/issues/11916
61+
62+
let state = DebugState.Inactive;
63+
session.onDidChange(() => {
64+
if (state !== session.state) {
65+
state = session.state;
66+
if (state === DebugState.Stopped) {
67+
this.onDidStopDebugSessionEmitter.fire(session);
68+
}
69+
}
70+
this.updateCurrentSession(session);
71+
});
72+
session.onDidChangeBreakpoints((uri) =>
73+
this.fireDidChangeBreakpoints({ session, uri })
74+
);
75+
session.on('terminated', async (event) => {
76+
const restart = event.body && event.body.restart;
77+
if (restart) {
78+
// postDebugTask isn't run in case of auto restart as well as preLaunchTask
79+
this.doRestart(session, !!restart);
80+
} else {
81+
await session.disconnect(false, () =>
82+
this.debug.terminateDebugSession(session.id)
83+
);
84+
await this.runTask(
85+
session.options.workspaceFolderUri,
86+
session.configuration.postDebugTask
87+
);
88+
}
89+
});
90+
91+
// eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
92+
session.on('exited', async (event) => {
93+
await session.disconnect(false, () =>
94+
this.debug.terminateDebugSession(session.id)
95+
);
96+
});
97+
98+
session.onDispose(() => this.cleanup(session));
99+
session
100+
.start()
101+
.then(() => {
102+
this.onDidCreateDebugSessionEmitter.fire(session); // now fire the didCreate event
103+
this.onDidStartDebugSessionEmitter.fire(session);
104+
})
105+
// eslint-disable-next-line unused-imports/no-unused-vars, @typescript-eslint/no-unused-vars
106+
.catch((e) => {
107+
session.stop(false, () => {
108+
this.debug.terminateDebugSession(session.id);
109+
});
110+
});
111+
session.onDidCustomEvent(({ event, body }) =>
112+
this.onDidReceiveDebugSessionCustomEventEmitter.fire({
113+
event,
114+
body,
115+
session,
116+
})
117+
);
118+
return session;
119+
}
120+
}

0 commit comments

Comments
 (0)