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

Aperta Adatta ai principianti
#11,887 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@aaqilniz ci sta già lavorando.

Dal 21/3/2024.

  • #10427 di @aaqilniz — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
76/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
node.js, openapi, typescript

Direzione di ricerca

Inizia leggendo il codice del generatore OpenAPI di lb4 che costruisce gli argomenti dei metodi del controller e segui il modo in cui mappa i nomi dei parametri della specifica OpenAPI nel TypeScript generato. Riproduci il problema con la specifica fornita e controlla il controller generato. Il lavoro è completo quando i nomi con trattini vengono normalizzati in modo coerente negli argomenti delle chiamate al servizio e il TypeScript generato viene compilato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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);  
  }
Lingua principale
TypeScript
Stelle
5.1k
Fork
1.1k
Merge medio
1g 23h
PR unite (30g)
44

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di loopbackio/loopback-next

Tutte le issue di loopbackio/loopback-next

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.