util: add new central logger

ChlodAlejandro · ChlodAlejandro · commit 530a76a57e1d · 2024-05-28T17:48:23.000+08:00
diff --git a/src/Deputy.ts b/src/Deputy.ts
@@ -23,6 +23,7 @@ import WikiConfiguration from './config/WikiConfiguration';
 import Recents from './wiki/Recents';
 import util from './util';
 import wikiUtil from './wiki/util';
+import log from './util/log';
 import DeputyAnnouncements from './DeputyAnnouncements';
 
 /**
@@ -169,7 +170,7 @@ class Deputy {
 		}
 		await this.wikiConfig.prepareEditBanners();
 
-		console.log( 'Loaded!' );
+		log( 'Loaded!' );
 
 		mw.hook( 'deputy.load' ).fire( this );
 
diff --git a/src/DeputyCommunications.ts b/src/DeputyCommunications.ts
@@ -2,6 +2,7 @@ import 'broadcastchannel-polyfill';
 import { ContributionSurveyRowStatus } from './models/ContributionSurveyRow';
 import generateId from './util/generateId';
 import { WikiPageConfiguration } from './config/WikiConfiguration';
+import log from './util/log';
 
 /**
  * Generic message used to acknowledge an action. This is usually required by
@@ -285,7 +286,7 @@ export default class DeputyCommunications extends EventTarget {
 
 		this.broadcastChannel.addEventListener( 'message', ( event ) => {
 			// TODO: debug
-			console.log( Date.now() - start, '[deputy comms]: in', event.data );
+			log( Date.now() - start, 'comms in: ', event.data );
 			if ( event.data && typeof event.data === 'object' && event.data._deputy ) {
 				this.dispatchEvent(
 					Object.assign( new Event( event.data.type ), {
@@ -309,7 +310,7 @@ export default class DeputyCommunications extends EventTarget {
 		);
 		this.broadcastChannel.postMessage( message );
 		// TODO: debug
-		console.log( Date.now() - start, '[deputy comms]: out', data );
+		log( Date.now() - start, 'comms out:', data );
 
 		return message;
 	}
@@ -355,7 +356,7 @@ export default class DeputyCommunications extends EventTarget {
 				}
 			};
 			handlers.listener = ( ( event: MessageEvent<InboundDeputyMessage> ) => {
-				console.log( event );
+				log( event );
 				if (
 					event.data._deputyRespondsTo === message._deputyMessageId &&
 					event.data.type === OneWayDeputyMessageMap[ data.type ]
diff --git a/src/DeputyLanguage.ts b/src/DeputyLanguage.ts
@@ -1,5 +1,7 @@
 import { DeputyResources } from './DeputyResources';
 import cloneRegex from './util/cloneRegex';
+import error from './util/error';
+import warn from './util/warn';
 
 /**
  * Handles internationalization and localization for Deputy and sub-modules.
@@ -40,7 +42,7 @@ export default class DeputyLanguage {
 				mw.messages.set( key, langData[ key ] );
 			}
 		} catch ( e ) {
-			console.error( e );
+			error( e );
 			mw.notify(
 				// No languages to fall back on. Do not translate this string.
 				'Deputy: Requested language page is not a valid JSON file.',
@@ -73,7 +75,7 @@ export default class DeputyLanguage {
 
 		if ( mw.loader.getState( 'moment' ) !== 'ready' ) {
 			// moment.js is not yet loaded.
-			console.warn(
+			warn(
 				'Deputy tried loading moment.js locales but moment.js is not yet ready.'
 			);
 			return;
@@ -136,7 +138,7 @@ export default class DeputyLanguage {
 			}
 		} catch ( e ) {
 			// Silent failure.
-			console.error( 'Deputy: Requested language page is not a valid JSON file.', e );
+			error( 'Deputy: Requested language page is not a valid JSON file.', e );
 		}
 	}
 
diff --git a/src/DeputyStorage.ts b/src/DeputyStorage.ts
@@ -2,6 +2,7 @@ import { openDB, DBSchema, IDBPDatabase } from 'idb';
 import { ExpandedRevisionData } from './api/ExpandedRevisionData';
 import { ContributionSurveyRowStatus } from './models/ContributionSurveyRow';
 import MwApi from './MwApi';
+import log from './util/log';
 
 /**
  * General key-value store. Used for storing single-variable data
@@ -122,8 +123,8 @@ export default class DeputyStorage {
 					};
 					while ( currentVersion < newVersion ) {
 						upgrader[ `${currentVersion}` ]();
-						console.log(
-							`[deputy] upgraded database from ${currentVersion} to ${
+						log(
+							`Upgraded database from ${currentVersion} to ${
 								currentVersion + 1
 							}`
 						);
diff --git a/src/config/Setting.ts b/src/config/Setting.ts
@@ -4,6 +4,7 @@
 import UserConfiguration from './UserConfiguration';
 import { ArrayOrNot } from '../types';
 import getObjectValues from '../util/getObjectValues';
+import warn from '../util/warn';
 
 interface DisplayOptionsBase {
 
@@ -225,7 +226,7 @@ export default class Setting<SerializedType, DeserializedType> {
 	 */
 	set( v: DeserializedType, throwOnInvalid = false ) {
 		if ( this.locked ) {
-			console.warn( 'Attempted to modify locked setting.' );
+			warn( 'Attempted to modify locked setting.' );
 			return;
 		}
 
diff --git a/src/config/UserConfiguration.ts b/src/config/UserConfiguration.ts
@@ -9,6 +9,7 @@ import ConfigurationBase from './ConfigurationBase';
 import {
 	ContributionSurveyRowSigningBehavior
 } from '../models/ContributionSurveyRowSigningBehavior';
+import error from '../util/error';
 
 /**
  * A configuration. Defines settings and setting groups.
@@ -31,7 +32,7 @@ export default class UserConfiguration extends ConfigurationBase {
 				config.deserialize( decodedOptions );
 			}
 		} catch ( e ) {
-			console.error( e, mw.user.options.get( UserConfiguration.optionKey ) );
+			error( e, mw.user.options.get( UserConfiguration.optionKey ) );
 			mw.hook( 'deputy.i18nDone' ).add( function notifyConfigFailure() {
 				mw.notify( mw.msg( 'deputy.loadError.userConfig' ), {
 					type: 'error'
diff --git a/src/modules/DeputyModule.ts b/src/modules/DeputyModule.ts
@@ -5,6 +5,7 @@ import deputySharedEnglish from '../../i18n/shared/en.json';
 import UserConfiguration from '../config/UserConfiguration';
 import { attachConfigurationDialogPortletLink } from '../ui/config/ConfigurationDialog';
 import WikiConfiguration from '../config/WikiConfiguration';
+import warn from '../util/warn';
 
 /**
  * A Deputy module. Modules are parts of Deputy that can usually be removed
@@ -112,7 +113,7 @@ export default abstract class DeputyModule {
 
 		if ( this.wikiConfig[ this.getName() as 'ia' | 'ante' ]?.enabled.get() !== true ) {
 			// Stop loading here.
-			console.warn( `[Deputy] Preinit for ${
+			warn( `Preinit for ${
 				this.getName()
 			} cancelled; module is disabled.` );
 			return false;
diff --git a/src/modules/ante/ui/pages/CopiedTemplateRowPage.tsx b/src/modules/ante/ui/pages/CopiedTemplateRowPage.tsx
@@ -15,6 +15,7 @@ import equalTitle from '../../../../util/equalTitle';
 import RevisionDateGetButton from '../components/RevisionDateGetButton';
 import SmartTitleInputWidget from '../components/SmartTitleInputWidget';
 import PageLatestRevisionGetButton from '../components/PageLatestRevisionGetButton';
+import error from '../../../../util/error';
 import dangerModeConfirm from '../../../../util/dangerModeConfirm';
 import parseDiffUrl from '../../../../wiki/util/parseDiffUrl';
 
@@ -613,7 +614,7 @@ function initCopiedTemplateRowPage() {
 				} );
 				confirmProcess.execute();
 			} catch ( e ) {
-				console.error( 'Cannot convert `diff` parameter to URL.', e );
+				error( 'Cannot convert `diff` parameter to URL.', e );
 				OO.ui.alert( mw.msg( 'deputy.ante.copied.diffDeprecate.failed' ) );
 			}
 		}
diff --git a/src/modules/ia/models/CopyrightProblemsListing.ts b/src/modules/ia/models/CopyrightProblemsListing.ts
@@ -5,6 +5,7 @@ import pagelinkToTitle from '../../../wiki/util/pagelinkToTitle';
 import decorateEditSummary from '../../../wiki/util/decorateEditSummary';
 import MwApi from '../../../MwApi';
 import changeTag from '../../../config/changeTag';
+import warn from '../../../util/warn';
 
 export interface SerializedCopyrightProblemsListingData {
 	basic: boolean;
@@ -175,7 +176,7 @@ export default class CopyrightProblemsListing {
 			} else if ( title.getPrefixedText() !== new mw.Title( id ).getPrefixedText() ) {
 				// Anchor and link mismatch. Someone tampered with the template?
 				// In this case, rely on the link instead, as the anchor is merely invisible.
-				console.warn(
+				warn(
 					`Anchor and link mismatch for "${title.getPrefixedText()}".`, title, id
 				);
 			}
@@ -217,7 +218,7 @@ export default class CopyrightProblemsListing {
 				plainlinks: plainlinks as HTMLSpanElement
 			};
 		} catch ( e ) {
-			console.warn( "Couldn't parse listing. Might be malformed?", e, el );
+			warn( "Couldn't parse listing. Might be malformed?", e, el );
 			return false;
 		}
 	}
@@ -276,7 +277,7 @@ export default class CopyrightProblemsListing {
 				element: el as HTMLAnchorElement
 			};
 		} catch ( e ) {
-			console.warn( "Couldn't parse listing. Might be malformed?", e, el );
+			warn( "Couldn't parse listing. Might be malformed?", e, el );
 			return false;
 		}
 	}
diff --git a/src/modules/ia/ui/ListingResponsePanel.tsx b/src/modules/ia/ui/ListingResponsePanel.tsx
@@ -5,6 +5,7 @@ import type CopyrightProblemsListing from '../models/CopyrightProblemsListing';
 import removeElement from '../../../util/removeElement';
 import renderWikitext from '../../../wiki/util/renderWikitext';
 import { CopyrightProblemsResponse } from '../models/CopyrightProblemsResponse';
+import error from '../../../util/error';
 
 /**
  *
@@ -186,7 +187,7 @@ export default class ListingResponsePanel extends EventTarget {
 					type: 'success'
 				} );
 			} catch ( e ) {
-				console.error( e );
+				error( e );
 				OO.ui.alert( mw.msg( 'deputy.ia.listing.re.error', e.message ) );
 
 				this.dropdown.setDisabled( false );
diff --git a/src/ui/config/ConfigurationGroupTabPanel.tsx b/src/ui/config/ConfigurationGroupTabPanel.tsx
@@ -103,11 +103,6 @@ function initConfigurationGroupTabPanel() {
 						break;
 				}
 			}
-
-			this.on( 'change', () => {
-				console.log( this.config.config );
-				console.log( this.config.config.serialize() );
-			} );
 		}
 
 		/**
diff --git a/src/ui/page/DeputyPageToolbar.tsx b/src/ui/page/DeputyPageToolbar.tsx
@@ -17,6 +17,7 @@ import EarwigCopyvioDetector from '../../wiki/EarwigCopyvioDetector';
 import DeputyPageMenu, { DeputyPageMenuOption } from './DeputyPageMenu';
 import deputyPageAnalysisOptions from './DeputyPageAnalysisOptions';
 import deputyPageTools from './DeputyPageTools';
+import error from '../../util/error';
 
 export interface DeputyPageToolbarOptions extends Omit<DeputyPageStatusResponseMessage, 'type'> {
 	/**
@@ -303,7 +304,7 @@ export default class DeputyPageToolbar implements DeputyUIElement {
 							button.setDisabled( true );
 						}
 					} catch ( e ) {
-						console.error( e );
+						error( e );
 						this.setDisabled( false );
 					}
 				} else if ( this.options.nextRevision !== false ) {
diff --git a/src/ui/root/DeputyContributionSurveyRow.tsx b/src/ui/root/DeputyContributionSurveyRow.tsx
@@ -20,6 +20,8 @@ import {
 import DeputyCCIStatusDropdown from '../shared/DeputyCCIStatusDropdown';
 import { ContributionSurveyRowSort } from '../../models/ContributionSurveyRowSort';
 import last from '../../util/last';
+import warn from '../../util/warn';
+import error from '../../util/error';
 import dangerModeConfirm from '../../util/dangerModeConfirm';
 
 export enum DeputyContributionSurveyRowState {
@@ -228,7 +230,7 @@ export default class DeputyContributionSurveyRow extends EventTarget implements
 		}
 
 		if ( this.wasFinished == null ) {
-			console.warn(
+			warn(
 				'Could not determine if this is an originally-finished or ' +
 				'originally-unfinished row. Assuming unfinished and moving on...'
 			);
@@ -478,7 +480,7 @@ export default class DeputyContributionSurveyRow extends EventTarget implements
 			);
 			this.state = DeputyContributionSurveyRowState.Ready;
 		} catch ( e ) {
-			console.error( 'Caught exception while loading data', e );
+			error( 'Caught exception while loading data', e );
 			this.state = DeputyContributionSurveyRowState.Broken;
 			this.renderRow( null, unwrapWidget(
 				new OO.ui.MessageWidget( {
diff --git a/src/ui/root/DeputyContributionSurveySection.tsx b/src/ui/root/DeputyContributionSurveySection.tsx
@@ -20,6 +20,8 @@ import { generateTrace } from '../../models/DeputyTrace';
 import DeputyMessageWidget from '../shared/DeputyMessageWidget';
 import sectionHeadingN from '../../wiki/util/sectionHeadingN';
 import changeTag from '../../config/changeTag';
+import warn from '../../util/warn';
+import error from '../../util/error';
 import DeputyExtraneousElement from './DeputyExtraneousElement';
 import classMix from '../../util/classMix';
 import dangerModeConfirm from '../../util/dangerModeConfirm';
@@ -338,7 +340,7 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 				listElements = Array.from( collapsible.querySelectorAll( 'ul' ) );
 			} else {
 				// No collapsible found. Give up.
-				console.warn( 'Could not find valid ULs in CCI section.', targetSectionNodes );
+				warn( 'Could not find valid ULs in CCI section.', targetSectionNodes );
 				return false;
 			}
 		}
@@ -389,7 +391,7 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 
 				if ( /^\*[^*:]+/.test( line ) ) {
 					// Only trigger on actual bulleted lists.
-					console.warn( 'Could not parse row.', line, e );
+					warn( 'Could not parse row.', line, e );
 					// For debugging and tests.
 					mw.hook( 'deputy.errors.cciRowParse' ).fire( {
 						line, error: e.toString()
@@ -730,7 +732,7 @@ export default class DeputyContributionSurveySection implements DeputyUIElement
 						title: mw.msg( 'deputy.session.section.failed' )
 					}
 				);
-				console.error( err );
+				error( err );
 				saveContainer.classList.remove( 'active' );
 				this.setDisabled( false );
 			} );
diff --git a/src/ui/root/DeputyFinishedContributionSurveyRow.tsx b/src/ui/root/DeputyFinishedContributionSurveyRow.tsx
@@ -5,6 +5,7 @@ import guessAuthor from '../../wiki/util/guessAuthor';
 import nsId from '../../wiki/util/nsId';
 import type { Moment } from 'moment';
 import { guessTrace } from '../../models/DeputyTrace';
+import warn from '../../util/warn';
 
 /**
  * Displayed when a ContributionSurveyRow has no remaining diffs. Deputy is not able
@@ -59,7 +60,7 @@ export default class DeputyFinishedContributionSurveyRow {
 		try {
 			parsedComment = parser.parse( props.originalElement )?.commentItems?.[ 0 ];
 		} catch ( e ) {
-			console.warn( 'Failed to parse user signature.', e );
+			warn( 'Failed to parse user signature.', e );
 		}
 		if ( !parsedComment ) {
 			// See if the Deputy trace exists.
diff --git a/src/util/error.ts b/src/util/error.ts
@@ -0,0 +1,8 @@
+/**
+ * Log errors to the console.
+ *
+ * @param {...any} data
+ */
+export default function error( ...data: any[] ) {
+	console.error( '[Deputy]', ...data );
+}
diff --git a/src/util/log.ts b/src/util/log.ts
@@ -0,0 +1,8 @@
+/**
+ * Log to the console.
+ *
+ * @param {...any} data
+ */
+export default function log( ...data: any[] ) {
+	console.log( '[Deputy]', ...data );
+}
diff --git a/src/util/swapElements.ts b/src/util/swapElements.ts
@@ -1,3 +1,5 @@
+import error from './error';
+
 /**
  * Swaps two elements in the DOM. Element 1 will be removed from the DOM, Element 2 will
  * be added in its place.
@@ -12,7 +14,7 @@ export default function <T extends Element> ( element1: T, element2: T ): T {
 		element1.parentElement.removeChild( element1 );
 		return element2;
 	} catch ( e ) {
-		console.error( e, { element1, element2 } );
+		error( e, { element1, element2 } );
 		// Caught for debug only. Rethrow.
 		throw e;
 	}
diff --git a/src/util/unwrapWidget.ts b/src/util/unwrapWidget.ts
@@ -1,3 +1,5 @@
+import error from './error';
+
 /**
  * Unwraps an OOUI widget from its JQuery `$element` variable and returns it as an
  * HTML element.
@@ -7,7 +9,7 @@
  */
 export default function ( el: OO.ui.Element ): HTMLElement {
 	if ( el.$element == null ) {
-		console.error( el );
+		error( el );
 		throw new Error( 'Element is not an OOUI Element!' );
 	}
 	return el.$element[ 0 ];
diff --git a/src/util/warn.ts b/src/util/warn.ts
@@ -0,0 +1,8 @@
+/**
+ * Log warnings to the console.
+ *
+ * @param {...any} data
+ */
+export default function warn( ...data: any[] ) {
+	console.warn( '[Deputy]', ...data );
+}
diff --git a/src/wiki/util/parseDiffUrl.ts b/src/wiki/util/parseDiffUrl.ts
diff --git a/src/wiki/util/sectionHeadingId.ts b/src/wiki/util/sectionHeadingId.ts
diff --git a/src/wiki/util/sectionHeadingN.ts b/src/wiki/util/sectionHeadingN.ts
diff --git a/src/wiki/util/sectionHeadingName.ts b/src/wiki/util/sectionHeadingName.ts
