Merge pull request #249 from Matt75/fix-logs

Fix logs
PrestaShopCorp · Jan 9, 2020 · 6f48327 · 6f48327
2 parents 1f0d52b + 070c94c
commit 6f48327
Show file tree

Hide file tree

Showing 11 changed files with 84 additions and 12 deletions.
diff --git a/_dev/src/pages/Debug.vue b/_dev/src/pages/Debug.vue
@@ -29,13 +29,26 @@
           <li>Shop ID: <b>{{ shopId }}</b></li>
           <li>Rounding config: <b>{{ roundingSettingsIsCorrect }}</b></li>
         </ul>
+        <PSSwitch id="hostedFieldsAvailability" v-model="debugLogsEnabled">
+          <template v-if="debugLogsEnabled">
+            Logs enabled
+          </template>
+          <template v-else>
+            Logs disabled
+          </template>
+        </PSSwitch>
       </b-card-body>
     </b-card>
   </b-container>
 </template>
 
 <script>
+  import PSSwitch from '@/components/form/switch';
+
   export default {
+    components: {
+      PSSwitch,
+    },
     name: 'Debug',
     computed: {
       moduleVersion() {
@@ -50,6 +63,14 @@
       roundingSettingsIsCorrect() {
         return this.$store.getters.roundingSettingsIsCorrect;
       },
+      debugLogsEnabled: {
+        get() {
+          return this.$store.state.configuration.debugLogsEnabled;
+        },
+        set(payload) {
+          this.$store.dispatch('toggleDebugLogs', payload);
+        },
+      },
     },
   };
 </script>
diff --git a/_dev/src/store/modules/configuration/actions.js b/_dev/src/store/modules/configuration/actions.js
@@ -110,4 +110,17 @@ export default {
       return Promise.resolve(payload);
     });
   },
+
+  toggleDebugLogs({commit, getters}, payload) {
+    return ajax({
+      url: getters.adminController,
+      action: 'ToggleDebugLogs',
+      data: {
+        status: payload ? 1 : 0,
+      },
+    }).then(() => {
+      commit(types.UPDATE_DEBUG_LOGS, payload);
+      return Promise.resolve(payload);
+    });
+  },
 };
diff --git a/_dev/src/store/modules/configuration/mutation-types.js b/_dev/src/store/modules/configuration/mutation-types.js
@@ -23,3 +23,4 @@ export const UPDATE_PAYMENT_CARD_AVAILABILITY = 'UPDATE_PAYMENT_CARD_AVAILABILIT
 export const UPDATE_EC_ORDER_PAGE = 'UPDATE_EC_ORDER_PAGE';
 export const UPDATE_EC_CHECKOUT_PAGE = 'UPDATE_EC_CHECKOUT_PAGE';
 export const UPDATE_EC_PRODUCT_PAGE = 'UPDATE_EC_PRODUCT_PAGE';
+export const UPDATE_DEBUG_LOGS = 'UPDATE_DEBUG_LOGS';
diff --git a/_dev/src/store/modules/configuration/mutations.js b/_dev/src/store/modules/configuration/mutations.js
@@ -40,4 +40,7 @@ export default {
   [types.UPDATE_EC_PRODUCT_PAGE](state, payload) {
     state.expressCheckout.productPage = payload;
   },
+  [types.UPDATE_DEBUG_LOGS](state, payload) {
+    state.debugLogsEnabled = payload;
+  },
 };
diff --git a/classes/Api/GenericClient.php b/classes/Api/GenericClient.php
@@ -76,18 +76,21 @@ protected function post(array $options = [])
     {
         $response = $this->getClient()->post($this->getRoute(), $options);
 
-        /**
-         * @var \Ps_checkout
-         */
-        $module = \Module::getInstanceByName('ps_checkout');
-        $logger = $module->getLogger();
-        $logger->debug('route ' . $this->getRoute());
-        $logger->debug('options ' . var_export($options, true));
-
         $responseHandler = new ResponseApiHandler();
 
         $response = $responseHandler->handleResponse($response);
-        $logger->debug('response ' . var_export($response, true));
+
+        // If response is not successful only
+        if (\Configuration::get('PS_CHECKOUT_DEBUG_LOGS_ENABLED') && !$response['status']) {
+            /**
+             * @var \Ps_checkout
+             */
+            $module = \Module::getInstanceByName('ps_checkout');
+            $logger = $module->getLogger();
+            $logger->debug('route ' . $this->getRoute());
+            $logger->debug('options ' . var_export($options, true));
+            $logger->debug('response ' . var_export($response, true));
+        }
 
         return $response;
     }

