feat(beta): add diagnostic exporter and GitHub issue template for feedback loop

newcooll · newcooll · commit 79290252f237 · 2026-03-25T22:03:45.000+08:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,54 @@
+name: Bug Report
+description: 提交一个缺陷报告，帮助我们快速定位并修复问题
+title: "[Bug]: "
+labels:
+  - bug
+body:
+  - type: checkboxes
+    id: precheck
+    attributes:
+      label: 提交前确认
+      description: 请在提交前完成以下自检项
+      options:
+        - label: 我已复现该问题。
+          required: true
+        - label: 我已使用“一键导出诊断包”功能获取了 `.zip` 诊断文件。
+          required: true
+
+  - type: dropdown
+    id: module
+    attributes:
+      label: 发生问题的模块
+      description: 请选择问题发生的功能区域
+      options:
+        - WeChat
+        - QQ
+        - Chrome
+        - 系统清理
+        - UI界面
+        - 其他
+    validations:
+      required: true
+
+  - type: textarea
+    id: steps
+    attributes:
+      label: 复现步骤 (Steps to Reproduce)
+      description: 请按顺序描述操作步骤，便于稳定复现
+      placeholder: |
+        1. 打开 ...
+        2. 点击 ...
+        3. 观察到 ...
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "> ⚠️ 请务必将导出的诊断包 (.zip) 拖拽上传至下方区域，否则我们将无法排查您的问题！"
+
+  - type: textarea
+    id: additional
+    attributes:
+      label: 其他补充信息
+      description: 可附上截图、日志片段、系统版本等信息
+      placeholder: 可将截图拖拽到此处并填写补充说明
diff --git a/src/CDriveMaster.Core/Services/DiagnosticExporter.cs b/src/CDriveMaster.Core/Services/DiagnosticExporter.cs
@@ -0,0 +1,137 @@
+using System;
+using System.IO;
+using System.IO.Compression;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace CDriveMaster.Core.Services;
+
+public sealed class DiagnosticExporter
+{
+    private readonly Func<string> outputDirectoryProvider;
+    private readonly Func<string> appBaseDirectoryProvider;
+    private readonly Func<DateTime> nowProvider;
+
+    public DiagnosticExporter(
+        Func<string>? outputDirectoryProvider = null,
+        Func<string>? appBaseDirectoryProvider = null,
+        Func<DateTime>? nowProvider = null)
+    {
+        this.outputDirectoryProvider = outputDirectoryProvider
+            ?? (() => Environment.GetFolderPath(Environment.SpecialFolder.Desktop));
+        this.appBaseDirectoryProvider = appBaseDirectoryProvider
+            ?? (() => AppContext.BaseDirectory);
+        this.nowProvider = nowProvider ?? (() => DateTime.Now);
+    }
+
+    public async Task<string> ExportAsync()
+    {
+        string outputDirectory = outputDirectoryProvider();
+        Directory.CreateDirectory(outputDirectory);
+
+        string zipPath = Path.Combine(outputDirectory, $"CDriveMaster_Diag_{nowProvider():yyyyMMdd_HHmmss}.zip");
+
+        string tempPath = Path.GetTempFileName();
+        if (File.Exists(tempPath))
+        {
+            File.Delete(tempPath);
+        }
+
+        Directory.CreateDirectory(tempPath);
+
+        try
+        {
+            string sysInfoPath = Path.Combine(tempPath, "sysinfo.txt");
+            string sysInfo = string.Join(Environment.NewLine, new[]
+            {
+                $"Timestamp: {nowProvider():yyyy-MM-dd HH:mm:ss}",
+                $"OS Version: {Environment.OSVersion.VersionString}",
+                $"Is64BitOperatingSystem: {Environment.Is64BitOperatingSystem}",
+                $"IsElevated: {PlatformProbe.IsElevated}"
+            });
+            await File.WriteAllTextAsync(sysInfoPath, sysInfo);
+
+            string appBase = appBaseDirectoryProvider();
+            string logsPath = Path.Combine(appBase, "Logs");
+            if (Directory.Exists(logsPath))
+            {
+                string tempLogs = Path.Combine(tempPath, "Logs");
+                Directory.CreateDirectory(tempLogs);
+
+                var jsonFiles = Directory
+                    .EnumerateFiles(logsPath, "*.json", SearchOption.AllDirectories)
+                    .ToList();
+
+                foreach (var file in jsonFiles)
+                {
+                    try
+                    {
+                        string relativePath = Path.GetRelativePath(logsPath, file);
+                        string target = Path.Combine(tempLogs, relativePath);
+                        string? targetDir = Path.GetDirectoryName(target);
+                        if (!string.IsNullOrWhiteSpace(targetDir))
+                        {
+                            Directory.CreateDirectory(targetDir);
+                        }
+
+                        File.Copy(file, target, overwrite: true);
+                    }
+                    catch (IOException)
+                    {
+                        // Ignore a single locked/corrupted file and continue collecting diagnostics.
+                    }
+                    catch (UnauthorizedAccessException)
+                    {
+                        // Ignore a single inaccessible file and continue collecting diagnostics.
+                    }
+                }
+            }
+
+            string rulesPath = Path.Combine(appBase, "Rules");
+            if (Directory.Exists(rulesPath))
+            {
+                string tempRules = Path.Combine(tempPath, "Rules");
+                CopyDirectory(rulesPath, tempRules);
+            }
+
+            if (File.Exists(zipPath))
+            {
+                File.Delete(zipPath);
+            }
+
+            ZipFile.CreateFromDirectory(tempPath, zipPath);
+            return zipPath;
+        }
+        finally
+        {
+            try
+            {
+                if (Directory.Exists(tempPath))
+                {
+                    Directory.Delete(tempPath, recursive: true);
+                }
+            }
+            catch
+            {
+                // Best effort cleanup only.
+            }
+        }
+    }
+
+    private static void CopyDirectory(string sourceDir, string targetDir)
+    {
+        Directory.CreateDirectory(targetDir);
+
+        foreach (var file in Directory.EnumerateFiles(sourceDir))
+        {
+            string target = Path.Combine(targetDir, Path.GetFileName(file));
+            File.Copy(file, target, overwrite: true);
+        }
+
+        foreach (var dir in Directory.EnumerateDirectories(sourceDir))
+        {
+            string targetSubDir = Path.Combine(targetDir, Path.GetFileName(dir));
+            CopyDirectory(dir, targetSubDir);
+        }
+    }
+}
diff --git a/src/CDriveMaster.UI/App.xaml.cs b/src/CDriveMaster.UI/App.xaml.cs
@@ -27,6 +27,7 @@ private void ConfigureServices(IServiceCollection services)
 		services.AddTransient<BucketBuilder>();
 		services.AddTransient<RuleCatalog>();
 		services.AddSingleton<AuditLogExporter>();
