Add user settings in issue template (microsoft#16492)

paulacamargo25 · karthiknadig · web-flow · commit 28be0f46e237 · 2021-07-19T13:45:31.000-05:00
* Add user settings in issue template

* Fix tests

* Add placeholder for path settings

* Fix user settings json values

* Fix tests

Co-authored-by: Karthik Nadig &lt;kanadig@microsoft.com&gt;
diff --git a/resources/report_issue_template.md b/resources/report_issue_template.md
@@ -6,7 +6,6 @@
 
 [**NOTE**: If you suspect that your issue is related to the Microsoft Python Language Server (`python.languageServer: 'Microsoft'`), please download our new language server [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) from the VS Code marketplace to see if that fixes your issue]
 
-
 ## Expected
 
 XXX
@@ -39,9 +38,23 @@ You can attach such things **after** you create your issue on GitHub.
 <p>
 
 <!-- Run the "Python: Show Output" command to see the requested output. --->
+
 ```
 {3}
 ```
 
 </p>
 </details>
+
+<details>
+
+<summary>User Settings</summary>
+
+<p>
+
+```
+{4}
+```
+
+</p>
+</details>
diff --git a/resources/report_issue_user_settings.json b/resources/report_issue_user_settings.json
@@ -0,0 +1,143 @@
+{
+    "initialize": false,
+    "pythonPath": "placeholder",
+    "onDidChange": false,
+    "defaultInterpreterPath": "placeholder",
+    "defaultLS": true,
+    "showStartPage": true,
+    "downloadLanguageServer": true,
+    "jediPath": false,
+    "jediMemoryLimit": false,
+    "envFile": "placeholder",
+    "venvPath": "placeholder",
+    "venvFolders": "placeholder",
+    "condaPath": "placeholder",
+    "pipenvPath": "placeholder",
+    "poetryPath": "placeholder",
+    "devOptions": false,
+    "disableInstallationChecks": false,
+    "globalModuleInstallation": false,
+    "autoUpdateLanguageServer": false,
+    "languageServer": true,
+    "languageServerIsDefault": false,
+    "logging": true,
+    "useIsolation": false,
+    "changed": false,
+    "_pythonPath": false,
+    "_defaultInterpreterPath": false,
+    "workspace": false,
+    "workspaceRoot": false,
+    "linting": {
+        "enabled": true,
+        "cwd": "placeholder",
+        "Flake8Args": "placeholder",
+        "flake8CategorySeverity": false,
+        "flake8Enabled": true,
+        "flake8Path": "placeholder",
+        "ignorePatterns": false,
+        "lintOnSave": true,
+        "maxNumberOfProblems": false,
+        "banditArgs": "placeholder",
+        "banditEnabled" : true,
+        "banditPath": "placeholder",
+        "mypyArgs": "placeholder",
+        "mypyCategorySeverity": false,
+        "mypyEnabled": true,
+        "mypyPath": "placeholder",
+        "pycodestyleArgs": "placeholder",
+        "pycodestyleCategorySeverity": false,
+        "pycodestyleEnabled": true,
+        "pycodestylePath": "placeholder",
+        "prospectorArgs": "placeholder",
+        "prospectorEnabled": true,
+        "prospectorPath": "placeholder",
+        "pydocstyleArgs": "placeholder",
+        "pydocstyleEnabled": true,
+        "pydocstylePath": "placeholder",
+        "pylamaArgs": "placeholder",
+        "pylamaEnabled": true,
+        "pylamaPath": "placeholder",
+        "pylintArgs": "placeholder",
+        "pylintCategorySeverity": false,
+        "pylintEnabled": true,
+        "pylintPath": "placeholder",
+        "pylintUseMinimalCheckers": true
+    },
+    "analysis": {
+        "completeFunctionParens": true,
+        "autoImportCompletions": true,
+        "autoSearchPaths": "placeholder",
+        "stubPath": "placeholder",
+        "diagnosticMode": true,
+        "extraPaths": "placeholder",
+        "useLibraryCodeForTypes": true,
+        "typeCheckingMode": true,
+        "diagnosticSeverityOverrides": false,
+        "diagnosticPublishDelay": false,
+        "errors": true,
+        "warnings": true,
+        "information": true,
+        "disabled": true,
+        "typeshedPaths": "placeholder",
+        "cacheFolderPath": "placeholder",
+        "memory": true,
+        "logLevel": true,
+        "symbolsHierarchyDepthLimit": false
+    },
+    "sortImports": {
+        "args": "placeholder",
+        "path": "placeholder"
+    },
+    "formatting": {
+        "autopep8Args": "placeholder",
+        "autopep8Path": "placeholder",
+        "provider": true,
+        "blackArgs": "placeholder",
+        "blackPath": "placeholder",
+        "yapfArgs": "placeholder",
+        "yapfPath": "placeholder"
+    },
+    "autoComplete": {
+        "addBrackets": true,
+        "extraPaths": "placeholder",
+        "showAdvancedMembers": true,
+        "typeshedPaths": "placeholder"
+    },
+    "workspaceSymbols": {
+        "ctagsPath":"placeholder",
+        "enabled": true,
+        "exclusionPatterns": true,
+        "rebuildOnFileSave": true,
+        "rebuildOnStart": true,
+        "tagFilePath": "placeholder"
+    },
+    "testing": {
+        "cwd": "placeholder",
+        "debugPort": true,
+        "nosetestArgs": "placeholder",
+        "nosetestsEnabled": true,
+        "nosetestPath": "placeholder",
+        "promptToConfigure": true,
+        "pytestArgs": "placeholder",
+        "pytestEnabled": true,
+        "pytestPath": "placeholder",
+        "unittestArgs": "placeholder",
+        "unittestEnabled": true,
+        "autoTestDiscoverOnSaveEnabled": true
+    },
+    "terminal": {
+        "activateEnvironment": true,
+        "executeInFileDir": "placeholder",
+        "launchArgs": "placeholder",
+        "activateEnvInCurrentTerminal": false
+    },
+    "tensorBoard": {
+        "logDirectory": "placeholder"
+    },
+    "experiments": {
+        "enabled": true,
+        "optInto": true,
+        "optOutFrom": true
+    },
+    "insidersChannel": true
+}
diff --git a/src/client/common/application/commands/reportIssueCommand.ts b/src/client/common/application/commands/reportIssueCommand.ts
@@ -4,6 +4,7 @@
 'use strict';
 
 import * as fs from 'fs-extra';
+import * as os from 'os';
 import * as path from 'path';
 import { inject, injectable } from 'inversify';
 import { IExtensionSingleActivationService } from '../../../activation/types';
@@ -13,6 +14,7 @@ import { IInterpreterService, IInterpreterVersionService } from '../../../interp
 import { identifyEnvironment } from '../../../pythonEnvironments/common/environmentIdentifier';
 import { getPythonOutputChannelContent } from '../../../logging';
 import { Commands } from '../../constants';
+import { IConfigurationService, IPythonSettings } from '../../types';
 
 /**
  * Allows the user to report an issue related to the Python extension using our template.
@@ -24,15 +26,43 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ
         @inject(IWorkspaceService) private readonly workspaceService: IWorkspaceService,
         @inject(IInterpreterService) private readonly interpreterService: IInterpreterService,
         @inject(IInterpreterVersionService) private readonly interpreterVersionService: IInterpreterVersionService,
+        @inject(IConfigurationService) protected readonly configurationService: IConfigurationService,
     ) {}
 
     public async activate(): Promise<void> {
         this.commandManager.registerCommand(Commands.ReportIssue, this.openReportIssue, this);
     }
 
+    private argSettingsPath = path.join(EXTENSION_ROOT_DIR, 'resources', 'report_issue_user_settings.json');
+
     private templatePath = path.join(EXTENSION_ROOT_DIR, 'resources', 'report_issue_template.md');
 
     public async openReportIssue(): Promise<void> {
+        const settings: IPythonSettings = this.configurationService.getSettings();
+        const argSettings = JSON.parse(await fs.readFile(this.argSettingsPath, 'utf8'));
+        let userSettings = '';
+        const keys: [keyof IPythonSettings] = Object.keys(settings) as [keyof IPythonSettings];
+        keys.forEach((property) => {
+            const argSetting = argSettings[property];
+            if (argSetting) {
+                if (typeof argSetting === 'object') {
+                    userSettings = userSettings.concat(os.EOL, property, os.EOL);
+                    const argSettingsDict = (settings[property] as unknown) as Record<string, unknown>;
+                    if (typeof argSettingsDict === 'object') {
+                        Object.keys(argSetting).forEach((item) => {
+                            const prop = argSetting[item];
+                            if (prop) {
+                                const value = prop === true ? JSON.stringify(argSettingsDict[item]) : '"<placeholder>"';
+                                userSettings = userSettings.concat('• ', item, ': ', value, os.EOL);
+                            }
+                        });
+                    }
+                } else {
+                    const value = argSetting === true ? JSON.stringify(settings[property]) : '"<placeholder>"';
+                    userSettings = userSettings.concat(os.EOL, property, ': ', value, os.EOL);
+                }
+            }
+        });
         const pythonLogs = await getPythonOutputChannelContent();
         const template = await fs.readFile(this.templatePath, 'utf8');
         const interpreterPath = (await this.interpreterService.getActiveInterpreter())?.path || 'not-selected';
@@ -43,7 +73,7 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ
 
         this.commandManager.executeCommand('workbench.action.openIssueReporter', {
             extensionId: 'ms-python.python',
-            issueBody: template.format(pythonVersion, virtualEnv, languageServer, pythonLogs),
+            issueBody: template.format(pythonVersion, virtualEnv, languageServer, pythonLogs, userSettings),
         });
     }
 }
diff --git a/src/test/common/application/commands/issueTemplateVenv1.md b/src/test/common/application/commands/issueTemplateVenv1.md
@@ -6,7 +6,6 @@
 
 [**NOTE**: If you suspect that your issue is related to the Microsoft Python Language Server (`python.languageServer: 'Microsoft'`), please download our new language server [Pylance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) from the VS Code marketplace to see if that fixes your issue]
 
-
 ## Expected
 
 XXX
@@ -39,9 +38,32 @@ You can attach such things **after** you create your issue on GitHub.
 <p>
 
 <!-- Run the "Python: Show Output" command to see the requested output. --->
+
 ```
 Python Output
 ```
 
 </p>
 </details>
+
+<details>
+
+<summary>User Settings</summary>
+
+<p>
+
+```
+
+experiments
+• enabled: true
+• optInto: []
+• optOutFrom: []
+
+insidersChannel: "off"
+
+venvPath: "<placeholder>"
+
+```
+
+</p>
+</details>
diff --git a/src/test/common/application/commands/reportIssueCommand.unit.test.ts b/src/test/common/application/commands/reportIssueCommand.unit.test.ts
@@ -23,13 +23,16 @@ import { InterpreterService } from '../../../../client/interpreter/interpreterSe
 import * as Logging from '../../../../client/logging/_global';
 import { Commands } from '../../../../client/common/constants';
 import { AllCommands } from '../../../../client/common/application/commands';
+import { ConfigurationService } from '../../../../client/common/configuration/service';
+import { IConfigurationService } from '../../../../client/common/types';
 
 suite('Report Issue Command', () => {
     let reportIssueCommandHandler: ReportIssueCommandHandler;
     let cmdManager: ICommandManager;
     let workspaceService: IWorkspaceService;
     let interpreterVersionService: IInterpreterVersionService;
     let interpreterService: IInterpreterService;
+    let configurationService: IConfigurationService;
     let identifyEnvironmentStub: sinon.SinonStub;
     let getPythonOutputContentStub: sinon.SinonStub;
 
@@ -38,6 +41,7 @@ suite('Report Issue Command', () => {
         workspaceService = mock(WorkspaceService);
         cmdManager = mock(CommandManager);
         interpreterService = mock(InterpreterService);
+        configurationService = mock(ConfigurationService);
 
         when(cmdManager.executeCommand('workbench.action.openIssueReporter', anything())).thenResolve();
         when(interpreterVersionService.getVersion(anything(), anything())).thenResolve('3.9.0');
@@ -47,6 +51,17 @@ suite('Report Issue Command', () => {
             }),
         );
         when(interpreterService.getActiveInterpreter(anything())).thenResolve(undefined);
+        when(configurationService.getSettings()).thenReturn({
+            experiments: {
+                enabled: true,
+                optInto: [],
+                optOutFrom: [],
+            },
+            insidersChannel: 'off',
+            initialize: true,
+            venvPath: 'path',
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        } as any);
         identifyEnvironmentStub = sinon.stub(EnvIdentifier, 'identifyEnvironment');
         identifyEnvironmentStub.resolves(PythonEnvKind.Venv);
 
@@ -59,6 +74,7 @@ suite('Report Issue Command', () => {
             instance(workspaceService),
             instance(interpreterService),
             instance(interpreterVersionService),
+            instance(configurationService),
         );
         await reportIssueCommandHandler.activate();
     });
@@ -90,6 +106,7 @@ suite('Report Issue Command', () => {
         verify(cmdManager.registerCommand(Commands.ReportIssue, anything(), anything())).once();
         verify(cmdManager.executeCommand('workbench.action.openIssueReporter', anything())).once();
         expect(args[0]).to.be.equal('workbench.action.openIssueReporter');
-        expect(args[1].issueBody).to.be.equal(expectedIssueBody);
+        const actual = args[1].issueBody;
+        expect(actual).to.be.equal(expectedIssueBody);
     });
 });
