Sample App Images not showing in Docs?

[michael-hawker]

Describe the bug

Images are missing in docs for sample app? (Thought this was working before.)

Steps to Reproduce

• Can this be reproduced in the Sample App? (Either in a sample as-is or with new XAML pasted in the editor.) If so, please provide custom XAML or steps to reproduce. If not, let us know why it can't be reproduced (e.g. more complex setup, environment, dependencies, etc...)

Steps to reproduce the behavior:

1. Given sample app
2. Go to PersonView sample
3. Image Missing

Expected behavior

A clear and concise description of what you expected to happen.

Screenshots

Environment

NuGet Package(s): 

Package Version(s): 

Windows 10 Build Number:
- [ ] Fall Creators Update (16299)
- [ ] April 2018 Update (17134)
- [ ] October 2018 Update (17763)
- [ ] May 2019 Update (18362)
- [ ] May 2020 Update (19041)
- [ ] Insider Build (build number: )

App min and target version:
- [ ] Fall Creators Update (16299)
- [ ] April 2018 Update (17134)
- [ ] October 2018 Update (17763)
- [ ] May 2019 Update (18362)
- [ ] May 2020 Update (19041)
- [ ] Insider Build (xxxxx)

Device form factor:
- [ ] Desktop
- [ ] Xbox
- [ ] Surface Hub
- [ ] IoT

Visual Studio 
- [ ] 2017 (version: )
- [ ] 2019 (version: ) 
- [ ] 2019 Preview (version: )

Additional context

Add any other context about the problem here.

Hello michael-hawker, thank you for opening an issue with us!

I have automatically added a "needs triage" label to help get things started. Our team will analyze and investigate the issue, and escalate it to the relevant team if possible. Other community members may also look into the issue and provide feedback 🙌

[michael-hawker]

Ah, this seems to only happen in release mode, just ran in Debug and it was fine... so different code path is a culprit somewhere.

[michael-hawker]

Probably has to do with this function, but haven't compared what's different yet. Debugger crapped out in Release mode and is unreliable with optimizations

https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/2c04c96cdd9e9c574f4a7a5c33d6b3a7ae8546ac/Microsoft.Toolkit.Uwp.SampleApp/Pages/SampleController.xaml.cs#L448-L482

[michael-hawker]

This is what things look like in Debug mode where the image loads properly passing into both if blocks:

[michael-hawker]

I couldn't get the resolved url, but looks like it should go down the same path in Release mode:

Wonder then if this is something with it not copying/caching the images to that folder then somewhere else?

I don't see where we would inspect the documentation file we download and grab any referenced images to download either from here:

https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/2c04c96cdd9e9c574f4a7a5c33d6b3a7ae8546ac/Microsoft.Toolkit.Uwp.SampleApp/Models/Sample.cs#L229-L267

@RosarioPulella @nmetulev thoughts? Think we're maybe not even caching the images at all after we clear the local cache?

Like if I go into the AppX folder and take a peak, we can see the Release folder is missing the resources folder that contains the images:

Has this been a long-standing bug we've missed in the past?

[Rosuavio]

I think I figured it out.

https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/2c04c96cdd9e9c574f4a7a5c33d6b3a7ae8546ac/Microsoft.Toolkit.Uwp.SampleApp/Models/Sample.cs#L244-L265

await StorageFileHelper.WriteTextToLocalCacheFileAsync(_cachedDocumentation, filename); is failing because filename is null and its null because in

https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/2c04c96cdd9e9c574f4a7a5c33d6b3a7ae8546ac/Microsoft.Toolkit.Uwp.SampleApp/Models/Sample.cs#L221-L227

filename = Path.GetFileName(RemoteDocumentationPath); sets filename to null because RemoteDocumentationPath is null.

The interesting thing is that in a way when await StorageFileHelper.WriteTextToLocalCacheFileAsync(_cachedDocumentation, filename); fails it gives a false positive because _cachedDocumentation is remains as the result of ProcessDocs(result); even though await StorageFileHelper.WriteTextToLocalCacheFileAsync(_cachedDocumentation, filename); has failed.

so when it hits
https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/2c04c96cdd9e9c574f4a7a5c33d6b3a7ae8546ac/Microsoft.Toolkit.Uwp.SampleApp/Models/Sample.cs#L270-L283

it is skipped, unlike in debug because in debug it is still and empty string and in release it is not empty.

[michael-hawker]

Ah, I found this line:

https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/2c04c96cdd9e9c574f4a7a5c33d6b3a7ae8546ac/Microsoft.Toolkit.Uwp.SampleApp/Pages/SampleController.xaml.cs#L465

Which is what caches (or uses the cached) image, somehow it's not the default case now. So investigating.

I'm making a REMOTE_DOCS compilation flag for this feature of the sample app, so that way we can enable it more easily even when in DEBUG mode to better test out the doc caching and fetching from the remote.