Rename PersistenceException to PaPersistenceException so it's una…

…mbiguous with similar type in DocSvr
microsoft · May 8, 2024 · d55c489 · d55c489
1 parent 3cd99b7
commit d55c489
Show file tree

Hide file tree

Showing 13 changed files with 45 additions and 45 deletions.
diff --git a/src/Persistence.Tests/Extensions/PersistenceExceptionAssertionsExtensions.cs b/src/Persistence.Tests/Extensions/PersistenceExceptionAssertionsExtensions.cs
@@ -15,7 +15,7 @@ public static ExceptionAssertions<TException> WithErrorCode<TException>(
         PersistenceErrorCode errorCode,
         string? because = null,
         params object[] becauseArgs)
-        where TException : PersistenceException
+        where TException : PaPersistenceException
     {
         _ = assertion ?? throw new ArgumentNullException(nameof(assertion));
 
@@ -36,7 +36,7 @@ public static ExceptionAssertions<TException> WithReason<TException>(
         string? wildcardPattern,
         string? because = null,
         params object[] becauseArgs)
-        where TException : PersistenceException
+        where TException : PaPersistenceException
     {
         _ = assertion ?? throw new ArgumentNullException(nameof(assertion));
 

diff --git a/src/Persistence.Tests/MsApp/MsappArchiveTests.cs b/src/Persistence.Tests/MsApp/MsappArchiveTests.cs
@@ -73,7 +73,7 @@ public void AddEntryTests(string[] entries, string[] expectedEntries)
         }
 
         // Get the required entry should throw if it doesn't exist
-        msappArchive.Invoking(a => a.GetRequiredEntry("not-exist")).Should().Throw<PersistenceException>()
+        msappArchive.Invoking(a => a.GetRequiredEntry("not-exist")).Should().Throw<PaPersistenceException>()
             .WithErrorCode(PersistenceErrorCode.MsappArchiveError);
     }
 

diff --git a/src/Persistence.Tests/MsApp/RoundTripWriterTests.cs b/src/Persistence.Tests/MsApp/RoundTripWriterTests.cs
@@ -58,7 +58,7 @@ public void Write_Should_Fail(string input, string output, int line, int column)
         };
 
         // Assert
-        var thrownEx = act.Should().ThrowExactly<PersistenceException>()
+        var thrownEx = act.Should().ThrowExactly<PaPersistenceException>()
             .WithErrorCode(PersistenceErrorCode.RoundTripValidationFailed)
             .Which;
         thrownEx.MsappEntryFullPath.Should().Be("test");

