Skip to content

refactor(hmr): provide a separate logger interface #15631

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

Merged
patak-cat merged 3 commits into from
Jan 19, 2024
Merged

refactor(hmr): provide a separate logger interface #15631

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1541e70
refactor(hmr): provide a separate logger interface
sheremet-va Jan 17, 2024
92e9001
chore: typo
patak-cat Jan 17, 2024
327d46a
chore: remove unused methods from logger
sheremet-va Jan 18, 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
13 changes: 12 additions & 1 deletion packages/vite/src/client/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,18 @@ const debounceReload = (time: number) => {
const pageReload = debounceReload(50)

const hmrClient = new HMRClient(
console,
{
error: console.error,
debug: console.debug,
updated({ acceptedPath, path }) {
const loggedPath =
acceptedPath === path ? path : `${acceptedPath} via ${path}`
console.debug(`[vite] hot updated: ${loggedPath}`)
},
invalidated(id, message) {
console.debug(`[vite] invalidate ${id}${message ? `: ${message}` : ''}`)
},
},
{
isReady: () => socket && socket.readyState === 1,
send: (message) => socket.send(message),
Expand Down
22 changes: 16 additions & 6 deletions packages/vite/src/shared/hmr.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@ interface HotCallback {
fn: (modules: Array<ModuleNamespace | undefined>) => void
}

export interface HMRLogger {
error(msg: string | Error): void
debug(...msg: unknown[]): void
/**
* Log when HMR update is applied
*/
updated(update: Update): void
/**
* Log when a module is invalidated via "import.meta.hot.invalidate"
*/
invalidated(id: string, message?: string): void
}

export interface HMRConnection {
/**
* Checked before sending messages to the client.
Expand Down Expand Up @@ -107,9 +120,7 @@ export class HMRContext implements ViteHotContext {
message,
})
this.send('vite:invalidate', { path: this.ownerPath, message })
this.hmrClient.logger.debug(
`[vite] invalidate ${this.ownerPath}${message ? `: ${message}` : ''}`,
)
this.hmrClient.logger.invalidated(this.ownerPath, message)
}

on<T extends string>(
Expand Down Expand Up @@ -196,7 +207,7 @@ export class HMRClient {
public messenger: HMRMessenger

constructor(
public logger: Console,
public logger: HMRLogger,
connection: HMRConnection,
// This allows implementing reloading via different methods depending on the environment
private importUpdatedModule: (update: Update) => Promise<ModuleNamespace>,
Expand Down Expand Up @@ -293,8 +304,7 @@ export class HMRClient {
deps.map((dep) => (dep === acceptedPath ? fetchedModule : undefined)),
)
}
const loggedPath = isSelfUpdate ? path : `${acceptedPath} via ${path}`
this.logger.debug(`[vite] hot updated: ${loggedPath}`)
this.logger.updated(update)
}
}
}