+		services.AddSingleton<DiagnosticExporter>();
 		services.AddSingleton<IDialogService, MessageBoxDialogService>();
 		services.AddSingleton<IPreviewDialogService, WpfPreviewDialogService>();
 		services.AddSingleton<PreflightGuard>();
diff --git a/src/CDriveMaster.UI/MainWindow.xaml b/src/CDriveMaster.UI/MainWindow.xaml
@@ -71,11 +71,21 @@
                             BorderThickness="1" />
                     <Button Content="❓ 帮助文档"
                             Command="{Binding OpenHelpDocsCommand}"
+                            Margin="0,0,8,0"
                             FontSize="11"
                             Padding="8,2"
                             Background="Transparent"
                             BorderBrush="#FFC8D0D8"
                             BorderThickness="1" />
+                        <Button Content="📦 导出诊断包"
+                            Command="{Binding ExportDiagnosticsCommand}"
+                            FontSize="11"
+                            FontWeight="SemiBold"
+                            Padding="10,2"
+                            Background="#FFE8F4FF"
+                            Foreground="#FF0E4A7A"
+                            BorderBrush="#FF8AB8DD"
+                            BorderThickness="1" />
                 </StackPanel>
             </Grid>
         </Border>
diff --git a/src/CDriveMaster.UI/ViewModels/MainViewModel.cs b/src/CDriveMaster.UI/ViewModels/MainViewModel.cs
@@ -1,26 +1,37 @@
 using CommunityToolkit.Mvvm.ComponentModel;
 using CommunityToolkit.Mvvm.Input;
+using CDriveMaster.Core.Services;
+using CDriveMaster.UI.Services;
 using System;
 using System.Diagnostics;
 using System.IO;
 using System.Reflection;
