Pass through header changes (microsoft#1364)

Arbitrary Header Changes
manudss · Aug 27, 2021 · 63ea8b0 · 63ea8b0
1 parent 58402d4
commit 63ea8b0
Show file tree

Hide file tree

Showing 28 changed files with 964 additions and 626 deletions.
diff --git a/src/AppInstallerCLICore/Argument.cpp b/src/AppInstallerCLICore/Argument.cpp
@@ -80,6 +80,8 @@ namespace AppInstaller::CLI
             return Argument{ "verbose-logs", NoAlias, Args::Type::VerboseLogs, Resource::String::VerboseLogsArgumentDescription, ArgumentType::Flag };
         case Args::Type::ExperimentalArg:
             return Argument{ "arg", NoAlias, Args::Type::ExperimentalArg, Resource::String::ExperimentalArgumentDescription, ArgumentType::Flag, ExperimentalFeature::Feature::ExperimentalArg };
+        case Args::Type::CustomHeader:
+            return Argument{ "header", NoAlias, Args::Type::CustomHeader, Resource::String::HeaderArgumentDescription, ArgumentType::Standard, Argument::Visibility::Help };
         default:
             THROW_HR(E_UNEXPECTED);
         }

diff --git a/src/AppInstallerCLICore/Command.cpp b/src/AppInstallerCLICore/Command.cpp
@@ -676,6 +676,12 @@ namespace AppInstaller::CLI
             throw CommandException(Resource::String::TooManyBehaviorsError, s_Command_ArgName_SilentAndInteractive);
         }
 
+        if (execArgs.Contains(Execution::Args::Type::CustomHeader) && !execArgs.Contains(Execution::Args::Type::Source) &&
+           !execArgs.Contains(Execution::Args::Type::SourceName))
+        {
+            throw CommandException(Resource::String::HeaderArgumentNotApplicableWithoutSource, Argument::ForType(Execution::Args::Type::CustomHeader).Name(), {});
+        }
+
         ValidateArgumentsInternal(execArgs);
     }
 

diff --git a/src/AppInstallerCLICore/Commands/InstallCommand.cpp b/src/AppInstallerCLICore/Commands/InstallCommand.cpp
@@ -40,6 +40,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Args::Type::InstallLocation),
             Argument::ForType(Args::Type::HashOverride),
             Argument::ForType(Args::Type::AcceptPackageAgreements),
+            Argument::ForType(Args::Type::CustomHeader),
         };
     }
 

diff --git a/src/AppInstallerCLICore/Commands/ListCommand.cpp b/src/AppInstallerCLICore/Commands/ListCommand.cpp
@@ -22,6 +22,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Execution::Args::Type::Command),
             Argument::ForType(Execution::Args::Type::Count),
             Argument::ForType(Execution::Args::Type::Exact),
+            Argument::ForType(Execution::Args::Type::CustomHeader),
         };
     }
 

diff --git a/src/AppInstallerCLICore/Commands/SearchCommand.cpp b/src/AppInstallerCLICore/Commands/SearchCommand.cpp
@@ -23,6 +23,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Execution::Args::Type::Source),
             Argument::ForType(Execution::Args::Type::Count),
             Argument::ForType(Execution::Args::Type::Exact),
+            Argument::ForType(Execution::Args::Type::CustomHeader),
         };
     }
 

diff --git a/src/AppInstallerCLICore/Commands/ShowCommand.cpp b/src/AppInstallerCLICore/Commands/ShowCommand.cpp
@@ -7,6 +7,8 @@
 #include "Workflows/WorkflowBase.h"
 #include "Resources.h"
 
+using namespace AppInstaller::CLI::Execution;
+
 namespace AppInstaller::CLI
 {
     std::vector<Argument> ShowCommand::GetArguments() const
@@ -23,6 +25,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Execution::Args::Type::Source),
             Argument::ForType(Execution::Args::Type::Exact),
             Argument::ForType(Execution::Args::Type::ListVersions),
+            Argument::ForType(Execution::Args::Type::CustomHeader),
         };
     }
 

diff --git a/src/AppInstallerCLICore/Commands/SourceCommand.cpp b/src/AppInstallerCLICore/Commands/SourceCommand.cpp
@@ -52,6 +52,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Args::Type::SourceName).SetRequired(true),
             Argument::ForType(Args::Type::SourceArg),
             Argument::ForType(Args::Type::SourceType),
