Jump to content
dadish

GraphQL for ProcessWire

Recommended Posts

25 minutes ago, dragan said:

Granted, I didn't do extensive testing so far, but I guess it throws errors each time when there is no value in a field. (hence, the selector "only show if images.count > 0" was working fine). Could that be? Earlier it just outputted empty nodes or null instead (which I would expect and is totally fine).

It could be. When some field is empty it should return null or empty array. Somewhere in the code it might be trying to return a value instead. I'm looking into FieldtypeInteger and can't quite figure out yet what I missed.

  • Like 1

Share this post


Link to post
Share on other sites

New Version 1.0.4

- Fixes empty value bug for FieldtypeInteger.

@dragan I was able to reproduce error for FieldtypeInteger. Turns out ProcessWire returns an empty string instead of null when FieldtypeInteger is empty. That's why GraphQL schema was complaining about getting empty string instead of Int.

Let me know if the latest patch works for you.

  • Like 3

Share this post


Link to post
Share on other sites

@dadish 

Thanks for the quick update / fix.

I tried it again today, and while empty int fields are no longer a problem, I get some other strange issues:

I can query some page reference fields, but not others. The error shown is like:

Spoiler

{
  "errors": [
    {
      "message": "Cannot query field \"title\" on type \"Page\".",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 10,
          "column": 11
        }
      ]
    },
    {
      "message": "Cannot query field \"title\" on type \"Page\".",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 15,
          "column": 11
        }
      ]
    },
    {
      "message": "Cannot query field \"title\" on type \"Page\".",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 20,
          "column": 11
        }
      ]
    }
  ]
}

Unlike with the integer issue, the output stops, i.e. there is no additional data output shown.

I compared a pageref field that doesn't throw GraphQL errors with another one that does:

The one that works shows this in the documentation explorer panel: (when searching with the field-name)

ProductPageArray
ProductPage
ProjectPage.product
ProjectCreateInput.product
ProjectUpdateInput.product

While others just show:

ProjectPage.industry
ProjectCreateInput.industry
ProjectUpdateInput.industry

(project = template, product + industry = page reference fields)

Does that give you a hint what's happening behind the scenes? 

Share this post


Link to post
Share on other sites
3 minutes ago, dragan said:

"message": "Cannot query field \"title\" on type \"Page\".",

 

When you create a FieldtypePage field it can store a reference to any page. Which means the module cannot know which template those pages have upfront, which in turn means we cannot know which fields those pages will have when we generate the schema (except built in fields like id, name, url and etc). But if you set a particular template for selectable pages for that field, then it will detect it and additional template fields for your page references will be available.

So my guess would be that your page reference field does not have a template assigned to it. Is that your case?

  • Like 1

Share this post


Link to post
Share on other sites
11 minutes ago, dadish said:

So my guess would be that your page reference field does not have a template assigned to it. Is that your case?

No, they all have a template assigned (most though without a physical file - don't think that should matter).

12 minutes ago, dadish said:

which in turn means we cannot know which fields those pages will have when we generate the schema (except built in fields like id, name, url and etc)

I only ever just use the system-field title. Is that not included?

Strange thing is that if I replace title with name in the query, it works. But (again, just for some PR fields) if use title, I get errors.

Share this post


Link to post
Share on other sites
27 minutes ago, dragan said:

I only ever just use the system-field title. Is that not included?

No, it's not. The title field can be removed from the page. so it's not included by default.

28 minutes ago, dragan said:

Strange thing is that if I replace title with name in the query, it works. But (again, just for some PR fields) if use title, I get errors.

In your graphql documentation, does your page reference fields has a title field in them?

  • Like 1

Share this post


Link to post
Share on other sites
28 minutes ago, dadish said:

In your graphql documentation, does your page reference fields has a title field in them?

Yes. 

PageType with template service.

title: PageTitle!
Field with the type of FieldtypePageTitle

It's listed in the config under "legalFields" (showing as "title (system)").

However, I can't choose it from legalPageFields, i.e. the dropdown doesn't list it.

Share this post


Link to post
Share on other sites
2 minutes ago, dragan said:

However, I can't choose it from legalPageFields, i.e. the dropdown doesn't list it.

That's fine. You should set it under legalFields config. The legalPageFields is for built-in fields like name, id, path, url, created and etc.

I'm still not sure how this could be happening. You're the second person with this problem but I can't reproduce it. Page reference fields have title and I can query them on my installations. Is there any chance that you can reproduce this in any of the Site Profiles? Then you can export it with Site Profile Exporter and share with me. I will continue trying to reproduce it but it'll go faster if you help me with it.

  • Like 2

Share this post


Link to post
Share on other sites
8 minutes ago, dadish said:

Is there any chance that you can reproduce this

I'll gladly do so and try to find a pattern that might help to isolate/identify the root cause. Alas, this week I'm short on time 😞

 

Share this post


Link to post
Share on other sites

New Version 1.0.5

- Fixes empty value bug for FieldtypePage and FieldtypePage::derefAsPageOrFalse setting.

@dragan I was trying to reproduce your bug but encountered different one which is also related to FieldtypePage. This probably not related to your bug but try it anyway when you have time.

 

  • Like 2

Share this post


Link to post
Share on other sites

When trying to fetch Repeater fields with module version 1.0.5, I get responses like this one:

[ 
	{ 
		"title": "", 
		"body": "", 
		"products": { 
			"list": [], 
			"__typename": "ProductPageArray" 
		}, 
		"__typename": "RepeaterProductGroupsPage" 
	},
	{ 
		"title": "", 
		"body": "", 
		"products": { 
			"list": [], 
			"__typename": "ProductPageArray" 
		}, 
		"__typename": "RepeaterProductGroupsPage" 
	} 
]

So I get an answer with the expected data structure (and no errors whatsoever), but the values of the fields are always empty. Also the amount of repeater items in the response matches with the backend. This is when I send the request from the frontend (via Apollo). Looking at the same query within GraphiQL returns the data with the correct values.

Could this be a permission problem? I correctly set the access permissions to view for all the fields mentioned in the query.

Share this post


Link to post
Share on other sites
6 hours ago, charger said:

Could this be a permission problem? I correctly set the access permissions to view for all the fields mentioned in the query.

Yes, it is probably a permission problem. For the page fields. You need to make sure the user has view permission for the pages in the page field. So in your case, you need to make sure that user has a view permission for product template.

Not sure why the title and body are not showing up. But, If you are setting permissions in the template context, then you need to set them for the fields in your repeater too. Either via the repeater field settings or via the template that your repeater is using. That would be repeater_product_groups template, if I guessed the name correctly.

Share this post


Link to post
Share on other sites

The template permissions are set correctly then. The guest role has view permission on the product template.

I’m setting the field permissions not in template context, but per field. So they all have the view permission, also in template context. Just double-checked that. What’s weird is that title and body generally work outside a repeater field. It’s only within the repeater field, that they return no values.

Any other ideas?

Share this post


Link to post
Share on other sites

@charger So the bug you're facing is due to the fact that repeaters are pages under the hood and the module checks permission those pages as well and since you do not have view access enabled for your repeater template the values return empty. So in version 1.0.5 you just need to enable view access for your repeater template repeater_product_groups and the values should show up.

But since you are already enabling view for your repeater field I think it's safe to assume that you want to enable view for template that used by that repeater field too. So for latest version 1.0.6 that I just released you don't have to enable access to your repeater templates. Just enabling access to your repeater field is enough.

New Version 1.0.6

Just upgrade the module to the version above and let me know if it solves your problem.

  • Like 2

Share this post


Link to post
Share on other sites

@dadish I’m afraid the problem persists. I get the exact same response. I cleared compiled files and browser cache.

Share this post


Link to post
Share on other sites

@charger I have no other ideas how to solve your case. Could you describe the steps to reproduce the error? You can take a starting point of any site profile and outline the steps to reproduce the issue. That would make it much easier for me to help you.

  • Like 1

Share this post


Link to post
Share on other sites

I could track down the problem to Apollo fragments (specifically using the same fragment more than once in the same query). Not sure why this only popped up inside Repeater fields though.

Thanks for the support!

Share this post


Link to post
Share on other sites

Hi @dadish the module is awesome. But i have some troubles with language support.

Here is my query:

{
  language(name: "default")
  airport(s: "limit=4, sort=title") {
    list {
      id
      title
    }
  }
}

Here is the response problem:

{
  "errors": [
    {
      "message": "Cannot query field \"language\" on type \"Query\".",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ]
    },
    {
      "message": "Cannot query field \"title\" on type \"AirportPage\".",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 6,
          "column": 7
        }
      ]
    }
  ]
}

title field has type - Page Title (Multi-Language), but as it mentioned above response is "Cannot query field \"title\" on type \"AirportPage\"

Here is GraphQL module configuration screen.

image.thumb.png.52deabac2d789cf74b032aa527375c5d.png

Where did I make a mistake?

  • Like 1

Share this post


Link to post
Share on other sites
9 hours ago, Ilyas said:

Where did I make a mistake?

Nowhere. This is embarrassing. I forgot about language field when I rewrote the module for alternative graphql library. My bad, sorry.

New Version 1.1.0

I updated the module to support languages now. Please upgrade and it should work fine. Sorry for inconvenience and thanks a lot for the feedback.

  • Like 2

Share this post


Link to post
Share on other sites

Hello,
First i want to to thank @dadish for this very helpful module! 
I played around a bit with existing pages (in development) and i have a question regarding the "title issue":

I'm trying to get the title from child pages with this query:

{
  job{
    getTotal
    list {
      title
      id
      job_client {
        list {
          title
        }
      }
      children(s: "template=task") {
        list {
          title
        }
      }
    }
  }
}

the task template has the title field but i only get this result:

{
  "errors": [
    {
      "message": "Cannot query field \"title\" on type \"Page\".",
      "extensions": {
        "category": "graphql"
      },
      "locations": [
        {
          "line": 14,
          "column": 11
        }
      ]
    }
  ]
}

Children results work with "name" instead of "title"...

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...