Skip to content

Changed profile modal to always remote load in admin-x-activitypub#22012

Merged
mike182uk merged 1 commit intomainfrom
ap-view-profile-remote-load
Jan 15, 2025
Merged

Changed profile modal to always remote load in admin-x-activitypub#22012
mike182uk merged 1 commit intomainfrom
ap-view-profile-remote-load

Conversation

@mike182uk
Copy link
Member

@mike182uk mike182uk commented Jan 15, 2025

no refs

Changed profile modal to always remote load in admin-x-activitypub instead of both accepting an object or a string. This will allow for easier refactoring of the modal when we switch this area of the app to use accounts instead of profiles

Summary by CodeRabbit

Release Notes

  • Refactor

    • Simplified profile modal data structure across multiple components
    • Updated profile-related function calls to use handle directly instead of nested profile objects
  • Bug Fixes

    • Streamlined profile data passing mechanism to improve consistency and reduce complexity

The changes focus on standardizing how profile information is handled and displayed throughout the application, making the code more straightforward and maintainable.

no refs

Changed profile modal to always remote load in admin-x-activitypub instead of
both accepting an object or a string. This will allow for easier refactoring
of the modal when we switch this area of the app to use `accounts` instead of
`profiles`
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 15, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/admin-x-activitypub/src/components/Profile.tsx

