Add support for referrerPolicy in Page.GoToAsync (#2284)

Author: kblok

lib/PuppeteerSharp.Tests/NavigationTests/PageGotoTests.cs

@@ -505,5 +505,28 @@ await Task.WhenAll(
             // Make sure subresources do not inherit referer.
             Assert.AreEqual(TestConstants.ServerUrl + "/grid.html", referer2);
         }
+
+        [PuppeteerTest("navigation.spec.ts", "Page.goto", "should send referer policy")]
+        [Skip(SkipAttribute.Targets.Firefox)]
+        public async Task ShouldSendRefererPolicy()
+        {
+            await Page.SetRequestInterceptionAsync(true);
+            Page.Request += async (_, e) => await e.Request.ContinueAsync();
+            string referer1 = null;
+            string referer2 = null;
+
+            await Task.WhenAll(
+                Server.WaitForRequest("/grid.html", r => referer1 = r.Headers["Referer"]),
+                Server.WaitForRequest("/digits/1.png", r => referer2 = r.Headers["Referer"]),
+                Page.GoToAsync(TestConstants.ServerUrl + "/grid.html", new NavigationOptions
+                {
+                    ReferrerPolicy = "no-referer"
+                })
+            );
+
+            Assert.IsNull(referer1);
+            // Make sure subresources do not inherit referer.
+            Assert.AreEqual(TestConstants.ServerUrl + "/grid.html", referer2);
+        }
     }
 }

lib/PuppeteerSharp.Tests/WontImplementTests.cs

@@ -15,10 +15,10 @@ public WontImplementTests(): base()
         [PuppeteerTest("chromiumonly.spec.ts", "Puppeteer.launch |pipe| option", "should support the pipe option")]
         [PuppeteerTest("chromiumonly.spec.ts", "Puppeteer.launch |pipe| option", "should support the pipe argument")]
         [PuppeteerTest("chromiumonly.spec.ts", "Puppeteer.launch |pipe| option", "should fire \"disconnected\" when closing with pipe")]
-        [PuppeteerTest("navigation.spec.ts", "should not leak listeners during navigation")]
-        [PuppeteerTest("navigation.spec.ts", "should not leak listeners during bad navigation")]
-        [PuppeteerTest("navigation.spec.ts", "should not leak listeners during navigation of 11 pages")]
-        [PuppeteerTest("navigation.spec.ts", "should throw if networkidle is passed as an option")]
+        [PuppeteerTest("navigation.spec.ts", "Page.goto", "should not leak listeners during navigation")]
+        [PuppeteerTest("navigation.spec.ts", "Page.goto", "should not leak listeners during bad navigation")]
+        [PuppeteerTest("navigation.spec.ts", "Page.goto", "should not leak listeners during navigation of 11 pages")]
+        [PuppeteerTest("navigation.spec.ts", "Page.goto", "should throw if networkidle is passed as an option")]
         [PuppeteerTest("launcher.spec.ts", "Puppeteer.launch", "should report the correct product")] //We don't use the product in this way
         [PuppeteerTest("launcher.spec.ts", "Puppeteer.launch", "falls back to launching chrome if there is an unknown product but logs a warning")]
         [PuppeteerTest("tracing.spec.ts", "Tracing", "should return null in case of Buffer error")]

lib/PuppeteerSharp.Tooling/PuppeteerSharp.Tooling.csproj

@@ -7,31 +7,18 @@
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
 	</PropertyGroup>
 	<ItemGroup>
-		<PackageReference Include="CommandLineParser" Version="2.9.0-preview1" />
+		<FrameworkReference Include="Microsoft.AspNetCore.App" />
+		<PackageReference Include="CommandLineParser" Version="2.9.1" />
 		<PackageReference Include="System.CodeDom" Version="5.0.0" />
 		<PackageReference Include="Macross.Json.Extensions" Version="1.5.0" />
 		<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="5.0.0" />
