Edit

Share via

Migrate custom check-in policy

  • Article

Warning

To use the provided migration method you must not remove the old implementations of the policies prior to following this guide.

  1. To migrate your custom policies, you should first create a new class with the same methods but inheriting CheckinPolicyBase class (IPolicyCompatibilityJson for IPolicyCompatibility) instead of PolicyBase. Examples:

Obsolete

    [Serializable]
    public class Simple : PolicyBase
    {
       public override string Description => "SimplePolicyDescription";
       ...
    }

Updated

    [Serializable]
    public class SimpleNew : CheckinPolicyBase
    {
        public override string Description => "SimplePolicyDescription";
        ...
    }
  1. If GetBinaryFormatter was overridden, then also implement GetJsonSerializerSettings with same logic for serialization. Example:

Obsolete

    [Serializable]
    public class Simple : PolicyBase
    {
        public override BinaryFormatter GetBinaryFormatter()
        {
            BinaryFormatter formatter = new BinaryFormatter();
            formatter.Binder = new SimpleBinder();
            return formatter;
        }
        ...
    }

Updated

    [Serializable]
    public class SimpleNew : CheckinPolicyBase
    {
        public override JsonSerializerSettings GetJsonSerializerSettings()
        {
            return new JsonSerializerSettings()
            {
                SerializationBinder = new SimpleNewSerializationBinder(),
                TypeNameHandling = TypeNameHandling.Objects
            };
        }
        ...
    }
  1. Instead of the old methods like GetCheckinPoliciesForServerPaths/GetCheckinPolicies/SetCheckinPolicies new ones were introduced: GetCheckinClientPoliciesForServerPaths/GetCheckinClientPolicies/SetCheckinClientPolicies accordingly. For example, default behavior right now for the LoadPolicies method in the package is to use new policies if they are created/available and obsolete ones in case they are absent.

Note

If you are not planning to use the migration method provided by NuGet package, further instructions can be omitted and obsolete policies can be removed, you are done, congratulations!

  1. For your obsolete policy add IPolicyMigration (This interface marked as deprecated only to show that it will be removed as unnecessary together with PolicyBase and IPolicyCompatibility).

Warning

Obsolete policies that don’t inherit this interface will be skipped during migration and not saved as new policies.

  1. Implement ToNewPolicyType from the mentioned interface. It should return the instance of the newly created policy class that is based on currently modified policy. Example:
    [Serializable]
    public class Simple : PolicyBase, IPolicyMigration
    {
        ...
        public CheckinPolicyBase ToNewPolicyType()
        {
            return new SimpleNew();
        }
    }
  1. Call MigrateFromOldPolicies method.

You are done, congratulations!