Clients return null, cannot be cancelled and drop Retry-After; the SDK reads the system clock

Đang mở
#3,310 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/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, typescript

Hướng nghiên cứu

Start with the listed locations: FluentCmsClient.cs, clients/typescript/src/client.ts, SystemOperation.cs, CmsEvent.cs, docs/analyzers.md, and Descriptors.cs; inspect the related client, SDK, and analyzer tests and the changes in #3273. The acceptance checklist defines done across six areas, from cancellation and Retry-After handling to API baselines and diagnostic documentation. This spans multiple packages and client implementations, so it requires substantial project context.

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

Mô tả

area:sdk type:bug

Problem

  1. The .NET client can return null for a non-nullable result. FluentCmsClient.cs:120-123 returns default for an empty body or a 204, and :127 returns null for a literal null body; callers suppress it with ! (:32,39,47,55,62,71,85,92). A proxy answering 200 with an empty body gives a NullReferenceException later.
  2. The TypeScript client has no cancellation or timeout. clients/typescript/src/client.ts:100-105 builds RequestInit without a signal, and no method takes one.
  3. Both clients discard Retry-After on a 429. FluentCmsClient.cs:114 and client.ts:107-108 pass only the status and body to the error.
  4. The SDK reads the system clock directly. src/FluentCMS.Sdk/Content/SystemOperation.cs:42 and src/FluentCMS.Sdk/Events/CmsEvent.cs:9 use DateTimeOffset.UtcNow instead of the injected TimeProvider.
  5. FluentCMS.Client has no tracked public API, unlike Sdk, Plugins.Abstractions and the two admin packages.
  6. FCMS0100–FCMS0104 are undocumented. docs/analyzers.md:5 only reserves the range, and src/FluentCMS.Generators/Descriptors.cs sets no helpLinkUri, unlike src/FluentCMS.Analyzers/Rules.cs:22.

Proposal

  • Throw FluentCmsProblemException when a result is expected and the body is empty or null.
  • Accept a signal per call and a timeoutMs option in the TypeScript client.
  • Expose RetryAfter on the problem type of both clients.
  • Take a TimeProvider in SystemOperation; let the bus stamp events.
  • Add the public API analyzer and baseline to FluentCMS.Client.
  • Document the five diagnostics and link them.

Done together with #3273, which changes the same two clients.

Acceptance

  • An empty or null body where a result is expected throws a problem exception
  • A TypeScript call can be aborted, and times out at timeoutMs
  • A 429 exposes the Retry-After of the server in both clients
  • No DateTimeOffset.UtcNow remains in FluentCMS.Sdk
  • A change to the public API of FluentCMS.Client fails the build until the baseline is updated
  • Each of FCMS0100–FCMS0104 has a section in docs/analyzers.md and a help link

Found in the code review of 17 Nov 2026.

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

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.