+using System.Threading.Tasks;
 
 namespace CDriveMaster.UI.ViewModels;
 
 public partial class MainViewModel : ObservableObject
 {
     private readonly SystemMaintenanceAnalysisViewModel systemMaintenanceViewModel;
     private readonly GenericCleanupViewModel genericCleanupViewModel;
+    private readonly DiagnosticExporter diagExporter;
+    private readonly IDialogService dialogService;
 
     [ObservableProperty]
     private object currentViewModel;
 
     public string AppVersion { get; }
 
-    public MainViewModel(SystemMaintenanceAnalysisViewModel systemMaintenanceViewModel, GenericCleanupViewModel genericCleanupViewModel)
+    public MainViewModel(
+        SystemMaintenanceAnalysisViewModel systemMaintenanceViewModel,
+        GenericCleanupViewModel genericCleanupViewModel,
+        DiagnosticExporter diagExporter,
+        IDialogService dialogService)
     {
         this.systemMaintenanceViewModel = systemMaintenanceViewModel;
         this.genericCleanupViewModel = genericCleanupViewModel;
+        this.diagExporter = diagExporter;
+        this.dialogService = dialogService;
 
         var informationalVersion = Assembly.GetExecutingAssembly()
             .GetCustomAttribute<AssemblyInformationalVersionAttribute>()
@@ -32,6 +43,29 @@ public MainViewModel(SystemMaintenanceAnalysisViewModel systemMaintenanceViewMod
         CurrentViewModel = this.systemMaintenanceViewModel;
     }
 
+    [RelayCommand]
+    private async Task ExportDiagnosticsAsync()
+    {
+        try
+        {
+            string zipPath = await diagExporter.ExportAsync();
+            await dialogService.ShowInfoAsync(
+                "导出成功",
+                $"诊断包已保存至桌面：{Environment.NewLine}{zipPath}{Environment.NewLine}{Environment.NewLine}请在提交反馈时附带此文件。");
+
+            Process.Start(new ProcessStartInfo
+            {
+                FileName = "explorer.exe",
+                Arguments = $"/select,\"{zipPath}\"",
+                UseShellExecute = true
+            });
+        }
+        catch (Exception ex)
+        {
+            await dialogService.ShowErrorAsync("导出失败", ex.Message);
+        }
+    }
+
     [RelayCommand]
     private void NavigateToSystemMaintenance()
     {
diff --git a/tests/CDriveMaster.Tests/Services/DiagnosticExporterTests.cs b/tests/CDriveMaster.Tests/Services/DiagnosticExporterTests.cs
@@ -0,0 +1,72 @@
+using System;
+using System.IO;
+using System.IO.Compression;
+using System.Linq;
+using System.Threading.Tasks;
+using CDriveMaster.Core.Services;
+using CDriveMaster.Tests.Helpers;
+using FluentAssertions;
+using Xunit;
+
+namespace CDriveMaster.Tests.Services;
+
+public sealed class DiagnosticExporterTests
+{
+    [Fact]
+    public async Task ExportAsync_WithLogsAndRules_ShouldCreateZipWithExpectedEntries()
+    {
+        using var outputSandbox = new TempSandbox("diag-output");
+        using var appBaseSandbox = new TempSandbox("diag-appbase");
+
+        _ = appBaseSandbox.CreateFile(Path.Combine("Logs", "cleanup.json"), "{\"ok\":true}");
+        _ = appBaseSandbox.CreateFile(Path.Combine("Logs", "nested", "audit.json"), "{\"nested\":true}");
+        _ = appBaseSandbox.CreateFile(Path.Combine("Rules", "wechat.json"), "{\"app\":\"wechat\"}");
+
+        var fixedNow = new DateTime(2026, 03, 25, 10, 20, 30);
+        var exporter = new DiagnosticExporter(
+            outputDirectoryProvider: () => outputSandbox.RootPath,
+            appBaseDirectoryProvider: () => appBaseSandbox.RootPath,
+            nowProvider: () => fixedNow);
+
+        string zipPath = await exporter.ExportAsync();
+
+        zipPath.Should().StartWith(outputSandbox.RootPath);
+        File.Exists(zipPath).Should().BeTrue();
+
+        using var archive = ZipFile.OpenRead(zipPath);
+        archive.Entries.Select(e => e.FullName).Should().Contain("sysinfo.txt");
+        archive.Entries.Select(e => e.FullName).Should().Contain("Logs/cleanup.json");
+        archive.Entries.Select(e => e.FullName).Should().Contain("Logs/nested/audit.json");
+        archive.Entries.Select(e => e.FullName).Should().Contain("Rules/wechat.json");
+
+        var sysInfoEntry = archive.GetEntry("sysinfo.txt");
+        sysInfoEntry.Should().NotBeNull();
+        using var reader = new StreamReader(sysInfoEntry!.Open());
+        string sysInfo = await reader.ReadToEndAsync();
+        sysInfo.Should().Contain("Timestamp: 2026-03-25 10:20:30");
+        sysInfo.Should().Contain("OS Version:");
+        sysInfo.Should().Contain("Is64BitOperatingSystem:");
+        sysInfo.Should().Contain("IsElevated:");
+    }
+
+    [Fact]
+    public async Task ExportAsync_WithoutLogsAndRules_ShouldStillCreateZipWithSysInfo()
+    {
+        using var outputSandbox = new TempSandbox("diag-output-empty");
+        using var appBaseSandbox = new TempSandbox("diag-appbase-empty");
+
+        var exporter = new DiagnosticExporter(
+            outputDirectoryProvider: () => outputSandbox.RootPath,
+            appBaseDirectoryProvider: () => appBaseSandbox.RootPath,
+            nowProvider: () => DateTime.UtcNow.AddTicks(Guid.NewGuid().GetHashCode()));
+
+        string zipPath = await exporter.ExportAsync();
+
+        File.Exists(zipPath).Should().BeTrue();
+
+        using var archive = ZipFile.OpenRead(zipPath);
+        archive.Entries.Select(e => e.FullName).Should().Contain("sysinfo.txt");
+        archive.Entries.Select(e => e.FullName).Should().NotContain(e => e.StartsWith("Logs/"));
+        archive.Entries.Select(e => e.FullName).Should().NotContain(e => e.StartsWith("Rules/"));
+    }
+}
