Refactor error handling to remove duplication (#834)

Author: therve

.generator/src/generator/cli.py

@@ -42,6 +42,7 @@ def cli(specs, output):
     env.filters["form_parameter"] = openapi.form_parameter
     env.filters["untitle_case"] = formatter.untitle_case
     env.filters["response_type"] = openapi.get_type_for_response
+    env.filters["responses_by_types"] = openapi.responses_by_types
     env.filters["docstring"] = formatter.docstring
 
     env.globals["get_references_for_model"] = openapi.get_references_for_model

.generator/src/generator/openapi.py

@@ -339,6 +339,17 @@ def get_type_for_response(response):
                 return type_to_typescript(content["schema"])
 
 
+def responses_by_types(operation):
+    result = {}
+    for response_code, response in operation["responses"].items():
+        response_type = get_type_for_response(response)
+        if response_type in result:
+            result[response_type][1].append(response_code)
+        else:
+            result[response_type] = [response, [response_code]]
+    return result.items()
+
+
 def return_type(operation):
     for response in operation.get("responses", {}).values():
         for content in response.get("content", {}).values():

.generator/src/generator/templates/api/api.j2

@@ -12,7 +12,6 @@ import FormData from "form-data";
 import { logger } from "../../../logger";
 import { ObjectSerializer } from "../models/ObjectSerializer";
 import { ApiException } from "../../datadog-api-client-common/exception";
-import { isCodeInRange } from "../../datadog-api-client-common/util";
 
 {% for model in get_api_models(operations)|sort %}
 import { {{ model }} } from "../models/{{ model }}";
@@ -163,26 +162,29 @@ export class {{ className }}ResponseProcessor {
    */
    public async {{ operationId }}(response: ResponseContext): Promise<{%- if returnType %}{{ returnType }} {%- else %}void{%-endif %}> {
     const contentType = ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
-    {%- for responseCode, response in operation.responses.items() %}
+    {%- for responseType, (response, responseCodes) in operation|responses_by_types %}
     {%- set responseSchema = response|parameter_schema %}
-    {%- set reponseType = response|response_type %}
-    if (isCodeInRange("{{ responseCode }}", response.httpStatusCode)) {
-      {%- if reponseType %}
+    if (
+      {%- for responseCode in responseCodes -%}
+      {%- if not loop.first -%} || {%- endif -%} response.httpStatusCode == {{ responseCode }}
+      {%- endfor -%}
+      ) {
+      {%- if responseType %}
       {%- if responseSchema and responseSchema.get("format") == "binary" %}
-      const body: {{ reponseType }} = await response.getBodyAsFile() as {{ returnType }};
+      const body: {{ responseType }} = await response.getBodyAsFile() as {{ returnType }};
       {%- else %}
-      const body: {{ reponseType }} = ObjectSerializer.deserialize(
+      const body: {{ responseType }} = ObjectSerializer.deserialize(
         ObjectSerializer.parse(await response.body.text(), contentType),
-        "{{ reponseType }}", "{{ responseSchema.get("format", "") }}"
-      ) as {{ reponseType }};
+        "{{ responseType }}"
+      ) as {{ responseType }};
       {%- endif %}
-      {%- if responseCode.startswith("2") %}
+      {%- if responseCodes[0].startswith("2") %}
       return body;
       {%- else %}
-      throw new ApiException<{{ reponseType }}>({{ responseCode }}, body);
+      throw new ApiException<{{ responseType }}>(response.httpStatusCode, body);
       {%- endif %}
       {%- else %}
-      {%- if responseCode.startswith("2") %}
+      {%- if responseCodes[0].startswith("2") %}
       return;
       {%- else %}
       throw new ApiException<string>(response.httpStatusCode, "{{ responseSchema.description }}");

.generator/src/generator/templates/util.j2

@@ -1,31 +1,3 @@
-/**
- * Returns if a specific http code is in a given code range
- * where the code range is defined as a combination of digits
- * and "X" (the letter X) with a length of 3
- *
- * @param codeRange string with length 3 consisting of digits and "X" (the letter X)
- * @param code the http status code to be checked against the code range
- */
-export function isCodeInRange(codeRange: string, code: number): boolean {
-  // This is how the default value is encoded in OAG
-  if (codeRange === "0") {
-    return true;
-  }
-  if (codeRange == code.toString()) {
-    return true;
-  } else {
-    const codeString = code.toString();
-    if (codeString.length != codeRange.length) {
-      return false;
-    }
-    for (let i = 0; i < codeString.length; i++) {
-      if (codeRange.charAt(i) != "X" && codeRange.charAt(i) != codeString.charAt(i)) {
-        return false;
-      }
-    }
-    return true;
-  }
-}
 
 export class UnparsedObject {
   unparsedObject:any;

packages/datadog-api-client-common/util.ts

@@ -1,35 +1,3 @@
-/**
- * Returns if a specific http code is in a given code range
- * where the code range is defined as a combination of digits
- * and "X" (the letter X) with a length of 3
- *
- * @param codeRange string with length 3 consisting of digits and "X" (the letter X)
- * @param code the http status code to be checked against the code range
- */
-export function isCodeInRange(codeRange: string, code: number): boolean {
-  // This is how the default value is encoded in OAG
-  if (codeRange === "0") {
-    return true;
-  }
-  if (codeRange == code.toString()) {
-    return true;
-  } else {
-    const codeString = code.toString();
-    if (codeString.length != codeRange.length) {
-      return false;
-    }
-    for (let i = 0; i < codeString.length; i++) {
-      if (
-        codeRange.charAt(i) != "X" &&
-        codeRange.charAt(i) != codeString.charAt(i)
-      ) {
-        return false;
-      }
-    }
-    return true;
-  }
-}
-
 export class UnparsedObject {
   unparsedObject: any;
   constructor(data: any) {