30096694707

Committed 24 Jul 2026 01:23PM UTC coverage: 59.949% (+0.04%) from 59.908%

Build # 30096694707

Build Type

Pull #802

github

Committed by

web-flow

Commit Message

Merge 333fa7808 into e465804e3

Pull Request Pull Request #802: Route extension logs through the BrightScript Extension output channel

Coverage Stats

2592 of 4745 branches covered (54.63%)

Branch coverage included in aggregate %.

19 of 23 new or added lines in 3 files covered. (82.61%)

732 existing lines in 18 files now uncovered.

4036 of 6311 relevant lines covered (63.95%)

43.79 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

74.29

/src/DebugConfigurationProvider.ts

import { util as bslangUtil } from 'brighterscript';
import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fsExtra from 'fs-extra';
import * as rta from 'roku-test-automation';
import type {
    CancellationToken,
    DebugConfigurationProvider,
    ExtensionContext,
    WorkspaceFolder
} from 'vscode';
import * as vscode from 'vscode';
import type { LaunchConfiguration } from 'roku-debug';
import { fileUtils } from 'roku-debug';
import { util } from './util';
import type { TelemetryManager } from './managers/TelemetryManager';
// eslint-disable-next-line @typescript-eslint/no-require-imports
import cloneDeep = require('clone-deep');
import { rokuDeploy } from 'roku-deploy';
import type { DeviceInfo } from 'roku-deploy';
import type { UserInputManager } from './managers/UserInputManager';
import type { BrightScriptCommands } from './BrightScriptCommands';
import type { RokuProjectManager } from './managers/RokuProject/RokuProjectManager';
import type { DeviceManager, RokuDevice } from './deviceDiscovery/DeviceManager';
import type { CredentialStore } from './managers/CredentialStore';


export class BrightScriptDebugConfigurationProvider implements DebugConfigurationProvider {

    /**
     * Canonical default `files` glob list for a Roku channel launch configuration.
     * Other providers (e.g. ManifestProjectProvider) reference this so the project's
     * notion of "what to deploy" stays in one place.
     *
     * Backed by Roku's documented channel package layout:
     *   - manifest, source/, components/, images/ — listed as standard folders in
     *     https://developer.roku.com/dev/docs/hello-world
     *   - locale/ — auto-loaded for translations and localized images per
     *     https://developer.roku.com/dev/docs/localization
     *   - fonts/ — TrueType/OpenType files loaded via roFontRegistry
     *   - componentLibraries/ — output dir for component-library builds bundled with the channel
     */
    public static readonly defaultFiles: ReadonlyArray<string> = [
        'source/**/*.*',
        'componentLibraries/**/*.*',
        'components/**/*.*',
        'images/**/*.*',
        'locale/**/*',
        'fonts/**/*',
        'manifest'
    ];

    public constructor(
        private context: ExtensionContext,
        private telemetryManager: TelemetryManager,
        private extensionOutputChannel: vscode.OutputChannel,
        private userInputManager: UserInputManager,
        private brightScriptCommands: BrightScriptCommands,
        private deviceManager: DeviceManager,
        private credentialStore: CredentialStore,
        private rokuProjectDiscovery?: RokuProjectManager
    ) {
        this.context = context;
    }

    //make unit testing easier by adding these imports properties
    public fsExtra = fsExtra;
    public util = util;

