Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions Client.Wasm/Components/StudentCard.razor
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
</CardHeader>
<CardBody>
<UnorderedList Unstyled>
<UnorderedListItem>Номер <Strong>№X "Название лабораторной"</Strong></UnorderedListItem>
<UnorderedListItem>Вариант <Strong>№Х "Название варианта"</Strong></UnorderedListItem>
<UnorderedListItem>Выполнена <Strong>Фамилией Именем 65ХХ</Strong> </UnorderedListItem>
<UnorderedListItem><Link To="https://puginarug.com/">Ссылка на форк</Link></UnorderedListItem>
<UnorderedListItem>Номер <Strong>№1 "Кэширование"</Strong></UnorderedListItem>
<UnorderedListItem>Вариант <Strong>№27 "Транспортное средство"</Strong></UnorderedListItem>
<UnorderedListItem>Выполнила <Strong>Лаврук Маргарита 6512</Strong> </UnorderedListItem>
<UnorderedListItem><Link To="https://github.com/Mlavrukk/cloud-development">Ссылка на форк</Link></UnorderedListItem>
</UnorderedList>
</CardBody>
</Card>
6 changes: 3 additions & 3 deletions Client.Wasm/Properties/launchSettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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": {
Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion Client.Wasm/wwwroot/appsettings.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
}
},
"AllowedHosts": "*",
"BaseAddress": ""
"BaseAddress": "https://localhost:7283/api/vehicle"
}
18 changes: 18 additions & 0 deletions CloudDevelopment.sln
Original file line number Diff line number Diff line change
Expand Up @@ -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}") = "VehicleVault.AppHost", "VehicleVault\VehicleVault.AppHost\VehicleVault.AppHost.csproj", "{675E2979-6231-45C9-A79D-E8D1BE095D7E}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VehicleVault.ServiceDefaults", "VehicleVault\VehicleVault.ServiceDefaults\VehicleVault.ServiceDefaults.csproj", "{2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VehicleVault.Api", "VehicleVault.Api\VehicleVault.Api.csproj", "{EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand All @@ -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
{675E2979-6231-45C9-A79D-E8D1BE095D7E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{675E2979-6231-45C9-A79D-E8D1BE095D7E}.Debug|Any CPU.Build.0 = Debug|Any CPU
{675E2979-6231-45C9-A79D-E8D1BE095D7E}.Release|Any CPU.ActiveCfg = Release|Any CPU
{675E2979-6231-45C9-A79D-E8D1BE095D7E}.Release|Any CPU.Build.0 = Release|Any CPU
{2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}.Debug|Any CPU.Build.0 = Debug|Any CPU
{2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}.Release|Any CPU.ActiveCfg = Release|Any CPU
{2691D15C-C371-2A92-5FA1-3FA8EDE4BFA9}.Release|Any CPU.Build.0 = Release|Any CPU
{EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}.Debug|Any CPU.Build.0 = Debug|Any CPU
{EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}.Release|Any CPU.ActiveCfg = Release|Any CPU
{EEC635D9-1FAB-BCC6-17E0-3EE52C2D262C}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
151 changes: 34 additions & 117 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,128 +1,45 @@
# Современные технологии разработки программного обеспечения
[Таблица с успеваемостью](https://docs.google.com/spreadsheets/d/1an43o-iqlq4V_kDtkr_y7DC221hY9qdhGPrpII27sH8/edit?usp=sharing)
# Лабораторная работа №1 «Кэширование»

## Задание
### Цель
Реализация проекта микросервисного бекенда.
## Описание

### Задачи
* Реализация межсервисной коммуникации,
* Изучение работы с брокерами сообщений,
* Изучение архитектурных паттернов,
* Изучение работы со средствами оркестрации на примере .NET Aspire,
* Повторение основ работы с системами контроля версий,
* Интеграционное тестирование.
Реализация сервиса генерации данных о транспортных средствах с кэшированием ответов в Redis.
Оркестрация проектов при помощи .NET Aspire.

### Лабораторные работы
<details>
<summary>1. «Кэширование» - Реализация сервиса генерации контрактов, кэширование его ответов</summary>
<br>

В рамках первой лабораторной работы необходимо:
* Реализовать сервис генерации контрактов на основе Bogus,
* Реализовать кеширование при помощи IDistributedCache и Redis,
* Реализовать структурное логирование сервиса генерации,
* Настроить оркестрацию Aspire.

</details>
<details>
<summary>2. «Балансировка нагрузки» - Реализация апи гейтвея, настройка его работы</summary>
<br>

В рамках второй лабораторной работы необходимо:
* Настроить оркестрацию на запуск нескольких реплик сервиса генерации,
* Реализовать апи гейтвей на основе Ocelot,
* Имплементировать алгоритм балансировки нагрузки согласно варианту.
## Технологии

<br>
</details>
<details>
<summary>3. «Интеграционное тестирование» - Реализация файлового сервиса и объектного хранилища, интеграционное тестирование бекенда</summary>
<br>
- .NET 8
- .NET Aspire 9.5
- Bogus — генерация фейковых данных
- Redis — распределённое кэширование (`IDistributedCache`)
- Blazor WebAssembly — клиентское приложение
- Blazorise — UI-компоненты
- OpenTelemetry — структурное логирование и трассировка

В рамках третьей лабораторной работы необходимо:
* Добавить в оркестрацию объектное хранилище,
* Реализовать файловый сервис, сериализующий сгенерированные данные в файлы и сохраняющий их в объектном хранилище,
* Реализовать отправку генерируемых данных в файловый сервис посредством брокера,
* Реализовать интеграционные тесты, проверяющие корректность работы всех сервисов бекенда вместе.
## Характеристики генерируемого объекта

<br>
</details>
<details>
<summary>4. (Опционально) «Переход на облачную инфраструктуру» - Перенос бекенда в Yandex Cloud</summary>
<br>

В рамках четвертой лабораторной работы необходимо перенестиервисы на облако все ранее разработанные сервисы:
* Клиент - в хостинг через отдельный бакет Object Storage,
* Сервис генерации - в Cloud Function,
* Апи гейтвей - в Serverless Integration как API Gateway,
* Брокер сообщений - в Message Queue,
* Файловый сервис - в Cloud Function,
* Объектное хранилище - в отдельный бакет Object Storage,
| № | Характеристика | Тип данных | Источник Bogus |
|---|---|---|---|
| 1 | Идентификатор в системе | `int` | Параметр запроса |
| 2 | VIN-номер | `string` | `Vehicle.Vin()` |
| 3 | Производитель | `string` | `Vehicle.Manufacturer()` |
| 4 | Модель | `string` | `Vehicle.Model()` |
| 5 | Год выпуска | `int` | `Random.Int(1960, текущий год)` |
| 6 | Тип корпуса | `string` | `Vehicle.Type()` |
| 7 | Тип топлива | `string` | `Vehicle.Fuel()` |
| 8 | Цвет корпуса | `string` | `Commerce.Color()` |
| 9 | Пробег | `double` | `Random.Double(0, 1000000)` |
| 10 | Дата последнего техобслуживания | `DateOnly` | Между годом выпуска и текущей датой |

<br>
</details>
### Кэширование

## Задание. Общая часть
**Обязательно**:
* Реализация серверной части на [.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 с информацией о задании, скриншоты приложения и прочая информация.
- Ключ кэша: `vehicle:{id}`
- Время жизни: настраивается в `appsettings.json` (`Cache:ExpirationMinutes`, по умолчанию 5 минут)
- При ошибке чтения/записи кэша — логируется warning, запрос обрабатывается без кэша

**Факультативно**:
* Перенос бекенда на облачную инфраструктуру Yandex Cloud
## API

Внимательно прочитайте [дискуссии](https://github.com/itsecd/cloud-development/discussions/1) о том, как работает автоматическое распределение на ревью.
Сразу корректно называйте свои pr, чтобы они попали на ревью нужному преподавателю.

По итогу работы в семестре должна получиться следующая информационная система:
<details>
<summary>C4 диаграмма</summary>
<img width="1584" height="771" alt="Современные_технологии_разработки_ПО_drawio" src="https://github.com/user-attachments/assets/71d6356f-7eb4-463d-b9f3-c953e5312993" />
</details>

## Варианты заданий
Номер варианта задания присваивается в начале семестра. Изменить его нельзя. Каждый вариант имеет уникальную комбинацию из предметной области, базы данных и технологии для общения сервиса генерации данных и сервера апи.

[Список вариантов](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 /api/vehicle?id={id}
```

Возвращает JSON с данными транспортного средства. При повторном запросе с тем же `id` — данные берутся из кэша Redis.
57 changes: 57 additions & 0 deletions VehicleVault.Api/Entities/Vehicle.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
namespace VehicleVault.Api.Entities;

/// <summary>
/// Транспортное средство
/// </summary>
public class Vehicle
{
/// <summary>
/// Идентификатор в системе
/// </summary>
public int SystemId { get; set; }

/// <summary>
/// VIN-номер
/// </summary>
public required string Vin { get; set; }

/// <summary>
/// Производитель
/// </summary>
public required string Manufacturer { get; set; }

/// <summary>
/// Модель
/// </summary>
public required string Model { get; set; }

/// <summary>
/// Год выпуска
/// </summary>
public int Year { get; set; }

/// <summary>
/// Тип корпуса
/// </summary>
public required string BodyType { get; set; }

/// <summary>
/// Тип топлива
/// </summary>
public required string FuelType { get; set; }

/// <summary>
/// Цвет корпуса
/// </summary>
public required string BodyColor { get; set; }

/// <summary>
/// Пробег
/// </summary>
public double Mileage { get; set; }

/// <summary>
/// Дата последнего техобслуживания
/// </summary>
public DateOnly LastServiceDate { get; set; }
}
31 changes: 31 additions & 0 deletions VehicleVault.Api/Program.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
using VehicleVault.Api.Services;

var builder = WebApplication.CreateBuilder(args);

builder.AddServiceDefaults();
builder.AddRedisDistributedCache("cache");

builder.Services.AddSingleton<IVehicleGeneratorService, VehicleGeneratorService>();
builder.Services.AddSingleton<IVehicleCacheService, VehicleCacheService>();

var allowedOrigins = builder.Configuration.GetSection("Cors:AllowedOrigins").Get<string[]>() ?? [];

builder.Services.AddCors(options =>
{
options.AddDefaultPolicy(policy =>
{
policy.WithOrigins(allowedOrigins)
.AllowAnyHeader()
.WithMethods("GET");
});
});

var app = builder.Build();

app.MapDefaultEndpoints();
app.UseCors();

app.MapGet("api/vehicle", async (int id, IVehicleCacheService vehicleService) =>
await vehicleService.GetOrGenerate(id));

app.Run();
38 changes: 38 additions & 0 deletions VehicleVault.Api/Properties/launchSettings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"$schema": "http://json.schemastore.org/launchsettings.json",
"iisSettings": {
"windowsAuthentication": false,
"anonymousAuthentication": true,
"iisExpress": {
"applicationUrl": "http://localhost:12998",
"sslPort": 44340
}
},
"profiles": {
"http": {
"commandName": "Project",
"dotnetRunMessages": true,
"launchBrowser": true,
"applicationUrl": "http://localhost:5260",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
"https": {
"commandName": "Project",
"dotnetRunMessages": true,
"launchBrowser": true,
"applicationUrl": "https://localhost:7283;http://localhost:5260",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
},
"IIS Express": {
"commandName": "IISExpress",
"launchBrowser": true,
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
}
}
}
14 changes: 14 additions & 0 deletions VehicleVault.Api/Services/IVehicleCacheService.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
using VehicleVault.Api.Entities;

namespace VehicleVault.Api.Services;

/// <summary>
/// Сервис транспортных средств с кэшированием
/// </summary>
public interface IVehicleCacheService
{
/// <summary>
/// Получение или генерация транспортного средства по идентификатору
/// </summary>
public Task<Vehicle> GetOrGenerate(int id);
}
Loading
Loading