Add comment about the undefined body hack

grafana · Mar 1, 2022 · d18db70 · d18db70
1 parent 7cd7bc4
commit d18db70
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/js/modules/k6/http/http.go b/js/modules/k6/http/http.go
@@ -89,11 +89,15 @@ func (r *RootModule) NewModuleInstance(vu modules.VU) modules.Instance {
 	// wrappers (facades) that convert the old k6 idiosyncratic APIs to the new
 	// proper Client ones that accept Request objects and don't suck
 	mustExport("get", func(url goja.Value, args ...goja.Value) (*Response, error) {
-		args = append([]goja.Value{goja.Undefined()}, args...) // sigh
+		// http.get(url, params) doesn't have a body argument, so we add undefined
+		// as the third argument to http.request(method, url, body, params)
+		args = append([]goja.Value{goja.Undefined()}, args...)
 		return mi.defaultClient.Request(http.MethodGet, url, args...)
 	})
 	mustExport("head", func(url goja.Value, args ...goja.Value) (*Response, error) {
-		args = append([]goja.Value{goja.Undefined()}, args...) // sigh
+		// http.head(url, params) doesn't have a body argument, so we add undefined
+		// as the third argument to http.request(method, url, body, params)
+		args = append([]goja.Value{goja.Undefined()}, args...)
 		return mi.defaultClient.Request(http.MethodHead, url, args...)
 	})
 	mustExport("post", mi.defaultClient.getMethodClosure(http.MethodPost))