microsoft / microsoft/microsoft-performance-toolkit-sdk

Remove IApplicationEnvironment (v1 and v2) and just use abstract class in the SDK

Open
#366 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C#
Stars
239
Forks
78
Avg merge
4d 3h
Merged PRs (30d)
2

Description

Because the SDK targets netstandard2.0, we cannot make use of default interface implementations of methods. This causes headaches when we want to add new functionality to the application environment, because adding a member to the interface is a major breaking change.

If we get rid of the interfaces and just use the abstract class, we can use virtual members to add new features while maintaining backwards compatibility.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the IApplicationEnvironment v1 and v2 definitions, their abstract-class counterparts, and all SDK references to them. Inventory implementations and consumers before deciding the migration scope. Done means the interfaces are removed and the abstract class supports future additions without the stated breaking-change problem.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.