Unverified Commit bbcd14ee authored by Mark Knichel's avatar Mark Knichel Committed by GitHub

[Diagnostics] Record framework.json after creating and cleaning distDir (#67819)

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

-->

---------
Co-authored-by: 's avatarJJ Kasper <jj@jjsweb.site>
parent e1034776
...@@ -794,11 +794,6 @@ export default async function build( ...@@ -794,11 +794,6 @@ export default async function build(
expFeatureInfo, expFeatureInfo,
}) })
await recordFrameworkVersion(process.env.__NEXT_VERSION as string)
await updateBuildDiagnostics({
buildStage: 'start',
})
const ignoreESLint = Boolean(config.eslint.ignoreDuringBuilds) const ignoreESLint = Boolean(config.eslint.ignoreDuringBuilds)
const shouldLint = !ignoreESLint && runLint const shouldLint = !ignoreESLint && runLint
...@@ -1189,6 +1184,12 @@ export default async function build( ...@@ -1189,6 +1184,12 @@ export default async function build(
'{"type": "commonjs"}' '{"type": "commonjs"}'
) )
// These are written to distDir, so they need to come after creating and cleaning distDr.
await recordFrameworkVersion(process.env.__NEXT_VERSION as string)
await updateBuildDiagnostics({
buildStage: 'start',
})
const outputFileTracingRoot = const outputFileTracingRoot =
config.experimental.outputFileTracingRoot || dir config.experimental.outputFileTracingRoot || dir
......
...@@ -27,7 +27,10 @@ async function getDiagnosticsDir(): Promise<string> { ...@@ -27,7 +27,10 @@ async function getDiagnosticsDir(): Promise<string> {
export async function recordFrameworkVersion(version: string): Promise<void> { export async function recordFrameworkVersion(version: string): Promise<void> {
const diagnosticsDir = await getDiagnosticsDir() const diagnosticsDir = await getDiagnosticsDir()
const frameworkVersionFile = join(diagnosticsDir, 'framework.json') const frameworkVersionFile = join(diagnosticsDir, 'framework.json')
await writeFile(frameworkVersionFile, JSON.stringify({ version })) await writeFile(
frameworkVersionFile,
JSON.stringify({ name: 'Next.js', version })
)
} }
/** /**
......
...@@ -30,6 +30,28 @@ describe('app dir - basic', () => { ...@@ -30,6 +30,28 @@ describe('app dir - basic', () => {
}) })
} }
if (isNextStart) {
it('should contain framework.json', async () => {
const frameworksJson = await next.readJSON(
'.next/diagnostics/framework.json'
)
expect(frameworksJson).toEqual({
name: 'Next.js',
version: require('next/package.json').version,
})
})
it('outputs correct build-diagnostics.json', async () => {
const buildDiagnosticsJson = await next.readJSON(
'.next/diagnostics/build-diagnostics.json'
)
expect(buildDiagnosticsJson).toMatchObject({
buildStage: 'static-generation',
buildOptions: {},
})
})
}
if (isNextStart && !process.env.NEXT_EXPERIMENTAL_COMPILE) { if (isNextStart && !process.env.NEXT_EXPERIMENTAL_COMPILE) {
it('should not have loader generated function for edge runtime', async () => { it('should not have loader generated function for edge runtime', async () => {
expect( expect(
......
...@@ -1243,7 +1243,9 @@ ...@@ -1243,7 +1243,9 @@
"failed": [ "failed": [
"app dir - basic should encode chunk path correctly", "app dir - basic should encode chunk path correctly",
"app dir - basic should generate build traces correctly", "app dir - basic should generate build traces correctly",
"app dir - basic should not have loader generated function for edge runtime" "app dir - basic should not have loader generated function for edge runtime",
"app dir - basic should contain framework.json",
"app dir - basic outputs correct build-diagnostics.json"
], ],
"pending": [ "pending": [
"app dir - basic known bugs should support React fetch instrumentation client component", "app dir - basic known bugs should support React fetch instrumentation client component",
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