Create a common package (#680)

* Move common files

This creates a new package containing classes shared between v1 and v2.

* Fix tests

* Fix unstable

* Fix operation servers

* Fix examples

* Update docs

* Rebase

* Rebase

* Rebase

Author: therve

.generator/src/generator/cli.py

@@ -11,23 +11,20 @@
 
 
 @click.command()
-@click.option(
-    "-i",
-    "--input",
+@click.argument(
+    "specs",
+    nargs=-1,
     type=click.Path(exists=True, file_okay=True, dir_okay=False, path_type=pathlib.Path),
 )
 @click.option(
     "-o",
     "--output",
     type=click.Path(path_type=pathlib.Path),
 )
-def cli(input, output):
+def cli(specs, output):
     """
     Generate a Typescript code snippet from OpenAPI specification.
     """
-    spec = openapi.load(input)
-
-    version = input.parent.name
 
     env = Environment(loader=FileSystemLoader(str(pathlib.Path(__file__).parent / "templates")))
 
@@ -51,8 +48,6 @@ def cli(input, output):
     env.globals["package_name"] = package_name
     env.globals["npm_name"] = npm_name
     env.globals["enumerate"] = enumerate
-    env.globals["version"] = version
-    env.globals["openapi"] = spec
     env.globals["get_name"] = openapi.get_name
     env.globals["type_to_typescript"] = openapi.type_to_typescript
     env.globals["get_type_for_attribute"] = openapi.get_type_for_attribute
@@ -69,49 +64,65 @@ def cli(input, output):
 
     api_j2 = env.get_template("api/api.j2")
     model_j2 = env.get_template("model/model.j2")
-    configuration_j2 = env.get_template("configuration.j2")
-    servers_j2 = env.get_template("servers.j2")
 
     extra_files = {
-        "util.ts": env.get_template("util.j2"),
-        "apis/baseapi.ts": env.get_template("api/baseapi.j2"),
-        "apis/exception.ts": env.get_template("api/exception.j2"),
-        "auth/auth.ts": env.get_template("auth/auth.j2"),
         "models/ObjectSerializer.ts": env.get_template("model/ObjectSerializer.j2"),
-        "http/http.ts": env.get_template("http/http.j2"),
-        "http/isomorphic-fetch.ts": env.get_template("http/isomorphic-fetch.j2"),
         "index.ts": env.get_template("index.j2"),
     }
 
-    apis = openapi.apis(spec)
-    models = openapi.models(spec)
+    all_specs = {}
+    all_apis = {}
+    for spec_path in specs:
+        spec = openapi.load(spec_path)
 
-    package_path = output / f"{package_name}-{version}"
+        version = spec_path.parent.name
 
-    for name, model in models.items():
-        filename = name + ".ts"
-        model_path = package_path / "models" / filename
-        model_path.parent.mkdir(parents=True, exist_ok=True)
-        with model_path.open("w+") as fp:
-            fp.write(model_j2.render(name=name, model=model))
+        env.globals["version"] = version
+        env.globals["openapi"] = spec
 
-    for name, operations in apis.items():
-        filename = name.replace(" ", "") + "Api.ts"
-        api_path = package_path / "apis" / filename
-        api_path.parent.mkdir(parents=True, exist_ok=True)
-        with api_path.open("w+") as fp:
-            fp.write(api_j2.render(name=name, operations=operations, models=models))
+        all_specs[version] = spec
 
-    for name, template in extra_files.items():
-        filename = package_path / name
-        filename.parent.mkdir(parents=True, exist_ok=True)
-        with filename.open("w+") as fp:
-            fp.write(template.render(apis=apis, models=models))
+        apis = openapi.apis(spec)
+        models = openapi.models(spec)
+
+        all_apis[version] = apis
+
+        package_path = output / f"{package_name}-{version}"
 
-    configuration_path = package_path / "configuration.ts"
-    with configuration_path.open("w+") as fp:
-        fp.write(configuration_j2.render())
+        for name, model in models.items():
+            filename = name + ".ts"
+            model_path = package_path / "models" / filename
+            model_path.parent.mkdir(parents=True, exist_ok=True)
+            with model_path.open("w+") as fp:
+                fp.write(model_j2.render(name=name, model=model))
 
-    servers_path = package_path / "servers.ts"
-    with servers_path.open("w+") as fp:
-        fp.write(servers_j2.render(apis=apis, operations=operations))
+        for name, operations in apis.items():
+            filename = name.replace(" ", "") + "Api.ts"
+            api_path = package_path / "apis" / filename
+            api_path.parent.mkdir(parents=True, exist_ok=True)
+            with api_path.open("w+") as fp:
+                fp.write(api_j2.render(name=name, operations=operations, models=models))
+
+        for name, template in extra_files.items():
+            filename = package_path / name
+            filename.parent.mkdir(parents=True, exist_ok=True)
+            with filename.open("w+") as fp:
+                fp.write(template.render(apis=apis, models=models))
+
+    common_files = {
+        "util.ts": env.get_template("util.j2"),
+        "baseapi.ts": env.get_template("api/baseapi.j2"),
+        "exception.ts": env.get_template("api/exception.j2"),
+        "auth.ts": env.get_template("auth/auth.j2"),
+        "http/http.ts": env.get_template("http/http.j2"),
+        "http/isomorphic-fetch.ts": env.get_template("http/isomorphic-fetch.j2"),
+        "servers.ts": env.get_template("servers.j2"),
+        "configuration.ts": env.get_template("configuration.j2"),
+        "index.ts": env.get_template("common_index.j2"),
+    }
+
+    for name, template in common_files.items():
+        filename = output / "datadog-api-client-common" / name
+        filename.parent.mkdir(parents=True, exist_ok=True)
+        with filename.open("w+") as fp:
+            fp.write(template.render(apis=all_apis))

.generator/src/generator/formatter.py

@@ -426,7 +426,7 @@ def get_response_type(schema, version):
 
     response_schema = list(schema["content"].values())[0]["schema"]
     if response_schema.get("format") == "binary":
-        return f"{version}.HttpFile"
+        return "client.HttpFile"
 
     if response_schema.get("type") == "array":
         nested_schema = response_schema.get("items")

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

@@ -1,18 +1,18 @@
-import { BaseAPIRequestFactory, RequiredError } from "./baseapi";
-import { Configuration, getServer, applySecurityAuthentication} from "../configuration";
+import { BaseAPIRequestFactory, RequiredError } from "../../datadog-api-client-common/baseapi";
+import { Configuration, getServer, applySecurityAuthentication} from "../../datadog-api-client-common/configuration";
 import {
   RequestContext,
   HttpMethod,
   ResponseContext,
   HttpFile
-  } from "../http/http";
+  } from "../../datadog-api-client-common/http/http";
 
 import FormData from "form-data";
 
 import { logger } from "../../../logger";
 import { ObjectSerializer } from "../models/ObjectSerializer";
-import { ApiException } from "./exception";
-import { isCodeInRange } from "../util";
+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 }}";
@@ -38,7 +38,7 @@ export class {{ className }}RequestFactory extends BaseAPIRequestFactory {
     {%- if "x-unstable" in operation %}
 
     logger.warn("Using unstable operation '{{ operationId }}'");
-    if (!_config.unstableOperations['{{ operationId }}']) {
+    if (!_config.unstableOperations['{{ version }}.{{ operationId }}']) {
       throw new Error("Unstable operation '{{ operationId }}' is disabled");
     }
     {%- endif %}
@@ -58,7 +58,7 @@ export class {{ className }}RequestFactory extends BaseAPIRequestFactory {
       {%- endfor %};
 
     // Make Request Context
-    const requestContext = getServer(_config, '{{ className }}.{{ operationId }}').makeRequestContext(localVarPath, HttpMethod.{{ method.upper() }});
+    const requestContext = getServer(_config, '{{ version }}.{{ className }}.{{ operationId }}').makeRequestContext(localVarPath, HttpMethod.{{ method.upper() }});
     {%- if operation|accept_headers|length == 0 %}
     requestContext.setHeaderParam("Accept", "application/json");
     {%- else %}

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

@@ -1,4 +1,4 @@
-import { Configuration } from "../configuration";
+import { Configuration } from "./configuration";
 
 /**
  *

.generator/src/generator/templates/auth/auth.j2

@@ -1,4 +1,4 @@
-import { RequestContext } from "../http/http";
+import { RequestContext } from "./http/http";
 
 /**
  * Interface authentication schemes.

.generator/src/generator/templates/common_index.j2

@@ -0,0 +1,9 @@
+export * from "./http/http";
+export * from "./http/isomorphic-fetch";
+export * from "./auth";
+export { createConfiguration } from "./configuration"
+export { setServerVariables } from "./configuration"
+export { Configuration } from "./configuration"
+export * from "./exception";
+export * from "./servers";
+

.generator/src/generator/templates/configuration.j2

@@ -1,7 +1,7 @@
 import { HttpLibrary, HttpConfiguration, RequestContext } from "./http/http";
 import { IsomorphicFetchHttpLibrary as DefaultHttpLibrary } from "./http/isomorphic-fetch";
 import { BaseServerConfiguration, server1, servers, operationServers } from "./servers";
-import { configureAuthMethods, AuthMethods, AuthMethodsConfiguration } from "./auth/auth";
+import { configureAuthMethods, AuthMethods, AuthMethodsConfiguration } from "./auth";
 
 export interface Configuration {
   readonly baseServer?: BaseServerConfiguration;
@@ -86,13 +86,15 @@ export function createConfiguration(conf: ConfigurationParameters = {}): Configu
     serverIndex: conf.serverIndex || 0,
     operationServerIndices: conf.operationServerIndices || {},
     unstableOperations: {
-    {%- for path in openapi.paths.values() %}
-    {%- for operation in path.values()|sort(attribute="operationId") %}
+    {%- for version, api in apis.items() %}
+    {%- for operations in api.values() %}
+    {%- for _, _, operation in operations|sort(attribute="2.operationId") %}
     {%- if "x-unstable" in operation %}
-    "{{ operation.operationId|untitle_case  }}": false,
+        "{{ version }}.{{ operation.operationId|untitle_case }}": false,
     {%- endif %}
     {%- endfor %}
     {%- endfor %}
+    {%- endfor %}
     },
     httpApi: conf.httpApi || new DefaultHttpLibrary(),
     authMethods: configureAuthMethods(authMethods),

.generator/src/generator/templates/example.j2

@@ -3,9 +3,9 @@
  */
 
 import * as fs from "fs";
-import { {{ version }} } from "@datadog/datadog-api-client";
+import { client, {{ version }} } from "@datadog/datadog-api-client";
 
-const configuration = {{ version }}.createConfiguration();
+const configuration = client.createConfiguration();
 {%- for operation in context._enable_operations %}
 configuration.unstableOperations["{{ operation|untitle_case }}"] = true;
 {%- endfor %}

.generator/src/generator/templates/index.j2

@@ -1,13 +1,3 @@
-export * from "./http/http";
-export * from "./http/isomorphic-fetch";
-export * from "./auth/auth";
-export { createConfiguration } from "./configuration"
-export { setServerVariables } from "./configuration"
-
-export { Configuration } from "./configuration"
-export * from "./apis/exception";
-export * from "./servers";
-
 {%- for api, operations in apis.items()|sort(attribute="0", case_sensitive=True) %}
 {%- set classname = api.replace(" ", "") + "Api" %}
 

.generator/src/generator/templates/model/ObjectSerializer.j2

@@ -3,7 +3,7 @@
 import { {{ name }} } from "./{{ name }}";
 {%- endif %}
 {%- endfor %}
-import { UnparsedObject } from "../util";
+import { UnparsedObject } from "../../datadog-api-client-common/util";
 import { logger } from "../../../logger";
 
 const primitives = [