Update with improvements

Author: chriszarate

readme.md

@@ -4,8 +4,7 @@ Persisted GraphQL queries allow a GraphQL client to optimistically send a hash
 of the query instead of the full query; if the server has seen the query
 before, it can satisfy the request. This saves network overhead and makes it
 possible to move to `GET` requests instead of `POST`. The primary benefit of
-`GET` requests is that they can be easily cached at the edge (e.g., with
-Varnish).
+`GET` requests is that they can be cached at the edge (e.g., with Varnish).
 
 This plugin requires [WPGraphQL][wp-graphql] 0.2.0 or newer.
 
@@ -17,16 +16,24 @@ https://github.com/apollographql/apollo-link-persisted-queries#automatic-persist
 
 This plugin aims to be compatible with that implementation, but will work with
 any client that sends a `queryId` alongside the `query`. Make sure your client
-also sends `operationName` with the optimistic request.
+also sends `operationName` or `operation_name` with the optimistic request.
 
 ## Implementation
 
 When the client provides a query hash or ID, that query will be persisted in a
-custom post type. By default, this post type will be visible in the dashboard
-only to admins.
+custom post type. By default, this post type will not be visible in the
+dashboard.
 
 Query IDs are case-insensitive (i.e., `MyQuery` and `myquery` are equivalent).
 
+## Caching
+
+This plugin does nothing to implement, amend, or purge page (edge) caching. It
+is up to you to make page caching work for you. Remember that WPGraphQL has a
+single monolithic endpoint at `/graphql` and persisted query requests will
+arrive as `GET` requests to that endpoint with unique query strings. Cache
+wisely!
+
 ## Filters
 
 ### `graphql_persisted_queries_post_type`
@@ -35,11 +42,10 @@ Query IDs are case-insensitive (i.e., `MyQuery` and `myquery` are equivalent).
 - The custom post type used to persist queries. If empty, queries will not be
  persisted.
 
-### `graphql_persisted_queries_show_in_graphql`
+### `graphql_persisted_queries_post_type_args`
 
-- Default: `false`
-- Whether the custom post type will itself be exposed via GraphQL. Enabling
- allows insight into which queries are persisted.
+- Args passed to register_post_type for custom post type. Filter to expose the
+ custom post type in the admin UI or in GraphQL:
 
  ```
  query PersistedQueryQuery {
@@ -53,7 +59,13 @@ Query IDs are case-insensitive (i.e., `MyQuery` and `myquery` are equivalent).
  }
  ```
 
-If you'd like to further customize the custom post type, filter
-`register_post_type_args`.
+### `graphql_persisted_queries_load_query`
+
+- Default: `null`
+- Override the default query loading implementation.
+
+### `graphql_persisted_queries_save_query`
+
+- Override the query (post data) that will be persisted.
 
 [wp-graphql]: https://github.com/wp-graphql/wp-graphql

src/loader.php

@@ -85,13 +85,42 @@ public function get_http_status_code( $status_code, $response ) {
 return $status_code;
 }
 
+/**
+ * Be a little flexible in how operation name is sent.
+ *
+ * @param array $request_data Request data.
+ * @return string
+ */
+private function get_operation_name( $request_data ) {
+foreach( [ 'operationName', 'operation_name' ] as $key ) {
+if ( ! empty( $request_data[ $key ] ) ) {
+return $request_data[ $key ];
+}
+}
+
+return 'UnnamedQuery';
+}
+
 /**
  * Attempts to load a persisted query corresponding to a query ID (hash).
  *
  * @param string $query_id Query ID
  * @return string Query
  */