Oops! Something went wrong! :(

ESLint: 8.44.0

ESLint couldn't find the plugin "eslint-plugin-react-hooks".

(The package "eslint-plugin-react-hooks" was not found when loaded as a Node module from the directory "/apps/admin-x-activitypub".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react-hooks@latest --save-dev

The plugin "eslint-plugin-react-hooks" was referenced from the config file in "apps/admin-x-activitypub/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces a systematic refactoring across multiple components in the ActivityPub admin interface, focusing on simplifying how profile handles are passed to modals. The changes consistently replace a complex profile object with a simple handle string when invoking NiceModal.show. This modification affects components like Profile, Search, APAvatar, and ViewProfileModal, streamlining the data structure for profile interactions and modal display.

Changes

File Change Summary
apps/admin-x-activitypub/src/components/Profile.tsx Modified handleAccountClick to pass handle directly instead of nested in a profile object
apps/admin-x-activitypub/src/components/Search.tsx Updated SearchResult to pass handle directly to modal
apps/admin-x-activitypub/src/components/global/APAvatar.tsx Changed onClick to pass handle directly to NiceModal.show
apps/admin-x-activitypub/src/components/modals/ViewProfileModal.tsx Simplified ViewProfileModalProps from complex object to single handle string
apps/admin-x-activitypub/src/utils/handle-profile-click.ts Renamed modal parameter from profile to handle

Sequence Diagram

sequenceDiagram
    participant Component
    participant NiceModal
    participant ViewProfileModal
    
    Component->>NiceModal: show(handle)
    NiceModal->>ViewProfileModal: Render with handle
    ViewProfileModal->>ViewProfileModal: Fetch profile data
    ViewProfileModal-->>Component: Display profile details
Loading

Possibly related PRs

Poem

🐰 A rabbit's tale of handles light,
Modals dancing with pure delight,
No more nested objects so dense,
Just a string that makes perfect sense!
Code refactored, clean and bright 🌟

Finishing Touches

  • 📝 Generate Docstrings (Beta)

🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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.

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 (3)
apps/admin-x-activitypub/src/components/Search.tsx (1)

51-51: Consider destructuring for improved readability.

While the change correctly implements the new modal interface, the code could be more readable with destructuring.

-NiceModal.show(ViewProfileModal, {handle: result.handle, onFollow, onUnfollow});
+const {handle} = result;
+NiceModal.show(ViewProfileModal, {handle, onFollow, onUnfollow});
apps/admin-x-activitypub/src/components/modals/ViewProfileModal.tsx (1)

227-234: Consider implementing caching for profile data.

Since the modal now always loads profile data remotely, implementing a caching strategy (e.g., React Query's caching capabilities) could improve performance and reduce unnecessary network requests, especially for frequently viewed profiles.

apps/admin-x-activitypub/src/components/Profile.tsx (1)

Line range hint 1-424: Consider further componentization opportunities.

The codebase is well-structured, but as you transition from profiles to accounts, consider these architectural improvements:

  1. Extract tab components (PostsTab, LikesTab, etc.) into separate files to improve maintainability
  2. Create a shared AccountListItem component to reduce duplication in FollowingTab and FollowersTab
  3. Consider implementing a central account state management solution to handle the transition more effectively

These changes would make the codebase more maintainable and easier to refactor in the future.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4ebf4dd and 6aa5c85.

📒 Files selected for processing (5)
  • apps/admin-x-activitypub/src/components/Profile.tsx (1 hunks)
  • apps/admin-x-activitypub/src/components/Search.tsx (1 hunks)
  • apps/admin-x-activitypub/src/components/global/APAvatar.tsx (1 hunks)
  • apps/admin-x-activitypub/src/components/modals/ViewProfileModal.tsx (1 hunks)
  • apps/admin-x-activitypub/src/utils/handle-profile-click.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Unit tests (Node 20.11.1)
  • GitHub Check: Unit tests (Node 18.12.1)
  • GitHub Check: Lint
🔇 Additional comments (4)
apps/admin-x-activitypub/src/utils/handle-profile-click.ts (1)

9-9: LGTM! Clean refactor to use handle instead of profile.

The change simplifies the data flow while maintaining the same functionality by extracting the handle from the actor properties.

apps/admin-x-activitypub/src/components/global/APAvatar.tsx (1)

72-72: LGTM! Simplified modal show call.

The change efficiently reuses the pre-computed handle variable and removes the unnecessary object wrapper, maintaining consistency with the new modal interface.

apps/admin-x-activitypub/src/components/modals/ViewProfileModal.tsx (1)

219-221: LGTM! Clean interface simplification.

The props interface has been simplified to accept just the handle and optional callbacks, making the component's contract clearer and more focused.

apps/admin-x-activitypub/src/components/Profile.tsx (1)

180-180: LGTM! The simplified modal show call aligns with the refactoring goals.

The change standardizes the profile modal loading pattern by directly passing the handle, which aligns with the transition from profiles to accounts.

Let's verify that this pattern is consistently applied across the codebase:

✅ Verification successful

Verified: Modal call correctly matches component interface

The change is consistent with the ViewProfileModal implementation, which expects a handle prop of type string. The simplified modal show call aligns perfectly with the component's interface and the codebase's refactoring goals.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining instances of profile object being passed to ViewProfileModal
# Expect: No instances of passing profile object to ViewProfileModal.show

# Search for ViewProfileModal.show calls
rg "ViewProfileModal.*show.*profile:" apps/admin-x-activitypub/

Length of output: 65


Script:

#!/bin/bash
# Search for all ViewProfileModal.show calls
echo "=== ViewProfileModal.show calls ==="
rg "ViewProfileModal.*show" apps/admin-x-activitypub/

# Search for ViewProfileModal component definition
echo -e "\n=== ViewProfileModal component definition ==="
ast-grep --pattern 'const ViewProfileModal = $_'

# Search for any remaining profile prop types or interfaces
echo -e "\n=== Profile related types ==="
rg "interface.*Profile|type.*Profile" apps/admin-x-activitypub/

Length of output: 1961


Script:

#!/bin/bash
# Search for NiceModal.show calls in Profile.tsx
echo "=== Modal show calls in Profile.tsx ==="
rg "NiceModal\.show" apps/admin-x-activitypub/src/components/Profile.tsx -A 1

# Check ViewProfileModal props and implementation
echo -e "\n=== ViewProfileModal implementation ==="
rg "interface ViewProfileModalProps|const ViewProfileModal" -A 3 apps/admin-x-activitypub/src/components/modals/ViewProfileModal.tsx

Length of output: 678

@mike182uk mike182uk merged commit 7cf0e92 into main Jan 15, 2025
18 checks passed
@mike182uk mike182uk deleted the ap-view-profile-remote-load branch January 15, 2025 20:59
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