Ensure local host only if connection not available (#10600) (#10644)

karthiknadig · web-flow · commit 31cd1f24f6ee · 2020-03-18T14:52:33.000-07:00
* Ensure local host only if connection not available

* Add news item
diff --git a/news/2 Fixes/10597.md b/news/2 Fixes/10597.md
@@ -0,0 +1 @@
+Ensure default `host` is not set, if `connect` or `listen` settings are available.
diff --git a/src/client/debugger/extension/configuration/resolvers/attach.ts b/src/client/debugger/extension/configuration/resolvers/attach.ts
@@ -55,7 +55,8 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
         if (!Array.isArray(debugConfiguration.debugOptions)) {
             debugConfiguration.debugOptions = [];
         }
-        if (!debugConfiguration.host) {
+        if (!(debugConfiguration.connect || debugConfiguration.listen) && !debugConfiguration.host) {
+            // Connect and listen cannot be mixed with host property.
             debugConfiguration.host = 'localhost';
         }
         if (debugConfiguration.justMyCode === undefined) {
@@ -116,7 +117,7 @@ export class AttachConfigurationResolver extends BaseConfigurationResolver<Attac
 
     private resolvePathMappings(
         pathMappings: PathMapping[],
-        host: string,
+        host?: string,
         localRoot?: string,
         remoteRoot?: string,
         workspaceFolder?: Uri
diff --git a/src/client/debugger/types.ts b/src/client/debugger/types.ts
@@ -26,6 +26,11 @@ export type PathMapping = {
     localRoot: string;
     remoteRoot: string;
 };
+export type Connection = {
+    host: string;
+    port: number;
+};
+
 interface ICommonDebugArguments {
     redirectOutput?: boolean;
     django?: boolean;
@@ -54,6 +59,8 @@ export interface IKnownAttachDebugArguments extends ICommonDebugArguments {
     subProcessId?: number;
 
     processId?: number | string;
+    connect?: Connection;
+    listen?: Connection;
 }
 
 export interface IKnownLaunchRequestArguments extends ICommonDebugArguments {
diff --git a/src/test/debugger/extension/configuration/resolvers/attach.unit.test.ts b/src/test/debugger/extension/configuration/resolvers/attach.unit.test.ts
@@ -181,6 +181,32 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
                 .deep.equal(debugOptionsAvailable);
             expect(debugConfig).to.have.property('host', 'localhost');
         });
+        test('Default host should not be added if connect is available.', async () => {
+            const pythonFile = 'xyz.py';
+
+            setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
+            setupWorkspaces([]);
+
+            const debugConfig = await debugProvider.resolveDebugConfiguration!(undefined, {
+                request: 'attach',
+                connect: { host: 'localhost', port: 5678 }
+            } as AttachRequestArguments);
+
+            expect(debugConfig).to.not.have.property('host', 'localhost');
+        });
+        test('Default host should not be added if listen is available.', async () => {
+            const pythonFile = 'xyz.py';
+
+            setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
+            setupWorkspaces([]);
+
+            const debugConfig = await debugProvider.resolveDebugConfiguration!(undefined, {
+                request: 'attach',
+                listen: { host: 'localhost', port: 5678 }
+            } as AttachRequestArguments);
+
+            expect(debugConfig).to.not.have.property('host', 'localhost');
+        });
         test("Ensure 'localRoot' is left unaltered", async () => {
             const activeFile = 'xyz.py';
             const workspaceFolder = createMoqWorkspaceFolder(__dirname);

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Ensure default `host` is not set, if `connect` or `listen` settings are available.