    private configDefaults: Partial<BrightScriptLaunchConfiguration> = {
        type: 'brightscript',
        name: 'BrightScript Debug: Launch',
        host: '${promptForHost}',
        password: '${promptForPassword}',
        consoleOutput: 'normal',
        request: 'launch',
        stopOnEntry: false,
        outDir: '${workspaceFolder}/out/',
        retainDeploymentArchive: true,
        injectRaleTrackerTask: false,
        injectRdbOnDeviceComponent: false,
        disableScreenSaver: true,
        retainStagingFolder: false,
        enableVariablesPanel: true,
        deferScopeLoading: false,
        autoResolveVirtualVariables: false,
        enhanceREPLCompletions: true,
        showHiddenVariables: false,
        enableDebuggerAutoRecovery: false,
        stopDebuggerOnAppExit: false,
        autoRunSgDebugCommands: [],
        files: [...BrightScriptDebugConfigurationProvider.defaultFiles],
        enableSourceMaps: true,
        rewriteDevicePathsInLogs: true,
        packagePort: 80,
        enableDebugProtocol: true,
        remotePort: 8060,
        rendezvousTracking: true,
        deleteDevChannelBeforeInstall: false,
        sceneGraphDebugCommandsPort: 8080,
        componentLibrariesPort: 8080,
        remoteControlMode: {
            activateOnSessionStart: false,
            deactivateOnSessionEnd: false
        }
    };

    public async provideDebugConfigurations(folder?: WorkspaceFolder, _token?: CancellationToken): Promise<vscode.DebugConfiguration[]> {
        return (await this.rokuProjectDiscovery?.provideDebugConfigurations(folder)) ?? [];
    }

    /**
     * Massage a debug configuration just before a debug session is being launched,
     * e.g. add all missing attributes to the debug configuration.
     */
    public async resolveDebugConfiguration(folder: WorkspaceFolder | undefined, config: BrightScriptLaunchConfiguration, token?: CancellationToken): Promise<BrightScriptLaunchConfiguration> {
        // F5 with no launch.json — ask RokuProjectDiscovery to find a config from the active file.
        if (!config.type && !config.request) {
            const discovered = await this.rokuProjectDiscovery?.resolveDebugConfigFromActiveFile();
            if (!discovered) {
                return undefined;
            }
            config = discovered as BrightScriptLaunchConfiguration;
        }

        let deviceInfo: DeviceInfo;
        let result: BrightScriptLaunchConfiguration;
        try {
            // merge user and workspace settings into the config
            result = this.processUserWorkspaceSettings(config);

            //force a specific stagingDir because sometimes this conflicts with bsconfig.json
            result.stagingDir ??= path.join('${outDir}/.roku-deploy-staging');
            result.stagingFolderPath = result.stagingDir;

            result = await this.sanitizeConfiguration(result, folder);
            result = await this.processEnvVariables(folder, result);
            result = await this.processHostParameter(result);
            result = await this.processPasswordParameter(config, result);
            result = await this.processDeepLinkUrlParameter(result);
            result = await this.processLogfilePath(folder, result);
            result = this.processDapLogFilePath(folder, result);

            // `processHostParameter` attached the raw device-info it gathered while probing the host.
            // Enhance a local copy here for the developer-mode check + telemetry (no request to the device).
            if (result.deviceInfo) {
                deviceInfo = rokuDeploy.enhanceDeviceInfo(result.deviceInfo);
            }

            if (deviceInfo && !deviceInfo.developerEnabled) {
                throw new Error(`Cannot deploy: developer mode is disabled on '${result.host}'`);
            }
            await this.context.workspaceState.update('enableDebuggerAutoRecovery', result.enableDebuggerAutoRecovery);

            //advertise the optional features this client supports to the debug adapter. This is populated by the
            //extension itself (not a user-facing setting) and gates optional roku-debug behavior like the
            //`processStagingDir` reverse request.
            result.clientCapabilities = {
                supportsProcessStagingDir: true
            };

            return result;
        } catch (e) {
            //log any exceptions to the extension panel
            this.extensionOutputChannel.append((e as Error).stack);
            throw e;
        } finally {
            //send telemetry about this debug session (don't worry, it gets sanitized...we're just checking if certain features are being used)
            this.telemetryManager?.sendStartDebugSessionEvent(
                this.processUserWorkspaceSettings(config) as any,
                result,
                deviceInfo
            );
        }
    }

