Merge pull request #164 from WebDevStudios/feature/CC-332-webhook-logging

Add logging to various parts of our code, mostly around connections and webhooks.

Author: tw2113

src/Api/KeyManager.php

@@ -9,6 +9,7 @@
 namespace WebDevStudios\CCForWoo\Api;
 
 use WebDevStudios\OopsWP\Structure\Service;
+use WebDevStudios\CCForWoo\Utility\DebugLogging;
 
 /**
  * KeyManager class
@@ -56,6 +57,13 @@ public function maybe_revoke_api_key( string $query ) : string {
 		 */
 		do_action( 'cc_woo_key_revoked' );
 
+		$ctct_logger = new DebugLogging(
+			wc_get_logger(),
+			'WooCommerce API Key with Constant Contact revoked',
+			'info'
+		);
+		$ctct_logger->log();
+
 		return $query;
 	}
 

src/Meta/ConnectionStatus.php

@@ -9,6 +9,8 @@
 
 namespace WebDevStudios\CCForWoo\Meta;
 
+use WebDevStudios\CCForWoo\Utility\DebugLogging;
+
 /**
  * Class PluginOption
  *
@@ -105,5 +107,13 @@ public function set_connection( int $connected, int $user_id ) {
 		if ( $this->connected ) {
 			update_option( self::CC_FIRST_CONNECTION, true );
 		}
+
+		$ctct_logger = new DebugLogging(
+			wc_get_logger(),
+			'Constant Contact connection set',
+			'info',
+			[ 'status' => $connected ]
+		);
+		$ctct_logger->log();
 	}
 }

src/Rest/AbandonedCheckouts/Controller.php

@@ -8,6 +8,7 @@
 
 namespace WebDevStudios\CCForWoo\Rest\AbandonedCheckouts;
 
+use WebDevStudios\CCForWoo\Utility\DebugLogging;
 use WP_REST_Server;
 use WP_REST_Request;
 use WP_REST_Controller;
@@ -79,6 +80,15 @@ public function register_routes() {
 	 */
 	public function get_items_permissions_check( $request ) {
 		if ( ! wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
+
+			$ctct_logger = new DebugLogging(
+				wc_get_logger(),
+				'CTCT Woo: no permission to check abandoned checkout',
+				'warning',
+				[ 'cc-woo-rest-not-allowed' => $request ]
+			);
+			$ctct_logger->log();
+
 			return new WP_Error( 'cc-woo-rest-not-allowed', esc_html__( 'Sorry, you cannot list resources.', 'cc-woo' ), [ 'status' => rest_authorization_required_code() ] );
 		}
 

src/Rest/PluginVersion/Controller.php

@@ -8,6 +8,7 @@
 
 namespace WebDevStudios\CCForWoo\Rest\PluginVersion;
 
+use WebDevStudios\CCForWoo\Utility\DebugLogging;
 use WP_REST_Server;
 use WP_REST_Request;
 use WP_REST_Controller;
@@ -76,6 +77,15 @@ public function register_routes() {
 	 */
 	public function get_item_permissions_check( $request ) {
 		if ( ! wc_rest_check_manager_permissions( 'settings', 'read' ) ) {
+
+			$ctct_logger = new DebugLogging(
+				wc_get_logger(),
+				'CTCT Woo: no permission to check version',
+				'warning',
+				[ 'cc-woo-rest-not-allowed' => $request ]
+			);
+			$ctct_logger->log();
+
 			return new WP_Error( 'cc-woo-rest-not-allowed', esc_html__( 'Sorry, you cannot list that resource.', 'cc-woo' ), [ 'status' => rest_authorization_required_code() ] );
 		}
 

src/Utility/DebugLogging.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace WebDevStudios\CCForWoo\Utility;
+
+/**
+ * Class DebugLogging
+ */
+class DebugLogging {
+
+	/**
+	 * The logger from WooCommerce.
+	 *
+	 * @since NEXT
+	 * @var object
+	 */
+	private $logger;
+
+	/**
+	 * The message to log.
+	 *
+	 * @var mixed|string
+	 */
+	private $message;
+
+	/**
+	 * The message level.
+	 *
+	 * See https://developer.woocommerce.com/2017/01/26/improved-logging-in-woocommerce-2-7/
+	 *
+	 * @var mixed|string
+	 */
+	private $level;
+
+	/**
+	 * Extra contextual information for the log item.
+	 *
+	 * @var array|mixed
+	 */
+	private $extras;
+
+	/**
+	 * Construct our compatibility checker with the main plugin class.
+	 *
+	 * @param string $classname The classname to use for testing.
+	 *
+	 * @author Zach Owen <zach@webdevstudios>
+	 * @since  0.0.1
+	 */
+	public function __construct( $logger, $message = '', $level = '', $extras = [] ) {
+		$this->logger  = $logger;
+		$this->message = $message;
+		$this->level   = $level;
+		$this->extras  = $extras;
+	}
+
+	/**
+	 * Perform our logging, if WP_DEBUG_LOG is enabled.
+	 *
+	 * @since NEXT
+	 */
+	public function log() {
+		if ( defined( 'WP_DEBUG_LOG' ) ) {
+			$this->logger->{$this->level}(
+				$this->message,
+				$this->extras
+			);
+		}
+	}
+}

src/View/Admin/Disconnect.php

@@ -1,7 +1,8 @@
-<?php 
+<?php
 // Handles the plugin disconnection.
 
 namespace WebDevStudios\CCForWoo\View\Admin;
+use WebDevStudios\CCForWoo\Utility\DebugLogging;
 use WebDevStudios\OopsWP\Structure\Service;
 use WebDevStudios\CCForWoo\Meta\ConnectionStatus;
 use WebDevStudios\CCForWoo\AbandonedCheckouts\CheckoutsTable;
@@ -12,7 +13,7 @@
  * @return void
  */
 class Disconnect extends Service {
-    
+
     /**
     * Constructor.
     *
@@ -22,7 +23,7 @@ class Disconnect extends Service {
     public function register_hooks() {
         add_action( 'admin_init', array( $this, 'disconnect' ) );
     }
-    
+
     /**
     * Disconnects the plugin from Constant Contact WOO.
     *
@@ -34,10 +35,17 @@ public function disconnect() {
             return;
         }
 
+	    $ctct_logger = new DebugLogging(
+		    wc_get_logger(),
+		    'CTCT Woo: Plugin disconnected from Constant Contact',
+		    'info'
+	    );
+	    $ctct_logger->log();
+
         $this->disconnect_plugin();
         $this->redirect();
     }
-    
+
     /**
     * Disconnects the plugin from Constant Contact WOO.
     *
@@ -61,7 +69,7 @@ public function disconnect_plugin() {
 		delete_option( ConnectionStatus::CC_CONNECTION_USER_ID );
 		delete_option( ConnectionStatus::CC_FIRST_CONNECTION );
 		delete_option( ConnectionStatus::CC_CONNECTION_ESTABLISHED_KEY );
-		
+
 
 		// WooCommerce Options
 		delete_option( 'cc_woo_store_information_first_name' );
@@ -75,7 +83,7 @@ public function disconnect_plugin() {
 		delete_option( 'constant_contact_for_woo_has_setup' );
 		delete_option( 'cc_woo_customer_data_allow_import' );
     }
-    
+
     /**
     * Redirects to the admin page.
     *
@@ -87,8 +95,8 @@ public function redirect() {
         $url = add_query_arg([
             'tab'  => 'wc-settings' === $_GET['page'] ? 'cc_woo' : '',
             'cc-connect' => '',
-        ], $url );  
+        ], $url );
         wp_redirect( $url );
         exit;
     }
-}
+}