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

feat: add sourcemapIgnoreList configuration option #12174

Merged
merged 8 commits into from
Mar 1, 2023
Merged

feat: add sourcemapIgnoreList configuration option #12174

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
83c6218
feat(vite): add `sourcemapIgnoreList` configuration option
danielroe Feb 23, 2023
a381b9c
feat: add `sourcemapPath` as second argument
danielroe Feb 24, 2023
875f719
docs: add default value
danielroe Feb 24, 2023
046c4b3
Merge remote-tracking branch 'upstream/main' into feat/sourcemap-ignore
danielroe Feb 27, 2023
61bcf54
refactor: combine with loop from #12079
danielroe Feb 27, 2023
01a5c43
fix: remove `/` fromm default `sourcemapIgnoreList`
danielroe Feb 27, 2023
ecda87b
feat: support setting option to `false`
danielroe Mar 1, 2023
e48c386
docs: make it slightly clearer
danielroe Mar 1, 2023
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
Next Next commit
feat(vite): add sourcemapIgnoreList configuration option
  • Loading branch information
@danielroe
danielroe committed Feb 23, 2023
commit 83c621819ffc01d542f4b0f3047d34d7e0ec9162
16 changes: 16 additions & 0 deletions docs/config/server-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,3 +318,19 @@ export default defineConfig({
},
})
```

## server.sourcemapIgnoreList

- **Type:** `Function`

Whether or not to ignore source files in the server sourcemap, used to populate the [`x_google_ignoreList` source map extension](https://developer.chrome.com/blog/devtools-better-angular-debugging/#the-x_google_ignorelist-source-map-extension).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bmeurer not blocking for the PR, but it would be nice to be able to link to a more focused blog post about x_google_ignoreList. If your team ends up having a better resource in the future, would you do a PR to rewire these references?

Copy link
Contributor

@jecfish jecfish Mar 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to this, I will draft something up and send another PR to update it. Thanks for calling that out!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jecfish, sounds great!


```js
export default defineConfig({
server: {
// This is the default value, and will add all files with node_modules in their paths
// to the ignore list.
sourcemapIgnoreList: sourcePath => sourcePath.includes('/node_modules/')
}
};
```
10 changes: 9 additions & 1 deletion packages/vite/src/node/server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,12 @@ export interface ServerOptions extends CommonServerOptions {
* @default true
*/
preTransformRequests?: boolean
/**
* Whether or not to ignore-list source files in the dev server sourcemap, used to populate
* the [`x_google_ignoreList` source map extension](https://developer.chrome.com/blog/devtools-better-angular-debugging/#the-x_google_ignorelist-source-map-extension).
* By default, it excludes all paths containing `/node_modules/`.
*/
sourcemapIgnoreList?: (sourcePath: string) => boolean
danielroe marked this conversation as resolved.
Show resolved Hide resolved
/**
* Force dep pre-optimization regardless of whether deps have changed.
*
Expand All @@ -127,6 +133,7 @@ export interface ServerOptions extends CommonServerOptions {
export interface ResolvedServerOptions extends ServerOptions {
fs: Required<FileSystemServeOptions>
middlewareMode: boolean
sourcemapIgnoreList: NonNullable<ServerOptions['sourcemapIgnoreList']>
}

export interface FileSystemServeOptions {
Expand Down Expand Up @@ -746,7 +753,8 @@ export function resolveServerOptions(
): ResolvedServerOptions {
const server: ResolvedServerOptions = {
preTransformRequests: true,
...(raw as ResolvedServerOptions),
sourcemapIgnoreList: (sourcePath) => sourcePath.includes('/node_modules/'),
danielroe marked this conversation as resolved.
Show resolved Hide resolved
...(raw as Omit<ResolvedServerOptions, 'sourcemapIgnoreList'>),
middlewareMode: !!raw?.middlewareMode,
}
let allowDirs = server.fs?.allow
Expand Down
20 changes: 20 additions & 0 deletions packages/vite/src/node/server/transformRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,26 @@ async function loadAndTransform(

if (map && mod.file) {
map = (typeof map === 'string' ? JSON.parse(map) : map) as SourceMap
for (
let sourcesIndex = 0;
sourcesIndex < map.sources.length;
++sourcesIndex
) {
const sourcePath = map.sources[sourcesIndex]

const ignoreList = config.server.sourcemapIgnoreList(sourcePath)
if (typeof ignoreList !== 'boolean') {
logger.warn('sourcemapIgnoreList function must return a boolean.')
}
if (ignoreList) {
if (map.x_google_ignoreList === undefined) {
map.x_google_ignoreList = []
}
if (!map.x_google_ignoreList.includes(sourcesIndex)) {
map.x_google_ignoreList.push(sourcesIndex)
}
}
}
if (map.mappings && !map.sourcesContent) {
await injectSourcesContent(map, mod.file, logger)
}
Expand Down