Skip to main content

Encapsulate libraries not frameworks

Encapsulation is a way of organizing code into separate modules, where each module has a clear and well-defined responsibility. It allows for better code reusability, maintainability, and testability.

Libraries and frameworks are both useful tools for building software applications. However, there is a key difference between the two in terms of encapsulation.

Libraries are typically designed to provide a set of functions or utilities that can be used in a variety of contexts. They are generally more loosely coupled and have fewer dependencies on your application code. Encapsulating a library means that you isolate its functionality and implementation details, allowing your application code to interact with it through a well-defined interface.

It can be a good idea to encapsulate a library to limit the dependencies to third-party components which makes it harder to maintain your application in the long run. Typically we do this by creating a wrapper that isolates our component by a specific interface.

Pro tip: Focus only on the functionality you need in this interface and don’t try to mimic the complete library.

Frameworks, on the other hand, are designed to provide a more comprehensive solution for building an entire application. They often include a set of pre-defined patterns, structures, and conventions that are tightly integrated with your application code. Encapsulating a framework can be more difficult because it may require modifying the way your application is structured, which could impact its overall architecture.

It is possible to wrap a framework, but it’s often more trouble than it’s worth.

Therefore, it is generally recommended to encapsulate libraries but not frameworks. Encapsulating a library can provide many benefits, while encapsulating a framework can be more challenging and may not provide the same level of benefits.

Popular posts from this blog

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) ...

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.