api-client: typed helper to parse the audit JSON Lines export

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#144 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ó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
85/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ệ
typescript
Lĩnh vực
api

Hướng nghiên cứu

Làm việc trong packages/api-client; trước tiên, kiểm tra client được tạo tự động và các mẫu kiểm thử đơn vị hiện có để tìm vị trí thích hợp cho parser. Thêm parseAuditExport(text: string): AuditEventDto[] để giữ nguyên thứ tự dòng, bỏ qua ký tự xuống dòng ở cuối và báo lỗi nếu có dòng JSON không hợp lệ. Thêm kiểm thử đơn vị và chạy pnpm nx test api-client.

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

Mô tả

enhancement good first issue priority:P3 track:web

The audit export (/audit-events/export) returns application/x-ndjson, one AuditEventDto per line, which the generated client does not parse.

Task

In packages/api-client:

  • add parseAuditExport(text: string): AuditEventDto[];
  • ignore a trailing newline, throw on invalid JSON lines, and keep the original order;
  • add unit tests.

Acceptance

pnpm nx test api-client passes. No new dependency.

Ngôn ngữ chính
TypeScript
Star
2
Fork
1
Merge trung bình
7 giờ 17 phút
Pull request đã merge (30 ngày)
197

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 shipkeepdev/shipkeep

Tất cả issue của shipkeepdev/shipkeep

Issue tương tự

Thêm issue về TypeScript

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.