Skip to content

Extension host: use native source maps in development hosts - #339169

Draft
Goga Koreli (gogakoreli) wants to merge 2 commits into
microsoft:mainfrom
gogakoreli:fix/dev-host-native-source-maps
Draft

Goga Koreli (gogakoreli) wants to merge 2 commits into
microsoft:mainfrom
gogakoreli:fix/dev-host-native-source-maps

Conversation

@gogakoreli

@gogakoreli Goga Koreli (gogakoreli) commented Oct 1, 2026 •

Copy link
Copy Markdown

Summary

Related to #145473 and #238469. This is a local extension-development host first step, not a claim to resolve the broader request for source-mapped crash reports from shipped extensions.

A bundled extension can ship a valid source map and still produce generated-file locations in its error stacks. There are two independent pieces to address:

  1. Enable Node's native source-map support before importing the extension host and its extensions.
  2. Keep the host's extension-attribution walk, but use the previously installed Error.prepareStackTrace formatter when native source maps are enabled. Building the stack from CallSite.toString() bypasses Node's mapped formatting.

This PR uses module.setSourceMapsSupport(true) and adds no dependency, Module._load interception, or extension API. The flag is set by NativeLocalProcessExtensionHost only for development hosts. With source maps disabled, the existing formatter and its tab indentation remain unchanged. Existing handling of formatters installed by extensions remains in place.

The formatter composition follows Node's documented guidance and the pattern used by Babel. The captured hook is inferred, and the wrapper is contextually typed from typeof Error.prepareStackTrace, rather than asserting compatibility with a narrower call-site interface. Delegation preserves the Error receiver, and the native path skips unused fallback string rendering while retaining attribution.

Before / after

The new isolated-process regression fixture has a real CommonJS module with an external source map. Paths below are shortened; this is a test fixture, not a screenshot from a fully launched editor.

Before (existing host formatter, even with native maps enabled):

Error: source map probe
    at Object.createError (<fixture>/fixture.cjs:1:62)

After (native formatter preserved):

Error: source map probe
    at Object.createError (<fixture>/fixture.ts:1:1)

The fixture deliberately uses a single mapping segment to make the expected source location deterministic. The test also verifies that the same error reaches $onExtensionRuntimeError and extension telemetry with the correct extension identifier and stack. It does not just assert a fabricated formatter string.

Regression coverage

Nine new cases run in separate child processes because the host makes Error.prepareStackTrace non-configurable:

  • Actual generated-to-source mapping using Node's formatter, with error and telemetry attribution preserved.
  • Existing formatting and attribution with source maps disabled.
  • Disabling source maps after handler installation.
  • Custom formatters installed before and after the host handler, including their Error receiver.
  • Zero fallback toString() calls when a formatter is selected, with attribution preserved.
  • Bootstrap with the opt-in flag unset, false, and true.

I also ran the existing seven formatter-wrapping/re-wrapping tests for #184926.

To check the tests are sensitive to the change, I temporarily removed the proposed formatter delegation and bootstrap activation while retaining the original eight tests. Three cases failed: native mapping, the pre-installed formatter case, and bootstrap activation. Restoring the implementation made the suite pass.

For the review follow-up, I strengthened the custom-formatter cases to check the receiver and added an independently instrumented fallback-rendering case. Against the initial PR implementation, these exposed two failures: an incorrect receiver and one unnecessary fallback rendering call. Both pass after the revision.

Local validation

Public microsoft/vscode source based on 1f6488722c942d1d7528a7d949769a69e4a557c3, macOS arm64:

  • npm run transpile-client — passed.
  • npm run typecheck-client — passed.
  • ESLint on all four changed files with --max-warnings 0 — passed.
  • Node 24.18.0: nine new cases and seven existing cases passed (the Node runner additionally reports its own unexpected-error checks).
  • VS Code's pinned Electron 43.7.3 / embedded Node 24.21.0: nine new cases and seven existing cases passed via scripts/test.sh.
  • npm run valid-layers-check — passed.
  • git-secrets with AWS patterns on all four contribution files — passed.
  • git diff --check — passed.

Commands:

npm run test-node -- --run src/vs/workbench/api/test/node/extensionHostSourceMaps.test.ts
npm run test-node -- --run src/vs/workbench/api/test/common/extensionHostMain.test.ts
./scripts/test.sh --run src/vs/workbench/api/test/node/extensionHostSourceMaps.test.ts --grep 'Extension host native source maps'
./scripts/test.sh --run src/vs/workbench/api/test/common/extensionHostMain.test.ts --grep 'ExtensionHostMain#ErrorHandler'

The subprocess cases use Electron-as-Node when launched from the Electron test runner. A full UI/utility-process extension-host launch, Windows/Linux validation, and a representative startup/stack-formatting performance benchmark are not yet completed. Opening as a draft to make that validation scope explicit and discuss whether this is a useful first step.

Scope and prior work

  • This is an alternative native-runtime approach to Add source-map-support for stack trace formatting in extensionHost debugging #238469, not a continuation of that PR or a claim to its authorship.
  • No new opt-in policy for release, remote, or web extension hosts is introduced. The shared handler respects native source-map support when it is already enabled, but only local development hosts are newly enabled by this PR.
  • ESM file: URL error-attribution behavior is a separate concern and is intentionally not included.
  • No internal repository files or patch files are included; this branch was prepared against public VS Code source.

Would the maintainers be open to this dev-host-only first step? Happy to adjust the scope based on guidance.

Prepared with AI assistance. The local automated checks are listed above; maintainer review is still required.

Enable Node's source-map support before importing the extension host.
Keep the error-attribution walk and delegate stack formatting to the
previous formatter when native source maps are enabled. Preserve the
existing output for source-map-disabled hosts and custom formatter wrapping.

Add isolated subprocess tests for real mapped frames, runtime-error and
telemetry attribution, custom formatters, runtime toggling, and bootstrap
opt-in behavior. Related to microsoft#145473 and microsoft#238469.

X-AI-Prompt: Add dev-host-only native source maps with regression tests and raise a VS Code PR.
X-AI-Tool: OpenAI coding assistant
Copilot AI balanced review requested due to automatic review settings October 1, 2026 20:00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Formatter receiver handling is incorrect, and native formatting currently duplicates avoidable stack-processing work.

Review effort: Balanced
Findings: 1 Medium severity · 1 Low severity

Open (2)
What changed in this PR

Enables native source-map formatting for local extension-development hosts while retaining extension error attribution.

Changes:

  • Activates Node source maps during extension-host bootstrap.
  • Delegates stack formatting to Node when enabled.
  • Adds subprocess regression coverage.
File Description
src/​bootstrap-fork.ts Enables native source maps before host loading.
src/​vs/​workbench/​api/​common/​extensionHostMain.ts Preserves native formatting during attribution.
src/​vs/​workbench/​api/​test/​node/​extensionHostSourceMaps.test.ts Tests mapping, attribution, formatters, and bootstrap flags.
src/​vs/​workbench/​services/​extensions/​electron-browser/​localProcessExtensionHost.ts Enables source maps for development hosts.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

const result = `${error.name || 'Error'}: ${error.message || ''}${stackTraceMessage}`;
const sourceMapsEnabled = (globalThis as { process?: { sourceMapsEnabled?: boolean } }).process?.sourceMapsEnabled === true;
const result = sourceMapsEnabled && defaultPrepareStackTrace
? defaultPrepareStackTrace(error, stackTrace)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in e81fe03. The captured formatter is now called with Error as its receiver, and the before/after formatter tests use receiver-sensitive functions. I also removed the assertions by inferring the captured hook and contextually typing the wrapper from typeof Error.prepareStackTrace.

Comment on lines +91 to +94
const sourceMapsEnabled = (globalThis as { process?: { sourceMapsEnabled?: boolean } }).process?.sourceMapsEnabled === true;
const result = sourceMapsEnabled && defaultPrepareStackTrace
? defaultPrepareStackTrace(error, stackTrace)
: `${error.name || 'Error'}: ${error.message || ''}${stackTraceMessage}`;

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in e81fe03. Formatter selection now happens before the attribution walk, and fallback toString()/concatenation only runs when needed. Added a regression that checks zero fallback rendering calls while runtime-error and telemetry attribution still work; it fails against the previous implementation.

Infer the captured Error.prepareStackTrace hook and contextually type the
wrapper from its declared callback contract instead of asserting a narrower
V8CallSite signature. Preserve Error as the captured formatter's receiver.

Select the formatter before the attribution walk and skip unused fallback
string rendering. Add regression coverage for receiver-sensitive formatters
and zero fallback rendering calls while preserving runtime attribution.

X-AI-Prompt: Address reviewer feedback with inferred formatter types and regression tests.
X-AI-Tool: OpenAI coding assistant
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

Goga Koreli (@gogakoreli) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

1 similar comment
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

Goga Koreli (@gogakoreli) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants