• Error AD0001: Compiler Analyzer … threw an exception of type 'System.InvalidOperationException' with message 'Feature 'IOperation' is disabled.'

    If you upgrade to the latest beta release of one of the Roslyn compiler analyzer packages, you might notice they fail with an error like this:

    Compiler Analyzer 'Microsoft.ApiDesignGuidelines.Analyzers.UsePropertiesWhereAppropriateAnalyzer' threw an exception of type 'System.InvalidOperationException' with message 'Feature 'IOperation' is disabled.'.
    

    The solution wasn’t immediately obvious to me, but I eventually tracked down this comment on a Github issue. According to the comment, the analyzers are using an API that needs to be enabled through configuration. To do this, you need open up the .csproj file and add a new property as a child of the first PropertyGroup element like this:

    <PropertyGroup>
      <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
      <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
      <Features>IOperation</Features>
    

    Or if you have lots of projects, run this PowerShell script to update them all:

    Get-ChildItem *.csproj -Recurse | ForEach-Object {
        $content = [xml] (Get-Content $_)
        $xmlNameSpace = new-object System.Xml.XmlNamespaceManager($content.NameTable)
        $xmlNameSpace.AddNamespace("p", "<a href="http://schemas.microsoft.com/developer/msbuild/2003%22)">http://schemas.microsoft.com/developer/msbuild/2003")</a>
        if (-not $content.Project.PropertyGroup[0].Features) {
            Write-Host "Features missing in $_"
            $featureElt = $content.CreateElement("Features", "<a href="http://schemas.microsoft.com/developer/msbuild/2003%22)">http://schemas.microsoft.com/developer/msbuild/2003")</a>
            $featureElt.set_InnerText("IOperation")
    
            $content.Project.PropertyGroup[0].AppendChild($featureElt)
        }
        $content.Save($_)
    
        # Normalise line endings
        (Get-Content $_ -Encoding UTF8) | Set-Content $_ -Encoding UTF8
    }
    

  • What HockeyApp told me about my Visual Studio extension

    Last time I wrote about how I managed to incorporate HockeyApp into a new Visual Studio extension I’ve created. Well I published the updated extension a couple of days ago and HockeyApp is already paying dividends.

    Here’s the info from HockeyApp at the time of writing:

    Build Number

    Downloads

    Crashes

    Last Updated

    1.1.0.0

    0

    119

    29 Jul 2016, 10:15

    1.0.0.0

    0

    8

    26 Jul 2016, 21:54

    HockeyApp can provide a way to deploy applications, but that isn’t relevant to Visual Studio extensions, which is why the ‘Downloads’ column is zero. So you can see there’s a bunch of crashes (aka exceptions) that my extension is experiencing. Now I’m pretty sure that these wouldn’t be really crashing Visual Studio, but they would be affecting how well the extension works.

    There’s now a number of issues created in the Github repo for me to review:

    A bit of work for me to do now Smile Hopefully not too much - I suspect a few of can all be handled in a similar way. Interesting too to see all the different ways your own code can interact with other parts of both Visual Studio and other extensions!

    Actually after a bit of investigation, I have a theory that most of these exceptions are nothing to do with me. When I configured HockeyApp, I used the RegisterDefaultUnobservedTaskExceptionHandler(). I suspect this was causing HockeyApp to capture any unobserved Task exception that happened in Visual Studio – not just relating to my extension. I guess if there was a way to get HockeyApp to include only those exceptions based on the extension’s namespace that would be more useful.

  • Using HockeyApp to instrument a Visual Studio extension

    I’m working on a new Visual Studio extension and I wanted to include some automatic analytics/crash reporting. Previously I would have looked at Visual Studio Application Insights, but over the last few months Microsoft have been transitioning developers of mobile and desktop apps to use their HockeyApp platform.

    Assuming you’ve signed up for HockeyApp (or as in my case, had an existing Insights app on Azure that was migrated over to HockeyApp), you are ready to start using HockeyApp.

    There is a choice of NuGet packages to choose from, depending on the kind of application you’re building. Nothing specifically for a Visual Studio extension, so the next best fit seemed to be HockeySDK.WPF. After all, Visual Studio has WPF in it, so that should work, right?

    Not quite. The WPF package really assumes that you’ve got your own complete WPF application, not just an extension assembly being hosted in another application.

    I encountered a couple of issues.

    TrackException vs HandleException

    The HockeyClient.Current property exposes an IHockeyClient interface. Browsing through the methods exposed on this interface I noticed TrackException. Perfect, I’ll use that in a few strategic try/catch blocks in the application. Just to test things, I added a throw new InvalidOperationException().

    Running the extension under the debugger gave a surprise – I was getting a KeyNotFoundException being thrown from inside that TrackException method call!

    A request for help from the HockeyApp forums pointed me in the right direction. There’s a WPF sample on GitHub. Reviewing the source code there revealed that they’re using a HandleException method which exists on HockeyClient, but not on IHockeyClient. Ok, let’s use that then, and we’re all good right?

    NullReferenceException in HockeyPlatformHelperWPF.get_AppVersion

    Not quite, again!

    This time, I was getting another exception being thrown inside the HockeyPlatformHelperWPF.AppVersion property getter. The SDK itself is also on GitHub, I had a look at the property body. Curiously most of it was already in a try/catch, so I suspected the part not working was in the actual catch block:

    catch (Exception) { }
        // Excecuting Assembly
        _appVersion = Assembly.GetCallingAssembly().GetName().Version.ToString();
    }
    

    Again, because we’re being hosted in another app, the code isn’t finding things as it was expecting. Fortunately it turns out that this code is only run if a field is null, otherwise it just uses the existing cached field value. Unfortunately there isn’t a public setter for that field, so reflection is the only option. Yes, it’s a bit dirty, but it gets the job done.

    I added this code directly after I called HockeyClient.Current.Configure():

    var hockeyClient = (HockeyClient)HockeyClient.Current;
    var helper = new HockeyPlatformHelperWPF();
    
    var crashLogInfo = new CrashLogInformation()
    {
        PackageName = helper.AppPackageName,
        OperatingSystem = helper.OSPlatform,
        Windows = hockeyClient.OsVersion,
        Manufacturer = helper.Manufacturer,
        Model = helper.Model,
        ProductID = helper.ProductID,
        Version = Assembly.GetExecutingAssembly().GetName().Version.ToString()
    };
    
    var field = typeof(HockeyClient).GetField("_crashLogInfo", BindingFlags.NonPublic | BindingFlags.Instance);
    
    field.SetValue(hockeyClient, crashLogInfo);
    

    This code almost completely replicates the functionality found in the HockeyClient.PrefilledCrashLogInfo property, with the exception (ha ha) of the value assigned to Version. Because this code is now part of our extension assembly, I just use GetExecutingAssembly() instead of GetCallingAssembly().

    With these changes made, I’m pleased to report that my InvalidOperationException was properly reported and now appears in HockeyApp. Even nicer, because I configured HockeyApp to talk to GitHub, it automatically created an issue in my extension’s GitHub repository.

    Very nice!