Validate that x-route-path actually exists in routes

Author: andrii-balitskyi

src/lib/blueprint.ts

@@ -306,14 +306,15 @@ export const createBlueprint = async (
     formatCode,
   }
 
-  const resources = createResources(openapi.components.schemas)
+  const routes = await createRoutes(openapi.paths, context)
+  const resources = createResources(openapi.components.schemas, routes)
 
   return {
     title: openapi.info.title,
-    routes: await createRoutes(openapi.paths, context),
+    routes,
     resources,
-    events: createEvents(openapi.components.schemas, resources),
-    actionAttempts: createActionAttempts(openapi.components.schemas),
+    events: createEvents(openapi.components.schemas, resources, routes),
+    actionAttempts: createActionAttempts(openapi.components.schemas, routes),
   }
 }
 
@@ -788,6 +789,7 @@ const createParameter = (
 
 export const createResources = (
   schemas: Openapi['components']['schemas'],
+  routes: Route[],
 ): Record<string, Resource> => {
   return Object.entries(schemas).reduce<Record<string, Resource>>(
     (resources, [schemaName, schema]) => {
@@ -804,7 +806,7 @@ export const createResources = (
         }
         return {
           ...resources,
-          [schemaName]: createResource(schemaName, eventSchema),
+          [schemaName]: createResource(schemaName, eventSchema, routes),
         }
       }
 
@@ -813,7 +815,7 @@ export const createResources = (
       if (isValidResourceSchema) {
         return {
           ...resources,
-          [schemaName]: createResource(schemaName, schema),
+          [schemaName]: createResource(schemaName, schema, routes),
         }
       }
 
@@ -826,11 +828,9 @@ export const createResources = (
 const createResource = (
   schemaName: string,
   schema: OpenapiSchema,
+  routes: Route[],
 ): Resource => {
-  const routePath = schema['x-route-path']
-  if (routePath == null || routePath.length === 0) {
-    throw new Error(`Missing route path for ${schemaName}`)
-  }
+  const routePath = validateRoutePath(schema['x-route-path'], routes)
 
   return {
     resourceType: schemaName,
@@ -846,6 +846,20 @@ const createResource = (
   }
 }
 
+const validateRoutePath = (
+  routePath: string | undefined,
+  routes: Route[],
+): string => {
+  if (routePath == null || routePath.length === 0) {
+    throw new Error('Missing route path')
+  }
+  if (!routes.some((r) => r.path === routePath)) {
+    throw new Error(`Route path ${routePath} not found in routes`)
+  }
+
+  return routePath
+}
+
 const createResponse = (
   operation: OpenapiOperation,
   path: string,
@@ -1095,6 +1109,7 @@ export const getPreferredMethod = (
 const createEvents = (
   schemas: Openapi['components']['schemas'],
   resources: Record<string, Resource>,
+  routes: Route[],
 ): EventResource[] => {
   const eventSchema = schemas['event']
   if (
@@ -1121,7 +1136,7 @@ const createEvents = (
       )
 
       return {
-        ...createResource('event', schema as OpenapiSchema),
+        ...createResource('event', schema as OpenapiSchema, routes),
         eventType,
         targetResourceType: targetResourceType ?? null,
       }
@@ -1131,6 +1146,7 @@ const createEvents = (
 
 const createActionAttempts = (
   schemas: Openapi['components']['schemas'],
+  routes: Route[],
 ): ActionAttempt[] => {
   const actionAttemptSchema = schemas['action_attempt']
   if (
@@ -1176,6 +1192,7 @@ const createActionAttempts = (
       const resource = createResource(
         'action_attempt',
         schemaWithStandardStatus,
+        routes,
       )
 
       return {

test/fixtures/types/openapi.ts

@@ -84,7 +84,7 @@ export default {
           },
         },
         required: ['plane_id', 'name'],
-        'x-route-path': '/planes',
+        'x-route-path': '/transport/air/planes',
       },
       deprecated_resource: {
         type: 'object',
@@ -99,7 +99,7 @@ export default {
         required: ['deprecated_resource_id'],
         deprecated: true,
         'x-deprecated': 'This resource is deprecated',
-        'x-route-path': '/deprecated/resources',
+        'x-route-path': '/deprecated/undocumented',
       },
       draft_resource: {
         type: 'object',
@@ -113,7 +113,7 @@ export default {
         },
         required: ['draft_resource_id'],
         'x-draft': 'This resource is draft',
-        'x-route-path': '/draft/resources',
+        'x-route-path': '/draft',
       },
       undocumented_resource: {
         type: 'object',
@@ -127,7 +127,7 @@ export default {
         },
         required: ['undocumented_resource_id'],
         'x-undocumented': 'This resource is undocumented',
-        'x-route-path': '/undocumented/resources',
+        'x-route-path': '/deprecated/undocumented',
       },
       event: {
         'x-route-path': '/events',
@@ -476,5 +476,40 @@ export default {
         'x-title': 'Draft endpoint',
       },
     },
+    '/action_attempts/get': {
+      post: {
+        operationId: 'actionAttemptsGetPost',
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    action_attempt: {
+                      $ref: '#/components/schemas/action_attempt',
+                    },
+                  },
+                  required: ['action_attempt', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'Get an action attempt.',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          {
+            api_key: [],
+          },
+        ],
+        summary: '/action_attempts/get',
+        tags: ['/action_attempts'],
+        'x-response-key': 'action_attempt',
+        'x-title': 'Get an action attempt',
+      },
+    },
   },
 }