[file-diet] Refactor AzureDevOpsSummaryReporter.Lifecycle.cs (537 lines) into focused files

Đang mở
  • Có gì không ổn?
#12,232 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp
Lĩnh vực
backend

Hướng nghiên cứu

Read AzureDevOpsSummaryReporter.Lifecycle.cs and the behavior-preserving-refactor skill at .github/skills/behavior-preserving-refactor/SKILL.md; inspect the existing AzureDevOpsSummaryReporter.*.cs partials and relevant tests. Move coherent method groups unchanged into focused partial files, checking project includes and consumers. Run focused builds and tests for affected consumers and compare behavior, including duplicate and malformed inputs; finish with each new file under 300 lines or report the remaining size and blocker.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

type/automation type/tech-debt
Overview

The file src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/AzureDevOpsSummaryReporter.Lifecycle.cs has grown to 537 lines, making it harder to navigate and maintain. This task involves refactoring it into smaller, more focused files.

Current State
  • File: src/Platform/Microsoft.Testing.Extensions.AzureDevOpsReport/AzureDevOpsSummaryReporter.Lifecycle.cs
  • Size: 537 lines
  • Language: C#
Structural Analysis

The file is a partial-class slice of internal sealed partial class AzureDevOpsSummaryReporter. From a bounded sample it contains:

  • OnTestSessionStartingAsync (~line 19): resets state and emits the "requires TF_BUILD" warning.
  • ConsumeAsync (~line 62): consumes TestNodeUpdateMessage, collects timing/dependency metadata, and records rows.
  • OnTestSessionFinishingAsync (~line 179): finalization and summary emission (~190 lines).
  • ClearFlakyRows (~line 366) and trailing helpers for flaky-row/record handling.

Other AzureDevOpsSummaryReporter.*.cs partials (Markdown.*) already exist; this file is the largest remaining slice.

Refactoring Strategy
Proposed File Splits

Based on the bounded structural sample, investigate these provisional splits. Confirm their safety during implementation preflight before moving code:

  1. AzureDevOpsSummaryReporter.Lifecycle.cs (kept)

    • Contents: OnTestSessionStartingAsync, OnTestSessionFinishingAsync
    • Responsibility: session start/finish lifecycle

  2. AzureDevOpsSummaryReporter.Consume.cs

    • Contents: ConsumeAsync and its local helpers (timing/dependency collection)
    • Responsibility: ingesting test node updates into rows

  3. AzureDevOpsSummaryReporter.FlakyRows.cs (if needed)

    • Contents: ClearFlakyRows and related flaky/record bookkeeping helpers
    • Responsibility: flaky-row tracking and cleanup
Implementation Guidelines
  1. Establish Equivalence: Follow .github/skills/behavior-preserving-refactor/SKILL.md. Before editing, read the complete affected bodies, inventory baseline behavior and relevant tests, and identify distinguishing cases.
  2. Preserve Selection and Evaluation: Keep iteration order, short-circuit evaluation, exact type selection, first/last-match semantics, defaults, exceptions, and side effects. Cover reachable duplicate and malformed inputs; similar-looking helpers are not automatically interchangeable.
  3. Trace All Consumers: Check partial declarations, source-linked consumers, owning/consuming project includes, target-framework guards, and tracked public/internal API surfaces. Keep names, accessibility, attributes, and native interop contracts unchanged.
  4. Move Before Modernizing: Move bodies unchanged first, one coherent responsibility at a time. Preserve allocation and performance behavior on hot paths; do not mix adjacent modernization or bug fixes into the split.
  5. Use Focused Checks: Run the smallest affected project/TFM builds and relevant tests before and after each coherent split. Add distinguishing equivalence cases where coverage is missing; a pure file move does not require the full solution. Report exact checks and outcomes, including unavailable checks.
  6. Surface Constraints: Measure resulting line counts. If a safe structural split cannot meet the size goal without changing semantics, report the remaining size and blocker rather than forcing behavior changes.
  7. New .cs files must be UTF-8 with BOM.
Acceptance Criteria
  • Original file is split into focused modules
  • Each new file is under 300 lines, or a concrete behavior-preservation blocker and remaining size are reported
  • Baseline semantics, including reachable duplicate/malformed cases and evaluation order, are preserved by focused equivalence checks
  • Relevant builds and tests pass for affected consumers/TFMs; exact checks and any validation gaps are reported
  • Public and tracked internal API contracts, attributes, and conditional compilation are preserved
  • Project includes, source links, and package layout still include the moved code for every affected consumer

Priority: Medium
Effort: Small
Expected Impact: Improved code navigability, easier testing, reduced merge conflicts

🤖 Automated content by GitHub Copilot. Generated by the Daily File Diet workflow. · copilot · auto · ~25 AIC · ⌖ ~1 AIC · ⊞ 7.4K · ◷

  • expires on Nov 7, 2026, 6:53 PM UTC
Ngôn ngữ chính
C#
Star
1.1k
Fork
312
Merge trung bình
10 giờ 39 phút
Pull request đã merge (30 ngày)
349

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/testfx

Tất cả issue của microsoft/testfx

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.