DYN-2239 Set the UserAgent for HttpWebRequest (#11293) (#11325)

QilongTang · StudioLE · web-flow · commit e919f17f685c · 2020-12-04T01:37:19.000-05:00
* Set the UserAgent for HttpWebRequest

* Added WebRequest_GitHubAPI test

* Replaced WebRequest_ValidArgs test. Added comment. Revised GitHub API endpoint.

Co-authored-by: Laurence Elsdon &lt;laurence.elsdon@matterlab.co&gt;
diff --git a/src/Libraries/CoreNodes/Web.cs b/src/Libraries/CoreNodes/Web.cs
@@ -28,6 +28,10 @@ public static string WebRequestByUrl(string url)
             // Initialize the WebRequest.
             var myRequest = System.Net.WebRequest.Create(uriResult);
 
+            // Set the User-Agent header required by some APIs
+            if (myRequest is System.Net.HttpWebRequest httpRequest)
+                httpRequest.UserAgent = "Dynamo";
+
             string responseFromServer;
 
             // Return the response. 
diff --git a/test/Libraries/CoreNodesTests/WebTests.cs b/test/Libraries/CoreNodesTests/WebTests.cs
@@ -9,24 +9,25 @@ class WebTests
     {
         [Test]
         [Category("UnitTests")]
-        public void WebRequest_ValidArgs()
+        public void WebRequest_BadArgs()
         {
-            var result = Web.WebRequestByUrl("https://www.google.com");
-            Assert.IsNotNullOrEmpty(result);
+            Assert.Throws<UriFormatException>(()=>Web.WebRequestByUrl("ThisIsNotAUrl"));
         }
 
         [Test]
         [Category("UnitTests")]
-        public void WebRequest_BadArgs()
+        public void WebRequest_EmptyUrl()
         {
-            Assert.Throws<UriFormatException>(()=>Web.WebRequestByUrl("ThisIsNotAUrl"));
+            Assert.Throws<ArgumentException>(() => Web.WebRequestByUrl(""));
         }
 
         [Test]
         [Category("UnitTests")]
-        public void WebRequest_EmptyUrl()
+        public void WebRequest_GitHubAPI()
         {
-            Assert.Throws<ArgumentException>(() => Web.WebRequestByUrl(""));
+            string url = "https://api.github.com/rate_limit";
+            string result = Web.WebRequestByUrl(url);
+            Assert.IsNotNullOrEmpty(result);
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -9,24 +9,25 @@ class WebTests`
`9`	`9`	`{`
`10`	`10`	`[Test]`
`11`	`11`	`[Category("UnitTests")]`
`12`		`- public void WebRequest_ValidArgs()`
	`12`	`+ public void WebRequest_BadArgs()`
`13`	`13`	`{`
`14`		`- var result = Web.WebRequestByUrl("https://www.google.com");`
`15`		`- Assert.IsNotNullOrEmpty(result);`
	`14`	`+ Assert.Throws<UriFormatException>(()=>Web.WebRequestByUrl("ThisIsNotAUrl"));`
`16`	`15`	`}`
`17`	`16`
`18`	`17`	`[Test]`
`19`	`18`	`[Category("UnitTests")]`
`20`		`- public void WebRequest_BadArgs()`
	`19`	`+ public void WebRequest_EmptyUrl()`
`21`	`20`	`{`
`22`		`- Assert.Throws<UriFormatException>(()=>Web.WebRequestByUrl("ThisIsNotAUrl"));`
	`21`	`+ Assert.Throws<ArgumentException>(() => Web.WebRequestByUrl(""));`
`23`	`22`	`}`
`24`	`23`
`25`	`24`	`[Test]`
`26`	`25`	`[Category("UnitTests")]`
`27`		`- public void WebRequest_EmptyUrl()`
	`26`	`+ public void WebRequest_GitHubAPI()`
`28`	`27`	`{`
`29`		`- Assert.Throws<ArgumentException>(() => Web.WebRequestByUrl(""));`
	`28`	`+ string url = "https://api.github.com/rate_limit";`
	`29`	`+ string result = Web.WebRequestByUrl(url);`
	`30`	`+ Assert.IsNotNullOrEmpty(result);`
`30`	`31`	`}`
`31`	`32`	`}`
`32`	`33`	`}`