Repository Quality: Extension UID Stability and Naming Governance #9757

🎯 Repository Quality Improvement Report — Extension UID Stability and Naming Governance

Analysis Date: 2026-07-08
Focus Area: Extension UID Stability and Naming Governance
Strategy Type: Custom

Executive Summary

Every MTP extension and internal platform service implements IExtension.Uid, which is SHA-256-hashed for AppInsights telemetry, displayed verbatim in --info output and error messages, embedded in artifact metadata, and used in feature-detection tests. Renaming the implementing class automatically and silently changes the Uid.

Analysis found 47 IExtension.Uid property definitions and 13 CommandLineOptionsProviderBase UID constructor arguments — ~60 total — that resolve their value via nameof(ClassName). The IExtension.Uid interface doc mentions uniqueness but not stability. Contrast this with the GUID-based auto-registration system, where the MSBuild .props files carry a block-caps warning: "DO NOT CHANGE THE GUID, IT'S A WELL KNOWN EXTENSION POINT." One concrete defect surfaces immediately: MSBuildCommandLineProvider passes nameof(MSBuildCommandLineProvider) as its displayName argument, so --info exposes the internal class name to end users.

🤖 Suggested Improvement Tasks

Task 1: Document UID stability requirement in IExtension

Priority: High | Effort: Small

Update IExtension.Uid XML doc in src/Platform/Microsoft.Testing.Platform/Extensions/IExtension.cs to state that the value must be a stable string constant that survives class renames, and must not use nameof(ImplementingClass).

Task 2: Fix MSBuildCommandLineProvider DisplayName

Priority: High | Effort: Small

src/Platform/Microsoft.Testing.Extensions.MSBuild/MSBuildCommandLineProvider.cs passes nameof(MSBuildCommandLineProvider) (line 20) as both the uid and displayName arguments. Replace the displayName argument with a user-readable string (e.g., move to Resources/ExtensionResources.resx as MSBuildCommandLineProviderDisplayName = "MSBuild Integration").

Task 3: Replace nameof() UIDs in command-line providers with stable string constants

Priority: Medium | Effort: Large

Introduce a stable const string UID per provider (or a shared WellKnownProviderUids file). Priority: the 13 providers whose UIDs appear in --info output and error messages, including PlatformCommandLineProvider, TerminalTestReporterCommandLineOptionsProvider, CrashDumpCommandLineProvider, HangDumpCommandLineProvider, RetryCommandLineOptionsProvider, all 4 report-format command lines, AzureDevOpsCommandLineProvider, GitHubActionsCommandLineProvider, VideoRecorderCommandLineProvider, MSBuildCommandLineProvider.

Task 4: Fix NopPlatformOutputDeviceTests UID assertion

Priority: Medium | Effort: Small

test/UnitTests/Microsoft.Testing.Platform.UnitTests/OutputDevice/NopPlatformOutputDeviceTests.cs:27: change Assert.AreEqual(nameof(NopPlatformOutputDevice), device.Uid) to assert the stable string literal directly (e.g., Assert.AreEqual("NopPlatformOutputDevice", device.Uid)) so a class rename causes the test to fail rather than silently update.

Task 5: Add a UID snapshot test to catch silent renames

Priority: Medium | Effort: Medium

Extend the --info acceptance tests in test/IntegrationTests/Microsoft.Testing.Platform.Acceptance.IntegrationTests/HelpInfoTests.cs to also assert known provider UIDs alongside the existing display-name assertions. Any UID change — intentional or accidental — produces a conspicuous test failure rather than a silent telemetry break.

📊 Historical Context

Next analysis: 2026-07-09 — Focus area selected based on diversity algorithm

🤖 Automated content by GitHub Copilot. Generated by the Repository Quality Improver workflow. · 186.5 AIC · ⌖ 10.2 AIC · ⊞ 10.2K · [◷]( · ◷)

gh aw add githubnext/agentics/workflows/repository-quality-improver.md@main

• expires on Jul 10, 2026, 10:45 PM UTC