Deprecate legacy error codes (#3156)

Author: nirinchev

.github/templates/test-ios.yml

@@ -30,6 +30,11 @@ jobs:
       - #@ template.replace(checkoutCode())
       - #@ template.replace(fetchPackageArtifacts())
       - #@ setupDotnet()
+      - name: Set XCode Version
+        shell: bash
+        run: |
+          sudo xcode-select -s "/Applications/Xcode_14.1.app"
+          echo "MD_APPLE_SDK_ROOT=/Applications/Xcode_14.1.app" >> $GITHUB_ENV
       - name: Setup workloads
         run: |
           dotnet workload install maui

.github/workflows/test-ios.yml

@@ -119,6 +119,11 @@ jobs:
       uses: actions/setup-dotnet@607fce577a46308457984d59e4954e075820f10a
       with:
         dotnet-version: 6.0.x
+    - name: Set XCode Version
+      shell: bash
+      run: |
+        sudo xcode-select -s "/Applications/Xcode_14.1.app"
+        echo "MD_APPLE_SDK_ROOT=/Applications/Xcode_14.1.app" >> $GITHUB_ENV
     - name: Setup workloads
       run: |
         dotnet workload install maui

CHANGELOG.md

@@ -36,6 +36,7 @@
 * Fixes an issue with where the source generator will not add the namespace for types used in properties' initializers. (Issue [#3135](https://github.com/realm/realm-dotnet/issues/3135))
 * Fixed an issue that would prevent Realm from working correctly in Unity applications that have [Domain Reloading](https://docs.unity3d.com/Manual/DomainReloading.html) turned off. (Issue [#2898](https://github.com/realm/realm-dotnet/issues/2898))
 * Fixed a bug when using `string.Contains` in .NET 2.1 or later where the search string is not a literal. (Issue [#3134](https://github.com/realm/realm-dotnet/issues/3134))
+* Added `[Obsolete]` notice for a few `ErrorCode` enum members that are no longer in use. (Issue [#3155](https://github.com/realm/realm-dotnet/issues/3155)
 
 ### Compatibility
 * Realm Studio: 12.0.0 or later.

Realm/Realm/DatabaseTypes/RealmDictionary.cs

@@ -33,6 +33,7 @@ namespace Realms
     [Preserve(AllMembers = true)]
     [EditorBrowsable(EditorBrowsableState.Never)]
     [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "This should not be directly accessed by users.")]
+    [SuppressMessage("Design", "CA1010:Generic interface should also be implemented", Justification = "IList conformance is needed for UWP databinding. IList<T> is not necessary.")]
     [DebuggerDisplay("Count = {Count}")]
     public class RealmDictionary<TValue>
         : RealmCollectionBase<KeyValuePair<string, TValue>>,

Realm/Realm/DatabaseTypes/RealmSet.cs

@@ -33,6 +33,7 @@ namespace Realms
     [Preserve(AllMembers = true)]
     [EditorBrowsable(EditorBrowsableState.Never)]
     [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "This should not be directly accessed by users.")]
+    [SuppressMessage("Design", "CA1010:Generic interface should also be implemented", Justification = "IList conformance is needed for UWP databinding. IList<T> is not necessary.")]
     [DebuggerDisplay("Count = {Count}")]
     public class RealmSet<T> : RealmCollectionBase<T>, ISet<T>, IDynamicMetaObjectProvider
     {

Realm/Realm/Exceptions/Sync/ErrorCode.cs

@@ -16,6 +16,8 @@
 //
 ////////////////////////////////////////////////////////////////////////////
 
+using System;
+
 namespace Realms.Sync.Exceptions
 {
     /// <summary>
@@ -97,13 +99,19 @@ public enum ErrorCode
         /// <summary>
         /// The session has been disabled.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         DisabledSession = 213,
 
         /// <summary>
         /// The client file is invalid.
         /// </summary>
         BadClientFile = 217,
 
+        /// <summary>
+        /// Client file has expired likely due to history compaction on the server.
+        /// </summary>
+        ClientFileExpired = 222,
+
         /// <summary>
         /// The user for this session doesn't match the user who originally created the file. This can happen
         /// if you explicitly specify the Realm file path in the configuration and you open the Realm first with
@@ -159,56 +167,67 @@ public enum ErrorCode
         /// <summary>
         /// Your request parameters did not validate.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         InvalidParameters = 601,
 
         /// <summary>
         /// Your request did not validate because of missing parameters.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         MissingParameters = 602,
 
         /// <summary>
         /// The provided credentials are invalid.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         InvalidCredentials = 611,
 
         /// <summary>
         /// The account does not exist.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         UnknownAccount = 612,
 
         /// <summary>
         /// The account cannot be registered as it exists already.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         ExistingAccount = 613,
 
         /// <summary>
         /// The path is invalid or current user has no access.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         AccessDenied = 614,
 
         /// <summary>
         /// The refresh token is expired.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         ExpiredRefreshToken = 615,
 
         /// <summary>
         /// The server is not authoritative for this URL.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         InvalidHost = 616,
 
         /// <summary>
         /// The permission offer is expired.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         ExpiredPermissionOffer = 701,
 
         /// <summary>
         /// The token used on the permission request does match more than a single permission offer.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         AmbiguousPermissionOfferToken = 702,
 
         /// <summary>
         /// The Realm file at the specified path is not available for shared access.
         /// </summary>
+        [Obsolete("This error can no longer happen")]
         FileMayNotBeShared = 703,
     }
 }