Fix crash when canceling file picker in profile settings #19504

balaraj74 · 2025-10-26T13:59:35Z

Wraps SetClientGuid, SetFileTypes, and related dialog setup calls in try-catch blocks to prevent unhandled exceptions when the user cancels the file selection dialog or when dialog configuration fails.

Previously, if these operations threw an exception (which could happen during cancellation or in certain system states), it would crash the terminal. Now these operations are treated as non-fatal, allowing the dialog to still open even if some configuration steps fail.

Fixes #19501

Fix crash when canceling file picker in profile settings

Summary

Fixes a crash that occurs when users cancel the file selection dialog while setting the Command Line executable or Starting Directory for a profile.

References

Closes #19501

Detailed Description

When adding a new profile and clicking the browse button to select a Command Line executable or Starting Directory, canceling the file dialog would cause the terminal to crash. This happened because some of the file dialog configuration calls could throw exceptions that weren't being caught.

Changes Made

Added proper exception handling to the Commandline_Click and StartingDirectory_Click functions:

Wrapped SetClientGuid, SetFileTypes, and related calls in try-catch blocks
All caught exceptions are logged but treated as non-fatal
This matches the existing pattern used for SetDefaultFolder elsewhere in the codebase

Validation

Reproduced the original crash by canceling the file dialog
Verified the fix prevents the crash
Confirmed the file picker still works correctly when a file is selected

PR Checklist

[ X] Closes Hard Crash Unselected Profile EXE #19501
[ x] Tests added/passed
[ x] Documentation updated
- If checked, please file a pull request on our docs repo and link it here: #xxx
[ x] Schema updated (if necessary)

Wraps SetClientGuid, SetFileTypes, and related dialog setup calls in try-catch blocks to prevent unhandled exceptions when the user cancels the file selection dialog or when dialog configuration fails. Previously, if these operations threw an exception (which could happen during cancellation or in certain system states), it would crash the terminal. Now these operations are treated as non-fatal, allowing the dialog to still open even if some configuration steps fail. Fixes microsoft#19501

balaraj74 · 2025-10-26T14:01:20Z

@microsoft-github-policy-service agree

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

carlos-zamora

Thanks for doing this! A few notes:

I've made some suggestions replacing simple try-catch blocks with LOG_IF_FAILED. it's cleaner and makes them one line.
For the bigger try-catch blocks, we probably want to block them together, but I think we could pull out the one for SetDefaultExtension(). Might be worth testing out to confirm though.

The PRs changes are all in the lambda for OpenFilePicker() which calls FilePicker(). There's a bunch of THROW_IF_FAILED in there, but looking through them, they all seem pretty essential. I'm thinking it needs to be updated with a method try-catch block, and if we catch an error, return an empty hstring. That way, in Profiles_Base, the returned path would be empty and we just skip over setting the setting (

terminal/src/cascadia/TerminalSettingsEditor/Profiles_Base.cpp

Lines 131 to 134 in a8beb4c

    
           if (!path.empty()) 
        
           { 
        
               _Profile.Commandline(path); 
        
           }

and

terminal/src/cascadia/TerminalSettingsEditor/Profiles_Base.cpp

Lines 168 to 171 in a8beb4c

    
           if (!folder.empty()) 
        
           { 
        
               _Profile.StartingDirectory(folder); 
        
           }

)

We probably want to also update Profiles_Base::Icon_Click() and Appearances::BackgroundImage_Click. Idk if there's any other file/folder/image pickers in the settings UI, but these are likely prone to the same issues you mentioned.

Hope this helps! Excited to see this land 😊

carlos-zamora · 2025-11-04T19:20:47Z

src/cascadia/TerminalSettingsEditor/Profiles_Base.cpp

+            try
+            {
+                THROW_IF_FAILED(dialog->SetClientGuid(clientGuidExecutables));
+            }
+            CATCH_LOG(); // non-fatal


Suggested change

try

{

THROW_IF_FAILED(dialog->SetClientGuid(clientGuidExecutables));

}

CATCH_LOG(); // non-fatal

LOG_IF_FAILED(dialog->SetClientGuid(clientGuidExecutables));

carlos-zamora · 2025-11-04T19:24:55Z

src/cascadia/TerminalSettingsEditor/Profiles_Base.cpp

+            try
+            {
+                THROW_IF_FAILED(dialog->SetFileTypes(ARRAYSIZE(supportedFileTypes), supportedFileTypes));
+                THROW_IF_FAILED(dialog->SetFileTypeIndex(1)); // the array is 1-indexed
+                THROW_IF_FAILED(dialog->SetDefaultExtension(L"exe;cmd;bat"));
+            }
+            CATCH_LOG(); // non-fatal


Suggested change

try

{

THROW_IF_FAILED(dialog->SetFileTypes(ARRAYSIZE(supportedFileTypes), supportedFileTypes));

THROW_IF_FAILED(dialog->SetFileTypeIndex(1)); // the array is 1-indexed

THROW_IF_FAILED(dialog->SetDefaultExtension(L"exe;cmd;bat"));

}

CATCH_LOG(); // non-fatal

try

{

THROW_IF_FAILED(dialog->SetFileTypes(ARRAYSIZE(supportedFileTypes), supportedFileTypes));

THROW_IF_FAILED(dialog->SetFileTypeIndex(1)); // the array is 1-indexed

}

CATCH_LOG(); // non-fatal

LOG_IF_FAILED(dialog->SetDefaultExtension(L"exe;cmd;bat"));

I'm thinking we want to treat SetFileTypes() and SetFileTypeIndex() as a block, but we can probably pull out SetDefaultExtension() so that it can succeed independently. Also adding in the LOG_IF_FAILED so that it doesn't throw if it fails.

carlos-zamora · 2025-11-04T19:25:19Z

src/cascadia/TerminalSettingsEditor/Profiles_Base.cpp

+            try
+            {
+                THROW_IF_FAILED(dialog->SetClientGuid(clientGuidFolderPicker));
+            }
+            CATCH_LOG(); // non-fatal


Suggested change

try

{

THROW_IF_FAILED(dialog->SetClientGuid(clientGuidFolderPicker));

}

CATCH_LOG(); // non-fatal

LOG_IF_FAILED(dialog->SetClientGuid(clientGuidFolderPicker));

dustnsmoke mentioned this pull request Oct 26, 2025

delete all remote #19506

Closed

carlos-zamora requested changes Nov 4, 2025

View reviewed changes

microsoft-github-policy-service bot added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Nov 4, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix crash when canceling file picker in profile settings #19504

Fix crash when canceling file picker in profile settings #19504

balaraj74 commented Oct 26, 2025

Uh oh!

balaraj74 commented Oct 26, 2025

Contribution License Agreement

Uh oh!

carlos-zamora left a comment

Uh oh!

carlos-zamora Nov 4, 2025

Uh oh!

carlos-zamora Nov 4, 2025

Uh oh!

carlos-zamora Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Fix crash when canceling file picker in profile settings #19504

Are you sure you want to change the base?

Fix crash when canceling file picker in profile settings #19504

Conversation

balaraj74 commented Oct 26, 2025

Summary

References

Detailed Description

Changes Made

Validation

PR Checklist

Uh oh!

balaraj74 commented Oct 26, 2025

Contribution License Agreement

Uh oh!

carlos-zamora left a comment

Choose a reason for hiding this comment

Uh oh!

carlos-zamora Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

carlos-zamora Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

carlos-zamora Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants