Repository navigation
Classify synchronization failures and carry the server's reason to the client - #21
Merged
Merged
Conversation
…e client SyncAgent.SynchronizeAsync still wraps every failure in a SynchronizationException with the same message and inner exception, but now also reports Kind (Network, Unauthorized, Cancelled, AnchorTooOld, SessionExpired, ServerUnavailable, DataError, ConfigurationError, ServerError), Stage, TableName, ErrorCode, TraceId and ServerMessage, mirrored into Exception.Data. CoreSync.Http.Client rebuilds a SyncHttpRequestException (an HttpRequestException) from the X-CoreSync-Error / X-CoreSync-Trace headers and the SyncErrorDetails body a server emits, infers a coarse classification from the status code when it emits neither, and stops retrying bulk downloads only for failures the server marked as permanent. CoreSync.Http.Server answers an expired upload/download session with 410 + session-expired instead of an unhandled InvalidOperationException, and tags unexpected failures with the error code and trace headers while leaving the host's own exception handling untouched.
…nse handling - SyncAgent no longer reports every plain HttpRequestException as Network: an older CoreSync.Http.Client throws that type from EnsureSuccessStatusCode for a 401/404/500 too, so the kind is Network only when the exception carries no status (read through reflection, since .NET Standard 2.0 has no HttpRequestException.StatusCode) and Unknown when it does or when the runtime cannot tell. - UnauthorizedAccessException maps to Unauthorized only on remote stages; a local store raising it for a read-only database file stays Unknown. - New agent-error code (not permanent, kind ServerError) for a data store agent that answered a request with a failure. - The HTTP client disposes every response it reads and asks for headers first where it used to rely on GetFromJsonAsync; the server registers its OnStarting headers only while the response has not started and documents that a bare Kestrel 500 carries none.
3.1.7 is affected by GHSA-qhrr-8q5h-9q3h (nested arrays can exceed buffer length limits), fixed in 3.1.9. The NuGet audit fails restore on it with warnings as errors. Patch release: the serialization format is unchanged.
CS0419: HttpResponse.OnStarting has two overloads, and the Release build treats the warning as an error.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sync failures used to reach apps as a single opaque
SynchronizationException, so every app showed "check your internet connection" whether the device was offline, the server was down, or a table was missing on the server. This PR classifies the failure and carries the server's reason to the client. All changes are additive.What changes
SynchronizationExceptiongainsKind(SyncFailureKind),Stage,ErrorCode,TableName,TraceIdandServerMessage, mirrored intoException.Data["CoreSync.*"]. The message andInnerExceptionare unchanged.Kind = DataErrorand the table name. Behaviour is otherwise the same.SyncErrorDetailsbody, error codes (session-expired,endpoint-not-found,agent-unavailable,agent-error,configuration-error,data-error,server-error) and theX-CoreSync-Traceheader.SyncHttpRequestException(still anHttpRequestException) is built from the error headers and body. Against servers that send neither, the client falls back to the status code. Retries stop only on failures the server marks as permanent; unknown codes are retried.session-expiredinstead of an unhandled exception. Unexpected failures get the code and trace headers. The new optionsHandleUnexpectedExceptionsandIncludeExceptionDetailsdefault to off, so host exception handling is untouched.Compatibility
HttpRequestExceptionwithout a status isNetwork, one with a status isUnknown.Tests
210/210 on SQL Server, PostgreSQL, MySQL and SQLite: 178 existing plus 32 new in
SyncErrorClassificationTests.