Optimize StoryClient to prevent unnecessary re-creation of client

[0oooooooo0]

Description

• Use useMemo to ensure the client is only created when the config changes.

Summary by CodeRabbit

• Performance Improvement
  • Optimized the StoryProvider component to reduce unnecessary re-renders by using the useMemo hook for client instance creation.

[coderabbitai]

Walkthrough

The recent changes optimize the StoryProvider component in the StoryProtocolContext.tsx file by incorporating the useMemo hook from React. This revision ensures that the client instance is only recreated when the config dependency changes, enhancing performance by preventing unnecessary re-instantiations.

Changes

File	Change Summary
.../react-sdk/src/StoryProtocolContext.tsx	Added useMemo import, modified StoryProvider to use useMemo for creating client with config

Poem

In the code where stories weave,
useMemo steps in to relieve.
With config's change, the client’s conceived,
Efficiency and speed achieved.
🐇✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1097d88 and 0fe6c5c.

Files selected for processing (1)

• packages/react-sdk/src/StoryProtocolContext.tsx (2 hunks)

Additional comments not posted (3)

packages/react-sdk/src/StoryProtocolContext.tsx (3)

1-1: LGTM! The addition of useMemo is appropriate for optimization.

The use of useMemo ensures that the client is only recreated when config changes, which can improve performance by preventing unnecessary re-instantiations.

---

Line range hint 15-17:
LGTM! The useStoryContext hook is correctly implemented.

The function correctly uses useContext to return the context value from StoryContext.

---

12-12: Ensure config is correctly passed and used throughout the codebase.

The useMemo hook is used correctly here. Verify that config is correctly passed and used in the rest of the codebase to ensure consistency and correctness.

Verification successful

---

Verified: config is correctly passed and used throughout the codebase.

The config object is correctly passed to the StoryProvider in the Wrapper component, ensuring consistency and correctness.

• Wrapper component correctly passes config to StoryProvider.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that `config` is correctly passed and used throughout the codebase.

# Test: Search for the usage of `StoryProvider` and ensure `config` is correctly passed.
rg --type typescript -A 5 $'StoryProvider'

Length of output: 76

---

Script:

#!/bin/bash
# Description: Verify that `config` is correctly passed and used throughout the codebase.

# Find all TypeScript files and search for the usage of `StoryProvider` to ensure `config` is correctly passed.
fd -e ts -e tsx -x rg 'StoryProvider' -A 10

Length of output: 1125