Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Being able to subscribe to updates

オープン
#577 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
12/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
活発
領域
api, backend

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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).

主要言語
Python
スター
7
フォーク
3
平均マージ
1日 8時間
マージ済み PR(30日)
27

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openzim/cms のほかの issue

openzim/cms の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。