Unverified Commit 7b9e711e authored by Will Binns-Smith's avatar Will Binns-Smith Committed by GitHub

Report HMR latency as trace spans for Turbopack (#60799)

This:
- Makes makes reporting hmr changes more accurate by emitting an
explicit start event and lowering the aggregation period for reporting
completed turbo tasks
- Parameterizes the aggregation period, allowing JS subscribers to
request different intervals, such as for the next-rs-api test
- Aligns path pattern with webpack by normalizing its layer names
- Fixes a bug in `drainAndGetNext` where the stream never could drain
past the first item
- Sends `client-hmr-latency` spans from Turbopack in both page and app
router pages


Closes PACK-2252

---------
Co-authored-by: 's avatarTobias Koppers <tobias.koppers@googlemail.com>
parent f6da5a0f
...@@ -696,6 +696,32 @@ pub fn project_hmr_identifiers_subscribe( ...@@ -696,6 +696,32 @@ pub fn project_hmr_identifiers_subscribe(
) )
} }
enum UpdateMessage {
Start,
End(UpdateInfo),
}
#[napi(object)]
struct NapiUpdateMessage {
pub update_type: String,
pub value: Option<NapiUpdateInfo>,
}
impl From<UpdateMessage> for NapiUpdateMessage {
fn from(update_message: UpdateMessage) -> Self {
match update_message {
UpdateMessage::Start => NapiUpdateMessage {
update_type: "start".to_string(),
value: None,
},
UpdateMessage::End(info) => NapiUpdateMessage {
update_type: "end".to_string(),
value: Some(info.into()),
},
}
}
}
#[napi(object)] #[napi(object)]
struct NapiUpdateInfo { struct NapiUpdateInfo {
pub duration: u32, pub duration: u32,
...@@ -714,20 +740,41 @@ impl From<UpdateInfo> for NapiUpdateInfo { ...@@ -714,20 +740,41 @@ impl From<UpdateInfo> for NapiUpdateInfo {
#[napi] #[napi]
pub fn project_update_info_subscribe( pub fn project_update_info_subscribe(
#[napi(ts_arg_type = "{ __napiType: \"Project\" }")] project: External<ProjectInstance>, #[napi(ts_arg_type = "{ __napiType: \"Project\" }")] project: External<ProjectInstance>,
aggregation_ms: u32,
func: JsFunction, func: JsFunction,
) -> napi::Result<()> { ) -> napi::Result<()> {
let func: ThreadsafeFunction<UpdateInfo> = func.create_threadsafe_function(0, |ctx| { let func: ThreadsafeFunction<UpdateMessage> = func.create_threadsafe_function(0, |ctx| {
let update_info = ctx.value; let message = ctx.value;
Ok(vec![NapiUpdateInfo::from(update_info)]) Ok(vec![NapiUpdateMessage::from(message)])
})?; })?;
let turbo_tasks = project.turbo_tasks.clone(); let turbo_tasks = project.turbo_tasks.clone();
tokio::spawn(async move { tokio::spawn(async move {
loop { loop {
let update_info = turbo_tasks let update_info = turbo_tasks
.get_or_wait_aggregated_update_info(Duration::from_secs(1)) .aggregated_update_info(Duration::ZERO, Duration::ZERO)
.await; .await;
let status = func.call(Ok(update_info), ThreadsafeFunctionCallMode::NonBlocking); func.call(
Ok(UpdateMessage::Start),
ThreadsafeFunctionCallMode::NonBlocking,
);
let update_info = match update_info {
Some(update_info) => update_info,
None => {
turbo_tasks
.get_or_wait_aggregated_update_info(Duration::from_millis(
aggregation_ms.into(),
))
.await
}
};
let status = func.call(
Ok(UpdateMessage::End(update_info)),
ThreadsafeFunctionCallMode::NonBlocking,
);
if !matches!(status, Status::Ok) { if !matches!(status, Status::Ok) {
let error = anyhow!("Error calling JS function: {}", status); let error = anyhow!("Error calling JS function: {}", status);
eprintln!("{}", error); eprintln!("{}", error);
......
...@@ -585,6 +585,15 @@ interface TurbopackStackFrame { ...@@ -585,6 +585,15 @@ interface TurbopackStackFrame {
methodName: string | null methodName: string | null
} }
export type UpdateMessage =
| {
updateType: 'start'
}
| {
updateType: 'end'
value: UpdateInfo
}
export interface UpdateInfo { export interface UpdateInfo {
duration: number duration: number
tasks: number tasks: number
...@@ -601,7 +610,9 @@ export interface Project { ...@@ -601,7 +610,9 @@ export interface Project {
traceSource( traceSource(
stackFrame: TurbopackStackFrame stackFrame: TurbopackStackFrame
): Promise<TurbopackStackFrame | null> ): Promise<TurbopackStackFrame | null>
updateInfoSubscribe(): AsyncIterableIterator<TurbopackResult<UpdateInfo>> updateInfoSubscribe(
aggregationMs: number
): AsyncIterableIterator<TurbopackResult<UpdateMessage>>
} }
export type Route = export type Route =
...@@ -984,11 +995,15 @@ function bindingToApi(binding: any, _wasm: boolean) { ...@@ -984,11 +995,15 @@ function bindingToApi(binding: any, _wasm: boolean) {
return binding.projectGetSourceForAsset(this._nativeProject, filePath) return binding.projectGetSourceForAsset(this._nativeProject, filePath)
} }
updateInfoSubscribe() { updateInfoSubscribe(aggregationMs: number) {
const subscription = subscribe<TurbopackResult<UpdateInfo>>( const subscription = subscribe<TurbopackResult<UpdateMessage>>(
true, true,
async (callback) => async (callback) =>
binding.projectUpdateInfoSubscribe(this._nativeProject, callback) binding.projectUpdateInfoSubscribe(
this._nativeProject,
aggregationMs,
callback
)
) )
return subscription return subscription
} }
......
...@@ -37,7 +37,11 @@ import { ...@@ -37,7 +37,11 @@ import {
import { parseComponentStack } from './internal/helpers/parse-component-stack' import { parseComponentStack } from './internal/helpers/parse-component-stack'
import type { VersionInfo } from '../../../server/dev/parse-version-info' import type { VersionInfo } from '../../../server/dev/parse-version-info'
import { HMR_ACTIONS_SENT_TO_BROWSER } from '../../../server/dev/hot-reloader-types' import { HMR_ACTIONS_SENT_TO_BROWSER } from '../../../server/dev/hot-reloader-types'
import type { HMR_ACTION_TYPES } from '../../../server/dev/hot-reloader-types' import type {
HMR_ACTION_TYPES,
TurbopackMsgToBrowser,
} from '../../../server/dev/hot-reloader-types'
import { extractModulesFromTurbopackMessage } from '../../../server/dev/extract-modules-from-turbopack-message'
interface Dispatcher { interface Dispatcher {
onBuildOk(): void onBuildOk(): void
...@@ -63,9 +67,18 @@ function onFastRefresh( ...@@ -63,9 +67,18 @@ function onFastRefresh(
sendMessage: (message: string) => void, sendMessage: (message: string) => void,
updatedModules: ReadonlyArray<string> updatedModules: ReadonlyArray<string>
) { ) {
let endLatency = Date.now()
dispatcher.onBuildOk() dispatcher.onBuildOk()
reportHmrLatency(sendMessage, updatedModules)
dispatcher.onRefresh()
}
function reportHmrLatency(
sendMessage: (message: string) => void,
updatedModules: ReadonlyArray<string>
) {
let endLatency = Date.now()
sendMessage( sendMessage(
JSON.stringify({ JSON.stringify({
event: 'client-hmr-latency', event: 'client-hmr-latency',
...@@ -79,10 +92,6 @@ function onFastRefresh( ...@@ -79,10 +92,6 @@ function onFastRefresh(
isPageHidden: document.visibilityState === 'hidden', isPageHidden: document.visibilityState === 'hidden',
}) })
) )
if (updatedModules.length > 0) {
dispatcher.onRefresh()
}
} }
// There is a newer version of the code available. // There is a newer version of the code available.
...@@ -237,6 +246,7 @@ function tryApplyUpdates( ...@@ -237,6 +246,7 @@ function tryApplyUpdates(
function processMessage( function processMessage(
obj: HMR_ACTION_TYPES, obj: HMR_ACTION_TYPES,
sendMessage: (message: string) => void, sendMessage: (message: string) => void,
processTurbopackMessage: (msg: TurbopackMsgToBrowser) => void,
router: ReturnType<typeof useRouter>, router: ReturnType<typeof useRouter>,
dispatcher: Dispatcher dispatcher: Dispatcher
) { ) {
...@@ -269,9 +279,9 @@ function processMessage( ...@@ -269,9 +279,9 @@ function processMessage(
} }
} }
function handleHotUpdate(updatedModules?: ReadonlyArray<string>) { function handleHotUpdate() {
if (process.env.TURBOPACK) { if (process.env.TURBOPACK) {
onFastRefresh(dispatcher, sendMessage, updatedModules || []) dispatcher.onBuildOk()
} else { } else {
tryApplyUpdates( tryApplyUpdates(
function onBeforeHotUpdate(hasUpdates: boolean) { function onBeforeHotUpdate(hasUpdates: boolean) {
...@@ -294,9 +304,6 @@ function processMessage( ...@@ -294,9 +304,6 @@ function processMessage(
console.log('[Fast Refresh] rebuilding') console.log('[Fast Refresh] rebuilding')
break break
} }
case HMR_ACTIONS_SENT_TO_BROWSER.FINISH_BUILDING: {
break
}
case HMR_ACTIONS_SENT_TO_BROWSER.BUILT: case HMR_ACTIONS_SENT_TO_BROWSER.BUILT:
case HMR_ACTIONS_SENT_TO_BROWSER.SYNC: { case HMR_ACTIONS_SENT_TO_BROWSER.SYNC: {
if (obj.hash) { if (obj.hash) {
...@@ -363,10 +370,27 @@ function processMessage( ...@@ -363,10 +370,27 @@ function processMessage(
if (obj.action === HMR_ACTIONS_SENT_TO_BROWSER.BUILT) { if (obj.action === HMR_ACTIONS_SENT_TO_BROWSER.BUILT) {
// Handle hot updates // Handle hot updates
handleHotUpdate(obj.updatedModules) handleHotUpdate()
} }
return return
} }
case HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED: {
processTurbopackMessage({
type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED,
})
break
}
case HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE: {
const updatedModules = extractModulesFromTurbopackMessage(obj.data)
dispatcher.onBeforeRefresh()
processTurbopackMessage({
type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE,
data: obj.data,
})
dispatcher.onRefresh()
reportHmrLatency(sendMessage, updatedModules)
break
}
// TODO-APP: make server component change more granular // TODO-APP: make server component change more granular
case HMR_ACTIONS_SENT_TO_BROWSER.SERVER_COMPONENT_CHANGES: { case HMR_ACTIONS_SENT_TO_BROWSER.SERVER_COMPONENT_CHANGES: {
sendMessage( sendMessage(
...@@ -501,10 +525,13 @@ export default function HotReload({ ...@@ -501,10 +525,13 @@ export default function HotReload({
const handler = (event: MessageEvent<any>) => { const handler = (event: MessageEvent<any>) => {
try { try {
const obj = JSON.parse(event.data) const obj = JSON.parse(event.data)
const handledByTurbopack = processTurbopackMessage?.(obj) processMessage(
if (!handledByTurbopack) { obj,
processMessage(obj, sendMessage, router, dispatcher) sendMessage,
} processTurbopackMessage,
router,
dispatcher
)
} catch (err: any) { } catch (err: any) {
console.warn( console.warn(
'[HMR] Invalid message: ' + event.data + '\n' + (err?.stack ?? '') '[HMR] Invalid message: ' + event.data + '\n' + (err?.stack ?? '')
......
import { useCallback, useContext, useEffect, useRef } from 'react' import { useCallback, useContext, useEffect, useRef } from 'react'
import { GlobalLayoutRouterContext } from '../../../../../shared/lib/app-router-context.shared-runtime' import { GlobalLayoutRouterContext } from '../../../../../shared/lib/app-router-context.shared-runtime'
import { getSocketUrl } from './get-socket-url' import { getSocketUrl } from './get-socket-url'
import type { import type { TurbopackMsgToBrowser } from '../../../../../server/dev/hot-reloader-types'
HMR_ACTION_TYPES,
TurbopackConnectedAction,
TurbopackMessageAction,
} from '../../../../../server/dev/hot-reloader-types'
export function useWebsocket(assetPrefix: string) { export function useWebsocket(assetPrefix: string) {
const webSocketRef = useRef<WebSocket>() const webSocketRef = useRef<WebSocket>()
...@@ -40,8 +36,8 @@ export function useSendMessage(webSocketRef: ReturnType<typeof useWebsocket>) { ...@@ -40,8 +36,8 @@ export function useSendMessage(webSocketRef: ReturnType<typeof useWebsocket>) {
export function useTurbopack(sendMessage: ReturnType<typeof useSendMessage>) { export function useTurbopack(sendMessage: ReturnType<typeof useSendMessage>) {
const turbopackState = useRef<{ const turbopackState = useRef<{
init: boolean init: boolean
queue: Array<TurbopackConnectedAction | TurbopackMessageAction> | undefined queue: Array<TurbopackMsgToBrowser> | undefined
callback: ((msg: HMR_ACTION_TYPES) => void) | undefined callback: ((msg: TurbopackMsgToBrowser) => void) | undefined
}>({ }>({
init: false, init: false,
// Until the dynamic import resolves, queue any turbopack messages which will be replayed. // Until the dynamic import resolves, queue any turbopack messages which will be replayed.
...@@ -49,17 +45,13 @@ export function useTurbopack(sendMessage: ReturnType<typeof useSendMessage>) { ...@@ -49,17 +45,13 @@ export function useTurbopack(sendMessage: ReturnType<typeof useSendMessage>) {
callback: undefined, callback: undefined,
}) })
const processTurbopackMessage = useCallback((msg: HMR_ACTION_TYPES) => { const processTurbopackMessage = useCallback((msg: TurbopackMsgToBrowser) => {
if ('type' in msg && msg.type?.startsWith('turbopack-')) { const { callback, queue } = turbopackState.current
const { callback, queue } = turbopackState.current if (callback) {
if (callback) { callback(msg)
callback(msg) } else {
} else { queue!.push(msg)
queue!.push(msg)
}
return true
} }
return false
}, []) }, [])
useEffect(() => { useEffect(() => {
...@@ -76,7 +68,7 @@ export function useTurbopack(sendMessage: ReturnType<typeof useSendMessage>) { ...@@ -76,7 +68,7 @@ export function useTurbopack(sendMessage: ReturnType<typeof useSendMessage>) {
).then(({ connect }) => { ).then(({ connect }) => {
const { current } = turbopackState const { current } = turbopackState
connect({ connect({
addMessageListener(cb: (msg: HMR_ACTION_TYPES) => void) { addMessageListener(cb: (msg: TurbopackMsgToBrowser) => void) {
current.callback = cb current.callback = cb
// Replay all Turbopack messages before we were able to establish the HMR client. // Replay all Turbopack messages before we were able to establish the HMR client.
......
...@@ -95,7 +95,6 @@ export default function initializeBuildWatcher( ...@@ -95,7 +95,6 @@ export default function initializeBuildWatcher(
break break
case HMR_ACTIONS_SENT_TO_BROWSER.BUILT: case HMR_ACTIONS_SENT_TO_BROWSER.BUILT:
case HMR_ACTIONS_SENT_TO_BROWSER.SYNC: case HMR_ACTIONS_SENT_TO_BROWSER.SYNC:
case HMR_ACTIONS_SENT_TO_BROWSER.FINISH_BUILDING:
hide() hide()
break break
} }
......
...@@ -39,7 +39,11 @@ import stripAnsi from 'next/dist/compiled/strip-ansi' ...@@ -39,7 +39,11 @@ import stripAnsi from 'next/dist/compiled/strip-ansi'
import { addMessageListener, sendMessage } from './websocket' import { addMessageListener, sendMessage } from './websocket'
import formatWebpackMessages from './format-webpack-messages' import formatWebpackMessages from './format-webpack-messages'
import { HMR_ACTIONS_SENT_TO_BROWSER } from '../../../server/dev/hot-reloader-types' import { HMR_ACTIONS_SENT_TO_BROWSER } from '../../../server/dev/hot-reloader-types'
import type { HMR_ACTION_TYPES } from '../../../server/dev/hot-reloader-types' import type {
HMR_ACTION_TYPES,
TurbopackMsgToBrowser,
} from '../../../server/dev/hot-reloader-types'
import { extractModulesFromTurbopackMessage } from '../../../server/dev/extract-modules-from-turbopack-message'
// This alternative WebpackDevServer combines the functionality of: // This alternative WebpackDevServer combines the functionality of:
// https://github.com/webpack/webpack-dev-server/blob/webpack-1/client/index.js // https://github.com/webpack/webpack-dev-server/blob/webpack-1/client/index.js
// https://github.com/webpack/webpack/blob/webpack-1/hot/dev-server.js // https://github.com/webpack/webpack/blob/webpack-1/hot/dev-server.js
...@@ -61,6 +65,7 @@ window.__nextDevClientId = Math.round(Math.random() * 100 + Date.now()) ...@@ -61,6 +65,7 @@ window.__nextDevClientId = Math.round(Math.random() * 100 + Date.now())
let hadRuntimeError = false let hadRuntimeError = false
let customHmrEventHandler: any let customHmrEventHandler: any
let turbopackMessageListeners: ((msg: TurbopackMsgToBrowser) => void)[] = []
let MODE: 'webpack' | 'turbopack' = 'webpack' let MODE: 'webpack' | 'turbopack' = 'webpack'
export default function connect(mode: 'webpack' | 'turbopack') { export default function connect(mode: 'webpack' | 'turbopack') {
MODE = mode MODE = mode
...@@ -87,6 +92,12 @@ export default function connect(mode: 'webpack' | 'turbopack') { ...@@ -87,6 +92,12 @@ export default function connect(mode: 'webpack' | 'turbopack') {
onUnrecoverableError() { onUnrecoverableError() {
hadRuntimeError = true hadRuntimeError = true
}, },
addTurbopackMessageListener(cb: (msg: TurbopackMsgToBrowser) => void) {
turbopackMessageListeners.push(cb)
},
sendTurbopackMessage(msg: string) {
sendMessage(msg)
},
} }
} }
...@@ -105,7 +116,7 @@ function clearOutdatedErrors() { ...@@ -105,7 +116,7 @@ function clearOutdatedErrors() {
} }
// Successful compilation. // Successful compilation.
function handleSuccess(updatedModules?: ReadonlyArray<string>) { function handleSuccess() {
clearOutdatedErrors() clearOutdatedErrors()
if (MODE === 'webpack') { if (MODE === 'webpack') {
...@@ -120,7 +131,6 @@ function handleSuccess(updatedModules?: ReadonlyArray<string>) { ...@@ -120,7 +131,6 @@ function handleSuccess(updatedModules?: ReadonlyArray<string>) {
tryApplyUpdates(onBeforeFastRefresh, onFastRefresh) tryApplyUpdates(onBeforeFastRefresh, onFastRefresh)
} }
} else { } else {
onFastRefresh(updatedModules)
onBuildOk() onBuildOk()
} }
} }
...@@ -195,7 +205,7 @@ function handleErrors(errors: any) { ...@@ -195,7 +205,7 @@ function handleErrors(errors: any) {
} }
} }
let startLatency: any = undefined let startLatency: number | undefined = undefined
function onBeforeFastRefresh(updatedModules: string[]) { function onBeforeFastRefresh(updatedModules: string[]) {
if (updatedModules.length > 0) { if (updatedModules.length > 0) {
...@@ -207,12 +217,16 @@ function onBeforeFastRefresh(updatedModules: string[]) { ...@@ -207,12 +217,16 @@ function onBeforeFastRefresh(updatedModules: string[]) {
function onFastRefresh(updatedModules: ReadonlyArray<string> = []) { function onFastRefresh(updatedModules: ReadonlyArray<string> = []) {
onBuildOk() onBuildOk()
if (updatedModules.length > 0) { if (updatedModules.length === 0) {
// Only complete a pending state if we applied updates return
// (cf. onBeforeFastRefresh)
onRefresh()
} }
onRefresh()
reportHmrLatency()
}
function reportHmrLatency(updatedModules: ReadonlyArray<string> = []) {
if (startLatency) { if (startLatency) {
const endLatency = Date.now() const endLatency = Date.now()
const latency = endLatency - startLatency const latency = endLatency - startLatency
...@@ -248,6 +262,7 @@ function processMessage(obj: HMR_ACTION_TYPES) { ...@@ -248,6 +262,7 @@ function processMessage(obj: HMR_ACTION_TYPES) {
return return
} }
// Use turbopack message for analytics, (still need built for webpack)
switch (obj.action) { switch (obj.action) {
case HMR_ACTIONS_SENT_TO_BROWSER.BUILDING: { case HMR_ACTIONS_SENT_TO_BROWSER.BUILDING: {
startLatency = Date.now() startLatency = Date.now()
...@@ -291,7 +306,7 @@ function processMessage(obj: HMR_ACTION_TYPES) { ...@@ -291,7 +306,7 @@ function processMessage(obj: HMR_ACTION_TYPES) {
clientId: window.__nextDevClientId, clientId: window.__nextDevClientId,
}) })
) )
return handleSuccess(obj.updatedModules) return handleSuccess()
} }
case HMR_ACTIONS_SENT_TO_BROWSER.SERVER_COMPONENT_CHANGES: { case HMR_ACTIONS_SENT_TO_BROWSER.SERVER_COMPONENT_CHANGES: {
window.location.reload() window.location.reload()
...@@ -307,6 +322,27 @@ function processMessage(obj: HMR_ACTION_TYPES) { ...@@ -307,6 +322,27 @@ function processMessage(obj: HMR_ACTION_TYPES) {
} }
return return
} }
case HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED: {
for (const listener of turbopackMessageListeners) {
listener({
type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED,
})
}
break
}
case HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE: {
const updatedModules = extractModulesFromTurbopackMessage(obj.data)
onBeforeFastRefresh(updatedModules)
for (const listener of turbopackMessageListeners) {
listener({
type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE,
data: obj.data,
})
}
onRefresh()
reportHmrLatency(updatedModules)
break
}
default: { default: {
if (customHmrEventHandler) { if (customHmrEventHandler) {
customHmrEventHandler(obj) customHmrEventHandler(obj)
......
...@@ -4,10 +4,9 @@ import initHMR from './dev/hot-middleware-client' ...@@ -4,10 +4,9 @@ import initHMR from './dev/hot-middleware-client'
import './setup-hydration-warning' import './setup-hydration-warning'
import { pageBootrap } from './page-bootstrap' import { pageBootrap } from './page-bootstrap'
import { addMessageListener, sendMessage } from './dev/error-overlay/websocket'
//@ts-expect-error requires "moduleResolution": "node16" in tsconfig.json and not .ts extension //@ts-expect-error requires "moduleResolution": "node16" in tsconfig.json and not .ts extension
import { connect } from '@vercel/turbopack-ecmascript-runtime/dev/client/hmr-client.ts' import { connect } from '@vercel/turbopack-ecmascript-runtime/dev/client/hmr-client.ts'
import type { HMR_ACTION_TYPES } from '../server/dev/hot-reloader-types' import type { TurbopackMsgToBrowser } from '../server/dev/hot-reloader-types'
window.next = { window.next = {
version: `${version}-turbo`, version: `${version}-turbo`,
...@@ -41,18 +40,10 @@ initialize({ ...@@ -41,18 +40,10 @@ initialize({
} }
connect({ connect({
addMessageListener(cb: (msg: HMR_ACTION_TYPES) => void) { addMessageListener(cb: (msg: TurbopackMsgToBrowser) => void) {
addMessageListener((msg) => { devClient.addTurbopackMessageListener(cb)
if (!('type' in msg)) {
return
}
// Only call Turbopack's message listener for turbopack messages
if (msg.type?.startsWith('turbopack-')) {
cb(msg)
}
})
}, },
sendMessage, sendMessage: devClient.sendTurbopackMessage,
}) })
return pageBootrap(assetPrefix) return pageBootrap(assetPrefix)
......
import type { Update as TurbopackUpdate } from '../../../build/swc' import type { Update as TurbopackUpdate } from '../../build/swc'
export function extractModulesFromTurbopackMessage( export function extractModulesFromTurbopackMessage(
data: TurbopackUpdate | TurbopackUpdate[] data: TurbopackUpdate | TurbopackUpdate[]
...@@ -7,6 +7,7 @@ export function extractModulesFromTurbopackMessage( ...@@ -7,6 +7,7 @@ export function extractModulesFromTurbopackMessage(
const updates = Array.isArray(data) ? data : [data] const updates = Array.isArray(data) ? data : [data]
for (const update of updates) { for (const update of updates) {
// TODO this won't capture changes to CSS since they don't result in a "merged" update
if ( if (
update.type !== 'partial' || update.type !== 'partial' ||
update.instruction.type !== 'ChunkListUpdate' || update.instruction.type !== 'ChunkListUpdate' ||
...@@ -30,5 +31,5 @@ export function extractModulesFromTurbopackMessage( ...@@ -30,5 +31,5 @@ export function extractModulesFromTurbopackMessage(
} }
} }
return updatedModules return [...updatedModules]
} }
...@@ -18,7 +18,6 @@ export const enum HMR_ACTIONS_SENT_TO_BROWSER { ...@@ -18,7 +18,6 @@ export const enum HMR_ACTIONS_SENT_TO_BROWSER {
SYNC = 'sync', SYNC = 'sync',
BUILT = 'built', BUILT = 'built',
BUILDING = 'building', BUILDING = 'building',
FINISH_BUILDING = 'finishBuilding',
DEV_PAGES_MANIFEST_UPDATE = 'devPagesManifestUpdate', DEV_PAGES_MANIFEST_UPDATE = 'devPagesManifestUpdate',
TURBOPACK_MESSAGE = 'turbopack-message', TURBOPACK_MESSAGE = 'turbopack-message',
SERVER_ERROR = 'serverError', SERVER_ERROR = 'serverError',
...@@ -31,7 +30,7 @@ interface ServerErrorAction { ...@@ -31,7 +30,7 @@ interface ServerErrorAction {
} }
export interface TurbopackMessageAction { export interface TurbopackMessageAction {
type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE action: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE
data: TurbopackUpdate | TurbopackUpdate[] data: TurbopackUpdate | TurbopackUpdate[]
} }
...@@ -39,23 +38,26 @@ interface BuildingAction { ...@@ -39,23 +38,26 @@ interface BuildingAction {
action: HMR_ACTIONS_SENT_TO_BROWSER.BUILDING action: HMR_ACTIONS_SENT_TO_BROWSER.BUILDING
} }
interface FinishBuildingAction { export interface CompilationError {
action: HMR_ACTIONS_SENT_TO_BROWSER.FINISH_BUILDING moduleName?: string
message: string
details?: string
moduleTrace?: Array<{ moduleName?: string }>
stack?: string
} }
export interface SyncAction { export interface SyncAction {
action: HMR_ACTIONS_SENT_TO_BROWSER.SYNC action: HMR_ACTIONS_SENT_TO_BROWSER.SYNC
hash: string hash: string
errors: ReadonlyArray<unknown> errors: ReadonlyArray<CompilationError>
warnings: ReadonlyArray<unknown> warnings: ReadonlyArray<CompilationError>
versionInfo: VersionInfo versionInfo: VersionInfo
updatedModules?: ReadonlyArray<string> updatedModules?: ReadonlyArray<string>
} }
interface BuiltAction { interface BuiltAction {
action: HMR_ACTIONS_SENT_TO_BROWSER.BUILT action: HMR_ACTIONS_SENT_TO_BROWSER.BUILT
hash: string hash: string
errors: ReadonlyArray<unknown> errors: ReadonlyArray<CompilationError>
warnings: ReadonlyArray<unknown> warnings: ReadonlyArray<CompilationError>
updatedModules?: ReadonlyArray<string> updatedModules?: ReadonlyArray<string>
} }
...@@ -100,14 +102,13 @@ interface DevPagesManifestUpdateAction { ...@@ -100,14 +102,13 @@ interface DevPagesManifestUpdateAction {
} }
export interface TurbopackConnectedAction { export interface TurbopackConnectedAction {
type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED action: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED
} }
export type HMR_ACTION_TYPES = export type HMR_ACTION_TYPES =
| TurbopackMessageAction | TurbopackMessageAction
| TurbopackConnectedAction | TurbopackConnectedAction
| BuildingAction | BuildingAction
| FinishBuildingAction
| SyncAction | SyncAction
| BuiltAction | BuiltAction
| AddedPageAction | AddedPageAction
...@@ -120,6 +121,10 @@ export type HMR_ACTION_TYPES = ...@@ -120,6 +121,10 @@ export type HMR_ACTION_TYPES =
| DevPagesManifestUpdateAction | DevPagesManifestUpdateAction
| ServerErrorAction | ServerErrorAction
export type TurbopackMsgToBrowser =
| { type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_MESSAGE; data: any }
| { type: HMR_ACTIONS_SENT_TO_BROWSER.TURBOPACK_CONNECTED }
export interface NextJsHotReloaderInterface { export interface NextJsHotReloaderInterface {
turbopackProject?: Project turbopackProject?: Project
activeWebpackConfigs?: Array<Awaited<ReturnType<typeof getBaseWebpackConfig>>> activeWebpackConfigs?: Array<Awaited<ReturnType<typeof getBaseWebpackConfig>>>
......
...@@ -56,7 +56,7 @@ import { ...@@ -56,7 +56,7 @@ import {
isMiddlewareFilename, isMiddlewareFilename,
} from '../../build/utils' } from '../../build/utils'
import { DecodeError } from '../../shared/lib/utils' import { DecodeError } from '../../shared/lib/utils'
import { Span, trace } from '../../trace' import { type Span, trace } from '../../trace'
import { getProperError } from '../../lib/is-error' import { getProperError } from '../../lib/is-error'
import ws from 'next/dist/compiled/ws' import ws from 'next/dist/compiled/ws'
import { existsSync, promises as fs } from 'fs' import { existsSync, promises as fs } from 'fs'
...@@ -386,16 +386,16 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -386,16 +386,16 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
switch (payload.event) { switch (payload.event) {
case 'span-end': { case 'span-end': {
new Span({ traceChild = {
name: payload.spanName, name: payload.spanName,
startTime: startTime:
BigInt(Math.floor(payload.startTime)) * BigInt(Math.floor(payload.startTime)) *
BigInt(MILLISECONDS_IN_NANOSECOND), BigInt(MILLISECONDS_IN_NANOSECOND),
attrs: payload.attributes, attrs: payload.attributes,
}).stop( endTime:
BigInt(Math.floor(payload.endTime)) * BigInt(Math.floor(payload.endTime)) *
BigInt(MILLISECONDS_IN_NANOSECOND) BigInt(MILLISECONDS_IN_NANOSECOND),
) }
break break
} }
case 'client-hmr-latency': { case 'client-hmr-latency': {
...@@ -408,7 +408,9 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -408,7 +408,9 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
BigInt(payload.endTime) * BigInt(MILLISECONDS_IN_NANOSECOND), BigInt(payload.endTime) * BigInt(MILLISECONDS_IN_NANOSECOND),
attrs: { attrs: {
updatedModules: payload.updatedModules.map((m: string) => updatedModules: payload.updatedModules.map((m: string) =>
m.replace(/^\.\//, '[project]/') m
.replace(`(${WEBPACK_LAYERS.appPagesBrowser})/`, '')
.replace(/^\.\//, '[project]/')
), ),
page: payload.page, page: payload.page,
isPageHidden: payload.isPageHidden, isPageHidden: payload.isPageHidden,
......
...@@ -108,18 +108,29 @@ function raceIterators<T>(iterators: AsyncIterableIterator<T>[]) { ...@@ -108,18 +108,29 @@ function raceIterators<T>(iterators: AsyncIterableIterator<T>[]) {
})() })()
} }
async function* filterMapAsyncIterator<T, U>(
iterator: AsyncIterableIterator<T>,
transform: (t: T) => U | undefined
): AsyncGenerator<Awaited<U>> {
for await (const val of iterator) {
const mapped = transform(val)
if (mapped !== undefined) {
yield mapped
}
}
}
/** /**
* Drains the stream until no value is available for 100ms, then returns the next value. * Drains the stream until no value is available for 100ms, then returns the next value.
*/ */
async function drainAndGetNext<T>( async function drainAndGetNext<T>(stream: AsyncIterableIterator<T>) {
stream: AsyncIterableIterator<TurbopackResult<T>>
) {
const next = stream.next()
while (true) { while (true) {
const next = stream.next()
const result = await Promise.race([ const result = await Promise.race([
new Promise((r) => setTimeout(() => r({ next }), 100)), new Promise((r) => setTimeout(() => r({ next }), 100)),
next.then(() => undefined), next.then(() => undefined),
]) ])
if (result) return result if (result) return result
} }
} }
...@@ -175,9 +186,7 @@ describe('next.rs api', () => { ...@@ -175,9 +186,7 @@ describe('next.rs api', () => {
afterAll(() => next.destroy()) afterAll(() => next.destroy())
let project: Project let project: Project
let projectUpdateSubscription: AsyncIterableIterator< let projectUpdateSubscription: AsyncIterableIterator<UpdateInfo>
TurbopackResult<UpdateInfo>
>
beforeAll(async () => { beforeAll(async () => {
console.log(next.testDir) console.log(next.testDir)
const nextConfig = await loadConfig(PHASE_DEVELOPMENT_SERVER, next.testDir) const nextConfig = await loadConfig(PHASE_DEVELOPMENT_SERVER, next.testDir)
...@@ -212,7 +221,10 @@ describe('next.rs api', () => { ...@@ -212,7 +221,10 @@ describe('next.rs api', () => {
previewModeId: undefined, previewModeId: undefined,
}), }),
}) })
projectUpdateSubscription = project.updateInfoSubscribe() projectUpdateSubscription = filterMapAsyncIterator(
project.updateInfoSubscribe(1000),
(update) => (update.updateType === 'end' ? update.value : undefined)
)
}) })
it('should detect the correct routes', async () => { it('should detect the correct routes', async () => {
......
...@@ -1578,8 +1578,6 @@ ...@@ -1578,8 +1578,6 @@
"basic HMR, basePath: \"\" Error Recovery should recover after an error reported via SSR", "basic HMR, basePath: \"\" Error Recovery should recover after an error reported via SSR",
"basic HMR, basePath: \"\" Error Recovery should recover after exporting an invalid page", "basic HMR, basePath: \"\" Error Recovery should recover after exporting an invalid page",
"basic HMR, basePath: \"\" Error Recovery should recover after undefined exported as default", "basic HMR, basePath: \"\" Error Recovery should recover after undefined exported as default",
"basic HMR, basePath: \"\" Error Recovery should recover from 404 after a page has been added",
"basic HMR, basePath: \"\" Error Recovery should recover from 404 after a page has been added with dynamic segments",
"basic HMR, basePath: \"\" Hot Module Reloading delete a page and add it back should load the page properly", "basic HMR, basePath: \"\" Hot Module Reloading delete a page and add it back should load the page properly",
"basic HMR, basePath: \"\" Hot Module Reloading editing a page should detect the changes and display it", "basic HMR, basePath: \"\" Hot Module Reloading editing a page should detect the changes and display it",
"basic HMR, basePath: \"\" Hot Module Reloading editing a page should not reload unrelated pages", "basic HMR, basePath: \"\" Hot Module Reloading editing a page should not reload unrelated pages",
...@@ -1596,8 +1594,6 @@ ...@@ -1596,8 +1594,6 @@
"basic HMR, basePath: \"/docs\" Error Recovery should recover after an error reported via SSR", "basic HMR, basePath: \"/docs\" Error Recovery should recover after an error reported via SSR",
"basic HMR, basePath: \"/docs\" Error Recovery should recover after exporting an invalid page", "basic HMR, basePath: \"/docs\" Error Recovery should recover after exporting an invalid page",
"basic HMR, basePath: \"/docs\" Error Recovery should recover after undefined exported as default", "basic HMR, basePath: \"/docs\" Error Recovery should recover after undefined exported as default",
"basic HMR, basePath: \"/docs\" Error Recovery should recover from 404 after a page has been added",
"basic HMR, basePath: \"/docs\" Error Recovery should recover from 404 after a page has been added with dynamic segments",
"basic HMR, basePath: \"/docs\" Hot Module Reloading delete a page and add it back should load the page properly", "basic HMR, basePath: \"/docs\" Hot Module Reloading delete a page and add it back should load the page properly",
"basic HMR, basePath: \"/docs\" Hot Module Reloading editing a page should detect the changes and display it", "basic HMR, basePath: \"/docs\" Hot Module Reloading editing a page should detect the changes and display it",
"basic HMR, basePath: \"/docs\" Hot Module Reloading editing a page should not reload unrelated pages", "basic HMR, basePath: \"/docs\" Hot Module Reloading editing a page should not reload unrelated pages",
...@@ -1611,6 +1607,8 @@ ...@@ -1611,6 +1607,8 @@
"failed": [ "failed": [
"basic HMR, basePath: \"\" Error Recovery should recover after loader parse error in an imported file", "basic HMR, basePath: \"\" Error Recovery should recover after loader parse error in an imported file",
"basic HMR, basePath: \"\" Error Recovery should recover after webpack parse error in an imported file", "basic HMR, basePath: \"\" Error Recovery should recover after webpack parse error in an imported file",
"basic HMR, basePath: \"\" Error Recovery should recover from 404 after a page has been added",
"basic HMR, basePath: \"\" Error Recovery should recover from 404 after a page has been added with dynamic segments",
"basic HMR, basePath: \"\" Error Recovery should recover from errors in getInitialProps in client", "basic HMR, basePath: \"\" Error Recovery should recover from errors in getInitialProps in client",
"basic HMR, basePath: \"\" Error Recovery should recover from errors in the render function", "basic HMR, basePath: \"\" Error Recovery should recover from errors in the render function",
"basic HMR, basePath: \"\" Full reload should warn about full reload in cli output - anonymous page function", "basic HMR, basePath: \"\" Full reload should warn about full reload in cli output - anonymous page function",
...@@ -1618,6 +1616,8 @@ ...@@ -1618,6 +1616,8 @@
"basic HMR, basePath: \"\" should have correct compile timing after fixing error", "basic HMR, basePath: \"\" should have correct compile timing after fixing error",
"basic HMR, basePath: \"/docs\" Error Recovery should recover after loader parse error in an imported file", "basic HMR, basePath: \"/docs\" Error Recovery should recover after loader parse error in an imported file",
"basic HMR, basePath: \"/docs\" Error Recovery should recover after webpack parse error in an imported file", "basic HMR, basePath: \"/docs\" Error Recovery should recover after webpack parse error in an imported file",
"basic HMR, basePath: \"/docs\" Error Recovery should recover from 404 after a page has been added",
"basic HMR, basePath: \"/docs\" Error Recovery should recover from 404 after a page has been added with dynamic segments",
"basic HMR, basePath: \"/docs\" Error Recovery should recover from errors in getInitialProps in client", "basic HMR, basePath: \"/docs\" Error Recovery should recover from errors in getInitialProps in client",
"basic HMR, basePath: \"/docs\" Error Recovery should recover from errors in the render function", "basic HMR, basePath: \"/docs\" Error Recovery should recover from errors in the render function",
"basic HMR, basePath: \"/docs\" Full reload should warn about full reload in cli output - anonymous page function", "basic HMR, basePath: \"/docs\" Full reload should warn about full reload in cli output - anonymous page function",
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