Add opt-in freshness status for command and stream providers

未关闭
#754 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
macos, swift

调研方向

Start with ProviderConfiguration.swift, ScriptWidget.swift and BarStore.widgetStatus in BarStore.swift, then read the Settings → Status and provider guide documentation. Trace how accepted outputs update diagnostics and how suspension affects status before deciding where freshness state belongs. Done when an opt-in per-source limit is reported consistently in Settings and the runtime query, with paused time and existing source states handled as specified.

由索引模型根据 Issue 内容生成。

描述

enhancement needs-info

Problem

A command or stream can leave its last valid value on the bar without reporting a new value for longer than that particular data source allows. For sources that have an expected update cadence, users cannot currently express when that value should be considered stale.

Status already distinguishes failures, missing access, waiting, paused, connected and working sources. It also shows the last successful update. A running connection alone does not establish that a deadline-sensitive value is still fresh.

Silence is not a general bug: an event-driven battery, input-source or other change-only source may correctly send nothing for hours. This request is an explicit per-source freshness contract, disabled by default, not a global silence timeout or an automatic recovery system.

Proposal

Let a command/stream provider opt into a maximum acceptable age for its last successful output. Expose the resulting freshness and age beside its existing source status in Settings → Status and the runtime query.

A provider that needs a liveness contract can use successful repeated output as a heartbeat: the runner already accepts an unchanged valid output without redrawing views. Document that heartbeat/liveness and the age of the underlying external data are different guarantees. Do not mark an old external value fresh merely because its process is still alive.

Keep the last good value available and let the user use the existing Refresh/Restart action. Do not restart, hide or discard a source automatically when the freshness limit expires.

Acceptance
  • With no configured freshness contract, existing behavior stays unchanged, including indefinitely quiet change-driven sources.
  • A source with a configured limit becomes stale after its last accepted successful update exceeds that limit, even if its stream process remains running. Status/query show the age and configured limit.
  • The next accepted valid update clears staleness. An unchanged valid output can renew an explicitly documented heartbeat contract without forcing a redraw.
  • Source failures, missing access, initial waiting and intentional suspension remain distinguishable from stale data. Time spent deliberately paused for sleep, lock or visibility must not create a misleading live-connection warning; resume behavior is defined and documented.
  • Shared consumers see one source's freshness consistently. This adds no automatic restart policy and does not require every silent source to emit unchanged data.

Possible today

Existing capability / workaround
  • ScriptDiagnostics already records lastUpdated, running/suspended state, counters and retry information.
  • ScriptWidget.accept advances lastUpdated for valid repeated output while avoiding unchanged view assignments.
  • BarStore.widgetStatus uses initial-update, error, suspension and connection state, but not a freshness limit. ProviderConfiguration has no opt-in age/heartbeat setting.
  • Settings → Status already offers last-update inspection, Refresh/Restart and explicit testing. A custom script can also report its own timestamp or warning. Those require each author or user to implement and interpret the policy separately.
  • The provider guide explicitly supports change-driven sources and keeps streams alive until they exit, fail, suspend or stop; command timeout is an execution limit, not a freshness contract.

Reviewed main: 01bf12a1a67f6083342421efa090e48213fbe62e. Latest stable reviewed: 0.17.0. This is a capability review, not a claim that a particular user's stream stalled. No app interaction, build or test was performed.

Related

  • #17 / #53 introduced common runners and event-driven sources. Their change-only output contract is retained; this request adds an opt-in freshness policy, not polling for all sources.
  • #119 introduced the existing Status overview and explicit source testing. The request adds a defined freshness state beside that diagnostic information.
  • #694 corrected the workspace connection label after a subscription drops. It does not detect an otherwise running custom source whose accepted output exceeds a user-defined age.
  • #307, declined, proposed command-run history and log following. This request adds neither a history/log interface nor a new recovery action.

Triaged by OMP (closerouter/openai/gpt-6.1-sol).

主要语言
Swift
星标
184
派生
12
平均合并
3 小时 50 分钟
30 天内合并 PR
387

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Seb-GRAF/StableBar 的其他 Issue

查看 Seb-GRAF/StableBar 的全部 Issue

相似的 Issue

更多 Swift Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。