Skip to content

Commit

Permalink
build: fix minimal trace caching (#55279)
Browse files Browse the repository at this point in the history
This PR fixes a small issue where we would not save nor read the minimal
server trace file from the cache, meaning that whenever you would do two
builds in a row, the build would skip the tracing of the server as
expected but not include a minimal server trace in the dist folder.

<!-- 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 #

-->
  • Loading branch information
feedthejim committed Sep 12, 2023
1 parent 180d552 commit 2a7f5cd
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion packages/next/src/build/index.ts
Expand Up @@ -2045,6 +2045,10 @@ export default async function build(
distDir,
'cache/next-server.js.nft.json'
)
const minimalCachedTracePath = path.join(
distDir,
'cache/next-minimal-server.js.nft.json'
)

if (
lockFiles.length > 0 &&
Expand Down Expand Up @@ -2072,9 +2076,19 @@ export default async function build(
const existingTrace = JSON.parse(
await fs.readFile(cachedTracePath, 'utf8')
)
const existingMinimalTrace = JSON.parse(
await fs.readFile(minimalCachedTracePath, 'utf8')
)

if (existingTrace.cacheKey === cacheKey) {
if (
existingTrace.cacheKey === cacheKey &&
existingMinimalTrace.cacheKey === cacheKey
) {
await fs.copyFile(cachedTracePath, nextServerTraceOutput)
await fs.copyFile(
minimalCachedTracePath,
nextMinimalTraceOutput
)
return
}
} catch {}
Expand Down Expand Up @@ -2301,9 +2315,13 @@ export default async function build(
])

await fs.unlink(cachedTracePath).catch(() => {})
await fs.unlink(minimalCachedTracePath).catch(() => {})
await fs
.copyFile(nextServerTraceOutput, cachedTracePath)
.catch(() => {})
await fs
.copyFile(nextMinimalTraceOutput, minimalCachedTracePath)
.catch(() => {})
})
}

Expand Down

0 comments on commit 2a7f5cd

Please sign in to comment.