-		<PackageReference Include="Microsoft.Extensions.Primitives" Version="5.0.0" />
-		<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="1.0.0" />
+		<PackageReference Include="Microsoft.Extensions.Primitives" Version="6.0.0" />
+		<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="7.0.0" />
 		<PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
-		<PackageReference Include="xunit.core" Version="2.4.2" />
-		<PackageReference Include="Microsoft.AspNetCore.Http.Abstractions" Version="2.2.0" />
 		<PackageReference Include="Mono.Posix.NETStandard" Version="1.0.0" />
-	</ItemGroup>
-	<ItemGroup>
-		<Folder Include="Extensions\" />
-		<Folder Include="Linux\" />
-		<Folder Include="Models\" />
-		<Folder Include="Options\" />
+		<PackageReference Include="NUnit" Version="3.13.3" />
 	</ItemGroup>
 	<ItemGroup>
 		<ProjectReference Include="..\PuppeteerSharp.Nunit\PuppeteerSharp.Nunit.csproj" />
 	</ItemGroup>
-	<ItemGroup>
-	  <None Remove="Microsoft.Bcl.AsyncInterfaces" />
-	  <None Remove="Newtonsoft.Json" />
-	  <None Remove="xunit.core" />
-	  <None Remove="Microsoft.AspNetCore.Http.Abstractions" />
-	  <None Remove="Mono.Posix.NETStandard" />
-	</ItemGroup>
 </Project>

lib/PuppeteerSharp/FrameManager.cs

@@ -64,13 +64,16 @@ public async Task<IResponse> NavigateFrameAsync(Frame frame, string url, Navigat
             var referrer = string.IsNullOrEmpty(options.Referer)
                ? NetworkManager.ExtraHTTPHeaders?.GetValueOrDefault(RefererHeaderName)
                : options.Referer;
+            var referrerPolicy = string.IsNullOrEmpty(options.ReferrerPolicy)
+                ? NetworkManager.ExtraHTTPHeaders?.GetValueOrDefault("referer-policy")
+                : options.ReferrerPolicy;
             var timeout = options?.Timeout ?? TimeoutSettings.NavigationTimeout;
 
             using (var watcher = new LifecycleWatcher(this, frame, options?.WaitUntil, timeout))
             {
                 try
                 {
-                    var navigateTask = NavigateAsync(Client, url, referrer, frame.Id);
+                    var navigateTask = NavigateAsync(Client, url, referrer, referrerPolicy, frame.Id);
                     var task = await Task.WhenAny(
                         watcher.TimeoutOrTerminationTask,
                         navigateTask).ConfigureAwait(false);
@@ -189,12 +192,13 @@ internal ExecutionContext GetExecutionContextById(int contextId, CDPSession sess
             return context;
         }
 
-        private async Task NavigateAsync(CDPSession client, string url, string referrer, string frameId)
+        private async Task NavigateAsync(CDPSession client, string url, string referrer, string referrerPolicy, string frameId)
         {
             var response = await client.SendAsync<PageNavigateResponse>("Page.navigate", new PageNavigateRequest
             {
                 Url = url,
                 Referrer = referrer ?? string.Empty,
+                ReferrerPolicy = referrerPolicy ?? string.Empty,
                 FrameId = frameId,
             }).ConfigureAwait(false);
 

lib/PuppeteerSharp/Messaging/PageNavigateRequest.cs

@@ -7,5 +7,7 @@ internal class PageNavigateRequest
         public string Referrer { get; set; }
 
         public string FrameId { get; set; }
+
+        public string ReferrerPolicy { get; set; }
     }
 }

lib/PuppeteerSharp/NavigationOptions.cs

@@ -23,5 +23,10 @@ public class NavigationOptions
         /// </summary>
         /// <value>The referer.</value>
         public string Referer { get; set; }
+
+        /// <summary>
+        /// Referrer policy. If provided it will take preference over the referer-policy header value set by <see cref="IPage.SetExtraHttpHeadersAsync(System.Collections.Generic.Dictionary{string, string})"/>.
+        /// </summary>
+        public string ReferrerPolicy { get; set; }
     }
 }