Fix #135. Add Explicit options for adding ACF Field Groups to the Schema #229

rsm0128 · 2021-03-15T02:56:41Z

This PR focuses on fixing the experience of mapping ACF Field Groups to the WPGraphQL Schema.

This video walks through the update:

https://youtu.be/VvrZGrcwv0Y

closes #135

…to the Schema

…lowed WP convention for new code

rsm0128 · 2021-03-15T03:04:05Z

@jasonbahl
I added a unit test for the explicit options as we discussed

supriome · 2021-03-19T16:49:23Z

When I active this plugin which download from your github repo, I got this warning? Is there some problem? @rsm0128

Warning: require(/Users/suprio/react/gatsby-wordpress/src/wp-content/plugins/wp-graphql-acf-bugfix-135/vendor/composer/platform_check.php): failed to open stream: No such file or directory in /Users/suprio/react/gatsby-wordpress/src/wp-content/plugins/wp-graphql-acf-bugfix-135/vendor/composer/autoload_real.php on line 25

rsm0128 · 2021-03-19T16:55:18Z

@supriome You need to run composer install.

jasonbahl · 2021-03-19T17:24:17Z

@rsm0128 For the "GraphQL Types to show the field group on" option, I think we also need to consider interfaces.

Specifically the ContentNode and TermNode interfaces.

For example, if I want a field group, maybe something like SEO Fields, to be available on all Post Types, I could apply the field group to a the ContentNode interface and would be able to query like so:

{
  contentNodes {
    nodes {
      __typename
      id
      acfFieldGroup {
        textField
        textAreaField
      }
    }
  }
}

If I were to chose an Interface, possibly the Types that implement that interface would become checked and disabled in the checkboxes:

jasonbahl · 2021-03-19T17:29:38Z

src/class-config.php

-					'taxonomy' => $taxonomy,
-				]
-			);
+			$key_prefix = 'post_type__';


Is there a specific reason you prefixed these values?

I think it makes more sense to used the Type name from the schema directly.

[ 'graphql_types_on' => [ 'Post', 'Page', 'Tag', 'Category', 'User', 'Comment', ], ]

etc

Users can create custom post type or custom taxonomy with the reserved names. For example, users can't use "User" custom post type if we don't use prefix.

Types are unique in the GraphQL Schema. You cannot create a User Post Type without giving it a unique GraphQL name.

For example, if I add the following code to register a post type with the user GraphQL type, it won't work and there will be a debug message output:

add_action( 'init', function() { register_post_type( 'user', [ 'show_in_graphql' => true, 'graphql_single_name' => 'user', 'graphql_plural_name' => 'users', ] ); } );

OK. I'll remove the prefixes. Thanks for your detailed explanation!

Any progress? Can this fix be merged into the master branch yet?

Should be able to group by Interface, I imagine? 🤔

I'll think on it a bit too

Also grouping in the UI doesn't have to be defined by the values passed to the field group definition.

For registering ACF field groups via Code, it would be cleaner for to pass the GraphQL Types directly without having to know about extra prefixes.

I used input[value^="post_type__"] and input[value^="taxonomy__"] selector to select all the post types and taxonomies, but if we don't use prefix, it's a bit hard to select.

@rsm0128 👋

I pushed a commit with some re-factoring to the checkboxes.

This removes the need for prefixing with post_type__ and taxonomy__ and uses the GraphQL Type names directly.

I adjusted the markup to be re-usable for many interfaces, and the jQuery to also be re-usable.

Right now we have the 2 interfaces (ContentNode and TermNode), but we'll have at least one more, the ContentTemplate Interface, so that ACF field groups can be assigned to Templates in the Schema as well.

@rsm0128 I pushed one more commit with the ContentTemplate interface added.

Now it works like so (you can see the ContentTemplate interface included now):

tests/wpunit/PostObjectFieldsTest.php

rsm0128 · 2021-03-20T01:37:21Z

