Improve Next Nuxt Nest endpoint extraction (#1777)

Author: hahwul

spec/functional_test/fixtures/javascript/nestjs/users.controller.ts

@@ -1,4 +1,5 @@
-import { Controller, Get, Post, Put, Delete, Param, Query, Body, Headers } from '@nestjs/common';
+import { Controller, Get, Post, Put, Delete, Param, Query, Body, Headers, Req, UploadedFile, UseGuards, UseInterceptors, Version } from '@nestjs/common';
+import { FileInterceptor } from '@nestjs/platform-express';
 
 @Controller('users')
 export class UserController {
@@ -39,4 +40,27 @@ export class ProtectedController {
   getProtected(@Headers('authorization') auth: string) {
     return {};
   }
-}
+}
+
+@Controller('admin')
+export class AdminController {
+  @Get('reports/:id')
+  @UseGuards(AuthGuard)
+  report(@Param('id') id: string, @Req() req: any) {
+    const include = req.query.include;
+    const token = req.headers['x-token'];
+    return { id, include, token };
+  }
+
+  @Post('upload')
+  @UseInterceptors(FileInterceptor('avatar'))
+  upload(@UploadedFile() file: any) {
+    return { file };
+  }
+
+  @Version('2')
+  @Get('versioned')
+  versioned() {
+    return {};
+  }
+}

spec/functional_test/fixtures/javascript/nestjs_versioning/cats.controller.ts

@@ -31,3 +31,14 @@ export class HealthController {
     return { ok: true }
   }
 }
+
+// Method-level versioning overrides, rather than stacks on top of,
+// controller-level URI versioning.
+@Controller({ path: 'dogs', version: '1' })
+export class DogsController {
+  @Version('2')
+  @Get('override')
+  override() {
+    return []
+  }
+}

spec/functional_test/fixtures/javascript/nextjs/app/api/commented/route.ts

@@ -0,0 +1,9 @@
+import { NextResponse } from "next/server"
+
+// export async function GET() {
+//   return NextResponse.json({ shouldNotAppear: true })
+// }
+
+export async function POST() {
+  return NextResponse.json({ ok: true })
+}

spec/functional_test/fixtures/javascript/nextjs/app/api/profile/route.ts

@@ -0,0 +1,12 @@
+import { cookies, headers } from "next/headers"
+import { NextRequest, NextResponse } from "next/server"
+
+export async function POST(request: NextRequest) {
+  const form = await request.formData()
+  const avatar = form.get("avatar")
+  const cookieStore = await cookies()
+  const session = cookieStore.get("session")
+  const forwarded = headers().get("x-forwarded-for")
+
+  return NextResponse.json({ avatar, session, forwarded })
+}

spec/functional_test/fixtures/javascript/nextjs/pages/api/switch.ts

@@ -0,0 +1,18 @@
+import type { NextApiRequest, NextApiResponse } from "next"
+
+export default function handler(req: NextApiRequest, res: NextApiResponse) {
+  switch (req.method) {
+    case "GET": {
+      const { cursor } = req.query
+      res.status(200).json({ cursor })
+      return
+    }
+    case "DELETE": {
+      const id = req.body.id
+      res.status(204).json({ id })
+      return
+    }
+    default:
+      res.status(405).end()
+  }
+}

spec/functional_test/fixtures/javascript/nextjs/pages/api/unrelated-switch.ts

@@ -0,0 +1,11 @@
+import type { NextApiRequest, NextApiResponse } from "next"
+
+export default function handler(req: NextApiRequest, res: NextApiResponse) {
+  switch (req.query.type) {
+    case "GET":
+      res.status(200).json({ type: "query-get" })
+      return
+    default:
+      res.status(200).json({ ok: true })
+  }
+}

spec/functional_test/fixtures/javascript/nuxtjs/server/api/blog/[...slug].get.ts

@@ -0,0 +1,5 @@
+export default defineEventHandler((event) => {
+  const slug = getRouterParam(event, "slug")
+  const { tag } = getQuery(event)
+  return { slug, tag }
+})

spec/functional_test/fixtures/javascript/nuxtjs/server/api/profile.post.ts

@@ -0,0 +1,6 @@
+export default defineEventHandler(async (event) => {
+  const { username, email } = await readValidatedBody(event, z.object({}))
+  const auth = getRequestHeader(event, "authorization")
+  const headers = getHeaders(event)
+  return { username, email, auth, agent: headers["user-agent"] }
+})

spec/functional_test/testers/javascript/nestjs_spec.cr

@@ -25,6 +25,20 @@ expected_endpoints = [
   Endpoint.new("/protected", "GET", [
     Param.new("authorization", "", "header"),
   ]),
+  # Decorators between the route decorator and method should not hide
+  # method params or request-object usage.
+  Endpoint.new("/admin/reports/:id", "GET", [
+    Param.new("id", "", "path"),
+    Param.new("include", "", "query"),
+    Param.new("x-token", "", "header"),
+  ]),
+  # FileInterceptor field names are the actual upload body surface.
+  Endpoint.new("/admin/upload", "POST", [
+    Param.new("avatar", "", "body"),
+    Param.new("file", "", "body"),
+  ]),
+  # Method-level URI versioning.
+  Endpoint.new("/v2/admin/versioned", "GET"),
 ]
 
 FunctionalTester.new("fixtures/javascript/nestjs/", {

spec/functional_test/testers/javascript/nestjs_versioning_spec.cr

@@ -12,8 +12,10 @@ expected_endpoints = [
     Param.new("body", "", "body"),
   ]),
   Endpoint.new("/health", "GET"),
+  Endpoint.new("/v2/dogs/override", "GET"),
 ]
 
 FunctionalTester.new("fixtures/javascript/nestjs_versioning/", {
-  :techs => 1,
+  :techs     => 1,
+  :endpoints => expected_endpoints.size,
 }, expected_endpoints).perform_tests