Add heuristics for matching packages to ARP after installing

.github/actions/spelling/expect.txt

@@ -158,6 +158,7 @@ hre
 hresults
 htm
 IAttachment
+IARP
 IConfiguration
 idx
 IFACEMETHODIMP
@@ -378,6 +379,7 @@ TStatus
 UCase
 ucasemap
 UChars
+ucnv
 uec
 uild
 uintptr

src/AppInstallerCLICore/ExecutionContextData.h

@@ -48,7 +48,7 @@ namespace AppInstaller::CLI::Execution
         // On import: Sources for the imported packages
         Sources,
         ARPSnapshot,
-        ProductCodeFromARP,
+        CorrelatedAppsAndFeaturesEntries,
         Dependencies,
         DependencySource,
         AllowedArchitectures,
@@ -192,7 +192,7 @@ namespace AppInstaller::CLI::Execution
         };
 
         template <>
-        struct DataMapping<Data::ProductCodeFromARP>
+        struct DataMapping<Data::CorrelatedAppsAndFeaturesEntries>
         {
             using value_t = std::vector<Manifest::AppsAndFeaturesEntry>;
         };

src/AppInstallerCLICore/Workflows/InstallFlow.cpp

@@ -524,54 +524,61 @@ namespace AppInstaller::CLI::Workflow
                 return result;
             }, true);
 
-        // We can only get the source identifier from an active source
-        std::string sourceIdentifier;
-        if (context.Contains(Execution::Data::PackageVersion))
-        {
-            sourceIdentifier = context.Get<Execution::Data::PackageVersion>()->GetProperty(PackageVersionProperty::SourceIdentifier);
-        }
-
-        auto arpEntry = Correlation::FindARPEntryForNewlyInstalledPackage(manifest, arpSnapshot, arpSource, sourceIdentifier);
+        auto correlationResult = Correlation::FindARPEntryForNewlyInstalledPackage(manifest, arpSnapshot, arpSource);
 
         // Store the ARP entry found to match the package to record it in the tracking catalog later
-        if (arpEntry)
+        if (correlationResult.Package)
         {
-            // TODO: Is this the right way to add the data we have?
             std::vector<AppsAndFeaturesEntry> entries;
 
-            auto metadata = arpEntry->GetMetadata();
+            auto metadata = correlationResult.Package->GetMetadata();
 
             AppsAndFeaturesEntry baseEntry;
-            baseEntry.DisplayName = arpEntry->GetProperty(PackageVersionProperty::Name).get();
-            baseEntry.DisplayVersion = arpEntry->GetProperty(PackageVersionProperty::Version).get();
-            baseEntry.Publisher = metadata[PackageVersionMetadata::Publisher];
+
+            // Display name and publisher are also available as multi properties, but
+            // for ARP there will always be only 0 or 1 values.
+            baseEntry.DisplayName = correlationResult.Package->GetProperty(PackageVersionProperty::Name).get();
+            baseEntry.Publisher = correlationResult.Package->GetProperty(PackageVersionProperty::Publisher).get();
+            baseEntry.DisplayVersion = correlationResult.Package->GetProperty(PackageVersionProperty::Version).get();
             baseEntry.InstallerType = Manifest::ConvertToInstallerTypeEnum(metadata[PackageVersionMetadata::InstalledType]);
 
-            auto productCodes = arpEntry->GetMultiProperty(PackageVersionMultiProperty::ProductCode);
+            auto productCodes = correlationResult.Package->GetMultiProperty(PackageVersionMultiProperty::ProductCode);
             for (auto&& productCode : productCodes)
             {
                 AppsAndFeaturesEntry entry = baseEntry;
                 entry.ProductCode = std::move(productCode).get();
                 entries.push_back(std::move(entry));
             }
 
-            auto names = arpEntry->GetMultiProperty(PackageVersionMultiProperty::Name);
-            auto publishers = arpEntry->GetMultiProperty(PackageVersionMultiProperty::Publisher);
+            context.Add<Data::CorrelatedAppsAndFeaturesEntries>(std::move(entries));
+        }
 
-            // TODO: these should always have the same size...
-            if (names.size() == publishers.size())
-            {
-                for (size_t i = 0; i < names.size(); ++i)
-                {
-                    AppsAndFeaturesEntry entry = baseEntry;
-                    entry.DisplayName = std::move(names[i]).get();
-                    entry.Publisher = std::move(publishers[i]).get();
-                    entries.push_back(std::move(entry));
-                }
-            }
+        // We can only get the source identifier from an active source
+        std::string sourceIdentifier;
+        if (context.Contains(Execution::Data::PackageVersion))
+        {
+            sourceIdentifier = context.Get<Execution::Data::PackageVersion>()->GetProperty(PackageVersionProperty::SourceIdentifier);
+        }
 
-            context.Add<Data::ProductCodeFromARP>(std::move(entries));
+        IPackageVersion::Metadata arpEntryMetadata;
+        if (correlationResult.Package)
+        {
+            arpEntryMetadata = correlationResult.Package->GetMetadata();
         }
+
+        Logging::Telemetry().LogSuccessfulInstallARPChange(
+            sourceIdentifier,
+            manifest.Id,
+            manifest.Version,
+            manifest.Channel,
+            correlationResult.ChangesToARP,
+            correlationResult.MatchesInARP,
+            correlationResult.CountOfIntersectionOfChangesAndMatches,
+            correlationResult.Package ? static_cast<std::string>(correlationResult.Package->GetProperty(PackageVersionProperty::Name)) : "",
+            correlationResult.Package ? static_cast<std::string>(correlationResult.Package->GetProperty(PackageVersionProperty::Version)) : "",
+            correlationResult.Package ? static_cast<std::string>(correlationResult.Package->GetProperty(PackageVersionProperty::Publisher)) : "",
+            correlationResult.Package ? static_cast<std::string_view>(arpEntryMetadata[PackageVersionMetadata::InstalledLocale]) : ""
+        );
     }
     CATCH_LOG();
 
@@ -591,11 +598,11 @@ namespace AppInstaller::CLI::Workflow
         // we set its product code in the manifest we record to ensure we can
         // find it in the future.
         // Note that this may overwrite existing information.
-        if (context.Contains(Data::ProductCodeFromARP))
+        if (context.Contains(Data::CorrelatedAppsAndFeaturesEntries))
         {
             // Use a new Installer entry
             manifest.Installers.emplace_back();
-            manifest.Installers.back().AppsAndFeaturesEntries = context.Get<Data::ProductCodeFromARP>();
+            manifest.Installers.back().AppsAndFeaturesEntries = context.Get<Data::CorrelatedAppsAndFeaturesEntries>();
         }
 
         auto trackingCatalog = context.Get<Data::PackageVersion>()->GetSource().GetTrackingCatalog();

src/AppInstallerCLICore/Workflows/InstallFlow.h

@@ -171,12 +171,12 @@ namespace AppInstaller::CLI::Workflow
     // and stores the product code of the ARP entry found for the package.
     // Required Args: None
     // Inputs: ARPSnapshot?, Manifest, PackageVersion
-    // Outputs: ProductCodeFromARP?
+    // Outputs: CorrelatedAppsAndFeaturesEntries?
     void ReportARPChanges(Execution::Context& context);
 
     // Records the installation to the tracking catalog.
     // Required Args: None
-    // Inputs: PackageVersion?, Manifest, Installer, ProductCodeFromARP?
+    // Inputs: PackageVersion?, Manifest, Installer, CorrelatedAppsAndFeaturesEntries?
     // Outputs: None
     void RecordInstall(Execution::Context& context);
 }

src/AppInstallerCLITests/ARPChanges.cpp

@@ -209,26 +209,18 @@ struct TestContext : public Context
 // consider only the exact matching.
 struct TestHeuristicOverride
 {
-    struct EmptyHeuristic: public ARPCorrelationAlgorithm
-    {
-        double GetMatchingScore(const Manifest::Manifest&, const Manifest::ManifestLocalization&, const ARPEntry&) const override
-        {
-            return 0;
-        }
-    };
-
     TestHeuristicOverride()
     {
-        ARPCorrelationAlgorithm::OverrideInstance(&m_algorithm);
+        IARPMatchConfidenceAlgorithm::OverrideInstance(&m_algorithm);
     }
 
     ~TestHeuristicOverride()
     {
-        ARPCorrelationAlgorithm::ResetInstance();
+        IARPMatchConfidenceAlgorithm::ResetInstance();
     }
 
 private:
-    EmptyHeuristic m_algorithm;
+    EmptyMatchConfidenceAlgorithm m_algorithm;
 };
 
 TEST_CASE("ARPChanges_MSIX_Ignored", "[ARPChanges][workflow]")