Merge pull request #383 from DataObjects-NET/6.0-renamefieldhint-validation-bug

Adds dedicated exception when RenameFieldHint.TargetType is absent in storage model

Author: alex-kulakov

ChangeLog/6.0.13_dev.txt

@@ -1,6 +1,7 @@
 [main] Fixed certain cases of bad translation of casts via 'as' operator in LINQ queries
 [main] Addressed certain issues of translation connected with comparison with local entity instace within LINQ queries
 [main] Fixed rare issues of incorrect translation of filtered index expressions including conditional expressions
-[main] Join/LeftJoin is denied to have the same expression instance for both inner/outer selector.
+[main] Join/LeftJoin is denied to have the same expression instance for both inner/outer selector
 [main] Addressed issue when wrong type of join was chosen when .First/FirstOrDefalult() method was used as subquery
+[main] Added dedicated exception when RenameFieldHint.TargetType exists in current model but absent in storage model
 [postgresql] Fixed issue of incorrect translation of contitional expressions including comparison with nullable fields

Orm/Xtensive.Orm.Tests/Issues/IssueJira0804_RenameFieldHintValidationBug.cs

@@ -0,0 +1,76 @@
+// Copyright (C) 2024 Xtensive LLC.
+// This code is distributed under MIT license terms.
+// See the License.txt file in the project root for more information.
+
+using System;
+using NUnit.Framework;
+using Xtensive.Collections;
+using Xtensive.Orm.Upgrade;
+using Xtensive.Orm.Tests.Issues.IssueJira0804_RenameFieldHintValidationBugModel;
+
+
+namespace Xtensive.Orm.Tests.Issues.IssueJira0804_RenameFieldHintValidationBugModel
+{
+  [Serializable]
+  [HierarchyRoot]
+  public class Person : Entity
+  {
+    [Key, Field]
+    public long Id { get; private set; }
+  }
+
+  [Serializable]
+  [HierarchyRoot]
+  public class Address : Entity
+  {
+    [Key, Field]
+    public long Id { get; private set; }
+    [Field]
+    public Person Person { get; set; }
+    [Field]
+    public bool NewName { get; set; }
+  }
+
+  public class Upgrader : UpgradeHandler
+  {
+    public override bool CanUpgradeFrom(string oldVersion) => true;
+
+    protected override void AddUpgradeHints(ISet<UpgradeHint> hints)
+    {
+      base.AddUpgradeHints(hints);
+      _ = hints.Add(
+        new RenameFieldHint(typeof(Address), "FieldToRename", "NewName")
+      );
+    }
+  }
+}
+
+namespace Xtensive.Orm.Tests.Issues
+{
+  [TestFixture]
+  public sealed class IssueJira0804_RenameFieldHintValidationBug
+  {
+    [Test]
+    public void MainTest()
+    {
+      var initConfig = DomainConfigurationFactory.Create();
+      initConfig.Types.Register(typeof(Person));
+      // I don't include this type for it to not exist in database before upgrade
+      // this type is delcared in the hint
+      //initConfig.Types.Register(typeof(Address));
+      initConfig.UpgradeMode = DomainUpgradeMode.Recreate;
+
+      using (var domain = Domain.Build(initConfig)) { }
+
+      var upgradeConfig = DomainConfigurationFactory.Create();
+      upgradeConfig.Types.Register(typeof(Person));
+      upgradeConfig.Types.Register(typeof(Address));
+      upgradeConfig.Types.Register(typeof(Upgrader));
+      upgradeConfig.UpgradeMode = DomainUpgradeMode.PerformSafely;
+
+      _ = Assert.Throws<InvalidOperationException>(() => {
+        using var domain = Domain.Build(upgradeConfig);
+      });
+    }
+  }
+}

Orm/Xtensive.Orm/Orm/Upgrade/Internals/UpgradeHintValidator.cs

@@ -65,7 +65,8 @@ private void ValidateRenameFieldHints(IEnumerable<RenameFieldHint> hints)
         var targetType = currentModel.Types.SingleOrDefault(type => type.UnderlyingType == targetTypeName);
         if (targetType==null)
           throw TypeNotFound(targetTypeName);
-        var sourceType = reverseTypeMapping[targetType];
+        if (!reverseTypeMapping.TryGetValue(targetType, out var sourceType))
+          throw TypeNotFoundInStorageModel(targetTypeName, hint.OldFieldName);
         var sourceTypeName = sourceType.UnderlyingType;
         if (sourceType.GetField(hint.OldFieldName)==null)
           throw FieldNotFound(sourceTypeName, hint.OldFieldName);
@@ -145,20 +146,17 @@ private void ValidateRemoveTypeHints(IEnumerable<RemoveTypeHint> hints)
       }
     }
 
-    private static InvalidOperationException TypeNotFound(string name)
-    {
-      return new InvalidOperationException(string.Format(Strings.ExTypeXIsNotFound, name));
-    }
+    private static InvalidOperationException TypeNotFound(string name) =>
+      new InvalidOperationException(string.Format(Strings.ExTypeXIsNotFound, name));
 
-    private static InvalidOperationException FieldNotFound(string typeName, string fieldName)
-    {
-      return new InvalidOperationException(string.Format(Strings.ExFieldXYIsNotFound, typeName, fieldName));
-    }
+    private static InvalidOperationException TypeNotFoundInStorageModel(string typeName, string oldFieldName) =>
+      new InvalidOperationException(string.Format(Strings.ExTypeXWhichContainsRenamingFieldYDoesntExistInStorageModel, typeName, oldFieldName));
 
-    private static InvalidOperationException HintConflict(UpgradeHint hintOne, UpgradeHint hintTwo)
-    {
-      return new InvalidOperationException(string.Format(Strings.ExHintXIsConflictingWithHintY, hintOne, hintTwo));
-    }
+    private static InvalidOperationException FieldNotFound(string typeName, string fieldName) =>
+      new InvalidOperationException(string.Format(Strings.ExFieldXYIsNotFound, typeName, fieldName));
+
+    private static InvalidOperationException HintConflict(UpgradeHint hintOne, UpgradeHint hintTwo) =>
+      new InvalidOperationException(string.Format(Strings.ExHintXIsConflictingWithHintY, hintOne, hintTwo));
 
     public UpgradeHintValidator(StoredDomainModel currentModel, StoredDomainModel extractedModel, Dictionary<StoredTypeInfo, StoredTypeInfo> typeMapping, Dictionary<StoredTypeInfo, StoredTypeInfo> reverseTypeMapping)
     {

Orm/Xtensive.Orm/Strings.Designer.cs

@@ -3479,4 +3479,7 @@ Error: {1}</value>
   <data name="ExJoinHasSameInnerAndOuterParameterInstances" xml:space="preserve">
     <value>Inner and outer selector expressions have the same parameter instance. Probably you use the same lambda expression for both selectors, which is currently not supported.</value>
   </data>
+  <data name="ExTypeXWhichContainsRenamingFieldYDoesntExistInStorageModel" xml:space="preserve">
+    <value>The type '{0}',which contains renaming field '{1}', doesn't exist in storage model.</value>
+  </data>
 </root>