diff --git a/Client.Wasm/Components/StudentCard.razor b/Client.Wasm/Components/StudentCard.razor index 661f1181..99f51686 100644 --- a/Client.Wasm/Components/StudentCard.razor +++ b/Client.Wasm/Components/StudentCard.razor @@ -4,10 +4,10 @@ - Номер №X "Название лабораторной" - Вариант №Х "Название варианта" - Выполнена Фамилией Именем 65ХХ - Ссылка на форк + Номер №1 "Кэширование" + Вариант №46 "Программный проект" + Выполнена Митеревым Дмитрием 6513 + Ссылка на форк diff --git a/Client.Wasm/Properties/launchSettings.json b/Client.Wasm/Properties/launchSettings.json index 0d824ea7..60120ec3 100644 --- a/Client.Wasm/Properties/launchSettings.json +++ b/Client.Wasm/Properties/launchSettings.json @@ -12,7 +12,7 @@ "http": { "commandName": "Project", "dotnetRunMessages": true, - "launchBrowser": true, + "launchBrowser": false, "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}", "applicationUrl": "http://localhost:5127", "environmentVariables": { @@ -22,7 +22,7 @@ "https": { "commandName": "Project", "dotnetRunMessages": true, - "launchBrowser": true, + "launchBrowser": false, "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}", "applicationUrl": "https://localhost:7282;http://localhost:5127", "environmentVariables": { @@ -31,7 +31,7 @@ }, "IIS Express": { "commandName": "IISExpress", - "launchBrowser": true, + "launchBrowser": false, "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" diff --git a/Client.Wasm/wwwroot/appsettings.json b/Client.Wasm/wwwroot/appsettings.json index d1fe7ab3..73bfc85c 100644 --- a/Client.Wasm/wwwroot/appsettings.json +++ b/Client.Wasm/wwwroot/appsettings.json @@ -6,5 +6,5 @@ } }, "AllowedHosts": "*", - "BaseAddress": "" + "BaseAddress": "https://localhost:7046/generate" } diff --git a/CloudDevelopment.sln b/CloudDevelopment.sln index cb48241d..74a417a9 100644 --- a/CloudDevelopment.sln +++ b/CloudDevelopment.sln @@ -5,6 +5,14 @@ VisualStudioVersion = 17.14.36811.4 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Client.Wasm", "Client.Wasm\Client.Wasm.csproj", "{AE7EEA74-2FE0-136F-D797-854FD87E022A}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ProjectGenerator.AppHost", "ProjectGenerator\ProjectGenerator.AppHost\ProjectGenerator.AppHost.csproj", "{2BD86B8F-8507-43F0-B17F-9607B7352733}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ProjectGenerator.ServiceDefaults", "ProjectGenerator\ProjectGenerator.ServiceDefaults\ProjectGenerator.ServiceDefaults.csproj", "{8F9985A2-9D06-28F9-3428-8039644EF545}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ProjectGenerator.Api", "ProjectGenerator.Api\ProjectGenerator.Api.csproj", "{AAEE18D8-2A8E-7273-1128-2FA0B1FA40F9}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ProjectGenerator.Domain", "ProjectGenerator.Domain\ProjectGenerator.Domain.csproj", "{67E00678-695C-407F-B401-27C9EC3527B1}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -15,6 +23,22 @@ Global {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Debug|Any CPU.Build.0 = Debug|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|Any CPU.ActiveCfg = Release|Any CPU {AE7EEA74-2FE0-136F-D797-854FD87E022A}.Release|Any CPU.Build.0 = Release|Any CPU + {2BD86B8F-8507-43F0-B17F-9607B7352733}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2BD86B8F-8507-43F0-B17F-9607B7352733}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2BD86B8F-8507-43F0-B17F-9607B7352733}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2BD86B8F-8507-43F0-B17F-9607B7352733}.Release|Any CPU.Build.0 = Release|Any CPU + {8F9985A2-9D06-28F9-3428-8039644EF545}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8F9985A2-9D06-28F9-3428-8039644EF545}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8F9985A2-9D06-28F9-3428-8039644EF545}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8F9985A2-9D06-28F9-3428-8039644EF545}.Release|Any CPU.Build.0 = Release|Any CPU + {AAEE18D8-2A8E-7273-1128-2FA0B1FA40F9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {AAEE18D8-2A8E-7273-1128-2FA0B1FA40F9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AAEE18D8-2A8E-7273-1128-2FA0B1FA40F9}.Release|Any CPU.ActiveCfg = Release|Any CPU + {AAEE18D8-2A8E-7273-1128-2FA0B1FA40F9}.Release|Any CPU.Build.0 = Release|Any CPU + {67E00678-695C-407F-B401-27C9EC3527B1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {67E00678-695C-407F-B401-27C9EC3527B1}.Debug|Any CPU.Build.0 = Debug|Any CPU + {67E00678-695C-407F-B401-27C9EC3527B1}.Release|Any CPU.ActiveCfg = Release|Any CPU + {67E00678-695C-407F-B401-27C9EC3527B1}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/ProjectGenerator.Api/Program.cs b/ProjectGenerator.Api/Program.cs new file mode 100644 index 00000000..ff5dd71b --- /dev/null +++ b/ProjectGenerator.Api/Program.cs @@ -0,0 +1,30 @@ +using ProjectGenerator.Api.Services; + +var builder = WebApplication.CreateBuilder(args); + +builder.AddServiceDefaults(); +builder.AddRedisDistributedCache("cache"); + +builder.Services.AddSingleton(); +builder.Services.AddScoped(); + +var trustedUrls = builder.Configuration.GetSection("CorsOrigins").Get() ?? []; +builder.Services.AddCors(options => +{ + options.AddDefaultPolicy(policy => + { + policy.WithOrigins(trustedUrls) + .WithMethods("GET") + .WithHeaders("Content-Type"); + }); +}); + +var app = builder.Build(); + +app.MapDefaultEndpoints(); +app.UseCors(); + +app.MapGet("/generate", async (int id, ISoftwareProjectService service) => + await service.GetOrGenerate(id)); + +app.Run(); diff --git a/ProjectGenerator.Api/ProjectGenerator.Api.csproj b/ProjectGenerator.Api/ProjectGenerator.Api.csproj new file mode 100644 index 00000000..3c878a17 --- /dev/null +++ b/ProjectGenerator.Api/ProjectGenerator.Api.csproj @@ -0,0 +1,23 @@ + + + + net8.0 + enable + enable + + + + + + + + + + + + + + + + + diff --git a/ProjectGenerator.Api/Properties/launchSettings.json b/ProjectGenerator.Api/Properties/launchSettings.json new file mode 100644 index 00000000..553903db --- /dev/null +++ b/ProjectGenerator.Api/Properties/launchSettings.json @@ -0,0 +1,38 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:10098", + "sslPort": 44392 + } + }, + "profiles": { + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:5283", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:7046;http://localhost:5283", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + } +} diff --git a/ProjectGenerator.Api/Services/ISoftwareProjectGenerator.cs b/ProjectGenerator.Api/Services/ISoftwareProjectGenerator.cs new file mode 100644 index 00000000..d5845502 --- /dev/null +++ b/ProjectGenerator.Api/Services/ISoftwareProjectGenerator.cs @@ -0,0 +1,14 @@ +using ProjectGenerator.Domain.Models; + +namespace ProjectGenerator.Api.Services; + +/// +/// Интерфейс генератора программных проектов +/// +public interface ISoftwareProjectGenerator +{ + /// + /// Генерирует программный проект с указанным идентификатором + /// + public SoftwareProject Generate(int id); +} diff --git a/ProjectGenerator.Api/Services/ISoftwareProjectService.cs b/ProjectGenerator.Api/Services/ISoftwareProjectService.cs new file mode 100644 index 00000000..26644fbc --- /dev/null +++ b/ProjectGenerator.Api/Services/ISoftwareProjectService.cs @@ -0,0 +1,14 @@ +using ProjectGenerator.Domain.Models; + +namespace ProjectGenerator.Api.Services; + +/// +/// Интерфейс сервиса программных проектов +/// +public interface ISoftwareProjectService +{ + /// + /// Получает программный проект по идентификатору из кэша или генерирует новый + /// + public Task GetOrGenerate(int id); +} diff --git a/ProjectGenerator.Api/Services/SoftwareProjectGenerator.cs b/ProjectGenerator.Api/Services/SoftwareProjectGenerator.cs new file mode 100644 index 00000000..fd38e8ab --- /dev/null +++ b/ProjectGenerator.Api/Services/SoftwareProjectGenerator.cs @@ -0,0 +1,62 @@ +using Bogus; +using Bogus.DataSets; +using ProjectGenerator.Domain.Models; + +namespace ProjectGenerator.Api.Services; + +/// +/// Генератор программных проектов на основе Bogus +/// +public class SoftwareProjectGenerator : ISoftwareProjectGenerator +{ + private readonly Faker _faker = new Faker("ru") + .RuleFor(p => p.Id, _ => 0) + .RuleFor(p => p.ProjectName, f => + $"{f.Commerce.ProductName()} {f.Hacker.Adjective()} {f.Finance.AccountName()} {f.Lorem.Word()}") + .RuleFor(p => p.Customer, f => f.Company.CompanyName()) + .RuleFor(p => p.ProjectManager, f => + { + var gender = f.PickRandom(); + return + $"{f.Name.LastName(gender)} {f.Name.FirstName(gender)} " + + $"{GeneratePatronymic(f.Name.FirstName(Name.Gender.Male), gender == Name.Gender.Female)}"; + }) + .RuleFor(p => p.StartDate, f => + DateOnly.FromDateTime(f.Date.Past(2))) + .RuleFor(p => p.PlannedEndDate, (f, p) => + p.StartDate.AddDays(f.Random.Int(30, 365))) + .RuleFor(p => p.ActualEndDate, (f, p) => + f.Random.Bool(0.3f) + ? p.StartDate.AddDays(f.Random.Int(10, 400)) + : null) + .RuleFor(p => p.Budget, f => + Math.Round(f.Finance.Amount(100_000, 100_000_000), 2)) + .RuleFor(p => p.ActualCosts, (f, p) => + Math.Round(p.Budget * f.Random.Decimal(0.01m, 1.2m), 2)) + .RuleFor(p => p.CompletionPercentage, (f, p) => + p.ActualEndDate.HasValue ? 100 : f.Random.Int(0, 99)); + + /// + /// Генерация отчества на основе мужского имени + /// + /// Мужское имя + /// Признак женского пола + /// Отчество + private static string GeneratePatronymic(string maleName, bool isFemale) => maleName switch + { + _ when maleName.EndsWith("ий") => maleName[..^2] + (isFemale ? "ьевна" : "ьевич"), + _ when maleName.EndsWith('ь') => maleName[..^1] + (isFemale ? "евна" : "евич"), + _ when maleName.EndsWith('й') => maleName[..^1] + (isFemale ? "евна" : "евич"), + _ when maleName.EndsWith('а') || maleName.EndsWith('я') => maleName[..^1] + (isFemale ? "ична" : "ич"), + _ => maleName + (isFemale ? "овна" : "ович") + }; + + /// + public SoftwareProject Generate(int id) + { + var project = _faker.Generate(); + project.Id = id; + return project; + } + +} diff --git a/ProjectGenerator.Api/Services/SoftwareProjectService.cs b/ProjectGenerator.Api/Services/SoftwareProjectService.cs new file mode 100644 index 00000000..02b23937 --- /dev/null +++ b/ProjectGenerator.Api/Services/SoftwareProjectService.cs @@ -0,0 +1,90 @@ +using System.Text.Json; +using Microsoft.Extensions.Caching.Distributed; +using ProjectGenerator.Domain.Models; + +namespace ProjectGenerator.Api.Services; + +/// +/// Сервис программных проектов с кэшированием +/// +/// Генератор программных проектов +/// Распределённый кэш +/// Конфигурация приложения +/// Логгер +public class SoftwareProjectService( + ISoftwareProjectGenerator generator, + IDistributedCache cache, + IConfiguration configuration, + ILogger logger) : ISoftwareProjectService +{ + private const string CacheKeyPrefix = "software-project"; + private readonly TimeSpan _cacheTtl = TimeSpan.FromMinutes(configuration.GetValue("CacheTtlMinutes", 15)); + + /// + public async Task GetOrGenerate(int id) + { + var cacheKey = $"{CacheKeyPrefix}:{id}"; + + var cached = await GetFromCache(cacheKey); + if (cached is not null) + { + return cached; + } + + logger.LogInformation("Cache miss for id {Id}, generating new data", id); + + var project = generator.Generate(id); + + await SetToCache(cacheKey, project); + + return project; + } + + /// + /// Получение программного проекта из кэша + /// + /// Ключ кэша + /// Программный проект или null + private async Task GetFromCache(string cacheKey) + { + try + { + var cached = await cache.GetStringAsync(cacheKey); + if (cached is null) + { + return null; + } + + logger.LogInformation("Cache hit for key {CacheKey}", cacheKey); + return JsonSerializer.Deserialize(cached); + } + catch (Exception ex) + { + logger.LogWarning(ex, "Failed to read from cache for key {CacheKey}", cacheKey); + return null; + } + } + + /// + /// Сохранение программного проекта в кэш + /// + /// Ключ кэша + /// Программный проект + private async Task SetToCache(string cacheKey, SoftwareProject project) + { + try + { + var json = JsonSerializer.Serialize(project); + await cache.SetStringAsync(cacheKey, json, new DistributedCacheEntryOptions + { + AbsoluteExpirationRelativeToNow = _cacheTtl + }); + + logger.LogInformation("Cached data for key {CacheKey}", cacheKey); + } + catch (Exception ex) + { + logger.LogWarning(ex, "Failed to write to cache for key {CacheKey}", cacheKey); + } + } +} diff --git a/ProjectGenerator.Api/appsettings.Development.json b/ProjectGenerator.Api/appsettings.Development.json new file mode 100644 index 00000000..0c208ae9 --- /dev/null +++ b/ProjectGenerator.Api/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/ProjectGenerator.Api/appsettings.json b/ProjectGenerator.Api/appsettings.json new file mode 100644 index 00000000..999a7fc3 --- /dev/null +++ b/ProjectGenerator.Api/appsettings.json @@ -0,0 +1,14 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*", + "CacheTtlMinutes": 15, + "CorsOrigins": [ + "http://localhost:5127", + "https://localhost:7282" + ] +} diff --git a/ProjectGenerator.Domain/Models/SoftwareProject.cs b/ProjectGenerator.Domain/Models/SoftwareProject.cs new file mode 100644 index 00000000..23c86aea --- /dev/null +++ b/ProjectGenerator.Domain/Models/SoftwareProject.cs @@ -0,0 +1,57 @@ +namespace ProjectGenerator.Domain.Models; + +/// +/// Программный проект +/// +public sealed class SoftwareProject +{ + /// + /// Идентификатор в системе + /// + public int Id { get; set; } + + /// + /// Название проекта + /// + public required string ProjectName { get; init; } + + /// + /// Заказчик проекта + /// + public required string Customer { get; init; } + + /// + /// Менеджер проекта + /// + public required string ProjectManager { get; init; } + + /// + /// Дата начала + /// + public DateOnly StartDate { get; init; } + + /// + /// Плановая дата завершения + /// + public DateOnly PlannedEndDate { get; init; } + + /// + /// Фактическая дата завершения + /// + public DateOnly? ActualEndDate { get; init; } + + /// + /// Бюджет + /// + public decimal Budget { get; init; } + + /// + /// Фактические затраты + /// + public decimal ActualCosts { get; init; } + + /// + /// Процент выполнения + /// + public int CompletionPercentage { get; init; } +} diff --git a/ProjectGenerator.Domain/ProjectGenerator.Domain.csproj b/ProjectGenerator.Domain/ProjectGenerator.Domain.csproj new file mode 100644 index 00000000..c60e6513 --- /dev/null +++ b/ProjectGenerator.Domain/ProjectGenerator.Domain.csproj @@ -0,0 +1,13 @@ + + + + net8.0 + enable + enable + + + + + + + diff --git a/ProjectGenerator/ProjectGenerator.AppHost/AppHost.cs b/ProjectGenerator/ProjectGenerator.AppHost/AppHost.cs new file mode 100644 index 00000000..d9fe117c --- /dev/null +++ b/ProjectGenerator/ProjectGenerator.AppHost/AppHost.cs @@ -0,0 +1,13 @@ +var builder = DistributedApplication.CreateBuilder(args); + +var cache = builder.AddRedis("cache") + .WithRedisInsight(); + +var generationApi = builder.AddProject("generation-api") + .WithReference(cache) + .WaitFor(cache); + +builder.AddProject("client-wasm") + .WaitFor(generationApi); + +builder.Build().Run(); diff --git a/ProjectGenerator/ProjectGenerator.AppHost/ProjectGenerator.AppHost.csproj b/ProjectGenerator/ProjectGenerator.AppHost/ProjectGenerator.AppHost.csproj new file mode 100644 index 00000000..107191af --- /dev/null +++ b/ProjectGenerator/ProjectGenerator.AppHost/ProjectGenerator.AppHost.csproj @@ -0,0 +1,23 @@ + + + + + + Exe + net8.0 + enable + enable + 5f0fcf55-56c6-4723-953b-9e24de107d8f + + + + + + + + + + + + + diff --git a/ProjectGenerator/ProjectGenerator.AppHost/Properties/launchSettings.json b/ProjectGenerator/ProjectGenerator.AppHost/Properties/launchSettings.json new file mode 100644 index 00000000..475d465e --- /dev/null +++ b/ProjectGenerator/ProjectGenerator.AppHost/Properties/launchSettings.json @@ -0,0 +1,29 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "profiles": { + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:17246;http://localhost:15108", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21233", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22087" + } + }, + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:15108", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19053", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20103" + } + } + } +} diff --git a/ProjectGenerator/ProjectGenerator.AppHost/appsettings.Development.json b/ProjectGenerator/ProjectGenerator.AppHost/appsettings.Development.json new file mode 100644 index 00000000..0c208ae9 --- /dev/null +++ b/ProjectGenerator/ProjectGenerator.AppHost/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/ProjectGenerator/ProjectGenerator.AppHost/appsettings.json b/ProjectGenerator/ProjectGenerator.AppHost/appsettings.json new file mode 100644 index 00000000..31c092aa --- /dev/null +++ b/ProjectGenerator/ProjectGenerator.AppHost/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning", + "Aspire.Hosting.Dcp": "Warning" + } + } +} diff --git a/ProjectGenerator/ProjectGenerator.ServiceDefaults/Extensions.cs b/ProjectGenerator/ProjectGenerator.ServiceDefaults/Extensions.cs new file mode 100644 index 00000000..b72c8753 --- /dev/null +++ b/ProjectGenerator/ProjectGenerator.ServiceDefaults/Extensions.cs @@ -0,0 +1,127 @@ +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Diagnostics.HealthChecks; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Diagnostics.HealthChecks; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.ServiceDiscovery; +using OpenTelemetry; +using OpenTelemetry.Metrics; +using OpenTelemetry.Trace; + +namespace Microsoft.Extensions.Hosting; + +// Adds common Aspire services: service discovery, resilience, health checks, and OpenTelemetry. +// This project should be referenced by each service project in your solution. +// To learn more about using this project, see https://aka.ms/dotnet/aspire/service-defaults +public static class Extensions +{ + private const string HealthEndpointPath = "/health"; + private const string AlivenessEndpointPath = "/alive"; + + public static TBuilder AddServiceDefaults(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.ConfigureOpenTelemetry(); + + builder.AddDefaultHealthChecks(); + + builder.Services.AddServiceDiscovery(); + + builder.Services.ConfigureHttpClientDefaults(http => + { + // Turn on resilience by default + http.AddStandardResilienceHandler(); + + // Turn on service discovery by default + http.AddServiceDiscovery(); + }); + + // Uncomment the following to restrict the allowed schemes for service discovery. + // builder.Services.Configure(options => + // { + // options.AllowedSchemes = ["https"]; + // }); + + return builder; + } + + public static TBuilder ConfigureOpenTelemetry(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Logging.AddOpenTelemetry(logging => + { + logging.IncludeFormattedMessage = true; + logging.IncludeScopes = true; + }); + + builder.Services.AddOpenTelemetry() + .WithMetrics(metrics => + { + metrics.AddAspNetCoreInstrumentation() + .AddHttpClientInstrumentation() + .AddRuntimeInstrumentation(); + }) + .WithTracing(tracing => + { + tracing.AddSource(builder.Environment.ApplicationName) + .AddAspNetCoreInstrumentation(tracing => + // Exclude health check requests from tracing + tracing.Filter = context => + !context.Request.Path.StartsWithSegments(HealthEndpointPath) + && !context.Request.Path.StartsWithSegments(AlivenessEndpointPath) + ) + // Uncomment the following line to enable gRPC instrumentation (requires the OpenTelemetry.Instrumentation.GrpcNetClient package) + //.AddGrpcClientInstrumentation() + .AddHttpClientInstrumentation(); + }); + + builder.AddOpenTelemetryExporters(); + + return builder; + } + + private static TBuilder AddOpenTelemetryExporters(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + var useOtlpExporter = !string.IsNullOrWhiteSpace(builder.Configuration["OTEL_EXPORTER_OTLP_ENDPOINT"]); + + if (useOtlpExporter) + { + builder.Services.AddOpenTelemetry().UseOtlpExporter(); + } + + // Uncomment the following lines to enable the Azure Monitor exporter (requires the Azure.Monitor.OpenTelemetry.AspNetCore package) + //if (!string.IsNullOrEmpty(builder.Configuration["APPLICATIONINSIGHTS_CONNECTION_STRING"])) + //{ + // builder.Services.AddOpenTelemetry() + // .UseAzureMonitor(); + //} + + return builder; + } + + public static TBuilder AddDefaultHealthChecks(this TBuilder builder) where TBuilder : IHostApplicationBuilder + { + builder.Services.AddHealthChecks() + // Add a default liveness check to ensure app is responsive + .AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]); + + return builder; + } + + public static WebApplication MapDefaultEndpoints(this WebApplication app) + { + // Adding health checks endpoints to applications in non-development environments has security implications. + // See https://aka.ms/dotnet/aspire/healthchecks for details before enabling these endpoints in non-development environments. + if (app.Environment.IsDevelopment()) + { + // All health checks must pass for app to be considered ready to accept traffic after starting + app.MapHealthChecks(HealthEndpointPath); + + // Only health checks tagged with the "live" tag must pass for app to be considered alive + app.MapHealthChecks(AlivenessEndpointPath, new HealthCheckOptions + { + Predicate = r => r.Tags.Contains("live") + }); + } + + return app; + } +} diff --git a/ProjectGenerator/ProjectGenerator.ServiceDefaults/ProjectGenerator.ServiceDefaults.csproj b/ProjectGenerator/ProjectGenerator.ServiceDefaults/ProjectGenerator.ServiceDefaults.csproj new file mode 100644 index 00000000..1b6e209a --- /dev/null +++ b/ProjectGenerator/ProjectGenerator.ServiceDefaults/ProjectGenerator.ServiceDefaults.csproj @@ -0,0 +1,22 @@ + + + + net8.0 + enable + enable + true + + + + + + + + + + + + + + + diff --git a/README.md b/README.md index dcaa5eb7..1e361231 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,36 @@ -# Современные технологии разработки программного обеспечения -[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing) +# Лабораторная работа №1 — Кэширование -## Задание -### Цель -Реализация проекта микросервисного бекенда. +## Описание -### Задачи -* Реализация межсервисной коммуникации, -* Изучение работы с брокерами сообщений, -* Изучение архитектурных паттернов, -* Изучение работы со средствами оркестрации на примере .NET Aspire, -* Повторение основ работы с системами контроля версий, -* Интеграционное тестирование. +Реализация сервиса генерации контрактов предметной области «Программный проект» с кэшированием ответов через Redis. -### Лабораторные работы -
-1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов -
- -В рамках первой лабораторной работы необходимо: -* Реализовать сервис генерации контрактов на основе Bogus, -* Реализовать кеширование при помощи IDistributedCache и Redis, -* Реализовать структурное логирование сервиса генерации, -* Настроить оркестрацию Aspire. - -
-
-2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы -
- -В рамках второй лабораторной работы необходимо: -* Настроить оркестрацию на запуск нескольких реплик сервиса генерации, -* Реализовать апи гейтвей на основе Ocelot, -* Имплементировать алгоритм балансировки нагрузки согласно варианту. +## Стек технологий -
-
-
-3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда -
+- .NET 8 +- .NET Aspire — оркестрация сервисов +- Bogus — генерация тестовых данных +- Redis — распределённый кэш (IDistributedCache) +- Blazor WebAssembly — клиентское приложение -В рамках третьей лабораторной работы необходимо: -* Добавить в оркестрацию объектное хранилище, -* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище, -* Реализовать отправку генерируемых данных в файловый сервис посредством брокера, -* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе. +## Предметная область — Программный проект -
-
-
-4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud -
- -В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы: -* Клиент - в хостинг через отдельный бакет Object Storage, -* Сервис генерации - в Cloud Function, -* Апи гейтвей - в Serverless Integration как API Gateway, -* Брокер сообщений - в Message Queue, -* Файловый сервис - в Cloud Function, -* Объектное хранилище - в отдельный бакет Object Storage, +| № | Характеристика | Тип данных | +|---|---|---| +| 1 | Идентификатор в системе | int | +| 2 | Название проекта | string | +| 3 | Заказчик проекта | string | +| 4 | Менеджер проекта | string | +| 5 | Дата начала | DateOnly | +| 6 | Плановая дата завершения | DateOnly | +| 7 | Фактическая дата завершения | DateOnly? | +| 8 | Бюджет | decimal | +| 9 | Фактические затраты | decimal | +| 10 | Процент выполнения | int | -
-
+## API -## Задание. Общая часть -**Обязательно**: -* Реализация серверной части на [.NET 8](https://learn.microsoft.com/ru-ru/dotnet/core/whats-new/dotnet-8/overview). -* Оркестрация проектов при помощи [.NET Aspire](https://learn.microsoft.com/ru-ru/dotnet/aspire/get-started/aspire-overview). -* Реализация сервиса генерации данных при помощи [Bogus](https://github.com/bchavez/Bogus). -* Реализация тестов с использованием [xUnit](https://xunit.net/?tabs=cs). -* Создание минимальной документации к проекту: страница на GitHub с информацией о задании, скриншоты приложения и прочая информация. - -**Факультативно**: -* Перенос бекенда на облачную инфраструктуру Yandex Cloud - -Внимательно прочитайте [дискуссии](https://github.com/itsecd/cloud-development/discussions/1) о том, как работает автоматическое распределение на ревью. -Сразу корректно называйте свои pr, чтобы они попали на ревью нужному преподавателю. - -По итогу работы в семестре должна получиться следующая информационная система: -
-C4 диаграмма -Современные_технологии_разработки_ПО_drawio -
- -## Варианты заданий -Номер варианта задания присваивается в начале семестра. Изменить его нельзя. Каждый вариант имеет уникальную комбинацию из предметной области, базы данных и технологии для общения сервиса генерации данных и сервера апи. - -[Список вариантов](https://docs.google.com/document/d/1WGmLYwffTTaAj4TgFCk5bUyW3XKbFMiBm-DHZrfFWr4/edit?usp=sharing) -[Список предметных областей и алгоритмов балансировки](https://docs.google.com/document/d/1PLn2lKe4swIdJDZhwBYzxqFSu0AbY2MFY1SUPkIKOM4/edit?usp=sharing) - -## Схема сдачи - -На каждую из лабораторных работ необходимо сделать отдельный [Pull Request (PR)](https://docs.github.com/en/pull-requests). - -Общая схема: -1. Сделать форк данного репозитория -2. Выполнить задание -3. Сделать PR в данный репозиторий -4. Исправить замечания после code review -5. Получить approve - -## Критерии оценивания - -Конкурентный принцип. -Так как задания в первой лабораторной будут повторяться между студентами, то выделяются следующие показатели для оценки: -1. Скорость разработки -2. Качество разработки -3. Полнота выполнения задания - -Быстрее делаете PR - у вас преимущество. -Быстрее получаете Approve - у вас преимущество. -Выполните нечто немного выходящее за рамки проекта - у вас преимущество. -Не укладываетесь в дедлайн - получаете минимально возможный балл. - -### Шкала оценивания - -- **3 балла** за качество кода, из них: - - 2 балла - базовая оценка - - 1 балл (но не более) можно получить за выполнение любого из следующих пунктов: - - Реализация факультативного функционала - - Выполнение работы раньше других: первые 5 человек из каждой группы, которые сделали PR и получили approve, получают дополнительный балл - -## Вопросы и обратная связь по курсу - -Чтобы задать вопрос по лабораторной, воспользуйтесь [соответствующим разделом дискуссий](https://github.com/itsecd/cloud-development/discussions/categories/questions) или заведите [ишью](https://github.com/itsecd/cloud-development/issues/new). -Если у вас появились идеи/пожелания/прочие полезные мысли по преподаваемой дисциплине, их можно оставить [здесь](https://github.com/itsecd/cloud-development/discussions/categories/ideas). +``` +GET /generate/?id={id} +``` +Возвращает JSON с программным проектом. При повторном запросе с тем же id данные берутся из кэша Redis (TTL — 15 минут).