Merge pull request #4 from elastic/feature/master/generate-client-flight-recorder

Create a flight recorder exporter to compare

Author: Mpdreamz

.gitignore

@@ -38,4 +38,4 @@ node_modules
 
 # Build output directory
 dist/
-
+flight-recorder-generator/output

flight-recorder-generator/flight-recorder-json-generator.d.ts

@@ -0,0 +1,18 @@
+import { Specification } from "../specification/src/api-specification";
+export declare class FlightRecorderJsonGenerator {
+    private specification;
+    constructor(specification: Specification);
+    export(folder: string): void;
+    private createRequestResponse;
+    private dispatchInterface;
+    private static createValueType;
+    private static createEnumSchema;
+    private lookupType;
+    private createTypeSchema;
+    private createArraySchema;
+    private createDictionarySchema;
+    private createInterfaceProperty;
+    private createUnionOfSchema;
+    private dispatchInstanceOf;
+    private toSchema;
+}

flight-recorder-generator/flight-recorder-json-generator.js

@@ -0,0 +1,157 @@
+import {Specification} from "../specification/src/api-specification";
+import * as fs from "fs";
+import * as path from "path";
+import * as Domain from "elasticsearch-client-specification/src/domain";
+import stringify from 'json-stable-stringify'
+
+export class FlightRecorderJsonGenerator {
+  constructor(private specification: Specification) { }
+
+  export(folder: string) {
+    const f = path.join(__dirname, folder);
+    if (!fs.existsSync(f))
+      fs.mkdirSync(f);
+    this.specification.endpoints.forEach(api => {
+      const pathPrefix = path.join(f, api.name);
+      const body =this.createRequestResponse(api.typeMapping.request);
+      let args = api.queryStringParameters.reduce((o, p) => ({...o, [p.name]: p.type}), {});
+      args = api.url.paths
+        .flatMap(p=>p.parts)
+        .reduce((o, p) => ({...o, [p.name]: p.type}), args);
+      // tslint:disable-next-line:curly
+      if (Object.keys(body).length > 0) {
+        // @ts-ignore
+        args.body = body;
+      }
+
+      const request = {
+        api: api.name,
+        args
+      };
+      fs.writeFileSync(pathPrefix + "_request.json", stringify(request, {space:2}));
+      const response = {
+        api: api.name,
+        headers: {
+          "content-length": "string",
+          "content-type": "application/json; charset=UTF-8"
+        },
+        payload: {
+          body: this.createRequestResponse(api.typeMapping.response)
+
+        },
+        statusCode: [200]
+      };
+      fs.writeFileSync(pathPrefix + "_response.json", stringify(response, {space:2}));
+    });
+
+  }
+  private createRequestResponse(typeName: string) {
+    const type = this.lookupType(typeName);
+    const seenTypes = new Set<string>();
+    seenTypes.add(typeName);
+    return this.toSchema(type, seenTypes, typeName);
+ }
+
+ private dispatchInterface(i: Domain.Interface, seenTypes: Set<string>) {
+    if (i.inheritsFromUnresolved.some(t => t === "String")) return "__" + i.name + "__";
+    const valueType = FlightRecorderJsonGenerator.createValueType(i.name);
+    if (valueType !== null) return valueType;
+
+    return i.properties
+      .filter(p => !p.isRequestParameter)
+      .reduce((o, p) => ({...o, [p.name]: this.createInterfaceProperty(p, seenTypes)}), {});
+  }
+
+  private static createValueType(typeName) {
+    switch (typeName) {
+      case "Time" : return "__time__";
+      case "Uri" : return "__uri__";
+      case "Date" : return "__date__";
+      case "TimeSpan" : return "__duration__";
+      case "TDocument" :
+      case "TPartialDocument" :
+      case "SourceDocument" : return "__source__";
+      case "T" : return "__value__";
+      case "TResult" : return "__value__";
+      case "string" :
+      case "boolean" :
+        return typeName;
+      case "short" :
+      case "byte" :
+      case "integer" :
+      case "long" :
+        return "number";
+      case "float" :
+      case "double" :
+        return "number";
+      case "object" :
+        return {}
+    }
+    return null
+  }
+
+  private static createEnumSchema(enumType: Domain.Enum) {
+    return "enum";
+    // return {
+      // type: "string",
+      // description: enumType.flags ? "flags" : null,
+      // enum: enumType.members.map(e => e.name)
+    // };
+  }
+
+  private lookupType(typeName) {
+    let i = this.specification.typeLookup[typeName];
+    if (i != null) return i;
+    typeName = typeName.replace(/<.+$/, "");
+    i = this.specification.typeLookup[typeName];
+    if (i == null && typeName !== "object" &&
+      (!typeName.endsWith("Response") && !typeName.endsWith("Request")))
+      throw Error("Can not find " + typeName);
+    return i;
+  }
+
+  private createTypeSchema(type: Domain.Type, seenTypes: Set<string>) {
+    const valueType = FlightRecorderJsonGenerator.createValueType(type.name);
+    if (valueType !== null) return valueType;
+
+    if (seenTypes.has(type.name)) return { $type: `Circular reference to: ${type.name}`};
+    seenTypes.add(type.name);
+
+    const i = this.lookupType(type.name);
+    const schema = this.toSchema(i, seenTypes, type.name);
+    seenTypes.delete(type.name);
+    return schema;
+  }
+
+  private createArraySchema(arr: Domain.ArrayOf, seenTypes) {
+    return [this.dispatchInstanceOf(arr.of, seenTypes)];
+  }
+
+  private createDictionarySchema(dict: Domain.Dictionary, seenTypes: Set<string>) {
+    return { __name__ : this.dispatchInstanceOf(dict.value, seenTypes) };
+  }
+
+  private createInterfaceProperty(property: Domain.InterfaceProperty, seenTypes: Set<string>) {
+    return this.dispatchInstanceOf(property.type, seenTypes);
+  }
+
+  private createUnionOfSchema(union: Domain.UnionOf, seenTypes: Set<string>) {
+    return { __anyOf__ : [
+      union.items.map(i => this.dispatchInstanceOf(i, seenTypes))
+    ] };
+  }
+
+  private dispatchInstanceOf(type: Domain.InstanceOf, seenTypes: Set<string>) {
+
+    if (type instanceof Domain.Dictionary) return this.createDictionarySchema(type, seenTypes);
+    if (type instanceof Domain.UnionOf) return this.createUnionOfSchema(type, seenTypes);
+    if (type instanceof Domain.Type) return this.createTypeSchema(type, seenTypes);
+    if (type instanceof Domain.ArrayOf) return this.createArraySchema(type, seenTypes);
+    return { type: "object", description: "Unknown InstanceOf" };
+  }
+  private toSchema(type: Domain.TypeDeclaration, seenTypes: Set<string>, lastAddedType: string) {
+    if (type instanceof Domain.Enum) return FlightRecorderJsonGenerator.createEnumSchema(type);
+    if (type instanceof Domain.Interface) return this.dispatchInterface(type, seenTypes);
+    return { type: "object", description: "undefined in spec" + lastAddedType};
+  }
+}

flight-recorder-generator/flight-recorder-json-generator.ts

@@ -0,0 +1 @@
+export {};

flight-recorder-generator/index.d.ts

@@ -0,0 +1,18 @@
+import {Specification} from "../specification/src/api-specification";
+import {FlightRecorderJsonGenerator} from "./flight-recorder-json-generator";
+// tslint:disable:no-console
+
+const specification = Specification.load();
+
+if (specification.endpoint_errors.length > 0) console.error("The specification contains the following endpoint mapping errors:");
+
+for (const e of specification.endpoint_errors) console.error("  - " + e);
+
+if (specification.domain_errors.length +  specification.endpoint_errors.length === 0)
+  console.log("The specification contains no errors in any of the " +
+    specification.endpoints.length + " endpoints yielding " + specification.types.length + " types");
+
+console.log("The specification contains " + specification.endpoints.length + " endpoints yielding " + specification.types.length + " types");
+
+const swaggerGenerator = new FlightRecorderJsonGenerator(specification);
+swaggerGenerator.export("output");