Open browser after launching (#214)

* Add autoStartBrowser and serverReady * add tests * fix lint * fix tests * remove only in test * send telemetry * fix lint
microsoft · Feb 16, 2024 · 37cae2b · 37cae2b
1 parent 25e00ca
commit 37cae2b
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 0 deletions.
diff --git a/package.json b/package.json
@@ -327,6 +327,11 @@
                                 "description": "Path (fully qualified) to the Python debug adapter executable.",
                                 "type": "string"
                             },
+                            "autoStartBrowser": {
+                                "default": false,
+                                "description": "Open external browser to launch the application",
+                                "type": "boolean"
+                            },
                             "django": {
                                 "default": false,
                                 "description": "Django debugging.",

diff --git a/src/extension/debugger/configuration/resolvers/base.ts b/src/extension/debugger/configuration/resolvers/base.ts
@@ -245,6 +245,7 @@ export abstract class BaseConfigurationResolver<T extends DebugConfiguration>
             stopOnEntry: !!debugConfiguration.stopOnEntry,
             showReturnValue: !!debugConfiguration.showReturnValue,
             subProcess: !!debugConfiguration.subProcess,
+            autoStartBrowser: !!debugConfiguration,
             watson: name.toLowerCase().indexOf('watson') >= 0,
             pyspark: name.toLowerCase().indexOf('pyspark') >= 0,
             gevent: name.toLowerCase().indexOf('gevent') >= 0,

diff --git a/src/extension/debugger/configuration/resolvers/launch.ts b/src/extension/debugger/configuration/resolvers/launch.ts
@@ -140,6 +140,13 @@ export class LaunchConfigurationResolver extends BaseConfigurationResolver<Launc
         }
         const isFastAPI = LaunchConfigurationResolver.isDebuggingFastAPI(debugConfiguration);
         const isFlask = LaunchConfigurationResolver.isDebuggingFlask(debugConfiguration);
+        if (debugConfiguration.autoStartBrowser && (debugConfiguration.django || isFlask)) {
+            debugConfiguration.serverReadyAction = {
+                pattern: '.*(https?:\\/\\/\\S+:[0-9]+\\/?).*',
+                uriFormat: '%s',
+                action: 'openExternally',
+            };
+        }
         if (
             (debugConfiguration.pyramid || isFlask || isFastAPI) &&
             debugOptions.indexOf(DebugOptions.Jinja) === -1 &&

diff --git a/src/extension/telemetry/index.ts b/src/extension/telemetry/index.ts
@@ -570,6 +570,12 @@ export interface IEventNamePropertyMapping {
          * @type {boolean}
          */
         scrapy: boolean;
+        /**
+         * Whether degbugging with autoStartBrowser.
+         *
+         * @type {boolean}
+         */
+        autoStartBrowser: boolean;
     };
     /**
      * Telemetry event sent when attaching to child process

diff --git a/src/test/unittest/configuration/resolvers/launch.unit.test.ts b/src/test/unittest/configuration/resolvers/launch.unit.test.ts
@@ -922,6 +922,37 @@ getInfoPerOS().forEach(([osName, osType, path]) => {
             expect((debugConfig as DebugConfiguration).debugOptions).contains(DebugOptions.Jinja);
         });
 
+        const testsForautoStartBrowser = [
+            {
+                autoStartBrowser: true,
+                module: 'flask',
+            },
+            {
+                autoStartBrowser: true,
+                django: true,
+            },
+        ];
+
+        test('Add serverReadyAction for Django and Flask', async () => {
+            const pythonPath = `PythonPath_${new Date().toString()}`;
+            const workspaceFolder = createMoqWorkspaceFolder(__dirname);
+            const pythonFile = 'xyz.py';
+            setupIoc(pythonPath);
+            setupActiveEditor(pythonFile, PYTHON_LANGUAGE);
+            const expectedServerReadyAction = {
+                pattern: '.*(https?:\\/\\/\\S+:[0-9]+\\/?).*',
+                uriFormat: '%s',
+                action: 'openExternally',
+            };
+            testsForautoStartBrowser.forEach(async (testParams) => {
+                const debugConfig = await resolveDebugConfiguration(workspaceFolder, {
+                    ...launch,
+                    ...testParams,
+                });
+                expect(debugConfig).to.have.property('serverReadyAction', expectedServerReadyAction);
+            });
+        });
+
         async function testSetting(
             requestType: 'launch' | 'attach',
             settings: Record<string, boolean>,