Unverified Commit 4deba0f6 authored by Niklas Mischkulnig's avatar Niklas Mischkulnig Committed by GitHub

Try to improve typed-routes test flakyness (#86512)

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the PR.
- Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to understand the PR)
- When linking to a Slack thread, you might want to share details of the conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
parent 06b3c445
......@@ -11,11 +11,17 @@ describe('typed-links', () => {
}
it('should generate types for next/link', async () => {
// To wait for the (dev) server to have started up.
await next.render('/')
const dts = await next.readFile(`${next.distDir}/types/link.d.ts`)
expect(dts).toContain(`declare module 'next/link'`)
})
it('should include handler route from app/api-test/route.ts in generated link route definitions', async () => {
// To wait for the (dev) server to have started up.
await next.render('/')
const dts = await next.readFile(`${next.distDir}/types/link.d.ts`)
// Ensure the app route handler at app/api-test/route.ts ("/api-test") is present
expect(dts).toContain('`/api-test`')
......
import { nextTestSetup } from 'e2e-utils'
import { runNextCommand } from 'next-test-utils'
import { retry, runNextCommand } from 'next-test-utils'
const expectedDts = `
type AppRoutes = "/" | "/_shop/[[...category]]" | "/dashboard" | "/dashboard/settings" | "/docs/[...slug]" | "/gallery/photo/[id]" | "/project/[slug]"
......@@ -22,11 +22,17 @@ describe('typed-routes', () => {
}
it('should generate route types correctly', async () => {
// To wait for the (dev) server to have started up.
await next.render('/')
const dts = await next.readFile(`${next.distDir}/types/routes.d.ts`)
expect(dts).toContain(expectedDts)
})
it('should correctly convert custom route patterns from path-to-regexp to bracket syntax', async () => {
// To wait for the (dev) server to have started up.
await next.render('/')
const dts = await next.readFile(`${next.distDir}/types/routes.d.ts`)
// Test standard dynamic segment: :slug -> [slug]
......@@ -52,17 +58,22 @@ describe('typed-routes', () => {
`
)
const routeTypesContent = await next.readFile(
`${next.distDir}/types/routes.d.ts`
)
await retry(async () => {
const routeTypesContent = await next.readFile(
`${next.distDir}/types/routes.d.ts`
)
expect(routeTypesContent).toContain(
'type LayoutRoutes = "/" | "/dashboard" | "/new-layout"'
)
expect(routeTypesContent).toContain(
'type LayoutRoutes = "/" | "/dashboard" | "/new-layout"'
)
})
})
}
it('should generate RouteContext type for route handlers', async () => {
// To wait for the (dev) server to have started up.
await next.render('/')
const dts = await next.readFile(`${next.distDir}/types/routes.d.ts`)
expect(dts).toContain(
'interface RouteContext<AppRouteHandlerRoute extends AppRouteHandlerRoutes>'
......@@ -92,13 +103,13 @@ type InvalidRoute = RouteContext<'/api/users/invalid'>`
`Type '"/api/users/invalid"' does not satisfy the constraint 'AppRouteHandlerRoutes'.`
)
})
}
it('should exit typegen successfully', async () => {
const { code } = await runNextCommand(['typegen'], {
cwd: next.testDir,
})
it('should exit typegen successfully', async () => {
const { code } = await runNextCommand(['typegen'], {
cwd: next.testDir,
})
expect(code).toBe(0)
})
expect(code).toBe(0)
})
}
})
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment