Jump to content

GraphQL for ProcessWire


dadish

Recommended Posts

So I made a mistake by not taking into account the ProcessWire's module naming convention. I totally forgot the fact that if module name starts with Fieldtype it becomes a fieldtype and PW will treat it like any other fieldtype. Like it would try to let you add a new field with that fieldtype. Which we do not want for our GraphQL extension modules. I already faced bugs because of this on admin side.

So naming rule for GraphQL extension modules will be changed from suffixing the name with GraphQL to prefixing the name with GraphQL. So it is GraphQLFieldtypeMapMarker instead of FieldtypeMapMarkerGraphQL. Other than that, everything is the same as before. I'll also update the previous post to reflect this change. Sorry if this causes inconvenience to anyone.

The updated version of ProcessGraphQL that works with new rules is available for use in latest release.

  • Like 7
Link to comment
Share on other sites

  • 3 weeks later...

Wow o_O @dadish I am humbled by your excellent work here. I stumbled on this thread researching PWAs and then was transfixed for the full 37 minutes of your excellent video intro. Thank you very much indeed for all of this, I am yet again thankful for the ProcessWire community's generous and excellent work.

I've had Vue.js noted down as "something I want to use", along with using ProcessWire as/via an API, and most recently, PWAs. I am hoping, if I've not misunderstood, now I may be able to use all these together for a project.

Brilliant! \o/

  • Like 7
Link to comment
Share on other sites

I'm very happy you like it @alan. You definitely can use this for any single page application. That's exactly why I built this module for. Please don't hesitate to share the issues that might come up when using this module. I would love hear some feedback and maybe fix bugs if there are any.

  • Like 3
  • Thanks 1
Link to comment
Share on other sites

5 hours ago, dadish said:

I'm very happy you like it @alan. You definitely can use this for any single page application. That's exactly why I built this module for. Please don't hesitate to share the issues that might come up when using this module. I would love hear some feedback and maybe fix bugs if there are any.

THANK you @dadish ^_^ — this; SPA + PW as an API + GraphQL for PW, for me is a milestone exciting proposition. I hope I make it the biggest thing to happen to my PW world since I read the word "ProcessWire" on the bottom generous Marty Walker's web site and first visited processwire.com.

First steps for me are reading up on PWAs and finally trying to finish a Wes Bos course on ES6, then I'm off to add in PW as an API & GraphQL. Exciting!

  • Like 3
Link to comment
Share on other sites

First of all, I love the module thus far. Unfortunately (for me), When I go to Setup->GraphQL, it pops up with "Loading...", but never actually loads anything . I am currently using php 5.6.30. Any idea what might be causing this? I dont currently have any errors in my console either. 

Screen Shot 2018-03-28 at 3.48.57 PM.png

Link to comment
Share on other sites

27 minutes ago, louisstephens said:

First of all, I love the module thus far. Unfortunately (for me), When I go to Setup->GraphQL, it pops up with "Loading...", but never actually loads anything . I am currently using php 5.6.30. Any idea what might be causing this? I dont currently have any errors in my console either. 

Screen Shot 2018-03-28 at 3.48.57 PM.png

This one is weird. I just installed the module on Classic profile and Skyscrapers profile with latest ProccessWire. Works fine for me.

The "Loading..." is a placeholder till JavaScript kicks in. So this means the GraphiQL js assets are not loading or firing. Could you please try to see if GraphiQL works out of ProcessWire admin. You can either do that manually, using API that exposes GraphiQL in your template file. Or use GraphQL Pages generator. It's in the modules setting page. Looks like this.
5abbfa69e4934_ScreenShot2018-03-29at2_23_50AM.thumb.png.b59965ccf4237c8e0634d51515e46a63.png

Just press it and go to `/graphiql/` on your website and show us what you got there.

  • Like 1
Link to comment
Share on other sites

@dadish I guess I have one question in regards to actually obtain an output in templates (sorry I am really new to ajax in general). I currently have

$result = $modules->get('ProcessGraphQL')->executeGraphQL($query, $variables);

