Skip to content

fix: when streaming, closing the chat window will continue to capture focus and reopen the chat div#142

Open
efortish wants to merge 2 commits intoopenedx:mainfrom
eduNEXT:ks/ai-chat-scrolling-kidnaping
Open

fix: when streaming, closing the chat window will continue to capture focus and reopen the chat div#142
efortish wants to merge 2 commits intoopenedx:mainfrom
eduNEXT:ks/ai-chat-scrolling-kidnaping

Conversation

@efortish
Copy link
Contributor

Related issue: #134

Summary

Improves the AI Sidebar chat UX during streaming responses by preventing scroll “hijacking” and allowing the sidebar to be closed by clicking outside.

Problem

When the AI response is streamed in many incremental chunks, the UI could:

  • Force-scroll to the bottom on every chunk, preventing users from scrolling up to read previous messages.
  • Feel “kidnapped” because the view kept snapping down while the message was being generated.
  • Not reliably close when clicking outside the sidebar during streaming.

Changes (Frontend)

1) Smart auto-follow (no scroll hijacking)

  • Tracks whether the user is near the bottom and whether auto-follow is enabled.
  • If the user scrolls up (even slightly), auto-follow is disabled immediately.
  • Auto-follow is re-enabled only when the user scrolls back near the bottom.
  • Ignores programmatic scroll events to avoid feedback loops.

2) Close on outside click (backdrop click)

  • Uses ModalLayer's onClose to close the sidebar when the user clicks outside the sidebar area.
  • Closing the sidebar does not fight against streaming updates.

How it works

  • Auto-scroll occurs only when:
    • the user is near the bottom, and
    • auto-follow is enabled.
  • A user scroll-up disables auto-follow so streaming chunks no longer yank the viewport back down.
  • Clicking outside triggers onClose -> handleClose, closing the sidebar cleanly.

What this prevents

  • Forced auto-scroll during streaming (scroll hijacking).
  • Scroll event feedback loops caused by programmatic scrolling.
  • Being unable to dismiss the sidebar via outside click while content is streaming.

Testing

2026-02-16.16-02-07.mp4

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 16, 2026
@openedx-webhooks
Copy link

Thanks for the pull request, @efortish!

This repository is currently maintained by @felipemontoya.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@codecov
Copy link

codecov bot commented Feb 16, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.76%. Comparing base (b246dd1) to head (b08a285).
⚠️ Report is 10 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #142      +/-   ##
==========================================
+ Coverage   91.25%   91.76%   +0.50%     
==========================================
  Files          54       54              
  Lines        4565     4942     +377     
  Branches      278      308      +30     
==========================================
+ Hits         4166     4535     +369     
- Misses        310      313       +3     
- Partials       89       94       +5     
Flag Coverage Δ
unittests 91.76% <ø> (+0.50%) ⬆️

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

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants