Implement package pinning

src/AppInstallerCLICore/Commands/UpgradeCommand.cpp

@@ -111,6 +111,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Execution::Args::Type::CustomHeader),
             Argument{ "all"_liv, 'r', "recurse"_liv, Args::Type::All, Resource::String::UpdateAllArgumentDescription, ArgumentType::Flag },
             Argument{ "include-unknown"_liv, 'u', "unknown"_liv, Args::Type::IncludeUnknown, Resource::String::IncludeUnknownArgumentDescription, ArgumentType::Flag },
+            Argument{ "include-pinned"_liv, Argument::NoAlias, "pinned"_liv, Args::Type::IncludePinned, Resource::String::IncludePinnedArgumentDescription, ArgumentType::Flag},
             Argument::ForType(Args::Type::UninstallPrevious),
             Argument::ForType(Args::Type::Force),
         };

src/AppInstallerCLICore/ExecutionArgs.h

@@ -86,6 +86,7 @@ namespace AppInstaller::CLI::Execution
             // Upgrade command
             All, // Used in Update command to update all installed packages to latest
             IncludeUnknown, // Used in Upgrade command to allow upgrades of packages with unknown versions
+            IncludePinned, // Used in Upgrade command to allow upgrades to pinned packages (only for pinning type of pins)
             UninstallPrevious, // Used in Upgrade command to override the default manifest behavior to UninstallPrevious
 
             // Show command

src/AppInstallerCLICore/Resources.h

@@ -123,6 +123,7 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(ImportPackageAlreadyInstalled);
         WINGET_DEFINE_RESOURCE_STRINGID(ImportSearchFailed);
         WINGET_DEFINE_RESOURCE_STRINGID(ImportSourceNotInstalled);
+        WINGET_DEFINE_RESOURCE_STRINGID(IncludePinnedArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(IncludeUnknownArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(IncompatibleArgumentsProvided);
         WINGET_DEFINE_RESOURCE_STRINGID(InstallAndUpgradeCommandsReportDependencies);
@@ -258,6 +259,7 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(PinNoPinsExist);
         WINGET_DEFINE_RESOURCE_STRINGID(PinRemoveCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinRemoveCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(PinRemovedSuccessfully);
         WINGET_DEFINE_RESOURCE_STRINGID(PinResetCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinResetCommandShortDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(PinResetSuccessful);
@@ -430,6 +432,7 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(UpdateAllArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(UpdateNotApplicable);
         WINGET_DEFINE_RESOURCE_STRINGID(UpgradeAvailableForPinned);
+        WINGET_DEFINE_RESOURCE_STRINGID(UpgradeBlockingPinCount);
         WINGET_DEFINE_RESOURCE_STRINGID(UpgradeCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(UpgradeCommandShortDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(UpgradeDifferentInstallTechnology);

src/AppInstallerCLICore/Workflows/CompletionFlow.cpp

@@ -70,7 +70,7 @@ namespace AppInstaller::CLI::Workflow
         const std::string& word = context.Get<Data::CompletionData>().Word();
         auto stream = context.Reporter.Completion();
 
-        for (const auto& vc : context.Get<Execution::Data::Package>()->GetAvailableVersionKeys())
+        for (const auto& vc : context.Get<Execution::Data::Package>()->GetAvailableVersionKeys(Repository::PinBehavior::IgnorePins))
         {
             if (word.empty() || Utility::ICUCaseInsensitiveStartsWith(vc.Version, word))
             {
@@ -86,7 +86,7 @@ namespace AppInstaller::CLI::Workflow
 
         std::vector<std::string> channels;
 
-        for (const auto& vc : context.Get<Execution::Data::Package>()->GetAvailableVersionKeys())
+        for (const auto& vc : context.Get<Execution::Data::Package>()->GetAvailableVersionKeys(Repository::PinBehavior::IgnorePins))
         {
             if ((word.empty() || Utility::ICUCaseInsensitiveStartsWith(vc.Channel, word)) &&
                 std::find(channels.begin(), channels.end(), vc.Channel) == channels.end())

src/AppInstallerCLICore/Workflows/DependencyNodeProcessor.cpp

@@ -41,7 +41,7 @@ namespace AppInstaller::CLI::Workflow
         const auto& package = match.Package;
         auto packageId = package->GetProperty(PackageProperty::Id);
         m_nodePackageInstalledVersion = package->GetInstalledVersion();
-        m_nodePackageLatestVersion = package->GetLatestAvailableVersion();
+        m_nodePackageLatestVersion = package->GetLatestAvailableVersion(PinBehavior::ConsiderPins);
 
         if (m_nodePackageInstalledVersion && dependencyNode.IsVersionOk(Utility::Version(m_nodePackageInstalledVersion->GetProperty(PackageVersionProperty::Version))))
         {

src/AppInstallerCLICore/Workflows/ImportExportFlow.cpp

@@ -65,13 +65,13 @@ namespace AppInstaller::CLI::Workflow
         {
             if (!checkVersion)
             {
-                return package->GetLatestAvailableVersion();
+                return package->GetLatestAvailableVersion(PinBehavior::IgnorePins);
             }
 
-            auto availablePackageVersion = package->GetAvailableVersion({ "", version, channel });
+            auto availablePackageVersion = package->GetAvailableVersion({ "", version, channel }, PinBehavior::IgnorePins);
             if (!availablePackageVersion)
             {
-                availablePackageVersion = package->GetLatestAvailableVersion();
+                availablePackageVersion = package->GetLatestAvailableVersion(PinBehavior::IgnorePins);
                 if (availablePackageVersion)
                 {
                     // Warn installed version is not available.

src/AppInstallerCLICore/Workflows/PinFlow.cpp

@@ -57,17 +57,26 @@ namespace AppInstaller::CLI::Workflow
     {
         auto package = context.Get<Execution::Data::Package>();
         std::vector<Pinning::Pin> pins;
-
-        // TODO: We should support querying the multiple sources for a package, instead of just one
-        auto availableVersion = package->GetLatestAvailableVersion();
+        std::set<std::string> sources;
 
         auto pinningIndex = context.Get<Execution::Data::PinningIndex>();
-        auto pin = pinningIndex->GetPin({
-            availableVersion->GetProperty(PackageVersionProperty::Id).get(),
-            availableVersion->GetProperty(PackageVersionProperty::SourceIdentifier).get() });
-        if (pin)
+
+        auto packageVersionKeys = package->GetAvailableVersionKeys(PinBehavior::IgnorePins);
+        for (auto versionKey : packageVersionKeys)
         {
-            pins.emplace_back(std::move(pin.value()));
+            auto availableVersion = package->GetAvailableVersion(versionKey, PinBehavior::IgnorePins);
+            Pinning::PinKey pinKey{
+            availableVersion->GetProperty(PackageVersionProperty::Id).get(),
+                availableVersion->GetProperty(PackageVersionProperty::SourceIdentifier).get() };
+
+            if (sources.insert(pinKey.SourceId).second)
+            {
+                auto pin = pinningIndex->GetPin(pinKey);
+                if (pin)
+                {
+                    pins.emplace_back(std::move(pin.value()));
+                }
+            }
         }
 
         context.Add<Execution::Data::Pins>(std::move(pins));
@@ -78,49 +87,71 @@ namespace AppInstaller::CLI::Workflow
         auto package = context.Get<Execution::Data::Package>();
         auto installedVersion = context.Get<Execution::Data::InstalledPackageVersion>();
 
-        std::vector<Pinning::Pin> pins;
-
-        // TODO: We should support querying the multiple sources for a package, instead of just one
-        auto availableVersion = package->GetLatestAvailableVersion();
-
-        Pinning::PinKey pinKey{
-            availableVersion->GetProperty(PackageVersionProperty::Id).get(),
-            availableVersion->GetProperty(PackageVersionProperty::SourceIdentifier).get() };
-        auto pin = CreatePin(context, pinKey.PackageId, pinKey.SourceId);
-        AICLI_LOG(CLI, Info, << "Adding pin with type " << ToString(pin.GetType()) << " for package [" << pin.GetPackageId() << "] from source [" << pin.GetSourceId() << "]");
+        auto installedVersionString = installedVersion->GetProperty(PackageVersionProperty::Version);
 
+        std::vector<Pinning::Pin> pinsToAddOrUpdate;
+        std::set<std::string> sources;
 
         auto pinningIndex = context.Get<Execution::Data::PinningIndex>();
-        auto existingPin = pinningIndex->GetPin(pinKey);
 
-        if (existingPin)
+        auto packageVersionKeys = package->GetAvailableVersionKeys(PinBehavior::IgnorePins);
+        for (auto versionKey : packageVersionKeys)
         {
-            // Pin already exists.
-            // If it is the same, we do nothing. If it is different, check for the --force arg
-            if (pin == existingPin)
+            auto availableVersion = package->GetAvailableVersion(versionKey, PinBehavior::IgnorePins);
+            Pinning::PinKey pinKey{
+                availableVersion->GetProperty(PackageVersionProperty::Id).get(),
+                availableVersion->GetProperty(PackageVersionProperty::SourceIdentifier).get() };
+
+            if (!sources.insert(pinKey.SourceId).second)
             {
-                AICLI_LOG(CLI, Info, << "Pin already exists");
-                context.Reporter.Info() << Resource::String::PinAlreadyExists << std::endl;
-                return;
+                // We already considered the pin for this source
+                continue;
             }
 
-            AICLI_LOG(CLI, Info, << "Another pin already exists for the package");
-            if (context.Args.Contains(Execution::Args::Type::Force))
+            auto pin = CreatePin(context, pinKey.PackageId, pinKey.SourceId);
+            AICLI_LOG(CLI, Info, << "Evaluating pin with type " << ToString(pin.GetType()) << " for package [" << pin.GetPackageId() << "] from source [" << pin.GetSourceId() << "]");
+
+            auto existingPin = pinningIndex->GetPin(pinKey);
+
+            if (existingPin)
             {
-                AICLI_LOG(CLI, Info, << "Overwriting pin due to --force argument");
-                context.Reporter.Warn() << Resource::String::PinExistsOverwriting << std::endl;
-                pinningIndex->UpdatePin(pin);
+                auto packageName = availableVersion->GetProperty(PackageVersionProperty::Name);
+
+                // Pin already exists.
+                // If it is the same, we do nothing. If it is different, check for the --force arg
+                if (pin == existingPin)
+                {
+                    AICLI_LOG(CLI, Info, << "Pin already exists");
+                    context.Reporter.Info() << Resource::String::PinAlreadyExists(packageName) << std::endl;
+                    continue;
+                }
+
+                AICLI_LOG(CLI, Info, << "Another pin already exists for the package for source " << pinKey.SourceId);
+                if (context.Args.Contains(Execution::Args::Type::Force))
+                {
+                    AICLI_LOG(CLI, Info, << "Overwriting pin due to --force argument");
+                    context.Reporter.Warn() << Resource::String::PinExistsOverwriting(packageName) << std::endl;
+                    pinsToAddOrUpdate.push_back(std::move(pin));
+                }
+                else
+                {
+                    context.Reporter.Error() << Resource::String::PinExistsUseForceArg(packageName) << std::endl;
+                    AICLI_TERMINATE_CONTEXT(APPINSTALLER_CLI_ERROR_PIN_ALREADY_EXISTS);
+                }
             }
             else
             {
-                context.Reporter.Error() << Resource::String::PinExistsUseForceArg << std::endl;
-                AICLI_TERMINATE_CONTEXT(APPINSTALLER_CLI_ERROR_PIN_ALREADY_EXISTS);
+                pinsToAddOrUpdate.push_back(std::move(pin));
             }
         }
-        else
+
+        if (!pinsToAddOrUpdate.empty())
         {
-            pinningIndex->AddPin(pin);
-            AICLI_LOG(CLI, Info, << "Finished adding pin");
+            for (auto pin : pinsToAddOrUpdate)
+            {
+                pinningIndex->AddOrUpdatePin(pin);
+            }
+
             context.Reporter.Info() << Resource::String::PinAdded << std::endl;
         }
     }
@@ -129,23 +160,41 @@ namespace AppInstaller::CLI::Workflow
     {
         auto package = context.Get<Execution::Data::Package>();
         std::vector<Pinning::Pin> pins;
-
-        // TODO: We should support querying the multiple sources for a package, instead of just one
-        auto availableVersion = package->GetLatestAvailableVersion();
+        std::set<std::string> sources;
 
         auto pinningIndex = context.Get<Execution::Data::PinningIndex>();
-        Pinning::PinKey pinKey{
-            availableVersion->GetProperty(PackageVersionProperty::Id).get(),
-            availableVersion->GetProperty(PackageVersionProperty::SourceIdentifier).get() };
-        AICLI_LOG(CLI, Info, << "Removing pin for package [" << pinKey.PackageId << "] from source [" << pinKey.SourceId << "]");
-        if (!pinningIndex->GetPin(pinKey))
+        bool pinExists = false;
+
+        // Note that if a source was specified in the command line,
+        // that will be the only one we get version keys from.
+        // So, we remove pins from all sources unless one was provided.
+        auto packageVersionKeys = package->GetAvailableVersionKeys(PinBehavior::IgnorePins);
+        for (auto versionKey : packageVersionKeys)
+        {
+            auto availableVersion = package->GetAvailableVersion(versionKey, PinBehavior::IgnorePins);
+            Pinning::PinKey pinKey{
+                availableVersion->GetProperty(PackageVersionProperty::Id).get(),
+                availableVersion->GetProperty(PackageVersionProperty::SourceIdentifier).get() };
+
+            if (sources.insert(pinKey.SourceId).second)
+            {
+                if (pinningIndex->GetPin(pinKey))
+                {
+                    AICLI_LOG(CLI, Info, << "Removing pin for package [" << pinKey.PackageId << "] from source [" << pinKey.SourceId << "]");
+                    pinningIndex->RemovePin(pinKey);
+                    pinExists = true;
+                }
+            }
+        }
+
+        if (!pinExists)
         {
             AICLI_LOG(CLI, Warning, << "Pin does not exist");
-            context.Reporter.Warn() << Resource::String::PinDoesNotExist(pinKey.PackageId) << std::endl;
+            context.Reporter.Warn() << Resource::String::PinDoesNotExist(package->GetProperty(PackageProperty::Name)) << std::endl;
             AICLI_TERMINATE_CONTEXT(APPINSTALLER_CLI_ERROR_PIN_DOES_NOT_EXIST);
         }
 
-        pinningIndex->RemovePin(pinKey);
+        context.Reporter.Info() << Resource::String::PinRemovedSuccessfully << std::endl;
     }
 
     void ReportPins(Execution::Context& context)
@@ -157,7 +206,13 @@ namespace AppInstaller::CLI::Workflow
             return;
         }
 
-        // TODO: Use package and source names
+        // Get a mapping of source IDs to names so that we can show something nicer
+        std::map<std::string, std::string> sourceNames;
+        for (const auto& source : Repository::Source::GetCurrentSources())
+        {
+            sourceNames[source.Identifier] = source.Name;
+        }
+
         Execution::TableOutput<4> table(context.Reporter,
             {
                 Resource::String::SearchId,
@@ -168,12 +223,11 @@ namespace AppInstaller::CLI::Workflow
 
         for (const auto& pin : pins)
         {
-            // TODO: Avoid these conversions to string
             table.OutputLine({
                 pin.GetPackageId(),
-                std::string{ pin.GetSourceId() },
-                pin.GetGatedVersion().ToString(),
+                sourceNames[pin.GetSourceId()],
                 std::string{ ToString(pin.GetType()) },
+                pin.GetGatedVersion().ToString(),
                 });
         }
 
@@ -216,14 +270,22 @@ namespace AppInstaller::CLI::Workflow
         const auto& source = context.Get<Execution::Data::Source>();
 
         std::vector<Pinning::Pin> matchingPins;
-        std::copy_if(pins.begin(), pins.end(), std::back_inserter(matchingPins), [&](Pinning::Pin pin) {
-            // TODO: Filter to source
+        for (const auto pin : pins)
+        {
             SearchRequest searchRequest;
             searchRequest.Filters.emplace_back(PackageMatchField::Id, MatchType::CaseInsensitive, pin.GetPackageId());
             auto searchResult = source.Search(searchRequest);
 
-            return !searchResult.Matches.empty();
-            });
+            // Ensure the match comes from the right source
+            for (const auto& match : searchResult.Matches)
+            {
+                auto availableVersion = match.Package->GetAvailableVersion({ pin.GetSourceId(), "", "" }, PinBehavior::IgnorePins);
+                if (availableVersion)
+                {
+                    matchingPins.push_back(pin);
+                }
+            }
+        }
 
         context.Add<Execution::Data::Pins>(std::move(matchingPins));
     }

src/AppInstallerCLICore/Workflows/PinFlow.h

@@ -29,7 +29,7 @@ namespace AppInstaller::CLI::Workflow
     // There may be several if a package is available from multiple sources.
     // Required Args: None
     // Inputs: PinningIndex, Package
-    // Outputs Pins
+    // Outputs: Pins
     void SearchPin(Execution::Context& context);
 
     // Adds a pin for the current package.
@@ -57,7 +57,7 @@ namespace AppInstaller::CLI::Workflow
     // Outputs: None
     void ResetAllPins(Execution::Context& context);
 
-    // Updates the list of pins to include only those matching the current open source
+    // Updates the list of pins to include only those matching the current open source.
     // Required Args: None
     // Inputs: Pins, Source
     // Outputs: None

src/AppInstallerCLICore/Workflows/ShowFlow.cpp

@@ -227,7 +227,7 @@ namespace AppInstaller::CLI::Workflow
 
     void ShowAppVersions(Execution::Context& context)
     {
-        auto versions = context.Get<Execution::Data::Package>()->GetAvailableVersionKeys();
+        auto versions = context.Get<Execution::Data::Package>()->GetAvailableVersionKeys(PinBehavior::IgnorePins);
 
         Execution::TableOutput<2> table(context.Reporter, { Resource::String::ShowVersion, Resource::String::ShowChannel });
         for (const auto& version : versions)

src/AppInstallerCLICore/Workflows/UninstallFlow.cpp

@@ -233,9 +233,9 @@ namespace AppInstaller::CLI::Workflow
         correlatedSources.AddIfRemoteAndNotPresent(package->GetInstalledVersion());
 
         // Then look through all available versions
-        for (const auto& versionKey : package->GetAvailableVersionKeys())
+        for (const auto& versionKey : package->GetAvailableVersionKeys(PinBehavior::IgnorePins))
         {
-            correlatedSources.AddIfRemoteAndNotPresent(package->GetAvailableVersion(versionKey));
+            correlatedSources.AddIfRemoteAndNotPresent(package->GetAvailableVersion(versionKey, PinBehavior::IgnorePins));
         }
 
         // Finally record the uninstall for each found value