[5.x]: Some events are not firing

[igorchubarets]

What happened?

Description

1. I need to create a module, that would hide certain functionality behind graphql resolver
2. To create a new resolver, I went through the official documentation
3. However it doesn't look like all event's are firing

Steps to reproduce

1. Create a new module
2. Add event's to init function

Expected behavior

All event's are firing and registering my query and interface

Actual behavior

1. 2 top events from screenshot are firing
2. 2 bottom events from screenshot are not firing
3. No errors in logs are detected, event's just don't fire.

PS

The only event from craft\services\Gql that is firing.
I tested it and yes, it works.

Craft CMS version

5.6.0

PHP version

8.2.26

Operating system and version

Docker container craftcms/nginx:8.2

Database type and version

No response

Image driver and version

No response

Installed plugins and versions

[i-just]

Hi, thanks for raising a new issue!

Is the call to attachEventHandlers() method wrapped in Craft::$app->onInit(), like so:

Craft::$app->onInit(function() {
    $this->attachEventHandlers();
});

Do you have enableGraphqlCaching set to true (that’s the default value)? If so, both those events will only fire if the schema and query are not cached. Can you invalidate data caches for GraphQL queries (control panel > Utilities > Caches or via craft clear-caches/data command) or set the enableGraphqlCaching to false and see if those events trigger the first time you load GraphiQL and the first time you perform a query?

[igorchubarets]

Good day there. Thank you for your response.

I've moved the two events inside onInit and invalidated caches. Nothing has changed.

Hi, thanks for raising a new issue!

Is the call to attachEventHandlers() method wrapped in Craft::$app->onInit(), like so:

Craft::$app->onInit(function() {
    $this->attachEventHandlers();
});

Do you have enableGraphqlCaching set to true (that’s the default value)? If so, both those events will only fire if the schema and query are not cached. Can you invalidate data caches for GraphQL queries (control panel > Utilities > Caches or via craft clear-caches/data command) or set the enableGraphqlCaching to false and see if those events trigger the first time you load GraphiQL and the first time you perform a query?

[brandonkelly]

@igorchubarets What about the second question?

[igorchubarets]

I didn't change those settings, so I assume it's default: true.

I thought Invalidating caches responds to the question. I will try setting it to false and will come back to you.

[igorchubarets]

@igorchubarets What about the second question?

I set the enableGraphqlCaching to false. I still see no events being fired.

[i-just]

Thanks for double-checking!
To clarify, when you say you still don’t see those events being fired, do you mean you don’t see them in the debug toolbar, or are they actually not fired - e.g. if you set a breakpoint inside the function(RegisterGqlTypesEvent $event) {} is it being reached?

[igorchubarets]

Good day @i-just , I was able to figure it out.

1. I was expecting the event to be displayed in the debug toolbar (it doesn't happen)
2. The event was firing outside of onInit, but was not giving any indication of an error or warning in logs
3. I could find an exception in the network tab

4. The error itself was related to the deprecated method of TypeManager, example of which is present in current documentation, which is outdated
5. The example of what has to be used instead, is also outdated, see screenshot below:

6. prepareFieldDefinitions is not a static method in Gql class.
7. Below is the way I was able to use it

It would be nice to update the documentation, so nobody would have to debug like me and you together :)

Thank you for your help.

[i-just]

Thanks for the update! I’m glad you got to the bottom of it. I will pass your feedback along.