feat(next-drupal): setup graphql

joaogarin · joaogarin · commit c836ded7ce87 · 2025-02-28T16:18:07.000Z
diff --git a/package.json b/package.json
@@ -33,6 +33,7 @@
     "ddev:init": "./scripts/init-drupal.sh",
     "ddev:init:basic": "./scripts/init-drupal.sh --starter basic-starter",
     "ddev:init:pages": "./scripts/init-drupal.sh --starter pages-starter",
+    "ddev:init:graphql": "./scripts/init-drupal.sh --starter graphql-starter",
     "ddev:destroy": "./scripts/destroy-drupal.sh"
   },
   "devDependencies": {
diff --git a/recipes/next_drupal_base/composer.json b/recipes/next_drupal_base/composer.json
@@ -12,4 +12,4 @@
   "require": {
     "drupal/next": "*"
   }
-}
+}
diff --git a/recipes/next_drupal_graphql/composer.json b/recipes/next_drupal_graphql/composer.json
@@ -0,0 +1,17 @@
+{
+  "name": "drupal/next_drupal_graphql",
+  "description": "Common dependencies and configuration for Next Drupal GraphQL projects.",
+  "type": "drupal-recipe",
+  "license": "GPL-2.0-or-later",
+  "repositories": [
+    {
+      "type": "composer",
+      "url": "https://packages.drupal.org/8"
+    }
+  ],
+  "require": {
+    "drupal/next": "*",
+    "drupal/graphql": "^4.6",
+    "drupal/graphql_compose": "^2.0"
+  }
+}
diff --git a/recipes/next_drupal_graphql/config/graphql.graphql_servers.graphql_schema.yml b/recipes/next_drupal_graphql/config/graphql.graphql_servers.graphql_schema.yml
@@ -0,0 +1,18 @@
+uuid: 3954a200-86f3-499b-914e-99a6dac58861
+langcode: en
+status: true
+dependencies: {  }
+name: graphql_schema
+label: 'Graphql Schema'
+endpoint: /graphql
+debug_flag: 0
+schema: graphql_compose
+caching: true
+batching: true
+disable_introspection: false
+query_depth: null
+query_complexity: null
+schema_configuration:
+  graphql_compose:
+    enabled: true
+persisted_queries_settings: {  }
diff --git a/recipes/next_drupal_graphql/config/graphql_compose.settings.yml b/recipes/next_drupal_graphql/config/graphql_compose.settings.yml
@@ -0,0 +1,50 @@
+entity_config:
+  node:
+    article:
+      enabled: true
+      query_load_enabled: true
+      edges_enabled: true
+      routes_enabled: true
+    page:
+      enabled: true
+      query_load_enabled: true
+      edges_enabled: true
+      routes_enabled: true
+  taxonomy_term:
+    tags:
+      enabled: false
+  user:
+    user:
+      enabled: true
+      query_load_enabled: true
+      edges_enabled: true
+      routes_enabled: true
+field_config:
+  node:
+    article:
+      body:
+        enabled: true
+      field_image:
+        enabled: true
+      field_tags:
+        enabled: true
+    page:
+      body:
+        enabled: true
+  user:
+    user:
+      user_picture:
+        enabled: true
+settings:
+  exclude_unpublished: true
+  expose_entity_ids: false
+  field_required_override: false
+  schema_description: "GraphQL Compose"
+  schema_version: "1"
+  simple_queries: true
+  simple_unions: true
+  site_name: false
+  site_slogan: false
+  site_front: true
+  inflector_langcode: en
+  inflector_singularize: true
diff --git a/recipes/next_drupal_graphql/config/pathauto.pattern.content.yml b/recipes/next_drupal_graphql/config/pathauto.pattern.content.yml
@@ -0,0 +1,23 @@
+uuid: a5900cb4-ec2f-4788-9e17-73ab49bfcb83
+langcode: en
+status: true
+dependencies:
+  module:
+    - node
+id: content
+label: Content
+type: 'canonical_entities:node'
+pattern: '[node:title]'
+selection_criteria:
+  c0c92c0f-9ee6-4b53-8270-198bd024c071:
+    id: 'entity_bundle:node'
+    negate: false
+    uuid: c0c92c0f-9ee6-4b53-8270-198bd024c071
+    context_mapping:
+      node: node
+    bundles:
+      article: article
+      page: page
+selection_logic: and
+weight: -5
+relationships: {  }
diff --git a/recipes/next_drupal_graphql/config/simple_oauth.oauth2_scope.nextjs_site.yml b/recipes/next_drupal_graphql/config/simple_oauth.oauth2_scope.nextjs_site.yml
@@ -0,0 +1,22 @@
+uuid: a5bd2fda-4983-4e8d-8019-1c2695b15a42
+langcode: en
+status: true
+dependencies: {}
+id: nextjs_site
+name: nextjs_site
+description: "Next.js Site"
+grant_types:
+  refresh_token:
+    status: false
+    description: ""
+  client_credentials:
+    status: true
+    description: ""
+  authorization_code:
+    status: false
+    description: ""
+umbrella: false
+parent: _none
+granularity_id: role
+granularity_configuration:
+  role: next_js_site
diff --git a/recipes/next_drupal_graphql/config/simple_oauth.settings.yml b/recipes/next_drupal_graphql/config/simple_oauth.settings.yml
@@ -0,0 +1,5 @@
+scope_provider: dynamic
+token_cron_batch_size: 0
+public_key: ../keys/public.key
+private_key: ../keys/private.key
+disable_openid_connect: false
diff --git a/recipes/next_drupal_graphql/config/user.role.next_js_site.yml b/recipes/next_drupal_graphql/config/user.role.next_js_site.yml
@@ -0,0 +1,11 @@
+uuid: 9082be18-8b66-4bfa-8d54-e703ef2c7e2d
+langcode: en
+status: true
+dependencies: {}
+id: next_js_site
+label: "Next.js Site"
+weight: 4
+is_admin: false
+permissions:
+  - "execute graphql_schema arbitrary graphql requests"
+  - "execute graphql_schema persisted graphql requests"
diff --git a/recipes/next_drupal_graphql/recipe.yml b/recipes/next_drupal_graphql/recipe.yml
@@ -0,0 +1,11 @@
+name: "Next Drupal GraphQL"
+description: "Common dependencies and configuration for Next Drupal GraphQL projects"
+type: "Site"
+
+install:
+  - next
+  - next_graphql
+  - graphql
+  - graphql_compose_edges
+  - graphql_compose_routes
+  - graphql_compose_users
diff --git a/scripts/config/graphQLConsumer.php b/scripts/config/graphQLConsumer.php
@@ -0,0 +1,61 @@
+<?php
+
+/**
+ * Borrowed with kudos from
+ * https://github.com/octahedroid/drupal-decoupled-project/blob/10.3.x/scripts/consumers.php
+ *
+ * Very liberal with permissions/secrets here - only intended for local development
+ */
+
+use Drupal\Component\Utility\Crypt;
+use Drupal\Component\Utility\Random;
+use Drupal\Core\File\FileSystemInterface;
+
+$random = new Random();
+$consumerStorage = \Drupal::entityTypeManager()->getStorage('consumer');
+
+// Create a user with role next_js
+$user = \Drupal::service('entity_type.manager')->getStorage('user')->create([
+  'name' => 'next',
+  'mail' => 'next@ddev.site',
+  'password' => 'next',
+  'roles' => ['next_js_site'],
+  'status' => 1,
+]);
+$user->save();
+
+$previewerClientId = Crypt::randomBytesBase64();
+$previewerClientSecret = $random->word(8);
+$consumer = $consumerStorage->create([
+  'client_id' => 'next_consumer',
+  'secret' => 'secret',
+  'label' => 'Next.js site',
+  'user_id' => $user->id(),
+  'grant_types' => ['client_credentials'],
+  'scopes' => ['nextjs_site'],
+  'third_party' => TRUE,
+  'is_default' => FALSE,
+])->save();
+
+$directory = '../keys';
+
+if (create_directory($directory)) {
+  echo 'Keys dir created succesfully' . PHP_EOL;
+} else {
+  echo 'Failed to create directory' . PHP_EOL;
+}
+
+\Drupal::service('simple_oauth.key.generator')->generateKeys($directory);
+
+function create_directory($directory)
+{
+  // Get the file system service.
+  $file_system = \Drupal::service('file_system');
+
+  // Check if the directory exists and create it if it doesn't.
+  if (!$file_system->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY | FileSystemInterface::MODIFY_PERMISSIONS)) {
+    return FALSE;
+  }
+
+  return TRUE;
+}
diff --git a/scripts/init-drupal.sh b/scripts/init-drupal.sh
@@ -75,11 +75,13 @@ ddev composer config allow-plugins.tbachert/spi true -n
 # Add repositories
 ddev composer config repositories.unpack vcs https://gitlab.ewdev.ca/yonas.legesse/drupal-recipe-unpack.git
 ddev composer config repositories.recipe path web/recipes/next_drupal_base
