return error string when trying to create optimized endpoint file

Author: dannyvankooten

.browserslistrc

@@ -13,8 +13,8 @@ class Admin_Actions
     public static function install_optimized_endpoint(): void
     {
         $installer = new Endpoint_Installer();
-        $success = $installer->install();
-        wp_safe_redirect(add_query_arg(['endpoint-installed' => (int) $success], wp_get_referer()));
+        $result = $installer->install();
+        wp_safe_redirect(add_query_arg(['endpoint-installed' => $result], wp_get_referer()));
         exit;
     }
 

.editorconfig

@@ -53,30 +53,46 @@ public function get_file_contents(): string
 EOT;
     }
 
-    public static function verify(): bool
+    /**
+     * @return string|bool
+     */
+    public static function verify()
     {
-        $works = self::verify_internal();
-        update_option('koko_analytics_use_custom_endpoint', $works, true);
-        return $works;
+        $verification_result = self::verify_internal();
+        update_option('koko_analytics_use_custom_endpoint', $verification_result === true, true);
+        return $verification_result;
     }
 
-    private static function verify_internal(): bool
+    /**
+     * @return string|bool
+     */
+    private static function verify_internal()
     {
         $tracker_url = site_url('/koko-analytics-collect.php?nv=1&p=0&up=1&test=1');
         $response    = wp_remote_get($tracker_url);
         if (is_wp_error($response)) {
-            return false;
+            return __('Error requesting endpoint: ', 'koko-analytics') . join(', ', $response->get_error_messages());
         }
 
         $status  = wp_remote_retrieve_response_code($response);
         $headers = wp_remote_retrieve_headers($response);
 
-        return $status == 200
+        // verify whether we get an expected response
+        if (
+            $status == 200
             && isset($headers['Content-Type'])
-            && str_contains($headers['Content-Type'], 'text/plain');
+            && str_contains($headers['Content-Type'], 'text/plain')
+        ) {
+            return true;
+        }
+
+        return __('Endpoint did not return the expected response', 'koko-analytics');
     }
 
-    public function install(): bool
+    /**
+     * @return string|bool
+     */
+    public function install()
     {
         /* If we made it this far we ideally want to use the custom endpoint file */
         /* Therefore we schedule a recurring health check event to periodically re-attempt and re-test */
@@ -90,21 +106,18 @@ public function install(): bool
         if (! is_file($file_name)) {
             $created = file_put_contents($file_name, $this->get_file_contents());
             if (! $created) {
-                return false;
+                return __('Error creating file', 'koko-analytics');
             }
         }
 
         /* Send an HTTP request to the custom endpoint to see if it's working properly */
-        $works = self::verify();
-        if (! $works) {
-            if (isset($created) && $created) {
-                unlink($file_name);
-            }
-            return false;
+        $verification_result = self::verify();
+        if ($verification_result !== true && isset($created) && $created) {
+            unlink($file_name);
         }
 
         /* All looks good! Custom endpoint file exists and returns the correct response */
-        return true;
+        return $verification_result;
     }
 
     public function is_eligibile(): bool

.github/workflows/build-test-lint.yml

@@ -66,6 +66,7 @@ private static function get_post_id(): int
 
     private static function get_tracker_url(): string
     {
+        // People can create their own endpoint and define it through this constant
         if (\defined('KOKO_ANALYTICS_CUSTOM_ENDPOINT') && KOKO_ANALYTICS_CUSTOM_ENDPOINT) {
             return site_url(KOKO_ANALYTICS_CUSTOM_ENDPOINT);
         }

.github/workflows/check-php-syntax.yml

@@ -146,7 +146,7 @@ function using_custom_endpoint(): bool
     }
 
     /** @see Endpoint_Installer::get_file_name() */
-    return \is_file(\rtrim(ABSPATH, '/') . '/koko-analytics-collect.php') && (bool) get_option('koko_analytics_use_custom_endpoint', false);
+    return \is_file(\rtrim(ABSPATH, '/') . '/koko-analytics-collect.php') && get_option('koko_analytics_use_custom_endpoint', 0);
 }
 
 function create_local_datetime(string $timestr): \DateTimeImmutable

.gitignore

@@ -27,10 +27,19 @@
             <?php } ?>
 
             <?php if (isset($_GET['endpoint-installed'])) { ?>
-                <div class="notice notice-<?php echo $_GET['endpoint-installed'] ? 'success' : 'warning'; ?> is-dismissible">
-                    <p><?php echo $_GET['endpoint-installed'] ? esc_html__('Successfully installed optimized endpoint.', 'koko-analytics') : esc_html__('Unable to install optimized endpoint. Please create the file manually and then try again.', 'koko-analytics'); ?></p>
+                <?php if ((int) $_GET['endpoint-installed']) { ?>
+                    <div class="notice notice-success is-dismissible">
+                        <p><?php esc_html_e('Successfully installed optimized endpoint.', 'koko-analytics'); ?></p>
+                    </div>
+                <?php } else { ?>
+                <div class="notice notice-warning is-dismissible">
+                    <p>
+                        <?php esc_html_e('Unable to install optimized endpoint: ', 'koko-analytics'); ?>
+                        <?php echo esc_html($_GET['endpoint-installed']); ?>
+                    </p>
                 </div>
-            <?php } ?>
+                <?php } ?>
+            <?php } // end if endpoint-installed ?>
 
             <?php if (class_exists('Jetpack')) { ?>
                 <div class="notice notice-info is-dismissible"><p><?php printf(__('We noticed you have Jetpack enabled. Do you want to <a href="%1$s">import your historical statistics data from JetPack stats into Koko Analytics</a>?', 'koko-analytics'), esc_attr(add_query_arg(['tab' => 'jetpack_importer']))); ?></p></div>