Skip to main content

Coding Stories

Parameter names
public void class Person 
{
  …
  public bool IsSimilar(Person person2) { … }
}
What do you think about the name of parameter name ‘person2’. Names of parameters, fields like xxx1, xxx2, xxx3 are not the best choice. In this case maybe a better name would be ‘otherPerson’.
Magic numbers
public void ValidatePhone(string phoneNumber)
{
  … phoneNumber.Contains(“40”);  
}
The “40” don’t’ say nothing to a reader. What this value represent, why is used and so on. If this value is used in only one place you should at least extract a constant in the body of method. In the case the same value is used in different places of the application, you should put this constraints in a common place.

Property names and enums
public class InvitesFilter
{
  public bool SendByLetter { get; set; }
  public bool SendBySms { get; set; }
  public bool SendByMail { get; set; }
  …
}
First of all, do we really need the ‘SendBy’ prefix? We already know that it is in invitation filter. You cannot send an invitation by receiving it.
Also, if we look closely, this should not be a class. This is clear an enum. If you need to support more than one value set, than you should use the ‘Flag’ attribute.
[Flag]
public void InvitesFilter
{
  Letter = 1,
  Sms = 2,
  Mail = 4
}
Don’t forget to set numeric values to enum items that are power of 2.
Common component (assembly)
It is great to have a common component. But try to not mix the common items from UI with the rest of the classes that are common. For example we don’t want to have in this component all the classes plus some XAML. Even if the XAML is something that is used in 2,3 components, you should create a different component for this (xxx.UI.Common).

Property name
xxxCallbackArgs.IsUserCancel – this property is set to true in the moment when the given action was canceled by the user. The name of the property doesn’t transmit the same thing. If I don’t know the implementation, I would say that this property would tell me if the user was canceled. A better name would be HasCancelledByUser or IsCancelledByUser.

Singleton and static properties
There are a lot of places where I usually see something like this:
public class Foo
{
  private Foo _instance;

  public static Foo Instance
  {
    if ( _instance == null )
    {
      _instance = new Foo();
    }
  }
}
If we are in a multi-thread application, there can be a situation when two threads could be in the same time in the IF. A lock should be used after the IF check and another check need to be made – because during the period when we wait the lock another thread can create a new instance.
public class Foo
{
  private Foo _instance;
  private object _padLock = new Object();
  
  public static Foo Instance
  {
    if ( _instance == null )
    {
      lock( _padLock )
      {
        if ( _instance == null )
        {
          _instance = new Foo();
        }
    }
  }
}
}

Single Responsibility Principle
The User class has a property field. This property need to be encrypted, so the class ends up with two private methods used to encrypt and decrypt the password. Do you thing that we should have the implementation of this class defined in the User class?
I would say NO. We should have a different class that can encrypt and decrypt. Not only will the User class manage only the user information, but the encryption algorithm will be easier to test.

Comments

Popular posts from this blog

How to check in AngularJS if a service was register or not

There are cases when you need to check in a service or a controller was register in AngularJS.
For example a valid use case is when you have the same implementation running on multiple application. In this case, you may want to intercept the HTTP provider and add a custom step there. This step don’t needs to run on all the application, only in the one where the service exist and register.
A solution for this case would be to have a flag in the configuration that specify this. In the core you would have an IF that would check the value of this flag.
Another solution is to check if a specific service was register in AngularJS or not. If the service was register that you would execute your own logic.
To check if a service was register or not in AngularJS container you need to call the ‘has’ method of ‘inhector’. It will return TRUE if the service was register.
if ($injector.has('httpInterceptorService')) { $httpProvider.interceptors.push('httpInterceptorService&#…

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine:
threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration:

TeamCity.NET 4.51EF 6.0.2VS2013
It seems that there …

Run native .NET application in Docker (.NET Framework 4.6.2)

Scope
The main scope of this post is to see how we can run a legacy application written in .NET Framework in Docker.

Context
First of all, let’s define what is a legacy application in our context. By a legacy application we understand an application that runs .NET Framework 3.5 or higher in a production environment where we don’t have any more the people or documentation that would help us to understand what is happening behind the scene.
In this scenarios, you might want to migrate the current solution from a standard environment to Docker. There are many advantages for such a migration, like:

Continuous DeploymentTestingIsolationSecurity at container levelVersioning ControlEnvironment Standardization
Until now, we didn’t had the possibility to run a .NET application in Docker. With .NET Core, there was support for .NET Core in Docker, but migration from a full .NET framework to .NET Core can be costly and even impossible. Not only because of lack of features, but also because once you…