FluentCMS.Admin.Hosting reads Core through InternalsVisibleTo: a public seam for a package that serves a surface of its own

Đang mở
#3,451 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
58/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp
Lĩnh vực
backend-api-design

Hướng nghiên cứu

Start with src/FluentCMS.Core/FluentCMS.Core.csproj and admin/src/FluentCMS.Admin.Hosting/AdminHostingExtensions.cs to trace the internal members used by the hosting package. Read the related API types under Api/Common and DependencyInjection, then check the backend specification for where new public members should be documented. Done means the admin package compiles without Core's InternalsVisibleTo, the reference host retains its headers, limits, and startup refusals, and the public members are documented in both places.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

area:host type:feature

Problem

FluentCMS.Core names FluentCMS.Admin.Hosting in InternalsVisibleTo (src/FluentCMS.Core/FluentCMS.Core.csproj, line 37), and the package uses internal types of Core: FluentCmsSurfaceMetadata, FluentCmsEndpointMetadata and ContentSecurityPolicyMetadata (Api/Common), ApiPipelineState (Api/Common/ApiPipeline.cs), HostErrorCodes and FluentCmsOptions with AddFluentCmsOptions (DependencyInjection). It marks its endpoints as a surface of FluentCMS, sets the policy of the admin page, checks that the pipeline is configured, and binds its options with the host's error codes (admin/src/FluentCMS.Admin.Hosting/AdminHostingExtensions.cs, lines 19, 35, 58, 82 and 86). The package is released with A-47. A host that takes a later patch of Core with the same hosting package then fails at run time on a renamed internal member, with no word at restore (#3178).

Proposal

A small public surface in Core for a package that maps endpoints of its own under a FluentCMS host: marking a group as a surface with a name, a Content-Security-Policy for an endpoint, the check that UseFluentCms ran, and the binding of an options section with the host's refusal at start. Then drop the InternalsVisibleTo line. A third party that serves a page from a FluentCMS host needs the same.

Acceptance

  • FluentCMS.Admin.Hosting compiles with no InternalsVisibleTo from Core
  • The reference host serves the admin as before, with the same headers, limits and refusals at start
  • The new members are documented, and the backend specification names them

From the review of #3191 (#3178). Needed by A-47, which until then has the package depend on the exact version of FluentCMS.Core. Size: S.

Ngôn ngữ chính
C#
Star
567
Fork
107
Merge trung bình
1 giờ 19 phút
Pull request đã merge (30 ngày)
353

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của fluentcms/FluentCMS

Tất cả issue của fluentcms/FluentCMS

Issue tương tự

Thêm issue về C#

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.