    /**
     * There are several debug-level config values that can be stored in user settings, so get those
     */
    private processUserWorkspaceSettings(config: BrightScriptLaunchConfiguration): BrightScriptLaunchConfiguration {
        const workspaceConfig = util.getConfiguration('brightscript.debug');

        let userWorkspaceSettings = {} as BrightScriptLaunchConfiguration;

        //only keep the config values that were explicitly defined in a config file (i.e. exclude default values)
        for (const key of Object.keys(workspaceConfig)) {
            const inspection = workspaceConfig.inspect(key);
            //if the value was explicitly defined by the user in one of the various locations, then keep this value
            if (
                inspection.globalValue !== undefined ||
                inspection.workspaceValue !== undefined ||
                inspection.globalLanguageValue !== undefined ||
                inspection.defaultLanguageValue !== undefined ||
                inspection.workspaceFolderValue !== undefined ||
                inspection.workspaceLanguageValue !== undefined ||
                inspection.workspaceFolderLanguageValue !== undefined
            ) {
                userWorkspaceSettings[key] = workspaceConfig[key];
            }
        }

        //merge the user/workspace settings in with the config (the config wins on conflict)
        const result = {
            ...userWorkspaceSettings ?? {},
            ...cloneDeep(config ?? {})
        };
        return result as BrightScriptLaunchConfiguration;
    }

