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

Fix recursive ignoring case in build traces #60740

Merged
merged 1 commit into from
Jan 16, 2024
Merged

Fix recursive ignoring case in build traces #60740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
80 changes: 50 additions & 30 deletions packages/next/src/build/collect-build-traces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ function shouldIgnore(
file: string,
serverIgnoreFn: (file: string) => boolean,
reasons: NodeFileTraceReasons,
cachedIgnoreFiles: Map<string, boolean>
cachedIgnoreFiles: Map<string, boolean>,
children: Set<string> = new Set()
) {
if (cachedIgnoreFiles.has(file)) {
return cachedIgnoreFiles.get(file)
Expand All @@ -47,24 +48,38 @@ function shouldIgnore(
cachedIgnoreFiles.set(file, true)
return true
}
children.add(file)

const reason = reasons.get(file)
if (!reason || reason.parents.size === 0 || reason.type.includes('initial')) {
cachedIgnoreFiles.set(file, false)
return false
}

if (
[...reason.parents.values()].every((parent) =>
shouldIgnore(parent, serverIgnoreFn, reasons, cachedIgnoreFiles)
)
) {
cachedIgnoreFiles.set(file, true)
return true
// if all parents are ignored the child file
// should be ignored as well
let allParentsIgnored = true

for (const parent of reason.parents.values()) {
if (!children.has(parent)) {
children.add(parent)
if (
!shouldIgnore(
parent,
serverIgnoreFn,
reasons,
cachedIgnoreFiles,
children
)
) {
allParentsIgnored = false
break
}
}
}

cachedIgnoreFiles.set(file, false)
return false
cachedIgnoreFiles.set(file, allParentsIgnored)
return allParentsIgnored
}

export async function collectBuildTraces({
Expand Down Expand Up @@ -265,6 +280,17 @@ export async function collectBuildTraces({
}
}

const makeIgnoreFn = (ignores: string[]) => (pathname: string) => {
if (path.isAbsolute(pathname) && !pathname.startsWith(root)) {
return true
}

return isMatch(pathname, ignores, {
contains: true,
dot: true,
})
}

const sharedIgnores = [
'**/next/dist/compiled/next-server/**/*.dev.js',
isStandalone ? null : '**/next/dist/compiled/jest-worker/**/*',
Expand Down Expand Up @@ -298,15 +324,19 @@ export async function collectBuildTraces({
'**/*.d.ts',
'**/*.map',
'**/next/dist/pages/**/*',
...(ciEnvironment.hasNextSupport ? ['**/node_modules/sharp/**/*'] : []),
...(ciEnvironment.hasNextSupport
? ['**/node_modules/sharp/**/*', '**/@img/sharp-libvips*/**/*']
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be **/node_modules/@img/sharp-libvips*/**/* instead (add the node_modules prefix)?

I'm also wondering why these need to be singled out. Couldn't we instead ignore **/*.node?

Copy link
Member Author

@ijjk ijjk Jan 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since this name is more specific should be ok without node_modules but doesn't hurt to add it, we can't ignore all .node files in general I don't think as there are valid native modules when deployed

Copy link
Member

@styfle styfle Jan 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In what case is a .node file "valid" vs "invalid"?

: []),
].filter(nonNullable)
const serverIgnoreFn = makeIgnoreFn(serverIgnores)

const minimalServerIgnores = [
...serverIgnores,
'**/next/dist/compiled/edge-runtime/**/*',
'**/next/dist/server/web/sandbox/**/*',
'**/next/dist/server/post-process.js',
]
const minimalServerIgnoreFn = makeIgnoreFn(minimalServerIgnores)

const routesIgnores = [
...sharedIgnores,
Expand All @@ -318,16 +348,8 @@ export async function collectBuildTraces({
'**/next/dist/server/post-process.js',
].filter(nonNullable)

const makeIgnoreFn = (ignores: string[]) => (pathname: string) => {
if (path.isAbsolute(pathname) && !pathname.startsWith(root)) {
return true
}
const routeIgnoreFn = makeIgnoreFn(routesIgnores)

return isMatch(pathname, ignores, {
contains: true,
dot: true,
})
}
const traceContext = path.join(nextServerEntry, '..', '..')
const serverTracedFiles = new Set<string>()
const minimalServerTracedFiles = new Set<string>()
Expand Down Expand Up @@ -379,10 +401,10 @@ export async function collectBuildTraces({
] as [Set<string>, string[]][]) {
for (const file of files) {
if (
!makeIgnoreFn(
!(
set === minimalServerTracedFiles
? minimalServerIgnores
: serverIgnores
? minimalServerIgnoreFn
: serverIgnoreFn
)(path.join(traceContext, file))
) {
addToTracedFiles(traceContext, file, set)
Expand Down Expand Up @@ -465,11 +487,9 @@ export async function collectBuildTraces({
if (
!shouldIgnore(
curFile,
makeIgnoreFn(
tracedFiles === minimalServerTracedFiles
? minimalServerIgnores
: serverIgnores
),
tracedFiles === minimalServerTracedFiles
? minimalServerIgnoreFn
: serverIgnoreFn,
reasons,
tracedFiles === minimalServerTracedFiles
? cachedLookupIgnoreMinimal
Expand Down Expand Up @@ -529,7 +549,7 @@ export async function collectBuildTraces({
if (
!shouldIgnore(
curFile,
makeIgnoreFn(routesIgnores),
routeIgnoreFn,
reasons,
cachedLookupIgnoreRoutes
)
Expand Down Expand Up @@ -574,7 +594,7 @@ export async function collectBuildTraces({

for (const item of await fs.readdir(contextDir)) {
const itemPath = path.relative(root, path.join(contextDir, item))
if (!makeIgnoreFn(serverIgnores)(itemPath)) {
if (!serverIgnoreFn(itemPath)) {
addToTracedFiles(root, itemPath, serverTracedFiles)
addToTracedFiles(root, itemPath, minimalServerTracedFiles)
}
Expand Down
3 changes: 3 additions & 0 deletions test/production/sharp-basic/pages/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default function Page() {
return <p>hello world</p>
}
22 changes: 22 additions & 0 deletions test/production/sharp-basic/sharp-basic.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { createNextDescribe } from 'e2e-utils'

createNextDescribe(
'sharp support with hasNextSupport',
{
files: __dirname,
dependencies: {
sharp: 'latest',
},
env: {
NOW_BUILDER: '1',
},
},
({ next }) => {
// we're mainly checking if build/start were successful so
// we have a basic assertion here
it('should work using cheerio', async () => {
const $ = await next.render$('/')
expect($('p').text()).toBe('hello world')
})
}
)