Skip to main content

[Code refactoring] Releasing resources that you still need

Let’s look over the following code and see if we can find the bug. When the Callback method is called, the _callbackAction field is null all the time (except 2-3 exception).
public class FooReader: IDisposable
{
  private ExternalComResource _externalResource;

  private Action<Foo> _callbackAction;
  
  public void Start(Action<Foo> callbackAction)
  {            
    lock (this)
    {
      _callbackAction = callbackAction;                               

      _externalResource = new ExternalComResource();
      ...
      _externalResource.Callback += Callback;
      _externalResource.Start(1);      
    }
  }
  
  public void Stop()
  {
    StopAndReleaseResources();
  }

  private void Callback(object source, EventArgs e)
  {
    ...
    StopCapture();            
    ...
    if (_callbackAction != null)
    {
      _callbackAction.Invoke(someData);
    }
    ...
  }       

  public void Dispose()
  {
    StopAndReleaseResources();
  }

  private void StopAndReleaseResources()
  {
    if (_externalResource != null)
    {
      lock (this)
      {
        if (_externalResource != null)
        {
          _externalResource.Stop();
          _externalResource.Dispose();
          _externalResource = null;
          _callbackAction = null;
        }
      }
    }
  }
}
Did you spotted the problem?
Well, the root cause of the problem is ‘Stop’ method. If we look closely you will see that the callback field is set to NULL when the results comes.
This is the kind of bug where you can spend 2-3 hours, trying to understand why you cannot access local fields from other thread, looking over AppDomain, MarshalByRefObject and what the hell is panning.
What you should never do: You should never use the action that is executed in the Dispose in other method because you know that resources are disposed. You could dispose more than you want.
The code should look like this this (but we still use the 'Dispose' method for Stop):
public class FooReader: IDisposable
{
  private ExternalComResource _externalResource;

  private Action<Foo> _callbackAction;
  
  public void Start(Action<Foo> callbackAction)
  {            
    lock (this)
    {
      _callbackAction = callbackAction;                               

      _externalResource = new ExternalComResource();
      ...
      _externalResource.Callback += Callback;
      _externalResource.Start(1);      
    }
  }
  
  public void Stop()
  {
    StopAndReleaseResources();
  }

  private void Callback(object source, EventArgs e)
  {
    ...
    StopCapture();            
    ...
    if (_callbackAction != null)
    {
      _callbackAction.Invoke(someData);
    }
    ...
  }       

  public void Dispose()
  {
    StopAndReleaseResources();
  }

  private void StopAndReleaseResources()
  {
    if (_externalResource != null)
    {
      lock (this)
      {
        if (_externalResource != null)
        {
          _externalResource.Stop();
          _externalResource.Dispose();
          _externalResource = null;  
          //_callbackAction = null;        
        }
      }
    }
  }
}

Comments

Popular posts from this blog

Why Database Modernization Matters for AI

  When companies transition to the cloud, they typically begin with applications and virtual machines, which is often the easier part of the process. The actual complexity arises later when databases are moved. To save time and effort, cloud adoption is more of a cloud migration in an IaaS manner, fulfilling current, but not future needs. Even organisations that are already in the cloud find that their databases, although “migrated,” are not genuinely modernised. This disparity becomes particularly evident when they begin to explore AI technologies. Understanding Modernisation Beyond Migration Database modernisation is distinct from merely relocating an outdated database to Azure. It's about making your data layer ready for future needs, like automation, real-time analytics, and AI capabilities. AI needs high throughput, which can be achieved using native DB cloud capabilities. When your database runs in a traditional setup (even hosted in the cloud), in that case, you will enc...

Cloud Myths: Migrating to the cloud is quick and easy (Pill 2 of 5 / Cloud Pills)

The idea that migration to the cloud is simple, straightforward and rapid is a wrong assumption. It’s a common misconception of business stakeholders that generates delays, budget overruns and technical dept. A migration requires laborious planning, technical expertise and a rigorous process.  Migrations, especially cloud migrations, are not one-size-fits-all journeys. One of the most critical steps is under evaluation, under budget and under consideration. The evaluation phase, where existing infrastructure, applications, database, network and the end-to-end estate are evaluated and mapped to a cloud strategy, is crucial to ensure the success of cloud migration. Additional factors such as security, compliance, and system dependencies increase the complexity of cloud migration.  A misconception regarding lift-and-shits is that they are fast and cheap. Moving applications to the cloud without changes does not provide the capability to optimise costs and performance, leading to ...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...