Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include proper instrumentation entry in required files manifest #68983

Merged
merged 6 commits into from
Aug 19, 2024
Merged

Include proper instrumentation entry in required files manifest #68983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7721f32
include proper instrumentation entry
huozhi Aug 16, 2024
bff7fe9
Fix edge-instrumentation.js missing in deployment
huozhi Aug 16, 2024
c5bb768
fix test path
huozhi Aug 16, 2024
009d798
write manifest later
huozhi Aug 19, 2024
c972b5a
rm comments
huozhi Aug 19, 2024
dda3606
Merge branch 'canary' into 08-16-include_proper_instrumentation_entry
huozhi Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
199 changes: 102 additions & 97 deletions packages/next/src/build/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1236,103 +1236,6 @@ export default async function build(
PAGES_MANIFEST
)

const { cacheHandler } = config

const requiredServerFilesManifest = nextBuildSpan
.traceChild('generate-required-server-files')
.traceFn(() => {
const serverFilesManifest: RequiredServerFilesManifest = {
version: 1,
config: {
...config,
configFile: undefined,
...(ciEnvironment.hasNextSupport
? {
compress: false,
}
: {}),
cacheHandler: cacheHandler
? path.relative(distDir, cacheHandler)
: config.cacheHandler,
experimental: {
...config.experimental,
trustHostHeader: ciEnvironment.hasNextSupport,

// @ts-expect-error internal field TODO: fix this, should use a separate mechanism to pass the info.
isExperimentalCompile: isCompileMode,
},
},
appDir: dir,
relativeAppDir: path.relative(outputFileTracingRoot, dir),
files: [
ROUTES_MANIFEST,
path.relative(distDir, pagesManifestPath),
BUILD_MANIFEST,
PRERENDER_MANIFEST,
path.join(SERVER_DIRECTORY, MIDDLEWARE_MANIFEST),
path.join(SERVER_DIRECTORY, MIDDLEWARE_BUILD_MANIFEST + '.js'),
path.join(
SERVER_DIRECTORY,
MIDDLEWARE_REACT_LOADABLE_MANIFEST + '.js'
),
...(appDir
? [
...(config.experimental.sri
? [
path.join(
SERVER_DIRECTORY,
SUBRESOURCE_INTEGRITY_MANIFEST + '.js'
),
path.join(
SERVER_DIRECTORY,
SUBRESOURCE_INTEGRITY_MANIFEST + '.json'
),
]
: []),
path.join(SERVER_DIRECTORY, APP_PATHS_MANIFEST),
path.join(APP_PATH_ROUTES_MANIFEST),
APP_BUILD_MANIFEST,
path.join(
SERVER_DIRECTORY,
SERVER_REFERENCE_MANIFEST + '.js'
),
path.join(
SERVER_DIRECTORY,
SERVER_REFERENCE_MANIFEST + '.json'
),
]
: []),
REACT_LOADABLE_MANIFEST,
config.optimizeFonts
? path.join(
SERVER_DIRECTORY,
AUTOMATIC_FONT_OPTIMIZATION_MANIFEST
)
: null,
BUILD_ID_FILE,
path.join(SERVER_DIRECTORY, NEXT_FONT_MANIFEST + '.js'),
path.join(SERVER_DIRECTORY, NEXT_FONT_MANIFEST + '.json'),
...(hasInstrumentationHook
? [
path.join(
SERVER_DIRECTORY,
`${INSTRUMENTATION_HOOK_FILENAME}.js`
),
path.join(
SERVER_DIRECTORY,
`edge-${INSTRUMENTATION_HOOK_FILENAME}.js`
),
]
: []),
]
.filter(nonNullable)
.map((file) => path.join(config.distDir, file)),
ignore: [] as string[],
}

return serverFilesManifest
})

async function turbopackBuild(): Promise<{
duration: number
buildTraceContext: undefined
Expand Down Expand Up @@ -2352,6 +2255,108 @@ export default async function build(
)
}

const { cacheHandler } = config

