Microsoft-ui-xaml: TeachingTip throws exception when calling isOpen

[duke7553]

Describe the bug
Defining a TeachingTip in XAML markup and setting the isOpen property will cause the app to crash after throwing a Microsoft C++ exception: winrt::hresult_error at memory location 0x0000001B01A7DF90. Since this is definitely a low level error, it requires certain debug symbols for the Microsoft.UI.Xaml.dll module that are not present on my machine, even after loading all symbols.

Steps to reproduce the bug

Steps to reproduce the behavior:

1. Define any type of TeachingTip in XAML (doesn't matter if bleeding image is present or not)
2. Set the isOpen property from the XAML or C# source to true
3. Build, Deploy, and Launch the app
4. Navigate to the appropriate page which has the TeachingTip defined

Expected behavior

The TeachingTip should appear, and the application should not crash, nor throw any exceptions related to this control.

Screenshots

Version Info

Please Note: Both target SDK versions tested (1809 and Insider build 18327) seemed to demonstrate this bug.

NuGet package version:

| Windows 10 version | Saw the problem? |
| :--------------------------------- | :-------------------- |
| Insider Build (18342) | Yes |
| October 2018 Update (17763) | |
| April 2018 Update (17134) | |
| Fall Creators Update (16299) | |
| Creators Update (15063) | |
| Anniversary Update (14393) | |

| Device form factor | Saw the problem? |
| :-------------------- | :------------------- |
| Desktop | Yes |
| Mobile | |
| Xbox | |
| Surface Hub | |
| IoT | |

Additional context

Creating a reproduction project with nothing except a button and the teaching tip attached to it had the same problem. Furthermore, I understand that this is a pre-release control, so I don't expect it to be working at all. I just wanted to ensure this bug is evaluated before the control is released to stable.

[jevansaks]

Thanks for the report! The missing symbols is something that was broken for this build which I've corrected for future builds, but I did go back and try to re-publish symbols for this prerelease. Hopefully that will be working by the end of today.

As for the crash you're seeing, @StephenLPeters can you please take a look when you're back tomorrow?

[jevansaks]

@duke7553 look like symbols are published now, could you try resolving symbols and getting a crash stack now? Thanks!

[duke7553]

@jevansaks I just tried to resolve the symbols, and everything went fine until I received an error related to base.h not being found.


In case it helps you, this file not found error may be related to what is described above. I did successfully attempt to change the SDK of my project to 19h1, but still couldn't resolve symbols.

[jevansaks]

Could you copy/paste the text from the Callstack window? Some of the files (like base.h) are from generated files and therefore aren't possible to source index since they don't live in GitHub.

[duke7553]

This is everything I found in the call stack window

    [External Code] 
>   Microsoft.UI.Xaml.dll!winrt::throw_hresult(const winrt::hresult result) Line 4567   C++
    [Inline Frame] Microsoft.UI.Xaml.dll!winrt::check_hresult(winrt::hresult) Line 4612 C++
    Microsoft.UI.Xaml.dll!winrt::impl::consume_Windows_UI_Xaml_IVisualStateManagerStatics<winrt::Windows::UI::Xaml::IVisualStateManagerStatics>::GoToState(const winrt::Windows::UI::Xaml::Controls::Control & control, const winrt::param::hstring & stateName, bool useTransitions) Line 5153 C++
    [Inline Frame] Microsoft.UI.Xaml.dll!winrt::Windows::UI::Xaml::VisualStateManager::GoToState::__l2::<lambda_9e66308770f1fce86491830749545e52>::operator()(const winrt::Windows::UI::Xaml::IVisualStateManagerStatics &) Line 17653  C++
    [Inline Frame] Microsoft.UI.Xaml.dll!winrt::impl::factory_cache_entry<winrt::Windows::UI::Xaml::VisualStateManager,winrt::Windows::UI::Xaml::IVisualStateManagerStatics>::call(winrt::Windows::UI::Xaml::VisualStateManager::GoToState::__l2::<lambda_9e66308770f1fce86491830749545e52> &) Line 7403    C++
    Microsoft.UI.Xaml.dll!winrt::impl::call_factory<winrt::Windows::UI::Xaml::VisualStateManager,winrt::Windows::UI::Xaml::IVisualStateManagerStatics,<lambda_9e66308770f1fce86491830749545e52> >(winrt::Windows::UI::Xaml::VisualStateManager::GoToState::__l2::<lambda_9e66308770f1fce86491830749545e52> && callback) Line 7496   C++
    [Inline Frame] Microsoft.UI.Xaml.dll!winrt::Windows::UI::Xaml::VisualStateManager::GoToState(const winrt::Windows::UI::Xaml::Controls::Control & useTransitions, const winrt::param::hstring &) Line 17653  C++
    Microsoft.UI.Xaml.dll!TeachingTip::OnIconSourceChanged() Line 772   C++
    Microsoft.UI.Xaml.dll!TeachingTip::OnApplyTemplate() Line 91    C++
    Microsoft.UI.Xaml.dll!winrt::impl::produce<TeachingTip,winrt::Windows::UI::Xaml::IFrameworkElementOverrides>::OnApplyTemplate() Line 10255  C++
    [External Code] 

[jevansaks]

Thanks! We'll investigate.

[SavoySchuler]

@duke7553, I know in the earlier version of the control there is a bug that causes the tip to crash if it does not contain fields for an icon and hero (formerly "bleeding") content. It is something that should be fixed in the updated version. But to help you where you're at, I've included the code from my working branch of the XAML Sample Gallery below. Does adding the IconSource and BleedingImageContent fix it for you?

.xaml

            <Button Content="Save" Click="SaveButtonClick1">
                <muxc:TeachingTip.Attach>
                    <muxc:TeachingTip x:Name="AutoSaveTip1"
                        Title="Saving automatically"
                        Subtext="We save your changes as you go - so you never have to.">
                        <muxc:TeachingTip.IconSource>
                            <muxc:SymbolIconSource Symbol="Save"/>
                        </muxc:TeachingTip.IconSource>
                        <muxc:TeachingTip.BleedingImageContent>
                            <Grid/>
                        </muxc:TeachingTip.BleedingImageContent>
                    </muxc:TeachingTip>
                </muxc:TeachingTip.Attach>
                <Button.Resources></Button.Resources>
            </Button>

.cs

    private void SaveButtonClick1(object sender, RoutedEventArgs e)
    {
        AutoSaveTip1.IsOpen = true;
    }

If not, it will require @StephenLPeters to help us look into it.

[StephenLPeters]

@duke7553 I've done some digging and found this issue, it is a bug in teaching tip and we are very grateful for your help finding it. If you need a work around right now you can either set an Icon on your teaching tip, or, because of a very strange quirk in this bug, run your app without a debugger attached.

This is actually why this bug escaped us, the crash will only occur while a debugger is attached and the tip has no icon, all of our tests run without a debugger by default and our manual verification included an icon.

I'll be submitting a fix for this shortly. Thanks again!

[duke7553]

@StephenLPeters I tried the workaround to add an IconSource and start without a debugger, but one of two things happen:

• If IsOpen is set from source code, it does not display at all, but no crash.
• If IsOpen is set from markup, it crashes with a similar error as last time.

Not sure if your PR fixes this, but I thought I should report it.

[jevansaks]

Thanks for the extra details, we'll make sure we try both of those scenarios ASAP.

[jevansaks]

@StephenLPeters Once you've verified that this is fixed, please close.

[msft-github-bot]

:tada:This issue was addressed in #364, which has now been successfully released as Microsoft.UI.Xaml v2.1.190319001-prerelease.:tada:

Handy links:

• Release Notes
• Official Nuget Release

[duke7553]

@StephenLPeters The TeachingTip is now able to display when IsOpen is called from non-markup code. I'll close this issue.