Skip to content

Fix startup crash when formatting localized update notifications - #28236

Open
wait4x (wait4xx) wants to merge 3 commits into
PowerShell:masterfrom
wait4xx:fix/update-notification-padding
Open

wait4x (wait4xx) wants to merge 3 commits into
PowerShell:masterfrom
wait4xx:fix/update-notification-padding

Conversation

@wait4xx

@wait4xx wait4x (wait4xx) commented Oct 20, 2026 •

Copy link
Copy Markdown

PR Summary

Fixes #28131.

UpdatesNotification.ShowUpdateNotification assumes the first line of the localized notification template is the longest and derives the trailing padding from it. Several templates shipped in PowerShell 7.6.6 have a longer URL line, so the computed width goes negative and string.PadRight throws during ConsoleHost.Start. The exception is unhandled, so pwsh terminates before the prompt.

This clamps both padding widths to zero. The change is intentionally minimal: locales whose first line is the longest keep the current layout, and the remaining mismatch becomes cosmetic instead of a startup crash.

A follow-up commit by BOYI (@boylin0) extracts the message formatting into an internal FormatUpdateNotification method — the formatting logic is unchanged — so it can be unit tested without an update file in the user cache directory, and adds xUnit tests covering the neutral templates, templates whose second or third line is longer than the first, and every shipped localized template.

PR Context

Validation

Extracted the three notification templates from all 13 satellite assemblies shipped with 7.6.6 and evaluated both paddings with release tag 7.6.7:

padding negative before negative after
line 2 18 of 39 0 of 39
line 3 13 of 39 0 of 39

The zh-Hans stable/preview templates reproduce the reported -17 (38 - 58 + 3); with the clamp the value is 0.

The added test_UpdatesNotification.cs runs the same calculation through FormatUpdateNotification for the neutral and all localized templates; without the clamp 27 of the 39 localized templates throw ArgumentOutOfRangeException from PadRight.

A full local build was not possible in this environment (no .NET SDK installed). The fix itself only wraps two existing integer expressions in Math.Max, and the follow-up commit is a mechanical extraction plus tests; CI will compile and run them.

PR Checklist

The first line of the notification template was assumed to be the
longest, but several localized templates have a longer second or
third line. The computed padding then becomes negative, and
PadRight throws during console host startup, terminating the
process before the user gets a prompt.

Clamp both padding widths to zero so a cosmetic alignment mismatch
cannot crash the host. The existing layout is unchanged for locales
where the first line is the longest.
Copilot AI balanced review requested due to automatic review settings October 20, 2026 02:03
@wait4xx
wait4x (wait4xx) requested a review from a team as a code owner October 20, 2026 02:03
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

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.

🟢 Approval recommended

Both guards directly prevent the reported exception without changing valid padding calculations.

No open issues 🎉

What changed in this PR

Prevents the localized update-notification startup crash reported in #28131 while preserving existing valid padding behavior.

Changes:

  • Clamps both padding widths to zero or greater.
  • Updates the comment to explain localized line-length differences.
File Description
src/​Microsoft.PowerShell.ConsoleHost/​host/​msh/​UpdatesNotification.cs Guards both padding calculations against negative widths.

Review effort: Balanced

@oljh0

oljh0 commented Oct 20, 2026

Copy link
Copy Markdown

Independent reproduction on 7.6.6 stable, with the exact zh-Hans numbers:

  • PowerShell 7.6.6 (MSI x64), Windows 10 22H2, UI culture zh-CN
  • Interactive ConPTY terminal, $Host.UI.SupportsVirtualTerminal = True
  • Update cache contained update1_v7.6.7_2026-10-13 (7.08 days old at startup), so the notification path ran
  • zh-Hans StableUpdateNotificationMessage: line 1 = 38 chars, line 3 = 58 chars
  • 38 - 58 + 3 = -17 -> PadRight(-17) -> FailFast, matching the reported stack exactly
  • The same terminal starts normally with POWERSHELL_UPDATECHECK=Off, confirming the notification is the only trigger

The line-2 expression is positive for zh-Hans, but the other locale reports show it can also go negative, so clamping both expressions in this PR is the right minimal fix. The template-length assumption is the real bug; console width is not involved.

Extract the message formatting in ShowUpdateNotification into an internal
FormatUpdateNotification method so it can be tested without an update file
in the user cache directory. The formatting logic is unchanged.

The new xUnit tests cover:
- Neutral templates keep all three lines at the same width.
- Templates whose second or third line is longer than the first line.
- Every shipped localized template. Without the padding clamp, 27 of the
  39 localized templates throw ArgumentOutOfRangeException from PadRight.
@boylin0

BOYI (boylin0) commented Oct 20, 2026 •

Copy link
Copy Markdown

wait4x (@wait4xx) Thanks for the fix! I prepared some additional test coverage for the update notification padding issue in my fork:

https://github.com/boylin0/PowerShell/tree/fix/update-notification-padding

BTW, besides adding the tests, the commit also moves the message formatting in ShowUpdateNotification into an internal FormatUpdateNotification method so it can be unit tested. The formatting logic itself is unchanged.

Feel free to take a look! If you find these tests useful, you can git cherry-pick 29fd033ce. Alternatively, If you'd rather keep this PR minimal, I can open a follow-up PR after this one is merged.

Thanks!

GitHub
PowerShell for every system! Contribute to boylin0/PowerShell development by creating an account on GitHub.

@wait4xx

Copy link
Copy Markdown
Author

Thanks BOYI (@boylin0)! Since your commit is based directly on the PR head, I fast-forwarded the branch to 29fd033ce and took it verbatim — authorship preserved as-is.

I also double-checked that the test assembly (powershell-tests) already gets internals visibility from Microsoft.PowerShell.ConsoleHost, and verified the neutral-template equal-width assertions against the shipped templates. PR description updated to cover the extraction and the new tests.

@wait4xx

Copy link
Copy Markdown
Author

wait4x (wait4x (@wait4xx)) 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.

@microsoft-github-policy-service agree

The CodeFactor check requires the file name to match the first type name
and static readonly fields to be PascalCase without prefixes.

- Rename test_UpdatesNotification.cs to UpdatesNotificationTests.cs to match the test class.
- Rename s_templateNames/s_localizedCultures to TemplateNames/LocalizedCultures.
@wait4xx
wait4x (wait4xx) force-pushed the fix/update-notification-padding branch from bd2cc22 to 160068a Compare October 20, 2026 09:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PowerShell can crash on startup when displaying the update notification under zh-Hans due to negative PadRight width

5 participants