+ddev composer config repositories.recipe path web/recipes/next_drupal_graphql
 ddev composer config repositories.next path modules/next
 
 # Add configuration scripts to run after install
 mkdir drupal/scripts
 cp ../scripts/config/consumers.php drupal/scripts/consumers.php
+cp ../scripts/config/graphQLConsumer.php drupal/scripts/graphQLConsumer.php
 
 # Use the local repo version of the next module
 # ideally this would be a symlink.
@@ -89,17 +91,34 @@ cp -a ../modules/. drupal/modules
 cp -a ../recipes/. drupal/web/recipes
 
 # Add useful composer dependencies
-ddev composer require drush/drush drupal/next_drupal_base drupal/devel drupal/core-dev ewcomposer/unpack:dev-master
+# if staters is basic or pages
+if [[ "$STARTER_NAME" == "basic-starter" || "$STARTER_NAME" == "pages-starter" ]]; then
+    ddev composer require drush/drush drupal/next_drupal_base drupal/devel drupal/core-dev ewcomposer/unpack:dev-master
+else
+    ddev composer require drush/drush drupal/next_drupal_graphql drupal/devel drupal/core-dev ewcomposer/unpack:dev-master
+fi
 
 # Install Drupal
 ddev drush site:install --account-name=admin --account-pass=admin -y
 
