Skip to content

feat(debugger): prompt user for target add-on id if not provided and multiple add-ons active in MC. #185

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 9, 2024
Merged

feat(debugger): prompt user for target add-on id if not provided and multiple add-ons active in MC. #185

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0fc953c
Prompt user for target add-on id if not provided and multiple add-ons…
chmeyer-ms Sep 6, 2024
df8de6c
messages
chmeyer-ms Sep 9, 2024
e2a8f11
fix
chmeyer-ms Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 102 additions & 21 deletions src/Session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ import {
ThreadEvent,
Variable,
} from '@vscode/debugadapter';
import { commands, FileSystemWatcher, QuickPickItem, QuickPickOptions, workspace, window } from 'vscode';
import { DebugProtocol } from '@vscode/debugprotocol';
import { LogOutputEvent, LogLevel } from '@vscode/debugadapter/lib/logger';
import { MessageStreamParser } from './MessageStreamParser';
import { SourceMaps } from './SourceMaps';
import { FileSystemWatcher, window, workspace, commands } from 'vscode';
import * as path from 'path';
import * as fs from 'fs';
import { isUUID } from './Utils';
Expand All @@ -33,6 +33,17 @@ interface ModuleMapping {
[moduleName: string]: string;
}

interface PluginDetails {
name: string;
module_uuid: string;
}

interface ProtocolCapabilities {
type: string;
version: number;
plugins: PluginDetails[];
}

