Create and utilise autowiring aliases for OpenID Connect

I'm not sure what the problem is with the one test failure. If you remove this line:

Drupal\openid_connect\OpenIDConnect: '@openid_connect.openid_connect'

...then the test passes. But if I understand the documentation correctly, then that line is important for downstream modules to use autowiring. So it can't just be deleted.

I've tried to identify what the problem might be, but haven't had success. The error occurs while the container is being built.

I fixed the broken test and added a post_update call to ensure cache's are cleared so the new service names are registered.

Good catch to see that the module wasn't enabled in that test. I didn't notice it.

With the addition of the post update function I think this is good to go.

This has been merged. Thanks everyone!

Alpha6 → causes an issue in keycloak reported by two others

I'm not sure which change in alpha6 is causing this.

Alpha6 → causes an issue in keycloak reported by two others

I'm not sure which change in alpha6 is causing this.

The service shows up if I do \Drupal::service('openid_connect.openid_connect');.

Not much has happened with this project recently, however the other user is reporting quite a leap. v1.8 to 2.2.1 ??

Providing a revert patch just so that folks experiencing the issue can test a revert.

Updating the name of the patch.

Can you confirm if the `openid_connect_rebuild_container_3462532` post update function ran? That should've rebuilt the container after the service definitions changed.

Ok I'll mention it and look for a review

After updating openid_connect from 3.0.0-alpha5 to 3.0.0-alpha6, the following error occurred in custom kernel tests with openid_connect in $modules:
Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException: You have requested a non-existent service openid_connect.openid_connect.

Similar to issue #5, this is resolved by removing Drupal\openid_connect\OpenIDConnect: '@openid_connect.openid_connect' from openid_connect.services.yml.

The script openid_connect_rebuild_container_3462532 ran without errors, but the problem persists.

@pfrilling for what it's worth, I can't replicate the issue where the service isn't found. I've updated a few D10 and D11 sites. They don't have any problem. I don't even have to update the database or manually clear the cache for it to work. Everything just keeps going like nothing changed before and after running the post_update function. The issue may be specific to certain situations.

Thanks @dcam, that's been my experience too with a few client projects I updated to alpha6 this week. One project is using the generic plugin, the other is using the windows_aad extension module.

@anna d, you mentioned custom kernel tests failing. Are you extending the `@openid_connect.openid_connect` service anywhere and/or injecting it in a custom class?

@joseph.olstad, I know you're using the Keycloak module. I'm unfamiliar with that code... is the openid_connect service being used in any non-standard ways?

One project is using the generic plugin, the other is using the windows_aad extension module.

For the record, we use windows_aad exclusively at work. But I did install other clients on testing sites while trying to verify the issue. They weren't functional of course. So I couldn't actually log in with them. But that raises a point I hadn't noticed before now. I don't think anyone has said when this happens. Is this a general WSoD? Or does it happen when taking certain actions like logging in or accessing admin pages?

I have the same exact problem as @anna d in #20. My Kernel tests are hosed whenever I have `openid_connect` in $modules using alpha6.

Thanks @danflanagan8. Question, is the issue only in your Kernel tests? Does the site actually work with the alpha6 upgrade?

@pfrilling It's hard to say for certain because I don't have any way to authenticate locally through openid_connect. What I can say is that for anonymous users locally or users logged in via `drush uli`, the site seems to be ok. No failures in my pretty significant suite of ExistingSite tests. I don't know how definitive that is though.

So I suspect this is just a Kernel test problem. I don't understand autowiring at all, and I'm also shaky on how Kernel test handle the container and services, but I suspect it's somehow the way that that all interacts in Kernel tests. :shrug:

Looking through the code, there was a call to $container->removeDefinition('openid_connect.openid_connect'); in a ServiceProvider class that was added to the 2.x branch with this issue: https://www.drupal.org/node/3206034 → . This looks to have been included when external auth was added as a dependency.

I think that makes sense now why your Kernel tests started failing with alpha6, if the service wasn't available, then the openid_connect.openid_connect service was being removed. Since the new autowiring fix was setup as an alias, it was trying to find a service that didn't exist.

I believe the service provider class should be safe to remove since the external auth module was installed in both `openid_connect_update_8203` and `openid_connect_update_8198`.

Please test the changes in MR #144 in your situations and report back.

Sounds like we're on the right path.

To make it clear, if your Kernel tests are testing openid_connect, then it you will need to also manually enable externalauth (add to $modules) since it has been a hard dependency for a while. It is only by luck (the service provider) that you havn't needed it.

@anna d, you mentioned custom kernel tests failing. Are you extending the `@openid_connect.openid_connect` service anywhere and/or injecting it in a custom class?

We have kernel tests for a custom module that depends on the OpenID Connect module, specifically the openid_connect.claims service. The openid_connect.openid_connect service is not used directly.

After adding 'externalauth' to the $modules the problem was solved.

Also I got a next problem that was fixed with adding "file" to the $modules:

"Symfony\Component\DependencyInjection\Exception\RuntimeException: Cannot autowire service "openid_connect.openid_connect": argument "$fileRepository" of method "Drupal\openid_connect\OpenIDConnect::__construct()" references interface "Drupal\file\FileRepositoryInterface" but no such service exists. Did you create a class that implements this interface?"

@anna d. Be sure the add the `file` module to the $modules array as well. See https://git.drupalcode.org/project/openid_connect/-/blob/3.x/tests/src/F... for a full list of required modules. Those should be the only three requirements in your tests.

MR144 works for me in resolving the "non-existent service" service error with the keycloak module.

Thanks for reporting back @profi248. If we can get another confirmation and someone to mark this RTBC, I'll go ahead and get it merged and a new tag pushed.

After adding externalauth and file to $modules in my failing Kernel tests, the tests are green again.

As @dpi wrote in #29:

It is only by luck (the service provider) that you havn't needed it.

My luck ran out!

I don't know enough about the module to say whether MR144 is a good idea regardless, but my problem was that I wasn't careful enough with dependencies in my Kernel tests.

I encountered the error You have requested a non-existent service "openid_connect.openid_connect". after upgrading from 8.x-1.4 to 3.0.0-alpha6. I am not using keycloak.

@srdtwc, if you apply the patch from MR #144 (https://git.drupalcode.org/project/openid_connect/-/merge_requests/144), does the error go away?