-# Apply recipe
-ddev exec -d /var/www/html/drupal/web php core/scripts/drupal recipe recipes/next_drupal_base
-ddev composer unpack drupal/next_drupal_base
+# if staters is basic or pages
+if [[ "$STARTER_NAME" == "basic-starter" || "$STARTER_NAME" == "pages-starter" ]]; then
+    # Apply recipe
+    ddev exec -d /var/www/html/drupal/web php core/scripts/drupal recipe recipes/next_drupal_base
+    ddev composer unpack drupal/next_drupal_base
+else
+    # Apply recipe
+    ddev exec -d /var/www/html/drupal/web php core/scripts/drupal recipe recipes/next_drupal_graphql
+    ddev composer unpack drupal/next_drupal_graphql
+fi
 
 # Create example consumer
-ddev drush php:script drupal/scripts/consumers
+if [[ "$STARTER_NAME" == "basic-starter" || "$STARTER_NAME" == "pages-starter" ]]; then
+    ddev drush php:script drupal/scripts/consumers
+else
+    ddev drush php:script drupal/scripts/graphQLConsumer
+fi
+
 
 # Generate content
 ddev drush pm:enable devel_generate -y

Original file line number	Diff line number	Diff line change
`@@ -12,4 +12,4 @@`
`12`	`12`	`"require": {`
`13`	`13`	`"drupal/next": "*"`
`14`	`14`	`}`
`15`		`-}`
	`15`	`+}`