Refactor FS references in the Base Server #32179
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -700,10 +700,18 @@ export default class DevServer extends Server { | |
| }) | ||
| } | ||
|
|
||
| protected getPagesManifest(): undefined { | ||
|
There was a problem hiding this comment. is There was a problem hiding this comment. Yes since I refactored the caller conditions in the base server a bit so they'are always called: https://github.com/vercel/next.js/pull/32179/files?diff=unified&w=0#diff-2b8e3503c1bebf856610a5551d9c5996435b99f45db389d4eeac1b671518875eL306-R310 Goal is to eventually get rid of ad-hoc dev server logic from the base server. |
||
| return undefined | ||
| } | ||
|
|
||
| protected getMiddleware(): never[] { | ||
| return [] | ||
| } | ||
|
|
||
| protected getMiddlewareManifest(): undefined { | ||
| return undefined | ||
| } | ||
|
|
||
| protected async hasMiddleware( | ||
| pathname: string, | ||
| isSSR?: boolean | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,136 @@ | ||
| import fs from 'fs' | ||
| import { join, relative } from 'path' | ||
|
|
||
| import { PAGES_MANIFEST, BUILD_ID_FILE } from '../shared/lib/constants' | ||
| import { PagesManifest } from '../build/webpack/plugins/pages-manifest-plugin' | ||
| import type { Route } from './router' | ||
| import { recursiveReadDirSync } from './lib/recursive-readdir-sync' | ||
| import { route } from './router' | ||
|
|
||
| import BaseServer from './base-server' | ||
| export * from './base-server' | ||
|
|
||
| export default class NextNodeServer extends BaseServer { | ||
| protected getHasStaticDir(): boolean { | ||
| return fs.existsSync(join(this.dir, 'static')) | ||
| } | ||
|
|
||
| protected getPagesManifest(): PagesManifest | undefined { | ||
| const pagesManifestPath = join(this.serverBuildDir, PAGES_MANIFEST) | ||
| return require(pagesManifestPath) | ||
| } | ||
|
|
||
| protected getBuildId(): string { | ||
| const buildIdFile = join(this.distDir, BUILD_ID_FILE) | ||
| try { | ||
| return fs.readFileSync(buildIdFile, 'utf8').trim() | ||
| } catch (err) { | ||
| if (!fs.existsSync(buildIdFile)) { | ||
| throw new Error( | ||
| `Could not find a production build in the '${this.distDir}' directory. Try building your app with 'next build' before starting the production server. https://nextjs.org/docs/messages/production-start-no-build-id` | ||
| ) | ||
| } | ||
|
|
||
| throw err | ||
| } | ||
| } | ||
|
|
||
| protected generatePublicRoutes(): Route[] { | ||
| if (!fs.existsSync(this.publicDir)) return [] | ||
|
|
||
| const publicFiles = new Set( | ||
| recursiveReadDirSync(this.publicDir).map((p) => | ||
| encodeURI(p.replace(/\\/g, '/')) | ||
| ) | ||
| ) | ||
|
|
||
| return [ | ||
| { | ||
| match: route('/:path*'), | ||
| name: 'public folder catchall', | ||
| fn: async (req, res, params, parsedUrl) => { | ||
| const pathParts: string[] = params.path || [] | ||
| const { basePath } = this.nextConfig | ||
|
|
||
| // if basePath is defined require it be present | ||
| if (basePath) { | ||
| const basePathParts = basePath.split('/') | ||
| // remove first empty value | ||
| basePathParts.shift() | ||
|
|
||
| if ( | ||
| !basePathParts.every((part: string, idx: number) => { | ||
| return part === pathParts[idx] | ||
| }) | ||
| ) { | ||
| return { finished: false } | ||
| } | ||
|
|
||
| pathParts.splice(0, basePathParts.length) | ||
| } | ||
|
|
||
| let path = `/${pathParts.join('/')}` | ||
|
|
||
| if (!publicFiles.has(path)) { | ||
| // In `next-dev-server.ts`, we ensure encoded paths match | ||
| // decoded paths on the filesystem. So we need do the | ||
| // opposite here: make sure decoded paths match encoded. | ||
| path = encodeURI(path) | ||
| } | ||
|
|
||
| if (publicFiles.has(path)) { | ||
| await this.serveStatic( | ||
| req, | ||
| res, | ||
| join(this.publicDir, ...pathParts), | ||
| parsedUrl | ||
| ) | ||
| return { | ||
| finished: true, | ||
| } | ||
| } | ||
| return { | ||
| finished: false, | ||
| } | ||
| }, | ||
| } as Route, | ||
| ] | ||
| } | ||
|
|
||
| private _validFilesystemPathSet: Set<string> | null = null | ||
| protected getFilesystemPaths(): Set<string> { | ||
| if (this._validFilesystemPathSet) { | ||
| return this._validFilesystemPathSet | ||
| } | ||
|
|
||
| const pathUserFilesStatic = join(this.dir, 'static') | ||
| let userFilesStatic: string[] = [] | ||
| if (this.hasStaticDir && fs.existsSync(pathUserFilesStatic)) { | ||
| userFilesStatic = recursiveReadDirSync(pathUserFilesStatic).map((f) => | ||
| join('.', 'static', f) | ||
| ) | ||
| } | ||
|
|
||
| let userFilesPublic: string[] = [] | ||
| if (this.publicDir && fs.existsSync(this.publicDir)) { | ||
| userFilesPublic = recursiveReadDirSync(this.publicDir).map((f) => | ||
| join('.', 'public', f) | ||
| ) | ||
| } | ||
|
|
||
| let nextFilesStatic: string[] = [] | ||
|
|
||
| nextFilesStatic = | ||
| !this.minimalMode && fs.existsSync(join(this.distDir, 'static')) | ||
| ? recursiveReadDirSync(join(this.distDir, 'static')).map((f) => | ||
| join('.', relative(this.dir, this.distDir), 'static', f) | ||
| ) | ||
| : [] | ||
|
|
||
| return (this._validFilesystemPathSet = new Set<string>([ | ||
| ...nextFilesStatic, | ||
| ...userFilesPublic, | ||
| ...userFilesStatic, | ||
| ])) | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do we think about trying to make these async when possible? I know that we can have some of this pre-calculated, but I feel like if it's easy during rewrite, making them async is just more flexible later on
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I think we can totally do that in an upcoming PR. Would be good to do the same for
requiretoo!