[IGNITE-13160] .NET: wrong affinity key registration with AffinityKeyMapped attribute

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.8.1
• Fix Version/s: 2.10
• Component/s: platforms
• Release Note: .NET: Fix binary metadata registration for QueryEntity key and value types
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Pavel Tupitsyn
• Reporter: Alexandr Shapkin
• Created: 17/Jun/20 22:18
• Updated: 28/Oct/21 11:52
• Resolved: 22/Oct/20 11:53

Description

When QueryEntities is set alongside a custom key that utilizes the AffinityKeyMapped attribute, the field won't be taken into account for some reason. When QueryEntities configuration gets removed, all works fine, setting KeyConfiguration manually helps as well. At the same time, the BinaryType registration itself looks fine.

After the investigation, it turned out that affinityKey field is not being registered on cache registration, and null is being cached instead. Later on Ignite correctly tries to register a custom class as a key, but it's never being updated internally case the real value is already cached.

 

NOTE: there is a workaround - you need to specify the key configuration explicitly:

cacheConfiguration.KeyConfiguration = new List<CacheKeyConfiguration>(1)
{
 //affinityKey should be auto adjusted with Reflection
 new CacheKeyConfiguration(typeof(MyKey))
};
 

 

Reproducer (add to the AffinityTest.cs):

        /// <summary>
        /// Tests AffinityKeyMapped attribute should map to the same partitions
        /// for the same field value.
        /// </summary>
        [Test]
        public void TestCustomAffinity()
        {
            IIgnite g = Ignition.GetIgnite("grid-0");

            var cacheCfg = new CacheConfiguration("mycache")
            {
                // Without QueryEntities tests passes.
                QueryEntities = new List<QueryEntity>()
                {
                    new QueryEntity(typeof(MyKey), typeof(int))
                }
            };
            g.GetOrCreateCache<MyKey, int>(cacheCfg);

            var key1 = new MyKey {Data = "data1", AffinityKey = 1};
            var key2 = new MyKey {Data = "data2", AffinityKey = 1};

            ICacheAffinity aff = g.GetAffinity(cacheCfg.Name);
            Assert.AreEqual(aff.GetPartition(key1), aff.GetPartition(key2));
        }

        public class MyKey
        {
            [QuerySqlField]
            public string Data { get; set; }
            [AffinityKeyMapped]
            public long AffinityKey { get; set; }
        }

Issue Links

• causes: IGNITE-13607 .NET: Binary meta is not registered from QueryEntity on cache start when types are not present on server node
• causes: IGNITE-14293 .NET: AffinityKey does not work
• causes: IGNITE-14856 "Failed to resolve class name" on server when cache with indexed types is defined on client
• causes: IGNITE-15845 .NET: CreateCache fails - Invalid array specification
• causes: IGNITE-13588 .NET: Incorrect binary type name is registered for generic query types
• is caused by: IGNITE-5795 Binary metadata is not registered during start of cache
• links to: GitHub Pull Request #8378