Do not run IHostedService implementations #2880

martincostello · 2024-05-14T14:21:58Z

Remove IHostedService implementations so the CLI doesn't run hosted services (and then hang/fail).
Refactor CLI tests to reduce duplication.
Use newer C# syntax as suggested by Visual Studio.

Supersedes #2713.

Resolves #2712.

/cc @desjoerd

codecov-commenter · 2024-05-14T14:27:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.88%. Comparing base (828b7df) to head (9b1d9f8).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2880   +/-   ##
=======================================
  Coverage   89.88%   89.88%           
=======================================
  Files          72       72           
  Lines        2710     2710           
  Branches      428      428           
=======================================
  Hits         2436     2436           
  Misses        274      274

Flag	Coverage Δ
Linux	`89.88% <ø> (ø)`
Windows	`89.88% <ø> (ø)`
macOS	`89.88% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

desjoerd

I've added the suggestion of the fix I wanted to port :)

desjoerd · 2024-05-14T14:54:27Z

src/Swashbuckle.AspNetCore.Cli/HostingApplication.cs

+                        // exclude all implementations of IHostedService
+                        // except Microsoft.AspNetCore.Hosting.GenericWebHostService because that one will build/configure
+                        // the WebApplication/Middleware pipeline in the case of the GenericWebHostBuilder.
+                        if (typeof(IHostedService).IsAssignableFrom(services[i].ServiceType)


Suggested change

if (typeof(IHostedService).IsAssignableFrom(services[i].ServiceType)

if (services[i].ServiceType == typeof(IHostedService)

This is taken from RicoSuter/NSwag#4756

Thanks! Do you have a specific example of a service that shouldn't be removed so I can augment the test?

Use newer C# syntax as suggested by Visual Studio.

- Remove `IHostedService` implementations so the CLI doesn't run hosted services (and then hang/fail). - Refactor CLI tests to reduce duplication. Co-Authored-By: Sjoerd van der Meer <2460430+desjoerd@users.noreply.github.com>

Narrow the type check to only `IHostedService` registrations, rather than types that implement it. Co-Authored-By: Sjoerd van der Meer <2460430+desjoerd@users.noreply.github.com>

Update test after rebase to use new helpers.

Apply suggested refactorings.

mesMess

Stop running Hosted Service interfaces (some) to reduce hanging
Syntax cleanup and changes (Visual Studio Syntax Guide)

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [Swashbuckle.AspNetCore](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore) | `6.6.1` -> `6.6.2` | [![age](https://developer.mend.io/api/mc/badges/age/nuget/Swashbuckle.AspNetCore/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/nuget/Swashbuckle.AspNetCore/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/nuget/Swashbuckle.AspNetCore/6.6.1/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/nuget/Swashbuckle.AspNetCore/6.6.1/6.6.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>domaindrivendev/Swashbuckle.AspNetCore (Swashbuckle.AspNetCore)</summary> ### [`v6.6.2`](https://togithub.com/domaindrivendev/Swashbuckle.AspNetCore/releases/tag/v6.6.2) #### What's Changed - Fix to make required and nullable properties nullable in schema by [@keahpeters](https://togithub.com/keahpeters) in [domaindrivendev/Swashbuckle.AspNetCore#2879 - Update Swagger UI section in README by [@cremor](https://togithub.com/cremor) in [domaindrivendev/Swashbuckle.AspNetCore#2883 - Add support for the `[Length]`attribute. by [@satma0745](https://togithub.com/satma0745) in [domaindrivendev/Swashbuckle.AspNetCore#2882 - Existing output file should be deleted/overwritten by [@patrikwlund](https://togithub.com/patrikwlund) in [domaindrivendev/Swashbuckle.AspNetCore#2886 - Fix libraries being handled as test projects by [@patrikwlund](https://togithub.com/patrikwlund) in [domaindrivendev/Swashbuckle.AspNetCore#2898 - Avoid competing swagger generation during test build by [@patrikwlund](https://togithub.com/patrikwlund) in [domaindrivendev/Swashbuckle.AspNetCore#2897 - Replace ` `, ` `, and ` ` in XML comments with `Environment.Newline` by [@mburumaxwell](https://togithub.com/mburumaxwell) in [domaindrivendev/Swashbuckle.AspNetCore#2899 - Fix schema generation for [c#9](https://togithub.com/c/Swashbuckle.AspNetCore/issues/9) positional record with param tag without example property creating unexpected empty example by [@stb-co](https://togithub.com/stb-co) in [domaindrivendev/Swashbuckle.AspNetCore#2901 - Fix serialization of `AdditionalItems` by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2890 - Disable parallel build by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2894 - Do not run `IHostedService` implementations by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2880 - Fix interceptor JSON casing by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2907 - Fix generation when `[DefaultValue]`'s type differs by [@martincostello](https://togithub.com/martincostello) in [domaindrivendev/Swashbuckle.AspNetCore#2895 #### New Contributors - [@satma0745](https://togithub.com/satma0745) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2882 - [@patrikwlund](https://togithub.com/patrikwlund) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2886 - [@stb-co](https://togithub.com/stb-co) made their first contribution in [domaindrivendev/Swashbuckle.AspNetCore#2901 **Full Changelog**: domaindrivendev/Swashbuckle.AspNetCore@v6.6.1...v6.6.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "after 10pm every weekday,every weekend,before 5am every weekday" in timezone Europe/Berlin, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/orso-co/Orso.Arpa.Api).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

martincostello added the bug fix label May 14, 2024

martincostello mentioned this pull request May 14, 2024

Do not run IHostedService implementations #2713

Closed

desjoerd suggested changes May 14, 2024

View reviewed changes

martincostello added this to the v6.6.2 milestone May 14, 2024

martincostello marked this pull request as ready for review May 14, 2024 15:07

martincostello force-pushed the gh-2712 branch from ddf47a9 to 7f9254a Compare May 15, 2024 10:32

martincostello and others added 5 commits May 16, 2024 08:29

Apply IDE code suggestions

bbab9f6

Use newer C# syntax as suggested by Visual Studio.

Do not run IHostedService implementations

d139c84

- Remove `IHostedService` implementations so the CLI doesn't run hosted services (and then hang/fail). - Refactor CLI tests to reduce duplication. Co-Authored-By: Sjoerd van der Meer <2460430+desjoerd@users.noreply.github.com>

Narrow type check

a670b2a

Narrow the type check to only `IHostedService` registrations, rather than types that implement it. Co-Authored-By: Sjoerd van der Meer <2460430+desjoerd@users.noreply.github.com>

Fix test

2975b06

Update test after rebase to use new helpers.

Apply IDE suggestions

9b1d9f8

Apply suggested refactorings.

martincostello force-pushed the gh-2712 branch from 7f9254a to 9b1d9f8 Compare May 16, 2024 07:31

mesMess approved these changes May 18, 2024

View reviewed changes

martincostello merged commit 432c417 into domaindrivendev:master May 18, 2024
9 checks passed

martincostello deleted the gh-2712 branch May 18, 2024 06:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Do not run IHostedService implementations #2880

Do not run IHostedService implementations #2880

martincostello commented May 14, 2024

codecov-commenter commented May 14, 2024 •

edited

desjoerd left a comment

desjoerd May 14, 2024

martincostello May 14, 2024

mesMess left a comment

	if (typeof(IHostedService).IsAssignableFrom(services[i].ServiceType)
	if (services[i].ServiceType == typeof(IHostedService)

Do not run IHostedService implementations #2880

Do not run IHostedService implementations #2880

Conversation

martincostello commented May 14, 2024

codecov-commenter commented May 14, 2024 • edited

Codecov Report

desjoerd left a comment

Choose a reason for hiding this comment

desjoerd May 14, 2024

Choose a reason for hiding this comment

martincostello May 14, 2024

Choose a reason for hiding this comment

mesMess left a comment

Choose a reason for hiding this comment

codecov-commenter commented May 14, 2024 •

edited