    /**
     * Takes the launch.json config and applies any defaults to missing values and sanitizes some of the more complex options
     * @param config current config object
     */
    private async sanitizeConfiguration(config: BrightScriptLaunchConfiguration, folder: WorkspaceFolder): Promise<BrightScriptLaunchConfiguration> {
        let userWorkspaceSettings: any = util.getConfiguration('brightscript') || {};

        //make sure we have an object
        config = {

            //the workspace settings are the baseline
            ...userWorkspaceSettings,
            //override with any debug-specific settings
            ...config
        };

        let folderUri: vscode.Uri;
        //use the workspace folder provided
        if (folder) {
            folderUri = folder.uri;

            //if there's only one workspace, use that workspace's folder path
        } else if (vscode.workspace.workspaceFolders?.length === 1) {
            folderUri = vscode.workspace.workspaceFolders[0].uri;
        } else {
            //there are multiple workspaces, ask the user to specify which one they want to use
            let workspaceFolder = await vscode.window.showWorkspaceFolderPick();
            if (workspaceFolder) {
                folderUri = workspaceFolder.uri;
            }
        }

        if (!folderUri) {
            //cancel this whole thing because we can't continue without the user specifying a workspace folder
            throw new Error('Cannot determine which workspace to use for brightscript debugging');
        }

        //load the bsconfig settings (if available)
        let bsconfig = this.getBsConfig(folderUri);
        if (bsconfig) {
            config = { ...bsconfig, ...config };
        }

        config.cwd = folderUri.fsPath;

        config.rootDir = this.util.ensureTrailingSlash(config.rootDir ? config.rootDir : '${workspaceFolder}');

        //Check for depreciated Items
        if (config.debugRootDir) {
            if (config.sourceDirs) {
                throw new Error('Cannot set both debugRootDir AND sourceDirs');
            } else {
                config.sourceDirs = [this.util.ensureTrailingSlash(config.debugRootDir)];
            }
        } else if (config.sourceDirs) {
            let dirs: string[] = [];

            for (let dir of config.sourceDirs) {
                dirs.push(this.util.ensureTrailingSlash(dir));
            }
            config.sourceDirs = dirs;
        } else if (!config.sourceDirs) {
            config.sourceDirs = [];
        }

        if (config.componentLibraries) {
            config.componentLibrariesOutDir = this.util.ensureTrailingSlash(config.componentLibrariesOutDir ? config.componentLibrariesOutDir : '${workspaceFolder}/libs');

            for (let library of config.componentLibraries as any) {
                library.rootDir = this.util.ensureTrailingSlash(library.rootDir);
                library.files = library.files ? library.files : [...BrightScriptDebugConfigurationProvider.defaultFiles];
            }
        } else {
            //create an empty array so it's easier to reason with downstream
            config.componentLibraries = [];
        }

        // Apply any defaults to missing values
        for (const key in this.configDefaults) {
            config[key] ??= this.configDefaults[key];
        }

        // Run any required post processing after applying defaults
        config.outDir = this.util.ensureTrailingSlash(config.outDir);

        // Pass along files needed by RDB to roku-debug
        config.rdbFilesBasePath = rta.utils.getDeviceFilesPath();

        //if packageTask is defined, make sure there's actually a task with that name defined
        if (config.packageTask) {
            const targetTask = (await vscode.tasks.fetchTasks()).find(x => x.name === config.packageTask);
            if (!targetTask) {
                throw new Error(`Cannot find task '${config.packageTask}' for launch option 'packageTask'`);
            }
        }

        if (typeof config.remoteControlMode === 'boolean') {
            config.remoteControlMode = {
                activateOnSessionStart: config.remoteControlMode,
                deactivateOnSessionEnd: config.remoteControlMode
            };
        } else {
            config.remoteControlMode = {
                activateOnSessionStart: config.remoteControlMode?.activateOnSessionStart ?? this.configDefaults.remoteControlMode.activateOnSessionStart,
                deactivateOnSessionEnd: config.remoteControlMode?.deactivateOnSessionEnd ?? this.configDefaults.remoteControlMode.deactivateOnSessionEnd
            };
        }

        if (config.request !== 'launch') {
            await vscode.window.showErrorMessage(`roku-debug only supports the 'launch' request type`);
        }

        if (config.raleTrackerTaskFileLocation?.includes('${workspaceFolder}')) {
            config.raleTrackerTaskFileLocation = path.normalize(config.raleTrackerTaskFileLocation.replace('${workspaceFolder}', folderUri.fsPath));
        }

        // Check for the existence of the tracker task file in auto injection is enabled
        if (config.injectRaleTrackerTask) {
            if (!config.raleTrackerTaskFileLocation) {
                await vscode.window.showErrorMessage(`"raleTrackerTaskFileLocation" must be defined when "injectRaleTrackerTask" is enabled`);
            } else if (await this.util.fileExists(config.raleTrackerTaskFileLocation) === false) {
                await vscode.window.showErrorMessage(`injectRaleTrackerTask was set to true but could not find TrackerTask.xml at:\n${config.raleTrackerTaskFileLocation}`);
            }
        }

        //for rootDir, replace workspaceFolder now to avoid issues in vscode itself
        if (config.rootDir.includes('${workspaceFolder}')) {
            config.rootDir = path.normalize(config.rootDir.replace('${workspaceFolder}', folderUri.fsPath));
        }

        //for outDir, replace workspaceFolder now
        if (config.outDir.includes('${workspaceFolder}')) {
            config.outDir = path.normalize(config.outDir.replace('${workspaceFolder}', folderUri.fsPath));
        }

        if (config.stagingFolderPath.includes('${outDir}')) {
            config.stagingFolderPath = path.normalize(config.stagingFolderPath.replace('${outDir}', config.outDir));
        }
        if (config.stagingFolderPath.includes('${workspaceFolder}')) {
            config.stagingFolderPath = path.normalize(config.stagingFolderPath.replace('${workspaceFolder}', folderUri.fsPath));
        }

        if (config.stagingDir.includes('${outDir}')) {
            config.stagingDir = path.normalize(config.stagingDir.replace('${outDir}', config.outDir));
        }
        if (config.stagingDir.includes('${workspaceFolder}')) {
            config.stagingDir = path.normalize(config.stagingDir.replace('${workspaceFolder}', folderUri.fsPath));
        }


        // Make sure that directory paths end in a trailing slash
        if (config.debugRootDir) {
            config.debugRootDir = this.util.ensureTrailingSlash(config.debugRootDir);
        }

        if (config.packagePath?.includes('${workspaceFolder}')) {
            config.packagePath = path.normalize(config.packagePath.replace('${workspaceFolder}', folderUri.fsPath));
        }
        if (config.packagePath?.includes('${outDir}')) {
            config.packagePath = path.normalize(config.packagePath.replace('${outDir}', config.outDir));
        }

        if (!config.rootDir) {
            console.log('No rootDir specified: defaulting to ${workspaceFolder}');
            //use the current workspace folder
            config.rootDir = folderUri.fsPath;
        }

        return config;
    }

