Be more resilient to plain text errors (#1227)

* Always parse JSON error, store it in BDD

* Regenerate client from commit 60c6582 of spec repo

Co-authored-by: Thomas Hervé <[email protected]>
Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-11-26 10:29:43.003956",
-            "spec_repo_commit": "fdabc88"
+            "regenerated": "2021-11-29 17:29:19.610352",
+            "spec_repo_commit": "60c6582"
         },
         "v2": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2021-11-26 10:29:43.022631",
-            "spec_repo_commit": "fdabc88"
+            "regenerated": "2021-11-29 17:29:19.629845",
+            "spec_repo_commit": "60c6582"
         }
     }
 }

.generator/templates/client.mustache

@@ -467,21 +467,18 @@ func (c *APIClient) decode(v interface{}, b []byte, contentType string) (err err
 		}
 		return nil
 	}
-	if jsonCheck.MatchString(contentType) {
-		if actualObj, ok := v.(interface{ GetActualInstance() interface{} }); ok { // oneOf, anyOf schemas
-			if unmarshalObj, ok := actualObj.(interface{ UnmarshalJSON([]byte) error }); ok { // make sure it has UnmarshalJSON defined
-				if err = unmarshalObj.UnmarshalJSON(b); err != nil {
-					return err
-				}
-			} else {
-				return errors.New("Unknown type with GetActualInstance but no unmarshalObj.UnmarshalJSON defined")
+	if actualObj, ok := v.(interface{ GetActualInstance() interface{} }); ok { // oneOf, anyOf schemas
+		if unmarshalObj, ok := actualObj.(interface{ UnmarshalJSON([]byte) error }); ok { // make sure it has UnmarshalJSON defined
+			if err = unmarshalObj.UnmarshalJSON(b); err != nil {
+				return err
 			}
-		} else if err = json.Unmarshal(b, v); err != nil { // simple model
-			return err
+		} else {
+			return errors.New("Unknown type with GetActualInstance but no unmarshalObj.UnmarshalJSON defined")
 		}
-		return nil
+	} else if err = json.Unmarshal(b, v); err != nil { // simple model
+		return err
 	}
-	return errors.New("undefined response type")
+	return nil
 }
 
 // Add a file to the multipart request

api/v1/datadog/client.go

@@ -0,0 +1 @@
+2021-11-27T20:34:41.465Z

api/v2/datadog/client.go

@@ -0,0 +1,47 @@
+interactions:
+- request:
+    body: |
+      {"date_happened":1,"tags":["test:TestPostaneventinthepastreturnsBadRequestresponse1638045281"],"text":"A text message.","title":"Test-Post_an_event_in_the_past_returns_Bad_Request_response-1638045281"}
+    form: {}
+    headers:
+      Accept:
+      - application/json, */*;q=0.8
+      Connection:
+      - close
+      Content-Length:
+      - '201'
+      Content-Type:
+      - application/json
+      Host:
+      - api.datadoghq.com
+      User-Agent:
+      - datadog-api-client-typescript/1.0.0-beta.6 (node 14.18.1; os Linux; arch x64)
+      X-Datadog-Parent-Id:
+      - '343467568446934486'
+      X-Datadog-Trace-Id:
+      - '4038788092229867157'
+    method: POST
+    url: https://api.datadoghq.com/api/v1/events
+  response:
+    body: '{"errors": ["Event too far in the past"]}'
+    code: 400
+    duration: ''
+    headers:
+      Connection:
+      - close
+      Content-Length:
+      - '41'
+      Content-Security-Policy:
+      - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report
+      Content-Type:
+      - text/plain; charset=utf-8
+      Date:
+      - Sat, 27 Nov 2021 20:34:41 GMT
+      Strict-Transport-Security:
+      - max-age=15724800;
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - SAMEORIGIN
+    status: 400 Bad Request
+version: 1

tests/scenarios/cassettes/TestScenarios/v1/Feature_Events/Scenario_Post_an_event_in_the_past_returns_Bad_Request_response.freeze

@@ -44,6 +44,13 @@ Feature: Events
     When the request is sent
     Then the response status is 202 OK
 
+  Scenario: Post an event in the past returns "Bad Request" response
+    Given new "CreateEvent" request
+    And body with value {"title": "{{ unique }}", "text": "A text message.", "date_happened": 1, "tags": ["test:{{ unique_alnum }}"]}
+    When the request is sent
+    Then the response status is 400 Bad Request
+    And the response "errors[0]" is equal to "Event too far in the past"
+
   @generated @skip
   Scenario: Query the event stream returns "Bad Request" response
     Given a valid "appKeyAuth" key in the system

tests/scenarios/cassettes/TestScenarios/v1/Feature_Events/Scenario_Post_an_event_in_the_past_returns_Bad_Request_response.yaml

@@ -229,10 +229,26 @@ func requestIsSent(t gobdd.StepTest, ctx gobdd.Context) {
 		if code < 300 && err != nil {
 			t.Errorf("unexpected error: %v", err)
 		}
-		// Store the unmarshalled JSON in context
-		responseJSON, err := toJSON(result[0])
+		var responseJSON interface{}
 		if err != nil {
-			t.Errorf("Unable to decode response object to JSON: %v", err)
+			version := GetVersion(ctx)
+			if version == "v1" {
+				err := err.(v1.GenericOpenAPIError)
+				if newErr := json.Unmarshal(err.Body(), &responseJSON); newErr != nil {
+					t.Errorf("Unable to decode response object to JSON: %v", newErr)
+				}
+			} else {
+				err := err.(v2.GenericOpenAPIError)
+				if newErr := json.Unmarshal(err.Body(), &responseJSON); newErr != nil {
+					t.Errorf("Unable to decode response object to JSON: %v", newErr)
+				}
+			}
+		} else {
+			// Store the unmarshalled JSON in context
+			responseJSON, err = toJSON(result[0])
+			if err != nil {
+				t.Errorf("Unable to decode response object to JSON: %v", err)
+			}
 		}
 		ctx.Set(jsonResponseKey{}, responseJSON)
 	}