+            Argument::ForType(Args::Type::CustomHeader),
         };
     }
 

diff --git a/src/AppInstallerCLICore/Commands/UninstallCommand.cpp b/src/AppInstallerCLICore/Commands/UninstallCommand.cpp
@@ -30,6 +30,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Args::Type::Interactive),
             Argument::ForType(Args::Type::Silent),
             Argument::ForType(Args::Type::Log),
+            Argument::ForType(Args::Type::CustomHeader),
         };
     }
 

diff --git a/src/AppInstallerCLICore/Commands/UpgradeCommand.cpp b/src/AppInstallerCLICore/Commands/UpgradeCommand.cpp
@@ -44,6 +44,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Args::Type::HashOverride),
             Argument::ForType(Args::Type::AcceptPackageAgreements),
             Argument{ "all", Argument::NoAlias, Args::Type::All, Resource::String::UpdateAllArgumentDescription, ArgumentType::Flag },
+            Argument::ForType(Execution::Args::Type::CustomHeader),
         };
     }
 

diff --git a/src/AppInstallerCLICore/ExecutionArgs.h b/src/AppInstallerCLICore/ExecutionArgs.h
@@ -77,6 +77,7 @@ namespace AppInstaller::CLI::Execution
             Help, // Show command usage
             Info, // Show general info about WinGet
             VerboseLogs, // Increases winget logging level to verbose
+            CustomHeader, // Optional Rest source header
 
             // Used for demonstration purposes
             ExperimentalArg,

diff --git a/src/AppInstallerCLICore/Resources.h b/src/AppInstallerCLICore/Resources.h
@@ -67,6 +67,9 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(GetManifestResultVersionNotFound);
         WINGET_DEFINE_RESOURCE_STRINGID(HashCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(HashCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(HeaderArgumentDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(HeaderArgumentNotApplicableForNonRestSourceWarning);
+        WINGET_DEFINE_RESOURCE_STRINGID(HeaderArgumentNotApplicableWithoutSource);
         WINGET_DEFINE_RESOURCE_STRINGID(HelpArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(HelpForDetails);
         WINGET_DEFINE_RESOURCE_STRINGID(HelpLinkPreamble);

diff --git a/src/AppInstallerCLICore/Workflows/SourceFlow.cpp b/src/AppInstallerCLICore/Workflows/SourceFlow.cpp
@@ -81,19 +81,22 @@ namespace AppInstaller::CLI::Workflow
 
     void AddSource(Execution::Context& context)
     {
-        std::string name(context.Args.GetArg(Args::Type::SourceName));
-        std::string arg(context.Args.GetArg(Args::Type::SourceArg));
-        std::string type;
+        Repository::SourceDetails sourceDetails;
+        sourceDetails.Name = context.Args.GetArg(Args::Type::SourceName);
+        sourceDetails.Arg = context.Args.GetArg(Args::Type::SourceArg);
+
         if (context.Args.Contains(Args::Type::SourceType))
         {
-            type = context.Args.GetArg(Args::Type::SourceType);
+            sourceDetails.Type = context.Args.GetArg(Args::Type::SourceType);
         }
 
+        sourceDetails.CustomHeader = GetCustomHeaderFromArg(context, sourceDetails);
+
         context.Reporter.Info() <<
             Resource::String::SourceAddBegin << std::endl <<
-            "  "_liv << name << " -> "_liv << arg << std::endl;
+            "  "_liv << sourceDetails.Name << " -> "_liv << sourceDetails.Arg << std::endl;
 
-        if (context.Reporter.ExecuteWithProgress(std::bind(Repository::AddSource, std::move(name), std::move(type), std::move(arg), std::placeholders::_1)))
+        if (context.Reporter.ExecuteWithProgress(std::bind(Repository::AddSource, sourceDetails, std::placeholders::_1)))
         {
             context.Reporter.Info() << Resource::String::Done;
         }

diff --git a/src/AppInstallerCLICore/Workflows/WorkflowBase.cpp b/src/AppInstallerCLICore/Workflows/WorkflowBase.cpp
@@ -46,9 +46,23 @@ namespace AppInstaller::CLI::Workflow
             std::shared_ptr<Repository::ISource> source;
             try
             {
-                auto result = context.Reporter.ExecuteWithProgress(std::bind(Repository::OpenSource, sourceName, std::placeholders::_1), true);
-                source = result.Source;
+                OpenSourceResult result;
+                if (!sourceName.empty())
+                {
+                    auto sourceDetails = Repository::GetSource(sourceName);
+                    if (sourceDetails)
+                    {
+                        sourceDetails.value().CustomHeader = GetCustomHeaderFromArg(context, sourceDetails.value());
+
+                        result = context.Reporter.ExecuteWithProgress(std::bind(Repository::OpenSourceFromDetails, sourceDetails.value(), std::placeholders::_1), true);
+                    }
+                }
+                else
+                {
+                    result = context.Reporter.ExecuteWithProgress(std::bind(Repository::OpenSource, sourceName, std::placeholders::_1), true);
+                }
 
+                source = result.Source;
                 // We'll only report the source update failure as warning and continue
                 for (const auto& s : result.SourcesWithUpdateFailure)
                 {
@@ -353,7 +367,7 @@ namespace AppInstaller::CLI::Workflow
                 latestVersion->GetProperty(PackageVersionProperty::Version),
                 GetMatchCriteriaDescriptor(searchResult.Matches[i]),
                 sourceIsComposite ? static_cast<std::string>(latestVersion->GetProperty(PackageVersionProperty::SourceName)) : ""s
-            });
+                });
         }
 
         table.Complete();
@@ -698,6 +712,24 @@ namespace AppInstaller::CLI::Workflow
         }
     }
 
