Stop using jsonSpec in compilation steps

Author: pquentin

compiler/src/compiler.ts

@@ -28,7 +28,7 @@ import {
 import buildJsonSpec, { JsonSpec } from './model/json-spec'
 import { ValidationErrors } from './validation-errors'
 
-type StepFunction = (model: Model, restSpec: Map<string, JsonSpec>, errors: ValidationErrors) => Promise<Model>
+type StepFunction = (model: Model, errors: ValidationErrors) => Promise<Model>
 
 /**
  * The main job of the compiler is to generate the Model and write it on disk.
@@ -62,7 +62,7 @@ export default class Compiler {
 
   async write (): Promise<void> {
     for (const step of this.queue) {
-      this.model = await step(this.model, this.jsonSpec, this.errors)
+      this.model = await step(this.model, this.errors)
     }
 
     const customStringify = stringify.configure(

compiler/src/index.ts

@@ -21,7 +21,6 @@ import { readFileSync, existsSync, lstatSync } from 'fs'
 import { join, resolve } from 'path'
 import { argv } from 'zx'
 import Compiler from './compiler'
-import validateRestSpec from './steps/validate-rest-spec'
 import addInfo from './steps/add-info'
 import validateModel from './steps/validate-model'
 import readDefinitionValidation from './steps/read-definition-validation'
@@ -72,7 +71,6 @@ compiler
   .step(addInfo)
   .step(addDeprecation)
   .step(readDefinitionValidation)
-  .step(validateRestSpec)
   .step(validateModel)
   .step(addExamples)
   .write()

compiler/src/model/json-spec.ts

@@ -18,12 +18,11 @@
  */
 
 import * as model from '../model/metamodel'
-import { JsonSpec } from '../model/json-spec'
 
 /**
  * Populates the `deprecation` field for endpoints from the value of the corresponding request definition.
  */
-export default async function addContentType (model: model.Model, jsonSpec: Map<string, JsonSpec>): Promise<model.Model> {
+export default async function addContentType (model: model.Model): Promise<model.Model> {
   for (const endpoint of model.endpoints) {
     if (endpoint.deprecation != null) {
       continue

compiler/src/steps/add-deprecation.ts

@@ -18,7 +18,6 @@
  */
 
 import * as model from '../model/metamodel'
-import { JsonSpec } from '../model/json-spec'
 import * as path from 'path'
 import * as fs from 'fs'
 import * as yaml from 'js-yaml'
@@ -35,9 +34,7 @@ export default class ExamplesProcessor {
   }
 
   // Add request and response examples for all the endpoints in the model.
-  // Note that the 'jsonSpec' is a parameter that is passed to a 'Step'.
-  // We don't need that parameter for the the 'addExamples' functionality.
-  async addExamples (model: model.Model, jsonSpec: Map<string, JsonSpec>): Promise<model.Model> {
+  async addExamples (model: model.Model): Promise<model.Model> {
     const requestExamplesProcessor = new RequestExamplesProcessor(model, this.specsFolder)
     const responseExamplesProcessor = new ResponseExamplesProcessor(model, this.specsFolder)
     for (const endpoint of model.endpoints) {

compiler/src/steps/add-examples.ts

@@ -18,12 +18,11 @@
  */
 
 import * as model from '../model/metamodel'
-import { JsonSpec } from '../model/json-spec'
 
 /**
  * Adds the `_info` field to the JSON model.
  */
-export default async function addInfo (model: model.Model, jsonSpec: Map<string, JsonSpec>): Promise<model.Model> {
+export default async function addInfo (model: model.Model): Promise<model.Model> {
   model._info = {
     title: 'Elasticsearch Request & Response Specification',
     license: {

compiler/src/steps/add-info.ts

@@ -19,15 +19,14 @@
 
 import assert from 'assert'
 import * as model from '../model/metamodel'
-import { JsonSpec } from '../model/json-spec'
 import chalk from 'chalk'
 
 /**
  * Verifies if "read" version of interface definitions
  * contains the same properties of their "write" version.
  * Then, it copies every model.Property from write to read but 'required'.
  */
-export default async function readDefinitionValidation (model: model.Model, jsonSpec: Map<string, JsonSpec>): Promise<model.Model> {
+export default async function readDefinitionValidation (model: model.Model): Promise<model.Model> {
   for (const type of model.types) {
     if (type.kind !== 'interface') continue
     const readBehavior = type.behaviors?.find(behavior => behavior.type.name === 'OverloadOf')

compiler/src/steps/read-definition-validation.ts

@@ -19,7 +19,6 @@
 
 import * as model from '../model/metamodel'
 import { ValidationErrors } from '../validation-errors'
-import { JsonSpec } from '../model/json-spec'
 import assert from 'assert'
 import { TypeName } from '../model/metamodel'
 
@@ -46,7 +45,7 @@ enum JsonEvent {
  * - verify that request parents don't define properties (would they be path/request/body properties?)
  * - verify that unions can be distinguished in a JSON stream (otherwise they should be inheritance trees)
  */
-export default async function validateModel (apiModel: model.Model, restSpec: Map<string, JsonSpec>, errors: ValidationErrors): Promise<model.Model> {
+export default async function validateModel (apiModel: model.Model, errors: ValidationErrors): Promise<model.Model> {
   const initialTypeCount = apiModel.types.length
 
   // Returns the fully-qualified name of a type name

compiler/src/steps/validate-model.ts

@@ -1,19 +1,5 @@
 {
-  "endpointErrors": {
-    "_internal.update_desired_nodes": {
-      "request": [
-        "Request: query parameter 'master_timeout' does not exist in the json spec",
-        "Request: query parameter 'timeout' does not exist in the json spec"
-      ],
-      "response": []
-    },
-    "capabilities": {
-      "request": [
-        "Request: query parameter 'timeout' does not exist in the json spec"
-      ],
-      "response": []
-    }
-  },
+  "endpointErrors": {},
   "generalErrors": [
     "Dangling type '_global.scripts_painless_execute:PainlessExecutionPosition'",
     "Dangling type '_global.scripts_painless_execute:PainlessScript'",