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.

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

Clarify app and pages file conflicting files #42415

Merged
merged 6 commits into from
Nov 3, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
58 changes: 32 additions & 26 deletions packages/next/build/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -576,36 +576,42 @@ export default async function build(
})
)

const pageKeys = {
pages: Object.keys(mappedPages),
app: mappedAppPages
? Object.keys(mappedAppPages).map(
(key) => normalizeAppPath(key) || '/'
)
: undefined,
}

if (pageKeys.app) {
const conflictingAppPagePaths = []

for (const appPath of pageKeys.app) {
if (pageKeys.pages.includes(appPath)) {
conflictingAppPagePaths.push(appPath)
const pagesPageKeys = Object.keys(mappedPages)

const conflictingAppPagePaths: [pagePath: string, appPath: string][] = []
const appPageKeys: string[] = []
if (mappedAppPages) {
for (const appKey in mappedAppPages) {
const normalizedAppPageKey = normalizeAppPath(appKey) || '/'
const pagePath = mappedPages[normalizedAppPageKey]
if (pagePath) {
const appPath = mappedAppPages[appKey]
conflictingAppPagePaths.push([
pagePath.replace(/^private-next-pages/, 'pages'),
appPath.replace(/^private-next-app-dir/, 'app'),
])
}

appPageKeys.push(normalizedAppPageKey)
}
const numConflicting = conflictingAppPagePaths.length
}

if (numConflicting > 0) {
Log.error(
`Conflicting app and page file${
numConflicting === 1 ? ' was' : 's were'
} found, please remove the conflicting files to continue:`
)
for (const p of conflictingAppPagePaths) {
Log.error(` "pages${p}" - "app${p}"`)
}
process.exit(1)
const pageKeys = {
pages: pagesPageKeys,
app: appPageKeys.length > 0 ? appPageKeys : undefined,
}

const numConflictingAppPaths = conflictingAppPagePaths.length
if (mappedAppPages && numConflictingAppPaths > 0) {
Log.error(
`Conflicting app and page file${
numConflictingAppPaths === 1 ? ' was' : 's were'
} found, please remove the conflicting files to continue:`
)
for (const [pagePath, appPath] of conflictingAppPagePaths) {
Log.error(` "${pagePath}" - "${appPath}"`)
}
process.exit(1)
}

const conflictingPublicFiles: string[] = []
Expand Down
20 changes: 14 additions & 6 deletions packages/next/server/dev/next-dev-server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,9 @@ export default class DevServer extends Server {
const appPaths: Record<string, string[]> = {}
const edgeRoutesSet = new Set<string>()
const pageNameSet = new Set<string>()
const conflictingAppPagePaths: string[] = []
const conflictingAppPagePaths = new Set<string>()
const appPageFilePaths = new Map<string, string>()
const pagesPageFilePaths = new Map<string, string>()

let envChange = false
let tsconfigChange = false
Expand Down Expand Up @@ -422,8 +424,13 @@ export default class DevServer extends Server {
pageName = pageName.replace(/\/index$/, '') || '/'
}

if (pageNameSet.has(pageName)) {
conflictingAppPagePaths.push(pageName)
;(isAppPath ? appPageFilePaths : pagesPageFilePaths).set(
pageName,
fileName
)

if (this.appDir && pageNameSet.has(pageName)) {
conflictingAppPagePaths.add(pageName)
} else {
pageNameSet.add(pageName)
}
Expand Down Expand Up @@ -451,17 +458,18 @@ export default class DevServer extends Server {
})
}

const numConflicting = conflictingAppPagePaths.length
const numConflicting = conflictingAppPagePaths.size
if (numConflicting > 0) {
Log.error(
`Conflicting app and page file${
numConflicting === 1 ? ' was' : 's were'
} found, please remove the conflicting files to continue:`
)
for (const p of conflictingAppPagePaths) {
Log.error(` "pages${p}" - "app${p}"`)
const appPath = relative(this.dir, appPageFilePaths.get(p)!)
const pagesPath = relative(this.dir, pagesPageFilePaths.get(p)!)
Log.error(` "${pagesPath}" - "${appPath}"`)
}
//process.exit(1)
}

if (!this.usingTypeScript && enabledTypeScript) {
Expand Down
3 changes: 3 additions & 0 deletions test/integration/conflicting-app-page-error/app/page.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default function Page(props) {
return <p>index page</p>
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default function Page() {
return <h1>Hello World!</h1>
}
24 changes: 18 additions & 6 deletions test/integration/conflicting-app-page-error/test/index.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,26 @@ function runTests({ dev }) {
it('should print error for conflicting app/page', async () => {
expect(output).toMatch(/Conflicting app and page files were found/)

for (const conflict of ['/hello', '/another']) {
expect(output).toContain(conflict)
for (const [pagePath, appPath] of [
['pages/index.js', 'app/page.js'],
['pages/hello.js', 'app/hello/page.js'],
['pages/another.js', 'app/another/page.js'],
]) {
expect(output).toContain(`"${pagePath}" - "${appPath}"`)
}
expect(output).not.toContain('/index')
expect(output).not.toContain('/non-conflict-pages')
expect(output).not.toContain('/non-conflict')
})

if (dev) {
it('should show error overlay for /', async () => {
const browser = await webdriver(appPort, '/')
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxHeader(browser)).toContain(
'Conflicting app and page file found: "app/page.js" and "pages/index.js". Please remove one to continue.'
)
})

it('should show error overlay for /hello', async () => {
const browser = await webdriver(appPort, '/hello')
expect(await hasRedbox(browser, true)).toBe(true)
Expand All @@ -45,11 +57,11 @@ function runTests({ dev }) {
)
})

it('should not show error overlay for /', async () => {
const browser = await webdriver(appPort, '/')
it('should not show error overlay for /non-conflict-pages', async () => {
const browser = await webdriver(appPort, '/non-conflict-pages')
expect(await hasRedbox(browser, false)).toBe(false)
expect(await getRedboxHeader(browser)).toBe(null)
expect(await browser.elementByCss('p').text()).toBe('index page')
expect(await browser.elementByCss('h1').text()).toBe('Hello World!')
})

it('should not show error overlay for /non-conflict', async () => {
Expand Down