feat: add implicit UI plugin companions#111
Merged
Merged
Conversation
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.
This pull request introduces a new generic companion plugin request/response channel between Quasar UI plugins and Magnetar plugins, formalizing how UI plugins can communicate with server-side Magnetar companions. It updates documentation to describe this new architecture and deployment flow, and adds new protocol types and interfaces. Additionally, it clarifies and improves the plugin build, deployment, and communication process, especially for UI-plugin-owned Magnetar companions.
Companion Plugin Communication Channel
IQuasarCompanionRequestHandlerinterface for Magnetar plugins to handle requests from Quasar UI plugins (Magnetar.Protocol/Bridge/IQuasarCompanionRequestHandler.cs).CompanionPluginRequestandCompanionPluginResponsetypes to carry JSON payloads and metadata for plugin communication (Magnetar.Protocol/Model/CompanionPluginRequest.cs,Magnetar.Protocol/Model/CompanionPluginResponse.cs). [1] [2]Documentation Updates for Plugin System and Build/Deployment
Docs/BuildingAndDevelopment.md,Docs/QuasarPluginSystem.md). [1] [2] [3] [4] [5]Docs/QuasarPluginSystem.md). [1] [2]Docs/QuasarPluginSystem.md).Docs/LinuxDeploymentAndUpdates.md,Docs/WindowsDeploymentAndUpdates.md). [1] [2]Agent and API Behavior
PluginRequestcommands for companion dispatch (Docs/StateMachines/AgentConnection.md).Entity Viewer and GridBackups Plugin Guidance
Docs/QuasarPluginSystem.md). [1] [2]Protocol Simplification
EntitySummaryDTO by removing the world matrix fields, as the protocol assembly no longer needs to support future renderer requirements directly (Magnetar.Protocol/Model/EntitySummary.cs). [1] [2]