Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
N
next.js
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Alex
next.js
Commits
0fe5b23b
Unverified
Commit
0fe5b23b
authored
Oct 16, 2020
by
Joe Haddad
Committed by
GitHub
Oct 16, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add perf data experiment (#17956)
parent
6bc6e2c4
Hide whitespace changes
Inline
Side-by-side
Showing
9 changed files
with
216 additions
and
1 deletion
+216
-1
index.ts
packages/next/build/index.ts
+9
-0
webpack-config.ts
packages/next/build/webpack-config.ts
+3
-0
performance-relayer.ts
packages/next/client/performance-relayer.ts
+40
-0
config.ts
packages/next/next-server/server/config.ts
+1
-0
_app.js
test/integration/relay-analytics-disabled/pages/_app.js
+15
-0
index.js
test/integration/relay-analytics-disabled/pages/index.js
+25
-0
index.test.js
test/integration/relay-analytics-disabled/test/index.test.js
+72
-0
index.js
test/integration/relay-analytics/pages/index.js
+17
-0
index.test.js
test/integration/relay-analytics/test/index.test.js
+34
-1
No files found.
packages/next/build/index.ts
View file @
0fe5b23b
...
@@ -1159,6 +1159,15 @@ export default async function build(
...
@@ -1159,6 +1159,15 @@ export default async function build(
printCustomRoutes
({
redirects
,
rewrites
,
headers
})
printCustomRoutes
({
redirects
,
rewrites
,
headers
})
}
}
if
(
config
.
experimental
.
analyticsId
)
{
console
.
log
(
chalk
.
bold
.
green
(
'Next.js Analytics'
)
+
' is enabled for this production build. '
+
"You'll receive a Real Experience Score computed by all of your visitors."
)
console
.
log
(
''
)
}
if
(
tracer
)
{
if
(
tracer
)
{
const
parsedResults
=
await
tracer
.
profiler
.
stopProfiling
()
const
parsedResults
=
await
tracer
.
profiler
.
stopProfiling
()
await
new
Promise
((
resolve
)
=>
{
await
new
Promise
((
resolve
)
=>
{
...
...
packages/next/build/webpack-config.ts
View file @
0fe5b23b
...
@@ -1015,6 +1015,9 @@ export default async function getBaseWebpackConfig(
...
@@ -1015,6 +1015,9 @@ export default async function getBaseWebpackConfig(
'process.env.__NEXT_i18n_SUPPORT'
:
JSON
.
stringify
(
'process.env.__NEXT_i18n_SUPPORT'
:
JSON
.
stringify
(
!!
config
.
experimental
.
i18n
!!
config
.
experimental
.
i18n
),
),
'process.env.__NEXT_ANALYTICS_ID'
:
JSON
.
stringify
(
config
.
experimental
.
analyticsId
),
...(
isServer
...(
isServer
?
{
?
{
// Fix bad-actors in the npm ecosystem (e.g. `node-formidable`)
// Fix bad-actors in the npm ecosystem (e.g. `node-formidable`)
...
...
packages/next/client/performance-relayer.ts
View file @
0fe5b23b
...
@@ -8,6 +8,7 @@ import {
...
@@ -8,6 +8,7 @@ import {
ReportHandler
,
ReportHandler
,
}
from
'web-vitals'
}
from
'web-vitals'
const
initialHref
=
location
.
href
let
isRegistered
=
false
let
isRegistered
=
false
let
userReportHandler
:
ReportHandler
|
undefined
let
userReportHandler
:
ReportHandler
|
undefined
...
@@ -15,6 +16,45 @@ function onReport(metric: Metric) {
...
@@ -15,6 +16,45 @@ function onReport(metric: Metric) {
if
(
userReportHandler
)
{
if
(
userReportHandler
)
{
userReportHandler
(
metric
)
userReportHandler
(
metric
)
}
}
// This code is not shipped, executed, or present in the client-side
// JavaScript bundle unless explicitly enabled in your application.
//
// When this feature is enabled, we'll make it very clear by printing a
// message during the build (`next build`).
if
(
process
.
env
.
NODE_ENV
===
'production'
&&
// This field is empty unless you explicitly configure it:
process
.
env
.
__NEXT_ANALYTICS_ID
)
{
const
body
:
Record
<
string
,
string
>
=
{
dsn
:
process
.
env
.
__NEXT_ANALYTICS_ID
,
id
:
metric
.
id
,
page
:
window
.
__NEXT_DATA__
.
page
,
href
:
initialHref
,
event_name
:
metric
.
name
,
value
:
metric
.
value
.
toString
(),
speed
:
'connection'
in
navigator
&&
navigator
[
'connection'
]
&&
'effectiveType'
in
navigator
[
'connection'
]
?
(
navigator
[
'connection'
][
'effectiveType'
]
as
string
)
:
''
,
}
const
blob
=
new
Blob
([
new
URLSearchParams
(
body
).
toString
()],
{
// This content type is necessary for `sendBeacon`:
type
:
'application/x-www-form-urlencoded'
,
})
const
vitalsUrl
=
'https://vitals.vercel-analytics.com/v1/vitals'
;(
navigator
.
sendBeacon
&&
navigator
.
sendBeacon
(
vitalsUrl
,
blob
))
||
fetch
(
vitalsUrl
,
{
body
:
blob
,
method
:
'POST'
,
credentials
:
'omit'
,
keepalive
:
true
,
})
}
}
}
export
default
(
onPerfEntry
?:
ReportHandler
)
=>
{
export
default
(
onPerfEntry
?:
ReportHandler
)
=>
{
...
...
packages/next/next-server/server/config.ts
View file @
0fe5b23b
...
@@ -60,6 +60,7 @@ const defaultConfig: { [key: string]: any } = {
...
@@ -60,6 +60,7 @@ const defaultConfig: { [key: string]: any } = {
optimizeImages
:
false
,
optimizeImages
:
false
,
scrollRestoration
:
false
,
scrollRestoration
:
false
,
i18n
:
false
,
i18n
:
false
,
analyticsId
:
process
.
env
.
VERCEL_ANALYTICS_ID
||
''
,
},
},
future
:
{
future
:
{
excludeDefaultMomentLocales
:
false
,
excludeDefaultMomentLocales
:
false
,
...
...
test/integration/relay-analytics-disabled/pages/_app.js
0 → 100644
View file @
0fe5b23b
/* global localStorage */
/* eslint-disable camelcase */
import
App
from
'next/app'
export
default
class
MyApp
extends
App
{}
/*
Method is experimental and will eventually be handled in a Next.js plugin
*/
export
function
reportWebVitals
(
data
)
{
localStorage
.
setItem
(
data
.
name
||
data
.
entryType
,
data
.
value
!==
undefined
?
data
.
value
:
data
.
startTime
)
}
test/integration/relay-analytics-disabled/pages/index.js
0 → 100644
View file @
0fe5b23b
if
(
typeof
navigator
!==
'undefined'
)
{
window
.
__BEACONS
=
window
.
__BEACONS
||
[]
navigator
.
sendBeacon
=
async
function
()
{
const
args
=
await
Promise
.
all
(
[...
arguments
].
map
((
v
)
=>
{
if
(
v
instanceof
Blob
)
{
return
v
.
text
()
}
return
v
})
)
window
.
__BEACONS
.
push
(
args
)
}
}
export
default
()
=>
{
return
(
<
div
>
<
h1
>
Foo
!<
/h1
>
<
h2
>
bar
!<
/h2
>
<
/div
>
)
}
test/integration/relay-analytics-disabled/test/index.test.js
0 → 100644
View file @
0fe5b23b
/* eslint-env jest */
import
fs
from
'fs-extra'
import
{
findPort
,
killApp
,
nextBuild
,
nextStart
}
from
'next-test-utils'
import
webdriver
from
'next-webdriver'
import
path
,
{
join
}
from
'path'
const
appDir
=
join
(
__dirname
,
'../'
)
let
appPort
let
server
jest
.
setTimeout
(
1000
*
60
*
2
)
let
buildManifest
describe
(
'Analytics relayer (disabled)'
,
()
=>
{
let
stdout
beforeAll
(
async
()
=>
{
appPort
=
await
findPort
()
;({
stdout
}
=
await
nextBuild
(
appDir
,
[],
{
stdout
:
true
,
}))
buildManifest
=
require
(
path
.
join
(
appDir
,
'.next/build-manifest.json'
),
'utf8'
)
server
=
await
nextStart
(
appDir
,
appPort
)
})
afterAll
(()
=>
killApp
(
server
))
it
(
'Does not relay any data'
,
async
()
=>
{
const
browser
=
await
webdriver
(
appPort
,
'/'
)
await
browser
.
waitForElementByCss
(
'h1'
)
const
h1Text
=
await
browser
.
elementByCss
(
'h1'
).
text
()
const
firstContentfulPaint
=
parseFloat
(
await
browser
.
eval
(
'localStorage.getItem("FCP")'
)
)
expect
(
h1Text
).
toMatch
(
/Foo!/
)
expect
(
firstContentfulPaint
).
not
.
toBeNaN
()
expect
(
firstContentfulPaint
).
toBeGreaterThan
(
0
)
const
beacons
=
(
await
browser
.
eval
(
'window.__BEACONS'
)).
map
(([,
value
])
=>
Object
.
fromEntries
(
new
URLSearchParams
(
value
))
)
expect
(
beacons
.
length
).
toBe
(
0
)
expect
(
stdout
).
not
.
toMatch
(
'Next.js Analytics'
)
await
browser
.
close
()
})
it
(
'Does not include the code'
,
async
()
=>
{
const
pageFiles
=
[
...
new
Set
([
...
buildManifest
.
pages
[
'/'
].
filter
((
file
)
=>
file
.
endsWith
(
'.js'
)),
...
buildManifest
.
pages
[
'/_app'
].
filter
((
file
)
=>
file
.
endsWith
(
'.js'
)),
]),
]
expect
(
pageFiles
.
length
).
toBeGreaterThan
(
1
)
for
(
const
pageFile
of
pageFiles
)
{
const
content
=
await
fs
.
readFile
(
path
.
join
(
appDir
,
'.next'
,
pageFile
),
'utf8'
)
expect
(
content
).
not
.
toMatch
(
'vercel-analytics'
)
}
})
})
test/integration/relay-analytics/pages/index.js
View file @
0fe5b23b
if
(
typeof
navigator
!==
'undefined'
)
{
window
.
__BEACONS
=
window
.
__BEACONS
||
[]
navigator
.
sendBeacon
=
async
function
()
{
const
args
=
await
Promise
.
all
(
[...
arguments
].
map
((
v
)
=>
{
if
(
v
instanceof
Blob
)
{
return
v
.
text
()
}
return
v
})
)
window
.
__BEACONS
.
push
(
args
)
}
}
export
default
()
=>
{
export
default
()
=>
{
return
(
return
(
<
div
>
<
div
>
...
...
test/integration/relay-analytics/test/index.test.js
View file @
0fe5b23b
...
@@ -10,9 +10,13 @@ let server
...
@@ -10,9 +10,13 @@ let server
jest
.
setTimeout
(
1000
*
60
*
2
)
jest
.
setTimeout
(
1000
*
60
*
2
)
describe
(
'Analytics relayer'
,
()
=>
{
describe
(
'Analytics relayer'
,
()
=>
{
let
stdout
beforeAll
(
async
()
=>
{
beforeAll
(
async
()
=>
{
appPort
=
await
findPort
()
appPort
=
await
findPort
()
await
nextBuild
(
appDir
)
;({
stdout
}
=
await
nextBuild
(
appDir
,
[],
{
env
:
{
VERCEL_ANALYTICS_ID
:
'test'
},
stdout
:
true
,
}))
server
=
await
nextStart
(
appDir
,
appPort
)
server
=
await
nextStart
(
appDir
,
appPort
)
})
})
afterAll
(()
=>
killApp
(
server
))
afterAll
(()
=>
killApp
(
server
))
...
@@ -54,6 +58,35 @@ describe('Analytics relayer', () => {
...
@@ -54,6 +58,35 @@ describe('Analytics relayer', () => {
expect
(
cls
).
not
.
toBeNull
()
expect
(
cls
).
not
.
toBeNull
()
expect
(
largestContentfulPaint
).
not
.
toBeNaN
()
expect
(
largestContentfulPaint
).
not
.
toBeNaN
()
expect
(
largestContentfulPaint
).
toBeGreaterThan
(
0
)
expect
(
largestContentfulPaint
).
toBeGreaterThan
(
0
)
const
beacons
=
(
await
browser
.
eval
(
'window.__BEACONS'
)).
map
(([,
value
])
=>
Object
.
fromEntries
(
new
URLSearchParams
(
value
))
)
beacons
.
sort
((
a
,
b
)
=>
a
.
event_name
.
localeCompare
(
b
.
event_name
))
expect
(
beacons
.
length
).
toBe
(
2
)
expect
(
beacons
[
0
]).
toMatchObject
({
dsn
:
'test'
,
event_name
:
'FCP'
,
href
:
expect
.
stringMatching
(
'http://'
),
id
:
expect
.
stringContaining
(
'-'
),
page
:
'/'
,
speed
:
'4g'
,
value
:
expect
.
stringContaining
(
'.'
),
})
expect
(
beacons
[
1
]).
toMatchObject
({
dsn
:
'test'
,
event_name
:
'TTFB'
,
href
:
expect
.
stringMatching
(
'http://'
),
id
:
expect
.
stringContaining
(
'-'
),
page
:
'/'
,
speed
:
'4g'
,
value
:
expect
.
stringContaining
(
'.'
),
})
expect
(
stdout
).
toMatch
(
'Next.js Analytics'
)
await
browser
.
close
()
await
browser
.
close
()
})
})
})
})
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment