Merge pull request #3149 from wp-graphql/release/v1.27.0

jasonbahl · web-flow · commit f8847933d755 · 2024-06-05T14:39:08.000-06:00
release: v1.27.0
diff --git a/.distignore b/.distignore
@@ -43,6 +43,7 @@ phpstan.neon.dist
 phpunit.xml.dist
 README.md
 schema.graphql
-
-
-
+webpack.config.js
+phpcs.xml.dist
+.wp-env.json
+.codeclimate.yml
diff --git a/.gitattributes b/.gitattributes
diff --git a/.wp-env.json b/.wp-env.json
@@ -1,6 +1,9 @@
 {
   "core": "WordPress/WordPress",
-  "plugins": [ "." ],
+  "plugins": [
+    "./tests/e2e/plugins/settings-page-spec/",
+    "."
+  ],
   "themes": [],
   "port": 8888,
   "config": {
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,21 @@
 # Changelog
 
-= 1.26.0 =
+## 1.27.0 =
 
-## New Features
+### New Features
+
+- [#3143](https://github.com/wp-graphql/wp-graphql/pull/3143): feat: Enhance tab state management with query arguments and localStorage fallback
+
+### Chores / Bugfixes
+
+- [#3139](https://github.com/wp-graphql/wp-graphql/pull/3139): fix: `$settings_fields` param on "graphql_get_setting_section_field_value" filter not passing the correct type
+- [#3137](https://github.com/wp-graphql/wp-graphql/pull/3137): fix: WPGraphQL Settings page fails to load when "graphiql_enabled" setting is "off"
+- [#3133](https://github.com/wp-graphql/wp-graphql/pull/3133): build: clean up dist
+- [#3146](https://github.com/wp-graphql/wp-graphql/pull/3146): test: add e2e test coverage for tabs in the settings page
+
+## 1.26.0 =
+
+### New Features
 
 - [#3125](https://github.com/wp-graphql/wp-graphql/pull/3125): refactor: improve query handling in AbstractConnectionResolver
     - new: `graphql_connection_pre_get_query` filter
diff --git a/access-functions.php b/access-functions.php
@@ -813,21 +813,24 @@ static function ( \WPGraphQL\Admin\Settings\SettingsRegistry $registry ) use ( $
  * @since 0.13.0
  */
 function get_graphql_setting( string $option_name, $default_value = '', $section_name = 'graphql_general_settings' ) {
-	$section_fields = get_option( $section_name );
+	$section_fields = get_option( $section_name, [] );
 
 	/**
 	 * Filter the section fields
-
+	 *
 	 * @param array<string,mixed> $section_fields The values of the fields stored for the section
 	 * @param string              $section_name   The name of the section
 	 * @param mixed               $default_value  The default value for the option being retrieved
 	 */
 	$section_fields = apply_filters( 'graphql_get_setting_section_fields', $section_fields, $section_name, $default_value );
 
+	// ensure the filtered sections fields are an array before proceeding
+	$section_fields = is_array( $section_fields ) ? $section_fields : [];
+
 	/**
 	 * Get the value from the stored data, or return the default
 	 */
-	$value = isset( $section_fields[ $option_name ] ) ? $section_fields[ $option_name ] : $default_value;
+	$value = $section_fields[ $option_name ] ?? $default_value;
 
 	/**
 	 * Filter the value before returning it
diff --git a/constants.php b/constants.php
@@ -18,7 +18,7 @@ function graphql_setup_constants() {
 
 	// Plugin version.
 	if ( ! defined( 'WPGRAPHQL_VERSION' ) ) {
-		define( 'WPGRAPHQL_VERSION', '1.26.0' );
+		define( 'WPGRAPHQL_VERSION', '1.27.0' );
 	}
 
 	// Plugin Folder Path.
diff --git a/readme.txt b/readme.txt
@@ -4,7 +4,7 @@ Tags: GraphQL, JSON, API, Gatsby, Faust, Headless, Decoupled, Svelte, React, Nex
 Requires at least: 5.0
 Tested up to: 6.5
 Requires PHP: 7.1
-Stable tag: 1.26.0
+Stable tag: 1.27.0
 License: GPL-3
 License URI: https://www.gnu.org/licenses/gpl-3.0.html
 
@@ -270,6 +270,19 @@ Composer dependencies are no longer versioned in Github. Recommended install sou
 
 == Changelog ==
 
+= 1.27.0 =
+
+**New Features**
+
+- [#3143](https://github.com/wp-graphql/wp-graphql/pull/3143): feat: Enhance tab state management with query arguments and localStorage fallback
+
+**Chores / Bugfixes**
+
+- [#3139](https://github.com/wp-graphql/wp-graphql/pull/3139): fix: `$settings_fields` param on "graphql_get_setting_section_field_value" filter not passing the correct type
+- [#3137](https://github.com/wp-graphql/wp-graphql/pull/3137): fix: WPGraphQL Settings page fails to load when "graphiql_enabled" setting is "off"
+- [#3133](https://github.com/wp-graphql/wp-graphql/pull/3133): build: clean up dist
+- [#3146](https://github.com/wp-graphql/wp-graphql/pull/3146): test: add e2e test coverage for tabs in the settings page
+
 = 1.26.0 =
 
 **New Features**
diff --git a/src/Admin/GraphiQL/GraphiQL.php b/src/Admin/GraphiQL/GraphiQL.php
@@ -58,7 +58,16 @@ public function init() {
 	 * @return void
 	 */
 	public function register_admin_bar_menu( WP_Admin_Bar $admin_bar ) {
-		if ( ! current_user_can( 'manage_options' ) || 'off' === get_graphql_setting( 'show_graphiql_link_in_admin_bar' ) ) {
+
+		if ( 'off' === get_graphql_setting( 'graphiql_enabled' ) ) {
+			return;
+		}
+
+		if ( ! current_user_can( 'manage_options' ) ) {
+			return;
+		}
+
+		if ( 'off' === get_graphql_setting( 'show_graphiql_link_in_admin_bar' ) ) {
 			return;
 		}
 
diff --git a/src/Admin/Settings/SettingsRegistry.php b/src/Admin/Settings/SettingsRegistry.php
@@ -57,7 +57,9 @@ public function get_settings_fields() {
 	 * @return void
 	 */
 	public function admin_enqueue_scripts( string $hook_suffix ) {
-		if ( 'graphql_page_graphql-settings' !== $hook_suffix ) {
+
+		// if the page is not the GraphQL Settings page, bail
+		if ( 'graphql_page_graphql-settings' !== $hook_suffix && 'toplevel_page_graphql-settings' !== $hook_suffix ) {
 			return;
 		}
 
@@ -677,37 +679,37 @@ public function show_forms() {
 	/**
 	 * Tabbable JavaScript codes & Initiate Color Picker
 	 *
-	 * This code uses localstorage for displaying active tabs
+	 * This code uses URL hash fragments and localStorage for displaying active tabs
 	 *
 	 * @return void
 	 */
 	public function script() {
 		?>
 		<script>
 			jQuery(document).ready(function ($) {
-				//Initiate Color Picker
+				// Initiate Color Picker
 				$('.wp-color-picker-field').wpColorPicker();
 
 				// Switches option sections
 				$('.group').hide();
 				var activetab = '';
-				if (typeof (localStorage) != 'undefined') {
-					activetab = localStorage.getItem("activetab");
-				}
+				var urlHash = window.location.hash;
 
-				//if url has section id as hash then set it as active or override the current local storage value
-				if (window.location.hash) {
-					activetab = window.location.hash;
+				if (urlHash) {
+					activetab = urlHash;
 					if (typeof (localStorage) != 'undefined') {
 						localStorage.setItem("activetab", activetab);
 					}
+				} else if (typeof (localStorage) != 'undefined') {
+					activetab = localStorage.getItem("activetab");
 				}
 
 				if (activetab != '' && $(activetab).length) {
 					$(activetab).fadeIn();
 				} else {
 					$('.group:first').fadeIn();
 				}
+
 				$('.group .collapsed').each(function () {
 					$(this).find('input:checked').parent().parent().parent().nextAll().each(
 						function () {
@@ -724,13 +726,15 @@ function () {
 				} else {
 					$('.nav-tab-wrapper a:first').addClass('nav-tab-active');
 				}
+
 				$('.nav-tab-wrapper a').click(function (evt) {
 					$('.nav-tab-wrapper a').removeClass('nav-tab-active');
 					$(this).addClass('nav-tab-active').blur();
 					var clicked_group = $(this).attr('href');
 					if (typeof (localStorage) != 'undefined') {
-						localStorage.setItem("activetab", $(this).attr('href'));
+						localStorage.setItem("activetab", clicked_group);
 					}
+					history.replaceState(null, '', clicked_group);
 					$('.group').hide();
 					$(clicked_group).fadeIn();
 					evt.preventDefault();
diff --git a/src/WPGraphQL.php b/src/WPGraphQL.php
@@ -335,6 +335,24 @@ static function ( $interfaces, $config, $type ) {
 			10,
 			3
 		);
+
+		/**
+		 * Prevent WPML from redirecting within WPGraphQL requests
+		 *
+		 * @see https://github.com/wp-graphql/wp-graphql/issues/1626#issue-769089073
+		 * @since @todo
+		 */
+		add_filter(
+			'wpml_is_redirected',
+			static function ( bool $is_redirect ) {
+				if ( is_graphql_request() ) {
+					return false;
+				}
+				return $is_redirect;
+			},
+			10,
+			1
+		);
 	}
 
 	/**
diff --git a/tests/e2e/plugins/README.md b/tests/e2e/plugins/README.md
@@ -0,0 +1,3 @@
+# WordPress Plugins
+
+These are custom WordPress plugins specifically designed for end-to-end (e2e) testing of the WPGraphQL plugin. They are not intended for production use but serve to facilitate testing by adding mock functionalities and settings.
diff --git a/tests/e2e/plugins/settings-page-spec/settings-page-spec.php b/tests/e2e/plugins/settings-page-spec/settings-page-spec.php
@@ -0,0 +1,47 @@
+<?php
+/**
+ * Plugin Name: Settings Page Spec
+ * Description: This plugin is specifically used for end-to-end (e2e) testing of the WPGraphQL plugin. It registers settings sections and fields for testing purposes.
+ */
+
+// Register settings sections and fields for testing.
+add_action(
+	'graphql_register_settings',
+	function() {
+		register_graphql_settings_section(
+			'graphql_section_a_settings',
+			array(
+				'title' => __( 'Section A Settings', 'settings-page-spec' ),
+				'desc'  => __( 'Settings for section A', 'settings-page-spec' ),
+			)
+		);
+
+		register_graphql_settings_field(
+			'graphql_section_a_settings',
+			array(
+				'name'  => 'graphql_section_a_checkbox',
+				'label' => __( 'Section A Checkbox Option', 'settings-page-spec' ),
+				'desc'  => __( 'This is a checkbox option for section A', 'settings-page-spec' ),
+				'type'  => 'checkbox',
+			)
+		);
+
+		register_graphql_settings_section(
+			'graphql_section_b_settings',
+			array(
+				'title' => __( 'Section B Settings', 'settings-page-spec' ),
+				'desc'  => __( 'Settings for section B', 'settings-page-spec' ),
+			)
+		);
+
+		register_graphql_settings_field(
+			'graphql_section_b_settings',
+			array(
+				'name'  => 'graphql_section_b_checkbox',
+				'label' => __( 'Section B Checkbox Option', 'settings-page-spec' ),
+				'desc'  => __( 'This is a checkbox option for section B', 'settings-page-spec' ),
+				'type'  => 'checkbox',
+			)
+		);
+	}
+);
diff --git a/tests/e2e/specs/settings-page.spec.js b/tests/e2e/specs/settings-page.spec.js
diff --git a/tests/e2e/utils.js b/tests/e2e/utils.js
diff --git a/wp-graphql.php b/wp-graphql.php

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ function graphql_setup_constants() {`
`18`	`18`
`19`	`19`	`// Plugin version.`
`20`	`20`	`if ( ! defined( 'WPGRAPHQL_VERSION' ) ) {`
`21`		`- define( 'WPGRAPHQL_VERSION', '1.26.0' );`
	`21`	`+ define( 'WPGRAPHQL_VERSION', '1.27.0' );`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`// Plugin Folder Path.`