PCH: Fix issue with potential duplicate API calls in settings and smart links#3095
PCH: Fix issue with potential duplicate API calls in settings and smart links#3095
Conversation
vaurdan
added
Changelog: Fixed
📝 WalkthroughWalkthroughThis pull request introduces modifications to the settings management and initialization processes in the Content Helper. The changes focus on optimizing the Changes
Sequence DiagramsequenceDiagram
participant Component as Smart Linking Component
participant InitRef as initializationRef
participant Effect as useEffect
Component->>InitRef: Initialize with false
Component->>Effect: Trigger initialization
Effect->>InitRef: Check current value
alt Not yet initialized
Effect->>Component: Perform initialization
Effect->>InitRef: Set to true
else Already initialized
Effect->>Effect: Return early
end
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
src/content-helper/common/settings/provider.tsx (2)
91-91: Good use ofuseReffor tracking previous settings.
Storing the initial data in a ref helps avoid unintended re-renders. Ensure the@sinceannotation reflects this addition if a doc block is introduced in the future.
97-99: Early return on first render is valid.
This prevents initial unnecessary API calls and ensures data is set properly before proceeding. Doc blocks around this logic might be updated to mention skipping the first render explicitly.src/content-helper/editor-sidebar/smart-linking/component.tsx (1)
194-194: Initial local ref for initialization state.
initializationRefensures the logic only runs once. Consider adding an inline comment with a@sincetag if this is part of a bigger feature change.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
build/content-helper/dashboard-widget.asset.phpis excluded by!build/**build/content-helper/dashboard-widget.jsis excluded by!build/**build/content-helper/editor-sidebar.asset.phpis excluded by!build/**build/content-helper/editor-sidebar.jsis excluded by!build/**
📒 Files selected for processing (3)
src/content-helper/common/settings/provider.tsx(2 hunks)src/content-helper/editor-sidebar/smart-linking/component.tsx(4 hunks)src/rest-api/settings/class-endpoint-excerpt-suggestions-settings.php(0 hunks)
💤 Files with no reviewable changes (1)
- src/rest-api/settings/class-endpoint-excerpt-suggestions-settings.php
🧰 Additional context used
📓 Path-based instructions (2)
src/content-helper/common/settings/provider.tsx (1)
Pattern **/*.{js,ts,tsx,jsx}: "Perform a detailed review of the provided code with following key aspects in mind:
- Review the code to ensure it is well-structured and adheres to best practices.
- Verify compliance with WordPress coding standards.
- Ensure the code is well-documented.
- Check for security vulnerabilities and confirm the code is secure.
- Optimize the code for performance, removing any unnecessary elements.
- Validate JSDoc comments for accuracy, currency, and adherence to WordPress coding standards.
- Ensure each line comment concludes with a period.
- Confirm every JSDoc comment includes a @SInCE tag indicating the next version of the plugin to include the code.
- Guarantee compatibility with the latest version of WordPress, avoiding deprecated functions or features."
src/content-helper/editor-sidebar/smart-linking/component.tsx (1)
Pattern **/*.{js,ts,tsx,jsx}: "Perform a detailed review of the provided code with following key aspects in mind:
- Review the code to ensure it is well-structured and adheres to best practices.
- Verify compliance with WordPress coding standards.
- Ensure the code is well-documented.
- Check for security vulnerabilities and confirm the code is secure.
- Optimize the code for performance, removing any unnecessary elements.
- Validate JSDoc comments for accuracy, currency, and adherence to WordPress coding standards.
- Ensure each line comment concludes with a period.
- Confirm every JSDoc comment includes a @SInCE tag indicating the next version of the plugin to include the code.
- Guarantee compatibility with the latest version of WordPress, avoiding deprecated functions or features."
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: E2E against WordPress latest
🔇 Additional comments (8)
src/content-helper/common/settings/provider.tsx (4)
62-68: Switching to a standard function declaration is fine.
This change is acceptable and consistent with the existing codebase style.
101-102: Efficient comparison for unchanged data.
Skipping the save when data has not changed aligns with the PR goal of reducing duplicate requests.
106-107: UpdatingpreviousDataafter changes is sound.
Properly synchronizingpreviousDatacloses the loop on preventing unnecessary updates.
Line range hint
246-248: Dependency array includes relevant state.
Addingpermissions.SmartLinking,ready,postId, andinitializationRefensures the effect only re-runs when logically necessary. Monitor for unintended rerenders or missing dependencies.Also applies to: 252-252
src/content-helper/editor-sidebar/smart-linking/component.tsx (4)
9-9: Ref imports are appropriate.
Bringing inuseRef(and other hooks) is consistent with WordPress and React usage.
211-214: Guard clause prevents repeated initialization.
This avoids multiple calls to the same endpoint. The inline comment properly ends with a period.
215-216: SettinginitializationRefindicates successful initialization.
This simple flag approach is clear and avoids repeated triggers.
246-248: Added dependencies in effect.
IncludinginitializationRefin the dependency array is crucial. Validate that changes in these dependencies won’t cause unwanted re-initializations.Also applies to: 252-252
…-requests PCH: Fix issue with potential duplicate API calls in settings and smart links" (13db281)
2 participants
Description
While working on the Traffic Boost feature, I noticed a re-rendering issue that was causing a bunch of duplicated requests in a row to the
editor-sidebarsettings endpoint. By checking if the data has actually changed, we can only call the endpoint if there are changes in the settings.I also noticed a double call to the Smart Links
/getendpoint. This was due to the initialization useEffect running twice. I added a safeguard ref to track if the component was already initialized, so it only calls the/getendpoint once.Motivation and context
How has this been tested?
Summary by CodeRabbit
Release Notes
Performance Improvements
Code Maintenance
Stability