Being able to subscribe to updates

Đang mở
  • Có gì không ổn?
#577 1 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
12/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Sôi nổi
Lĩnh vực
api, backend

Hướng nghiên cứu

This is a design question, not a patch: the issue asks whether catalog clients should subscribe to updates over SSE or websockets, and whether the payload should be ad hoc JSON or OPDS entries with a removal convention. Start with the earlier discussion in #265 and with how the current polling flow works for catalog retriever and the bittorrent tracker and seeder. Done means maintainers agree on a transport and format, not that code exists.

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

Mô tả

pending clarification

Now that the Catalog is managed in a centralized DB/service, we should be able to get instant updates instead of relying on the old scheme of polling the API, checking if it has been updated, then parsing the whole thing. It was approached in #265.

That ticket was about stateless requests but there's a growing pattern of constantly watching catalog services:

  • catalog retriever (staging)
  • catalog retriever (prod)
  • bittorrent tracker
  • bittorrent seeder could work this way also.

For such catalog clients, being able to subscribe to updates would make a lot more sense. There are several ways to implement this but I believe SSE or even websocket are well suited for the transport part of this. SSE is simpler on both side of the connection and has this LastEventId concept so I'd look at it first.

Then there's the format, we could either use something adhoc (JSON) or send valid OPDS entries (which custom handling for removal).

Ngôn ngữ chính
Python
Star
8
Fork
4
Merge trung bình
2 ngày 1 giờ
Pull request đã merge (30 ngày)
34

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 openzim/cms

Tất cả issue của openzim/cms

Issue tương tự

Thêm issue về Python

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.