Dispose sockets (microsoft#4942)

Dispose sockets

Author: DonJayamanne

news/3 Code Health/4935.md

@@ -0,0 +1 @@
+Ensure sockets get disposed along with other resources.

src/client/debugger/debugAdapter/Common/debugStreamProvider.ts

@@ -2,18 +2,24 @@
 // Licensed under the MIT License.
 
 import { inject, injectable } from 'inversify';
-import { createServer, Socket } from 'net';
+import { createServer, Server, Socket } from 'net';
 import { isTestExecution } from '../../../common/constants';
 import { ICurrentProcess } from '../../../common/types';
 import { IServiceContainer } from '../../../ioc/types';
 import { IDebugStreamProvider } from '../types';
 
 @injectable()
 export class DebugStreamProvider implements IDebugStreamProvider {
+ private server?: Server;
  constructor(@inject(IServiceContainer) private readonly serviceContainer: IServiceContainer) { }
  public get useDebugSocketStream(): boolean {
  return this.getDebugPort() > 0;
  }
+ public dispose() {
+ if (this.server) {
+ this.server.close();
+ }
+ }
  public async getInputAndOutputStreams(): Promise<{ input: NodeJS.ReadStream | Socket; output: NodeJS.WriteStream | Socket }> {
  const debugPort = this.getDebugPort();
  let debugSocket: Promise<Socket> | undefined;
@@ -27,7 +33,7 @@ export class DebugStreamProvider implements IDebugStreamProvider {
  if (!isTestExecution()) {
  console.error(`waiting for debug protocol on port ${debugPort}`);
  }
- createServer((socket) => {
+ this.server = createServer((socket) => {
  if (!isTestExecution()) {
  console.error('>> accepted connection from client');
  }

src/client/debugger/debugAdapter/main.ts

@@ -264,6 +264,7 @@ class DebugManager implements Disposable {
  }
  public async start() {
  const debugStreamProvider = this.serviceContainer.get<IDebugStreamProvider>(IDebugStreamProvider);
+ this.disposables.push(debugStreamProvider);
  const { input, output } = await debugStreamProvider.getInputAndOutputStreams();
  this.isServerMode = debugStreamProvider.useDebugSocketStream;
  this.inputStream = input;

src/client/debugger/debugAdapter/types.ts

@@ -37,7 +37,7 @@ export interface IProtocolLogger extends Disposable {
 }
 
 export const IDebugStreamProvider = Symbol('IDebugStreamProvider');
-export interface IDebugStreamProvider {
+export interface IDebugStreamProvider extends Disposable {
  readonly useDebugSocketStream: boolean;
  getInputAndOutputStreams(): Promise<{ input: NodeJS.ReadStream | Socket; output: NodeJS.WriteStream | Socket }>;
 }

src/client/unittests/unittest/runner.ts

@@ -3,7 +3,7 @@
 import { inject, injectable } from 'inversify';
 import * as path from 'path';
 import { EXTENSION_ROOT_DIR } from '../../common/constants';
-import { ILogger } from '../../common/types';
+import { IDisposableRegistry, ILogger } from '../../common/types';
 import { createDeferred, Deferred } from '../../common/utils/async';
 import { noop } from '../../common/utils/misc';
 import { IServiceContainer } from '../../ioc/types';
@@ -49,6 +49,7 @@ export class TestManagerRunner implements ITestManagerRunner {
  this.server = this.serviceContainer.get<IUnitTestSocketServer>(IUnitTestSocketServer);
  this.logger = this.serviceContainer.get<ILogger>(ILogger);
  this.helper = this.serviceContainer.get<IUnitTestHelper>(IUnitTestHelper);
+ this.serviceContainer.get<IDisposableRegistry>(IDisposableRegistry).push(this.server);
  }
 
  // tslint:disable-next-line:max-func-body-length
@@ -73,7 +74,7 @@ export class TestManagerRunner implements ITestManagerRunner {
  const statusDetails = outcomeMapping.get(data.outcome)!;
  if (test) {
  test.testFunction.status = statusDetails.status;
- switch (test.testFunction.status){
+ switch (test.testFunction.status) {
  case TestStatus.Error:
  case TestStatus.Fail: {
  test.testFunction.passed = false;