SVRB: Distinguish "automatic retry" from "manual retry" errors

- Java: This distinction is already made, just reworded

- Node: We include "protocol errors" in IoError here, where retrying
  probably won't help, but it won't really be harmful either.

- Swift: Automatically retryable errors are now enumerated; other
  errors are still described as "manually retryable". (Also, fixed a
  redundant error message format call.)

Author: jrose-signal

java/client/src/main/java/org/signal/libsignal/net/SvrB.kt

@@ -117,7 +117,7 @@ public class SvrB internal constructor(
    * - [Result.failure] containing [RetryLaterException] if the server is rate limiting this client.
    *   This is **retryable** after waiting the designated delay.
    * - [Result.failure] containing [NetworkException] if the network operation fails (connection,
-   *   service, or timeout errors). These are **retryable**.
+   *   service, or timeout errors). These can be **automatically retried** (backoff recommended).
    * - [Result.failure] containing [NetworkProtocolException] if there is a protocol error. This
    *   indicates a possible bug in libsignal or in the enclave.
    * - [Result.failure] containing
@@ -191,7 +191,7 @@ public class SvrB internal constructor(
    * - [Result.failure] containing [RetryLaterException] if the server is rate limiting this client.
    *   This is **retryable** after waiting the designated delay.
    * - [Result.failure] containing [NetworkException] if the network operation fails (connection,
-   *   service, or timeout errors). These are **retryable**.
+   *   service, or timeout errors). These can be **automatically retried** (backoff recommended).
    * - [Result.failure] containing [NetworkProtocolException] if there is a protocol error. This
    *   indicates a possible bug in libsignal or in the enclave.
    * - [Result.failure] containing
@@ -249,7 +249,7 @@ public class SvrB internal constructor(
    * - [Result.failure] containing [RetryLaterException] if the server is rate limiting this client.
    *   This is **retryable** after waiting the designated delay.
    * - [Result.failure] containing [NetworkException] if the network operation fails (connection,
-   *   service, or timeout errors). These are **retryable**.
+   *   service, or timeout errors). These can be **automatically retried** (backoff recommended).
    * - [Result.failure] containing [NetworkProtocolException] if there is a protocol error. This
    *   indicates a possible bug in libsignal or in the enclave.
    * - [Result.failure] containing

node/ts/net/SvrB.ts

