Skip to content

extract _parse_tool_version helper for black --version parsing#762

Open
HrachShah wants to merge 2 commits into
microsoft:mainfrom
HrachShah:fix/parse-tool-version-helper
Open

extract _parse_tool_version helper for black --version parsing#762
HrachShah wants to merge 2 commits into
microsoft:mainfrom
HrachShah:fix/parse-tool-version-helper

Conversation

@HrachShah

Copy link
Copy Markdown

_update_workspace_settings_with_version_info inlined a fragile regex match against the first line of the tool's --version output. If the line was empty, splitlines() raised IndexError and the whole initialization crashed. If the first line had no version token, or had multiple (e.g. a CPython banner like 'Python 3.12.0'), the code defaulted to the literal string '0.0.0' which is a valid (very old) SemVer and silently passes the >= 22.3.0 check while logging a misleading 'NOT supported' line for every workspace.

This commit pulls the regex match out into _parse_tool_version(stdout) and calls it from the version detection loop with proper ValueError handling: empty stdout -> 'empty --version output'; no candidate -> 'no version candidate in --version output: '. When the first line has multiple version-shaped tokens, the helper picks the longest so a real '24.3.0' or '24.3.0rc1' wins over a stray short match in a Python banner.

Also tightens the regex from \d+.\d+\S* to \d+.\d+(?:.\d+)?\S* fullmatch, so a bare '24.3' is accepted (some dev installs drop the patch number) without matching '24.3.0' twice on a '24.3.0rc1' line.

Added bundled/tool/tests/test_parse_tool_version.py with 9 unit tests covering: standard 'black, 24.3.0' output, pre-release '24.3.0rc1', multiple version tokens on the first line, CRLF line endings, empty stdout, whitespace-only first line, missing version token, two-part version '24.3', and confirms the helper uses the first line only.

… helper

_update_workspace_settings_with_version_info inlined a fragile regex match against the first line of the tool's --version output: \d+\.\d+\S*. If the line was empty (splitlines() raises IndexError) the whole initialization crashed; if the first line had no version token, or had multiple (e.g. a CPython banner like 'Python 3.12.0'), the code defaulted to the literal string '0.0.0' which is a valid (very old) SemVer and silently passes the >= 22.3.0 check while logging a misleading 'NOT supported' line for every workspace.

Pull the regex match out into _parse_tool_version(stdout) and call it from the version detection loop with proper ValueError handling: empty stdout -> 'empty --version output'; no candidate -> 'no version candidate in --version output: <line>'. When the first line has multiple version-shaped tokens, pick the longest so a real '24.3.0' or '24.3.0rc1' wins over a stray short match in a Python banner. The previous code only kept a match when len(parts) == 1, silently dropping valid versions whenever the line had any other version-shaped text.

Added bundled/tool/tests/test_parse_tool_version.py with 9 unit tests: standard black output 'black, 24.3.0', pre-release '24.3.0rc1', multiple candidates, CRLF line endings, empty stdout, whitespace-only first line, missing version token, two-part version '24.3', and confirms the helper uses the first line only.
@edvilme

edvilme commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Danke shon! @HrachShah
Thanks for the contribution. There are some merge conflicts, but otherwise looks good to me! :)

edvilme
edvilme previously approved these changes Jun 20, 2026
@github-actions github-actions Bot mentioned this pull request Jun 20, 2026
def test_handles_two_part_version(self):
out = "black, 24.3\n"
assert _parse_tool_version(out) == "24.3"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📍 bundled/tool/tests/test_parse_tool_version.py:52
Confirmed violation of tests-no-partial-asserts.md: test_raises_on_whitespace_only_output and test_raises_when_no_version_token use match="no version candidate", a partial regex, against fully deterministic exception messages. The inputs are hardcoded constants, so the full message is fixed and must be asserted exactly: match=r"no version candidate in --version output: '\s*'" and match=r"no version candidate in --version output: 'something went wrong'". (test_raises_on_empty_output already uses a full match and is fine.)

# If the first line contains multiple version-shaped tokens (e.g. black
# with an embedded 'X.Y.Z' and '24.3.0'), pick the longest so a
# pre-release suffix like '24.3.0rc1' wins over a stray short match.
return max(parts, key=len)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📍 bundled/tool/lsp_server.py:348
max(parts, key=len) picks the wrong token on a same-length tie: _parse_tool_version("Python 3.12.0 black, 24.3.0") returns "3.12.0", not 24.3.0, because max returns the first maximum. The PR's multi-token test only passes because rc1 makes black's token coincidentally longer — the test is tuned to the heuristic, not the real format. Reachability is low (black emits a single version token on line 1), so this is not a blocker, but consider anchoring on the format instead — e.g. the first token that fullmatches after black, — and retargeting the test.

# A second line that contains a version is ignored; we only look
# at the first line because that's where tools emit their banner.
out = "black, 24.3.0\nsome other 1.2.3.4 token\n"
assert _parse_tool_version(out) == "24.3.0"

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📍 bundled/tool/tests/test_parse_tool_version.py:1
The tests exercise _parse_tool_version in isolation only. The PR's most consequential behavioral change — the new continue skipping VERSION_LOOKUP population and the resulting potential KeyError in range formatting — has no integration coverage. A unit test of the helper can never catch this. Consider adding a test that drives the version-detection loop with unparseable --version output and then asserts range formatting still degrades gracefully rather than raising.

# If the first line contains multiple version-shaped tokens (e.g. black
# with an embedded 'X.Y.Z' and '24.3.0'), pick the longest so a
# pre-release suffix like '24.3.0rc1' wins over a stray short match.
return max(parts, key=len)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📍 bundled/tool/lsp_server.py:332
The PR description overstates/misstates the motivation: the old splitlines()[0] IndexError was caught by the surrounding bare except: so initialization did not crash (one workspace was skipped); (0,0,0) >= (22,3,0) is False so the old default logged "NOT supported" rather than silently passing the check; and the old \d+\.\d+\S* regex already matched a bare 24.3, so the (?:\.\d+)? addition doesn't change that case. The refactor still stands on its own merits — please correct the description so future readers trust the rationale. Info-only.

@rchiodo

rchiodo commented Jun 23, 2026

Copy link
Copy Markdown

Refactor looks good and is safe to merge. A few non-blocking notes below: a tie-break edge case in max(parts, key=len), a test-rule nit on partial exception asserts, a missing integration test around the new continue path, and some inaccuracies in the PR description worth correcting.

rchiodo
rchiodo previously approved these changes Jun 23, 2026

@rchiodo rchiodo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved via Review Center.

@edvilme edvilme dismissed stale reviews from rchiodo and themself via 26f7e47 June 25, 2026 18:47
@rchiodo

rchiodo commented Jun 25, 2026

Copy link
Copy Markdown

Solid refactor with good unit coverage. One non-blocking note on the version-token selection heuristic; the remaining first-pass items were either test-style nitpicks, an inapplicable internal review rule, or PR-description nits and were dropped.

@rchiodo rchiodo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Approved via Review Center.

@edvilme edvilme added the bug Issue identified by VS Code Team member as probable bug label Jun 25, 2026
@edvilme

edvilme commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Thanks for your contribution @HrachShah !

@edvilme edvilme enabled auto-merge (squash) June 25, 2026 23:30
@microsoft-github-policy-service

Copy link
Copy Markdown

@HrachShah 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.

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

Labels

bug Issue identified by VS Code Team member as probable bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants