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 teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...