diff --git a/Client.Wasm/Components/StudentCard.razor b/Client.Wasm/Components/StudentCard.razor index 661f1181..89936d11 100644 --- a/Client.Wasm/Components/StudentCard.razor +++ b/Client.Wasm/Components/StudentCard.razor @@ -4,10 +4,10 @@ - Номер №X "Название лабораторной" - Вариант №Х "Название варианта" - Выполнена Фамилией Именем 65ХХ - Ссылка на форк + Номер №1 "Кэширование" + Вариант №39 "Программный проект" + Выполнил Жидяев Дмитрий 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..8e1bc44d 100644 --- a/Client.Wasm/wwwroot/appsettings.json +++ b/Client.Wasm/wwwroot/appsettings.json @@ -6,5 +6,5 @@ } }, "AllowedHosts": "*", - "BaseAddress": "" + "BaseAddress": "http://localhost:5299/api/software-projects" } diff --git a/CloudDevelopment.sln b/CloudDevelopment.sln index cb48241d..7abfdb63 100644 --- a/CloudDevelopment.sln +++ b/CloudDevelopment.sln @@ -5,6 +5,12 @@ 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}") = "SoftwareProjects.AppHost", "SoftwareProjects\SoftwareProjects.AppHost\SoftwareProjects.AppHost.csproj", "{EC51E772-B7D1-4185-86B3-9E0ACF79C521}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SoftwareProjects.ServiceDefaults", "SoftwareProjects\SoftwareProjects.ServiceDefaults\SoftwareProjects.ServiceDefaults.csproj", "{D568B20D-5F65-3DB5-3289-0CA101BC09FE}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SoftwareProjects.Api", "SoftwareProjects.Api\SoftwareProjects.Api.csproj", "{D333DF66-6F24-76D8-CFA9-228C3368FF0D}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -15,6 +21,18 @@ 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 + {EC51E772-B7D1-4185-86B3-9E0ACF79C521}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {EC51E772-B7D1-4185-86B3-9E0ACF79C521}.Debug|Any CPU.Build.0 = Debug|Any CPU + {EC51E772-B7D1-4185-86B3-9E0ACF79C521}.Release|Any CPU.ActiveCfg = Release|Any CPU + {EC51E772-B7D1-4185-86B3-9E0ACF79C521}.Release|Any CPU.Build.0 = Release|Any CPU + {D568B20D-5F65-3DB5-3289-0CA101BC09FE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D568B20D-5F65-3DB5-3289-0CA101BC09FE}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D568B20D-5F65-3DB5-3289-0CA101BC09FE}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D568B20D-5F65-3DB5-3289-0CA101BC09FE}.Release|Any CPU.Build.0 = Release|Any CPU + {D333DF66-6F24-76D8-CFA9-228C3368FF0D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D333DF66-6F24-76D8-CFA9-228C3368FF0D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D333DF66-6F24-76D8-CFA9-228C3368FF0D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D333DF66-6F24-76D8-CFA9-228C3368FF0D}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/README.md b/README.md index dcaa5eb7..9f28d5b2 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,35 @@ -# Современные технологии разработки программного обеспечения -[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing) +# Лабораторная работа №1 «Кэширование» -## Задание -### Цель -Реализация проекта микросервисного бекенда. +## Вариант №39 — «Программный проект» -### Задачи -* Реализация межсервисной коммуникации, -* Изучение работы с брокерами сообщений, -* Изучение архитектурных паттернов, -* Изучение работы со средствами оркестрации на примере .NET Aspire, -* Повторение основ работы с системами контроля версий, -* Интеграционное тестирование. +## Описание -### Лабораторные работы -
-1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов -
- -В рамках первой лабораторной работы необходимо: -* Реализовать сервис генерации контрактов на основе Bogus, -* Реализовать кеширование при помощи IDistributedCache и Redis, -* Реализовать структурное логирование сервиса генерации, -* Настроить оркестрацию Aspire. - -
-
-2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы -
- -В рамках второй лабораторной работы необходимо: -* Настроить оркестрацию на запуск нескольких реплик сервиса генерации, -* Реализовать апи гейтвей на основе Ocelot, -* Имплементировать алгоритм балансировки нагрузки согласно варианту. +Реализован сервис генерации данных о программных проектах с кэшированием ответов в Redis и оркестрацией через .NET Aspire -
-
-
-3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда -
+## Что реализовано -В рамках третьей лабораторной работы необходимо: -* Добавить в оркестрацию объектное хранилище, -* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище, -* Реализовать отправку генерируемых данных в файловый сервис посредством брокера, -* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе. +### Генерация данных (Bogus) +- Класс `SoftwareProjectFaker` с `RuleFor` для каждого поля +- Генерация ФИО менеджера с отчеством, образованным от мужского имени с учётом пола (окончания «ович/овна», «евич/евна») +- Локаль `ru` для русскоязычных имён -
-
-
-4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud -
- -В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы: -* Клиент - в хостинг через отдельный бакет Object Storage, -* Сервис генерации - в Cloud Function, -* Апи гейтвей - в Serverless Integration как API Gateway, -* Брокер сообщений - в Message Queue, -* Файловый сервис - в Cloud Function, -* Объектное хранилище - в отдельный бакет Object Storage, +### Кэширование (Redis + IDistributedCache) +- Сервис `SoftwareProjectService` с интерфейсом `ISoftwareProjectService` -
-
+### Структурное логирование +- Логирование на английском языке через `ILogger` +- Структурные параметры `{ProjectId}` для корреляции +- Отдельные уровни: `Information` для успешных операций, `Warning` для ошибок кэша, `Error` для ошибок генерации -## Задание. Общая часть -**Обязательно**: -* Реализация серверной части на [.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 с информацией о задании, скриншоты приложения и прочая информация. +### CORS +- Разрешён только `GET`-запрос +- Доверенные URL вынесены в `appsettings.json` (`TrustedOrigins`) -**Факультативно**: -* Перенос бекенда на облачную инфраструктуру 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). +### Оркестрация (.NET Aspire) +- Redis с RedisInsight +- API сервис ждёт Redis (`WaitFor(cache)`) +- Клиент WASM ждёт API сервис (`WaitFor(softwareProjectsApi)`) +### API +- Единственный эндпоинт: `GET /api/software-projects?id={id}` +- Minimal API diff --git a/SoftwareProjects.Api/Entities/SoftwareProject.cs b/SoftwareProjects.Api/Entities/SoftwareProject.cs new file mode 100644 index 00000000..3c044b94 --- /dev/null +++ b/SoftwareProjects.Api/Entities/SoftwareProject.cs @@ -0,0 +1,57 @@ +namespace SoftwareProjects.Api.Entities; + +/// +/// Программный проект с информацией о бюджете, сроках и прогрессе +/// +public class SoftwareProject +{ + /// + /// Идентификатор в системе + /// + public int Id { get; set; } + + /// + /// Название проекта + /// + public required string ProjectName { get; set; } + + /// + /// Заказчик проекта + /// + public required string CustomerCompany { get; set; } + + /// + /// Менеджер проекта (Фамилия Имя Отчество) + /// + public required string ProjectManager { get; set; } + + /// + /// Дата начала + /// + public DateOnly StartDate { get; set; } + + /// + /// Плановая дата завершения + /// + public DateOnly PlannedEndDate { get; set; } + + /// + /// Фактическая дата завершения + /// + public DateOnly? ActualEndDate { get; set; } + + /// + /// Бюджет + /// + public decimal Budget { get; set; } + + /// + /// Фактические затраты + /// + public decimal ActualCosts { get; set; } + + /// + /// Процент выполнения (0-100) + /// + public int CompletionPercentage { get; set; } +} diff --git a/SoftwareProjects.Api/Program.cs b/SoftwareProjects.Api/Program.cs new file mode 100644 index 00000000..f9f7e353 --- /dev/null +++ b/SoftwareProjects.Api/Program.cs @@ -0,0 +1,33 @@ +using SoftwareProjects.Api.Services; + +var builder = WebApplication.CreateBuilder(args); + +builder.AddServiceDefaults(); +builder.AddRedisDistributedCache("cache"); + +builder.Services.AddScoped(); +builder.Services.AddScoped(); + +var trustedOrigins = builder.Configuration + .GetSection("TrustedOrigins") + .Get() ?? []; + +builder.Services.AddCors(options => +{ + options.AddDefaultPolicy(policy => + { + policy.WithOrigins(trustedOrigins) + .WithMethods("GET") + .AllowAnyHeader(); + }); +}); + +var app = builder.Build(); + +app.MapDefaultEndpoints(); +app.UseCors(); + +app.MapGet("/api/software-projects", async (int id, ISoftwareProjectService service) => + Results.Ok(await service.GetById(id))); + +app.Run(); diff --git a/SoftwareProjects.Api/Properties/launchSettings.json b/SoftwareProjects.Api/Properties/launchSettings.json new file mode 100644 index 00000000..600c5c75 --- /dev/null +++ b/SoftwareProjects.Api/Properties/launchSettings.json @@ -0,0 +1,38 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:20046", + "sslPort": 44320 + } + }, + "profiles": { + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:5299", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:7166;http://localhost:5299", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + } +} diff --git a/SoftwareProjects.Api/Services/ISoftwareProjectCacheService.cs b/SoftwareProjects.Api/Services/ISoftwareProjectCacheService.cs new file mode 100644 index 00000000..7488b1e3 --- /dev/null +++ b/SoftwareProjects.Api/Services/ISoftwareProjectCacheService.cs @@ -0,0 +1,19 @@ +using SoftwareProjects.Api.Entities; + +namespace SoftwareProjects.Api.Services; + +/// +/// Служба кэширования программных проектов +/// +public interface ISoftwareProjectCacheService +{ + /// + /// Получает программный проект из кэша по идентификатору + /// + public Task GetFromCache(int id); + + /// + /// Сохраняет программный проект в кэш + /// + public Task SetToCache(int id, SoftwareProject project); +} diff --git a/SoftwareProjects.Api/Services/ISoftwareProjectService.cs b/SoftwareProjects.Api/Services/ISoftwareProjectService.cs new file mode 100644 index 00000000..d3c3b338 --- /dev/null +++ b/SoftwareProjects.Api/Services/ISoftwareProjectService.cs @@ -0,0 +1,14 @@ +using SoftwareProjects.Api.Entities; + +namespace SoftwareProjects.Api.Services; + +/// +/// Сервис получения программного проекта с поддержкой кэширования +/// +public interface ISoftwareProjectService +{ + /// + /// Получает программный проект по идентификатору из кэша или генерирует новый + /// + public Task GetById(int id); +} diff --git a/SoftwareProjects.Api/Services/SoftwareProjectCacheService.cs b/SoftwareProjects.Api/Services/SoftwareProjectCacheService.cs new file mode 100644 index 00000000..98590729 --- /dev/null +++ b/SoftwareProjects.Api/Services/SoftwareProjectCacheService.cs @@ -0,0 +1,64 @@ +using System.Text.Json; +using Microsoft.Extensions.Caching.Distributed; +using SoftwareProjects.Api.Entities; + +namespace SoftwareProjects.Api.Services; + +/// +/// Реализация службы кэширования программных проектов через Redis +/// +public class SoftwareProjectCacheService( + IDistributedCache cache, + IConfiguration configuration, + ILogger logger) : ISoftwareProjectCacheService +{ + private readonly int _cacheExpirationMinutes = configuration.GetValue("CacheExpirationMinutes", 5); + + /// + /// Получает программный проект из кэша по идентификатору + /// + public async Task GetFromCache(int id) + { + try + { + var cached = await cache.GetStringAsync($"software-project-{id}"); + + if (!string.IsNullOrEmpty(cached)) + { + var deserialized = JsonSerializer.Deserialize(cached); + + if (deserialized is not null) + { + logger.LogInformation("Project {ProjectId} retrieved from cache", id); + return deserialized; + } + } + } + catch (Exception ex) + { + logger.LogWarning(ex, "Failed to read project {ProjectId} from cache", id); + } + + return null; + } + + /// + /// Сохраняет программный проект в кэш + /// + public async Task SetToCache(int id, SoftwareProject project) + { + try + { + var json = JsonSerializer.Serialize(project); + await cache.SetStringAsync($"software-project-{id}", json, new DistributedCacheEntryOptions + { + AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(_cacheExpirationMinutes) + }); + logger.LogInformation("Project {ProjectId} saved to cache", id); + } + catch (Exception ex) + { + logger.LogWarning(ex, "Failed to write project {ProjectId} to cache", id); + } + } +} diff --git a/SoftwareProjects.Api/Services/SoftwareProjectFaker.cs b/SoftwareProjects.Api/Services/SoftwareProjectFaker.cs new file mode 100644 index 00000000..f60cab24 --- /dev/null +++ b/SoftwareProjects.Api/Services/SoftwareProjectFaker.cs @@ -0,0 +1,65 @@ +using Bogus; +using Bogus.DataSets; +using SoftwareProjects.Api.Entities; + +namespace SoftwareProjects.Api.Services; + +/// +/// Статический генератор данных для программного проекта +/// +public static class SoftwareProjectFaker +{ + private static readonly Faker _faker = new Faker("ru") + .RuleFor(p => p.Id, _ => 0) + .RuleFor(p => p.ProjectName, f => + $"{f.Commerce.ProductName()} {f.Hacker.Abbreviation()}") + .RuleFor(p => p.CustomerCompany, f => + f.Commerce.Department()) + .RuleFor(p => p.ProjectManager, f => + { + var gender = f.PickRandom(); + return $"{f.Name.LastName(gender)} {f.Name.FirstName(gender)} {GeneratePatronymic(f, gender)}"; + }) + .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.4f) + ? p.StartDate.AddDays(f.Random.Int(30, 400)) + : null) + .RuleFor(p => p.Budget, f => + Math.Round(f.Finance.Amount(100_000, 10_000_000), 2)) + .RuleFor(p => p.ActualCosts, (f, p) => + Math.Round(p.Budget * f.Random.Decimal(0.3m, 1.2m), 2)) + .RuleFor(p => p.CompletionPercentage, (f, p) => + p.ActualEndDate.HasValue ? 100 : f.Random.Int(0, 99)); + + /// + /// Генерирует программный проект с указанным идентификатором + /// + public static SoftwareProject Generate(int id) + { + var project = _faker.Generate(); + project.Id = id; + return project; + } + + /// + /// Генерирует отчество на основе мужского имени с учётом пола менеджера + /// + private static string GeneratePatronymic(Faker faker, Name.Gender gender) + { + var maleName = faker.Name.FirstName(Name.Gender.Male); + var suffix = gender == Name.Gender.Male ? "ович" : "овна"; + var softSuffix = gender == Name.Gender.Male ? "евич" : "евна"; + + if (maleName.EndsWith('а') || maleName.EndsWith('я')) + return maleName[..^1] + suffix; + + if (maleName.EndsWith('ь')) + return maleName[..^1] + softSuffix; + + return maleName + suffix; + } +} diff --git a/SoftwareProjects.Api/Services/SoftwareProjectService.cs b/SoftwareProjects.Api/Services/SoftwareProjectService.cs new file mode 100644 index 00000000..e19b80d7 --- /dev/null +++ b/SoftwareProjects.Api/Services/SoftwareProjectService.cs @@ -0,0 +1,39 @@ +using SoftwareProjects.Api.Entities; + +namespace SoftwareProjects.Api.Services; + +/// +/// Реализация сервиса программных проектов с кэшированием +/// +public class SoftwareProjectService( + ISoftwareProjectCacheService cacheService, + ILogger logger) : ISoftwareProjectService +{ + /// + /// Получает программный проект по идентификатору из кэша или генерирует новый + /// + public async Task GetById(int id) + { + var cached = await cacheService.GetFromCache(id); + + if (cached is not null) + return cached; + + SoftwareProject project; + + try + { + project = SoftwareProjectFaker.Generate(id); + logger.LogInformation("Project {ProjectId} generated successfully", id); + } + catch (Exception ex) + { + logger.LogError(ex, "Failed to generate project {ProjectId}", id); + throw; + } + + await cacheService.SetToCache(id, project); + + return project; + } +} diff --git a/SoftwareProjects.Api/SoftwareProjects.Api.csproj b/SoftwareProjects.Api/SoftwareProjects.Api.csproj new file mode 100644 index 00000000..bef0eadb --- /dev/null +++ b/SoftwareProjects.Api/SoftwareProjects.Api.csproj @@ -0,0 +1,23 @@ + + + + net8.0 + enable + enable + + + + + + + + + + + + + + + + + diff --git a/SoftwareProjects.Api/appsettings.Development.json b/SoftwareProjects.Api/appsettings.Development.json new file mode 100644 index 00000000..0c208ae9 --- /dev/null +++ b/SoftwareProjects.Api/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/SoftwareProjects.Api/appsettings.json b/SoftwareProjects.Api/appsettings.json new file mode 100644 index 00000000..125e7169 --- /dev/null +++ b/SoftwareProjects.Api/appsettings.json @@ -0,0 +1,14 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*", + "TrustedOrigins": [ + "http://localhost:5127", + "https://localhost:7282" + ], + "CacheExpirationMinutes": 5 +} diff --git a/SoftwareProjects/SoftwareProjects.AppHost/AppHost.cs b/SoftwareProjects/SoftwareProjects.AppHost/AppHost.cs new file mode 100644 index 00000000..31fbb9ef --- /dev/null +++ b/SoftwareProjects/SoftwareProjects.AppHost/AppHost.cs @@ -0,0 +1,13 @@ +var builder = DistributedApplication.CreateBuilder(args); + +var cache = builder.AddRedis("cache") + .WithRedisInsight(containerName: "credit-redis-insight"); + +var softwareProjectsApi = builder.AddProject("softwareprojects-api") + .WithReference(cache) + .WaitFor(cache); + +builder.AddProject("client-wasm") + .WaitFor(softwareProjectsApi); + +builder.Build().Run(); diff --git a/SoftwareProjects/SoftwareProjects.AppHost/Properties/launchSettings.json b/SoftwareProjects/SoftwareProjects.AppHost/Properties/launchSettings.json new file mode 100644 index 00000000..f966aa44 --- /dev/null +++ b/SoftwareProjects/SoftwareProjects.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:17036;http://localhost:15252", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21213", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22154" + } + }, + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:15252", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19181", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20164" + } + } + } +} diff --git a/SoftwareProjects/SoftwareProjects.AppHost/SoftwareProjects.AppHost.csproj b/SoftwareProjects/SoftwareProjects.AppHost/SoftwareProjects.AppHost.csproj new file mode 100644 index 00000000..1126c490 --- /dev/null +++ b/SoftwareProjects/SoftwareProjects.AppHost/SoftwareProjects.AppHost.csproj @@ -0,0 +1,23 @@ + + + + + + Exe + net8.0 + enable + enable + 8fca868f-2ed6-4417-82a1-5fb1ad8ee5f0 + + + + + + + + + + + + + diff --git a/SoftwareProjects/SoftwareProjects.AppHost/appsettings.Development.json b/SoftwareProjects/SoftwareProjects.AppHost/appsettings.Development.json new file mode 100644 index 00000000..0c208ae9 --- /dev/null +++ b/SoftwareProjects/SoftwareProjects.AppHost/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/SoftwareProjects/SoftwareProjects.AppHost/appsettings.json b/SoftwareProjects/SoftwareProjects.AppHost/appsettings.json new file mode 100644 index 00000000..31c092aa --- /dev/null +++ b/SoftwareProjects/SoftwareProjects.AppHost/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning", + "Aspire.Hosting.Dcp": "Warning" + } + } +} diff --git a/SoftwareProjects/SoftwareProjects.ServiceDefaults/Extensions.cs b/SoftwareProjects/SoftwareProjects.ServiceDefaults/Extensions.cs new file mode 100644 index 00000000..b72c8753 --- /dev/null +++ b/SoftwareProjects/SoftwareProjects.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/SoftwareProjects/SoftwareProjects.ServiceDefaults/SoftwareProjects.ServiceDefaults.csproj b/SoftwareProjects/SoftwareProjects.ServiceDefaults/SoftwareProjects.ServiceDefaults.csproj new file mode 100644 index 00000000..1b6e209a --- /dev/null +++ b/SoftwareProjects/SoftwareProjects.ServiceDefaults/SoftwareProjects.ServiceDefaults.csproj @@ -0,0 +1,22 @@ + + + + net8.0 + enable + enable + true + + + + + + + + + + + + + + +