Koenig: Fix race condition in Unsplash search that causes incorrect results

[niranjan-uma-shankar]

Fixes TryGhost/Ghost#24640

Problem

The Unsplash search component (used in the lexical editor and Design Settings) can sometimes fail to request results for the final search term. When typing a term like "Trumpet", the component may only send a request for a partial keyword (e.g. "Trump") and never send the request for the full term "Trumpet". This is caused by logic that prevents a new search from being initiated while a prior request is still in flight.

In the example below, the search for "Trumpet" shows results for "Trump".

lfinal.mp4

Root cause

• New search is skipped while a prior request is running. The search logic contains a guard that prevents starting a new request if another is still in progress. This means the final, complete query may never be sent.
  For example, when typing "Jupiter" with a brief pause after "Jupi", the debounced search (300 ms) fires for "Jupi". If the remaining "ter" is typed while the "Jupi" request is still in flight, the "Jupiter" request is never made, because the guard blocks it until the current request completes.

• Debounce is short. The debounce is relatively short at 300 ms, which increases the probability that a previous request is still running when a new search is fired (The Ember Unsplash component uses 600 ms for reference.)

Fix

• Remove the guard that blocks starting a new fetch when there is an in-flight request.
• Only update results if they match the active search term. When a response arrives, verify that its search term matches the current active term before updating the modal. This prevents a flash of response for stale search terms, and instead the loading indicator will be displayed.
  For example, in the "Jupiter" scenario above, if the active term is "Jupiter", ignore updating the UI with "Jupi" response and instead continue showing the loading indicator.
• Increase debounce to 600ms, which lowers the chances that an in-flight request is still under process when a new fetch has started.

[coderabbitai]

Warning

Rate limit exceeded

@niranjan-uma-shankar has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 27 minutes and 27 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 9636c1d and 2933f71.

📒 Files selected for processing (6)

• packages/kg-unsplash-selector/src/UnsplashSearchModal.tsx (2 hunks)
• packages/kg-unsplash-selector/src/api/IUnsplashProvider.ts (1 hunks)
• packages/kg-unsplash-selector/src/api/InMemoryUnsplashProvider.ts (3 hunks)
• packages/kg-unsplash-selector/src/api/PhotoUseCase.ts (1 hunks)
• packages/kg-unsplash-selector/src/api/UnsplashProvider.ts (4 hunks)
• packages/kg-unsplash-selector/src/api/UnsplashService.ts (3 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

🪧 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.
• 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.

Support

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

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 generate unit tests to generate unit tests for 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.