    public async processLogfilePath(folder: WorkspaceFolder | undefined, config: BrightScriptLaunchConfiguration) {
        if (config?.logfilePath?.trim()) {
            config.logfilePath = config.logfilePath.trim();
            if (config.logfilePath.includes('${workspaceFolder}')) {
                config.logfilePath = config.logfilePath.replace('${workspaceFolder}', folder.uri.fsPath);
            }

            try {
                config.logfilePath = fileUtils.standardizePath(config.logfilePath);
                //create the logfile folder structure if not exist
                fsExtra.ensureDirSync(path.dirname(config.logfilePath));

                //create the log file if it doesn't exist
                if (!fsExtra.pathExistsSync(config.logfilePath)) {
                    fsExtra.createFileSync(config.logfilePath);
                }
                await this.context.workspaceState.update('logfilePath', config.logfilePath);
            } catch (e) {
                throw new Error(`Could not create logfile at "${config.logfilePath}"`);
            }
        }
        return config;
    }

    public processDapLogFilePath(folder: WorkspaceFolder | undefined, config: BrightScriptLaunchConfiguration) {
        if (!config.debugAdapterProtocolLogging) {
            return config;
        }
        const folderPath = folder?.uri.fsPath ?? process.cwd();
        const dir = path.resolve(folderPath, './logs');
        const timestamp = new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
        fsExtra.ensureDirSync(dir);
        config.debugAdapterProtocolLogFilePath = path.join(dir, `${timestamp}-debugAdapterProtocol.log`);
        return config;
    }

    /**
     * Resolves any `${env:*}` placeholders in the config using the process environment
     * and (if present) the optional `.env` file, without mutating `process.env`.
     * @param folder current workspace folder
     * @param config current config object
     */
    private async processEnvVariables(folder: WorkspaceFolder | undefined, config: BrightScriptLaunchConfiguration): Promise<BrightScriptLaunchConfiguration> {
        //start with a copy of the current process environment so we never mutate process.env
        let environmentValues = { ...process.env };
        let loadedEnvFile = false;

        //layer any values from the .env file on top of the process environment (the .env file is optional)
        if (config.envFile) {
            let envFilePath = config.envFile;
            //resolve ${workspaceFolder} so we can actually load the .env file now
            if (config.envFile.includes('${workspaceFolder}')) {
                envFilePath = config.envFile.replace('${workspaceFolder}', folder.uri.fsPath);
            }
            if (await this.util.fileExists(envFilePath) === false) {
                //the .env file is optional, so just warn instead of failing the debug session
                console.warn(`Cannot find .env file at "${envFilePath}". Falling back to the process environment for '\${env:*}' values.`);
            } else {
                //parse the .env file, letting its values override the process environment
                environmentValues = {
                    ...environmentValues,
                    ...dotenv.parse(await this.fsExtra.readFile(envFilePath))
                };
                loadedEnvFile = true;
            }
        }

        // temporarily convert entire config to string for any environment replacements.
        let configString = JSON.stringify(config);
        let match: RegExpMatchArray;
        let regexp = /\$\{env:([\w\d_]*)\}/g;
        let updatedConfigString = configString;

        // apply any defined values to env placeholders
        while ((match = regexp.exec(configString))) {
            let environmentVariableName = match[1];
            let environmentVariableValue = environmentValues[environmentVariableName];

            if (environmentVariableValue) {
                updatedConfigString = updatedConfigString.replace(match[0], environmentVariableValue);
            }
        }

        config = JSON.parse(updatedConfigString);

        let configDefaults = {
            rootDir: config.rootDir,
            ...this.configDefaults
        };

        // apply any default values to env placeholders
        for (let key in config) {
            let configValue = config[key];
            let match: RegExpMatchArray;
            //replace all environment variable placeholders with their values
            while ((match = regexp.exec(configValue))) {
                let environmentVariableName = match[1];
                configValue = configDefaults[key];
                console.log(`The configuration value for ${key} was not found in the environment variables${loadedEnvFile ? ' or env file' : ''} under the name ${environmentVariableName}. Defaulting the value to: ${configValue}`);
            }
            config[key] = configValue;
        }
        return config;
    }

