Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Development mode should be set to 'plugin' in the development environment #1423

Closed
westonruter opened this issue Jul 31, 2024 · 2 comments · Fixed by #1700
Closed

Development mode should be set to 'plugin' in the development environment #1423

westonruter opened this issue Jul 31, 2024 · 2 comments · Fixed by #1700
Labels
Infrastructure Issues for the overall performance plugin infrastructure Needs Dev Anything that requires development (e.g. a pull request) [Plugin] Optimization Detective Issues for the Optimization Detective plugin

Comments

@westonruter
Copy link
Member

westonruter commented Jul 31, 2024 •
edited
Loading

WordPress has a development mode introduced in WP 6.3 which can be set to core, theme, plugin, or all. Wouldn't it make sense if this were set to plugin in the development environment? Our plugins could behave differently when in plugin development mode. For example, Optimization Detective could by default do the equivalent of the following, a configuration that makes it easier to test during development:

// By default Optimization Detective doesn't optimize responses for admin users.
add_filter( 'od_can_optimize_response', '__return_true' );

// By default new URL metrics are only accepted for a given IP once every 60 seconds.
add_filter( 'od_url_metric_storage_lock_ttl', '__return_zero' );

// By default a URL metric is considered fresh for 1 day.
// Reducing this ensures new URL metrics will be collected.
add_filter( 'od_url_metric_freshness_ttl', '__return_zero' );

// By default 3 URL Metrics are collected for a given breakpoint viewport group.
// Reducing this to 1 means the groups can be considered complete with fewer page loads.
add_filter( 'od_url_metrics_breakpoint_sample_size', function () { return 1; } );

For example, the plugin could be patched as follows:

diff --git a/plugins/optimization-detective/optimization.php b/plugins/optimization-detective/optimization.php
index 442a7a62..eb7a9c3e 100644
--- a/plugins/optimization-detective/optimization.php
+++ b/plugins/optimization-detective/optimization.php
@@ -92,7 +92,7 @@ function od_can_optimize_response(): bool {
 		// interfere with the XPath indices. Note that od_get_normalized_query_vars() is varied by is_user_logged_in()
 		// so membership sites and e-commerce sites will still be able to be optimized for their normal visitors.
 		current_user_can( 'customize' )
-	);
+	) || wp_is_development_mode( 'plugin' );
 
 	/**
 	 * Filters whether the current response can be optimized.
diff --git a/plugins/optimization-detective/storage/class-od-storage-lock.php b/plugins/optimization-detective/storage/class-od-storage-lock.php
index 619a041e..40162a7e 100644
--- a/plugins/optimization-detective/storage/class-od-storage-lock.php
+++ b/plugins/optimization-detective/storage/class-od-storage-lock.php
@@ -43,7 +43,7 @@ final class OD_Storage_Lock {
 		 *
 		 * @param int $ttl TTL.
 		 */
-		$ttl = (int) apply_filters( 'od_url_metric_storage_lock_ttl', MINUTE_IN_SECONDS );
+		$ttl = (int) apply_filters( 'od_url_metric_storage_lock_ttl', wp_is_development_mode( 'plugin' ) ? 0 : MINUTE_IN_SECONDS );
 		return max( 0, $ttl );
 	}
 
diff --git a/plugins/optimization-detective/storage/data.php b/plugins/optimization-detective/storage/data.php
index c3395f96..4bf68b3f 100644
--- a/plugins/optimization-detective/storage/data.php
+++ b/plugins/optimization-detective/storage/data.php
@@ -31,7 +31,7 @@ function od_get_url_metric_freshness_ttl(): int {
 	 *
 	 * @param int $ttl Expiration TTL in seconds. Defaults to 1 day.
 	 */
-	$freshness_ttl = (int) apply_filters( 'od_url_metric_freshness_ttl', DAY_IN_SECONDS );
+	$freshness_ttl = (int) apply_filters( 'od_url_metric_freshness_ttl', wp_is_development_mode( 'plugin' ) ? 0 : DAY_IN_SECONDS );
 
 	if ( $freshness_ttl < 0 ) {
 		_doing_it_wrong(
@westonruter westonruter added Infrastructure Issues for the overall performance plugin infrastructure [Plugin] Optimization Detective Issues for the Optimization Detective plugin Needs Dev Anything that requires development (e.g. a pull request) labels Jul 31, 2024
@westonruter westonruter mentioned this issue Jul 31, 2024
Closed
@github-project-automation github-project-automation bot moved this to Not Started/Backlog 📆 in WP Performance 2025 Oct 23, 2024
@ShyamGadde
Copy link
Contributor

Wouldn't it make more sense to integrate the wp_is_development_mode( 'plugin' ) check directly into the $able conditions? Instead of overriding the exclusions entirely in plugin development mode, we could preserve them while selectively enabling optimization for admin users.

For example, we could adjust the current_user_can( 'customize' ) condition like this:

( current_user_can( 'customize' ) && ! wp_is_development_mode( 'plugin' ) )

This ensures optimization remains disabled for scenarios like is_search and is_embed, allows admin users to test optimization in plugin development mode, and avoids globally overriding exclusions.

@westonruter
Copy link
Member Author

That makes sense to me.

@ShyamGadde ShyamGadde mentioned this issue Nov 25, 2024
Merged
@westonruter westonruter moved this from Not Started/Backlog 📆 to Code Review 👀 in WP Performance 2025 Nov 26, 2024
@github-project-automation github-project-automation bot moved this from Code Review 👀 to Done 😃 in WP Performance 2025 Nov 26, 2024
@westonruter westonruter mentioned this issue Jan 12, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Infrastructure Issues for the overall performance plugin infrastructure Needs Dev Anything that requires development (e.g. a pull request) [Plugin] Optimization Detective Issues for the Optimization Detective plugin
Projects
WP Performance 2025
Status: Done 😃
Milestone
No milestone
2 participants
@westonruter @ShyamGadde