Prevent breaking changes using Microsoft.CodeAnalysis.PublicApiAnalyzers

For one of my clients, I maintain a set of libraries that help to streamline the development of new applications in .NET Core. The functionality offered through these libraries follow the 'paved road' principle and help the development teams to fall in the pit of success. They are used by multiple development teams working on different projects.

As a library author, I don’t have full control on all the different ways these libraries are used so I have to be very conscious in avoiding breaking changes. In this post I want to share some details on how I try to manage and avoid breaking changes.

Microsoft.CodeAnalysis.PublicApiAnalyzers

The ‘magic’ solution I use to avoid or handle breaking changes is with the help of a specific Roslyn analyzer, the Microsoft.CodeAnalysis.PublicApiAnalyzers.

Let me explain how this analyzer works.

First add a package reference to Microsoft.CodeAnalysis.PublicApiAnalyzers to your project:

dotnet add package Microsoft.CodeAnalysis.PublicAnalyzers

This will add 2 extra files to your project:

PublicAPI.Shipped.txt
PublicApi.Unshipped.txt

When you now try to build your project, you get a RS0016 diagnostics on all your public APIs:

This warning helps you to be aware that a change is done in a public api so that you can take it into account in code reviews and pull requests (or look at a way to avoid introducing a breaking change).

You can now use the code fix feature to add the API to the PublicAPI.Unshipped.txt file:

Remark: In Visual Studio, you can apply the fix in one go for all changes.

If I have changes in this file, I know that a made a breaking change somewhere. This allows me to track these breaking changes in an effective and centralized way.

It is up to you as a library author when you release a new version of your library to copy the changes from the PublicAPI.Unshipped.txt file to the PublicAPI.Shipped.txt file.

Remark: While preparing this post, I stumbled over an alternative solution, PublicApiGenerator, mentioned in a blog post by Andrew Lock. If you have experience using this package, please let me now.

More information

The paved road

NuGet Gallery | Microsoft.CodeAnalysis.PublicApiAnalyzers 3.3.4

Preventing breaking changes in public APIs with PublicApiGenerator

NuGet Gallery | PublicApiGenerator 11.3.0

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME ...

Cache stampede: when our cache turned against us

While investigating some performance issues, we ran into an ASP.NET Core API that cached a fairly expensive aggregation query for 60 seconds. Under normal load, that was fine: one request rebuilds the cache, everyone else reads from it. Under peak load, dozens of requests would arrive in that same expiry window, all see a cache miss, and all fire the same expensive query in parallel. The database didn't like that. That was the moment when our caching layer stopped helping and started hurting. A burst of requests comes in at the same time, all miss the cache, and all go hammer the database or the downstream API at once. That's a cache stampede . The cache was supposed to protect our backend, and for a few hundred milliseconds it did the opposite. Why this happens IMemoryCache.GetOrCreate (and its async sibling) looks like it protects you, but it doesn't add any locking on its own. Look at the naive version: public async Task<Report> GetReportAsync(string key) ...

A complex system designed from scratch never works

A few years ago, I worked as an architect on a big mainframe rewrite. I still count it as one of my failures. Not because the technology was wrong, but because I couldn't convince the management team to simplify the approach. Years later, the organization is still struggling to get the new system up and running. I left the project at the time, because I couldn't put my name behind an approach that would take very long and cost a lot of money without a working system to show for it along the way. Gall’s Law That memory keeps coming back to me, because it's a textbook case of Gall's Law playing out in real life. Gall's Law , from John Gall's Systemantics , states it plainly: A complex system that works is invariably found to have evolved from a simple system that worked. A complex system designed from scratch never works, and it cannot be patched to make it work. You have to start over with a simple system that works. What does that mean in practice,...

The art of simplicity

Search This Blog