Архивация списков (#13)
Tests / frontend-test (push) Successful in 44s
Tests / backend-test (push) Failing after 17m4s

Co-authored-by: gorbenko.pavel <gorbenko.pavel@tansu.kz>
Reviewed-on: http://git.tnsu.kz/gorbenko.pavel/tnsu-approval-route/pulls/13
This commit was merged in pull request #13.
This commit is contained in:
2026-08-19 09:08:36 +00:00
parent a2672042d7
commit 82512eb1db
56 changed files with 2587 additions and 51 deletions
@@ -20,15 +20,32 @@ public static class InfrastructureServiceCollectionExtensions
opt.UseNpgsql(configuration.GetConnectionString("Postgres"))
.UseSnakeCaseNamingConvention());
services.AddAsyncInitializer<DatabaseMigrationInitializer>();
services.AddScoped<ListPartitioningLock>();
services.Configure<SharePointOptions>(configuration.GetSection("SharePoint"));
// Провайдер сертификата — синглтон: разобранный .pfx кешируется на всё
// время жизни процесса (см. DbCertificateProvider).
services.AddSingleton<ICertificateProvider, DbCertificateProvider>();
services.AddHttpClient<ISharePointClient, SharePointClient>();
services.AddScoped<ISharePointListProvisioner, SharePointListProvisioner>();
services.Configure<TnsuPortalOptions>(configuration.GetSection("TnsuPortal"));
services.AddHttpClient<TnsuPortalTokenProvider>();
// Токен вызывающего и общая авторизация запросов к порталу — одни на всех
// его клиентов (см. TnsuPortalCallerToken/TnsuPortalAuthorizer). Именно
// Scoped: Hangfire даёт задаче свою область DI, и положенный в задаче токен
// не должен протекать в соседние.
services.AddScoped<TnsuPortalCallerToken>();
services.AddScoped<TnsuPortalAuthorizer>();
// Подписка новых списков на уведомления SharePoint. Клиент отдельный от
// ITnsuPortalClient: там кешируемые чтения справочника, здесь команда.
// Своих опций нет — адрес приёмника лежит в SharePoint:NotificationUrl.
services.AddHttpClient<ISharePointWebhookSubscriber, HttpSharePointWebhookSubscriber>((sp, client) =>
{
var options = sp.GetRequiredService<IOptions<TnsuPortalOptions>>().Value;
client.BaseAddress = new Uri(options.BaseUrl);
});
// ITnsuPortalClient резолвится в CachingTnsuPortalClient (кеш на 5 минут,
// см. её комментарий) — сам HttpTnsuPortalClient регистрируем по
// конкретному типу, а не по интерфейсу, чтобы декоратор мог его получить
@@ -7,6 +7,7 @@ namespace Tnsu.ApprovalRoute.Infrastructure.Persistence;
public class ApprovalRouteDbContext(DbContextOptions<ApprovalRouteDbContext> options) : DbContext(options)
{
public DbSet<RequestType> RequestTypes => Set<RequestType>();
public DbSet<RequestListPartition> RequestListPartitions => Set<RequestListPartition>();
public DbSet<TemplateRoute> TemplateRoutes => Set<TemplateRoute>();
public DbSet<TemplateRouteStep> TemplateRouteSteps => Set<TemplateRouteStep>();
public DbSet<AppSetting> Settings => Set<AppSetting>();
@@ -33,6 +34,18 @@ public class ApprovalRouteDbContext(DbContextOptions<ApprovalRouteDbContext> opt
e.Property(x => x.Section).HasMaxLength(256).IsRequired();
});
modelBuilder.Entity<RequestListPartition>(e =>
{
e.HasKey(x => x.Id);
e.Property(x => x.ListId).HasMaxLength(512).IsRequired();
e.Property(x => x.Title).HasMaxLength(512);
e.HasOne(x => x.RequestType).WithMany(x => x.ListPartitions).HasForeignKey(x => x.RequestTypeId);
// Номер уникален в пределах типа заявок — вторая попытка записать тот же
// номер (например, при двойном запуске задачи) упадёт на этом индексе,
// а не создаст в реестре дубль.
e.HasIndex(x => new { x.RequestTypeId, x.Number }).IsUnique();
});
modelBuilder.Entity<TemplateRoute>(e =>
{
e.HasKey(x => x.Id);
@@ -0,0 +1,51 @@
using Microsoft.EntityFrameworkCore;
namespace Tnsu.ApprovalRoute.Infrastructure.Persistence;
/// <summary>
/// Блокировка «по типу заявок идёт создание следующей партиции списка» на строке
/// request_types.
///
/// Почему сырой SQL, а не обычный EF: через change tracker это было бы
/// read-modify-write (прочитали флаг → проверили → записали), и две задачи,
/// прочитавшие null одновременно, обе решили бы, что блокировка свободна.
/// Здесь проверка и захват — ОДИН условный UPDATE, атомарный на уровне строки:
/// Postgres берёт row lock на время оператора, поэтому ровно одна из
/// конкурирующих задач увидит affected rows = 1, остальные — 0.
///
/// Никакого pg_advisory_lock: он живёт в рамках сессии, а нам нужно, чтобы
/// блокировку было видно в самой строке (админке — что провижининг идёт) и чтобы
/// она переживала возврат соединения в пул между шагами задачи.
/// </summary>
public sealed class ListPartitioningLock(ApprovalRouteDbContext db)
{
/// <summary>
/// Попытаться захватить блокировку. true — захватили (и только тогда можно
/// провижинить), false — держит кто-то другой либо типа заявок нет.
///
/// Блокировка старше staleAfter считается брошенной (процесс упал, не сняв
/// флаг) и перехватывается.
/// </summary>
public async Task<bool> TryAcquireAsync(int requestTypeId, TimeSpan staleAfter, CancellationToken cancellationToken)
{
// Имена таблицы/колонки — snake_case из UseSnakeCaseNamingConvention
// (см. InfrastructureServiceCollectionExtensions).
var affected = await db.Database.ExecuteSqlInterpolatedAsync(
$"""
UPDATE request_types
SET list_partitioning_started_at = now()
WHERE id = {requestTypeId}
AND (list_partitioning_started_at IS NULL
OR list_partitioning_started_at < now() - CAST({staleAfter} AS interval))
""",
cancellationToken);
return affected == 1;
}
/// <summary>Снять блокировку. Идемпотентно: снятая блокировка снимается повторно без ошибки.</summary>
public Task ReleaseAsync(int requestTypeId, CancellationToken cancellationToken) =>
db.Database.ExecuteSqlInterpolatedAsync(
$"UPDATE request_types SET list_partitioning_started_at = NULL WHERE id = {requestTypeId}",
cancellationToken);
}
@@ -0,0 +1,314 @@
// <auto-generated />
using System;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Infrastructure;
using Microsoft.EntityFrameworkCore.Migrations;
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
using Tnsu.ApprovalRoute.Infrastructure.Persistence;
#nullable disable
namespace Tnsu.ApprovalRoute.Infrastructure.Persistence.Migrations
{
[DbContext(typeof(ApprovalRouteDbContext))]
[Migration("20260817102423_AddListPartitioning")]
partial class AddListPartitioning
{
/// <inheritdoc />
protected override void BuildTargetModel(ModelBuilder modelBuilder)
{
#pragma warning disable 612, 618
modelBuilder
.HasAnnotation("ProductVersion", "10.0.10")
.HasAnnotation("Relational:MaxIdentifierLength", 63);
NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.RequestListPartition", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("integer")
.HasColumnName("id");
NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("Id"));
b.Property<DateTimeOffset>("CreatedAt")
.HasColumnType("timestamp with time zone")
.HasColumnName("created_at");
b.Property<string>("ListId")
.IsRequired()
.HasMaxLength(512)
.HasColumnType("character varying(512)")
.HasColumnName("list_id");
b.Property<int>("Number")
.HasColumnType("integer")
.HasColumnName("number");
b.Property<int>("RequestTypeId")
.HasColumnType("integer")
.HasColumnName("request_type_id");
b.Property<string>("Title")
.HasMaxLength(512)
.HasColumnType("character varying(512)")
.HasColumnName("title");
b.HasKey("Id")
.HasName("pk_request_list_partitions");
b.HasIndex("RequestTypeId", "Number")
.IsUnique()
.HasDatabaseName("ix_request_list_partitions_request_type_id_number");
b.ToTable("request_list_partitions", (string)null);
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.RequestType", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("integer")
.HasColumnName("id");
NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("Id"));
b.Property<bool?>("AskOverdueReason")
.HasColumnType("boolean")
.HasColumnName("ask_overdue_reason");
b.Property<string>("ListId")
.HasMaxLength(512)
.HasColumnType("character varying(512)")
.HasColumnName("list_id");
b.Property<DateTimeOffset?>("ListPartitioningStartedAt")
.HasColumnType("timestamp with time zone")
.HasColumnName("list_partitioning_started_at");
b.Property<string>("Name")
.IsRequired()
.HasMaxLength(256)
.HasColumnType("character varying(256)")
.HasColumnName("name");
b.Property<string>("PageUrl")
.IsRequired()
.HasMaxLength(512)
.HasColumnType("character varying(512)")
.HasColumnName("page_url");
b.Property<string>("Section")
.IsRequired()
.HasMaxLength(256)
.HasColumnType("character varying(256)")
.HasColumnName("section");
b.Property<string>("SiteUrl")
.HasMaxLength(512)
.HasColumnType("character varying(512)")
.HasColumnName("site_url");
b.Property<int?>("SlaHours")
.HasColumnType("integer")
.HasColumnName("sla_hours");
b.HasKey("Id")
.HasName("pk_request_types");
b.ToTable("request_types", (string)null);
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.TemplateRoute", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("integer")
.HasColumnName("id");
NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("Id"));
b.Property<bool>("ByProject")
.HasColumnType("boolean")
.HasColumnName("by_project");
b.Property<Guid?>("CompanyId")
.HasColumnType("uuid")
.HasColumnName("company_id");
b.Property<Guid?>("DepartmentId")
.HasColumnType("uuid")
.HasColumnName("department_id");
b.Property<int>("RequestTypeId")
.HasColumnType("integer")
.HasColumnName("request_type_id");
b.Property<bool>("RequiresControl")
.HasColumnType("boolean")
.HasColumnName("requires_control");
b.HasKey("Id")
.HasName("pk_template_routes");
b.HasIndex("RequestTypeId", "DepartmentId", "CompanyId", "ByProject")
.IsUnique()
.HasDatabaseName("ix_template_routes_request_type_id_department_id_company_id_by");
b.ToTable("template_routes", (string)null);
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.TemplateRouteStep", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("integer")
.HasColumnName("id");
NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("Id"));
b.Property<bool>("AllowReassignToOtherApprovers")
.HasColumnType("boolean")
.HasColumnName("allow_reassign_to_other_approvers");
b.Property<bool?>("AskOverdueReason")
.HasColumnType("boolean")
.HasColumnName("ask_overdue_reason");
b.Property<string>("ExecutorEmail")
.HasMaxLength(256)
.HasColumnType("character varying(256)")
.HasColumnName("executor_email");
b.Property<string>("FieldName")
.HasMaxLength(128)
.HasColumnType("character varying(128)")
.HasColumnName("field_name");
b.Property<string>("HeadType")
.HasMaxLength(32)
.HasColumnType("character varying(32)")
.HasColumnName("head_type");
b.Property<string>("Operation")
.HasMaxLength(32)
.HasColumnType("character varying(32)")
.HasColumnName("operation");
b.Property<int>("OrderNo")
.HasColumnType("integer")
.HasColumnName("order_no");
b.Property<string>("Position")
.HasMaxLength(128)
.HasColumnType("character varying(128)")
.HasColumnName("position");
b.Property<string>("ProjectRole")
.HasMaxLength(32)
.HasColumnType("character varying(32)")
.HasColumnName("project_role");
b.Property<int>("RouteId")
.HasColumnType("integer")
.HasColumnName("route_id");
b.Property<int?>("SlaHours")
.HasColumnType("integer")
.HasColumnName("sla_hours");
b.Property<string>("Status")
.IsRequired()
.HasMaxLength(32)
.HasColumnType("character varying(32)")
.HasColumnName("status");
b.Property<string>("Value")
.HasMaxLength(256)
.HasColumnType("character varying(256)")
.HasColumnName("value");
b.HasKey("Id")
.HasName("pk_template_route_steps");
b.HasIndex("RouteId", "OrderNo")
.HasDatabaseName("ix_template_route_steps_route_id_order_no");
b.ToTable("template_route_steps", (string)null);
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Infrastructure.Persistence.Entities.AppSetting", b =>
{
b.Property<string>("OptionName")
.HasMaxLength(128)
.HasColumnType("character varying(128)")
.HasColumnName("option_name");
b.Property<byte[]>("FileData")
.HasColumnType("bytea")
.HasColumnName("file_data");
b.Property<string>("Value")
.HasColumnType("text")
.HasColumnName("value");
b.HasKey("OptionName")
.HasName("pk_settings");
b.ToTable("settings", (string)null);
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.RequestListPartition", b =>
{
b.HasOne("Tnsu.ApprovalRoute.Domain.Entities.RequestType", "RequestType")
.WithMany("ListPartitions")
.HasForeignKey("RequestTypeId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired()
.HasConstraintName("fk_request_list_partitions_request_types_request_type_id");
b.Navigation("RequestType");
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.TemplateRoute", b =>
{
b.HasOne("Tnsu.ApprovalRoute.Domain.Entities.RequestType", "RequestType")
.WithMany("Routes")
.HasForeignKey("RequestTypeId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired()
.HasConstraintName("fk_template_routes_request_types_request_type_id");
b.Navigation("RequestType");
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.TemplateRouteStep", b =>
{
b.HasOne("Tnsu.ApprovalRoute.Domain.Entities.TemplateRoute", "Route")
.WithMany("Steps")
.HasForeignKey("RouteId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired()
.HasConstraintName("fk_template_route_steps_template_routes_route_id");
b.Navigation("Route");
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.RequestType", b =>
{
b.Navigation("ListPartitions");
b.Navigation("Routes");
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.TemplateRoute", b =>
{
b.Navigation("Steps");
});
#pragma warning restore 612, 618
}
}
}
@@ -0,0 +1,62 @@
using System;
using Microsoft.EntityFrameworkCore.Migrations;
using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata;
#nullable disable
namespace Tnsu.ApprovalRoute.Infrastructure.Persistence.Migrations
{
/// <inheritdoc />
public partial class AddListPartitioning : Migration
{
/// <inheritdoc />
protected override void Up(MigrationBuilder migrationBuilder)
{
migrationBuilder.AddColumn<DateTimeOffset>(
name: "list_partitioning_started_at",
table: "request_types",
type: "timestamp with time zone",
nullable: true);
migrationBuilder.CreateTable(
name: "request_list_partitions",
columns: table => new
{
id = table.Column<int>(type: "integer", nullable: false)
.Annotation("Npgsql:ValueGenerationStrategy", NpgsqlValueGenerationStrategy.IdentityByDefaultColumn),
request_type_id = table.Column<int>(type: "integer", nullable: false),
number = table.Column<int>(type: "integer", nullable: false),
list_id = table.Column<string>(type: "character varying(512)", maxLength: 512, nullable: false),
title = table.Column<string>(type: "character varying(512)", maxLength: 512, nullable: true),
created_at = table.Column<DateTimeOffset>(type: "timestamp with time zone", nullable: false)
},
constraints: table =>
{
table.PrimaryKey("pk_request_list_partitions", x => x.id);
table.ForeignKey(
name: "fk_request_list_partitions_request_types_request_type_id",
column: x => x.request_type_id,
principalTable: "request_types",
principalColumn: "id",
onDelete: ReferentialAction.Cascade);
});
migrationBuilder.CreateIndex(
name: "ix_request_list_partitions_request_type_id_number",
table: "request_list_partitions",
columns: new[] { "request_type_id", "number" },
unique: true);
}
/// <inheritdoc />
protected override void Down(MigrationBuilder migrationBuilder)
{
migrationBuilder.DropTable(
name: "request_list_partitions");
migrationBuilder.DropColumn(
name: "list_partitioning_started_at",
table: "request_types");
}
}
}
@@ -22,6 +22,48 @@ namespace Tnsu.ApprovalRoute.Infrastructure.Persistence.Migrations
NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder);
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.RequestListPartition", b =>
{
b.Property<int>("Id")
.ValueGeneratedOnAdd()
.HasColumnType("integer")
.HasColumnName("id");
NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property<int>("Id"));
b.Property<DateTimeOffset>("CreatedAt")
.HasColumnType("timestamp with time zone")
.HasColumnName("created_at");
b.Property<string>("ListId")
.IsRequired()
.HasMaxLength(512)
.HasColumnType("character varying(512)")
.HasColumnName("list_id");
b.Property<int>("Number")
.HasColumnType("integer")
.HasColumnName("number");
b.Property<int>("RequestTypeId")
.HasColumnType("integer")
.HasColumnName("request_type_id");
b.Property<string>("Title")
.HasMaxLength(512)
.HasColumnType("character varying(512)")
.HasColumnName("title");
b.HasKey("Id")
.HasName("pk_request_list_partitions");
b.HasIndex("RequestTypeId", "Number")
.IsUnique()
.HasDatabaseName("ix_request_list_partitions_request_type_id_number");
b.ToTable("request_list_partitions", (string)null);
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.RequestType", b =>
{
b.Property<int>("Id")
@@ -40,6 +82,10 @@ namespace Tnsu.ApprovalRoute.Infrastructure.Persistence.Migrations
.HasColumnType("character varying(512)")
.HasColumnName("list_id");
b.Property<DateTimeOffset?>("ListPartitioningStartedAt")
.HasColumnType("timestamp with time zone")
.HasColumnName("list_partitioning_started_at");
b.Property<string>("Name")
.IsRequired()
.HasMaxLength(256)
@@ -212,6 +258,18 @@ namespace Tnsu.ApprovalRoute.Infrastructure.Persistence.Migrations
b.ToTable("settings", (string)null);
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.RequestListPartition", b =>
{
b.HasOne("Tnsu.ApprovalRoute.Domain.Entities.RequestType", "RequestType")
.WithMany("ListPartitions")
.HasForeignKey("RequestTypeId")
.OnDelete(DeleteBehavior.Cascade)
.IsRequired()
.HasConstraintName("fk_request_list_partitions_request_types_request_type_id");
b.Navigation("RequestType");
});
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.TemplateRoute", b =>
{
b.HasOne("Tnsu.ApprovalRoute.Domain.Entities.RequestType", "RequestType")
@@ -238,6 +296,8 @@ namespace Tnsu.ApprovalRoute.Infrastructure.Persistence.Migrations
modelBuilder.Entity("Tnsu.ApprovalRoute.Domain.Entities.RequestType", b =>
{
b.Navigation("ListPartitions");
b.Navigation("Routes");
});
@@ -0,0 +1,27 @@
namespace Tnsu.ApprovalRoute.Infrastructure.SharePoint;
/// <summary>Созданный список: серверный относительный url (он же ListId) и Title.</summary>
public sealed record ProvisionedList(string ListId, string Title);
/// <summary>
/// Создание следующей пары списков серии в SharePoint («&lt;Форма&gt; &lt;N&gt; — данные»
/// + «&lt;Форма&gt; &lt;N&gt; — согласование») дублированием текущей пары.
///
/// Интерфейс живёт в Infrastructure, а не в Application, потому что Application уже
/// ссылается на Infrastructure (так же устроен <see cref="ISharePointClient"/>) —
/// обратная ссылка замкнула бы проекты в кольцо.
/// </summary>
public interface ISharePointListProvisioner
{
/// <summary>
/// Создать пару списков с номером <paramref name="number"/>, скопировав структуру
/// со списка <paramref name="sourceDataListId"/>. Возвращает созданный список ДАННЫХ
/// (список согласования создаётся тем же вызовом, но наружу не отдаётся — его
/// находят по конвенции имени).
/// </summary>
Task<ProvisionedList> CreateNextListPairAsync(
string siteUrl,
string sourceDataListId,
int number,
CancellationToken cancellationToken);
}
@@ -0,0 +1,54 @@
using System.Text.RegularExpressions;
namespace Tnsu.ApprovalRoute.Infrastructure.SharePoint;
/// <summary>
/// Конвенция имён списков заявок: «&lt;Форма&gt; &lt;N&gt; — данные» и парный ему
/// «&lt;Форма&gt; &lt;N&gt; — согласование».
///
/// Третья копия одного и того же соглашения — оно же в провижинере request-portal
/// (provisioning/Provision-Lists.ps1, Get-NumberedListTitle) и в самом портале
/// (shared/listTitles.ts). Держать в одном месте не получается: три разных runtime.
/// Меняя здесь, менять и там.
///
/// Номер стоит ПЕРЕД суффиксом, потому что имя списка согласования и портал, и
/// админка выводят из имени списка данных регексом, привязанным к концу строки.
/// </summary>
internal static class ListTitleConvention
{
private const string DataSuffix = "данные";
private const string ApprovalSuffix = "согласование";
private static readonly Regex TitlePattern = new(
@"^(?<base>.+?)\s*—\s*(?<suffix>данные|согласование)\s*$",
RegexOptions.Compiled);
private static readonly Regex TrailingNumber = new(@"\s+\d+$", RegexOptions.Compiled);
/// <summary>
/// Имя того же списка с номером <paramref name="number"/>. Уже имеющийся номер
/// заменяется, а не дописывается вторым.
/// </summary>
public static string WithNumber(string title, int number)
{
var match = TitlePattern.Match(title);
if (!match.Success)
throw new InvalidOperationException(
$"Имя списка «{title}» не по конвенции «<Форма> — данные|согласование» — номер поставить некуда.");
var baseName = TrailingNumber.Replace(match.Groups["base"].Value, string.Empty);
return $"{baseName} {number} — {match.Groups["suffix"].Value}";
}
/// <summary>
/// Имя парного списка согласования по имени списка данных (номер сохраняется).
/// null — имя не по конвенции либо это не список данных.
/// </summary>
public static string? ToApprovalTitle(string dataListTitle)
{
var match = TitlePattern.Match(dataListTitle);
if (!match.Success || match.Groups["suffix"].Value != DataSuffix) return null;
return $"{match.Groups["base"].Value} — {ApprovalSuffix}";
}
}
@@ -7,11 +7,45 @@ using Microsoft.Extensions.Options;
namespace Tnsu.ApprovalRoute.Infrastructure.SharePoint;
/// <summary>Список SharePoint: Id нужен для операций над колонками, url — как ссылка на список.</summary>
public sealed record SharePointListInfo(Guid Id, string Title, string ServerRelativeUrl, int ItemCount);
/// <summary>Колонка списка в виде её SchemaXml — в таком виде её можно создать в другом списке.</summary>
public sealed record SharePointFieldSchema(string InternalName, string SchemaXml);
public interface ISharePointClient
{
/// <summary>Список по серверному относительному url. null — списка нет.</summary>
Task<SharePointListInfo?> GetListByUrlAsync(
string siteUrl, string listServerRelativeUrl, CancellationToken cancellationToken);
/// <summary>Список по заголовку. null — списка нет.</summary>
Task<SharePointListInfo?> GetListByTitleAsync(
string siteUrl, string listTitle, CancellationToken cancellationToken);
/// <summary>
/// Пользовательские колонки списка — те, что нужно повторить в дубле. Системные
/// (унаследованные от базового типа, скрытые, только для чтения) отфильтрованы:
/// они появляются в новом списке сами.
/// </summary>
Task<IReadOnlyList<SharePointFieldSchema>> GetCustomFieldsAsync(
string siteUrl, string listServerRelativeUrl, CancellationToken cancellationToken);
/// <summary>Создать пустой список (GenericList с версионированием) и вернуть его.</summary>
Task<SharePointListInfo> CreateListAsync(string siteUrl, string title, CancellationToken cancellationToken);
/// <summary>Создать колонку в списке из её SchemaXml.</summary>
Task AddFieldFromXmlAsync(string siteUrl, Guid listId, string schemaXml, CancellationToken cancellationToken);
/// <summary>Заголовок списка по его серверному относительному URL (см. RequestType.ListId).</summary>
Task<string?> GetListTitleAsync(string siteUrl, string listServerRelativeUrl, CancellationToken cancellationToken);
/// <summary>
/// Число элементов в списке (ItemCount самого списка, без выгрузки элементов) —
/// по нему решается, не пора ли заводить следующий список серии.
/// </summary>
Task<int?> GetItemCountAsync(string siteUrl, string listServerRelativeUrl, CancellationToken cancellationToken);
/// <summary>Элементы списка данных, найденного по серверному относительному URL.</summary>
Task<IReadOnlyList<JsonElement>> GetItemsByListUrlAsync(
string siteUrl, string listServerRelativeUrl, string odataQuery, CancellationToken cancellationToken);
@@ -50,6 +84,116 @@ public sealed class SharePointClient(
return json.TryGetProperty("Title", out var title) ? title.GetString() : null;
}
public Task<SharePointListInfo?> GetListByUrlAsync(
string siteUrl, string listServerRelativeUrl, CancellationToken cancellationToken) =>
GetListInfoAsync(
siteUrl,
$"{siteUrl.TrimEnd('/')}/_api/web/getList('{Escape(listServerRelativeUrl)}')",
cancellationToken);
public Task<SharePointListInfo?> GetListByTitleAsync(
string siteUrl, string listTitle, CancellationToken cancellationToken) =>
GetListInfoAsync(
siteUrl,
$"{siteUrl.TrimEnd('/')}/_api/web/lists/getByTitle('{Escape(listTitle)}')",
cancellationToken);
private async Task<SharePointListInfo?> GetListInfoAsync(
string siteUrl, string listUrl, CancellationToken cancellationToken)
{
var url = $"{listUrl}?$select=Id,Title,ItemCount,RootFolder/ServerRelativeUrl&$expand=RootFolder";
var json = await TryGetAsync(siteUrl, url, cancellationToken);
if (json is null) return null;
var value = json.Value;
var serverRelativeUrl = value.TryGetProperty("RootFolder", out var rootFolder)
&& rootFolder.TryGetProperty("ServerRelativeUrl", out var relative)
? relative.GetString()
: null;
if (serverRelativeUrl is null) return null;
return new SharePointListInfo(
value.GetProperty("Id").GetGuid(),
value.GetProperty("Title").GetString() ?? string.Empty,
serverRelativeUrl,
value.TryGetProperty("ItemCount", out var count) && count.TryGetInt32(out var items) ? items : 0);
}
public async Task<IReadOnlyList<SharePointFieldSchema>> GetCustomFieldsAsync(
string siteUrl, string listServerRelativeUrl, CancellationToken cancellationToken)
{
// Ни FromBaseType, ни CanBeDeleted не годятся как признак «колонку явно
// добавили в список»: у переиспользуемых стандартных site-колонок SharePoint
// (например, «Department» — встроенная текстовая колонка из схемы v3,
// подключаемая через DelayActivateTemplateBinding) ОБА флага стоят как у
// настоящего системного поля, хотя колонка реально добавлена в список и в
// неё пишут данные. Из-за этого такие колонки тихо выпадали из копирования —
// без ошибки, просто без предупреждения.
//
// Поэтому здесь фильтруем только Hidden/ReadOnlyField (их создать всё равно
// нельзя), а отделять настоящие базовые поля (Title, ID, ContentType …) от
// явно добавленных — задача вызывающего кода: он сравнивает с полями
// ТОЛЬКО ЧТО СОЗДАННОГО пустого списка того же шаблона (см. CloneAsync,
// alreadyThere) — то, что есть на обоих, действительно базовое; то, что
// есть только на источнике, добавлено явно, независимо от флагов SharePoint.
var url = $"{siteUrl.TrimEnd('/')}/_api/web/getList('{Escape(listServerRelativeUrl)}')/fields" +
"?$select=InternalName,SchemaXml,Hidden,ReadOnlyField" +
"&$filter=Hidden eq false and ReadOnlyField eq false";
var json = await GetAsync(siteUrl, url, cancellationToken);
var rows = json.TryGetProperty("value", out var value) && value.ValueKind == JsonValueKind.Array
? value.EnumerateArray()
: json.EnumerateArray();
var fields = new List<SharePointFieldSchema>();
foreach (var row in rows)
{
var internalName = row.TryGetProperty("InternalName", out var name) ? name.GetString() : null;
var schemaXml = row.TryGetProperty("SchemaXml", out var schema) ? schema.GetString() : null;
if (internalName is null || schemaXml is null) continue;
fields.Add(new SharePointFieldSchema(internalName, schemaXml));
}
return fields;
}
public async Task<SharePointListInfo> CreateListAsync(
string siteUrl, string title, CancellationToken cancellationToken)
{
// BaseTemplate 100 — GenericList, как -Template GenericList у провижинера.
await PostAsync(
siteUrl,
$"{siteUrl.TrimEnd('/')}/_api/web/lists",
JsonSerializer.Serialize(new { Title = title, BaseTemplate = 100, EnableVersioning = true }),
cancellationToken);
// Ответ POST'а не отдаёт RootFolder, а нам нужен серверный относительный url —
// дочитываем список отдельным запросом.
return await GetListByTitleAsync(siteUrl, title, cancellationToken)
?? throw new InvalidOperationException($"Список «{title}» создан, но не читается обратно.");
}
public Task AddFieldFromXmlAsync(
string siteUrl, Guid listId, string schemaXml, CancellationToken cancellationToken) =>
PostAsync(
siteUrl,
$"{siteUrl.TrimEnd('/')}/_api/web/lists(guid'{listId}')/fields/createfieldasxml",
// Options = 8 (AddFieldInternalNameHint): SharePoint обязан сохранить
// InternalName из SchemaXml, а не сгенерировать свой. К колонкам обращается
// код портала именно по внутреннему имени, так что это не косметика.
JsonSerializer.Serialize(new { parameters = new { SchemaXml = schemaXml, Options = 8 } }),
cancellationToken);
public async Task<int?> GetItemCountAsync(
string siteUrl, string listServerRelativeUrl, CancellationToken cancellationToken)
{
var url = $"{siteUrl.TrimEnd('/')}/_api/web/getList('{Escape(listServerRelativeUrl)}')?$select=ItemCount";
var json = await GetAsync(siteUrl, url, cancellationToken);
return json.TryGetProperty("ItemCount", out var count) && count.TryGetInt32(out var value) ? value : null;
}
public Task<IReadOnlyList<JsonElement>> GetItemsByListUrlAsync(
string siteUrl, string listServerRelativeUrl, string odataQuery, CancellationToken cancellationToken) =>
GetItemsAsync(
@@ -79,9 +223,26 @@ public sealed class SharePointClient(
: [];
}
private async Task<JsonElement> GetAsync(string siteUrl, string url, CancellationToken cancellationToken)
private async Task<JsonElement> GetAsync(string siteUrl, string url, CancellationToken cancellationToken) =>
await SendAsync(HttpMethod.Get, siteUrl, url, body: null, allowNotFound: false, cancellationToken)
?? throw new InvalidOperationException($"SharePoint не вернул тело на {url}.");
/// <summary>GET, для которого «нет такого списка» — не ошибка, а null.</summary>
private Task<JsonElement?> TryGetAsync(string siteUrl, string url, CancellationToken cancellationToken) =>
SendAsync(HttpMethod.Get, siteUrl, url, body: null, allowNotFound: true, cancellationToken);
private Task PostAsync(string siteUrl, string url, string json, CancellationToken cancellationToken) =>
SendAsync(HttpMethod.Post, siteUrl, url, json, allowNotFound: false, cancellationToken);
private async Task<JsonElement?> SendAsync(
HttpMethod method,
string siteUrl,
string url,
string? body,
bool allowNotFound,
CancellationToken cancellationToken)
{
using var request = new HttpRequestMessage(HttpMethod.Get, url);
using var request = new HttpRequestMessage(method, url);
request.Headers.Authorization = new AuthenticationHeaderValue(
"Bearer", await GetTokenAsync(siteUrl, cancellationToken));
request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")
@@ -89,14 +250,30 @@ public sealed class SharePointClient(
Parameters = { new NameValueHeaderValue("odata", "nometadata") }
});
if (body is not null)
{
request.Content = new StringContent(body);
// odata=nometadata и на запись: тогда в теле не нужен блок __metadata с
// типом сущности — SharePoint выводит тип из самого эндпоинта.
request.Content.Headers.ContentType = new MediaTypeHeaderValue("application/json")
{
Parameters = { new NameValueHeaderValue("odata", "nometadata") }
};
}
using var response = await httpClient.SendAsync(request, cancellationToken);
var body = await response.Content.ReadAsStringAsync(cancellationToken);
var responseBody = await response.Content.ReadAsStringAsync(cancellationToken);
if (allowNotFound && response.StatusCode == System.Net.HttpStatusCode.NotFound)
return null;
if (!response.IsSuccessStatusCode)
throw new InvalidOperationException(
$"SharePoint ответил {(int)response.StatusCode} на {url}: {body}");
$"SharePoint ответил {(int)response.StatusCode} на {method} {url}: {responseBody}");
using var document = JsonDocument.Parse(body);
if (string.IsNullOrWhiteSpace(responseBody)) return null;
using var document = JsonDocument.Parse(responseBody);
return document.RootElement.Clone();
}
@@ -0,0 +1,174 @@
using System.Diagnostics;
using Microsoft.Extensions.Logging;
using Tnsu.ApprovalRoute.Infrastructure.TnsuPortal;
namespace Tnsu.ApprovalRoute.Infrastructure.SharePoint;
/// <summary>
/// Создаёт следующую пару списков ДУБЛИРОВАНИЕМ текущей: берёт структуру живого
/// списка (его пользовательские колонки) и повторяет её в новом списке с
/// номером N+1. Манифесты provisioning.json request-portal при этом не читаются —
/// источник структуры сам SharePoint, поэтому дубль не может разойтись с тем, что
/// реально в списке.
///
/// Идемпотентен: список с целевым именем переиспользуется, уже существующие колонки
/// пропускаются. Повторный запуск после частичного сбоя дозаполняет недостающее, а
/// не создаёт второй список.
/// </summary>
public sealed class SharePointListProvisioner(
ISharePointClient sharePoint,
ISharePointWebhookSubscriber webhookSubscriber,
ILogger<SharePointListProvisioner> logger) : ISharePointListProvisioner
{
public async Task<ProvisionedList> CreateNextListPairAsync(
string siteUrl,
string sourceDataListId,
int number,
CancellationToken cancellationToken)
{
logger.LogInformation(
"Дублирую пару списков №{Number} на {SiteUrl} по образцу {SourceListId}.",
number, siteUrl, sourceDataListId);
var stopwatch = Stopwatch.StartNew();
var sourceData = await sharePoint.GetListByUrlAsync(siteUrl, sourceDataListId, cancellationToken)
?? throw new InvalidOperationException(
$"Исходный список {sourceDataListId} не найден на {siteUrl} — дублировать нечего.");
var newData = await CloneAsync(
siteUrl,
sourceData,
ListTitleConvention.WithNumber(sourceData.Title, number),
role: "данные",
retarget: null,
cancellationToken);
await CloneApprovalPairAsync(siteUrl, sourceData, newData, number, cancellationToken);
logger.LogInformation(
"Пара списков №{Number} готова за {ElapsedMs} мс: данные «{Title}» ({ListId}).",
number, stopwatch.ElapsedMilliseconds, newData.Title, newData.ServerRelativeUrl);
// Подписка — ПОСЛЕДНИМ шагом, когда списки уже созданы:
// • подписывать нечего, пока списка нет;
// • только для списка ДАННЫХ — заявки портал отслеживает по нему, списку
// согласования подписка не нужна;
// • в самом конце, а не сразу после создания списка данных: сорвись
// дублирование пары на списке согласования, подписка была бы уже
// заведена, и повтор задачи Hangfire отправил бы второй запрос на ту же
// подписку (идемпотентна ли ручка портала — неизвестно).
// Не бросает и провижининг не рушит (см. ISharePointWebhookSubscriber).
await webhookSubscriber.TrySubscribeAsync(siteUrl, newData.Title, cancellationToken);
return new ProvisionedList(newData.ServerRelativeUrl, newData.Title);
}
/// <summary>
/// Дублирует парный список согласования. Его не на что сослаться, кроме имени:
/// в БД хранится ссылка только на список данных, а согласование ищется по
/// конвенции — так же, как это делают портал и админка.
/// </summary>
private async Task CloneApprovalPairAsync(
string siteUrl,
SharePointListInfo sourceData,
SharePointListInfo newData,
int number,
CancellationToken cancellationToken)
{
var sourceApprovalTitle = ListTitleConvention.ToApprovalTitle(sourceData.Title);
if (sourceApprovalTitle is null)
{
logger.LogWarning(
"Список «{Title}» не по конвенции «… — данные» — парный список согласования не дублируется.",
sourceData.Title);
return;
}
var sourceApproval = await sharePoint.GetListByTitleAsync(siteUrl, sourceApprovalTitle, cancellationToken);
if (sourceApproval is null)
{
logger.LogWarning(
"Список согласования «{Title}» не найден — дублируется только список данных.",
sourceApprovalTitle);
return;
}
await CloneAsync(
siteUrl,
sourceApproval,
ListTitleConvention.WithNumber(sourceApproval.Title, number),
role: "согласование",
// Ticket списка согласования смотрит на список данных — в дубле он должен
// смотреть на НОВЫЙ список данных, иначе строки маршрута новых заявок
// будут ссылаться в старый список.
retarget: (sourceData.Id, newData.Id),
cancellationToken);
}
/// <summary>
/// role — только для логов («данные»/«согласование»): по нему в логе видно, какую
/// половину пары обрабатывает конкретный вызов, не заглядывая в стек вызовов.
/// </summary>
private async Task<SharePointListInfo> CloneAsync(
string siteUrl,
SharePointListInfo source,
string newTitle,
string role,
(Guid From, Guid To)? retarget,
CancellationToken cancellationToken)
{
var existing = await sharePoint.GetListByTitleAsync(siteUrl, newTitle, cancellationToken);
var target = existing ?? await sharePoint.CreateListAsync(siteUrl, newTitle, cancellationToken);
logger.LogInformation(
existing is null
? "Список {Role} «{Title}» создан."
: "Список {Role} «{Title}» уже существует — дозаполняю недостающие колонки.",
role, newTitle);
var sourceFields = await sharePoint.GetCustomFieldsAsync(siteUrl, source.ServerRelativeUrl, cancellationToken);
var targetFields = await sharePoint.GetCustomFieldsAsync(siteUrl, target.ServerRelativeUrl, cancellationToken);
var alreadyThere = targetFields.Select(x => x.InternalName).ToHashSet(StringComparer.OrdinalIgnoreCase);
var copied = 0;
foreach (var field in sourceFields)
{
if (alreadyThere.Contains(field.InternalName)) continue;
var schemaXml = retarget is null
? field.SchemaXml
: RetargetLookup(field.SchemaXml, retarget.Value.From, retarget.Value.To);
await sharePoint.AddFieldFromXmlAsync(siteUrl, target.Id, schemaXml, cancellationToken);
copied++;
// По каждой колонке — только на Debug: при штатной первой партии их
// десятки на список, и на Information это был бы шум. Итог всё равно
// виден в сводке ниже.
logger.LogDebug(
"Список {Role} «{Title}»: скопирована колонка {InternalName}.", role, newTitle, field.InternalName);
}
logger.LogInformation(
"Список {Role} «{Title}»: скопировано колонок {Copied}, уже было {AlreadyThere}.",
role, newTitle, copied, sourceFields.Count - copied);
return target;
}
/// <summary>
/// Перенацеливает Lookup на новый список данных.
///
/// Целевой список Lookup хранит в SchemaXml GUID'ом (атрибут List), поэтому
/// подменяем именно GUID. Подменяем ТОЛЬКО ссылки на исходный список данных:
/// кросс-формные lookup'ы (например, «организация рабочего места» ссылается на
/// список «приема на работу») должны и дальше смотреть на список ЧУЖОЙ формы.
/// </summary>
private static string RetargetLookup(string schemaXml, Guid from, Guid to)
{
var fromText = from.ToString("D");
return schemaXml.Contains(fromText, StringComparison.OrdinalIgnoreCase)
? schemaXml.Replace(fromText, to.ToString("D"), StringComparison.OrdinalIgnoreCase)
: schemaXml;
}
}
@@ -20,4 +20,15 @@ public sealed class SharePointOptions
/// это здесь не стоит — пароль от сертификата в исходниках не место.
/// </summary>
public string CertificatePassword { get; set; } = string.Empty;
/// <summary>
/// Куда SharePoint будет присылать уведомления об изменениях списка — параметр
/// notificationUrl ручки POST /Webhook/Subscribe, которой новый список данных
/// подписывается на уведомления (см. HttpSharePointWebhookSubscriber).
/// Это приёмник на СТОРОНЕ ПОРТАЛА, а не адрес нашего сервиса.
///
/// Пусто — подписывать не будем вовсе: без адреса приёмника подписка
/// бессмысленна, и это же единственный способ её выключить.
/// </summary>
public string NotificationUrl { get; set; } = "https://api.tnsu.kz/Webhook/SharePoint";
}
@@ -22,7 +22,7 @@ public sealed class CachingTnsuPortalClient(HttpTnsuPortalClient inner, IMemoryC
$"emp:email:{email.ToLowerInvariant()}",
() => inner.GetEmployeeByEmailAsync(email, cancellationToken));
public Task<string?> GetEmployeeByPositionAsync(string position, string company, CancellationToken cancellationToken) =>
public Task<EmployeeLookupResult> GetEmployeeByPositionAsync(string position, string company, CancellationToken cancellationToken) =>
GetOrAddAsync(
$"emp:position:{position.ToLowerInvariant()}|{company.ToLowerInvariant()}",
() => inner.GetEmployeeByPositionAsync(position, company, cancellationToken));
@@ -0,0 +1,94 @@
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;
using Tnsu.ApprovalRoute.Infrastructure.SharePoint;
namespace Tnsu.ApprovalRoute.Infrastructure.TnsuPortal;
/// <summary>
/// POST {BaseUrl}/Webhook/Subscribe?listName=…&amp;url=…&amp;notificationUrl=… — просит
/// портал завести подписку SharePoint на только что созданный список данных.
///
/// Параметры уходят строкой запроса, тела у запроса нет — так описана ручка.
///
/// Отдельный клиент, а не метод в ITnsuPortalClient: тот про справочник сотрудников
/// и обёрнут кешем (CachingTnsuPortalClient), а здесь команда, которую кешировать
/// нельзя ни в каком виде. Авторизация общая с ним — см. TnsuPortalAuthorizer.
///
/// Адрес приёмника уведомлений живёт в SharePoint:NotificationUrl — в одном блоке с
/// остальными настройками SharePoint, а не в своём: подписка относится к спискам,
/// а не к порталу как таковому.
///
/// Ошибки НЕ пробрасываются наружу. Список к этому моменту уже создан, и уронить
/// провижининг из-за недоступности портала значило бы оставить партиционирование
/// нерабочим целиком (задача Hangfire ушла бы в повторы, а порог по элементам
/// продолжал бы срабатывать). Поэтому сбой — Error в лог с полным контекстом
/// (имя списка и сайт видны, подписку можно завести руками), а провижининг идёт
/// дальше. Отдельно предупреждаем про 401/403: в фоновой задаче нет входящего
/// токена, а client_credentials требует заполненных TnsuPortal:ClientSecret/Scope
/// (в конфигурации они пустые — см. TnsuPortalAuthorizer).
/// </summary>
public sealed class HttpSharePointWebhookSubscriber(
HttpClient httpClient,
TnsuPortalAuthorizer authorizer,
IOptions<SharePointOptions> options,
ILogger<HttpSharePointWebhookSubscriber> logger) : ISharePointWebhookSubscriber
{
public async Task<bool> TrySubscribeAsync(string siteUrl, string listTitle, CancellationToken cancellationToken)
{
var notificationUrl = options.Value.NotificationUrl;
if (string.IsNullOrWhiteSpace(notificationUrl))
{
// Без адреса приёмника подписка бессмысленна — он же служит выключателем
// (см. SharePointOptions.NotificationUrl).
logger.LogInformation(
"SharePoint:NotificationUrl не задан — список «{ListTitle}» на уведомления не подписан.",
listTitle);
return false;
}
if (string.IsNullOrWhiteSpace(listTitle))
{
// Без имени списка ручке нечего подписывать: у неё нет другого способа
// его найти (адрес списка она не принимает).
logger.LogError("Заголовок нового списка пуст — подписка на уведомления невозможна.");
return false;
}
// Полный адрес сайта целиком («https://tnsukz.sharepoint.com/sites/requests»),
// а не короткое имя — именно это ждёт ручка.
var site = siteUrl.TrimEnd('/');
var url =
$"/Webhook/Subscribe?listName={Uri.EscapeDataString(listTitle)}" +
$"&url={Uri.EscapeDataString(site)}" +
$"&notificationUrl={Uri.EscapeDataString(notificationUrl)}";
try
{
using var request = new HttpRequestMessage(HttpMethod.Post, url);
await authorizer.AuthorizeAsync(request, cancellationToken);
using var response = await httpClient.SendAsync(request, cancellationToken);
if (!response.IsSuccessStatusCode)
{
// Тело читаем именно на неуспехе — в нём причина отказа портала.
var body = await response.Content.ReadAsStringAsync(cancellationToken);
logger.LogError(
"Портал отказал в подписке списка «{ListTitle}» (сайт {Site}): {StatusCode}. Ответ: {Body}",
listTitle, site, (int)response.StatusCode, body);
return false;
}
logger.LogInformation(
"Список «{ListTitle}» (сайт {Site}) подписан на уведомления SharePoint.", listTitle, site);
return true;
}
catch (Exception ex)
{
logger.LogError(
ex,
"Не удалось подписать список «{ListTitle}» (сайт {Site}) на уведомления — подпишите вручную.",
listTitle, site);
return false;
}
}
}
@@ -1,17 +1,14 @@
using System.Net;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using System.Text.Json;
using System.Text.Json.Serialization;
using Microsoft.AspNetCore.Http;
using Tnsu.ApprovalRoute.Domain.Enums;
namespace Tnsu.ApprovalRoute.Infrastructure.TnsuPortal;
public sealed class HttpTnsuPortalClient(
HttpClient httpClient,
TnsuPortalTokenProvider tokenProvider,
IHttpContextAccessor httpContextAccessor) : ITnsuPortalClient
TnsuPortalAuthorizer authorizer) : ITnsuPortalClient
{
private static readonly JsonSerializerOptions JsonOptions = new() { PropertyNameCaseInsensitive = true };
@@ -25,12 +22,12 @@ public sealed class HttpTnsuPortalClient(
return new EmployeeDirectoryInfo(employee.CompanyId ?? Guid.Empty, employee.DepartmentId, employee.Company ?? string.Empty, employee.Position);
}
public async Task<string?> GetEmployeeByPositionAsync(string position, string company, CancellationToken cancellationToken)
public async Task<EmployeeLookupResult> GetEmployeeByPositionAsync(string position, string company, CancellationToken cancellationToken)
{
var employee = await GetAsync<EmployeeResponse>(
$"/Employee/ByPosition?position={Uri.EscapeDataString(position)}&company={Uri.EscapeDataString(company)}", cancellationToken);
return employee?.Email;
return new EmployeeLookupResult(employee is not null, employee?.Email, employee?.Fio);
}
public async Task<string?> GetManagerAsync(string email, string managerType, CancellationToken cancellationToken)
@@ -73,7 +70,7 @@ public sealed class HttpTnsuPortalClient(
private async Task<T?> GetAsync<T>(string requestUri, CancellationToken cancellationToken) where T : class
{
using var request = new HttpRequestMessage(HttpMethod.Get, requestUri);
await AuthorizeAsync(request, cancellationToken);
await authorizer.AuthorizeAsync(request, cancellationToken);
using var response = await httpClient.SendAsync(request, cancellationToken);
if (response.StatusCode == HttpStatusCode.NotFound)
@@ -89,25 +86,13 @@ public sealed class HttpTnsuPortalClient(
executors.Add(new ProjectExecutorInfo(role, email));
}
private async Task AuthorizeAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
var incoming = httpContextAccessor.HttpContext?.Request.Headers.Authorization.ToString();
if (!string.IsNullOrWhiteSpace(incoming))
{
request.Headers.TryAddWithoutValidation("Authorization", incoming);
return;
}
var token = await tokenProvider.GetAccessTokenAsync(cancellationToken);
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
}
private sealed record EmployeeResponse(
[property: JsonPropertyName("email")] string? Email,
[property: JsonPropertyName("company")] string? Company,
[property: JsonPropertyName("companyId")] Guid? CompanyId,
[property: JsonPropertyName("departmentId")] Guid? DepartmentId,
[property: JsonPropertyName("position")] string? Position);
[property: JsonPropertyName("position")] string? Position,
[property: JsonPropertyName("fio")] string? Fio);
private sealed record ManagerResponse(
[property: JsonPropertyName("managerEmail")] string? ManagerEmail);
@@ -0,0 +1,16 @@
namespace Tnsu.ApprovalRoute.Infrastructure.TnsuPortal;
/// <summary>
/// Подписывает список данных SharePoint на уведомления об изменениях через портал.
/// </summary>
public interface ISharePointWebhookSubscriber
{
/// <summary>
/// Подписать список. НЕ бросает: подписка — следствие создания списка, а не его
/// условие (см. реализацию), поэтому сбой портала не должен рушить провижининг
/// партиции. Возвращает true, только если портал подтвердил подписку.
/// </summary>
/// <param name="siteUrl">Абсолютный адрес сайта, где создан список.</param>
/// <param name="listTitle">Заголовок списка данных — русское имя, как в SharePoint.</param>
Task<bool> TrySubscribeAsync(string siteUrl, string listTitle, CancellationToken cancellationToken);
}
@@ -4,7 +4,7 @@ public interface ITnsuPortalClient
{
Task<EmployeeDirectoryInfo?> GetEmployeeByEmailAsync(string email, CancellationToken cancellationToken);
Task<string?> GetEmployeeByPositionAsync(string position, string company, CancellationToken cancellationToken);
Task<EmployeeLookupResult> GetEmployeeByPositionAsync(string position, string company, CancellationToken cancellationToken);
Task<string?> GetManagerAsync(string email, string managerType, CancellationToken cancellationToken);
@@ -0,0 +1,39 @@
using System.Net.Http.Headers;
namespace Tnsu.ApprovalRoute.Infrastructure.TnsuPortal;
/// <summary>
/// Авторизация запросов к api.tnsu.kz. Вынесена из HttpTnsuPortalClient, потому что
/// к порталу ходит не только справочник сотрудников (см.
/// HttpSharePointWebhookSubscriber), а правило выбора токена должно быть одно.
///
/// Токен берётся в двух режимах, и порядок принципиален:
/// 1) Токен вызывающего пользователя (см. TnsuPortalCallerToken) — из текущего
/// HTTP-запроса либо переданный аргументом в фоновую задачу. Портал тогда
/// видит исходного пользователя, а не сервисное приложение.
/// 2) Его нет вовсе — client_credentials самого сервиса (см.
/// TnsuPortalTokenProvider).
///
/// ВАЖНО про второй путь: TnsuPortal:ClientSecret/Scope в конфигурации пусты
/// (см. appsettings.json), поэтому он сейчас нерабочий — это именно фолбэк, а не
/// штатный режим. Вызывающая сторона обязана это учитывать: см.
/// HttpSharePointWebhookSubscriber, где сбой подписки намеренно не рушит
/// провижининг списка.
/// </summary>
public sealed class TnsuPortalAuthorizer(
TnsuPortalCallerToken callerToken,
TnsuPortalTokenProvider tokenProvider)
{
public async Task AuthorizeAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
var caller = callerToken.Current;
if (!string.IsNullOrWhiteSpace(caller))
{
request.Headers.TryAddWithoutValidation("Authorization", caller);
return;
}
var token = await tokenProvider.GetAccessTokenAsync(cancellationToken);
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
}
}
@@ -0,0 +1,37 @@
using Microsoft.AspNetCore.Http;
namespace Tnsu.ApprovalRoute.Infrastructure.TnsuPortal;
/// <summary>
/// Authorization, с которым идти в api.tnsu.kz в пределах текущей области DI.
///
/// Два источника, и второй нужен именно фоновым задачам:
/// • обрабатывается HTTP-запрос — заголовок берётся прямо из него;
/// • выполняется задача Hangfire — своего HttpContext'а у неё нет, поэтому
/// токен инициировавшего пользователя ей передают аргументом и кладут сюда
/// через <see cref="Set"/> (см. CreateNextListPartitionJob).
///
/// Scoped: Hangfire создаёт отдельную область DI на каждое выполнение задачи,
/// поэтому положенный здесь токен не протекает между задачами.
/// </summary>
public sealed class TnsuPortalCallerToken(IHttpContextAccessor httpContextAccessor)
{
private string? _explicit;
/// <summary>
/// Заголовок целиком, вида «Bearer …». null — вызывающего токена нет
/// (тогда авторизация уходит на client_credentials, см. TnsuPortalAuthorizer).
/// </summary>
public string? Current
{
get
{
var incoming = httpContextAccessor.HttpContext?.Request.Headers.Authorization.ToString();
return string.IsNullOrWhiteSpace(incoming) ? _explicit : incoming;
}
}
/// <summary>Положить токен явно — для кода без HttpContext (фоновые задачи).</summary>
public void Set(string? authorization) =>
_explicit = string.IsNullOrWhiteSpace(authorization) ? null : authorization;
}
@@ -5,3 +5,6 @@ namespace Tnsu.ApprovalRoute.Infrastructure.TnsuPortal;
public sealed record EmployeeDirectoryInfo(Guid CompanyId, Guid? DepartmentId, string Company, string? Position);
public sealed record ProjectExecutorInfo(ProjectRole ProjectRole, string Email);
/// <summary>Найден ли сотрудник вообще — отдельно от того, заполнен ли у него email в портале (это разные проблемы).</summary>
public sealed record EmployeeLookupResult(bool Found, string? Email, string? Fio);