Switch consoles to log utils (#3542)

xh · Dec 1, 2023 · 1c6357d · 1c6357d
1 parent 5a729ef
commit 1c6357d
Show file tree

Hide file tree

Showing 32 changed files with 115 additions and 105 deletions.
diff --git a/cmp/grid/impl/Utils.ts b/cmp/grid/impl/Utils.ts
@@ -19,7 +19,7 @@ export function managedRenderer<T extends ColumnRenderer | GroupRowRenderer>(
         try {
             return fn.apply(null, arguments);
         } catch (e) {
-            console.warn(`Renderer for '${identifier}' has thrown an error.`, e);
+            console.warn(`Renderer for '${identifier}' has thrown an error`, e);
             return '#ERROR';
         }
     } as unknown as T;

diff --git a/cmp/relativetimestamp/RelativeTimestamp.ts b/cmp/relativetimestamp/RelativeTimestamp.ts
@@ -20,7 +20,7 @@ import {fmtCompactDate, fmtDateTime} from '@xh/hoist/format';
 import {action, computed, makeObservable, observable} from '@xh/hoist/mobx';
 import {Timer} from '@xh/hoist/utils/async';
 import {DAYS, HOURS, LocalDate, SECONDS} from '@xh/hoist/utils/datetime';
-import {withDefault} from '@xh/hoist/utils/js';
+import {logWarn, withDefault} from '@xh/hoist/utils/js';
 
 interface RelativeTimestampProps extends HoistProps, BoxProps {
     /**
@@ -231,7 +231,10 @@ function doFormat(timestamp: Date | number, opts: RelativeTimestampOptions): str
 
     // 1) Degenerate cases
     if (isFuture && !allowFuture) {
-        console.warn(`Unexpected future date provided for timestamp: ${elapsed}ms in the future.`);
+        logWarn(
+            `Unexpected future date provided for timestamp: ${elapsed}ms in the future.`,
+            RelativeTimestamp
+        );
         return '[????]';
     }
 

diff --git a/cmp/zoneGrid/ZoneGridModel.ts b/cmp/zoneGrid/ZoneGridModel.ts
@@ -620,7 +620,7 @@ export class ZoneGridModel extends HoistModel {
                 ret[zone] = this.parseZoneMapping(zone, rawMapping);
             } catch (e) {
                 if (strict) throw e;
-                console.warn(e.message);
+                this.logWarn(e.message);
                 ret[zone] = this._defaultState.mappings[zone];
             }
         });

diff --git a/core/HoistBase.ts b/core/HoistBase.ts
@@ -267,9 +267,10 @@ export abstract class HoistBase {
                 run: data => provider.write(data)
             });
         } catch (e) {
-            console.error(
+            this.logError(
                 `Failed to configure Persistence for '${property}'.  Be sure to fully specify ` +
-                    `'persistWith' on this object or in the method call.`
+                    `'persistWith' on this object or in the method call`,
+                e
             );
         }
     }

diff --git a/core/HoistBaseDecorators.ts b/core/HoistBaseDecorators.ts
@@ -6,7 +6,7 @@
  */
 import {cloneDeep, isUndefined} from 'lodash';
 import {wait} from '../promise';
-import {throwIf} from '../utils/js';
+import {logError, throwIf} from '../utils/js';
 import {HoistBaseClass, PersistenceProvider, PersistOptions} from './';
 
 /**
@@ -66,9 +66,10 @@ function createPersistDescriptor(
         '@persist decorator should be applied to an instance of HoistBase'
     );
     if (descriptor.get || descriptor.set) {
-        console.error(
+        logError(
             `Error defining ${property} : @persist or @persistWith should be defined closest ` +
-                `to property, and after mobx annotation e.g. '@bindable @persist ${property}'`
+                `to property, and after mobx annotation e.g. '@bindable @persist ${property}'`,
+            target
         );
         return descriptor;
     }
@@ -89,9 +90,13 @@ function createPersistDescriptor(
                 });
             });
         } catch (e) {
-            console.error(
-                `Failed to configure Persistence for '${property}'.  Be sure to fully specify ` +
-                    `'persistWith' on this object or annotation.`
+            logError(
+                [
+                    `Failed to configure Persistence for '${property}'.  Be sure to fully specify ` +
+                        `'persistWith' on this object or annotation`,
+                    e
+                ],
+                target
             );
         }
 

diff --git a/core/HoistComponent.ts b/core/HoistComponent.ts
@@ -282,9 +282,7 @@ function wrapWithModel(render: RenderFn, cfg: Config): RenderFn {
         if (!model && !spec.optional && spec instanceof UsesSpec) {
             console.error(`
                 Failed to find model with selector '${formatSelector(spec.selector)}' for
-                component '${
-                    cfg.displayName
-                }'.  Ensure the proper model is available via context, or
+                component '${cfg.displayName}'. Ensure the proper model is available via context, or
                 specify explicitly using the 'model' prop.
             `);
             return cmpErrDisplay({...getLayoutProps(props), item: 'No model found'});

diff --git a/core/exception/ExceptionHandler.ts b/core/exception/ExceptionHandler.ts
@@ -6,7 +6,7 @@
  */
 import {Exception} from './Exception';
 import {fragment, span} from '@xh/hoist/cmp/layout';
-import {stripTags} from '@xh/hoist/utils/js';
+import {logError, logWarn, stripTags} from '@xh/hoist/utils/js';
 import {Icon} from '@xh/hoist/icon';
 import {forOwn, has, isArray, isNil, isObject, omitBy, pick, set} from 'lodash';
 import {HoistException, PlainObject, XH} from '../';
@@ -189,7 +189,7 @@ export class ExceptionHandler {
                 username = XH.getUsername();
 
             if (!username) {
-                console.warn('Error report cannot be submitted to UI server - user unknown');
+                logWarn('Error report cannot be submitted to UI server - user unknown', this);
                 return false;
             }
 
@@ -206,7 +206,7 @@ export class ExceptionHandler {
             });
             return true;
         } catch (e) {
-            console.error('Exception while submitting error report to UI server', e);
+            logError(['Exception while submitting error report to UI server', e], this);
             return false;
         }
     }
