Retry on ratelimited error.

Author: CXuesong

WikiClientLibrary/Client/MediaWikiJsonResponseParser.cs

@@ -158,6 +158,9 @@ protected virtual void OnApiError(string? errorCode, string? errorMessage,
                 context.NeedRetry = true;
                 throw new ServerLagException(errorCode, fullMessage, (double?)errorNode["lag"] ?? 0, (string)errorNode["type"],
                     (string)errorNode["host"]);
+            case "ratelimited":
+                context.NeedRetry = true;
+                throw new RateLimitedException(errorCode, fullMessage);
             case "permissiondenied":
             case "readapidenied": // You need read permission to use this module.
             case "mustbeloggedin": // You must be logged in to upload this file.

WikiClientLibrary/Exceptions.cs

@@ -81,8 +81,8 @@ public OperationFailedException(string? message, Exception? inner)
 public class BadValueException : OperationFailedException
 {
 
-    public BadValueException(string errorCode, string message)
-        : base(errorCode, message)
+    public BadValueException(string errorCode, string? errorMessage)
+        : base(errorCode, errorMessage)
     {
     }
 
@@ -95,8 +95,8 @@ public BadValueException(string errorCode, string message)
 public class InvalidActionException : BadValueException
 {
 
-    public InvalidActionException(string errorCode, string message)
-        : base(errorCode, message)
+    public InvalidActionException(string errorCode, string? errorMessage)
+        : base(errorCode, errorMessage)
     {
     }
 
@@ -113,8 +113,8 @@ public InvalidActionException(string errorCode, string message)
 public class AccountAssertionFailureException : OperationFailedException
 {
 
-    public AccountAssertionFailureException(string errorCode, string message)
-        : base(errorCode, message)
+    public AccountAssertionFailureException(string errorCode, string? errorMessage)
+        : base(errorCode, errorMessage)
     {
     }
 
@@ -195,8 +195,8 @@ public override string ToString()
 public class OperationConflictException : OperationFailedException
 {
 
-    public OperationConflictException(string errorCode, string message)
-        : base(errorCode, message)
+    public OperationConflictException(string errorCode, string? errorMessage)
+        : base(errorCode, errorMessage)
     {
     }
 
@@ -209,8 +209,8 @@ public OperationConflictException(string errorCode, string message)
 public class BadTokenException : OperationFailedException
 {
 
-    public BadTokenException(string errorCode, string message)
-        : base(errorCode, message)
+    public BadTokenException(string errorCode, string? errorMessage)
+        : base(errorCode, errorMessage)
     {
     }
 
@@ -265,15 +265,15 @@ public override string ToString()
 }
 
 /// <summary>
-/// Raises when MediaWiki server replication lag
-/// does not meet the required limitation.
-/// (<a href="https://www.mediawiki.org/wiki/Manual:Maxlag_parameter">mw:Manual:Maxlag parameter</a>)
+/// Raised when MediaWiki server replication lag
+/// does not meet the required limitation. (<c>maxlag</c>)
+/// See <a href="https://www.mediawiki.org/wiki/Manual:Maxlag_parameter">mw:Manual:Maxlag parameter</a>.
 /// </summary>
 public class ServerLagException : OperationFailedException
 {
 
-    public ServerLagException(string errorCode, string message, double lag, string lagType, string laggedHost)
-        : base(errorCode, message)
+    public ServerLagException(string errorCode, string? errorMessage, double lag, string lagType, string laggedHost)
+        : base(errorCode, errorMessage)
     {
         Lag = lag;
         LaggedHost = laggedHost;
@@ -300,21 +300,35 @@ public ServerLagException(string errorCode, string message, double lag, string l
 
 }
 
+/// <summary>
+/// Raised by MediaWiki server when the API operation is too frequent. (<c>ratelimited</c>).
+/// </summary>
+public class RateLimitedException : OperationFailedException
+{
+
+    public RateLimitedException(string errorCode, string? errorMessage)
+        : base(errorCode, errorMessage)
+    {
+    }
+
+
+}
+
 /// <summary>
 /// Raises when the MediaWiki server is in read-only mode.
 /// </summary>
 public class MediaWikiReadOnlyException : OperationFailedException
 {
 
-    internal static string? BuildExceptionMessage(string errorCode, string errorMessage, string? readOnlyReason)
+    internal static string? BuildExceptionMessage(string errorCode, string? errorMessage, string? readOnlyReason)
     {
         errorMessage ??= "";
         if (!string.IsNullOrEmpty(readOnlyReason) && !errorMessage.Contains(readOnlyReason, StringComparison.Ordinal))
             errorMessage += " " + readOnlyReason;
         return BuildExceptionMessage(errorCode, errorMessage);
     }
 
-    public MediaWikiReadOnlyException(string errorCode, string errorMessage, string? readOnlyReason)
+    public MediaWikiReadOnlyException(string errorCode, string? errorMessage, string? readOnlyReason)
         : base(errorCode, errorMessage, BuildExceptionMessage(errorCode, errorMessage, readOnlyReason))
     {
         ReadOnlyReason = readOnlyReason;

WikiClientLibrary/Infrastructures/Throttler.cs

@@ -45,8 +45,8 @@ async Task<IDisposable> RunWorkAsync(WorkItem? previousWork, WorkItem thisWork,
                     if (ct.CanBeCanceled)
                     {
                         // With cancellation support.
-                        var tcs = new TaskCompletionSource<bool>();
-                        using (ct.Register(o => ((TaskCompletionSource<bool>)o!).SetCanceled(), tcs))
+                        var tcs = new TaskCompletionSource();
+                        using (ct.Register(o => ((TaskCompletionSource)o!).SetCanceled(), tcs))
                         {
                             await Task.WhenAny(previousWork.Completion, tcs.Task);
                         }
@@ -122,7 +122,7 @@ public Task Completion
     private class WorkItem : IDisposable
     {
 
-        private readonly TaskCompletionSource<bool> completionTcs = new TaskCompletionSource<bool>();
+        private readonly TaskCompletionSource completionTcs = new();
 
         public WorkItem(string name)
         {
@@ -138,7 +138,7 @@ public WorkItem(string name)
         /// </summary>
         public void Dispose()
         {
-            completionTcs.TrySetResult(true);
+            completionTcs.TrySetResult();
         }
 
         public override string ToString()