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

next.js: complete v14.x compatibility (fixing >=14.2.7) #4916

Merged
merged 2 commits into from
Nov 21, 2024
Merged

next.js: complete v14.x compatibility (fixing >=14.2.7) #4916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab4fffc
next.js: fix compatibility with 14.2.7
tlhunter Nov 20, 2024
437d328
test >=14.2.7 <15
tlhunter Nov 21, 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
3 changes: 2 additions & 1 deletion .github/workflows/appsec.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,11 +205,12 @@ jobs:

next:
strategy:
fail-fast: false
matrix:
version:
- 18
- latest
range: ['9.5.0', '11.1.4', '13.2.0', '14.2.6']
range: ['9.5.0', '11.1.4', '13.2.0', '>=14.0.0 <=14.2.6', '>=14.2.7 <15']
runs-on: ubuntu-latest
env:
PLUGINS: next
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/plugins.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,11 +742,12 @@ jobs:
# TODO: fix performance issues and test more Node versions
next:
strategy:
fail-fast: false
matrix:
version:
- 18
- latest
range: ['9.5.0', '11.1.4', '13.2.0', '14.2.6']
range: ['9.5.0', '11.1.4', '13.2.0', '>=14.0.0 <=14.2.6', '>=14.2.7 <15']
runs-on: ubuntu-latest
env:
PLUGINS: next
Expand Down
26 changes: 19 additions & 7 deletions packages/datadog-instrumentations/src/next.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,14 @@ const queryParsedChannel = channel('apm:next:query-parsed')
const requests = new WeakSet()
const nodeNextRequestsToNextRequests = new WeakMap()

// Next.js <= 14.2.6
const MIDDLEWARE_HEADER = 'x-middleware-invoke'

// Next.js >= 14.2.7
const NEXT_REQUEST_META = Symbol.for('NextInternalRequestMeta')
const META_IS_MIDDLEWARE = 'middlewareInvoke'
const encounteredMiddleware = new WeakSet()

function wrapHandleRequest (handleRequest) {
return function (req, res, pathname, query) {
return instrument(req, res, () => handleRequest.apply(this, arguments))
Expand Down Expand Up @@ -111,6 +117,11 @@ function getPageFromPath (page, dynamicRoutes = []) {
return getPagePath(page)
}

function getRequestMeta (req, key) {
const meta = req[NEXT_REQUEST_META] || {}
return typeof key === 'string' ? meta[key] : meta
}

function instrument (req, res, error, handler) {
if (typeof error === 'function') {
handler = error
Expand All @@ -121,8 +132,9 @@ function instrument (req, res, error, handler) {
res = res.originalResponse || res

// TODO support middleware properly in the future?
const isMiddleware = req.headers[MIDDLEWARE_HEADER]
if (isMiddleware || requests.has(req)) {
const isMiddleware = req.headers[MIDDLEWARE_HEADER] || getRequestMeta(req, META_IS_MIDDLEWARE)
if ((isMiddleware && !encounteredMiddleware.has(req)) || requests.has(req)) {
encounteredMiddleware.add(req)
if (error) {
errorChannel.publish({ error })
}
Expand Down Expand Up @@ -188,7 +200,7 @@ function finish (ctx, result, err) {
// however, it is not provided as a class function or exported property
addHook({
name: 'next',
versions: ['>=13.3.0 <14.2.7'],
versions: ['>=13.3.0 <15'],
file: 'dist/server/web/spec-extension/adapters/next-request.js'
}, NextRequestAdapter => {
shimmer.wrap(NextRequestAdapter.NextRequestAdapter, 'fromNodeNextRequest', fromNodeNextRequest => {
Expand All @@ -203,7 +215,7 @@ addHook({

addHook({
name: 'next',
versions: ['>=11.1 <14.2.7'],
versions: ['>=11.1 <15'],
file: 'dist/server/serve-static.js'
}, serveStatic => shimmer.wrap(serveStatic, 'serveStatic', wrapServeStatic))

Expand All @@ -213,7 +225,7 @@ addHook({
file: 'dist/next-server/server/serve-static.js'
}, serveStatic => shimmer.wrap(serveStatic, 'serveStatic', wrapServeStatic))

addHook({ name: 'next', versions: ['>=11.1 <14.2.7'], file: 'dist/server/next-server.js' }, nextServer => {
addHook({ name: 'next', versions: ['>=11.1 <15'], file: 'dist/server/next-server.js' }, nextServer => {
const Server = nextServer.default

shimmer.wrap(Server.prototype, 'handleRequest', wrapHandleRequest)
Expand All @@ -230,7 +242,7 @@ addHook({ name: 'next', versions: ['>=11.1 <14.2.7'], file: 'dist/server/next-se
})

// `handleApiRequest` changes parameters/implementation at 13.2.0
addHook({ name: 'next', versions: ['>=13.2 <14.2.7'], file: 'dist/server/next-server.js' }, nextServer => {
addHook({ name: 'next', versions: ['>=13.2 <15'], file: 'dist/server/next-server.js' }, nextServer => {
const Server = nextServer.default
shimmer.wrap(Server.prototype, 'handleApiRequest', wrapHandleApiRequestWithMatch)
return nextServer
Expand Down Expand Up @@ -264,7 +276,7 @@ addHook({

addHook({
name: 'next',
versions: ['>=13 <14.2.7'],
versions: ['>=13 <15'],
file: 'dist/server/web/spec-extension/request.js'
}, request => {
const nextUrlDescriptor = Object.getOwnPropertyDescriptor(request.NextRequest.prototype, 'nextUrl')
Expand Down
Loading