@@ -228,7 +228,8 @@ export class SvrB {
    * @throws {RateLimitedError} if the server is rate limiting this client. This is **retryable**
    * after waiting the designated delay.
    * @throws {IoError} if the network operation fails (connection, service, or timeout errors).
-   * These are **retryable**, but some may indicate a possible bug in libsignal or in the enclave.
+   * These can be **automatically retried** (backoff recommended), but some may indicate a possible
+   * bug in libsignal or in the enclave.
    * @throws {SvrAttestationError} if enclave attestation fails. This indicates a possible bug in
    * libsignal or in the enclave.
    */
@@ -281,7 +282,8 @@ export class SvrB {
    * @throws {RateLimitedError} if the server is rate limiting this client. This is **retryable**
    * after waiting the designated delay.
    * @throws {IoError} if the network operation fails (connection, service, or timeout errors).
-   * These are **retryable**, but some may indicate a possible bug in libsignal or in the enclave.
+   * These can be **automatically retried** (backoff recommended), but some may indicate a possible
+   * bug in libsignal or in the enclave.
    * @throws {SvrAttestationError} if enclave attestation fails. This indicates a possible bug in
    * libsignal or in the enclave.
    */
@@ -309,9 +311,9 @@ export class SvrB {
   /**
    * Attempts to remove the info stored with SVR-B for this particular username/password pair.
    *
-   * This is a best-effort operation; a successful return means the data has been removed from
-   * (or never was present in) the current SVR-B enclaves, but may still be present in previous
-   * ones that have yet to be decommissioned. Conversely, a thrown error may still have removed
+   * This is a best-effort operation; a successful return means the data has been removed from (or
+   * never was present in) the current SVR-B enclaves, but may still be present in previous ones
+   * that have yet to be decommissioned. Conversely, a thrown error may still have removed
    * information from previous enclaves.
    *
    * This should not typically be needed; rather than explicitly removing an entry, the client
@@ -322,7 +324,8 @@ export class SvrB {
    * @throws {RateLimitedError} if the server is rate limiting this client. This is **retryable**
    * after waiting the designated delay.
    * @throws {IoError} if the network operation fails (connection, service, or timeout errors).
-   * These are **retryable**, but some may indicate a possible bug in libsignal or in the enclave.
+   * These can be **automatically retried** (backoff recommended), but some may indicate a possible
+   * bug in libsignal or in the enclave.
    * @throws {SvrAttestationError} if enclave attestation fails. This indicates a possible bug in
    * libsignal or in the enclave.
    */

rust/bridge/shared/types/src/ffi/error.rs

@@ -974,7 +974,7 @@ impl FfiError for libsignal_net::svrb::Error {
             }
             Self::Connect(e) => match e {
                 WebSocketConnectError::Transport(e) => format!("IO error: {e}").into(),
-                WebSocketConnectError::WebSocketError(_) => format!("WebSocket error: {e}").into(),
+                WebSocketConnectError::WebSocketError(e) => format!("WebSocket error: {e}").into(),
             },
             Self::RateLimited(inner) => inner.describe(),
             Self::Service(e) => format!("WebSocket error: {e}").into(),

swift/Sources/LibSignalClient/SecureValueRecoveryBackup.swift

@@ -119,8 +119,12 @@ public class SvrB {
     ///     choice here but to **start a new chain**.
     ///   - ``SignalError/rateLimitedError(retryAfter:message:)`` if the server is rate limiting
     ///     this client. This is **retryable** after waiting the designated delay.
-    ///   - Other ``SignalError``s for networking and attestation issues. These are **retryable**,
-    ///     but some may indicate a possible bug in libsignal or in the enclave.
+    ///   - ``SignalError/connectionFailed(_:)``, ``SignalError/ioError(_:)``, or
+    ///     ``SignalError/webSocketError(_:)`` for networking failures before and during
+    ///     communication with the server. These can be **automatically retried** (backoff
+    ///     recommended).
+    ///   - Other ``SignalError``s for networking and attestation issues. These can be manually
+    ///     retried, but some may indicate a possible bug in libsignal or in the enclave.
     public func store(
         backupKey: BackupKey,
         previousSecretData: Data
@@ -174,8 +178,12 @@ public class SvrB {
     ///     recoverable).
     ///   - ``SignalError/rateLimitedError(retryAfter:message:)`` if the server is rate limiting
     ///     this client. This is **retryable** after waiting the designated delay.
-    ///   - Other ``SignalError``s for networking and attestation issues. These are **retryable**,
-    ///     but some may indicate a possible bug in libsignal or in the enclave.
+    ///   - ``SignalError/connectionFailed(_:)``, ``SignalError/ioError(_:)``, or
+    ///     ``SignalError/webSocketError(_:)`` for networking failures before and during
+    ///     communication with the server. These can be **automatically retried** (backoff
+    ///     recommended).
+    ///   - Other ``SignalError``s for networking and attestation issues. These can be manually
+    ///     retried, but some may indicate a possible bug in libsignal or in the enclave.
     public func restore(
         backupKey: BackupKey,
         metadata: Data
@@ -216,8 +224,12 @@ public class SvrB {
     /// - Throws:
     ///   - ``SignalError/rateLimitedError(retryAfter:message:)`` if the server is rate limiting
     ///     this client. This is **retryable** after waiting the designated delay.
-    ///   - Other ``SignalError``s for networking and attestation issues. These are **retryable**,
-    ///     but some may indicate a possible bug in libsignal or in the enclave.
+    ///   - ``SignalError/connectionFailed(_:)``, ``SignalError/ioError(_:)``, or
+    ///     ``SignalError/webSocketError(_:)`` for networking failures before and during
+    ///     communication with the server. These can be **automatically retried** (backoff
+    ///     recommended).
+    ///   - Other ``SignalError``s for networking and attestation issues. These can be manually
+    ///     retried, but some may indicate a possible bug in libsignal or in the enclave.
     public func remove() async throws {
         let _: Bool = try await self.net.asyncContext.invokeAsyncFunction {
             promise,