Add async MessagePack converter for method parameters#587
Draft
Copilot wants to merge 20 commits into
Draft
Conversation
1 task
Co-authored-by: Daniel-Svensson <3167509+Daniel-Svensson@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add MessagePack serialization as optional wire format
Add optional MessagePack wire format for AspNetCore hosting and HTTP domain clients
May 31, 2026
Member
|
/azp run |
Contributor
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Daniel-Svensson
requested changes
May 31, 2026
Member
Daniel-Svensson
left a comment
Daniel-Svensson
left a comment
There was a problem hiding this comment.
@copilot please address review comments
| } | ||
|
|
||
| using var stream = await response.Content.ReadAsStreamAsync().ConfigureAwait(false); | ||
| var envelope = (MessagePackResponseEnvelope)_serializer.DeserializeObject(stream, _typeShapeProvider.GetTypeShapeOrThrow(typeof(MessagePackResponseEnvelope))) |
Member
There was a problem hiding this comment.
Create Request and Response types for Query, Invoke and Submit Operations.
For queries you can create a derived generic QueryCompletedResult
- Try to use PolyType attributes to annotate the Request and Response types
- If PolyType attributes is not enough (such as for request where parameters of type IDictionary<string,object>) is passed then consider custom Converters https://aarnott.github.io/Nerdbank.MessagePack/docs/custom-converters.html might be needed for serializing requests and deserializing responsees (in client project)
- Any converter must support async operation and follow security recommendations
In Hosting.AspNetCore the converters must deserialize requests and serialize responses.
In the server consider creating a FaultResponse class.
|
|
||
| internal sealed class MessagePackRequestEnvelope | ||
| { | ||
| public Dictionary<string, byte[]?>? Parameters { get; set; } = new(StringComparer.Ordinal); |
Member
There was a problem hiding this comment.
change type to a new class "MethodParameters", and write a custom Converter for the type.
You should pass in DomainOperationEntry _operation to the MessagePackSerializers SerializationContext
Then the type should be serialized/deserialized as a map with keys set to parameter names ,
the actual data should be serialized by delegating to converter registered for the ParameterType of the corresponding "Parameters" on the DomainOperationEntry.
Co-authored-by: Daniel-Svensson <3167509+Daniel-Svensson@users.noreply.github.com>
Contributor
Author
Implemented the requested review updates in commit |
Co-authored-by: Daniel-Svensson <3167509+Daniel-Svensson@users.noreply.github.com>
Co-authored-by: Daniel-Svensson <3167509+Daniel-Svensson@users.noreply.github.com>
Copilot
AI
changed the title
Add optional MessagePack wire format for AspNetCore hosting and HTTP domain clients
Add async MessagePack converter for method parameters
May 31, 2026
* Parameter passing WORKS * DateTime passing don't throw (Need to investigate)
| var provider = ReflectionTypeShapeProvider.Default; | ||
| var responseType = typeof(MessagePackInvokeResponseEnvelope<>).MakeGenericType(resultType); | ||
| dynamic response = serializer.DeserializeObject(payload, provider.GetTypeShapeOrThrow(responseType)); | ||
| return (string)response.Result; |
| // If the name is new then should a separate property be added | ||
| // | ||
|
|
||
| string _name = (inner.AttributeProvider.GetCustomAttribute<IncludeAttribute>() is IncludeAttribute includeAttribute |
Comment on lines
+45
to
+49
| catch (System.Exception) | ||
| { | ||
| // Ignore throwing domain services | ||
| continue; | ||
| } |
…ks working. 365 tests are now passing (with submit not yet working) , 323 failing
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.
Review feedback called for
MethodParametersto use a custom Nerdbank.MessagePack converter that delegates each parameter to its declared type converter, carries operation metadata viaSerializationContext, and supports async serialization.Method parameter conversion
MethodParametersconverters on client and server.Async and security handling
DepthStep()and cancellation-aware async buffering/flush behavior.Wire schema and cleanup