in my header of a file, but need to have an "operation" included. I was testing it out with just trying to get the title and body of the current page. I geuss I am a little unsure of how to get started with this.

Link to comment
Share on other sites

Not really sure if this is the best place to post this (or if it belongs in the thread for the module itself, but if it needs to be moved please do so. I successfully got graphql set up and love how easy it makes it to query etc. 

In my endpoint, I have:

echo $modules->get('ProcessGraphQL')->executeGraphQL();

And on another page, I was testing with:

$.ajax({
		type: "POST",
		url: 'localhost/pw/graphql/',          
		data: "{ modals(s: \"title=Test-Page\") { list { id title body } } }",      
		
		success: function(data) {
			console.log(data);
		} 
	});

However, I seem to be getting an error message returned with: "Must provide an operation.". I do apologize if I have just missed something basic (very new to ajax and how it all functions), but is there something missing from my initial request?

Link to comment
Share on other sites

I get the same "loading" screen.

My browser console shows 

Failed to load resource: the server responded with a status of 404 ()

It looks for a file that doesn't exist: site/templates/admin/admin.js

edit: OK, I also disabled Tracy, and everything works fine.

 

Edited by dragan
Link to comment
Share on other sites

On 4/5/2018 at 7:47 PM, louisstephens said:

Not really sure if this is the best place to post this (or if it belongs in the thread for the module itself, but if it needs to be moved please do so. I successfully got graphql set up and love how easy it makes it to query etc. 

In my endpoint, I have:


echo $modules->get('ProcessGraphQL')->executeGraphQL();

And on another page, I was testing with:


$.ajax({
		type: "POST",
		url: 'localhost/pw/graphql/',          
		data: "{ modals(s: \"title=Test-Page\") { list { id title body } } }",      
		
		success: function(data) {
			console.log(data);
		} 
	});

However, I seem to be getting an error message returned with: "Must provide an operation.". I do apologize if I have just missed something basic (very new to ajax and how it all functions), but is there something missing from my initial request?

@louisstephens Your query should be assigned to query variable. Try to change above code like this

$.ajax({
  type: "POST",
  url: 'localhost/pw/graphql/',          
  data: {
    query: "{ modals(s: \"title=Test-Page\") { list { id title body } } }" // <-- change here
  },  
  success: function(data) {
    console.log(data);
  } 
});

 

  • Like 1
Link to comment
Share on other sites

On 4/2/2018 at 10:09 PM, chumneypwire said:

@dadish I guess I have one question in regards to actually obtain an output in templates (sorry I am really new to ajax in general). I currently have


$result = $modules->get('ProcessGraphQL')->executeGraphQL($query, $variables);

in my header of a file, but need to have an "operation" included. I was testing it out with just trying to get the title and body of the current page. I geuss I am a little unsure of how to get started with this.

You shouldn't use it to obtain output in your template file. ProcessWire already comes with the best API to access your content. The purpose of the GraphQL module is to let you access content via AJAX, using JavaScript from client side.

  • Like 1
Link to comment
Share on other sites

  • 1 month later...

@dadish

While installing the module I get 

require_once(): Failed opening required ' ... modules/ProcessGraphQL/vendor/autoload.php'

There is no 'vendor' folder on the master branch, but it exists on dev branch. Am I missing something? 

Link to comment
Share on other sites

Thank @dadish for this great module. I liked this post long time ago. I just have a chance to get my hand dirty on it. It turns Processwire to a powerful headless CMS with no pain! I am going to use this in my next project with Vue.js or Nuxt.js. 😋

One noob question. Could this module query and mutate session data? I have modules that read/write user, including the unsigned guests, session data. I have no idea how to make it happen using only a GraphQL end point.

Link to comment
Share on other sites

8 hours ago, Zeka said:

@dadish

While installing the module I get 


require_once(): Failed opening required ' ... modules/ProcessGraphQL/vendor/autoload.php'

There is no 'vendor' folder on the master branch, but it exists on dev branch. Am I missing something? 

Hi @Zeka. You should not install the main repository of the module. The main repository of the module is intended only for development of the module. You can install the module in two ways:

  • By module classname. Go to Modules -> Site -> Add New in your PW admin and write `ProcessGraphQL` in Module Class Name field and press Download and Install button.
  • By a zip file. You need to download the module for installation from the releases page of the module. There you can download a .zip file and place it's contents to the site/modules/ directory of the module.
  • Like 2
Link to comment
Share on other sites

21 hours ago, Karl_T said:

Thank @dadish for this great module. I liked this post long time ago. I just have a chance to get my hand dirty on it. It turns Processwire to a powerful headless CMS with no pain! I am going to use this in my next project with Vue.js or Nuxt.js. 😋

One noob question. Could this module query and mutate session data? I have modules that read/write user, including the unsigned guests, session data. I have no idea how to make it happen using only a GraphQL end point.

Hi @Karl_T.

The module has no ability to modify the session data. It only can modify PW pages. AFAIK session data is not stored as pages.

What you can do is add a custom GraphQL mutation field for modifying your session. But that would require you to learn GraphQL and the PHP library that we use. Here is how it might look like

<?php namespace ProcessWire;

use Youshido\GraphQL\Type\Scalar\BooleanType;
use Youshido\GraphQL\Type\Scalar\StringType;
use Youshido\GraphQL\Type\Scalar\IntType;
use Youshido\GraphQL\Execution\ResolveInfo;

$processGraphQL = $modules->get('ProcessGraphQL');

wire()->addHookAfter('ProcessGraphQL::getMutation', function ($event) {
    $mutation = $event->return;
    $mutation->addField('modifySessionData', [
        'type' => new BooleanType(),
        'args' => [
          'foo' => new StringType(),
          'bar' => new IntType(),
        ],
        'resolve' => function ($value, array $args, ResolveInfo $info) {
          $success = false;
		  // modify session data here...
          if ($something) {
            $success = true;
          }
          return $success;
        }
    ]);
});

echo $processGraphQL->executeGraphQL();

And then the query for this could look like this

mutation {
  modifySessionData("foo": "boblibob", "bar": 12234)
}

Haven't tried it. So there might be something I'm missing. But I hope this gives you the idea of how you can achieve what you want.

  • Like 6
  • Thanks 1
Link to comment
Share on other sites

  • 1 month later...

Slightly OT but worth a read:

Open Source GraphQL Engine Launched

https://www.i-programmer.info/news/197-data-mining/11962-graphql-engine-launched.html

quotes:

"The GraphQL community can harness our lightweight GraphQL-as-a-Service engine and turbocharge any of their new or existing Postgres applications."
"While this release focuses on Postgres, the plan is to add support for other databases in the future."

Link to comment
Share on other sites

  • 1 month later...

Love this module, but I'm concerned about the speed. In my tests, a native template returning the same records and data as the GraphQL endpoint:

Returning 20 pages and some details about  page references:

Native Template: 0.4s
GraphQL Endpoint: 3.2s

Is this performance something that could still be improved? 

Link to comment
Share on other sites

  • 3 weeks later...

How do you get the name of Pages from a Page Reference field? I have one called 'colors' and it only lets me get the following total, limit, start - no means to get colors -> name or title?


 

{
  product_single (s: "parent=X") {
    list {
      title
      product_code
			colors {
			  getTotal
			  getLimit
			  getStart
			} 
    }
  }
}

 

Link to comment
Share on other sites

On 9/17/2018 at 8:37 PM, patricktsg said:

How do you get the name of Pages from a Page Reference field? I have one called 'colors' and it only lets me get the following total, limit, start - no means to get colors -> name or title

It should be like this

{
  product_single (s: "parent=X") {
    list {
      title
      product_code
        colors {
          getTotal
          getLimit
          getStart
          list { // list of colors
            name // name for each color
          }
        }
      }
    }
  }
}

 

  • Like 1
Link to comment
Share on other sites

On 8/29/2018 at 3:11 AM, bcartier said:

Love this module, but I'm concerned about the speed. In my tests, a native template returning the same records and data as the GraphQL endpoint:

Returning 20 pages and some details about  page references:

Native Template: 0.4s
GraphQL Endpoint: 3.2s

Is this performance something that could still be improved? 

Unfortunately I haven't had much time in optimization for this module. I'm very busy so can't promise any timelines when this will happen. The only thing you can do now is to keep your graphql schema as small as possible by unchecking all the unwanted fields and templates in the module config page.

There is supposed to be a way to cache the schema (https://github.com/youshido-php/GraphQL/pull/37) I was planning to look into it. But never had a time for it and thus is not implemented in this module yet.

  • Like 1
Link to comment
Share on other sites

22 hours ago, dadish said:

It should be like this


{
  product_single (s: "parent=X") {
    list {
      title
      product_code
        colors {
          getTotal
          getLimit
          getStart
          list { // list of colors
            name // name for each color
          }
        }
      }
    }
  }
}

 

Thanks for getting back to me - tried that code but I just get an empty array for the list

 

{
  "data": {
    "product_single": {
      "list": [
        {
          "title": "Widget",
          "product_code": "12345",
          "colour": {
            "getTotal": 1,
            "getLimit": 0,
            "getStart": 0,
            "list": []
          }
        }
      ]
    }
  }
}

 

Link to comment
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 kixe
      Field that stores one or more references to ProcessWire pages with additional data in field context.
      Values are editable via page edit modal of the referenced page provided from the field if module AdminPageFieldEditLinks is installed and "Enable link to create new pages?" is checked in field settings.
      Requirements: AdminPageFieldEditLinks >= 3.1.4
      https://github.com/kixe/FieldtypePageContextData
      https://processwire.com/modules/fieldtype-page-context-data/
      Use case example:
      The planning of the Tonmeistertagung in the CCD (Congress Center Düsseldorf) from November 3rd, 2021 to November 6th, 2021 is in the finalization phase.
      The conference consists of a conference part and an exhibition. The planning is done via a separate frontendless PW instance. There, all companies (pages) that are active at various events are kept in a pool. Changes (address, logo) can always be done there. For the exhibition of the current conference in November, the exhibitor-companies (pages) are selected via a page reference field. A stand number must now be assigned to each selected company (page). We had originally solved this using the Profield FieldtypeTable. However, this had the disadvantage that each entry again made all companies available for selection and did not recognize which were already selected in a previous table row. The new field type now allows the value (company's stand number) to be assigned to a Company (page) in context to a specific Pagefield living in a specific page.
      https://tonmeistertagung.com/en/exhibitors/exhibition/
       
    • By Robin S
      This module lets you add some custom menu items to the main admin menu, and you can set the dropdown links dynamically in a hook if needed.
      Sidenote: the module config uses some repeatable/sortable rows for the child link settings, similar to the ProFields Table interface. The data gets saved as JSON in a hidden textarea field. Might be interesting to other module developers?
      Custom Admin Menus
      Adds up to three custom menu items with optional dropdowns to the main admin menu.
      The menu items can link to admin pages, front-end pages, or pages on external websites.
      The links can be set to open in a new browser tab, and child links in the dropdown can be given an icon.
      Requires ProcessWire v3.0.178 or newer.
      Screenshots
      Example of menu items

      Module config for the menus

      Link list shown when parent menu item is not given a URL

      Advanced
      Setting child menu items dynamically
      If needed you can set the child menu items dynamically using a hook.
      Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $colours = $event->wire()->pages->findRaw('template=colour', ['title', 'url', 'page_icon']); $children = []; foreach($colours as $colour) { // Each child item should be an array with the following keys $children[] = [ 'icon' => $colour['page_icon'], 'label' => $colour['title'], 'url' => $colour['url'], 'newtab' => false, ]; } $event->return = $children; } }); Create multiple levels of flyout menus
      It's also possible to create multiple levels of flyout submenus using a hook.

      For each level a submenu can be defined in a "children" item. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $children = [ [ 'icon' => 'adjust', 'label' => 'One', 'url' => '/one/', 'newtab' => false, ], [ 'icon' => 'anchor', 'label' => 'Two', 'url' => '/two/', 'newtab' => false, 'children' => [ [ 'icon' => 'child', 'label' => 'Red', 'url' => '/red/', 'newtab' => false, ], [ 'icon' => 'bullhorn', 'label' => 'Green', 'url' => '/green/', 'newtab' => false, 'children' => [ [ 'icon' => 'wifi', 'label' => 'Small', 'url' => '/small/', 'newtab' => true, ], [ 'icon' => 'codepen', 'label' => 'Medium', 'url' => '/medium/', 'newtab' => false, ], [ 'icon' => 'cogs', 'label' => 'Large', 'url' => '/large/', 'newtab' => false, ], ] ], [ 'icon' => 'futbol-o', 'label' => 'Blue', 'url' => '/blue/', 'newtab' => true, ], ] ], [ 'icon' => 'hand-o-left', 'label' => 'Three', 'url' => '/three/', 'newtab' => false, ], ]; $event->return = $children; } }); Showing/hiding menus according to user role
      You can determine which menu items can be seen by a role by checking the user's role in the hook.
      For example, if a user has or lacks a role you could include different child menu items in the hook return value. Or if you want to conditionally hide a custom menu altogether you can set the return value to false. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); $user = $event->wire()->user; // For custom menu number 1... if($menu_number === 1) { // ...if user does not have some particular role... if(!$user->hasRole('foo')) { // ...do not show the menu $event->return = false; } } });  
      https://github.com/Toutouwai/CustomAdminMenus
      https://processwire.com/modules/custom-admin-menus/
    • By tcnet
      This module for ProcessWire sends a notification email for each failed login attempt. Similar modules exists already in the module directory of ProcessWire. However, this module is designed to notify, even if specified user doesn't exist.
      Settings
      The settings for this module are located in the menu Modules=>Configure=>LoginFailNotifier.
      Notification email
      Specifies the email address to which the notification emails should be sent.
        Email subject
      Specifies the subject line for the notification email.
        Post variables
      Specifies the $_POST variables to be included in the notification email. Each variable must be separated by a comma. For example: login_name,login_pass
        Server variables
      Specifies the $_SERVER variables to be included in the notification email. Each variable must be separated by a comma. For example: REMOTE_ADDR,HTTP_USER_AGENT
      Link to ProcessWire module directory:
      https://processwire.com/modules/login-fail-notifier/
      Link to github.com:
      https://github.com/techcnet/LoginFailNotifier
    • By Fokke
      ProcessWire 3.x markup module for rendering meta tags in HTML document head section. Note that this module is not a full-blown SEO solution, but rather a simple tool for rendering meta tags based on module configuration. Adding custom meta tags is also supported.
      Built-in meta tags
      The following meta tags are supported out-of-the-box:
      Document title consisting of page title and site name Character set Canonical Viewport Description Keywords Hreflang tags Open Graph og:title og:site_name og:type og:url og:description og:image og:image:width og:image:height Twitter meta tags twitter:card twitter:site twitter:creator twitter:title twitter:description twitter:image Facebook meta tags fb:app_id The full documentation with configurable options can be found here: https://github.com/Fokke-/MarkupMetadata
       
      Requirements:
      ProcessWire>=3.0.0 PHP >=7.1 Installation using Composer
      composer require fokke/markup-metadata Manual installation
      Download latest version from https://github.com/Fokke-/MarkupMetadata/archive/master.zip Extract module files to site/modules/MarkupMetadata directory.
    • By m.sieber
      ITRK-Service for ProcessWire
      Module for the automated transfer of imprint, data protection declaration and terms and conditions from IT-Recht Kanzlei to your ProcessWire installation
      What is ITRK Service for ProcessWire?
      ITRK-Service for ProcessWire is a free module for ProcessWire CMS. It provides an interface to the update service of IT-Recht Kanzlei, via which the legal texts of your online presence are automatically updated. In this way, the texts remain legally secure and warning-proof in the long term. Imprint, data protection declaration, revocation and general terms and conditions are currently supported.
      You can find our documentation (in german language) here: https://www.pupit.de/itrk-service-for-processwire/dokumentation/

      Download: https://www.pupit.de/itrk-service-for-processwire/
      Github: https://github.com/pupit-de/pwItrkServiceConnector
×
×
  • Create New...