Base explorer refreshes on streamed events instead of polling so freq…

…uently (#3680)

package.json

@@ -1540,11 +1540,6 @@
                     "default": true,
                     "description": "%vscode-docker.config.docker.promptForRegistryWhenPushingImages%"
                 },
-                "docker.explorerRefreshInterval": {
-                    "type": "number",
-                    "default": 2000,
-                    "description": "%vscode-docker.config.docker.explorerRefreshInterval%"
-                },
                 "docker.commands.build": {
                     "oneOf": [
                         {
@@ -2979,6 +2974,7 @@
         "node-fetch": "^2.6.7",
         "semver": "^7.3.7",
         "tar": "^6.1.11",
+        "tree-kill": "^1.2.2",
         "vscode-languageclient": "^8.0.2",
         "vscode-nls": "^5.0.0",
         "vscode-tas-client": "^0.1.22",

package.nls.json

@@ -152,7 +152,6 @@
     "vscode-docker.config.template.composeDown.label": "The label displayed to the user.",
     "vscode-docker.config.template.composeDown.match": "The regular expression for choosing the right template. Checked against docker-compose YAML files, folder name, etc.",
     "vscode-docker.config.template.composeDown.description": "Command templates for `docker-compose down` commands.",
-    "vscode-docker.config.docker.explorerRefreshInterval": "Docker view refresh interval (milliseconds)",
     "vscode-docker.config.docker.containers.groupBy": "The property to use to group containers in Docker view: ContainerId, ContainerName, CreatedTime, FullTag, ImageId, Networks, Ports, Registry, Repository, RepositoryName, RepositoryNameAndTag, State, Status, Tag, or None",
     "vscode-docker.config.docker.containers.description": "Any secondary properties to display for a container (an array). Possible elements include: ContainerId, ContainerName, CreatedTime, FullTag, ImageId, Networks, Ports, Registry, Repository, RepositoryName, RepositoryNameAndTag, State, Status, and Tag",
     "vscode-docker.config.docker.containers.label": "The primary property to display for a container: ContainerId, ContainerName, CreatedTime, FullTag, ImageId, Networks, Ports, Registry, Repository, RepositoryName, RepositoryNameAndTag, State, Status, or Tag",

src/commands/containers/attachShellContainer.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { ContainerOS } from '../../runtimes/docker';
+import { ContainerOS, VoidCommandResponse } from '../../runtimes/docker';
 import { IActionContext } from '@microsoft/vscode-azext-utils';
 import { ext } from '../../extensionVariables';
 import { localize } from '../../localize';
@@ -34,7 +34,8 @@ export async function attachShellContainer(context: IActionContext, node?: Conta
         try {
             // If this succeeds, bash is present (exit code 0)
             await ext.runWithDefaultShell(client =>
-                client.execContainer({ container: node.containerId, interactive: true, command: ['sh', '-c', 'which bash'] })
+                // Since we're not interested in the output, just the exit code, we can pretend this is a `VoidCommandResponse`
+                client.execContainer({ container: node.containerId, interactive: true, command: ['sh', '-c', 'which bash'] }) as Promise<VoidCommandResponse>
             );
             shellCommand = 'bash';
         } catch {

src/commands/containers/composeGroup.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { CommandResponse, CommonOrchestratorCommandOptions, IContainerOrchestratorClient, LogsCommandOptions } from '../../runtimes/docker';
+import { CommonOrchestratorCommandOptions, IContainerOrchestratorClient, LogsCommandOptions, VoidCommandResponse } from '../../runtimes/docker';
 import { IActionContext } from '@microsoft/vscode-azext-utils';
 import * as path from 'path';
 import { ext } from '../../extensionVariables';
@@ -13,7 +13,8 @@ import { ContainerGroupTreeItem } from '../../tree/containers/ContainerGroupTree
 import { ContainerTreeItem } from '../../tree/containers/ContainerTreeItem';
 
 export async function composeGroupLogs(context: IActionContext, node: ContainerGroupTreeItem): Promise<void> {
-    return composeGroup<LogsCommandOptions>(context, (client, options) => client.logs(options), node, { follow: true, tail: 1000 });
+    // Since we're not interested in the output, we can pretend this is a `VoidCommandResponse`
+    return composeGroup<LogsCommandOptions>(context, (client, options) => client.logs(options) as Promise<VoidCommandResponse>, node, { follow: true, tail: 1000 });
 }
 
 export async function composeGroupStart(context: IActionContext, node: ContainerGroupTreeItem): Promise<void> {
@@ -36,7 +37,7 @@ type AdditionalOptions<TOptions extends CommonOrchestratorCommandOptions> = Omit
 
 async function composeGroup<TOptions extends CommonOrchestratorCommandOptions>(
     context: IActionContext,
-    composeCommandCallback: (client: IContainerOrchestratorClient, options: TOptions) => Promise<CommandResponse<unknown>>,
+    composeCommandCallback: (client: IContainerOrchestratorClient, options: TOptions) => Promise<VoidCommandResponse>,
     node: ContainerGroupTreeItem,
     additionalOptions?: AdditionalOptions<TOptions>
 ): Promise<void> {

src/commands/registries/logInToDockerCli.ts

@@ -11,7 +11,6 @@ import { ext } from '../../extensionVariables';
 import { localize } from "../../localize";
 import { registryExpectedContextValues } from '../../tree/registries/registryContextValues';
 import { RegistryTreeItemBase } from '../../tree/registries/RegistryTreeItemBase';
-import { runWithDefaultShell } from '../../runtimes/runners/runWithDefaultShell';
 
 export async function logInToDockerCli(context: IActionContext, node?: RegistryTreeItemBase): Promise<void> {
     if (!node) {
@@ -40,13 +39,12 @@ export async function logInToDockerCli(context: IActionContext, node?: RegistryT
 
         await vscode.window.withProgress(progressOptions, async () => {
             try {
-                await runWithDefaultShell(
+                await ext.runWithDefaultShell(
                     client => client.login({
                         username: username,
                         passwordStdIn: true,
                         registry: creds.registryPath,
                     }),
-                    ext.runtimeManager,
                     {
                         stdInPipe: stream.Readable.from(password),
                     }

src/commands/selectCommandTemplate.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See LICENSE.md in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { CommandResponse, PortBinding } from '../runtimes/docker';
+import { PortBinding, VoidCommandResponse } from '../runtimes/docker';
 import { IActionContext, IAzureQuickPickItem, IAzureQuickPickOptions, UserCancelledError } from '@microsoft/vscode-azext-utils';
 import * as vscode from 'vscode';
 import { ext } from '../extensionVariables';
@@ -29,7 +29,7 @@ export interface CommandTemplate {
     match?: string;
 }
 
-export async function selectBuildCommand(context: IActionContext, folder: vscode.WorkspaceFolder, dockerfile: string, buildContext: string): Promise<CommandResponse<void>> {
+export async function selectBuildCommand(context: IActionContext, folder: vscode.WorkspaceFolder, dockerfile: string, buildContext: string): Promise<VoidCommandResponse> {
     return await selectCommandTemplate(
         context,
         'build',
@@ -39,7 +39,7 @@ export async function selectBuildCommand(context: IActionContext, folder: vscode
     );
 }
 
-export async function selectRunCommand(context: IActionContext, fullTag: string, interactive: boolean, exposedPorts?: PortBinding[]): Promise<CommandResponse<void>> {
+export async function selectRunCommand(context: IActionContext, fullTag: string, interactive: boolean, exposedPorts?: PortBinding[]): Promise<VoidCommandResponse> {
     let portsString: string = '';
     if (exposedPorts) {
         portsString = exposedPorts.map(pb => `-p ${pb.containerPort}:${pb.containerPort}${pb.protocol ? '/' + pb.protocol : ''}`).join(' ');
@@ -54,7 +54,7 @@ export async function selectRunCommand(context: IActionContext, fullTag: string,
     );
 }
 
-export async function selectAttachCommand(context: IActionContext, containerName: string, imageName: string, containerId: string, shellCommand: string): Promise<CommandResponse<void>> {
+export async function selectAttachCommand(context: IActionContext, containerName: string, imageName: string, containerId: string, shellCommand: string): Promise<VoidCommandResponse> {
     return await selectCommandTemplate(
         context,
         'attach',
@@ -64,7 +64,7 @@ export async function selectAttachCommand(context: IActionContext, containerName
     );
 }
 
-export async function selectLogsCommand(context: IActionContext, containerName: string, imageName: string, containerId: string): Promise<CommandResponse<void>> {
+export async function selectLogsCommand(context: IActionContext, containerName: string, imageName: string, containerId: string): Promise<VoidCommandResponse> {
     return await selectCommandTemplate(
         context,
         'logs',
@@ -74,7 +74,7 @@ export async function selectLogsCommand(context: IActionContext, containerName:
     );
 }
 
-export async function selectComposeCommand(context: IActionContext, folder: vscode.WorkspaceFolder, composeCommand: 'up' | 'down' | 'upSubset', configurationFile?: string, detached?: boolean, build?: boolean): Promise<CommandResponse<void>> {
+export async function selectComposeCommand(context: IActionContext, folder: vscode.WorkspaceFolder, composeCommand: 'up' | 'down' | 'upSubset', configurationFile?: string, detached?: boolean, build?: boolean): Promise<VoidCommandResponse> {
     let template: TemplateCommand;
 
     switch (composeCommand) {
@@ -120,7 +120,7 @@ export async function selectCommandTemplate(
     // The following three are overridable for test purposes, but have default values that cover actual usage
     templatePicker: TemplatePicker = (i, o) => actionContext.ui.showQuickPick(i, o), // Default is the normal ext.ui.showQuickPick (this longer syntax is because doing `ext.ui.showQuickPick` alone doesn't result in the right `this` further down)
     getCommandSettings: () => CommandSettings = () => vscode.workspace.getConfiguration('docker').inspect<string | CommandTemplate[]>(`commands.${command}`)
-): Promise<CommandResponse<void>> {
+): Promise<VoidCommandResponse> {
     // Get the configured settings values
     const commandSettings = getCommandSettings();
     const userTemplates: CommandTemplate[] = toCommandTemplateArray(commandSettings.workspaceFolderValue ?? commandSettings.workspaceValue ?? commandSettings.globalValue);

src/debugging/DockerServerReadyAction.ts

@@ -7,14 +7,14 @@
 // Adapted from: https://github.com/microsoft/vscode/blob/8827cf5a607b6ab7abf45817604bc21883314db7/extensions/debug-server-ready/src/extension.ts
 //
 
+import * as readline from 'readline';
 import * as stream from 'stream';
 import * as util from 'util';
 import * as vscode from 'vscode';
 import { IActionContext, callWithTelemetryAndErrorHandling } from '@microsoft/vscode-azext-utils';
 import { ext } from '../extensionVariables';
 import { localize } from '../localize';
 import { ResolvedDebugConfiguration } from './DebugHelper';
-import { runWithDefaultShell } from '../runtimes/runners/runWithDefaultShell';
 
 const PATTERN = 'listening on.* (https?://\\S+|[0-9]+)'; // matches "listening on port 3000" or "Now listening on: https://localhost:5001"
 const URI_FORMAT = 'http://localhost:%s';
@@ -191,60 +191,43 @@ interface DockerServerReadyDetector {
 }
 
 class DockerLogsTracker extends vscode.Disposable {
-    private logStream: stream.PassThrough;
     private readonly cts = new vscode.CancellationTokenSource();
+    private lineReader: readline.Interface | undefined;
 
     public constructor(private readonly containerName: string, private readonly detector: DockerServerReadyDetector) {
         super(
             () => {
                 this.cts.cancel();
+                this.lineReader?.close();
             });
 
         if (!this.detector) {
             return;
         }
 
-        // eslint-disable-next-line @typescript-eslint/no-floating-promises
-        this.startListening();
+        // Don't wait
+        void this.listen();
     }
 
-    private async startListening(): Promise<void> {
-        return callWithTelemetryAndErrorHandling('dockerServerReadyAction.dockerLogsTracker.startListening', async (context: IActionContext) => {
-            // Don't actually telemetrize or show anything (same as prior behavior), but wrap call to get an IActionContext
-            context.telemetry.suppressAll = true;
-            context.errorHandling.suppressDisplay = true;
-            context.errorHandling.rethrow = false;
-
-            this.logStream = new stream.PassThrough();
-
-            this.logStream.on('data', (data) => {
-                this.detector.detectPattern(data.toString());
-            });
-
-            // Don't wait
-            void runWithDefaultShell(
+    private async listen(): Promise<void> {
+        try {
+            const generator = ext.streamWithDefaultShell(
                 client => client.logsForContainer({ container: this.containerName, follow: true }),
-                ext.runtimeManager,
                 {
                     cancellationToken: this.cts.token,
-                    stdOutPipe: this.logStream,
-                }
-            ).then(
-                () => {
-                    // Do nothing on fulfilled
-                },
-                () => {
-                    // Do nothing on reject
-                    //
-                    // The usual termination path is for `runWithDefaultShell` to throw a `CancellationError`,
-                    // because when this `DockerLogsTracker` object is disposed, cancellation of the process
-                    // is triggered.
-                    //
-                    // If we do not eat that `CancellationError` here, it bubbles up to the extension host process
-                    // where it will be eaten, but ugly warnings show in a few places
                 }
             );
-        });
+
+            this.lineReader = readline.createInterface({ input: stream.Readable.from(generator) });
+            for await (const line of this.lineReader) {
+                this.detector.detectPattern(line);
+            }
+        } catch {
+            // Do nothing
+            // The usual termination pathway is cancellation through the CTS above, so errors are expected
+            // TODO: for unknown reasons, the cancellation error does not actually get thrown to here, and ends
+            // up in the extension host output log. Ideally this should not happen.
+        }
     }
 }
 

src/debugging/netcore/NetCoreDebugHelper.ts

@@ -5,7 +5,7 @@
 
 import * as fse from 'fs-extra';
 import * as path from 'path';
-import { composeArgs, ContainerOS, withArg, withQuotedArg } from '../../runtimes/docker';
+import { composeArgs, ContainerOS, VoidCommandResponse, withArg, withQuotedArg } from '../../runtimes/docker';
 import { DialogResponses, IActionContext, UserCancelledError } from '@microsoft/vscode-azext-utils';
 import { DebugConfiguration, MessageItem, ProgressLocation, ShellQuotedString, window } from 'vscode';
 import { ext } from '../../extensionVariables';
@@ -312,25 +312,29 @@ export class NetCoreDebugHelper implements DebugHelper {
             containerCommand = 'cmd';
             containerCommandArgs = composeArgs(
                 withArg('/C'),
-                withQuotedArg(`IF EXIST "${debuggerPath}" (echo true) else (echo false)`)
+                withQuotedArg(`IF EXIST "${debuggerPath}" (exit 0) else (exit 1)`)
             )();
         } else {
             containerCommand = '/bin/sh';
             containerCommandArgs = composeArgs(
                 withArg('-c'),
-                withQuotedArg(`if [ -f ${debuggerPath} ]; then echo true; fi;`)
+                withQuotedArg(`if [ -f ${debuggerPath} ]; then exit 0; else exit 1; fi;`)
             )();
         }
 
-        const stdout = await ext.runWithDefaultShell(client =>
-            client.execContainer({
-                container: containerName,
-                command: [containerCommand, ...containerCommandArgs],
-                interactive: true,
-            })
-        );
-
-        return /true/ig.test(stdout);
+        try {
+            await ext.runWithDefaultShell(client =>
+                // Since we're not interested in the output, just the exit code, we can pretend this is a `VoidCommandResponse`
+                client.execContainer({
+                    container: containerName,
+                    command: [containerCommand, ...containerCommandArgs],
+                    interactive: true,
+                }) as Promise<VoidCommandResponse>
+            );
+            return true;
+        } catch {
+            return false;
+        }
     }
 
     private async getContainerNameToAttach(context: IActionContext): Promise<string> {

src/extensionVariables.ts

@@ -14,7 +14,7 @@ import { NetworksTreeItem } from './tree/networks/NetworksTreeItem';
 import { RegistriesTreeItem } from './tree/registries/RegistriesTreeItem';
 import { VolumesTreeItem } from './tree/volumes/VolumesTreeItem';
 import { OrchestratorRuntimeManager } from './runtimes/OrchestratorRuntimeManager';
-import { runOrchestratorWithDefaultShellInternal, runWithDefaultShellInternal } from './runtimes/runners/runWithDefaultShell';
+import { runOrchestratorWithDefaultShellInternal, runWithDefaultShellInternal, streamOrchestratorWithDefaultShellInternal, streamWithDefaultShellInternal } from './runtimes/runners/runWithDefaultShell';
 
 /**
  * Namespace for common variables used throughout the extension. They must be initialized in the activate() method of extension.ts
@@ -60,5 +60,7 @@ export namespace ext {
     export let runtimeManager: ContainerRuntimeManager;
     export let orchestratorManager: OrchestratorRuntimeManager;
     export const runWithDefaultShell = runWithDefaultShellInternal;
+    export const streamWithDefaultShell = streamWithDefaultShellInternal;
     export const runOrchestratorWithDefaultShell = runOrchestratorWithDefaultShellInternal;
+    export const streamOrchestratorWithDefaultShell = streamOrchestratorWithDefaultShellInternal;
 }