Unverified Commit be43ff10 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

[segment explorer] open in editor (#80856)

When click each file label in segment explorer, open the file in editor.


https://github.com/user-attachments/assets/fcec113c-2d65-477c-9b44-22d46dcc42ae
parent 28e07270
...@@ -114,11 +114,14 @@ function PageSegmentTreeLayerPresentation({ ...@@ -114,11 +114,14 @@ function PageSegmentTreeLayerPresentation({
if (!childNode || !childNode.value) { if (!childNode || !childNode.value) {
return null return null
} }
const fileName = const filePath = childNode.value.pagePath
childNode.value.pagePath.split('/').pop() || '' const fileName = filePath.split('/').pop() || ''
return ( return (
<span <span
key={fileChildSegment} key={fileChildSegment}
onClick={() => {
openInEditor({ filePath })
}}
className={cx( className={cx(
'segment-explorer-file-label', 'segment-explorer-file-label',
`segment-explorer-file-label--${childNode.value.type}` `segment-explorer-file-label--${childNode.value.type}`
...@@ -215,6 +218,7 @@ export const DEV_TOOLS_INFO_RENDER_FILES_STYLES = css` ...@@ -215,6 +218,7 @@ export const DEV_TOOLS_INFO_RENDER_FILES_STYLES = css`
font-size: var(--size-12); font-size: var(--size-12);
font-weight: 500; font-weight: 500;
user-select: none; user-select: none;
cursor: pointer;
} }
.segment-explorer-file-label--layout, .segment-explorer-file-label--layout,
.segment-explorer-file-label--template, .segment-explorer-file-label--template,
...@@ -242,3 +246,17 @@ export const DEV_TOOLS_INFO_RENDER_FILES_STYLES = css` ...@@ -242,3 +246,17 @@ export const DEV_TOOLS_INFO_RENDER_FILES_STYLES = css`
color: var(--color-red-900); color: var(--color-red-900);
} }
` `
function openInEditor({ filePath }: { filePath: string }) {
const params = new URLSearchParams({
file: filePath,
// Mark the file path is relative to the app directory,
// The editor launcher will complete the full path for it.
isAppRelativePath: '1',
})
fetch(
`${
process.env.__NEXT_ROUTER_BASEPATH || ''
}/__nextjs_launch-editor?${params.toString()}`
)
}
...@@ -24,6 +24,7 @@ ...@@ -24,6 +24,7 @@
import { cyan, green, red } from '../../lib/picocolors' import { cyan, green, red } from '../../lib/picocolors'
import child_process from 'child_process' import child_process from 'child_process'
import fs from 'fs' import fs from 'fs'
import fsp from 'fs/promises'
import os from 'os' import os from 'os'
import path from 'path' import path from 'path'
import shellQuote from 'next/dist/compiled/shell-quote' import shellQuote from 'next/dist/compiled/shell-quote'
...@@ -428,3 +429,28 @@ export function launchEditor( ...@@ -428,3 +429,28 @@ export function launchEditor(
}) })
} }
} }
// Open the file in editor if exists, otherwise return an error
export async function openFileInEditor(
filePath: string,
line: number,
col: number
) {
const result = {
found: false,
error: null as Error | null,
}
const existed = await fsp.access(filePath, fs.constants.F_OK).then(
() => true,
() => false
)
if (existed) {
try {
launchEditor(filePath, line, col)
result.found = true
} catch (err) {
result.error = err as Error
}
}
return result
}
...@@ -156,7 +156,7 @@ function getSourceMapFromTurbopack( ...@@ -156,7 +156,7 @@ function getSourceMapFromTurbopack(
} }
export async function createHotReloaderTurbopack( export async function createHotReloaderTurbopack(
opts: SetupOpts, opts: SetupOpts & { isSrcDir: boolean },
serverFields: ServerFields, serverFields: ServerFields,
distDir: string, distDir: string,
resetFetch: () => void resetFetch: () => void
...@@ -652,7 +652,11 @@ export async function createHotReloaderTurbopack( ...@@ -652,7 +652,11 @@ export async function createHotReloaderTurbopack(
) )
const middlewares = [ const middlewares = [
getOverlayMiddleware(project, projectPath), getOverlayMiddleware({
project,
projectPath,
isSrcDir: opts.isSrcDir,
}),
getSourceMapMiddleware(project), getSourceMapMiddleware(project),
getNextErrorFeedbackMiddleware(opts.telemetry), getNextErrorFeedbackMiddleware(opts.telemetry),
getDevOverlayFontMiddleware(), getDevOverlayFontMiddleware(),
......
...@@ -262,6 +262,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -262,6 +262,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
} }
private devtoolsFrontendUrl: string | undefined private devtoolsFrontendUrl: string | undefined
private reloadAfterInvalidation: boolean = false private reloadAfterInvalidation: boolean = false
private isSrcDir: boolean
public serverStats: webpack.Stats | null public serverStats: webpack.Stats | null
public edgeServerStats: webpack.Stats | null public edgeServerStats: webpack.Stats | null
...@@ -274,6 +275,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -274,6 +275,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
dir: string, dir: string,
{ {
config, config,
isSrcDir,
pagesDir, pagesDir,
distDir, distDir,
buildId, buildId,
...@@ -285,6 +287,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -285,6 +287,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
resetFetch, resetFetch,
}: { }: {
config: NextConfigComplete config: NextConfigComplete
isSrcDir: boolean
pagesDir?: string pagesDir?: string
distDir: string distDir: string
buildId: string buildId: string
...@@ -302,6 +305,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -302,6 +305,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
this.buildId = buildId this.buildId = buildId
this.encryptionKey = encryptionKey this.encryptionKey = encryptionKey
this.dir = dir this.dir = dir
this.isSrcDir = isSrcDir
this.middlewares = [] this.middlewares = []
this.pagesDir = pagesDir this.pagesDir = pagesDir
this.appDir = appDir this.appDir = appDir
...@@ -1567,6 +1571,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -1567,6 +1571,7 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
this.middlewares = [ this.middlewares = [
getOverlayMiddleware({ getOverlayMiddleware({
rootDirectory: this.dir, rootDirectory: this.dir,
isSrcDir: this.isSrcDir,
clientStats: () => this.clientStats, clientStats: () => this.clientStats,
serverStats: () => this.serverStats, serverStats: () => this.serverStats,
edgeServerStats: () => this.edgeServerStats, edgeServerStats: () => this.edgeServerStats,
......
...@@ -6,10 +6,9 @@ import { ...@@ -6,10 +6,9 @@ import {
type OriginalStackFramesResponse, type OriginalStackFramesResponse,
} from '../../next-devtools/server/shared' } from '../../next-devtools/server/shared'
import { middlewareResponse } from '../../next-devtools/server/middleware-response' import { middlewareResponse } from '../../next-devtools/server/middleware-response'
import fs, { constants as FS } from 'fs/promises'
import path from 'path' import path from 'path'
import url from 'url' import url from 'url'
import { launchEditor } from '../../next-devtools/server/launch-editor' import { openFileInEditor } from '../../next-devtools/server/launch-editor'
import type { StackFrame } from 'next/dist/compiled/stacktrace-parser' import type { StackFrame } from 'next/dist/compiled/stacktrace-parser'
import { import {
SourceMapConsumer, SourceMapConsumer,
...@@ -371,7 +370,15 @@ async function createOriginalStackFrame( ...@@ -371,7 +370,15 @@ async function createOriginalStackFrame(
} }
} }
export function getOverlayMiddleware(project: Project, projectPath: string) { export function getOverlayMiddleware({
project,
projectPath,
isSrcDir,
}: {
project: Project
projectPath: string
isSrcDir: boolean
}) {
return async function ( return async function (
req: IncomingMessage, req: IncomingMessage,
res: ServerResponse, res: ServerResponse,
...@@ -421,23 +428,34 @@ export function getOverlayMiddleware(project: Project, projectPath: string) { ...@@ -421,23 +428,34 @@ export function getOverlayMiddleware(project: Project, projectPath: string) {
return middlewareResponse.json(res, result) return middlewareResponse.json(res, result)
} else if (pathname === '/__nextjs_launch-editor') { } else if (pathname === '/__nextjs_launch-editor') {
const frame = createStackFrame(searchParams) const isAppRelativePath = searchParams.get('isAppRelativePath') === '1'
if (!frame) return middlewareResponse.badRequest(res) let openEditorResult
if (isAppRelativePath) {
const fileExists = await fs.access(frame.file, FS.F_OK).then( const relativeFilePath = searchParams.get('file') || ''
() => true, const absoluteFilePath = path.join(
() => false projectPath,
) 'app',
if (!fileExists) return middlewareResponse.notFound(res) isSrcDir ? 'src' : '',
relativeFilePath
)
openEditorResult = await openFileInEditor(absoluteFilePath, 1, 1)
} else {
const frame = createStackFrame(searchParams)
if (!frame) return middlewareResponse.badRequest(res)
openEditorResult = await openFileInEditor(
frame.file,
frame.line ?? 1,
frame.column ?? 1
)
}
try { if (openEditorResult.error) {
launchEditor(frame.file, frame.line ?? 1, frame.column ?? 1)
} catch (err) {
console.log('Failed to launch editor:', err)
return middlewareResponse.internalServerError(res) return middlewareResponse.internalServerError(res)
} }
if (!openEditorResult.found) {
return middlewareResponse.notFound(res)
}
return middlewareResponse.noContent(res) return middlewareResponse.noContent(res)
} }
......
import { constants as FS, promises as fs } from 'fs'
import { findSourceMap, type SourceMap } from 'module' import { findSourceMap, type SourceMap } from 'module'
import path from 'path' import path from 'path'
import { fileURLToPath, pathToFileURL } from 'url' import { fileURLToPath, pathToFileURL } from 'url'
...@@ -8,7 +7,7 @@ import { ...@@ -8,7 +7,7 @@ import {
} from 'next/dist/compiled/source-map08' } from 'next/dist/compiled/source-map08'
import type { StackFrame } from 'next/dist/compiled/stacktrace-parser' import type { StackFrame } from 'next/dist/compiled/stacktrace-parser'
import { getSourceMapFromFile } from './get-source-map-from-file' import { getSourceMapFromFile } from './get-source-map-from-file'
import { launchEditor } from '../../next-devtools/server/launch-editor' import { openFileInEditor } from '../../next-devtools/server/launch-editor'
import { import {
getOriginalCodeFrame, getOriginalCodeFrame,
type OriginalStackFrameResponse, type OriginalStackFrameResponse,
...@@ -514,11 +513,13 @@ async function getOriginalStackFrame({ ...@@ -514,11 +513,13 @@ async function getOriginalStackFrame({
export function getOverlayMiddleware(options: { export function getOverlayMiddleware(options: {
rootDirectory: string rootDirectory: string
isSrcDir: boolean
clientStats: () => webpack.Stats | null clientStats: () => webpack.Stats | null
serverStats: () => webpack.Stats | null serverStats: () => webpack.Stats | null
edgeServerStats: () => webpack.Stats | null edgeServerStats: () => webpack.Stats | null
}) { }) {
const { rootDirectory, clientStats, serverStats, edgeServerStats } = options const { rootDirectory, isSrcDir, clientStats, serverStats, edgeServerStats } =
options
return async function ( return async function (
req: IncomingMessage, req: IncomingMessage,
...@@ -577,24 +578,39 @@ export function getOverlayMiddleware(options: { ...@@ -577,24 +578,39 @@ export function getOverlayMiddleware(options: {
if (!frame.file) return middlewareResponse.badRequest(res) if (!frame.file) return middlewareResponse.badRequest(res)
// frame files may start with their webpack layer, like (middleware)/middleware.js let openEditorResult
const filePath = path.resolve( const isAppRelativePath = searchParams.get('isAppRelativePath') === '1'
rootDirectory, if (isAppRelativePath) {
frame.file.replace(/^\([^)]+\)\//, '') const relativeFilePath = searchParams.get('file') || ''
) const absoluteFilePath = path.join(
const fileExists = await fs.access(filePath, FS.F_OK).then( rootDirectory,
() => true, 'app',
() => false isSrcDir ? 'src' : '',
) relativeFilePath
if (!fileExists) return middlewareResponse.notFound(res) )
openEditorResult = await openFileInEditor(absoluteFilePath, 1, 1)
try { } else {
launchEditor(filePath, frame.lineNumber, frame.column ?? 1) // frame files may start with their webpack layer, like (middleware)/middleware.js
} catch (err) { const filePath = path.resolve(
console.log('Failed to launch editor:', err) rootDirectory,
return middlewareResponse.internalServerError(res) frame.file.replace(/^\([^)]+\)\//, '')
)
openEditorResult = await openFileInEditor(
filePath,
frame.lineNumber,
frame.column ?? 1
)
}
if (openEditorResult.error) {
console.error('Failed to launch editor:', openEditorResult.error)
return middlewareResponse.internalServerError(
res,
openEditorResult.error
)
}
if (!openEditorResult.found) {
return middlewareResponse.notFound(res)
} }
return middlewareResponse.noContent(res) return middlewareResponse.noContent(res)
} }
......
...@@ -158,7 +158,11 @@ export async function propagateServerField( ...@@ -158,7 +158,11 @@ export async function propagateServerField(
await opts.renderServer?.instance?.propagateServerField(opts.dir, field, args) await opts.renderServer?.instance?.propagateServerField(opts.dir, field, args)
} }
async function startWatcher(opts: SetupOpts) { async function startWatcher(
opts: SetupOpts & {
isSrcDir: boolean
}
) {
const { nextConfig, appDir, pagesDir, dir, resetFetch } = opts const { nextConfig, appDir, pagesDir, dir, resetFetch } = opts
const { useFileSystemPublicRoutes } = nextConfig const { useFileSystemPublicRoutes } = nextConfig
const usingTypeScript = await verifyTypeScript(opts) const usingTypeScript = await verifyTypeScript(opts)
...@@ -191,6 +195,7 @@ async function startWatcher(opts: SetupOpts) { ...@@ -191,6 +195,7 @@ async function startWatcher(opts: SetupOpts) {
const hotReloader: NextJsHotReloaderInterface = opts.turbo const hotReloader: NextJsHotReloaderInterface = opts.turbo
? await createHotReloaderTurbopack(opts, serverFields, distDir, resetFetch) ? await createHotReloaderTurbopack(opts, serverFields, distDir, resetFetch)
: new HotReloaderWebpack(opts.dir, { : new HotReloaderWebpack(opts.dir, {
isSrcDir: opts.isSrcDir,
appDir, appDir,
pagesDir, pagesDir,
distDir, distDir,
...@@ -1026,7 +1031,10 @@ export async function setupDevBundler(opts: SetupOpts) { ...@@ -1026,7 +1031,10 @@ export async function setupDevBundler(opts: SetupOpts) {
.relative(opts.dir, opts.pagesDir || opts.appDir || '') .relative(opts.dir, opts.pagesDir || opts.appDir || '')
.startsWith('src') .startsWith('src')
const result = await startWatcher(opts) const result = await startWatcher({
...opts,
isSrcDir,
})
opts.telemetry.record( opts.telemetry.record(
eventCliSession( eventCliSession(
......
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