Skip to content

fix(vscode): drop the contradictory compiler-not-found popup - #11527

Open
Hamza Shah (Hamjaster) wants to merge 1 commit into
microsoft:mainfrom
Hamjaster:fix-typespec-vscode-duplicate-compiler-popup
Open

fix(vscode): drop the contradictory compiler-not-found popup#11527
Hamza Shah (Hamjaster) wants to merge 1 commit into
microsoft:mainfrom
Hamjaster:fix-typespec-vscode-duplicate-compiler-popup

Conversation

@Hamjaster

Copy link
Copy Markdown

Fixes #11343

The problem in plain terms

When the TypeSpec extension can't start its language server, it throws three error popups at you at once. They stack up and cover a good chunk of the screen.

Worse, two of them say opposite things. From the screenshot in the issue:

  • Popup 1: "TypeSpec server executable was not found: 'tsp' is not found"
  • Popup 3: "TypeSpec compiler was found at '/Users/.../tsp-server.js', but it cannot be started because neither 'node' nor 'tsp' is available in PATH"

So one popup says it couldn't find the compiler, and another says it found it and tells you the actual reason it won't start. Popup 3 is the correct one, and it's the only one with useful advice (this is the classic nvm/fnm/volta situation where VS Code doesn't inherit your shell's PATH).

Why all three appear

The resolver figures out the real problem, shows popup 3, and then still hands back a tsp command anyway as a last resort, with a comment explaining that it might work in environments where the lookup fails but the shell can still find the command.

That last-resort attempt then fails with spawn tsp ENOENT, which produces the other two popups: one from vscode-languageclient itself, and the generic "was not found" one from our own start handler.

What this changes

The generic "was not found" popup no longer appears when the resolver has already given the specific diagnosis. It still goes to the TypeSpec output channel, so nothing is lost from the logs; it just stops competing with the accurate message.

Result: two popups instead of three, and the contradiction is gone. The one you're left with is the one that actually tells you what to do.

The last-resort spawn is untouched, so anyone currently relying on it keeps working.

Being upfront: this doesn't get you to one popup

The third popup ("client: couldn't create connection to server ... spawn tsp ENOENT") comes from vscode-languageclient, not from this repo. It calls error(..., 'force') internally, and 'force' deliberately bypasses the revealOutputChannelOn setting we'd normally use to quiet it. I confirmed that in the installed library.

Getting down to a single popup needs one of two decisions that felt like yours to make rather than mine:

  1. Don't attempt the doomed spawn. If neither runtime is on PATH, return undefined so the client never starts. Cleanest result, one popup. But it removes the deliberate fallback, so anyone in the "lookup fails, shell works" case would break.
  2. Override the client's error method in a LanguageClient subclass to swallow that specific message. Keeps the fallback, but reaches into library behaviour.

Worth noting that today's code shows the scary popup even when the fallback succeeds, which is arguably its own small bug. Happy to follow up with either option if you tell me which direction you prefer.

How I checked it

I couldn't reproduce the original conditions here (it needs macOS VS Code launched with a PATH that's missing node), so I want to be clear that this is verified by reading the flow plus type checking, not by watching the popups disappear.

What I did run, in packages/typespec-vscode:

  • tsc --noEmit: 28 errors before my change, 28 after, and none of them in the two files I touched. The pre-existing ones are all "Cannot find module '@typespec/compiler'" from workspace packages that aren't built in my sparse checkout.
  • vitest run test/unit/task-command.test.ts: 4 passed. I couldn't add a unit test for this path because it needs the VS Code extension host and a broken PATH; the sibling extension.test.ts doesn't even run without a built compiler. If there's a harness for this I missed, point me at it and I'll add one.
  • Prettier: clean (run with the repo's settings; I had to drop the local prettier-plugin-typespec plugin since it isn't built in my checkout).

To confirm by hand: launch VS Code so that node isn't on its PATH (e.g. install Node via nvm and open VS Code from Finder rather than from a terminal) and open a .tsp file. Before, three popups; after, two, and neither claims the compiler is missing.

An AI coding agent helped me write this. I reviewed the change, read the screenshot in the issue to identify each popup's source, and ran the checks above myself.

When neither node nor tsp is on PATH, the server resolver shows a specific,
actionable popup ("compiler was found at X, but it cannot be started because
neither 'node' nor 'tsp' is available in PATH", with nvm/fnm/volta guidance) and
then still returns a tsp command as a last resort.

That spawn then fails with ENOENT, and the start handler reports a generic
"TypeSpec server executable was not found: 'tsp' is not found". So the user gets
two popups that disagree: one says the compiler was found, the other says it
was not.

Keep the generic message in the output channel but stop popping it up when the
resolver has already given the specific diagnosis. The last-resort spawn is
unchanged, so environments where `which` fails but the shell still resolves the
command keep working.

This does not remove the third popup in the report. That one ("client: couldn't
create connection to server ... spawn tsp ENOENT") comes from
vscode-languageclient, which calls error(..., 'force') and so bypasses
revealOutputChannelOn. Suppressing it would mean overriding the client's error
method or not attempting the doomed spawn at all; both are judgement calls for
maintainers rather than part of this fix.
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).
1 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

@microsoft-github-policy-service microsoft-github-policy-service Bot added the ide Issues for VS, VSCode, Monaco, etc. label Aug 4, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

Hamza Shah (@Hamjaster) 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Hi Hamza Shah (@Hamjaster), thanks for the contribution this is however not I think the right way to handle this, setting some global state like that is not very clean and this only solve 1 message. I think here we need to detach resolving the inputs and then have a single place reporting the issue at the end

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

Labels

ide Issues for VS, VSCode, Monaco, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Triple error when compiler is not found

2 participants