The orRelatedToEntries gql argument

[Aku-benj]

Hey,

On a lot my graphql projects, I need to use an orRelatedToEntries gql argument that end up converted in a relatedTo: ["or", ...id] and not a relatedTo: ["and", ...id]

Usually I create my own orRelatedToEntries gql argument via a craft module and a custom Handler that extends RelationArgumentHandler where I simply change the and terms in the functions handleArgumentCollection and prepareRelatedTo.

Does that make sens or am I doing something wrong ?
If it does make sens, could there be a native argument to gql queries ?

Event::on(
      Gql::class,
      Gql::EVENT_REGISTER_GQL_QUERIES,
      function(RegisterGqlQueriesEvent $event) {
          $orRelatedToEntriesArgs = [
              'orRelatedToEntries' => [
                  'name' => 'orRelatedToEntries',
                  'type' => fn() => Type::listOf(EntryRelation::getType()),
                  'description' => 'Narrows the query results to elements that are related the entry list defined with this argument.',
              ],
          ];

          $event->queries['entries']['args'] = array_merge(
              $event->queries['entries']['args'],
              $orRelatedToEntriesArgs
          );
          $event->queries['entryCount']['args'] = array_merge(
              $event->queries['entryCount']['args'],
              $orRelatedToEntriesArgs
          );
      }
  );

  Event::on(
      ArgumentManager::class,
      ArgumentManager::EVENT_DEFINE_GQL_ARGUMENT_HANDLERS,
      function(RegisterGqlArgumentHandlersEvent $event) {
          $event->handlers['orRelatedToEntries'] = OrRelatedEntries::class;
      }
  );

[brandonkelly]

Craft’s built-in GraphQL queries don’t define an orRelatedToEntries argument, as far as I can tell… was that added by a module/plugin?

[Aku-benj]

Exactly, as I said in the description, I add this argument via a module in almost every headless projects I work on.
I was wondering if there was a better solution or alternative instead of defining my own argument every time, or if maybe it could be interesting to have it directly on your side.

[brandonkelly]

Doh! Misunderstood.

The relatedTo* arguments use or by default, so you shouldn’t need to do anything special for that.

[Aku-benj]

🤔 Are you certain ?
I was looking at vendor/craftcms/cms/src/gql/base/RelationArgumentHandler.php wich is the handler of the relatedToEntries argument and the function handleArgumentCollection seems to instead enforce a and by default.
I mean its not doing a or by default with a graphql query using relatedToEntries like :

{
  entries(
    relatedToEntries: [ #<-- and by default
     {
        slug: "test"
        section: "page"
     },
     {
        slug: "test1"
        section: "news"
     }
    ]
  ){
    id
  }
}

But If in the handler you change the following code of the function handleArgumentCollection(l.81) then it's ok:

$relatedTo = $this->prepareRelatedTo($argumentList['relatedTo'] ?? []);

if (empty($relatedTo)) {
  $relatedTo = ['and'];
}

with

$relatedTo = $this->prepareRelatedTo($argumentList['relatedTo'] ?? []);

if (empty($relatedTo)) {
  $relatedTo = ['or'];
}

I am not saying it should be a or by default in the gql relatedToEntries argument, but maybe it could be like the relatedTo and support something like :

{
  entries(
    relatedToEntries: [
     "or" #<---
     {
        slug: "test"
        section: "page"
     },
     {
        slug: "test1"
        section: "news"
     }
    ]
  ){
    id
  }
}

Or as stated previously, adding a new orRelatedToEntries argument could do the trick.
Or maybe I am the only one needing this "feature" and I will keep adding the custom gql argument in a module...

[brandonkelly]

Sorry, I tested by passing specific IDs into the param, which does in fact result in an inclusive search (or):

{
{
  entries(
    relatedToEntries: {
      id: [129, 122]
    }
  ) {
    # ...
  }
}

You could reformat your query like so, which would also result in an inclusive search:

{
  entries(
    relatedToEntries: [
      {
        slug: ["test", "test1"]
      	section: ["page", "news"]
      }
    ]
  ) {
    # ...
  }
}

(Though I realize that isn’t quite the same as what you’re going for – as you don’t want to pull in test1 from the news section, or test from the page section, etc.)

I am not saying it should be a or by default in the gql relatedToEntries argument, but maybe it could be like the relatedTo and support something like :

{
  entries(
    relatedToEntries: [
     "or" #<---
     {
        slug: "test"
        section: "page"
     },
     {
        slug: "test1"
        section: "news"
     }
    ]
  ){
    id
  }
}

Unfortunately GraphQL is pretty strict on what can be allowed in queries – you can’t have an array whose values can be either an object or a string; they must all be the same type.

But the bigger issue is that we’re limited by our current relation param system, which doesn’t currently support nested sets of relation params. So there would be no way to combine relatedToEntries and orRelatedToEntries params, for example.

[Aku-benj]

Ok, I understand.
I will keep my "fake" custom orRelatedToEntries added via module then.
Thanks a lot for the brainstorming !