diff --git a/Client.Wasm/Components/StudentCard.razor b/Client.Wasm/Components/StudentCard.razor index 661f1181..89cc60e9 100644 --- a/Client.Wasm/Components/StudentCard.razor +++ b/Client.Wasm/Components/StudentCard.razor @@ -4,10 +4,10 @@ - Номер №X "Название лабораторной" - Вариант №Х "Название варианта" - Выполнена Фамилией Именем 65ХХ - Ссылка на форк + Номер №1 "Кэширование" + Вариант №31 "Товар на складе" + Выполнил Пахомов Леонид 6512 + Ссылка на форк 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..c6b06aa0 100644 --- a/Client.Wasm/wwwroot/appsettings.json +++ b/Client.Wasm/wwwroot/appsettings.json @@ -6,5 +6,5 @@ } }, "AllowedHosts": "*", - "BaseAddress": "" + "BaseAddress": "https://localhost:7284/api/warehouse-item" } diff --git a/CloudDevelopment.sln b/CloudDevelopment.sln index cb48241d..eb459937 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}") = "WarehouseApp.AppHost", "WarehouseApp\WarehouseApp.AppHost\WarehouseApp.AppHost.csproj", "{62DA23FA-2BAF-4F9A-B719-B4EE06809BA0}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WarehouseApp.ServiceDefaults", "WarehouseApp\WarehouseApp.ServiceDefaults\WarehouseApp.ServiceDefaults.csproj", "{ADCEFD5A-DE46-3D8E-DD7F-B5FD83A993DF}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WarehouseApp.Api", "WarehouseApp.Api\WarehouseApp.Api.csproj", "{6D2468DE-58C5-E4A1-2839-0E91AF620D88}" +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 + {62DA23FA-2BAF-4F9A-B719-B4EE06809BA0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {62DA23FA-2BAF-4F9A-B719-B4EE06809BA0}.Debug|Any CPU.Build.0 = Debug|Any CPU + {62DA23FA-2BAF-4F9A-B719-B4EE06809BA0}.Release|Any CPU.ActiveCfg = Release|Any CPU + {62DA23FA-2BAF-4F9A-B719-B4EE06809BA0}.Release|Any CPU.Build.0 = Release|Any CPU + {ADCEFD5A-DE46-3D8E-DD7F-B5FD83A993DF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {ADCEFD5A-DE46-3D8E-DD7F-B5FD83A993DF}.Debug|Any CPU.Build.0 = Debug|Any CPU + {ADCEFD5A-DE46-3D8E-DD7F-B5FD83A993DF}.Release|Any CPU.ActiveCfg = Release|Any CPU + {ADCEFD5A-DE46-3D8E-DD7F-B5FD83A993DF}.Release|Any CPU.Build.0 = Release|Any CPU + {6D2468DE-58C5-E4A1-2839-0E91AF620D88}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {6D2468DE-58C5-E4A1-2839-0E91AF620D88}.Debug|Any CPU.Build.0 = Debug|Any CPU + {6D2468DE-58C5-E4A1-2839-0E91AF620D88}.Release|Any CPU.ActiveCfg = Release|Any CPU + {6D2468DE-58C5-E4A1-2839-0E91AF620D88}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/README.md b/README.md index dcaa5eb7..bfd2de26 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,52 @@ -# Современные технологии разработки программного обеспечения -[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing) - -## Задание -### Цель -Реализация проекта микросервисного бекенда. - -### Задачи -* Реализация межсервисной коммуникации, -* Изучение работы с брокерами сообщений, -* Изучение архитектурных паттернов, -* Изучение работы со средствами оркестрации на примере .NET Aspire, -* Повторение основ работы с системами контроля версий, -* Интеграционное тестирование. - -### Лабораторные работы -
-1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов -
- -В рамках первой лабораторной работы необходимо: -* Реализовать сервис генерации контрактов на основе Bogus, -* Реализовать кеширование при помощи IDistributedCache и Redis, -* Реализовать структурное логирование сервиса генерации, -* Настроить оркестрацию Aspire. - -
-
-2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы -
- -В рамках второй лабораторной работы необходимо: -* Настроить оркестрацию на запуск нескольких реплик сервиса генерации, -* Реализовать апи гейтвей на основе Ocelot, -* Имплементировать алгоритм балансировки нагрузки согласно варианту. - -
-
-
-3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда -
- -В рамках третьей лабораторной работы необходимо: -* Добавить в оркестрацию объектное хранилище, -* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище, -* Реализовать отправку генерируемых данных в файловый сервис посредством брокера, -* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе. - -
-
-
-4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud -
- -В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы: -* Клиент - в хостинг через отдельный бакет Object Storage, -* Сервис генерации - в Cloud Function, -* Апи гейтвей - в Serverless Integration как API Gateway, -* Брокер сообщений - в Message Queue, -* Файловый сервис - в Cloud Function, -* Объектное хранилище - в отдельный бакет Object Storage, - -
-
- -## Задание. Общая часть -**Обязательно**: -* Реализация серверной части на [.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). - +# Лабораторная работа №1 — «Кэширование» + +Реализация сервиса генерации данных о товарах на складе с кэшированием ответов через Redis, оркестрацией через .NET Aspire и Blazor WebAssembly клиентом. + +## Стек технологий + +| Технология | Назначение | +|---|---| +| .NET 8 | Серверная часть | +| ASP.NET Core Minimal API | HTTP-сервис | +| .NET Aspire | Оркестрация сервисов | +| Redis + `IDistributedCache` | Распределённое кэширование | +| Bogus | Генерация тестовых данных | +| Blazor WebAssembly | Клиентское приложение | + +## API + +**Endpoint**: `GET /api/warehouse-item?id={int}` + +При первом запросе генерирует товар и кэширует его. При повторном запросе с тем же `id` возвращает данные из кэша. Время жизни записи в кэше настраивается через `CacheExpirationMinutes` в `appsettings.json` (по умолчанию 10 минут). + +**Пример ответа**: + +```json +{ + "id": 42, + "productName": "Fantastic Metal Shoes", + "category": "Electronics", + "quantity": 317, + "pricePerUnit": 1234.56, + "weightPerUnit": 2.45, + "dimensions": "30х15х10 см", + "isFragile": false, + "lastDeliveryDate": "2024-11-03", + "nextDeliveryDate": "2025-06-18" +} +``` + +## Сущность «Товар на складе» + +| № | Поле | Тип | Правило генерации | +|---|---|---|---| +| 1 | `id` | `int` | Передаётся из запроса | +| 2 | `productName` | `string` | `Commerce.ProductName()` | +| 3 | `category` | `string` | `Commerce.Categories(1)[0]` | +| 4 | `quantity` | `int` | Случайное `[0, 1000]` | +| 5 | `pricePerUnit` | `decimal` | Случайное `[1, 10000]`, 2 знака | +| 6 | `weightPerUnit` | `double` | Случайное `[0.1, 500]`, 2 знака | +| 7 | `dimensions` | `string` | Формат `**х**х** см` | +| 8 | `isFragile` | `bool` | Случайный `bool` | +| 9 | `lastDeliveryDate` | `DateOnly` | Прошедшая дата ≤ сегодня | +| 10 | `nextDeliveryDate` | `DateOnly` | Дата ≥ `lastDeliveryDate` | diff --git a/WarehouseApp.Api/Generation/WarehouseItemGenerator.cs b/WarehouseApp.Api/Generation/WarehouseItemGenerator.cs new file mode 100644 index 00000000..4c1e4bce --- /dev/null +++ b/WarehouseApp.Api/Generation/WarehouseItemGenerator.cs @@ -0,0 +1,38 @@ +using Bogus; +using WarehouseApp.Api.Models; + +namespace WarehouseApp.Api.Generation; + +/// +/// Генератор товаров на складе на основе Bogus +/// +public static class WarehouseItemGenerator +{ + private static readonly Faker _faker = new Faker() + .RuleFor(x => x.ProductName, f => f.Commerce.ProductName()) + .RuleFor(x => x.Category, f => f.Commerce.Categories(1)[0]) + .RuleFor(x => x.Quantity, f => f.Random.Int(0, 1000)) + .RuleFor(x => x.PricePerUnit, f => Math.Round(f.Random.Decimal(1m, 10000m), 2)) + .RuleFor(x => x.WeightPerUnit, f => Math.Round(f.Random.Double(0.1, 500.0), 2)) + .RuleFor(x => x.Dimensions, f => + $"{f.Random.Int(1, 99)}х{f.Random.Int(1, 99)}х{f.Random.Int(1, 99)} см") + .RuleFor(x => x.IsFragile, f => f.Random.Bool()) + .RuleFor(x => x.LastDeliveryDate, f => + DateOnly.FromDateTime(f.Date.Past(2, DateTime.Today))) + .RuleFor(x => x.NextDeliveryDate, (f, item) => DateOnly.FromDateTime( + f.Date.Between( + item.LastDeliveryDate.ToDateTime(TimeOnly.MinValue), + DateTime.Today.AddYears(1)))); + + /// + /// Генерирует товар на складе с указанным идентификатором + /// + /// Идентификатор товара в системе + /// Сгенерированный товар на складе + public static WarehouseItem Generate(int id) + { + var item = _faker.Generate(); + item.Id = id; + return item; + } +} diff --git a/WarehouseApp.Api/Models/WarehouseItem.cs b/WarehouseApp.Api/Models/WarehouseItem.cs new file mode 100644 index 00000000..a396489e --- /dev/null +++ b/WarehouseApp.Api/Models/WarehouseItem.cs @@ -0,0 +1,57 @@ +namespace WarehouseApp.Api.Models; + +/// +/// Товар на складе +/// +public class WarehouseItem +{ + /// + /// Идентификатор в системе + /// + public int Id { get; set; } + + /// + /// Наименование товара + /// + public required string ProductName { get; init; } + + /// + /// Категория товара + /// + public required string Category { get; init; } + + /// + /// Количество на складе + /// + public int Quantity { get; init; } + + /// + /// Цена за единицу товара + /// + public decimal PricePerUnit { get; init; } + + /// + /// Вес единицы товара + /// + public double WeightPerUnit { get; init; } + + /// + /// Габариты единицы товара + /// + public required string Dimensions { get; init; } + + /// + /// Товар хрупкий + /// + public bool IsFragile { get; init; } + + /// + /// Дата последней поставки + /// + public DateOnly LastDeliveryDate { get; init; } + + /// + /// Дата следующей поставки + /// + public DateOnly NextDeliveryDate { get; init; } +} diff --git a/WarehouseApp.Api/Program.cs b/WarehouseApp.Api/Program.cs new file mode 100644 index 00000000..89aa0e96 --- /dev/null +++ b/WarehouseApp.Api/Program.cs @@ -0,0 +1,28 @@ +using WarehouseApp.Api.Services; + +var builder = WebApplication.CreateBuilder(args); + +builder.AddServiceDefaults(); +builder.AddRedisDistributedCache("cache"); + +var allowedOrigins = builder.Configuration + .GetSection("Cors:AllowedOrigins") + .Get() ?? []; + +builder.Services.AddCors(options => + options.AddDefaultPolicy(policy => + policy.WithOrigins(allowedOrigins) + .WithMethods("GET") + .AllowAnyHeader())); + +builder.Services.AddScoped(); + +var app = builder.Build(); + +app.MapDefaultEndpoints(); +app.UseCors(); + +app.MapGet("/api/warehouse-item", async (int id, IWarehouseItemService service) => + Results.Ok(await service.GetOrGenerate(id))); + +app.Run(); diff --git a/WarehouseApp.Api/Properties/launchSettings.json b/WarehouseApp.Api/Properties/launchSettings.json new file mode 100644 index 00000000..1c771b97 --- /dev/null +++ b/WarehouseApp.Api/Properties/launchSettings.json @@ -0,0 +1,38 @@ +{ + "$schema": "http://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:15575", + "sslPort": 44317 + } + }, + "profiles": { + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:5288", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "https": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "https://localhost:7284;http://localhost:5288", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + } +} diff --git a/WarehouseApp.Api/Services/IWarehouseItemService.cs b/WarehouseApp.Api/Services/IWarehouseItemService.cs new file mode 100644 index 00000000..6221742e --- /dev/null +++ b/WarehouseApp.Api/Services/IWarehouseItemService.cs @@ -0,0 +1,16 @@ +using WarehouseApp.Api.Models; + +namespace WarehouseApp.Api.Services; + +/// +/// Сервис получения товара на складе с кэшированием +/// +public interface IWarehouseItemService +{ + /// + /// Возвращает товар по идентификатору: из кэша или генерирует новый + /// + /// Идентификатор товара в системе + /// Сгенерированный товар на складе + public Task GetOrGenerate(int id); +} diff --git a/WarehouseApp.Api/Services/WarehouseItemService.cs b/WarehouseApp.Api/Services/WarehouseItemService.cs new file mode 100644 index 00000000..9e8a5a52 --- /dev/null +++ b/WarehouseApp.Api/Services/WarehouseItemService.cs @@ -0,0 +1,100 @@ +using System.Text.Json; +using Microsoft.Extensions.Caching.Distributed; +using WarehouseApp.Api.Generation; +using WarehouseApp.Api.Models; + +namespace WarehouseApp.Api.Services; + +/// +/// Кэш +/// Логгер +/// Конфигурация приложения +public class WarehouseItemService(IDistributedCache cache, ILogger logger, IConfiguration configuration) + : IWarehouseItemService +{ + private const string KeyPrefix = "warehouse-item:"; + + private readonly int _cacheExpirationMinutes = configuration.GetValue("CacheExpirationMinutes", 10); + + /// + public async Task GetOrGenerate(int id) + { + var cached = await TryGetFromCache(id); + if (cached is not null) + return cached; + + logger.LogInformation("Cache miss for item {Id}, generating...", id); + + var item = await Generate(id); + + await TrySaveToCache(id, item); + return item; + } + + /// + /// Пытается получить товар из кэша + /// + /// Идентификатор товара в системе + /// Товар из кэша или , если запись отсутствует или произошла ошибка + private async Task TryGetFromCache(int id) + { + try + { + var data = await cache.GetStringAsync(KeyPrefix + id); + + if (data is null) + return null; + + logger.LogInformation("Cache hit for item {Id}", id); + return JsonSerializer.Deserialize(data); + } + catch (Exception ex) + { + logger.LogError(ex, "Failed to get item {Id} from cache: {Error}", id, ex.Message); + return null; + } + } + + /// + /// Сохраняет товар в кэш + /// + /// Идентификатор товара в системе + /// Товар для сохранения + private async Task TrySaveToCache(int id, WarehouseItem item) + { + try + { + var data = JsonSerializer.Serialize(item); + await cache.SetStringAsync(KeyPrefix + id, data, new DistributedCacheEntryOptions + { + AbsoluteExpirationRelativeToNow = TimeSpan.FromMinutes(_cacheExpirationMinutes) + }); + + logger.LogInformation("Item {Id} saved to cache", id); + } + catch (Exception ex) + { + logger.LogError(ex, "Failed to save item {Id} to cache: {Error}", id, ex.Message); + } + } + + /// + /// Генерирует товар с указанным идентификатором + /// + /// Идентификатор товара в системе + /// Сгенерированный товар на складе + private async Task Generate(int id) + { + try + { + var item = await Task.FromResult(WarehouseItemGenerator.Generate(id)); + logger.LogInformation("Successfully generated item {Id}", id); + return item; + } + catch (Exception ex) + { + logger.LogError(ex, "Failed to generate item {Id}: {Error}", id, ex.Message); + throw; + } + } +} diff --git a/WarehouseApp.Api/WarehouseApp.Api.csproj b/WarehouseApp.Api/WarehouseApp.Api.csproj new file mode 100644 index 00000000..d78b3dc9 --- /dev/null +++ b/WarehouseApp.Api/WarehouseApp.Api.csproj @@ -0,0 +1,18 @@ + + + + net8.0 + enable + enable + + + + + + + + + + + + diff --git a/WarehouseApp.Api/appsettings.Development.json b/WarehouseApp.Api/appsettings.Development.json new file mode 100644 index 00000000..0c208ae9 --- /dev/null +++ b/WarehouseApp.Api/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/WarehouseApp.Api/appsettings.json b/WarehouseApp.Api/appsettings.json new file mode 100644 index 00000000..db082e85 --- /dev/null +++ b/WarehouseApp.Api/appsettings.json @@ -0,0 +1,16 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "Cors": { + "AllowedOrigins": [ + "http://localhost:5127", + "https://localhost:7282" + ] + }, + "CacheExpirationMinutes": 10, + "AllowedHosts": "*" +} diff --git a/WarehouseApp/WarehouseApp.AppHost/AppHost.cs b/WarehouseApp/WarehouseApp.AppHost/AppHost.cs new file mode 100644 index 00000000..1f9aaf6e --- /dev/null +++ b/WarehouseApp/WarehouseApp.AppHost/AppHost.cs @@ -0,0 +1,13 @@ +var builder = DistributedApplication.CreateBuilder(args); + +var cache = builder.AddRedis("cache") + .WithRedisCommander(); + +var api = builder.AddProject("warehouseapp-api") + .WithReference(cache) + .WaitFor(cache); + +builder.AddProject("client-wasm") + .WaitFor(api); + +builder.Build().Run(); diff --git a/WarehouseApp/WarehouseApp.AppHost/Properties/launchSettings.json b/WarehouseApp/WarehouseApp.AppHost/Properties/launchSettings.json new file mode 100644 index 00000000..ff34ac0e --- /dev/null +++ b/WarehouseApp/WarehouseApp.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:17181;http://localhost:15266", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "https://localhost:21128", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "https://localhost:22078" + } + }, + "http": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "applicationUrl": "http://localhost:15266", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development", + "DOTNET_ENVIRONMENT": "Development", + "ASPIRE_DASHBOARD_OTLP_ENDPOINT_URL": "http://localhost:19002", + "ASPIRE_RESOURCE_SERVICE_ENDPOINT_URL": "http://localhost:20010" + } + } + } +} diff --git a/WarehouseApp/WarehouseApp.AppHost/WarehouseApp.AppHost.csproj b/WarehouseApp/WarehouseApp.AppHost/WarehouseApp.AppHost.csproj new file mode 100644 index 00000000..3059fe91 --- /dev/null +++ b/WarehouseApp/WarehouseApp.AppHost/WarehouseApp.AppHost.csproj @@ -0,0 +1,23 @@ + + + + + + Exe + net8.0 + enable + enable + 18a6328e-1481-4926-bc64-b322ed53ca5c + + + + + + + + + + + + + diff --git a/WarehouseApp/WarehouseApp.AppHost/appsettings.Development.json b/WarehouseApp/WarehouseApp.AppHost/appsettings.Development.json new file mode 100644 index 00000000..0c208ae9 --- /dev/null +++ b/WarehouseApp/WarehouseApp.AppHost/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/WarehouseApp/WarehouseApp.AppHost/appsettings.json b/WarehouseApp/WarehouseApp.AppHost/appsettings.json new file mode 100644 index 00000000..31c092aa --- /dev/null +++ b/WarehouseApp/WarehouseApp.AppHost/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning", + "Aspire.Hosting.Dcp": "Warning" + } + } +} diff --git a/WarehouseApp/WarehouseApp.ServiceDefaults/Extensions.cs b/WarehouseApp/WarehouseApp.ServiceDefaults/Extensions.cs new file mode 100644 index 00000000..b72c8753 --- /dev/null +++ b/WarehouseApp/WarehouseApp.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/WarehouseApp/WarehouseApp.ServiceDefaults/WarehouseApp.ServiceDefaults.csproj b/WarehouseApp/WarehouseApp.ServiceDefaults/WarehouseApp.ServiceDefaults.csproj new file mode 100644 index 00000000..1b6e209a --- /dev/null +++ b/WarehouseApp/WarehouseApp.ServiceDefaults/WarehouseApp.ServiceDefaults.csproj @@ -0,0 +1,22 @@ + + + + net8.0 + enable + enable + true + + + + + + + + + + + + + + +