|
| 1 | +// Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | +// Licensed under the MIT License. |
| 3 | + |
| 4 | +using System.Globalization; |
| 5 | +using System.Text; |
| 6 | +using CsvHelper; |
| 7 | +using CsvHelper.Configuration.Attributes; |
| 8 | +using Microsoft.Extensions.Logging; |
| 9 | +using Microsoft.NugetNinja.Core; |
| 10 | +using NuGet.Common; |
| 11 | +using NuGet.Configuration; |
| 12 | +using NuGet.Protocol.Core.Types; |
| 13 | +using NugetNinja.PackageListerPlugin.Models; |
| 14 | + |
| 15 | +namespace Microsoft.NugetNinja.PackageListerPlugin; |
| 16 | + |
| 17 | +public class PackageList : IAction |
| 18 | +{ |
| 19 | + |
| 20 | + private List<(string project, List<Package> packages)> _allPackages; |
| 21 | + private readonly ILogger<PackageListerDetector> _logger; |
| 22 | + |
| 23 | + public PackageList(List<(string, List<Package>)> allPackages1, Extensions.Logging.ILogger<PackageListerDetector> logger) |
| 24 | + { |
| 25 | + _allPackages = allPackages1; |
| 26 | + _logger = logger; |
| 27 | + } |
| 28 | + |
| 29 | + public string BuildMessage() |
| 30 | + { |
| 31 | + var sb = new StringBuilder(); |
| 32 | + foreach (var package in _allPackages) |
| 33 | + { |
| 34 | + sb.AppendLine($"Project: {package.project}\n"); |
| 35 | + foreach (var p in package.packages) |
| 36 | + { |
| 37 | + sb.AppendLine($" {p.Name} {p.Version}\n"); |
| 38 | + } |
| 39 | + } |
| 40 | + return sb.ToString(); |
| 41 | + } |
| 42 | + |
| 43 | + public async Task TakeActionAsync() |
| 44 | + { |
| 45 | + _logger.LogInformation($"Preparing summary file"); |
| 46 | + var flatList = _allPackages.SelectMany(p => p.packages.Select(package => (p.project, package))).ToList(); |
| 47 | + var byPackage = flatList.GroupBy(p => p.package.Name).ToList(); |
| 48 | + var allLines = new List<PackageListLine>(); |
| 49 | + foreach (var el in byPackage) |
| 50 | + { |
| 51 | + try |
| 52 | + { |
| 53 | + var description = SanitizeNugetDescription(await GetNugetDescriptionAsync(el.Key)); |
| 54 | + allLines.Add(new PackageListLine(el.Key, GetAllVersions(el), description, null, GetAllProjects(el))); |
| 55 | + } |
| 56 | + catch (Exception e) |
| 57 | + { |
| 58 | + _logger.LogError(e, $"Error processing package {el.Key}"); |
| 59 | + } |
| 60 | + } |
| 61 | + allLines = allLines.OrderBy(p => p.PackageId).ToList(); |
| 62 | + var outFile = "all_packages.csv"; |
| 63 | + _logger.LogInformation($"Writing package list to {Path.GetFullPath(outFile)}"); |
| 64 | + using (var writer = new StreamWriter("all_packages.csv")) |
| 65 | + using (var csv = new CsvWriter(writer, CultureInfo.InvariantCulture)) |
| 66 | + { |
| 67 | + csv.WriteRecords(allLines); |
| 68 | + } |
| 69 | + await Task.CompletedTask; |
| 70 | + } |
| 71 | + |
| 72 | + public async Task<string> GetNugetDescriptionAsync(string packageId) |
| 73 | + { |
| 74 | + _logger.LogInformation($"Getting description from nuget.org for {packageId}"); |
| 75 | + var providers = NuGet.Protocol.Core.Types.Repository.Provider.GetCoreV3(); |
| 76 | + var source = new PackageSource("https://api.nuget.org/v3/index.json"); |
| 77 | + var repository = new SourceRepository(source, providers); |
| 78 | + var resource = await repository.GetResourceAsync<PackageMetadataResource>(); |
| 79 | + var metadata = await resource.GetMetadataAsync(packageId, includePrerelease: false, includeUnlisted: false, new SourceCacheContext(), NullLogger.Instance, CancellationToken.None); |
| 80 | + |
| 81 | + var packageMetadata = metadata.FirstOrDefault(); |
| 82 | + return packageMetadata?.Description ?? "Description not found"; |
| 83 | + } |
| 84 | + |
| 85 | + private static string SanitizeNugetDescription(string desc) |
| 86 | + { |
| 87 | + const string marker = "Commonly used types:"; |
| 88 | + int index = desc.IndexOf(marker, StringComparison.OrdinalIgnoreCase); |
| 89 | + if (index >= 0) |
| 90 | + { |
| 91 | + desc = desc.Substring(0, index); |
| 92 | + } |
| 93 | + return desc.Replace("\n", " ").Replace("\r", " ").Trim(); |
| 94 | + } |
| 95 | + |
| 96 | + public string GetAllVersions(IEnumerable<(string project, Package package)> packages) |
| 97 | + { |
| 98 | + var allVersions = packages.Select(p => p.package.SourceVersionText).Distinct().ToList(); |
| 99 | + return string.Join(", ", allVersions); |
| 100 | + } |
| 101 | + |
| 102 | + public string GetAllProjects(IEnumerable<(string project, Package package)> packages) |
| 103 | + { |
| 104 | + var allProjects = packages.Select(p => p.project).Distinct().ToList(); |
| 105 | + return string.Join(", ", allProjects); |
| 106 | + } |
| 107 | +} |
0 commit comments