Use new report issue command api

package.json

@@ -23,7 +23,8 @@
         "testObserver",
         "quickPickItemTooltip",
         "terminalDataWriteEvent",
-        "terminalExecuteCommandEvent"
+        "terminalExecuteCommandEvent",
+        "contribIssueReporter"
     ],
     "author": {
         "name": "Microsoft Corporation"
@@ -1243,6 +1244,11 @@
             }
         ],
         "menus": {
+            "issue/reporter": [
+				{
+					"command": "python.reportIssue"
+				}
+			],
             "commandPalette": [
                 {
                     "category": "Python",

resources/report_issue_template.md

@@ -12,13 +12,9 @@ XXX
 **After** creating the issue on GitHub, you can add screenshots and GIFs of what is happening. Consider tools like https://www.cockos.com/licecap/, https://github.com/phw/peek or https://www.screentogif.com/ for GIF creation.
 -->
 
-<!-- **NOTE**: Everything below except Python output panel is auto-generated; no editing required. Please do provide Python output panel. -->
+<!-- **NOTE**: Please do provide Python output panel. -->
 # Diagnostic data
 
--   Python version (& distribution if applicable, e.g. Anaconda): {0}
--   Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): {1}
--   Value of the `python.languageServer` setting: {2}
-
 <details>
 
 <summary>Output for <code>Python</code> in the <code>Output</code> panel (<code>View</code>→<code>Output</code>, change the drop-down the upper-right of the <code>Output</code> panel to <code>Python</code>)
@@ -32,16 +28,3 @@ XXX
 
 </p>
 </details>
-
-<details>
-
-<summary>User Settings</summary>
-
-<p>
-
-```
-{3}{4}
-```
-
-</p>
-</details>

resources/report_issue_user_data_template.md

@@ -0,0 +1,16 @@
+-   Python version (& distribution if applicable, e.g. Anaconda): {0}
+-   Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): {1}
+-   Value of the `python.languageServer` setting: {2}
+
+<details>
+
+<summary>User Settings</summary>
+
+<p>
+
+```
+{3}{4}
+```
+
+</p>
+</details>

src/client/common/application/commands/reportIssueCommand.ts

@@ -48,6 +48,8 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ
 
     private templatePath = path.join(EXTENSION_ROOT_DIR, 'resources', 'report_issue_template.md');
 
+    private userDataTemplatePath = path.join(EXTENSION_ROOT_DIR, 'resources', 'report_issue_user_data_template.md');
+
     public async openReportIssue(): Promise<void> {
         const settings: IPythonSettings = this.configurationService.getSettings();
         const argSettings = JSON.parse(await fs.readFile(this.argSettingsPath, 'utf8'));
@@ -86,6 +88,7 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ
             }
         });
         const template = await fs.readFile(this.templatePath, 'utf8');
+        const userTemplate = await fs.readFile(this.userDataTemplatePath, 'utf8');
         const interpreter = await this.interpreterService.getActiveInterpreter();
         const pythonVersion = interpreter?.version?.raw ?? '';
         const languageServer =
