woocommerce/woocommerce-paypal-payments
2
0
Fork 0
mirror of https://github.com/woocommerce/woocommerce-paypal-payments.git synced 2025-09-06 10:55:00 +08:00
Code Issues Projects Packages Wiki Activity Actions 7

✨ Introduce a new ConsoleLogger JS class

Browse source 
Extract debug logic to separate component
This commit is contained in:
Philipp Stracker 2024-08-02 16:32:27 +02:00
parent 9da37a2cc6
commit f1f243505c
No known key found for this signature in database
2 changed files with 56 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

42
modules/ppcp-button/resources/js/modules/Helper/ConsoleLogger.js Normal file
View file

@ -0,0 +1,42 @@
/**
* Logs debug details to the console.
*
* A utility class that is used by payment buttons on the front-end, like the GooglePayButton.
*/
export default class ConsoleLogger {
/**
* The prefix to display before every log output.
*
* @type {string}
*/
#prefix = '';
/**
* Whether logging is enabled, disabled by default.
*
* @type {boolean}
*/
#enabled = false;
constructor( ...prefixes ) {
if ( prefixes.length ) {
this.#prefix = `[${ prefixes.join( ' | ' ) }]`;
}
}
set enabled( state ) {
this.#enabled = state;
}
log( ...args ) {
if ( this.#enabled ) {
console.log( this.#prefix, ...args );
}
}
error( ...args ) {
if ( this.#enabled ) {
console.error( this.#prefix, ...args );
}
}
}

41
modules/ppcp-googlepay/resources/js/GooglepayButton.js
View file

@ -1,5 +1,6 @@
/* global google */
import ConsoleLogger from '../../../ppcp-button/resources/js/modules/Helper/ConsoleLogger';
import widgetBuilder from '../../../ppcp-button/resources/js/modules/Renderer/WidgetBuilder';
import UpdatePaymentData from './Helper/UpdatePaymentData';
import { apmButtonsInit } from '../../../ppcp-button/resources/js/modules/Helper/ApmButtons';
@ -28,6 +29,11 @@ import {
*/
class GooglepayButton {
/**
* @type {ConsoleLogger}
*/
#logger;
#wrapperId = '';
#ppcpButtonWrapperId = '';
@ -66,7 +72,8 @@ class GooglepayButton {
ppcpConfig,
contextHandler
) {
this._initDebug( !! buttonConfig?.is_debug, context );
this.#logger = new ConsoleLogger( 'GooglePayButton', context );
this.#logger.enabled = !! buttonConfig?.is_debug;
apmButtonsInit( ppcpConfig );
@ -81,34 +88,12 @@ class GooglepayButton {
this.log( 'Create instance' );
}
/**
* NOOP log function to avoid errors when debugging is disabled.
*/
log() {}
/**
* Enables debugging tools, when the button's is_debug flag is set.
*
* @param {boolean} enableDebugging If debugging features should be enabled for this instance.
* @param {string} context Used to make the instance accessible via the global debug
* object.
* @private
*/
_initDebug( enableDebugging, context ) {
if ( ! enableDebugging || this.#isInitialized ) {
return;
log( ...args ) {
this.#logger.log( ...args );
}
document.ppcpGooglepayButtons = document.ppcpGooglepayButtons || {};
document.ppcpGooglepayButtons[ context ] = this;
this.log = ( ...args ) => {
console.log( `[GooglePayButton | ${ context }]`, ...args );
};
document.addEventListener( 'ppcp-googlepay-debug', () => {
this.log( this );
} );
error( ...args ) {
this.#logger.error( ...args );
}
/**
@ -550,7 +535,7 @@ class GooglepayButton {
if ( timeElapsed > timeout ) {
stop();
this.log( '!! Wrapper not found:', this.wrapperId );
this.error( 'Wrapper not found:', this.wrapperId );
}
};