@@ -261,7 +261,7 @@ export class ExceptionHandler {
             return stripTags(JSON.stringify(ret, null, 4));
         } catch (e) {
             const message = 'Failed to serialize error';
-            console.error(message, exception, e);
+            logError([message, exception, e], this);
             return JSON.stringify({message}, null, 4);
         }
     }

diff --git a/core/load/LoadSupport.ts b/core/load/LoadSupport.ts
@@ -7,8 +7,8 @@
 import {HoistBase, managed, PlainObject, RefreshContextModel, TaskObserver} from '../';
 import {LoadSpec, Loadable} from './';
 import {makeObservable, observable, runInAction} from '@xh/hoist/mobx';
-import {throwIf} from '@xh/hoist/utils/js';
-import {isPlainObject} from 'lodash';
+import {logDebug, logError, throwIf} from '@xh/hoist/utils/js';
+import {isPlainObject, pull} from 'lodash';
 
 /**
  * Provides support for objects that participate in Hoist's loading/refresh lifecycle.
@@ -98,18 +98,17 @@ export class LoadSupport extends HoistBase implements Loadable {
                 if (target instanceof RefreshContextModel) return;
 
                 const elapsed = this.lastLoadCompleted.getTime() - this.lastLoadRequested.getTime(),
-                    msg = `[${target.constructor.name}] | ${loadSpec.typeDisplay} | ${
-                        exception ? 'failed | ' : ''
-                    }${elapsed}ms`;
+                    status = exception ? 'failed' : null,
+                    msg = pull([loadSpec.typeDisplay, status, `${elapsed}ms`, exception], null);
 
                 if (exception) {
                     if (exception.isRoutine) {
-                        console.debug(msg, exception);
+                        logDebug(msg, target);
                     } else {
-                        console.error(msg, exception);
+                        logError(msg, target);
                     }
                 } else {
-                    console.debug(msg);
+                    logDebug(msg, target);
                 }
             });
     }

diff --git a/desktop/cmp/button/ColChooserButton.ts b/desktop/cmp/button/ColChooserButton.ts
@@ -12,7 +12,7 @@ import {ColChooserModel} from '@xh/hoist/desktop/cmp/grid/impl/colchooser/ColCho
 import '@xh/hoist/desktop/register';
 import {Icon} from '@xh/hoist/icon';
 import {popover, Position} from '@xh/hoist/kit/blueprint';
-import {stopPropagation, withDefault} from '@xh/hoist/utils/js';
+import {logError, stopPropagation, withDefault} from '@xh/hoist/utils/js';
 import {button, ButtonProps} from './Button';
 
 export interface ColChooserButtonProps extends ButtonProps {
@@ -40,15 +40,17 @@ export const [ColChooserButton, colChooserButton] = hoistCmp.withFactory<ColChoo
         const colChooserModel = gridModel?.colChooserModel as ColChooserModel;
 
         if (!gridModel) {
-            console.error(
-                "No GridModel available to ColChooserButton.  Provide via a 'gridModel' prop, or context."
+            logError(
+                "No GridModel available.  Provide via a 'gridModel' prop, or context.",
+                ColChooserButton
             );
             disabled = true;
         }
 
         if (!colChooserModel) {
-            console.error(
-                'No ColChooserModel available on bound GridModel - enable via GridModel.colChooserModel config.'
+            logError(
+                'No ColChooserModel available on bound GridModel - enable via GridModel.colChooserModel config.',
+                ColChooserButton
             );
             disabled = true;
         }

diff --git a/desktop/cmp/button/ZoneMapperButton.ts b/desktop/cmp/button/ZoneMapperButton.ts
@@ -12,7 +12,7 @@ import {ZoneMapperModel} from '@xh/hoist/cmp/zoneGrid/impl/ZoneMapperModel';
 import {zoneMapper} from '@xh/hoist/desktop/cmp/zoneGrid/impl/ZoneMapper';
 import {Icon} from '@xh/hoist/icon';
 import {popover, Position} from '@xh/hoist/kit/blueprint';
-import {stopPropagation, withDefault} from '@xh/hoist/utils/js';
+import {logError, stopPropagation, withDefault} from '@xh/hoist/utils/js';
 import {button, ButtonProps} from './Button';
 
 export interface ZoneMapperButtonProps extends ButtonProps {
@@ -37,15 +37,17 @@ export const [ZoneMapperButton, zoneMapperButton] = hoistCmp.withFactory<ZoneMap
         const mapperModel = zoneGridModel?.mapperModel as ZoneMapperModel;
 
         if (!zoneGridModel) {
-            console.error(
-                "No ZoneGridModel available to ZoneMapperButton. Provide via a 'zoneGridModel' prop, or context."
+            logError(
+                "No ZoneGridModel available. Provide via a 'zoneGridModel' prop, or context.",
+                ZoneMapperButton
             );
             disabled = true;
         }
 
         if (!mapperModel) {
-            console.error(
-                'No ZoneMapperModel available on bound ZoneGridModel - enable via ZoneGridModel.zoneMapperModel config.'
+            logError(
+                'No ZoneMapperModel available on bound ZoneGridModel - enable via ZoneGridModel.zoneMapperModel config.',
+                ZoneMapperButton
             );
             disabled = true;
         }

diff --git a/desktop/cmp/dash/canvas/DashCanvasModel.ts b/desktop/cmp/dash/canvas/DashCanvasModel.ts
@@ -189,7 +189,7 @@ export class DashCanvasModel extends DashModel<
                 this.provider = PersistenceProvider.create({path: 'dashCanvas', ...persistWith});
                 persistState = this.provider.read();
             } catch (e) {
-                console.error(e);
+                this.logError(e);
                 XH.safeDestroy(this.provider);
                 this.provider = null;
             }
@@ -419,7 +419,7 @@ export class DashCanvasModel extends DashModel<
                 if (this.hasSpec(viewSpecId)) {
                     this.addViewInternal(viewSpecId, state);
                 } else {
-                    console.warn(`Unknown viewSpecId [${viewSpecId}] found in state - skipping.`);
+                    this.logWarn(`Unknown viewSpecId [${viewSpecId}] found in state - skipping.`);
                 }
             });
         } finally {

diff --git a/desktop/cmp/dash/container/DashContainerModel.ts b/desktop/cmp/dash/container/DashContainerModel.ts
@@ -195,7 +195,7 @@ export class DashContainerModel extends DashModel<
                 this.provider = PersistenceProvider.create({path: 'dashContainer', ...persistWith});
                 persistState = this.provider.read();
             } catch (e) {
-                console.error(e);
+                this.logError(e);
                 XH.safeDestroy(this.provider);
                 this.provider = null;
             }
@@ -238,7 +238,7 @@ export class DashContainerModel extends DashModel<
     async loadStateAsync(state) {
         const containerEl = this.containerRef.current;
         if (!containerEl) {
-            console.warn(
+            this.logWarn(
                 'DashboardContainer not yet rendered - cannot update state - change will be discarded!'
             );
             return;

diff --git a/desktop/cmp/form/FormField.ts b/desktop/cmp/form/FormField.ts
@@ -15,7 +15,7 @@ import {fmtDate, fmtDateTime, fmtJson, fmtNumber} from '@xh/hoist/format';
 import {Icon} from '@xh/hoist/icon';
 import {tooltip} from '@xh/hoist/kit/blueprint';
 import {isLocalDate} from '@xh/hoist/utils/datetime';
-import {errorIf, getTestId, TEST_ID, throwIf, withDefault} from '@xh/hoist/utils/js';
+import {errorIf, getTestId, logWarn, TEST_ID, throwIf, withDefault} from '@xh/hoist/utils/js';
 import {getLayoutProps, getReactElementName, useOnMount, useOnUnmount} from '@xh/hoist/utils/react';
 import classNames from 'classnames';
 import {isBoolean, isDate, isEmpty, isFinite, isNil, isUndefined, kebabCase} from 'lodash';
@@ -107,7 +107,7 @@ export const [FormField, formField] = hoistCmp.withFactory<FormFieldProps>({
         model = model ?? (formModel && field ? formModel.fields[field] : null);
 
         if (!model) {
-            console.warn(`Unable to bind FormField to field "${field}" on backing FormModel`);
+            logWarn(`Unable to bind FormField to field "${field}" on backing FormModel`, FormField);
         }
 
         // Model related props

diff --git a/desktop/cmp/grid/editors/BooleanEditor.ts b/desktop/cmp/grid/editors/BooleanEditor.ts
@@ -12,6 +12,7 @@ import {useImperativeHandle} from 'react';
 import {EditorProps} from './EditorProps';
 import './Editors.scss';
 import {useInlineEditorModel} from './impl/InlineEditorModel';
+import {logWarn} from '@xh/hoist/utils/js';
 
 export interface BooleanEditorProps extends EditorProps<CheckboxProps> {
     /**
@@ -35,7 +36,10 @@ export const [BooleanEditor, booleanEditor] = hoistCmp.withFactory<BooleanEditor
         quickToggle = quickToggle ?? !fullRowEditing;
 
         if (quickToggle && fullRowEditing) {
-            console.warn("'quickToggle' prop ignored for GridModel with full row editing.");
+            logWarn(
+                "'quickToggle' prop ignored for GridModel with full row editing.",
+                BooleanEditor
+            );
             quickToggle = false;
         }
 

diff --git a/desktop/cmp/input/DateInput.ts b/desktop/cmp/input/DateInput.ts
@@ -319,9 +319,7 @@ class DateInputModel extends HoistInputModel {
             if (date) {
                 date = this.applyPrecision(date);
             } else {
-                console.debug(
-                    'DateInput value exceeded max/minDate bounds on change - reset to null.'
-                );
+                this.logDebug('Value exceeded max/minDate bounds on change - reset to null.');
             }
         }
         this.noteValueChange(date);

diff --git a/desktop/cmp/panel/Panel.ts b/desktop/cmp/panel/Panel.ts
@@ -23,6 +23,7 @@ import {toolbar} from '@xh/hoist/desktop/cmp/toolbar';
 import {useContextMenu, useHotkeys} from '@xh/hoist/desktop/hooks';
 import '@xh/hoist/desktop/register';
 import {HotkeyConfig} from '@xh/hoist/kit/blueprint';
+import {logWarn} from '@xh/hoist/utils/js';
 import {splitLayoutProps} from '@xh/hoist/utils/react';
 import {castArray, omitBy} from 'lodash';
 import {Children, isValidElement, ReactElement, ReactNode, useLayoutEffect, useRef} from 'react';
@@ -256,8 +257,9 @@ function parseLoadDecorator(prop: any, name: string, contextModel: HoistModel) {
     if (prop === 'onLoad') {
         const loadModel = contextModel?.loadModel;
         if (!loadModel) {
-            console.warn(
-                `Cannot use 'onLoad' for '${name}' - the linked context model must enable LoadSupport to support this feature.`
+            logWarn(
+                `Cannot use 'onLoad' for '${name}' - the linked context model must enable LoadSupport to support this feature.`,
+                Panel
             );
             return null;
         }

diff --git a/desktop/cmp/panel/PanelModel.ts b/desktop/cmp/panel/PanelModel.ts
@@ -213,20 +213,20 @@ export class PanelModel extends HoistModel {
                 : defaultSize;
 
         if ((collapsible || resizable) && (isNil(defaultSize) || isNil(side))) {
-            console.error(
+            this.logError(
                 "Must specify 'defaultSize' and 'side' for a collapsible or resizable PanelModel. Panel sizing disabled."
             );
             collapsible = false;
             resizable = false;
         }
 
         if (!isNil(maxSize) && maxSize < minSize) {
-            console.error("'maxSize' must be greater than 'minSize'. No 'maxSize' will be set.");
+            this.logError("'maxSize' must be greater than 'minSize'. No 'maxSize' will be set.");
             maxSize = null;
         }
 
         if (resizable && !resizeWhileDragging && !showSplitter) {
-            console.error(
+            this.logError(
                 "Must not set 'showSplitter = false' for a resizable PanelModel unless 'resizeWhileDragging` is enabled. Panel sizing disabled."
             );
             resizable = false;
@@ -277,7 +277,7 @@ export class PanelModel extends HoistModel {
                 this.provider = PersistenceProvider.create({path: 'panel', ...persistWith});
                 state = this.provider.read() ?? this.legacyState();
             } catch (e) {
-                console.error(e);
+                this.logError(e);
                 XH.safeDestroy(this.provider);
                 this.provider = null;
             }
@@ -408,7 +408,7 @@ export class PanelModel extends HoistModel {
                     return data;
                 }
             } catch (e) {
-                console.error('Failed reading legacy state');
+                this.logError('Failed reading legacy state', e);
             }
         }
         return null;