Merge pull request #89 from prom-client-net/refactor/rename-service

phnx47 · web-flow · commit 485675450ed9 · 2024-12-15T22:55:03.000+07:00
rename service &amp; internal refactoring
diff --git a/README.md b/README.md
@@ -4,12 +4,11 @@
 [![nuget](https://img.shields.io/nuget/v/Prometheus.Client.MetricPusher.HostedService?logo=nuget&style=flat-square)](https://www.nuget.org/packages/Prometheus.Client.MetricPusher.HostedService)
 [![nuget](https://img.shields.io/nuget/dt/Prometheus.Client.MetricPusher.HostedService?logo=nuget&style=flat-square)](https://www.nuget.org/packages/Prometheus.Client.MetricPusher.HostedService)
 [![codecov](https://img.shields.io/codecov/c/github/prom-client-net/prom-client-metricpusher-hostedservice?logo=codecov&style=flat-square)](https://app.codecov.io/gh/prom-client-net/prom-client-metricpusher-hostedservice)
-[![codefactor](https://img.shields.io/codefactor/grade/github/prom-client-net/prom-client-metricpusher-hostedservice?logo=codefactor&style=flat-square)](https://www.codefactor.io/repository/github/prom-client-net/prom-client-metricpusher-hostedservice)
 [![license](https://img.shields.io/github/license/prom-client-net/prom-client-metricpusher-hostedservice?style=flat-square)](https://github.com/prom-client-net/prom-client-metricpusher-hostedservice/blob/main/LICENSE)
 
 Extension for [Prometheus.Client](https://github.com/prom-client-net/prom-client)
 
-## Installation
+## Install
 
 ```sh
 dotnet add package Prometheus.Client.MetricPusher.HostedService
@@ -29,7 +28,7 @@ var metricPusher = new MetricPusher(new MetricPusherOptions
 ```
 
 ```c#
-services.AddMetricPusherService(metricPusher);
+services.AddMetricPusherHostedService(metricPusher);
 ```
 
 ## Contribute
diff --git a/src/Defaults.cs b/src/Defaults.cs
@@ -4,5 +4,5 @@ namespace Prometheus.Client.MetricPusher.HostedService;
 
 internal static class Defaults
 {
-    internal static TimeSpan Interval = TimeSpan.FromMilliseconds(1000);
+    internal static TimeSpan PushInterval = TimeSpan.FromMilliseconds(1000);
 }
diff --git a/src/MetricPusherHostedService.cs b/src/MetricPusherHostedService.cs
@@ -5,20 +5,11 @@
 
 namespace Prometheus.Client.MetricPusher.HostedService;
 
-public class MetricPusherService : BackgroundService
+public class MetricPusherHostedService(IMetricPusher pusher, TimeSpan pushInterval) : BackgroundService
 {
-    private readonly IMetricPusher _pusher;
-    private readonly TimeSpan _interval;
-
-    public MetricPusherService(IMetricPusher pusher)
-        : this(pusher, Defaults.Interval)
-    {
-    }
-
-    public MetricPusherService(IMetricPusher pusher, TimeSpan interval)
+    public MetricPusherHostedService(IMetricPusher pusher)
+        : this(pusher, Defaults.PushInterval)
     {
-        _pusher = pusher;
-        _interval = interval;
     }
 
     protected override async Task ExecuteAsync(CancellationToken stoppingToken)
@@ -28,7 +19,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
             await DoPushAsync();
             try
             {
-                await Task.Delay(_interval, stoppingToken);
+                await Task.Delay(pushInterval, stoppingToken);
             }
             catch (TaskCanceledException)
             {
@@ -43,7 +34,7 @@ async Task DoPushAsync()
         {
             try
             {
-                await _pusher.PushAsync();
+                await pusher.PushAsync();
             }
             catch (Exception)
             {
diff --git a/src/Prometheus.Client.MetricPusher.HostedService.csproj b/src/Prometheus.Client.MetricPusher.HostedService.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
-    <Description>Prometheus.Client.MetricPusher as HostedService</Description>
+    <Description>MetricPusher as HostedService</Description>
     <RepositoryUrl>https://github.com/prom-client-net/prom-client-metricpusher-hostedservice</RepositoryUrl>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
diff --git a/src/ServiceCollectionExtensions.cs b/src/ServiceCollectionExtensions.cs
@@ -6,19 +6,19 @@ namespace Prometheus.Client.MetricPusher.HostedService;
 
 public static class ServiceCollectionExtensions
 {
-    public static IServiceCollection AddMetricPusherService(this IServiceCollection services, IMetricPusher pusher)
+    public static IServiceCollection AddMetricPusherHostedService(this IServiceCollection services, IMetricPusher pusher)
     {
-        return AddMetricPusherService(services, pusher, Defaults.Interval);
+        return AddMetricPusherHostedService(services, pusher, Defaults.PushInterval);
     }
 
-    public static IServiceCollection AddMetricPusherService(this IServiceCollection services, IMetricPusher pusher, TimeSpan interval)
+    public static IServiceCollection AddMetricPusherHostedService(this IServiceCollection services, IMetricPusher pusher, TimeSpan pushInterval)
     {
         if (pusher == null)
             throw new ArgumentNullException(nameof(pusher));
-        if (interval == TimeSpan.Zero)
-            throw new ArgumentOutOfRangeException(nameof(interval));
+        if (pushInterval == TimeSpan.Zero)
+            throw new ArgumentOutOfRangeException(nameof(pushInterval));
 
-        services.AddSingleton<IHostedService, MetricPusherService>(_ => new MetricPusherService(pusher, interval));
+        services.AddSingleton<IHostedService, MetricPusherHostedService>(_ => new MetricPusherHostedService(pusher, pushInterval));
 
         return services;
     }
diff --git a/tests/MetricPusherHostedServiceTests.cs b/tests/MetricPusherHostedServiceTests.cs
@@ -3,13 +3,13 @@
 
 namespace Prometheus.Client.MetricPusher.HostedService.Tests;
 
-public class MetricPusherServiceTests
+public class MetricPusherHostedServiceTests
 {
     [Fact]
     public async Task WithDefaultInterval_PushMetricPeriodically()
     {
         var metricPusherMock = Substitute.For<IMetricPusher>();
-        var metricPusherService = new MetricPusherService(metricPusherMock);
+        var metricPusherService = new MetricPusherHostedService(metricPusherMock);
         var canellationToken = Arg.Any<CancellationToken>();
 
         await metricPusherService.StartAsync(canellationToken);
@@ -27,7 +27,7 @@ public async Task WithDefaultInterval_PushMetricPeriodically()
     public async Task WithGivenInterval_PushMetricPeriodically(int seconds)
     {
         var metricPusherMock = Substitute.For<IMetricPusher>();
-        var metricPusherService = new MetricPusherService(metricPusherMock, TimeSpan.FromSeconds(seconds));
+        var metricPusherService = new MetricPusherHostedService(metricPusherMock, TimeSpan.FromSeconds(seconds));
         var canellationToken = Arg.Any<CancellationToken>();
 
         await metricPusherService.StartAsync(canellationToken);
diff --git a/tests/ServiceCollectionExtensionsTests.cs b/tests/ServiceCollectionExtensionsTests.cs
@@ -3,14 +3,14 @@
 
 namespace Prometheus.Client.MetricPusher.HostedService.Tests;
 
-public class ServiceCollecttionExtensionsTests
+public class ServiceCollectionExtensionsTests
 {
     [Fact]
     public void AddMetricPusherService_WithNullMetricPusher_ThrowsArgumentNullException()
     {
         var servicesCollection = Substitute.For<IServiceCollection>();
 
-        Action act = () => servicesCollection.AddMetricPusherService(null, TimeSpan.FromSeconds(1));
+        Action act = () => servicesCollection.AddMetricPusherHostedService(null, TimeSpan.FromSeconds(1));
 
         act.Should().Throw<ArgumentNullException>();
     }
@@ -21,7 +21,7 @@ public void AddMetricPusherService_WithZeroTimeInterval_ThrowsArgumentOutOfRange
         var servicesCollection = Substitute.For<IServiceCollection>();
         var metricPusher = Substitute.For<IMetricPusher>();
 
-        Action act = () => servicesCollection.AddMetricPusherService(metricPusher, TimeSpan.Zero);
+        Action act = () => servicesCollection.AddMetricPusherHostedService(metricPusher, TimeSpan.Zero);
 
         act.Should().Throw<ArgumentOutOfRangeException>();
     }
@@ -32,11 +32,11 @@ public void AddMetricPusherService_WithDefaultInterval_AddsMetricPusherServiceIn
         var servicesCollection = new ServiceCollection();
         var metricPusher = Substitute.For<IMetricPusher>();
 
-        servicesCollection.AddMetricPusherService(metricPusher);
+        servicesCollection.AddMetricPusherHostedService(metricPusher);
         var provider = servicesCollection.BuildServiceProvider();
         var service = provider.GetRequiredService<IHostedService>();
 
-        service.Should().BeOfType<MetricPusherService>();
+        service.Should().BeOfType<MetricPusherHostedService>();
     }
 
     [Fact]
@@ -45,10 +45,10 @@ public void AddMetricPusherService_WithValidParameterValues_AddsMetricPusherServ
         var servicesCollection = new ServiceCollection();
         var metricPusher = Substitute.For<IMetricPusher>();
 
-        servicesCollection.AddMetricPusherService(metricPusher, TimeSpan.FromSeconds(1));
+        servicesCollection.AddMetricPusherHostedService(metricPusher, TimeSpan.FromSeconds(1));
         var provider = servicesCollection.BuildServiceProvider();
         var service = provider.GetRequiredService<IHostedService>();
 
-        service.Should().BeOfType<MetricPusherService>();
+        service.Should().BeOfType<MetricPusherHostedService>();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@ namespace Prometheus.Client.MetricPusher.HostedService;`
`4`	`4`
`5`	`5`	`internal static class Defaults`
`6`	`6`	`{`
`7`		`- internal static TimeSpan Interval = TimeSpan.FromMilliseconds(1000);`
	`7`	`+ internal static TimeSpan PushInterval = TimeSpan.FromMilliseconds(1000);`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,20 +5,11 @@`
`5`	`5`
`6`	`6`	`namespace Prometheus.Client.MetricPusher.HostedService;`
`7`	`7`
`8`		`-public class MetricPusherService : BackgroundService`
	`8`	`+public class MetricPusherHostedService(IMetricPusher pusher, TimeSpan pushInterval) : BackgroundService`
`9`	`9`	`{`
`10`		`- private readonly IMetricPusher _pusher;`
`11`		`- private readonly TimeSpan _interval;`
`12`		`-`
`13`		`- public MetricPusherService(IMetricPusher pusher)`
`14`		`- : this(pusher, Defaults.Interval)`
`15`		`- {`
`16`		`- }`
`17`		`-`
`18`		`- public MetricPusherService(IMetricPusher pusher, TimeSpan interval)`
	`10`	`+ public MetricPusherHostedService(IMetricPusher pusher)`
	`11`	`+ : this(pusher, Defaults.PushInterval)`
`19`	`12`	`{`
`20`		`- _pusher = pusher;`
`21`		`- _interval = interval;`
`22`	`13`	`}`
`23`	`14`
`24`	`15`	`protected override async Task ExecuteAsync(CancellationToken stoppingToken)`
`@@ -28,7 +19,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)`
`28`	`19`	`await DoPushAsync();`
`29`	`20`	`try`
`30`	`21`	`{`
`31`		`- await Task.Delay(_interval, stoppingToken);`
	`22`	`+ await Task.Delay(pushInterval, stoppingToken);`
`32`	`23`	`}`
`33`	`24`	`catch (TaskCanceledException)`
`34`	`25`	`{`
`@@ -43,7 +34,7 @@ async Task DoPushAsync()`
`43`	`34`	`{`
`44`	`35`	`try`
`45`	`36`	`{`
`46`		`- await _pusher.PushAsync();`
	`37`	`+ await pusher.PushAsync();`
`47`	`38`	`}`
`48`	`39`	`catch (Exception)`
`49`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,19 +6,19 @@ namespace Prometheus.Client.MetricPusher.HostedService;`
`6`	`6`
`7`	`7`	`public static class ServiceCollectionExtensions`
`8`	`8`	`{`
`9`		`- public static IServiceCollection AddMetricPusherService(this IServiceCollection services, IMetricPusher pusher)`
	`9`	`+ public static IServiceCollection AddMetricPusherHostedService(this IServiceCollection services, IMetricPusher pusher)`
`10`	`10`	`{`
`11`		`- return AddMetricPusherService(services, pusher, Defaults.Interval);`
	`11`	`+ return AddMetricPusherHostedService(services, pusher, Defaults.PushInterval);`
`12`	`12`	`}`
`13`	`13`
`14`		`- public static IServiceCollection AddMetricPusherService(this IServiceCollection services, IMetricPusher pusher, TimeSpan interval)`
	`14`	`+ public static IServiceCollection AddMetricPusherHostedService(this IServiceCollection services, IMetricPusher pusher, TimeSpan pushInterval)`
`15`	`15`	`{`
`16`	`16`	`if (pusher == null)`
`17`	`17`	`throw new ArgumentNullException(nameof(pusher));`
`18`		`- if (interval == TimeSpan.Zero)`
`19`		`- throw new ArgumentOutOfRangeException(nameof(interval));`
	`18`	`+ if (pushInterval == TimeSpan.Zero)`
	`19`	`+ throw new ArgumentOutOfRangeException(nameof(pushInterval));`
`20`	`20`
`21`		`- services.AddSingleton<IHostedService, MetricPusherService>(_ => new MetricPusherService(pusher, interval));`
	`21`	`+ services.AddSingleton<IHostedService, MetricPusherHostedService>(_ => new MetricPusherHostedService(pusher, pushInterval));`
`22`	`22`
`23`	`23`	`return services;`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,14 +3,14 @@`
`3`	`3`
`4`	`4`	`namespace Prometheus.Client.MetricPusher.HostedService.Tests;`
`5`	`5`
`6`		`-public class ServiceCollecttionExtensionsTests`
	`6`	`+public class ServiceCollectionExtensionsTests`
`7`	`7`	`{`
`8`	`8`	`[Fact]`
`9`	`9`	`public void AddMetricPusherService_WithNullMetricPusher_ThrowsArgumentNullException()`
`10`	`10`	`{`
`11`	`11`	`var servicesCollection = Substitute.For<IServiceCollection>();`
`12`	`12`
`13`		`- Action act = () => servicesCollection.AddMetricPusherService(null, TimeSpan.FromSeconds(1));`
	`13`	`+ Action act = () => servicesCollection.AddMetricPusherHostedService(null, TimeSpan.FromSeconds(1));`
`14`	`14`
`15`	`15`	`act.Should().Throw<ArgumentNullException>();`
`16`	`16`	`}`
`@@ -21,7 +21,7 @@ public void AddMetricPusherService_WithZeroTimeInterval_ThrowsArgumentOutOfRange`
`21`	`21`	`var servicesCollection = Substitute.For<IServiceCollection>();`
`22`	`22`	`var metricPusher = Substitute.For<IMetricPusher>();`
`23`	`23`
`24`		`- Action act = () => servicesCollection.AddMetricPusherService(metricPusher, TimeSpan.Zero);`
	`24`	`+ Action act = () => servicesCollection.AddMetricPusherHostedService(metricPusher, TimeSpan.Zero);`
`25`	`25`
`26`	`26`	`act.Should().Throw<ArgumentOutOfRangeException>();`
`27`	`27`	`}`
`@@ -32,11 +32,11 @@ public void AddMetricPusherService_WithDefaultInterval_AddsMetricPusherServiceIn`
`32`	`32`	`var servicesCollection = new ServiceCollection();`
`33`	`33`	`var metricPusher = Substitute.For<IMetricPusher>();`
`34`	`34`
`35`		`- servicesCollection.AddMetricPusherService(metricPusher);`
	`35`	`+ servicesCollection.AddMetricPusherHostedService(metricPusher);`
`36`	`36`	`var provider = servicesCollection.BuildServiceProvider();`
`37`	`37`	`var service = provider.GetRequiredService<IHostedService>();`
`38`	`38`
`39`		`- service.Should().BeOfType<MetricPusherService>();`
	`39`	`+ service.Should().BeOfType<MetricPusherHostedService>();`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`[Fact]`
`@@ -45,10 +45,10 @@ public void AddMetricPusherService_WithValidParameterValues_AddsMetricPusherServ`
`45`	`45`	`var servicesCollection = new ServiceCollection();`
`46`	`46`	`var metricPusher = Substitute.For<IMetricPusher>();`
`47`	`47`
`48`		`- servicesCollection.AddMetricPusherService(metricPusher, TimeSpan.FromSeconds(1));`
	`48`	`+ servicesCollection.AddMetricPusherHostedService(metricPusher, TimeSpan.FromSeconds(1));`
`49`	`49`	`var provider = servicesCollection.BuildServiceProvider();`
`50`	`50`	`var service = provider.GetRequiredService<IHostedService>();`
`51`	`51`
`52`		`- service.Should().BeOfType<MetricPusherService>();`
	`52`	`+ service.Should().BeOfType<MetricPusherHostedService>();`
`53`	`53`	`}`
`54`	`54`	`}`