Add CustomHeader support to PushOptions

MarcellvanRooyen · Alexander Ovchinnikov · commit 2dab5053320a · 2023-04-07T17:22:39.000+02:00
The underlying gitPushOptions class already supports this so we are only exposing this functionality through the api
diff --git a/LibGit2Sharp/Network.cs b/LibGit2Sharp/Network.cs
@@ -400,14 +400,19 @@ public virtual void Push(Remote remote, IEnumerable<string> pushRefSpecs, PushOp
                 var callbacks = new RemoteCallbacks(pushOptions);
                 GitRemoteCallbacks gitCallbacks = callbacks.GenerateCallbacks();
 
+                GitPushOptions gitPushOptions = new GitPushOptions()
+                {
+                    PackbuilderDegreeOfParallelism = pushOptions.PackbuilderDegreeOfParallelism,
+                    RemoteCallbacks = gitCallbacks,
+                    ProxyOptions = proxyOptionsWrapper.GitProxyOptions
+                };
+
+                if (pushOptions.CustomHeaders != null && pushOptions.CustomHeaders.Length > 0)
+                    gitPushOptions.CustomHeaders = GitStrArrayManaged.BuildFrom(pushOptions.CustomHeaders);
+
                 Proxy.git_remote_push(remoteHandle,
-                                      pushRefSpecs,
-                                      new GitPushOptions()
-                                      {
-                                          PackbuilderDegreeOfParallelism = pushOptions.PackbuilderDegreeOfParallelism,
-                                          RemoteCallbacks = gitCallbacks,
-                                          ProxyOptions = proxyOptionsWrapper.GitProxyOptions,
-                                      });
+                    pushRefSpecs,
+                    gitPushOptions);
             }
         }
 
diff --git a/LibGit2Sharp/PushOptions.cs b/LibGit2Sharp/PushOptions.cs
@@ -51,5 +51,26 @@ public sealed class PushOptions
         /// information about what updates will be performed.
         /// </summary>
         public PrePushHandler OnNegotiationCompletedBeforePush { get; set; }
+
+        /// <summary>
+        /// Get/Set the custom headers.
+        /// 
+        /// <para> 
+        /// This allows you to set custom headers (e.g. X-Forwarded-For, 
+        /// X-Request-Id, etc),
+        /// </para>
+        /// </summary>
+        /// <remarks>
+        /// Libgit2 sets some headers for HTTP requests (User-Agent, Host, 
+        /// Accept, Content-Type, Transfer-Encoding, Content-Length, Accept) that
+        /// cannot be overriden.
+        /// </remarks>
+        /// <example>
+        /// var pushOptions - new PushOptions() {
+        ///     CustomHeaders = new String[] {"X-Request-Id: 12345"}
+        /// };
+        /// </example>
+        /// <value>The custom headers string array</value>
+        public string[] CustomHeaders { get; set; }
     }
 }
