Include umbraco-package.json manifests in telemetry data

[ronaldbarendse]

Prerequisites

• I have added steps to test this contribution in the description below

Description

PR #15744 removed the legacy package manifest parser, but also removed the code from PackagingService that returned the combined the package migrations and manifests. This data is used in the telemetry service to report the installed packages (if the consent level of the installation is set to Basic or Detailed and the package hasn't opted-out), which is mainly used in the Marketplace to sort the packages by most active installs.

Another important detail that was missing, is being able to specify the (NuGet) package ID in the manifest, so the Marketplace can do a 1:1 match when aggregating the data.

Besides re-introducing the package manifests as installed packages and adding the package ID, I've ensured the ID is also exposed in the Management API endpoints. E.g. the umbraco/management/api/v1/manifest/manifest endpoint now returns:

[
  {
    "name": "@umbraco-cms/backoffice",
    "id": null,
    "version": "14.0.0-rc2",
    "extensions": []
  },
  {
    "name": "Test",
    "id": "Umbraco.Cms.Test",
    "version": "14.0.0",
    "extensions": []
  }
]

Testing can be done by adding a umbraco-package.json file to e.g. wwwroot\App_Plugins\Test:

{
  "name": "Test",
  "id": "Umbraco.Cms.Test",
  "version": "14.0.0",
  "extensions": []
}

And then making sure this is included in ReportSiteJob.RunJobAsync() (update Delay to 0 and add a breakpoint to this method) and the package ID is exposed in the Management API (all Manifest endpoints).

[ronaldbarendse]

The backoffice UI will still need to be updated to show the package ID, as that's currently missing:

Comparing it to v13, the package name is more visible/prominent and the version has a label, so maybe the styling could be slightly updated as well:

[Zeegaan]

Heyo 👋
This won't make it in 14.0.0 sadly, so you'll need to fix the breaking changes in IPackagingService, should be fairly simple using Default implementation 😁

[ronaldbarendse]

I noticed we have quite a few occurrences of await Task.FromResult() spread throughout the codebase, which seems wasteful, as it wraps the result and adds an additional await (with all the extra async state machine code that's generated by the compiler)...

[ronaldbarendse]

Heyo 👋 This won't make it in 14.0.0 sadly, so you'll need to fix the breaking changes in IPackagingService, should be fairly simple using Default implementation 😁

I've avoided any breaking changes now and added comments to highlight some additional bugs/issues that are fixed in this PR. Would be great if we can ship this in a patch, instead of waiting for the next minor 😇

[ronaldbarendse]

To help testing out the changes, you can put this composer/component in your project and check out the logged messages:

using Umbraco.Cms.Core.Composing;
using Umbraco.Cms.Core.Telemetry;

internal sealed class LogPackageTelemetryComposer : IComposer
{
    public void Compose(IUmbracoBuilder builder)
    {
        builder.AddComponent<LogPackageTelemetryComponent>();
    }

    private sealed class LogPackageTelemetryComponent : IComponent
    {
        private readonly ITelemetryService _telemetryService;
        private readonly ILogger<LogPackageTelemetryComponent> _logger;

        public LogPackageTelemetryComponent(ITelemetryService telemetryService, ILogger<LogPackageTelemetryComponent> logger)
        {
            _telemetryService = telemetryService;
            _logger = logger;
        }

        public void Initialize()
        {
            var telemetryReportData = _telemetryService.GetTelemetryReportDataAsync().GetAwaiter().GetResult();
            if (telemetryReportData?.Packages is not null)
            {
                foreach (var packageTelemetry in telemetryReportData.Packages)
                {
                    _logger.LogInformation(
                        "Package telemetry for {PackageName} ({PackageId}) {PackageVersion}",
                        packageTelemetry.Name,
                        packageTelemetry.Id,
                        packageTelemetry.Version);
                }
            }
        }

        public void Terminate()
        { }
    }
}

On a side note: this does highlight the fact we don't have an IAsyncComponent 😇

[Zeegaan]

Looks good, tests good 🚀