Add log() wrappers

lionel- · lionel- · commit 169ab0e24bf5 · 2025-07-03T13:42:19.000+02:00
diff --git a/apps/lsp/src/config.ts b/apps/lsp/src/config.ts
@@ -141,7 +141,7 @@ export class ConfigurationManager extends Disposable {
   }
 
   public async update() {
-    this._logger.log(LogLevel.Trace, 'Sending \'configuration\' request');
+    this._logger.logTrace('Sending \'configuration\' request');
     const settings = await this.connection_.workspace.getConfiguration();
 
     this._settings = {
diff --git a/apps/lsp/src/diagnostics.ts b/apps/lsp/src/diagnostics.ts
@@ -35,7 +35,6 @@ import {
   ILogger,
   IMdLanguageService,
   IWorkspace,
-  LogLevel,
 } from "./service";
 import {
   ConfigurationManager,
@@ -130,7 +129,7 @@ export async function registerDiagnostics(
         FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport
       > => {
 
-        logger.log(LogLevel.Debug, "connection.languages.diagnostics.on", {
+        logger.logDebug("connection.languages.diagnostics.on", {
           document: params.textDocument.uri,
         });
 
diff --git a/apps/lsp/src/logging.ts b/apps/lsp/src/logging.ts
@@ -62,7 +62,7 @@ export class LogFunctionLogger extends Disposable implements ILogger {
 
   setConnection(connection: Connection) {
     this._connection = connection;
-    this.log(LogLevel.Debug, 'LSP is now connected');
+    this.logInfo('LSP is now connected');
   }
 
   setConfigurationManager(config: ConfigurationManager) {
@@ -104,12 +104,27 @@ export class LogFunctionLogger extends Disposable implements ILogger {
     }
   }
 
-  public logNotification(method: string) {
-    this.log(LogLevel.Trace, `Got notification: '${method}'`);
+  public logTrace(message: string, data?: Record<string, unknown>): void {
+    this.log(LogLevel.Trace, message, data);
+  }
+  public logDebug(message: string, data?: Record<string, unknown>): void {
+    this.log(LogLevel.Debug, message, data);
+  }
+  public logInfo(message: string, data?: Record<string, unknown>): void {
+    this.log(LogLevel.Info, message, data);
+  }
+  public logWarn(message: string, data?: Record<string, unknown>): void {
+    this.log(LogLevel.Warn, message, data);
+  }
+  public logError(message: string, data?: Record<string, unknown>): void {
+    this.log(LogLevel.Error, message, data);
   }
 
-  public logRequest(method: string) {
-    this.log(LogLevel.Trace, `Got request: '${method}'`);
+  public logNotification(method: string, data?: Record<string, unknown>) {
+    this.logTrace(`Got notification: '${method}'`, data);
+  }
+  public logRequest(method: string, data?: Record<string, unknown>) {
+    this.logTrace(`Got request: '${method}'`, data);
   }
 
   private toLevelLabel(level: LogLevel): string {
diff --git a/apps/lsp/src/service/logging.ts b/apps/lsp/src/service/logging.ts
@@ -52,15 +52,21 @@ export interface ILogger {
    */
   log(level: LogLevel, message: string, data?: Record<string, unknown>): void;
 
+  logTrace(message: string, data?: Record<string, unknown>): void;
+  logDebug(message: string, data?: Record<string, unknown>): void;
+  logInfo(message: string, data?: Record<string, unknown>): void;
+  logWarn(message: string, data?: Record<string, unknown>): void;
+  logError(message: string, data?: Record<string, unknown>): void;
+
   /**
    * Log notification at Trace level.
    * @param method Message type name.
    */
-  logNotification(method: string): void;
+  logNotification(method: string, data?: Record<string, unknown>): void;
 
   /**
    * Log request at Trace level.
    * @param method Message type name.
    */
-  logRequest(method: string): void;
+  logRequest(method: string, data?: Record<string, unknown>): void;
 }
diff --git a/apps/lsp/src/service/providers/diagnostics.ts b/apps/lsp/src/service/providers/diagnostics.ts
@@ -210,7 +210,7 @@ export class DiagnosticComputer {
     readonly links: readonly MdLink[];
     readonly statCache: ResourceMap<{ readonly exists: boolean }>;
   }> {
-    this.#logger.log(LogLevel.Debug, 'DiagnosticComputer.compute', { document: doc.uri, version: doc.version });
+    this.#logger.logDebug('DiagnosticComputer.compute', { document: doc.uri, version: doc.version });
 
     const { links, definitions } = await this.#linkProvider.getLinks(doc);
     const statCache = new ResourceMap<{ readonly exists: boolean }>();
@@ -235,7 +235,7 @@ export class DiagnosticComputer {
       ])).flat());
     }
 
-    this.#logger.log(LogLevel.Trace, 'DiagnosticComputer.compute finished', { document: doc.uri, version: doc.version, diagnostics });
+    this.#logger.logTrace('DiagnosticComputer.compute finished', { document: doc.uri, version: doc.version, diagnostics });
 
     return {
       links: links,
@@ -612,7 +612,7 @@ class FileLinkState extends Disposable {
   }
 
   #onLinkedResourceChanged(resource: URI, exists: boolean) {
-    this.#logger.log(LogLevel.Trace, 'FileLinkState.onLinkedResourceChanged', { resource, exists });
+    this.#logger.logTrace('FileLinkState.onLinkedResourceChanged', { resource, exists });
 
     const entry = this.#linkedToFile.get(resource);
     if (entry) {
@@ -650,7 +650,7 @@ export class DiagnosticsManager extends Disposable implements IPullDiagnosticsMa
     this.#linkWatcher = this._register(linkWatcher);
 
     this._register(this.#linkWatcher.onDidChangeLinkedToFile(e => {
-      logger.log(LogLevel.Trace, 'DiagnosticsManager.onDidChangeLinkedToFile', { resource: e.changedResource });
+      logger.logTrace('DiagnosticsManager.onDidChangeLinkedToFile', { resource: e.changedResource });
 
       this.#onLinkedToFileChanged.fire({
         changedResource: e.changedResource,
diff --git a/apps/lsp/src/service/providers/document-links.ts b/apps/lsp/src/service/providers/document-links.ts
@@ -779,7 +779,7 @@ export class MdLinkProvider extends Disposable {
 
     this.#linkComputer = new MdLinkComputer(parser, this.#workspace);
     this.#linkCache = this._register(new MdDocumentInfoCache(this.#workspace, async (doc, token) => {
-      logger.log(LogLevel.Debug, 'LinkProvider.compute', { document: doc.uri, version: doc.version });
+      logger.logDebug('LinkProvider.compute', { document: doc.uri, version: doc.version });
 
       const links = await this.#linkComputer.getAllLinks(doc, token);
       return {
diff --git a/apps/lsp/src/service/providers/document-symbols.ts b/apps/lsp/src/service/providers/document-symbols.ts
@@ -48,7 +48,7 @@ export class MdDocumentSymbolProvider {
   }
 
   public async provideDocumentSymbols(document: Document, options: ProvideDocumentSymbolOptions, token: CancellationToken): Promise<lsp.DocumentSymbol[]> {
-    this.#logger.log(LogLevel.Debug, 'DocumentSymbolProvider.provideDocumentSymbols', { document: document.uri, version: document.version });
+    this.#logger.logDebug('DocumentSymbolProvider.provideDocumentSymbols', { document: document.uri, version: document.version });
 
     if (token.isCancellationRequested) {
       return [];
diff --git a/apps/lsp/src/service/providers/folding.ts b/apps/lsp/src/service/providers/folding.ts
@@ -45,7 +45,7 @@ export class MdFoldingProvider {
   }
 
   public async provideFoldingRanges(document: Document, token: CancellationToken): Promise<lsp.FoldingRange[]> {
-    this.#logger.log(LogLevel.Debug, 'MdFoldingProvider.provideFoldingRanges', { document: document.uri, version: document.version });
+    this.#logger.logDebug('MdFoldingProvider.provideFoldingRanges', { document: document.uri, version: document.version });
 
     if (token.isCancellationRequested) {
       return [];
diff --git a/apps/lsp/src/service/providers/references.ts b/apps/lsp/src/service/providers/references.ts
@@ -119,7 +119,7 @@ export class MdReferencesProvider extends Disposable {
   }
 
   public async getReferencesAtPosition(document: Document, position: lsp.Position, token: CancellationToken): Promise<MdReference[]> {
-    this.#logger.log(LogLevel.Debug, 'ReferencesProvider.getReferencesAtPosition', { document: document.uri, version: document.version });
+    this.#logger.logDebug('ReferencesProvider.getReferencesAtPosition', { document: document.uri, version: document.version });
 
     const toc = await this.#tocProvider.getForDocument(document);
     if (token.isCancellationRequested) {
@@ -135,7 +135,7 @@ export class MdReferencesProvider extends Disposable {
   }
 
   public async getReferencesToFileInWorkspace(resource: URI, token: CancellationToken): Promise<MdReference[]> {
-    this.#logger.log(LogLevel.Debug, 'ReferencesProvider.getAllReferencesToFileInWorkspace', { resource });
+    this.#logger.logDebug('ReferencesProvider.getAllReferencesToFileInWorkspace', { resource });
 
     if (token.isCancellationRequested) {
       return [];
diff --git a/apps/lsp/src/service/providers/smart-select.ts b/apps/lsp/src/service/providers/smart-select.ts
@@ -41,7 +41,7 @@ export class MdSelectionRangeProvider {
   }
 
   public async provideSelectionRanges(document: Document, positions: readonly Position[], token: CancellationToken): Promise<lsp.SelectionRange[] | undefined> {
-    this.#logger.log(LogLevel.Debug, 'MdSelectionRangeProvider.provideSelectionRanges', { document: document.uri, version: document.version });
+    this.#logger.logDebug('MdSelectionRangeProvider.provideSelectionRanges', { document: document.uri, version: document.version });
 
     if (token.isCancellationRequested) {
       return undefined;
diff --git a/apps/lsp/src/service/toc.ts b/apps/lsp/src/service/toc.ts
@@ -299,7 +299,7 @@ export class MdTableOfContentsProvider extends Disposable {
     this.#logger = logger;
 
     this.#cache = this._register(new MdDocumentInfoCache<TableOfContents>(workspace, (doc, token) => {
-      this.#logger.log(LogLevel.Debug, 'TableOfContentsProvider.create', { document: doc.uri, version: doc.version });
+      this.#logger.logDebug('TableOfContentsProvider.create', { document: doc.uri, version: doc.version });
       return TableOfContents.create(parser, doc, token);
     }));
   }
diff --git a/apps/lsp/src/workspace.ts b/apps/lsp/src/workspace.ts
@@ -33,7 +33,6 @@ import { Document, isQuartoDoc } from "quarto-core";
 import {
   FileStat,
   ILogger,
-  LogLevel,
   LsConfiguration,
   IWorkspace,
   IWorkspaceWithWatching,
@@ -98,7 +97,7 @@ export function languageServiceWorkspace(
   const onDidDeleteMarkdownDocument = new Emitter<URI>();
 
   const doDeleteDocument = (uri: URI) => {
-    logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.deleteDocument', { document: uri.toString() });
+    logger.logTrace('VsCodeClientWorkspace.deleteDocument', { document: uri.toString() });
     documentCache.delete(uri);
     onDidDeleteMarkdownDocument.fire(uri);
   }
@@ -107,7 +106,7 @@ export function languageServiceWorkspace(
     if (!isRelevantMarkdownDocument(e.document)) {
       return;
     }
-    logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.TextDocument.onDidOpen', { document: e.document.uri });
+    logger.logNotification('onDidOpen', { document: e.document.uri });
 
     const uri = URI.parse(e.document.uri);
     const doc = documentCache.get(uri);
@@ -132,7 +131,7 @@ export function languageServiceWorkspace(
       return;
     }
 
-    logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.TextDocument.onDidChanceContent', { document: e.document.uri });
+    logger.logNotification('onDidChangeContent', { document: e.document.uri });
 
     const uri = URI.parse(e.document.uri);
     const entry = documentCache.get(uri);
@@ -147,7 +146,7 @@ export function languageServiceWorkspace(
       return;
     }
 
-    logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.TextDocument.onDidClose', { document: e.document.uri });
+    logger.logNotification('onDidClose', { document: e.document.uri });
 
     const uri = URI.parse(e.document.uri);
     const doc = documentCache.get(uri);
@@ -254,15 +253,15 @@ export function languageServiceWorkspace(
     },
 
     async stat(resource: URI): Promise<FileStat | undefined> {
-      logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.stat', { resource: resource.toString() });
+      logger.logTrace('VsCodeClientWorkspace.stat', { resource: resource.toString() });
       if (documentCache.has(resource)) {
         return { isDirectory: false };
       }
       return statBypassingCache(resource);
     },
 
     async readDirectory(resource: URI): Promise<Iterable<readonly [string, FileStat]>> {
-      logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.readDirectory', { resource: resource.toString() });
+      logger.logTrace('VsCodeClientWorkspace.readDirectory', { resource: resource.toString() });
       const result = await fspromises.readdir(resource.fsPath, { withFileTypes: true });
       return result.map(value => [value.name, { isDirectory: value.isDirectory() }]);
     },
@@ -313,7 +312,7 @@ export function languageServiceWorkspace(
       // keep document cache up to date and notify clients
       for (const change of changes) {
         const resource = URI.parse(change.uri);
-        logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.onDidChangeWatchedFiles', { type: change.type, resource: resource.toString() });
+        logger.logTrace('VsCodeClientWorkspace.onDidChangeWatchedFiles', { type: change.type, resource: resource.toString() });
         switch (change.type) {
           case FileChangeType.Changed: {
             const entry = documentCache.get(resource);
@@ -356,7 +355,7 @@ export function languageServiceWorkspace(
     const fsWorkspace: IWorkspaceWithWatching = {
       ...workspace,
       watchFile(resource, options) {
-        logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.watchFile', { resource: resource.toString() });
+        logger.logTrace('VsCodeClientWorkspace.watchFile', { resource: resource.toString() });
 
         const entry = {
           resource,
@@ -371,7 +370,7 @@ export function languageServiceWorkspace(
           onDidChange: entry.onDidChange.event,
           onDidDelete: entry.onDidDelete.event,
           dispose: () => {
-            logger.log(LogLevel.Trace, 'VsCodeClientWorkspace.disposeWatcher', { resource: resource.toString() });
+            logger.logTrace('VsCodeClientWorkspace.disposeWatcher', { resource: resource.toString() });
             watchers.delete(entry.resource.toString());
           }
         };

Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ export class ConfigurationManager extends Disposable {`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`public async update() {`
`144`		`- this._logger.log(LogLevel.Trace, 'Sending \'configuration\' request');`
	`144`	`+ this._logger.logTrace('Sending \'configuration\' request');`
`145`	`145`	`const settings = await this.connection_.workspace.getConfiguration();`
`146`	`146`
`147`	`147`	`this._settings = {`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ export class MdDocumentSymbolProvider {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`public async provideDocumentSymbols(document: Document, options: ProvideDocumentSymbolOptions, token: CancellationToken): Promise<lsp.DocumentSymbol[]> {`
`51`		`- this.#logger.log(LogLevel.Debug, 'DocumentSymbolProvider.provideDocumentSymbols', { document: document.uri, version: document.version });`
	`51`	`+ this.#logger.logDebug('DocumentSymbolProvider.provideDocumentSymbols', { document: document.uri, version: document.version });`
`52`	`52`
`53`	`53`	`if (token.isCancellationRequested) {`
`54`	`54`	`return [];`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ export class MdFoldingProvider {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`public async provideFoldingRanges(document: Document, token: CancellationToken): Promise<lsp.FoldingRange[]> {`
`48`		`- this.#logger.log(LogLevel.Debug, 'MdFoldingProvider.provideFoldingRanges', { document: document.uri, version: document.version });`
	`48`	`+ this.#logger.logDebug('MdFoldingProvider.provideFoldingRanges', { document: document.uri, version: document.version });`
`49`	`49`
`50`	`50`	`if (token.isCancellationRequested) {`
`51`	`51`	`return [];`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ export class MdReferencesProvider extends Disposable {`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`public async getReferencesAtPosition(document: Document, position: lsp.Position, token: CancellationToken): Promise<MdReference[]> {`
`122`		`- this.#logger.log(LogLevel.Debug, 'ReferencesProvider.getReferencesAtPosition', { document: document.uri, version: document.version });`
	`122`	`+ this.#logger.logDebug('ReferencesProvider.getReferencesAtPosition', { document: document.uri, version: document.version });`
`123`	`123`
`124`	`124`	`const toc = await this.#tocProvider.getForDocument(document);`
`125`	`125`	`if (token.isCancellationRequested) {`
`@@ -135,7 +135,7 @@ export class MdReferencesProvider extends Disposable {`
`135`	`135`	`}`
`136`	`136`
`137`	`137`	`public async getReferencesToFileInWorkspace(resource: URI, token: CancellationToken): Promise<MdReference[]> {`
`138`		`- this.#logger.log(LogLevel.Debug, 'ReferencesProvider.getAllReferencesToFileInWorkspace', { resource });`
	`138`	`+ this.#logger.logDebug('ReferencesProvider.getAllReferencesToFileInWorkspace', { resource });`
`139`	`139`
`140`	`140`	`if (token.isCancellationRequested) {`
`141`	`141`	`return [];`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ export class MdSelectionRangeProvider {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`public async provideSelectionRanges(document: Document, positions: readonly Position[], token: CancellationToken): Promise<lsp.SelectionRange[] \| undefined> {`
`44`		`- this.#logger.log(LogLevel.Debug, 'MdSelectionRangeProvider.provideSelectionRanges', { document: document.uri, version: document.version });`
	`44`	`+ this.#logger.logDebug('MdSelectionRangeProvider.provideSelectionRanges', { document: document.uri, version: document.version });`
`45`	`45`
`46`	`46`	`if (token.isCancellationRequested) {`
`47`	`47`	`return undefined;`