next.js
bef015e0 - Enhance types for Node and Edge envionments (#64454)

Commit
1 year ago
Enhance types for Node and Edge envionments (#64454) <!-- 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 ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### 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 # --> ### What? This enhances the typings in the `BaseServer`, `NextNodeServer`, and `NextWebServer` to simplify types for request and responses across the entire server. Rather than relying on manual environment checks only as the source with error-prone type casts, this adds basic guards (albeit naive) that assert the typings depending on the runtime environment variables. This greatly enhances the typings used across the servers as the servers no longer use the `as` keyword when working with these request and response types. This is a precursor to future planned work to further split the different rendering runtimes to assist with code elimination and framework organization. ### Why? As a step to utilizing these more unified types, the `app-render.tsx` (App Pages rendering pipeline) has been modified to instead accept the abstract `BaseNextRequest` and `BaseNextResponse` types. This is a precursor to future work to split the streaming behaviour based on the runtime environment (ie, in Node.js, we can utilize the native streams instead of web streams, which offer significant performance gains). ### How? The server types were modified to be generic, allowing the three server implementations to have their types flow safely between the different methods. This enables us to only reference the `NodeNextRequest` within the `NextNodeServer`, and the `WebNextRequest` within the `NextWebServer` for example. 🎥 [Loom Video](https://www.loom.com/share/76af2225cf0246d0b4f609ab3e35fff9?sid=c948a919-ac9e-4571-8a75-bd9d0a0776e2) Closes NEXT-3102
Author
Parents
Loading