Added field to exclude queries rather than multiple rules.

Author: colinmurphy

plugins/wpgraphql-logging/src/Admin/Settings/Fields/Tab/Basic_Configuration_Tab.php

@@ -53,11 +53,11 @@ class Basic_Configuration_Tab implements Settings_Tab_Interface {
 	public const EVENT_LOG_SELECTION = 'event_log_selection';
 
 	/**
-	 * The field ID for the seed query exclusion for Faust.js.
+	 * The field ID for the exclude query text input.
 	 *
 	 * @var string
 	 */
-	public const SEED_QUERY = 'seed_query';
+	public const EXCLUDE_QUERY = 'exclude_query';
 
 	/**
 	 * The field ID for whether to log the response from the WPGGraphQL query into the context object.
@@ -107,6 +107,15 @@ public function get_fields(): array {
 			__( 'e.g., 192.168.1.1, 10.0.0.1', 'wpgraphql-logging' )
 		);
 
+		$fields[ self::EXCLUDE_QUERY ] = new Text_Input_Field(
+			self::EXCLUDE_QUERY,
+			$this->get_name(),
+			__( 'Exclude Query', 'wpgraphql-logging' ),
+			'',
+			__( 'Comma-separated list of GraphQL query names to exclude from logging.', 'wpgraphql-logging' ),
+			__( 'e.g., __schema,SeedNode,__typename', 'wpgraphql-logging' )
+		);
+
 		$fields[ self::ADMIN_USER_LOGGING ] = new Checkbox_Field(
 			self::ADMIN_USER_LOGGING,
 			$this->get_name(),
@@ -148,15 +157,6 @@ public function get_fields(): array {
 			true
 		);
 
-
-		$fields[ self::SEED_QUERY ] = new Checkbox_Field(
-			self::SEED_QUERY,
-			$this->get_name(),
-			__( 'Log Seed Query', 'wpgraphql-logging' ),
-			'',
-			__( 'Whether or not to log the Faust.js seed query.', 'wpgraphql-logging' ),
-		);
-
 		$fields[ self::LOG_RESPONSE ] = new Checkbox_Field(
 			self::LOG_RESPONSE,
 			$this->get_name(),

plugins/wpgraphql-logging/src/Logger/LoggingHelper.php

@@ -6,13 +6,12 @@
 
 use WPGraphQL\Logging\Logger\Rules\AdminUserRule;
 use WPGraphQL\Logging\Logger\Rules\EnabledRule;
-use WPGraphQL\Logging\Logger\Rules\IntrospectionQueryRule;
+use WPGraphQL\Logging\Logger\Rules\ExcludeQueryRule;
 use WPGraphQL\Logging\Logger\Rules\IpRestrictionsRule;
 use WPGraphQL\Logging\Logger\Rules\LogResponseRule;
 use WPGraphQL\Logging\Logger\Rules\QueryNullRule;
 use WPGraphQL\Logging\Logger\Rules\RuleManager;
 use WPGraphQL\Logging\Logger\Rules\SamplingRateRule;
-use WPGraphQL\Logging\Logger\Rules\SeedQueryRule;
 
 /**
  * Trait for shared logging helper methods.
@@ -54,8 +53,7 @@ protected function get_rule_manager(): RuleManager {
 		$this->rule_manager->add_rule( new EnabledRule() );
 		$this->rule_manager->add_rule( new AdminUserRule() );
 		$this->rule_manager->add_rule( new IpRestrictionsRule() );
-		$this->rule_manager->add_rule( new IntrospectionQueryRule() );
-		$this->rule_manager->add_rule( new SeedQueryRule() );
+		$this->rule_manager->add_rule( new ExcludeQueryRule() );
 		apply_filters( 'wpgraphql_logging_rule_manager', $this->rule_manager );
 		return $this->rule_manager;
 	}

plugins/wpgraphql-logging/src/Logger/Rules/SeedQueryRule.php renamed to plugins/wpgraphql-logging/src/Logger/Rules/ExcludeQueryRule.php

@@ -7,15 +7,13 @@
 use WPGraphQL\Logging\Admin\Settings\Fields\Tab\Basic_Configuration_Tab;
 
 /**
- * Rule to check if the query is a Faust.js Seed Query.
+ * Rule to check if the query is excluded from logging.
  *
  * @package WPGraphQL\Logging
  *
- * @link https://github.com/wpengine/faustjs/blob/8e8797b1758d34d489236266e08f0657c015ff9f/packages/faustwp-core/src/queries/seedQuery.ts
- *
  * @since 0.0.1
  */
-class SeedQueryRule implements LoggingRuleInterface {
+class ExcludeQueryRule implements LoggingRuleInterface {
 	/**
 	 * Check if the rule passes.
 	 *
@@ -25,22 +23,25 @@ class SeedQueryRule implements LoggingRuleInterface {
 	 * @return bool True if the rule passes (logging should continue).
 	 */
 	public function passes(array $config, ?string $query_string = null): bool {
-
+		$queries = $config[ Basic_Configuration_Tab::EXCLUDE_QUERY ] ?? '';
 		if ( null === $query_string ) {
 			return true;
 		}
 
-		$allow_query = (bool) $config[ Basic_Configuration_Tab::SEED_QUERY ];
-		if ( ! $allow_query ) {
-			return true;
+		$excluded_queries = array_map( 'trim', explode( ',', $queries ) );
+		foreach ( $excluded_queries as $excluded_query ) {
+			if ( stripos( $query_string, $excluded_query ) !== false ) {
+				return false;
+			}
 		}
-		return stripos( $query_string, 'SeedNode' ) === false;
+
+		return true;
 	}
 
 	/**
 	 * Get the rule name for debugging.
 	 */
 	public function get_name(): string {
-		return 'faustjs_seed_query_rule';
+		return 'exclude_query_rule';
 	}
 }