const instrumentationHookEntryFiles: string[] = []
if (hasInstrumentationHook) {
instrumentationHookEntryFiles.push(
path.join(SERVER_DIRECTORY, `${INSTRUMENTATION_HOOK_FILENAME}.js`)
)
// If there's edge routes, append the edge instrumentation hook
if (edgeRuntimeAppCount || edgeRuntimePagesCount) {
instrumentationHookEntryFiles.push(
path.join(
SERVER_DIRECTORY,
`edge-${INSTRUMENTATION_HOOK_FILENAME}.js`
)
)
}
}

const requiredServerFilesManifest = nextBuildSpan
.traceChild('generate-required-server-files')
.traceFn(() => {
const serverFilesManifest: RequiredServerFilesManifest = {
version: 1,
config: {
...config,
configFile: undefined,
...(ciEnvironment.hasNextSupport
? {
compress: false,
}
: {}),
cacheHandler: cacheHandler
? path.relative(distDir, cacheHandler)
: config.cacheHandler,
experimental: {
...config.experimental,
trustHostHeader: ciEnvironment.hasNextSupport,

// @ts-expect-error internal field TODO: fix this, should use a separate mechanism to pass the info.
isExperimentalCompile: isCompileMode,
},
},
appDir: dir,
relativeAppDir: path.relative(outputFileTracingRoot, dir),
files: [
ROUTES_MANIFEST,
path.relative(distDir, pagesManifestPath),
BUILD_MANIFEST,
PRERENDER_MANIFEST,
path.join(SERVER_DIRECTORY, MIDDLEWARE_MANIFEST),
path.join(SERVER_DIRECTORY, MIDDLEWARE_BUILD_MANIFEST + '.js'),
path.join(
SERVER_DIRECTORY,
MIDDLEWARE_REACT_LOADABLE_MANIFEST + '.js'
),
...(appDir
? [
...(config.experimental.sri
? [
path.join(
SERVER_DIRECTORY,
SUBRESOURCE_INTEGRITY_MANIFEST + '.js'
),
path.join(
SERVER_DIRECTORY,
SUBRESOURCE_INTEGRITY_MANIFEST + '.json'
),
]
: []),
path.join(SERVER_DIRECTORY, APP_PATHS_MANIFEST),
path.join(APP_PATH_ROUTES_MANIFEST),
APP_BUILD_MANIFEST,
path.join(
SERVER_DIRECTORY,
SERVER_REFERENCE_MANIFEST + '.js'
),
path.join(
SERVER_DIRECTORY,
SERVER_REFERENCE_MANIFEST + '.json'
),
]
: []),
REACT_LOADABLE_MANIFEST,
config.optimizeFonts
? path.join(
SERVER_DIRECTORY,
AUTOMATIC_FONT_OPTIMIZATION_MANIFEST
)
: null,
BUILD_ID_FILE,
path.join(SERVER_DIRECTORY, NEXT_FONT_MANIFEST + '.js'),
path.join(SERVER_DIRECTORY, NEXT_FONT_MANIFEST + '.json'),
...instrumentationHookEntryFiles,
]
.filter(nonNullable)
.map((file) => path.join(config.distDir, file)),
ignore: [] as string[],
}

return serverFilesManifest
})

if (!hasSsrAmpPages) {
requiredServerFilesManifest.ignore.push(
path.relative(
Expand Down
3 changes: 3 additions & 0 deletions test/production/instrumentation/required-files-instrumentation-entry/app/node/route.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export function GET() {
return new Response('node')
}
1 change: 1 addition & 0 deletions test/production/instrumentation/required-files-instrumentation-entry/instrumentation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export function register() {}
6 changes: 6 additions & 0 deletions test/production/instrumentation/required-files-instrumentation-entry/next.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/** @type {import('next').NextConfig} */
module.exports = {
experimental: {
instrumentationHook: true,
},
}
19 changes: 19 additions & 0 deletions ...ntation/required-files-instrumentation-entry/required-files-instrumentation-entry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import { nextTestSetup } from 'e2e-utils'

async function readRequiredFilesManifest(next: any) {
const manifest = JSON.parse(
await next.readFile('.next/required-server-files.json')
)
return manifest.files
}

describe('instrumentation - required-files-instrumentation-entry', () => {
const { next } = nextTestSetup({
files: __dirname,
})

it('should not contain edge entry in required files manifest', async () => {
const requiredFiles = await readRequiredFilesManifest(next)
expect(requiredFiles).not.toContain('.next/server/edge-instrumentation.js')
})
})
Loading