Merge pull request #11 from speakeasy-api/fix-time-precision

TristanSpeakEasy · web-flow · commit 8a80d77b59f7 · 2022-08-04T18:43:19.000+01:00
fix: time precision
diff --git a/capture.go b/capture.go
@@ -133,7 +133,7 @@ func (s *speakeasy) buildHarFile(ctx context.Context, cw *captureWriter, r *http
 			Comment: "request capture for " + r.URL.String(),
 			Entries: []*har.Entry{
 				{
-					StartedDateTime: startTime.Format(time.RFC3339),
+					StartedDateTime: startTime.Format(time.RFC3339Nano),
 					Time:            float64(timeSince(startTime).Milliseconds()),
 					Request:         s.getHarRequest(ctx, cw, r),
 					Response:        s.getHarResponse(ctx, cw, r, startTime),
@@ -286,9 +286,9 @@ func getHarCookies(cookies []*http.Cookie, startTime time.Time) []*har.Cookie {
 		}
 
 		if cookie.MaxAge != 0 {
-			harCookie.Expires = startTime.Add(time.Duration(cookie.MaxAge) * time.Second).Format(time.RFC3339)
+			harCookie.Expires = startTime.Add(time.Duration(cookie.MaxAge) * time.Second).Format(time.RFC3339Nano)
 		} else if (cookie.Expires != time.Time{}) {
-			harCookie.Expires = cookie.Expires.Format(time.RFC3339)
+			harCookie.Expires = cookie.Expires.Format(time.RFC3339Nano)
 		}
 
 		harCookies = append(harCookies, harCookie)
diff --git a/middleware_test.go b/middleware_test.go
@@ -38,13 +38,15 @@ type fields struct {
 	MaxCaptureSize int `json:"max_capture_size,omitempty"`
 }
 type args struct {
-	Method          string              `json:"method"`
-	URL             string              `json:"url"`
-	Headers         map[string][]string `json:"headers,omitempty"`
-	Body            string              `json:"body,omitempty"`
-	ResponseStatus  int                 `json:"response_status,omitempty"`
-	ResponseBody    string              `json:"response_body,omitempty"`
-	ResponseHeaders map[string][]string `json:"response_headers,omitempty"`
+	Method           string              `json:"method"`
+	URL              string              `json:"url"`
+	Headers          map[string][]string `json:"headers"`
+	Body             string              `json:"body"`
+	RequestStartTime time.Time           `json:"request_start_time"`
+	ElapsedTime      int                 `json:"elapsed_time"`
+	ResponseStatus   int                 `json:"response_status"`
+	ResponseBody     string              `json:"response_body"`
+	ResponseHeaders  map[string][]string `json:"response_headers"`
 }
 type test struct {
 	Name    string `json:"name"`
@@ -96,8 +98,16 @@ func TestSpeakeasy_Middleware_Capture_Success(t *testing.T) {
 			captured := false
 			handled := false
 
-			speakeasy.ExportSetTimeNow(time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC))
-			speakeasy.ExportSetTimeSince(1 * time.Millisecond)
+			if tt.Args.RequestStartTime.IsZero() {
+				speakeasy.ExportSetTimeNow(time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC))
+			} else {
+				speakeasy.ExportSetTimeNow(tt.Args.RequestStartTime)
+			}
+			if tt.Args.ElapsedTime == 0 {
+				speakeasy.ExportSetTimeSince(1 * time.Millisecond)
+			} else {
+				speakeasy.ExportSetTimeSince(time.Duration(tt.Args.ElapsedTime) * time.Millisecond)
+			}
 
 			wg := &sync.WaitGroup{}
 			wg.Add(1)
@@ -386,8 +396,16 @@ func TestSpeakeasy_GinMiddleware_Success(t *testing.T) {
 			captured := false
 			handled := false
 
-			speakeasy.ExportSetTimeNow(time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC))
-			speakeasy.ExportSetTimeSince(1 * time.Millisecond)
+			if tt.Args.RequestStartTime.IsZero() {
+				speakeasy.ExportSetTimeNow(time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC))
+			} else {
+				speakeasy.ExportSetTimeNow(tt.Args.RequestStartTime)
+			}
+			if tt.Args.ElapsedTime == 0 {
+				speakeasy.ExportSetTimeSince(1 * time.Millisecond)
+			} else {
+				speakeasy.ExportSetTimeSince(time.Duration(tt.Args.ElapsedTime) * time.Millisecond)
+			}
 
 			wg := &sync.WaitGroup{}
 			wg.Add(1)
@@ -552,8 +570,16 @@ func TestSpeakeasy_EchoMiddleware_Success(t *testing.T) {
 			captured := false
 			handled := false
 
-			speakeasy.ExportSetTimeNow(time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC))
-			speakeasy.ExportSetTimeSince(1 * time.Millisecond)
+			if tt.Args.RequestStartTime.IsZero() {
+				speakeasy.ExportSetTimeNow(time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC))
+			} else {
+				speakeasy.ExportSetTimeNow(tt.Args.RequestStartTime)
+			}
+			if tt.Args.ElapsedTime == 0 {
+				speakeasy.ExportSetTimeSince(1 * time.Millisecond)
+			} else {
+				speakeasy.ExportSetTimeSince(time.Duration(tt.Args.ElapsedTime) * time.Millisecond)
+			}
 
 			wg := &sync.WaitGroup{}
 			wg.Add(1)
diff --git a/speakeasy.go b/speakeasy.go
@@ -15,7 +15,7 @@ const (
 )
 
 var (
-	speakeasyVersion = "0.0.2" // TODO get this from CI
+	speakeasyVersion = "0.0.3" // TODO get this from CI
 	serverURL        = "https://api.speakeasyapi.dev"
 
 	defaultInstance *speakeasy
diff --git a/testdata/captures_basic_request_and_no_response_body_output.json b/testdata/captures_basic_request_and_no_response_body_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/captures_basic_request_and_response_output.json b/testdata/captures_basic_request_and_response_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/captures_basic_request_and_response_with_different_content_types_output.json b/testdata/captures_basic_request_and_response_with_different_content_types_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/captures_basic_request_and_response_with_no_response_header_set_output.json b/testdata/captures_basic_request_and_response_with_no_response_header_set_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/captures_basic_request_with_nano_precision_input.json b/testdata/captures_basic_request_with_nano_precision_input.json
@@ -0,0 +1,14 @@
+{
+    "name": "captures basic request with nano precision",
+    "fields": {
+        "max_capture_size": 9437184
+    },
+    "args": {
+        "method": "GET",
+        "url": "http://test.com/test",
+        "request_start_time": "2020-01-01T00:00:00.0000005Z",
+        "elapsed_time": 2,
+        "response_status": 200,
+        "response_body": "test"
+    }
+}
diff --git a/testdata/captures_basic_request_with_nano_precision_output.json b/testdata/captures_basic_request_with_nano_precision_output.json
@@ -0,0 +1,44 @@
+{
+    "log": {
+        "version": "1.2",
+        "creator": {
+            "name": "speakeasy-go-sdk",
+            "version": "0.0.3"
+        },
+        "entries": [
+            {
+                "startedDateTime": "2020-01-01T00:00:00.0000005Z",
+                "time": 2,
+                "request": {
+                    "method": "GET",
+                    "url": "http://test.com/test",
+                    "httpVersion": "HTTP/1.1",
+                    "cookies": [],
+                    "headers": [],
+                    "queryString": [],
+                    "headersSize": 0,
+                    "bodySize": 0
+                },
+                "response": {
+                    "status": 200,
+                    "statusText": "OK",
+                    "httpVersion": "HTTP/1.1",
+                    "cookies": [],
+                    "headers": [],
+                    "content": {
+                        "size": 4,
+                        "mimeType": "application/octet-stream",
+                        "text": "test"
+                    },
+                    "redirectURL": "",
+                    "headersSize": 0,
+                    "bodySize": 4
+                },
+                "cache": null,
+                "timings": null,
+                "serverIPAddress": "test.com"
+            }
+        ],
+        "comment": "request capture for http://test.com/test"
+    }
+}
diff --git a/testdata/captures_body_size_zero_when_cached_output.json b/testdata/captures_body_size_zero_when_cached_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/captures_cookies_output.json b/testdata/captures_cookies_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/captures_post_request_with_body_output.json b/testdata/captures_post_request_with_body_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/captures_query_params_output.json b/testdata/captures_query_params_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/captures_redirect_output.json b/testdata/captures_redirect_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/drops_request_and_response_bodies_when_request_body_too_large_output.json b/testdata/drops_request_and_response_bodies_when_request_body_too_large_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {
diff --git a/testdata/drops_response_body_when_too_large_output.json b/testdata/drops_response_body_when_too_large_output.json
@@ -3,7 +3,7 @@
         "version": "1.2",
         "creator": {
             "name": "speakeasy-go-sdk",
-            "version": "0.0.2"
+            "version": "0.0.3"
         },
         "entries": [
             {

Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ func (s speakeasy) buildHarFile(ctx context.Context, cw captureWriter, r *http`
`133`	`133`	`Comment: "request capture for " + r.URL.String(),`
`134`	`134`	`Entries: []*har.Entry{`
`135`	`135`	`{`
`136`		`- StartedDateTime: startTime.Format(time.RFC3339),`
	`136`	`+ StartedDateTime: startTime.Format(time.RFC3339Nano),`
`137`	`137`	`Time: float64(timeSince(startTime).Milliseconds()),`
`138`	`138`	`Request: s.getHarRequest(ctx, cw, r),`
`139`	`139`	`Response: s.getHarResponse(ctx, cw, r, startTime),`
`@@ -286,9 +286,9 @@ func getHarCookies(cookies []http.Cookie, startTime time.Time) []har.Cookie {`
`286`	`286`	`}`
`287`	`287`
`288`	`288`	`if cookie.MaxAge != 0 {`
`289`		`- harCookie.Expires = startTime.Add(time.Duration(cookie.MaxAge) * time.Second).Format(time.RFC3339)`
	`289`	`+ harCookie.Expires = startTime.Add(time.Duration(cookie.MaxAge) * time.Second).Format(time.RFC3339Nano)`
`290`	`290`	`} else if (cookie.Expires != time.Time{}) {`
`291`		`- harCookie.Expires = cookie.Expires.Format(time.RFC3339)`
	`291`	`+ harCookie.Expires = cookie.Expires.Format(time.RFC3339Nano)`
`292`	`292`	`}`
`293`	`293`
`294`	`294`	`harCookies = append(harCookies, harCookie)`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ const (`
`15`	`15`	`)`
`16`	`16`
`17`	`17`	`var (`
`18`		`- speakeasyVersion = "0.0.2" // TODO get this from CI`
	`18`	`+ speakeasyVersion = "0.0.3" // TODO get this from CI`
`19`	`19`	`serverURL = "https://api.speakeasyapi.dev"`
`20`	`20`
`21`	`21`	`defaultInstance *speakeasy`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"version": "1.2",`
`4`	`4`	`"creator": {`
`5`	`5`	`"name": "speakeasy-go-sdk",`
`6`		`- "version": "0.0.2"`
	`6`	`+ "version": "0.0.3"`
`7`	`7`	`},`
`8`	`8`	`"entries": [`
`9`	`9`	`{`