Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix unguarded calls to ServiceDescriptor.ImplementationType for keyed services #16604

Merged
merged 2 commits into from
Jun 22, 2024

Conversation

xdjoshuaaz
Copy link
Contributor

@xdjoshuaaz xdjoshuaaz commented Jun 15, 2024

Prerequisites

  • I have added steps to test this contribution in the description below

No known existing issue that I could find.

Description

This PR updates the calls to ServiceDescriptor.ImplementationType by checking IsKeyedService first.

Currently, if you register a keyed service before UmbracoBuilder does its work, you'll get an exception like below (running the ComponentRuntimeTests.Start_And_Stop_Umbraco_With_Components_Enabled test):

System.InvalidOperationException : This service descriptor is keyed. Your service provider may not support keyed services.
TearDown : System.NullReferenceException : Object reference not set to an instance of an object.
   at Microsoft.Extensions.DependencyInjection.ServiceDescriptor.ThrowKeyedDescriptor()
   at Microsoft.Extensions.DependencyInjection.ServiceDescriptor.get_ImplementationType()
   at Umbraco.Cms.Api.Common.DependencyInjection.UmbracoBuilderAuthExtensions.<>c.<AddUmbracoOpenIddict>b__0_0(ServiceDescriptor x) in F:\repos\umbraco\Umbraco-CMS\src\Umbraco.Cms.Api.Common\DependencyInjection\UmbracoBuilderAuthExtensions.cs:line 20
   at System.Linq.Enumerable.Any[TSource](IEnumerable`1 source, Func`2 predicate)
   at Umbraco.Cms.Api.Common.DependencyInjection.UmbracoBuilderAuthExtensions.AddUmbracoOpenIddict(IUmbracoBuilder builder) in F:\repos\umbraco\Umbraco-CMS\src\Umbraco.Cms.Api.Common\DependencyInjection\UmbracoBuilderAuthExtensions.cs:line 20
   at Umbraco.Cms.Api.Management.DependencyInjection.BackOfficeAuthBuilderExtensions.AddBackOfficeAuthentication(IUmbracoBuilder builder) in F:\repos\umbraco\Umbraco-CMS\src\Umbraco.Cms.Api.Management\DependencyInjection\BackOfficeAuthBuilderExtensions.cs:line 20
   at Umbraco.Cms.Tests.Integration.Testing.UmbracoIntegrationTest.ConfigureServices(IServiceCollection services) in F:\repos\umbraco\Umbraco-CMS\tests\Umbraco.Tests.Integration\Testing\UmbracoIntegrationTest.cs:line 156
   at Umbraco.Cms.Tests.Integration.Testing.UmbracoIntegrationTest.<CreateHostBuilder>b__27_1(HostBuilderContext _, IServiceCollection services) in F:\repos\umbraco\Umbraco-CMS\tests\Umbraco.Tests.Integration\Testing\UmbracoIntegrationTest.cs:line 112
   at Microsoft.Extensions.Hosting.HostBuilder.InitializeServiceProvider()
   at Microsoft.Extensions.Hosting.HostBuilder.Build()
   at Umbraco.Cms.Web.Common.Hosting.UmbracoHostBuilderDecorator.Build() in F:\repos\umbraco\Umbraco-CMS\src\Umbraco.Web.Common\Hosting\UmbracoHostBuilderDecorator.cs:line 63
   at Umbraco.Cms.Tests.Integration.Testing.UmbracoIntegrationTest.Setup() in F:\repos\umbraco\Umbraco-CMS\tests\Umbraco.Tests.Integration\Testing\UmbracoIntegrationTest.cs:line 76
   at System.RuntimeMethodHandle.InvokeMethod(Object target, Void** arguments, Signature sig, Boolean isConstructor)
   at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr)
--TearDown
   at Umbraco.Cms.Tests.Integration.Testing.UmbracoIntegrationTest.TearDownAsync() in F:\repos\umbraco\Umbraco-CMS\tests\Umbraco.Tests.Integration\Testing\UmbracoIntegrationTest.cs:line 87
   at System.RuntimeMethodHandle.InvokeMethod(Object target, Void** arguments, Signature sig, Boolean isConstructor)
   at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr)

To test & verify against this, I've registered a keyed service in the UmbracoIntegrationTest base class before UmbracoBuilder is created & used.

…criptor.ImplementationType are guarded for keyed services
Copy link

github-actions bot commented Jun 15, 2024

Hi there @xdjoshuaaz, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

  • It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
  • The automated tests all pass (see "Checks" tab on this PR)
  • The level of security for this contribution is the same or improved
  • The level of performance for this contribution is the same or improved
  • Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
  • If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
  • 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

@georgebid
Copy link
Contributor

Hey @xdjoshuaaz, thanks for your PR 😄 someone on the core collaborators team will review this soon!

@Matthew-Wise Matthew-Wise self-assigned this Jun 22, 2024
@Matthew-Wise Matthew-Wise merged commit cb09035 into umbraco:contrib Jun 22, 2024
13 checks passed
@Matthew-Wise
Copy link
Contributor

Hi @xdjoshuaaz, thanks for this PR it works great :) Nice to have some extra guards in place

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants