Mitigation for mono/wasm/etc. explicit interface covariance issue#138
Merged
Mitigation for mono/wasm/etc. explicit interface covariance issue#138
Conversation
trrwilson
changed the title
joseharriaga
added a commit
that referenced
this pull request
Sep 3, 2024
…238) This is the same issue that we saw previously with `ChatMessage`'s serialization in unity/mono/etc. See: dotnet/runtime#103365 See: #138
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
1 participant
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.
See: dotnet/runtime#103365
The implication is that any of our types with an abstract base (e.g.
ChatMessage : IJsonModel<ChatMessage>) and derived instance types (e.g.SystemChatMessage : ChatMessage, IJsonModel<SystemChatMessage>) currently have the base explicit interface implementation invoked in impacted environments (e.g.IJsonModel<ChatMessage>.Write()).The mitigation approach:
protected abstract void WriteCore(Utf8JsonWriter, ModelReaderOptions)WriteCoreIJsonModel<T>.Write()to invokeWriteCore()for all (base+derived) affected types, ensuring that the instance type's serialization logic is used independently of the explicit interface covariance appliedThis change addresses the behavior of
Assistants.MessageContent,Assistants.ToolDefinition, andChat.ChatMessage. Several more abstract types exist in theAssistantsnamespace, but these are response models -- given moving code to the custom layer comes at the cost of maintainability, leaving direct manual MRW serialization of e.g.RunStepDetailsimpacted feels like the right initial tradeoff for a mitigation while the runtime fix is awaited.