Unverified Commit 99bf5e9a authored by Sebastian "Sebbie" Silbermann's avatar Sebastian "Sebbie" Silbermann Committed by GitHub

Add (failing) test for module based feature telemetry in App Router (#75952)

Noticed this while adding bundle layers to Pages router. The telemetry Webpack plugin is picking up these features but then we're not recording them properly.
parent 2cbd03c8
import Image from 'next/image'
import LegacyImage from 'next/legacy/image'
import profilePic from '../../public/small.jpg'
function About() {
return (
<>
<h1>My Homepage</h1>
<LegacyImage src={profilePic} alt="Picture of the author" />
<Image src={profilePic} alt="Picture of the author" />
<p>Welcome to my homepage!</p>
</>
)
}
export default About
export default function Page() {
return 'hello world'
}
export default function RootLayout({ children }) {
return (
<html>
<body>{children}</body>
</html>
)
}
...@@ -84,7 +84,7 @@ describe('config telemetry', () => { ...@@ -84,7 +84,7 @@ describe('config telemetry', () => {
expect(event1).toMatch(/"reactStrictMode": false/) expect(event1).toMatch(/"reactStrictMode": false/)
expect(event1).toMatch(/"turboFlag": false/) expect(event1).toMatch(/"turboFlag": false/)
expect(event1).toMatch(/"pagesDir": true/) expect(event1).toMatch(/"pagesDir": true/)
expect(event1).toMatch(/"appDir": false/) expect(event1).toMatch(/"appDir": true/)
} catch (err) { } catch (err) {
require('console').error('failing stderr', stderr, err) require('console').error('failing stderr', stderr, err)
throw err throw err
...@@ -287,6 +287,7 @@ describe('config telemetry', () => { ...@@ -287,6 +287,7 @@ describe('config telemetry', () => {
expect.arrayContaining([ expect.arrayContaining([
{ {
featureName: 'next/image', featureName: 'next/image',
// FIXME: Should be +1 from App Router
invocationCount: 2, invocationCount: 2,
}, },
{ {
...@@ -532,12 +533,14 @@ describe('config telemetry', () => { ...@@ -532,12 +533,14 @@ describe('config telemetry', () => {
) )
// eslint-disable-next-line jest/no-standalone-expect // eslint-disable-next-line jest/no-standalone-expect
expect(featureUsageEvents).toContainEqual({ expect(featureUsageEvents).toContainEqual({
// FIXME: Should be +1 from App Router
featureName: 'next/legacy/image', featureName: 'next/legacy/image',
invocationCount: 2, invocationCount: 2,
}) })
// eslint-disable-next-line jest/no-standalone-expect // eslint-disable-next-line jest/no-standalone-expect
expect(featureUsageEvents).toContainEqual({ expect(featureUsageEvents).toContainEqual({
featureName: 'next/image', featureName: 'next/image',
// FIXME: Should be +1 from App Router
invocationCount: 2, invocationCount: 2,
}) })
} }
...@@ -724,6 +727,7 @@ describe('config telemetry', () => { ...@@ -724,6 +727,7 @@ describe('config telemetry', () => {
path.join(appDir, 'next.config.js') path.join(appDir, 'next.config.js')
) )
await fs.move(path.join(appDir, 'app'), path.join(appDir, '~app'))
await fs.move(path.join(appDir, '_app'), path.join(appDir, 'app')) await fs.move(path.join(appDir, '_app'), path.join(appDir, 'app'))
const { stderr } = await nextBuild(appDir, [], { const { stderr } = await nextBuild(appDir, [], {
...@@ -737,6 +741,7 @@ describe('config telemetry', () => { ...@@ -737,6 +741,7 @@ describe('config telemetry', () => {
) )
await fs.move(path.join(appDir, 'app'), path.join(appDir, '_app')) await fs.move(path.join(appDir, 'app'), path.join(appDir, '_app'))
await fs.move(path.join(appDir, '~app'), path.join(appDir, 'app'))
const featureUsageEvents = findAllTelemetryEvents( const featureUsageEvents = findAllTelemetryEvents(
stderr, stderr,
......
...@@ -382,8 +382,8 @@ describe('Telemetry CLI', () => { ...@@ -382,8 +382,8 @@ describe('Telemetry CLI', () => {
expect(event1).toMatch(/"ssrPageCount": 3/) expect(event1).toMatch(/"ssrPageCount": 3/)
expect(event1).toMatch(/"staticPageCount": 5/) expect(event1).toMatch(/"staticPageCount": 5/)
expect(event1).toMatch(/"totalPageCount": 12/) expect(event1).toMatch(/"totalPageCount": 12/)
expect(event1).toMatch(/"totalAppPagesCount": 0/) expect(event1).toMatch(/"totalAppPagesCount": 3/)
expect(event1).toMatch(/"staticAppPagesCount": 0/) expect(event1).toMatch(/"staticAppPagesCount": 3/)
expect(event1).toMatch(/"serverAppPagesCount": 0/) expect(event1).toMatch(/"serverAppPagesCount": 0/)
expect(event1).toMatch(/"edgeRuntimeAppCount": 0/) expect(event1).toMatch(/"edgeRuntimeAppCount": 0/)
expect(event1).toMatch(/"edgeRuntimePagesCount": 2/) expect(event1).toMatch(/"edgeRuntimePagesCount": 2/)
......
...@@ -11,39 +11,12 @@ import { ...@@ -11,39 +11,12 @@ import {
const appDir = path.join(__dirname, '..') const appDir = path.join(__dirname, '..')
const setupAppDir = async () => {
await fs.mkdir(path.join(__dirname, '../app'))
await fs.writeFile(
path.join(__dirname, '../app/layout.js'),
`
export default function RootLayout({ children }) {
return <html>
<head/>
<body>{children}</body>
</html>
}
`
)
await fs.ensureFile(path.join(__dirname, '../app/hello/page.js'))
await fs.writeFile(
path.join(__dirname, '../app/hello/page.js'),
'export default function Page() { return "hello world" }'
)
return async function teardownAppDir() {
await fs.remove(path.join(__dirname, '../app'))
}
}
describe('page features telemetry', () => { describe('page features telemetry', () => {
if (process.env.TURBOPACK) { if (process.env.TURBOPACK) {
it('detects --turbo correctly for `next dev`', async () => { it('detects --turbo correctly for `next dev`', async () => {
let port = await findPort() let port = await findPort()
let stderr = '' let stderr = ''
const teardown = await setupAppDir()
try {
const handleStderr = (msg) => { const handleStderr = (msg) => {
stderr += msg stderr += msg
} }
...@@ -73,18 +46,12 @@ describe('page features telemetry', () => { ...@@ -73,18 +46,12 @@ describe('page features telemetry', () => {
require('console').error('failing stderr', stderr, err) require('console').error('failing stderr', stderr, err)
throw err throw err
} }
} finally {
await teardown()
}
}) })
it('detects --turbo correctly for `next dev` stopped', async () => { it('detects --turbo correctly for `next dev` stopped', async () => {
let port = await findPort() let port = await findPort()
let stderr = '' let stderr = ''
const teardown = await setupAppDir()
try {
const handleStderr = (msg) => { const handleStderr = (msg) => {
stderr += msg stderr += msg
} }
...@@ -112,21 +79,15 @@ describe('page features telemetry', () => { ...@@ -112,21 +79,15 @@ describe('page features telemetry', () => {
expect(event1).toMatch(/"pagesDir": true/) expect(event1).toMatch(/"pagesDir": true/)
expect(event1).toMatch(/"turboFlag": true/) expect(event1).toMatch(/"turboFlag": true/)
expect( expect(await fs.pathExists(path.join(appDir, '.next/_events.json'))).toBe(
await fs.pathExists(path.join(appDir, '.next/_events.json')) false
).toBe(false) )
} finally {
await teardown()
}
}) })
} else { } else {
it('detects correctly for `next dev` stopped (no turbo)', async () => { it('detects correctly for `next dev` stopped (no turbo)', async () => {
let port = await findPort() let port = await findPort()
let stderr = '' let stderr = ''
const teardown = await setupAppDir()
try {
const handleStderr = (msg) => { const handleStderr = (msg) => {
stderr += msg stderr += msg
} }
...@@ -155,20 +116,14 @@ describe('page features telemetry', () => { ...@@ -155,20 +116,14 @@ describe('page features telemetry', () => {
expect(event1).toMatch(/"pagesDir": true/) expect(event1).toMatch(/"pagesDir": true/)
expect(event1).toMatch(/"appDir": true/) expect(event1).toMatch(/"appDir": true/)
expect( expect(await fs.pathExists(path.join(appDir, '.next/_events.json'))).toBe(
await fs.pathExists(path.join(appDir, '.next/_events.json')) false
).toBe(false) )
} finally {
await teardown()
}
}) })
;(process.env.TURBOPACK_DEV ? describe.skip : describe)( ;(process.env.TURBOPACK_DEV ? describe.skip : describe)(
'production mode', 'production mode',
() => { () => {
it('should detect app page counts', async () => { it('should detect app page counts', async () => {
const teardown = await setupAppDir()
try {
await fs.ensureFile(path.join(__dirname, '../app/ssr/page.js')) await fs.ensureFile(path.join(__dirname, '../app/ssr/page.js'))
await fs.writeFile( await fs.writeFile(
path.join(__dirname, '../app/ssr/page.js'), path.join(__dirname, '../app/ssr/page.js'),
...@@ -221,7 +176,7 @@ describe('page features telemetry', () => { ...@@ -221,7 +176,7 @@ describe('page features telemetry', () => {
expect(event1).toMatch(/"ssrPageCount": 3/) expect(event1).toMatch(/"ssrPageCount": 3/)
expect(event1).toMatch(/"staticPageCount": 5/) expect(event1).toMatch(/"staticPageCount": 5/)
expect(event1).toMatch(/"totalPageCount": 12/) expect(event1).toMatch(/"totalPageCount": 12/)
expect(event1).toMatch(/"totalAppPagesCount": 5/) expect(event1).toMatch(/"totalAppPagesCount": 6/)
expect(event1).toMatch(/"serverAppPagesCount": 2/) expect(event1).toMatch(/"serverAppPagesCount": 2/)
expect(event1).toMatch(/"edgeRuntimeAppCount": 1/) expect(event1).toMatch(/"edgeRuntimeAppCount": 1/)
expect(event1).toMatch(/"edgeRuntimePagesCount": 2/) expect(event1).toMatch(/"edgeRuntimePagesCount": 2/)
...@@ -231,14 +186,11 @@ describe('page features telemetry', () => { ...@@ -231,14 +186,11 @@ describe('page features telemetry', () => {
.exec(stderr) .exec(stderr)
.pop() .pop()
expect(event2).toMatch(/"totalAppPagesCount": 5/) expect(event2).toMatch(/"totalAppPagesCount": 6/)
} catch (err) { } catch (err) {
require('console').error('failing stderr', stderr, err) require('console').error('failing stderr', stderr, err)
throw err throw err
} }
} finally {
await teardown()
}
}) })
it('detects reportWebVitals with no _app correctly for `next build`', async () => { it('detects reportWebVitals with no _app correctly for `next build`', async () => {
......
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