-public function load( $query_id ) {
+private function load( $query_id ) {
+/**
+ * Allow other implementors to load queries.
+ *
+ * @param string $query Persisted query.
+ * @param string $query_id Query ID.
+ * @since 1.1.0
+ */
+$query = apply_filters( "{$this->namespace}_load_query", null, $query_id );
+if ( $query ) {
+return $query;
+}
+
+// If query has been persisted to our custom post type, return it.
 $post = get_page_by_path( $query_id, 'OBJECT', $this->post_type );
 
 return isset( $post->post_content ) ? $post->post_content : null;
@@ -116,7 +145,7 @@ public function process_request_data( $request_data ) {
 
 // Client sends *both* queryId and query == request to persist query.
 if ( $has_query_id && $has_query ) {
-$this->save( $query_id, $request_data['query'], $request_data['operationName'] );
+$this->save( $query_id, $request_data['query'], $this->get_operation_name( $request_data ) );
 }
 
 // Client sends queryId but *not* query == optimistic request to use
@@ -137,36 +166,34 @@ public function process_request_data( $request_data ) {
 }
 
 /**
- * Register the persisted query post type. We could filter a lot of individual
- * values here, but we won't. If further customization is wanted, filter
- * register_post_type_args.
+ * Register the persisted query post type.
  *
  * @return void
  */
 private function register_post_type() {
+$post_type_args = [
+'label' => 'Queries',
+'public' => false,
+'query_var' => false,
+'rewrite' => false,
+'show_in_rest' => false,
+'show_in_graphql' => false,
+'graphql_single_name' => 'persistedQuery',
+'graphql_plural_name' => 'persistedQueries',
+'show_ui' => false,
+'supports' => [ 'title', 'editor' ],
+];
+
 /**
- * Whether persisted queries can be themselves queried via GraphQL. 💅
+ * Post type args for persisted queries. Filter this to expose the post type
+ * in the UI or in GraphQL.
  *
- * @param bool $show_in_graphql Show in GraphQL?
- * @since 1.0.0
+ * @param bool $post_type_args Register post type args.
+ * @since 1.1.0
  */
-$show_in_graphql = apply_filters( "{$this->namespace}_show_in_graphql", false );
-
-register_post_type(
-$this->post_type,
-[
-'label' => 'Queries',
-'public' => false,
-'query_var' => false,
-'rewrite' => false,
-'show_in_rest' => false,
-'show_in_graphql' => $show_in_graphql,
-'graphql_single_name' => 'persistedQuery',
-'graphql_plural_name' => 'persistedQueries',
-'show_ui' => is_admin(),
-'supports' => [ 'title', 'editor' ],
-]
-);
+$post_type_args = apply_filters( "{$this->namespace}_post_type_args", $post_type_args );
+
+register_post_type( $this->post_type, $post_type_args );
 }
 
 /**
@@ -177,19 +204,34 @@ private function register_post_type() {
  * @param string $name Operation name
  * @return void
  */
-public function save( $query_id, $query, $name = 'UnnamedQuery' ) {
+private function save( $query_id, $query, $name = 'UnnamedQuery' ) {
 // Check to see if the query has already been persisted. If so, we're done.
 if ( ! empty( $this->load( $query_id ) ) ) {
 return;
 }
 
-// Persist the query.
-wp_insert_post( [
+$post_data = [
 'post_content' => $query,
 'post_name' => $query_id,
 'post_title' => $name,
 'post_status' => 'publish',
 'post_type' => $this->post_type,
-] );
+];
+
+/**
+ * Allow implementors to override persisted query.
+ *
+ * @param bool $post_data Post data for persisted query.
+ * @param string $query_id Query ID.
+ * @since 1.1.0
+ */
+$post_data = apply_filters( "{$this->namespace}_save_query", $post_data, $query_id );
+
+if ( empty( $post_data ) ) {
+return;
+}
+
+// Persist the query.
+wp_insert_post( $post_data );
 }
 }

wp-graphql-persisted-queries.php

@@ -4,7 +4,7 @@
  * Plugin URI: https://github.com/Quartz/wp-graphql-persisted-queries
  * Description: Provides persistence to GraphQL queries allowing them to be queried by ID or hash. Requires WPGraphQL 0.2.0 or newer.
  * Author: Chris Zarate, Quartz
- * Version: 1.0.0
+ * Version: 1.1.0
  * Author URI: https://qz.com/
  *
  * @package wp-graphql-persisted-queries
@@ -14,4 +14,5 @@
 
 require_once( __DIR__ . '/src/loader.php' );
 
-add_action( 'graphql_init', array( new Loader(), 'init' ), 10, 0 );
+// Higher priority allows other code at default priority to run first.
+add_action( 'graphql_init', array( new Loader(), 'init' ), 20, 0 );