Skip to content

fix issue reporter duplication #25377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

fix issue reporter duplication #25377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d56191c
Initial plan
Copilot Aug 11, 2025
db40e9e
Fix duplicate content in Python Report Issue template by using only f…
Copilot Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions src/client/common/application/commands/reportIssueCommand.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ

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');

private userDataTemplatePath = path.join(EXTENSION_ROOT_DIR, 'resources', 'report_issue_user_data_template.md');

public async openReportIssue(): Promise<void> {
Expand Down Expand Up @@ -88,7 +86,6 @@ 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 ?? '';
Expand Down Expand Up @@ -120,8 +117,7 @@ export class ReportIssueCommandHandler implements IExtensionSingleActivationServ

await this.commandManager.executeCommand('workbench.action.openIssueReporter', {
extensionId: 'ms-python.python',
issueBody: template,
data: userTemplate.format(
issueBody: userTemplate.format(
pythonVersion,
virtualEnvKind,
languageServer,
Expand Down
30 changes: 8 additions & 22 deletions src/test/common/application/commands/reportIssueCommand.unit.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ suite('Report Issue Command', () => {
let interpreterService: IInterpreterService;
let configurationService: IConfigurationService;
let appEnvironment: IApplicationEnvironment;
let expectedIssueBody: string;
let getExtensionsStub: sinon.SinonStub;

setup(async () => {
Expand Down Expand Up @@ -84,17 +83,6 @@ suite('Report Issue Command', () => {
);
await reportIssueCommandHandler.activate();

const issueTemplatePath = path.join(
EXTENSION_ROOT_DIR_FOR_TESTS,
'src',
'test',
'common',
'application',
'commands',
'issueTemplate.md',
);
expectedIssueBody = fs.readFileSync(issueTemplatePath, 'utf8');

getExtensionsStub.returns([
{
id: 'ms-python.python',
Expand Down Expand Up @@ -126,17 +114,16 @@ suite('Report Issue Command', () => {
);
const expectedData = fs.readFileSync(userDataTemplatePath, 'utf8');

const args: [string, { extensionId: string; issueBody: string; data: string }] = capture<
const args: [string, { extensionId: string; issueBody: string }] = capture<
AllCommands,
{ extensionId: string; issueBody: string; data: string }
{ extensionId: string; issueBody: 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 { issueBody, data } = args[1];
expect(issueBody).to.be.equal(expectedIssueBody);
expect(data).to.be.equal(expectedData);
const { issueBody } = args[1];
expect(issueBody).to.be.equal(expectedData);
});

test('Test if issue body is filled when only including settings which are explicitly set', async () => {
Expand Down Expand Up @@ -167,16 +154,15 @@ suite('Report Issue Command', () => {
);
const expectedData = fs.readFileSync(userDataTemplatePath, 'utf8');

const args: [string, { extensionId: string; issueBody: string; data: string }] = capture<
const args: [string, { extensionId: string; issueBody: string }] = capture<
AllCommands,
{ extensionId: string; issueBody: string; data: string }
{ extensionId: string; issueBody: string }
>(cmdManager.executeCommand).last();

verify(cmdManager.executeCommand('workbench.action.openIssueReporter', anything())).once();
expect(args[0]).to.be.equal('workbench.action.openIssueReporter');
const { issueBody, data } = args[1];
expect(issueBody).to.be.equal(expectedIssueBody);
expect(data).to.be.equal(expectedData);
const { issueBody } = args[1];
expect(issueBody).to.be.equal(expectedData);
});
test('Should send telemetry event when run Report Issue Command', async () => {
const sendTelemetryStub = sinon.stub(Telemetry, 'sendTelemetryEvent');
Expand Down
Loading