Skip to content

Commit 8eb0e8d

Browse files
followynnefollowynne
authored
chore: release serilog-ui 2.6.0 (#110)
1 parent 86af828 commit 8eb0e8d

File tree

26 files changed

+367
-239
lines changed

26 files changed

+367
-239
lines changed

‎samples/SampleWebApp/SampleWebApp.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
<ItemGroup>
3131
<ProjectReference Include="..\..\src\Serilog.Ui.MsSqlServerProvider\Serilog.Ui.MsSqlServerProvider.csproj"/>
3232
<ProjectReference Include="..\..\src\Serilog.Ui.Web\Serilog.Ui.Web.csproj"/>
33+
<ProjectReference Include="..\..\src\Serilog.Ui.Core\Serilog.Ui.Core.csproj"/>
3334
</ItemGroup>
3435

3536
</Project>

‎src/Serilog.Ui.Core/AggregateDataProvider.cs

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,26 @@
22
using System.Collections.Generic;
33
using System.Linq;
44
using System.Threading.Tasks;
5+
using Ardalis.GuardClauses;
56

67
namespace Serilog.Ui.Core
78
{
89
/// <summary>
9-
/// Aggregates multiple <see cref="IDataProvider"/> into one instance.
10+
/// Aggregates multiple <see cref="IDataProvider"/> into one instance.
1011
/// </summary>
1112
public class AggregateDataProvider : IDataProvider
1213
{
13-
private IDataProvider _selectedDataProvider;
14-
private readonly Dictionary<string, IDataProvider> _dataProviders = new Dictionary<string, IDataProvider>();
14+
private readonly Dictionary<string, IDataProvider> _dataProviders = new();
1515

16+
/// <summary>
17+
/// It creates an instance of <see cref="AggregateDataProvider"/>.
18+
/// </summary>
19+
/// <param name="dataProviders">IEnumerable of providers.</param>
20+
/// <exception cref="ArgumentNullException">when <paramref name="dataProviders"/> is null</exception>
21+
/// <exception cref="ArgumentException">when <paramref name="dataProviders"/> is empty</exception>
1622
public AggregateDataProvider(IEnumerable<IDataProvider> dataProviders)
1723
{
18-
if (dataProviders == null)
19-
throw new ArgumentNullException(nameof(dataProviders));
24+
Guard.Against.NullOrEmpty(dataProviders, nameof(dataProviders));
2025

2126
foreach (var grouped in dataProviders.GroupBy(dp => dp.Name, p => p, (k, e) => e.ToList()))
2227
{
@@ -39,25 +44,33 @@ public AggregateDataProvider(IEnumerable<IDataProvider> dataProviders)
3944
}
4045
}
4146

42-
_selectedDataProvider = _dataProviders.First(c => true).Value;
47+
SelectedDataProvider = _dataProviders.First().Value;
4348
}
4449

4550
/// <summary>
46-
/// <inheritdoc cref="IDataProvider.Name"/> NOTE We assume only one Aggregate provider, so
47-
/// the name is static.
51+
/// <inheritdoc cref="IDataProvider.Name"/>
52+
/// NOTE: We assume only one Aggregate provider, so the name is static.
4853
/// </summary>
4954
public string Name => nameof(AggregateDataProvider);
5055

5156
/// <summary>
52-
/// If there is only one data provider, this is it. If there are multiple, this is the
53-
/// current data provider.
57+
/// If there is only one data provider, this is it.
58+
/// If there are multiple, this is the current data provider.
5459
/// </summary>
55-
public IDataProvider SelectedDataProvider => _selectedDataProvider;
60+
private IDataProvider SelectedDataProvider { get; set; }
5661

57-
public void SwitchToProvider(string key) => _selectedDataProvider = _dataProviders[key];
62+
/// <summary>
63+
/// Switch active data provider by key.
64+
/// </summary>
65+
/// <param name="key">Data provider key</param>
66+
public void SwitchToProvider(string key) => SelectedDataProvider = _dataProviders[key];
5867

68+
/// <summary>
69+
/// Existing data providers keys.
70+
/// </summary>
5971
public IEnumerable<string> Keys => _dataProviders.Keys;
6072

73+
/// <inheritdoc/>
6174
public Task<(IEnumerable<LogModel>, int)> FetchDataAsync(
6275
int page,
6376
int count,

‎src/Serilog.Ui.Core/Extensions/RelationalDbOptionsExtensions.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
11
namespace Serilog.Ui.Core
22
{
3+
/// <summary>
4+
/// Relational Db Options extensions.
5+
/// </summary>
36
public static class RelationalDbOptionsExtensions
47
{
8+
/// <summary>
9+
/// Generates a complete data provider name, by using its properties.
10+
/// </summary>
11+
/// <param name="options"><see cref="RelationalDbOptions"/></param>
12+
/// <param name="providerName">Data provider name.</param>
13+
/// <returns></returns>
514
public static string ToDataProviderName(this RelationalDbOptions options, string providerName)
615
=> string.Join(".", providerName, options.Schema, options.TableName);
716
}

‎src/Serilog.Ui.Core/Models/LogModel.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,44 @@
22

33
namespace Serilog.Ui.Core
44
{
5+
/// <summary>
6+
/// Log Model class.
7+
/// </summary>
58
public class LogModel
69
{
10+
/// <summary>
11+
/// It gets or sets RowNo.
12+
/// </summary>
713
public virtual int RowNo { get; set; }
814

15+
/// <summary>
16+
/// It gets or sets Level.
17+
/// </summary>
918
public virtual string Level { get; set; }
1019

20+
/// <summary>
21+
/// It gets or sets Message.
22+
/// </summary>
1123
public virtual string Message { get; set; }
1224

25+
/// <summary>
26+
/// It gets or sets Timestamp.
27+
/// </summary>
1328
public virtual DateTime Timestamp { get; set; }
1429

30+
/// <summary>
31+
/// It gets or sets Exception.
32+
/// </summary>
1533
public virtual string Exception { get; set; }
1634

35+
/// <summary>
36+
/// It gets or sets Properties.
37+
/// </summary>
1738
public virtual string Properties { get; set; }
1839

40+
/// <summary>
41+
/// It gets or sets PropertyType.
42+
/// </summary>
1943
public virtual string PropertyType { get; set; }
2044
}
2145
}

‎src/Serilog.Ui.Core/OptionsBuilder/RelationalDbOptions.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
11
namespace Serilog.Ui.Core
22
{
3+
/// <summary>
4+
/// RelationDbOptions class
5+
/// </summary>
36
public class RelationalDbOptions
47
{
8+
/// <summary>
9+
/// It gets or sets ConnectionString.
10+
/// </summary>
511
public string ConnectionString { get; set; }
612

13+
/// <summary>
14+
/// It gets or sets TableName.
15+
/// </summary>
716
public string TableName { get; set; }
817

18+
/// <summary>
19+
/// It gets or sets Schema.
20+
/// </summary>
921
public string Schema { get; set; }
1022
}
1123
}

‎src/Serilog.Ui.Core/OptionsBuilder/SerilogUiOptionsBuilder.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,18 @@
22

33
namespace Serilog.Ui.Core
44
{
5+
/// <summary>
6+
/// SerilogUi OptionsBuilder class, used during app services registration.
7+
/// Implements <see cref="ISerilogUiOptionsBuilder"/>.
8+
/// </summary>
59
public class SerilogUiOptionsBuilder : ISerilogUiOptionsBuilder
610
{
711
private readonly IServiceCollection _services;
812

13+
/// <summary>
14+
/// It creates an instance of <see cref="SerilogUiOptionsBuilder"/>.
15+
/// </summary>
16+
/// <param name="services">Service collection.</param>
917
public SerilogUiOptionsBuilder(IServiceCollection services)
1018
{
1119
_services = services;

‎src/Serilog.Ui.Core/Serilog.Ui.Core.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<TargetFramework>netstandard2.0</TargetFramework>
44
<GenerateDocumentationFile>True</GenerateDocumentationFile>
55
<LangVersion>latest</LangVersion>
6-
<Version>2.5.0</Version>
6+
<Version>2.6.0</Version>
77
</PropertyGroup>
88

99
<ItemGroup>

‎src/Serilog.Ui.ElasticSearchProvider/Serilog.Ui.ElasticSearchProvider.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@
1212
</ItemGroup>
1313

1414
<ItemGroup>
15-
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" />
15+
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" PrivateAssets="all" />
1616
</ItemGroup>
1717
</Project>

‎src/Serilog.Ui.MongoDbProvider/Serilog.Ui.MongoDbProvider.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@
1313
</ItemGroup>
1414

1515
<ItemGroup>
16-
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" />
16+
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" PrivateAssets="all" />
1717
</ItemGroup>
1818
</Project>

‎src/Serilog.Ui.MsSqlServerProvider/package-lock.json

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Serilog.Ui.MySqlProvider/Serilog.Ui.MySqlProvider.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
<PropertyGroup>
44
<TargetFramework>netstandard2.0</TargetFramework>
5-
<LangVersion>latest</LangVersion>
6-
<Version>2.2.1</Version>
5+
<LangVersion>latest</LangVersion>
6+
<Version>2.2.1</Version>
77
</PropertyGroup>
88

99
<ItemGroup>
@@ -12,6 +12,6 @@
1212
</ItemGroup>
1313

1414
<ItemGroup>
15-
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" />
15+
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" PrivateAssets="all" />
1616
</ItemGroup>
1717
</Project>

‎src/Serilog.Ui.PostgreSqlProvider/Extensions/PostgreSqlDbOptions.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
namespace Serilog.Ui.PostgreSqlProvider;
44

5+
/// <inheritdoc/> - Postgres implementation
56
public class PostgreSqlDbOptions : RelationalDbOptions
67
{
8+
/// <summary>
9+
/// It gets or sets SinkType.
10+
/// </summary>
711
public PostgreSqlSinkType SinkType { get; set; }
812
}

‎src/Serilog.Ui.PostgreSqlProvider/Extensions/PostgreSqlSinkType.cs

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
1-
namespace Serilog.Ui.PostgreSqlProvider;
1+
// ReSharper disable InconsistentNaming
2+
namespace Serilog.Ui.PostgreSqlProvider;
23

4+
/// <summary>
5+
/// Available Postgres sink types.
6+
/// </summary>
37
public enum PostgreSqlSinkType
48
{
9+
/// <remarks>
10+
/// <a href="https://github.com/b00ted/serilog-sinks-postgresql">Sink</a>
11+
/// </remarks>
512
SerilogSinksPostgreSQL,
6-
13+
/// <remarks>
14+
/// <a href="https://github.com/serilog-contrib/Serilog.Sinks.Postgresql.Alternative">Sink</a>
15+
/// </remarks>
716
SerilogSinksPostgreSQLAlternative
817
}

‎src/Serilog.Ui.PostgreSqlProvider/PostgreDataProvider.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@
1010

1111
namespace Serilog.Ui.PostgreSqlProvider;
1212

13+
/// <inheritdoc/>
1314
public class PostgresDataProvider(PostgreSqlDbOptions options) : IDataProvider
1415
{
16+
/// <inheritdoc/>
1517
public string Name => options.ToDataProviderName("NPGSQL");
1618

19+
/// <inheritdoc/>
1720
public async Task<(IEnumerable<LogModel>, int)> FetchDataAsync(
1821
int page,
1922
int count,

‎src/Serilog.Ui.PostgreSqlProvider/Serilog.Ui.PostgreSqlProvider.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</ItemGroup>
1414

1515
<ItemGroup>
16-
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" />
16+
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" PrivateAssets="all" />
1717
<InternalsVisibleTo Include="Postgres.Tests" />
1818
</ItemGroup>
1919
</Project>

‎src/Serilog.Ui.Web/Endpoints/SerilogUiEndpoints.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ private static (int currPage, int count, string dbKey, string level, string text
122122
/// <returns></returns>
123123
private Task OnError(HttpContext httpContext, Exception ex)
124124
{
125-
_logger.LogError(ex, "@Message", ex.Message);
125+
_logger.LogError(ex, "{Message}", ex.Message);
126126

127127
httpContext.Response.StatusCode = (int) HttpStatusCode.InternalServerError;
128128
httpContext.Response.ContentType = "application/problem+json";

‎src/Serilog.Ui.Web/Extensions/ServiceCollectionExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public static IServiceCollection AddSerilogUi(this IServiceCollection services,
4040
services.AddScoped<ISerilogUiAppRoutes, SerilogUiAppRoutes>();
4141
services.Decorate<ISerilogUiAppRoutes, SerilogUiAppRoutesDecorator>();
4242

43-
services.TryAddScoped(typeof(AggregateDataProvider));
43+
services.TryAddScoped<AggregateDataProvider>();
4444

4545
return services;
4646
}

‎src/Serilog.Ui.Web/Serilog.Ui.Web.csproj

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
4+
<PackageId>Serilog.UI</PackageId>
45
<TargetFrameworks>netcoreapp3.1;net5.0;net6.0;net7.0</TargetFrameworks>
56
<LangVersion>latest</LangVersion>
6-
<Version>2.5.1</Version>
7+
<Version>2.6.0</Version>
78
</PropertyGroup>
89

910
<ItemGroup>
@@ -15,7 +16,7 @@
1516
</ItemGroup>
1617

1718
<ItemGroup>
18-
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" />
19+
<ProjectReference Include="..\Serilog.Ui.Core\Serilog.Ui.Core.csproj" PrivateAssets="all"/>
1920
</ItemGroup>
2021

2122
<ItemGroup>

0 commit comments

Comments
 (0)