Fix unhandled ArgumentOutOfRangeException when exporting FlameGraph with unrendered canvas by Copilot · Pull Request #2339 · microsoft/perfview

Copilot · 2025-11-21T02:17:05Z

Summary

Fixed unhandled ArgumentOutOfRangeException that occurred when saving a FlameGraph with an unrendered or invalid-sized canvas. The fix includes:

Input validation: Added checks in FlameGraph.Export() to ensure canvas width and height are greater than zero before creating RenderTargetBitmap
Proper exception type: Uses ArgumentOutOfRangeException which matches the original error from RenderTargetBitmap
Graceful error handling: Wrapped the export call in a try-catch block to display user-friendly error messages via StatusBar.LogError()
User feedback: Added success message when flame graph is saved successfully
Test coverage: Added unit test to verify the fix
Best practices: Uses nameof() operator for parameter names

All review comments have been addressed. The changes are minimal, focused, and directly address the reported issue.

Original prompt

This section details on the original issue you should resolve

<issue_title>Unhanded exception while trying to Save Flame Graph</issue_title>
<issue_description>I apologize for not sharing the offending ETL file, it contains proprietary information.

An unhanded exception occured.

. . .

The fact that this exception went unhanded is a programmer error.   It should be reported so it can be fixed.  Please set along the following stack trace information which will be useful in diagnosing the problem.

StackTrace:
System.ArgumentOutOfRangeException: The parameter value must be greater than zero.
Parameter name: pixelWidth
   at System.Windows.Media.Imaging.RenderTargetBitmap..ctor(Int32 pixelWidth, Int32 pixelHeight, Double dpiX, Double dpiY, PixelFormat pixelFormat)
   at PerfView.FlameGraph.Export(Canvas flameGraphCanvas, String filePath)
   at PerfView.StackWindow.DoSaveFlameGraph(Object sender, RoutedEventArgs e)
   at System.Windows.Input.CommandBinding.OnExecuted(Object sender, ExecutedRoutedEventArgs e)
   at System.Windows.Input.CommandManager.ExecuteCommandBinding(Object sender, ExecutedRoutedEventArgs e, CommandBinding commandBinding)
   at System.Windows.Input.CommandManager.FindCommandBinding(CommandBindingCollection commandBindings, Object sender, RoutedEventArgs e, ICommand command, Boolean execute)
   at System.Windows.Input.CommandManager.FindCommandBinding(Object sender, RoutedEventArgs e, ICommand command, Boolean execute)
   at System.Windows.Input.CommandManager.OnExecuted(Object sender, ExecutedRoutedEventArgs e)
   at System.Windows.RoutedEventArgs.InvokeHandler(Delegate handler, Object target)
   at System.Windows.RoutedEventHandlerInfo.InvokeHandler(Object target, RoutedEventArgs routedEventArgs)
   at System.Windows.EventRoute.InvokeHandlersImpl(Object source, RoutedEventArgs args, Boolean reRaised)
   at System.Windows.UIElement.RaiseEventImpl(DependencyObject sender, RoutedEventArgs args)
   at System.Windows.Input.RoutedCommand.ExecuteImpl(Object parameter, IInputElement target, Boolean userInitiated)
   at System.Windows.Input.CommandManager.TransferEvent(IInputElement newSource, ExecutedRoutedEventArgs e)
   at System.Windows.Input.CommandManager.OnExecuted(Object sender, ExecutedRoutedEventArgs e)
   at System.Windows.RoutedEventArgs.InvokeHandler(Delegate handler, Object target)
   at System.Windows.RoutedEventHandlerInfo.InvokeHandler(Object target, RoutedEventArgs routedEventArgs)
   at System.Windows.EventRoute.InvokeHandlersImpl(Object source, RoutedEventArgs args, Boolean reRaised)
   at System.Windows.UIElement.RaiseEventImpl(DependencyObject sender, RoutedEventArgs args)
   at System.Windows.Input.RoutedCommand.ExecuteImpl(Object parameter, IInputElement target, Boolean userInitiated)
   at MS.Internal.Commands.CommandHelpers.CriticalExecuteCommandSource(ICommandSource commandSource, Boolean userInitiated)
   at System.Windows.Controls.MenuItem.InvokeClickAfterRender(Object arg)
   at System.Windows.Threading.ExceptionWrapper.InternalRealCall(Delegate callback, Object args, Int32 numArgs)
   at System.Windows.Threading.ExceptionWrapper.TryCatchWhen(Object source, Delegate callback, Object args, Int32 numArgs, Delegate catchHandler)
