Remove console log usage

news/3 Code Health/10202.md

@@ -0,0 +1 @@
+Remove usage of console.log in renderers.

src/kernels/ipywidgets-message-coordination/ipyWidgetMessageDispatcher.ts

@@ -7,7 +7,7 @@ import type { KernelMessage } from '@jupyterlab/services';
 import * as uuid from 'uuid/v4';
 import { Event, EventEmitter, NotebookDocument } from 'vscode';
 import type { Data as WebSocketData } from 'ws';
-import { traceInfoIfCI, traceVerbose, traceError } from '../../platform/logging';
+import { traceVerbose, traceError, traceInfo } from '../../platform/logging';
 import { IDisposable } from '../../platform/common/types';
 import { Deferred, createDeferred } from '../../platform/common/utils/async';
 import { noop } from '../../platform/common/utils/misc';
@@ -106,7 +106,7 @@ export class IPyWidgetMessageDispatcher implements IIPyWidgetMessageDispatcher {
     public receiveMessage(message: IPyWidgetMessage): void {
         switch (message.message) {
             case IPyWidgetMessages.IPyWidgets_logMessage:
-                traceInfoIfCI(`Widget Message: ${message.payload}`);
+                traceInfo(`Widget Message: ${message.payload}`);
                 break;
             case IPyWidgetMessages.IPyWidgets_Ready:
                 this.sendKernelOptions();

src/webviews/extension-side/variablesView/variableView.ts

@@ -75,7 +75,6 @@ export class VariableView extends WebviewViewHost<IVariableViewPanelMapping> imp
         this.documentManager.onDidChangeActiveTextEditor(this.activeTextEditorChanged, this, this.disposables);
 
         this.dataViewerChecker = new DataViewerChecker(configuration, appShell);
-        console.log(`Done initializing variables`);
     }
 
     @captureTelemetry(Telemetry.NativeVariableViewLoaded)

src/webviews/webview-side/ipywidgets/common/kernel.ts

@@ -11,7 +11,6 @@ import { KernelSocketOptions } from '../../../../kernels/types';
 import { Deferred, createDeferred } from '../../../../platform/common/utils/async';
 import { serializeDataViews, deserializeDataViews } from '../../../../platform/common/utils/serializers';
 import { IInteractiveWindowMapping, IPyWidgetMessages } from '../../../../platform/messageTypes';
-import { logMessageOnlyOnCI } from '../../react-common/logger';
 import { IMessageHandler, PostOffice } from '../../react-common/postOffice';
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
@@ -324,7 +323,6 @@ class ProxyKernel implements IMessageHandler, Kernel.IKernelConnection {
         this.messageHooks.set(msgId, hook);
 
         // Wrap the hook and send it to the real kernel
-        logMessageOnlyOnCI(`Registering hook for ${msgId}`);
         this.realKernel.registerMessageHook(msgId, this.messageHook);
     }
 
@@ -350,7 +348,6 @@ class ProxyKernel implements IMessageHandler, Kernel.IKernelConnection {
         this.lastHookedMessageId = undefined;
 
         // Remove from the real kernel
-        logMessageOnlyOnCI(`Removing hook for ${msgId}`);
         this.realKernel.removeMessageHook(msgId, this.messageHook);
     }
 
@@ -393,9 +390,6 @@ class ProxyKernel implements IMessageHandler, Kernel.IKernelConnection {
     }
     private messageHookInterceptor(msg: KernelMessage.IIOPubMessage): boolean | PromiseLike<boolean> {
         try {
-            logMessageOnlyOnCI(
-                `Message hook callback for ${(msg as any).header.msg_type} and ${(msg.parent_header as any).msg_id}`
-            );
             // Save the active message that is currently being hooked. The Extension
             // side needs this information during removeMessageHook so it can delay removal until after a message is called
             this.lastHookedMessageId = msg.header.msg_id;

src/webviews/webview-side/ipywidgets/kernel/index.ts

@@ -11,6 +11,7 @@ import {
     IInteractiveWindowMapping,
     InteractiveWindowMessages
 } from '../../../../platform/messageTypes';
+import { logMessage } from '../../react-common/logger';
 
 class WidgetManagerComponent {
     private readonly widgetManager: WidgetManager;
@@ -126,9 +127,9 @@ function renderIPyWidget(
     container: HTMLElement,
     logger: (message: string) => void
 ) {
-    console.log(`Rendering IPyWidget ${outputId} with model ${model.model_id}`);
+    logger(`Rendering IPyWidget ${outputId} with model ${model.model_id}`);
     if (renderedWidgets.has(outputId)) {
-        return console.error('already rendering');
+        return logger('already rendering');
     }
     const output = document.createElement('div');
     output.className = 'cell-output cell-output';
@@ -241,10 +242,10 @@ let capturedContext: KernelMessagingApi | undefined;
 // To ensure we initialize after the other scripts, wait for them.
 function attemptInitialize(context?: KernelMessagingApi) {
     capturedContext = capturedContext || context;
-    console.log('Attempt Initialize IpyWidgets kernel.js', context);
+    logMessage(`Attempt Initialize IpyWidgets kernel.js : ${JSON.stringify(context)}`);
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     if ((window as any).vscIPyWidgets) {
-        console.log('IPyWidget kernel initializing...');
+        logMessage('IPyWidget kernel initializing...');
         initialize(capturedContext);
     } else {
         setTimeout(attemptInitialize, 100);

src/webviews/webview-side/ipywidgets/renderer/index.ts

@@ -67,7 +67,6 @@ function hookupTestScripts(context: RendererContext<unknown>) {
                 message: 'Hook not registered'
             });
         }
-        console.log(`No Widgetentry point`);
         return;
     }
     if (context.postMessage) {
@@ -76,7 +75,6 @@ function hookupTestScripts(context: RendererContext<unknown>) {
             message: 'Hook registered'
         });
     }
-    console.log(`Widgetentry point found`);
     anyWindow.widgetEntryPoint.initialize(context);
 }
 function sendRenderOutputItem(context: RendererContext<unknown>, outputItem: OutputItem, element: HTMLElement) {

src/webviews/webview-side/react-common/logger.ts

@@ -8,15 +8,6 @@ export function logMessage(message: string) {
         messageLogger(message);
     }
 }
-/**
- * Logging in production seems to slow down webview (unnecessarily too chatty)
- */
-export function logMessageOnlyOnCI(message: string) {
-    // TODO: No way to check if CI for webview
-    if (messageLogger) {
-        messageLogger(message);
-    }
-}
 
 export function setLogger(logger: (message: string) => void) {
     messageLogger = logger;

src/webviews/webview-side/react-common/postOffice.ts

@@ -7,7 +7,7 @@ import { Subject } from 'rxjs/Subject';
 import { VSCodeEvent } from 'vscode-notebook-renderer/events';
 import { WebviewMessage } from '../../../platform/common/application/types';
 import { IDisposable } from '../../../platform/common/types';
-import { logMessage, logMessageOnlyOnCI } from './logger';
+import { logMessage } from './logger';
 
 export interface IVsCodeApi {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -77,7 +77,6 @@ class VsCodeMessageApi implements IMessageApi {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     public sendMessage(type: string, payload?: any) {
         if (this.vscodeApi) {
-            logMessageOnlyOnCI(`UI PostOffice Sent ${type}`);
             this.vscodeApi.postMessage({ type: type, payload });
         } else if (type === 'IPyWidgets_logMessage') {
             logMessage(`Logging message ${type}, ${payload}`);
@@ -224,9 +223,6 @@ export class PostOffice implements IDisposable {
     private async handleMessage(msg: WebviewMessage) {
         if (this.handlers) {
             if (msg) {
-                if ('type' in msg && typeof msg.type === 'string') {
-                    logMessageOnlyOnCI(`UI PostOffice Received ${msg.type}`);
-                }
                 this.subject.next({ type: msg.type, payload: msg.payload });
                 this.handlers.forEach((h: IMessageHandler | null) => {
                     if (h) {