Techsola.InstantReplay

[🔬 Currently experimental. More documentation will be added later.]

Produces an animated GIF on demand of the last ten seconds of a Windows desktop app’s user interface. This can be useful to include in error reports or to help understand how an unusual situation came about.

Goals

Low resource usage while recording
Privacy: never captures content from other apps
Ease of consumption: the right thing happens if you double-click a .gif file on Windows or if you open a .gif attachment in a web browser
Fast generation when a GIF is requested

Non-goals

Optimizing GIF file size (unless it also speeds up GIF creation)
Pixel-perfect recording of non-client areas of the app windows (but improvements will be considered)

Is this for me?

While other integrations could happen in the future, right now this library only works with Windows desktop applications that have access to native Win32 APIs.

App model	Supported
Windows Forms	✔
WPF	✔
UWP	❌

To continue fleshing out the list: support currently depends on whether the app is able to invoke native Windows functions such as BitBlt and EnumWindows.

How to use

[🔬 Currently experimental. Examples and more documentation will be added later.]

Set up

Until this library is released to nuget.org, add this package source to a nuget.config file at the root of your project’s source repository:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="Techsola prerelease" value="https://www.myget.org/F/techsola/api/v3/index.json" />
  </packageSources>
</configuration>

If your project was open in Visual Studio when you edited the nuget.config file, close the solution and reopen it. Then use the NuGet package manager to install the latest available version of the package Techsola.InstantReplay into your app’s startup project. Make sure that the ‘Include prerelease’ box is checked and the selected package source is ‘All.’

Now that the package is added to your project, add a call to InstantReplayCamera.Start(); before your app’s first window is shown. (The namespace to include is Techsola.InstantReplay.) This call only needs to be made once in the lifetime of the process. Subsequent calls are ignored.

For a Windows Forms app, the ideal place for this call is in Program.Main before Application.Run is called.

Profit

Whenever you want a GIF of the last ten seconds of the app’s user interface, call InstantReplayCamera.SaveGif(); to obtain a byte array containing an animated GIF. (Or null, if there are currently no frames to save.) A good place to do this is in your app’s top-level unhandled exception reporter so that you get a recording of the UI along with the exception information.

ℹ Consider calling InstantReplayCamera.SaveGif on a non-UI thread using Task.Run due to the CPU-blocking work it takes to encode a GIF. This way the user interface doesn't pause for even a split second.

Debugging into Techsola.InstantReplay source

Stepping into Techsola.InstantReplay source code, pausing the debugger while execution is inside Techsola.InstantReplay code and seeing the source, and setting breakpoints in Techsola.InstantReplay all require loading symbols for Techsola.InstantReplay. To do this in Visual Studio:

Go to Debug > Options, and uncheck ‘Enable Just My Code.’ (It’s a good idea to reenable this as soon as you’re finished with the task that requires debugging into a specific external library.)
ℹ Before doing this, because Visual Studio can become unresponsive when attempting to load symbols for absolutely everything, I recommend going to Debugging > Symbols within the Options window and selecting ‘Load only specified modules.’
If you are using a prerelease version of Techsola.InstantReplay package, go to Debugging > Symbols within the Options window and add this as a new symbol location: https://www.myget.org/F/techsola/api/v2/symbolpackage/
If you are using a version that was released to nuget.org, enable the built-in ‘NuGet.org Symbol Server’ symbol location.
If ‘Load only specified modules’ is selected in Options > Debugging > Symbols, you will have to explicitly tell Visual Studio to load symbols for Techsola.InstantReplay. One way to do this while debugging is to go to Debug > Windows > Modules and right-click on Techsola.InstantReplay. Select ‘Load Symbols’ if you only want to do it for the current debugging session. Select ‘Always Load Automatically’ if you want to load symbols now and also add the file name to a list so that Visual Studio loads Techsola.InstantReplay symbols in all future debug sessions when Just My Code is disabled.

jnm2 / InstantReplay