// Interface for specific launch arguments.
// See package.json for schema.
interface IAttachRequestArguments extends DebugProtocol.AttachRequestArguments {
Expand All @@ -49,10 +60,33 @@ interface IAttachRequestArguments extends DebugProtocol.AttachRequestArguments {
targetModuleUuid?: string;
}

class TargetPluginItem implements QuickPickItem {
public label: string;
public detail: string;
public targetModuleId: string;

constructor(pluginDetails: PluginDetails) {
this.label = pluginDetails.name;
this.detail = 'Script module uuid ' + pluginDetails.module_uuid;
this.targetModuleId = pluginDetails.module_uuid;
}
}

// protocol version history
// 1 - initial version
// 2 - add targetModuleUuid to protocol event
// 3 - add array of plugins and target module ids to incoming protocol event
enum ProtcolVersion {
Initial = 1,
SupportTargetModuleUuid = 2,
SupportTargetSelection = 3,
}

// The Debug Adapter for 'minecraft-js'
//
export class Session extends DebugSession {
private static DEBUGGER_PROTOCOL_VERSION = 2;
private static DEBUGGER_PROTOCOL_VERSION = ProtcolVersion.SupportTargetSelection;

private static CONNECTION_RETRY_ATTEMPTS = 5;
private static CONNECTION_RETRY_WAIT_MS = 2000;

Expand Down Expand Up @@ -132,13 +166,7 @@ export class Session extends DebugSession {
this.sendErrorResponse(response, 1001, `Failed to attach to Minecraft, invalid port "${args.inputPort}".`);
return;
}

if (!args.targetModuleUuid || args.targetModuleUuid === '' || !isUUID(args.targetModuleUuid)) {
this.showNotification(
'Launch config module target (targetModuleUuid) is not a valid uuid. This should be set to the script module uuid from your manifest.json. Omitting this may cause problems when multiple Minecraft Add-Ons are active.',
LogLevel.Warn
);
} else {
if (args.targetModuleUuid && isUUID(args.targetModuleUuid)) {
this._targetModuleUuid = args.targetModuleUuid.toLowerCase();
}

Expand Down Expand Up @@ -477,7 +505,19 @@ export class Session extends DebugSession {
//
}

private onConnectionComplete() {
private onConnectionComplete(targetModuleUuid?: string) {
this._targetModuleUuid = targetModuleUuid;

// respond with protocol version and chosen debugee target
this.sendDebuggeeMessage({
type: 'protocol',
version: Session.DEBUGGER_PROTOCOL_VERSION,
target_module_uuid: targetModuleUuid,
});

// show notifications for source map issues
this.checkSourceFilePaths();

// success
this.showNotification('Success! Debugger is now connected.', LogLevel.Log);

Expand Down Expand Up @@ -620,8 +660,10 @@ export class Session extends DebugSession {
this.sendEvent(new ThreadEvent(eventMessage.reason, eventMessage.thread));
} else if (eventMessage.type === 'PrintEvent') {
this.handlePrintEvent(eventMessage.message, eventMessage.logLevel);
} else if (eventMessage.type === 'NotificationEvent') {
this.showNotification(eventMessage.message, eventMessage.logLevel);
} else if (eventMessage.type === 'ProtocolEvent') {
this.handleProtocolEvent(eventMessage);
this.handleProtocolEvent(eventMessage as ProtocolCapabilities);
} else if (eventMessage.type === 'StatEvent2') {
this._statsProvider2.setStats(eventMessage as StatMessageModel);
}
Expand Down Expand Up @@ -688,24 +730,63 @@ export class Session extends DebugSession {
// ------------------------------------------------------------------------

// the final client event before connection is complete
private handleProtocolEvent(protocolCapabilities: any) {
private handleProtocolEvent(protocolCapabilities: ProtocolCapabilities) {
//
// handle protocol capabilities here...
// can fail connection on errors
//
if (Session.DEBUGGER_PROTOCOL_VERSION < protocolCapabilities.version) {
this.terminateSession('protocol mismatch. Update Debugger Extension.', LogLevel.Error);
} else {
this.sendDebuggeeMessage({
type: 'protocol',
version: Session.DEBUGGER_PROTOCOL_VERSION,
target_module_uuid: this._targetModuleUuid,
});

this.checkSourceFilePaths();
if (protocolCapabilities.version == ProtcolVersion.SupportTargetModuleUuid) {
this.onConnectionComplete(this._targetModuleUuid);
} else if (protocolCapabilities.version == ProtcolVersion.SupportTargetSelection) {
if (!protocolCapabilities.plugins || protocolCapabilities.plugins.length === 0) {
this.terminateSession('protocol error. No Minecraft Add-Ons found.', LogLevel.Error);
return;
} else if (this._targetModuleUuid) {
const isValidTarget = protocolCapabilities.plugins.some(
plugin => plugin.module_uuid === this._targetModuleUuid
);
if (isValidTarget) {
this.onConnectionComplete(this._targetModuleUuid);
return;
} else {
this.showNotification(
`Minecraft Add-On not found with targetModuleUuid ${this._targetModuleUuid} specified in launch.json. Prompting for debug target.`,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe this should reference the fact that this need to be the script module's UUID, not the add-on's/pack's UUID

LogLevel.Warn
);
}
} else if (protocolCapabilities.plugins.length === 1) {
this.onConnectionComplete(protocolCapabilities.plugins[0].module_uuid);
return;
} else {
this.showNotification(
'The targetModuleUuid in launch.json is not set to a valid uuid. Set this to a script module uuid (manifest.json) to avoid the selection prompt.',
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does code blocks work in the notifications? If so, "The targetModuleUuid in launch.json..." might be better.

LogLevel.Warn
);
}

// success
this.onConnectionComplete();
//
// Could not connect automatically, prompt user to select target.
//
const items: TargetPluginItem[] = protocolCapabilities.plugins.map(
plugin => new TargetPluginItem(plugin)
);
const options: QuickPickOptions = {
title: 'Choose the Minecraft Add-On to debug',
ignoreFocusOut: true,
};
window.showQuickPick(items, options).then(value => {
if (!value) {
this.terminateSession('could not determine target Minecraft Add-On.', LogLevel.Error);
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this say something like "You must select a target module"?

} else {
this.onConnectionComplete(value?.targetModuleId);
}
});
} else {
this.terminateSession('protocol unsupported. Update Debugger Extension.', LogLevel.Error);
}
}
}

Expand Down
Loading