    /**
     * Validates the host parameter in the config and opens an input ui if set to ${promptForHost}.
     * ${activeHost} is a deprecated alias for ${promptForHost}.
     * Both use the active device when it's set and passes a health check, otherwise fall back to the device picker.
     *
     * Assigns the raw `device-info` gathered while probing the resolved host onto `config.deviceInfo`,
     * so downstream password resolution and the debug session can reuse it without re-fetching.
     * Throws if the device couldn't be reached (no device-info came back).
     * @param config  current config object
     */
    private async processHostParameter(config: BrightScriptLaunchConfiguration): Promise<BrightScriptLaunchConfiguration> {
        const trimmedHost = config.host.trim();
        const needsHostPrompt =
            trimmedHost === '' ||
            trimmedHost === '${promptForHost}' ||
            trimmedHost === '${activeHost}' ||
            config?.deepLinkUrl?.includes('${promptForHost}');

        let device: RokuDevice | undefined;

        if (needsHostPrompt) {
            // both the active-host lookup and the picker probe + register the device in the device
            // manager, so reuse it below instead of probing again
            let resolved = await this.brightScriptCommands.getHealthyActiveHost();
            if (!resolved) {
                resolved = await this.userInputManager.promptForHost();
                if (resolved?.host) {
                    //the active device (if there was one) couldn't be located and the user picked a device
                    //themselves, so forget the saved active device unless they picked that same device
                    await this.deviceManager.forgetActiveDeviceIfDifferent(resolved.host);
                }
            }
            config.host = resolved?.host;
            if (resolved?.host) {
                device = this.deviceManager.getDevice({ ip: resolved.host });
            }
        }

        //check the host and throw error if not provided or update the workspace to set last host
        if (!config.host) {
            throw new Error('Debug session terminated: host is required.');
        } else {
            await this.context.workspaceState.update('remoteHost', config.host);
        }

        // If the host didn't come from the picker, probe it so we have fresh SN/deviceInfo.
        device ??= await this.deviceManager.validateAndAddDevice(config.host);

        // A reachable developer device always returns device-info; its absence means we couldn't reach it.
        if (!device?.deviceInfo || Object.keys(device.deviceInfo).length === 0) {
            throw new Error(`Debug session terminated: unable to reach device at '${config.host}'.`);
        }

        // Attach the raw device-info so downstream password resolution and the debug session can reuse it
        // without another request to the device.
        config.deviceInfo = device.deviceInfo;

        return config;
    }

