48 KiB
Inbox (home screen) implementation plan
Ported from GitWorkshop's home screen, the Dashboard rendered at route / for a logged-in user.
Correction to the first draft. The first draft assumed the inbox was the
/notificationspage. It is not. GitWorkshop'sIndexroute (src/pages/Index.tsx) renders<Dashboard />when an account is active, and that home screen is the inbox.
Status. Phases 0-4 are implemented and green on
feat/inbox, then the screen was redesigned to group notifications and activity by repository (see the repository-grouping note in §7).cargo test -p signed_core(68),cargo test -p signed_state(24),cargo test -p workspace(7),cargo test -p dock(1),cargo clippy -p workspace --all-targetsclean,cargo check --workspace --all-targetssucceeds. Phase 5 is not started. This document reflects the implementation as it stands: the Phase 1 refactors, the §4.3 split of the inbox into a thin globalInboxand a panel-owned derivation, the Phase 4 click-through, and the repository-grouped list. The Phase 3 bottom-dock sub-views were removed before the redesign; their implementation notes in §7 are historical.
1. What the GitWorkshop home screen is
Index.tsx:
if (account) return <Dashboard />;
return <LandingPage />;
Dashboard.tsx layout:
- Desktop: two columns.
- Left column:
GreetingHeader,NotificationsPanel,RecentActivitySection. - Right column:
MyRepositoriesPanel,AccessiblePrivateRepositoriesPanel,FollowedReposPanel.
- Left column:
- Mobile: a single column in a different order.
The panel that gives the screen its inbox identity is NotificationsPanel:
- heading Notifications with a bell icon and an unread count badge,
- a Mark all read action and a View all link to
/notifications, - a compact list of the first 5 non-archived notification items,
- the empty state reads "Your inbox is empty" (with an
Inboxicon).
So in GitWorkshop's vocabulary, "inbox" is the non-archived activity directed at you, surfaced inline on the home screen. The home screen also shows your own recent activity and your repositories.
Data hooks:
| Section | Hook | What it loads |
|---|---|---|
| Notifications (inbox) | useNotifications() |
Notification model: grouped thread activity directed at you, read/archived state |
| Continue where you left off | useUserActivity(pubkey) |
Git activity authored by you: kinds 1621/1617/1618/1111 (git K)/1624/1630-1633, newest first, limit 50 |
| My repositories | useUserRepositories(pubkey) |
Kind 30617 announcements authored by you |
| Followed repositories | useUserFollowedRepos(pubkey) |
Repos you follow |
| Accessible private repositories | useAccessiblePrivateRepositories() |
Private repos from CI/services |
2. Scope for Signed
| Priority | Section | Notes |
|---|---|---|
| P0 | Inbox panel | Activity directed at you and your own activity, grouped by repository; unread badge; mark all read; all groups shown |
| P1 | Click-through | Open the repo panel at the relevant PR/issue |
| P2 (defer) | Standalone notifications page, NIP-65 relay discovery, pagination | Web-app concerns |
| Out of scope | Greeting header, my repositories, followed repositories, private repositories, pinned repositories, Unread/Archived sub-views | Not needed in Signed |
Notes:
- There is no greeting header. The screen starts with the inbox panel.
- There is no My repositories column. The sidebar already lists the signed-in user's repositories, so the inbox is a single column.
- The Unread/Archived sub-view panels were removed: the panel is a single repository-grouped list instead.
3. The Signed screen
InboxView is a center panel, opened by the sidebar's existing Inbox nav item. It is one bordered
card holding a single virtual list. Every row is either a repository header or one of that
repository's notifications / own activity, newest first:
The sections are all of the user's own repositories, seeded from RepoListStore, plus any other
repository that has notifications or activity. Owned repositories with nothing to show render an
empty state ("No activity yet.") under their header, and sort after the ones with activity (newest
announcement first). Items with no repository address fall into a single "Other repository" section.
+-------------------------------------------------------------------------+
| Inbox (3 unread) [Mark all read] |
|-------------------------------------------------------------------------|
| [repo] you/repo-a (2) |
| [avatar] issue opened issue 2m |
| [avatar] commented on "..." comment 1h |
| [icon] "Add retry" patch 3d |
|-------------------------------------------------------------------------|
| [repo] you/repo-b |
| No activity yet. |
|-------------------------------------------------------------------------|
| [repo] you/repo-c |
| No activity yet. |
+-------------------------------------------------------------------------+
The sections are the repositories that actually have notifications or activity, ordered by their newest row. A repository the user owns but that has no items is not shown. Items with no repository address fall into a single "Other repository" section.
4. Data layer
4.1 signed_core: pure logic
filters.rs (extend, next to activity/comments_for):
/// Kinds that notify a user when they tag them directly.
pub const NOTIFICATION_KINDS: [Kind; 9] = [
Kind::GitIssue,
Kind::GitPullRequest,
Kind::GitPatch,
Kind::GitPullRequestUpdate,
COVER_NOTE_KIND,
Kind::GitStatusOpen,
Kind::GitStatusApplied,
Kind::GitStatusClosed,
Kind::GitStatusDraft,
];
/// Comments on our issues/PRs/patches.
pub fn notification_comments(me: PublicKey) -> Filter {
Filter::new()
.kind(Kind::Comment)
.custom_tags(SingleLetterTag::UPPERCASE_P, [me.to_hex()])
.custom_tags(SingleLetterTag::UPPERCASE_K, ["1621", "1617", "1618"])
}
/// Activity directed at us: comments on our roots, and git events tagging us.
pub fn notifications(me: PublicKey) -> Vec<Filter> {
vec![
notification_comments(me),
Filter::new().kinds(NOTIFICATION_KINDS).pubkey(me),
]
}
/// Git activity authored by `me`, for "Continue where you left off".
pub fn authored_activity(me: PublicKey) -> Filter {
Filter::new()
.kinds([ACTIVITY_KINDS.as_slice(), &[COVER_NOTE_KIND]].concat())
.author(me)
}
ACTIVITY_KINDS already exists in this file. All builders use existing SDK APIs
(Filter::kind/kinds/pubkey/custom_tags, SingleLetterTag::{UPPERCASE_P, UPPERCASE_K}).
Comments authored by me are not all git comments, so the activity query needs a post-filter:
keep kind 1111 only when its uppercase K tag is a git root kind (1621/1617/1618/30617), matching
gitworkshop's isGitComment.
inbox.rs (new file):
pub struct InboxItem {
pub root: EventId,
pub root_kind: Option<Kind>,
pub address: Option<RepoAddr>,
/// Events in the group, newest first.
pub events: Vec<Event>,
/// Unread event ids, oldest first.
pub unread_ids: Vec<EventId>,
pub archived: bool,
}
/// The thread root of a notification event, or `None` if it isn't git-related.
pub fn notification_root(
event: &Event,
lookup: &impl Fn(EventId) -> Option<Event>,
) -> Option<EventId>;
/// Group notification events by root, newest activity first, self excluded.
pub fn group(
events: impl IntoIterator<Item = Event>,
me: PublicKey,
state: &InboxReadState,
lookup: &impl Fn(EventId) -> Option<Event>,
) -> Vec<InboxItem>;
Root resolution, ported from getNotificationRootId:
- issue (1621) / PR (1618): itself
- patch (1617): its
eparent patch, else itself - NIP-22 comment (1111): uppercase
Eroot pointer (SDKnip22::extract_root) - PR update (1619): uppercase
E - statuses (1630-1633) / cover note (1624): NIP-10 root
e - self-authored events are excluded
Read/archive state, the compact high-water-mark model:
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct InboxReadState {
#[serde(default)] pub read_before: Timestamp,
#[serde(default)] pub read_ids: HashSet<EventId>,
#[serde(default)] pub archived_before: Timestamp,
#[serde(default)] pub archived_ids: HashSet<EventId>,
}
impl InboxReadState {
pub fn is_read(&self, event: &Event) -> bool;
pub fn is_archived(&self, event: &Event) -> bool;
pub fn mark_read(&mut self, event: &Event);
pub fn mark_all_read(&mut self, all: &[Event], me: PublicKey);
/// Move the cutoff to `min(oldest unread - 1, now - 3 days)` and prune ids.
pub fn advance_read(&mut self, all: &[Event], me: PublicKey);
pub fn advance_archived(&mut self, all: &[Event], me: PublicKey);
}
activity_subject in model.rs already gives an issue/PR title from the subject tag or first
line; reuse it for the home screen rows.
4.2 Persistence: NIP-78 in the local database, never published
Read state is a normal NIP-78 (kind 30078, Kind::ApplicationSpecificData) addressable event
written to LMDB only. It is never broadcast to a relay, so the read state stays on this device.
It is signed with a random keypair, never the user's signer. The event is local application
storage, so its author carries no identity; this avoids a signing round-trip and does not depend on
the signer type. The d tag identifies the owning user, so state does not leak across identities
when the signed-in key changes.
/// d tag identifying the inbox read/archive state event of `me`.
fn inbox_state_d_tag(me: PublicKey) -> String {
format!("signed-inbox-state:{}", me.to_hex())
}
/// Newest stored read state for `me`.
async fn load_state(client: &Client, me: PublicKey) -> Result<Option<InboxReadState>, Error> {
// No author filter: the signing key is random per save.
let filter = Filter::new()
.kind(Kind::ApplicationSpecificData)
.identifier(inbox_state_d_tag(me));
let events = client.database().query(filter).await?;
let Some(event) = events.into_iter().max_by_key(|event| event.created_at) else {
return Ok(None);
};
match serde_json::from_str(&event.content) {
Ok(state) => Ok(Some(state)),
Err(error) => {
log::warn!("ignoring unreadable inbox state {}: {error}", event.id);
Ok(None)
}
}
}
/// Sign with a fresh random key and store locally.
async fn save_state(client: &Client, me: PublicKey, state: &InboxReadState) -> Result<(), Error> {
let event = EventBuilder::new(Kind::ApplicationSpecificData, serde_json::to_string(state)?)
.tags([Tag::identifier(inbox_state_d_tag(me))])
.finalize(&Keys::generate())?; // synchronous: random key, no user signer
// Local-only: no `send_event`, no broadcast. The event lives in LMDB.
client.database().save_event(&event).await?;
Ok(())
}
A fresh random key is generated on every save, so each save writes a new event rather than
replacing the previous one. LMDB only auto-replaces an addressable event when the incoming event
has the same pubkey, so old copies accumulate. Nothing prunes them; load_state reads the
newest by created_at, so the behavior is correct. This is a deliberate trade for not caching a
key in the store (see §4.3). An earlier implementation deleted the previous event by tracking its
id across saves; that was removed as more derived state than it was worth.
NostrDatabase::{save_event, query} and Client::database() are existing SDK APIs.
4.3 Data layer: a thin global Inbox, a panel-owned derivation
The inbox is split in two, because the expensive derivation is only needed while the home screen is open.
Inbox is a child Entity<Inbox> owned by Backend (inbox: Entity<Inbox>) and is
deliberately thin: it owns only the read/archive state that must outlive the panel and the NIP-78
load/save.
// backend.rs
pub struct Backend {
...
inbox: Entity<Inbox>,
}
// inbox.rs
#[derive(Default)]
pub struct Inbox {
state: InboxReadState,
state_loaded: bool,
}
impl Inbox {
pub fn state(&self) -> &InboxReadState;
pub fn is_loaded(&self) -> bool;
pub fn mark_read(&mut self, group: &[Event], all: &[Event], me: PublicKey, cx);
pub fn mark_archived(&mut self, group: &[Event], all: &[Event], me: PublicKey, cx);
pub fn mark_all_read(&mut self, all: &[Event], me: PublicKey, cx);
pub(crate) fn activate(&mut self, me: PublicKey, client: Client, cx);
pub(crate) fn reset(&mut self, cx);
}
The panel owns the derivation. InboxView itself holds the derived lists, the copy of the read
state they were computed with, and the refresh coalescing. There is no separate store entity: the
panel is the only consumer, so an Entity<InboxStore> would add an update indirection and a
forwarding subscription without buying any sharing. The panel's own unread_count feeds its header
badge only; there is no global count and no sidebar badge.
pub struct InboxView {
focus_handle: FocusHandle,
dock_area: WeakEntity<DockArea>,
notifications: Arc<Vec<InboxItem>>,
activity: Arc<Vec<Event>>,
sections: Arc<Vec<InboxSection>>, // grouped by repository
rows: Arc<Vec<InboxRow>>, // flattened list
unread_count: usize,
state: InboxReadState,
state_loaded: bool,
refresh: RefreshGate,
list: ListState,
_subscriptions: Vec<Subscription>,
}
impl InboxView {
pub fn new(dock_area: WeakEntity<DockArea>, cx: &mut Context<Self>); // cx.defer(… sync_state)
pub fn sync_state(&mut self, cx); // observes the global Inbox
pub fn mark_all_read(&mut self, cx);
fn handle_backend_event(&mut self, event: &BackendEvent, cx);
fn refresh(&mut self, cx);
fn run_refresh(&mut self, cx);
fn regroup(&mut self, cx); // re-apply read state
fn rebuild(&mut self, cx); // group by repository, seed owned, flatten
fn clear(&mut self);
}
The panel owns three subscriptions that carry logic: it observes the global Inbox
(InboxView::sync_state), subscribes to Backend (InboxView::handle_backend_event), and observes
RepoListStore to rebuild when the user's own repositories load. Re-rendering itself needs no
subscription: GPUI invalidates a window for every entity it read during render, so the panel tracks
RepoListStore and ProfileStore just by reading them in render. The panel does not write back
to the global.
signed_state::query_inbox. The database work stays in signed_state, so the UI crate never
queries LMDB directly. query_inbox returns the grouped notifications, the user's own git
activity and the unread count; the panel applies the results on the main thread. RefreshGate is
re-exported for the panel's debounce.
pub async fn query_inbox(
client: &Client,
me: PublicKey,
state: &InboxReadState,
) -> Result<(Vec<InboxItem>, Vec<Event>, usize), Error>;
Lifespan. Inbox is created with the backend but idles until the user has a signer. The
derived lists live only as long as the panel. Nothing is wired from the desktop crate and
signed_state::init gains no parameters.
No sidebar badge. The sidebar's inbox nav item has no unread suffix (an earlier global count derivation was removed with it). The unread count lives entirely in the panel, which shows it in its header and per repository section. The trade-off is that the count is only current while the panel is open, which is acceptable now that nothing outside it displays one.
The dependency chain is Backend → Inbox and InboxView → query_inbox.
Backend owns the inbox lifecycle (sync_inbox); the panel subscribes to Backend directly for
its lists. BackendEvent::SignerChanged and SignerRequired are still emitted and must stay:
CheckoutsStore and SidebarPanel consume them. They no longer drive the inbox's activation
directly.
InboxView::handle_backend_event refreshes on:
NostrUpdate(updates): when any update kind is inNOTIFICATION_KINDS, isKind::Comment, or is a deletion (EventDeletion/RequestToVanish).Synced/Published.- everything else: ignored.
Signer lifecycle: Backend::sync_inbox. Backend owns the wiring and calls sync_inbox from the
three real signer transitions: create_identity, set_signer (nsec, bunker and passphrase restore)
and logout. It starts the subscriptions and repo-relay connects, then calls Inbox::activate or
Inbox::reset. The client is passed into activate, so the global inbox never reads Backend
while sync_inbox is mid-update:
fn sync_inbox(&mut self, cx: &mut Context<Self>) {
let me = self.current_user;
if let Some(me) = me {
self.subscribe_bootstrap(filters::notifications(me), cx);
self.subscribe_bootstrap(vec![filters::authored_activity(me)], cx);
let relays: HashSet<RelayUrl> = RepoListStore::global(cx)
.read(cx)
.announcements_of(&me)
.into_iter()
.flat_map(|announcement| announcement.relays)
.collect();
if !relays.is_empty() {
let relays: Vec<RelayUrl> = relays.into_iter().collect();
self.connect_repo_relays(relays.clone(), filters::notifications(me), cx);
self.connect_repo_relays(relays, vec![filters::authored_activity(me)], cx);
}
}
let client = self.client.clone();
self.inbox.update(cx, |inbox, cx| match me {
Some(me) => inbox.activate(me, client, cx),
None => inbox.reset(cx),
});
}
The repo relays are read from RepoListStore::global(cx).read(cx).announcements_of(&me) at call
time and never cached. (NIP-65 outbox relay discovery is deferred; Signed does not fetch kind
10002 yet.) Inbox::activate and Inbox::reset are pub(crate); Inbox has no subscribe_remote
/ connect_own_repo_relays.
Activation clears the state and loads the NIP-78 state from LMDB. The panel clears its own lists and in-flight refresh when it sees the unloaded state, then refreshes once it is loaded:
pub(crate) fn activate(&mut self, me: PublicKey, client: Client, cx: &mut Context<Self>) {
// state = default; state_loaded = false; cx.notify();
// spawn load_state(client, me), then set state and state_loaded = true
}
reset performs the same clearing without a state load, and is used on logout.
Reading the state event needs no signer at all (the d tag carries the identity); activation is
still gated on the signer because the fetch filters need the user's pubkey.
Fetch reuses Backend::subscribe_bootstrap and Backend::connect_repo_relays through
Backend::sync_inbox (see above). The query the panel runs is intentionally the offline-first cache
read, not a wait on the network; see the note below.
Refresh (InboxView::run_refresh, mirrors RepoListStore::run_refresh):
cx.background_spawn: query the notification filters and the activity filter fromclient.database().- Query
filters::deletions(), buildDeletions, skip deleted events. - Build
HashMap<EventId, Event>for root walking; group the notification events withinbox::group. - Filter the activity events: keep issues/PRs/patches/statuses/cover notes, and comments only when
their
Ktag is a git kind; sort newest first. - Cross back to the main thread: guard on
Backend::global(cx).read(cx).current_user() == Some(me); if the signer changed while the query ran,refresh.abort()instead of applying, so a previous user's results never land. Then setnotifications,activity,unread_count, rebuild the repository sections (rebuild),cx.notify(),refresh.finish().
InboxView::sync_state reacts to the global Inbox: while the state is not loaded it clears the
lists, on the first load it runs the initial refresh, and on a state change (a mark action) it
re-derives the flags (InboxItem::apply_state).
Fetch vs. the immediate query. subscribe_bootstrap / connect_repo_relays return immediately,
so the query that follows them reads the local cache rather than waiting for the relays. That is
deliberate offline-first behavior: cached content appears at once on a warm start and with no
network, instead of blocking the home screen on the network. The gap is closed by the SDK, not by
timing: received events are written to LMDB and surfaced as ClientNotification::Event, so
Backend's pump batches them into BackendEvent::NostrUpdate and the store refreshes. This was
reviewed and left as-is.
Actions: mark_all_read() lives on the panel, which passes every known notification event to the
global Inbox. The global marks them, advances the cutoffs against all notification events to bound
the id sets, saves the state to LMDB (signed with a fresh random key, see 4.2), and notifies. The
panel then re-derives and publishes the unread count.
Repository names need no new store: RepoListStore already holds every announcement and
repo_name resolves an address to a display name.
4.4 Cargo.toml
signed_core: addserde.workspacefor theInboxReadStatederives.signed_state: addserde_json.workspacefor the NIP-78 content.
5. UI
5.1 InboxView center panel
crates/workspace/src/views/inbox.rs, a BasePanel + Panel + Render, like RepoListView.
It owns the derived lists directly, so cx.notify() from an update re-renders it. The panel is one
bordered card (flex_1, min_h_0) with a header bar and a scrolling body. The body is a single
gpui::list virtual list (ListState + ListAlignment::Top, 400px overdraw) with a
vertical_scrollbar; the panel itself does not scroll, so the list gets a definite viewport height.
The list count is reset from render whenever the rendered row count changes.
- Header: the unread count badge and Mark all read.
- Body: the flattened repository-grouped rows. A repository header is a muted bar with a git icon, the repository name (or "Other repository" when the address is unknown) and its unread badge. Rows under it show the actor avatar, a kind icon, the subject, the kind label, a relative time, and an unread dot (the subject is semibold while unread). A repository with nothing to show renders "No activity yet."; the panel-level "You're all caught up." empty state appears only when there are no sections at all (no owned repositories and no items).
No greeting header, and no My repositories column - the sidebar already lists the user's repositories.
5.2 Grouping by repository
The grouping is panel-owned derivation, done once per data change in InboxView::rebuild (called
from run_refresh and regroup), never per frame:
struct InboxSection {
address: Option<RepoAddr>, // repository, None for items without one
unread: usize, // unread notification groups
entries: Vec<InboxEntry>, // newest first
latest: Timestamp, // orders the sections
}
enum InboxEntry { // indices into the panel's own lists
Notification(usize),
Activity(usize),
}
enum InboxRow { // the flattened list
Repo(usize),
Entry(usize, usize),
Empty, // "No activity yet." under an empty section
}
The section list and the flattened rows are stored as Arcs and cloned into the gpui::list
closure, which indexes the panel's notifications / activity lists - no per-frame deep copies.
Notification groups carry their repository in InboxItem::address; activity events carry it in a
GitRepoAnnouncement a tag (repo_address). Archived notification groups are left out.
rebuild also seeds a section for every repository in announcements_of(me). The panel observes
RepoListStore so a repository that loads after the last refresh still appears (its own empty
section, or with items if any arrived); this is the one logic subscription beyond the Inbox and
Backend ones. Repository names are resolved per render through repo_name -> RepoListStore, so a
late announcement still labels its section without re-deriving the grouping.
5.3 Sidebar
In views/sidebar/mod.rs:
-
Add
inbox: Option<WeakEntity<InboxView>>(mirrorsexplore). -
Add
fn open_inbox(&mut self, window, cx)that returns when the panel is already open, else adds a center panel (same shape asopen_explore; there is no dock API to focus an existing tab).InboxView::newtakes the sidebar'sWeakEntity<DockArea>so the panel can open a repo for a row. -
Point the existing nav item at it:
NavItem::new("inbox", "Inbox", Icon::new(IconName::Inbox).small()) .on_click(cx.listener(|this, _ev, window, cx| this.open_inbox(window, cx))), -
No unread badge. The nav item carries no suffix, and the sidebar does not observe the global
Inbox. The unread count lives in the panel only.
5.4 Click-through (P1)
Reuse the single RepoStore that RepoDetailView already creates instead of making a second one.
The detail panels need a Window, and GPUI's Entity::update_in only exists on a VisualContext,
which a synchronous App + Window pair is not - so the entry point is a free function rather than
a RepoDetailView::open_item method. In repo_detail/mod.rs:
pub(crate) enum RepoItem {
Issue(EventId),
PullRequest(EventId),
Patch,
}
pub(crate) fn open_repo_item(
dock_area: &WeakEntity<DockArea>,
store: Entity<RepoStore>,
item: RepoItem,
window: &mut Window,
cx: &mut App,
) { /* new IssueDetailView / PullRequestDetailView, added to the center */ }
RepoDetailView::store()exposes itsOption<Entity<RepoStore>>, so the caller reuses the repo panel's store rather than building one.views/mod.rsre-exportsRepoItemandopen_repo_item.InboxViewresolvesitem.addressto anAnnouncementfromRepoListStore, callsopen_repo_panel(which returnsEntity<RepoDetailView>), takes its store, and callsopen_repo_itemwith the root id and kind. The detail panel renders a "not found" placeholder until the store's fetch lands, then re-renders.- The repository panel and the detail panel are two tabs of the center group; the detail is activated. This matches the sidebar, which also opens a fresh repo panel per click.
Patches have no detail view in Signed (they are only consumed inside PullRequestDetailView), so a
patch-root click opens the repo panel only. RepoItem::Patch carries no id for that reason. A group
whose root is not an issue/PR/patch, or whose repository is not in RepoListStore, opens nothing.
6. File-by-file change list
| File | Change |
|---|---|
crates/signed_core/Cargo.toml |
add serde |
crates/signed_core/src/filters.rs |
NOTIFICATION_KINDS, notification_comments, notifications, authored_activity, is_git_activity, deletions |
crates/signed_core/src/inbox.rs |
new: InboxItem, notification_root, group, InboxReadState, tests |
crates/signed_core/src/lib.rs |
mod inbox; and re-exports |
crates/signed_state/Cargo.toml |
add serde_json |
crates/signed_state/src/inbox.rs |
thin global Inbox (NIP-78 read state, mark actions) and query_inbox (query, grouping, activity) |
crates/signed_state/src/backend.rs |
inbox: Entity<Inbox> field, construction, inbox() accessor, sync_inbox, RepoListStore import |
crates/signed_state/src/refresh.rs |
doc comment lists Inbox among the RefreshGate users |
crates/signed_state/src/lib.rs |
mod inbox;, re-export Inbox and query_inbox; re-export RefreshGate (no global install) |
crates/dock/src/lib.rs |
add_bottom_panel helper (currently unused; left over from the removed sub-views) |
crates/workspace/src/views/inbox.rs |
InboxView home panel owning the derived lists, the repository grouping, and the notification click-through |
crates/workspace/src/views/mod.rs |
mod inbox; pub use inbox::InboxView;; re-export RepoItem, open_repo_item, open_repo_panel |
crates/workspace/src/views/sidebar/mod.rs |
inbox field, open_inbox, nav wiring |
crates/workspace/src/views/repo_detail/mod.rs |
RepoItem, open_repo_item, RepoDetailView::store() |
No changes to desktop or signed_nostr. signed_state::init gains no parameters; Backend::sync_inbox
activates the Inbox child entity at each signer transition.
7. Phasing
- Phase 0 - pure logic:
signed_corefilters andinbox.rsplus tests. DONE. Implemented asfilters::{NOTIFICATION_KINDS, notification_comments, notifications, authored_activity, is_git_activity}andinbox::{InboxItem, notification_root, group, InboxReadState}. Two deviations from the sketch: the cutoff methods take an explicitnow: Timestampso the pure logic stays deterministic and testable, andauthored_activityresults must pass throughis_git_activitybefore display (comments on non-git roots are matched by the filter).cargo test -p signed_corepasses (66 tests at the end of Phase 0; 68 after the two Phase 1 additions). - Phase 1 - store:
Inboxchild entity, activated byBackend::sync_inboxonce a signer exists; both queries, unread count, and NIP-78 load/save to LMDB. DONE. See the implementation notes below. - Phase 2 - screen:
InboxView(inbox + activity) and the sidebar nav item. DONE. See the implementation notes below. - Phase 3 - sub-views:
add_bottom_panelandInboxFilterViewfor Unread / Archived. Done, then reverted. The sub-views were removed before the repository-grouping redesign; the notes below are historical. - Phase 4 - click-through:
open_itemand announcement lookup. DONE. See the implementation notes below. - Phase 5 (optional): standalone notifications page, NIP-65 relays, pagination, patch detail view.
Each phase compiles and is usable on its own.
Phase 1 implementation notes
Files: crates/signed_state/{Cargo.toml, src/inbox.rs, src/lib.rs, src/backend.rs, src/refresh.rs}
and two additions to crates/signed_core/src/inbox.rs.
Inboxis a child entity ofBackend(inbox: Entity<Inbox>), created inBackend::newand reached viaBackend::inbox(). Nothing indesktopis wired andsigned_state::initgains no parameters. The dependency is strictly one-way:Inboxholds noBackendhandle.Backend::emitis the single funnel for everyBackendEvent. It updates the inbox throughcx.deferand then emits to the other subscribers. The defer is required: every emit site runs insideBackend::update, and the inbox handlers readBackend, so a synchronous call panics on a re-entrant entity access.- The signer lifecycle lives in
Backend::sync_inbox, called fromcreate_identity,set_signerandlogout. It starts the subscriptions and repo-relay connects, then defersinbox.activate/inbox.reset.SignerChanged/SignerRequiredare still emitted forCheckoutsStoreandSidebarPanel, but no longer drive the inbox. InboxmirrorsRepoListStore:RefreshGatecoalescing,cx.background_spawnfor the database work, plain data applied on the main thread, refresh-on-NostrUpdate/Synced/Published.- Added
state_loaded: bool, not in the sketch. Groups are derived from the read state, so a refresh before the stored state is read would briefly mark everything unread. The first refresh is chained afterload_state, and laterrefreshcalls are ignored untilstate_loadedis set. - Account switches are guarded.
activateandresetboth replaceself.refreshwith a freshRefreshGate, dropping any in-flight or pending run of the previous user, and the apply step ofrun_refreshaborts instead of applying whenBackend::current_user()no longer matches the user the query was started for. - Two additions to
signed_core::inboxthat Phase 1 needs:InboxReadState::mark_archived(mirrorsmark_read) andInboxItem::apply_state(recomputesunread_ids/archived;groupnow uses it). Both are covered by tests. - The thread-root lookup is built by walking every
e/Eancestor transitively (fetch_notifications) rather than a single hop, because a patch series chains through parent patches. Only the notification events are grouped; ancestors are used solely as the lookup, so a root authored by someone else is not mistaken for a notification. - The read/archive state event is written to LMDB only (
database().save_event), signed with a freshKeys::generate()on each save and never published. Filtering is bydtag only, no author, so the random key is irrelevant across sessions.dtag usesme.to_hex()rather thanDisplay. - Actions:
mark_read(root),mark_archived(root),mark_all_read(). Each marks the group, advances the relevant cutoffs against all notification events (matching GitWorkshop's use ofallEvents), re-derives the groups locally so the UI updates immediately, then persists in the background. - The global
Inboxkeeps no derived state. The signing key is generated per save, the current user is read fromBackend::current_user()where needed, and the relays of the user's own repositories are queried fromRepoListStoreinBackend::sync_inboxrather than cached. There is no prune logic either: the newest state event is selected bycreated_at. Inbox::activate/Inbox::resetarepub(crate); the formersubscribe_remoteandconnect_own_repo_relaysmethods were deleted once their work moved intoBackend::sync_inbox.cargo test -p signed_corepasses (68 tests),cargo test -p signed_statepasses (24 tests);cargo clippy -p signed_state --all-targetsis clean;cargo check --workspacesucceeds.
Phase 2 implementation notes
Files: crates/workspace/src/views/{inbox.rs, mod.rs, sidebar/mod.rs}. No store changes.
InboxViewis a plain center panel likeRepoListView; the sidebar holds aWeakEntity<InboxView>so there is no cycle. Re-rendering relies on GPUI's render-time entity tracking rather than explicit observations. (Phase 2 introduced anEntity<InboxStore>here; it was later folded into the panel - see the store-merge note below.)- The layout is a column of two flexible bordered cards (
gap_4,p_4, eachflex_1/min_h_0), inbox over activity. Each card is a roundedv_flexwith a header bar (section) and agpui::listbody. There is no My repositories column: the sidebar already lists the user's repositories, so the panel is a single column. - Notification rows read the newest event of each group for the actor, subject and time, and the
root's kind for the icon. The repo name is resolved from
item.addressthrough a linear scan ofRepoListStore::announcements(repo_name); the list is small and this keeps the store unchanged. - The Unread / Archived header buttons are intentionally absent: they need
add_bottom_panel/InboxFilterView, which are Phase 3. The header is only Mark all read, so the panel is fully usable on its own. kind_icon/kind_labelmap aKindto aCustomIconName/IconNameand a short noun. The cover note is compared with==rather than matched, sinceKindcannot appear in a pattern arm.- Sidebar:
open_inboxmirrorsopen_explore(return if open, else add a center panel); the inbox nav item is repointed. The screen is still opened by the nav item, not on app startup, matching the "idle until signer" rule; auto-opening it as the post-login home is a possible follow-up. - The My repositories column (search
InputState, New button,open_repo_panelrows) was removed after Phase 2 as redundant with the sidebar, along with the panel'sdock_area,open_repo/open_create_repohelpers and thecreate_repo_dialog/open_repo_panelimports.InboxView::newnow takes onlycx.create_repo_dialogis private again. cargo clippy -p workspace --all-targetsis clean andcargo check --workspace --all-targetssucceeds.cargo test -p signed_core(68) andcargo test -p signed_state(24) still pass.
Architecture refactor (after Phase 2)
Phases 0-2 kept all derivation in the global Inbox, so every notification and activity query ran
whether or not the home screen was open, and Backend::emit carried a deferred side effect just to
feed it.
- The global
Inboxis now thin:state: InboxReadState,state_loaded, plus the NIP-78 load/save and the mark actions. Backend::emitis gone. AllBackendEvents are emitted withcx.emitagain, andsync_inboxupdates the inbox synchronously, passing the client in so nothing readsBackendmid-update.- The panel became the client-side owner of the derivation, initially through a panel-scoped
Entity<InboxStore>. signed_coreis unchanged.
Store merged into the panel (after Phase 2)
The InboxStore entity was then folded into InboxView, since the panel was its only consumer.
InboxViewholdsnotifications,activity,unread_count,state,state_loadedandRefreshGateas fields, and the store's methods (sync_state,handle_backend_event,refresh/run_refresh,regroup,publish_unread_count,clear, the mark actions) became panel methods. The two subscriptions call them directly, with noupdateindirection.- The database work stayed in
signed_stateaspub async fn query_inbox(...);RefreshGateandRefreshRequestare re-exported. The UI crate never queries LMDB directly. mark_read,mark_archivedand theirgroup_eventshelper carry a scoped#[allow(dead_code)]until the Phase 3 sub-views wire them up.cargo test -p signed_core(68),cargo test -p signed_state(24) andcargo test -p workspace(7) pass; clippy andcargo check --workspace --all-targetsare clean.
Trade-off: the unread count is derived by the panel, so it is only current while the panel is open.
(publish_unread_count fed a sidebar badge at the time; both were removed later - see "Sidebar
badge removed" below.)
Phase 3 implementation notes
Historical: the Unread/Archived sub-views below were later removed; the panel is now a single repository-grouped list. Kept for the
add_bottom_panel/ sub-view rationale.
Files: crates/dock/src/lib.rs and crates/workspace/src/views/{inbox.rs, sidebar/mod.rs}. No
store changes.
add_bottom_panelsits next toadd_center_paneland wrapsDockArea::add_panel_view(panel, DockPlacement::Bottom, None, ...). A new bottom dock starts open, and the workspace's existingDockEvent::LayoutChangedsubscription removes an emptied bottom dock, so a closed sub-view leaves no strip behind.InboxFilterViewis private toviews/inbox.rs. It holds anEntity<InboxView>(strong; the panel keeps only the weakfilter_viewback, so there is no cycle), the mode, and its ownListState. There is no subscription: it reads the inbox entity during render, which is enough for GPUI to invalidate the window when the inbox notifies.InboxFilteris a private two-variant enum withlabel()andmatches(&InboxItem). The tab title comes fromPanel::title, so switching modes throughset_moderetitles the same tab instead of opening a second one.InboxViewregained adock_area: WeakEntity<DockArea>(removed with the My-repositories column) and takes it innew.open_filterreuses the existing panel, focuses it, and reopens the bottom dock when it is collapsed; otherwise it creates and adds the panel.InboxView::newis now called asInboxView::new(self.dock_area.clone(), cx)fromSidebarPanel::open_inbox.- The three
#[allow(dead_code)]markers onmark_read,mark_archivedandgroup_eventsare gone: Unread rows callmark_readon click andmark_archivedfrom a trailing ghost icon button (Button+IconName::FolderClosed, tooltip "Archive"). The button callscx.stop_propagation()so it does not also trigger the row's mark-read click. Archived rows are display-only; the read state has no un-archive operation. notification_rowtakes an idprefixand returnsStateful<Div>rather thanAnyElement, so callers can attach a click handler and a trailing action. The inbox list passes"inbox-row"and the sub-view"inbox-filter-row", because the two lists render in the same window and would otherwise collide on(str, ix)ids.cargo clippy -p workspace -p dock --all-targetsis clean,cargo check --workspace --all-targetssucceeds, andcargo test -p signed_core -p signed_state -p workspacepasses (68 / 24 / 7).
Phase 4 implementation notes
Files: crates/workspace/src/views/{inbox.rs, mod.rs, repo_detail/mod.rs}. No store changes.
RepoItem { Issue(EventId), PullRequest(EventId), Patch }andpub(crate) fn open_repo_itemlive inrepo_detail/mod.rs, next toopen_repo_panel.open_repo_itemtakes the store as a parameter, avoiding a secondRepoStore.- It is a free function, not
RepoDetailView::open_item: the detail constructors take aWindow, and a synchronous&mut App+&mut Windowpair is not aVisualContext, soEntity::update_inis not available.InboxViewalready has the window in the list'son_click, so it drives the free function directly. The plan's originaldetail.update_in(window, cx, ...)sketch could not compile. RepoDetailView::store()(pub(crate)) exposes the panel'sOption<Entity<RepoStore>>. The repo panel is opened first and its store reused, so the detail panel shares one store with the repo it came from.InboxView::open_itemis also a free function (it needs nothing butdock_area, which it captures from the panel) because thegpui::listitem closure only receives&mut App. It resolvesitem.addressthroughRepoListStore, returns silently when the repository is unknown, opens the repo panel, then maps the root kind to aRepoItemand callsopen_repo_item.- Only the notification rows are clickable. Activity rows are display-only. The Phase 3 mark-read / archive row behaviour is gone with the sub-views.
RepoItem::Patchis a unit variant because the id would be unused: patches have no detail panel, soopen_repo_itemreturns before doing anything and only the repository panel opens.cargo clippy -p workspace --all-targetsis clean,cargo check --workspace --all-targetssucceeds, andcargo test -p signed_core -p signed_state -p workspace -p dockpasses (68 / 24 / 7 / 1).
Repository grouping redesign (after Phase 4)
Files: crates/workspace/src/views/inbox.rs. No store, no signed_core changes.
The two-card layout (notifications over activity) was replaced by a single repository-grouped list.
- The panel now derives
sections: Vec<InboxSection>and a flattenedrows: Vec<InboxRow>inrebuild, called fromrun_refreshandregroup. Both are stored asArcs and cloned into thegpui::listclosure, which indexesnotifications/activity- no deep copies per frame and no data duplicated between the section list and the source lists. InboxSectiongroups a repository's non-archived notification groups and the user's own activity, newest first; sections are ordered by their newest entry.InboxEntryholds indices into the panel's lists;InboxRow::Repo/InboxRow::Entry/InboxRow::Emptyis the flattened shape the list renders.- All of the user's own repositories are seeded as sections from
RepoListStore::announcements_of, so an owned repository with nothing to show gets an empty section ("No activity yet.") and sorts after the sections with activity. The panel observesRepoListStoreto rebuild when the user's repositories load or change. - Activity is matched to a repository through a
GitRepoAnnouncementatag (repo_address). Items without an address share the "Other repository" section. notification_row/activity_rowno longer render the repository name - the section header does. That also drops oneRepoListStorescan per row.- The single card has one
ListState; the oldnotifications_list/activity_listand therender_inbox_panel/render_activity_panel/sectionhelpers are gone.notification_rowstill takes an id prefix so rows stay unique within the list. cargo clippy -p workspace --all-targetsis clean andcargo test -p signed_core -p signed_state -p workspace -p dockpasses (68 / 24 / 7 / 1).
Sidebar badge removed (after the repository grouping redesign)
Files: crates/signed_core/src/filters.rs, crates/signed_state/src/{inbox.rs,backend.rs},
crates/workspace/src/views/{inbox.rs,sidebar/mod.rs}.
An intermediate change made the sidebar badge live by moving the unread count into the global
Inbox (a refresh_unread_count driven by Backend). That was then reverted along with the badge
itself, so the global is thin again.
- The sidebar nav item no longer renders a
CountBadge;SidebarPanellost itsunreadfield and its observe of the globalInbox. - The global
Inboxno longer stores anunread_countand has noset_unread_count/refresh_unread_count.Backendhas norefresh_inbox_unreadand no per-batch or per-sync count refresh.filters::affects_inboxand thequery_inboxhelper split were reverted with it. InboxViewkeeps its localunread_countfor its header badge and the per-sectionunreadfor the repository headers;publish_unread_countstays deleted.- Consequence: the unread count is only current while the panel is open, and there is no unread indication anywhere else in the app.
cargo clippy -p signed_core -p signed_state -p workspace --all-targetsis clean,cargo check -p signed_core -p signed_state -p workspace --all-targetssucceeds, andcargo test -p signed_core -p signed_state -p workspace -p dockpasses (68 / 24 / 7 / 1).
8. Validation
cargo test -p signed_core(68 tests): root resolution, grouping, read-state cutoff, serde round-trip.cargo test -p signed_state(24 tests): theInbox/query_inboxpaths that do not need GPUI (state round-trip, grouping helpers).cargo test -p workspace(7 tests): repository-detail helpers.cargo clippy -p signed_state --all-targets,cargo clippy -p workspace --all-targetsandcargo check --workspace --all-targetsafter each phase.- Manual: log in with a repo-owning identity; open the inbox from the sidebar and confirm the panel
populates from another identity's issue/comment, the activity list shows your own items, and that no
kind-30078 event is broadcast (watch the relays /
Publishedevents). Restart to confirm the read state is read back from LMDB. Confirm the sidebar has no unread badge.
9. SDK APIs used (verified in the pinned 5c669a4 checkout)
Kind::{Comment, GitIssue, GitPullRequest, GitPatch, GitPullRequestUpdate,GitStatusOpen/Applied/Closed/Draft, ApplicationSpecificData, EventDeletion, RequestToVanish}Filter::{kind, kinds, pubkey, pubkeys, custom_tags, limit, since, events, coordinate, identifier}- Non-obvious:
Filter::pubkey/pubkeysset the lowercaseptag, notauthors. UseFilter::author/authorsfor authorship. Thenotificationsfilter relies on this.
- Non-obvious:
SingleLetterTag::{LOWERCASE_P, LOWERCASE_E, UPPERCASE_P, UPPERCASE_K, UPPERCASE_E}nostr::nips::nip22::{extract_root, extract_parent, CommentTarget}: NIP-22 root/parent pointersTags::{event_ids, public_keys, coordinates, identifier, hashtags}iteratorsClient::{database, subscribe, sync, notifications, send_event, add_relay};NostrDatabase::{save_event, query};NostrLmdb,NostrGossipMemoryEventBuilder::{new, tags, finalize},Tag::identifier,Keys::generateTimestamp,EventId(hex serde),PublicKey,Coordinate- Fetch paths converge on the same notification:
client.subscribe(...)and negentropyclient.sync(...)both persist received events to LMDB and surface them asClientNotification::Event, whichBackend's pump batches intoBackendEvent::NostrUpdate. This is why the query right after a fetch is a cache read, not a race.