@@ -99,7 +102,8 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ
                 : '';
         await this.commandManager.executeCommand('workbench.action.openIssueReporter', {
             extensionId: 'ms-python.python',
-            issueBody: template.format(
+            issueBody: template,
+            data: userTemplate.format(
                 pythonVersion,
                 virtualEnvKind,
                 languageServer,

src/test/common/application/commands/issueTemplateVenv2.md → src/test/common/application/commands/issueTemplate.md

@@ -12,13 +12,9 @@ XXX
 **After** creating the issue on GitHub, you can add screenshots and GIFs of what is happening. Consider tools like https://www.cockos.com/licecap/, https://github.com/phw/peek or https://www.screentogif.com/ for GIF creation.
 -->
 
-<!-- **NOTE**: Everything below except Python output panel is auto-generated; no editing required. Please do provide Python output panel. -->
+<!-- **NOTE**: Please do provide Python output panel. -->
 # Diagnostic data
 
--   Python version (& distribution if applicable, e.g. Anaconda): 3.9.0
--   Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): Venv
--   Value of the `python.languageServer` setting: Pylance
-
 <details>
 
 <summary>Output for <code>Python</code> in the <code>Output</code> panel (<code>View</code>→<code>Output</code>, change the drop-down the upper-right of the <code>Output</code> panel to <code>Python</code>)
@@ -32,22 +28,3 @@ XXX
 
 </p>
 </details>
-
-<details>
-
-<summary>User Settings</summary>
-
-<p>
-
-```
-Multiroot scenario, following user settings may not apply:
-
-experiments
-• enabled: false
-
-venvPath: "<placeholder>"
-
-```
-
-</p>
-</details>

src/test/common/application/commands/issueUserDataTemplateVenv1.md

@@ -0,0 +1,25 @@
+-   Python version (& distribution if applicable, e.g. Anaconda): 3.9.0
+-   Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): Venv
+-   Value of the `python.languageServer` setting: Pylance
+
+<details>
+
+<summary>User Settings</summary>
+
+<p>
+
+```
+
+experiments
+• enabled: false
+• optInto: []
+• optOutFrom: []
+
+venvPath: "<placeholder>"
+
+pipenvPath: "<placeholder>"
+
+```
+
+</p>
+</details>

src/test/common/application/commands/issueUserDataTemplateVenv2.md

@@ -0,0 +1,22 @@
+-   Python version (& distribution if applicable, e.g. Anaconda): 3.9.0
+-   Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): Venv
+-   Value of the `python.languageServer` setting: Pylance
+
+<details>
+
+<summary>User Settings</summary>
+
+<p>
+
+```
+Multiroot scenario, following user settings may not apply:
+
+experiments
+• enabled: false
+
+venvPath: "<placeholder>"
+
+```
+
+</p>
+</details>

src/test/common/application/commands/reportIssueCommand.unit.test.ts

@@ -38,6 +38,7 @@ suite('Report Issue Command', () => {
     let interpreterService: IInterpreterService;
     let configurationService: IConfigurationService;
     let appEnvironment: IApplicationEnvironment;
+    let expectedIssueBody: string;
 
     setup(async () => {
         workspaceService = mock(WorkspaceService);
@@ -79,6 +80,17 @@ suite('Report Issue Command', () => {
             instance(appEnvironment),
         );
         await reportIssueCommandHandler.activate();
+
+        const issueTemplatePath = path.join(
+            EXTENSION_ROOT_DIR_FOR_TESTS,
+            'src',
+            'test',
+            'common',
+            'application',
+            'commands',
+            'issueTemplate.md',
+        );
+        expectedIssueBody = fs.readFileSync(issueTemplatePath, 'utf8');
     });
 
     teardown(() => {
@@ -88,27 +100,28 @@ suite('Report Issue Command', () => {
     test('Test if issue body is filled correctly when including all the settings', async () => {
         await reportIssueCommandHandler.openReportIssue();
 
-        const templatePath = path.join(
+        const userDataTemplatePath = path.join(
             EXTENSION_ROOT_DIR_FOR_TESTS,
             'src',
             'test',
             'common',
             'application',
             'commands',
-            'issueTemplateVenv1.md',
+            'issueUserDataTemplateVenv1.md',
         );
-        const expectedIssueBody = fs.readFileSync(templatePath, 'utf8');
+        const expectedData = fs.readFileSync(userDataTemplatePath, 'utf8');
 
-        const args: [string, { extensionId: string; issueBody: string }] = capture<
+        const args: [string, { extensionId: string; issueBody: string; data: string }] = capture<
             AllCommands,
-            { extensionId: string; issueBody: string }
+            { extensionId: string; issueBody: string; data: string }
         >(cmdManager.executeCommand).last();
 
         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');
-        const actual = args[1].issueBody;
-        expect(actual).to.be.equal(expectedIssueBody);
+        const { issueBody, data } = args[1];
+        expect(issueBody).to.be.equal(expectedIssueBody);
+        expect(data).to.be.equal(expectedData);
     });
 
     test('Test if issue body is filled when only including settings which are explicitly set', async () => {
@@ -128,26 +141,27 @@ suite('Report Issue Command', () => {
         await reportIssueCommandHandler.activate();
         await reportIssueCommandHandler.openReportIssue();
 
-        const templatePath = path.join(
+        const userDataTemplatePath = path.join(
             EXTENSION_ROOT_DIR_FOR_TESTS,
             'src',
             'test',
             'common',
             'application',
             'commands',
-            'issueTemplateVenv2.md',
+            'issueUserDataTemplateVenv2.md',
         );
-        const expectedIssueBody = fs.readFileSync(templatePath, 'utf8');
+        const expectedData = fs.readFileSync(userDataTemplatePath, 'utf8');
 
-        const args: [string, { extensionId: string; issueBody: string }] = capture<
+        const args: [string, { extensionId: string; issueBody: string; data: string }] = capture<
             AllCommands,
-            { extensionId: string; issueBody: string }
+            { extensionId: string; issueBody: string; data: string }
         >(cmdManager.executeCommand).last();
 
         verify(cmdManager.executeCommand('workbench.action.openIssueReporter', anything())).once();
         expect(args[0]).to.be.equal('workbench.action.openIssueReporter');
-        const actual = args[1].issueBody;
-        expect(actual).to.be.equal(expectedIssueBody);
+        const { issueBody, data } = args[1];
+        expect(issueBody).to.be.equal(expectedIssueBody);
+        expect(data).to.be.equal(expectedData);
     });
     test('Should send telemetry event when run Report Issue Command', async () => {
         const sendTelemetryStub = sinon.stub(Telemetry, 'sendTelemetryEvent');