    /**
     * Resolve the device password for the launch configuration.
     *
     * Collects candidate passwords from every known source (cred store, matching
     * `brightscript.devices[]` entry across scopes, `brightscript.defaultDevicePassword`,
     * the merged `result.password`, and the raw `config.password`), dedupes them,
     * validates each against the device in order, and uses the first that is
     * accepted. The winning password is cached in the cred store so later launches
     * resolve without re-validating every candidate. If no candidate is accepted,
     * the user is prompted.
     *
     * @param config  the raw launch configuration as received from VS Code
     * @param result  the merged/resolved config being built up. Its `deviceInfo` (set by
     *                `processHostParameter`) supplies the serial number used to look up credentials.
     */
    private async processPasswordParameter(
        config: BrightScriptLaunchConfiguration,
        result: BrightScriptLaunchConfiguration
    ): Promise<BrightScriptLaunchConfiguration> {
        const host = result.host;
        const serialNumber = result.deviceInfo?.['serial-number'];

        // Opportunistically drain any legacy IP-keyed password that still lives in
        // workspaceState from pre-refactor extension installs. Reads never consult
        // this store anymore; it's peeked here and disposed of once we know whether
        // it works. This step is best-effort: an unreachable device just means we
        // try again next launch; the authoritative error surfaces from the main flow.
        const legacyPassword = this.getLegacyIpKeyedPassword(host);
        if (legacyPassword !== undefined) {
            const validation = await this.deviceManager.validateDevicePassword(host, legacyPassword);
            if (validation === 'ok') {
                await this.clearLegacyIpKeyedPassword(host);
                // A legacy entry is explicit historical opt-in: persist it to the cred store
                // (unconditionally, unlike the normal "refresh existing only" gate) and the
                // global fallback, then use it.
                if (serialNumber) {
                    await this.credentialStore.setPassword(serialNumber, legacyPassword);
                }
                result.password = legacyPassword;
                await this.context.workspaceState.update('remotePassword', legacyPassword);
                return result;
            } else if (validation === 'bad-password') {
                // Reads don't use the legacy store anymore, so a proven-wrong entry is dead weight.
                await this.clearLegacyIpKeyedPassword(host);
            }
            // 'unreachable' — leave the legacy entry alone (it may still be correct) and
            // fall through to the normal candidate flow, which will surface its own error.
        }

        // Resolve and validate the password against the device, trying the launch config's own
        // `result.password`/`config.password` after the standard credential sources. The resolver
        // prompts (and persists an accepted password) the same way it does for the other commands.
        const resolution = await this.userInputManager.resolveDevicePassword({
            host: host,
            serialNumber: serialNumber,
            extraCandidates: [result.password, config.password]
        });
        if (resolution.status === 'unreachable') {
            throw new Error(`Debug session terminated: device at ${host} is unreachable.`);
        }
        if (resolution.status === 'cancelled') {
            throw new Error('Debug session terminated: password is required.');
        }
        result.password = resolution.password;
        // Keep the global password fallback in sync so later launches resolve without re-prompting.
        await this.context.workspaceState.update('remotePassword', resolution.password);
        return result;
    }

    private readonly legacyPasswordStoreKey = 'devicePasswords';

    /**
     * Peek the legacy IP-keyed password store (`workspaceState.devicePasswords`).
     * Reads never use this store anymore; it's consulted only for one-shot
     * migration inside `processPasswordParameter` and drained on the first
     * successful device contact.
     */
    private getLegacyIpKeyedPassword(ip: string): string | undefined {
        if (!ip) {
            return undefined;
        }
        const map = this.context.workspaceState.get<Record<string, string>>(this.legacyPasswordStoreKey) ?? {};
        return map[ip];
    }

    /**
     * Remove an entry from the legacy IP-keyed password store.
     */
    private async clearLegacyIpKeyedPassword(ip: string): Promise<void> {
        if (!ip) {
            return;
        }
        const map = this.context.workspaceState.get<Record<string, string>>(this.legacyPasswordStoreKey) ?? {};
        if (!(ip in map)) {
            return;
        }
        delete map[ip];
        await this.context.workspaceState.update(this.legacyPasswordStoreKey, map);
    }