diff --git a/classes/Factory/CheckoutLogger.php b/classes/Factory/CheckoutLogger.php
@@ -25,12 +25,16 @@
 
 class CheckoutLogger
 {
-    const MAX_FILES = 30;
+    const MAX_FILES = 15;
 
     public static function create()
     {
+        $path = version_compare(_PS_VERSION_, '1.7.4', '>=')
+            ? _PS_ROOT_DIR_ . '/var/logs/ps_checkout'
+            : _PS_ROOT_DIR_ . '/app/logs/ps_checkout'
+        ;
         $rotatingFileHandler = new RotatingFileHandler(
-            _PS_ROOT_DIR_ . '/var/logs/ps_checkout',
+            $path,
             static::MAX_FILES
         );
         $logger = new Logger('ps_checkout');

diff --git a/classes/Presenter/Store/Modules/ConfigurationModule.php b/classes/Presenter/Store/Modules/ConfigurationModule.php
@@ -40,6 +40,7 @@ public function present()
                 'captureMode' => \Configuration::get('PS_CHECKOUT_INTENT'),
                 'paymentMode' => \Configuration::get('PS_CHECKOUT_MODE'),
                 'cardIsEnabled' => (bool) \Configuration::get('PS_CHECKOUT_CARD_PAYMENT_ENABLED'),
+                'debugLogsEnabled' => (bool) \Configuration::get('PS_CHECKOUT_DEBUG_LOGS_ENABLED'),
                 'expressCheckout' => [
                     'orderPage' => (bool) \Configuration::get('PS_CHECKOUT_EC_ORDER_PAGE'),
                     'checkoutPage' => (bool) \Configuration::get('PS_CHECKOUT_EC_CHECKOUT_PAGE'),

diff --git a/controllers/admin/AdminAjaxPrestashopCheckoutController.php b/controllers/admin/AdminAjaxPrestashopCheckoutController.php
@@ -265,4 +265,15 @@ public function ajaxProcessToggleECProductPage()
             Tools::getValue('status') ? 1 : 0
         );
     }
+
+    /**
+     * AJAX: Toggle logs for debug
+     */
+    public function ajaxProcessToggleDebugLogs()
+    {
+        Configuration::updateValue(
+            'PS_CHECKOUT_DEBUG_LOGS_ENABLED',
+            Tools::getValue('status') ? 1 : 0
+        );
+    }
 }
diff --git a/ps_checkout.php b/ps_checkout.php
@@ -120,7 +120,6 @@ public function __construct()
             'AdminAjaxPrestashopCheckout',
             'AdminPaypalOnboardingPrestashopCheckout',
         ];
-        $this->logger = CheckoutLogger::create();
     }
 
     /**
@@ -899,6 +898,12 @@ public function addCheckoutPaymentForAllActivatedCountries()
      */
     public function getLogger()
     {
+        if (null !== $this->logger) {
+            return $this->logger;
+        }
+
+        $this->logger = CheckoutLogger::create();
+
         return $this->logger;
     }
 }
diff --git a/tests/PaymentCreateOrderTest.php b/tests/PaymentCreateOrderTest.php
@@ -71,6 +71,14 @@ public function debug($msg)
     }
 }
 
+class Configuration
+{
+    public static function get($key)
+    {
+        return $key;
+    }
+}
+
 class PaymentCreateOrderTest extends TestCase
 {
     public function testCreateOrderDefaultScenario()

diff --git a/tests/phpstan/phpstan.neon b/tests/phpstan/phpstan.neon
@@ -4,6 +4,8 @@ parameters:
 		- classes
 		- controllers
 		- ps_checkout.php
+	dynamicConstantNames:
+		- _PS_VERSION_
 	reportUnmatchedIgnoredErrors: false
 	ignoreErrors:
 		- '#Cannot assign offset "merchant…" to string|true.#'