Labs: GitHub-177: Add functionality to define constant to enable nginx logging

.github/ci/main.sh

@@ -26,7 +26,7 @@ function start_services() {
 # Create, setup and populate learn.rtcamp.com base site with data
 function create_and_configure_site () {
 
-    ee site create $SITE_NAME --wp --php74 
+    ee site create $SITE_NAME --wp --php74
     cd $SITE_ROOT/wp-content/plugins/
     rm -rf nginx-helper
     ls
@@ -36,7 +36,6 @@ function create_and_configure_site () {
     ls
     wp plugin activate nginx-helper --allow-root
     wp user create automation [email protected] --role=administrator --user_pass=automation --allow-root
-    wp theme activate twentytwentyone --allow-root
 }
 
 
@@ -96,4 +95,4 @@ function main() {
     run_playwright_tests
 }
 
-main
+main

admin/class-nginx-helper-admin.php

@@ -53,7 +53,7 @@ class Nginx_Helper_Admin {
 	 *
 	 * @since    2.0.0
 	 * @access   public
-	 * @var      string    $options    Purge options.
+	 * @var      string[]    $options    Purge options.
 	 */
 	public $options;
 
@@ -345,6 +345,27 @@ public function nginx_helper_settings_link( $links ) {
 
 	}
 
+	/**
+	 * Check if the nginx log is enabled.
+	 *
+	 * @since 2.2.4
+	 * @return    boolean
+	 */
+	public function is_nginx_log_enabled() {
+
+		$options = get_site_option( 'rt_wp_nginx_helper_options', array() );
+
+		if ( ! empty( $options['enable_log'] ) && 1 === (int) $options['enable_log'] ) {
+			return true;
+		}
+
+		if ( defined( 'NGINX_HELPER_LOG' ) && true === NGINX_HELPER_LOG ) {
+			return true;
+		}
+
+		return false;
+	}
+
 	/**
 	 * Retrieve the asset path.
 	 *
@@ -732,10 +753,10 @@ public function purge_all() {
 		}
 
 		if ( 'purge' === $action ) {
-	
+
 			/**
 			 * Fire an action after the entire cache has been purged whatever caching type is used.
-			 * 
+			 *
 			 * @since 2.2.2
 			 */
 			do_action( 'rt_nginx_helper_after_purge_all' );

admin/class-purger.php

@@ -529,7 +529,7 @@ public function log( $msg, $level = 'INFO' ) {
 
 		global $nginx_helper_admin;
 
-		if ( ! $nginx_helper_admin->options['enable_log'] ) {
+		if ( ! $nginx_helper_admin->is_nginx_log_enabled() ) {
 			return;
 		}
 
@@ -562,7 +562,7 @@ public function check_and_truncate_log_file() {
 
 		global $nginx_helper_admin;
 
-		if ( ! $nginx_helper_admin->options['enable_log'] ) {
+		if ( ! $nginx_helper_admin->is_nginx_log_enabled() ) {
 			return;
 		}
 

admin/css/nginx-helper-admin.css

@@ -98,3 +98,4 @@ form#purgeall .button-primary:focus {
 }
 
 .rt-purge_url { width: 100%; }
+

admin/partials/nginx-helper-general-options.php

@@ -539,10 +539,29 @@
 				<?php } ?>
 					<tr valign="top">
 						<td>
-							<input type="checkbox" value="1" id="enable_log" name="enable_log"<?php checked( $nginx_helper_settings['enable_log'], 1 ); ?> />
+							<?php
+							$is_checkbox_enabled = false;
+							if ( 1 === (int) $nginx_helper_settings['enable_log'] ) {
+								$is_checkbox_enabled = true;
+							}
+							?>
+							<input
+								type="checkbox" value="1" id="enable_log" name="enable_log"
+								<?php checked( $nginx_helper_admin->is_nginx_log_enabled(), true ); ?>
+								<?php echo esc_attr( $is_checkbox_enabled ? '' : ' disabled ' ); ?>
+							/>
 							<label for="enable_log">
 								<?php esc_html_e( 'Enable Logging', 'nginx-helper' ); ?>
 							</label>
+							<?php
+							if ( ! $nginx_helper_admin->is_nginx_log_enabled() ) {
+								printf(
+									'<pre>[<b>NOTE:</b> %1$s<br /><b>define( \'NGINX_HELPER_LOG\', true )</b> %2$s <b>wp-config.php</b>]</pre>',
+									esc_html__( 'To activate the logging feature, you must define the constant', 'nginx-helper' ),
+									esc_html__( 'in your', 'nginx-helper' )
+								);
+							}
+							?>
 						</td>
 					</tr>
 					<tr valign="top">
@@ -626,7 +645,7 @@
 		<?php
 	}
 	?>
-	<div class="postbox enable_log"<?php echo ( empty( $nginx_helper_settings['enable_log'] ) ) ? ' style="display: none;"' : ''; ?>>
+	<div class="postbox enable_log"<?php echo ( ! $nginx_helper_admin->is_nginx_log_enabled() ) ? ' style="display: none;"' : ''; ?>>
 		<h3 class="hndle">
 			<span><?php esc_html_e( 'Logging Options', 'nginx-helper' ); ?></span>
 		</h3>

tests/e2e-playwright/specs/04_enable-debug-option-test.spec.js

@@ -16,18 +16,15 @@ test.describe("Enable the debug option", () => {
 
     expect(page.locator(".rt_option_title")).toHaveText("Nginx Settings");
 
-    if (await page.locator("#enable_log").uncheck) {
-      await page.click("#enable_log");
-    }
-    if (await page.locator("#enable_stamp").uncheck) {
-      await page.click("#enable_stamp");
-    }
-
-    await page.click("#smart_http_expire_save");
-
-    await page.waitForTimeout(1000);
-    expect(page.locator("div[class='updated'] p")).toHaveText(
-      "Settings saved."
+    // Assert that the checkbox is disabled
+    await expect(page.locator("input#enable_log")).toBeDisabled();
+
+    expect(
+      page.locator(
+        "#post_form > div:nth-child(5) > div > table > tbody > tr:nth-child(1) > td > pre"
+      )
+    ).toHaveText(
+      "[NOTE: To activate the logging feature, you must define the constantdefine( 'NGINX_HELPER_LOG', true ) in your wp-config.php]"
     );
   });