Skip to content

Added Valtio experiment for reactive state management in ActivityPub #23956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

minimaluminium
Copy link
Member

no issues

- Added basic feed store with posts array and setPosts action
- Synced React Query feed data to Valtio store
- Updated FeedList to render from store instead of props
Copy link
Contributor

coderabbitai bot commented Jun 20, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new state management approach was introduced to the @tryghost/admin-x-activitypub package using the Valtio library, which was added as a dependency. A centralized feed store was implemented with Valtio, including a proxy store, action methods, and a React hook for accessing the store's state. A synchronization hook was created to update the store with paginated feed data. The FeedList component was refactored to consume feed data directly from the store rather than receiving it as a prop, and the Feed view was updated to use the new synchronization hook. No changes were made to exported entities outside the feed store and related hooks.


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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@minimaluminium minimaluminium marked this pull request as draft June 20, 2025 10:26
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
apps/admin-x-activitypub/src/stores/feed-store.ts (1)

18-24: LGTM: Well-structured store actions.

The actions object provides a clean API for updating the store. The direct mutation of feedStore.posts is the correct pattern for Valtio stores.

Consider expanding the actions object in the future to include methods like:

  • addPost(post: Activity) for adding individual posts
  • updatePost(id: string, updates: Partial<Activity>) for updating specific posts
  • clearPosts() for clearing the feed

This would provide a more comprehensive API as the application grows.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between da3cf28 and 428eed9.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (5)
  • apps/admin-x-activitypub/package.json (1 hunks)
  • apps/admin-x-activitypub/src/stores/feed-store.ts (1 hunks)
  • apps/admin-x-activitypub/src/stores/sync-feed.ts (1 hunks)
  • apps/admin-x-activitypub/src/views/Feed/Feed.tsx (1 hunks)
  • apps/admin-x-activitypub/src/views/Feed/components/FeedList.tsx (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Setup
🔇 Additional comments (13)
apps/admin-x-activitypub/package.json (1)

76-76: Verify the Valtio version and check for security advisories.

Ensure that the specified version ^2.1.5 is valid, secure, and compatible with the project's other dependencies.

#!/bin/bash
# Description: Verify Valtio version availability and security advisories

# Check latest version of Valtio
npm view valtio versions --json | jq '.[-5:]'

# Check for security advisories
gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: NPM, package: "valtio") {
    nodes {
      advisory {
        summary
        severity
        publishedAt
      }
      vulnerableVersionRange
      firstPatchedVersion {
        identifier
      }
    }
  }
}'
apps/admin-x-activitypub/src/views/Feed/Feed.tsx (3)

7-7: LGTM: Clean integration of the synchronization hook.

The import statement properly integrates the new sync functionality.


15-16: LGTM: Proper synchronization with Valtio store.

The synchronization call is well-placed and includes a helpful comment explaining its purpose.


20-26: Verify that FeedList component interface has been updated.

The activities prop is no longer passed to FeedList. Ensure that the component's interface and implementation have been properly updated to consume data from the store.

#!/bin/bash
# Description: Verify FeedList component interface and prop usage

# Check FeedList component interface to ensure activities prop is removed
ast-grep --pattern 'export type FeedListProps = {
  $$$
}'

# Check if activities prop is still being used anywhere in FeedList
rg -A 3 'activities' apps/admin-x-activitypub/src/views/Feed/components/FeedList.tsx
apps/admin-x-activitypub/src/stores/sync-feed.ts (2)

5-7: LGTM: Clear interface definition for paginated response.

The PaginatedResponse interface properly defines the expected structure for paginated feed data.


9-17: ```shell
#!/bin/bash

Preview the feedQuery definition to inspect its return structure

sed -n '1350,1450p' apps/admin-x-activitypub/src/hooks/use-activity-pub-queries.ts


</details>
<details>
<summary>apps/admin-x-activitypub/src/views/Feed/components/FeedList.tsx (4)</summary>

`10-10`: **LGTM: Proper integration of the feed store hook.**

The import statement correctly integrates the Valtio store hook.

---

`29-31`: **LGTM: Clean integration of reactive store data.**

The component properly accesses reactive data from the Valtio store with a helpful comment.

---

`63-63`: **LGTM: Consistent replacement of activities with store data.**

All references to the activities array have been correctly replaced with `feedState.posts` from the store, maintaining the same functionality while using the centralized state management.



Also applies to: 69-69, 76-76, 98-98

---

`13-19`: **Verify that the activities prop has been removed from the interface.**

The component no longer receives activities as a prop. Ensure the `FeedListProps` interface has been updated to remove the activities property.


```shell
#!/bin/bash
# Description: Verify the FeedListProps interface has been updated

# Check the exact interface definition
ast-grep --pattern 'export type FeedListProps = {
  $$$
}'

# Ensure no activities prop remains in the interface
rg 'activities.*Activity\[\]' apps/admin-x-activitypub/src/views/Feed/components/FeedList.tsx
apps/admin-x-activitypub/src/stores/feed-store.ts (3)

4-6: LGTM: Well-defined store interface.

The FeedStore interface clearly defines the store structure with proper TypeScript typing.


8-11: LGTM: Proper Valtio proxy store initialization.

The store is correctly initialized using Valtio's proxy() with appropriate default state.


13-16: LGTM: Clean reactive hook implementation.

The hook properly uses useSnapshot() to provide reactive access to the store state for React components.

Copy link

codecov bot commented Jun 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.38%. Comparing base (d4f4b88) to head (5f94fc7).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #23956   +/-   ##
=======================================
  Coverage   72.38%   72.38%           
=======================================
  Files        1533     1533           
  Lines      112636   112636           
  Branches    13768    13768           
=======================================
  Hits        81537    81537           
- Misses      30061    30078   +17     
+ Partials     1038     1021   -17     
Flag Coverage Δ
admin-tests 48.71% <ø> (ø)
e2e-tests 72.38% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant