lb4 openapi generator produces invalid TypeScript code when OpenAPI parameters contain hyphens

Abierto Apto para principiantes
#11,887 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@aaqilniz ya está trabajando en esto.

Desde el 21/3/2024.

  • #10427 de @aaqilniz — abierto

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
76/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
node.js, openapi, typescript

Línea de trabajo

Empieza leyendo el código del generador OpenAPI de lb4 que construye los argumentos de los métodos del controlador y sigue cómo asigna los nombres de los parámetros de la especificación OpenAPI al TypeScript generado. Reproduce el problema con la especificación proporcionada e inspecciona el controlador generado. El trabajo estará terminado cuando los nombres con guiones se normalicen de forma coherente en los argumentos de las llamadas al servicio y el TypeScript generado compile.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug CLI
Bug Description

When generating server controllers or services using the lb4 openapi generator from an OpenAPI specification containing query or path parameters with hyphens (kebab-case, like limit-number or status-code), the code generator incorrectly emits literal code containing hyphens (e.g., limit-number, status-code) directly inside the TypeScript method body call arguments instead of sanitizing/camelCasing them into valid TypeScript identifiers (limitNumber, statusCode).

This causes immediate compilation/syntax errors.

Steps to Reproduce

Create an OpenAPI 3.0 specification JSON file (openapi.json) with an endpoint having hyphenated query parameters:

{
  "openapi": "3.0.3",
  "info": {
    "title": "Hyphenated Bug API",
    "version": "1.0.0"
  },
  "paths": {
    "/customers": {
      "get": {
        "operationId": "getCustomers",
        "parameters": [
          {
            "name": "limit-number",
            "in": "query",
            "schema": { "type": "integer" }
          },
          {
            "name": "status-code",
            "in": "query",
            "schema": { "type": "string" }
          }
        ],
        "responses": {
          "200": { "description": "OK" }
        }
      }
    }
  }
}
  1. Run the LoopBack OpenAPI generator command pointing to this spec: lb4 openapi openapi.json
  2. Inspect the generated Controller file.
Current Output (Buggy Code)

The controller method tries to pass raw hyphenated strings as variable names into the service layer call:

 async getCustomers(
    @param({
      name: 'limit-number',
      in: 'query',
      // ...
    }) limitNumber: number | undefined, 
    @param({
      name: 'status-code',
      in: 'query',
      // ...
    }) statusCode: string | undefined
  ): Promise<any[]> {
       // BUG: TypeScript treats 'limit-number' and 'status-code' as invalid mathematical subtraction expressions
       return this.openApiService.getCustomers(limit-number, status-code);  
  }
Expected Output

The generated controller should correctly use the sanitized camelCase parameter identifiers (limitNumber, statusCode) inside the implementation body:

async getCustomers(...): Promise<any[]> {
       return this.openApiService.getCustomers(limitNumber, statusCode);  
  }
Lenguaje dominante
TypeScript
Estrellas
5.1k
Forks
1.1k
Merge medio
1 d 23 h
PR fusionados (30 d)
44

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de loopbackio/loopback-next

Todos los issues de loopbackio/loopback-next

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.