Files
pages/docs/design/ja/feeds.md
T

5.9 KiB
Raw Blame History

15. RSSビューア・FreshRSS・newsboat

状態:設計案。既存のブログRSS「配信」と、本章の外部RSS「購読」は別機能。

2026-11-08:利用者指定のサブプロジェクト順で最初に実施する。FreshRSS/内蔵readerの 正本選定と実環境への接続は別の判断であり、RSSを優先することだけでは確定しない。

選択肢と推奨する試作順

案 正本 利点 追加する責任
PagesWiki内蔵reader ローカルの購読と状態 Wiki保存と一体のUI 取得・既読・同期・client対応を全て持つ
FreshRSS connector FreshRSSの購読・既読 既存reader資産を利用 API互換性、権限、cacheと失効
newsboat単独の橋渡し newsboat側の購読・状態 CLI利用に合わせやすい ローカル連携経路・export/importの設計

FreshRSSにはGoogle Reader互換APIがあり、APIの有効化と専用passwordを使います。newsboatにはFreshRSS連携が用意され、カテゴリのtag化やstar操作を扱えます。FreshRSS公式API、newsboat公式マニュアル。

このため最初の候補は FreshRSSを正本、PagesWikiを読取connector、newsboatを同じFreshRSSのclient とする構成です。これは設計上の提案で、ユーザー環境のFreshRSS導入・採用決定ではありません。PagesWikiがnewsboatをサーバー上で起動したり、そのSQLiteを共有したりする必要はありません。

読取MVP

購読一覧、フォルダ、記事一覧、外部原文、Wiki保存を提供します。初期段階では表示しただけでFreshRSSへ既読を送りません。UIには「読取専用・既読は同期していない」と明示します。ブラウザへFreshRSS password/tokenを渡さず、backend connectorがsecret参照を使います。

最小cache案はsource UUID、remote feed/item ID、title、safe excerpt/body hash、canonical URL、published/updated/fetched時刻、remote state/versionです。IDなしRSSにはfeed単位の保守的な代替キーを使い、題名だけで重複排除しません。Atomはentry IDと更新情報を持つ形式です。Atom仕様。

既読・star同期を追加する条件

server-authoritative stateと未送信の操作を分けます。操作ごとのrequest_idで重複を防ぎ、成功応答前に確定済みと表示しません。newsboat等で同時変更された場合、古いローカルcacheをまとめて送り返しません。接続解除・認可失効時は未送信変更を勝手に再送しません。

FreshRSS APIに条件付き更新がない操作もあり得るため、対応版の実機fixtureで競合動作を確認するまで完全な双方向同期を約束しません。

内蔵fetcherを選ぶ場合

定期event、条件付きGET、host別同時数、timeout、応答サイズ、展開サイズ、backoffを設けます。XML外部entityを無効にし、feed HTMLを安全化します。redirect/DNSを含むSSRF対策、外部画像の同意、個人購読URLや認証情報の秘匿が必要です。

OPMLは購読の入出力として扱い、既読・star・全本文のバックアップと同一視しません。importはpreview・追加/置換選択・重複確認を行い、既存購読を黙って削除しません。

Wiki保存と権利・公開

既定はURL、出典、短いメモの保存です。全文保存は取得可能性・利用条件・個人用途等を確認する独立操作とし、feedが短いからといって有料記事を自動取得しません。保存先が自動公開範囲なら内容と添付の公開を明示確認します。

TODOと受け入れ

RSS-1:read-only FreshRSS fixture。RSS-2:安全な一覧と出典付きWiki保存。RSS-3:必要なら既読/star送信。RSS-4:内蔵reader採用判断とOPML。オフライン、欠落ID、巨大feed、未知HTML、同期再送、他user情報、feed削除後の保存Page維持を試験します。

実施段階

  1. 共通契約とfixture:Domain/本人のsource所有、provider ID、remote ID、cursor、取得予算、 最終成功/失敗と無効化を定義する。合成記事を返すfixtureから開始し、FreshRSSを必須の 稼働依存として固定しない。sourceの資格情報をブラウザ・ログへ出さない。
  2. 読取UIと背景取得:購読/フォルダ、記事の一行一覧、本文表示、出典リンクを用意する。 デスクトップでは一覧を見渡せる配置、スマホでは一覧と本文を切り替える。画面表示で外部fetchを 待たず、schedulerで有界に更新し、取得済みcacheと鮮度を表示する。source停止・失効も検証する。
  3. Wiki保存とタスク化:タイトル・URL・出典・短いメモをpreviewし、保存先Pathを選ぶ。 既存captureと権限確認を再利用し、二重送信・保存先競合・自動公開範囲を検査する。全文保存は 独立した明示操作。タスク作成が失敗しても保存済みWikiを消さず、部分成功と再試行方法を示す。
  4. ダッシュボードと実環境受入:読める記事だけのwidgetを追加。providerと正本を選定後、 同意した接続先でread-only受入を行う。既読/star書込、OPML、内蔵fetcherはそれぞれ後続の 明示範囲とし、read-only連携を有効化しただけで外部状態を変更しない。

各段階で無効化、件数・時間・容量上限、移行の再実行、ユーザー/Domain間の分離を試験する。 source解除時のcache清掃と、利用者が明示保存したWiki/タスクの保持は別操作とする。