fix: error if route placeholder present without matching path parameter (#331)

closes #330

Author: mnahkies

packages/openapi-code-generator/src/typescript/client/client-operation-builder.ts

@@ -52,6 +52,38 @@ export class ClientOperationBuilder {
     return this.operation.servers.length > 0
   }
 
+  routeToTemplateString(paramName = "p"): string {
+    const {route, parameters} = this.operation
+    const placeholder = /{([^{}]+)}/g
+
+    return Array.from(route.matchAll(placeholder)).reduce((result, match) => {
+      const wholeString = match[0]
+      const placeholderName = match[1]
+
+      if (!placeholderName) {
+        throw new Error(
+          `invalid route parameter placeholder in route '${placeholder}'`,
+        )
+      }
+
+      const parameter = parameters.find(
+        (it) => it.name === placeholderName && it.in === "path",
+      )
+
+      if (!parameter) {
+        throw new Error(
+          `invalid route ${route}. missing path parameter for '${placeholderName}'`,
+        )
+      }
+
+      return result.replace(
+        wholeString,
+        // TODO: why do we camelCase here? Feels presumptuous
+        `\${${paramName}["${camelCase(placeholderName)}"]}`,
+      )
+    }, route)
+  }
+
   methodParameter(): MethodParameterDefinition | undefined {
     const {parameters} = this.operation
     const {requestBodyParameter} = this.requestBodyAsParameter()

packages/openapi-code-generator/src/typescript/client/typescript-angular/angular-service-builder.ts

@@ -1,9 +1,6 @@
 import type {ImportBuilder} from "../../common/import-builder"
 import {union} from "../../common/type-utils"
-import {
-  buildMethod,
-  routeToTemplateString,
-} from "../../common/typescript-common"
+import {buildMethod} from "../../common/typescript-common"
 import {AbstractClientBuilder} from "../abstract-client-builder"
 import type {ClientOperationBuilder} from "../client-operation-builder"
 
@@ -19,7 +16,7 @@ export class AngularServiceBuilder extends AbstractClientBuilder {
   }
 
   protected buildOperation(builder: ClientOperationBuilder): string {
-    const {operationId, route, method, hasServers} = builder
+    const {operationId, method, hasServers} = builder
     const {requestBodyParameter} = builder.requestBodyAsParameter()
 
     const operationParameter = builder.methodParameter()
@@ -35,7 +32,7 @@ export class AngularServiceBuilder extends AbstractClientBuilder {
       .concat(["HttpResponse<unknown>"])
       .join(" | ")
 
-    const url = routeToTemplateString(route)
+    const url = builder.routeToTemplateString()
 
     const body = `
     ${[

packages/openapi-code-generator/src/typescript/client/typescript-axios/typescript-axios-client-builder.ts

@@ -1,9 +1,6 @@
 import type {ImportBuilder} from "../../common/import-builder"
 import {union} from "../../common/type-utils"
-import {
-  asyncMethod,
-  routeToTemplateString,
-} from "../../common/typescript-common"
+import {asyncMethod} from "../../common/typescript-common"
 import {AbstractClientBuilder} from "../abstract-client-builder"
 import type {ClientOperationBuilder} from "../client-operation-builder"
 
@@ -19,7 +16,7 @@ export class TypescriptAxiosClientBuilder extends AbstractClientBuilder {
   }
 
   protected buildOperation(builder: ClientOperationBuilder): string {
-    const {operationId, route, method, hasServers} = builder
+    const {operationId, method, hasServers} = builder
     const {requestBodyParameter} = builder.requestBodyAsParameter()
 
     const operationParameter = builder.methodParameter()
@@ -64,7 +61,7 @@ export class TypescriptAxiosClientBuilder extends AbstractClientBuilder {
       .join(",\n")}})`
 
     const body = `
-    const url = \`${routeToTemplateString(route)}\`
+    const url = \`${builder.routeToTemplateString()}\`
     ${[
       headers
         ? `const headers = this._headers(${headers}, opts.headers)`

packages/openapi-code-generator/src/typescript/client/typescript-fetch/typescript-fetch-client-builder.ts

@@ -2,10 +2,7 @@ import type {ImportBuilder} from "../../common/import-builder"
 import {JoiBuilder} from "../../common/schema-builders/joi-schema-builder"
 import {ZodBuilder} from "../../common/schema-builders/zod-schema-builder"
 import {union} from "../../common/type-utils"
-import {
-  asyncMethod,
-  routeToTemplateString,
-} from "../../common/typescript-common"
+import {asyncMethod} from "../../common/typescript-common"
 import {AbstractClientBuilder} from "../abstract-client-builder"
 import type {ClientOperationBuilder} from "../client-operation-builder"
 
@@ -39,7 +36,7 @@ export class TypescriptFetchClientBuilder extends AbstractClientBuilder {
   }
 
   protected buildOperation(builder: ClientOperationBuilder): string {
-    const {operationId, route, method, hasServers} = builder
+    const {operationId, method, hasServers} = builder
     const {requestBodyParameter} = builder.requestBodyAsParameter()
 
     const operationParameter = builder.methodParameter()
@@ -69,7 +66,7 @@ export class TypescriptFetchClientBuilder extends AbstractClientBuilder {
       .join("\n")}}, timeout)`
 
     const body = `
-    const url = ${hasServers ? "basePath" : "this.basePath"} + \`${routeToTemplateString(route)}\`
+    const url = ${hasServers ? "basePath" : "this.basePath"} + \`${builder.routeToTemplateString()}\`
     ${[
       headers
         ? `const headers = this._headers(${headers}, opts.headers)`

packages/openapi-code-generator/src/typescript/common/typescript-common.ts

@@ -60,26 +60,6 @@ export function combineAndDestructureParams(
   }
 }
 
-export function routeToTemplateString(route: string, paramName = "p"): string {
-  const placeholder = /{([^{}]+)}/g
-
-  return Array.from(route.matchAll(placeholder)).reduce((result, match) => {
-    const wholeString = match[0]
-    const placeholderName = match[1]
-
-    if (!placeholderName) {
-      throw new Error(
-        `invalid route parameter placeholder in route '${placeholder}'`,
-      )
-    }
-
-    return result.replace(
-      wholeString,
-      `\${${paramName}["${camelCase(placeholderName)}"]}`,
-    )
-  }, route)
-}
-
 export function buildMethod({
   name,
   parameters,

packages/openapi-code-generator/src/typescript/server/server-operation-builder.ts

@@ -91,7 +91,26 @@ export class ServerOperationBuilder {
   }
 
   get route(): string {
-    return this.operation.route
+    const {route, parameters} = this.operation
+
+    const placeholder = /{([^{}]+)}/g
+
+    return Array.from(route.matchAll(placeholder)).reduce((result, match) => {
+      const wholeString = match[0]
+      const placeholderName = match[1]
+
+      const parameter = parameters.find(
+        (it) => it.name === placeholderName && it.in === "path",
+      )
+
+      if (!parameter) {
+        throw new Error(
+          `invalid route ${route}. missing path parameter for '${placeholderName}'`,
+        )
+      }
+
+      return result.replace(wholeString, `:${placeholderName}`)
+    }, route)
   }
 
   get method(): string {

packages/openapi-code-generator/src/typescript/server/typescript-express/typescript-express-router-builder.ts

@@ -1,16 +1,13 @@
 import type {Input} from "../../../core/input"
-import {isDefined, titleCase} from "../../../core/utils"
+import {titleCase} from "../../../core/utils"
 import type {ServerImplementationMethod} from "../../../templates.types"
 import type {ImportBuilder} from "../../common/import-builder"
 import {JoiBuilder} from "../../common/schema-builders/joi-schema-builder"
 import type {SchemaBuilder} from "../../common/schema-builders/schema-builder"
 import {ZodBuilder} from "../../common/schema-builders/zod-schema-builder"
 import type {TypeBuilder} from "../../common/type-builder"
 import {constStatement, object} from "../../common/type-utils"
-import {
-  buildExport,
-  routeToTemplateString,
-} from "../../common/typescript-common"
+import {buildExport} from "../../common/typescript-common"
 import {
   AbstractRouterBuilder,
   type ServerSymbols,
@@ -126,7 +123,7 @@ export class ExpressRouterBuilder extends AbstractRouterBuilder {
 const ${symbols.responseBodyValidator} = ${builder.responseValidator()}
 
 // ${builder.operationId}
-router.${builder.method.toLowerCase()}(\`${route(builder.route)}\`, async (req: Request, res: Response, next: NextFunction) => {
+router.${builder.method.toLowerCase()}(\`${builder.route}\`, async (req: Request, res: Response, next: NextFunction) => {
   try {
    const input = {
     params: ${params.path.schema ? `parseRequestInput(${symbols.paramSchema}, req.params, RequestInputType.RouteParam)` : "undefined"},
@@ -240,11 +237,3 @@ export ${this.implementationMethod === "type" || this.implementationMethod === "
     }
   }
 }
-
-function route(route: string): string {
-  const placeholder = /{([^{}]+)}/g
-
-  return Array.from(route.matchAll(placeholder)).reduce((result, match) => {
-    return result.replace(match[0], `:${match[1]}`)
-  }, route)
-}

packages/openapi-code-generator/src/typescript/server/typescript-koa/typescript-koa-router-builder.ts

@@ -132,7 +132,7 @@ export class KoaRouterBuilder extends AbstractRouterBuilder {
     statements.push(`
 const ${symbols.responseBodyValidator} = ${builder.responseValidator()}
 
-router.${builder.method.toLowerCase()}('${symbols.implPropName}','${route(builder.route)}', async (ctx, next) => {
+router.${builder.method.toLowerCase()}('${symbols.implPropName}','${builder.route}', async (ctx, next) => {
    const input = {
     params: ${params.path.schema ? `parseRequestInput(${symbols.paramSchema}, ctx.params, RequestInputType.RouteParam)` : "undefined"},
     query: ${params.query.schema ? `parseRequestInput(${symbols.querySchema}, ctx.query, RequestInputType.QueryString)` : "undefined"},
@@ -241,11 +241,3 @@ export ${this.implementationMethod === "type" || this.implementationMethod === "
 `
   }
 }
-
-function route(route: string): string {
-  const placeholder = /{([^{}]+)}/g
-
-  return Array.from(route.matchAll(placeholder)).reduce((result, match) => {
-    return result.replace(match[0], `:${match[1]}`)
-  }, route)
-}