Skip to content

Fix avatar image flickering on first load #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 11, 2025
Merged

Fix avatar image flickering on first load #45

merged 1 commit into from
Aug 11, 2025

Conversation

flang
Copy link
Contributor

@flang flang commented Aug 5, 2025 •
edited by coderabbitai bot
Loading

Close #44

Summary by CodeRabbit

  • Bug Fixes

    • Improved avatar display by ensuring its size is set after it has been added to the chat window, enhancing visual consistency.

  • Chores

    • Updated the version number of the chat assistant add-on.

@flang flang requested a review from mlopezFC August 5, 2025 20:28
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Aug 5, 2025 •
edited
Loading

Walkthrough

The pull request updates the artifact version in pom.xml from 3.0.0-SNAPSHOT to 3.0.1-SNAPSHOT and modifies the ChatAssistant.java file to defer the avatar.setSizeFull() call until after the avatar element is appended and the chat window target is set, adjusting the timing of avatar sizing.

Changes

Cohort / File(s) Change Summary
Version Update
pom.xml		 Updated chat-assistant-addon artifact version from 3.0.0-SNAPSHOT to 3.0.1-SNAPSHOT.
Avatar Sizing Timing
src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java		 Moved avatar.setSizeFull() into the JavaScript execution callback to defer sizing until after DOM manipulation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective Addressed Explanation
Prevent avatar flickering by avoiding initial full-size rendering (#44) ✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • javier-godoy

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7050631 and d9b8c49.

📒 Files selected for processing (2)
  • pom.xml (1 hunks)
  • src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java (1 hunks)
🧰 Additional context used
🧠 Learnings (6)
📓 Common learnings 
Learnt from: mlopezFC
PR: FlowingCode/ChatAssistant#35
File: src/main/resources/META-INF/frontend/react/animated-fab.tsx:0-0
Timestamp: 2025-07-24T13:41:19.117Z
Learning: In the ChatAssistant animated-fab React component (src/main/resources/META-INF/frontend/react/animated-fab.tsx), the Floating Action Button (FAB) appears empty in the React code but gets its icon content from the Avatar Vaadin component, which is inserted via DOM manipulation from the Java backend's initializeAvatar method.

Learnt from: mlopezFC
PR: FlowingCode/ChatAssistant#35
File: src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java:179-186
Timestamp: 2025-07-24T13:40:40.471Z
Learning: In ChatAssistant's initializeAvatar method (src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java), direct DOM manipulation using executeJs is intentionally used to move the Avatar component to be a child of a button that is inside a div within the React-controlled web component structure. This approach is necessary because the target elements are created by React, and standard Vaadin component hierarchy methods cannot be used due to ReactAdapterComponent limitations.

Learnt from: mlopezFC
PR: FlowingCode/ChatAssistant#35
File: src/main/resources/META-INF/frontend/styles/chat-assistant-styles.css:20-28
Timestamp: 2025-07-22T20:00:43.518Z
Learning: In ChatAssistant's CSS (src/main/resources/META-INF/frontend/styles/chat-assistant-styles.css), the double 180-degree rotation trick on both .chat-assistant-resizable-vertical-layout and .chat-assistant-container-vertical-layout is used to move the resize handle from the default bottom-right corner to the upper-left corner. This positioning is more suitable for resizing the chat window since the chat bubble is positioned in the bottom-right part of the viewport.
📚 Learning: in chatassistant's initializeavatar method (src/main/java/com/flowingcode/vaadin/addons/chatassistan... 
Learnt from: mlopezFC
PR: FlowingCode/ChatAssistant#35
File: src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java:179-186
Timestamp: 2025-07-24T13:40:40.471Z
Learning: In ChatAssistant's initializeAvatar method (src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java), direct DOM manipulation using executeJs is intentionally used to move the Avatar component to be a child of a button that is inside a div within the React-controlled web component structure. This approach is necessary because the target elements are created by React, and standard Vaadin component hierarchy methods cannot be used due to ReactAdapterComponent limitations.

Applied to files:

  • pom.xml
  • src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java
📚 Learning: in `src/main/java/com/flowingcode/vaadin/addons/chatassistant/chatassistant.java`, the parameter `po... 
Learnt from: paodb
PR: FlowingCode/ChatAssistant#31
File: pom.xml:317-317
Timestamp: 2024-11-11T17:49:24.845Z
Learning: In `src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java`, the parameter `position` in the method `scrollToIndex(int position)` is properly documented at line 328.

Applied to files:

  • pom.xml
  • src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java
📚 Learning: in the chatassistant animated-fab react component (src/main/resources/meta-inf/frontend/react/animat... 
Learnt from: mlopezFC
PR: FlowingCode/ChatAssistant#35
File: src/main/resources/META-INF/frontend/react/animated-fab.tsx:0-0
Timestamp: 2025-07-24T13:41:19.117Z
Learning: In the ChatAssistant animated-fab React component (src/main/resources/META-INF/frontend/react/animated-fab.tsx), the Floating Action Button (FAB) appears empty in the React code but gets its icon content from the Avatar Vaadin component, which is inserted via DOM manipulation from the Java backend's initializeAvatar method.

Applied to files:

  • pom.xml
  • src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java
📚 Learning: in chatassistant's css (src/main/resources/meta-inf/frontend/styles/chat-assistant-styles.css), the ... 
Learnt from: mlopezFC
PR: FlowingCode/ChatAssistant#35
File: src/main/resources/META-INF/frontend/styles/chat-assistant-styles.css:20-28
Timestamp: 2025-07-22T20:00:43.518Z
Learning: In ChatAssistant's CSS (src/main/resources/META-INF/frontend/styles/chat-assistant-styles.css), the double 180-degree rotation trick on both .chat-assistant-resizable-vertical-layout and .chat-assistant-container-vertical-layout is used to move the resize handle from the default bottom-right corner to the upper-left corner. This positioning is more suitable for resizing the chat window since the chat bubble is positioned in the bottom-right part of the viewport.

Applied to files:

  • src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java
📚 Learning: when using reactadaptercomponent with custom react components in chatassistant, standard vaadin comp... 
Learnt from: mlopezFC
PR: FlowingCode/ChatAssistant#35
File: src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java:179-186
Timestamp: 2025-07-22T19:52:28.019Z
Learning: When using ReactAdapterComponent with custom React components in ChatAssistant, standard Vaadin component hierarchy methods like add() cannot be used because the component doesn't implement HasComponents, and the DOM structure is controlled by React. Direct DOM manipulation with executeJs may be necessary to integrate Vaadin components (like Avatar) into React-generated DOM structures.

Applied to files:

  • src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java
🔇 Additional comments (2)
pom.xml (1)

7-7: LGTM! Appropriate version increment for bug fix.

The patch version increment from 3.0.0-SNAPSHOT to 3.0.1-SNAPSHOT correctly follows semantic versioning conventions for a bug fix addressing the avatar flickering issue.

src/main/java/com/flowingcode/vaadin/addons/chatassistant/ChatAssistant.java (1)

192-195: Excellent fix for the avatar flickering issue!

Moving avatar.setSizeFull() into the nested callback ensures proper timing by deferring the size setting until after:

  1. The avatar element is appended to the DOM
  2. DOM manipulation repositions the avatar correctly
  3. The chat window target is assigned

This eliminates the flickering effect that occurred when large avatars were resized before being properly positioned in the DOM structure.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch issue-44

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

mlopezFC
mlopezFC requested changes Aug 5, 2025
View reviewed changes
Copy link
Member

@mlopezFC mlopezFC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the version change commit, given that we didn't release the 3.0.0 version yet.

@paodb paodb requested a review from mlopezFC August 11, 2025 16:59
mlopezFC
mlopezFC approved these changes Aug 11, 2025
View reviewed changes
Copy link
Member

@mlopezFC mlopezFC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mlopezFC mlopezFC merged commit 592dd6b into master Aug 11, 2025
3 checks passed
@mlopezFC mlopezFC deleted the issue-44 branch August 11, 2025 19:48
@github-project-automation github-project-automation bot moved this from To Do to Pending release in Flowing Code Addons Aug 11, 2025
@paodb paodb moved this from Pending release to Done in Flowing Code Addons Aug 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mlopezFC mlopezFC mlopezFC approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Flowing Code Addons
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Flickering with big avatars
2 participants
@flang @mlopezFC