diff --git a/src/Persistence.Tests/PersistenceExceptionTests.cs b/src/Persistence.Tests/PersistenceExceptionTests.cs
@@ -12,13 +12,13 @@ public class PersistenceExceptionTests
     [TestMethod]
     public void ConstructTest()
     {
-        ThrowAndVerify(new PersistenceException(PersistenceErrorCode.DeserializationError))
+        ThrowAndVerify(new PaPersistenceException(PersistenceErrorCode.DeserializationError))
             .WithErrorCode(PersistenceErrorCode.DeserializationError)
             .WithReason(null);
-        ThrowAndVerify(new PersistenceException(PersistenceErrorCode.SerializationError, "A test reason."))
+        ThrowAndVerify(new PaPersistenceException(PersistenceErrorCode.SerializationError, "A test reason."))
             .WithErrorCode(PersistenceErrorCode.SerializationError)
             .WithReason("A test reason.");
-        ThrowAndVerify(new PersistenceException(PersistenceErrorCode.MsappArchiveError, "A test reason2.")
+        ThrowAndVerify(new PaPersistenceException(PersistenceErrorCode.MsappArchiveError, "A test reason2.")
         {
             MsappEntryFullPath = "src/entry1.txt",
             LineNumber = 5,
@@ -32,17 +32,17 @@ public void ConstructTest()
     [TestMethod]
     public void MessageTest()
     {
-        ThrowAndVerify(new PersistenceException(PersistenceErrorCode.DeserializationError))
+        ThrowAndVerify(new PaPersistenceException(PersistenceErrorCode.DeserializationError))
             .WithMessage("[3000:DeserializationError] An error occurred during deserialization.");
-        ThrowAndVerify(new PersistenceException(PersistenceErrorCode.SerializationError, "A test reason."))
+        ThrowAndVerify(new PaPersistenceException(PersistenceErrorCode.SerializationError, "A test reason."))
             .WithMessage("[2000:SerializationError] An error occurred during serialization. A test reason.");
-        ThrowAndVerify(new PersistenceException(PersistenceErrorCode.YamlInvalidSyntax)
+        ThrowAndVerify(new PaPersistenceException(PersistenceErrorCode.YamlInvalidSyntax)
         {
             LineNumber = 5,
             Column = 3,
         })
             .WithMessage("[3001:YamlInvalidSyntax] Invalid YAML syntax was encountered during deserialization. Line: 5; Column: 3;");
-        ThrowAndVerify(new PersistenceException(PersistenceErrorCode.MsappArchiveError, "A test reason2.")
+        ThrowAndVerify(new PaPersistenceException(PersistenceErrorCode.MsappArchiveError, "A test reason2.")
         {
             MsappEntryFullPath = "src/entry1.txt",
             LineNumber = 5,
@@ -55,9 +55,9 @@ public void MessageTest()
     [TestMethod]
     public void IsSerializableTests()
     {
-        new PersistenceException(PersistenceErrorCode.DeserializationError).Should().BeBinarySerializable();
-        new PersistenceException(PersistenceErrorCode.SerializationError, "A test reason.").Should().BeBinarySerializable();
-        new PersistenceException(PersistenceErrorCode.MsappArchiveError, "A test reason2.")
+        new PaPersistenceException(PersistenceErrorCode.DeserializationError).Should().BeBinarySerializable();
+        new PaPersistenceException(PersistenceErrorCode.SerializationError, "A test reason.").Should().BeBinarySerializable();
+        new PaPersistenceException(PersistenceErrorCode.MsappArchiveError, "A test reason2.")
         {
             MsappEntryFullPath = "src/entry1.txt",
             LineNumber = 5,

diff --git a/src/Persistence.Tests/Yaml/DeserializerInvalidTests.cs b/src/Persistence.Tests/Yaml/DeserializerInvalidTests.cs
@@ -27,7 +27,7 @@ public void Deserialize_ShouldFailWhenYamlIsInvalid(bool isControlIdentifiers)
             var yaml = File.ReadAllText(filePath);
             using var yamlReader = new StringReader(yaml);
             var act = () => deserializer.Deserialize<Control>(yamlReader);
-            act.Should().ThrowExactly<PersistenceException>("deserializing file '{0}' is expected to be invalid", filePath)
+            act.Should().ThrowExactly<PaPersistenceException>("deserializing file '{0}' is expected to be invalid", filePath)
                 .WithErrorCode(PersistenceErrorCode.DeserializationError)
                 .WithInnerExceptionExactly<YamlException>();
         }
@@ -48,7 +48,7 @@ public void Deserialize_ShouldFailWhenExpectingDifferentType(bool isControlIdent
         Action act = () => { deserializer.Deserialize<BuiltInControl>(yamlReader); };
 
         // Assert
-        act.Should().Throw<PersistenceException>()
+        act.Should().Throw<PaPersistenceException>()
             .WithErrorCode(PersistenceErrorCode.DeserializationError)
             .WithInnerExceptionExactly<YamlException>()
             .WithInnerException<NotSupportedException>()
@@ -78,7 +78,7 @@ public void Deserialize_Screens_List(string path, bool isControlIdentifiers)
         };
 
         // Assert
-        act.Should().Throw<PersistenceException>()
+        act.Should().Throw<PaPersistenceException>()
             .WithErrorCode(PersistenceErrorCode.DeserializationError)
             .WithReason("Duplicate control property*")
             .WithInnerExceptionExactly<YamlException>();

diff --git a/src/Persistence/MsApp/MsappArchive.cs b/src/Persistence/MsApp/MsappArchive.cs
@@ -263,7 +263,7 @@ public DataSources? DataSources
     /// <returns></returns>
     /// <exception cref="ArgumentNullException"></exception>
     /// <exception cref="InvalidOperationException"></exception>
-    /// <exception cref="PersistenceException"></exception>
+    /// <exception cref="PaPersistenceException"></exception>
     public T Deserialize<T>(string entryName, bool ensureRoundTrip = true) where T : Control
     {
         if (string.IsNullOrWhiteSpace(entryName))
@@ -292,11 +292,11 @@ public T Deserialize<T>(ZipArchiveEntry archiveEntry) where T : Control
         _ = archiveEntry ?? throw new ArgumentNullException(nameof(archiveEntry));
 
         if (!archiveEntry.FullName.EndsWith(YamlFileExtension, StringComparison.OrdinalIgnoreCase))
-            throw new PersistenceException(PersistenceErrorCode.MsappArchiveError, $"Entry {archiveEntry} is not a yaml file.") { MsappEntryFullPath = archiveEntry.FullName };
+            throw new PaPersistenceException(PersistenceErrorCode.MsappArchiveError, $"Entry {archiveEntry} is not a yaml file.") { MsappEntryFullPath = archiveEntry.FullName };
 
         using var textReader = new StreamReader(archiveEntry.Open());
         return _yamlDeserializer.Deserialize<T>(textReader)
-            ?? throw new PersistenceException(PersistenceErrorCode.EditorStateJsonEmptyOrNull, "Deserialization of file resulted in null object.") { MsappEntryFullPath = archiveEntry.FullName };
+            ?? throw new PaPersistenceException(PersistenceErrorCode.EditorStateJsonEmptyOrNull, "Deserialization of file resulted in null object.") { MsappEntryFullPath = archiveEntry.FullName };
     }
 
     /// <summary>
@@ -346,11 +346,11 @@ public IEnumerable<ZipArchiveEntry> GetDirectoryEntries(string directoryName, st
     /// <param name="entryName"></param>
     /// <returns></returns>
     /// <exception cref="ArgumentException"></exception>
-    /// <exception cref="PersistenceException"></exception>
+    /// <exception cref="PaPersistenceException"></exception>
     public ZipArchiveEntry GetRequiredEntry(string entryName)
     {
         return GetEntry(entryName) ??
-            throw new PersistenceException(PersistenceErrorCode.MsappArchiveError, $"Entry with name '{entryName}' not found in msapp archive.");
+            throw new PaPersistenceException(PersistenceErrorCode.MsappArchiveError, $"Entry with name '{entryName}' not found in msapp archive.");
     }
 
     /// <inheritdoc/>
@@ -632,11 +632,11 @@ private static T DeserializeMsappJsonFile<T>(ZipArchiveEntry entry)
         try
         {
             return JsonSerializer.Deserialize<T>(entry.Open())
-                 ?? throw new PersistenceException(PersistenceErrorCode.EditorStateJsonEmptyOrNull, "Deserialization of json file resulted in null object.") { MsappEntryFullPath = entry.FullName };
+                 ?? throw new PaPersistenceException(PersistenceErrorCode.EditorStateJsonEmptyOrNull, "Deserialization of json file resulted in null object.") { MsappEntryFullPath = entry.FullName };
         }
         catch (JsonException ex)
         {
-            throw new PersistenceException(PersistenceErrorCode.InvalidEditorStateJson, $"Failed to deserialize json file to an instance of {typeof(T).Name}.", ex)
+            throw new PaPersistenceException(PersistenceErrorCode.InvalidEditorStateJson, $"Failed to deserialize json file to an instance of {typeof(T).Name}.", ex)
             {
                 MsappEntryFullPath = entry.FullName,
                 LineNumber = ex.LineNumber,

diff --git a/src/Persistence/MsApp/RoundTripWriter.cs b/src/Persistence/MsApp/RoundTripWriter.cs
@@ -47,7 +47,7 @@ public override void Write(char value)
         if (inputValue == -1 || inputValue != value)
         {
             _exThrown = true;
-            throw new PersistenceException(PersistenceErrorCode.RoundTripValidationFailed, $"Round trip serialization failed")
+            throw new PaPersistenceException(PersistenceErrorCode.RoundTripValidationFailed, $"Round trip serialization failed")
             {
                 MsappEntryFullPath = _entryFullPath,
                 LineNumber = _lineNumber,
@@ -72,7 +72,7 @@ protected override void Dispose(bool disposing)
             var inputValue = _input.Read();
             if (inputValue != -1)
             {
-                throw new PersistenceException(PersistenceErrorCode.RoundTripValidationFailed, $"Round trip serialization failed. Additional input not read when disposing.")
+                throw new PaPersistenceException(PersistenceErrorCode.RoundTripValidationFailed, $"Round trip serialization failed. Additional input not read when disposing.")
                 {
                     MsappEntryFullPath = _entryFullPath,
                     LineNumber = _lineNumber,

diff --git a/src/Persistence/PersistenceException.cs → src/Persistence/PaPersistenceException.cs b/src/Persistence/PersistenceException.cs → src/Persistence/PaPersistenceException.cs
@@ -9,30 +9,30 @@
 namespace Microsoft.PowerPlatform.PowerApps.Persistence;
 
 [Serializable]
-public class PersistenceException : Exception
+public class PaPersistenceException : Exception
 {
-    public PersistenceException(PersistenceErrorCode errorCode)
+    public PaPersistenceException(PersistenceErrorCode errorCode)
         : this(errorCode, null, null)
     {
     }
 
-    public PersistenceException(PersistenceErrorCode errorCode, string reason)
+    public PaPersistenceException(PersistenceErrorCode errorCode, string reason)
         : this(errorCode, reason, null)
     {
     }
 
-    public PersistenceException(PersistenceErrorCode errorCode, Exception innerException)
+    public PaPersistenceException(PersistenceErrorCode errorCode, Exception innerException)
         : this(errorCode, null, innerException)
     {
     }
 
-    public PersistenceException(PersistenceErrorCode errorCode, string? reason, Exception? innerException)
+    public PaPersistenceException(PersistenceErrorCode errorCode, string? reason, Exception? innerException)
         : base(reason ?? string.Empty, innerException) // Convert reason to non-null so base.Message doesn't get set to the default ex message.
     {
         ErrorCode = errorCode.CheckArgumentInRange();
     }
 
-    protected PersistenceException(SerializationInfo info, StreamingContext context)
+    protected PaPersistenceException(SerializationInfo info, StreamingContext context)
         : base(info, context)
     {
         ErrorCode = ((PersistenceErrorCode)info.GetInt32(nameof(ErrorCode))).CheckArgumentInRange();
@@ -114,11 +114,11 @@ public override void GetObjectData(SerializationInfo info, StreamingContext cont
         base.GetObjectData(info, context);
     }
 
-    internal static PersistenceException FromYamlException(YamlException ex, PersistenceErrorCode errorCode)
+    internal static PaPersistenceException FromYamlException(YamlException ex, PersistenceErrorCode errorCode)
     {
         return ex.Start.Equals(Mark.Empty)
-            ? new PersistenceException(errorCode, ex.Message, ex)
-            : new PersistenceException(errorCode, ex.Message, ex)
+            ? new PaPersistenceException(errorCode, ex.Message, ex)
+            : new PaPersistenceException(errorCode, ex.Message, ex)
             {
                 LineNumber = ex.Start.Line,
                 Column = ex.Start.Column,

diff --git a/src/Persistence/PaYaml/Serialization/PaYamlSerializer.cs b/src/Persistence/PaYaml/Serialization/PaYamlSerializer.cs
@@ -60,7 +60,7 @@ private static void WriteTextWriter<TValue>(TextWriter writer, in TValue? value,
         }
         catch (YamlException ex)
         {
-            throw PersistenceException.FromYamlException(ex, PersistenceErrorCode.SerializationError);
+            throw PaPersistenceException.FromYamlException(ex, PersistenceErrorCode.SerializationError);
         }
     }
     #endregion
@@ -117,7 +117,7 @@ private static void WriteTextWriter<TValue>(TextWriter writer, in TValue? value,
         }
         catch (YamlException ex)
         {
-            throw PersistenceException.FromYamlException(ex, PersistenceErrorCode.YamlInvalidSyntax);
+            throw PaPersistenceException.FromYamlException(ex, PersistenceErrorCode.YamlInvalidSyntax);
         }
 
         // TODO: Consider using FluentValidation nuget package to validate the deserialized object

diff --git a/src/Persistence/Yaml/IYamlDeserializer.cs b/src/Persistence/Yaml/IYamlDeserializer.cs
@@ -5,9 +5,9 @@ namespace Microsoft.PowerPlatform.PowerApps.Persistence.Yaml;
 
 public interface IYamlDeserializer
 {
-    /// <exception cref="PersistenceException">Thrown when an error occurs while deserializing.</exception>
+    /// <exception cref="PaPersistenceException">Thrown when an error occurs while deserializing.</exception>
     public T? Deserialize<T>(string yaml) where T : notnull;
 
-    /// <exception cref="PersistenceException">Thrown when an error occurs while deserializing.</exception>
+    /// <exception cref="PaPersistenceException">Thrown when an error occurs while deserializing.</exception>
     public T? Deserialize<T>(TextReader reader) where T : notnull;
 }
diff --git a/src/Persistence/Yaml/IYamlSerializer.cs b/src/Persistence/Yaml/IYamlSerializer.cs
@@ -7,12 +7,12 @@ namespace Microsoft.PowerPlatform.PowerApps.Persistence.Yaml;
 
 public interface IYamlSerializer
 {
-    /// <exception cref="PersistenceException">Thrown when an error occurs while serializing.</exception>
+    /// <exception cref="PaPersistenceException">Thrown when an error occurs while serializing.</exception>
     public string Serialize(object graph);
 
-    /// <exception cref="PersistenceException">Thrown when an error occurs while serializing.</exception>
+    /// <exception cref="PaPersistenceException">Thrown when an error occurs while serializing.</exception>
     public string SerializeControl<T>(T graph) where T : Control;
 
-    /// <exception cref="PersistenceException">Thrown when an error occurs while serializing.</exception>
+    /// <exception cref="PaPersistenceException">Thrown when an error occurs while serializing.</exception>
     public void SerializeControl<T>(TextWriter writer, T graph) where T : Control;
 }
diff --git a/src/Persistence/Yaml/YamlDeserializer.cs b/src/Persistence/Yaml/YamlDeserializer.cs
@@ -38,7 +38,7 @@ internal YamlDeserializer(IDeserializer deserializer)
         }
         catch (YamlException ex)
         {
-            throw PersistenceException.FromYamlException(ex, PersistenceErrorCode.DeserializationError);
+            throw PaPersistenceException.FromYamlException(ex, PersistenceErrorCode.DeserializationError);
         }
     }
 }
diff --git a/src/Persistence/Yaml/YamlSerializer.cs b/src/Persistence/Yaml/YamlSerializer.cs
@@ -46,7 +46,7 @@ private void SerializeCore<T>(TextWriter writer, T graph)
         }
         catch (YamlException ex)
         {
-            throw PersistenceException.FromYamlException(ex, PersistenceErrorCode.SerializationError);
+            throw PaPersistenceException.FromYamlException(ex, PersistenceErrorCode.SerializationError);
         }
     }
 
@@ -58,7 +58,7 @@ private string SerializeCore<T>(T graph)
         }
         catch (YamlException ex)
         {
-            throw PersistenceException.FromYamlException(ex, PersistenceErrorCode.SerializationError);
+            throw PaPersistenceException.FromYamlException(ex, PersistenceErrorCode.SerializationError);
         }
     }
 }