ENG-1188: prod: pull watchers for prop based settings

[sid597]

https://www.loom.com/share/609bba5ec2b54b2aad94d4c09a4921ce

Summary by CodeRabbit

Release Notes

• Refactor
  • Introduced reactive watchers to detect and respond to changes in feature flags, global settings, personal settings, and discourse node pages.
  • Streamlined system initialization and removed debug diagnostic output for cleaner runtime behavior.
  • System now dynamically handles settings modifications with customizable handlers for different setting types.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

---

[linear]

ENG-1188 Create a pull watch handler on the settings page per feature flag

[supabase]

This pull request has been ignored for the connected project zytfjzqyijgagqxrzbmz because there are no changes detected in packages/database/supabase directory. You can change this behaviour in Project Integrations Settings ↗︎.

---

Preview Branches by Supabase.
Learn more about Supabase Branching ↗︎.

[sid597]

• ENG-1345: Modify existing RoamJS component onChange to also change props #745 : 2 dependent PRs (#684 , #688 )
• ENG-1190 Replace existing roam-js components with blockProp based ones #689
• ENG-1188: prod: pull watchers for prop based settings #682 👈 (View in Graphite)
• ENG-1187: Prod: Implement get and set for block prop based settings #669
• ENG-1189: Prod: Init block prop based schema #666
• ENG-1330: zod schema for discourse relations #719
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[coderabbitai]

✅ Actions performed

Full review triggered.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request removes debug stubs and implements a new pull-watch system to observe and react to changes in Roam block properties for settings-related blocks and discourse nodes. The system provides handler registries for feature flags, global settings, personal settings, and discourse node changes, with setup and cleanup utilities.

Changes

Cohort / File(s)	Summary
Stub Code Removal apps/roam/src/components/settings/utils/accessors.ts, apps/roam/src/components/settings/utils/init.ts	Removed stubGetLeftSidebarPersonalSections getter function and its debug console logging. Removed printAllSettings diagnostic function and related imports; simplified initialization to only invoke stubSetLeftSidebarPersonalSections after 2-second delay.
Pull-Watch Infrastructure apps/roam/src/components/settings/utils/pullWatchers.ts	New module introducing a pull-watch system with handler registries for feature flags, global settings, and personal settings. Provides setupPullWatchOnSettingsPage() and setupPullWatchDiscourseNodes() setup functions with cleanup callbacks, plus utility functions for property normalization and change detection using zod validation.
Main Integration apps/roam/src/index.ts	Integrated pull-watch system into initialization flow by destructuring blockUids and nodePageUids from initSchema, setting up watchers with their cleanup callbacks, and invoking cleanup functions during unload.

Sequence Diagram

sequenceDiagram
    participant Init as Initialization Flow
    participant PullWatch as Pull-Watch System
    participant RoamAPI as Roam Block API
    participant Handlers as Handler Registries
    participant Cleanup as Cleanup

    Init->>PullWatch: setupPullWatchOnSettingsPage(blockUids)
    activate PullWatch
    PullWatch->>RoamAPI: Register watchers on settings blocks
    PullWatch->>PullWatch: Return cleanup callback
    deactivate PullWatch
    
    Init->>PullWatch: setupPullWatchDiscourseNodes(nodePageUids)
    activate PullWatch
    PullWatch->>RoamAPI: Register watchers on discourse nodes
    PullWatch->>PullWatch: Return cleanup callback
    deactivate PullWatch

    RoamAPI->>PullWatch: Block property change detected
    activate PullWatch
    PullWatch->>PullWatch: Normalize props & validate with zod
    PullWatch->>Handlers: Invoke registered handler<br/>(newValue, oldValue, allSettings)
    deactivate PullWatch

    Init->>Cleanup: On unload: invoke cleanup callbacks
    activate Cleanup
    Cleanup->>RoamAPI: Unregister all watchers
    deactivate Cleanup

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• ENG-852 Render left sidebar based on fetched sections and settings #440: Implements the LeftSidebarView component that consumes the left-sidebar personal settings provided by the pull-watch handler infrastructure introduced in this PR.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: introducing pull watchers for property-based settings, which is the core focus of the changeset across multiple files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[devin-ai-integration]

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 5 additional flags.

[mdroidian]

Good stuff!

Mostly a lot of DRY code can be removed, and we can use roamjs-component definitions.

[mdroidian]

Looks good, a few cleanup comments.

It isn't clear what path we are taking with all of these branches to get to main, so make sure not to merge code that makes changes to users graphs (eg: discourse node init) to main.