Rename request and response types (elastic#375)

Author: delvedor

compiler/model/build-model.ts

@@ -146,8 +146,14 @@ export function compileSpecification (endpointMappings: Record<string, model.End
 
   // Sort the types in alphabetical order
   model.types.sort((a, b) => {
-    if (a.name.name > b.name.name) return 1
-    if (a.name.name < b.name.name) return -1
+    if (a.name.namespace === b.name.namespace) {
+      if (a.name.name > b.name.name) return 1
+      if (a.name.name < b.name.name) return -1
+      return 0
+    }
+
+    if (a.name.namespace > b.name.namespace) return 1
+    if (a.name.namespace < b.name.namespace) return -1
     return 0
   })
 
@@ -177,13 +183,10 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int
   // Request definitions needs to be handled
   // differently from normal classes
   if (Node.isInterfaceDeclaration(declaration) && isApi(declaration)) {
-    // It's not guaranteed that every *Request definition
-    // has an associated *Response definition as well.
-    const response = allClasses
-      .map(d => d.getName())
-      .find(n => n === `${name.slice(0, -7)}Response`) !== undefined
-      ? { name: `${name.slice(0, -7)}Response`, namespace: getNameSpace(declaration) }
-      : null
+    const response: model.TypeName = {
+      name: 'Response',
+      namespace: getNameSpace(declaration)
+    }
 
     const type: model.Request = {
       kind: 'request',

compiler/steps/validate-rest-spec.ts

@@ -40,7 +40,7 @@ const LOG = 'ALL' // default: ALL
 export default async function validateRestSpec (model: model.Model, jsonSpec: Map<string, JsonSpec>, errors: ValidationErrors): Promise<model.Model> {
   for (const endpoint of model.endpoints) {
     if (endpoint.request == null) continue
-    const requestDefinition = getDefinition(endpoint.request.name)
+    const requestDefinition = getDefinition(endpoint.request)
     const requestProperties = getProperties(requestDefinition)
     if (endpoint.request.name === LOG || LOG === 'ALL') {
       const spec = jsonSpec.get(endpoint.name)
@@ -98,15 +98,15 @@ export default async function validateRestSpec (model: model.Model, jsonSpec: Ma
 
   return model
 
-  function getDefinition (name: string): model.Request | model.Interface {
+  function getDefinition (name: model.TypeName): model.Request | model.Interface {
     for (const type of model.types) {
       if (type.kind === 'request' || type.kind === 'interface') {
-        if (type.name.name === name) {
+        if (type.name.name === name.name && type.name.namespace === name.namespace) {
           return type
         }
       }
     }
-    throw new Error(`Can't find the request definiton for ${name}`)
+    throw new Error(`Can't find the request definiton for ${name.namespace}.${name.name}`)
   }
 
   // recursively gets the properties from the current and inherited classes
@@ -134,7 +134,7 @@ export default async function validateRestSpec (model: model.Model, jsonSpec: Ma
     }
 
     if (Array.isArray(definition.inherits)) {
-      const inherits = definition.inherits.map(inherit => getDefinition(inherit.type.name))
+      const inherits = definition.inherits.map(inherit => getDefinition(inherit.type))
       for (const inherit of inherits) {
         const properties = getProperties(inherit)
         if (properties.path.length > 0) {

compiler/update-imports.ts

@@ -49,14 +49,26 @@ Example: npm run imports:fix -- --help
 const specsFolder = join(__dirname, '..', 'specification')
 const tsConfigFilePath = join(specsFolder, 'tsconfig.json')
 
+const aliasedImports: string[] = []
+
 async function removeImports (): Promise<void> {
   if (options.rebuild !== true) return
   const project = new Project({ tsConfigFilePath })
   for (const sourceFile of project.getSourceFiles()) {
     if (typeof options.file === 'string' && !sourceFile.getFilePath().includes(options.file)) continue
     console.log(`Removing imports in ${sourceFile.getFilePath().replace(/.*[/\\]specification[/\\]?/, '')}`)
     for (const declaration of sourceFile.getImportDeclarations()) {
-      declaration.remove()
+      let hasImportAlias = false
+      for (const namedImport of declaration.getNamedImports()) {
+        if (namedImport.getAliasNode() != null) {
+          aliasedImports.push(sourceFile.getFilePath().replace(/.*[/\\]specification[/\\]?/, ''))
+          hasImportAlias = true
+          break
+        }
+      }
+      if (!hasImportAlias) {
+        declaration.remove()
+      }
     }
   }
   await project.save()
@@ -84,7 +96,11 @@ async function fixImports (): Promise<void> {
 removeImports()
   .then(fixImports)
   .then(() => {
-    console.log('Done!')
+    if (aliasedImports.length > 0) {
+      console.log('\nThere are some import with aliases that can\'t be rebuilt automatically, run `make spec-compile` to verify if those need to be fixed manually:')
+      console.log(aliasedImports.join('\n'))
+    }
+    console.log('\nDone!')
   })
   .catch(err => {
     console.log(err)

docs/specification-structure.md

@@ -42,4 +42,37 @@ For example: [`/specification/_global/search`](../specification/_global/search).
 ### Specification helpers
 
 The specification has a set of custom types used to define complex structures
-or behaviors. Those types must be placed in [`/specification/_spec_utils`](../specification/_spec_utils).
+or behaviors. Those types must be placed in [`/specification/_spec_utils`](../specification/_spec_utils).
+
+### Import alias
+
+It can happen that you need to import a type from a different namespace that already exist in the current file.
+To solve this problem, you should use import aliases.
+
+```ts
+// _global/get/GetRequest.ts
+
+import { RequestBase } from '@_types/Base'
+
+/**
+ * @rest_spec_name get
+ * @since 0.0.0
+ * @stability TODO
+ */
+export interface Request extends RequestBase {
+  path_parts: {}
+  query_parameters?: {}
+}
+```
+```ts
+// _global/get_source/SourceRequest.ts
+
+import { Request as GetRequest } from '_global/get/GetRequest'
+
+/**
+ * @rest_spec_name get_source
+ * @since 0.0.0
+ * @stability TODO
+ */
+export interface Request extends GetRequest {}
+```