```</issue_description>

## Comments on the Issue (you are @copilot in this section)

<comments>
</comments>

Fixes Unhanded exception while trying to Save Flame Graph #2245

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

…t namespace usage Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

brianrob

@copilot, please address these comments.

brianrob · 2025-11-21T04:53:26Z

src/PerfView/StackViewer/FlameGraph.cs

+            // Validate that the canvas has a valid size before attempting to export
+            if (width <= 0 || height <= 0)
+            {
+                throw new InvalidOperationException(


Suggested change

throw new InvalidOperationException(

throw new ArgumentOutOfRangeException(

Done in 0699b4a

brianrob · 2025-11-21T04:54:06Z

src/PerfView/StackViewer/FlameGraph.cs

+            {
+                throw new InvalidOperationException(
+                    $"Cannot export flame graph: the canvas has an invalid size (width={width}, height={height}). " +
+                    "Please ensure the flame graph is visible and has been rendered before attempting to export.");


The text here is too long to appear in the status bar. Please use this text: "Please ensure the flame graph is visible and has been rendered before attempting to export."

Done in 0699b4a - shortened the error message to just the essential guidance

brianrob · 2025-11-21T04:54:30Z

src/PerfView/StackViewer/StackWindow.xaml.cs

+                    FlameGraph.Export(FlameGraphCanvas, saveDialog.FileName);
+                    StatusBar.Log($"Saved flame graph to {saveDialog.FileName}");
+                }
+                catch (InvalidOperationException ex)


Suggested change

catch (InvalidOperationException ex)

catch (ArgumentOutOfRangeException ex)

Done in 0699b4a

brianrob · 2025-11-21T04:54:46Z

src/PerfView.Tests/StackViewer/StackWindowTests.cs

+            try
+            {
+                // Attempt to export should throw InvalidOperationException with a meaningful message
+                var exception = Assert.Throws<InvalidOperationException>(() =>


Suggested change

var exception = Assert.Throws<InvalidOperationException>(() =>

var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>

Done in 0699b4a

…r message Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

Copilot · 2025-11-21T04:57:42Z

@copilot, please address these comments.

All review comments addressed in commit 0699b4a:

Changed exception type from InvalidOperationException to ArgumentOutOfRangeException
Shortened error message text
Updated catch block and test to match new exception type

Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

brianrob

@copilot, please address these comments.

brianrob · 2025-11-21T05:14:39Z

src/PerfView/StackViewer/FlameGraph.cs

+            {
+                throw new ArgumentOutOfRangeException(
+                    "flameGraphCanvas",
+                    $"canvas has an invalid size (width={width}, height={height}). Please ensure the flame graph is visible and has been rendered before attempting to export.");


Suggested change

$"canvas has an invalid size (width={width}, height={height}). Please ensure the flame graph is visible and has been rendered before attempting to export.");

$"Canvas has an invalid size (width={width}, height={height}). Please ensure the flame graph is visible and has been rendered before attempting to export.");

Done in 9f9e872

brianrob · 2025-11-21T05:14:46Z

src/PerfView.Tests/StackViewer/StackWindowTests.cs

+                });
+
+                // Verify the exception message is helpful
+                Assert.Contains("canvas has an invalid size", exception.Message);


Suggested change

Assert.Contains("canvas has an invalid size", exception.Message);

Assert.Contains("Canvas has an invalid size", exception.Message);

Done in 9f9e872

Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

Copilot · 2025-11-21T05:17:38Z

@copilot, please address these comments.

Both review comments addressed in commit 9f9e872 - capitalized 'Canvas' in error message and test assertion

leculver

One nitpick, but otherwise looks good to me.

src/PerfView/StackViewer/FlameGraph.cs

Co-authored-by: leculver <8496639+leculver@users.noreply.github.com>

StephenMolloy

lgtm

Initial plan

f89aa05

Copilot AI assigned Copilot and brianrob Nov 21, 2025

Copilot started work on behalf of brianrob November 21, 2025 02:17 View session

Copilot AI and others added 2 commits November 21, 2025 02:25

Add validation for FlameGraph export with invalid canvas size

be6c536

Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

Address code review feedback - use string interpolation and consisten…

1320239

…t namespace usage Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix unhandled exception while saving flame graph~~ Fix unhandled ArgumentOutOfRangeException when exporting FlameGraph with unrendered canvas Nov 21, 2025

Copilot finished work on behalf of brianrob November 21, 2025 02:29

Copilot AI requested a review from brianrob November 21, 2025 02:29

brianrob reviewed Nov 21, 2025

View reviewed changes

Copilot started work on behalf of brianrob November 21, 2025 04:55 View session

Change exception type to ArgumentOutOfRangeException and shorten erro…

0699b4a

…r message Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

Fix capitalization in error message for consistency

f684ba5

Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

Copilot AI requested a review from brianrob November 21, 2025 05:00

Copilot finished work on behalf of brianrob November 21, 2025 05:00

brianrob reviewed Nov 21, 2025

View reviewed changes

Copilot started work on behalf of brianrob November 21, 2025 05:15 View session

Capitalize 'Canvas' in error message per review feedback

9f9e872

Co-authored-by: brianrob <6210322+brianrob@users.noreply.github.com>

Copilot AI requested a review from brianrob November 21, 2025 05:18

Copilot finished work on behalf of brianrob November 21, 2025 05:18

brianrob marked this pull request as ready for review November 21, 2025 05:20

brianrob requested review from StephenMolloy, cincuranet, leculver, marklio and mconnew as code owners November 21, 2025 05:20

leculver previously approved these changes Nov 21, 2025

View reviewed changes

src/PerfView/StackViewer/FlameGraph.cs Outdated Show resolved Hide resolved

Copilot started work on behalf of leculver November 21, 2025 13:41 View session

Use nameof() for parameter name in ArgumentOutOfRangeException

7af7d62

Co-authored-by: leculver <8496639+leculver@users.noreply.github.com>

Copilot AI dismissed leculver’s stale review via 7af7d62 November 21, 2025 13:43

Copilot finished work on behalf of leculver November 21, 2025 13:44

Copilot AI requested a review from leculver November 21, 2025 13:44

leculver approved these changes Nov 21, 2025

View reviewed changes

StephenMolloy approved these changes Nov 21, 2025

View reviewed changes

brianrob merged commit 699501e into main Nov 21, 2025
12 checks passed

brianrob deleted the copilot/fix-unhandled-exception-flame-graph branch November 21, 2025 16:43

github-actions bot mentioned this pull request Jan 29, 2026

Update PerfView to version 3.1.29 ilabutin/chocolatey-packages#8

Merged

	throw new InvalidOperationException(
	throw new ArgumentOutOfRangeException(

	catch (InvalidOperationException ex)
	catch (ArgumentOutOfRangeException ex)

	var exception = Assert.Throws<InvalidOperationException>(() =>
	var exception = Assert.Throws<ArgumentOutOfRangeException>(() =>

	$"canvas has an invalid size (width={width}, height={height}). Please ensure the flame graph is visible and has been rendered before attempting to export.");
	$"Canvas has an invalid size (width={width}, height={height}). Please ensure the flame graph is visible and has been rendered before attempting to export.");

	Assert.Contains("canvas has an invalid size", exception.Message);
	Assert.Contains("Canvas has an invalid size", exception.Message);

Conversation

Copilot AI commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

brianrob left a comment

Choose a reason for hiding this comment

Uh oh!

brianrob Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

brianrob Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

brianrob Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

brianrob Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Nov 21, 2025

Uh oh!

brianrob left a comment

Choose a reason for hiding this comment

Uh oh!

brianrob Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

brianrob Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Nov 21, 2025

Uh oh!

leculver left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

StephenMolloy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

Copilot AI commented Nov 21, 2025 •

edited

Loading