+    std::optional<std::string> GetCustomHeaderFromArg(Execution::Context& context, const SourceDetails& sourceDetails)
+    {
+        std::optional<std::string> customHeader;
+        if (context.Args.Contains(Execution::Args::Type::CustomHeader))
+        {
+            if (!SupportsCustomHeader(sourceDetails))
+            {
+                context.Reporter.Warn() << Resource::String::HeaderArgumentNotApplicableForNonRestSourceWarning << std::endl;
+            }
+            else
+            {
+                customHeader = context.Args.GetArg(Execution::Args::Type::CustomHeader);
+            }
+        }
+
+        return customHeader;
+    }
+
     void EnsureFeatureEnabled::operator()(Execution::Context& context) const
     {
         if (!Settings::ExperimentalFeature::IsEnabled(m_feature))

diff --git a/src/AppInstallerCLICore/Workflows/WorkflowBase.h b/src/AppInstallerCLICore/Workflows/WorkflowBase.h
@@ -295,6 +295,10 @@ namespace AppInstaller::CLI::Workflow
     // Outputs: None
     void EnsureRunningAsAdmin(Execution::Context& context);
 
+    // Gets the custom header from Arguments.
+    // Returns: Custom header if provided and applicable.
+    std::optional<std::string> GetCustomHeaderFromArg(Execution::Context& context, const AppInstaller::Repository::SourceDetails& sourceDetails);
+
     // Ensures that the feature is enabled.
     // Required Args: the desired feature
     // Inputs: None

diff --git a/src/AppInstallerCLIPackage/Shared/Strings/en-us/winget.resw b/src/AppInstallerCLIPackage/Shared/Strings/en-us/winget.resw
@@ -1022,4 +1022,13 @@ Do you agree to the terms?</value>
   <data name="InstallFlowRegistrationDeferred" xml:space="preserve">
     <value>Successfully installed. Restart the application to complete the upgrade.</value>
   </data>
+  <data name="HeaderArgumentDescription" xml:space="preserve">
+    <value>Optional Windows-Package-Manager REST source HTTP header</value>
+  </data>
+  <data name="HeaderArgumentNotApplicableForNonRestSourceWarning" xml:space="preserve">
+    <value>Ignoring the optional header as it is not applicable for this source.</value>
+  </data>
+  <data name="HeaderArgumentNotApplicableWithoutSource" xml:space="preserve">
+    <value>The optional header is not applicable without specifying a Rest source</value>
+  </data>
 </root>
diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj
@@ -186,6 +186,7 @@
     <ClCompile Include="Command.cpp" />
     <ClCompile Include="Completion.cpp" />
     <ClCompile Include="CompositeSource.cpp" />
+    <ClCompile Include="CustomHeader.cpp" />
     <ClCompile Include="Downloader.cpp" />
     <ClCompile Include="ExperimentalFeature.cpp" />
     <ClCompile Include="GroupPolicy.cpp" />