    /**
     * Validates the deepLinkUrl parameter in the config and opens an input ui if set to ${promptForDeepLinkUrl} or if the url contains ${promptForQueryParams
     * @param config  current config object
     */
    private async processDeepLinkUrlParameter(config: BrightScriptLaunchConfiguration) {
        if (config.deepLinkUrl) {
            config.deepLinkUrl = config.deepLinkUrl.replace('${host}', config.host);
            config.deepLinkUrl = config.deepLinkUrl.replace('${promptForHost}', config.host);
            if (config.deepLinkUrl.includes('${promptForQueryParams}')) {
                let queryParams = await this.openInputBox('Querystring params for deep link');
                config.deepLinkUrl = config.deepLinkUrl.replace('${promptForQueryParams}', queryParams);
            }
            if (config.deepLinkUrl === '${promptForDeepLinkUrl}') {
                config.deepLinkUrl = await this.openInputBox('Full deep link url');
            }
        }
        return config;
    }

    /**
     * Helper to open a vscode input box ui
     * @param placeHolder placeHolder text
     * @param value default value
     */
    private async openInputBox(placeHolder: string, value = '') {
        return vscode.window.showInputBox({
            placeHolder: placeHolder,
            value: value
        });
    }

    /**
     * Get the bsconfig file, if available
     */
    public getBsConfig(workspaceFolder: vscode.Uri) {
        //try to load bsconfig settings
        let settings = util.getConfiguration('brightscript', workspaceFolder);
        let configFilePath = settings.get<string>('configFile');
        let isDefaultPath = false;
        if (!configFilePath) {
            isDefaultPath = true;
            configFilePath = 'bsconfig.json';
        }

        //if the path is relative, resolve it relative to the workspace folder. If it's absolute, use as is (path.resolve handles this logic for us)
        let workspaceFolderPath = bslangUtil.uriToPath(workspaceFolder.toString());
        configFilePath = path.resolve(workspaceFolderPath, configFilePath);
        try {
            let bsconfig = bslangUtil.loadConfigFile(configFilePath);
            return bsconfig;
        } catch (e) {
            //only log the error if the user explicitly defined a config path
            if (!isDefaultPath) {
                console.error(`Could not load bsconfig file at "${configFilePath}`);
            }
            return undefined;
        }
    }
}

export interface BrightScriptLaunchConfiguration extends LaunchConfiguration {
    /**
     * The name of this launch configuration
     */
    name: string;
    /**
     * The type of this debug configuration
     */
    type: string;
    /**
     * Should the debugger launch or attach. roku-debug only supports launching
     */
    request: 'launch' | 'attach';

    /**
     * A path to a file where all brightscript console output will be written. If falsey, file logging will be disabled.
     */
    logfilePath?: string;

    /**
     * Enable DAP protocol logging. Can be set via the `brightscript.debug.debugAdapterProtocolLogging` workspace setting or in launch.json.
     * The resolved absolute log file path is written to `debugAdapterProtocolLogFilePath` by `processDapLogFilePath`
     * and passed to the debug adapter process as the `ROKU_DAP_LOG_FILE` env var by the descriptor factory.
     */
    debugAdapterProtocolLogging?: boolean;

    /**
     * Resolved absolute path for the DAP protocol log file, populated by `processDapLogFilePath`.
     * Consumed by the DebugAdapterDescriptorFactory to inject `ROKU_DAP_LOG_FILE` into the adapter process.
     */
    debugAdapterProtocolLogFilePath?: string;
    /**
     *  If true, then the zip archive is NOT deleted after a debug session has been closed.
     * @default true
     */
    retainDeploymentArchive?: boolean;

    /**
     * A path to an environment variables file which will be used to augment the launch config
     */
    envFile?: string;

    /**
     * If injectRdbOnDeviceComponent is true and this is true the screen saver will be be disabled while the deployed application is running.
     */
    disableScreenSaver?: boolean;

    /**
     * If set, the remote control will be enabled/disabled at the start/end of the debug session, respectively.
     * @default { activateOnSessionStart: false, deactivateOnSessionEnd: false }
     */
    remoteControlMode?: { activateOnSessionStart?: boolean; deactivateOnSessionEnd?: boolean };
}

rokucommunity / vscode-brightscript-language / 30096694707

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous