microsoft / microsoft/microsoft-performance-toolkit-sdk
Plugin metadata versioning
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 239
- Forks
- 78
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 2
Description
Currently the plugins system has these four DTO types: PluginMetadata, PluginContentsMetadata, AvailablePluginInfo and InstalledPluginInfo. They are used as both the contract for serialization/deserialization and the types that are passed around across systems (SDK clients and plugin feed server). These two functionalities should be decoupled into separate classes and only the types used for serialization/deserialization should be versioned.
For the versioning/upgrading pattern, we can consider refactoring the one used in PrebuiltConfigurations into a generic one.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the four DTO types—PluginMetadata, PluginContentsMetadata, AvailablePluginInfo, and InstalledPluginInfo—and the versioning pattern in src/Microsoft.Performance.SDK.Runtime/DTO/PreV1/PrebuiltConfigurations.cs. Define the separation between serialization contracts and cross-system types, then establish a generic versioning and upgrade pattern for the serialization types. Done means the responsibilities are decoupled and only serialization/deserialization types are versioned.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- devtools
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100