And I think \vendor\composer\platform_check.php should be git ignored or be added to the repo. If I run composer install the file marked as an untracked file.

rsm0128 · 2021-03-20T08:23:51Z

@jasonbahl I added ContentNode and TermNode support for explicit options.
Instead of disabling Post Type Checkboxes when ContentNode Checkbox is checked, I implemented it in the same way with Check All button. Please check below screenshot.

jasonbahl · 2021-03-20T14:02:06Z

@rsm0128 the screenshot for how you implemented the Interface checkbox looks nice! I like it better then the disabled idea I suggested. Good work!

- update Docker entrypoint to download wp-graphql from WordPress.org - update test for custom fields

drewbaker · 2021-03-25T21:56:56Z

@jasonbahl lets get this bad boy merged! Such a big upgrade to the plugin.

…ues instead of prefixing with `post_type__`, `taxonomy__`, etc - Update to use `graphql_types` instead of `graphql_types_on` setting name - Update Checkbox markup to be re-usable for multiple interfaces and their possible types - Update jQuery for checkbox state management to be re-usable for any Interface checkbox set

jasonbahl · 2021-03-31T04:35:37Z

@jasonbahl lets get this bad boy merged! Such a big upgrade to the plugin.

@rsm0128 @drewbaker we're getting close for sure!

I pushed some commits refactoring some things with the checkboxes. I'll follow-up with more tomorrow. (I broke the tests 🤦‍♂️ , so I'll fix them) We're getting close to a spot where I'll be comfortable supporting this!

Stoked to get this out!

…g as context - Add ACF Options Pages to the WPGraphQL when the Schema is loading - Update code to use `graphql_types` instead of `graphql_types_on` - Update tests to use `graphql_types` instead of `graphql_types_on` - run `composer install --no-dev`

src/class-config.php

- Update default `required` value for the `graphql_field_name` rule - Updates docblocks in class-config - Updates class-config to get location rules from the location rules class - Adds new LegacyLocationRules class to help support legacy location rules (before GraphQL Schema Types were explicitly set for each field group) - Adds JS to handle required field logic for graphql_field_name - Adds tests for CommentLocation, LegacyRules, MenuItemLocation, MenuLocation, TemplateLocation and TermLocation - updates composer autoloader map

…ing field group location rules - Move GraphQL Settings into their own meta box - Register an `AcfFieldGroup` Interface - Revamp location-rules. They will now be treated as more of a first-class citizen than a legacy thing. Field Groups will still use ACF Location Rules as the first attempt to map field groups to the Schema, but still allow users to override if they choose to. - Work on JS for conditional visibility of GraphQL Settings fields - Update LocationRulesTest (instead of LegacyLocationRulesTest)

# Conflicts: # docker/app.entrypoint.sh

…ld Group page - Add Ajax callback for determining rules - Update Location Rules to check for rule conflicts, and support many edge cases, such as assigning a Field Group to a post_status - Update JS helpers for the GraphQL Field Group settings. Add conditional logic to the field that allows users to manually chose GraphQL fields or map based on location rules - Reset location rules when manual graphql type mapping is unchecked.

- add support for new location rules to map to options pages - check to see if field group is set to be manually mapped to GraphQL Types, and if so, don't use get_location_rules() to automatically map when building the Schema - Add test for ACF settings pages and ACF sub settings pages

- back out the change to remove the prefix from field groups (will be addressed later)

rsm0128 and others added 6 commits March 13, 2021 12:00

Fix wp-graphql#135. Add Explicit options for adding ACF Field Groups …

6cb6193

…to the Schema

Fixed formatting issues. Reverted phpcs auto formatting error and fol…

46696e3

…lowed WP convention for new code

fixed spelling issue. Thanks @drewbaker

fc010f7

updated unit test with new graphql_types_on field

3c9349b

Aded Explicit Options WpUnit test case

1271ed9

updated plugin version check

36b03c0

rsm0128 mentioned this pull request Mar 15, 2021

Fix #135. Add Explicit options for adding ACF Field Groups to the Schema #207

Closed

jasonbahl reviewed Mar 19, 2021

View reviewed changes

rsm0128 force-pushed the bugfix-135 branch from d0678bc to 36b03c0 Compare March 20, 2021 00:57

fixed typo issue with user register fields

629dfac

Added contentNode and termNode support for the explicit option

078cc98

- add plaftform_check to .gitignore

7f1ebdd

- update Docker entrypoint to download wp-graphql from WordPress.org - update test for custom fields

ccorda mentioned this pull request Mar 28, 2021

New built-in ACF + page template targeting. patronage/bubs-next#91

Closed

supriome mentioned this pull request Mar 29, 2021

[gatsby-plugin-wordpress] Can't query data from allWpPost when enable location rules in wpgraphql-acf plugin gatsbyjs/gatsby#30544

Closed

This comment has been minimized.

Sign in to view

jasonbahl added 3 commits March 30, 2021 22:20

- Add the ContentTemplate interface to the Checkboxes

0d2e191

- Fix typo in JS for unsetting checked state

c6e3888

jasonbahl self-assigned this Mar 31, 2021

jasonbahl reviewed Apr 5, 2021

View reviewed changes

src/class-config.php Outdated Show resolved Hide resolved

jasonbahl added 10 commits April 6, 2021 13:39

- Update test to include nav menu registration

b202db1

- Update test message linking to WPGraphQL Issue

d7cb493

Merge commit '3bf411f270c591a89dce3b41acb655046139a10e' into bugfix-135

63afa2f

# Conflicts: # docker/app.entrypoint.sh

- update testing matrix

8bde1b2

- update testing matrix

e35e895

- Update tests to test with multiple versions of WPGraphQL

d0ca31f

TylerBarnes mentioned this pull request Apr 15, 2021

WPGraphiQL and gatsby-source-wordpress return different values for same ACF field gatsbyjs/gatsby#30878

Closed

- Update .gitignore to not ignore the platform check

bf4c781

- back out the change to remove the prefix from field groups (will be addressed later)

jasonbahl merged commit 3cb2244 into wp-graphql:develop Apr 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #135. Add Explicit options for adding ACF Field Groups to the Schema #229

Fix #135. Add Explicit options for adding ACF Field Groups to the Schema #229

rsm0128 commented Mar 15, 2021 •

edited by jasonbahl

Loading

rsm0128 commented Mar 15, 2021

supriome commented Mar 19, 2021

rsm0128 commented Mar 19, 2021

jasonbahl commented Mar 19, 2021

jasonbahl Mar 19, 2021

rsm0128 Mar 20, 2021

jasonbahl Mar 20, 2021

rsm0128 Mar 20, 2021

supriome Mar 22, 2021

jasonbahl Mar 23, 2021

jasonbahl Mar 23, 2021

rsm0128 Mar 23, 2021

jasonbahl Mar 31, 2021

jasonbahl Mar 31, 2021

rsm0128 commented Mar 20, 2021

rsm0128 commented Mar 20, 2021

jasonbahl commented Mar 20, 2021

drewbaker commented Mar 25, 2021

This comment has been minimized.

jasonbahl commented Mar 31, 2021

Fix #135. Add Explicit options for adding ACF Field Groups to the Schema #229

Fix #135. Add Explicit options for adding ACF Field Groups to the Schema #229

Conversation

rsm0128 commented Mar 15, 2021 • edited by jasonbahl Loading

rsm0128 commented Mar 15, 2021

supriome commented Mar 19, 2021

rsm0128 commented Mar 19, 2021

jasonbahl commented Mar 19, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rsm0128 commented Mar 20, 2021

rsm0128 commented Mar 20, 2021

jasonbahl commented Mar 20, 2021

drewbaker commented Mar 25, 2021

This comment has been minimized.

jasonbahl commented Mar 31, 2021

rsm0128 commented Mar 15, 2021 •

edited by jasonbahl

Loading